Comment utiliser les RPC et les commandes du mode opérationnel dans les scripts op
La plupart des commandes du mode opérationnel de Junos OS ont des équivalents XML. Les scripts Op peuvent exécuter ces commandes XML sur un équipement local ou distant à l’aide du protocole RPC ( Remote Procedure Call ). Toutes les commandes du mode opérationnel qui ont des équivalents XML sont répertoriées dans l’API XML Junos Operational Developer Reference.
L’utilisation des RPC et des commandes en mode opérationnel dans les scripts op est abordée plus en détail dans les sections suivantes :
Utilisation de RPC dans les scripts op
Pour utiliser un RPC dans un script d’exploitation SLAX ou XSLT, incluez le RPC dans une déclaration variable, puis appelez le RPC en utilisant la fonction ou jcs:execute() l’extension jcs:invoke() avec la variable RPC comme argument. La jcs:invoke() fonction exécute le RPC sur l’équipement local. La jcs:execute() fonction, associée à une poignée de connexion, exécute le RPC sur un équipement distant.
L’extrait de code suivant, qui appelle un RPC sur l’équipement local, est développé et décrit entièrement dans l’exemple : Personnaliser la sortie des interfaces d’affichage Commande terse à l’aide d’un script Op :
Syntaxe XSLT
<xsl:variable name="rpc"> <get-interface-information/> # Junos RPC for the show interfaces command </xsl:variable> <xsl:variable name="out" select="jcs:invoke($rpc)"/> ...
Syntaxe SLAX
var $rpc = <get-interface-information>; var $out = jcs:invoke($rpc);
L’extrait de code suivant appelle le même RPC sur un équipement distant :
Syntaxe XSLT
<xsl:variable name="rpc">
<get-interface-information/> # Junos RPC for the show interfaces command
</xsl:variable>
<xsl:variable name="connection" select="jcs:open('198.51.100.1', 'bsmith', 'test123')"/>
<xsl:variable name="out" select="jcs:execute($connection, $rpc)"/>
<xsl:value-of select="jcs:close($connection)"/>
...
Syntaxe SLAX
var $rpc = <get-interface-information>;
var $connection = jcs:open('198.51.100.1', 'bsmith', 'test123');
var $out = jcs:execute($connection, $rpc);
expr jcs:close($connection);
Dans les scripts Python Op, les RPC sont faciles à exécuter à l’aide des API PyEZ Junos . Chaque instance de la classe Junos PyEZ Device possède une propriété qui vous permet d’exécuter rpc n’importe quel RPC disponible via l’API XML Junos. Après avoir établi une session avec un équipement local ou distant, vous pouvez exécuter le RPC en ajoutant la propriété et le nom de la rpc méthode RPC à l’instance de l’équipement. La valeur de retour est un objet XML commençant par le premier élément sous la <rpc-reply> balise.
Pour exécuter le RPC sur l’équipement local, créez l’instance à l’aide Device d’une liste d’arguments vide. Pour exécuter le RPC sur un équipement distant, créez une instance qui Device utilise les arguments appropriés pour se connecter à cet équipement.
Le code suivant appelle un RPC sur l’équipement local et imprime la réponse :
Syntaxe Python
from jnpr.junos import Device
from lxml import etree
with Device() as jdev:
rsp = jdev.rpc.get_interface_information()
print (etree.tostring(rsp, encoding='unicode'))
Le code suivant appelle le même RPC sur un équipement distant et imprime la réponse :
Syntaxe Python
from jnpr.junos import Device
from lxml import etree
import jcs
user = jcs.get_input('Enter username: ')
password = jcs.get_secret('Enter user password: ')
with Device(host='198.51.100.1', user=user, password=password) as jdev:
rsp = jdev.rpc.get_interface_information()
print (etree.tostring(rsp, encoding='unicode'))
Pour exécuter un RPC sur un équipement distant, une session SSH doit être établie. Pour que le script établisse la connexion, vous devez configurer les informations de clé d’hôte SSH pour l’équipement distant sur l’équipement local où le script sera exécuté, ou les informations de la clé d’hôte SSH pour l’équipement distant doivent exister dans le fichier d’hôtes connu de l’utilisateur exécutant le script. Pour chaque équipement distant où un RPC est exécuté, configurez les informations de clé de l’hôte SSH avec l’une des méthodes suivantes :
Pour configurer des hôtes connus SSH sur l’équipement local, incluez l’instruction et spécifiez le
hostnom de l’hôte et les options de clés d’hôte pour l’équipement distant au[edit security ssh-known-hosts]niveau hiérarchique de la configuration.Pour récupérer manuellement les informations clés de l’hôte SSH, émission de la
set security ssh-known-hosts fetch-from-server hostnamecommande configuration mode pour demander à Junos OS de se connecter à l’équipement distant et d’ajouter la clé.user@host# set security ssh-known-hosts fetch-from-server router2 The authenticity of host 'router2 (198.51.100.1)' can't be established. RSA key fingerprint is 30:18:99:7a:3c:ed:40:04:0f:fd:c1:57:7e:6b:f3:90. Are you sure you want to continue connecting (yes/no)? yes Warning: Permanently added 'router2,198.51.100.1' (RSA) to the list of known hosts.
Pour importer manuellement des informations de clé d’hôte SSH à partir d’un fichier, utilisez la commande mode
set security ssh-known-hosts load-key-file filenamede configuration et spécifiez le fichier d’hôtes connus.user@host# set security ssh-known-hosts load-key-file /var/tmp/known_hosts Import SSH host keys from trusted source /var/tmp/known_hosts ? [yes,no] (no) yes
L’utilisateur exécutant le script peut également se connecter à l’équipement local, puis se connecter SSH à l’équipement distant, puis accepter manuellement la clé d’hôte, ajoutée au fichier d’hôtes connus de cet utilisateur. Dans l’exemple suivant, le root est connecté au routeur1. Afin d’exécuter un RPC distant sur le routeur2, le root ajoute la clé d’hôte du routeur2 en émettant la commande du
ssh router2mode opérationnel et en acceptant manuellement la clé.root@router1> ssh router2 The authenticity of host 'router2 (198.51.100.1)' can't be established. RSA key fingerprint is 30:18:99:7a:3c:ed:40:04:0f:fd:c1:57:7e:6b:f3:90. Are you sure you want to continue connecting (yes/no)? yes Warning: Permanently added 'router2,198.51.100.1' (RSA) to the list of known hosts.
Affichage des balises RPC pour une commande
Vous pouvez afficher les balises XML RPC pour les commandes du mode opérationnel dans l’interface de ligne de commande de l’unité. Pour afficher les balises XML RPC pour une commande, entrez display xml rpc après le symbole du tuyau ( | ).
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>
Les scripts SLAX et XSLT peuvent exécuter des RPC à l’aide des balises XML RPC. Les scripts Python doivent convertir les balises RPC et les options de commande dans un format adapté à Python. Pour plus d’informations sur l’utilisation de Junos PyEZ pour exécuter des RPC et sur le mappage des balises RPC avec les arguments de méthode et de méthode Python correspondants, consultez Using Junos PyEZ to Execute RPCs on Devices Running Junos OS.
Utilisation des commandes du mode opérationnel dans les scripts op
Certaines commandes de mode opérationnel n’ont pas d’équivalents XML. Les scripts SLAX et XSLT peuvent exécuter des commandes sans équivalent XML à l’aide de l’élément <command> . Les scripts Python peuvent exécuter ces commandes à l’aide de la méthode Junos PyEZ cli() définie dans la Device classe.
Si une commande n’est pas répertoriée dans la référence du développeur opérationnel de l’API XML Junos, cette commande n’a pas d’équivalent XML. Une autre façon de déterminer si une commande possède un équivalent XML consiste à émettre la commande suivie de la | display xml commande, par exemple :
user@host> operational-mode-command | display xml
Si la sortie inclut uniquement des éléments de balise tels que <output>, <cli>et <banner>, la commande peut ne pas avoir d’équivalent XML. Dans l’exemple suivant, la sortie indique que la commande n’a pas d’équivalent show host XML :
user@host> show host hostname | display xml <rpc-reply xmlns:junos="http://xml.juniper.net/junos/10.0R1/junos"> <output> ... </output> <cli> <banner></banner> </cli> </rpc-reply>
Pour certaines commandes qui ont un équivalent XML, la sortie de la commande « nulle| display xml » n’inclut pas d’éléments de balise autres que , <cli>et <banner> uniquement parce que <output>la fonction pertinente n’est pas configurée. Par exemple, la show services cos statistics forwarding-class commande possède un équivalent XML qui renvoie le résultat dans la <service-cos-forwarding-class-statistics> balise de réponse, mais si la configuration n’inclut pas d’instructions au niveau de la [edit class-of-service] hiérarchie, il n’y a pas de données réelles que la show services cos statistics forwarding-class | display xml commande affiche. Le résultat est similaire à celui-ci :
user@host> show services cos statistics forwarding-class | display xml <rpc-reply xmlns:junos="http://xml.juniper.net/junos/8.3I0/junos"> <cli> <banner></banner> </cli> </rpc-reply>
C’est pourquoi les informations de l’API XML Junos Operational Developer Reference sont généralement plus fiables.
Les scripts SLAX et XSLT op peuvent inclure des commandes qui n’ont pas d’équivalent XML. Utilisez le <command>, <xsl:value-of>et <output> les éléments du script, comme illustré dans l’extrait de code suivant. Cet extrait est développé et décrit dans l’exemple suivant : Afficher les informations du nom de l’hôte DNS à l’aide d’un script Op.
<xsl:variable name="query">
<command>
<xsl:value-of select="concat('show host ', $hostname)"/>
</command>
</xsl:variable>
<xsl:variable name="result" select="jcs:invoke($query)"/>
<xsl:variable name="host" select="$result"/>
<output>
<xsl:value-of select="concat('Name: ', $host)"/>
</output>
...
Les scripts Python Op peuvent exécuter des commandes qui n’ont pas d’équivalent XML à l’aide des API PyEZ Junos. La cli() méthode définie dans la Device classe exécute une commande de mode opérationnel et renvoie la sortie au format texte. Par exemple :
from jnpr.junos import Device
def main():
with Device() as jdev:
res = jdev.cli('show host hostname', warning=False)
print (res)
if __name__ == "__main__":
main()
Vous pouvez également spécifier format='xml' de renvoyer le format de sortie sous forme d’éléments XML Junos OS. Pour plus d’informations sur la méthode Junos PyEZ cli() , reportez-vous à http://junos-pyez.readthedocs.org/en/latest/_modules/jnpr/junos/device.html#Device.cli .