ddos template encap¶
Encapsulation template Configuration
encap Specification¶
Parameter Value Type Collection Object Key(s) encap-tmpl-name Collection Name encap-list Collection URI /axapi/v3/ddos/template/encap Element Name encap Element URI /axapi/v3/ddos/template/encap/{encap-tmpl-name} Element Attributes encap_attributes Partition Visibility shared Schema encap schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/ddos/template/encap | ||
Create List | POST | /axapi/v3/ddos/template/encap | ||
Get Object | GET | /axapi/v3/ddos/template/encap/{encap-tmpl-name} | ||
Get List | GET | /axapi/v3/ddos/template/encap | ||
Modify Object | POST | /axapi/v3/ddos/template/encap/{encap-tmpl-name} | ||
Replace Object | PUT | /axapi/v3/ddos/template/encap/{encap-tmpl-name} | ||
Replace List | PUT | /axapi/v3/ddos/template/encap | ||
Delete Object | DELETE | /axapi/v3/ddos/template/encap/{encap-tmpl-name} |
encap-list¶
encap-list is JSON List of encap attributes
encap-list : [
]
encap attributes¶
encap-tmpl-name
Description DDOS Tunnel Template Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
preserve-source-ip
Description Use original source ip for encapsulation
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tunnel-encap
Description: tunnel-encap is a JSON Block. Please see below for tunnel-encap
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
tunnel-encap¶
Specification Value Type object gre-cfg
Description: gre-cfg is a JSON Block. Please see below for tunnel-encap_gre-cfg
Type: Object
ip-cfg
Description: ip-cfg is a JSON Block. Please see below for tunnel-encap_ip-cfg
Type: Object
tunnel-encap_ip-cfg¶
Specification Value Type object always
Description: always is a JSON Block. Please see below for tunnel-encap_ip-cfg_always
Type: Object
ip-encap
Description Enable Tunnel encap for IP packets
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tunnel-encap_ip-cfg_always¶
Specification Value Type object ipv4-addr
Description IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)
Type: string
Format: ipv4-address
ipv6-addr
Description IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)
Type: string
Format: ipv6-address
tunnel-encap_gre-cfg¶
Specification Value Type object gre-always
Description: gre-always is a JSON Block. Please see below for tunnel-encap_gre-cfg_gre-always
Type: Object
gre-encap
Description Enable Tunnel encap for GRE packets
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tunnel-encap_gre-cfg_gre-always¶
Specification Value Type object gre-ipv4
Description IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)
Type: string
Format: ipv4-address
gre-ipv6
Description IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)
Type: string
Format: ipv6-address
key-ipv4
Description Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)
Type: string
Maximum Length: 10 characters
Maximum Length: 1 characters
key-ipv6
Description Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)
Type: string
Maximum Length: 10 characters
Maximum Length: 1 characters