.. _junos_commit:


junos_commit - Execute commit on device
+++++++++++++++++++++++++++++++++++++++

:Author: Rick Sherman, Juniper Networks

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

Synopsis
--------

.. versionadded:: 1.2.0

Execute a Commit on a device running Junos independently of loading a configuration

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>check</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Do a commit check Can be used to confirm a `commit confirmed` without performing an actual commit</td>
    </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>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>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>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>Extend the NETCONF RPC timeout beyond the default value of 30 seconds. Set this value to accommodate 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


Examples
--------

.. raw:: html

    <br/>


::

    
    - junos_commit:
       host: "{{ inventory_hostname }}"
       logfile=changes.log
       comment="Non load commit"
    
    # over console server connection using PyEZ >= 2.0
    - name: junos commit
      junos_commit:
        host={{ inventory_hostname }}
        port=7016
        mode='telnet'
        comment="commit with console connection via PyEZ"