.. _ddos_dst_zone_ip_proto_proto_number:
ddos dst zone ip-proto proto-number
===================================
DDOS IP protocol configuration
proto-number Specification
--------------------------
===================================== =======================================================================================================
**Parameter** **Value**
===================================== =======================================================================================================
**Type** *Collection*
**Object Key(s)** *protocol-num*
**Collection Name** :ref:`892_proto-number_list`
**Collection URI** /axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number
**Element Name** proto-number
**Element URI** /axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}
**Element Attributes** proto-number_attributes
**Partition Visibility** shared
**Statistics Data URI** /axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/stats
**Operational Data URI** /axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/oper
**Schema** :download:`proto-number schema <ddos-dst-zone-ip-proto-proto-number/ddos-dst-zone-ip-proto-proto-number.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/dst/zone/{zone-name}/ip-proto/proto-number
.. raw:: html
</td><td valign = 'top'>
:ref:`892_proto-number_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Create List
.. raw:: html
</td><td valign = 'top'>
POST
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number
.. raw:: html
</td><td valign = 'top'>
:ref:`892_proto-number_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/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}
.. raw:: html
</td><td valign = 'top'>
:ref:`892_proto-number_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Get List
.. raw:: html
</td><td valign = 'top'>
GET
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number
.. raw:: html
</td><td valign = 'top'>
:ref:`892_proto-number_list`
.. 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/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}
.. raw:: html
</td><td valign = 'top'>
:ref:`892_proto-number_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/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}
.. raw:: html
</td><td valign = 'top'>
:ref:`892_proto-number_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
<tr style='border-bottom: thin solid;'><td valign = 'top'>
Replace List
.. raw:: html
</td><td valign = 'top'>
PUT
.. raw:: html
</td><td valign = 'top'>
/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number
.. raw:: html
</td><td valign = 'top'>
:ref:`892_proto-number_list`
.. 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/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}
.. raw:: html
</td><td valign = 'top'>
:ref:`892_proto-number_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
</table>
.. _892_proto-number_list:
proto-number-list
-----------------
proto-number-list is **JSON List** of :ref:`892_proto-number_attributes`
proto-number-list : [
{ :ref:`892_proto-number_attributes` },
{ :ref:`892_proto-number_attributes` },
...
]
.. _892_proto-number_attributes:
proto-number attributes
-----------------------
**age**
**Description** Idle age for ip entry
**Type:** number
**Range:** 2-1023
**Default:** 5
**apply-policy-on-overflow**
**Description** Enable this flag to apply overflow policy when dynamic entry count overflows
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**deny**
**Description** Blacklist and Drop all incoming packets for this ip-proto
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**drop-frag-pkt**
**Description** Drop fragmented packets
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**dynamic-entry-overflow-policy-list**
**Type:** List
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/dynamic-entry-overflow-policy/{dummy-name} <ddos_dst_zone>`
**enable-class-list-overflow**
**Description** Apply class-list overflow policy upon exceeding dynamic entry count specified for zone-port or class-list
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**enable-top-k**
**Description** Enable ddos top-k source IP detection
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**enable-top-k-destination**
**Description** Enable ddos top-k destination IP detection
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**esp-inspect**
**Description:** esp-inspect is a **JSON Block**. Please see below for :ref:`892_esp-inspect`
**Type:** Object
**faster-de-escalation**
**Description** De-escalate faster in standalone mode
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**glid-cfg**
**Description:** glid-cfg is a **JSON Block**. Please see below for :ref:`892_glid-cfg`
**Type:** Object
**ip-filtering-policy**
**Description** Configure IP Filter
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/ddos/ip-filtering-policy <ddos_ip_filtering_policy>`
**ip-filtering-policy-oper**
**Description:** ip-filtering-policy-oper is a **JSON Block**. Please see below for :ref:`892_ip-filtering-policy-oper`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/ip-filtering-policy-oper <ddos_dst_zone>`
**level-list**
**Type:** List
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/level/{level-num} <ddos_dst_zone>`
**manual-mode-enable**
**Description** Toggle manual mode to use fix templates
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**manual-mode-list**
**Type:** List
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/manual-mode/{config} <ddos_dst_zone>`
**max-dynamic-entry-count**
**Description** Maximum count for dynamic source zone service entry
**Type:** number
**Range:** 0-2147483647
**port-ind**
**Description:** port-ind is a **JSON Block**. Please see below for :ref:`892_port-ind`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/port-ind <ddos_dst_zone>`
**progression-tracking**
**Description:** progression-tracking is a **JSON Block**. Please see below for :ref:`892_progression-tracking`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/progression-tracking <ddos_dst_zone>`
**protocol-num**
**Description** Protocol Number
**Type:** number
**Range:** 0-255
**set-counter-base-val**
**Description** Set T2 counter value of current context to specified value
**Type:** number
**Range:** 1-4294967295
**src-based-policy-list**
**Type:** List
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/src-based-policy/{src-based-policy-name} <ddos_dst_zone>`
**topk-destinations**
**Description:** topk-destinations is a **JSON Block**. Please see below for :ref:`892_topk-destinations`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/topk-destinations <ddos_dst_zone>`
**topk-dst-num-records**
**Description** Maximum number of records to show in topk
**Type:** number
**Range:** 1-100
**Default:** 20
**topk-num-records**
**Description** Maximum number of records to show in topk
**Type:** number
**Range:** 1-100
**Default:** 20
**topk-sources**
**Description:** topk-sources is a **JSON Block**. Please see below for :ref:`892_topk-sources`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/topk-sources <ddos_dst_zone>`
**unlimited-dynamic-entry-count**
**Description** No limit for maximum dynamic src entry count
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _892_dynamic-entry-overflow-policy-list:
dynamic-entry-overflow-policy-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**action**
**Description** 'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service;
**Type:** string
**Supported Values:** bypass, deny
**dummy-name**
**Description** 'configuration': Configure overflow policy;
**Type:** string
**Supported Values:** configuration
**glid**
**Description** Global limit ID
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/glid <glid>`
**user-tag**
**Description** Customized tag
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
**zone-template**
**Description:** zone-template is a **JSON Block**. Please see below for :ref:`892_dynamic-entry-overflow-policy-list_zone-template`
**Type:** Object
.. _892_dynamic-entry-overflow-policy-list_zone-template:
dynamic-entry-overflow-policy-list_zone-template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**ip-proto**
**Description** DDOS ip-proto template
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
.. _892_ip-filtering-policy-oper:
ip-filtering-policy-oper
^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _892_glid-cfg:
glid-cfg
^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**action-list**
**Description** Configure action-list to take
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`
**glid**
**Description** Global limit ID for the whole zone
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/glid <glid>`
**glid-action**
**Description** 'drop': Drop packets for glid exceed (Default); 'ignore': Do nothing for glid exceed;
**Type:** string
**Supported Values:** drop, ignore
**per-addr-glid**
**Description** Global limit ID per address
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/glid <glid>`
.. _892_level-list:
level-list
^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**glid-action**
**Description** 'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed;
**Type:** string
**Supported Values:** drop, blacklist-src, ignore
**indicator-list**
**Type:** List
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/level/{level-num}/indicator/{type} <ddos_dst_zone>`
**level-num**
**Description** '0': Default policy level; '1': Policy level 1; '2': Policy level 2; '3': Policy level 3; '4': Policy level 4;
**Type:** string
**Supported Values:** 0, 1, 2, 3, 4
**src-default-glid**
**Description** Global limit ID
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/glid <glid>`
**src-escalation-score**
**Description** Source activation score of this level
**Type:** number
**Range:** 1-1000000
**src-violation-actions**
**Description** Violation actions apply due to source escalate from this level
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/ddos/violation-actions <ddos_violation_actions>`
**user-tag**
**Description** Customized tag
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
**zone-escalation-score**
**Description** Zone activation score of this level
**Type:** number
**Range:** 1-1000000
**zone-template**
**Description:** zone-template is a **JSON Block**. Please see below for :ref:`892_level-list_zone-template`
**Type:** Object
**zone-violation-actions**
**Description** Violation actions apply due to zone escalate from this level
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/ddos/violation-actions <ddos_violation_actions>`
.. _892_level-list_zone-template:
level-list_zone-template
^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**encap**
**Description** DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**ip-proto**
**Description** DDOS ip-proto template
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
.. _892_level-list_indicator-list:
level-list_indicator-list
^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**data-packet-size**
**Description** Expected minimal data size
**Type:** number
**Range:** 1-1500
**score**
**Description** Score corresponding to the indicator
**Type:** number
**Range:** 1-1000000
**src-threshold-large-num**
**Description** Indicator per-src threshold
**Type:** number
**Range:** 1-10995116277760
**src-threshold-num**
**Description** Indicator per-src threshold
**Type:** number
**Range:** 1-2147483647
**src-threshold-str**
**Description** Indicator per-src threshold (Non-zero floating point)
**Type:** string
**Maximum Length:** 128 characters
**Maximum Length:** 1 characters
**src-violation-actions**
**Description** Violation actions to use when this src indicator threshold reaches
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/ddos/violation-actions <ddos_violation_actions>`
**type**
**Description** 'pkt-rate': rate of incoming packets; 'pkt-drop-rate': rate of packets got dropped; 'bit-rate': rate of incoming bits; 'pkt-drop-ratio': ratio of incoming packet rate divided by the rate of dropping packets; 'bytes-to-bytes-from-ratio': ratio of incoming packet rate divided by the rate of outgoing packets; 'frag-rate': rate of incoming fragmented packets; 'cpu-utilization': average data CPU utilization; 'interface-utilization': outside interface utilization;
**Type:** string
**Supported Values:** pkt-rate, pkt-drop-rate, bit-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, frag-rate, cpu-utilization, interface-utilization
**user-tag**
**Description** Customized tag
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
**zone-threshold-large-num**
**Description** Threshold for the entire zone
**Type:** number
**Range:** 1-10995116277760
**zone-threshold-num**
**Description** Threshold for the entire zone
**Type:** number
**Range:** 1-2147483647
**zone-threshold-str**
**Description** Threshold for the entire zone (Non-zero floating point)
**Type:** string
**Maximum Length:** 128 characters
**Maximum Length:** 1 characters
**zone-violation-actions**
**Description** Violation actions to use when this zone indicator threshold reaches
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/ddos/violation-actions <ddos_violation_actions>`
.. _892_manual-mode-list:
manual-mode-list
^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**config**
**Description** 'configuration': Manual-mode configuration;
**Type:** string
**Supported Values:** configuration
**glid-action**
**Description** 'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed;
**Type:** string
**Supported Values:** drop, blacklist-src, ignore
**src-default-glid**
**Description** Global limit ID
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/glid <glid>`
**user-tag**
**Description** Customized tag
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
**zone-template**
**Description:** zone-template is a **JSON Block**. Please see below for :ref:`892_manual-mode-list_zone-template`
**Type:** Object
.. _892_manual-mode-list_zone-template:
manual-mode-list_zone-template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**encap**
**Description** DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**ip-proto**
**Description** DDOS ip-proto template
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
.. _892_src-based-policy-list:
src-based-policy-list
^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**policy-class-list-list**
**Type:** List
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name} <ddos_dst_zone>`
**src-based-policy-name**
**Description** Specify name of the policy
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**user-tag**
**Description** Customized tag
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _892_src-based-policy-list_policy-class-list-list:
src-based-policy-list_policy-class-list-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**action**
**Description** 'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service;
**Type:** string
**Supported Values:** bypass, deny
**class-list-name**
**Description** Class-list name
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**class-list-overflow-policy-list**
**Type:** List
**Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name} <ddos_dst_zone>`
**glid**
**Description** Global limit ID
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/glid <glid>`
**glid-action**
**Description** 'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed;
**Type:** string
**Supported Values:** drop, blacklist-src, ignore
**log-enable**
**Description** Enable logging
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**log-periodic**
**Description** Enable log periodic
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**max-dynamic-entry-count**
**Description** Maximum count for dynamic source zone service entry allowed for this class-list
**Type:** number
**Range:** 0-2147483647
**sampling-enable**
**Type:** List
**user-tag**
**Description** Customized tag
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
**zone-template**
**Description:** zone-template is a **JSON Block**. Please see below for :ref:`892_src-based-policy-list_policy-class-list-list_zone-template`
**Type:** Object
.. _892_src-based-policy-list_policy-class-list-list_sampling-enable:
src-based-policy-list_policy-class-list-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**counters1**
**Description** 'all': all; 'packet_received': Packets Received; 'packet_dropped': Packets Dropped; 'entry_learned': Entry Learned; 'entry_count_overflow': Entry Count Overflow;
**Type:** string
**Supported Values:** all, packet_received, packet_dropped, entry_learned, entry_count_overflow
.. _892_src-based-policy-list_policy-class-list-list_zone-template:
src-based-policy-list_policy-class-list-list_zone-template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**ip-proto**
**Description** DDOS ip-proto template
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**logging**
**Description** DDOS logging template
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
.. _892_src-based-policy-list_policy-class-list-list_class-list-overflow-policy-list:
src-based-policy-list_policy-class-list-list_class-list-overflow-policy-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**action**
**Description** 'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service;
**Type:** string
**Supported Values:** bypass, deny
**dummy-name**
**Description** 'configuration': Configure overflow policy for class-list;
**Type:** string
**Supported Values:** configuration
**glid**
**Description** Global limit ID
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/glid <glid>`
**log-enable**
**Description** Enable logging
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**log-periodic**
**Description** Enable log periodic
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**user-tag**
**Description** Customized tag
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
**zone-template**
**Description:** zone-template is a **JSON Block**. Please see below for :ref:`892_src-based-policy-list_policy-class-list-list_class-list-overflow-policy-list_zone-template`
**Type:** Object
.. _892_src-based-policy-list_policy-class-list-list_class-list-overflow-policy-list_zone-template:
src-based-policy-list_policy-class-list-list_class-list-overflow-policy-list_zone-template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**ip-proto**
**Description** DDOS ip-proto template
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
.. _892_port-ind:
port-ind
^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**sampling-enable**
**Type:** List
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _892_port-ind_sampling-enable:
port-ind_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**counters1**
**Description** 'all': all; 'ip-proto-type': IP Protocol Type; 'ddet_ind_pkt_rate_current': Pkt Rate Current; 'ddet_ind_pkt_rate_min': Pkt Rate Min; 'ddet_ind_pkt_rate_max': Pkt Rate Max; 'ddet_ind_pkt_rate_adaptive_threshold': Pkt Rate Adaptive Threshold; 'ddet_ind_pkt_drop_rate_current': Pkt Drop Rate Current; 'ddet_ind_pkt_drop_rate_min': Pkt Drop Rate Min; 'ddet_ind_pkt_drop_rate_max': Pkt Drop Rate Max; 'ddet_ind_pkt_drop_rate_adaptive_threshold': Pkt Drop Rate Adaptive Threshold; 'ddet_ind_syn_rate_current': TCP SYN Rate Current; 'ddet_ind_syn_rate_min': TCP SYN Rate Min; 'ddet_ind_syn_rate_max': TCP SYN Rate Max; 'ddet_ind_syn_rate_adaptive_threshold': TCP SYN Rate Adaptive Threshold; 'ddet_ind_fin_rate_current': TCP FIN Rate Current; 'ddet_ind_fin_rate_min': TCP FIN Rate Min; 'ddet_ind_fin_rate_max': TCP FIN Rate Max; 'ddet_ind_fin_rate_adaptive_threshold': TCP FIN Rate Adaptive Threshold; 'ddet_ind_rst_rate_current': TCP RST Rate Current; 'ddet_ind_rst_rate_min': TCP RST Rate Min; 'ddet_ind_rst_rate_max': TCP RST Rate Max; 'ddet_ind_rst_rate_adaptive_threshold': TCP RST Rate Adaptive Threshold; 'ddet_ind_small_window_ack_rate_current': TCP Small Window ACK Rate Current; 'ddet_ind_small_window_ack_rate_min': TCP Small Window ACK Rate Min; 'ddet_ind_small_window_ack_rate_max': TCP Small Window ACK Rate Max; 'ddet_ind_small_window_ack_rate_adaptive_threshold': TCP Small Window ACK Rate Adaptive Threshold; 'ddet_ind_empty_ack_rate_current': TCP Empty ACK Rate Current; 'ddet_ind_empty_ack_rate_min': TCP Empty ACK Rate Min; 'ddet_ind_empty_ack_rate_max': TCP Empty ACK Rate Max; 'ddet_ind_empty_ack_rate_adaptive_threshold': TCP Empty ACK Rate Adaptive Threshold; 'ddet_ind_small_payload_rate_current': TCP Small Payload Rate Current; 'ddet_ind_small_payload_rate_min': TCP Small Payload Rate Min; 'ddet_ind_small_payload_rate_max': TCP Small Payload Rate Max; 'ddet_ind_small_payload_rate_adaptive_threshold': TCP Small Payload Rate Adaptive Threshold; 'ddet_ind_pkt_drop_ratio_current': Pkt Drop / Pkt Rcvd Current; 'ddet_ind_pkt_drop_ratio_min': Pkt Drop / Pkt Rcvd Min; 'ddet_ind_pkt_drop_ratio_max': Pkt Drop / Pkt Rcvd Max; 'ddet_ind_pkt_drop_ratio_adaptive_threshold': Pkt Drop / Pkt Rcvd Adaptive Threshold; 'ddet_ind_inb_per_outb_current': Bytes-to / Bytes-from Current; 'ddet_ind_inb_per_outb_min': Bytes-to / Bytes-from Min; 'ddet_ind_inb_per_outb_max': Bytes-to / Bytes-from Max; 'ddet_ind_inb_per_outb_adaptive_threshold': Bytes-to / Bytes-from Adaptive Threshold; 'ddet_ind_syn_per_fin_rate_current': TCP SYN Rate / FIN Rate Current; 'ddet_ind_syn_per_fin_rate_min': TCP SYN Rate / FIN Rate Min; 'ddet_ind_syn_per_fin_rate_max': TCP SYN Rate / FIN Rate Max; 'ddet_ind_syn_per_fin_rate_adaptive_threshold': TCP SYN Rate / FIN Rate Adaptive Threshold; 'ddet_ind_conn_miss_rate_current': TCP Session Miss Rate Current; 'ddet_ind_conn_miss_rate_min': TCP Session Miss Rate Min; 'ddet_ind_conn_miss_rate_max': TCP Session Miss Rate Max; 'ddet_ind_conn_miss_rate_adaptive_threshold': TCP Session Miss Rate Adaptive Threshold; 'ddet_ind_concurrent_conns_current': TCP/UDP Concurrent Sessions Current; 'ddet_ind_concurrent_conns_min': TCP/UDP Concurrent Sessions Min; 'ddet_ind_concurrent_conns_max': TCP/UDP Concurrent Sessions Max; 'ddet_ind_concurrent_conns_adaptive_threshold': TCP/UDP Concurrent Sessions Adaptive Threshold; 'ddet_ind_data_cpu_util_current': Data CPU Utilization Current; 'ddet_ind_data_cpu_util_min': Data CPU Utilization Min; 'ddet_ind_data_cpu_util_max': Data CPU Utilization Max; 'ddet_ind_data_cpu_util_adaptive_threshold': Data CPU Utilization Adaptive Threshold; 'ddet_ind_outside_intf_util_current': Outside Interface Utilization Current; 'ddet_ind_outside_intf_util_min': Outside Interface Utilization Min; 'ddet_ind_outside_intf_util_max': Outside Interface Utilization Max; 'ddet_ind_outside_intf_util_adaptive_threshold': Outside Interface Utilization Adaptive Threshold; 'ddet_ind_frag_rate_current': Frag Pkt Rate Current; 'ddet_ind_frag_rate_min': Frag Pkt Rate Min; 'ddet_ind_frag_rate_max': Frag Pkt Rate Max; 'ddet_ind_frag_rate_adaptive_threshold': Frag Pkt Rate Adaptive Threshold; 'ddet_ind_bit_rate_current': Bit Rate Current; 'ddet_ind_bit_rate_min': Bit Rate Min; 'ddet_ind_bit_rate_max': Bit Rate Max; 'ddet_ind_bit_rate_adaptive_threshold': Bit Rate Adaptive Threshold;
**Type:** string
**Supported Values:** all, ip-proto-type, ddet_ind_pkt_rate_current, ddet_ind_pkt_rate_min, ddet_ind_pkt_rate_max, ddet_ind_pkt_rate_adaptive_threshold, ddet_ind_pkt_drop_rate_current, ddet_ind_pkt_drop_rate_min, ddet_ind_pkt_drop_rate_max, ddet_ind_pkt_drop_rate_adaptive_threshold, ddet_ind_syn_rate_current, ddet_ind_syn_rate_min, ddet_ind_syn_rate_max, ddet_ind_syn_rate_adaptive_threshold, ddet_ind_fin_rate_current, ddet_ind_fin_rate_min, ddet_ind_fin_rate_max, ddet_ind_fin_rate_adaptive_threshold, ddet_ind_rst_rate_current, ddet_ind_rst_rate_min, ddet_ind_rst_rate_max, ddet_ind_rst_rate_adaptive_threshold, ddet_ind_small_window_ack_rate_current, ddet_ind_small_window_ack_rate_min, ddet_ind_small_window_ack_rate_max, ddet_ind_small_window_ack_rate_adaptive_threshold, ddet_ind_empty_ack_rate_current, ddet_ind_empty_ack_rate_min, ddet_ind_empty_ack_rate_max, ddet_ind_empty_ack_rate_adaptive_threshold, ddet_ind_small_payload_rate_current, ddet_ind_small_payload_rate_min, ddet_ind_small_payload_rate_max, ddet_ind_small_payload_rate_adaptive_threshold, ddet_ind_pkt_drop_ratio_current, ddet_ind_pkt_drop_ratio_min, ddet_ind_pkt_drop_ratio_max, ddet_ind_pkt_drop_ratio_adaptive_threshold, ddet_ind_inb_per_outb_current, ddet_ind_inb_per_outb_min, ddet_ind_inb_per_outb_max, ddet_ind_inb_per_outb_adaptive_threshold, ddet_ind_syn_per_fin_rate_current, ddet_ind_syn_per_fin_rate_min, ddet_ind_syn_per_fin_rate_max, ddet_ind_syn_per_fin_rate_adaptive_threshold, ddet_ind_conn_miss_rate_current, ddet_ind_conn_miss_rate_min, ddet_ind_conn_miss_rate_max, ddet_ind_conn_miss_rate_adaptive_threshold, ddet_ind_concurrent_conns_current, ddet_ind_concurrent_conns_min, ddet_ind_concurrent_conns_max, ddet_ind_concurrent_conns_adaptive_threshold, ddet_ind_data_cpu_util_current, ddet_ind_data_cpu_util_min, ddet_ind_data_cpu_util_max, ddet_ind_data_cpu_util_adaptive_threshold, ddet_ind_outside_intf_util_current, ddet_ind_outside_intf_util_min, ddet_ind_outside_intf_util_max, ddet_ind_outside_intf_util_adaptive_threshold, ddet_ind_frag_rate_current, ddet_ind_frag_rate_min, ddet_ind_frag_rate_max, ddet_ind_frag_rate_adaptive_threshold, ddet_ind_bit_rate_current, ddet_ind_bit_rate_min, ddet_ind_bit_rate_max, ddet_ind_bit_rate_adaptive_threshold
.. _892_topk-sources:
topk-sources
^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _892_esp-inspect:
esp-inspect
^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**auth-algorithm**
**Description** 'AUTH_NULL': No Integrity Check Value; 'HMAC-SHA-1-96': 96 bit Auth Algo; 'HMAC-SHA-256-96': 96 bit Auth Algo; 'HMAC-SHA-256-128': 128 bit Auth Algo; 'HMAC-SHA-384-192': 192 bit Auth Algo; 'HMAC-SHA-512-256': 256 bit Auth Algo; 'HMAC-MD5-96': 96 bit Auth Algo; 'MAC-RIPEMD-160-96': 96 bit Auth Algo;
**Type:** string
**Supported Values:** AUTH_NULL, HMAC-SHA-1-96, HMAC-SHA-256-96, HMAC-SHA-256-128, HMAC-SHA-384-192, HMAC-SHA-512-256, HMAC-MD5-96, MAC-RIPEMD-160-96
**encrypt-algorithm**
**Description** 'NULL': Null Encryption Algorithm;
**Type:** string
**Supported Values:** NULL
**mode**
**Description** 'transport': Transport mode;
**Type:** string
**Supported Values:** transport
.. _892_topk-destinations:
topk-destinations
^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _892_progression-tracking:
progression-tracking
^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters