Netmiko
Multi-vendor library to simplify Paramiko SSH connections to network devices.
Supported Platforms
Netmiko supports a wide range of devices. These devices fall into three categories:
- Regularly Tested
- Limited Testing
- Experimental
Regularly tested means we try to run our full test suite against that set of devices prior to each Netmiko release.
Limited testing means the config and show operation system tests passed against a test on that platform at one point in time so we are reasonably comfortable the driver should generally work.
Experimental means that we reviewed the PR and the driver seems reasonable, but we don't have good data on whether the driver fully passes the unit tests or how reliably it works.
Click PLATFORMS for a list of all supported platforms.
Installation
To install netmiko, simply us pip:
$ pip install netmiko
Netmiko has the following requirements (which pip will install for you)
- Paramiko >= 2.4.3
- scp >= 0.13.2
- pyserial
- textfsm
Tutorials/Examples/Getting Started
Tutorials:
- Getting Started
- Secure Copy
- Netmiko through SSH Proxy
- Netmiko and TextFSM
- Netmiko and what constitutes done
Examples:
A whole bunch of examples
Getting Started:
Create a dictionary representing the device.
Supported device_types can be found in ssh_dispatcher.py, see CLASS_MAPPER keys.
from netmiko import ConnectHandler
cisco_881 = {
'device_type': 'cisco_ios',
'host': '10.10.10.10',
'username': 'test',
'password': 'password',
'port' : 8022, # optional, defaults to 22
'secret': 'secret', # optional, defaults to ''
}
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#
API-Documentation
Below are some of the particularly handy Classes/functions for easy reference:
TextFSM Integration
Netmiko has been configured to automatically look in ~/ntc-template/templates/index
for the ntc-templates index file. Alternatively, you can explicitly tell Netmiko where to look for the TextFSM template directory by setting the NET_TEXTFSM
environment variable (note, there must be an index file in this directory):
export NET_TEXTFSM=/path/to/ntc-templates/templates/
More info on TextFSM and Netmiko.