ddos dst entry¶

Configure IP/IPv6 static entry

entry Specification¶

Parameter Value

Type Collection

Object Key(s) dst-entry-name

Collection Name entry-list

Collection URI /axapi/v3/ddos/dst/entry

Element Name entry

Element URI /axapi/v3/ddos/dst/entry/{dst-entry-name}

Element Attributes entry_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/ddos/dst/entry/{dst-entry-name}/stats

Operational Data URI /axapi/v3/ddos/dst/entry/{dst-entry-name}/oper

Schema entry schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ddos/dst/entry	entry attributes
POST /axapi/v3/ddos/dst/entry/ Payload: { "entry": { "dst-entry-name": "a", "ipv6-addr": "2003::1" } }
Create List	POST	/axapi/v3/ddos/dst/entry	entry attributes
Get Object	GET	/axapi/v3/ddos/dst/entry/{dst-entry-name}	entry attributes
GET /axapi/v3/ddos/dst/entry/a Reponse: { "entry": { "dst-entry-name": "a", "ipv6-addr": "2003::1", "exceed-log-cfg": { "log-enable": 0, "log-high-frequency": 0 }, "log-periodic": 0, "drop-frag-pkt": 0, "sflow": { "polling": { "sflow-packets": 0, "sflow-layer-4": 0, "sflow-tcp": { "sflow-tcp-basic": 0, "sflow-tcp-stateful": 0 }, "sflow-http": 0, "sflow-undef-port-hit-stats": 0, "sflow-undef-port-hit-stats-brief": 0 } }, "drop-on-no-src-dst-default": 0, "drop-disable": 0, "operational-mode": "protection", "reporting-disabled": 0, "advertised-enable": 0, "pattern-recognition-hw-filter-enable": 0, "uuid": "3b4d6aa6-6218-11ef-9889-5f1aca88b750", "topk-destinations": { "uuid": "3b4d8ca2-6218-11ef-9889-5f1aca88b750", "a10-url": "/axapi/v3/ddos/dst/entry/a/topk-destinations" }, "a10-url": "/axapi/v3/ddos/dst/entry/a" } }
Get List	GET	/axapi/v3/ddos/dst/entry	entry-list
Modify Object	POST	/axapi/v3/ddos/dst/entry/{dst-entry-name}	entry attributes
Replace Object	PUT	/axapi/v3/ddos/dst/entry/{dst-entry-name}	entry attributes
PUT /axapi/v3/ddos/dst/entry/a Payload: { "entry": { "dst-entry-name": "a", "ipv6-addr": "2003::1" } }
Replace List	PUT	/axapi/v3/ddos/dst/entry	entry-list
Delete Object	DELETE	/axapi/v3/ddos/dst/entry/{dst-entry-name}	entry attributes
DELETE /axapi/v3/ddos/dst/entry/a Reponse: { "response": { "status": "OK" } }

entry-list¶

entry-list is JSON List of entry attributes

entry-list : [

{ entry attributes },

{ entry attributes },

…

]

entry attributes¶

advertised-enable

Description BGP advertised

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

blackhole-on-glid-exceed

Description Blackhole destination entry for X minutes upon glid limit exceeded

Type: number

Range: 1-30

capture-config-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/capture-config/{name}

description

Description Description for this Destination Entry

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

dest-nat-ip

Description Destination NAT IP address

Type: string

Format: ipv4-address

dest-nat-ipv6

Description Destination NAT IPv6 address

Type: string

Format: ipv6-address

drop-disable

Description Disable certain drops during packet processing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

drop-disable-fwd-immediate

Description Immediately forward L4 drops

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

drop-on-no-src-dst-default

Description Drop if no match with src-based-policy class-list, and default is not configured

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dst-entry-name

Description

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

dynamic-entry-overflow-policy-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/dynamic-entry-overflow-policy/{dummy-name}

enable-top-k

Type: List

exceed-log-cfg

Description: exceed-log-cfg is a JSON Block. Please see below for exceed-log-cfg

Type: Object

exceed-log-dep-cfg

Description: exceed-log-dep-cfg is a JSON Block. Please see below for exceed-log-dep-cfg

Type: Object

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

glid-exceed-action

Description: glid-exceed-action is a JSON Block. Please see below for glid-exceed-action

Type: Object

hw-blacklist-blocking

Description: hw-blacklist-blocking is a JSON Block. Please see below for hw-blacklist-blocking

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/hw-blacklist-blocking

inbound-forward-dscp

Description To set dscp value for inbound packets (DSCP Value for the clear traffic marking)

Type: number

Range: 1-63

ip-addr

Description

Type: string

Format: ipv4-address

ip-proto-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/ip-proto/{port-num}

ipv6-addr

Description

Type: string

Format: ipv6-address

l4-type-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/l4-type/{protocol}

log-periodic

Description Enable periodic log while event is continuing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

operational-mode

Description ‘protection’: Protection mode; ‘bypass’: Bypass mode;

Type: string

Supported Values: protection, bypass

Default: protection

outbound-forward-dscp

Description To set dscp value for outbound

Type: number

Range: 1-63

pattern-recognition-hw-filter-enable

