.. _scaleout_distributed_forwarding:

scaleout distributed-forwarding
===============================

Enable Scaleout distributed-forwarding


distributed-forwarding Specification
------------------------------------

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

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

	 **Element Name**                      distributed-forwarding

	 **Element URI**                       /axapi/v3/scaleout/distributed-forwarding

	 **Element Attributes**                distributed-forwarding_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`distributed-forwarding schema <scaleout-distributed-forwarding/scaleout-distributed-forwarding.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/distributed-forwarding



.. raw:: html

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


distributed-forwarding_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2733_distributed-forwarding_attributes:

distributed-forwarding attributes
---------------------------------

    **cgn**

        **Description:** cgn is a **JSON Block**.  Please see below for :ref:`2733_cgn` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/scaleout/distributed-forwarding/cgn <scaleout_distributed_forwarding_cgn>`

    **fw**

        **Description:** fw is a **JSON Block**.  Please see below for :ref:`2733_fw` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/scaleout/distributed-forwarding/fw <scaleout_distributed_forwarding_fw>`

    **slb**

        **Description:** slb is a **JSON Block**.  Please see below for :ref:`2733_slb` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/scaleout/distributed-forwarding/slb <scaleout_distributed_forwarding_slb>`

.. _2733_fw:

fw
^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **enable**

        **Description** Enable distributed-forwarding for Firewall

        **Type:** boolean

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

        **Default:** 0

    **session-offload-direction**

        **Description** 'uplink': Enable session offload only in uplink direction; 'downlink': Enable session offload in downlink direction; 'both': Enable session offload in both direction; 

        **Type:** string

        **Supported Values:** uplink, downlink, both

        **Default:** both

    **threshold**

        **Description:** threshold is a **JSON Block**.  Please see below for :ref:`2733_fw_threshold` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2733_fw_threshold:

fw_threshold
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **global-threshold**

        **Description** configure packet threshold value to offload sessions of any(TCP and UDP) protocol(default 5)

        **Type:** number

        **Range:** 4-63

        **Default:** 5

        **Mutual Exclusion:** global-threshold and protocol-value are mutually exclusive

    **protocol-threshold**

        **Type:** List

.. _2733_fw_threshold_protocol-threshold:

fw_threshold_protocol-threshold
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **protocol-value**

        **Description** 'UDP': configure threshold for udp session offload; 'TCP': configure threshold for tcp session offload; 

        **Type:** string

        **Supported Values:** UDP, TCP

        **Mutual Exclusion:** protocol-value and global-threshold are mutually exclusive

    **threshold-value**

        **Description** configure packet threshold value to offload sessions(default 5)

        **Type:** number

        **Range:** 4-63

        **Default:** 5

.. _2733_slb:

slb
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **slb-value**

        **Description** 'enable': Enable SLB; 'disable': Disable SLB; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **tcp-threshold**

        **Description** configure packet threshold value to offload TCP sessions(default 5)

        **Type:** number

        **Range:** 4-63

        **Default:** 5

    **udp-threshold**

        **Description** configure packet threshold value to offload UDP sessions(default 5)

        **Type:** number

        **Range:** 4-63

        **Default:** 5

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2733_cgn:

cgn
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **enable**

        **Description** Enable distributed-forwarding for CGN

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