.. _junos_shutdown:


junos_shutdown - Shut down or reboot a device running Junos OS.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

:Author: Jeremy Schulman, Juniper Networks

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

Synopsis
--------

.. versionadded:: 1.0.0

Shut down (power off) or reboot a device running Junos OS. This includes all Routing Engines in a Virtual Chassis or a dual Routing Engine system. This is equivalent to executing either the Junos OS **request system power-off** or **request system reboot** operational command.

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>at</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Specify a time for the reboot (yyyymmddhhmm). Can be used only with reboot=yes.</td>
    </tr>
            <tr>
    <td>host</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Set to {{ inventory_hostname }}</td>
    </tr>
            <tr>
    <td>in_min</td>
    <td>no</td>
    <td></td>
        <td><ul></ul></td>
        <td>Specify a delay, in minutes, before the shutdown or reboot. If both "at" and "in_min" are specified, "in_min" will be ignored.</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>reboot</td>
    <td>no</td>
    <td></td>
        <td><ul><li>yes</li><li>no</li></ul></td>
        <td>If set to <b>yes</b>, then the device is rebooted rather than powered off.</td>
    </tr>
            <tr>
    <td>shutdown</td>
    <td>yes</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Safety mechanism. You <b>MUST</b> set this to 'shutdown'.</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>
        </table>


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


Examples
--------

.. raw:: html

    <br/>


::

    
    - junos_shutdown:
        host={{ inventory_hostname }}
        shutdown="shutdown"
        reboot=yes
    
    # over console server connection using PyEZ >= 2.0
    - junos_shutdown:
        host={{ inventory_hostname }}
        shutdown="shutdown"
        reboot=yes
        mode='telnet'
        port=7016