.. _fw_tcp:

fw tcp
======

Firewall TCP parameters


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

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

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

	 **Element Name**                      tcp

	 **Element URI**                       /axapi/v3/fw/tcp

	 **Element Attributes**                tcp_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`tcp schema <fw-tcp/fw-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'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/fw/tcp



.. raw:: html

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


tcp_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _1685_tcp_attributes:

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

    **mss-clamp**

        **Description:** mss-clamp is a **JSON Block**.  Please see below for :ref:`1685_mss-clamp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/fw/tcp/mss-clamp <fw_tcp_mss_clamp>`

    **reset-on-error**

        **Description:** reset-on-error is a **JSON Block**.  Please see below for :ref:`1685_reset-on-error` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/fw/tcp/reset-on-error <fw_tcp_reset_on_error>`

    **syn-cookie**

        **Description:** syn-cookie is a **JSON Block**.  Please see below for :ref:`1685_syn-cookie` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/fw/tcp/syn-cookie <fw_tcp_syn_cookie>`

.. _1685_mss-clamp:

mss-clamp
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **min**

        **Description** Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: ((576 - 60 - 60))))

        **Type:** number

        **Range:** 0-1460

        **Default:** 456

    **mss-clamp-type**

        **Description** 'fixed': Specify a fixed max value for the TCP MSS; 'subtract': Specify the value to subtract from the TCP MSS; 

        **Type:** string

        **Supported Values:** fixed, subtract

    **mss-subtract**

        **Description** Specify the value to subtract from the TCP MSS (default: not configured)

        **Type:** number

        **Range:** 0-1460

    **mss-value**

        **Description** The max value allowed for the TCP MSS (default: not configured)}

        **Type:** number

        **Range:** 0-1460

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1685_reset-on-error:

reset-on-error
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **enable**

        **Description** Enable send TCP reset on error

        **Type:** boolean

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

        **Default:** 0

    **outbound**

        **Description** 'enable': Enable send TCP reset on error; 

        **Type:** string

        **Supported Values:** enable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1685_syn-cookie:

syn-cookie
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **sampling-enable**

        **Type:** List

    **syn-cookie-enable**

        **Description** Enable Firewall Syn-Cookie Protection

        **Type:** boolean

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

        **Default:** 0

    **syn-cookie-on-threshold**

        **Description** on-threshold for Syn-cookie (Decimal number)

        **Type:** number

        **Range:** 1-1000000

    **syn-cookie-on-timeout**

        **Description** on-timeout for Syn-cookie (Timeout in seconds, default is 120 seconds (2 minutes))

        **Type:** number

        **Range:** 1-300000

        **Default:** 120

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1685_syn-cookie_sampling-enable:

syn-cookie_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'syn_ack_sent': SYN cookie SYN ACK sent; 'verification_passed': SYN cookie verification passed; 'verification_failed': SYN cookie verification failed; 'conn_setup_failed': SYN cookie connection setup failed; 

        **Type:** string

        **Supported Values:** all, syn_ack_sent, verification_passed, verification_failed, conn_setup_failed