======
Commit
======

.. sidebar:: Contents

  .. contents::
      :depth: 3
      :local:


This chapter covers some aspects related to the ``system cli configuration commit`` tool,
which allows you to configure the behaviour of the "commit" command in OSDx.

Commit Alarm
============

One of the available options is to configure the system to feed an ``alarm`` based on
whether the execution of the "commit" command succeeds or fails.

 * If the commit **fails**, the alarm will be **activated**.
 * If the commit **succeeds**, the alarm will be **deactivated**.


Configuration
-------------

This is the syntax to configure the behaviour of the "commit" command in OSDx:

.. code-block:: none

  set system cli configuration commit [ ... ]


Examples
--------

Enable the feeding of an alarm based on the commit validation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Imagine that you want to configure the system so that the status of alarm ALARM_COMMIT
is updated based on the commit result.

In OSDx, this can be achieved by setting the following commands:

.. code-block:: none

  set system cli configuration commit alarm ALARM_COMMIT


Commit Confirmation Needed
==========================

Use this command to require a confirmation after each commit. This is useful when
you want to ensure that you don't lose the connection to the device once the new
configuration is committed.

When the commit confirmation-needed is set, the system will wait for a confirmation
after each commit. This confirmation can be done by 3 different ways:

  * Another **commit**, if the confirmation-needed is still set, it will wait for another
    confirmation. if not set, the previous commit is considered confirmed.
  * **Save**, it is assumed that if the user saves the configuration, it is because the
    configuration is correct so the commit will be considered confirmed.
  * :osdx:op:`system cli configuration commit confirm`, this operational command will 
    confirm the last commit.

If no confirmation is received after the timeout, the commit will be automatically 
rolled back, by committing the previous configuration which was saved before the 
commit. 

Configuration
-------------

To configure the commit confirmation, you need to set the following commands:

.. code-block:: none

  set system cli configuration commit confirm-needed
  set system cli configuration commit confirm-needed timeout <u32>

By default, the timeout is set to **600** seconds.

Use the following command to confirm the commit:

.. code-block:: none

  system cli configuration commit confirm



.. osdx:cmdtree:: cfg

  system cli configuration commit

.. osdx:cmdtree:: op

  system cli configuration commit