.. _scaleout_cluster_local_device:

scaleout cluster local-device
=============================

Local device configuration


local-device Specification
--------------------------

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

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

	 **Element Name**                      local-device

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

	 **Element Attributes**                local-device_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2611_local-device_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/scaleout_cluster_local_device_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/scaleout/cluster/{cluster-id}/local-device



.. raw:: html

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


:ref:`2611_local-device_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_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/scaleout/cluster/{cluster-id}/local-device



.. raw:: html

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


:ref:`2611_local-device_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/scaleout/cluster/{cluster-id}/local-device



.. raw:: html

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


:ref:`2611_local-device_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/scaleout_cluster_local_device_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/scaleout/cluster/{cluster-id}/local-device



.. raw:: html

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


:ref:`2611_local-device_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/scaleout_cluster_local_device_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2611_local-device_attributes:

local-device attributes
-----------------------

    **action**

        **Description** 'enable': enable; 'disable': disable; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **cluster-mode**

        **Description** 'layer-2': Nodes in cluster are layer 2 connected (default mode); 'layer-3': Nodes in cluster are l3 connected; 

        **Type:** string

        **Supported Values:** layer-2, layer-3

        **Default:** layer-2

    **exclude-interfaces**

        **Description:** exclude-interfaces is a **JSON Block**.  Please see below for :ref:`2611_exclude-interfaces` 

        **Type:** Object

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

    **id**

        **Description** 

        **Type:** number

        **Range:** 1-16

    **l2-redirect**

        **Description:** l2-redirect is a **JSON Block**.  Please see below for :ref:`2611_l2-redirect` 

        **Type:** Object

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

    **priority**

        **Description** 

        **Type:** number

        **Range:** 1-255

    **session-sync**

        **Description:** session-sync is a **JSON Block**.  Please see below for :ref:`2611_session-sync` 

        **Type:** Object

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

    **start-delay**

        **Description** 

        **Type:** number

        **Range:** 10-300

    **tracking-template**

        **Description:** tracking-template is a **JSON Block**.  Please see below for :ref:`2611_tracking-template` 

        **Type:** Object

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

    **traffic-redirection**

        **Description:** traffic-redirection is a **JSON Block**.  Please see below for :ref:`2611_traffic-redirection` 

        **Type:** Object

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2611_session-sync:

session-sync
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **follow-shared**

        **Description** Follow shared partition for session sync

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **interfaces**

        **Description:** interfaces is a **JSON Block**.  Please see below for :ref:`2611_session-sync_interfaces` 

        **Type:** Object

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

    **reachability-options**

        **Description:** reachability-options is a **JSON Block**.  Please see below for :ref:`2611_session-sync_reachability-options` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync/reachability-options <scaleout_cluster>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2611_session-sync_interfaces:

session-sync_interfaces
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **eth-cfg**

        **Type:** List

    **loopback-cfg**

        **Type:** List

    **trunk-cfg**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve-cfg**

        **Type:** List

.. _2611_session-sync_interfaces_ve-cfg:

session-sync_interfaces_ve-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ve**

        **Description** Virtual ethernet Interface (Virtual ethernet interface number)

        **Type:** number

        **Range:** 2-4094

.. _2611_session-sync_interfaces_loopback-cfg:

session-sync_interfaces_loopback-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **loopback**

        **Description** Loopback Interface(Not applicable in 'layer-2' mode) (Loopback interface number)

        **Type:** number

        **Range:** 0-10

.. _2611_session-sync_interfaces_trunk-cfg:

session-sync_interfaces_trunk-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **trunk**

        **Description** Trunk Interface (Trunk interface number)

        **Type:** number

        **Range:** 1-4096

.. _2611_session-sync_interfaces_eth-cfg:

session-sync_interfaces_eth-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet**

        **Description** Ethernet Interface (Ethernet interface number)

        **Type:** number

        **Format:** interface

.. _2611_session-sync_reachability-options:

session-sync_reachability-options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **skip-default-route**

        **Description** Do not choose default route for redirection(Not applicable in 'layer-2' mode)

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

