Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET apService/rxNeighbors

Return Rx Neighbors of an access point. Only Unified access points are supported. Note that the Prime Infrastructure does not cache/persist Rx neighbors due to volatility of this data. Thus the API resource queries the network to obtain Rx neighbors. API response time may depend on a network condition and is limited to 30 seconds. If it can not get response from a network device within this interval an error will be returned.

Since Product Version: 3.5

Resource Information

Rate Limiting?

Yes

Max Concurrent Requests

5

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v4/op/apService/rxNeighbors

Request Parameters

Attribute Source Description

apId Long

query

Required

Id of the access point to get Rx Neighbors.

Response Parameters

Attribute Description

macAddress MacAddress

MAC address of the access point's radio interface that discovered the Rx neighbor

neighborApId Long

Id of the neighbor's parent access point. Null if the access point is not known.

neighborApName String

Name of the neighbor's parent access point. Null if the access point is not known.

neighborChannel int

Represents Channel information which neighboring access point is using

neighborChannelBandwidth RxNeighborChannelWidthEnum

Bandwidth of the channel which neighboring access point is using

  • 5 MHz
  • 10 MHz
  • 20 MHz
  • 40 MHz
  • Below 40 MHz
  • Above 40 MHz
  • 80 MHz
  • 160 MHz

neighborIpAddress InetAddress

Rx Neighbor IP address

neighborMacAddress MacAddress

Rx Neighbor MAC address

neighborMapLocation String

Name of the service domain the Rx neighbor is located at. Null if there are no associated service domain or the parent access point is not known.

neighborRSSI int

RSSI value of the Rx Neighbor

neighborSlotId int

Slot value of the Rx Neighbor

radioBand RadioBandEnum

Radio band of the access point's radio interface that discovered the Rx neighbor

  • 2.4 GHz
  • 5 GHz
  • Unknown

slotId int

Slot Id of the access point's radio interface that discovered the Rx neighbor

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 Response Payload

https://localhost/webacs/api/v4/op/apService/rxNeighbors?apId=1

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/apService/rxNeighbors?apId=1" rootUrl="https://localhost/webacs/api/v4/op">
  <rxNeighborInfoDTO>
    <macAddress>
      <octets>000a959d6816</octets>
    </macAddress>
    <neighborApId>15</neighborApId>
    <neighborApName>String value</neighborApName>
    <neighborChannel>1</neighborChannel>
    <neighborChannelBandwidth>5 MHz</neighborChannelBandwidth>
    <neighborIpAddress>
      <address>192.168.115.243</address>
    </neighborIpAddress>
    <neighborMacAddress>
      <octets>000a959d6816</octets>
    </neighborMacAddress>
    <neighborMapLocation>String value</neighborMapLocation>
    <neighborRSSI>1</neighborRSSI>
    <neighborSlotId>1</neighborSlotId>
    <radioBand>2.4 GHz</radioBand>
    <slotId>1</slotId>
  </rxNeighborInfoDTO>
  <rxNeighborInfoDTO>
    <macAddress>
      <octets>000a959d6817</octets>
    </macAddress>
    <neighborApId>25</neighborApId>
    <neighborApName>Another string value</neighborApName>
    <neighborChannel>11</neighborChannel>
    <neighborChannelBandwidth>10 MHz</neighborChannelBandwidth>
    <neighborIpAddress>
      <address>192.168.115.244</address>
    </neighborIpAddress>
    <neighborMacAddress>
      <octets>000a959d6817</octets>
    </neighborMacAddress>
    <neighborMapLocation>Another string value</neighborMapLocation>
    <neighborRSSI>11</neighborRSSI>
    <neighborSlotId>11</neighborSlotId>
    <radioBand>5 GHz</radioBand>
    <slotId>11</slotId>
  </rxNeighborInfoDTO>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v4/op/apService/rxNeighbors.json?apId=1

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v4/op/apService/rxNeighbors?apId=1",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v4/op",
    "rxNeighborInfoDTO" : [ {
      "macAddress" : {
        "octets" : "000a959d6816"
      },
      "neighborApId" : 15,
      "neighborApName" : "String value",
      "neighborChannel" : 1,
      "neighborChannelBandwidth" : "5 MHz",
      "neighborIpAddress" : {
        "address" : "192.168.115.243"
      },
      "neighborMacAddress" : {
        "octets" : "000a959d6816"
      },
      "neighborMapLocation" : "String value",
      "neighborRSSI" : 1,
      "neighborSlotId" : 1,
      "radioBand" : "2.4 GHz",
      "slotId" : 1
    }, {
      "macAddress" : {
        "octets" : "000a959d6817"
      },
      "neighborApId" : 25,
      "neighborApName" : "Another string value",
      "neighborChannel" : 11,
      "neighborChannelBandwidth" : "10 MHz",
      "neighborIpAddress" : {
        "address" : "192.168.115.244"
      },
      "neighborMacAddress" : {
        "octets" : "000a959d6817"
      },
      "neighborMapLocation" : "Another string value",
      "neighborRSSI" : 11,
      "neighborSlotId" : 11,
      "radioBand" : "5 GHz",
      "slotId" : 11
    } ]
  }
}