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

GET Radios

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Represents a radio interface of an wireless access point.

Since Product Version: 1.2

Resource URL

/webacs/api/v1/data/Radios

Response Parameters

Type Attribute Name Description

RadioAdminStatusEnum

adminStatus

Administrative status of the radio interface

Allowed values:

  • UNKNOWN
  • ENABLE
  • DISABLE

String

apIpAddress

IP address of the access point

String

apName

Name of the access point

String

apType

Type of access point (CAPWAP or Autonomous)

String

baseRadioMac

Base radio MAC address

ChannelNumberEnum

channelNumber

current operational channel number

Allowed values:

  • UNKNOWN
  • _1
  • _2
  • _3
  • _4
  • _5
  • _6
  • _7
  • _8
  • _9
  • _10
  • _11
  • _12
  • _13
  • _14
  • _20
  • _21
  • _22
  • _23
  • _24
  • _25
  • _26
  • _34
  • _36
  • _38
  • _40
  • _42
  • _44
  • _46
  • _48
  • _52
  • _56
  • _60
  • _64
  • _100
  • _104
  • _108
  • _112
  • _116
  • _120
  • _124
  • _128
  • _132
  • _136
  • _140
  • _144
  • _149
  • _153
  • _157
  • _161
  • _165
  • _169
  • _173

String

clientCount

client count connected to the radio interface

String

controllerIpAddress

Registered controller IP address for CAPWAP AP only

String

ethernetMac

MAC address of the ethernet interface on the AP

String

instanceUuid

This is a uuid for this instance.

RadioOperStatusEnum

operStatus

operational status of the radio interface

Allowed values:

  • DOWN
  • UP
  • NOTASSOCIATED
  • UNKNOWN

Integer

powerLevel

power level of the radio

String

radioType

radio type (802.11a/b/g/n)

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://172.25.123.114/webacs/api/v1/data/Radios/15

<?xml version="1.0" ?>
<queryResponse type="Radios" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/Radios/15" rootUrl="https://172.25.123.114/webacs/api/v1/data">
  <entity dtoType="radiosDTO" type="Radios" url="https://172.25.123.114/webacs/api/v1/data/Radios/15">
    <radiosDTO displayName="String value" id="15" uuid="String value">
      <adminStatus>UNKNOWN</adminStatus>
      <apIpAddress>String value</apIpAddress>
      <apName>String value</apName>
      <apType>String value</apType>
      <baseRadioMac>String value</baseRadioMac>
      <channelNumber>UNKNOWN</channelNumber>
      <clientCount>String value</clientCount>
      <controllerIpAddress>String value</controllerIpAddress>
      <ethernetMac>String value</ethernetMac>
      <operStatus>DOWN</operStatus>
      <powerLevel>15</powerLevel>
      <radioType>String value</radioType>
    </radiosDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.25.123.114/webacs/api/v1/data/Radios/15.json

{
  "queryResponse" : {
    "@type" : "Radios",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Radios\/15",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "radiosDTO",
      "@type" : "Radios",
      "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Radios\/15",
      "radiosDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "adminStatus" : "UNKNOWN",
        "apIpAddress" : "String value",
        "apName" : "String value",
        "apType" : "String value",
        "baseRadioMac" : "String value",
        "channelNumber" : "UNKNOWN",
        "clientCount" : "String value",
        "controllerIpAddress" : "String value",
        "ethernetMac" : "String value",
        "operStatus" : "DOWN",
        "powerLevel" : 15,
        "radioType" : "String value"
      }
    }
  }
}