.. _fw_session_aging_tcp:

fw session-aging tcp
====================

TCP Aging options


tcp Specification
-----------------

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

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

	 **Element Name**                      tcp

	 **Element URI**                       /axapi/v3/fw/session-aging/{name}/tcp

	 **Element Attributes**                tcp_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`tcp schema <fw-session-aging-tcp/fw-session-aging-tcp.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/fw/session-aging/{name}/tcp



.. raw:: html

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


:ref:`1670_tcp_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/fw_session_aging_tcp_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/fw/session-aging/{name}/tcp



.. raw:: html

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


:ref:`1670_tcp_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/fw_session_aging_tcp_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/fw/session-aging/{name}/tcp



.. raw:: html

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


:ref:`1670_tcp_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/fw/session-aging/{name}/tcp



.. raw:: html

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


:ref:`1670_tcp_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/fw_session_aging_tcp_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/fw/session-aging/{name}/tcp



.. raw:: html

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


:ref:`1670_tcp_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/fw_session_aging_tcp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1670_tcp_attributes:

tcp attributes
--------------

    **force-delete-timeout**

        **Description** The maximum time that a session can stay in the system before being deleted, default is off (number (second))

        **Type:** number

        **Range:** 1-31

        **Mutual Exclusion:** force-delete-timeout and force-delete-timeout-100ms are mutually exclusive

    **force-delete-timeout-100ms**

        **Description** The maximum time that a session can stay in the system before being deleted, default is off (number in 100ms)

        **Type:** number

        **Range:** 1-31

        **Mutual Exclusion:** force-delete-timeout-100ms and force-delete-timeout are mutually exclusive

    **half-close-idle-timeout**

        **Description** TCP Half Close Idle Timeout (sec), default is off (number)

        **Type:** number

        **Range:** 60-120

    **half-open-idle-timeout**

        **Description** TCP Half Open Idle Timeout (sec), default is off (number)

        **Type:** number

        **Range:** 1-60

    **port-cfg**

        **Type:** List

    **tcp-idle-timeout**

        **Description** Idle Timeout (sec), default is 600 (number)

        **Type:** number

        **Range:** 1-2097151

        **Default:** 600

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1670_port-cfg:

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

	 **Block object keys**             

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

    **force-delete-timeout**

        **Description** The maximum time that a session can stay in the system before being deleted, default is off (number (second))

        **Type:** number

        **Range:** 1-31

        **Mutual Exclusion:** force-delete-timeout and force-delete-timeout-100ms are mutually exclusive

    **force-delete-timeout-100ms**

        **Description** The maximum time that a session can stay in the system before being deleted, default is off (number in 100ms)

        **Type:** number

        **Range:** 1-31

        **Mutual Exclusion:** force-delete-timeout-100ms and force-delete-timeout are mutually exclusive

    **half-close-idle-timeout**

        **Description** TCP Half Close Idle Timeout (sec), default is off (number)

        **Type:** number

        **Range:** 60-120

    **half-open-idle-timeout**

        **Description** TCP Half Open Idle Timeout (sec), default is off (number)

        **Type:** number

        **Range:** 1-60

    **tcp-idle-timeout**

        **Description** Idle Timeout (sec), default is 600 (number)

        **Type:** number

        **Range:** 1-2097151

    **tcp-port**

        **Description** 

        **Type:** number

        **Range:** 1-65535