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

# GET WlanControllers

Represents summary information about a WLAN controller.

Since Product Version: 1.2

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/data/WlanControllers

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

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
alarmStatus AlarmSeverityEnum | Alarm status Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION
apCount int | Number of access points associated with the controller
auditStatus AuditStatusEnum | Audit status Allowed values NA MISMATCH IDENTICAL UNREACHABLE
autoRefresh boolean | Auto refresh state
clientCount int | Number of clients associated with the controller
contact String | System contact
ipAddress String | Management IP address of the WLAN controller
lastBackup String | The latest backup time, as milliseconds from the Unix epoch. Zero if no backup were taken
location String | Device location set in MIB2
mobilityGroupName String | Mobility group name
name String | Device name
reachabilityStatus boolean | SNMP reachability
rfGroupName String | RF group name
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/v1/data/WlanControllers/15

    <?xml version="1.0" ?>
    <queryResponse type="WlanControllers" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/WlanControllers/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="wlanControllersDTO" type="WlanControllers" url="https://10.64.88.203/webacs/api/v1/data/WlanControllers/15">
        <wlanControllersDTO displayName="String value" id="15" uuid="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>
          <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>
          <lastBackup>String value</lastBackup>
        </wlanControllersDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v1/data/WlanControllers/15.json

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

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/data/WlanControllers

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

Unmodified

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

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
alarmStatus AlarmSeverityEnum | Alarm status Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION
apCount int | Number of access points associated with the controller
auditStatus AuditStatusEnum | Audit status Allowed values NA MISMATCH IDENTICAL UNREACHABLE
autoRefresh boolean | Auto refresh state
clientCount int | Number of clients associated with the controller
contact String | System contact
ipAddress String | Management IP address of the WLAN controller
lastBackup String | The latest backup time, as milliseconds from the Unix epoch. Zero if no backup were taken
location String | Device location set in MIB2
mobilityGroupName String | Mobility group name
name String | Device name
reachabilityStatus boolean | SNMP reachability
rfGroupName String | RF group name
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/v2/data/WlanControllers/15

    <?xml version="1.0" ?>
    <queryResponse type="WlanControllers" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/WlanControllers/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="wlanControllersDTO" type="WlanControllers" url="https://10.64.88.203/webacs/api/v2/data/WlanControllers/15">
        <wlanControllersDTO displayName="String value" id="15" uuid="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>
          <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>
          <lastBackup>String value</lastBackup>
        </wlanControllersDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v2/data/WlanControllers/15.json

    {
      "queryResponse" : {
        "@type" : "WlanControllers",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/WlanControllers/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "wlanControllersDTO",
          "@type" : "WlanControllers",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/WlanControllers/15",
          "wlanControllersDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "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"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/data/WlanControllers

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

Unmodified

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

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
alarmStatus AlarmSeverityEnum | Alarm status Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION
apCount int | Number of access points associated with the controller
auditStatus AuditStatusEnum | Audit status Allowed values NA MISMATCH IDENTICAL UNREACHABLE
autoRefresh boolean | Auto refresh state
clientCount int | Number of clients associated with the controller
contact String | System contact
ipAddress String | Management IP address of the WLAN controller
lastBackup String | The latest backup time, as milliseconds from the Unix epoch. Zero if no backup were taken
location String | Device location set in MIB2
mobilityGroupName String | Mobility group name
name String | Device name
reachabilityStatus boolean | SNMP reachability
rfGroupName String | RF group name
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/v3/data/WlanControllers/15

    <?xml version="1.0" ?>
    <queryResponse type="WlanControllers" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/WlanControllers/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="wlanControllersDTO" type="WlanControllers" url="https://10.64.88.203/webacs/api/v3/data/WlanControllers/15">
        <wlanControllersDTO displayName="String value" id="15" uuid="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>
          <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>
          <lastBackup>String value</lastBackup>
        </wlanControllersDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v3/data/WlanControllers/15.json

    {
      "queryResponse" : {
        "@type" : "WlanControllers",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/WlanControllers/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "wlanControllersDTO",
          "@type" : "WlanControllers",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/WlanControllers/15",
          "wlanControllersDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "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"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/WlanControllers

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 lastBackup attribute is Date instead of String.

## Response Parameters

Attribute | Description
--- | ---
alarmStatus AlarmSeverityEnum | Alarm status Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION
apCount int | Number of access points associated with the controller
auditStatus AuditStatusEnum | Audit status Allowed values NA MISMATCH IDENTICAL UNREACHABLE
autoRefresh boolean | Auto refresh state
clientCount int | Number of clients associated with the controller
contact String | System contact
ipAddress String | Management IP address of the WLAN controller
lastBackup Date | The latest backup time. Null if no backup were taken
location String | Device location set in MIB2
mobilityGroupName String | Mobility group name
name String | Device name
reachabilityStatus boolean | SNMP reachability
rfGroupName String | RF group name
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/WlanControllers/15

    <?xml version="1.0" ?>
    <queryResponse type="WlanControllers" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/WlanControllers/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="wlanControllersDTO" type="WlanControllers" url="https://10.64.88.203/webacs/api/v4/data/WlanControllers/15">
        <wlanControllersDTO displayName="String value" id="15" uuid="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>
          <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>
          <lastBackup>1986-07-24T00:00:00+05:30</lastBackup>
        </wlanControllersDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "WlanControllers",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/WlanControllers/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "wlanControllersDTO",
          "@type" : "WlanControllers",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/WlanControllers/15",
          "wlanControllersDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "alarmStatus" : "CRITICAL",
            "apCount" : 1,
            "auditStatus" : "NA",
            "autoRefresh" : true,
            "clientCount" : 1,
            "contact" : "String value",
            "ipAddress" : "String value",
            "lastBackup" : "1986-07-23T18:30:00.000Z",
            "location" : "String value",
            "mobilityGroupName" : "String value",
            "name" : "String value",
            "reachabilityStatus" : true,
            "rfGroupName" : "String value",
            "softwareVersion" : "String value",
            "type" : "String value"
          }
        } ]
      }
    }