.. _acos_events_log_parameterization:

acos-events log-parameterization
================================

Harmony controller log parameterization configuration


log-parameterization Specification
----------------------------------

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

	===================================== =========================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      log-parameterization

	 **Element URI**                       /axapi/v3/acos-events/log-parameterization

	 **Element Attributes**                log-parameterization_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`log-parameterization schema <acos-events-log-parameterization/acos-events-log-parameterization.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'>


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/acos-events/log-parameterization



.. raw:: html

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


:ref:`152_log-parameterization_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/acos_events_log_parameterization_POST.txt
   :literal:




.. raw:: html

   </div></td></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/acos-events/log-parameterization



.. raw:: html

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


:ref:`152_log-parameterization_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/acos_events_log_parameterization_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Modify Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/acos-events/log-parameterization



.. raw:: html

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


:ref:`152_log-parameterization_attributes`



.. raw:: html

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




.. raw:: html

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


Replace Object



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/acos-events/log-parameterization



.. raw:: html

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


:ref:`152_log-parameterization_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/acos_events_log_parameterization_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/acos-events/log-parameterization



.. raw:: html

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


:ref:`152_log-parameterization_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/acos_events_log_parameterization_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _152_log-parameterization_attributes:

log-parameterization attributes
-------------------------------

    **log-rate**

        **Description** Max number of parameterized logs sent per second

        **Type:** number

        **Range:** 0-10000

        **Default:** 10

    **message-selector**

        **Description:** message-selector is a **JSON Block**.  Please see below for :ref:`152_message-selector` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/acos-events/log-parameterization/message-selector <acos_events_log_parameterization_message_selector>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _152_message-selector:

message-selector
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **rule-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/acos-events/log-parameterization/message-selector/rule/{index} <acos_events_log_parameterization_message_selector_rule>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _152_message-selector_rule-list:

message-selector_rule-list
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'send': log messages selected by this rule will be sent (Default); 'drop': log messages selected by this rule will be dropped; 

        **Type:** string

        **Supported Values:** send, drop

        **Default:** send

    **index**

        **Description** Specify rule index - rules are applied in numeric order

        **Type:** number

        **Range:** 1-256

    **message-id**

        **Description** Select a specific message by message-id and optionally severity

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **message-id-scope**

        **Description** 'all': Log messages at this level and all sub-trees; 'node-only': Log messages at this node only; 'children-only': Log messages at all sub-trees only; 'log-field-only': Log message for this Log Field only; 

        **Type:** string

        **Supported Values:** all, node-only, children-only, log-field-only

    **severity-oper**

        **Description** 'equal-and-higher': emergency is highest, debugging lowest; 'equal': single severity; 

        **Type:** string

        **Supported Values:** equal-and-higher, equal

    **severity-val**

        **Description** 'emergency': System unusable log messages (Most Important); 'alert': Action must be taken immediately; 'critical': Critical conditions; 'error': Error conditions; 'warning': Warning conditions; 'notification': Normal but significant conditions; 'information': Informational messages; 'debugging': Debug level messages (Least Important); 

        **Type:** string

        **Supported Values:** emergency, alert, critical, error, warning, notification, information, debugging

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters