topic Re: To check If Zone Director has Ruckus Public API in ZoneDirector

To check If Zone Director has Ruckus Public API

mikael_tamirie_ — Wed, 10 Mar 2021 06:10:13 GMT

Hello Ruckus Community,

This is to check if Zone Director has Ruckus Public API. I know that you have a public API for the SZ series and vSCG but I could not find any free public API for the zone director controller. Can you check and share the information, please?

Re: To check If Zone Director has Ruckus Public API

martin_martin — Wed, 10 Mar 2021 08:19:34 GMT

Hi Mikael,

There is no public API on the ZoneDirector platform.

Kind regards

Martin

Re: To check If Zone Director has Ruckus Public API

mikael_tamirie_ — Wed, 10 Mar 2021 10:28:40 GMT

Hello Martin,

Thank you for your advice. I will forward to look only at the SZ series and vSCG one.

Another thing I wanted to do is using the MIB browser, I need to get the SNMP data of the client MAC address and other details. Normally, I have come to know that I can not get such data from the WLC via SNMP due to some scalability issue as confirmed by the Ruckus technical support. Normally, we can get some details from cisco WLC. So, what the ruckus technical support advised me is to use public API. But I can not get an exact Get or Post request to get all the client details like client MAC Address and Client IP Address. I am not able to get the result using postman software as well. Actually, I am able to get results on a browser for some GET requests. Can you advise If any of this thing is familiar to you?

Regards,

Mikael Tamirie

Re: To check If Zone Director has Ruckus Public API

martin_martin — Wed, 10 Mar 2021 11:55:59 GMT

Hi Mikael,

What version of vSZ are you running? and are you using the Essentials or the High scale one. After that we can see what API options are available.

As example on the high scale 5.2.2 you have this query output you can get when requesting client mac info.

{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "58:B6:33:37:D4:E0",
      "apName": "R710_Box_Up_Pink",
      "hostname": "Nolan_DELL_Laptop",
      "status": "AUTHORIZED",
      "authStatus": "AUTHORIZED",
      "alerts": null,
      "osType": "Windows 7/Vista",
      "deviceType": "Laptop",
      "osVendorType": "Windows",
      "modelName": "Windows 7/Vista",
      "ipAddress": "10.11.0.86",
      "ipv6Address": "2001:b030:2516:164:7074:3f14:f0d9:c939",
      "clientMac": "00:24:D7:89:36:A0",
      "ssid": "NolanWPATest",
      "txBytes": 2099158501,
      "rxBytes": 73731395,
      "txRxBytes": 2172889896,
      "uplink": 73731395,
      "downlink": 2099158501,
      "traffic": 2172889896,
      "uplinkRate": 131194,
      "downlinkRate": 3735157,
      "rssi": -47,
      "snr": 58,
      "radioType": "11a/n/ac",
      "vlan": 1,
      "channel": 36,
      "userName": null,
      "authMethod": "Standard+Open",
      "encryptionMethod": "WPA2-AES",
      "controlPlaneName": "node232",
      "dataPlaneName": null,
      "rxFrames": 952977,
      "txFrames": 1729632,
      "txDropDataFrames": 4,
      "sessionStartTime": 1487400391000,
      "speedflex": 0,
      "wlanType": "0",
      "zoneId": "d6ad32aa-c400-4005-b9c2-1d5b90e44139",
      "zoneVersion": "3.5.0.99.1132"
    },

Regards

Martin

Re: To check If Zone Director has Ruckus Public API

mikael_tamirie_ — Wed, 10 Mar 2021 12:02:50 GMT

Hello Martin,

Again thank you for your reply,

Actually, I am running SZ version 3.6.2 and the public API is a different one. Can you advise for this version to get a client details like below:

Re: To check If Zone Director has Ruckus Public API

martin_martin — Wed, 10 Mar 2021 12:10:20 GMT

With 3.6.2 we have this:

{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "mac": "3C:A9:F4:0C:85:B0",
      "ipAddress": "172.18.116.141",
      "ipv6Address": "2001:b030:2516:1a0::5d6e",
      "hostName": "SDC-Randall-PC",
      "osType": "Windows 7/Vista",
      "user": "",
      "status": "AUTHORIZED",
      "radioId": "0",
      "radioMode": null,
      "channel": "11",
      "wlanId": "1",
      "ssid": "client-test",
      "snr": "46",
      "rssi": "-49",
      "rxByteRate": 52,
      "txByteRate": 39,
      "rxAvgByteRate": 50,
      "txAvgByteRate": 30,
      "fromClientBytes": 240863,
      "toClientBytes": 642897,
      "fromClientPkts": 2247,
      "toClientPkts": 7678,
      "connectedSince": 2600,
      "vlan": "1",
      "toClientDroppedPkts": 108
    }
  ]
}

via the

RETRIEVE CLIENT LIST ¶

GET`/v6_1/aps/{apMac}/operational/client`

Use this API command to retrieve the client list per AP.

URI Parameters

Hide

index: string (optional)
The index of the first entry to be retrieved. Default: 0
listSize: string (optional)
The maximum number of entries to be retrieved. Default: 100

Response 200

Hide

Body

In newer releases, it was improved.

regards

Martin

Re: To check If Zone Director has Ruckus Public API

mikael_tamirie_ — Wed, 10 Mar 2021 12:33:29 GMT

Hello Martin,

Thank you for this. I tested the client per AP and get the correct result. Now one more question is can I get all client lists that are online not per a single AP? I am trying here to develop software for location-based tracking and I need to extract the client details generally to make the algorithm efficient. Another thing is this option added on the newer version? If you have some advice, it is appreciated.

Re: To check If Zone Director has Ruckus Public API

mikael_tamirie_ — Wed, 10 Mar 2021 12:36:03 GMT

Here is what I got for the client list per AP

Re: To check If Zone Director has Ruckus Public API

martin_martin — Wed, 10 Mar 2021 13:33:23 GMT

Hi Mikael,

In the newer versions 5.x this is improved.

I would suggest you to use a more recent version for you product testing.

regards
Martin

Re: To check If Zone Director has Ruckus Public API

mikael_tamirie_ — Wed, 10 Mar 2021 13:36:37 GMT

Hello Martin,

Thank you very much for your priceless support. It is my pleasure to get all this advice from you. You are truly a legend in this field.

Thank you again.

Regards,

Mikael Tamirie.

topic Re: To check If Zone Director has Ruckus Public API in ZoneDirector

To check If Zone Director has Ruckus Public API

Re: To check If Zone Director has Ruckus Public API

Re: To check If Zone Director has Ruckus Public API

Re: To check If Zone Director has Ruckus Public API

Re: To check If Zone Director has Ruckus Public API

Re: To check If Zone Director has Ruckus Public API

RETRIEVE CLIENT LIST ¶

GET/v6_1/aps/{apMac}/operational/client

Body

Re: To check If Zone Director has Ruckus Public API

Re: To check If Zone Director has Ruckus Public API

Re: To check If Zone Director has Ruckus Public API

Re: To check If Zone Director has Ruckus Public API

GET`/v6_1/aps/{apMac}/operational/client`