Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET_WlanControllerDetails

GET WlanControllerDetails

Resource Information

Rate Limiting?

 Yes

Sorting?

 Yes

Paging?

 Yes

Filtering?

 Yes

Response Formats

xml

json

HTTP Methods

GET

Represents detail information about a WLAN controller.

Resource URL

/webacs/api/v1/data/WlanControllerDetails

Since : 1.2

Response Parameters

Type Attribute Name Description

AlarmSeverityEnum

alarmStatus

Allowed values:

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

int

apCount

number of access

WLCApGroups[]

apGroups

AP groups and their profiles for this device.

AuditStatusEnum

auditStatus

Audit status

Allowed values:

  • NA
  • MISMATCH
  • IDENTICAL
  • UNREACHABLE

boolean

autoRefresh

auto refresh state

String

capwapTransportMode

Current CAPWAP transport mode

WLCCDPNeighbor[]

cdpNeighbors

CDP neighbors for this controller.

String

contact

contact

String

cryptoCard1Supported

Crypto Card One

String

cryptoCard2Supported

Crypto card two

int

dot11aClientCount

number of dot11a/n clients associated with the controller

int

dot11bClientCount

number of dot11bgn clients associated with the controller

String

gigCardSupported

Gig Ethernet/Fiber Card

String

ipAddress

management IP address of the WLAN controller

String

lastBackup

String

location

device location set in MIB2

String

macAddress

Burned-in MAC address

String

mobilityGroupName

Mobility group name

String

modelNumber

Model number

String

name

device name

int

numberOfAPsSupported

Number of APs supported

WLCPorts[]

ports

Represents port information for this controller.

String

productDescription

Product description

boolean

reachabilityStatus

SNMP reachability

String

rfGroupName

RF group name

String

serialNumber

Serial number

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/WlanControllerDetails/42

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/WlanControllerDetails/42" responseType="getEntity">
    <entity url="/webacs/data/className/15" type="className" dtoType="wlanControllerDetailsDTO_$$_javassist_5947">
        <wlanControllerDetailsDTO id="15" displayName="String value">
            <alarmStatus>CRITICAL</alarmStatus>
            <apCount>1</apCount>
            <apGroups>
                <apGroup>
                    <apGroupDescription>String value</apGroupDescription>
                    <apGroupName>String value</apGroupName>
                    <apGroupProfileMappings>
                        <apGroupProfileMapping>
                            <interfaceName>String value</interfaceName>
                            <nacOverrideSupport>true</nacOverrideSupport>
                            <profileName>String value</profileName>
                        </apGroupProfileMapping>
                    </apGroupProfileMappings>
                </apGroup>
            </apGroups>
            <auditStatus>NA</auditStatus>
            <autoRefresh>true</autoRefresh>
            <capwapTransportMode>String value</capwapTransportMode>
            <cdpNeighbors>
                <cdpNeighbor>
                    <duplexMode>NA</duplexMode>
                    <farEndInterface>String value</farEndInterface>
                    <interfaceIndex>1</interfaceIndex>
                    <nearEndInterface>String value</nearEndInterface>
                    <neighborCapabilities>String value</neighborCapabilities>
                    <neighborDeviceName>String value</neighborDeviceName>
                    <neighborDevicePlatformType>String value</neighborDevicePlatformType>
                    <neighborVersion>String value</neighborVersion>
                </cdpNeighbor>
            </cdpNeighbors>
            <contact>String value</contact>
            <cryptoCard1Supported>String value</cryptoCard1Supported>
            <cryptoCard2Supported>String value</cryptoCard2Supported>
            <dot11aClientCount>1</dot11aClientCount>
            <dot11bClientCount>1</dot11bClientCount>
            <gigCardSupported>String value</gigCardSupported>
            <ipAddress>String value</ipAddress>
            <lastBackup>String value</lastBackup>
            <location>String value</location>
            <macAddress>String value</macAddress>
            <mobilityGroupName>String value</mobilityGroupName>
            <modelNumber>String value</modelNumber>
            <name>String value</name>
            <numberOfAPsSupported>1</numberOfAPsSupported>
            <ports>
                <port>
                    <adminStatus>UNKNOWN</adminStatus>
                    <desiredDuplexMode>UNKNOWN</desiredDuplexMode>
                    <portNumber>1</portNumber>
                </port>
            </ports>
            <productDescription>String value</productDescription>
            <reachabilityStatus>true</reachabilityStatus>
            <rfGroupName>String value</rfGroupName>
            <serialNumber>String value</serialNumber>
            <softwareVersion>String value</softwareVersion>
            <type>String value</type>
        </wlanControllerDetailsDTO>
    </entity>
</queryResponse>

Sample JSON Payload

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

{
  "queryResponse" : {
    "@rootUrl" : "\/webacs\/data",
    "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/WlanControllerDetails\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "\/webacs\/data\/className\/15",
      "@type" : "className",
      "@dtoType" : "wlanControllerDetailsDTO_$$_javassist_5947",
      "wlanControllerDetailsDTO" : {
        "@id" : "15",
        "@displayName" : "String value",
        "alarmStatus" : "CRITICAL",
        "apCount" : 1,
        "apGroups" : {
          "apGroup" : {
            "apGroupDescription" : "String value",
            "apGroupName" : "String value",
            "apGroupProfileMappings" : {
              "apGroupProfileMapping" : {
                "interfaceName" : "String value",
                "nacOverrideSupport" : true,
                "profileName" : "String value"
              }
            }
          }
        },
        "auditStatus" : "NA",
        "autoRefresh" : true,
        "capwapTransportMode" : "String value",
        "cdpNeighbors" : {
          "cdpNeighbor" : {
            "duplexMode" : "NA",
            "farEndInterface" : "String value",
            "interfaceIndex" : 1,
            "nearEndInterface" : "String value",
            "neighborCapabilities" : "String value",
            "neighborDeviceName" : "String value",
            "neighborDevicePlatformType" : "String value",
            "neighborVersion" : "String value"
          }
        },
        "contact" : "String value",
        "cryptoCard1Supported" : "String value",
        "cryptoCard2Supported" : "String value",
        "dot11aClientCount" : 1,
        "dot11bClientCount" : 1,
        "gigCardSupported" : "String value",
        "ipAddress" : "String value",
        "lastBackup" : "String value",
        "location" : "String value",
        "macAddress" : "String value",
        "mobilityGroupName" : "String value",
        "modelNumber" : "String value",
        "name" : "String value",
        "numberOfAPsSupported" : 1,
        "ports" : {
          "port" : {
            "adminStatus" : "UNKNOWN",
            "desiredDuplexMode" : "UNKNOWN",
            "portNumber" : 1
          }
        },
        "productDescription" : "String value",
        "reachabilityStatus" : true,
        "rfGroupName" : "String value",
        "serialNumber" : "String value",
        "softwareVersion" : "String value",
        "type" : "String value"
      }
    }
  }
}