Mapper les commandes et la sortie de commande Junos OS aux éléments de balise XML Junos
L’API XML Junos est une représentation XML des instructions de configuration de Junos OS et des commandes du mode opérationnel. Il définit un équivalent XML pour toutes les instructions de la hiérarchie de configuration Junos OS et pour la plupart des commandes que vous publiez en mode opérationnel CLI. Chaque commande du mode opérationnel avec un pendant XML Junos mappe à un élément de balise de requête et, si nécessaire, à un élément de balise de réponse.
Les éléments de balise de demande sont utilisés dans les appels de procédure à distance (RPC) au sein des sessions de protocole XML NETCONF et Junos pour demander des informations à un équipement exécutant Junos OS. Le serveur renvoie la réponse à l’aide d’éléments de balise XML Junos inclus dans l’élément de balise de réponse. Par exemple, les show interfaces
commandes se mappent à la <get-interface-information>
balise de requête et le serveur renvoie la balise de <interface-information>
réponse.
Les sections suivantes décrivent comment mapper les commandes, les options de commande et la sortie de commande aux éléments de balise XML Junos.
Mappage des commandes en sortie vers les éléments XML Junos
Dans l’interface de ligne de commande (CLI) de Junos OS, pour afficher la sortie de commande sous forme d’éléments de balise XML Junos au lieu du texte ASCII au format par défaut, incluez l’option | display xml
après la commande. Les éléments de balise décrivant la configuration de Junos OS ou les données opérationnelles appartiennent à l’API XML Junos, qui définit le contenu Junos OS pouvant être récupéré et manipulé par NETCONF et les opérations du protocole de gestion XML Junos.
L’exemple suivant montre le résultat de la show chassis hardware
commande émise sur un routeur M20 exécutant Junos OS Version 9.3 (la balise d’ouverture <chassis-inventory>
s’affiche sur deux lignes uniquement à des fins de lisibilité). Cette réponse est identique à celle du serveur pour la <get-chassis-inventory>
requête RPC.
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>
Mappage des commandes vers les éléments de balise de requête XML Junos
Vous pouvez trouver des informations sur les commandes du mode opérationnel Junos OS disponibles et sur leurs balises de requête RPC XML Junos équivalentes dans l’outil Junos XML API Explorer - Operational Tags et l’interface CLI de Junos OS. Vous pouvez utiliser l’outil pour vérifier une commande, mapper cette commande à son équivalent Junos XML RPC request tag et des balises enfant, et afficher la balise de réponse attendue pour diverses versions de Junos OS.
Vous pouvez également afficher les éléments de balise de requête XML Junos pour n’importe quelle commande de mode opérationnel contenant un pendant XML Junos sur l’interface de ligne de commande Junos OS. Pour afficher les balises de requête RPC XML Junos pour une commande de mode opérationnel, saisissez la commande et dirigez-la vers la display xml rpc
commande.
L’exemple suivant affiche les balises RPC pour la show route
commande :
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>
À partir de Junos OS Version 20.3R1, les noms de certaines balises de requête RPC XML Junos ont été mis à jour afin de garantir la cohérence entre l’API XML Junos. Les équipements exécutant Junos OS acceptent toujours les anciens noms de balises de requête pour une rétrocompatibilité, mais nous vous recommandons d’utiliser les nouveaux noms à l’avenir. Pour vérifier la balise de demande RPC XML Junos pour une commande de mode opérationnel dans une version de Junos OS donnée, consultez l’outil Junos XML API Explorer - Operational Tags .
Mappage des options de commande avec des valeurs variables
De nombreuses commandes CLI disposent d’options permettant d’identifier l’objet affecté ou de rapport, ce qui distingue l’objet des autres objets du même type. Dans certains cas, l’interface de ligne de commande ne précède pas l’identificateur par un mot-clé à forme fixe, mais la convention XML exige que l’API XML Junos définisse un élément de balise pour chaque option. Pour connaître les noms de chaque identifiant (et de tout autre élément de balise enfant) pour un élément de balise de requête opérationnelle, consultez l’entrée de l’élément de balise dans le DTD approprié ou dans l’API XML Junos Operational Developer Reference, ou envoyez l’option de commande et de commande dans l’interface de ligne de commande et ajoutez l’option | display xml rpc
.
L’exemple suivant montre les éléments de balise XML Junos pour deux commandes opérationnelles CLI avec des options de formulaire variable. Dans la show interfaces
commande, t3-5/1/0:0 est le nom de l’interface. Dans la show bgp neighbor
commande, 10.168.1.222 est l’adresse IP de la pair d’intérêt BGP.

Vous pouvez afficher les balises XML RPC junos pour une commande et ses options dans l’interface de ligne de commande en exécutant l’option de commande et de commande et en ajoutant | 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>
Mappage pour les options de commande de formulaire fixe
Certaines commandes CLI incluent des options qui disposent d’un formulaire fixe, comme les brief
chaînes et detail
les chaînes, qui spécifient la quantité de détails à inclure dans la sortie. L’API XML Junos mappe généralement une telle option à une balise vide dont le nom correspond au nom de l’option.
L’exemple suivant montre les éléments de balise XML Junos pour la show isis adjacency
commande, avec une option à formulaire fixe appelée detail
:

Pour afficher les balises dans l’interface de ligne de commande :
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>