.. _system_mon_template_monitor:

system mon-template monitor
===========================

Monitor template


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

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

	===================================== =========================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *id*

	 **Collection Name**                   :ref:`3334_monitor_list`

	 **Collection URI**                    /axapi/v3/system/mon-template/monitor

	                                       

	 **Element Name**                      monitor

	 **Element URI**                       /axapi/v3/system/mon-template/monitor/{id}

	 **Element Attributes**                monitor_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3334_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/system_mon_template_monitor_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/system/mon-template/monitor



.. raw:: html

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


:ref:`3334_monitor_attributes`



.. raw:: html

   </td><td></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/system/mon-template/monitor/{id}



.. raw:: html

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


:ref:`3334_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/system_mon_template_monitor_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/system/mon-template/monitor



.. raw:: html

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


:ref:`3334_monitor_list`



.. raw:: html

   </td><td></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/system/mon-template/monitor/{id}



.. raw:: html

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


:ref:`3334_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/system/mon-template/monitor/{id}



.. raw:: html

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


:ref:`3334_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/system_mon_template_monitor_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/system/mon-template/monitor



.. raw:: html

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


:ref:`3334_monitor_list`



.. raw:: html

   </td><td></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/system/mon-template/monitor/{id}



.. raw:: html

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


:ref:`3334_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/system_mon_template_monitor_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3334_monitor_list:

monitor-list
------------


    monitor-list is **JSON List** of :ref:`3334_monitor_attributes` 

        monitor-list : [

             { :ref:`3334_monitor_attributes` },

             { :ref:`3334_monitor_attributes` },

             ...

         ]

.. _3334_monitor_attributes:

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

    **clear-cfg**

        **Type:** List

    **id**

        **Description** Monitor template ID Number

        **Type:** number

        **Range:** 1-16

    **link-disable-cfg**

        **Type:** List

    **link-down-cfg**

        **Type:** List

    **link-enable-cfg**

        **Type:** List

    **link-up-cfg**

        **Type:** List

    **monitor-relation**

        **Description** 'monitor-and': Configures the monitors in current template to work with AND logic; 'monitor-or': Configures the monitors in current template to work with OR logic; 

        **Type:** string

        **Supported Values:** monitor-and, monitor-or

        **Default:** monitor-and

    **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

.. _3334_clear-cfg:

clear-cfg
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **clear-all-sequence**

        **Description** Sequence number (Specify the port physical port number)

        **Type:** number

        **Range:** 1-16

    **clear-sequence**

        **Description** Specify the port physical port number

        **Type:** number

        **Range:** 1-16

    **sessions**

        **Description** 'all': Clear all sessions; 'sequence': Sequence number; 

        **Type:** string

        **Supported Values:** all, sequence

.. _3334_link-enable-cfg:

link-enable-cfg
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ena-sequence**

        **Description** Sequence number (Specify the sequence number)

        **Type:** number

        **Range:** 1-16

    **enaeth**

        **Description** Specify the physical port number (Ethernet interface number)

        **Type:** number

        **Format:** interface

.. _3334_link-up-cfg:

link-up-cfg
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **link-up-sequence1**

        **Description** Sequence number (Specify the sequence number)

        **Type:** number

        **Range:** 1-16

    **link-up-sequence2**

        **Description** Sequence number (Specify the sequence number)

        **Type:** number

        **Range:** 1-16

    **link-up-sequence3**

        **Description** Sequence number (Specify the sequece number)

        **Type:** number

        **Range:** 1-16

    **linkup-ethernet1**

        **Description** Specify the port physical port number (Ethernet interface number)

        **Type:** number

        **Format:** interface

    **linkup-ethernet2**

        **Description** Specify the port physical port number (Ethernet interface number)

        **Type:** number

        **Format:** interface

    **linkup-ethernet3**

        **Description** Specify the port physical port number (Ethernet interface number)

        **Type:** number

        **Format:** interface

.. _3334_link-down-cfg:

link-down-cfg
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **link-down-sequence1**

        **Description** Sequence number (Specify the sequence number)

        **Type:** number

        **Range:** 1-16

    **link-down-sequence2**

        **Description** Sequence number (Specify the seqeuence number)

        **Type:** number

        **Range:** 1-16

    **link-down-sequence3**

        **Description** Sequence number (Specify the sequence number)

        **Type:** number

        **Range:** 1-16

    **linkdown-ethernet1**

        **Description** Specify the port physical port number (Ethernet interface number)

        **Type:** number

        **Format:** interface

    **linkdown-ethernet2**

        **Description** Specify the port physical port number (Ethernet interface number)

        **Type:** number

        **Format:** interface

    **linkdown-ethernet3**

        **Description** Specify the port physical port number (Ethernet interface number)

        **Type:** number

        **Format:** interface

.. _3334_link-disable-cfg:

link-disable-cfg
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **dis-sequence**

        **Description** Sequence number (Specify the sequence number)

        **Type:** number

        **Range:** 1-16

    **diseth**

        **Description** Specify the physical port number (Ethernet interface number)

        **Type:** number

        **Format:** interface