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

GET WlanControllerDetails

Represents detail information about a WLAN controller.

Since Product Version: 1.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

Yes

Aggregation?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v4/data/WlanControllerDetails

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Updated

Since version 4 type of macAddress attribute is MacAddress instead of String, type of lastBackup attribute is Date, and type of capwapTransportMode attribute is enum. Type of gigCardSupported, cryptoCard1Supported, cryptoCard2Supported has been changed to boolean.

Response Parameters

Attribute Description

alarmStatus AlarmSeverityEnum

Alarm status

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

apCount int

Number of access points associated with the controller

apGroups Arrow image WLCApGroups[]

AP groups and their profiles for this device.

apLimit long

Number of access points supported by the controller.

auditStatus AuditStatusEnum

Audit status

  • NA
  • MISMATCH
  • IDENTICAL
  • UNREACHABLE

autoRefresh boolean

Auto refresh state

capwapTransportMode LwappTransportModeEnum

Current CAPWAP transport mode

  • LAYER2
  • LAYER3

cdpNeighbors Arrow image WLCCDPNeighbor[]

CDP neighbors for this controller.

contact String

System contact

cryptoCard1Supported boolean

Crypto Card One is present

cryptoCard2Supported boolean

Crypto Card Two is present

dot11aClientCount int

Number of 802.11a/n clients associated with the controller

dot11bClientCount int

Number of 802.11bgn clients associated with the controller

gigCardSupported boolean

Gig Ethernet/Fiber Card is present

interfaceGroups Arrow image WLCInterfaceGroups[]

Interface groups for this device.

interfaces Arrow image WLCInterfaces[]

Interfaces for this device.

ipAddress String

Management IP address of the WLAN controller

lastBackup Date

The latest backup time. Null if no backup were taken.

Note: The date has an incorrect UTC offset. Please see the FAQ for details.

localNetUserRoles Arrow image LocalNetUserRole[]

User roles for this device.

location String

Device location set in MIB2

macAddress MacAddress

Burned-in MAC address

mobilityGroupName String

Mobility group name

modelNumber String

Model number

name String

Device name

numberOfAPsSupported int

Number of APs supported

ports Arrow image WLCPorts[]

Represents port information for this controller.

productDescription String

Product description

reachabilityStatus boolean

SNMP reachability

redundancy RedundancyStatusEnum

Redundancy status

  • DISABLED
  • ENABLED
  • PAIRED
  • NOT_AVAILABLE

rfGroupName String

RF group name

serialNumber String

Serial number

softwareVersion String

Software version running on the controller

type String

Device type

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 Payload

https://10.64.88.203/webacs/api/v4/data/WlanControllerDetails/15