Description to enable pattern recognition hardware filter

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}

port-range-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port-range/{port-range-start}+{port-range-end}+{protocol}

reporting-disabled

Description Disable Reporting

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow

Description: sflow is a JSON Block. Please see below for sflow

Type: Object

source-nat-pool

Description Configure source NAT

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

src-dst-pair

Description: src-dst-pair is a JSON Block. Please see below for src-dst-pair

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair

src-dst-pair-class-list-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}

src-dst-pair-policy-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}

src-dst-pair-settings-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-settings/{all-types}

src-port-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-port/{port-num}+{protocol}

src-port-range-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}

subnet-ip-addr

Description IP Subnet

Type: string

Format: ipv4-cidr

subnet-ipv6-addr

Description IPV6 Subnet

Type: string

Format: ipv6-address-plen

template

Description: template is a JSON Block. Please see below for template

Type: Object

topk-destinations

Description: topk-destinations is a JSON Block. Please see below for topk-destinations

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/topk-destinations

traffic-distribution-mode

Description ‘default’: Distribute traffic to one slot using default distribution mechanism; ‘source-ip-based’: Distribute traffic between slots, based on source ip;

Type: string

Supported Values: default, source-ip-based

Default: default

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

port-list¶

Specification Value

Type list

Block object keys

capture-config

Description: capture-config is a JSON Block. Please see below for port-list_capture-config

Type: Object

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

detection-enable

Description Enable ddos detection

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-cache

Description DNS Cache Instance

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ddos/dns-cache

enable-top-k

Description Enable ddos top-k entries

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

glid-exceed-action

Description: glid-exceed-action is a JSON Block. Please see below for port-list_glid-exceed-action

Type: Object

pattern-recognition

Description: pattern-recognition is a JSON Block. Please see below for port-list_pattern-recognition

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}/pattern-recognition

pattern-recognition-pu-details

Description: pattern-recognition-pu-details is a JSON Block. Please see below for port-list_pattern-recognition-pu-details

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}/pattern-recognition-pu-details

port-ind

Description: port-ind is a JSON Block. Please see below for port-list_port-ind

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}/port-ind

port-num

Description Port Number

Type: number

Range: 0-65535

protocol

Description ‘dns-tcp’: DNS-TCP Port; ‘dns-udp’: DNS-UDP Port; ‘http’: HTTP Port; ‘tcp’: TCP Port; ‘udp’: UDP Port; ‘ssl-l4’: SSL-L4 Port; ‘sip-udp’: SIP-UDP Port; ‘sip-tcp’: SIP-TCP Port;

Type: string

Supported Values: dns-tcp, dns-udp, http, tcp, udp, ssl-l4, sip-udp, sip-tcp

sflow

Description: sflow is a JSON Block. Please see below for port-list_sflow

Type: Object

signature-extraction

Description: signature-extraction is a JSON Block. Please see below for port-list_signature-extraction

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}/signature-extraction

template

Description: template is a JSON Block. Please see below for port-list_template

Type: Object

topk-num-records

Description Maximum number of records to show in topk

Type: number

Range: 1-100

Default: 20

topk-sort-key

Description ‘avg’: window average; ‘max-peak’: max peak;

Type: string

Supported Values: avg, max-peak

Default: avg

topk-sources

Description: topk-sources is a JSON Block. Please see below for port-list_topk-sources

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}/topk-sources

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

port-list_pattern-recognition¶

Specification Value

Type object

algorithm

Description ‘heuristic’: heuristic algorithm;

Type: string

Supported Values: heuristic

mode

Description ‘capture-never-expire’: War-time capture without rate exceeding and never expires; ‘manual’: Manual mode;

Type: string

Supported Values: capture-never-expire, manual

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

port-list_sflow¶

Specification Value

Type object

polling

Description: polling is a JSON Block. Please see below for port-list_sflow_polling

Type: Object

port-list_sflow_polling¶

Specification Value

Type object

sflow-http

Description Enable sFlow HTTP counter polling

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-packets

Description Enable sFlow packet-level counter polling

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-tcp

Description: sflow-tcp is a JSON Block. Please see below for port-list_sflow_polling_sflow-tcp

Type: Object

port-list_sflow_polling_sflow-tcp¶

Specification Value

Type object

sflow-tcp-basic

Description Enable sFlow basic TCP counter polling

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-tcp-stateful

Description Enable sFlow stateful TCP counter polling

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-list_capture-config¶

Specification Value

Type object

capture-config-mode

Description ‘drop’: Apply capture-config to dropped packets; ‘forward’: Apply capture-config to forwarded packets; ‘all’: Apply capture-config to both dropped and forwarded packets;

Type: string

Supported Values: drop, forward, all

capture-config-name

Description Capture-config name

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

port-list_pattern-recognition-pu-details¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

port-list_port-ind¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

port-list_signature-extraction¶

Specification Value

Type object

algorithm

Description ‘heuristic’: heuristic algorithm;

Type: string

Supported Values: heuristic

manual-mode

Description Enable manual mode

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

port-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS tcp template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

udp

Description DDOS udp template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

port-list_glid-exceed-action¶

