Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET_AutoApRadioDetails

GET AutoApRadioDetails

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

HTTP Methods

GET

Represents a radio interface of an autonomous access point.

Resource URL

/webacs/api/v1/data/AutoApRadioDetails

Response Parameters

Type Attribute Name Description

RadioAdminStatusEnum

adminStatus

Administrative status of the radio interface

Allowed values:

  • UNKNOWN
  • ENABLE
  • DISABLE

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

ChannelNumberEnum

channelNumber

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
  • _149
  • _153
  • _157
  • _161
  • _165
  • _169
  • _173

String

clientCount

client count connected to the radio interafce

String

ethernetMac

MAC address of the ethernet interface on the AP

String

ifDescr

SNMP ifDescr

boolean

nativePowerUseStandard

Native power use standard

Cd11HtPhyOperBandEnum

operBand

802.11 operational band

Allowed values:

  • UNKNOWN
  • BAND24GHZ
  • BAND5GHZ

RadioOperStatusEnum

operStatus

operational status of the radio interface

Allowed values:

  • DOWN
  • UP
  • NOTASSOCIATED
  • UNKNOWN

Dot11PhyTypeEnum

phyType

802.11 phy type

Allowed values:

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

int

powerLevel

power level of the radio

String

radioMac

Radio MAC address

AutoApRadioRoleEnum

radioRole

Radio role

Allowed values:

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

String

radioType

radio type (802.11a/b/g/n)

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.19.31.161/webacs/api/v1/data/AutoApRadioDetails/42

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://172.19.31.161/webacs/api/v1/data/AutoApRadioDetails/42" responseType="getEntity">
    <entity url="/webacs/data/className/15" type="className" dtoType="autoApRadioDetailsDTO_$$_javassist_2968">
        <autoApRadioDetailsDTO id="15" displayName="String value">
            <adminStatus>UNKNOWN</adminStatus>
            <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>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>1</powerLevel>
            <radioMac>String value</radioMac>
            <radioRole>UNKNOWN</radioRole>
            <radioType>String value</radioType>
        </autoApRadioDetailsDTO>
    </entity>
</queryResponse>

Sample JSON Payload

https://172.19.31.161/webacs/api/v1/data/AutoApRadioDetails/42.json

{
  "queryResponse" : {
    "@rootUrl" : "\/webacs\/data",
    "@requestUrl" : "https : \/\/172.19.31.161\/webacs\/api\/v1\/data\/AutoApRadioDetails\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "\/webacs\/data\/className\/15",
      "@type" : "className",
      "@dtoType" : "autoApRadioDetailsDTO_$$_javassist_2968",
      "autoApRadioDetailsDTO" : {
        "@id" : "15",
        "@displayName" : "String value",
        "adminStatus" : "UNKNOWN",
        "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" : "UNKNOWN",
        "clientCount" : "String value",
        "ethernetMac" : "String value",
        "ifDescr" : "String value",
        "nativePowerUseStandard" : true,
        "operBand" : "UNKNOWN",
        "operStatus" : "DOWN",
        "phyType" : "UNKNOWN",
        "powerLevel" : 1,
        "radioMac" : "String value",
        "radioRole" : "UNKNOWN",
        "radioType" : "String value"
      }
    }
  }
}