Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmulyalin/salt-nornir
SALTSTACK Nornir based proxy minion, execution, state and runner modules
https://github.com/dmulyalin/salt-nornir
network-automation network-engineers network-programming networking python
Last synced: 3 months ago
JSON representation
SALTSTACK Nornir based proxy minion, execution, state and runner modules
- Host: GitHub
- URL: https://github.com/dmulyalin/salt-nornir
- Owner: dmulyalin
- License: mit
- Created: 2020-08-22T10:40:05.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-18T12:22:27.000Z (6 months ago)
- Last Synced: 2024-01-26T11:04:34.060Z (6 months ago)
- Topics: network-automation, network-engineers, network-programming, networking, python
- Language: Python
- Homepage:
- Size: 2.83 MB
- Stars: 26
- Watchers: 4
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome-network-automation - salt-nornir - proxy minion to manage network with SaltStack and Nornir using Netmiko, NAPALM, Scrapli, Ncclient, PyGNMI, PyATS based plugins to name a few. (Salt / NETCONF)
README
[![Downloads][pepy-downloads-badge]][pepy-downloads-link]
[![PyPI][pypi-latest-release-badge]][pypi-latest-release-link]
[![PyPI versions][pypi-versions-badge]][pypi-versions-link]
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
[![Code style: black][black-badge]][black-link]
[![Documentation status][readthedocs-badge]][readthedocs-link]
![logo][logo]
# Salt Nornir
Nornir centered SaltStack modules:
- salt-nornir proxy minion module
- salt-nornir execution module
- salt-nornir state module
- salt-nornir runner module
- salt-nornir Netbox pillar module
Nornir Proxy Minion helps to manage network devices at scale, refer to
[documentation](https://salt-nornir.readthedocs.io/en/latest/index.html)
for details.
# Architecture
Python and Plugins.
![architecture][architecture]
Nornir Proxy acts as a bridge between SaltStack and a wide set of open
source network automation libraries.
# Features
- **CLI** management of devices over SSH or Telnet using Netmiko, Scrapli, Cisco Genie/PyATS or NAPALM
- **NETCONF** management of network devices using Ncclient or Scrapli-Netconf
- **HTTP API**/**RESTCONF** interact with devices using Python requests library
- **gNMI** device management supported thanks to integration with PyGNMI library
- **SNMPv1/2/3** support to manage device using puresnmp library
- **Data Processing** using NTC-Templates, TTP, Jmespath, lxml, xmltodict libraries
- **Network Testing** of state and configuration via SSH, Netconf, gNMI, HTTP or SNMP
- **Python** is a first class citizen - write plugins, modules, scripts, codify work flows
- **API** integrate with anything using SaltStack and Nornir Python API or SaltStack HTTP API
- **Netbox** Source of Truth inventory integration for infrastructure management
# Communication and discussion
Network To Code [salt-nornir Slack Channel](https://app.slack.com/client/T09LQ7E9E/C02MPR34DGF)
Open an [issue](https://github.com/dmulyalin/salt-nornir/issues)
Start a [discussion](https://github.com/dmulyalin/salt-nornir/discussions)
# Contributing
Issues, bug reports and feature requests are welcomed. Feedback is a gift and we truly value it.
# Developers Motto
- if it is not in the docs it does not exist
- if it is not tested it is broken
- done is better than perfect
- keep it stupid simple
# Want To Hire
Reach out at [[email protected]](mailto:[email protected]?subject=[GitHub]%20Salt-Nornir-Job) to discuss.
Feel like you want to [sponsor me or buy me a coffee](https://paypal.me/dmulyalin) :smiley: :coffee:.
[logo]: docs/source/_images/SaltNornirLogo.png "salt nornir logo"
[architecture]: docs/source/_images/Nornir_proxy_minion_architecture_v2.png "salt nornir architecture"
[pepy-downloads-badge]: https://pepy.tech/badge/salt-nornir
[pepy-downloads-link]: https://pepy.tech/project/salt-nornir
[pypi-versions-badge]: https://img.shields.io/pypi/pyversions/salt-nornir.svg
[pypi-versions-link]: https://pypi.python.org/pypi/salt-nornir/
[readthedocs-badge]: https://readthedocs.org/projects/salt-nornir/badge/?version=latest
[readthedocs-link]: http://salt-nornir.readthedocs.io/?badge=latest
[pypi-latest-release-badge]: https://img.shields.io/pypi/v/salt-nornir.svg
[pypi-latest-release-link]: https://pypi.python.org/pypi/salt-nornir
[github-discussions-link]: https://github.com/dmulyalin/salt-nornir/discussions
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-link]: https://github.com/psf/black
[github-tests-badge]: https://github.com/dmulyalin/salt-nornir/actions/workflows/main.yml/badge.svg
[github-tests-link]: https://github.com/dmulyalin/salt-nornir/actions