NAPALM
NAPALM (Network Automation and Programmability Abstraction Layer with Multivendor support) is a Python library that implements a set of functions to interact with different router vendor devices using a unified API.
NAPALM supports several methods to connect to the devices, to manipulate configurations or to retrieve data.
Supported Network Operating Systems
Please check the following link to see which devices are supported. Make sure you understand the caveats.
Documentation
Before using the library, please read the documentation at: Read the Docs
You can also watch a live demo of NAPALM to see what it is and what it can do for you.
Install
Full installation
If you want to fully install NAPALM you can do it by executing:
pip install napalm
That will install all the drivers currently available.
Partial Installation
If you want to install just a subset of the available modules you can just pick them as follows:
pip install napalm-eos napalm-junos
That will install only the eos and the junos drivers. If you want to remove or add a module later on you can just use pip to do it:
pip uninstall napalm-junos
pip install napalm-ios
Check the 'Supported Network Operating Systems' section for more information about supported modules.
Upgrading
We plan to upgrade napalm as fast as possible. Adding new methods and bugfixes. To upgrade napalm it's a simple as repeating the steps you performed while installing but adding the -U flag. For example:
pip install napalm -U
or:
pip install napalm-eos napalm-junos -U
We will be posting news on our slack channel and on Twitter (more details soon).
Ansible
Please ckeck napalm-ansible for existing Ansible modules leveraging the NAPALM API. Make sure you read the documentation and you understand how it works before trying to use it.
Contact
Mailing List
If you have any questions, join the users' mailing list at napalm-automation@googlegroups.com and if you are developer and want to contribute to NAPALM feel free to join to the developers' mailing list at napalm-dev@googlegroups.com
Slack
Slack is probably the easiest way to get help with NAPALM. You can find us in the channel napalm on the network.toCode() team.
News
Blog Posts
- NAPALM, Ansible, and Cisco IOS by Kirk Byers
- Adding Cisco IOS support to NAPALM (Network Automation and Programmability Abstraction Layer with Multivendor support) by Gabriele Gerbino
Presentations
- NANOG 64 Presentation & Demo by David Barroso and Elisa Jasinska
- Netnod Autumn Meeting 2015 Presentation by David Barroso
- Automating IXP Device Configurations with Ansible at the Euro-IX Forum by Elisa Jasinska
Podcasts
- NAPALM: Integrating Ansible with Network Devices on Software Gone Wild with David Barroso and Elisa Jasinska
Authors
- David Barroso (dbarrosop@dravetech.com)
- Elisa Jasinska (elisa@bigwaveit.org)
- Many others, check the contributors page for details.
Thanks
This project was founded by David Barroso as part of Spotify and Elisa Jasinska as part of BigWave IT. Originally it was hosted by the Spotify organization but due to the many contributions received by third parties we agreed creating a dedicated organization for NAPALM and give a big thanks to Spotify for the support.