Network Automation and Programmability Abstraction Layer with Multivendor support

napalm-automation

Last update: Dec 31, 2022

Related tags

Network Virtualization napalm

Overview

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

pip install napalm

Note: Beginning with release 3.0.0 and later, NAPALM offers support for Python 3.6+ only.

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

We will be posting news on our slack channel and on Twitter.

Automation Frameworks

Due to its flexibility, NAPALM can be integrated in widely used automation frameworks.

Ansible

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.

SaltStack

Beginning with release code named Carbon (2016.11), NAPALM is fully integrated in SaltStack - no additional modules required. For setup recommendations, please see napalm-salt. For documentation and usage examples, you can check the modules documentation, starting from the release notes and this blog post.

StackStorm

NAPALM is usable from StackStorm using the NAPALM integration pack. See that repository for instructions on installing and configuring the pack to work with StackStorm. General StackStorm documentation can be found at https://docs.stackstorm.com/, and StackStorm can be easily spun up for testing using Vagrant or Docker.

Contact

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.

FAQ

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:

Make sure you have the latest release installed. We release very often, so upgrading to the latest version might help in many cases.
Double check you are able to access the device using the credentials provided.
Does your device meet the minimum requirements?
Some operating systems have some specific constraints. (e.g. have you enabled the XML agent on IOS-XR, or the NXAPI feature on NXOS?)
Are you able to connect to the device using NAPALM? Check using napalm CLI to get_facts:

$ napalm --vendor VENDOR --user USERNAME --password PASSWORD --optional_args OPTIONAL_ARGS HOSTNAME call get_facts

Where vendor, username, password and hostname are mandatory. Optional arguments are specified as comma separated values.

Example:

$ napalm --vendor junos --user napalm --password dbejmujz --optional_args 'port=12202, config_lock=False' edge01.bjm01 call get_facts

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.

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
Network orchestration with Salt and NAPALM by Mircea Ulinic
Network Configuration Consistency with StackStorm and NAPALM by Matt Oswalt

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
Network Automation with Salt and NAPALM at NANOG 68; video; recorded demo by Mircea Ulinic

Podcasts

NAPALM: Integrating Ansible with Network Devices on Software Gone Wild with David Barroso and Elisa Jasinska

Authors

David Barroso ([email protected])
Mircea Ulinic ([email protected])
Kirk Byers ([email protected])
Elisa Jasinska ([email protected])
Many others, check the contributors page for details.

Thanks

This project is maintained by David Barroso, Mircea Ulinic, and Kirk Byers and a set of other contributors.

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.

Comments

[WIP] Show IP of all VRF on nxos

If a VRF is not specified in the nxos command, it will only show the default vrf IP. As the vrf cannot be specified in the method, now it doesn't restrict the result to one vrf.

The SSH parser needed to be fixed to allow multiple VRF

opened by aruhier 24
VLAN getters

Following on from a discussion in NTC slack. Adding VLAN getters would be a nice addition IMO. @ktbyers mentioned that he is open to at least a discussion on adding VLAN getters.

Some closed issues in this topic from the past https://github.com/napalm-automation/napalm/issues/571 https://github.com/napalm-automation/napalm-base/issues/252

I need this functionality for mainly Junos and Cumulus drivers so can focus my energy there if there is some agreement to move forward.

CC @jobec
new method feature api change

opened by bwks 23
IOS method commit_config running is too slow

I use 'load_merge_candidate' method spend about 1~3s, but 'commit_config' can spend about 1minutes. That‘s insane. when i use cli-command to change my password, I type every words just spend 20 seconds. Please check this issue.
bug ios Info needed

opened by Laurel-rao 23
add canonical_interface

Added canonical_interface and updated some linter complaints when I first had everything in string_parsers.py.

Didn't want to go to crazy until I had consensus on naming and implementation.
enhancement base

opened by itdependsnetworks 23
DO NOT Merge: NX-OS XML Support

After discussions with Matthew Schwen he made a strong argument that we should be using XML and neither NX-OS JSON nore NX-OS Text (screen-scraping).

This long-term proposal would be to implement NX-OS XML Support for both NX-API and for NX-OS SSH and to deprecate both the JSON getter parsing the Text getter parsing.

The configuration operations would need some more research.

The parsing of the XML output data would be decoupled from the transport (NX-API or SSH) and we would intend to use the same parsing for both.

I think in the long-run this will give us less maintenance and less technical debt in the NX-OS support and a better overall solution.

I will add some more details below.
enhancement vendor bug nxos nxos-ssh Info needed pending discussion

