.. _alert-types-field-reference:

Alert Types and Alert Field Reference
---------------------------------------

.. _21.3|VOSS-886:

For alert codes also see:

.. raw:: html

   <a href="operations/reference-error-codes.html">Error Messages</a> and SNMP Traps in the Platform Guide.

.. raw:: latex


   the Error Messages topic in the Platform or API Guides and SNMP Traps in the Platform Guide.

.. _database-maintenance-alerts:

Database Maintenance Alerts
...........................

.. _19.2.1|VOSS-542|EKB-1564:

If database maintenance schedules have not been set up from the
Command Line Interface (CLI), alerts are shown 
*at the provider level hierarchy* for each required schedule.

The schedules are required to periodically:

* Archive or delete database transaction logs 
  (CLI: **voss transaction archive** or **voss transaction delete**)

Refer to the Platform Guide topic "Enable Database Scheduling " 
for details.

The format of the alert is:

* ID: A generated identifier:

  * ``TRANSACTION_DATABASE-<hostname>``

  .. note:: The ``<hostname>`` will be a primary unified node. 
     These are where alerts are generated.

* Code: An error or warning code associated with the alert. (``-1``)
* Alert category: ``Database Maintenance``
* Severity: ``Warning``
* Message:

  * ``TRANSACTION DATABASE MAINTENANCE NOT SCHEDULED``

* Count: Displays the number of times the alert has occurred.
* Latest Alert: Displays the last time this alert occurred.

+------------+---------------------------------+----------------------+
| Alert Code |  Alert ID                       |  Alert Category      |
+============+=================================+======================+
| -1         | TRANSACTION_DATABASE-<hostname> | Database Maintenance |
+------------+---------------------------------+----------------------+
| -1         | CACHE_DATABASE-<hostname>       | Database Maintenance |
+------------+---------------------------------+----------------------+

.. _licensing-alerts:

Licensing
...........


+------------+--------------------------------------------------+----------------------------------+
| Alert Code |  Alert ID                                        |  Alert Category                  |
+============+==================================================+==================================+
| 36200      | Hierarchy Resolution Failure                     | Licensing                        |
+------------+--------------------------------------------------+----------------------------------+
| 36100      | License Audit File Transfer or                   | License Audit File Transfer      |
|            | data/SmtpDestination, data/HttpDestination, etc. |                                  |
+------------+--------------------------------------------------+----------------------------------+

.. _change-notification-alerts:

Change Notification
.......................

+-------------------------+-----------------------------+---------------------------------------------------+
| Alert Code              |  Alert ID                   |  Alert Category                                   |
+=========================+=============================+===================================================+
| calling exception code: | device pkid OR business key | Device Change Notification Collector <model type> |
| 40000-40006, 40008      |                             |                                                   |
+-------------------------+-----------------------------+---------------------------------------------------+

.. _number-inventory-alerts:

Number Inventory Alerts
.......................

If alerts have been enabled on available number inventory numbers in global settings,
alerts are raised when the availability threshold is exceeded. See: :ref:`global-settings`.

+------------+---------------------------------------------+------------------+
| Alert Code |  Alert ID                                   |  Alert Category  |
+============+=============================================+==================+
| 110000     | Number Inventory Threshold of               | Number Inventory |
|            | {{ pwf.INI_ALERT_THRESHOLD }}% Exceeded ... |                  |
+------------+---------------------------------------------+------------------+

In the GUI, the alert **Message** field  also provides details on the INI threshold,
availability, hierarchy, count and a CSV list of nodes and numbers, as shown in the
alert message template below. (Long message strings are truncated). For details on macro
references, refer to :ref:`email-html-templates`:

::

   {{ pwf.INI_ALERT_HIERARCHY_NODE_TYPE }} [{{ pwf.INI_ALERT_HIERARCHY_NAME }}].
   Hierarchy full path = {{ pwf.INI_ALERT_HIERARCHY }}
   Total INI Available = {{ pwf.INI_ALERT_TOTAL_INI_AVAILABLE }}
   Total INI count = {{ pwf.INI_ALERT_TOTAL_INI_COUNT }}
   Total percent available = {{ fn.as_string pwf.INI_ALERT_TOTAL_PERCENT_AVAILABLE }}%

   {{ pwf.INI_ALERT_NODES_EXCEEDED_THRESHOLD_DATA_ALERT }}


.. important::

   * If alerts have been enabled, a schedule called "InternalNumberInventoryAlert" is also created
     that is by default set to run daily if the availability threshold in the global settings is exceeded.
     For schedule management, see :ref:`scheduling`.


Alert Field Reference
........................

-  The field Title is indicated in bold. An asterisk * indicates
   the field is mandatory.
-  If the field Type is an array, its the Field Name has a .[n] suffix,
   where n is the array index placeholder.
-  Object and array names are listed to provide the context of fields.
-  If a field belongs to an object or an array, the full name is in dot
   separated notation.
-  Where cardinality is shown, the range is [MinItems..MaxItems].
-  If a field has a Default value, the value is shown.
-  If a field has a Pattern, the regular expression pattern is shown.

.. tabularcolumns:: |p{4cm}|p{10cm}|

+--------------------+-----------------------------------------------+
| **ID \***          |                                               |
+--------------------+-----------------------------------------------+
| Field Name         | alert\_id                                     |
+--------------------+-----------------------------------------------+
| Description        | The unique ID of the alert                    |
+--------------------+-----------------------------------------------+
| Type               | String                                        |
+--------------------+-----------------------------------------------+
| **Code \***        |                                               |
+--------------------+-----------------------------------------------+
| Field Name         | alert\_code                                   |
+--------------------+-----------------------------------------------+
| Description        | The code of the alert                         |
+--------------------+-----------------------------------------------+
| Type               | String                                        |
+--------------------+-----------------------------------------------+
| **Category \***    |                                               |
+--------------------+-----------------------------------------------+
| Field Name         | alert\_category                               |
+--------------------+-----------------------------------------------+
| Description        | The category of the alert                     |
+--------------------+-----------------------------------------------+
| Type               | String                                        |
+--------------------+-----------------------------------------------+
| **Severity**       |                                               |
+--------------------+-----------------------------------------------+
| Field Name         | alert\_severity                               |
+--------------------+-----------------------------------------------+
| Description        | The severity of the alert                     |
+--------------------+-----------------------------------------------+
| Type               | String                                        |
+--------------------+-----------------------------------------------+
| Choices            | ["Error", "Warning", "Info"]                  |
+--------------------+-----------------------------------------------+
| **Message**        |                                               |
+--------------------+-----------------------------------------------+
| Field Name         | alert\_message                                |
+--------------------+-----------------------------------------------+
| Description        | The message describing the alert              |
+--------------------+-----------------------------------------------+
| Type               | String                                        |
+--------------------+-----------------------------------------------+
| **Count**          |                                               |
+--------------------+-----------------------------------------------+
| Field Name         | alert\_count                                  |
+--------------------+-----------------------------------------------+
| Description        | The number of times this alert has occurred   |
+--------------------+-----------------------------------------------+
| Type               | Integer                                       |
+--------------------+-----------------------------------------------+
| **Latest Alert**   |                                               |
+--------------------+-----------------------------------------------+
| Field Name         | alert\_timestamp                              |
+--------------------+-----------------------------------------------+
| Description        | The last time this alert occurred             |
+--------------------+-----------------------------------------------+
| Type               | String                                        |
+--------------------+-----------------------------------------------+
| Format             | date-time                                     |
+--------------------+-----------------------------------------------+