Represents detail information of a radio interfaces on lightweight access point.
Since Product Version: 1.2
Resource URL
/webacs/api/v1/data/RadioDetailsResponse Parameters
Type | Attribute Name | Description |
---|---|---|
RadioAdminStatusEnum |
adminStatus |
Administrative status of the radio interface Allowed values:
|
AlarmSeverityEnum |
alarmStatus |
Allowed values:
|
float |
antennaAzimAngle |
Antenna Azim. Angle |
String |
antennaDiversity |
Antenna diversity |
float |
antennaElevAngle |
Antenna Elev. angle |
int |
antennaGain |
raw value from device. It is different from displayed in the UI. |
String |
antennaMode |
Antenna mode |
String |
antennaName |
Antenna name |
String |
antennaType |
Antenna type (Internal or External) |
String |
apIpAddress |
IP address of the access point |
String |
apName |
Name of the access point |
String |
baseRadioMac |
Base radio MAC address |
String |
channelControl |
Radio channel control |
int |
channelNumber |
current operational channel number |
String |
channelWidth |
channel width |
String |
cleanAirCapable |
capability of clean air feature |
String |
cleanAirSensorStatus |
Clean air sensor status |
String |
cleanAirStatus |
Clean air status |
String |
clientCount |
client count connected to the radio interface |
String |
controllerIpAddress |
Resgistered controller IP address for CAPWAP AP only |
boolean |
dot11nCapable |
802.11n capability |
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:
|
int |
port |
controller port number |
Integer |
powerLevel |
power level of the radio |
RadioRoleEnum |
radioRole |
Radio role Allowed values:
|
String |
radioType |
radio type (802.11a/b/g/n) |
int |
slotId |
slot ID of the radio in the AP |
String |
txPowerControl |
Tranmission power control |
Integer |
txPowerOutput |
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.25.123.114/webacs/api/v1/data/RadioDetails/15
<?xml version="1.0" ?> <queryResponse type="RadioDetails" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/RadioDetails/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="radioDetailsDTO" type="RadioDetails" url="https://172.25.123.114/webacs/api/v1/data/RadioDetails/15"> <radioDetailsDTO displayName="String value" id="15" uuid="String value"> <adminStatus>UNKNOWN</adminStatus> <alarmStatus>CRITICAL</alarmStatus> <antennaAzimAngle>3.0</antennaAzimAngle> <antennaDiversity>String value</antennaDiversity> <antennaElevAngle>3.0</antennaElevAngle> <antennaGain>1</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>1</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>1</slotId> <txPowerControl>String value</txPowerControl> <txPowerOutput>15</txPowerOutput> </radioDetailsDTO> </entity> </queryResponse>
Sample JSON Payload
https://172.25.123.114/webacs/api/v1/data/RadioDetails/15.json
{ "queryResponse" : { "@type" : "RadioDetails", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/RadioDetails\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "radioDetailsDTO", "@type" : "RadioDetails", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/RadioDetails\/15", "radioDetailsDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "adminStatus" : "UNKNOWN", "alarmStatus" : "CRITICAL", "antennaAzimAngle" : 3, "antennaDiversity" : "String value", "antennaElevAngle" : 3, "antennaGain" : 1, "antennaMode" : "String value", "antennaName" : "String value", "antennaType" : "String value", "apIpAddress" : "String value", "apName" : "String value", "baseRadioMac" : "String value", "channelControl" : "String value", "channelNumber" : 1, "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" : 1, "txPowerControl" : "String value", "txPowerOutput" : 15 } } } }