Specification Value

Type object

stateless-encap-action-cfg

Description: stateless-encap-action-cfg is a JSON Block. Please see below for port-list_glid-exceed-action_stateless-encap-action-cfg

Type: Object

port-list_glid-exceed-action_stateless-encap-action-cfg¶

Specification Value

Type object

encap-template

Description Apply legacy encap template for encap action

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ddos/template/encap

stateless-encap-action

Description ‘stateless-tunnel-encap’: Encapsulate all packets; ‘stateless-tunnel-encap-scrubbed’: Encapsulate all packets and allow packets to go through other DDoS checks before sent (conn-limit exceeded packet can not be scrubbed, it will default to stateless-tunnel-encap);

Type: string

Supported Values: stateless-tunnel-encap, stateless-tunnel-encap-scrubbed

port-list_topk-sources¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

capture-config-list¶

Specification Value

Type list

Block object keys

mode

Description ‘drop’: Apply capture-config to dropped packets; ‘forward’: Apply capture-config to forwarded packets; ‘all’: Apply capture-config to both dropped and forwarded packets;

Type: string

Supported Values: drop, forward, all

name

Description Capture-config name

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/capture-config

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

dynamic-entry-overflow-policy-list¶

Specification Value

Type list

Block object keys

app-type-src-dst-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/dynamic-entry-overflow-policy/{dummy-name}/app-type-src-dst/{protocol}

bypass

Description Always permit for the Source to bypass all feature & limit checks

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dummy-name

Description ‘configuration’: Configure src dst dynamic entry count overflow policy;

Type: string

Supported Values: configuration

exceed-log-cfg

Description: exceed-log-cfg is a JSON Block. Please see below for dynamic-entry-overflow-policy-list_exceed-log-cfg

Type: Object

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

l4-type-src-dst-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/dynamic-entry-overflow-policy/{dummy-name}/l4-type-src-dst/{protocol}

log-periodic

Description Enable periodic log while event is continuing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

template

Description: template is a JSON Block. Please see below for dynamic-entry-overflow-policy-list_template

Type: Object

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

dynamic-entry-overflow-policy-list_template¶

Specification Value

Type object

logging

Description DDOS logging template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

dynamic-entry-overflow-policy-list_app-type-src-dst-list¶

Specification Value

Type list

Block object keys

protocol

Description ‘dns’: dns; ‘http’: http; ‘ssl-l4’: ssl-l4; ‘sip’: sip;

Type: string

Supported Values: dns, http, ssl-l4, sip

template

Description: template is a JSON Block. Please see below for dynamic-entry-overflow-policy-list_app-type-src-dst-list_template

Type: Object

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

dynamic-entry-overflow-policy-list_app-type-src-dst-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

dynamic-entry-overflow-policy-list_l4-type-src-dst-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

protocol

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp; ‘other’: other;

Type: string

Supported Values: tcp, udp, icmp, other

template

Description: template is a JSON Block. Please see below for dynamic-entry-overflow-policy-list_l4-type-src-dst-list_template

Type: Object

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

dynamic-entry-overflow-policy-list_l4-type-src-dst-list_template¶

Specification Value

Type object

other

Description DDOS OTHER template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS TCP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v4

Description DDOS icmp-v4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v4 and template-icmp-v6 are mutually exclusive

template-icmp-v6

Description DDOS icmp-v6 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v6 and template-icmp-v4 are mutually exclusive

udp

Description DDOS UDP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

dynamic-entry-overflow-policy-list_exceed-log-cfg¶

Specification Value

Type object

log-enable

Description Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-range-list¶

Specification Value

Type list

Block object keys

capture-config

Description: capture-config is a JSON Block. Please see below for port-range-list_capture-config

Type: Object

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

detection-enable

Description Enable ddos detection

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enable-top-k

Description Enable ddos top-k entries

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

glid-exceed-action

Description: glid-exceed-action is a JSON Block. Please see below for port-range-list_glid-exceed-action

Type: Object

ip-filtering-policy

Description Configure IP Filter

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ddos/ip-filtering-policy

pattern-recognition

Description: pattern-recognition is a JSON Block. Please see below for port-range-list_pattern-recognition

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition

pattern-recognition-pu-details

Description: pattern-recognition-pu-details is a JSON Block. Please see below for port-range-list_pattern-recognition-pu-details

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition-pu-details

port-ind

Description: port-ind is a JSON Block. Please see below for port-range-list_port-ind

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/port-ind

port-range-end

Description Port-Range End Port Number

Type: number

Range: 1-65535

port-range-start

Description Port-Range Start Port Number

Type: number

Range: 1-65535

protocol

Description ‘dns-tcp’: DNS-TCP Port; ‘dns-udp’: DNS-UDP Port; ‘http’: HTTP Port; ‘tcp’: TCP Port; ‘udp’: UDP Port; ‘ssl-l4’: SSL-L4 Port; ‘sip-udp’: SIP-UDP Port; ‘sip-tcp’: SIP-TCP Port;

Type: string

Supported Values: dns-tcp, dns-udp, http, tcp, udp, ssl-l4, sip-udp, sip-tcp

