The AOS-CX Developer Hub

Welcome to the AOS-CX developer hub. You'll find comprehensive guides and documentation to help you start working with AOS-CX as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Installing Aruba's AOS-CX NAPALM drivers

Instructions for installing the AOS-CX NAPALM drivers

Before installation, users may want to create a Python virtual environment in order to isolate this Python project and it's dependencies. Instructions in creating a Python virtual environment and more information can be found on this page

Base Installation for Linux

The recommended way that users can start base installation of NAPALM is through pip (as pip3).

pip3 install napalm

As of release 3.0.0+, NAPALM offers support for Python 3.6+ only

Base Installation for Windows 10

Due to some support issues with dependencies, when NAPALM was updated to version 3, it created issues with Windows 10 installations. Until those dependencies are resolved, it would be safe to install with NAPALM version 2.5.0

python -m pip install napalm==2.5.0

The specific dependencies that are causing issues are fcntl and clitable, which are called through textfsm.

Installing the AOS-CX Community Driver

Similarly, users can install the AOS-CX NAPALM community driver through pip3.

pip3 install napalm-aruba-cx

Alternatively, AOS-CX NAPALM drivers can be manually installed if the directories are copied into the NAPALM folder.
If installing manually, the user also must then edit the files in the 'napalm' folder where you installed NAPALM to include "aoscx" in the list.


As listed in the requirements.txt file, the AOS-CX NAPALM driver makes use of the AOS-CX REST interface, so these dependencies are also installed.


AOS-CX NAPALM Current Support Functionality

Function Name


Get the ARP table from a device.


Get the BGP Neighbors from a device.


Get a detailed BGP neighbor from a device.


Get configuration from the device.


Get the version, serial number, vendor, model, and uptime from a device.


Get list of interfaces from a device.


Get list of interface IP addresses from a device.


Get the list of LLDP Neighbors from a device.


Get LLDP Neighbor details from a device.


Get the MAC Address table from a device.


Gets NTP information from a network device.


Shows an IP route on a device.


Get the SNMP information of a device.


Check to see if the connection to the device is up.


Execute a ping command from the device.

Updated 4 months ago

Installing Aruba's AOS-CX NAPALM drivers

Instructions for installing the AOS-CX NAPALM drivers

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.