Package: netmiko-bsh
NetmikoMulti-vendor library to simplify Paramiko SSH connections to network devicesQuick LinksSupported PlatformsInstallationTutorials/Examples/Getting StartedCommon Issues/FAQAPI-DocumentationTextFSM IntegrationContributingQuestions/DiscussionSupported PlatformsNetmiko supports a wide range of devices. These devices fall into three categories:Regularly TestedLimited TestingExperimentalRegularly 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.ClickPLATFORMSfor a list of all supported platforms.InstallationTo install netmiko, simply us pip:$ pip install netmikoNetmiko has the following requirements (which pip will install for you)Paramiko >= 2.4.3scp >= 0.13.2pyserialtextfsmTutorials/Examples/Getting StartedTutorials:Getting StartedSecure CopyNetmiko through SSH ProxyNetmiko and TextFSMNetmiko and what constitutes doneExamples:A whole bunch ofexamplesGetting Started:Create a dictionary representing the device.Supported device_types can be found inssh_dispatcher.py, see CLASS_MAPPER keys.fromnetmikoimportConnectHandlercisco_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                  downExecute 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#Common Issues/FAQAnswers to somecommon questionsTopics covered in above document:Handling commands that prompt for additional inputEnabling logging of all reads/writes of the communication channelRedispatch -- or connecting through a terminal serverAPI-DocumentationAPI DocumentationBelow are some of the particularly handy Classes/functions for easy reference:Base Connection ObjectSSH AutodetectSSH DispatcherRedispatchTextFSM IntegrationNetmiko has been configured to automatically look in~/ntc-template/templates/indexfor the ntc-templates index file. Alternatively, you can explicitly tell Netmiko where to look for the TextFSM template directory by setting theNET_TEXTFSMenvironment 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.ContributingContributors are always welcome! You can contribute to Netmiko in a variety of ways: spreading the word about Netmiko, answering questions on Slack (see below in Quests/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 (much more so for the "regularly tested" devices and the core of Netmiko)! To add a vendor/platform you can follow the outlinehere. 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 thathere.For all code contributions, please ensure that you have ranblackagainst the code or your code will fail the Travis CI build.Questions/DiscussionIf 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 inthis Slackworkspace. To join, usethis invitation. Once you have entered the workspace, then you can join the #netmiko channel.Kirk ByersPython for Network Engineershttps://pynet.twb-tech.com