sflow

Description: sflow is a JSON Block. Please see below for port-range-list_sflow

Type: Object

template

Description: template is a JSON Block. Please see below for port-range-list_template

Type: Object

topk-num-records

Description Maximum number of records to show in topk

Type: number

Range: 1-100

Default: 20

topk-sort-key

Description ‘avg’: window average; ‘max-peak’: max peak;

Type: string

Supported Values: avg, max-peak

Default: avg

topk-sources

Description: topk-sources is a JSON Block. Please see below for port-range-list_topk-sources

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/topk-sources

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

port-range-list_pattern-recognition¶

Specification Value

Type object

algorithm

Description ‘heuristic’: heuristic algorithm;

Type: string

Supported Values: heuristic

mode

Description ‘capture-never-expire’: War-time capture without rate exceeding and never expires; ‘manual’: Manual mode;

Type: string

Supported Values: capture-never-expire, manual

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

port-range-list_pattern-recognition-pu-details¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

port-range-list_capture-config¶

Specification Value

Type object

capture-config-mode

Description ‘drop’: Apply capture-config to dropped packets; ‘forward’: Apply capture-config to forwarded packets; ‘all’: Apply capture-config to both dropped and forwarded packets;

Type: string

Supported Values: drop, forward, all

capture-config-name

Description Capture-config name

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

port-range-list_sflow¶

Specification Value

Type object

polling

Description: polling is a JSON Block. Please see below for port-range-list_sflow_polling

Type: Object

port-range-list_sflow_polling¶

Specification Value

Type object

sflow-http

Description Enable sFlow HTTP counter polling

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-packets

Description Enable sFlow packet-level counter polling

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-tcp

Description: sflow-tcp is a JSON Block. Please see below for port-range-list_sflow_polling_sflow-tcp

Type: Object

port-range-list_sflow_polling_sflow-tcp¶

Specification Value

Type object

sflow-tcp-basic

Description Enable sFlow basic TCP counter polling

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-tcp-stateful

Description Enable sFlow stateful TCP counter polling

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-range-list_port-ind¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

port-range-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS tcp template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

udp

Description DDOS udp template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

port-range-list_glid-exceed-action¶

Specification Value

Type object

stateless-encap-action-cfg

Description: stateless-encap-action-cfg is a JSON Block. Please see below for port-range-list_glid-exceed-action_stateless-encap-action-cfg

Type: Object

port-range-list_glid-exceed-action_stateless-encap-action-cfg¶

Specification Value

Type object

encap-template

Description Apply legacy encap template for encap action

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ddos/template/encap

stateless-encap-action

Description ‘stateless-tunnel-encap’: Encapsulate all packets; ‘stateless-tunnel-encap-scrubbed’: Encapsulate all packets and allow packets to go through other DDoS checks before sent (conn-limit exceeded packet can not be scrubbed, it will default to stateless-tunnel-encap);

Type: string

Supported Values: stateless-tunnel-encap, stateless-tunnel-encap-scrubbed

port-range-list_topk-sources¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

hw-blacklist-blocking¶

Specification Value

Type object

dst-enable

Description Enable Dst side hardware blocking

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

src-enable

Description Enable Src side hardware blocking

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

src-dst-pair-class-list-list¶

Specification Value

Type list

Block object keys

app-type-src-dst-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}/app-type-src-dst/{protocol}

cid-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}/cid/{cid-num}

class-list-name

Description Class-list name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

exceed-log-cfg

Description: exceed-log-cfg is a JSON Block. Please see below for src-dst-pair-class-list-list_exceed-log-cfg

Type: Object

l4-type-src-dst-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}/l4-type-src-dst/{protocol}

log-periodic

Description Enable periodic log while event is continuing

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

src-dst-pair-class-list-list_cid-list¶

Specification Value

Type list

Block object keys

app-type-src-dst-cid-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}/cid/{cid-num}/app-type-src-dst-cid/{protocol}

cid-num

Description Class-list id

Type: number

Range: 1-32

exceed-log-cfg

Description: exceed-log-cfg is a JSON Block. Please see below for src-dst-pair-class-list-list_cid-list_exceed-log-cfg

Type: Object

l4-type-src-dst-cid-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}/cid/{cid-num}/l4-type-src-dst-cid/{protocol}

log-periodic

Description Enable periodic log while event is continuing

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

src-dst-pair-class-list-list_cid-list_app-type-src-dst-cid-list¶

Specification Value

Type list

Block object keys

protocol

Description ‘dns’: dns; ‘http’: http; ‘ssl-l4’: ssl-l4; ‘sip’: sip;

Type: string

Supported Values: dns, http, ssl-l4, sip

template

Description: template is a JSON Block. Please see below for src-dst-pair-class-list-list_cid-list_app-type-src-dst-cid-list_template

Type: Object

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

src-dst-pair-class-list-list_cid-list_app-type-src-dst-cid-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair-class-list-list_cid-list_l4-type-src-dst-cid-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

protocol

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp; ‘other’: other;

Type: string

Supported Values: tcp, udp, icmp, other

template

Description: template is a JSON Block. Please see below for src-dst-pair-class-list-list_cid-list_l4-type-src-dst-cid-list_template

