.. _scaleout_cluster_local_device_tracking_template:

scaleout cluster local-device tracking-template
===============================================

Configure scaleout tracking


tracking-template Specification
-------------------------------

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

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

	 **Element Name**                      tracking-template

	 **Element URI**                       /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template

	 **Element Attributes**                tracking-template_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`tracking-template schema <scaleout-cluster-local-device-tracking-template/scaleout-cluster-local-device-tracking-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/scaleout/cluster/{cluster-id}/local-device/tracking-template



.. raw:: html

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


tracking-template_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/scaleout_cluster_local_device_tracking_template_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2607_tracking-template_attributes:

tracking-template attributes
----------------------------

    **multi-template-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template/{multi-template} <scaleout_cluster>`

    **template-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/template/{template} <scaleout_cluster>`

.. _2607_multi-template-list:

multi-template-list
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'down': node stops processing user traffic; 'exit-cluster': node exits scaleout cluster; 

        **Type:** string

        **Supported Values:** down, exit-cluster

    **multi-template**

        **Description** bind multi tracking template name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **template**

        **Type:** List

    **threshold**

        **Description** action triggering threshold

        **Type:** number

        **Range:** 1-65535

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

.. _2607_multi-template-list_template:

multi-template-list_template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **partition-name**

        **Description** Partition name

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/partition <partition>`

    **template-name**

        **Description** bind tracking template name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _2607_template-list:

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

	 **Block object keys**             

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

    **template**

        **Description** bind tracking template name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **threshold-cfg**

        **Type:** List

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

.. _2607_template-list_threshold-cfg:

template-list_threshold-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'down': node stops processing user traffic; 'exit-cluster': node exits scaleout cluster; 

        **Type:** string

        **Supported Values:** down, exit-cluster

    **threshold**

        **Description** action triggering threshold

        **Type:** number

        **Range:** 1-65535