<?xml version="1.0" ?>
<queryResponse type="WlanControllerDetails" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/WlanControllerDetails/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
  <entity dtoType="wlanControllerDetailsDTO" type="WlanControllerDetails" url="https://10.64.88.203/webacs/api/v4/data/WlanControllerDetails/15">
    <wlanControllerDetailsDTO displayName="String value" id="15" uuid="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>
              <ssid>String value</ssid>
            </apGroupProfileMapping>
            <apGroupProfileMapping>
              <interfaceName>Another string value</interfaceName>
              <nacOverrideSupport>false</nacOverrideSupport>
              <profileName>Another string value</profileName>
              <ssid>Another string value</ssid>
            </apGroupProfileMapping>
          </apGroupProfileMappings>
        </apGroup>
        <apGroup>
          <apGroupDescription>Another string value</apGroupDescription>
          <apGroupName>Another string value</apGroupName>
          <apGroupProfileMappings>
            <apGroupProfileMapping>
              <interfaceName>String value</interfaceName>
              <nacOverrideSupport>true</nacOverrideSupport>
              <profileName>String value</profileName>
              <ssid>String value</ssid>
            </apGroupProfileMapping>
            <apGroupProfileMapping>
              <interfaceName>Another string value</interfaceName>
              <nacOverrideSupport>false</nacOverrideSupport>
              <profileName>Another string value</profileName>
              <ssid>Another string value</ssid>
            </apGroupProfileMapping>
          </apGroupProfileMappings>
        </apGroup>
      </apGroups>
      <apLimit>2</apLimit>
      <auditStatus>NA</auditStatus>
      <autoRefresh>true</autoRefresh>
      <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>
        <cdpNeighbor>
          <duplexMode>UNKNOWN</duplexMode>
          <farEndInterface>Another string value</farEndInterface>
          <interfaceIndex>11</interfaceIndex>
          <nearEndInterface>Another string value</nearEndInterface>
          <neighborCapabilities>Another string value</neighborCapabilities>
          <neighborDeviceName>Another string value</neighborDeviceName>
          <neighborDevicePlatformType>Another string value</neighborDevicePlatformType>
          <neighborVersion>Another string value</neighborVersion>
        </cdpNeighbor>
      </cdpNeighbors>
      <contact>String value</contact>
      <dot11aClientCount>1</dot11aClientCount>
      <dot11bClientCount>1</dot11bClientCount>
      <interfaceGroups>
        <interfaceGroup>
          <interfaceGroupDescription>String value</interfaceGroupDescription>
          <interfaceGroupName>String value</interfaceGroupName>
          <interfaceMappings>
            <interfaceMapping>
              <interfaceName>String value</interfaceName>
            </interfaceMapping>
            <interfaceMapping>
              <interfaceName>Another string value</interfaceName>
            </interfaceMapping>
          </interfaceMappings>
          <mdnsProfileName>String value</mdnsProfileName>
          <quarantineInterface>true</quarantineInterface>
        </interfaceGroup>
        <interfaceGroup>
          <interfaceGroupDescription>Another string value</interfaceGroupDescription>
          <interfaceGroupName>Another string value</interfaceGroupName>
          <interfaceMappings>
            <interfaceMapping>
              <interfaceName>String value</interfaceName>
            </interfaceMapping>
            <interfaceMapping>
              <interfaceName>Another string value</interfaceName>
            </interfaceMapping>
          </interfaceMappings>
          <mdnsProfileName>Another string value</mdnsProfileName>
          <quarantineInterface>false</quarantineInterface>
        </interfaceGroup>
      </interfaceGroups>
      <interfaces>
        <interface>
          <aclName>String value</aclName>
          <dhcpOption82Enabled>true</dhcpOption82Enabled>
          <dhcpProtocolEnabled>true</dhcpProtocolEnabled>
          <dnsHostname>String value</dnsHostname>
          <gateway>
            <address>192.168.115.243</address>
          </gateway>
          <interfaceApManagementEnabled>true</interfaceApManagementEnabled>
          <interfaceName>String value</interfaceName>
          <interfaceType>STATIC</interfaceType>
          <ipAddress>
            <address>192.168.115.243</address>
          </ipAddress>
          <isGuestLan>true</isGuestLan>
          <macAddress>
            <octets>000a959d6816</octets>
          </macAddress>
          <mdnsProfileName>String value</mdnsProfileName>
          <netMask>
            <address>192.168.115.243</address>
          </netMask>
          <portNum>1</portNum>
          <primaryDhcpAddress>
            <address>192.168.115.243</address>
          </primaryDhcpAddress>
          <quarantineInterface>true</quarantineInterface>
          <quarantineVlanId>1</quarantineVlanId>
          <secondaryDhcpAddress>
            <address>192.168.115.243</address>
          </secondaryDhcpAddress>
          <secondaryPortNum>1</secondaryPortNum>
          <vlanId>1</vlanId>
        </interface>
        <interface>
          <aclName>Another string value</aclName>
          <dhcpOption82Enabled>false</dhcpOption82Enabled>
          <dhcpProtocolEnabled>false</dhcpProtocolEnabled>
          <dnsHostname>Another string value</dnsHostname>
          <gateway>
            <address>192.168.115.244</address>
          </gateway>
          <interfaceApManagementEnabled>false</interfaceApManagementEnabled>
          <interfaceName>Another string value</interfaceName>
          <interfaceType>DYNAMIC</interfaceType>
          <ipAddress>
            <address>192.168.115.244</address>
          </ipAddress>
          <isGuestLan>false</isGuestLan>
          <macAddress>
            <octets>000a959d6817</octets>
          </macAddress>
          <mdnsProfileName>Another string value</mdnsProfileName>
          <netMask>
            <address>192.168.115.244</address>
          </netMask>
          <portNum>11</portNum>
          <primaryDhcpAddress>
            <address>192.168.115.244</address>
          </primaryDhcpAddress>
          <quarantineInterface>false</quarantineInterface>
          <quarantineVlanId>11</quarantineVlanId>
          <secondaryDhcpAddress>
            <address>192.168.115.244</address>
          </secondaryDhcpAddress>
          <secondaryPortNum>11</secondaryPortNum>
          <vlanId>11</vlanId>
        </interface>
      </interfaces>
      <ipAddress>String value</ipAddress>
      <localNetUserRoles>
        <localNetUserRole>
          <roleName>String value</roleName>
        </localNetUserRole>
        <localNetUserRole>
          <roleName>Another string value</roleName>
        </localNetUserRole>
      </localNetUserRoles>
      <location>String value</location>
      <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>
        <port>
          <adminStatus>ENABLED</adminStatus>
          <desiredDuplexMode>AUTONEGOTIATE</desiredDuplexMode>
          <portNumber>11</portNumber>
        </port>
      </ports>
      <productDescription>String value</productDescription>
      <reachabilityStatus>true</reachabilityStatus>
      <redundancy>DISABLED</redundancy>
      <rfGroupName>String value</rfGroupName>
      <serialNumber>String value</serialNumber>
      <softwareVersion>String value</softwareVersion>
      <type>String value</type>
      <capwapTransportMode>LAYER2</capwapTransportMode>
      <cryptoCard1Supported>true</cryptoCard1Supported>
      <cryptoCard2Supported>true</cryptoCard2Supported>
      <gigCardSupported>true</gigCardSupported>
      <lastBackup>1986-07-24T00:00:00+05:30</lastBackup>
      <macAddress>
        <octets>000a959d6816</octets>
      </macAddress>
    </wlanControllerDetailsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/WlanControllerDetails/15.json

