diff --git a/README.md b/README.md index eda987b9e..cddc92d5b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![PyPI](https://img.shields.io/pypi/v/netmiko.svg)](https://pypi.python.org/pypi/netmiko) - - + + Netmiko ======= @@ -10,70 +10,75 @@ Python 2.7, 3.5, 3.6 #### Requires: -Paramiko >= 2 -scp >= 0.10.0 -pyyaml -pyserial -textfsm +- Paramiko >= 2.4.1 +- scp >= 0.10.0 +- pyyaml +- pyserial +- textfsm #### Supports: ###### Regularly tested -Arista vEOS -Cisco ASA -Cisco IOS -Cisco IOS-XE -Cisco IOS-XR -Cisco NX-OS -Cisco SG300 -HP Comware7 -HP ProCurve -Juniper Junos -Linux - +- Arista vEOS +- Cisco ASA +- Cisco IOS +- Cisco IOS-XE +- Cisco IOS-XR +- Cisco NX-OS +- Cisco SG300 +- HP Comware7 +- HP ProCurve +- Juniper Junos +- Linux + ###### Limited testing -Alcatel AOS6/AOS8 -Apresia Systems AEOS -Avaya ERS -Avaya VSP -Brocade VDX -Brocade MLX/NetIron -Calix B6 -Cisco WLC -Dell OS10 -Dell-Force10 -Dell PowerConnect -Huawei -Mellanox -NetApp cDOT -Palo Alto PAN-OS -Pluribus -Ruckus ICX/FastIron -Ubiquiti EdgeSwitch -Vyatta VyOS +- Alcatel AOS6/AOS8 +- Apresia Systems AEOS +- Calix B6 +- Cisco WLC +- Dell OS9 (Force10) +- Dell OS10 +- Dell PowerConnect +- Extreme ERS (Avaya) +- Extreme VSP (Avaya) +- Extreme VDX (Brocade) +- Extreme MLX/NetIron (Brocade/Foundry) +- Huawei +- IP Infusion OcNOS +- Mellanox +- NetApp cDOT +- Palo Alto PAN-OS +- Pluribus +- Ruckus ICX/FastIron +- Ubiquiti EdgeSwitch +- Vyatta VyOS ###### Experimental -A10 -Accedian -Aruba -Ciena SAOS -Citrix Netscaler -Cisco Telepresence -Check Point GAiA -Coriant -Dell EMC Isilon -Eltex -Enterasys -Extreme EXOS -Extreme Wing -F5 LTM -Fortinet -MRV Communications OptiSwitch -Nokia/Alcatel SR-OS -QuantaMesh +- A10 +- Accedian +- Aruba +- Ciena SAOS +- Citrix Netscaler +- Cisco Telepresence +- Check Point GAiA +- Coriant +- Dell OS6 +- Dell EMC Isilon +- Eltex +- Enterasys +- Extreme EXOS +- Extreme Wing +- Extreme SLX (Brocade) +- F5 TMSH +- F5 Linux +- Fortinet +- MRV Communications OptiSwitch +- Nokia/Alcatel SR-OS +- QuantaMesh +- Rad ETX ## Tutorials: @@ -131,12 +136,12 @@ 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 +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) @@ -158,6 +163,16 @@ pynet-rtr1(config)#end pynet-rtr1# ``` +## 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](https://pynet.twb-tech.com/blog/automation/netmiko-textfsm.html). + ## 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](https://github.com/ktbyers/netmiko/issues) @@ -167,7 +182,7 @@ If you have questions or would like to discuss Netmiko, a Netmiko channel exists ---- +--- Kirk Byers Python for Network Engineers https://pynet.twb-tech.com diff --git a/docs/build/html/classes/base_connection.html b/docs/build/html/classes/base_connection.html index 4f2ff9a05..ed5a82338 100644 --- a/docs/build/html/classes/base_connection.html +++ b/docs/build/html/classes/base_connection.html @@ -434,7 +434,7 @@