Skip to main content

GET /api/v1/data/deviceInfo?deviceID={id}

Use this method to return general information about a specific device.

Authentication​

Authentication with username and password is required.

Resource URI​

GET https://{orchestrator_server_IP}/api/v1/data/deviceInfo?deviceID={id}

Query parameters​

ParametersRequired / OptionalDescription
deviceID={id}RequiredReturns general information about a device, specified by the ID

To obtain the device IDs, use GET /api/v1/data/devices

The following example returns general information about a specific device.
GET https://192.0.2.0/api/v1/data/deviceInfo?deviceID=
3015DE7E2B6011E881940A94EF5F5B65-C7199530FEDE4FE09540DFC3D75FC56C

Request body​

None

Response codes​

CodeDescriptionComments
200OK The request completed successfully. If a query parameter is specified and the value of that parameter has no matches, the response body returns default values.
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.
404Not foundThe resource cannot be found. 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
domainNameStringDomain name
entitleSerialNumberStringEntitled serial number
groupNamesArray of stringsList of names of the groups to which the device belongs
healthStatusStringHealth state of the device (translated). This can be one of the following values.
  • Normal
  • Warning
  • Critical
  • Unknown
healthStatusKeyStringHealth state key. This can be one of the following values.
  • Normal
  • Warning
  • Critical
  • Unknown
hostnameStringHostname
ipv4AddressesArray of stringsList of IPv4 addresses
ipv6AddressesArray of stringsList of IPv6 addresses
locationObjectInformation about the location of the device
 locationStringLocation description
 lowestRackUnitStringLowest rack unit
 rackStringRack name
 roomStringRoom name
machineTypeStringDevice machine type
managerObjectInformation about the resource manager that manages this device
 domainNameStringFully qualified domain name
 fqdnStringFull-qualified domain name
 hostnameStringHost name
 inContextHrefStringIn context URI
 ipv4AddressesArray of stringsIPv4 addresses
 ipv6AddressesArray of stringsIPv6 addresses
modelStringDevice model
patternComplianceStatusStringSever-configuration pattern compliance status (translated). This can be one of the following values.
  • Compliant
  • Failed Deployment
  • No Pattern Assigned
  • Not Compliant
  • Pending Compliance Check
  • Pending Deployment
  • Pending Restart
patternComplianceStatusKeyStringSever-configuration pattern compliance status key. This can be one of the following values.
  • Compliant
  • FailedDeployment
  • NoPatternAssigned
  • NotCompliant
  • PpendingComplianceCheck
  • PendingDeployment
  • PendingRestart
patternIDStringSever-configuration pattern ID
patternNameStringSever-configuration pattern name

If a pattern is not assigned, this value is No Assignment.

powerStatusStringPower status (translated). This can be one of the following values.
  • Off
  • On
  • Standby
  • Unknown
powerStatusKeyStringPower status key. This can be one of the following values.
  • Off
  • On
  • Standby
  • Unknown
productNameStringDevice product name
serialNumberStringDevice serial number
userDefinedNameStringUser-defined name for the device
uuidStringDevice UUID
_linksObjectDevice URI (see Links)
The following example is returned if the request is successful.
{
   "domainName": "labs.lenovo.com",
   "entitleSerialNumber": null,
   "groupNames": [],
   "healthStatus": "Warning",
   "healthStatusKey": "Warning",
   "hostname": "XCC-7Y02-0123456789",
   "ipv4Addresses": ["10.243.0.235","169.254.95.118"],
   "ipv6Addresses": ["fd55:faaf:e1ab:2021:a94:efff:fe4f:5635","fe80::a94:efff:fe4f:5635"],
   "location": {
      "location": "elephante",
      "lowestRackUnit": 33,
      "rack": "Snufflaluffagus",
      "room": "pacaderm"
   },
   "machineType": "7Y02",
   "manager": {
      "domainName": "",
      "fqdn": null,
      "hostname": "localhost",
      "inContextHref": "/ui/index.html#/compDetails/Rack-Tower Server/8151C5148B4411E791329DD935F1CD89/",
      "ipv4Addresses": ["10.243.17.164"],
      "ipv6Addresses": ["0::0","fe80:0:0:0:215:5dff:fe0c:d156"]
   },
   "model": "RCZ000",
   "patternComplianceStatus": "No Pattern Assigned",
   "patternComplianceStatusKey": "NoPatternAssigned",
   "patternID": null,
   "patternName": "No Assignment",
   "powerStatus": "On",
   "powerStatusKey": "On",
   "productName": "ThinkSystem SR570",
   "serialNumber": "0123456789",
   "userDefinedName": "",
   "uuid": "8151C5148B4411E791329DD935F1CD89",
   "_links": {
      "rel": "self",
      "uri": "/api/v1/data/devices/C7199530FEDE4FE09540DFC3D75FC56C"
   }
}