DELETE /api/v1/boarding/management
Use this method to unmanage devices.
When you unmanage a chassis, all devices in the chassis are unmanaged. You cannot unmanage individual devices in a chassis.
An asynchronous job is created to complete this request. The response header returns the job URI and job ID.
A successful response code indicates that the job was successfully transmitted and accepted by the hub. 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 or later.
Authentication
Authentication with username and password is required.
Resource URI
DELETE https://{orchestrator_server_IP}/api/v1/boarding/management
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| ids={uuids} | Required | List of UUIDs of devices to be unmanaged, separated by a comma |
| force={Boolean} | Optional | Indicates whether to force the unmanagement operation. This can be one of the following values.
|
The following example unmanages multiple devices without force.
DELETE https://{management_server_IP}/api/v1/boarding/management
?ids=fbb43c13103511e785f2e4a2ced78753,48331a223bf34fba90732b379b837b9c
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. |
| 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
| Attributes | Type | Description | ||
|---|---|---|---|---|
| {message_attributes} | varies | Status messages (see Status messages) | ||
Give documentation feedback