.. _system_tcp:

system tcp
==========

tcp counters and global config


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

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

	 **Element Name**                      tcp

	 **Element URI**                       /axapi/v3/system/tcp

	 **Element Attributes**                tcp_attributes

	 **Statistics Data URI**               /axapi/v3/system/tcp/stats

	 **Operational Data URI**              /axapi/v3/system/tcp/oper

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



.. raw:: html

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


:ref:`2143_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/system/tcp



.. raw:: html

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


:ref:`2143_tcp_attributes`



.. 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/system/tcp



.. raw:: html

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


:ref:`2143_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/system/tcp



.. raw:: html

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


:ref:`2143_tcp_attributes`



.. 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/system/tcp



.. raw:: html

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


:ref:`2143_tcp_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2143_tcp_attributes:

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

    **rate-limit-reset-unknown-conn**

        **Description:** rate-limit-reset-unknown-conn is a **JSON Block**.  Please see below for :ref:`2143_rate-limit-reset-unknown-conn` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/tcp/rate-limit-reset-unknown-conn <system_tcp_rate_limit_reset_unknown_conn>`

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2143_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'activeopens': Active open conns; 'passiveopens': Passive open conns; 'attemptfails': Connect attemp failures; 'estabresets': Resets rcvd on EST conn; 'insegs': Total in TCP packets; 'outsegs': Total out TCP packets; 'retranssegs': Retransmited packets; 'inerrs': Input errors; 'outrsts': Reset Sent; 'sock_alloc': Sockets allocated; 'orphan_count': Orphan sockets; 'mem_alloc': Memory alloc; 'recv_mem': Total rx buffer; 'send_mem': Total tx buffer; 'currestab': Currently EST conns; 'currsyssnt': TCP in SYN-SNT state; 'currsynrcv': TCP in SYN-RCV state; 'currfinw1': TCP in FIN-W1 state; 'currfinw2': TCP FIN-W2 state; 'currtimew': TCP TimeW state; 'currclose': TCP in Close state; 'currclsw': TCP in CloseW state; 'currlack': TCP in LastACK state; 'currlstn': TCP in Listen state; 'currclsg': TCP in Closing state; 'pawsactiverejected': TCP paw active rej; 'syn_rcv_rstack': Rcv RST|ACK on SYN; 'syn_rcv_rst': Rcv RST on SYN; 'syn_rcv_ack': Rcv ACK on SYN; 'ax_rexmit_syn': TCP rexmit SYN; 'tcpabortontimeout': TCP abort on timeout; 'noroute': TCPIP out noroute; 'exceedmss': MSS exceeded pkt dropped; 'tfo_conns': TFO Total Connections; 'tfo_actives': TFO Current Actives; 'tfo_denied': TFO Denied; 

        **Type:** string

        **Supported Values:** all, activeopens, passiveopens, attemptfails, estabresets, insegs, outsegs, retranssegs, inerrs, outrsts, sock_alloc, orphan_count, mem_alloc, recv_mem, send_mem, currestab, currsyssnt, currsynrcv, currfinw1, currfinw2, currtimew, currclose, currclsw, currlack, currlstn, currclsg, pawsactiverejected, syn_rcv_rstack, syn_rcv_rst, syn_rcv_ack, ax_rexmit_syn, tcpabortontimeout, noroute, exceedmss, tfo_conns, tfo_actives, tfo_denied

.. _2143_rate-limit-reset-unknown-conn:

