.. _junos_install_config:


junos_install_config - Load a configuration file or snippet onto a device running Junos OS.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

:Author: Jeremy Schulman, Juniper Networks

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

Synopsis
--------

.. versionadded:: 1.0.0

Load a complete Junos OS configuration (overwrite) or merge a configuration snippet onto a device running Junos OS and commit it. The default behavior is to perform a **load merge** operation (overwrite='no'). This module performs an atomic lock/edit/unlock. If the process fails at any step, then all configuration changes are discarded. You can load the configuration using either NETCONF or the CONSOLE port. Specify the *console* option to use the CONSOLE port.
You provide the configuration data in a file. Supported formats when using NETCONF include ASCII text, Junos XML elements, and Junos OS **set** commands. Configurations performed through the console must only use ASCII text formatting.

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>comment</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Provide a comment to the commit of the configuration</td>
    </tr>
            <tr>
    <td>confirm</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Provide a confirm in minutes to the commit of the configuration</td>
    </tr>
            <tr>
    <td>console</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Port configuration, per the <b>netconify</b> utility</td>
    </tr>
            <tr>
    <td>diffs_file</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Path to the file where any diffs will be written</td>
    </tr>
            <tr>
    <td>file</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Path to the file containing the Junos OS configuration data. If the file has a <code>*.conf</code> extension, the content is treated as text format. If the file has a <code>*.xml</code> extension, the content is treated as XML format. If the file has a <code>*.set</code> extension, the content is treated as Junos OS <b>set</b> commands.</td>
    </tr>
            <tr>
    <td>host</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Set to {{ inventory_hostname }}</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</td>
    </tr>
            <tr>
    <td>overwrite</td>
    <td>no</td>
    <td></td>
        <td><ul><li>true</li><li>false</li><li>yes</li><li>no</li></ul></td>
        <td>Specify whether the configuration <em>file</em> completely replaces the existing configuration.</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>TCP port number to use when connecting to the device</td>
    </tr>
            <tr>
    <td>replace</td>
    <td>no</td>
    <td></td>
        <td><ul><li>true</li><li>false</li><li>yes</li><li>no</li></ul></td>
        <td>Specify whether the configuration <em>file</em> uses "replace:" statements. (NETCONF only) <b>NOT</b> compatible with <b>set</b> format</td>
    </tr>
            <tr>
    <td>savedir</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Path to the local server directory where device facts and inventory files will be stored. This option is used only with the <em>console</em> option. Refer to the <b>netconify</b> utility for details.</td>
    </tr>
            <tr>
    <td>timeout</td>
    <td>no</td>
    <td>0</td>
        <td><ul></ul></td>
        <td>Extend the NETCONF RPC timeout beyond the default value of 30 seconds. Set this value to accommodate configuration changes (commits) that might take longer than the default timeout interval.</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


.. note:: Requires junos-netconify >= 1.0.1, when using the *console* option


Examples
--------

.. raw:: html

    <br/>


::

    # load merge a change to the Junos OS configuration using NETCONF
    
    - junos_install_config:
        host={{ inventory_hostname }}
        file=banner.conf
    
    # load overwrite a new Junos OS configuration using the CONSOLE port
    
    - junos_install_config:
        host={{ inventory_hostname }}
        console="--telnet={{TERMSERV}},{{TERMSERV_PORT}}"
        file=default_new_switch.conf
        overwrite=yes
    
    # load merge a change to the Junos OS configuration using NETCONF and supplying a commit log message
    - junos_install_config:
        host={{ inventory_hostname }}
        file=banner.conf
        comment="configured by ansible"
    
    # load replace a change to the Junos OS configuration using NETCONF
    - junos_install_config:
        host={{ inventory_hostname }}
        file=snmp.conf
        replace=yes