GET /api/v1/boarding/devices/`{id}`

Use this method to return information about a specific discovered (but not managed) Lenovo device 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/{id}

where {id} is the ID of the discovered device. To obtain the discovered device IDs, use GET /api/v1/boarding/devices.

Query parameters

None

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.
401	Unauthorized	The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403	Forbidden	The 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).

Attributes				Type	Description
id				String	Device 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.
accessState				String	Access state of the device (translated). This can be one of the following values. Online Offline Offline Managed Partial Pending Unknown
accurateHealth				Boolean	Indicates whether the health status is accurate. This can be one of the following values. true. The accessState is Offline Managed, Online, or partial. false. The acccessState is Offline, Pending, or Unknown.
canisters				Array of objects	(Storage devices only) Information about each canister in the device
	id			String	Canister ID
cmmDisplayName				String	Chassis name
cmmHealthState				String	Health state (translated). This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
cmms				Array of objects	(Chassis only) Information about each CMM
	accessState			String	Access state (translated) of the chassis. This can be one of the following values. Online Offline Offline Managed Partial Pending Unknown
	accessStateKey			String	Access state key of the chassis. This can be one of the following values. Online Offline Offline Managed Partial Pending Unknown
	accurateHealth			Boolean	Indicates whether the health status is accurate. This can be one of the following values. true. The accessState is Offline Managed, Online, or partial. false. The acccessState is Offline, Pending, or Unknown.
	backedBy			String	Indicates whether the data is from a real or demo server. This can be one of the following values. real. The inventory describes real hardware. demo. The inventory describes demo (mock) hardware. proxy. A proxy is temporarily serving to provide the inventory.
	cmmDisplayName			String	Display name provided by the CMM
	cmmHealthState			String	Health summary that corresponds to the highest event severity of all the devices. This can be one of the following values. Normal Warning Critical Unknown
	dataHandle			Long	Time stamp of the last status update
	description			String	Description that was provided by the CMM
	deviceTypeKey			String
	domainName			String	User-defined domain name
	dnsHostnames			Array of strings
	errorFields			Array of objects	Error code. This can be one of the following values. FETCH_SUCCESS FETCH_FAILED NO_CONNECTOR FATAL_EXCEPTION NETWORK_FAIL
	excludedHealthState			String	Highest severity alert with exclusions. This can be one of the following values. Normal Warning Critical Unknown
	firmware			Array of objects	Information about CMM firmware
		build		String	Firmware build
		classifications		Array of integers	Firmware type codes
		date		String	Firmware date
		name		String	Firmware name
		deviceTypeKey		String
		revision		String	Firmware revision
		role		String	Firmware role. This can be one of the following values. Primary Backup Temporary Permanent
		softwareID		String	Firmware ID
		status		String	Firmware status. This can be one of the following values. Active Inactive
		type		String	Firmware type, such as UEFI, MP, or DSA
		version		String	Firmware version
	FRU			String	CMM FRU part number
	fruSerialNumber			String	CMM FRU serial number
	hostConfig			Array of objects	Information about host configuration
		DDNSenabled		Boolean	Identifies whether dynamic DNS enabled. This can be one of the following values. true. Dynamic DNS is enabled. false. Dynamic DNS is disabled.
		DNSenabled		Boolean	Identifies whether DNS enabled. This can be one of the following values. true. DNS is enabled. false. DNS is disabled.
		IPversionPriority		String	IP version priority. This can be one of the following values IPv6ThenIPv4 IPv4ThenIPv6
		priIPv4userDNSserver		String	Primary user assigned IPv4 DNS server
		priIPv6userDNSserver		String	Primary user assigned IPv6 DNS server
		secIPv4userDNSserver		String	Secondary user assigned IPv4 DNS server
		secIPv6userDNSserver		String	Secondary user assigned IPv6 DNS server
		terIPv4userDNSserver		String	Tertiary user assigned IPv4 DNS server
		terIPv6userDNSserver		String	Ternary user assigned IPv6 DNS server
	hostname			String	User-defined hostname
	ipInterfaces			Array of objects	Information about each IP interface
		IPv4assignments		Array of objects	Information about each IPv4 assignment
			id	Integer	IPv4 assignment ID
			address	String	IPv4 address
			deviceTypeKey	String
			gateway	String	IPv4 gateway
			subnet	String	IPv4 subnet mask
			type	String	Type of the IPv4 assignment. This can be one of the following values. INUSE CONFIGURED ALIAS UNKNOWN
		IPv4DHCPmode		String	IP address assignment method. This can be one of the following values. STATIC_ONLY DHCP_ONLY DHCP_THEN_STATIC UNKNOWN
		IPv4enabled		Boolean	Identifies whether IPv4 is enabled. This can be one of the following values. true. IPv4 is enabled. false. IPv4 is disabled.
		IPv6assignments		Array of objects	Information about each IPv6 assignment
			id	Integer	IPv6 assignment ID
			address	String	IPv6 address
			gateway	String	IPv6 gateway
			prefix	Integer	IPv6 prefix
			scope	String	Scope of the IPv6 assignment. This can be one of the following values. Global LinkLocal Unknown
			source	String	Source of the IPv6 assignment. This can be one of the following values. DHCP Statelesss Static Other Unknown
			type	String	Type of the IPv6 assignment. This can be one of the following values. INUSE CONFIGURED ALIAS UNKNOWN
		IPv6DHCPenabled		Boolean	Identifies whether IPv6 DHCP is enabled. This can be one of the following values. true. IPv6 DHCP is enabled. false. IPv6 DHCP is disabled.
		IPv6enabled		Boolean	Identifies whether IPv6 is enabled. This can be one of the following values. true. IPv6 is enabled. false. IPv6 is disabled.
		IPv6statelessEnabled		Boolean	Identifies whether IPv6 stateless is enabled. This can be one of the following values. true. IPv6 stateless is enabled. false. IPv6 stateless is disabled.
		IPv6staticEnabled		Boolean	Identifies whether IPv6 static is enabled. This can be one of the following values. true. IPv6 static is enabled. false. IPv6 static is disabled.
		label		String	Label
		name		String	Name
	ipv4Addresses			Array of strings	List of IPv4 addresses
	ipv6Addresses			Array of strings	List of IPV6 addresses
	leds			Array of objects	Information about server LEDs
		color		String	LED color. This can be one of the following values. Red Amber Yellow Green Blue Unknown
		location		String	LED location. This can be one of the following values. Front panel Lightpath Card Planar FRU Rear Panel Unknown
		name		String	LED name
		state		String	LED state. This can be one of the following values. Off On Blinking Unknown
	macAddresses			Array of strings	List of MAC addresses
	machineType			String	Server machine type
	manufacturer			String	Manufacturer
	manufacturerId			String	Manufacturer ID
	mgmtProcIPaddress			String	IP address used by XClarity Orchestrator to manage this resource
	model			String	CMM model
	name			String	Name that is displayed in the user interface for this device
	overallHealthState			String	Highest severity of all alerts. This can be one of the following values. Normal Warning Critical Unknown
	overallHealthStateKey			String	Highest severity key. This can be one of the following values. normal warning critical unknown
	parent			Object	Information about the parent device
		uri		String	Parent URI
		uuid		String	Parent UUID
	partNumber			String	CMM part number
	powerAllocation			Object
		maximumAllocatedPower		Long	Maximum power that is allocated
		minimumAllocatedPower		Long	Minimum power that is allocated
	powerStatus			String
	powerStatusKey			String
	productId			String	CMM product ID
	role			String	Role of the CMM. This can be one of the following values. primary backup
	serialNumber			String	CMM serial number
	slots			Array of integers	CMM primary slot
	type			String	Resource type. This value is always CMM.
	userDefinedName			String	User-defined name for the device
	userDescription			String	Description that was defined by the user
	uri			String	CMM URI
	uuid			String	CMM UUID
