.. _ddos_session:

ddos session
============

session counters


session Specification
---------------------

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

	 **Element Name**                      session

	 **Element URI**                       /axapi/v3/ddos/session

	 **Element Attributes**                session_attributes

	 **Statistics Data URI**               /axapi/v3/ddos/session/stats

	 **Schema**                             :download:`session schema <ddos-session/ddos-session.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/ddos/session



.. raw:: html

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


:ref:`704_session_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/ddos/session



.. raw:: html

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


:ref:`704_session_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/ddos/session



.. raw:: html

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


:ref:`704_session_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/ddos/session



.. raw:: html

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


:ref:`704_session_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/ddos/session



.. raw:: html

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


:ref:`704_session_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _704_session_attributes:

session attributes
------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _704_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'sess_create_ip': IPv4 Session Created; 'sess_create_ip6': IPv6 Session Created; 'sess_create_tcp': TCP Sessions Created; 'conn_tcp_est_w_syn': TCP Conn Established With SYN; 'conn_tcp_est_w_ack': TCP Conn Established With ACK; 'conn_tcp_est': TCP Conn Established; 'conn_tcp_close_w_rst': TCP Conn Closed With RST; 'conn_tcp_close_w_fin': TCP Conn Closed With FIN; 'conn_tcp_close_w_idle': TCP Conn Closed With Idle; 'conn_tcp_close_w_half_open': TCP Conn Closed With Half Open; 'conn_tcp_close': TCP Conn Closed; 'sess_create_udp': UDP Sessions Created; 'conn_udp_est': UDP Conn Established; 'conn_udp_close': UDP Conn Closed; 'sess_aged_out': Session Aged Out; 'conn_entry_mismatch': Conn Entry Mismatch Dropped; 'conn_tcp_create_from_syn': TCP Conn Created From SYN; 'conn_tcp_create_from_ack': TCP Conn Created From ACK; 'sess_oom': Out of Session Memory; 'sess_create_udp_auth': UDP Helper Auth Sessions Created; 'sess_aged_udp_auth': UDP Helper Auth Sessions Aged Out; 'sess_snat_failed': Session Source NAT Failure; 

        **Type:** string

        **Supported Values:** all, sess_create_ip, sess_create_ip6, sess_create_tcp, conn_tcp_est_w_syn, conn_tcp_est_w_ack, conn_tcp_est, conn_tcp_close_w_rst, conn_tcp_close_w_fin, conn_tcp_close_w_idle, conn_tcp_close_w_half_open, conn_tcp_close, sess_create_udp, conn_udp_est, conn_udp_close, sess_aged_out, conn_entry_mismatch, conn_tcp_create_from_syn, conn_tcp_create_from_ack, sess_oom, sess_create_udp_auth, sess_aged_udp_auth, sess_snat_failed

.. _704_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - conn_tcp_est
      - 8
      - TCP Conn Established

   *  - 
      - conn_tcp_close
      - 8
      - TCP Conn Closed

   *  - 
      - sess_aged_out
      - 8
      - Session Aged Out

   *  - 
      - conn_entry_mismatch
      - 8
      - Conn Entry Mismatch Dropped

   *  - 
      - conn_tcp_close_w_rst
      - 8
      - TCP Conn Closed With RST

   *  - 
      - conn_tcp_create_from_ack
      - 8
      - TCP Conn Created From ACK

   *  - 
      - conn_udp_close
      - 8
      - UDP Conn Closed

   *  - 
      - conn_tcp_close_w_half_open
      - 8
      - TCP Conn Closed With Half Open

   *  - 
      - sess_create_tcp
      - 8
      - TCP Sessions Created

   *  - 
      - sess_snat_failed
      - 8
      - Session Source NAT Failure

   *  - 
      - sess_create_ip
      - 8
      - IPv4 Session Created

   *  - 
      - conn_tcp_est_w_syn
      - 8
      - TCP Conn Established With SYN

   *  - 
      - conn_tcp_close_w_idle
      - 8
      - TCP Conn Closed With Idle

   *  - 
      - conn_udp_est
      - 8
      - UDP Conn Established

   *  - 
      - sess_aged_udp_auth
      - 8
      - UDP Helper Auth Sessions Aged Out

   *  - 
      - sess_create_ip6
      - 8
      - IPv6 Session Created

   *  - 
      - conn_tcp_create_from_syn
      - 8
      - TCP Conn Created From SYN

   *  - 
      - sess_oom
      - 8
      - Out of Session Memory

   *  - 
      - conn_tcp_est_w_ack
      - 8
      - TCP Conn Established With ACK

   *  - 
      - sess_create_udp_auth
      - 8
      - UDP Helper Auth Sessions Created

   *  - 
      - conn_tcp_close_w_fin
      - 8
      - TCP Conn Closed With FIN

   *  - 
      - sess_create_udp
      - 8
      - UDP Sessions Created