Skip to main content

Napalm-aruba-cx

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.

Prerequisites

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

Installing

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

Contributing

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

License

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

Metadata

Release files for napalm-aruba-cx 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for napalm-aruba-cx 0.1.4
File Size Uploaded Provenance Actions
napalm-aruba-cx-0.1.4.tar.gz 16.1 kB Without provenance Details for napalm-aruba-cx-0.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for napalm-aruba-cx 0.1.4
File Interpreter ABI Platform Actions
napalm_aruba_cx-0.1.4-py3-none-any.whl Python 3 none any Details for napalm_aruba_cx-0.1.4-py3-none-any.whl

Total release size: 31.9 kB

Release files / napalm-aruba-cx-0.1.4.tar.gz

Download URL napalm-aruba-cx-0.1.4.tar.gz
Size 16.1 kB
Tags Source
SHA-256 checksum
How to use checksums
bf9feafbef41b026ab31e392ab531a7965987681ca1b87c603f38641563f5ae0
BLAKE2b-256 checksum
How to use checksums
698be997840b3f172fd0080d96112f6b64eefc74e63db01bc481099868b440db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.5.0.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.1

Release files / napalm_aruba_cx-0.1.4-py3-none-any.whl

Download URL napalm_aruba_cx-0.1.4-py3-none-any.whl
Size 15.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
93e8dbf4fa7a9d9f9fffbc75e55904e837d0125d4625e447e6976de29eff0118
BLAKE2b-256 checksum
How to use checksums
444e1b0168e9d61403ecd6d0534583d845c173cd2dda4cdd9785cb46ebab16c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.5.0.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.1

Security for napalm-aruba-cx 0.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page