rate-limit-reset-unknown-conn
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **log-for-reset-unknown-conn**

        **Description** Log when rate exceed

        **Type:** boolean

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

        **Default:** 0

    **pkt-rate-for-reset-unknown-conn**

        **Description** 

        **Type:** number

        **Range:** 1-1048575

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2143_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - atcprexmit
      - 8
      - Adaptive TCP retransmits

   *  - 
      - sndrexmitpack
      - 8
      - Data packet retransmit

   *  - 
      - sndwinup
      - 8
      - Window update packet sent

   *  - 
      - a2bfsmtransition
      - 8
      - ATCP to BTCP state machine transition

   *  - 
      - sndpack
      - 8
      - Data packet sent

   *  - 
      - atcpsendbackack
      - 8
      - Adaptive TCP sendback ACK

   *  - 
      - atcpsendfail
      - 8
      - Adaptive TCP sent fails

   *  - 
      - a2bpartialack
      - 8
      - ATCP to BTCP partial ack received

   *  - 
      - preddat
      - 8
      - Hdr predict for data pkts

   *  - 
      - cc_reduce
      - 8
      - Congestion control window reduced by event

   *  - 
      - sack_rexmit_bytes
      - 8
      - SACK rexmit bytes

   *  - 
      - keepdrops
      - 8
      - Connect dropped in keepalive

   *  - 
      - rcvdupack
      - 8
      - Rcvd duplicate acks

   *  - 
      - atcpsent
      - 8
      - Adaptive TCP sent

   *  - 
      - keepprobe
      - 8
      - Keepalive probe sent

   *  - 
      - rcvtotal
      - 8
      - Total packet received

   *  - 
      - cc_idle
      - 8
      - Congestion control window set do to idle

   *  - 
      - sndbyte
      - 8
      - Data bytes sent

   *  - 
      - rcvpartdupbyte
      - 8
      - Dup. bytes in part-dup. packets

   *  - 
      - a2bsackpresent
      - 8
      - ATCP to BTCP SACK options present

   *  - 
      - sndacks
      - 8
      - Ack packet sent

   *  - 
      - sack_rexmits
      - 8
      - SACK rexmit segments

   *  - 
      - mburstlim
      - 8
      - Maxburst limited tx

   *  - 
      - atcpbuffallocfail
      - 8
      - Adaptive TCP buffer allocation fails

   *  - 
      - earlyrexmit
      - 8
      - Early Retransmission sent

   *  - 
      - rcvdupbyte
      - 8
      - Duplicate bytes received

   *  - 
      - a2brcvwnd
      - 8
      - ATCP to BTCP receive window

   *  - 
      - rcvwinupd
      - 8
      - Rcvd window update packets

   *  - 
      - a2bappbuffering
      - 8
      - Transition to full stack on when application buffers too much data

   *  - 
      - rcvackbyte
      - 8
      - Bytes acked by rcvd acks

   *  - 
      - a2btransitionnum
      - 8
      - ATCP to BTCP total transitions

   *  - 
      - bad_iochan
      - 8
      - IO Channel Modified

   *  - 
      - rcvdsack
      - 8
      - Rcvd DSACK packets

   *  - 
      - delack
      - 8
      - Delayed acks sent

   *  - 
      - a2boodata
      - 8
      - ATCP to BTCP oo data received

   *  - 
      - closed
      - 8
      - Connect closed

   *  - 
      - badrst
      - 8
      - Ignored RST

   *  - 
      - rcvoopack
      - 8
      - Out-of-order packet received

   *  - 
      - finwait2_drops
      - 8
      - Drop FIN_WAIT_2 connection after time limit

   *  - 
      - rcvacktoomuch
      - 8
      - Rcvd acks for unsent data

   *  - 
      - rcvpartduppack
      - 8
      - Packet with some duplicate data

   *  - 
      - rcvbyteafterwin
      - 8
      - Bytes rcvd after window

   *  - 
      - segstimed
      - 8
      - Segs to get RTT

   *  - 
      - a2bsndwnd
      - 8
      - ATCP to BTCP send window

   *  - 
      - persisttimeo
      - 8
      - Persist timeout

   *  - 
      - keeptimeo
      - 8
      - Keepalive timeout

   *  - 
      - sndrexmitbad
      - 8
      - Unnecessary packet retransmit

   *  - 
      - proxyheaderv1
      - 8
      - Proxy header v1

   *  - 
      - sack_recovery_episode
      - 8
      - SACK recovery episodes

   *  - 
      - rcvoobyte
      - 8
      - Out-of-order bytes received

   *  - 
      - pawsdrop
      - 8
      - Segments dropped due to PAWS

   *  - 
      - sndprobe
      - 8
      - Window probe sent

   *  - 
      - rcvduppack
      - 8
      - Duplicate packet received

   *  - 
      - rcvackpack
      - 8
      - Rcvd ack packets

   *  - 
      - rexmttimeo
      - 8
      - Retransmit timeout

   *  - 
      - predack
      - 8
      - Hdr predict for acks

   *  - 
      - conndrops
      - 8
      - Embryonic connect dropped

   *  - 
      - sndurg
      - 8
      - URG packet sent

   *  - 
      - rcvpack
      - 8
      - Packet received

   *  - 
      - sndsyn
      - 8
      - SYN packet sent

   *  - 
      - rcvbadoff
      - 8
      - Packet received with bad offset

   *  - 
      - atcprexmitsadrop
      - 8
      - Adaptive TCP transmit SA drops

   *  - 
      - sndtotal
      - 8
      - Total packet sent

   *  - 
      - sndfin
      - 8
      - FIN packet sent

   *  - 
      - drops
      - 8
      - Connect dropped

   *  - 
      - connattempt
      - 8
      - Connect initiated

   *  - 
      - timeoutdrop
      - 8
      - Conn dropped in rxmt timeout

   *  - 
      - sack_send_blocks
      - 8
      - SACK sent

   *  - 
      - persistdrop
      - 8
      - Timeout in persist state

   *  - 
      - b2atransitionnum
      - 8
      - ATCP to BTCP total transitions

   *  - 
      - rcvbyte
      - 8
      - Bytes received

   *  - 
      - rcvmemdrop
      - 8
      - Packet dropped for lack of memory

   *  - 
      - sndrexmitbyte
      - 8
      - Data byte retransmit

   *  - 
      - atcpforward
      - 8
      - Adaptive TCP forward

   *  - 
      - rcvwinprobe
      - 8
      - Rcvd window probe packet

   *  - 
      - sndctrl
      - 8
      - SYN|FIN|RST packet sent

   *  - 
      - a2bdupack
      - 8
      - ATCP to BTCP Dup/OO ACK

   *  - 
      - cacklim
      - 8
      - Challenge ACK limited

   *  - 
      - sndcack
      - 8
      - Challenge ACK sent

   *  - 
      - a2brxdata
      - 8
      - ATCP to BTCP Rxmitted data

   *  - 
      - connects
      - 8
      - Connect established

   *  - 
      - rttupdated
      - 8
      - Update RTT

   *  - 
      - a2btcpoptions
      - 8
      - ATCP to BTCP unsupported TCP options

   *  - 
      - proxyheaderv2
      - 8
      - Proxy header v2

   *  - 
      - reasstimeout
      - 8
      - Reassembly Time Out

   *  - 
      - rcvpackafterwin
      - 8
      - Packets with data after window

   *  - 
      - sndrst
      - 8
      - RST packet sent

   *  - 
      - reassmemdrop
      - 8
      - Packet dropped during reassembly

   *  - 
      - sack_rcv_blocks
      - 8
      - SACK received

.. _2143_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - tcp-cpu-list
      - 
      - tcp-cpu-list

   *  - 
      - cpu-count
      - number
      - cpu-count