r2r-dev / netmiko

Multi-vendor library to simplify Paramiko SSH connections to network devices

Netmiko

Multi-vendor library to simplify Paramiko SSH connections to network devices

Python 2.7, 3.4, 3.5

#### Requires: Paramiko >= 1.13+ scp >= 0.10.0 pyyaml pytest (for unit tests)
#### Supports:

Regularly tested

Arista vEOS
Cisco ASA
Cisco IOS
Cisco IOS-XR
Cisco SG300
HP Comware7
HP ProCurve
Juniper Junos
Linux

Limited testing

Avaya ERS
Avaya VSP
Brocade VDX
Brocade ICX/FastIron
Brocade MLX/NetIron
Cisco IOS-XE
Cisco NX-OS
Cisco WLC
Dell-Force10 DNOS9
Huawei
Palo Alto PAN-OS
Vyatta VyOS

Experimental

A10
Alcatel-Lucent SR-OS
Enterasys
Extreme
F5 LTM
Fortinet

## Tutorials:

Standard Tutorial:

https://pynet.twb-tech.com/blog/automation/netmiko.html

SSH Proxy:

https://pynet.twb-tech.com/blog/automation/netmiko-proxy.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. ```py net_connect = ConnectHandler(**cisco_881) ```
#### Execute show commands. ```py 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 ```
#### For long-running commands, use `send_command_expect()`

send_command_expect waits for the trailing prompt (or for an optional pattern)

net_connect.send_command_expect('write memory')

Building configuration...
[OK]

#### Enter and exit enable mode. ```py net_connect.enable() net_connect.exit_enable_mode() ```
#### Execute configuration change commands (will automatically enter into config mode) ```py 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