{
  "queryResponse" : {
    "@type" : "WlanControllerDetails",
    "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/WlanControllerDetails/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
    "entity" : [ {
      "@dtoType" : "wlanControllerDetailsDTO",
      "@type" : "WlanControllerDetails",
      "@url" : "https://10.64.88.203/webacs/api/v4/data/WlanControllerDetails/15",
      "wlanControllerDetailsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "alarmStatus" : "CRITICAL",
        "apCount" : 1,
        "apGroups" : {
          "apGroup" : [ {
            "apGroupDescription" : "String value",
            "apGroupName" : "String value",
            "apGroupProfileMappings" : {
              "apGroupProfileMapping" : [ {
                "interfaceName" : "String value",
                "nacOverrideSupport" : true,
                "profileName" : "String value",
                "ssid" : "String value"
              }, {
                "interfaceName" : "Another string value",
                "nacOverrideSupport" : false,
                "profileName" : "Another string value",
                "ssid" : "Another string value"
              } ]
            }
          }, {
            "apGroupDescription" : "Another string value",
            "apGroupName" : "Another string value",
            "apGroupProfileMappings" : {
              "apGroupProfileMapping" : [ {
                "interfaceName" : "String value",
                "nacOverrideSupport" : true,
                "profileName" : "String value",
                "ssid" : "String value"
              }, {
                "interfaceName" : "Another string value",
                "nacOverrideSupport" : false,
                "profileName" : "Another string value",
                "ssid" : "Another string value"
              } ]
            }
          } ]
        },
        "apLimit" : 2,
        "auditStatus" : "NA",
        "autoRefresh" : true,
        "capwapTransportMode" : "LAYER2",
        "cdpNeighbors" : {
          "cdpNeighbor" : [ {
            "duplexMode" : "NA",
            "farEndInterface" : "String value",
            "interfaceIndex" : 1,
            "nearEndInterface" : "String value",
            "neighborCapabilities" : "String value",
            "neighborDeviceName" : "String value",
            "neighborDevicePlatformType" : "String value",
            "neighborVersion" : "String value"
          }, {
            "duplexMode" : "UNKNOWN",
            "farEndInterface" : "Another string value",
            "interfaceIndex" : 11,
            "nearEndInterface" : "Another string value",
            "neighborCapabilities" : "Another string value",
            "neighborDeviceName" : "Another string value",
            "neighborDevicePlatformType" : "Another string value",
            "neighborVersion" : "Another string value"
          } ]
        },
        "contact" : "String value",
        "cryptoCard1Supported" : true,
        "cryptoCard2Supported" : true,
        "dot11aClientCount" : 1,
        "dot11bClientCount" : 1,
        "gigCardSupported" : true,
        "interfaceGroups" : {
          "interfaceGroup" : [ {
            "interfaceGroupDescription" : "String value",
            "interfaceGroupName" : "String value",
            "interfaceMappings" : {
              "interfaceMapping" : [ {
                "interfaceName" : "String value"
              }, {
                "interfaceName" : "Another string value"
              } ]
            },
            "mdnsProfileName" : "String value",
            "quarantineInterface" : true
          }, {
            "interfaceGroupDescription" : "Another string value",
            "interfaceGroupName" : "Another string value",
            "interfaceMappings" : {
              "interfaceMapping" : [ {
                "interfaceName" : "String value"
              }, {
                "interfaceName" : "Another string value"
              } ]
            },
            "mdnsProfileName" : "Another string value",
            "quarantineInterface" : false
          } ]
        },
        "interfaces" : {
          "interface" : [ {
            "aclName" : "String value",
            "dhcpOption82Enabled" : true,
            "dhcpProtocolEnabled" : true,
            "dnsHostname" : "String value",
            "gateway" : {
              "address" : "192.168.115.243"
            },
            "interfaceApManagementEnabled" : true,
            "interfaceName" : "String value",
            "interfaceType" : "STATIC",
            "ipAddress" : {
              "address" : "192.168.115.243"
            },
            "isGuestLan" : true,
            "macAddress" : {
              "octets" : "000a959d6816"
            },
            "mdnsProfileName" : "String value",
            "netMask" : {
              "address" : "192.168.115.243"
            },
            "portNum" : 1,
            "primaryDhcpAddress" : {
              "address" : "192.168.115.243"
            },
            "quarantineInterface" : true,
            "quarantineVlanId" : 1,
            "secondaryDhcpAddress" : {
              "address" : "192.168.115.243"
            },
            "secondaryPortNum" : 1,
            "vlanId" : 1
          }, {
            "aclName" : "Another string value",
            "dhcpOption82Enabled" : false,
            "dhcpProtocolEnabled" : false,
            "dnsHostname" : "Another string value",
            "gateway" : {
              "address" : "192.168.115.244"
            },
            "interfaceApManagementEnabled" : false,
            "interfaceName" : "Another string value",
            "interfaceType" : "DYNAMIC",
            "ipAddress" : {
              "address" : "192.168.115.244"
            },
            "isGuestLan" : false,
            "macAddress" : {
              "octets" : "000a959d6817"
            },
            "mdnsProfileName" : "Another string value",
            "netMask" : {
              "address" : "192.168.115.244"
            },
            "portNum" : 11,
            "primaryDhcpAddress" : {
              "address" : "192.168.115.244"
            },
            "quarantineInterface" : false,
            "quarantineVlanId" : 11,
            "secondaryDhcpAddress" : {
              "address" : "192.168.115.244"
            },
            "secondaryPortNum" : 11,
            "vlanId" : 11
          } ]
        },
        "ipAddress" : "String value",
        "lastBackup" : "1986-07-23T18:30:00.000Z",
        "localNetUserRoles" : {
          "localNetUserRole" : [ {
            "roleName" : "String value"
          }, {
            "roleName" : "Another string value"
          } ]
        },
        "location" : "String value",
        "macAddress" : {
          "octets" : "000a959d6816"
        },
        "mobilityGroupName" : "String value",
        "modelNumber" : "String value",
        "name" : "String value",
        "numberOfAPsSupported" : 1,
        "ports" : {
          "port" : [ {
            "adminStatus" : "UNKNOWN",
            "desiredDuplexMode" : "UNKNOWN",
            "portNumber" : 1
          }, {
            "adminStatus" : "ENABLED",
            "desiredDuplexMode" : "AUTONEGOTIATE",
            "portNumber" : 11
          } ]
        },
        "productDescription" : "String value",
        "reachabilityStatus" : true,
        "redundancy" : "DISABLED",
        "rfGroupName" : "String value",
        "serialNumber" : "String value",
        "softwareVersion" : "String value",
        "type" : "String value"
      }
    } ]
  }
}