.. _scaleout_cluster_local_device:

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

Local device configuration


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

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

	 **Element Name**                      local-device

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

	 **Element Attributes**                local-device_attributes

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



.. raw:: html

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


:ref:`555_local-device_attributes`



.. 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/scaleout/cluster/{cluster-id}/local-device



.. raw:: html

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


:ref:`555_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:`555_local-device_attributes`



.. 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/scaleout/cluster/{cluster-id}/local-device



.. raw:: html

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


:ref:`555_local-device_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _555_local-device_attributes:

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

    **id**

        **Description** 

        **Type:** number

        **Range:** 1-8

    **l2-redirect**

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

        **Type:** Object

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

    **priority**

        **Description** 

        **Type:** number

        **Range:** 1-255

    **session-sync-interface**

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

        **Type:** Object

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _555_l2-redirect:

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

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

    **ethernet-vlan**

        **Description** VLAN ID

        **Type:** number

        **Range:** 2-4094

    **redirect-eth**

        **Description** Ethernet port (Port Value)

        **Type:** number

        **Format:** interface

        **Range:** 2-224

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

.. _555_session-sync-interface:

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

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

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

.. _555_session-sync-interface_ve-cfg:

session-sync-interface_ve-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ve**

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

        **Type:** number

        **Range:** 2-4094

.. _555_session-sync-interface_trunk-cfg:

session-sync-interface_trunk-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **trunk**

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

        **Type:** number

        **Range:** 1-4096

.. _555_session-sync-interface_eth-cfg:

session-sync-interface_eth-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet**

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

        **Type:** number

        **Format:** interface

        **Range:** 0-1