netmiko – RSNET.PL

Skrypt python do zmiany serwerów ntp na CISCO

admin — Sun, 15 Oct 2017 20:38:08 +0000

W poniższym wpisie pokażę prosty skrypt w Pythonie wykorzystujący bibliotekę netmiko oraz textfsm. Skrypt będzie łączył sie po ssh ze switchami CISCO i zmieniać adresy serwerów ntp na nowe.

Wyobraźmy sobie sytuację że mamy 20 switchy ze skonfigurowanymi następującymi adresami serwerów ntp:

SWITCH-1#show run | in ntp
ntp server 192.168.55.100
ntp server 192.168.60.100

Dostaliśmy informację, że niedługo nastąpi zmiana adresów IP serwerów ntp na nowe następujące adresy:

10.0.10.1, 10.0.10.2, 10.0.10.3

i musimy na wszystkich switchach zamienić adresy serwerów ntp. Możemy to zrobić ręcznie, logując się na każdy switch i wydając komendy:

no ntp server …

ntp server..

albo wykorzystać skrypt, który zrobi to za nas.

ZACZYNAMY

Skrypt realizujący to zadanie będzie działał następująco:

Logowanie do urządzenia
Wykonanie komendy show run | in ntp i zapisanie wyników
Usunięcie starych serwerów ntp z wyników z punktu 2.
Ustawienie nowych serwerów ntp

Skrypt będzie wykorzystywał pliki z komendami, dzięki czemu będziemy mogli go w łatwy sposób przerabiać do innych potrzeb (nie tylko do zmian serwerów ntp). Wystarczy wyedytować pliki commands.txt i commands2.txt oraz zmienić plik textfsm, który parsuje wyniki polecenia z pliku commands2.txt. Zapraszam do przeczytania moich wpisów o Netmiko i TextFSM, które napewno rozjaśnią poniższy skrypt.

SKRYPT

config_cisco.py

#!/usr/bin/python

from netmiko import ConnectHandler
import sys, textfsm

def check_cmd(ip, username, password,commands):
 # nawiązanie połączenia do urządzenia
 ssh_connection = ConnectHandler(
 device_type='cisco_ios',
 ip=ip,
 username=username,
 password=password,
 )
 result = ""
 for i in commands:
    result += ssh_connection.send_command(i)+"\n"
 # zamknięcie połączenia
 ssh_connection.disconnect()

 return result

def set_cmd(ip, username, password,commands):
 # nawiązanie połączenia do urządzenia
 ssh_connection = ConnectHandler(
 device_type='cisco_ios',
 ip=ip,
 username=username,
 password=password,
 )
 result = ssh_connection.send_config_set(commands)
 # zamknięcie połączenia
 ssh_connection.disconnect()

 return result

if __name__ == "__main__":
 if len(sys.argv) != 4:
   print("\nSkrypt do zmiany adresów serwerów ntp na urzadzeniach cisco:")
   print("\tconfig_cisco.py ,   \n\n")
   print("\tprzykładowe użycie: config_cisco.py 192.168.10.10,192.168.10.11 admin cisco123 \n\n")
   sys.exit(0)

 devices = sys.argv[1]
 username = sys.argv[2]
 password = sys.argv[3]
 set_file = "commands.txt"
 get_file = "commands2.txt"

 f = open(set_file,'r')
 commands = f.read().splitlines()
 f.close

 f = open(get_file,'r')
 commands2 = f.read().splitlines()
 f.close

 device = devices.split(',')
 re_table = textfsm.TextFSM(open("config_devices.textfsm"))

 for i in switch:
   print "wykonywanie komend z pliku (%s) dla urządzenia %s" %(get_file,i)

 #sprawdzanie czy sa juz jakies ntp servery
 #sprawdzenie odbywa sie przy pomocy komend z pliku get_file
 check_out = check_cmd(i,username,password,commands2)
 fsm_results = re_table.ParseText(check_out)

 commands3=[]
 #sprawdzanie czy juz jest jakis ntp server, jesli jest to go usuwamy
 for j in fsm_results:
   commands3.append('no '+' '.join(j))
   set_out = set_cmd(i,username,password,commands3)

 print "wykonywanie komend z pliku (%s) dla switcha %s" % (set_file,i)
 #ustawienie nowych serwerow ntp, czyli komend z pliku set_file
 set_out = set_cmd(i,username,password,commands)

 #koniec
 print "koniec"

