Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET AutoApRadioDetails

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

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v2/data/AutoApRadioDetails

Unmodified

This resource has not been modified since the previous API version.

Deprecated

This version has been deprecated. Please use v4.

Response Parameters

Attribute Description

adminStatus RadioAdminStatusEnum

Administrative status of the radio interface

Allowed values:

  • UNKNOWN
  • ENABLE
  • DISABLE

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, 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 ChannelNumberEnum

Current operational channel number

Allowed values:

  • UNKNOWN
  • _1
  • _2
  • _3
  • _4
  • _5
  • _6
  • _7
  • _8
  • _9
  • _10
  • _11
  • _12
  • _13
  • _14
  • _20
  • _21
  • _22
  • _23
  • _24
  • _25
  • _26
  • _34
  • _36
  • _38
  • _40
  • _42
  • _44
  • _46
  • _48
  • _52
  • _56
  • _60
  • _64
  • _100
  • _104
  • _108
  • _112
  • _116
  • _120
  • _124
  • _128
  • _132
  • _136
  • _140
  • _144
  • _149
  • _153
  • _157
  • _161
  • _165
  • _169
  • _173

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:

  • UNKNOWN
  • BAND24GHZ
  • BAND5GHZ

operStatus RadioOperStatusEnum

Operational status of the radio interface

Allowed values:

  • DOWN
  • UP
  • NOTASSOCIATED
  • UNKNOWN

phyType Dot11PhyTypeEnum

802.11 phy type

Allowed values:

  • UNKNOWN
  • FHSS
  • DSSS
  • IRBASEBAND
  • OFDM
  • HRDSSS
  • ERP
  • HT

powerLevel Integer

Power level of the radio

radioMac String

Radio MAC address

radioRole AutoApRadioRoleEnum

Radio role

Allowed values:

  • UNKNOWN
  • WGB
  • BRIDGE
  • CLIENT
  • ROOT
  • REPEATER
  • APBRIDGE
  • APREPEATER
  • IBSS
  • NRBRIDGE
  • APBRBRIDGE
  • SCANNER

radioType String

Radio type. Allowed values: 802.11a, 802.11b/g, 802.11b/g/n, 802.11a/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/v2/data/AutoApRadioDetails/15

<?xml version="1.0" ?>
<queryResponse type="AutoApRadioDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/AutoApRadioDetails/15" rootUrl="https://localhost/webacs/api/v2/data">
  <entity dtoType="autoApRadioDetailsDTO" type="AutoApRadioDetails" url="https://localhost/webacs/api/v2/data/AutoApRadioDetails/15">
    <autoApRadioDetailsDTO displayName="String value" id="15" uuid="String value">
      <adminStatus>UNKNOWN</adminStatus>
      <antennaAzimAngle>15.0</antennaAzimAngle>
      <antennaElevAngle>15.0</antennaElevAngle>
      <antennaGain>15</antennaGain>
      <antennaName>String value</antennaName>
      <apName>String value</apName>
      <channelNumber>UNKNOWN</channelNumber>
      <ifDescr>String value</ifDescr>
      <nativePowerUseStandard>true</nativePowerUseStandard>
      <operBand>UNKNOWN</operBand>
      <operStatus>DOWN</operStatus>
      <phyType>UNKNOWN</phyType>
      <powerLevel>15</powerLevel>
      <radioRole>UNKNOWN</radioRole>
      <antennaDiversity>String value</antennaDiversity>
      <antennaMode>String value</antennaMode>
      <antennaType>String value</antennaType>
      <apIpAddress>String value</apIpAddress>
      <baseRadioMac>String value</baseRadioMac>
      <channelControl>String value</channelControl>
      <clientCount>String value</clientCount>
      <ethernetMac>String value</ethernetMac>
      <radioMac>String value</radioMac>
      <radioType>String value</radioType>
    </autoApRadioDetailsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v2/data/AutoApRadioDetails/15.json

{
  "queryResponse" : {
    "@type" : "AutoApRadioDetails",
    "@requestUrl" : "https://localhost/webacs/api/v2/data/AutoApRadioDetails/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v2/data",
    "entity" : [ {
      "@dtoType" : "autoApRadioDetailsDTO",
      "@type" : "AutoApRadioDetails",
      "@url" : "https://localhost/webacs/api/v2/data/AutoApRadioDetails/15",
      "autoApRadioDetailsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "adminStatus" : "UNKNOWN",
        "antennaAzimAngle" : 15.0,
        "antennaDiversity" : "String value",
        "antennaElevAngle" : 15.0,
        "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"
      }
    } ]
  }
}