Skip to main content

Python API for UniFi accesspoints

Project description

unifi_ap

Python API for UniFi accesspoints

Installation

  • pip install unifi_ap

Usage

currently this package can only be used by importing it into own python files

import unifi_ap
ap = UniFiAP("10.0.0.253", "admin")
clients = ap.get_clients()
ssids = ap.get_ssids()
clients_for_ssid = ap.get_clients(for_ssids=["guest"])
  • Address/hostname and username are mandatory
  • if you don't define a password, ssh keys from the local ssh authentication agent are used
  • in addition/alternative to a password you can also define a private key file to be used for the authentication

UniFiAP("10.0.0.253", "admin", keyfile="my-rsa.key")

Features

  • get a list of SSIDs that the accesspoint is serving
  • get currently connected clients (you can specify the SSIDs for which you want to get the clients - default: all)

Credits

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unifi_ap-0.0.1.tar.gz (3.8 kB view hashes)

Uploaded Source

Built Distribution

unifi_ap-0.0.1-py3-none-any.whl (3.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page