Name: napalm
Owner: Netflix-Skunkworks
Description: Network Automation and Programmability Abstraction Layer with Multivendor support
Created: 2016-07-21 16:15:12.0
Updated: 2016-07-21 16:15:12.0
Pushed: 2016-07-21 16:15:48.0
Size: 1118
Language: Python
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
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.
Please check the following link to see which devices are supported. Make sure you understand the caveats.
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.
If you want to fully install NAPALM you can do it by executing:
install napalm
That will install all the drivers currently available.
If you want to install just a subset of the available modules you can just pick them as follows:
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:
uninstall napalm-junos
install napalm-ios
Check the 'Supported Network Operating Systems' section for more information about supported modules.
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:
install napalm -U
or:
install napalm-eos napalm-junos -U
We will be posting news on our slack channel and on Twitter (more details soon).
Due to its flexibility, NAPALM can be integrated in widely used automation frameworks.
Please check 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.
NAPALM will be completely integrated in Salt beginning with the release code named Carbon. For usage examples, please check naplam-salt.
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 is probably the easiest way to get help with NAPALM. You can find us in the channel napalm on the network.toCode() team.
If you have any issues using NAPALM or encounter any errors, before submitting any questions (directly by email or on Slack), please go through the following checklist:
_napalm_test --vendor VENDOR --user USERNAME --password PASSWORD --optional_args OPTIONAL_ARGS HOSTNAME
Where vendor, username, password and hostname are mandatory. Optional arguments are specified as comma separated values.
Example:
_napalm_test --vendor junos --user napalm --password dbejmujz --optional_args 'port=12202, config_lock=False' edge01.bjm01
In case you have any errors, please review the steps above - this looks like a problem with your environment setup.
In order to get help faster, when submitting a bug/error make sure to include all the details requested.
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.