Delete one or more devices through a batch job.
Since Product Version: 3.1
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
DevNet Discussions
Resource URL
/webacs/api/v1/op/devices/removalJobRequest Payload Parameters
Attribute | Description |
---|---|
deleteAPs boolean |
Delete access points associated to wireless controllers. When not provided or 'false', then associated access points will not be deleted and remain in "unassociated" state. Note, that thirdparty access points will be deleted regardless of the property value. |
ipAddressList InetAddress[] |
List of device IP addresses |
Response Parameters
Attribute | Description |
---|---|
jobName String |
The unique job name for this job |
jobType String |
The non-unique job type for this job |
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/v1/op/devices/removalJob
<?xml version="1.0" ?>
<removalJobParamsDTO>
<deleteAPs>true</deleteAPs>
<ipAddressList>
<ipAddressList>
<address>192.168.115.243</address>
</ipAddressList>
</ipAddressList>
</removalJobParamsDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/devices/removalJob.json
{
"removalJobParamsDTO" : {
"deleteAPs" : true,
"ipAddressList" : {
"ipAddressList" : {
"address" : "192.168.115.243"
}
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v1/op/devices/removalJob
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/devices/removalJob" rootUrl="https://localhost/webacs/api/v1/op">
<removalJobResultDTO>
<jobName>String value</jobName>
<jobType>String value</jobType>
</removalJobResultDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/devices/removalJob.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/devices\/removalJob",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"removalJobResultDTO" : {
"jobName" : "String value",
"jobType" : "String value"
}
}
}