GET /profiles
Use this method to return information about server profiles from the Lenovo XClarity Administrator.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/profiles
Query parameters
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 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. |
| 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 "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.
| ||
| 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.
| ||
| 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.
| ||
| profileName | String | Name of the server profile | ||
| profileStatus | String | Current status of the profile. This can be one of the following values.
| ||
| 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 | ||
The following example is returned if the request is successful.
{
"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"
}]
}
Give documentation feedback