GET /config/target/{id}
Use this method to return a list of deployable target systems according to their pattern and profile.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/config/target/{id}
where {id} is the unique ID for the server pattern or profile that was assigned when the server pattern or profile was created. To obtain the ID for the server pattern or profile, use the GET /patterns/{id} or GET /profiles method.
Query parameters
None
Request body
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 | |||||
| label | String | |||||
| items | Object | Information about the deployable target system | ||||
| firmwareLevel | String | Firmware level of the server or chassis | ||||
| uuid | String | UUID of the server or chassis | ||||
| children | Object | List of all deployable servers | ||||
| ites | Array | Information about each deployable server in the chassis | ||||
| firmwareLevel | String | Indicates whether the firmware on the server is compatible. This can be one of the following values.
| ||||
| formFactor | String | Form factor of the server. This can be one of the following values.
| ||||
| ips | Array | List of all IP addresses for the server | ||||
| id | String | UUID of the server | ||||
| location | String | Location ID of the server | ||||
| name | String | Name of the server | ||||
| profile | String | Name of the profile that is assigned to the server | ||||
| schedule | String | Indicates the server-restart schedule. This can be one of the following values.
| ||||
| type | String | Type of server. This can be one of the following values.
| ||||
| access | String | Access level of the server | ||||
| bays | Array | List of bays that the server takes up | ||||
| subBays | Array | (Flex System x222 Compute Node only) List of sub-bays that the device takes up | ||||
| architecture | String | Server architecture. This can be one of the following values.
| ||||
| rackId | String | ID of the rack that contains the server | ||||
| unit | String | ID of the lowest rack unit (LRU) that contains the server | ||||
| productName | String | Description the official product name for the server | ||||
| deployCompatibility | Array | Information about deployment compatibility | ||||
| status | String | Deploy status of the device. This can be one of the following values.
| ||||
| message | String | Information about the deployment status | ||||
| powerStatus | String | Current power state of the server. This can be one of the following values.
| ||||
| id | String | UUID of the chassis or server | ||||
| name | String | Name of the chassis or server | ||||
| type | String | Type of device. The value is always chassis. | ||||
| access | String | The access-level of the chassis or server. This can be one of the following values.
| ||||
| description | String | Description of the chassis or server | ||||
| ipaddresses | Array | List of all IP addresses for the chassis or server | ||||
The following example is returned if the request is successful.
{
"identifier": "id",
"label": "name",
"items": [{
"firmwareLevel": "compatible",
"uuid": "phc-d6f5c6be4e4c4996a3fbf8ffd17f78c5",
"children": [{
"ites": [{
"firmwareLevel": "compatible",
"formFactor": "f",
"location": "phc-d6f5c6be4e4c4996a3fbf8ffd17f78c5_bay1",
"ips": [],
"id": "phc-d6f5c6be4e4c4996a3fbf8ffd17f78c5_bay1",
"name": "Bay1",
"profile": "",
"schedule": "defer",
"type": "bay",
"access": "empty",
"bays": ["1"],
"subBays": [],
"architecture": "",
"rackId": "",
"unit": 0,
"productName": "",
"deployCompatibility": {
"status": "READY",
"message": "The pattern can be deployed to this server or bay."
},
"powerStatus": "off"
}]
},
{
"ites": [{
"firmwareLevel": "compatible",
"formFactor": "f",
"location": "phc-d6f5c6be4e4c4996a3fbf8ffd17f78c5_bay2",
"ips": [],
"id": "phc-d6f5c6be4e4c4996a3fbf8ffd17f78c5_bay2",
"name": "Bay2",
"profile": "",
"schedule": "defer",
"type": "bay",
"access": "empty",
"bays": ["2"],
"subBays": [],
"architecture": "",
"rackId": "",
"unit": 0,
"productName": "",
"deployCompatibility": {
"status": "READY",
"message": "The pattern can be deployed to this server or bay."
},
"powerStatus": "off"
}]
},
...
{
"ites": [{
"firmwareLevel": "compatible",
"formFactor": "f",
"location": "phc-d6f5c6be4e4c4996a3fbf8ffd17f78c5_bay14",
"ips": [],
"id": "phc-d6f5c6be4e4c4996a3fbf8ffd17f78c5_bay14",
"name": "Bay14",
"profile": "",
"schedule": "defer",
"type": "bay",
"access": "empty",
"bays": ["14"],
"subBays": [],
"architecture": "",
"rackId": "",
"unit": 0,
"productName": "",
"deployCompatibility": {
"status": "READY",
"message": "The pattern can be deployed to this server or bay."
},
"powerStatus": "off"
}]
}],
"id": "47",
"name": "PHC",
"type": "chassis",
"access": "placeholder",
"description": "",
"ipaddresses": ""
}]
}
Give documentation feedback