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

.. 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.

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

.. osdx:cmdtree:: cfg

  system cli configuration commit