.. _junos_install_os:


junos_install_os - Install a Junos OS image.
++++++++++++++++++++++++++++++++++++++++++++

:Author: Jeremy Schulman, Juniper Networks

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

Synopsis
--------

.. versionadded:: 1.0.0

Install a Junos OS image on one or more Routing Engines. This module supports installations on single Routing Engine devices, MX Series routers with dual Routing Engines, and EX Series switches in a non-mixed Virtual Chassis. This action is equivalent to performing the Junos OS **request system software add** operational command.
If the existing Junos OS version matches the desired version, no action is performed, and the "changed" attribute reports False. If the existing version does not match, then the module performs the following actions
(1) Computes the MD5 checksum of the package located on the server. (2) Copies the Junos OS software package to the device running Junos OS. (3) Computes the MD5 checksum on the device running Junos OS and compares the two. (4) Installs the Junos OS software package. (5) Reboots the device (default).
Running the module in check mode reports whether the current Junos OS version matches the desired version.

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>force_host</td>
    <td>no</td>
    <td></td>
        <td><ul><li>true</li><li>false</li><li>yes</li><li>no</li></ul></td>
        <td>If set to <b>true</b>, forces the upgrade of the Host Software package on QFX-series devices.</td>
    </tr>
            <tr>
    <td>host</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Set to {{ inventory_hostname }}</td>
    </tr>
            <tr>
    <td>issu</td>
    <td>no</td>
    <td></td>
        <td><ul><li>true</li><li>false</li><li>yes</li><li>no</li></ul></td>
        <td>If set to <b>true</b>, allows unified in-service software upgrade (ISSU) feature enables you to upgrade between two different Junos OS releases with no disruption on the control plane and with minimal disruption of traffic.</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>no_copy</td>
    <td>no</td>
    <td></td>
        <td><ul><li>true</li><li>false</li></ul></td>
        <td>Installer need to be copied or not on the device.</td>
    </tr>
            <tr>
    <td>nssu</td>
    <td>no</td>
    <td></td>
        <td><ul><li>true</li><li>false</li><li>yes</li><li>no</li></ul></td>
        <td>If set to <b>true</b>, allows nonstop software upgrade (NSSU) enables you to upgrade the software running on a Juniper Networks EX Series Virtual Chassis or a Juniper Networks EX Series Ethernet Switch with redundant Routing Engines with a single command and minimal disruption to network traffic.</td>
    </tr>
            <tr>
    <td>package</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Absolute path on the local server to the Junos OS software package</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>reboot</td>
    <td>no</td>
    <td>True</td>
        <td><ul><li>true</li><li>false</li><li>yes</li><li>no</li></ul></td>
        <td>If set to <b>yes</b>, the device reboots after the installation completes.</td>
    </tr>
            <tr>
    <td>reboot_pause</td>
    <td>no</td>
    <td>10</td>
        <td><ul></ul></td>
        <td>Amount of time in seconds to wait after the reboot is issued</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>user</td>
    <td>no</td>
    <td>$USER</td>
        <td><ul></ul></td>
        <td>Login username</td>
    </tr>
            <tr>
    <td>version</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Junos OS version string as it would be reported by the <b>show version</b> command</td>
    </tr>
        </table>


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


Examples
--------

.. raw:: html

    <br/>


::

    
    - junos_install_os:
        host={{ inventory_hostname }}
        version=12.1X46-D10.2
        package=/usr/local/junos/images/junos-vsrx-12.1X46-D10.2-domestic.tgz
        logfile=/usr/local/junos/log/software.log