GET /profiles/status

Use this method to return information about the server-profile status for specific server.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/profiles/status

Query parameters

Parameters Required / Optional Description
uuids={uuid_list} Required List of server UUIDs, separated by a comma

The following example retrieves the profile status for two servers.

GET https://192.0.2.0/profiles/status
?uids=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401 Unauthorized The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.

For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions.

404 Not found A specified resource cannot be found. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
identifier String Always set to uuid
items Array of objects Configuration status for each server
  activationStatus String Activation status. This can be one of the following values.
  • UNKNOWN. Activation status is in an unknown state.
  • RUNNING. Profile activation is in progress.
  • PENDING. Profile activation is pending.
  • COMPLETED. Profile activation is complete.
  • TERMINATED. Profile activation process was terminated before it completed.
  • CONFIGERROR. Cannot retrieve the configuration definitions from the server.
  • LDAPERROR. Cannot connect to the XClarity Administrator LDAP server.
  complianceStatus String Compliance status. This can be one of the following values.
  • VALID. Server settings are compliant with the assigned server profile

  • INVALID. Server settings are not compliant with the assigned server profile.

  • NONE. Compliance is not calculated because the pattern is still being activated, pending or inactive.

  configStatus String Configuration status. This can be one of the following values.
  • NO_PROFILE. A profile has not been assigned to this server.
  • PROFILE_USE_NOT_SUPPORTED. Configuration patterns is not supported for the server.
  • DEPLOY_STARTED. Configuration-Pattern deployment is started.
  • BUILDING_PROFILE. The server profile is being built.
  • SAVING_PROFILE. The server profile is being saved.
  • PENDING_PROFILE. The server profile is pending activation.
  • ACTIVATING_PROFILE. The server profile is being activated.
  • ERROR_CREATING_PROFILE. The server profile cannot be created.
  • ERROR_ACTIVATING_PROFILE. The server profile cannot be activated.
  • RESTARTING. The server is restarting.
  • PROFILE_ACTIVATED. The server profile is activated.
  serverName String Server name
  serverProfileId String ID of the server profile that is associated with this server
  serverProfileName String Name of the server profile that is associated with this server
  serverTemplateId String ID of the server pattern that was used to create the server profile that is associated with this server
  serverTemplateName String Name of the server pattern that was used to create the server profile that is associated with this server
  uuid String Server UUID
  virtualAddressStatus String Virtual address status. This can be one of the following values.
  • NOT_APPLIED. Virtual addresses are not applied.
  • APPLIED. Virtual addresses are applied.
label String Always set to Server Status
The following example is returned if the request is successful.
{
   "identifier": "uuid",
   "items": [{ 
      "activationStatus": "COMPLETED",
      "complianceStatus": "VALID ",
      "configStatus": "PROFILE_ACTIVATED",
      "serverName": "ch02n12-imm",
      "serverProfileId": "69",
      "serverProfileName": "Flex Virtual Fabric Pattern-profile1",
      "serverTemplateId": "68",
      "serverTemplateName": "Flex Virtual Fabric Pattern",
      "uuid": "BA298CD7BC5311E69A000090FAF46898",
      "virtualAddressStatus": "APPLIED"
   }]
   "label": "Server Status",
}