GET /api/v1/data/devices
Use this method to return a list of all managed devices.
Authentication
Authentication with username and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/data/devices
Query parameters
This REST API supports query parameters for paginating, scoping, filtering, sorting, including data, and excluding data in the response. For more information about these common query parameters, see Paginating, scoping, filtering, sorting, including data, and excluding data in responses. For a list of supported attributes, see GET /api/v1/data/devices/{id}.
The following example returns a list of all managed devices.
GET https://192.0.2.0/api/v1/data/devices
The following example returns a list of all devices that are managed by a specific resource manager.
GET https://192.0.2.0/api/v1/data/devices
?filterEquals[][attributes]=lxcaUUID&filterEquals[][values]=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
The following example returns a list of all managed IBM servers and includes the manufacturer in the response.
GET https://192.0.2.0/api/v1/data/devices
?filterContains[0][attributes]=typeKey&filterContains[0][values]=server
&filterEquals[1][attributes]=manufacturer&filterEquals[1][values]=IBM
&includeAttributes=id,deviceName,ipv4Addresses,ipv6Addresses,lxcaUUID,productName,manufacturer
The following example returns a list of all managed servers.
GET https://192.0.2.0/api/v1/data/devices
?filterContains[0][attributes]=typeKey&filterContains[0][values]=server
The following example returns a list of all managed ThinkSystem servers.
GET https://192.0.2.0/api/v1/data/devices
?filterContains[0][attributes]=typeKey&filterContains[0][values]=server
&filterContains[1][attributes]=productName&filterContains[1][values]=ThinkSystem
The following example returns a list of all managed chassis.
GET https://192.0.2.0/api/v1/data/devices
?filterContains[][attributes]=typeKey&filterContains[][values]=chassis
The following example returns a list of all managed storage devices.
GET https://192.0.2.0/api/v1/data/devices
?filterContains[][attributes]=typeKey&filterContains[][values]=storage
The following example returns a list of all managed switches.
GET https://192.0.2.0/api/v1/data/devices
?filterContains[][attributes]=typeKey&filterContains[][values]=switch
The following example returns warranty information for all devices in a specific group with expired warranties.
GET https://192.0.2.0/api/v1/data/devices
?filterContains[1][attributes]=statusKey&filterContains[1][values]=Expired
&groupIDs=G_136FAA46D0754FE5B5A493F454EC5551
&includeAttributes=id,name,machineType,model,serialNumber,warranty
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. If a single query parameter is specified and the value of that parameter has no matches, the response body returns default values. If a list of query parameters is specified and the value of at least one parameter has no matches, the response body returns only what matches. |
| 206 | Partial Content | Partial content was returned for a multi-part response. The response header includes a content-range header field indicating the range that is included in the response body for each part. |
| 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. |
| 408 | Request Timeout | The orchestrator server did not receive a required request in a specific amount of time. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| results | Array of objects | Information about each managed device | ||
| id | String | Device ID Tip The device ID includes the UUID of the device and the UUID of the resource manager that manages the device, separated by a dash (deviceUUID–managerUUID). | ||
| deviceName | String | Name that is displayed in the user interface for this device | ||
| ipv4Addresses | Array of strings | List of IPv4 addresses | ||
| ipv6Addresses | Array of strings | List of IPV6 addresses | ||
| lxcaUUID | String | Resource manager UUID | ||
| name | String | Device name | ||
| overallHealthState | String | Highest severity of all alerts. This can be one of the following values.
| ||
| powerStatus | String | Power status. This can be one of the following values.
| ||
| productName | String | Product name | ||
| _links | String | Device URI (see Links) | ||
| _metadata | Object | Request metadata (see Metadata) | ||
The following example is returned if the request is successful.
{
"results": [{
"id": "00632D78DE644E23B712E200FE449787-7AF5D198CECF431AAEC674C7CA5A29B5",
"deviceName": "Kong-SB",
"ipv4Addresses": ["10.243.0.165"],
"ipv6Addresses": ["fe80::e61f:13ff:fed9:367d"],
"lxcaUUID": "7AF5D198CECF431AAEC674C7CA5A29B5",
"name": "Kong-SB",
"overallHealthState": "Normal",
"powerStatus": "On",
"productName": "System x3750 M4",
"_links": {
"rel": "self",
"uri": "/api/v1/data/devices/00632D78DE644E23B712E200FE449787-7AF5D198CECF431AAEC674C7CA5A29B5"
}
}],
"_metadata": {...}
}
Give documentation feedback