.. _monitor:

monitor
=======

System monitor configuration


monitor Specification
---------------------

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

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

	 **Element Name**                      monitor

	 **Element URI**                       /axapi/v3/monitor

	 **Element Attributes**                monitor_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`monitor schema <monitor/monitor.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/monitor



.. raw:: html

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


:ref:`2277_monitor_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/monitor_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/monitor



.. raw:: html

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


:ref:`2277_monitor_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/monitor_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/monitor



.. raw:: html

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


:ref:`2277_monitor_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/monitor



.. raw:: html

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


:ref:`2277_monitor_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/monitor_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/monitor



.. raw:: html

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


:ref:`2277_monitor_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/monitor_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2277_monitor_attributes:

monitor attributes
------------------

    **buffer-drop**

        **Description** Monitor buffer drop threshold (Threshold value)

        **Type:** number

        **Range:** 1-32767

        **Default:** 4000

    **buffer-usage**

        **Description** Monitor IO buffer usage threshold (Threshold value)

        **Type:** number

        **Range:** 60000-4000000

    **conn-type0**

        **Description** Conn resource type 0 (Threshold value, default 32767)

        **Type:** number

        **Range:** 32767-256000000

        **Default:** 32767

    **conn-type1**

        **Description** Conn resource type 1 (Threshold value, default 32767)

        **Type:** number

        **Range:** 32767-256000000

        **Default:** 32767

    **conn-type2**

        **Description** Conn resource type 2 (Threshold value, default 32767)

        **Type:** number

        **Range:** 32767-256000000

        **Default:** 32767

    **conn-type3**

        **Description** Conn resource type 3 (Threshold value, default 32767)

        **Type:** number

        **Range:** 32767-256000000

        **Default:** 32767

    **conn-type4**

        **Description** Conn resource type 4 (Threshold value, default 32767)

        **Type:** number

        **Range:** 32767-256000000

        **Default:** 32767

    **ctrl-cpu**

        **Description** Monitor control CPU threshold (Threshold value in percentage, default 90)

        **Type:** number

        **Range:** 1-100

        **Default:** 90

    **data-cpu**

        **Description** Monitor data CPU threshold (Threshold value in percentage, default 90)

        **Type:** number

        **Range:** 1-100

        **Default:** 90

    **disk**

        **Description** Monitor hard disk usage threshold (Threshold value in percentage, default 85)

        **Type:** number

        **Range:** 1-100

        **Default:** 85

    **memory**

        **Description** Monitor memory usage threshold (Threshold value in percentage, default 95)

        **Type:** number

        **Range:** 1-100

        **Default:** 95

    **smp-type0**

        **Description** SMP resource type 0 (Threshold value, default 32767)

        **Type:** number

        **Range:** 32767-256000000

        **Default:** 32767

    **smp-type1**

        **Description** SMP resource type 1 (Threshold value, default 32767)

        **Type:** number

        **Range:** 32767-256000000

        **Default:** 32767

    **smp-type2**

        **Description** SMP resource type 2 (Threshold value, default 32767)

        **Type:** number

        **Range:** 32767-256000000

        **Default:** 32767

    **smp-type3**

        **Description** SMP resource type 3 (Threshold value, default 32767)

        **Type:** number

        **Range:** 32767-256000000

        **Default:** 32767

    **smp-type4**

        **Description** SMP resource type 4 (Threshold value, default 32767)

        **Type:** number

        **Range:** 32767-256000000

        **Default:** 32767

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **warn-temp**

        **Description** Monitor warning system temperature threshold (Threshold value in Celsius, default 1)

        **Type:** number