Schedules a job to delete an AP group from a Wlan Controller.
Resource URL
/webacs/api/v1/op/wlanProvisioning/apGroup
Since : 2.2
Request Parameters
Long
|
controllerId
required
|
query
|
Identifies the controller to delete the AP group from. Either controllerId or controllerName must be specified.
|
String
|
controllerName
required
|
query
|
Identifies the controller to delete the AP group from. Either controllerId or controllerName must be specified.
|
String
|
apGroupName
required
|
query
|
Identifies the AP group to be deleted.
|
Response Parameters
String
|
jobName
|
The unique job name for this job.
|
String
|
jobType
|
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 Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup" responseType="operation">
<jobInformation>
<jobName>String value</jobName>
<jobType>String value</jobType>
</jobInformation>
</mgmtResponse>
Sample JSON Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/",
"@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/wlanProvisioning\/apGroup",
"@responseType" : "operation",
"jobInformation" : {
"jobName" : "String value",
"jobType" : "String value"
}
}
}
POST
POST wlanProvisioning/apGroup
Schedules a job to create an AP group on a Wlan Controller.
Resource URL
/webacs/api/v1/op/wlanProvisioning/apGroup
Since : 2.2
Request Payload Parameters
String
|
apGroupDescription
|
Describes the AP group. Optional.
|
String
|
apGroupName
|
|
ApGroupWlanDTO[]
|
apGroupProfileMappings
|
The collection of Wlan Profile mappings.
|
String
|
interfaceName
|
The name of the interface or interface group to map to.
|
Boolean
|
nacOverride
|
Is NAC override supported? Optional, defaults to false.
|
String
|
wlanProfileName
|
The name of the wlan profile for this mapping.
|
|
Long[]
|
apMembers
|
The AP members of this group, identified by id.
|
Long
|
controllerId
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
String
|
controllerName
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
Response Parameters
String
|
jobName
|
The unique job name for this job.
|
String
|
jobType
|
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://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<apGroupMembershipDTO>
<controllerId>15</controllerId>
<controllerName>String value</controllerName>
<apGroupDescription>String value</apGroupDescription>
<apGroupName>String value</apGroupName>
<apGroupProfileMappings>
<apGroupProfileMapping>
<interfaceName>String value</interfaceName>
<nacOverride>true</nacOverride>
<wlanProfileName>String value</wlanProfileName>
</apGroupProfileMapping>
</apGroupProfileMappings>
<apMembers>
<apMember>15</apMember>
</apMembers>
</apGroupMembershipDTO>
Sample JSON Request Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup.json
{
"apGroupMembershipDTO" : {
"controllerId" : 15,
"controllerName" : "String value",
"apGroupDescription" : "String value",
"apGroupName" : "String value",
"apGroupProfileMappings" : {
"apGroupProfileMapping" : {
"interfaceName" : "String value",
"nacOverride" : true,
"wlanProfileName" : "String value"
}
},
"apMembers" : {
"apMember" : 15
}
}
}
Sample XML Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup" responseType="operation">
<jobInformation>
<jobName>String value</jobName>
<jobType>String value</jobType>
</jobInformation>
</mgmtResponse>
Sample JSON Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/",
"@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/wlanProvisioning\/apGroup",
"@responseType" : "operation",
"jobInformation" : {
"jobName" : "String value",
"jobType" : "String value"
}
}
}
PUT
PUT wlanProvisioning/apGroup
Schedules a job to modify an existing AP group on a Wlan Controller. The apGroupName attribute must match the existing AP group to be modified, and cannot be changed.
Resource URL
/webacs/api/v1/op/wlanProvisioning/apGroup
Since : 2.2
Request Payload Parameters
String
|
apGroupDescription
|
Describes the AP group. Optional.
|
String
|
apGroupName
|
|
ApGroupWlanDTO[]
|
apGroupProfileMappings
|
The collection of Wlan Profile mappings.
|
String
|
interfaceName
|
The name of the interface or interface group to map to.
|
Boolean
|
nacOverride
|
Is NAC override supported? Optional, defaults to false.
|
String
|
wlanProfileName
|
The name of the wlan profile for this mapping.
|
|
Long[]
|
apMembers
|
The AP members of this group, identified by id.
|
Long
|
controllerId
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
String
|
controllerName
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
Response Parameters
String
|
jobName
|
The unique job name for this job.
|
String
|
jobType
|
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://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<apGroupMembershipDTO>
<controllerId>15</controllerId>
<controllerName>String value</controllerName>
<apGroupDescription>String value</apGroupDescription>
<apGroupName>String value</apGroupName>
<apGroupProfileMappings>
<apGroupProfileMapping>
<interfaceName>String value</interfaceName>
<nacOverride>true</nacOverride>
<wlanProfileName>String value</wlanProfileName>
</apGroupProfileMapping>
</apGroupProfileMappings>
<apMembers>
<apMember>15</apMember>
</apMembers>
</apGroupMembershipDTO>
Sample JSON Request Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup.json
{
"apGroupMembershipDTO" : {
"controllerId" : 15,
"controllerName" : "String value",
"apGroupDescription" : "String value",
"apGroupName" : "String value",
"apGroupProfileMappings" : {
"apGroupProfileMapping" : {
"interfaceName" : "String value",
"nacOverride" : true,
"wlanProfileName" : "String value"
}
},
"apMembers" : {
"apMember" : 15
}
}
}
Sample XML Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup" responseType="operation">
<jobInformation>
<jobName>String value</jobName>
<jobType>String value</jobType>
</jobInformation>
</mgmtResponse>
Sample JSON Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/apGroup.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/",
"@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/wlanProvisioning\/apGroup",
"@responseType" : "operation",
"jobInformation" : {
"jobName" : "String value",
"jobType" : "String value"
}
}
}