ddos src entry¶
Configure IP/IPv6 static Entry
entry Specification¶
Type
Collection
Object Key(s)
src-entry-name
Collection Name
Collection URI
/axapi/v3/ddos/src/entry
Element Name
entry
Element URI
/axapi/v3/ddos/src/entry/{src-entry-name}
Element Attributes
entry_attributes
Operational Data URI
/axapi/v3/ddos/src/entry/{src-entry-name}/oper
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/ddos/src/entry | ||
Create List | POST | /axapi/v3/ddos/src/entry | ||
Get Object | GET | /axapi/v3/ddos/src/entry/{src-entry-name} | ||
Get List | GET | /axapi/v3/ddos/src/entry | ||
Modify Object | POST | /axapi/v3/ddos/src/entry/{src-entry-name} | ||
Replace Object | PUT | /axapi/v3/ddos/src/entry/{src-entry-name} | ||
Replace List | PUT | /axapi/v3/ddos/src/entry | ||
Delete Object | DELETE | /axapi/v3/ddos/src/entry/{src-entry-name} |
entry-list¶
entry-list is JSON List of entry attributes
entry-list : [
]
entry attributes¶
app-type-list
Type: List
Refernce Object: /axapi/v3/ddos/src/entry/{src-entry-name}/app-type/{protocol}
bypass
Description Always permit for the Source to bypass all feature & limit checks
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
description
Description Description for this Source Entry
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
exceed-log-cfg
Description: exceed-log-cfg is a JSON Block. Please see below for exceed-log-cfg
Type: Object
glid
Description Global limit ID
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/glid
hw-blacklist-blocking
Description: hw-blacklist-blocking is a JSON Block. Please see below for hw-blacklist-blocking
Type: Object
Refernce Object: /axapi/v3/ddos/src/entry/{src-entry-name}/hw-blacklist-blocking
ip-addr
Description
Type: string
Format: ipv4-address
ipv6-addr
Description
Type: string
Format: ipv6-address
l4-type-list
Type: List
Refernce Object: /axapi/v3/ddos/src/entry/{src-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
src-entry-name
Description
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
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
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
app-type-list¶
Specification
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 app-type-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
app-type-list_template¶
Specification
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
hw-blacklist-blocking¶
Specification
Type
object
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
l4-type-list¶
Specification
Type
list
Block object keys
action
Description ‘permit’: Whitelist incoming packets for protocol; ‘deny’: Blacklist incoming packets for protocol;
Type: string
Supported Values: permit, deny
glid
Description Global limit ID
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce 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 l4-type-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
l4-type-list_template¶
Specification
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
template-icmp-v6
Description DDOS icmp-v6 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
exceed-log-cfg¶
Specification
Type
object
log-enable
Description Enable logging of limit exceed drop’s
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template¶
Specification
Type
object
logging
Description DDOS logging template
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
operational data¶
Counter |
Size |
Description |
|
|---|---|---|---|
hw-blacklisted |
string |
hw-blacklisted |
|
black-listed |
flag |
black-listed |
|
authenticated |
flag |
authenticated |
|
l4-ext-rate |
string |
l4-ext-rate |
|
entry-displayed-count |
number |
entry-displayed-count |
|
all-l4-types |
flag |
all-l4-types |
|
ddos_entry_list |
ddos_entry_list |
||
app-type |
string |
app-type |
|
white-listed |
flag |
white-listed |
|
service-displayed-count |
number |
service-displayed-count |
|
exceeded |
flag |
exceeded |
|
l4-type-str |
string |
l4-type-str |
|
all-entries |
flag |
all-entries |