Perform check readiness
Select
SaaS
Customer Managed
Perform check readiness on a given server
Path Parameters
- clientId string required
Client ID. Use GetId API to find the client ID
Query Parameters
- network boolean
Default value:
true
Flag to verify network connections between the client, CommCell environment, and MediaAgents
- resourceCapacity boolean
Default value:
true
Flag to verify resources and capacity of the client
- includeDisabledClients boolean
Flag to include disabled entities of the client
- ApplicationReadinessOption integer
Possible values: [
0
,1
]Default value:
1
Flag to verify resource connections between client and remote software cache pair client, laptop client and Edge index server client, and client and log monitoring index client
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
summary object[]
entityStatus integer0 - Success
status stringEntity status value
entity object
entityType integerClient ID
entityName string_type_ integerreason stringIndexCache object[]
Index cache readiness details
ReadinessStatus stringIndexCachePath stringdetail object[]
Data paths readiness details
Compression stringMediaAgent stringMedia Agent Name
Deduplication stringReadinessStatus stringReadiness status of the data path
StoragePolicy stringSubclient object
Subclient details of the entity
entityType integerentityName string_type_ integer
{
"summary": [
{
"entityStatus": 0,
"status": "string",
"entity": {
"entityType": 0,
"entityName": "string",
"_type_": 0
},
"reason": "string"
}
],
"IndexCache": [
{
"ReadinessStatus": "string",
"IndexCachePath": "string"
}
],
"detail": [
{
"Compression": "string",
"MediaAgent": "string",
"Deduplication": "string",
"ReadinessStatus": "string",
"StoragePolicy": "string",
"Subclient": {
"entityType": 0,
"entityName": "string",
"_type_": 0
}
}
]
}
{
"summary": [
{
"entityStatus": 0,
"status": "Ready.",
"entity": {
"entityType": 3,
"entityName": "Client",
"_type_": 0
}
},
{
"reason": "",
"entityStatus": 0,
"status": "Ready.",
"entity": {
"entityType": 3,
"entityName": "MediaAgent",
"_type_": 0
}
}
],
"IndexCache": [
{
"ReadinessStatus": "Ready.\n",
"IndexCachePath": "C:\\Program Files\\Commvault\\ContentStore\\IndexCache"
}
],
"detail": [
{
"Compression": "Off",
"MediaAgent": "N/A",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "N/A",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/defaultBackupSet/default",
"_type_": 0
}
},
{
"Compression": "On Client",
"MediaAgent": "USProxy",
"Deduplication": "Off",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "NewManPlan1627541685538(Primary)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/defaultBackupSet/DDBBackup",
"_type_": 0
}
}
]
}
Loading...