ddos zone-template icmp-v4¶

ICMPv4 template Configuration

icmp-v4 Specification¶

Parameter Value

Type Collection

Object Key(s) icmp-tmpl-name

Collection Name icmp-v4-list

Collection URI /axapi/v3/ddos/zone-template/icmp-v4

Element Name icmp-v4

Element URI /axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}

Element Attributes icmp-v4_attributes

Partition Visibility shared

Schema icmp-v4 schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ddos/zone-template/icmp-v4	icmp-v4 attributes
POST /axapi/v3/ddos/zone-template/icmp-v4/ Payload: { "icmp-v4": { "icmp-tmpl-name": "a" } }
Create List	POST	/axapi/v3/ddos/zone-template/icmp-v4	icmp-v4 attributes
Get Object	GET	/axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}	icmp-v4 attributes
GET /axapi/v3/ddos/zone-template/icmp-v4/a Reponse: { "icmp-v4": { "icmp-tmpl-name": "a", "uuid": "0fa8f1ba-1b81-11ee-8061-96e2e08a4638", "a10-url": "/axapi/v3/ddos/zone-template/icmp-v4/a" } }
Get List	GET	/axapi/v3/ddos/zone-template/icmp-v4	icmp-v4-list
Modify Object	POST	/axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}	icmp-v4 attributes
Replace Object	PUT	/axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}	icmp-v4 attributes
PUT /axapi/v3/ddos/zone-template/icmp-v4/a Payload: { "icmp-v4": { "icmp-tmpl-name": "a" } }
Replace List	PUT	/axapi/v3/ddos/zone-template/icmp-v4	icmp-v4-list
Delete Object	DELETE	/axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}	icmp-v4 attributes
DELETE /axapi/v3/ddos/zone-template/icmp-v4/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

icmp-v4-list¶

icmp-v4-list is JSON List of icmp-v4 attributes

icmp-v4-list : [

{ icmp-v4 attributes },

{ icmp-v4 attributes },

…

]

icmp-v4 attributes¶

filter-list

Type: List

Reference Object: /axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}/filter/{icmp-filter-name}

icmp-tmpl-name

Description DDOS ICMPv4 Template Name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

type-list

Type: List

Reference Object: /axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}/type/{type-number}

type-other

Description: type-other is a JSON Block. Please see below for type-other

Type: Object

Reference Object: /axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}/type-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

type-list¶

Specification Value

Type list

Block object keys

dst-code-other-rate

Description Specify the rate with other code

Type: number

Range: 1-16000000

dst-code-other-rate-action

Description ‘drop’: Drop packets for rate exceed (Default); ‘blacklist-src’: Blacklist-src for rate exceed; ‘ignore’: Do nothing for rate exceed;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: dst-code-other-rate-action and dst-code-other-rate-action-list-name are mutually exclusive

dst-code-other-rate-action-list-name

Description Configure action-list to take for rate exceed

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: dst-code-other-rate-action-list-name and dst-code-other-rate-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

icmp-type-action

Description ‘drop’: Reject this ICMP type; ‘blacklist-src’: Blacklist-src this ICMP type; ‘ignore’: Ignore this ICMP type;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: icmp-type-action and icmp-type-action-list-name are mutually exclusive

icmp-type-action-list-name

Description Configure action-list to take for this ICMP type

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: icmp-type-action-list-name and icmp-type-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

src-code-other-rate

Description Specify the rate with other code

Type: number

Range: 1-16000000

src-code-other-rate-action

Description ‘drop’: Drop packets for rate exceed (Default); ‘blacklist-src’: Blacklist-src for rate exceed; ‘ignore’: Do nothing for rate exceed;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: src-code-other-rate-action and src-code-other-rate-action-list-name are mutually exclusive

src-code-other-rate-action-list-name

Description Configure action-list to take for rate exceed

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: src-code-other-rate-action-list-name and src-code-other-rate-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

type-number

Description Specify ICMP type number

Type: number

Range: 0-255

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

v4-dst-code-cfg

Type: List

v4-dst-rate-cfg

Description: v4-dst-rate-cfg is a JSON Block. Please see below for type-list_v4-dst-rate-cfg

Type: Object

v4-src-code-cfg

Type: List

v4-src-rate-cfg

Description: v4-src-rate-cfg is a JSON Block. Please see below for type-list_v4-src-rate-cfg

Type: Object

type-list_v4-src-rate-cfg¶

Specification Value

Type object

src-type-rate

Description Specify the whole src rate for this type

Type: number

Range: 1-16000000

src-type-rate-action

Description ‘drop’: Drop packets for rate exceed (Default); ‘blacklist-src’: Blacklist-src for rate exceed; ‘ignore’: Do nothing for rate exceed;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: src-type-rate-action and src-type-rate-action-list-name are mutually exclusive

src-type-rate-action-list-name

Description Configure action-list to take for rate exceed

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: src-type-rate-action-list-name and src-type-rate-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

type-list_v4-dst-code-cfg¶

Specification Value

Type list

Block object keys

dst-code-number

Description Specify the ICMP code for this dst rate

Type: number

Range: 0-255

dst-code-rate

Description Specify the rate with the code

Type: number

Range: 1-16000000

dst-code-rate-action

Description ‘drop’: Drop packets for rate exceed (Default); ‘blacklist-src’: Blacklist-src for rate exceed; ‘ignore’: Do nothing for rate exceed;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: dst-code-rate-action and dst-code-rate-action-list-name are mutually exclusive

dst-code-rate-action-list-name

Description Configure action-list to take for rate exceed

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: dst-code-rate-action-list-name and dst-code-rate-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

type-list_v4-src-code-cfg¶

Specification Value

Type list

Block object keys

src-code-number

Description Specify the ICMP code for this src rate

Type: number

Range: 0-255

src-code-rate

Description Specify the rate with the code

Type: number

Range: 1-16000000

src-code-rate-action

Description ‘drop’: Drop packets for rate exceed (Default); ‘blacklist-src’: Blacklist-src for rate exceed; ‘ignore’: Do nothing for rate exceed;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: src-code-rate-action and src-code-rate-action-list-name are mutually exclusive

src-code-rate-action-list-name

Description Configure action-list to take for rate exceed

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: src-code-rate-action-list-name and src-code-rate-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

type-list_v4-dst-rate-cfg¶

Specification Value

Type object

dst-type-rate

Description Specify the whole dst rate for this type

Type: number

Range: 1-16000000

dst-type-rate-action

Description ‘drop’: Drop packets for rate exceed (Default); ‘blacklist-src’: Blacklist-src for rate exceed; ‘ignore’: Do nothing for rate exceed;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: dst-type-rate-action and dst-type-rate-action-list-name are mutually exclusive

dst-type-rate-action-list-name

Description Configure action-list to take for rate exceed

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: dst-type-rate-action-list-name and dst-type-rate-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

type-other¶

Specification Value

Type object

dst

Description: dst is a JSON Block. Please see below for type-other_dst

Type: Object

icmp-type-other-action

Description ‘drop’: Reject wildcard ICMP type; ‘blacklist-src’: Blacklist-src wildcard ICMP type; ‘ignore’: Ignore wildcard ICMP type;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: icmp-type-other-action and icmp-type-other-action-list-name are mutually exclusive

icmp-type-other-action-list-name

Description Configure action-list to take for wildcard ICMP match

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: icmp-type-other-action-list-name and icmp-type-other-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

src

Description: src is a JSON Block. Please see below for type-other_src

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

type-other_src¶

Specification Value

Type object

src-type-other-rate

Description Specify the whole src rate for wildcard ICMP type

Type: number

Range: 1-16000000

src-type-other-rate-action

Description ‘drop’: Drop packets for rate exceed (Default); ‘blacklist-src’: Blacklist-src for rate exceed; ‘ignore’: Do nothing for rate exceed;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: src-type-other-rate-action and src-type-other-rate-action-list-name are mutually exclusive

src-type-other-rate-action-list-name

Description Configure action-list to take for rate exceed

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: src-type-other-rate-action-list-name and src-type-other-rate-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

type-other_dst¶

Specification Value

Type object

dst-type-other-rate

Description Specify the whole dst rate for wildcard ICMP type

Type: number

Range: 1-16000000

dst-type-other-rate-action

Description ‘drop’: Drop packets for rate exceed (Default); ‘blacklist-src’: Blacklist-src for rate exceed; ‘ignore’: Do nothing for rate exceed;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: dst-type-other-rate-action and dst-type-other-rate-action-list-name are mutually exclusive

dst-type-other-rate-action-list-name

Description Configure action-list to take for rate exceed

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: dst-type-other-rate-action-list-name and dst-type-other-rate-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

filter-list¶

Specification Value

Type list

Block object keys

byte-offset-filter

Description filter using Berkeley packet filter syntax

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

icmp-filter-action

Description ‘drop’: Drop packets (Default); ‘ignore’: Take no action; ‘blacklist-src’: Blacklist-src;

Type: string

Supported Values: drop, ignore, blacklist-src

Default: drop

Mutual Exclusion: icmp-filter-action and icmp-filter-action-list-name are mutually exclusive

icmp-filter-action-list-name

Description Configure action-list to take

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: icmp-filter-action-list-name and icmp-filter-action are mutually exclusive

icmp-filter-inverse-match

Description Inverse the result of matching

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

icmp-filter-name

Description

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

icmp-filter-regex

Description Regex Expression

Type: string

Format: string-rlx

Maximum Length: 1275 characters

Maximum Length: 1 characters

icmp-filter-seq

Description sequence number

Type: number

Range: 1-200

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