Type: Object

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

src-dst-pair-class-list-list_cid-list_l4-type-src-dst-cid-list_template¶

Specification Value

Type object

other

Description DDOS OTHER template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS TCP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v4

Description DDOS icmp-v4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v4 and template-icmp-v6 are mutually exclusive

template-icmp-v6

Description DDOS icmp-v6 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v6 and template-icmp-v4 are mutually exclusive

udp

Description DDOS UDP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair-class-list-list_cid-list_exceed-log-cfg¶

Specification Value

Type object

log-enable

Description Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

src-dst-pair-class-list-list_app-type-src-dst-list¶

Specification Value

Type list

Block object keys

protocol

Description ‘dns’: dns; ‘http’: http; ‘ssl-l4’: ssl-l4; ‘sip’: sip;

Type: string

Supported Values: dns, http, ssl-l4, sip

template

Description: template is a JSON Block. Please see below for src-dst-pair-class-list-list_app-type-src-dst-list_template

Type: Object

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

src-dst-pair-class-list-list_app-type-src-dst-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair-class-list-list_l4-type-src-dst-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

protocol

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp; ‘other’: other;

Type: string

Supported Values: tcp, udp, icmp, other

template

Description: template is a JSON Block. Please see below for src-dst-pair-class-list-list_l4-type-src-dst-list_template

Type: Object

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

src-dst-pair-class-list-list_l4-type-src-dst-list_template¶

Specification Value

Type object

other

Description DDOS OTHER template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS TCP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v4

Description DDOS icmp-v4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v4 and template-icmp-v6 are mutually exclusive

template-icmp-v6

Description DDOS icmp-v6 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v6 and template-icmp-v4 are mutually exclusive

udp

Description DDOS UDP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair-class-list-list_exceed-log-cfg¶

Specification Value

Type object

log-enable

Description Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

template¶

Specification Value

Type object

logging

Description DDOS logging template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

glid-exceed-action¶

Specification Value

Type object

stateless-encap-action-cfg

Description: stateless-encap-action-cfg is a JSON Block. Please see below for glid-exceed-action_stateless-encap-action-cfg

Type: Object

glid-exceed-action_stateless-encap-action-cfg¶

Specification Value

Type object

encap-template

Description Apply legacy encap template for encap action

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ddos/template/encap

stateless-encap-action

Description ‘stateless-tunnel-encap’: Encapsulate all packets; ‘stateless-tunnel-encap-scrubbed’: Encapsulate all packets and allow packets to go through other DDoS checks before sent (conn-limit exceeded packet can not be scrubbed, it will default to stateless-tunnel-encap);

Type: string

Supported Values: stateless-tunnel-encap, stateless-tunnel-encap-scrubbed

l4-type-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

detection-enable

Description Enable ddos detection

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

drop-on-no-port-match

Description ‘disable’: disable; ‘enable’: enable;

Type: string

Supported Values: disable, enable

Default: enable

enable-top-k

Description Enable ddos top-k entries

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

glid-exceed-action

Description: glid-exceed-action is a JSON Block. Please see below for l4-type-list_glid-exceed-action

Type: Object

max-rexmit-syn-per-flow

Description Maximum number of re-transmit SYN per flow

Type: number

Range: 1-6

max-rexmit-syn-per-flow-exceed-action

Description ‘drop’: Drop the packet; ‘black-list’: Add the source IP into black list;

Type: string

Supported Values: drop, black-list

port-ind

Description: port-ind is a JSON Block. Please see below for l4-type-list_port-ind

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/l4-type/{protocol}/port-ind

protocol

Description ‘tcp’: L4-Type TCP; ‘udp’: L4-Type UDP; ‘icmp’: L4-Type ICMP; ‘other’: L4-Type OTHER;

Type: string

Supported Values: tcp, udp, icmp, other

stateful

Description Enable stateful tracking of sessions (Default is stateless)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

syn-auth

Description ‘send-rst’: Send RST to client upon client ACK; ‘force-rst-by-ack’: Force client RST via the use of ACK; ‘force-rst-by-synack’: Force client RST via the use of bad SYN|ACK; ‘disable’: Disable TCP SYN Authentication;

Type: string

Supported Values: send-rst, force-rst-by-ack, force-rst-by-synack, disable

Default: send-rst

syn-cookie

Description Enable SYN Cookie

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tcp-reset-client

Description Send reset to client when rate exceeds or session ages out

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tcp-reset-server

Description Send reset to server when rate exceeds or session ages out

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

template

Description: template is a JSON Block. Please see below for l4-type-list_template

Type: Object

topk-num-records

Description Maximum number of records to show in topk

Type: number

Range: 1-100

Default: 20

topk-sort-key

Description ‘avg’: window average; ‘max-peak’: max peak;

Type: string

Supported Values: avg, max-peak

Default: avg

topk-sources

Description: topk-sources is a JSON Block. Please see below for l4-type-list_topk-sources

Type: Object

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/l4-type/{protocol}/topk-sources

tunnel-decap

Description: tunnel-decap is a JSON Block. Please see below for l4-type-list_tunnel-decap