deviceInfo				Object	Information about the device
	domainName			String	Domain name
	entitleSerialNumber			String	Entitled serial number
	groups			Array of strings	List of IDs for groups that include this device
		id		String	Groups ID
		name		String	Group name
		type		String	Group type
		uri		String	Group URI
	healthStatus			String	Highest severity of all alerts (translated). This can be one of the following values. Normal Warning Critical Unknown
	hostname			String	Hostname
	ipv4Addresses			Array of strings	List of IPv4 addresses
	ipv6Addresses			Array of strings	List of IPV6 addresses
	location			Object	Information about the location of the server or Flex System storage device
		location		String	Location
		lowestRackUnit		Integer	Lowest rack unit
		rack		String	Rack
		room		String	Room
	machineType			String	Machine type
	model			String	Device model
	powerStatus			String	Power status (translated). This can be one of the following values. Off On Standby Unknown
	productName			String	Product name
	serialNumber			String	Device serial number
	userDefinedName			String	User-defined name for the device
	uuid			String	Device UUID
	_ui			Object	Information about web-interface-specific attributes.
		healthStatusKey		String	Severity key of the highest severity of all devices. This can be one of the following values. normal warning critical unknown
		powerStatusKey		String	Power status key. This can be one of the following values: off on standby unknown
deviceName				String	Device name
deviceType				String	Device name
discoveredBy				Array of objects	Information about each resource manager that discovered this device
	id			String	Manager ID
	name			String	Manager name
	uri			String	Manager URI
