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 integer

  0 - Success

  status string

  Entity status value

  entity object

  entityType integer

  Client ID

  entityName string

  _type_ integer

  reason string
• IndexCache object[]

  Index cache readiness details

  ReadinessStatus string

  IndexCachePath string
• detail object[]

  Data paths readiness details

  Compression string

  MediaAgent string

  Media Agent Name

  Deduplication string

  ReadinessStatus string

  Readiness status of the data path

  StoragePolicy string

  Subclient object

  Subclient details of the entity

  entityType integer

  entityName 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
      }
    }
  ]
}

GET /client/:clientid/checkreadiness    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

clientId — path required

network — query

---truefalse

resourceCapacity — query

---truefalse

includeDisabledClients — query

---truefalse

ApplicationReadinessOption — query

---01

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/client/:clientId/checkreadiness' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/client/:clientId/checkreadiness' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/client/:clientId/checkreadiness' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/client/:clientId/checkreadiness' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/client/:clientId/checkreadiness' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/client/:clientId/checkreadiness' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/client/:clientId/checkreadiness' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'