Schedules a job to delete an interface group from a Wlan Controller.
Resource URL
/webacs/api/v1/op/wlanProvisioning/interfaceGroup
Since : 2.2
Request Parameters
Long
|
controllerId
required
|
query
|
Identifies the controller to delete the interface group from. Either controllerId or controllerName must be specified.
|
String
|
controllerName
required
|
query
|
Identifies the controller to delete the interface group from. Either controllerId or controllerName must be specified.
|
String
|
interfaceGroupName
required
|
query
|
Identifies the interface group to remove from the controller.
|
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/interfaceGroup
<?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/interfaceGroup" 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/interfaceGroup.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\/interfaceGroup",
"@responseType" : "operation",
"jobInformation" : {
"jobName" : "String value",
"jobType" : "String value"
}
}
}
PUT
PUT wlanProvisioning/interfaceGroup
Schedules a job to modify an existing interface group on a Wlan Controller. The interfaceGroupName attribute must match the existing interface group to be modified, and cannot be changed.
Resource URL
/webacs/api/v1/op/wlanProvisioning/interfaceGroup
Since : 2.2
Request Payload Parameters
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.
|
String
|
interfaceGroupDescription
|
A description of the interface group. Optional.
|
String
|
interfaceGroupName
|
Names the interface group.
|
InterfaceMapping[]
|
interfaceMappings
|
The list of interfaces mapped into this interface group.
|
String
|
interfaceName
|
The name of the interface mapped into the interface group.
|
|
String
|
mdnsProfileName
|
The mDNS profile name for this group. Optional, defaults to none.
|
Boolean
|
quarantineInterface
|
Is a quarantine VLAN enabled? If true, ensure all interfaces mapped to this group are quarantine interfaces; if false, ensure all interfaces mapped to this group are non-quarantine interfaces. Optional, defaults to false.
|
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/interfaceGroup
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<interfaceGroup>
<controllerId>15</controllerId>
<controllerName>String value</controllerName>
<interfaceGroupDescription>String value</interfaceGroupDescription>
<interfaceGroupName>String value</interfaceGroupName>
<interfaceMappings>
<interfaceMapping>
<interfaceName>String value</interfaceName>
</interfaceMapping>
</interfaceMappings>
<mdnsProfileName>String value</mdnsProfileName>
<quarantineInterface>true</quarantineInterface>
</interfaceGroup>
Sample JSON Request Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/interfaceGroup.json
{
"interfaceGroup" : {
"controllerId" : 15,
"controllerName" : "String value",
"interfaceGroupDescription" : "String value",
"interfaceGroupName" : "String value",
"interfaceMappings" : {
"interfaceMapping" : {
"interfaceName" : "String value"
}
},
"mdnsProfileName" : "String value",
"quarantineInterface" : true
}
}
Sample XML Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/interfaceGroup
<?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/interfaceGroup" 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/interfaceGroup.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\/interfaceGroup",
"@responseType" : "operation",
"jobInformation" : {
"jobName" : "String value",
"jobType" : "String value"
}
}
}
POST
POST wlanProvisioning/interfaceGroup
Schedules a job to create an interface group on a Wlan Controller.
Resource URL
/webacs/api/v1/op/wlanProvisioning/interfaceGroup
Since : 2.2
Request Payload Parameters
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.
|
String
|
interfaceGroupDescription
|
A description of the interface group. Optional.
|
String
|
interfaceGroupName
|
Names the interface group.
|
InterfaceMapping[]
|
interfaceMappings
|
The list of interfaces mapped into this interface group.
|
String
|
interfaceName
|
The name of the interface mapped into the interface group.
|
|
String
|
mdnsProfileName
|
The mDNS profile name for this group. Optional, defaults to none.
|
Boolean
|
quarantineInterface
|
Is a quarantine VLAN enabled? If true, ensure all interfaces mapped to this group are quarantine interfaces; if false, ensure all interfaces mapped to this group are non-quarantine interfaces. Optional, defaults to false.
|
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/interfaceGroup
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<interfaceGroup>
<controllerId>15</controllerId>
<controllerName>String value</controllerName>
<interfaceGroupDescription>String value</interfaceGroupDescription>
<interfaceGroupName>String value</interfaceGroupName>
<interfaceMappings>
<interfaceMapping>
<interfaceName>String value</interfaceName>
</interfaceMapping>
</interfaceMappings>
<mdnsProfileName>String value</mdnsProfileName>
<quarantineInterface>true</quarantineInterface>
</interfaceGroup>
Sample JSON Request Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/interfaceGroup.json
{
"interfaceGroup" : {
"controllerId" : 15,
"controllerName" : "String value",
"interfaceGroupDescription" : "String value",
"interfaceGroupName" : "String value",
"interfaceMappings" : {
"interfaceMapping" : {
"interfaceName" : "String value"
}
},
"mdnsProfileName" : "String value",
"quarantineInterface" : true
}
}
Sample XML Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/wlanProvisioning/interfaceGroup
<?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/interfaceGroup" 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/interfaceGroup.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\/interfaceGroup",
"@responseType" : "operation",
"jobInformation" : {
"jobName" : "String value",
"jobType" : "String value"
}
}
}