Skip to main content

NAPALM drivers for Aruba AOS-CX Switches

Project description


NAPALM Driver implementation for AOS-CX Switches.

Supported Devices

All AOS-CX devices are supported, however the AOS-CX switch firmware should be version 10.05 or later, as some modules may have not been properly tested in older versions.

Current Support Functionality

* get_arp_table - Get the ARP table from a device.
* get_config - Get configuration from the device.
* get_facts - Get the version, serial number, vendor, model, and uptime from a device.
* get_interfaces - Get list of interfaces from a device.
* get_interfaces_ip - Get list of interface IP addresses from a device.
* get_lldp_neighbors - Get the list of LLDP Neighbors from a device.
* get_lldp_neighbors_detail - Get LLDP Neighbor details from a device.
* get_mac_address_table - Get the MAC Address table from a device.
* get_ntp_servers - Gets NTP information from a network device.
* get_route_to - Shows an IP route on a device.
* get_snmp_information - Get the SNMP information of a device.
* is_alive - Check to see if the connection to the device is up.
* ping - Execute a ping command from the device.

Early versions of this driver will focus on the Get functions.  Configuration handling is in current development.

Getting Started

For more information and guides to help get started, check out the Aruba Developer Hub section for NAPALM.


The following software is required:

  • Python3
  • Pip
  • Python modules specified in requirements.txt
    • pyaoscx v1.0.0
    • requests
    • urllib3

Note that the current version of this driver utilizes pyaoscx v1 only. Future versions of this driver will be compatible with pyaoscx v2


To install simply run:

pip3 install napalm-aruba-cx

Switch configuration

The AOS-CX driver utilizes the REST API on the switches. Depending on the switch model, this may already be enabled. If not, please use the CLI commands below to enable REST on the specified VRF.

  1. There must be a user on the switch who belongs to the "administrators group" and has a password set. This user would then be allowed to access the REST API. In the below example, replace the username "admin" and password "mypassword" with your own username and password respectively.
8320(config)# user admin group administrators password plaintext mypassword
  1. Set the access mode for the HTTPS server to "read-write" and enable the HTTPS server on the VRF through which the client making the NAPALM calls can reach the switch. In the below example, this specifies both the management VRF and the default VRF.
8320(config)# https-server rest access-mode read-write
8320(config)# https-server vrf default
8320(config)# https-server vrf mgmt


Please read CONTRIBUTING for details on our process for submitting issues and requests.


This project is licensed under the Apache License - see the LICENSE file for details

Project details

Download files

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

Files for napalm-aruba-cx, version 0.1.4
Filename, size File type Python version Upload date Hashes
Filename, size napalm_aruba_cx-0.1.4-py3-none-any.whl (15.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size napalm-aruba-cx-0.1.4.tar.gz (16.1 kB) File type Source Python version None Upload date Hashes View

Supported by

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