Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager 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

Group Filtering?

No

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/RadioDetails

Deprecated

This version has been deprecated. Please use v4.

Response Parameters

Attribute Description

adminStatus RadioAdminStatusEnum

Administrative status of the radio interface

  • UNKNOWN
  • ENABLE
  • DISABLE

alarmStatus AlarmSeverityEnum

  • 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.

Allowed values: 'Connector A', 'Connector B', 'Enabled', 'NA'

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. Allowed values: Sector A, Sector B, Omni, NA (non-applicable).

antennaName String

Antenna name

antennaType String

Antenna type. Allowed values: Internal, External, Circular, Linear, NA

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. Allowed values: Automatic, Custom, NA

channelNumber Integer

Current operational channel number

channelWidth String

Channel width. Allowed values: 5 MHz, 10 MHz, 20 MHz, 40 MHz, 80 MHz, 160 MHz, Above 40 MHz, Below 40 MHz, NA

cleanAirCapable String

Capability of clean air feature. Allowed values: Yes, No

cleanAirSensorStatus String

Clean air sensor status. Allowed values: Up, Down, NA

cleanAirStatus String

Clean air status. Allowed values: Yes, No

clientCount String

Client count connected to the radio interface

controllerIpAddress String

Registered 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

  • DOWN
  • UP
  • NOTASSOCIATED
  • UNKNOWN

port int

Controller port number

powerLevel Integer

Power level of the radio

radioBand RadioBandEnum

Radio band of the radio interface

  • 2.4 GHz
  • 5 GHz
  • Unknown

radioRole RadioRoleEnum

Radio role

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

radioType String

Radio type of the interface. Allowed values: 802.11a, 802.11ac, 802.11a/n, 802.11a/n/ac, 802.11a/n/ac/ax, 802.11b/g, 802.11b/g/n, 802.11b/g/n/ax, 802.11a/b/g/n, 802.11a/b/g/n/ac, 802.11a/b/g/n/ac/ax, XOR (Monitor Mode), XOR (2.4GHz), XOR (5GHz), UWB, BLE, Unknown

slotId Integer

Slot ID of the radio in the AP

txPowerControl String

Tranmission power control. Allowed values: Automatic, Custom, NA

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://172.20.127.108/webacs/api/v1/data/RadioDetails/15

<?xml version="1.0" ?>
<queryResponse type="RadioDetails" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v1/data/RadioDetails/15" rootUrl="https://172.20.127.108/webacs/api/v1/data">
  <entity dtoType="radioDetailsDTO" type="RadioDetails" url="https://172.20.127.108/webacs/api/v1/data/RadioDetails/15">
    <radioDetailsDTO displayName="String value" id="15" uuid="String value">
      <adminStatus>UNKNOWN</adminStatus>
      <alarmStatus>CRITICAL</alarmStatus>
      <antennaAzimAngle>15.0</antennaAzimAngle>
      <antennaElevAngle>15.0</antennaElevAngle>
      <antennaGain>15</antennaGain>
      <antennaName>String value</antennaName>
      <apName>String value</apName>
      <dot11nCapable>true</dot11nCapable>
      <operStatus>DOWN</operStatus>
      <port>1</port>
      <powerLevel>15</powerLevel>
      <radioBand>2.4 GHz</radioBand>
      <radioRole>SHUTDOWN</radioRole>
      <slotId>15</slotId>
      <txPowerOutput>15</txPowerOutput>
      <antennaDiversity>String value</antennaDiversity>
      <antennaMode>String value</antennaMode>
      <antennaType>String value</antennaType>
      <apIpAddress>String value</apIpAddress>
      <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>
      <ethernetMac>String value</ethernetMac>
      <radioType>String value</radioType>
      <txPowerControl>String value</txPowerControl>
    </radioDetailsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.20.127.108/webacs/api/v1/data/RadioDetails/15.json

{
  "queryResponse" : {
    "@type" : "RadioDetails",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data\/RadioDetails\/15",
    "@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "radioDetailsDTO",
      "@type" : "RadioDetails",
      "@url" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data\/RadioDetails\/15",
      "radioDetailsDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "adminStatus" : "UNKNOWN",
        "alarmStatus" : "CRITICAL",
        "antennaAzimAngle" : 15,
        "antennaElevAngle" : 15,
        "antennaGain" : 15,
        "antennaName" : "String value",
        "apName" : "String value",
        "dot11nCapable" : true,
        "operStatus" : "DOWN",
        "port" : 1,
        "powerLevel" : 15,
        "radioBand" : "2.4 GHz",
        "radioRole" : "SHUTDOWN",
        "slotId" : 15,
        "txPowerOutput" : 15,
        "antennaDiversity" : "String value",
        "antennaMode" : "String value",
        "antennaType" : "String value",
        "apIpAddress" : "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",
        "ethernetMac" : "String value",
        "radioType" : "String value",
        "txPowerControl" : "String value"
      }
    }
  }
}