.. _ddos_switch:

ddos switch
===========

switch counters


switch Specification
--------------------

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

	 **Element Name**                      switch

	 **Element URI**                       /axapi/v3/ddos/switch

	 **Element Attributes**                switch_attributes

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

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



.. raw:: html

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


:ref:`883_switch_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/switch



.. raw:: html

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


:ref:`883_switch_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/switch



.. raw:: html

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


:ref:`883_switch_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/switch



.. raw:: html

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


:ref:`883_switch_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/switch



.. raw:: html

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


:ref:`883_switch_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _883_switch_attributes:

switch attributes
-----------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _883_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'ip_rcvd': IPv4 Received; 'ip_sent': IPv4 Sent; 'ipv6_rcvd': IPv6 Received; 'ipv6_sent': IPv6 Sent; 'in_stateless_pkt': Stateless Packets Received; 'noroute': IPv4/v6 Out No Route; 'pkt_not_for_ddos': Not For DDOS; 'ingress_bytes': Inbound Bytes Received; 'egress_bytes': Outbound Bytes Received; 'ingress_packets': Inbound Packets Received; 'egress_packets': Outbound Packets Received; 'src_ip_bypass': Src IP Bypass; 'dst_ip_bypass': Dst IP Bypass; 'dst_blackhole_inject': Dst Blackhole Injected; 'dst_blackhole_withdraw': Dst Blackhole Withdrawn; 'mpls_rcvd': MPLS Received; 'mpls_drop': MPLS Dropped; 'mpls_malformed': MPLS Malformed; 'frag_rcvd': Fragment Received (deprecated); 'frag_drop': Fragment Drop (deprecated); 'jumbo_frag_drop_by_filter': Jumbo Fragment Filter Miss Drop; 'jumbo_frag_drop_before_slb': Jumbo Fragment Non Data Plane Drop; 'jumbo_outgoing_mtu_exceed_drop': Jumbo Outgoing MTU Exceed Drop; 

        **Type:** string

        **Supported Values:** all, ip_rcvd, ip_sent, ipv6_rcvd, ipv6_sent, in_stateless_pkt, noroute, pkt_not_for_ddos, ingress_bytes, egress_bytes, ingress_packets, egress_packets, src_ip_bypass, dst_ip_bypass, dst_blackhole_inject, dst_blackhole_withdraw, mpls_rcvd, mpls_drop, mpls_malformed, frag_rcvd, frag_drop, jumbo_frag_drop_by_filter, jumbo_frag_drop_before_slb, jumbo_outgoing_mtu_exceed_drop

.. _883_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - jumbo_frag_drop_before_slb
      - 8
      - Jumbo Fragment Non Data Plane Drop

   *  - 
      - mpls_malformed
      - 8
      - MPLS Malformed

   *  - 
      - pkt_not_for_ddos
      - 8
      - Not For DDOS

   *  - 
      - egress_bytes
      - 8
      - Outbound Bytes Received

   *  - 
      - in_stateless_pkt
      - 8
      - Stateless Packets Received

   *  - 
      - ipv6_sent
      - 8
      - IPv6 Sent

   *  - 
      - noroute
      - 8
      - IPv4/v6 Out No Route

   *  - 
      - src_ip_bypass
      - 8
      - Src IP Bypass

   *  - 
      - jumbo_outgoing_mtu_exceed_drop
      - 8
      - Jumbo Outgoing MTU Exceed Drop

   *  - 
      - ip_sent
      - 8
      - IPv4 Sent

   *  - 
      - ipv6_rcvd
      - 8
      - IPv6 Received

   *  - 
      - mpls_rcvd
      - 8
      - MPLS Received

   *  - 
      - ingress_bytes
      - 8
      - Inbound Bytes Received

   *  - 
      - ip_rcvd
      - 8
      - IPv4 Received

   *  - 
      - dst_blackhole_inject
      - 8
      - Dst Blackhole Injected

   *  - 
      - jumbo_frag_drop_by_filter
      - 8
      - Jumbo Fragment Filter Miss Drop

   *  - 
      - ingress_packets
      - 8
      - Inbound Packets Received

   *  - 
      - dst_ip_bypass
      - 8
      - Dst IP Bypass

   *  - 
      - mpls_drop
      - 8
      - MPLS Dropped

   *  - 
      - dst_blackhole_withdraw
      - 8
      - Dst Blackhole Withdrawn

   *  - 
      - egress_packets
      - 8
      - Outbound Packets Received