Delete one or more devices through a batch job.
Since Product Version: 3.1
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/devices/removalJob
Request Payload Parameters
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 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
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"
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/devices/removalJob
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
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 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
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/v2/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/v2/op/devices/removalJob.json
{
"removalJobParamsDTO" : {
"deleteAPs" : true,
"ipAddressList" : {
"ipAddressList" : [ {
"address" : "192.168.115.243"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v2/op/devices/removalJob
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/devices/removalJob" rootUrl="https://localhost/webacs/api/v2/op">
<removalJobResultDTO>
<jobName>String value</jobName>
<jobType>String value</jobType>
</removalJobResultDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/devices/removalJob.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/devices/removalJob",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"removalJobResultDTO" : [ {
"jobName" : "String value",
"jobType" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/devices/removalJob
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
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 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
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/v3/op/devices/removalJob
<?xml version="1.0" ?>
<removalJobParamsDTO>
<deleteAPs>true</deleteAPs>
<ipAddressList>
<ipAddressList>
<address>192.168.115.243</address>
</ipAddressList>
<ipAddressList>
<address>192.168.115.244</address>
</ipAddressList>
</ipAddressList>
</removalJobParamsDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/devices/removalJob.json
{
"removalJobParamsDTO" : {
"deleteAPs" : true,
"ipAddressList" : {
"ipAddressList" : [ {
"address" : "192.168.115.243"
}, {
"address" : "192.168.115.244"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/devices/removalJob
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/devices/removalJob" rootUrl="https://localhost/webacs/api/v3/op">
<removalJobResultDTO>
<jobName>String value</jobName>
<jobType>String value</jobType>
</removalJobResultDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/devices/removalJob.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/devices/removalJob",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"removalJobResultDTO" : [ {
"jobName" : "String value",
"jobType" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/devices/removalJob
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
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 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
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/v4/op/devices/removalJob
<?xml version="1.0" ?>
<removalJobParamsDTO>
<deleteAPs>true</deleteAPs>
<ipAddressList>
<ipAddressList>
<address>192.168.115.243</address>
</ipAddressList>
<ipAddressList>
<address>192.168.115.244</address>
</ipAddressList>
</ipAddressList>
</removalJobParamsDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/devices/removalJob.json
{
"removalJobParamsDTO" : {
"deleteAPs" : true,
"ipAddressList" : {
"ipAddressList" : [ {
"address" : "192.168.115.243"
}, {
"address" : "192.168.115.244"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/devices/removalJob
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/devices/removalJob" rootUrl="https://localhost/webacs/api/v4/op">
<removalJobResultDTO>
<jobName>String value</jobName>
<jobType>String value</jobType>
</removalJobResultDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/devices/removalJob.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/devices/removalJob",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"removalJobResultDTO" : [ {
"jobName" : "String value",
"jobType" : "String value"
} ]
}
}