Plik config_devices.textfsm

Value ntp (\S+)
Value server (\S+)
Value ip (.+)

Start
 ^${ntp}\s+${server}\s+${ip} -> Record

Pliki z komendami:

commands.txt

ntp server 10.0.10.1
ntp server 10.0.10.2
ntp server 10.0.10.3

commands2.txt

show run | in ntp server

Skrypt uruchamiamy następującym poleceniem:

config_devices.py 192.168.10.10,192.168.10.11,192.168.10.12,192.168.10.13,192.168.10.14,192.168.10.15,192.168.10.16,192.168.10.17,192.168.10.18,192.168.10.19,192.168.10.20,192.168.10.21,192.168.10.22,192.168.10.23,192.168.10.24,192.168.10.25,192.168.10.26,192.168.10.27,192.168.10.28,192.168.10.29 admin cisco123

Oczywiście skrypt można napisać w inny sposób, nie korzystając z textfsm i plików z komendami, ale chciałem pokazać textfsm, bo uważam że jest to nieodzowna biblioteka przy pracy z urządzeniami Cisco i napewno będę publikował więcej skryptów z jej wykorzystaniem.

Cisco CLI + TextFSM

admin — Tue, 26 Sep 2017 19:41:12 +0000

W poprzednich wpisach pokazałem jak można wykorzystać Pythona i biblioteki Netmiko, Paramiko do wydawania komend w Cisco IOS. Tradycyjnie SSH jest używany do łączenia się z urządzeniem sieciowym, wydawania polecenia i zrzutu wyników zwykłego tekstu z powrotem do użytkownika.

W celu automatyzacji niektórych czynności musimy często wyniki z komend sformatować w sposób umożliwiający wydobywanie tylko niektórych informacji. W tym celu możemy posłużyć się biblioteką Pythona textFSM.

Zobaczmy jak korzystając z textFSM przetwarzać wyniki komend CISCO IOS. Do pracy z textFSM przyda się podstawowa wiedza z wyrażeń regularnych, jednak nie jest ona niezbędna. Pokaże jak szybko nauczyć się podstawowych wyrażeń regularnych. Budując wyrażenia regularne będziemy posługiwać się stroną regex101.com.

Przed przystąpieniem do pracy z textFSM musimy go zainstalować:

pip install textfsm
Collecting textfsm
 Downloading textfsm-0.3.2.tar.gz
Installing collected packages: textfsm
 Running setup.py install for textfsm ... done
Successfully installed textfsm-0.3.2

a następnie w skrypcie Pythona musimy go zaimportować:

