.. _logging_email:

logging email
=============

Set logging level which sent to email address


email Specification
-------------------

	===================================== ======================================================
	 **Parameter**                         **Value** 

	===================================== ======================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      email

	 **Element URI**                       /axapi/v3/logging/email

	 **Element Attributes**                email_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`email schema <logging-email/logging-email.txt>`
	===================================== ======================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/logging/email



.. raw:: html

   </td><td valign = 'top'>


email_attributes



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _2234_email_attributes:

email attributes
----------------

    **buffer**

        **Description:** buffer is a **JSON Block**.  Please see below for :ref:`2234_buffer` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/email/buffer <logging_email_buffer>`

    **filter-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/logging/email/filter/{filter-id} <logging_email_filter>`

    **level**

        **Description:** level is a **JSON Block**.  Please see below for :ref:`2234_level` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/email/level <logging_email_level>`

.. _2234_buffer:

buffer
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **number**

        **Description** Number of log messages that can be buffered (Number of log messages that can be buffered, default 50)

        **Type:** number

        **Range:** 16-256

        **Default:** 50

    **time**

        **Description** Number of minutes a log message can stay in buffer (Number of minutes a log message can stay in buffer, default 10)

        **Type:** number

        **Range:** 10-1440

        **Default:** 10

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2234_filter-list:

filter-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **expression**

        **Description** Reverse Polish Notation, consists of level 0-7, module AFLEX/HMON/..., pattern log-content-pattern, and or/and/not

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 511 characters

        **Maximum Length:** 1 characters

    **filter-id**

        **Description** Logging via email filter settings

        **Type:** number

        **Range:** 1-8

    **trigger**

        **Description** Trigger email, override buffer settings

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2234_level:

level
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **email-levelname**

        **Description** 'disable': Do not send log to email address; 'emergency': System unusable log messages      (severity=0); 'alert': Action must be taken immediately   (severity=1); 'critical': Critical conditions      (severity=2); 'notification': Normal but significant conditions (severity=5); 

        **Type:** string

        **Supported Values:** disable, emergency, alert, critical, notification

        **Default:** disable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters