Skip to main content

Multi-vendor library to simplify legacy CLI connections to network devices

Project description

PyPI - Python Version PyPI Downloads GitHub contributors Code Style

Netmiko

Multi-vendor library to simplify CLI connections to network devices


Contributing to Netmiko

CONTRIBUTING.md


Why Netmiko?

Network automation to screen-scraping devices is primarily concerned with gathering output from show commands and with making configuration changes.

Netmiko aims to accomplish both of these operations and to do it across a very broad set of platforms. It seeks to do this while abstracting away low-level state control (i.e. eliminate low-level regex pattern matching to the extent practical).


Getting Started


Examples

You really should look here.


Supported Platforms

PLATFORMS


Installation

To install netmiko, simply use pip:

$ pip install netmiko

API-Documentation

API-Documentation


Common Issues/FAQ

Answers to some common questions


Tutorials


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

API Documentation

Below are some of the particularly handy Classes/functions for easy reference:


Contributing

Contributors are welcome.

You can contribute to Netmiko in a variety of ways: answering questions on Slack (see below in Questions/Discussions), responding to issues, adding to the common issues, reporting/fixing bugs, or even adding your own device type.

Before contributing a new vendor/platform device type, remember that any code added needs to be supported in some fashion. To add a vendor/platform you can follow the outline here. Once you've worked on your first pass of your driver and have it functional, you'll need to include test data in order for it to be merged into develop, you can see the general flow of how to do that here.

For all code contributions, please ensure that you have ran black against the code or your code will fail the Travis CI build.


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. Please make sure you've read through the common issues and examples prior to opening an issue. Please only open issues for bugs, feature requests, or other topics related to development of Netmiko. If you simply have a question, join us on Slack...

If you have questions or would like to discuss Netmiko, a #netmiko channel exists in this Slack workspace. To join, use this invitation. Once you have entered the workspace, then you can join the #netmiko channel.


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-4.5.0.tar.gz (159.8 kB view details)

Uploaded Source

Built Distribution

netmiko-4.5.0-py3-none-any.whl (244.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netmiko-4.5.0.tar.gz
  • Upload date:
  • Size: 159.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for netmiko-4.5.0.tar.gz
Algorithm Hash digest
SHA256 dbdfc20b6caaf8e5d7a570bb1b42a26b9a6f8d8234e91f5c65f4dbfe0c0e4f50
MD5 f712da6852c129279b37d3f4607933e4
BLAKE2b-256 da3ca684dadb7d676f53cc00efc87cae50e2dc8542348071f48e34709d3b0da6

See more details on using hashes here.

File details

Details for the file netmiko-4.5.0-py3-none-any.whl.

File metadata

  • Download URL: netmiko-4.5.0-py3-none-any.whl
  • Upload date:
  • Size: 244.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for netmiko-4.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 42d81fb906339af1fb5c6899f181f5cb5c9b03311262ba56c696b113e1f2f61a
MD5 a53a230f5a123615792b3a8d4e96bf5f
BLAKE2b-256 27671912985e8649e056795837dd65beee66afcec1386d4fae29b0bb69735ce7

See more details on using hashes here.

Supported by

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