Retrieves radio interfaces of lightweight and autonomous access points. You should use RadioDetails API for retrieving only radio interfaces of lightweight APs and AutoApRadioDetails API for only radio interfaces of autonomous APs.
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/v1/data/RadiosResponse Parameters
Attribute | Description |
---|---|
adminStatus RadioAdminStatusEnum |
Administrative status of the radio interface Allowed values: |
apIpAddress String |
IP address of the access point |
apName String |
Name of the access point |
apType String |
Type of access point (CAPWAP or Autonomous) |
baseRadioMac String |
Base radio MAC address |
channelNumber ChannelNumberEnum |
current operational channel number Allowed values: |
clientCount String |
client count connected to the radio interface |
controllerIpAddress String |
Registered controller IP address for CAPWAP AP only |
ethernetMac String |
MAC address of the ethernet interface on the AP |
operStatus RadioOperStatusEnum |
operational status of the radio interface Allowed values: |
powerLevel Integer |
power level of the radio |
radioType String |
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://localhost/webacs/api/v1/data/Radios/15
<?xml version="1.0" ?>
<queryResponse type="Radios" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/Radios/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="radiosDTO" type="Radios" url="https://localhost/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://localhost/webacs/api/v1/data/Radios/15.json
{
"queryResponse" : {
"@type" : "Radios",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Radios\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "radiosDTO",
"@type" : "Radios",
"@url" : "https : \/\/localhost\/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"
}
}
}
}