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

PUT wlanProvisioning/apGroup

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 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 URL

/webacs/api/v1/op/wlanProvisioning/apGroup

Request Payload Parameters

Type Attribute Name Description

String

apGroupDescription

Describes the AP group. Optional.

String

apGroupName

Names the AP group.

ApGroupWlanDTO[]

apGroupProfileMappings

The collection of Wlan Profile mappings.

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

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/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>
  </apGroupProfileMappings>
  <apMembers>
    <apMember>15</apMember>
  </apMembers>
</apGroupMembershipDTO>

Sample JSON Request Payload

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

<?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/apGroup.json

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