Getting Started with pyaoscx v2
Overview of Python and pyaoscx
What is Python?
Python is a high-level programming language that is used widely across various disciplines. Highly regarded for its simplified syntax, beginner-friendliness, and abundance of third-party libraries, Python is among the most popular programming languages in the world. The networking community especially embraces Python due in no small part to extensive vendor support as well as a low barrier of entry for getting started with automation and scripting.
pyaoscx v2 on Pypi
The latest supported version of the
pyaoscxpackage can be found here on Pypi.
Installing Python
Please refer to Python's official documentation for instructions on how to install Python3 to your machine.
Once Python is installed you're ready to install & use the pyaoscx package. For instructions on how to use the package follow Using the pyaoscx Package , for instructions on how to install the package follow Installing pyaoscx v2.
About the pyaoscx v2 Library
The pyaoscx package contains Python modules that can be called upon to access the REST API and configure various features on the switches. In order to use pyaoscx, Python 3 must be installed on your system. You can download and install Python here. The package has gone through a change in structure introduced in v2.0.0 of the package, follow the below guides that discuss how to use the package and write workflows to automate your AOS-CX switch.
The
pyaoscxpackage is compatible with Python 3 only. Python 2 is not officially supported.
pyaoscx v2.0.0+ Module Support
Module Documentation on READTHEDOCS
Detailed module documentation can be found on the
pyaoscxreadthedocs here:
Below is a table of all supported modules and platforms, for a complete feature supported list check out the Aruba Feature Navigator:
| Module⁺ | 8400 | 8360 | 8325 | 8320 | 6400 | 6300 | 6200 | 6100 | 6000 | 4100i | 10000 | 9300 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| acl.py |  | | | | | | |  | | | | |
| acl_entry.py | | | | | | | | | | | | |
| aggregate_address.py | | | | | | | | | | | | |
| api.py | | | | | | | | | | | | |
| bgp_neighbor.py | | | | | | | | | | | | |
| bgp_router.py | | | | | | | | | | | | |
| configuration.py | | | | | | | | | | | | |
| device.py | | | | | | | | | | | | |
| dhcp_relay.py | | | | | | | | | | | | |
| dns.py | | | | | | | | | | | | |
| firmware | | | | | | | | | | | | |
| interface.py | | | | | | | | | | | | |
| ipv6.py | | | | | | | | | | | | |
| mac.py | | | | | | | | | | | | |
| ospf_area.py | | | | | | | | | | | | |
| ospf_interface.py | | | | | | | | | | | | |
| ospf_router.py | | | | | | | | | | | | |
| ospf_virtual_link.py | | | | | | | | | | | | |
| ospfv3_router.py | | | | | | | | | | | | |
| poe_interface.py | | | | | | | | | | | | |
| pyaoscx_factory.py | | | | | | | | | | | | |
| pyaoscx_module.py | | | | | | | | | | | | |
| qos.py | | | | | | | | | | | | |
| qos_cos.py | | | | | | | | | | | | |
| qos_dscp.py | | | | | | | | | | | | |
| queue.py | | | | | | | | | | | | |
| queue_profile.py | | | | | | | | | | | | |
| queue_profile_entry.py | | | | | | | | | | | | |
| session.py | | | | | | | | | | | | |
| static_mac.py | | | | | | | | | | | | |
| static_nexthop.py | | | | | | | | | | | | |
| static_route.py | | | | | | | | | | | | |
| tunnel_endpoint.py | | | | | | | | | | | | |
| vlan.py | | | | | | | | | | | | |
| vni.py | | | | | | | | | | | | |
| vrf.py | | | | | | | | | | | | |
| vrf_address_family.py | | | | | | | | | | | | |
| vsx.py | | | | | | | | | | | | |
Workflows
Workflows are scripts that combine calls to functions in the pyaoscx modules to emulate large higher-level network configuration processes (e.g. create ACL and ACL entries, apply ACL on interface, and lastly enable interface). The workflows subfolder contains an example workflow showing a method on how to use the pyaoscx v2 package.
A walkthrough of the example workflow as well as guidance on creating custom workflows can be found in the Using the pyaoscx Package guide.
More example workflows will be added to this directory in the future as well as we are open to receiving community contributed workflows as well. If you are interested in contributing to this project please read the CONTRIBUTING.md within the repository and open a pull request. We also have the option for community members to contribute full projects through our Aruba devHub Code Exchange.
Updated 8 months ago