.. _ddos_brief: ddos brief ========== ddos brief counters brief Specification ------------------- ===================================== =================================================== ===================================== =================================================== **Type** *Configuration Resource* **Element Name** brief **Element URI** /axapi/v3/ddos/brief **Element Attributes** brief_attributes **Statistics Data URI** /axapi/v3/ddos/brief/stats **Schema** :download:`brief schema ` ===================================== =================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/ddos/brief .. raw:: html :ref:`494_brief_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/ddos/brief .. raw:: html :ref:`494_brief_attributes` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/ddos/brief .. raw:: html :ref:`494_brief_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/ddos/brief .. raw:: html :ref:`494_brief_attributes` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/ddos/brief .. raw:: html :ref:`494_brief_attributes` .. raw:: html
.. _494_brief_attributes: brief attributes ---------------- **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _494_sampling-enable: sampling-enable ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'ip_rcv': IPv4 Received; 'ip_sent': IPv4 Sent; 'ipv6_rcv': IPv6 Received; 'ipv6_sent': IPv6 Sent; 'out_no_route': IPv4/v6 Out No Route; 'not_for_ddos': Not For DDOS; 'instateless': Stateless Packets Received; 'intcp': TCP Total Packets Received; 'inudp': UDP Total Packets Received; 'inicmp': ICMP Total Packets Received; 'inother': OTHER Total Packets Received; 'v4_sess_create': IPv4 Session Created; 'v6_sess_create': IPv6 Session Created; 'tcp_sess_create': TCP Sessions Created; 'udp_sess_create': UDP Sessions Created; 'sess_aged_out': Session Aged Out; 'tcp_total_drop': TCP Total Packets Dropped; 'tcp_dst_drop': TCP Dst Packets Dropped; 'tcp_src_drop': TCP Src Packets Dropped; 'tcp_src_dst_drop': TCP SrcDst Packets Dropped; 'tcp_drop_black_dst': TCP Dst Blacklist Drop (deprecated); 'tcp_drop_black_src': TCP Src Blacklist Drop (deprecated); 'tcp_drop_black_src_dst': TCP SrcDst Blacklist Drop (deprecated); 'tcp_exceed_drop_any_dst': TCP Dst Exceed Drop (deprecated); 'tcp_exceed_drop_any_src': TCP Src Exceed Drop (deprecated); 'tcp_exceed_drop_any_src_dst': TCP SrcDst Exceed Drop (deprecated); 'udp_total_drop': UDP Total Packets Dropped; 'udp_dst_drop': UDP Dst Packets Dropped; 'udp_src_drop': UDP Src Packets Dropped; 'udp_src_dst_drop': UDP SrcDst Packets Dropped; 'udp_drop_black_dst': UDP Dst Blacklist Drop (deprecated); 'udp_drop_black_src': UDP Src Blacklist Drop (deprecated); 'udp_drop_black_src_dst': UDP SrcDst Blacklist Drop (deprecated); 'udp_exceed_drop_any_dst': UDP Dst Exceed Drop (deprecated); 'udp_exceed_drop_any_src': UDP Src Exceed Drop (deprecated); 'udp_exceed_drop_any_src_dst': UDP SrcDst Exceed Drop (deprecated); 'icmp_total_drop': ICMP Total Packets Dropped; 'icmp_dst_drop': ICMP Dst Packets Dropped; 'icmp_src_drop': ICMP Src Packets Dropped; 'icmp_src_dst_drop': ICMP SrcDst Packets Dropped; 'icmp_drop_black_dst': ICMP Dst Blacklist Drop (deprecated); 'icmp_drop_black_src': ICMP Src Blacklist Drop (deprecated); 'icmp_drop_black_src_dst': ICMP SrcDst Blacklist Drop (deprecated); 'icmp_exceed_drop_any_dst': ICMP Dst Exceed Drop (deprecated); 'icmp_exceed_drop_any_src': ICMP Src Exceed Drop (deprecated); 'icmp_exceed_drop_any_src_dst': ICMP SrcDst Exceed Drop (deprecated); 'other_total_drop': OTHER Total Packets Dropped; 'other_dst_drop': OTHER Dst Packets Dropped; 'other_src_drop': OTHER Src Packets Dropped; 'other_src_dst_drop': OTHER SrcDst Packets Dropped; 'other_drop_black_dst': OTHER Dst Blacklist Drop (deprecated); 'other_drop_black_src': OTHER Src Blacklist Drop (deprecated); 'other_drop_black_src_dst': OTHER SrcDst Blacklist Drop (deprecated); 'other_exceed_drop_any_dst': OTHER Dst Exceed Drop (deprecated); 'other_exceed_drop_any_src': OTHER Src Exceed Drop (deprecated); 'other_exceed_drop_any_src_dst': OTHER SrcDst Exceed Drop (deprecated); 'frag_rcvd': Fragmented Packets Received; 'frag_drop': Fragmented Packets Dropped; 'dst_port_undef_drop': Dst Port Undefined Dropped; 'dst_port_exceed_drop_any': Dst Port Exceed Dropped; 'dst_ipproto_bl': Dst IP-Proto Blacklist Packets Dropped; 'dst_port_bl': Dst Port Blacklist Packets Dropped; 'dst_sport_bl': Dst SrcPort Blacklist Packets Dropped; 'dst_sport_exceed_drop_any': Dst SrcPort Exceed Dropped; 'dst_ipproto_rcvd': Dst IP-Proto Total Packets Received; 'dst_ipproto_drop': Dst IP-Proto Total Packets Dropped; 'dst_ipproto_exceed_drop_any': Dst IP-Proto Exceed Dropped; 'src_ip_bypass': Src IP Bypass; 'dst_scanning_detected': Dst Scanning Detected (deprecated); 'dst_ingress_bytes': Inbound Bytes Received; 'dst_egress_bytes': Outbound Bytes Received; 'dst_ingress_packets': Inbound Packets Received; 'dst_egress_packets': Outbound Packets Received; 'dst_ip_bypass': Dst IP Bypass; 'dst_blackhole_inject': Dst Blackhole Injected; 'dst_blackhole_withdraw': Dst Blackhole Withdrawn; 'tcp_total_bytes_rcv': TCP Total Bytes Received; 'tcp_total_bytes_drop': TCP Total Bytes Dropped; 'udp_total_bytes_rcv': UDP Total Bytes Received; 'udp_total_bytes_drop': UDP Total Bytes Dropped; 'icmp_total_bytes_rcv': ICMP Total Bytes Received; 'icmp_total_bytes_drop': ICMP Total Bytes Dropped; 'other_total_bytes_rcv': OTHER Total Bytes Received; 'other_total_bytes_drop': OTHER Total Bytes Dropped; 'udp_any_exceed': UDP Exceeded; 'tcp_any_exceed': TCP Exceeded; 'icmp_any_exceed': ICMP Exceeded; 'other_any_exceed': OTHER Exceeded; 'tcp_drop_bl': TCP Blacklist Packets Dropped; 'udp_drop_bl': UDP Blacklist Packets Dropped; 'icmp_drop_bl': ICMP Blacklisted Packets Dropped; 'other_drop_bl': OTHER Blacklisted Packets Dropped; 'glid_action_encap_send_immed': Glid Action Tunnel-encap; 'glid_action_encap_send_delay': Glid Action Tunnel-encap with Scrub; 'dst_hw_drop': Dst Default Hardware Packets Dropped; **Type:** string **Supported Values:** all, ip_rcv, ip_sent, ipv6_rcv, ipv6_sent, out_no_route, not_for_ddos, instateless, intcp, inudp, inicmp, inother, v4_sess_create, v6_sess_create, tcp_sess_create, udp_sess_create, sess_aged_out, tcp_total_drop, tcp_dst_drop, tcp_src_drop, tcp_src_dst_drop, tcp_drop_black_dst, tcp_drop_black_src, tcp_drop_black_src_dst, tcp_exceed_drop_any_dst, tcp_exceed_drop_any_src, tcp_exceed_drop_any_src_dst, udp_total_drop, udp_dst_drop, udp_src_drop, udp_src_dst_drop, udp_drop_black_dst, udp_drop_black_src, udp_drop_black_src_dst, udp_exceed_drop_any_dst, udp_exceed_drop_any_src, udp_exceed_drop_any_src_dst, icmp_total_drop, icmp_dst_drop, icmp_src_drop, icmp_src_dst_drop, icmp_drop_black_dst, icmp_drop_black_src, icmp_drop_black_src_dst, icmp_exceed_drop_any_dst, icmp_exceed_drop_any_src, icmp_exceed_drop_any_src_dst, other_total_drop, other_dst_drop, other_src_drop, other_src_dst_drop, other_drop_black_dst, other_drop_black_src, other_drop_black_src_dst, other_exceed_drop_any_dst, other_exceed_drop_any_src, other_exceed_drop_any_src_dst, frag_rcvd, frag_drop, dst_port_undef_drop, dst_port_exceed_drop_any, dst_ipproto_bl, dst_port_bl, dst_sport_bl, dst_sport_exceed_drop_any, dst_ipproto_rcvd, dst_ipproto_drop, dst_ipproto_exceed_drop_any, src_ip_bypass, dst_scanning_detected, dst_ingress_bytes, dst_egress_bytes, dst_ingress_packets, dst_egress_packets, dst_ip_bypass, dst_blackhole_inject, dst_blackhole_withdraw, tcp_total_bytes_rcv, tcp_total_bytes_drop, udp_total_bytes_rcv, udp_total_bytes_drop, icmp_total_bytes_rcv, icmp_total_bytes_drop, other_total_bytes_rcv, other_total_bytes_drop, udp_any_exceed, tcp_any_exceed, icmp_any_exceed, other_any_exceed, tcp_drop_bl, udp_drop_bl, icmp_drop_bl, other_drop_bl, glid_action_encap_send_immed, glid_action_encap_send_delay, dst_hw_drop .. _494_stats_data: stats data ---------- .. list-table:: :widths: 10 20 30 80 :header-rows: 2 :stub-columns: 1 * - - Counter - Size - Description * - - - - * - - ip_rcv - 8 - IPv4 Received * - - tcp_drop_bl - 8 - TCP Blacklist Packets Dropped * - - udp_drop_bl - 8 - UDP Blacklist Packets Dropped * - - src_hw_drop_rule_removed - 8 - Src Default Hardware Drop Rules Removed * - - tcp_any_exceed - 8 - TCP Exceeded * - - dst_egress_bytes - 8 - Outbound Bytes Received * - - ipv6_sent - 8 - IPv6 Sent * - - sess_aged_out - 8 - Session Aged Out * - - src_ip_bypass - 8 - Src IP Bypass * - - dst_ipproto_drop - 8 - Dst IP-Proto Total Packets Dropped * - - udp_sess_create - 8 - UDP Sessions Created * - - v6_sess_create - 8 - IPv6 Session Created * - - udp_src_dst_drop - 8 - UDP SrcDst Packets Dropped * - - udp_src_drop - 8 - UDP Src Packets Dropped * - - tcp_dst_drop - 8 - TCP Dst Packets Dropped * - - dst_hw_drop_rule_inserted - 8 - Dst Default Hardware Drop Rules Inserted * - - dst_ipproto_rcvd - 8 - Dst IP-Proto Total Packets Received * - - udp_total_bytes_drop - 8 - UDP Total Bytes Dropped * - - inudp - 8 - UDP Total Packets Received * - - inicmp - 8 - ICMP Total Packets Received * - - glid_action_encap_send_delay - 8 - Glid Action Tunnel-encap with Scrub * - - icmp_any_exceed - 8 - ICMP Exceeded * - - dst_ipproto_bl - 8 - Dst IP-Proto Blacklist Packets Dropped * - - dst_sport_bl - 8 - Dst SrcPort Blacklist Packets Dropped * - - dst_ingress_packets - 8 - Inbound Packets Received * - - icmp_drop_bl - 8 - ICMP Blacklisted Packets Dropped * - - icmp_total_drop - 8 - ICMP Total Packets Dropped * - - other_src_dst_drop - 8 - OTHER SrcDst Packets Dropped * - - inother - 8 - OTHER Total Packets Received * - - other_dst_drop - 8 - OTHER Dst Packets Dropped * - - other_total_bytes_rcv - 8 - OTHER Total Bytes Received * - - dst_hw_drop_rule_removed - 8 - Dst Default Hardware Drop Rules Removed * - - udp_any_exceed - 8 - UDP Exceeded * - - out_no_route - 8 - IPv4/v6 Out No Route * - - tcp_total_bytes_drop - 8 - TCP Total Bytes Dropped * - - dst_ingress_bytes - 8 - Inbound Bytes Received * - - dst_sport_exceed_drop_any - 8 - Dst SrcPort Exceed Dropped * - - other_src_drop - 8 - OTHER Src Packets Dropped * - - dst_ipproto_exceed_drop_any - 8 - Dst IP-Proto Exceed Dropped * - - tcp_total_drop - 8 - TCP Total Packets Dropped * - - dst_port_exceed_drop_any - 8 - Dst Port Exceed Dropped * - - other_any_exceed - 8 - OTHER Exceeded * - - udp_dst_drop - 8 - UDP Dst Packets Dropped * - - ip_sent - 8 - IPv4 Sent * - - icmp_dst_drop - 8 - ICMP Dst Packets Dropped * - - glid_action_encap_send_immed - 8 - Glid Action Tunnel-encap * - - v4_sess_create - 8 - IPv4 Session Created * - - other_total_bytes_drop - 8 - OTHER Total Bytes Dropped * - - other_drop_bl - 8 - OTHER Blacklisted Packets Dropped * - - udp_total_drop - 8 - UDP Total Packets Dropped * - - dst_blackhole_inject - 8 - Dst Blackhole Injected * - - tcp_src_dst_drop - 8 - TCP SrcDst Packets Dropped * - - dst_ip_bypass - 8 - Dst IP Bypass * - - icmp_total_bytes_rcv - 8 - ICMP Total Bytes Received * - - icmp_src_drop - 8 - ICMP Src Packets Dropped * - - dst_blackhole_withdraw - 8 - Dst Blackhole Withdrawn * - - src_hw_drop_rule_inserted - 8 - Src Default Hardware Drop Rules Inserted * - - udp_total_bytes_rcv - 8 - UDP Total Bytes Received * - - tcp_total_bytes_rcv - 8 - TCP Total Bytes Received * - - not_for_ddos - 8 - Not For DDOS * - - dst_port_bl - 8 - Dst Port Blacklist Packets Dropped * - - tcp_src_drop - 8 - TCP Src Packets Dropped * - - dst_hw_drop - 8 - Dst Hardware Packets Dropped * - - frag_rcvd - 8 - Fragmented Packets Received * - - dst_port_undef_drop - 8 - Dst Port Undefined Dropped * - - tcp_sess_create - 8 - TCP Sessions Created * - - intcp - 8 - TCP Total Packets Received * - - icmp_total_bytes_drop - 8 - ICMP Total Bytes Dropped * - - ipv6_rcv - 8 - IPv6 Received * - - instateless - 8 - Stateless Packets Received * - - frag_drop - 8 - Fragmented Packets Dropped * - - other_total_drop - 8 - OTHER Total Packets Dropped * - - dst_egress_packets - 8 - Outbound Packets Received * - - icmp_src_dst_drop - 8 - ICMP SrcDst Packets Dropped