{"id":13609509,"url":"https://github.com/napalm-automation/napalm","last_synced_at":"2025-05-11T03:50:51.868Z","repository":{"id":723402,"uuid":"32737992","full_name":"napalm-automation/napalm","owner":"napalm-automation","description":"Network Automation and Programmability Abstraction Layer with Multivendor support","archived":false,"fork":false,"pushed_at":"2025-05-08T14:52:41.000Z","size":7528,"stargazers_count":2322,"open_issues_count":165,"forks_count":567,"subscribers_count":148,"default_branch":"develop","last_synced_at":"2025-05-08T17:17:19.432Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/napalm-automation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing/core.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/support/.gitignore","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-03-23T14:43:45.000Z","updated_at":"2025-05-08T16:37:47.000Z","dependencies_parsed_at":"2024-04-28T01:56:18.134Z","dependency_job_id":"dbf8bb21-9635-4a9a-9a95-08f7fc4df33b","html_url":"https://github.com/napalm-automation/napalm","commit_stats":{"total_commits":3280,"total_committers":212,"mean_commits":"15.471698113207546","dds":0.811890243902439,"last_synced_commit":"8e7d663e0f4432e7a896becc34c16b103d9a26d0"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/napalm-automation%2Fnapalm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/napalm-automation%2Fnapalm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/napalm-automation%2Fnapalm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/napalm-automation%2Fnapalm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/napalm-automation","download_url":"https://codeload.github.com/napalm-automation/napalm/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253514567,"owners_count":21920334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T19:01:35.477Z","updated_at":"2025-05-11T03:50:51.822Z","avatar_url":"https://github.com/napalm-automation.png","language":"Python","funding_links":[],"categories":["Networking","Python","others","网络虚拟化","Network Virtualization","网络可视化和 SDN","Network Virtualization [🔝](#readme)","Library","资源列表","Awesome Python","Uncategorized","Libraries"],"sub_categories":["NETCONF","网络可视化和 SDN","Networking","Uncategorized","Python"],"readme":"[![PyPI](https://img.shields.io/pypi/v/napalm.svg)](https://pypi.python.org/pypi/napalm)\n[![PyPI versions](https://img.shields.io/pypi/pyversions/napalm.svg)](https://pypi.python.org/pypi/napalm)\n[![Actions Build](https://github.com/napalm-automation/napalm/actions/workflows/commit.yaml/badge.svg?branch=develop)](https://github.com/napalm-automation/napalm/actions/workflows/commit.yaml)\n[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n\nNAPALM\n======\nNAPALM (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.\n\n![NAPALM logo](static/logo.png?raw=true \"NAPALM logo\")\n\nNAPALM supports several methods to connect to the devices, to manipulate configurations or to retrieve data.\n\nSupported Network Operating Systems\n-----------------------------------\n\nPlease check the following [link](https://napalm.readthedocs.io/en/latest/support/index.html) to see which devices are supported. Make sure you understand the [caveats](https://napalm.readthedocs.io/en/latest/support/index.html#caveats).\n\nDocumentation\n=============\n\nBefore using the library, please read the documentation at: [Read the Docs](https://napalm.readthedocs.io)\n\nYou can also watch a [live demo](https://youtu.be/93q-dHC0u0I) of NAPALM to see what it is and what it can do for you.\n\nInstall\n=======\n\n```\npip install napalm\n```\n\n*Note*: Beginning with release 5.1.0 and later, NAPALM offers support for\nPython 3.9+ only.\n\n*Note*: Beginning with release 5.0.0 and later, NAPALM offers support for\nPython 3.8+ only.\n\n*Note*: Beginning with release 4.0.0 and later, NAPALM offers support for\nPython 3.7+ only.\n\n\nUpgrading\n=========\n\nWe 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:\n\n```\npip install napalm -U\n```\n\nWe will be posting news on our slack channel and on Twitter.\n\n\nAutomation Frameworks\n======================\n\nDue to its flexibility, NAPALM can be integrated in widely used automation frameworks.\n\n\nAnsible\n-------\n\nPlease check [napalm-ansible](https://github.com/napalm-automation/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.\n\n\nSaltStack\n---------\n\nBeginning with release code named `Carbon` (2016.11), [NAPALM is fully integrated](https://mirceaulinic.net/2016-11-30-salt-carbon-released/) in SaltStack - no additional modules required. For setup recommendations, please see [napalm-salt](https://github.com/napalm-automation/napalm-salt). For documentation and usage examples, you can check the modules documentation, starting from the [release notes](https://docs.saltstack.com/en/develop/topics/releases/2016.11.0.html#network-automation-napalm) and [this blog post](https://mirceaulinic.net/2016-11-17-network-orchestration-with-salt-and-napalm/).\n\nStackStorm\n----------\n\nNAPALM is usable from StackStorm using the [NAPALM integration pack](https://github.com/StackStorm-Exchange/stackstorm-napalm). 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/](https://docs.stackstorm.com/), and StackStorm can be easily spun up for testing using [Vagrant](https://github.com/StackStorm/st2vagrant) or [Docker](https://github.com/StackStorm/st2-docker).\n\n\nContact\n=======\n\nSlack\n-----\n\nSlack is probably the easiest way to get help with NAPALM. You can find us in the channel `napalm` on the [network.toCode()](https://networktocode.herokuapp.com/) team.\n\nFAQ\n---\n\nIf 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:\n\n- Make sure you have the latest release installed. We release very often, so upgrading to the latest version might help in many cases.\n- Double check you are able to access the device using the credentials provided.\n- Does your device meet the minimum [requirements](http://napalm.readthedocs.io/en/latest/support/index.html#general-support-matrix)?\n- Some operating systems have some specific [constraints](http://napalm.readthedocs.io/en/latest/support/index.html#caveats). (e.g. have you enabled the XML agent on IOS-XR, or the NXAPI feature on NXOS?)\n- Are you able to connect to the device using NAPALM? Check using napalm CLI to get_facts:\n\n```bash\n$ napalm --vendor VENDOR --user USERNAME --password PASSWORD --optional_args OPTIONAL_ARGS HOSTNAME call get_facts\n```\n\nWhere vendor, username, password and hostname are mandatory. [Optional arguments](http://napalm.readthedocs.io/en/latest/support/index.html#optional-arguments) are specified as comma separated values.\n\nExample:\n\n```bash\n$ napalm --vendor junos --user napalm --password dbejmujz --optional_args 'port=12202, config_lock=False' edge01.bjm01 call get_facts\n```\n\nIn case you have any errors, please review the steps above - this looks like a problem with your environment setup.\n\nIn order to get help faster, when submitting a bug/error make sure to include all the details requested.\n\nNews\n====\n\nBlog Posts\n----------\n\n* [NAPALM, Ansible, and Cisco IOS](https://pynet.twb-tech.com/blog/automation/napalm-ios.html) by Kirk Byers\n* [Adding Cisco IOS support to NAPALM (Network Automation and Programmability Abstraction Layer with Multivendor support)](https://projectme10.wordpress.com/2015/12/07/adding-cisco-ios-support-to-napalm-network-automation-and-programmability-abstraction-layer-with-multivendor-support/) by Gabriele Gerbino\n* [Network orchestration with Salt and NAPALM](https://mirceaulinic.net/2016-11-17-network-orchestration-with-salt-and-napalm/) by Mircea Ulinic\n* [Network Configuration Consistency with StackStorm and NAPALM](https://stackstorm.com/2017/04/11/ensuring-network-configuration-consistency-stackstorm-napalm/) by Matt Oswalt\n\nPresentations\n-------------\n\n* [NANOG 64 Presentation \u0026 Demo](https://youtu.be/93q-dHC0u0I) by David Barroso and Elisa Jasinska\n* [Netnod Autumn Meeting 2015 Presentation](https://www.netnod.se/sites/default/files/NAPALM-david_barroso-Netnodautumnmeeting2015.pdf) by David Barroso\n* [Automating IXP Device Configurations with Ansible at the Euro-IX Forum](https://www.euro-ix.net/m/uploads/2015/10/26/euroix-berlin-v2.pdf) by Elisa Jasinska\n* [Network Automation with Salt and NAPALM at NANOG 68](https://www.nanog.org/sites/default/files/NANOG68%20Network%20Automation%20with%20Salt%20and%20NAPALM%20Mircea%20Ulinic%20Cloudflare%20(1).pdf); [video](https://www.youtube.com/watch?v=gV2918bH5_c); [recorded demo](https://www.youtube.com/watch?v=AqBk5fM7qZ0) by Mircea Ulinic\n\nPodcasts\n--------\n\n* [NAPALM: Integrating Ansible with Network Devices on Software Gone Wild](http://blog.ipspace.net/2015/06/napalm-integrating-ansible-with-network.html) with David Barroso and Elisa Jasinska\n\nAuthors\n=======\n * David Barroso ([dbarrosop@dravetech.com](mailto:dbarrosop@dravetech.com))\n * Mircea Ulinic ([ping@mirceaulinic.net](mailto:ping@mirceaulinic.net))\n * Kirk Byers ([ktbyers@twb-tech.com](mailto:ktbyers@twb-tech.com))\n * Elisa Jasinska ([elisa@bigwaveit.org](mailto:elisa@bigwaveit.org))\n * Many others, check the [contributors](https://github.com/napalm-automation/napalm/graphs/contributors) page for details.\n\n\nThanks\n======\n\nThis project is maintained by David Barroso, Mircea Ulinic, and Kirk Byers and a set of other contributors.\n\nOriginally it was hosted by the [Spotify][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][spotify] for the support.\n\n[spotify]: http://www.spotify.com\n[bigwave]: http://bigwaveit.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnapalm-automation%2Fnapalm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnapalm-automation%2Fnapalm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnapalm-automation%2Fnapalm/lists"}