Multi-vendor library to simplify Paramiko SSH connections to network devices
Project description
Netmiko
Multi-vendor library to simplify Paramiko SSH connections to network devices
Python 2.7, 3.5, 3.6
Requires:
Paramiko >= 2
scp >= 0.10.0
pyyaml
pyserial
textfsm
Supports:
Regularly tested
Arista vEOS
Cisco ASA
Cisco IOS
Cisco IOS-XE
Cisco IOS-XR
Cisco NX-OS
Cisco SG300
HP Comware7
HP ProCurve
Juniper Junos
Linux
Limited testing
Alcatel AOS6/AOS8
Apresia Systems AEOS
Avaya ERS
Avaya VSP
Brocade VDX
Brocade MLX/NetIron
Calix B6
Cisco WLC
Dell OS10
Dell-Force10
Dell PowerConnect
Huawei
Mellanox
NetApp cDOT
Palo Alto PAN-OS
Pluribus
Ruckus ICX/FastIron
Ubiquiti EdgeSwitch
Vyatta VyOS
Experimental
A10
Accedian
Aruba
Ciena SAOS
Citrix Netscaler
Cisco Telepresence
Check Point GAiA
Coriant
Dell EMC Isilon
Eltex
Enterasys
Extreme EXOS
Extreme Wing
F5 LTM
Fortinet
MRV Communications OptiSwitch
Nokia/Alcatel SR-OS
QuantaMesh
Tutorials:
Standard Tutorial:
https://pynet.twb-tech.com/blog/automation/netmiko.html
SSH Proxy:
https://pynet.twb-tech.com/blog/automation/netmiko-proxy.html
Documentation (Stable)
http://netmiko.readthedocs.io/en/stable/index.html
Examples:
Create a dictionary representing the device.
Supported device_types can be found here, see CLASS_MAPPER keys.
from netmiko import ConnectHandler
cisco_881 = {
'device_type': 'cisco_ios',
'ip': '10.10.10.10',
'username': 'test',
'password': 'password',
'port' : 8022, # optional, defaults to 22
'secret': 'secret', # optional, defaults to ''
'verbose': False, # optional, defaults to False
}
Establish an SSH connection to the device by passing in the device dictionary.
net_connect = ConnectHandler(**cisco_881)
Execute show commands.
output = net_connect.send_command('show ip int brief')
print(output)
Interface IP-Address OK? Method Status Protocol
FastEthernet0 unassigned YES unset down down
FastEthernet1 unassigned YES unset down down
FastEthernet2 unassigned YES unset down down
FastEthernet3 unassigned YES unset down down
FastEthernet4 10.10.10.10 YES manual up up
Vlan1 unassigned YES unset down down
Execute configuration change commands (will automatically enter into config mode)
config_commands = [ 'logging buffered 20000',
'logging buffered 20010',
'no logging console' ]
output = net_connect.send_config_set(config_commands)
print(output)
pynet-rtr1#config term
Enter configuration commands, one per line. End with CNTL/Z.
pynet-rtr1(config)#logging buffered 20000
pynet-rtr1(config)#logging buffered 20010
pynet-rtr1(config)#no logging console
pynet-rtr1(config)#end
pynet-rtr1#
Questions/Discussion
If you find an issue with Netmiko, then you can open an issue on this projects issue page here: https://github.com/ktbyers/netmiko/issues
If you have questions or would like to discuss Netmiko, a Netmiko channel exists on this Slack team. To join, visit this url and request access to the Slack team. Once access is granted you can join the #netmiko channel.
Kirk Byers
Python for Network Engineers
https://pynet.twb-tech.com
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
