POST /unmanageRequest
Use this method to unmanage one or more target devices. The response header indicates the URI of a job that is associated with a new task that has been started.
Authentication
Authentication with username and password is required.
Request URL
POST https://{management_server_IP}/unmanageRequest
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| endpoints | Required | Array | Information about one or more devices to be unmanaged | ||
| ipAddresses | Required | Array of strings | IP addresses for the device | ||
| type | Required | String | Type of device. This can be one of the following values:
| ||
| uuid | Required | String | UUID for the device | ||
| forceUnmanage | Optional | Boolean | Indicates whether to force the unmanagement of a device. This can be one of the following values.
Important When unmanaging demo hardware, set this attribute to | ||
Request example
The following is an example of a request that is submitted to unmanage a chassis.
{
"endpoints":[{
"ipAddresses" : ["10.243.4.144"],
"type":"Chassis",
"uuid":"63E29269BB634AB9A610D6F8FCE2B28F"
}],
"forceUnmanage":true
}
The following is an example of a request that is submitted to unmanage a rack switch.
{
"endpoints":[{
"ipAddresses":["10.241.139.100"],
"type":"Rackswitch",
"uuid":"F6F5A2630C244FDD9DE5376812C55480"
}],
"forceUnmanage":false
}
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. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response header
If this POST method results in a job getting started, the response header includes a URI in the form /unmanageRequest/jobs/{job_id} (for example, /unmanageRequest/jobs/12) that represents the job that is monitored by the management server. You can use GET /unmanageRequest/jobs/{job_id} to determine the status of the job. If a job was not successfully started, refer to the response code and response body for details.
Note
A successful response indicates that the request was successfully transmitted and accepted by the management server. It does not indicate that the operation that is associated with the job was successful.
Response body
None
Give documentation feedback