Type: Object

tunnel-rate-limit

Description: tunnel-rate-limit is a JSON Block. Please see below for l4-type-list_tunnel-rate-limit

Type: Object

undefined-port-hit-statistics

Description: undefined-port-hit-statistics is a JSON Block. Please see below for l4-type-list_undefined-port-hit-statistics

Type: Object

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

l4-type-list_undefined-port-hit-statistics¶

Specification Value

Type object

reset-interval

Description Configure port scanning counter reset interval (minutes), Default 60 mins

Type: number

Range: 1-64000

Default: 60

undefined-port-hit-statistics

Description Enable port scanning statistics

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l4-type-list_template¶

Specification Value

Type object

template-icmp-v4

Description DDOS icmp-v4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v4 and template-icmp-v6 are mutually exclusive

template-icmp-v6

Description DDOS icmp-v6 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v6 and template-icmp-v4 are mutually exclusive

l4-type-list_glid-exceed-action¶

Specification Value

Type object

stateless-encap-action-cfg

Description: stateless-encap-action-cfg is a JSON Block. Please see below for l4-type-list_glid-exceed-action_stateless-encap-action-cfg

Type: Object

l4-type-list_glid-exceed-action_stateless-encap-action-cfg¶

Specification Value

Type object

encap-template

Description Apply legacy encap template for encap action

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ddos/template/encap

stateless-encap-action

Description ‘stateless-tunnel-encap’: Encapsulate all packets; ‘stateless-tunnel-encap-scrubbed’: Encapsulate all packets and allow packets to go through other DDoS checks before sent (conn-limit exceeded packet can not be scrubbed, it will default to stateless-tunnel-encap);

Type: string

Supported Values: stateless-tunnel-encap, stateless-tunnel-encap-scrubbed

l4-type-list_tunnel-decap¶

Specification Value

Type object

gre-decap

Description Enable GRE Tunnel decapsulation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-decap

Description Enable IP Tunnel decapsulation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

key-cfg

Type: List

l4-type-list_tunnel-decap_key-cfg¶

Specification Value

Type list

Block object keys

key

Description Only decapsulate GRE packet with this key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)

Type: string

Maximum Length: 10 characters

Maximum Length: 1 characters

l4-type-list_port-ind¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

l4-type-list_topk-sources¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

l4-type-list_tunnel-rate-limit¶

Specification Value

Type object

gre-rate-limit

Description Enable inner IP rate limiting on GRE traffic

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-rate-limit

Description Enable inner IP rate limiting on IPinIP traffic

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

topk-destinations¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

src-dst-pair-settings-list¶

Specification Value

Type list

Block object keys

age

Description Idle age for ip entry

Type: number

Range: 2-1023

Default: 5

all-types

Description ‘all-types’: Settings for all types (default or class-list);

Type: string

Supported Values: all-types

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

enable-class-list-overflow

Description Apply class-list overflow policy upon exceeding dynamic entry count specified for DST entry or each class-list

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l4-type-src-dst-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-settings/{all-types}/l4-type-src-dst/{protocol}

max-dynamic-entry-count

Description Maximum count for dynamic src-dst entry

Type: number

Range: 0-2147483647

src-prefix-len

Description Specify src prefix length for IPv6 (default: not set)

Type: number

Range: 32-127

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

src-dst-pair-settings-list_l4-type-src-dst-list¶

Specification Value

Type list

Block object keys

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

max-dynamic-entry-count

Description Maximum count for dynamic src-dst entry

Type: number

Range: 0-2147483647

protocol

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp; ‘other’: other;

Type: string

Supported Values: tcp, udp, icmp, other

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

src-port-range-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

protocol

Description ‘udp’: UDP Port; ‘tcp’: TCP Port;

Type: string

Supported Values: udp, tcp

src-port-range-end

Description Src Port-Range End Port Number

Type: number

Range: 2-65535

src-port-range-start

Description Src Port-Range Start Port Number

Type: number

Range: 1-65535

template

Description: template is a JSON Block. Please see below for src-port-range-list_template

Type: Object

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

src-port-range-list_template¶

Specification Value

Type object

src-tcp

Description DDOS tcp src template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-udp

Description DDOS udp src template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ip-proto-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

esp-inspect

Description: esp-inspect is a JSON Block. Please see below for ip-proto-list_esp-inspect

Type: Object

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

glid-exceed-action

Description: glid-exceed-action is a JSON Block. Please see below for ip-proto-list_glid-exceed-action

Type: Object

ip-filtering-policy

Description Configure IP Filter

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ddos/ip-filtering-policy

port-num

Description Protocol Number

Type: number

Range: 0-255

template

Description: template is a JSON Block. Please see below for ip-proto-list_template

Type: Object

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

ip-proto-list_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

ip-proto-list_template¶

Specification Value

Type object

other

Description DDOS other template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ip-proto-list_glid-exceed-action¶

Specification Value

Type object

stateless-encap-action-cfg

Description: stateless-encap-action-cfg is a JSON Block. Please see below for ip-proto-list_glid-exceed-action_stateless-encap-action-cfg

Type: Object

