Skip to main content

GET /api/v1/boarding/devices

Use this method to return a list of all discovered (but not managed) Lenovo devices with or without baseboard management controllers.

Note
This REST API requires Lenovo XClarity Orchestrator v2.0 or later.

Authentication​

Authentication with username and password is required.

Resource URI​

GET https://{orchestrator_server_IP}/api/v1/boarding/devices

Query parameters​

This REST API supports query parameters for paginating, 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/boarding/devices/{id}.

The following example return a list of all discovered Lenovo devices.
GET https://192.0.2.0/api/v1/boarding/devices
The following example return a list of all discovered Lenovo servers
GET https://192.0.2.0/api/v1/boarding/devices
?filterContains[0][attributes]=type&filterContains[0][values]=server

Request body​

None

Response codes​

CodeDescriptionComments
200OK 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.
206Partial ContentPartial 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.
400Bad RequestA 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.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403ForbiddenThe orchestrator server was prevented from fulfilling the request. 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).

AttributesTypeDescription
resultsArray of objectsInformation about each discovered device
 idStringDevice ID
Tip
The device ID is made up of the UUID of the device and the UUID of the resource manager that manages the device, separated by a dash.
 deviceNameStringDevice name
 discoveredByArray of objectsInformation about each resource manager that discovered this device
  idStringManager ID
  nameStringManager name
  uriStringManager URI
 ipv4AddressesArray of stringsList of IPv4 addresses that are assigned to this device
 ipv6AddressesArray of stringsList of IPv6 addresses that are assigned to this device
 jobIdIntegerID of the job through which this device was discovered
 nameStringName that is displayed in the user interface for this device
 overallHealthStateStringHighest severity of all devices (translated). This can be one of the following values.
  • Normal
  • Warning
  • Critical
  • Unknown
 powerStatusStringPower status (translated). This can be one of the following values.
  • Off
  • On
  • Standby
  • Unknown
 productNameStringProduct name
 uuidStringDevice UUID
 _linksArray of objectsUser URI (see Links)
_metadataObjectRequest metadata (see Metadata)
The following example is returned if the request is successful.
{
   "results": [{
      "id": "ABC31213310B11EAAC96A252EC8212C0-1CB64754EA1543E0AAAA46C1D45CD549",
      "deviceName": "Steel-AMD-53-125",
      "discoveredBy": [{
         "id": "1CB64754EA1543E0AAAA46C1D45CD549",
         "name": "10.241.54.149",
         "uri": "/api/v1/managers-management/managers/1CB64754EA1543E0AAAA46C1D45CD549"
      }],
      "ipv4Addresses": ["10.241.53.125"],
      "ipv6Addresses": ["fd55:faaf:e1ab:21bb::125","fe80::a94:efff:feaa:9393"],
      "jobId": 29,
      "name": "Steel-AMD-53-125",
      "overallHealthState": "Unknown",
      "powerStatus": "Off",
      "productName": null,
      "uuid": "ABC31213310B11EAAC96A252EC8212C0"
      "_links": [{
         "rel": "self",
         "uri": "/api/v1/boarding/devices/ABC31213310B11EAAC96A252EC8212C0-1CB64754EA1543E0AAAA46C1D45CD549"
      }]
   "_metadata": {...}
}