Python 2.7.14 (v2.7.14:84471935ed, Sep 16 2017, 20:25:58) [MSC v.1500 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import textfsm

Załóżmy, że chcemy z routera Cisco wyciągnąć takie informacje jak:

hostname,
model,
uptime,
serial number,
ios,
software version.

Skrzystajmy więc z biblioteki netmiko i podłączmy się przez ssh do routera R1 o adresie IP 192.168.174.200 korzystając z użytkownika admin o haśle cisco i wydajmy polecenie show version.

>>> from netmiko import ConnectHandler
>>> cisco = {'device_type':'cisco_ios','ip':'192.168.174.200','username':'admin','password':'cisco'}
>>> net_connect = ConnectHandler(**cisco)
>>> output = net_connect.send_command('show version') 
>>> ssh_connection.disconnect()
>>> print output

Wynik komendy show version najlepiej zapisać w notatniku, bo przyda nam się do zbudowania wyrażeń regularnych:

Cisco IOS Software, 7200 Software (C7200-JK9S-M), Version 12.4(13b), RELEASE SOFTWARE (fc3)
Technical Support: http://www.cisco.com/techsupport
Copyright (c) 1986-2007 by Cisco Systems, Inc.
Compiled Wed 25-Apr-07 03:18 by prod_rel_team

ROM: ROMMON Emulation Microcode
BOOTLDR: 7200 Software (C7200-JK9S-M), Version 12.4(13b), RELEASE SOFTWARE (fc3)

R1 uptime is 1 minute
System returned to ROM by unknown reload cause - suspect boot_data[BOOT_COUNT] 0x0, BOOT_COUNT 0, BOOTDATA 19
System image file is "tftp://255.255.255.255/unknown"

This product contains cryptographic features and is subject to United
States and local country laws governing import, export, transfer and
use. Delivery of Cisco cryptographic products does not imply
third-party authority to import, export, distribute or use encryption.
Importers, exporters, distributors and users are responsible for
compliance with U.S. and local country laws. By using this product you
agree to comply with applicable laws and regulations. If you are unable
to comply with U.S. and local laws, return this product immediately.

A summary of U.S. laws governing Cisco cryptographic products may be found at:
http://www.cisco.com/wwl/export/crypto/tool/stqrg.html

If you require further assistance please contact us by sending email to
export@cisco.com.

Cisco 7206VXR (NPE400) processor (revision A) with 491520K/32768K bytes of memory.
Processor board ID 4279256517
R7000 CPU at 150MHz, Implementation 39, Rev 2.1, 256KB L2 Cache
6 slot VXR midplane, Version 2.1

Last reset from power-on

PCI bus mb0_mb1 (Slots 0, 1, 3 and 5) has a capacity of 600 bandwidth points.
Current configuration on bus mb0_mb1 has a total of 600 bandwidth points.
This configuration is within the PCI bus capacity and is supported.

PCI bus mb2 (Slots 2, 4, 6) has a capacity of 600 bandwidth points.
Current configuration on bus mb2 has a total of 0 bandwidth points
This configuration is within the PCI bus capacity and is supported.

Please refer to the following document "Cisco 7200 Series Port Adaptor
Hardware Configuration Guidelines" on Cisco.com /
for c7200 bandwidth points oversubscription and usage guidelines.

3 FastEthernet interfaces
509K bytes of NVRAM.

8192K bytes of Flash internal SIMM (Sector size 256K).
Configuration register is 0x2102

Przykładowe użycie biblioteki wygląda następująco:

>>> re_table = textfsm.TextFSM(open("template.textfsm"))
>>> fsm_results = re_table1.ParseText(output)

gdzie output to surowy tekst wyniku naszej komendy show version, a template.textfsm to plik zawierający szablon z wyrażeniami regularnymi dla naszej komendy show version i informacji które chcemy z niej wyciągnąć.

template.textfsm

Value hostname (\S+)
Value model (\S+)
Value uptime (.+)
Value serial ([^ ,]+)
Value ios (\S+)
Value version ([^ ,]+)
Start
 ^.*Software.*Version\s+${version}
 ^${hostname}\s+uptime\s+is\s+${uptime}
 ^Cisco\s+${model}.+
 ^System\s+image\s+file\s+is\s+.${ios}.
 ^Processor\s+board\s+ID\s+${serial}

Sprawdźmy co zawiera zmienna fsm_results:

>>> print fsm_results
[[u'R1', u'7206VXR', u'4 weeks, 1 day, 8 hours, 19 minutes', u'4279256517', u'tftp://255.255.255.255/unknown', u'12.4(13b)']]

Jest to tablica, z której w łatwy sposób możemy wyciągnać interesującą nas rzecz. Np. jeśli chcemy wyświetlić sam numer seryjny routera, wystarczy że wpiszemy:

>> fsm_results[0][3]
u'4279256517'

Pokażę teraz jak stworzyć zawartość pliku template.textfsm. Otwórzmy stronę regex101.com i wklejmy w polu TEST STRING wynik komendy show version:

Strona powyższa pozwoli nam przetestować regex, który wyciąga odpowiednią informację. Najważniejsze regexy które należy znać to:

\s+ spacja występująca raz lub więcej razy

\S+ dowolny znak bez spacji występujących raz lub więcej razy

.+ dowolny znak występujący od 1 do nieskończoności razy

Jeśli nie znamy wyrażeń regularnych możemy skorzystać z pomocy na stronie regex101.com. Weźmy wyrażenie regularne którego nie znamy, np. [^ ,]+ i wklejmy w pole REGULAR EXPRESSION, otrzymamy taki wynik:

Po prawej stronie mamy wyjaśnienie (EXPLANATION) co robi dane wyrażenie regularne. W tym przypadku jest to dowolna znak, oprócz spacji i przecinka które występujący raz lub więcej razy.

Wróćmy teraz do textFSM. Zawartość pliku template.textfsm wygląda następująco:

Value   wartosc1     regex
Value   wartosc2     regex
Start
^regex    ${wartosc1}
^regex    ${wartosc2}

Domyślnie textFSM działa następująco. Parser textFSM tworzy tablice wartości [wartosc1,wartosc2,..] na podstawie szablonu template.textfsm. Najpierw sprawdzana jest pierwsza linijka tekstu – w moim przypadku jest to tekst ze zmiennej output (re_table1.ParseText(output)) i sprawdzane są wyrażenia regularne po kolei (Start ^regex -> ^regex …). Jeśli któreś wyrażenie regularne dla danej wartości pasuje, to zapisywana jest wartość wyrażenia regularnego do buforu. Następnie sprawdzana jest druga linijka i również dla drugiej linijki sprawdzane są wyrażenia regularne po kolei tak jak dla pierwszej linijki, jak któreś z nich pasuje, to zapisywana jest wartość tego wyrażenia do buforu. Na końcu bufor zawiera wartości dla pól Value, które są w takiej kolejności jak zadeklarowane wartości w pliku template.textfsm.

Najlepiej pokazać tworzenie zawartości pliku textfsm na przykladzie. Weźmy teraz dla przykładu ios. Do wyciągnięcia informacji o pliku z systemem IOS musimy stworzyć regex o postaci:

Jak widać z powyższego zrzutu ekranu, dokładnie taki regex wyciągnie nam informacje o IOS.

Value ios (\S+) 

^System\s+image\s+file\s+is\s+.${ios}.

Więcej gotowych szablonów dla różnych komend dla różnych urządzeń znajduje się pod poniższym linkiem.

Polecam naukę wyrażeń regularnych, bo przydają się one bardzo często, chociażby do takich czynności jak praca z textfsm, które jest bardzo pomocnym narzędziem do automatyzacji pracy z urządzeniami sieciowymi.

CISCO + Python + Netmiko

admin — Wed, 20 Sep 2017 23:48:17 +0000

Python i biblioteka Netmiko mogą stanowić fantastyczne uzupełnienie codziennej pracy z urządzeniami CISCO. W poniższym wpisie pokaże jak wykonać dowolną komendę na urządzeniu z CISCO IOS przy pomocy skryptu Python.

Biblioteka netmiko wspiera oprócz urządzeń Cisco również masę innych produktów takich jak:

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

Limited testing

Alcatel AOS6/AOS8
Avaya ERS
Avaya VSP
Brocade VDX
Brocade ICX/FastIron
Brocade MLX/NetIron
Cisco WLC
Dell-Force10 DNOS9
Dell PowerConnect
Huawei
Mellanox
Palo Alto PAN-OS
Pluribus
Ubiquiti EdgeOS
Vyatta VyOS

Experimental

A10
Accedian
Alcatel-Lucent SR-OS
Aruba
Ciena SAOS
Cisco Telepresence
CheckPoint Gaia
Enterasys
Extreme EXOS
Extreme Wing
F5 LTM
Fortinet
MRV Communications OptiSwitch

W celu zainstalowania biblioteki netmiko wykonujemy następującą komendę:

pip install netmiko

Collecting netmiko
 Downloading netmiko-1.4.3.tar.gz (47kB)
 100% |################################| 51kB 287kB/s
Collecting paramiko>=1.13.0 (from netmiko)
 Downloading paramiko-2.3.1-py2.py3-none-any.whl (182kB)
 100% |################################| 184kB 975kB/s
Collecting scp>=0.10.0 (from netmiko)
 Downloading scp-0.10.2-py2.py3-none-any.whl
Collecting pyyaml (from netmiko)
 Downloading PyYAML-3.12-cp27-cp27m-win_amd64.whl (197kB)
 100% |################################| 204kB 1.2MB/s
Collecting pynacl>=1.0.1 (from paramiko>=1.13.0->netmiko)
 Downloading PyNaCl-1.1.2-cp27-cp27m-win_amd64.whl (130kB)
 100% |################################| 133kB 1.2MB/s
Collecting cryptography>=1.5 (from paramiko>=1.13.0->netmiko)
 Downloading cryptography-2.1.2-cp27-cp27m-win_amd64.whl (1.3MB)
 100% |################################| 1.3MB 660kB/s
Collecting bcrypt>=3.1.3 (from paramiko>=1.13.0->netmiko)
 Downloading bcrypt-3.1.4-cp27-cp27m-win_amd64.whl
Collecting pyasn1>=0.1.7 (from paramiko>=1.13.0->netmiko)
 Downloading pyasn1-0.3.7-py2.py3-none-any.whl (63kB)
 100% |################################| 71kB 2.5MB/s
Collecting six (from pynacl>=1.0.1->paramiko>=1.13.0->netmiko)
 Downloading six-1.11.0-py2.py3-none-any.whl
Collecting cffi>=1.4.1 (from pynacl>=1.0.1->paramiko>=1.13.0->netmiko)
 Downloading cffi-1.11.2-cp27-cp27m-win_amd64.whl (163kB)
 100% |################################| 163kB 2.4MB/s
Collecting idna>=2.1 (from cryptography>=1.5->paramiko>=1.13.0->netmiko)
 Downloading idna-2.6-py2.py3-none-any.whl (56kB)
 100% |################################| 61kB 4.4MB/s
Collecting enum34; python_version < "3" (from cryptography>=1.5->paramiko>=1.13.0->netmiko)
 Downloading enum34-1.1.6-py2-none-any.whl
Collecting asn1crypto>=0.21.0 (from cryptography>=1.5->paramiko>=1.13.0->netmiko)
 Downloading asn1crypto-0.23.0-py2.py3-none-any.whl (99kB)
 100% |################################| 102kB 2.4MB/s
Collecting ipaddress; python_version < "3" (from cryptography>=1.5->paramiko>=1.13.0->netmiko)
 Downloading ipaddress-1.0.18-py2-none-any.whl
Collecting pycparser (from cffi>=1.4.1->pynacl>=1.0.1->paramiko>=1.13.0->netmiko)
 Downloading pycparser-2.18.tar.gz (245kB)
 100% |################################| 256kB 2.6MB/s
Installing collected packages: six, pycparser, cffi, pynacl, idna, enum34, asn1crypto, ipaddress, cryptography, bcrypt, pyasn1, paramiko, scp, pyyaml, netmiko
 Running setup.py install for pycparser ... done
 Running setup.py install for netmiko ... done
Successfully installed asn1crypto-0.23.0 bcrypt-3.1.4 cffi-1.11.2 cryptography-2.1.2 enum34-1.1.6 idna-2.6 ipaddress-1.0.18 netmiko-1.4.3 paramiko-2.3.1 pyasn1-0.3.7 pycparser-2.18 pynacl-1.1.2 pyyaml-3.12 scp-0.10.2 six-1.11.0

PIERWSZY SKRYPT

Najpierw musimy zaimportować funkcję ConnectHandler z biblioteki netmiko. Następnie definiujemy słownik urządzeń sieciowych składający się z typu urządzenia, adresu IP, nazwy użytkownika i hasła, który reprezentuje urządzenie do którego chcemy nawiązać połączenie ssh. (netmiko umożliwia również połączenia telnet, należy w tym celu zmienić device_type z cisco_ios na cisco_ios_telnet).

W moim przypadku chcę się podłączyć przez ssh do routera R1 o adresie IP 192.168.174.200 korzystając z użytkownika admin o haśle cisco.

Python 2.7.14 (v2.7.14:84471935ed, Sep 16 2017, 20:25:58) [MSC v.1500 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> from netmiko import ConnectHandler
>>> cisco = {'device_type':'cisco_ios','ip':'192.168.174.200','username':'admin','password':'cisco'}
>>> net_connect = ConnectHandler(**cisco)

Po wydaniu ostatniej komendy net_connect = ConnectHandler(**cisco) następuję połączenie ssh do routera, można to zweryfikować logując się na urządzenie i wydając komendę: show users

R1#show users
 Line User Host(s) Idle Location
* 0 con 0 idle 00:00:00
 2 vty 0 admin idle 00:09:25 192.168.174.1

Interface User Mode Idle Peer Address

Teraz możemy wykonać dowolną komendę i wypisać ją na ekranie:

>>> output = net_connect.send_command('show ip int brief')
>>> print output
Interface IP-Address OK? Method Status Protocol
FastEthernet0/0 192.168.174.200 YES manual up up
FastEthernet1/0 10.0.10.1 YES NVRAM up up
FastEthernet1/1 unassigned YES NVRAM administratively down down

>>> output = net_connect.send_command('show run')
>>> print output
 Building configuration...

Current configuration : 1175 bytes
 !
 ! Last configuration change at 17:59:31 UTC Wed Oct 25 2017
 !
 version 15.2
 service timestamps debug datetime msec
 service timestamps log datetime msec
 !
 hostname R1
 !
 boot-start-marker
 boot-end-marker
 !
 !
 !
 no aaa new-model
 no ip icmp rate-limit unreachable
 ip cef
 !
 !
 !
 no ip domain lookup
 ip domain name cisco
 no ipv6 cef
 !
 !
 multilink bundle-name authenticated
 !
 !
 !
 username admin privilege 15 secret 5 $1$EVqH$s80zvoLdjFQM88a6ifTpA/
 !
 !
 ip tcp synwait-time 5
 !
 !
 !
 interface FastEthernet0/0
 ip address 192.168.174.200 255.255.255.0
 duplex full
 !
 interface FastEthernet1/0
 ip address 10.0.10.1 255.255.255.0
 speed auto
 duplex auto
 !
 interface FastEthernet1/1
 no ip address
 shutdown
 speed auto
 duplex auto
 !
 ip forward-protocol nd
 !
 !
 ip http server
 no ip http secure-server
 ip route 0.0.0.0 0.0.0.0 192.168.174.1
 !
 !
 !
 control-plane
 !
 !
 line con 0
 exec-timeout 0 0
 privilege level 15
 logging synchronous
 stopbits 1
 line aux 0
 exec-timeout 0 0
 privilege level 15
 logging synchronous
 stopbits 1
 line vty 0 4
 login local
 transport input ssh
 !
 !
 end

Kilka przydatnych metod dostępnych w netmiko:

net_connect.config_mode() — Enter into config mode
net_connect.check_config_mode() — Check if you are in config mode, return a boolean
net_connect.exit_config_mode() — Exit config mode
net_connect.clear_buffer() — Clear the output buffer on the remote device
net_connect.enable() — Enter enable mode
net_connect.exit_enable_mode() — Exit enable mode
net_connect.find_prompt() — Return the current router prompt
net_connect.commit(arguments) — Execute a commit action on Juniper and IOS-XR
net_connect.disconnect() — Close the SSH connection
net_connect.send_command(arguments) — Send command down the SSH channel, return output back
net_connect.send_config_set(arguments) — Send a set of configuration commands to remote device
net_connect.send_config_from_file(arguments) — Send a set of configuration commands loaded from a file

W dalszych wpisach pokażę więcej możliwości i przykładowe skrypty z wykorzystaniem biblioteki netmiko.