Zuordnen von Junos OS-Befehlen und Befehlsausgaben zu Junos XML-Tag-Elementen
Die Junos XML-API ist eine XML-Darstellung von Junos OS-Konfigurationsanweisungen und Betriebsmodusbefehlen. Es definiert ein XML-Äquivalent für alle Anweisungen in der Junos OS-Konfigurationshierarchie und viele der Befehle, die Sie im CLI-Betriebsmodus aus geben. Jeder Betriebsmodusbefehl mit einem Junos XML-Gegenstück wird einem Request-Tag-Element und gegebenenfalls einem Antworttag-Element zugeordnet.
Request-Tag-Elemente werden in Remote Procedure Calls (RPCs) in NETCONF- und Junos XML-Protokollsitzungen verwendet, um Informationen von einem Gerät, auf dem Junos OS ausgeführt wird, anzufordern. Der Server gibt die Antwort mithilfe von Junos XML-Tag-Elementen zurück, die in das Antworttag-Element eingeschlossen sind. Beispielsweise wird der show interfaces Befehl dem <get-interface-information> Anforderungs-Tag zuordnet, und der Server gibt das <interface-information> Antwort-Tag zurück.
In den folgenden Abschnitten wird erläutert, wie Sie Junos XML-Tag-Elementen Befehle, Befehlsoptionen und Befehlsausgaben zuordnen.
Zuweisung von Befehlsausgaben zu Junos XML-Elementen
Fügen Sie auf der Befehlszeilenschnittstelle (CLI) von Junos OS die | display xml Option nach dem Befehl ein, um die Befehlsausgabe als Junos XML-Tag-Elemente statt als standardformatierten ASCII-Text anzuzeigen. Die Tag-Elemente, die die Junos OS-Konfigurations- oder Betriebsdaten beschreiben, gehören zur Junos XML API, die den Junos OS-Inhalt definiert, der durch NETCONF- und Junos XML-Verwaltungsprotokollvorgänge abgerufen und manipuliert werden kann.
Das folgende Beispiel zeigt die Ausgabe des Befehls, der show chassis hardware auf einem M20-Router ausgegeben wurde, auf dem Junos OS Version 9.3 ausgeführt wird (das öffnenden <chassis-inventory> Tag wird nur zur Lesbarkeit in zwei Zeilen angezeigt). Dies ist identisch mit der Antwort des Servers für die <get-chassis-inventory> RPC-Anforderung.
user@host> show chassis hardware | display xml
<rpc-reply xmlns:junos="http://xml.juniper.net/junos/9.3R1/junos">
<chassis-inventory \
xmlns="http://xml.juniper.net/junos/9.3R1/junos-chassis">
<chassis junos:style="inventory">
<name>Chassis</name>
<serial-number>00118</serial-number>
<description>M20</description>
<chassis-module>
<name>Backplane</name>
<version>REV 06</version>
<part-number>710-001517</part-number>
<serial-number>AB5911</serial-number>
</chassis-module>
<chassis-module>
<name>Power Supply A</name>
<!-- other child tags of <chassis-module> -->
</chassis-module>
<!-- other child tags of <chassis> -->
</chassis>
</chassis-inventory>
</rpc-reply>
Zuweisung von Befehlen zu Junos XML Request Tag-Elementen
Informationen zu den verfügbaren Junos OS-Betriebsmodusbefehlen und ihren äquivalenten Junos XML RPC-Anforderungs-Tags finden Sie im Junos XML API Explorer – Operational Tags Tool und der Junos OS CLI. Sie können mit dem Tool einen Befehl überprüfen, den Befehl seinen äquivalenten Junos XML RPC-Anforderungs-Tag und untergeordneten Tags zuordnen und das erwartete Antwort-Tag für verschiedene Junos OS-Versionen anzeigen.
Sie können auch die Junos XML-Anforderungs-Tag-Elemente für jeden Betriebsmodusbefehl anzeigen, der ein Junos XML-Gegenstück auf der Junos OS CLI hat. Um die Junos XML RPC-Anforderungs-Tags für einen Betriebsmodus-Befehl anzuzeigen, geben Sie den Befehl ein und pipe ihn an den display xml rpc Befehl.
Im folgenden Beispiel werden die RPC-Tags für den show route Befehl angezeigt:
user@host> show route | display xml rpc
<rpc-reply xmlns:junos="http://xml.juniper.net/junos/10.1I0/junos">
<rpc>
<get-route-information>
</get-route-information>
</rpc>
<cli>
<banner></banner>
</cli>
</rpc-reply>
Ab Junos OS Version 20.3R1 wurden die Namen einiger Junos XML RPC-Anforderungs-Tags aktualisiert, um die Konsistenz in der Junos XML-API zu gewährleisten. Geräte mit Junos OS akzeptieren weiterhin die alten Anforderungs-Tag-Namen aus Gründen der Abwärtskompatibilität, aber wir empfehlen, die neuen Namen in Zukunft zu verwenden. Informationen zum Überprüfen des Junos XML RPC-Anforderungs-Tags für einen Betriebsmodusbefehl in einer bestimmten Junos OS-Version finden Sie im Junos XML API Explorer – Operational Tags Tool.
Zuordnung für Befehlsoptionen mit Variablenwerten
Viele CLI-Befehle verfügen über Optionen zur Identifizierung des Objekts, das sich auf den Befehl auswirkt oder über das der Befehl berichtet, und unterscheidet das Objekt von anderen Objekten desselben Typs. In einigen Fällen geht die CLI dem Bezeichner nicht mit einem Schlüsselwort mit fester Form voraus, aber die XML-Konvention erfordert, dass die Junos XML-API ein Tag-Element für jede Option definiert. Um die Namen für jeden Bezeichner (und alle anderen untergeordneten Tag-Elemente) für ein Tag-Element der Betriebsanforderung zu erfahren, lesen Sie den Eintrag des Tag-Elements in der entsprechenden DTD oder in der Junos XML API Operational Developer Reference, oder stellen Sie die Befehlsoption in der CLI aus, und fügen Sie die | display xml rpc Option an.
Das folgende Beispiel zeigt die Junos XML-Tag-Elemente für zwei CLI-Betriebsbefehle, die Optionen für variable Form haben. show interfaces Im Befehl ist t3-5/1/0:0 der Name der Schnittstelle. show bgp neighbor Im Befehl ist 10.168.1.222 die IP-Adresse für den BGP-Peer von Interesse.
Sie können die Junos XML RPC-Tags für einen Befehl und seine Optionen in der CLI anzeigen, indem Sie die Befehls- und Befehlsoption ausführen und anfügen | display xml rpc.
user@host> show interfaces t3-5/1/0:0 | display xml rpc
<rpc-reply xmlns:junos="http://xml.juniper.net/junos/16.1R1/junos">
<rpc>
<get-interface-information>
<interface-name>t3-5/1/0:0</interface-name>
</get-interface-information>
</rpc>
<cli>
<banner></banner>
</cli>
</rpc-reply>
Zuordnung für Befehlsoptionen mit fester Form
Einige CLI-Befehle enthalten Optionen, die eine feste Form haben, wie z. B. die brief Zeichenfolgen und detail die Menge an Details, die in die Ausgabe einbezogen werden sollen. Die Junos XML-API ordnet eine solche Option normalerweise einem leeren Tag zu, dessen Name mit dem Optionsnamen übereinstimmt.
Das folgende Beispiel zeigt die Junos XML-Tag-Elemente für den show isis adjacency Befehl, der eine Option mit fester Form namens :detail
So zeigen Sie die Tags in der CLI an:
user@host> show isis adjacency detail | display xml rpc
<rpc-reply xmlns:junos="http://xml.juniper.net/junos/16.1R1/junos">
<rpc>
<get-isis-adjacency-information>
<detail/>
</get-isis-adjacency-information>
</rpc>
<cli>
<banner></banner>
</cli>
</rpc-reply>