This operation deletes devices in a synchronized way which may take a long time to respond. Use the Delete devices through job resource instead
An operation to delete devices by ip address. The response time of this service varies and depends on the status of the devices. The API accepts the hostname, the IP address, or the management address of the device to be deleted. Firstly, the API tries to find the device by its management address. Then, if it has not been found, the API tries to find it by IP address and hostname. If there are more than one device with the same IP address or hostname an error will be returned. In this case you should use management address to delete the device.
Since Product Version: 2.2
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
PUT |
Resource URL
/webacs/api/v2/op/devices/deleteDevices UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description |
---|---|
ipAddresses String[] |
Required A list of addresses of the devices to be deleted. Either the hostname, the IP address, or the management address can be passed in. The management address is the address used to add the device to the managed inventory, either an IP address or hostname. |
Response Parameters
Attribute | Description |
---|---|
A list of the delete operation results |
|
message String |
The message returned from the delete device operation |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://localhost/webacs/api/v2/op/devices/deleteDevices
<?xml version="1.0" ?>
<deviceDeleteCandidates>
<ipAddresses>
<ipAddress>String value</ipAddress>
</ipAddresses>
</deviceDeleteCandidates>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/devices/deleteDevices.json
{
"deviceDeleteCandidates" : {
"ipAddresses" : {
"ipAddress" : [ "String value" ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v2/op/devices/deleteDevices
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/devices/deleteDevices" rootUrl="https://localhost/webacs/api/v2/op">
<deleteDeviceResult>
<deleteStatuses>
<deleteStatus>
<ipAddress>String value</ipAddress>
<message>String value</message>
<status>String value</status>
</deleteStatus>
</deleteStatuses>
<message>String value</message>
</deleteDeviceResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/devices/deleteDevices.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/devices/deleteDevices",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"deleteDeviceResult" : [ {
"deleteStatuses" : {
"deleteStatus" : [ {
"ipAddress" : "String value",
"message" : "String value",
"status" : "String value"
} ]
},
"message" : "String value"
} ]
}
}