Skip to content

netops-toolkit

netops-toolkit is a Python network-automation toolkit for device discovery, inventory, operational checks, configuration collection, and controlled changes. The core works on Python 3.9+; the optional Textual TUI needs Python 3.10+.

Start here

  1. Follow Getting Started to install locally and create an inventory.
  2. Use the Terminal UI for an interactive inventory and scan workflow, or use CLI Reference for exact public command names and flags.
  3. If devices are reachable only through a jump host, start with Active Bastion Routing.

Capabilities

Area Primary interfaces
Discovery netops scan, python -m netops.inventory.scan
Inventory YAML/JSON files and python -m netops.core.inventory export
Operational checks netops health, plus BGP/VLAN/interface and vendor-specific modules
Collection netops backup, python -m netops.collect.config
Change safety netops diff, netops push, python -m netops.change.plan, python -m netops.change.rollback
Bastion access netops bastion connect/status/disconnect
Reports Python API and python -m netops.report.health_dashboard

Install from source

git clone https://github.com/plures/netops-toolkit.git
cd netops-toolkit
python -m venv .venv
# Activate .venv for your shell, then:
python -m pip install -e ".[tui,snmp,report]"

For Linux and macOS, the repository also supplies install.sh, which creates a user-local install at ~/.venv/netops. See the repository README for platform-specific commands and optional extras.

Documentation map