ktbyers/netmiko
Netmiko
Netmiko est une bibliothèque Python et une boîte à outils d'automatisation réseau multi-fournisseurs qui fournit une interface unifiée pour gérer divers matériels réseau. Il fonctionne comme un wrapper de connexion SSH CLI, simplifiant le processus d'établissement de sessions sécurisées et d'automatisation des interactions avec les périphériques réseau.
Le projet abstrait la logique de connexion spécifique au fournisseur et la syntaxe des commandes via un système basé sur des pilotes, permettant une automatisation cohérente à travers différentes marques de matériel. Il inclut des capacités d'auto-détection du type d'appareil et prend en charge des extensions de fournisseur personnalisées pour assurer la compatibilité avec le matériel non pris en charge.
La boîte à outils couvre un large éventail de tâches opérationnelles, incluant la gestion de la configuration réseau avec escalade de privilèges automatisée et flux de travail de commit. Elle fournit des utilitaires pour l'audit des périphériques réseau via des commandes en lecture seule, des transferts de fichiers sécurisés utilisant SCP ou des méthodes scriptées, et la possibilité d'acheminer les connexions via des serveurs de saut (jump hosts) ou des serveurs de terminaux.
La bibliothèque gère la sécurité des sessions via diverses méthodes d'authentification SSH et fournit une journalisation du trafic de communication pour l'audit et le débogage.
Features
- Hardware Vendor Abstractions - Provides a unified interface that abstracts vendor-specific connection logic and CLI syntax for diverse network hardware.
- Multi-Vendor Network Automation - Netmiko establishes CLI sessions via SSH, Telnet, or Secure Copy across diverse network hardware vendors and operating systems.
- SSH Libraries - Provides a Python-based library for managing SSH connections and CLI interactions with network devices.
- Remote Device Command Sends - Sends commands to remote network devices and captures the resulting output while handling interactive responses.
- Network Configuration Management - Provides automation for standardizing and applying settings across diverse network hardware.
- Network Configuration Tools - Automates the application and commitment of configuration changes to network hardware.
- CLI Session Wrappers - Wraps the SSH protocol to handle interactive prompts, pagination, and privilege escalation on network devices.
- SSH Transport Integrations - Uses a low-level SSH library to manage encrypted tunnels and byte-stream communication with remote network hardware.
- SSH Authentication - Supports diverse SSH authentication methods including passwords, private keys, and configuration files.
- CLI Prompt Tracking - Monitors the CLI stream for specific strings to determine exactly when a command has finished executing.
- Network Configuration Deployment - Automates the delivery of configuration changes by navigating the necessary CLI modes on remote hardware.
- Read-Only Command Execution - Provides a dedicated mechanism to send read-only show commands for system auditing and state analysis.
- Command-Line Output Parsing - Extracts structured system information by parsing the raw text output of network shell commands.
- Regex-Based Output Parsing - Utilizes regular expressions and templates to transform raw, unstructured CLI text into structured data formats.
- Device Model Detection - Identifies the manufacturer and model of network devices via SSH or SNMP to select the correct communication driver.
- Connection Routing - Netmiko routes a connection through a jump host and re-initializes the driver upon reaching the final target device.
- Remote Access Clients - Establishes secure terminal sessions to network hardware via jump hosts or terminal servers.
- WebSocket CONNECT Tunnels - Enables secure access to target devices by routing SSH traffic through intermediate jump hosts.
- SSH Proxy Jump Routings - Routes SSH connections through intermediate jump hosts to reach target devices in restricted network segments.
- Interactive Prompt Handlers - Responds to multi-step interactive CLI prompts using timing and expected strings to complete automation tasks.
- Draft-Based Configuration Commitments - Implements commit-based workflows to ensure pending configuration changes are permanently applied to the device.
- CLI Mode Transitions - Automates the transition between user, privileged, and global configuration modes via required entry and exit commands.
- CLI Privilege Management - Automatically navigates between privileged and configuration modes on network devices.
- Network Device Audits - Enables retrieval and analysis of system state and configuration data across multiple network devices.
- Remote File Transfers - Moves configuration files and firmware images between local systems and remote network hardware.
- Infrastructure and Automation - Simplified SSH connections for network hardware.
- Network Automation Libraries - Multi-vendor library for simplified SSH connections to devices.
