Wireless Access Point Notifications
Since Product Version: 3.7
Resource Information
Rate Limiting? |
Yes |
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/sse/AccessPointsResponse Parameters
Attribute | Description |
---|---|
adminStatus ApAdminStatusEnum |
AP Admin Status Allowed values:
|
bootVersion String |
AP Boot Version |
clientCount int |
Total Client Count |
clientCount_2_4GHz int |
Client Count on 2.4GHz Band |
clientCount_5GHz int |
Client Count on 5GHZ Band |
controllerIpAddress String |
Registered Controller IP Address |
controllerName String |
Registered Controller Name |
countryCode String |
Identifies the country in which the AP is operating. This value is the 3 letter country code. |
ethernetMac MacAddress |
AP Ethernet MAC Address |
hreapEnabled boolean |
Displays whether OfficeExtend is enabled. |
ipAddress InetAddress |
AP IP Address |
location String |
AP SNMP Location |
lwappUpTime long |
LWAPP uptime. Represents the time in hundredths of a second since the last time the AP joined the controller. |
macAddress MacAddress |
AP MAC Address |
model String |
AP Model |
name String |
AP Name |
serialNumber String |
AP Serial Number |
softwareVersion String |
AP Software Version |
status AlarmSeverityEnum |
AP Alarm Status Allowed values:
|
type String |
AP Type |
upTime Long |
AP Up Time in hundredths of a second |
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/v4/sse/AccessPoints
<?xml version="1.0" ?>
<streamResponse responseType="listEvents" requestUrl="https://localhost/webacs/api/v4/sse/AccessPoints" rootUrl="https://localhost/webacs/api/v4/sse">
<streamEvent dtoType="accessPointsDTO" id="AccessPoints" action="CREATED">
<accessPointsDTO displayName="String value" id="15" uuid="String value">
<adminStatus>UNKNOWN</adminStatus>
<bootVersion>String value</bootVersion>
<clientCount>1</clientCount>
<clientCount_2_4GHz>1</clientCount_2_4GHz>
<clientCount_5GHz>1</clientCount_5GHz>
<controllerIpAddress>String value</controllerIpAddress>
<controllerName>String value</controllerName>
<countryCode>String value</countryCode>
<hreapEnabled>true</hreapEnabled>
<location>String value</location>
<lwappUpTime>2</lwappUpTime>
<model>String value</model>
<name>String value</name>
<serialNumber>String value</serialNumber>
<softwareVersion>String value</softwareVersion>
<status>CRITICAL</status>
<type>String value</type>
<upTime>15</upTime>
<ethernetMac>
<octets>000a959d6816</octets>
</ethernetMac>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
</accessPointsDTO>
</streamEvent>
</streamResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/sse/AccessPoints.json
{
"streamResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/sse/AccessPoints",
"@responseType" : "listEvents",
"@rootUrl" : "https://localhost/webacs/api/v4/sse",
"streamEvent" : [ {
"@action" : "CREATED",
"@dtoType" : "accessPointsDTO",
"@id" : "AccessPoints",
"accessPointsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"adminStatus" : "UNKNOWN",
"bootVersion" : "String value",
"clientCount" : 1,
"clientCount_2_4GHz" : 1,
"clientCount_5GHz" : 1,
"controllerIpAddress" : "String value",
"controllerName" : "String value",
"countryCode" : "String value",
"ethernetMac" : {
"octets" : "000a959d6816"
},
"hreapEnabled" : true,
"ipAddress" : {
"address" : "192.168.115.243"
},
"location" : "String value",
"lwappUpTime" : 2,
"macAddress" : {
"octets" : "000a959d6816"
},
"model" : "String value",
"name" : "String value",
"serialNumber" : "String value",
"softwareVersion" : "String value",
"status" : "CRITICAL",
"type" : "String value",
"upTime" : 15
}
} ]
}
}