.. _system_mon_template:

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

Define an template monitor


mon-template Specification
--------------------------

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

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

	 **Element Name**                      mon-template

	 **Element URI**                       /axapi/v3/system/mon-template

	 **Element Attributes**                mon-template_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


mon-template_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _3335_mon-template_attributes:

mon-template attributes
-----------------------

    **link-block-as-down**

        **Description:** link-block-as-down is a **JSON Block**.  Please see below for :ref:`3335_link-block-as-down` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/mon-template/link-block-as-down <system_mon_template_link_block_as_down>`

    **link-down-on-restart**

        **Description:** link-down-on-restart is a **JSON Block**.  Please see below for :ref:`3335_link-down-on-restart` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/mon-template/link-down-on-restart <system_mon_template_link_down_on_restart>`

    **monitor-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/system/mon-template/monitor/{id} <system_mon_template_monitor>`

.. _3335_link-down-on-restart:

link-down-on-restart
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **enable**

        **Description** 

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

.. _3335_monitor-list:

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

	 **Block object keys**             

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

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

.. _3335_monitor-list_clear-cfg:

monitor-list_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

.. _3335_monitor-list_link-enable-cfg:

monitor-list_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

.. _3335_monitor-list_link-up-cfg:

monitor-list_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

.. _3335_monitor-list_link-down-cfg:

monitor-list_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

.. _3335_monitor-list_link-disable-cfg:

monitor-list_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

.. _3335_link-block-as-down:

link-block-as-down
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **enable**

        **Description** 

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