POST /api/v1/boarding/management

Use this method to directly manage discovered devices with or without baseboard management controllers.

When you manage a chassis, all devices in the chassis are managed. You cannot manage individual devices in a chassis.

Attention

Before managing a device, the devices must have been previously discovered using the POST /api/v1/boarding/discovery method.

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/management

Query parameters

None

Request body

Attributes			Required / Optional	Type	Description
chassis			Optional	Object	Information about the chassis to be managed
	config		Required	Object	Information about chassis configuration
		forceManage	Optional	Boolean	Indicates whether to force management of the chassis. This can be one of the following values. true. Force management. false. (default) Do not force management. Note Use the force-management option only if you previously attempted to manage the device and management was not successful due to one of the following error conditions. Note If the managing resource manager failed and cannot be recovered. If the replacement resource manager instance uses the same IP address as the failed resource manager, you can manage the device again using the RECOVERY_ID account and password (if applicable) and the Force management option. If the managing resource manager was taken down before the devices were unmanaged. If the devices were not unmanaged successfully. Attention Devices can be managed by only one resource manager at a time. Management by multiple resource manager is not supported. If a device is managed by one resource manager, and you want to manage it with another resource manager, you must first unmanage the device from the original resource manager, and then manage it with the new resource manager.
		newPassword	Optional	String	(Chassis and servers only) New password to be used for managed authentication
		password	Required	String	Current password to access the chassis
		recoveryPassword	Required	String	Recovery password to be used for the chassis
		username	Required	String	User ID to be used to access the chassis
	ids		Optional	Array of strings	List of IDs of chassis to be managed
		managerId	Optional	String	Manager identifier
		resourceId	Optional	String	Resource identifier
servers			Optional	Object	Information about the servers to be managed
	config		Required	Object	Information about server configuration
		forceManage	Optional	Boolean	Indicates whether to force management of the servers. This can be one of the following values. true. Force management. false. (default) Do not force management. Note Use the force-management option only if you previously attempted to manage the device and management was not successful due to one of the following error conditions. Note If the managing resource manager failed and cannot be recovered. If the replacement resource manager instance uses the same IP address as the failed resource manager, you can manage the device again using the RECOVERY_ID account and password (if applicable) and the Force management option. If the managing resource manager was taken down before the devices were unmanaged. If the devices were not unmanaged successfully. Attention Devices can be managed by only one resource manager at a time. Management by multiple resource manager is not supported. If a device is managed by one resource manager, and you want to manage it with another resource manager, you must first unmanage the device from the original resource manager, and then manage it with the new resource manager.
		newPassword	Optional	String	(Chassis and servers only) New password to be used for managed authentication
		password	Required	String	Current password to access the servers
		recoveryPassword	Optional	String	Recovery password to be used for the servers
		username	Required	String	User ID to be used to access the servers
	ids		Optional	Array of strings	List of IDs of servers to be managed
		managerId	Optional	String	Manager identifier
		resourceId	Optional	String	Resource identifier
storage			Optional	Object	Information about the storage devices to be managed
	config		Required	Object	Information about storage-device configuration
		forceManage	Optional	Boolean	Indicates whether to force management of the storage device. This can be one of the following values. true. Force management. false. (default) Do not force management. Note Use the force-management option only if you previously attempted to manage the device and management was not successful due to one of the following error conditions. Note If the managing resource manager failed and cannot be recovered. If the replacement resource manager instance uses the same IP address as the failed resource manager, you can manage the device again using the RECOVERY_ID account and password (if applicable) and the Force management option. If the managing resource manager was taken down before the devices were unmanaged. If the devices were not unmanaged successfully. Attention Devices can be managed by only one resource manager at a time. Management by multiple resource manager is not supported. If a device is managed by one resource manager, and you want to manage it with another resource manager, you must first unmanage the device from the original resource manager, and then manage it with the new resource manager.
		password	Required	String	Current password to access the storage device
		username	Required	String	User ID to be used to access the storage device
	ids		Optional	Array of strings	List of IDs of storage devices to be managed
		managerId	Optional	String	Manager identifier
		resourceId	Optional	String	Resource identifier

The following example manages multiple devices.

{
   "chassis": {
      "config": {
         "forceManage": false,
         "newPassword": "************",
         "password": "************",",
         "recoveryPassword": "************",
         "username": " User1"
      },
      "ids": [
           {
              "managerId":"823CC2575E0DABAAC6C1D45CD2221CB87",
              "resourceId":"FBB43C13D103511E785F2E4A2CED78753"
           }
      ],
   },
   "servers": {
      "config": {
         "forceManage": false,
         "newPassword": "************",
         "password": "************",
         "recoveryPassword": "************",
         "username": "User1"
      },
      "ids": [
           {
              "managerId":"1CB64754EA1543E0AAAA46C1D45CD549",
              "resourceId":"3015DE7E2B6011E881940A94EF5F5B65"
           }
      ],
  }
  "storage": {
         "forceManage": false,
         "password": "************",
         "username": "User1"
      },
      "ids": [
           {
              "managerId":"754EA1543E0BDACCB6C1D45CD5491CB6",
              "resourceId":"2376F7C628FB11E1B72B5CF3fC3C1448"
           }
      ],
   }
}

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/management

Authentication​

Resource URI​

Query parameters​

Request body​

Response codes​

Response header​

Response body​