Represents a radio interface of an autonomous 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/v1/data/AutoApRadioDetailsResponse Parameters
Attribute | Description |
---|---|
adminStatus RadioAdminStatusEnum |
Administrative status of the radio interface Allowed values: |
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 |
Antenna mode |
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 ChannelNumberEnum |
current operational channel number Allowed values: |
clientCount String |
client count connected to the radio interface |
ethernetMac String |
MAC address of the ethernet interface on the AP |
ifDescr String |
SNMP ifDescr |
nativePowerUseStandard boolean |
Native power use standard |
operBand Cd11HtPhyOperBandEnum |
802.11 operational band Allowed values: |
operStatus RadioOperStatusEnum |
operational status of the radio interface Allowed values: |
phyType Dot11PhyTypeEnum |
802.11 phy type Allowed values: |
powerLevel Integer |
power level of the radio |
radioMac String |
Radio MAC address |
radioRole AutoApRadioRoleEnum |
Radio role Allowed values: |
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/AutoApRadioDetails/15
<?xml version="1.0" ?>
<queryResponse type="AutoApRadioDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/AutoApRadioDetails/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="autoApRadioDetailsDTO" type="AutoApRadioDetails" url="https://localhost/webacs/api/v1/data/AutoApRadioDetails/15">
<autoApRadioDetailsDTO displayName="String value" id="15" uuid="String value">
<adminStatus>UNKNOWN</adminStatus>
<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>UNKNOWN</channelNumber>
<clientCount>String value</clientCount>
<ethernetMac>String value</ethernetMac>
<ifDescr>String value</ifDescr>
<nativePowerUseStandard>true</nativePowerUseStandard>
<operBand>UNKNOWN</operBand>
<operStatus>DOWN</operStatus>
<phyType>UNKNOWN</phyType>
<powerLevel>15</powerLevel>
<radioMac>String value</radioMac>
<radioRole>UNKNOWN</radioRole>
<radioType>String value</radioType>
</autoApRadioDetailsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/AutoApRadioDetails/15.json
{
"queryResponse" : {
"@type" : "AutoApRadioDetails",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/AutoApRadioDetails\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "autoApRadioDetailsDTO",
"@type" : "AutoApRadioDetails",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/AutoApRadioDetails\/15",
"autoApRadioDetailsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"adminStatus" : "UNKNOWN",
"antennaAzimAngle" : 15,
"antennaDiversity" : "String value",
"antennaElevAngle" : 15,
"antennaGain" : 15,
"antennaMode" : "String value",
"antennaName" : "String value",
"antennaType" : "String value",
"apIpAddress" : "String value",
"apName" : "String value",
"baseRadioMac" : "String value",
"channelControl" : "String value",
"channelNumber" : "UNKNOWN",
"clientCount" : "String value",
"ethernetMac" : "String value",
"ifDescr" : "String value",
"nativePowerUseStandard" : true,
"operBand" : "UNKNOWN",
"operStatus" : "DOWN",
"phyType" : "UNKNOWN",
"powerLevel" : 15,
"radioMac" : "String value",
"radioRole" : "UNKNOWN",
"radioType" : "String value"
}
}
}
}