===
SSM
===

.. sidebar:: Contents

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


This chapter covers some aspects related to the :osdx:cfg:`service ssm` tool, which
allows operations to be configured to monitor several system parameters
and feed system alarms.

Depending on the system parameter monitored, the 
``type`` of SSM operation can be configured using one of the following values:

 * ``cpu``: to monitor the CPU load percentage in the last minute.
 * ``memory``: to monitor the memory used.
 * ``storage``: to monitor the storage used.
 * ``temperature``: to monitor the current temperature.

The monitoring ``interval`` of each SSM operation can also be configured.
By default, monitoring is carried out every **second**.

An SSM operation can be configured to feed more than one alarm defined
in the system. To do this, the name of the ``alarm`` and the threshold value of the 
monitored parameter that will ``activate`` this alarm must be indicated.

If the value of the monitored parameter does not reach 70% of the activation threshold,
an SSM operation also deactivates the alarms being fed.
This default deactivation threshold can be changed through
the ``deactivate`` field.

These activation and deactivation thresholds can be configured as
absolute values or as a percentage of the parameter being monitored. It is
worth noting that not all operations accept both types of threshold.

 * ``cpu`` only accepts ``percentage`` thresholds.
 * ``temperature`` only accepts ``value`` thresholds.


Configuration
=============

This is the syntax to create a :osdx:cfg:`service ssm`:

.. code-block:: none

  set service ssm operation <op_name> [ ... ]


Examples
========

CPU monitoring
--------------

Imagine you want to configure an SSM operation to monitor the CPU
status every 10 seconds and feed two different alarms.

For the first alarm, set the following thresholds:

 * Activation: when the CPU value exceeds 85%.
 * Deactivation: when the CPU value drops below 70%.

For the second alarm, set the following thresholds:

 * Activation: when the CPU value exceeds 95%.
 * Deactivation: default value.

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

.. code-block:: none

  set service ssm operation TEST_OPER type cpu
  set service ssm operation TEST_OPER interval 10
  set service ssm operation TEST_OPER alarm TEST_ALARM_1 activate percentage 85
  set service ssm operation TEST_OPER alarm TEST_ALARM_1 deactivate percentage 70
  set service ssm operation TEST_OPER alarm TEST_ALARM_2 activate percentage 95

Lastly, for this to work, alarms must be defined:

.. code-block:: none

  set system alarm TEST_ALARM_1
  set system alarm TEST_ALARM_2


Monitoring
==========

Operational command ``service ssm operation [ <op_name> ]`` can be used
to display statistics related to ``ssm`` operations.

*Example:*

.. code-block:: none
 
  admin@DUT0$ service ssm operation TEST_OPER show 
  
  ----------------------------------------------------------------------------------------------
  Operation  Type  Last-Value     Alarm      Activate  Deactivate  Status  Toggled  Prev-toggled
  ----------------------------------------------------------------------------------------------
  TEST_OPER  cpu         0.21  TEST_ALARM_2     95.00       66.50  false 
  TEST_OPER  cpu         0.21  TEST_ALARM_1     85.00       70.00  false 
..
  depth=5 to show ssm alarm options

.. osdx:cmdtree:: cfg
  :maxdepth: 5

  service ssm