.. _scaleout_cluster_local_device_session_sync:

scaleout cluster local-device session-sync
==========================================

Interface for scaleout session sync


session-sync Specification
--------------------------

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

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

	 **Element Name**                      session-sync

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

	 **Element Attributes**                session-sync_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2604_session-sync_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/session-sync



.. raw:: html

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


:ref:`2604_session-sync_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/session-sync



.. raw:: html

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


:ref:`2604_session-sync_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/session-sync



.. raw:: html

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


:ref:`2604_session-sync_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/session-sync



.. raw:: html

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


:ref:`2604_session-sync_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2604_session-sync_attributes:

session-sync attributes
-----------------------

    **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:`2604_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:`2604_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

.. _2604_interfaces:

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

.. _2604_interfaces_ve-cfg:

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

	 **Block object keys**             

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

    **ve**

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

        **Type:** number

        **Range:** 2-4094

.. _2604_interfaces_loopback-cfg:

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

.. _2604_interfaces_trunk-cfg:

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

	 **Block object keys**             

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

    **trunk**

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

        **Type:** number

        **Range:** 1-4096

.. _2604_interfaces_eth-cfg:

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

	 **Block object keys**             

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

    **ethernet**

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

        **Type:** number

        **Format:** interface

.. _2604_reachability-options:

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