topic Re: Unleashed API in Unleashed

Unleashed API

ms — Fri, 04 Feb 2022 21:17:44 GMT

Is there published or unpublished API for Unleashed?

I'm looking for the MACs from cli command "show current-active-clients all".

Re: Unleashed API

mmMOLINARI — Tue, 08 Feb 2022 01:19:00 GMT

Hi ms,

Yes, there is an unpublished API. It's not a standard REST API. It uses HTTP POST and GET, but the payload is XML/ajax. I have a postman collection and some documentation for Unleashed and Zone Director APIs. That's too much information to post here. Please send me your email, I will send you the collection and the doc.

Marcelo

Re: Unleashed API

ms264556 — Tue, 08 Feb 2022 07:10:18 GMT

This would be great to have on GitHub or somewhere similar (or maybe it is already)?

I captured the browser traffic to figure out the relevant posts and gets for updating certificates, but it'd be nicer to steal from your hard work next time. Especially code for the necessary session cookies & headers would've saved me a few hours of experimentation.

Re: Unleashed API

mmMOLINARI — Tue, 08 Feb 2022 20:53:34 GMT

Totally agree. I just created a new repo on GitHub and added the Unleashed postman collection: https://github.com/commscope-ruckus/RUCKUS-Unleashed

You start with the call to login using the unleashed credentials, then retrieve a CSRF token, and use it in the header for subsequent calls.

Re: Unleashed API

ms264556 — Thu, 10 Feb 2022 05:38:38 GMT

Thanks!

I added a pull request which re-works the login steps so ZoneDirector 10.x is also supported.

Re: Unleashed API

ms — Thu, 10 Feb 2022 05:45:30 GMT

Amazing! I’ll have a look.

Re: Unleashed API

mmMOLINARI — Thu, 10 Feb 2022 21:45:31 GMT

the endpoints for ZD are a little different. I will create another repo with the ZD collection

Re: Unleashed API

mmMOLINARI — Thu, 10 Feb 2022 22:30:50 GMT

I uploaded a ZD 1200 collection to this repository: https://github.com/commscope-ruckus/RUCKUS-Zone-Director

Re: Unleashed API

ms264556 — Fri, 11 Feb 2022 01:34:33 GMT

My pull updated all the requests so they work on Unleashed, ZD 9.x & ZD 10.x endpoints.

If you keep the ZoneDirector & Unleashed repos split...

Maybe add a note to the ZoneDirector readme that ZD 9.x users need to use the Unleashed repo (or find-replace admin10 > admin before importing the workspace).
The 2 initial steps (logon & get csrf) can be combined: turn off 'automatically follow redirects' for the logon request, and the login response headers include the csrf token.
The ZoneDirector repo has some extra requests (e.g. client list, wlan stats 2) which are also useful for Unleashed and can be converted over.

Re: Unleashed API

ms — Sat, 12 Feb 2022 18:21:50 GMT

Worked. Thanks for this!

Re: Unleashed API

ms264556 — Wed, 14 Jun 2023 05:46:46 GMT

There are now a couple of python APIs for Unleashed (and ZoneDirector), both of which will let you query active clients.

My one, aioruckus, connects to Unleashed and ZoneDirector using the AJAX endpoints (or a backup file).

Re: Unleashed API

mmMOLINARI — Thu, 15 Jun 2023 18:11:05 GMT

Great work! May I create a fork to our GitHub repository?

Re: Unleashed API

ms264556 — Fri, 16 Jun 2023 00:33:53 GMT

Sure - the license is BSD 0-clause, so you can do whatever you like with the code, with no attribution required.

Development is still quite active, so the API isn't 100% stable yet. e.g. I have a batch of changes which I'll commit next week, to write AP Groups and DPSKs, so it can be used for ZD to Unleashed migrations.

Re: Unleashed API

ms264556 — Thu, 21 Sep 2023 20:33:43 GMT

Hi Marcelo. Since I think you're the Ruckus API guy...

I would like to add discovery to the Home Assistant Ruckus_Unleashed integration but, disappointingly, mDNS service discovery is functional on all Ruckus platforms except Unleashed.

Edit:

I restarted my APs and I could see the _ruckus_unleashed._tcp service from all APs for a short time, then only from the master. Then every hour I could see "mDNSResponder (Engineering Build) (Jun 15 2023 07:52:32) stopping" followed by "mDNSResponder (Engineering Build) (Jun 15 2023 07:52:32) starting". After 28 hours there was just "mDNSResponder (Engineering Build) (Jun 15 2023 07:52:32) stopping" then nothing else.

I changed the master, which brought the service back to life again.

This time it's lasted 7 hours before it failed to restart.

Re: Unleashed API

mmMOLINARI — Tue, 12 Sep 2023 21:56:33 GMT

Can you give an example of a bad service type in Unleashed, and a good service type in SmartZone? I will send the details to the unleashed PLM

Re: Unleashed API

ms264556 — Wed, 13 Sep 2023 01:26:10 GMT

Thanks.

With a ZD1200 on my subnet I see:-ZD service

With a vSZ on my subnet I see:-
vSZ service

But I see nothing when I have an Unleashed network on my subnet.
I think the intention is that I should see a service, since usr/sbin/bonjour_mon.sh is being kept up-to-date with service types for your newer platforms.

(The two errors I showed, in the comment above, were from my Unleashed syslog).
(The screenshots are from Bonjour Browser for Windows, but I see the same results from dns-sd).

Re: Unleashed API

ms264556 — Mon, 18 Sep 2023 09:04:02 GMT

I did a restart of all the Unleashed APs today & I have the _ruckus-unleashed._tcp. service. I'll keep an eye on it to see if it goes away or not.

Definitely this is enough for me to test mDNS Discovery, but it would be good if you could raise the issue that the service vanishes sometimes.

Re: Unleashed API

mmMOLINARI — Mon, 18 Sep 2023 13:52:31 GMT

Understood. I did inform the PLM about the need of a fix already. I will keep them posted about your findings

Re: Unleashed API

PaulXtreme — Mon, 04 Mar 2024 15:17:50 GMT

Hi @mmMOLINARI Thanks a bunch for the postman scripts. I need to control the access points and block clients based on certain triggers within our programming and then re-enable them at a later time. Is this possible via unleashed or would we need additional hardware?

Re: Unleashed API

ms264556 — Sun, 17 Mar 2024 03:00:58 GMT

What actions are you wanting to take, from what triggers? and what platform are you on (I'm assuming you have some system you want to integrate with Unleashed, but maybe you are trying to do everything inside Unleashed)?

Assuming the builtin functionality, or SNMP & syslog integrations aren't suitable... I've got quite good coverage of Unleashed query functionality in aioruckus, and I've added the actions I needed (block/unblock clients, enable/disable WLANs, enable/disable AP LEDs, reboot APs, perform backups).

If you need extra actions or queries then I can add them quite easily.

Or if you need something other than python then I might also be able to help (e.g. I have JavaScript & PowerShell APIs I've been tinkering with, or the python API can be wrapped in shell scripts).