.. _junos_rpc:


junos_rpc - run given rpc
+++++++++++++++++++++++++

:Author: Nitin Kumar, Juniper Networks

.. contents::
   :local:
   :depth: 1

Synopsis
--------

.. versionadded:: 1.9

run given rpc

Options
-------

.. raw:: html

    <table border=1 cellpadding=4>
    <tr>
    <th class="head">parameter</th>
    <th class="head">required</th>
    <th class="head">default</th>
    <th class="head">choices</th>
    <th class="head">comments</th>
    </tr>
            <tr>
    <td>dest</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Path to the local server directory where configuration will be saved.</td>
    </tr>
            <tr>
    <td>filter_xml</td>
    <td>no</td>
    <td></td>
        <td><ul></ul></td>
        <td>This options can be used with get-config rpc only, to retrieve specific config</td>
    </tr>
            <tr>
    <td>format</td>
    <td>no</td>
    <td>xml</td>
        <td><ul><li>text</li><li>xml</li><li>json</li></ul></td>
        <td>text - configuration saved as text (curly-brace) format. xml - configuration saved as XML. json - configuration saved as json, supported only for devices &gt;=14.2 Also with this format, rpc_reply attribute can be used with results</td>
    </tr>
            <tr>
    <td>host</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Set to {{ inventory_hostname }}</td>
    </tr>
            <tr>
    <td>kwargs</td>
    <td>no</td>
    <td></td>
        <td><ul></ul></td>
        <td>params need to be passed to rpc kwargs="interface_name=em0" or kwargs="interface_name=em0,media=True" kwargs={interface_name:em0} kwargs={interface_name:em0,media:True} kwargs={interface_name:em0,media:True}</td>
    </tr>
            <tr>
    <td>logfile</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Path on the local server where the progress status is logged for debugging purposes. This option is used only with the <em>console</em> option.</td>
    </tr>
            <tr>
    <td>mode</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>mode of console connection (telnet/serial). If mode is not provided SSH connection is used.</td>
    </tr>
            <tr>
    <td>passwd</td>
    <td>no</td>
    <td>assumes ssh-key active</td>
        <td><ul></ul></td>
        <td>Login password</td>
    </tr>
            <tr>
    <td>port</td>
    <td>no</td>
    <td>830</td>
        <td><ul></ul></td>
        <td>port number to use when connecting to the device</td>
    </tr>
            <tr>
    <td>rpc</td>
    <td>no</td>
    <td></td>
        <td><ul></ul></td>
        <td>rpc to be executed</td>
    </tr>
            <tr>
    <td>ssh_private_key_file</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>This can be used if you need to provide a private key rather than loading the key into the ssh-key-ring/environment.  if your ssh-key requires a password, then you must provide it via **passwd**</td>
    </tr>
            <tr>
    <td>timeout</td>
    <td>no</td>
    <td>0</td>
        <td><ul></ul></td>
        <td>Set the NETCONF RPC timeout. Set this value to accommodate Cli commands that might take longer than the default timeout interval. Setting to 0 will use the PyEZ default (30 seconds).</td>
    </tr>
            <tr>
    <td>user</td>
    <td>no</td>
    <td>$USER</td>
        <td><ul></ul></td>
        <td>Login username</td>
    </tr>
        </table>


.. note:: Requires junos-eznc >= 1.2.2


Examples
--------

.. raw:: html

    <br/>


::

    
    # retrieve rpc response using NETCONF
    
    - junos_rpc:
      host={{ inventory_hostname }}
      rpc=get-interface-information
      dest=get_interface_information.conf
      register=junos
    
    - junos_rpc:
      host={{ inventory_hostname }}
      rpc=get-interface-information
      kwargs="interface_name=em0"
      format=xml/text/json
      dest=get_interface_information.conf
      register=junos
    
    # Example to fetch device configuration
    - name: Get Device Configuration
      junos_rpc:
        host={{ inventory_hostname }}
        rpc=get-config
        dest=get_config.conf
    
    # Fetch configuration over console server connection using PyEZ >= 2.0
    - name: Get Device Configuration
      junos_rpc:
        host={{ inventory_hostname }}
        port=7005
        mode='telnet'
        rpc=get-config
        dest=get_config.conf
    
    # Example to fetch device configuration
    - name: Get Device Configuration for interface
      junos_rpc:
        host={{ inventory_hostname }}
        rpc=get-config
        filter_xml="<configuration><interfaces/></configuration>"
        dest=get_config.conf
      register: junos
    
    # Example to fetch configuration in json for >=14.2
    # and use it with rpc_reply
    - name: Get Device Configuration
      hosts: all
      roles:
        - Juniper.junos
      connection: local
      gather_facts: no
      tasks:
        - name: Get interface information
          junos_rpc:
            host: "{{ inventory_hostname }}"
            rpc: get-interface-information
            kwargs:
              interface_name: em0
              media: True
            format: json
            dest: get_interface_information.conf
          register: junos
    
        - name: Print configuration
          debug: msg="{{ junos.rpc_reply }}"