displayName				String	Display name
driveBays				String	Domain name
drives				Integer	Number of drive bays
	bay			Integer	Drive bay
	blockSize			Integer	Block size
	capacity			Long	Drive capacity
	description			String	Description
	diskState			String	Disk-drive state
	firmware			Array of objects	Information about add-in card firmware
		build		String	Firmware build
		classifications		Array of integers	Firmware type codes
		date		String	Firmware date
		name		String	Firmware name
		deviceTypeKey		String
		revision		String	Firmware revision
		role		String	Firmware role. This can be one of the following values. Primary Backup Temporary Permanent
		softwareID		String	Firmware ID
		status		String	Firmware status. This can be one of the following values. Active Inactive
		type		String	Firmware type, such as UEFI, MP, or DSA
		version		String	Firmware version
	FRU			String	FRU
	healthState			String	Highest severity of all alerts. This can be one of the following values. Normal Warning Critical Unknown
	healthStateKey			String	Highest severity key. This can be one of the following values. normal warning critical unknown
	interfaceType			String	(ThinkServer servers only) Drive interface type
	largestAvailableSize			Integer
	m2Location			String	(M.2 drives only) Location of M.2 drive and bay
	manufacturer			String	Manufacturer
	mediaType			String	Media type
	model			String	Model
	name			String	Drive name
	numberOfBlocks			Integer	Number of blocks
	partNumber			String	Part number
	remainingLife			Integer	Indicate the amount of life that remains for a solid-state drive (SSD). This can be one of the following values. 0 – 100. Percent of remaining life -1. Unknown (default) -2. Information is not available -3. The drive is not an SSD
	serialNumber			String	Serial number
	temperature			String	Device temperature
	uuid			String	Storage device UUID
drivesInstalled				Integer	(Storage devices only) Number of installed drives
enclosureFormFactor				String	Form factor of the chassis. This can be one of the following values. dense-computing edge-computing rack-tower
excludedHealthState				String	Highest severity alert with exclusions. This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
firmware				Array of objects	Information about each firmware
	build			String	Firmware build
	date			String	Firmware date
	version			String	Firmware version
