https://github.com/tes3awy/netmiko-examples

Netmiko and Requests Examples for Cisco DevNet
https://github.com/tes3awy/netmiko-examples

api automation cisco-ios cisco-nxos ciscodevnet examples-netmiko examples-python netmiko openpyxl pandas pandas-python python python3 requests-python vscode xlsxwriter

Last synced: 5 months ago
JSON representation

Netmiko and Requests Examples for Cisco DevNet

• Host: GitHub
• URL: https://github.com/tes3awy/netmiko-examples
• Owner: Tes3awy
• License: mit
• Created: 2021-05-20T05:02:16.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-03-16T08:34:13.000Z (over 3 years ago)
• Last Synced: 2025-04-06T14:12:00.326Z (6 months ago)
• Topics: api, automation, cisco-ios, cisco-nxos, ciscodevnet, examples-netmiko, examples-python, netmiko, openpyxl, pandas, pandas-python, python, python3, requests-python, vscode, xlsxwriter
• Language: Python
• Homepage:
• Size: 188 KB
• Stars: 3
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
> **Last updated: March 16th, 2022**

![Cisco DevNet](https://img.shields.io/badge/Cisco-DevNet-blue?style=flat-square)

[![Python 3.6+](https://img.shields.io/badge/Python%203.6+-blue.svg?logo=python&logoColor=yellow&color=black&style=flat-square)](https://www.python.org/downloads)

![Language](https://img.shields.io/github/languages/top/Tes3awy/Netmiko-Examples?label=Python&style=flat-square)

![Repo Size](https://img.shields.io/github/repo-size/Tes3awy/Netmiko-Examples?label=Repo%20size&style=flat-square)

[![Issues Open](https://img.shields.io/github/issues/Tes3awy/Netmiko-Examples?label=Issues&style=flat-square)](https://github.com/Tes3awy/Netmiko-Examples/issues)

![Releases Download](https://img.shields.io/github/downloads/Tes3awy/Netmiko-Examples/total?color=purple&label=Downloads&style=flat-square)

[![Commit Activity](https://img.shields.io/github/commit-activity/m/Tes3awy/Netmiko-Examples?color=orange&label=Commit%20activity&style=flat-square)](https://github.com/Tes3awy/Netmiko-Examples)

![Last Commit](https://img.shields.io/github/last-commit/Tes3awy/Netmiko-Examples?label=Last%20commit&style=flat-square)

[![License](https://img.shields.io/github/license/Tes3awy/Netmiko-Examples?label=License&style=flat-square&color=purple)](https://github.com/Tes3awy/Netmiko-Examples/blob/main/LICENSE)

[![Black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat-square&labelColor=ef8336)](https://pycqa.github.io/isort/)

[![Pre-Commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square)](https://github.com/pre-commit/pre-commit)

# Netmiko & Requests Examples for Cisco DevNet

- In `netmiko` folder, you will find 18 Python examples, `device_list.csv` file, `config-sample-ex8.txt` file, a `requirements.txt` file, and an explanation of each example.

- In `requests` folder, you will find seven Python examples, a `requirements.txt` file, and an explanation of each example.

## How to use?

1. `Clone` this repo or `Download ZIP` by clicking on  up above.

   _(Alternativley, you can click on Releases on the right hand side and download the latest release)_

2. Once downloaded, extract the ZIP file and `cd` into `netmiko` folder or `requests` folder.

3. Open `netmiko` or `requests` folder in VSCode.

4. Open `requirements.txt` file and if any of the libraries is not installed on your PC, run the following command in the PowerShell terminal:

```powershell

path_to\folder> cd netmiko

netmiko> pip install -r requirements.txt --user ↵

path_to\folder> cd requests

requests> pip install -r requirements.txt --user ↵

```

> If the libraries already installed but not the same version as in `requirements.txt`, then add `--upgrade` flag to the `pip install` command:

```powershell

path_to\folder> pip install -r requirements.txt --user --upgrade ↵

```

5. Explore each `example*.py` file. _**(where **\*** is the number of the example)**_

6. Run any Python example by typing the following command in PowerShell terminal _(Either integrated terminal in VSCode or standablone Windows PowerShell/CMD)_:

```powershell

path_to\folder> python example*.py ↵

```

---

## Libraries Documentation Links

Examples in `netmiko` and `requests` folder uses some Python libraries. These libraries are:

1. Netmiko **v3.4.0** (Multi-vendor library to simplify Paramiko SSH connections to network devices) [Documentation Link](https://github.com/ktbyers/netmiko/blob/develop/README.md)

2. NTC Templates **v3.0.0** (TextFSM templates for parsing show commands of network devices) [Documentation Link](https://github.com/networktocode/ntc-templates)

3. XlsxWriter **v3.0.3** (XlsxWriter is a Python module for creating Excel XLSX files) [Documentation Link](https://xlsxwriter.readthedocs.io/)

4. Pandas **v1.4.1** (Data Analysis Library) [Documentation Link](https://pandas.pydata.org/docs/).

5. Openpyxl **v3.0.9** (A Python library to read/write Excel 2010 xlsx/xlsm files) [Documentation Link](https://openpyxl.readthedocs.io/en/stable/)

6. Requests **v2.27.1** (HTTP Requests) [Documentation Link](https://docs.python-requests.org/en/master/)