Junos PyEZ med exempel på en uppgift för att hitta lediga IPv4-subnät

Artikel om arbete med Junos PyEZ – "Python-mikrahäftet som möjliggör att hantera och automatisera enheter som kör Junos OS" automatisering och hantering, precis som vi älskar. Syftet med att skriva skriptet som beskrivs i denna artikel var att studera Python och automatisera uppgifter för att samla in information eller ändra konfigurationer på utrustning som kör Junos OS. Valet av denna kombination Python + Junos PyEZ gjordes på grund av den låga tröskeln för att komma in i programmeringsspråket Python och enkelheten i att använda biblioteken Junos PyEZ, som inte kräver expertkunskaper i Junos OS.

Uppgift

Revision av lediga IPv4-subnät som tillhör företaget. Kriteriet för att ett subnät ska vara ledigt är att det inte finns någon post om det i routingen på switchen som fungerar som router som kör Junos OS.

Implementering

Python + Junos PyEZ, även om det fanns en frestelse att göra det via paramiko och ssh.exec_command, så kommer det därför att krävas att den utrustning som frågas har nätverksstyrprotokollet netconf konfigurerat. Netconf fungerar med utrustning genom att använda fjärranropningsprocedurer (remote procedure call, RPC) och använder XML i det här exemplet för att tillhandahålla den mottagna informationen.

Installation av den nuvarande versionen av Junos PyEZ från PyPI görs med följande kommando:

$ pip install junos-eznc

Det kan också installeras från huvudgrenen av projektet på GitHub med följande kommando:

$ pip install git+https://github.com/Juniper/py-junos-eznc.git

Och ytterligare ett alternativ genom

$ pip install -r requirements.txt 

detta kommando installerar de bibliotek som saknas i systemet som är nödvändiga för att fungera. I min version requirements.txt är det totalt två, versionerna anges sist på skrivandet av skriptet:

junos-eznc
netaddr

Skriptet tar som standard det aktuella användarnamnet i systemet, för att logga in som en annan användare kan du använda nyckeln show_route.py -u getpass.getpass tar emot lösenordet från stdin så att lösenordet inte stannar kvar i systemet. För att ansluta till utrustningen kommer det också att behöva ange dess hostname eller IP-adress på begäran. All information som behövs för autentisering på enheten har erhållits.

Junos PyEZ stöder anslutning till utrustning som kör Junos OS via konsol, telnet eller netconf via ssh. I artikeln diskuteras det senaste alternativet.

För att ansluta till utrustningen används klassen Device i modulen jnpr.junos

med jnpr.junos.Device(host=router,
                           user=args.name,
                           passwd=password) som dev:

Ett anrop görs för att hämta alla kända rutter till routern via en RPC eller ett avlägset funktionsanrop, vad som helst som passar bäst.

data = dev.rpc.get_route_information()

Motsvarande kommando i Junos OS

user@router> show route | display xml

Genom att lägga till rpc i slutet av kommandot får vi taggen för begäran och kan matcha den med namnet på RPC-metoden, på detta sätt kan vi även få andra intressanta namn. Det bör noteras att syntaxen för att skriva begärstagen skiljer sig från metodens namn, nämligen att vi ska byta ut bindestrecken mot understreck.

user@router> show route | display xml rpc
route_list = data.xpath("//rt-destination/text()")

Resten av koden har jag lagt i en while-loop för att inte behöva göra en ny begäran till routern, om jag behöver kontrollera en annan subnet som routern redan känner till. Det är värt att nämna att routern jag frågar känner endast till rutter via OSPF, därför är det bättre att ändra begäran något för att minska scriptets körningstid.

data = dev.rpc.get_ospf_route_information()

Nu ska vi titta på innehållet i while-loopen

I början kommer användaren att uppmanas att ange en subnet med mask och högst tre oktetter från det nätverket, vilket är nödvändigt för att ange sökområdet. Jag gillar inte riktigt denna implementering av kriteriet och sökområdet, men jag har ännu inte hittat en bättre lösning. Sedan från den erhållna listan av subnet routes_list väljer jag de intressanta subnät med hjälp av en variabel som innehåller högst tre oktetter.

tmp = re.search(r'^%sS*' % subnet_search, route_list[i])

Via IPNetwork, modulen netaddr, får jag subnät i form av en lista med ipv4-adresser.

range_subnet = netaddr.IPNetwork(tmp.group(0))

Genom att använda IPNetwork från det nätverk som användaren angav med mask får jag en adressintervall och formar en lista med alla adresser inom det intervallet för att jämföra med listan med upptagna adresser.

for i in set(net_list).difference(set(busyip)):
        freeip.append(i)

Den erhållna listan med lediga adresser skriver jag ut i form av subnät.

print(netaddr.IPSet(freeip))

Nedan finns hela skriptet, testat på switchar som används som routrar, modeller ex4550, ex4600.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import argparse
import getpass
import netaddr
import re
import sys

import jnpr.junos

parser = argparse.ArgumentParser()
parser.add_argument('-u', '--user',
                    action='store',
                    dest='name',
                    help='Enter login from tacacs if it differs from the '
                         'username in the system.')
args = parser.parse_args()

if not args.name:
    args.name = getpass.getuser()    # Return the “login name” of the user.
router = input("Full routers name: ")
password = getpass.getpass("Password: ")

try:
    # Authenticates to a device running Junos, for get information about routs
    # into xml format and selects by tag.
    route_list = []
    with jnpr.junos.Device(host=router,
                           user=args.name,
                           passwd=password) as dev:
        data = dev.rpc.get_route_information()
    route_list = data.xpath("//rt-destination/text()")
except (jnpr.junos.exception.ConnectRefusedError,
        jnpr.junos.exception.ConnectUnknownHostError) as err:
    print("Equipment name or password wrong.")
    sys.exit(1)

while True:
    subnet = input("Net with mask: ")
    subnet_search = input("Input no more three octet: ")
    # Gets a list of busy IP addresses from the received subnets.
    busyip = []
    for i in range(len(route_list)):
        tmp = re.search(r'^%sS*' % subnet_search, route_list[i])
        if tmp:
            range_subnet = netaddr.IPNetwork(tmp.group(0))
            for ip in range_subnet:
                busyip.append("%s" % ip)
    range_subnet = netaddr.IPNetwork(subnet)
    # Gets list ip adresses from subnetworks lists.
    net_list = []
    for ip in range_subnet:
        net_list.append("%s" % ip)
    # Сomparing lists.
    freeip = []
    for i in set(net_list).difference(set(busyip)):
        freeip.append(i)
    print(netaddr.IPSet(freeip))

    request = input("To run request again enter yes or y, "
                    "press 'enter', complete request: ")
    if request in ("yes", "y"):
        continue
    else:
        print('Bye')
        break

Källa: habr.com