.. _ddos_port:

ddos port
=========

global ddos port counters


port Specification
------------------

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

	 **Element Name**                      port

	 **Element URI**                       /axapi/v3/ddos/port

	 **Element Attributes**                port_attributes

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

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



.. raw:: html

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


:ref:`1282_port_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/port



.. raw:: html

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


:ref:`1282_port_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/port



.. raw:: html

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


:ref:`1282_port_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/port



.. raw:: html

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


:ref:`1282_port_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/port



.. raw:: html

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


:ref:`1282_port_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1282_port_attributes:

port attributes
---------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1282_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'dst_port_undef_drop': Dst Port Undefined Dropped; 'dst_port_bl': Dst Port Blacklist Packets Dropped; 'dst_port_exceed_drop_any': Dst Port Exceed Dropped; 'dst_port_pkt_rate_exceed': Dst Port Pkt Rate Exceeded; 'dst_port_kbit_rate_exceed': Dst Port KiBit Rate Exceeded (KiBit); 'dst_port_frag_rate_exceed': Dst Port Frag Pkt Rate Exceeded; 'dst_port_conn_limit_exceed': Dst Port Conn Limit Exceeded; 'dst_port_conn_rate_exceed': Dst Port Conn Rate Exceeded; 'dst_sport_bl': Dst SrcPort Blacklist Packets Dropped; 'dst_sport_exceed_drop_any': Dst SrcPort Exceed Dropped; 'dst_sport_pkt_rate_exceed': Dst SrcPort Pkt Rate Exceeded; 'dst_sport_kbit_rate_exceed': Dst SrcPort KiBit Rate Exceeded (KiBit); 'dst_sport_frag_rate_exceed': Dst SrcPort Frag Pkt Rate Exceeded; 'dst_sport_conn_limit_exceed': Dst SrcPort Conn Limit Exceeded; 'dst_sport_conn_rate_exceed': Dst SrcPort Conn Rate Exceeded; 

        **Type:** string

        **Supported Values:** all, dst_port_undef_drop, dst_port_bl, dst_port_exceed_drop_any, dst_port_pkt_rate_exceed, dst_port_kbit_rate_exceed, dst_port_frag_rate_exceed, dst_port_conn_limit_exceed, dst_port_conn_rate_exceed, dst_sport_bl, dst_sport_exceed_drop_any, dst_sport_pkt_rate_exceed, dst_sport_kbit_rate_exceed, dst_sport_frag_rate_exceed, dst_sport_conn_limit_exceed, dst_sport_conn_rate_exceed

.. _1282_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - dst_port_bl
      - 8
      - Dst Port Blacklist Packets Dropped

   *  - 
      - dst_sport_conn_rate_exceed
      - 8
      - Dst SrcPort Conn Rate Exceeded

   *  - 
      - dst_sport_frag_rate_exceed
      - 8
      - Dst SrcPort Frag Pkt Rate Exceeded

   *  - 
      - dst_port_exceed_drop_any
      - 8
      - Dst Port Exceed Dropped

   *  - 
      - dst_port_kbit_rate_exceed
      - 8
      - Dst Port KiBit Rate Exceeded (KiBit)

   *  - 
      - dst_sport_exceed_drop_any
      - 8
      - Dst SrcPort Exceed Dropped

   *  - 
      - dst_port_conn_rate_exceed
      - 8
      - Dst Port Conn Rate Exceeded

   *  - 
      - dst_port_undef_drop
      - 8
      - Dst Port Undefined Dropped

   *  - 
      - dst_sport_bl
      - 8
      - Dst SrcPort Blacklist Packets Dropped

   *  - 
      - dst_sport_conn_limit_exceed
      - 8
      - Dst SrcPort Conn Limit Exceeded

   *  - 
      - dst_port_pkt_rate_exceed
      - 8
      - Dst Port Pkt Rate Exceeded

   *  - 
      - dst_port_frag_rate_exceed
      - 8
      - Dst Port Frag Pkt Rate Exceeded

   *  - 
      - dst_sport_pkt_rate_exceed
      - 8
      - Dst SrcPort Pkt Rate Exceeded

   *  - 
      - dst_sport_kbit_rate_exceed
      - 8
      - Dst SrcPort KiBit Rate Exceeded (KiBit)

   *  - 
      - dst_port_conn_limit_exceed
      - 8
      - Dst Port Conn Limit Exceeded