Skip to main content

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.6, 2.7, 3.3, 3.4


<br>
##### Requires: #####
Paramiko >= 1.13+ ( >=1.7.5+ if Python2)
scp >= 0.10.0
pytest (for unit tests)
pyyaml (for unit tests)


<br>
##### Supports: #####
Cisco IOS
Cisco IOS-XE
Cisco ASA
Cisco NX-OS
Cisco IOS-XR
Cisco WLC (limited testing)
Arista vEOS
HP ProCurve
HP Comware (limited testing)
Juniper Junos
Brocade VDX (limited testing)
F5 LTM (experimental)
Huawei (limited testing)
A10 (limited testing)
Avaya ERS (limited testing)
Avaya VSP (limited testing)


<br>
##### More detailed example: #####
See https://pynet.twb-tech.com/blog/automation/netmiko.html


<br>
##### Simple example: #####

```
>>> from netmiko import ConnectHandler

# Create a dictionary representing the device.
>>> 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 True
... }
# Supported device_types can be found at:
# https://github.com/ktbyers/netmiko/blob/master/netmiko/ssh_dispatcher.py
# (see CLASS_MAPPER keys)

```

```
# Establish an SSH connection to the device by passing in the device dictionary.
>>> net_connect = ConnectHandler(**cisco_881)

```

```
# Execute show commands on the channel:
>>> 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
```

```
# Enter enable mode
>>> net_connect.enable()
```

```
# 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#

```


<br>
---
Kirk Byers
Python for Network Engineers
https://pynet.twb-tech.com


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netmiko-0.2.5.tar.gz (17.1 kB view details)

Uploaded Source

Built Distributions

netmiko-0.2.5-py2.py3-none-any.whl (25.8 kB view details)

Uploaded Python 2 Python 3

netmiko-0.2.5-py2.7.egg (57.0 kB view details)

Uploaded Egg

File details

Details for the file netmiko-0.2.5.tar.gz.

File metadata

  • Download URL: netmiko-0.2.5.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for netmiko-0.2.5.tar.gz
Algorithm Hash digest
SHA256 8783681af44c2a528abee49a6dd7df4e02b1f33fb9853a68e20c00e7c3d7a930
MD5 3ef10211efbd80da0d34c8a60c32cf1f
BLAKE2b-256 3994055ef3094f173e9b50ba58383e3e3f5647694712f34001bb40ca7fcc19b9

See more details on using hashes here.

File details

Details for the file netmiko-0.2.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for netmiko-0.2.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 753d6f737ef45aeb3558dc9c72fbafb9d422706d9a6b394c1eac38c1b420f7bb
MD5 83796b61d77e62e89839760cf2863d46
BLAKE2b-256 1396ef36cccb8b31f40f5096fc5a989751d2241922ccf4bc4f7239c1a41a620f

See more details on using hashes here.

File details

Details for the file netmiko-0.2.5-py2.7.egg.

File metadata

  • Download URL: netmiko-0.2.5-py2.7.egg
  • Upload date:
  • Size: 57.0 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for netmiko-0.2.5-py2.7.egg
Algorithm Hash digest
SHA256 499e211b6b7a9e536e9ebcdd01186f450d9b2b71950fef1c96f8049b0c6341b6
MD5 09ee1bb7d34a4b6bb312affd70725050
BLAKE2b-256 4c41ad2123a760bc5612cfdf64598d6564827145ef7437ed98d478eb8bfe2450

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page