Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET_WlanControllers

GET WlanControllers

Resource Information

Rate Limiting?

 Yes

Sorting?

 Yes

Paging?

 Yes

Filtering?

 Yes

Response Formats

xml

json

HTTP Methods

GET

Represents summary information about a WLAN controller.

Resource URL

/webacs/api/v1/data/WlanControllers

Since : 1.2

Response Parameters

Type Attribute Name Description

AlarmSeverityEnum

alarmStatus

Allowed values:

  • CRITICAL
  • MAJOR
  • MINOR
  • WARNING
  • CLEARED
  • INFORMATION

int

apCount

number of access

AuditStatusEnum

auditStatus

Audit status

Allowed values:

  • NA
  • MISMATCH
  • IDENTICAL
  • UNREACHABLE

boolean

autoRefresh

auto refresh state

int

clientCount

number of clients associated with the controller

String

contact

contact

String

ipAddress

management IP address of the WLAN controller

String

lastBackup

String

location

device location set in MIB2

String

mobilityGroupName

Mobility group name

String

name

device name

boolean

reachabilityStatus

SNMP reachability

String

rfGroupName

RF group name

String

softwareVersion

software version running on the controller

String

type

device type

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 Payload

https://192.168.116.207/webacs/api/v1/data/WlanControllers/42

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/WlanControllers/42" responseType="getEntity">
    <entity url="/webacs/data/className/15" type="className" dtoType="wlanControllersDTO_$$_javassist_5945">
        <wlanControllersDTO id="15" displayName="String value">
            <alarmStatus>CRITICAL</alarmStatus>
            <apCount>1</apCount>
            <auditStatus>NA</auditStatus>
            <autoRefresh>true</autoRefresh>
            <clientCount>1</clientCount>
            <contact>String value</contact>
            <ipAddress>String value</ipAddress>
            <lastBackup>String value</lastBackup>
            <location>String value</location>
            <mobilityGroupName>String value</mobilityGroupName>
            <name>String value</name>
            <reachabilityStatus>true</reachabilityStatus>
            <rfGroupName>String value</rfGroupName>
            <softwareVersion>String value</softwareVersion>
            <type>String value</type>
        </wlanControllersDTO>
    </entity>
</queryResponse>

Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/WlanControllers/42.json

{
  "queryResponse" : {
    "@rootUrl" : "\/webacs\/data",
    "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/WlanControllers\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "\/webacs\/data\/className\/15",
      "@type" : "className",
      "@dtoType" : "wlanControllersDTO_$$_javassist_5945",
      "wlanControllersDTO" : {
        "@id" : "15",
        "@displayName" : "String value",
        "alarmStatus" : "CRITICAL",
        "apCount" : 1,
        "auditStatus" : "NA",
        "autoRefresh" : true,
        "clientCount" : 1,
        "contact" : "String value",
        "ipAddress" : "String value",
        "lastBackup" : "String value",
        "location" : "String value",
        "mobilityGroupName" : "String value",
        "name" : "String value",
        "reachabilityStatus" : true,
        "rfGroupName" : "String value",
        "softwareVersion" : "String value",
        "type" : "String value"
      }
    }
  }
}