.. _slb_template_tcp:

slb template tcp
================

L4 TCP switch config


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

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

	===================================== ================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`3051_tcp_list`

	 **Collection URI**                    /axapi/v3/slb/template/tcp

	                                       

	 **Element Name**                      tcp

	 **Element URI**                       /axapi/v3/slb/template/tcp/{name}

	 **Element Attributes**                tcp_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3051_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/slb_template_tcp_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/slb/template/tcp



.. raw:: html

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


:ref:`3051_tcp_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/slb/template/tcp/{name}



.. raw:: html

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


:ref:`3051_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/slb_template_tcp_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/slb/template/tcp



.. raw:: html

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


:ref:`3051_tcp_list`



.. 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/slb/template/tcp/{name}



.. raw:: html

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


:ref:`3051_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/slb/template/tcp/{name}



.. raw:: html

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


:ref:`3051_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/slb_template_tcp_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/slb/template/tcp



.. raw:: html

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


:ref:`3051_tcp_list`



.. 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/slb/template/tcp/{name}



.. raw:: html

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


:ref:`3051_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/slb_template_tcp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3051_tcp_list:

tcp-list
--------


    tcp-list is **JSON List** of :ref:`3051_tcp_attributes` 

        tcp-list : [

             { :ref:`3051_tcp_attributes` },

             { :ref:`3051_tcp_attributes` },

             ...

         ]

.. _3051_tcp_attributes:

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

    **alive-if-active**

        **Description** keep connection alive if active traffic

        **Type:** boolean

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

        **Default:** 0

    **del-session-on-server-down**

        **Description** Delete session if the server/port goes down (either disabled/hm down)

        **Type:** boolean

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

        **Default:** 0

    **disable**

        **Description** send reset to client when server is disabled

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** disable and down are mutually exclusive

    **down**

        **Description** send reset to client when server is down

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** down and disable are mutually exclusive

    **force-delete-timeout**

        **Description** The maximum time that a session can stay in the system before being delete (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 delete (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 off (half close idle timeout in second, default off)

        **Type:** number

        **Range:** 60-120

    **half-open-idle-timeout**

        **Description** TCP Half Open Idle Timeout (sec), default off (half open idle timeout in second, default off)

        **Type:** number

        **Range:** 1-60

    **idle-timeout**

        **Description** Idle Timeout value (Interval of 60 seconds), default 120 seconds (idle timeout in second, default 120)

        **Type:** number

        **Range:** 1-2097151

        **Default:** 120

    **initial-window-size**

        **Description** Set the initial window size (number)

        **Type:** number

        **Range:** 1-65535

    **insert-client-ip**

        **Description** Insert client ip into TCP option

        **Type:** boolean

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

        **Default:** 0

    **lan-fast-ack**

        **Description** Enable fast TCP ack on LAN

        **Type:** boolean

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

        **Default:** 0

    **logging**

        **Description** 'init': init only log; 'term': termination only log; 'both': both initial and termination log; 

        **Type:** string

        **Supported Values:** init, term, both

    **name**

        **Description** Fast TCP Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Default:** default

    **proxy-header**

        **Description:** proxy-header is a **JSON Block**.  Please see below for :ref:`3051_proxy-header` 

        **Type:** Object

    **qos**

        **Description** QOS level (number)

        **Type:** number

        **Range:** 1-63

    **re-select-if-server-down**

        **Description** re-select another server if service port is down

        **Type:** boolean

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

        **Default:** 0

    **reset-follow-fin**

        **Description** send reset to client or server upon receiving first fin

        **Type:** boolean

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

        **Default:** 0

    **reset-fwd**

        **Description** send reset to server if error happens

        **Type:** boolean

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

        **Default:** 0

    **reset-rev**

        **Description** send reset to client if error happens

        **Type:** boolean

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

        **Default:** 0

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3051_proxy-header:

proxy-header
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **proxy-header-action**

        **Description** 'insert': Insert proxy header; 

        **Type:** string

        **Supported Values:** insert

    **proxy-header-version**

        **Description** 'v1': version 1; 'v2': version 2; 

        **Type:** string

        **Supported Values:** v1, v2