Wired Intelligent Edge (Campus Switching and Routing)

This community is currently in a read-only state due to a maintenance window. For more info click here
Occasional Contributor II

Work in Progress: Python API integration

Hey guys,


during the Corona times, I had some time and kept working on a general integration for the switch APIs in Python. 

The package is available on GitHub and PyPi


Installation is as easy as any other package, just run 

pip install aos-api-connector


There are currently classes for AOS-S, AOS-CX and ClearPass. Although ClearPass is very rudimentary and does not have many functions implemented by now.


Please feel free to look through the functions and give feedback. 


Usage and examples are in the readme of the project pages. 

For example, when using an AOS-S switch:

You get the login data, create a switch instance, connect, work, disconnect.

from aos_api_connector.aos_s import aos_api_caller as aos_s

data = { "url": "",
  "username": "admin",
  "password": "Aruba123",
  "api_version": "v7"
switch = aos_s.AOSSwitchAPIClient(**data)
sys_info = switch.get_system_info()
vlan = switch.get_vlans()


I wanted to share it with you, maybe someone wants to use it as it is. 

I will continue to work on it and will integrate more complex workflows in the future.




MVP Guru Elite

Re: Work in Progress: Python API integration



nice work !


I think, you need to post also on Developer section.


Do you have look also pyaoscx because i think you make the same stuff (for ArubaCX !)

PowerArubaSW: Powershell Module to use Aruba Switch API for Vlan, VlanPorts, LACP, LLDP... More info

PowerArubaCP: Powershell Module to use ClearPass API (create NAD, Guest...) More info

PowerArubaCX: Powershell Module to use ArubaCX API (get interface/vlan/ports info)

PowerArubaIAP: Powershell Module to use Aruba Instant AP

PowerArubaMC: Powershell Module to use Mobility Controller / Master

ACMP 6.4 / ACMX #107 / ACCP 6.5 / ACSP
Search Airheads
Showing results for 
Search instead for 
Did you mean: