GET /profiles/{id}
Use this method to return information about a specific server profile.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/profiles/{id}
where {id} is the unique ID for the server profile that was assigned when the server pattern was deployed. To obtain the server profile ID, use the GET /profiles method.
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 | ||
|---|---|---|---|---|
| addressPresent | Boolean | Indicates whether any address pools are present. This can be one of the following values.
| ||
| commands | Array | All the commands that are generated by the profile | ||
| complianceStatus | String | Compliance status. This can be one of the following values.
| ||
| complianceTimestamp | String | Timestamp when the compliance status was set to VALID. This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | ||
| displayName | String | Displayed name of the profile | ||
| dynamicProperties | String | Internal use only | ||
| endpointId | String | ID of the device the profile is deployed to | ||
| endpointType | String | Type of device the profile is deployed to. This can be one of the following values.
| ||
| externalId | String | The ID of the device the profile is deployed to. | ||
| forScalableNode | Boolean | Indicates whether the server is in a scalable system. This can be one of the following values.
| ||
| forScalablePrimaryNode | Boolean | Indicates whether the server is the primary node in the scalable system. This can be one of the following values.
| ||
| forScalableSecondaryNode | Boolean | Indicates whether the profile is for a secondary node in a scalable system. This can be one of the following values.
| ||
| ID | String | ID of the profile | ||
| managementPatternPresent | Boolean | Indicates whether a management interface pattern is present. This can be one of the following values.
| ||
| name | String | Name of the profile | ||
| primaryProfileID | String | If this is a secondary profile, this is a string that is the primary profiles ID | ||
| profilePath | Array of strings | Location where the server profile is assigned. The following strings are returned in this order.
| ||
| rackId | String | ID of the rack that contains the server that the profile is deployed to | ||
| secondaryProfileIDs | Array | IDs of any secondary profiles created as part of a scalable deploy | ||
| serverTemplateId | String | ID of the server pattern used to build the profile | ||
| templateId | String | ID of the server pattern used to build the profile | ||
| unit | Integer | ID of the unit that contains the server that the profile is deployed to | ||
The following example is returned if the request is successful.
{
"addressPresent": false,
"commands": [
"#11/06/2017 3:49:51 PM",
"asu set UEFI.DevicesandIOPorts.RemoteConsole \"Auto\"",
"asusetUEFI.DevicesandIOPorts.SerialPortSharing\"Disable\"",
"asusetUEFI.DevicesandIOPorts.SerialPortAccessMode\"Disable\"",
"asusetUEFI.DevicesandIOPorts.LegacyOptionROMDisplay\"COM Port 1\"",
"asusetUEFI.DevicesandIOPorts.COMPort1\"Enable\"",
"asusetUEFI.DevicesandIOPorts.Com1BaudRate\"115200\"",
"asusetUEFI.DevicesandIOPorts.Com1DataBits\"8\"",
"asusetUEFI.DevicesandIOPorts.Com1Parity\"None\"",
"asusetUEFI.DevicesandIOPorts.Com1StopBits\"1\"",
"asusetUEFI.DevicesandIOPorts.Com1TerminalEmulation\"ANSI\"",
"asusetUEFI.DevicesandIOPorts.Com1ActiveAfterBoot\"Disable\"",
"asusetUEFI.DevicesandIOPorts.Com1FlowControl\"Disable\"",
"asusetUEFI.DevicesandIOPorts.COMPort2\"Enable\"",
"asusetUEFI.DevicesandIOPorts.Com2BaudRate\"115200\"",
"asusetUEFI.DevicesandIOPorts.Com2DataBits\"8\"",
"asusetUEFI.DevicesandIOPorts.Com2Parity\"None\"",
"asusetUEFI.DevicesandIOPorts.Com2StopBits\"1\"",
"asusetUEFI.DevicesandIOPorts.Com2TerminalEmulation\"ANSI\"",
"asusetUEFI.DevicesandIOPorts.Com2ActiveAfterBoot\"Disable\"",
"asusetUEFI.DevicesandIOPorts.Com2FlowControl\"Disable\"",
"portcfg-b115200"
],
"complianceStatus": "Invalid",
"complianceTimestamp": "2022-04-11T18:50:00Z",
"displayId": "56",
"displayName": "flex non-compliant-profile1",
"dynamicProperties": {},
"endPointId": "97C28DF7541B4657AB59A26C2640A0A3_bay7",
"endPointType": "LOCATION",
"externalId": "97C28DF7541B4657AB59A26C2640A0A3_bay7",
"forScalableNode": false,
"forScalablePrimaryNode": false,
"forScalableSecondaryNode": false,
"ID": "56",
"managementPatternPresent": false,
"name": "flex non-compliant-profile1",
"primaryProfileID": "",
"profilePath": ["bay07", "97C28DF7541B4657AB59A26C2640A0A3", "system01", "pod01",
"datacenter01"],
"rackId": "",
"secondaryProfileIDs": [],
"serverTemplateId": "55",
"templateId": "55",
"unit": 0
}
Give documentation feedback