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

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.

Since Product Version: 2.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

Resource URL

/webacs/api/v3/op/wlanProvisioning/apGroup

Unmodified

This resource has not been modified since the previous API version.

Request Payload Parameters

Attribute Description

apGroupDescription String

Describes the AP group. Optional.

apGroupName String

Names the AP group.

apGroupProfileMappings Arrow image ApGroupWlanDTO[]

The collection of Wlan Profile mappings.

apMembers Long[]

The AP members of this group, identified by id.

controllerId Long

Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.

controllerName String

Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.

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://172.20.127.108/webacs/api/v3/op/wlanProvisioning/apGroup

<?xml version="1.0" ?>
<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>
    <apGroupProfileMapping>
      <interfaceName>Another string value</interfaceName>
      <nacOverride>false</nacOverride>
      <wlanProfileName>Another string value</wlanProfileName>
    </apGroupProfileMapping>
  </apGroupProfileMappings>
  <apMembers>
    <apMember>15</apMember>
    <apMember>25</apMember>
  </apMembers>
</apGroupMembershipDTO>

Sample JSON Request Payload

https://172.20.127.108/webacs/api/v3/op/wlanProvisioning/apGroup.json

{
  "apGroupMembershipDTO" : {
    "apGroupDescription" : "String value",
    "apGroupName" : "String value",
    "apGroupProfileMappings" : {
      "apGroupProfileMapping" : [ {
        "interfaceName" : "String value",
        "nacOverride" : true,
        "wlanProfileName" : "String value"
      }, {
        "interfaceName" : "Another string value",
        "nacOverride" : false,
        "wlanProfileName" : "Another string value"
      } ]
    },
    "apMembers" : {
      "apMember" : [ 15, 25 ]
    },
    "controllerId" : 15,
    "controllerName" : "String value"
  }
}

Sample XML Response Payload

https://172.20.127.108/webacs/api/v3/op/wlanProvisioning/apGroup

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

Sample JSON Response Payload

https://172.20.127.108/webacs/api/v3/op/wlanProvisioning/apGroup.json

{
  "mgmtResponse" : {
    "@requestUrl" : "../../../../pages/common/login.jsp.html",
    "@responseType" : "operation",
    "@rootUrl" : "https://172.20.127.108/webacs/api/v3/op",
    "jobInformation" : [ {
      "jobName" : "String value",
      "jobType" : "String value"
    } ]
  }
}