Junos PyEZ am Beispiel der Suche nach freien IPv4-Subnetzen

Ein Artikel über die Arbeit mit Junos PyEZ – „Python-Mikroframework, das es ermöglicht, Geräte mit Junos OS zu verwalten und zu automatisieren“. Automatisierung und Verwaltung, genau wie wir es lieben. Das Schreiben des in diesem Artikel beschriebenen Skripts verfolgte mehrere Ziele – das Erlernen von Python und die Automatisierung von Aufgaben zur Informationssammlung oder zur Änderung von Konfigurationen auf Geräten, die Junos OS verwenden. Die Wahl dieser Kombination aus Python + Junos PyEZ fiel aufgrund der niedrigen Einstiegshürde der Programmiersprache Python und der Benutzerfreundlichkeit der Bibliothek Junos PyEZ, die keine Expertenkenntnisse in Junos OS erfordert.

Aufgabe

Audit freier IPv4-Subnetze, die dem Unternehmen gehören. Das Kriterium dafür, dass ein Subnetz frei ist, besteht darin, dass es keinen Eintrag in den Routen auf dem Switch gibt, der als Router unter Junos OS fungiert.

Implementierung

Python + Junos PyEZ, obwohl es verlockend war, stattdessen paramiko und ssh.exec_command zu verwenden, wird es notwendig sein, den Protokoll für die Netzwerkverwaltung Netconf auf dem zu befragenden Gerät zu konfigurieren. Netconf arbeitet mit Geräten über Remote Procedure Call (RPC) und verwendet XML, um die bereitgestellten Informationen im vorliegenden Beispiel zu übermitteln.

Die Installation der aktuellen Version von Junos PyEZ aus PyPI erfolgt mit folgendem Befehl:

$ pip install junos-eznc

Es kann auch aus dem Hauptzweig des Projekts auf GitHub mit folgendem Befehl installiert werden:

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

Und eine weitere Option über

$ pip install -r requirements.txt 

Dieser Befehl installiert die in der Systembibliothek fehlenden Bibliotheken, die zum Betrieb erforderlich sind. In meiner Version requirements.txt sind es insgesamt zwei, die zuletzt zum Zeitpunkt des Schreibens des Skripts angegebenen Versionen:

junos-eznc
netaddr

Das Skript verwendet standardmäßig den Namen des aktuellen Benutzers im System. Um sich unter einem anderen Benutzernamen anzumelden, kann der Schlüssel show_route.py -u verwendet werden, getpass.getpass nimmt das Passwort von stdin entgegen, sodass das Passwort nicht im System bleibt. Für die Verbindung zum Gerät wird außerdem nach seinem Hostnamen oder seiner IP-Adresse gefragt. Alle für die Authentifizierung erforderlichen Daten auf dem Gerät wurden erhalten.

Junos PyEZ unterstützt die Verbindung zu Geräten, die unter Junos OS betrieben werden, über eine Konsole, Telnet oder Netconf über SSH. In diesem Artikel wird die letzte Option behandelt.

Für die Verbindung zu Geräten wird die Klasse Device des Moduls jnpr.junos verwendet

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

Eine Anfrage nach allen dem Router bekannten Routen wird über einen Remote Procedure Call oder per Aufruf von Remote Procedures ausgeführt, je nach Wunsch.

data = dev.rpc.get_route_information()

Ein ähnlicher Befehl in Junos OS

user@router> show route | display xml

Wenn wir den Befehl rpc am Ende hinzufügen, erhalten wir ein Anfrage-Tag, das wir mit dem Namen der RPC-Methode abgleichen können, auf diese Weise können wir auch andere interessante Namen erfahren. Es ist zu beachten, dass die Syntax des Anfrage-Tags von dem Namen der Methode abweicht, insbesondere sollten die Bindestriche durch Unterstriche ersetzt werden.

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

Den restlichen Teil habe ich in eine while-Schleife gewickelt, um nicht erneut eine Anfrage an den Router auszuführen, falls ich in einem anderen Subnetz prüfen muss, das vom Router bereits bekannt ist. Es ist erwähnenswert, dass der Router, von dem ich anfrage, nur über OSPF-Routen kennt, daher wäre es besser, die Anfrage für den Grenzrouter etwas zu ändern, um die Ausführungszeit des Skripts zu verkürzen.

data = dev.rpc.get_ospf_route_information()

Jetzt wenden wir uns dem Inhalt der while-Schleife zu.

Zu Beginn wird der Benutzer aufgefordert, ein Subnetz mit einer Maske und nicht mehr als drei Oktetten aus dem Netzwerk dieses Subnetzes einzugeben, dies ist notwendig, um den Suchbereich festzulegen. Mir gefällt diese Implementierung der Festlegung der Kriterien und des Suchbereichs nicht besonders, aber ich habe bisher keine bessere Lösung gefunden. Danach wähle ich aus der erhaltenen Liste der Subnetze route_list die Subnetze aus, die mich interessieren, indem ich eine Variable verwende, die nicht mehr als drei Oktette enthält.

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

Durch IPNetwork des Moduls netaddr erhalte ich Subnetze in Form einer Liste von ipv4-Adressen.

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

Mit IPNetwork des vom Benutzer eingegebenen Netzwerks mit Maske erhalte ich den Adressbereich und forme eine Liste aller Adressen aus diesem Bereich für den Vergleich mit der Liste der belegten Adressen.

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

Die erhaltene Liste der freien Adressen gebe ich als Subnetze aus.

print(netaddr.IPSet(freeip))

Nachfolgend ist das vollständige Skript aufgeführt, das auf Switches getestet wurde, die als Router verwendet werden, Modelle 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

Quelle: habr.com