opened by ktbyers 21
don't remove file prompt quiet unnecessarily

If file prompt quiet is already present in the config at the start of an operation, napalm shouldn't remove it. This is fixed by checking the running-config during _disable_confirm(), and setting a flag (IOSDriver._do_enable_confirm) to indicate whether the configuration line ought to be removed during later calls to _enable_confirm(). A RuntimeError is raised if the attribute does not exist, since this indicates that the methods were called in the incorrect order. The configuration line is also removed from ignore_strings within _normalize_compare_config() since this line will only be present in the diff when it is included in either the candidate and/or (existing) running configs. In that case, a change in that command should show up in coompare_config().

opened by benmaddison 21
adding optional arguments for load_replace_candidate

We need option for autoComplete, timeStamp and expandAliases

I ran into an issue where using load_replace_candidate failed because of the autoComplete is False

I had two commands back to back: router bgp 1 router multicast

Since I had autoComplete False as default, the router multicast was considered as 'router-id multicast'. This is only because 'router' is valid under bgp configuration.

Submitting a change here to add optional arguments
enhancement core

opened by bharath-ravindranath 21

Junos SRX cluster get_environment() returns null. 15.1X49-D130.6

Description of Issue/Question

Note: Please check https://guides.github.com/features/mastering-markdown/ to see how to properly format your request.

Did you follow the steps from https://github.com/napalm-automation/napalm#faq

(Place an x between the square brackets where applicable)

[X] Yes
[] No

Setup

napalm version

(Paste verbatim output from pip freeze | grep napalm between quotes below)

napalm==2.5.0

Network operating system version

(Paste verbatim output from show version - or equivalent - between quotes below)

node0:
--------------------------------------------------------------------------
Hostname: node0
Model: srx345-dual-ac
Junos: 15.1X49-D130.6
JUNOS Software Release [15.1X49-D130.6]

node1:
--------------------------------------------------------------------------
Hostname: node1
Model: srx345-dual-ac
Junos: 15.1X49-D130.6
JUNOS Software Release [15.1X49-D130.6]

Steps to Reproduce the Issue

Error Traceback

(Paste the complete traceback of the exception between quotes below)

No errors, per se.  Just empty dataset being returned.

I inspected the elements at:
https://github.com/napalm-automation/napalm/blob/develop/napalm/junos/junos.py#L381

And also `environment_data` at:
https://github.com/napalm-automation/napalm/blob/develop/napalm/junos/junos.py#L381

All elements are empty.  I confirmed connectivity and results being returned with the `get_facts()` which does indeed work as desired.

bug vendor bug junos

opened by mcroff-wish 20

add recording/replaying commands capability
This adds back the capability for recording/replaying commands. Two main use cases are:

Compliance.

Build easily reproducible tests and demos.

From the previous discussion we had, @mirceaulinic didn't like the use of camel library. For reference, camel is a lightweight library that builds on top of pyyaml to ensure serialized/deserialized data is safe.

To do:

Discuss if camel is still an issue and look for alternatives or just "vendor" the library and add it directly without adding it as a requirement.

Check with @itdependsnetworks if this does what he needs

Upon agreement: a. Hook the recorder to rest of core drivers b. Remove test/demo code c. See how to connect this with the testing framework so people can reproduce issues and provide test cases by using the recording feature.

enhancement core
opened by dbarrosop 20
Add vrf paramter to get_arp_table()
Update all drivers get_arp_table signature to accept a VRF name, and create test.

[x] Base/testcase

[x] EOS

[x] EOS mocked data

[x] IOS

[ ] IOS mocked data

[ ] IOS-XR

[ ] IOS-XR mocked data

[x] JunOS

[ ] JunOS mocked data

[ ] NX-OS

[ ] NX-OS mocked data

[ ] NX-OS (SSH)

[ ] NX-OS (SSH) mocked data

enhancement help wanted junos iosxr ios eos nxos nxos-ssh api change
opened by bewing 20
Turning napalm into a metapackage

This PR turns napalm into a 'metapackage'. From a user perspective, nothing should change. From a code perspective this means that napalm doesn't have code anymore and it just leverages on the other individual repos.

Napalm should contain only the documentation, guidelines and serve as a single entry point to get napalm fully deployed.

@fooelisa @mirceaulinic @ktbyers would you mind testing this PR? If you have some code that uses napalm today I would appreciate if you could try to run it installing napalm from my fork.

opened by dbarrosop 20
[IOSXR ] napalm get interfaces ip returns ipv4 adresse : 0.0.0.0/0 ?
Description of Issue/Question

