A simple Python wrapper for the TP-Link Omada Software Controller API
Project description
Omada API
A simple Python wrapper for the TP-Link Omada Software Controller API.
Resources
Here are some links which may be helpful when using or extending this library:
- Omada SDN Controller V5.9.9 API Document
- Omada SDN Controller V5.4.6 API Document
- Omada SDN Controller V5.0.15 API Document
- Omada SDN Controller V4.1.5 API Document
- Requirements of Establishing an External Portal Server (> 5.0.15)
- Requirements of Establishing an External Portal Server (> 4.1.5)
- Requirements of Establishing an External Portal Server (> 2.6.0)
- Requirements of Establishing an External Portal Server (< 2.5.4)
Usage
Currently this is just the bare-minimum required to log in, get site settings, push site settings, and log out.
from omada import Omada
# load our local config file
omada = Omada('omada.cfg')
# or specify the baseurl and site name directly
#omada = Omada(baseurl='https://...', site='Office')
# log into the controller (username and password are in omada.cfg)
omada.login()
# or specify the username and password directly
# omada.login(username='apiuser', password='secretpassword')
# get the site settings
settings = omada.getSiteSettings()
# turn the LEDs off
settings['led']['enable'] = False
# push the settings back
omada.setSiteSettings(settings)
# log out of the controller
omada.logout()
Examples
led.py
I use this in a cron schedule to turn my site LED setting off at night and back on in the morning.
Turn the LED on:
$ python led.py on
led: on
Turn the LED off:
$ python led.py off
led: off
clients.py, devices.py
These are simple apps to display similar output to the "Clients" and "Devices" page on the web interface.
$ python clients.py
USERNAME IP ADDRESS STATUS
00-11-22-33-44-55 192.168.1.123 CONNECTED
...
Make sure you have your Settings file configured correctly for these to work.
Settings
You can store your controller settings in a configuration file to avoid hard-coding them in your scripts.
Currently supported settings:
baseurl
- the base url to the controllersite
- the name of the site in the controller (usuallyDefault
)verify
- set this toFalse
to ignore self-signed certificate errorswarnings
- set this toFalse
to hide urllib3 warnings whenverify=False
verbose
- set this toTrue
to force low-level reqeusts to output debugging infousername
- the username to log in aspassword
- the password for the user
Example
[omada]
baseurl = https://omadacontroller.local:8043
site = Default
verify = False
username = apiuser
password = secretpassword
Acknowledgements
For my wife, who asked that I turn off the device LEDs at night. :heart:
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
Built Distribution
Hashes for omada_api-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a539c12b41559b14bb5b4af71987f03bc7972afde7b8eb0cd6e97f580c62838 |
|
MD5 | f1a42beb069c00b4923ca74ab81137ff |
|
BLAKE2b-256 | 0e85921c58734add3b7d8e4468ceb556aeefabd9cca97deb054f21da1662c17a |