fruNumber				String	Device FRU number
groups				Array of objects	Information about each group that include this device
	id			String	Group ID
	name			String	Group name
	uri			String	Group URI
hostname				String	Hostname
ipv4Addresses				Array of strings	List of IPv4 addresses that are assigned to this device
ipv6Addresses				Array of strings	List of IPv6 addresses that are assigned to this device
isEmbeddedisEmbedded				Boolean
jobId				Integer	ID of the job through which this device was discovered
location				Object	Information about the location of the server or Flex System storage device
	location			String	Location
	lowestRackUnit			Integer	Lowest rack unit
	rack			String	Rack
	room			String	Room
machineType				String	Device machine type
managementProcessor				String	Management controller type. This can be one of the following values. integrated-management-module integrated-management-module2 lenovo-xclarity-controller chassis-management-module
manufacturer				String	Manufacturer
mgmtProcType				String	Type of management controller. This can be one of the following values. FSP IMM2 XCC XCC2 UNKNOWN
model				String	Device model
mtm				String	Device machine type and model, separate by a forward slash (for example, 8387/AC1
name				String	Name that is displayed in the user interface for this device
overallHealthState				String	Highest severity of all devices (translated). This can be one of the following values. Normal Warning Critical Unknown
powerStatus				String	Power status (translated). This can be one of the following values. Off On Standby Unknown
powerSupplies				Array of objects	(Rack servers only) Information about power supplies
	cmmDisplayName			String	Assigned component name
	cmmHealthState			String	Health state (translated). This can be one of the following values. Normal Warning Critical Unknown
	dataHandle			Long	Time stamp of the last status update
	description			String	Assigned component description
	deviceTypeKey			String
	excludedHealthState			String	Highest severity alert with exclusions. This can be one of the following values. Normal Warning Critical Unknown
	firmware			Array of objects	Information about firmware
		build		String	Firmware build
		classifications		Array of integers	Firmware type codes
		date		String	Firmware date
		deviceTypeKey		String
		name		String	Firmware name
		revision		String	Firmware revision
		role		String	Firmware role. This can be one of the following values. Primary Backup Temporary Permanent
		softwareID		String	Firmware ID
		status		String	Firmware status. This can be one of the following values. Active Inactive
		type		String	Firmware type, such as UEFI, MP, or DSA.
		version		String	Firmware version
	FRU			String	FRU part number
	fruSerialNumber			String	FRU serial number
	hardwareRevision			String	Hardware revision
	healthState			String	Health state (translated). This can be one of the following values. Normal Warning Critical Unknown
	healthStateKey			String	Health state key. This can be one of the following values. normal warning critical unknown
	inputVoltageIsAC			Boolean	Identifies whether the input voltage is ac or dc. This can be one of the following values. The value is valid only if inputVoltageMin and inputVoltageMax are valid. true. ac false. dc
	inputVoltageMax			Integer	Maximum input voltage A value of `-1` mean it has not been set yet.
	inputVoltageMin			Integer	Minimum input voltage A value of `-1` means it has not been set yet.
	leds			Array of objects	Information about power-supply LEDs.
		color		String	LED color. This can be one of the following values. Red Amber Yellow Green Blue Unknown
		location		String	LED location. This can be one of the following values. Front panel Lightpath Card Planar FRU Rear Panel Unknown
		name		String	LED name
		state		String	LED state. This can be one of the following values. Off On Blinking Unknown
	machineType			String	Machine type
	manufactureDate			String	Manufacture date
	manufacturer			String	Manufacturer name
	manufacturerId			String	Manufacturer ID
	model			String	Power-supply model
	name			String	User-defined name, if available. Otherwise, this is one of the following values. component name serial number UUID
	overallHealthState				Highest severity of all power supplies(translated). This can be one of the following values. Normal Warning Critical Unknown
	overallHealthStateKey				Highest severity key. This can be one of the following values. Normal Warning Critical Unknown
	parent			Object	Information about the parent device, if applicable
		uri		String	Parent URI
		uuid		String	Parent UUID
	partNumber			String	Part number
	posID			String	Position ID
	powerAllocation			Object	Information about the power allocation
		totalInputPower		Long	Total input power
		totalOutputPower		Long	Total output power
	powerState			String	Current power state of the power supply. This can be one of the following values. Off On ShuttingDown Standby Hibernate Unknown
	productId			String	Product ID
	productName			String	Product name
	serialNumber			String	Serial number
	slots			Array	Power-supply primary slot
	type			String	Resource type. This value is always PowerSupply
	uri			String	URI
	userDescription			String	User description
	uuid			String	UUID
	vpdID			String	VPD ID
productName				String	Product name
securityDescriptor				Object	Information about the authentication enablement and support the associated stored credentials for a managed device
	identityManagementSystemEnabled			Boolean	Indicates whether to use an identity-management system for authentication. This can be one of the following values. true. An identity-management system is to authenticate this device. false. An identity-management system is not used to authenticate this device. In this case, either manually entered credentials or stored credentials must be used. Note Identity management systems can be used to authenticate only ThinkSystem and ThinkAgile servers.
	managedAuthEnabled			Boolean	Indicates whether the device uses managed authentication. This can be one of the following values. true. The device uses managed authentication. false. The device uses local authentication.
	managedAuthSupported			Boolean	Indicates whether the device supports the ability to choose whether managed authentication is to be used. This can be one of the following values. true. This device supports the ability to choose managed authentication. false. This device does not support the ability to choose managed authentication.
	publicAccess			Boolean	Indicates whether the device can be accessed by all role groups. This can be one of the following values. true. The resource can be access by all role group. false. The resource is restricted to specific role groups.
	roleGroups			Array of strings	List of role groups that are permitted to view and manage this device
	storedCredentials			object	Information about the stored credential that is associated with this device, if applicable
		id		String	Description of the stored credential
		description		String	ID of the stored credential
		userName		String	Name of the stored credential
	uri			String	URI of the device
serialNumber				String	Device serial number
server-type				String	Server type. This can be one of the following values. ITE. Flex System server DenseChassis Edge Server. ThinkSystem SE server NeXtScale. NeXtScale server Rack-Tower Server. ThinkAgile, ThinkSystem SD, ThinkSystem SR, ThinkSystem ST , Converged, System x
status				Object	Information about management status
	name			String	Status. This is always UNMANAGED.
	message			String	Status message. This is always Unmanaged.
systemBoard				Object	Information about the system board
	machineType			String	Device machine type
	model			String	Device model
	productName			String	Product name
	serialNumber			String	Device serial number
	uuid			String	Device UUID
type				String	Resource type (translated). This can be one of the following values. chassis server storage switch
userDefinedName				String	User-defined name for the device
uuid				String	Device UUID
_id				String	Device internal ID
_links				Object	Devices URI (see Links)
_rawDeviceData				Object	Raw data about the device data from the resource manager
_ui				Object	Information about web-interface-specific attributes
	overallHealthStateKey			String	Severity key of the highest severity of all devices. This can be one of the following values. normal warning critical unknown
	powerStatusKey			String	Power status key. This can be one of the following values. off on standby unknown

The following example is returned if the request is successful.

{
   "id": "ABC31213310B11EAAC96A252EC8212C0-1CB64754EA1543E0AAAA46C1D45CD549",
   "accurateHealth": true,
   "deviceInfo": {
      "domainName": null,
      "entitleSerialNumber": null,
      "healthStatus": "Unknown",
      "hostname": "XCC-SR665",
      "ipv4Addresses": ["10.241.53.125"],
      "ipv6Addresses": ["fd55:faaf:e1ab:21bb::125","fe80::a94:efff:feaa:9393"],
      "location": null,
      "machineType": "7D2W",
      "model": "RCZ000",
      "powerStatus": "Off",
      "productName": null,
      "serialNumber": "1234567890",
      "userDefinedName": null,
      "uuid": "ABC31213310B11EAAC96A252EC8212C0",
      "_ui": {
         "powerStatusKey": "Off",
         "healthStatusKey": "Unknown"
      }
   },
   "deviceName": "Steel-AMD-53-125",
   "discoveredBy": [{
      "id": "1CB64754EA1543E0AAAA46C1D45CD549",
      "name": "10.241.54.149",
      "uri": "/api/v1/managers-management/managers/1CB64754EA1543E0AAAA46C1D45CD549"
   }],
   "displayName": "Steel-AMD-53-125",
   "enclosureFormFactor": "rack-tower",
   "firmware": [],
   "fruNumber": "02YE183",
   "groups": [],
   "hostname": "XCC-SR665",
   "ipv4Addresses": ["10.241.53.125"],
   "ipv6Addresses": ["fd55:faaf:e1ab:21bb::125","fe80::a94:efff:feaa:9393"],
   "jobId": 29,
   "model": "RCZ000",
   "machineType": "7D2W",
   "managementProcessor": "lenovo-xclarity-controller",
   "mtm": "7D2W/RCZ000",
   "name": "Steel-AMD-53-125",
   "overallHealthState": "Unknown",
   "powerStatus": "Off",
   "productName": null,
   "serialNumber": "1234567890",
   "server-type": "Rack-Tower Server",
   "systemBoard": {
      "machineType": "7D2W",
      "model": "RCZ000",
      "productName": null,
      "serialNumber": "1234567890",
      "uuid": "ABC31213310B11EAAC96A252EC8212C0"
   },
   "type": "server",
   "uuid": "ABC31213310B11EAAC96A252EC8212C0",
   "_id": "62c6e4632d1860bf666e12c6",
   "_links": {
      "rel": "self",
      "uri": "/api/v1/boarding/devices/ABC31213310B11EAAC96A252EC8212C0-1CB64754EA1543E0AAAA46C1D45CD549"
   }
   "_rawDeviceData": {
      "displayName": "Steel-AMD-53-125",
      "enclosureFormFactor": "rack-tower",
      "firmware": [{
         "build": "D8BT37L",
         "date": "2022-04-20",
         "version": "4.10"
      },
      {
         "build": "D8E101P",
         "date": "2019-12-26",
         "version": "1.00"
      }],
      "fruNumber": "02YE183",
      "hostname": "XCC-SR665",
      "ipAddresses": ["10.241.53.125","fd55:faaf:e1ab:21bb::125","fe80::a94:efff:feaa:9393"],
      "machineType": "7D2W",
      "managementPorts": [{
         "enabled": false,
         "port": 5988,
         "protocol": "cimxml-http"
      },
      ...,
      {
         "enabled": true,
         "port": 443,
         "protocol": "https"
      }],
      "managementProcessor": "lenovo-xclarity-controller",
      "model": "RCZ000",
      "name": "Steel-AMD-53-125",
      "securityDescriptor": {
         "managedAuthEnabled": true,
         "managedAuthSupported": true,
         "publicAccess": false,
         "roleGroups": [],
         "uri": "nodes/ABC31213310B11EAAC96A252EC8212C0"
      },
      "serialNumber": "1234567890",
      "server-type": "Rack-Tower Server",
      "status": {
         "manageable": true,
         "message": "Unmanaged",
         "name": "UNMANAGED"
      },
      "subType": "",
      "type": "server",
      "uuid": "ABC31213310B11EAAC96A252EC8212C0"
   },
   "_ui": {
      "overallHealthStateKey": "Unknown",
      "powerStatusKey": "Off"
   }
}

Give documentation feedback

GET /api/v1/boarding/devices/{id}

Authentication​

Resource URI​

Query parameters​

Request body​

Response codes​

Response body​