GET /profiles

Use the GET method to retrieve information about server profiles from the Lenovo XClarity Administrator.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/profiles

Query parameters

None

Response codes

Code Description
200 OK
500 Internal server error

Response body

Attributes Type Description
identifier String Always set to "id"
label String Always set to "id"
items Array of objects Information about each server profile
  addressPresent Boolean Identifies whether address pools are used. This can be one of the following values.
  • true. Address pools are used.
  • false. Address pools are not used.
  bayId String ID of the bay in the chassis in which the server is installed, if applicable

For a rack server, this value is empty.

  chassisName String Chassis in which the server is installed, if applicable

For a rack server, this value is empty.

  complianceStatus String Compliance status. This can be one of the following values.
  • valid : Server settings are compliant with the profile

  • invalid : Server settings are Non-compliant with the profile

  • none : Compliance has not been calculated because pattern is still activated, pending or inactive

  externalId String ID of the server or bay to which the profile is deployed
  id String Unique ID of the profile
  managementPatternPresent Boolean Identifies whether a management-interface pattern is used. This can be one of the following values.
  • true. A management-interface pattern is used.
  • false. A management-interface pattern is not used.
  profileName String Name of the server profile
  profileStatus String Current status of the profile. This can be one of the following values.
  • ASSIGNED. The profile is assigned to the server.
  • UNASSIGNED. The profile in not assigned to any server.
  • PENDING_ACTIVATION. The profile is created and targeted to a server but has not been activated yet.
  • ACTIVATING. The profile is currently being activated on the targeted server
  • ERROR_ACTIVATING. There was an error while activating the profile on the targeted server.
  rackID String ID of the rack that contains the server to which the profile is deployed
  serverName String Name of the server to which the profile is deployed
  subBayId String ID of the sub-bay in the chassis in which the server is installed, if the server is a Flex System x222 Compute Node

For all other servers, this value is empty.

  templateID String ID of the server pattern that was used to create the profile
  templateName String Name of the server pattern that was used to create the profile
  type String Internal use only
  unit Integer ID of the unit that contains the server to which the profile is deployed
  uuid String UUID of the server to which the profile is deployed

Response example

{
   "identifier": "id",
   "label": "id",
   "items": [{
      "addressPresent": false,
      "bayId": "12",
      "chassisName": "SN#Y030BG21E01C",
      "complianceStatus": "VALID",
      "managementPatternPresent": false,
      "externalId": "97C28DF7541B4657AB59A26C2640A0A3_bay12",
      "id": "50",
      "profileName": "flex noop-profile4",
      "profileStatus": "ASSIGNED",
      "rackId": "",
      "serverName": "AT-C4022-empt0",
      "subBayId": null,
      "templateId": "46",
      "templateName": "flex noop",
      "type": "root",
      "unit": 0,
      "uuid": "64AADF17B64D11E499180090FA8BC90A"
   },
   ...,
   {
      "addressPresent": false,
      "bayId": "13",
      "chassisName": "SN#Y030BG21E01C",
      "complianceStatus": "NONE",
      "externalId": "97C28DF7541B4657AB59A26C2640A0A3_bay13",
      "id": "49",
      "managementPatternPresent": false,
      "profileName": "flex noop-profile5",
      "profileStatus": "ASSIGNED",
      "rackId": "",
      "serverName": "IB-C4054R-F5054",
      "subBayId": null,
      "templateId": "46",
      "templateName": "flex noop",
      "type": "root",
      "unit": 0,
      "uuid": "65E7D38AA6D811E298BD0090FA1C0DCE"
   }]
}