Skip to main content

Collection of API functions for Aruba products.

Project description


API connector for ArubaOS products

APIs supported:

  • ArubaOS-S Switches
  • ArubaOS-CX Switches


Every type of API has an API caller class. You can create instances of that class with at least three arguments:

  • Username
  • Password
  • URL / IP / FQDN address of the device
data = { "url": "",
  "username": "admin",
  "password": "Aruba123",
  "api_version": "v10.04"
aocx_test = AOSCXAPIClient(**data)

After creating the device, use connect() to create a session. Then use the other functions to use the API. When you are finished use disconnect() to logout.

Please note that there is no syntax check!

Some parameters are case sensitive. For example, api_version, there is no check for "V7" or "v7", but only "v7" will work.


Examples can be found in the example folder.

Differences between classes

The functions between the two classes should have the same name, if they end up doing the same. So both classes have connect(), disconnect() or get_vlans() even if they are implemented differently.


I am working on implementing more functions and to create classes for the ClearPass and ArubaOS WLAN APIs. After that I will create workflows spanning different APIs.

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

aos-api-connector-0.1.0.tar.gz (18.1 kB view hashes)

Uploaded source

Built Distribution

aos_api_connector-0.1.0-py3-none-any.whl (47.6 kB view hashes)

Uploaded py3

Supported by

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