ip-proto-list_glid-exceed-action_stateless-encap-action-cfg¶

Specification Value

Type object

encap-template

Description Apply legacy encap template for encap action

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ddos/template/encap

stateless-encap-action

Description ‘stateless-tunnel-encap’: Encapsulate all packets; ‘stateless-tunnel-encap-scrubbed’: Encapsulate all packets and allow packets to go through other DDoS checks before sent (conn-limit exceeded packet can not be scrubbed, it will default to stateless-tunnel-encap);

Type: string

Supported Values: stateless-tunnel-encap, stateless-tunnel-encap-scrubbed

src-port-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

outbound-src-tracking

Description ‘enable’: enable; ‘disable’: disable;

Type: string

Supported Values: enable, disable

Default: disable

port-num

Description Port Number

Type: number

Range: 0-65535

protocol

Description ‘dns-udp’: DNS-UDP Port; ‘dns-tcp’: DNS-TCP Port; ‘udp’: UDP Port; ‘tcp’: TCP Port;

Type: string

Supported Values: dns-udp, dns-tcp, udp, tcp

template

Description: template is a JSON Block. Please see below for src-port-list_template

Type: Object

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

src-port-list_template¶

Specification Value

Type object

src-dns

Description DDOS dns src template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-tcp

Description DDOS tcp src template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-udp

Description DDOS udp src template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

exceed-log-cfg¶

Specification Value

Type object

log-enable

Description Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log-high-frequency

Description Enable High frequency logging for non-event logs per entry

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log-with-sflow

Description Turn on sflow sample with log

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rate-limit

Description Rate limit per second per entry(Default : 1 per second)

Type: number

Range: 1-1000

Default: 1

sflow¶

Specification Value

Type object

collector

Type: List

polling

Description: polling is a JSON Block. Please see below for sflow_polling

Type: Object

sflow_collector¶

Specification Value

Type list

Block object keys

sflow-name

Description Name of configured custom sFlow collector

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/sflow/collector/custom

sflow_polling¶

Specification Value

Type object

sflow-http

Description Enable sFlow HTTP counter polling. WARNING: Entry level Sflow polling might induce heavy CPU load depending on the total number

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-layer-4

Description Enable sFlow Layer 4 counter polling. WARNING: Entry level Sflow polling might induce heavy CPU load depending on the total num

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-packets

Description Enable sFlow packet-level counter polling. WARNING: Entry level Sflow polling might induce heavy CPU load depending on the tota

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-tcp

Description: sflow-tcp is a JSON Block. Please see below for sflow_polling_sflow-tcp

Type: Object

sflow-undef-port-hit-stats

Description Enable sFlow undefined-port-hit-statistics polling

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-undef-port-hit-stats-brief

Description Enable sFlow undefined-port-hit-statistics polling in brief mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow_polling_sflow-tcp¶

Specification Value

Type object

sflow-tcp-basic

Description Enable sFlow basic TCP counter polling. WARNING: Entry level Sflow polling might induce heavy CPU load depending on the total n

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sflow-tcp-stateful

Description Enable sFlow stateful TCP counter polling. WARNING: Entry level Sflow polling might induce heavy CPU load depending on the tota

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

src-dst-pair¶

Specification Value

Type object

app-type-src-dst-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair/app-type-src-dst/{protocol}

bypass

Description Always permit for the Source to bypass all feature & limit checks

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

default

Description Configure default

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

exceed-log-cfg

Description: exceed-log-cfg is a JSON Block. Please see below for src-dst-pair_exceed-log-cfg

Type: Object

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

l4-type-src-dst-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair/l4-type-src-dst/{protocol}

log-periodic

Description Enable periodic log while event is continuing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

template

Description: template is a JSON Block. Please see below for src-dst-pair_template

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

src-dst-pair_template¶

Specification Value

Type object

logging

Description DDOS logging template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair_app-type-src-dst-list¶

Specification Value

Type list

Block object keys

protocol

Description ‘dns’: dns; ‘http’: http; ‘ssl-l4’: ssl-l4; ‘sip’: sip;

Type: string

Supported Values: dns, http, ssl-l4, sip

template

Description: template is a JSON Block. Please see below for src-dst-pair_app-type-src-dst-list_template

Type: Object

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

src-dst-pair_app-type-src-dst-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair_l4-type-src-dst-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

protocol

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp; ‘other’: other;

Type: string

Supported Values: tcp, udp, icmp, other

template

Description: template is a JSON Block. Please see below for src-dst-pair_l4-type-src-dst-list_template

Type: Object

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

src-dst-pair_l4-type-src-dst-list_template¶

Specification Value

Type object

other

Description DDOS OTHER template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS TCP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v4

Description DDOS icmp-v4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v4 and template-icmp-v6 are mutually exclusive

template-icmp-v6

Description DDOS icmp-v6 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v6 and template-icmp-v4 are mutually exclusive

udp

Description DDOS UDP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair_exceed-log-cfg¶

Specification Value

Type object

log-enable

Description Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

src-dst-pair-policy-list¶

Specification Value

Type list

Block object keys

policy-class-list-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}

src-based-policy-name

Description Src-based-policy name

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

