.. _sys_ut_template_tcp:

sys-ut template tcp
===================

TCP header


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

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

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

	 **Element Name**                      tcp

	 **Element URI**                       /axapi/v3/sys-ut/template/{name}/tcp

	 **Element Attributes**                tcp_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`tcp schema <sys-ut-template-tcp/sys-ut-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/sys-ut/template/{name}/tcp



.. raw:: html

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


:ref:`3172_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/sys_ut_template_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/sys-ut/template/{name}/tcp



.. raw:: html

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


:ref:`3172_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/sys_ut_template_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/sys-ut/template/{name}/tcp



.. raw:: html

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


:ref:`3172_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/sys-ut/template/{name}/tcp



.. raw:: html

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


:ref:`3172_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/sys_ut_template_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/sys-ut/template/{name}/tcp



.. raw:: html

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


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




.. raw:: html

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


.. raw:: html

   </table>

.. _3172_tcp_attributes:

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

    **ack-seq-number**

        **Description** 'valid': valid; 'invalid': invalid; 

        **Type:** string

        **Supported Values:** valid, invalid

        **Default:** valid

    **checksum**

        **Description** 'valid': valid; 'invalid': invalid; 

        **Type:** string

        **Supported Values:** valid, invalid

        **Default:** valid

    **dest-port**

        **Description** Dest port

        **Type:** boolean

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

        **Default:** 0

    **dest-port-value**

        **Description** Dest port value

        **Type:** number

        **Range:** 1-65535

    **flags**

        **Description:** flags is a **JSON Block**.  Please see below for :ref:`3172_flags` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sys-ut/template/{name}/tcp/flags <sys_ut_template>`

    **nat-pool**

        **Description** Nat pool port

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **options**

        **Description:** options is a **JSON Block**.  Please see below for :ref:`3172_options` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sys-ut/template/{name}/tcp/options <sys_ut_template>`

    **seq-number**

        **Description** 'valid': valid; 'invalid': invalid; 

        **Type:** string

        **Supported Values:** valid, invalid

        **Default:** valid

    **src-port-range**

        **Type:** List

    **urgent**

        **Description** 'valid': valid; 'invalid': invalid; 

        **Type:** string

        **Supported Values:** valid, invalid

        **Default:** valid

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **window**

        **Description** 'valid': valid; 'invalid': invalid; 

        **Type:** string

        **Supported Values:** valid, invalid

        **Default:** valid

.. _3172_src-port-range:

src-port-range
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **src-port-end**

        **Description** Src port end value

        **Type:** number

    **src-port-start**

        **Description** Source port value

        **Type:** number

.. _3172_flags:

flags
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ack**

        **Description** Ack

        **Type:** boolean

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

        **Default:** 0

    **cwr**

        **Description** Cwr

        **Type:** boolean

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

        **Default:** 0

    **ece**

        **Description** Ece

        **Type:** boolean

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

        **Default:** 0

    **fin**

        **Description** Fin

        **Type:** boolean

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

        **Default:** 0

    **psh**

        **Description** Psh

        **Type:** boolean

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

        **Default:** 0

    **rst**

        **Description** Rst

        **Type:** boolean

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

        **Default:** 0

    **syn**

        **Description** Syn

        **Type:** boolean

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

        **Default:** 0

    **urg**

        **Description** Urg

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

.. _3172_options:

options
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **mss**

        **Description** TCP MSS

        **Type:** number

        **Range:** 536-1460

    **nop**

        **Description** No Op

        **Type:** boolean

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

        **Default:** 0

    **sack-type**

        **Description** 'permitted': permitted; 'block': block; 

        **Type:** string

        **Supported Values:** permitted, block

    **time-stamp-enable**

        **Description** adds Time Stamp to options

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

    **wscale**

        **Description** 

        **Type:** number

        **Range:** 1-8