Note: Please check https://guides.github.com/features/mastering-markdown/ to see how to properly format your request.

Did you follow the steps from https://github.com/napalm-automation/napalm#faq

(Place an x between the square brackets where applicable)

[X] Yes

[] No

Setup

I have an ansible-napalm napalm_get_facts with interfaces_ip filter (like get_interfaces_ip in python napalm)

napalm version

(Paste verbatim output from pip freeze | grep napalm between quotes below)

[napalm](https://pypi.python.org/pypi/napalm)==4.0.0 [napalm-ansible](https://pypi.python.org/pypi/napalm-ansible)==1.1.0

Network operating system version

(Paste verbatim output from show version - or equivalent - between quotes below)

[ansible](https://pypi.python.org/pypi/ansible)==2.10.0 [ansible-base](https://pypi.python.org/pypi/ansible-base)==2.10.6 [ansible-inventory-grapher](https://pypi.python.org/pypi/ansible-inventory-grapher)==2.4.4

Steps to Reproduce the Issue

When interface (Cisco) has ipv4 unreachables disabled, napalm returns : ipv4 : 0.0.0.0/0 ?? Is this normal ? The interface config (CLI): interface GigabitEthernet0/0/0/5 description -Z-- LIBRE ---- ipv4 unreachables disable shutdown !

Error Traceback

(Paste the complete traceback of the exception between quotes below)
opened by ansible75013 0
Bump sphinx from 1.8.6 to 6.0.0
Bumps sphinx from 1.8.6 to 6.0.0.

Release notes

Sourced from sphinx's releases.

v6.0.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.0.0b2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.3.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.3

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.0

No release notes provided.

v5.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.5.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.4.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.3.1

No release notes provided.

Changelog

Sourced from sphinx's changelog.

Release 6.0.0 (released Dec 29, 2022)

Dependencies

#10468: Drop Python 3.6 support

#10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner

Incompatible changes

#7405: Removed the jQuery and underscore.js JavaScript frameworks.

These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the jQuery, $, or $u global objects, you need to update your JavaScript to modern standards, or use the mitigation below.

The first option is to use the sphinxcontrib.jquery_ extension, which has been developed by the Sphinx team and contributors. To use this, add sphinxcontrib.jquery to the extensions list in conf.py, or call app.setup_extension("sphinxcontrib.jquery") if you develop a Sphinx theme or extension.

The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy jquery.js and underscore.js from the Sphinx repository_ to your static directory, and add the following to your layout.html:

.. code-block:: html+jinja

{%- block scripts %} {{ super() }} {%- endblock %}

.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/

Patch by Adam Turner.

#10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:dev-deprecated-apis for details. Patch by Adam Turner.

#10901: C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables c_allow_pre_v3 and c_warn_on_allowed_pre_v3. Patch by Adam Turner.

Features added

... (truncated)

Commits

5b56a23 Bump to 6.0.0 final

f1d1e9c Update coverage workflow for Tox 4

66a738c Update coverage workflow for new configuration location

041e5f8 Add test coverage for 'today_fmt' reference substitution (#10980)

da25145 Remove unnecessary conditional import in sphinx.ext.napoleon (#11043)

45a0ea9 Migrate coveragepy config into pyproject.toml (#11025)

3ec54f1 Create a pydata_sphinx_theme section in usage examples (#11046)

32bce8f Copy edit the tutorial (#11049)

9844162 Fix example using add_config_value (#10937)

bf4a626 RTD builder: add graphviz depedendency (#11040)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependency issue
opened by dependabot[bot] 0
Add tolerance percentage to validate

This pr adds the ability to validate based on a percentage tolerance either side of the specified value (useful for BGP prefixes). I was trying to keep it as close to existing operators ("<d", ">d", "d<->d"), in the end came up with "t%d". The logic behind it is that a tolerance of "t percent of d" is allowed either side of the value of d. For example "10%100" would be 10% of 100, so a value between 90 and 110 is accepted. I didnt really want to use a % sign but couldn't think of a better way to represent this. Have done tests and docs that I could find, let me know if need anything else.

opened by sjhloco 0

Junos: get_snmp_information returns blank dict

Description of Issue/Question

The output from get_snmp_information is returning a blank dict, looks to be the return from line 1507 in the code is not as expected so the subsequent .items() on line 1509 is not evaluating as True so we get the blank dict from snmp_information from the if on line 1511

I was able to modify the config to add test keys to the dict to confirm it was returning at that point

Other calls work fine, get_facts for example as shown in the details below.

I suspect the problem is around the junos_views yaml file but I'm not sure where to start dissecting it to resolve the issue