.. _2611_exclude-interfaces:

exclude-interfaces
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **eth-cfg**

        **Type:** List

    **loopback-cfg**

        **Type:** List

    **trunk-cfg**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve-cfg**

        **Type:** List

.. _2611_exclude-interfaces_ve-cfg:

exclude-interfaces_ve-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ve**

        **Description** Virtual ethernet Interface (Virtual ethernet interface number)

        **Type:** number

        **Range:** 2-4094

.. _2611_exclude-interfaces_loopback-cfg:

exclude-interfaces_loopback-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **loopback**

        **Description** Loopback Interface (Loopback interface number)

        **Type:** number

        **Range:** 0-10

.. _2611_exclude-interfaces_trunk-cfg:

exclude-interfaces_trunk-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **trunk**

        **Description** Trunk Interface (Trunk interface number)

        **Type:** number

        **Range:** 1-4096

.. _2611_exclude-interfaces_eth-cfg:

exclude-interfaces_eth-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet**

        **Description** Ethernet Interface (Ethernet interface number)

        **Type:** number

        **Format:** interface

.. _2611_l2-redirect:

l2-redirect
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ethernet-vlan**

        **Description** VLAN ID

        **Type:** number

        **Range:** 2-4094

    **redirect-eth**

        **Description** Ethernet port (Port Value)

        **Type:** number

        **Format:** interface

        **Mutual Exclusion:** redirect-eth and redirect-trunk are mutually exclusive

    **redirect-trunk**

        **Description** L2 Trunk group

        **Type:** number

        **Range:** 1-4096

        **Mutual Exclusion:** redirect-trunk and redirect-eth are mutually exclusive

    **trunk-vlan**

        **Description** VLAN ID

        **Type:** number

        **Range:** 2-4094

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2611_traffic-redirection:

traffic-redirection
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **follow-shared**

        **Description** Follow shared partition for redirection

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **interfaces**

        **Description:** interfaces is a **JSON Block**.  Please see below for :ref:`2611_traffic-redirection_interfaces` 

        **Type:** Object

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

    **reachability-options**

        **Description:** reachability-options is a **JSON Block**.  Please see below for :ref:`2611_traffic-redirection_reachability-options` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/traffic-redirection/reachability-options <scaleout_cluster>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2611_traffic-redirection_interfaces:

traffic-redirection_interfaces
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **eth-cfg**

        **Type:** List

    **loopback-cfg**

        **Type:** List

    **trunk-cfg**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve-cfg**

        **Type:** List

.. _2611_traffic-redirection_interfaces_ve-cfg:

traffic-redirection_interfaces_ve-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ve**

        **Description** Virtual ethernet Interface (Virtual ethernet interface number)

        **Type:** number

        **Range:** 2-4094

.. _2611_traffic-redirection_interfaces_loopback-cfg:

traffic-redirection_interfaces_loopback-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **loopback**

        **Description** Loopback Interface (Loopback interface number)

        **Type:** number

        **Range:** 0-10

.. _2611_traffic-redirection_interfaces_trunk-cfg:

traffic-redirection_interfaces_trunk-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **trunk**

        **Description** Trunk Interface (Trunk interface number)

        **Type:** number

        **Range:** 1-4096

.. _2611_traffic-redirection_interfaces_eth-cfg:

traffic-redirection_interfaces_eth-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet**

        **Description** Ethernet Interface (Ethernet interface number)

        **Type:** number

        **Format:** interface

.. _2611_traffic-redirection_reachability-options:

traffic-redirection_reachability-options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **skip-default-route**

        **Description** Do not choose default route for redirection

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

.. _2611_tracking-template:

tracking-template
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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

.. _2611_tracking-template_multi-template-list:

tracking-template_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

.. _2611_tracking-template_multi-template-list_template:

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

.. _2611_tracking-template_template-list:

tracking-template_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

.. _2611_tracking-template_template-list_threshold-cfg:

tracking-template_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