.. _scaleout_distributed_forwarding_fw:

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

Enable Scaleout distributed-forwarding for fw


fw Specification
----------------

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

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

	 **Element Name**                      fw

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

	 **Element Attributes**                fw_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2731_fw_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_distributed_forwarding_fw_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/distributed-forwarding/fw



.. raw:: html

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


:ref:`2731_fw_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_distributed_forwarding_fw_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/distributed-forwarding/fw



.. raw:: html

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


:ref:`2731_fw_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/distributed-forwarding/fw



.. raw:: html

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


:ref:`2731_fw_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_distributed_forwarding_fw_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/distributed-forwarding/fw



.. raw:: html

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


:ref:`2731_fw_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_distributed_forwarding_fw_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2731_fw_attributes:

fw attributes
-------------

    **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:`2731_threshold` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2731_threshold:

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

.. _2731_threshold_protocol-threshold:

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