Python API to interact with Ruckus Unleashed and ZoneDirector devices.
Project description
aioruckus
A Python API which interacts with Ruckus Unleashed and ZoneDirector devices.
Compatible with all Ruckus Unleashed versions, and Ruckus ZoneDirector versions 9.10 onwards.
How to install
pip install aioruckus
Usage
Functions are defined within an async context manager, so you will have to create an event loop instead of calling the functions directly in a shell.
from aioruckus import AjaxSession, SystemStat
import asyncio
async def test_aioruckus():
async with AjaxSession.async_create("<ruckus ip>", "<ruckus user>", "<ruckus password>") as session:
ruckus = session.api
wlans = await ruckus.get_wlans()
wlan_groups = await ruckus.get_wlan_groups()
aps = await ruckus.get_aps()
ap_groups = await ruckus.get_ap_groups()
mesh = await ruckus.get_mesh_info()
default_system_info = await ruckus.get_system_info()
all_system_info = await ruckus.get_system_info(SystemStat.ALL)
active_clients = await ruckus.get_active_clients()
inactive_clients = await ruckus.get_inactive_clients() # empty on Unleashed
blocked = await ruckus.get_blocked_client_macs()
syslog = await api.get_syslog()
await ruckus.do_block_client("60:ab:de:ad:be:ef")
await ruckus.do_unblock_client("60:ab:de:ad:be:ef")
await ruckus.do_disable_wlan("my ssid")
await ruckus.do_enable_wlan("my ssid")
await ruckus.do_set_wlan_password("my ssid", "blah>blah<")
await ruckus.do_hide_ap_leds("24:79:de:ad:be:ef")
await ruckus.do_show_ap_leds("24:79:de:ad:be:ef")
await api.do_restart_ap("24:79:de:ad:be:ef")
asyncio.run(test_aioruckus())
Other Python APIs for Ruckus Unleashed
This project was originally a fork of pyuckus, which provides similar query functionality by controlling an SSH CLI session.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
aioruckus-0.23.tar.gz
(9.6 kB
view details)
Built Distribution
aioruckus-0.23-py3-none-any.whl
(10.5 kB
view details)
File details
Details for the file aioruckus-0.23.tar.gz
.
File metadata
- Download URL: aioruckus-0.23.tar.gz
- Upload date:
- Size: 9.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ab4ffbd102a157546abbd3429f7e98db4bd58223cabf116b9250d3502eda7c7 |
|
MD5 | ae3151f11dda9c0b7c0112a43e6a57e5 |
|
BLAKE2b-256 | 1998443a794eaa91cbb3aee2d1499990603b9551fe4b699ae1f1eaebda492aa5 |
Provenance
File details
Details for the file aioruckus-0.23-py3-none-any.whl
.
File metadata
- Download URL: aioruckus-0.23-py3-none-any.whl
- Upload date:
- Size: 10.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea27f1b5ee42427f16bca7c70183dd9c1d5784e7bafd1c92ee609636910c6bc1 |
|
MD5 | 3a86a1c5129fd29cfee349721db75c3e |
|
BLAKE2b-256 | bd1d653d56c5706f42ad6d3a2e890f9d0d0ce87c3c08859dee248329f2e07059 |