Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET RadioDetails

Represents detail information of a radio interfaces on lightweight access point.

Since Product Version: 1.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v3/data/RadioDetails

Unmodified

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

Response Parameters

Attribute Description

adminStatus RadioAdminStatusEnum

Administrative status of the radio interface

Allowed values:

  • UNKNOWN
  • ENABLE
  • DISABLE

alarmStatus AlarmSeverityEnum

Allowed values:

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

antennaAzimAngle Float

Displays the horizontal angle of the antenna

antennaDiversity String

Displays if antenna diversity is enabled or disabled. Antenna diversity refers to the access point sampling the radio signal from two integrated antenna ports to choose the preferred antenna.

antennaElevAngle Float

Displays the elevation angle of the antenna.

antennaGain Integer

The external antenna gain, measured in 0.5 dBi units. This is the raw value from device. It is different from displayed in the UI. An integer value 7 means 7 x 0.5 = 3.5 dBm of gain.

antennaMode String

Displays the antenna mode such as Omni, Directional, or NA (non-applicable).

antennaName String

Antenna name

antennaType String

Antenna type (Internal or External)

apIpAddress String

IP address of the access point

apName String

Name of the access point

baseRadioMac String

Base radio MAC address

channelControl String

Radio channel control

channelNumber Integer

current operational channel number

channelWidth String

channel width

cleanAirCapable String

capability of clean air feature

cleanAirSensorStatus String

Clean air sensor status

cleanAirStatus String

Clean air status

clientCount String

client count connected to the radio interface

controllerIpAddress String

Resgistered controller IP address for CAPWAP AP only

dot11nCapable boolean

802.11n capability

ethernetMac String

MAC address of the ethernet interface on the AP

operStatus RadioOperStatusEnum

operational status of the radio interface

Allowed values:

  • DOWN
  • UP
  • NOTASSOCIATED
  • UNKNOWN

port int

controller port number

powerLevel Integer

power level of the radio

radioRole RadioRoleEnum

Radio role

Allowed values:

  • SHUTDOWN
  • UPDOWNLINK
  • UPLINK
  • DOWNLINK
  • ACCESS
  • UPLINKACCESS
  • DOWNLINKACCESS
  • UPDOWNLINKACCESS
  • NOTAPPLICABLE

radioType String

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

slotId Integer

slot ID of the radio in the AP

txPowerControl String

Tranmission power control

txPowerOutput Integer

The txPower currently being used to transmit data, in dBm

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://localhost/webacs/api/v3/data/RadioDetails/15

<?xml version="1.0" ?>
<queryResponse type="RadioDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/RadioDetails/15" rootUrl="https://localhost/webacs/api/v3/data">
  <entity dtoType="radioDetailsDTO" type="RadioDetails" url="https://localhost/webacs/api/v3/data/RadioDetails/15">
    <radioDetailsDTO displayName="String value" id="15" uuid="String value">
      <adminStatus>UNKNOWN</adminStatus>
      <alarmStatus>CRITICAL</alarmStatus>
      <antennaAzimAngle>15.0</antennaAzimAngle>
      <antennaDiversity>String value</antennaDiversity>
      <antennaElevAngle>15.0</antennaElevAngle>
      <antennaGain>15</antennaGain>
      <antennaMode>String value</antennaMode>
      <antennaName>String value</antennaName>
      <antennaType>String value</antennaType>
      <apIpAddress>String value</apIpAddress>
      <apName>String value</apName>
      <baseRadioMac>String value</baseRadioMac>
      <channelControl>String value</channelControl>
      <channelNumber>15</channelNumber>
      <channelWidth>String value</channelWidth>
      <cleanAirCapable>String value</cleanAirCapable>
      <cleanAirSensorStatus>String value</cleanAirSensorStatus>
      <cleanAirStatus>String value</cleanAirStatus>
      <clientCount>String value</clientCount>
      <controllerIpAddress>String value</controllerIpAddress>
      <dot11nCapable>true</dot11nCapable>
      <ethernetMac>String value</ethernetMac>
      <operStatus>DOWN</operStatus>
      <port>1</port>
      <powerLevel>15</powerLevel>
      <radioRole>SHUTDOWN</radioRole>
      <radioType>String value</radioType>
      <slotId>15</slotId>
      <txPowerControl>String value</txPowerControl>
      <txPowerOutput>15</txPowerOutput>
    </radioDetailsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v3/data/RadioDetails/15.json

{
  "queryResponse" : {
    "@type" : "RadioDetails",
    "@requestUrl" : "https://localhost/webacs/api/v3/data/RadioDetails/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v3/data",
    "entity" : [ {
      "@dtoType" : "radioDetailsDTO",
      "@type" : "RadioDetails",
      "@url" : "https://localhost/webacs/api/v3/data/RadioDetails/15",
      "radioDetailsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "adminStatus" : "UNKNOWN",
        "alarmStatus" : "CRITICAL",
        "antennaAzimAngle" : 15.0,
        "antennaDiversity" : "String value",
        "antennaElevAngle" : 15.0,
        "antennaGain" : 15,
        "antennaMode" : "String value",
        "antennaName" : "String value",
        "antennaType" : "String value",
        "apIpAddress" : "String value",
        "apName" : "String value",
        "baseRadioMac" : "String value",
        "channelControl" : "String value",
        "channelNumber" : 15,
        "channelWidth" : "String value",
        "cleanAirCapable" : "String value",
        "cleanAirSensorStatus" : "String value",
        "cleanAirStatus" : "String value",
        "clientCount" : "String value",
        "controllerIpAddress" : "String value",
        "dot11nCapable" : true,
        "ethernetMac" : "String value",
        "operStatus" : "DOWN",
        "port" : 1,
        "powerLevel" : 15,
        "radioRole" : "SHUTDOWN",
        "radioType" : "String value",
        "slotId" : 15,
        "txPowerControl" : "String value",
        "txPowerOutput" : 15
      }
    } ]
  }
}