Wireless

getWirelessNetworkDetails

Lists Access Points, Client Count and Network Usage for each SSID in Wireless LAN Controller

HTTP Method

GET

API URL

https://localhost:8060/api/json/v2/wireless/getWirelessNetworkDetails?apiKey=***************&deviceName=CiscoWirelessController

Parameters

Param Name Description Data Type Additional Information Is Mandatory
apiKey API Key to access your OpManager server. String - Yes
deviceName Name of the WLC device (Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response) String - Yes

Sample Response

HTTP Code: 200

[ { "ClientCount": "40", "TotalBytes": "224.548 MBps", "SSIDName": "Mobile-Connect", "APCount": "20"}, { "ClientCount": "20", "TotalBytes": "224.546 MBps", "SSIDName": "Machine-Connect", "APCount": "20"}, { "ClientCount": "20", "TotalBytes": "196.161 MBps", "SSIDName": "Free-Connect", "APCount": "20"}]

Error Response

View common error responses
Rate limit: 40 requests per minute. Exceeding this limit will block requests for 1 minute

getWirelessAPList

Lists all Access Points in the WLC Device.

HTTP Method

GET

API URL

https://localhost:8060/api/json/v2/wireless/getWirelessAPList?apiKey=***************&deviceName=CiscoWirelessController

Parameters

Param Name Description Data Type Additional Information Is Mandatory
apiKey API Key to access your OpManager server. String - Yes
deviceName Name of the WLC device (Managed Entity name seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response) String - Yes
filterBy Filter criteria to narrow down the list of wireless access points String Allowed values: All, Active, Removed, Managed, UnManaged, Monitored, NotMonitored No

Sample Response

HTTP Code: 200

[ { "macAddress": "1:50:bf:7:xx:xx", "channels": "53,64", "statusStr": "Clear", "ipAddress": "10.5.5.2", "apDisplayName": "South-0011", "advanceMonitoringEnabled": "true", "apName": "ap-10.5.5.2-1.80.191.7.xxx.xx", "statusNum": "5"}, { "macAddress": "1:50:bf:7:xx:xx", "channels": "53,64", "statusStr": "Not Monitored", "ipAddress": "10.5.5.2", "apDisplayName": "North021", "advanceMonitoringEnabled": "false", "apName": "ap-10.5.5.2-1.80.191.7.xxx.xx", "statusNum": "7"}, { "macAddress": "1:50:bf:7:xx:xx", "channels": "53,64", "statusStr": "Not Monitored", "ipAddress": "10.5.5.2", "apDisplayName": "South0021", "advanceMonitoringEnabled": "false", "apName": "ap-10.5.5.2-1.80.191.7.xxx.xx", "statusNum": "7"}, { "macAddress": "1:50:bf:7:xx:xx", "channels": "53,64", "statusStr": "Not Monitored", "ipAddress": "10.5.5.2", "apDisplayName": "North0031", "advanceMonitoringEnabled": "false", "apName": "ap-10.5.5.2-1.80.191.7.xxx.xx", "statusNum": "7"}]

Error Response

View common error responses
Rate limit: 40 requests per minute. Exceeding this limit will block requests for 1 minute

getSSIDClientList

Lists all the SSID Clients associated with the given WLC device.

HTTP Method

GET

API URL

https://localhost:8060/api/json/v2/wireless/getSSIDClientList?apiKey=***************&deviceName=CiscoWirelessController

Parameters

Param Name Description Data Type Additional Information Is Mandatory
apiKey API Key to access your OpManager server. String - Yes
deviceName Name of the WLC device (Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response) String - Yes

Sample Response

HTTP Code: 200

{ "clientData": [ { "displayName": "Mobile-Connect", "ClientCount": "40"}, { "displayName": "Free-Connect", "ClientCount": "20"}, { "displayName": "Machine-Connect", "ClientCount": "20"} ], "clientCount": 80}

Error Response

View common error responses
Rate limit: 50 requests per minute. Exceeding this limit will block requests for 1 minute

getClientDetails

Fetches the client devices connected to the given SSID of WLC device.

HTTP Method

GET

API URL

https://localhost:8060/api/json/v2/wireless/getClientDetails?apiKey=***************&deviceName=CiscoWirelessController&ssidName=WorkstationNetwork

Parameters

Param Name Description Data Type Additional Information Is Mandatory
apiKey API Key to access your OpManager server. String - Yes
deviceName Name of the WLC device (Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response) String - Yes
ssidName SSID name of the wireless network associated to WLC String - Yes

Sample Response

HTTP Code: 200

[ { "ClientCount": "2", "TotalBytes": "28.156 MBps", "APMOName": "ap-10.5.5.2-1.80.191.7.xxx.xx", "advanceMonitoringEnabled": "false", "apName": "North0041"}, { "ClientCount": "2", "TotalBytes": "28.154 MBps", "APMOName": "ap-10.5.5.2-1.80.191.7.xxx.xx", "advanceMonitoringEnabled": "false", "apName": "North0031"}, { "ClientCount": "2", "TotalBytes": "14.079 MBps", "APMOName": "ap-10.5.5.2-1.80.191.7.xxx.xx", "advanceMonitoringEnabled": "false", "apName": "North0101"}]

Error Response

View common error responses
Rate limit: 50 requests per minute. Exceeding this limit will block requests for 1 minute

Thank you for your feedback!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?
Do you need assistance with this topic?
By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.

Thank you for your feedback!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?
Do you need assistance with this topic?
By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.