src-dst-pair-policy-list_policy-class-list-list¶

Specification Value

Type list

Block object keys

app-type-src-dst-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/app-type-src-dst/{protocol}

bypass

Description Always permit for the Source to bypass all feature & limit checks

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}

exceed-log-cfg

Description: exceed-log-cfg is a JSON Block. Please see below for src-dst-pair-policy-list_policy-class-list-list_exceed-log-cfg

Type: Object

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

l4-type-src-dst-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/l4-type-src-dst/{protocol}

log-periodic

Description Enable periodic log while event is continuing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

max-dynamic-entry-count

Description Maximum count for dynamic src-dst entry under class-list

Type: number

Range: 0-2147483647

template

Description: template is a JSON Block. Please see below for src-dst-pair-policy-list_policy-class-list-list_template

Type: Object

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

src-dst-pair-policy-list_policy-class-list-list_template¶

Specification Value

Type object

logging

Description DDOS logging template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair-policy-list_policy-class-list-list_app-type-src-dst-list¶

Specification Value

Type list

Block object keys

protocol

Description ‘dns’: dns; ‘http’: http; ‘ssl-l4’: ssl-l4; ‘sip’: sip;

Type: string

Supported Values: dns, http, ssl-l4, sip

template

Description: template is a JSON Block. Please see below for src-dst-pair-policy-list_policy-class-list-list_app-type-src-dst-list_template

Type: Object

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

src-dst-pair-policy-list_policy-class-list-list_app-type-src-dst-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair-policy-list_policy-class-list-list_l4-type-src-dst-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

protocol

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp; ‘other’: other;

Type: string

Supported Values: tcp, udp, icmp, other

template

Description: template is a JSON Block. Please see below for src-dst-pair-policy-list_policy-class-list-list_l4-type-src-dst-list_template

Type: Object

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

src-dst-pair-policy-list_policy-class-list-list_l4-type-src-dst-list_template¶

Specification Value

Type object

other

Description DDOS OTHER template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS TCP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v4

Description DDOS icmp-v4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v4 and template-icmp-v6 are mutually exclusive

template-icmp-v6

Description DDOS icmp-v6 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v6 and template-icmp-v4 are mutually exclusive

udp

Description DDOS UDP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list¶

Specification Value

Type list

Block object keys

app-type-src-dst-overflow-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}/app-type-src-dst-overflow/{protocol}

bypass

Description Always permit for the Source to bypass all feature & limit checks

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dummy-name

Description ‘configuration’: Configure src dst dynamic entry count overflow policy for class-list;

Type: string

Supported Values: configuration

exceed-log-cfg

Description: exceed-log-cfg is a JSON Block. Please see below for src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list_exceed-log-cfg

Type: Object

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

l4-type-src-dst-overflow-list

Type: List

Reference Object: /axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}/l4-type-src-dst-overflow/{protocol}

log-periodic

Description Enable periodic log while event is continuing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

template

Description: template is a JSON Block. Please see below for src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list_template

Type: Object

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

src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list_template¶

Specification Value

Type object

logging

Description DDOS logging template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list_l4-type-src-dst-overflow-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

protocol

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp; ‘other’: other;

Type: string

Supported Values: tcp, udp, icmp, other

template

Description: template is a JSON Block. Please see below for src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list_l4-type-src-dst-overflow-list_template

Type: Object

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

src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list_l4-type-src-dst-overflow-list_template¶

Specification Value

Type object

other

Description DDOS OTHER template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS TCP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v4

Description DDOS icmp-v4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v4 and template-icmp-v6 are mutually exclusive

template-icmp-v6

Description DDOS icmp-v6 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: template-icmp-v6 and template-icmp-v4 are mutually exclusive

udp

Description DDOS UDP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list_app-type-src-dst-overflow-list¶

Specification Value

Type list

Block object keys

protocol

Description ‘dns’: dns; ‘http’: http; ‘ssl-l4’: ssl-l4; ‘sip’: sip;

Type: string

Supported Values: dns, http, ssl-l4, sip

template

Description: template is a JSON Block. Please see below for src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list_app-type-src-dst-overflow-list_template

Type: Object

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

src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list_app-type-src-dst-overflow-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst-pair-policy-list_policy-class-list-list_class-list-overflow-policy-list_exceed-log-cfg¶

Specification Value

Type object

log-enable

Description Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

src-dst-pair-policy-list_policy-class-list-list_exceed-log-cfg¶

Specification Value

Type object

log-enable

Description Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enable-top-k¶

Specification Value

Type list

Block object keys

topk-num-records

Description Maximum number of records to show in topk

Type: number

Range: 1-100

Default: 20

topk-sort-key

Description ‘avg’: window average; ‘max-peak’: max peak;

Type: string

Supported Values: avg, max-peak

Default: avg

topk-type

Description ‘destination’: Topk destination IP;

Type: string

Supported Values: destination

exceed-log-dep-cfg¶

Specification Value

Type object

exceed-log-enable

Description (Deprecated)Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log-with-sflow-dep

Description Turn on sflow sample with log

Type: boolean

Supported Values: true, false, 1, 0

Default: 0