To get wireless radio information for a rf-domain:
Note
You must forward the auth_token as a cookie with each API call.Sample Request
curl -X GET --cookie auth_token=$cookie http://10.1.1.1/rest/v1/stats/wireless/radio -d '{"rf-domain":"SITE-1"}'
Sample Response (200 OK)
{ "data": [ { "adopted_to": "00-00-00-00-00-00", "ap_type": "ap7532", "config_channel": "smt", "config_power": "smt", "current_channel": "11", "current_power": 18, "device_mac": "84-24-8D-15-E5-D8", "expire_at": 2769507, "hostname": "ap-zzz", "last_update": 2769417, "location": "", "max_user_rate": 216600, "num_clients": 0, "protocol": 22, "radio_alias": "ap-zzz:R1", "radio_id": "84-24-8D-15-E5-D8:R1", "radio_mac": "FC-0A-81-A3-1C-C0", "radio_num": 1, "radio_type": "2.4GHz-wlan", "rf_domain_name": "SITE-1", "state": "On" }, { "adopted_to": "00-00-00-00-00-00", "ap_type": "ap7532",…...... "state": "Off" } ], "return_code": 0 }
Response Item | Description | Data Type |
---|---|---|
adopted_to | MAC address of the parent wireless controller that the access point is adopted to | mac-address |
ap_type | Type of access point | String |
config_channel | Configured channel for this radio | String (length 64) |
config_power | Configured power for this radio | String (length 16) |
current_channel | Current channel this radio is operating at | String (length 16) |
current_power | Current power (in dBm) that this radio is operating at | Integer |
device_mac | Device MAC address | mac-address |
expire_at | Expiry time | Integer |
hostname | Host name of the access point device | String (length 64) |
last_update | Last Update time | Integer |
location | Location description of the access point device | String (length 64) |
max_user_rate | Theoretical maximum user-level data rate in kbps | Integer |
num_clients | Number of clients associated with this radio | Integer |
protocol | Bit flag for supported protocol (bit4=11GN, bit3=11AN, bit2=11G, bit1=11B, bit0=11A) | Integer |
radio_alias | Radio ID alias of its associated radio in the form of hostname:R%d. E.g., rfs4000-22A24E:R1 | String |
radio_id | Unique ID for its associated radio in the form of AP-MAC:R%d. E.g., 00-A0-F8-00-00-00:R1 | String |
radio_mac | MAC address of this radio interface | mac-address |
radio_num | Radio number of the radio interface | Integer |
radio_type | 802.11 radio-type of the client | Enumeration [11a, 11b, 11g, 11an, 11bn, 11ac] |
rf_domain_name | RF-domain name of the AP device | String (length 64) |
state | Current radio state | String (length 64) |