POST /api/v1/boarding/discovery

Use this method to directly discover manageable Lenovo devices with or without baseboard management controllers by specifying an individual IP addresses or hostname, range of IP addresses, or subnet.

A job is created to complete this request. The response header returns the URI for the job in the Location field.

A successful response code indicates that the job was successfully transmitted and accepted by the orchestrator. It does not indicate that the operation that is associated with the job was successful. If a job was not successfully started, refer to the response code and response body for details.

Note

This REST API requires Lenovo XClarity Orchestrator v2.0.0 or later.

Authentication

Authentication with user name and password is required.

Resource URI

POST https://{orchestrator_server_IP}/api/v1/boarding/discovery

Query parameters

None

Request body

Attributes		Required / Optional	Type	Description
hosts		Optional	Array of objects	Information about each individual IP address or hostname
	host	Required	String	IPv4 address, IPv6 address, or hostname
	managerID	Required	String	Resource manager ID
ranges		Optional	Array of objects	Information about each range of IP addresses
	start	Required	String	First IPv4 or IPV6 address in the range
	end	Required	String	Last IPv4 or IPV6 address in the range
	managerID	Required	String	Resource manager ID
subnets		Optional	Array of objects	Information about each subnet
	ipAddress	Required	String	IPv4 or IPV6 address
	mask	Required	String	Subnet mask (for IPv4) or a routing prefix length (for IPv6)
	managerID	Required	String	Resource manager ID

The following example example discovers devices using individual IP address, individual hostname, range of IP addresses, and subset.

{
   "hosts": [{
      "host": "10.241.54.10",
      "managerID": "48331a223bf34fba90732b379b837b9c"
   },
   {
      "host": "id-lxc.labs.lenovo.com",
      "managerID": "48331a223bf34fba90732b379b837b9c"
   }],
   "ranges": [{
      "start": "10.241.54.10",
      "end": "10.241.54.15",
      "managerID": "48331a223bf34fba90732b379b837b9c"
   }],
   "subnets": [{
   {
      "ipAddress": "10.241.55.15",
      "mask": "255.255.255.0",
      "managerID": "48331a223bf34fba90732b379b837b9c"
   }]
}

Response codes

Code	Description	Comments
200	OK	The request completed successfully.
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 header

The URI and ID of the root job are returned in the Location and JobID fields respectively, for example:

Location: /api/v1/jobs-management/jobs/56?childrenLevels=-1
jobID: 56

Response body

Attributes			Type	Description
`{message_attributes}`			`varies`	Status messages (see Status messages)

Give feedback

POST /api/v1/boarding/discovery

Authentication​

Resource URI​

Query parameters​

Request body​

Response codes​

Response header​

Response body​