Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

PUT wlanProvisioning/interfaceGroup

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

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.

Since Product Version: 2.2

Resource URL

/webacs/api/v1/op/wlanProvisioning/interfaceGroup

Request Payload Parameters

Type Attribute Name Description

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

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

Type Attribute Name Description

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://172.25.123.114/webacs/api/v1/op/wlanProvisioning/interfaceGroup

<?xml version="1.0" ?>
<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://172.25.123.114/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://172.25.123.114/webacs/api/v1/op/wlanProvisioning/interfaceGroup

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <jobInformation>
    <jobName>String value</jobName>
    <jobType>String value</jobType>
  </jobInformation>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/wlanProvisioning/interfaceGroup.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/wlanProvisioning\/interfaceGroup",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "jobInformation" : {
      "jobName" : "String value",
      "jobType" : "String value"
    }
  }
}