Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET_Radios

GET Radios

Resource Information

Rate Limiting?

 Yes

Sorting?

 Yes

Paging?

 Yes

Filtering?

 Yes

Response Formats

xml

json

HTTP Methods

GET

Represents a radio interface of an wireless access point.

Resource URL

/webacs/api/v1/data/Radios

Since : 1.2

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
  • _149
  • _153
  • _157
  • _161
  • _165
  • _169
  • _173

String

clientCount

client count connected to the radio interafce

String

controllerIpAddress

Resgistered controller IP address for CAPWAP AP only

String

ethernetMac

MAC address of the ethernet interface on the AP

RadioOperStatusEnum

operStatus

operational status of the radio interface

Allowed values:

  • DOWN
  • UP
  • NOTASSOCIATED
  • UNKNOWN

int

powerLevel

power level of the radio

String

radioType

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

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/Radios/42" responseType="getEntity">
    <entity url="/webacs/data/className/15" type="className" dtoType="radiosDTO_$$_javassist_5971">
        <radiosDTO id="15" displayName="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>1</powerLevel>
            <radioType>String value</radioType>
        </radiosDTO>
    </entity>
</queryResponse>

Sample JSON Payload

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

{
  "queryResponse" : {
    "@rootUrl" : "\/webacs\/data",
    "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/Radios\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "\/webacs\/data\/className\/15",
      "@type" : "className",
      "@dtoType" : "radiosDTO_$$_javassist_5971",
      "radiosDTO" : {
        "@id" : "15",
        "@displayName" : "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" : 1,
        "radioType" : "String value"
      }
    }
  }
}