cgnv6 map encapsulation¶
MAP Encapsulation (MAP-E)
encapsulation Specification¶
Type
Intermediate Resource
Element Name
encapsulation
Element URI
/axapi/v3/cgnv6/map/encapsulation
Element Attributes
encapsulation_attributes
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/cgnv6/map/encapsulation | encapsulation_attributes |
encapsulation attributes¶
domain-list
Type: List
Refernce Object: /axapi/v3/cgnv6/map/encapsulation/domain/{name}
fragmentation
Description: fragmentation is a JSON Block. Please see below for fragmentation
Type: Object
Refernce Object: /axapi/v3/cgnv6/map/encapsulation/fragmentation
fragmentation¶
Specification
Type
object
inbound
Description: inbound is a JSON Block. Please see below for fragmentation_inbound
Type: Object
Refernce Object: /axapi/v3/cgnv6/map/encapsulation/fragmentation/inbound
outbound
Description: outbound is a JSON Block. Please see below for fragmentation_outbound
Type: Object
Refernce Object: /axapi/v3/cgnv6/map/encapsulation/fragmentation/outbound
fragmentation_inbound¶
Specification
Type
object
df-set
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘ipv6’: Use IPv6 fragmentation for oversize packets; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default);
Type: string
Supported Values: drop, ipv4, ipv6, send-icmp
Default: send-icmp
frag-action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘ipv6’: Use IPv6 fragmentation for oversize packets (default);
Type: string
Supported Values: drop, ipv4, ipv6
Default: ipv6
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fragmentation_outbound¶
Specification
Type
object
df-set
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set)(default); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmp, send-icmpv6
Default: send-icmp
frag-action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets (default); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmpv6
Default: ipv4
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
domain-list¶
Specification
Type
list
Block object keys
basic-mapping-rule
Description: basic-mapping-rule is a JSON Block. Please see below for domain-list_basic-mapping-rule
Type: Object
Refernce Object: /axapi/v3/cgnv6/map/encapsulation/domain/{name}/basic-mapping-rule
description
Description MAP-E domain description
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
format
Description ‘draft-03’: Construct IPv6 Interface Identifier according to draft-03;
Type: string
Supported Values: draft-03
health-check-gateway
Description: health-check-gateway is a JSON Block. Please see below for domain-list_health-check-gateway
Type: Object
Refernce Object: /axapi/v3/cgnv6/map/encapsulation/domain/{name}/health-check-gateway
name
Description MAP-E domain name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
tunnel-endpoint-address
Description Tunnel Endpoint Address for MAP-E domain
Type: string
Format: ipv6-address
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
domain-list_basic-mapping-rule¶
Specification
Type
object
ea-length
Description Length of Embedded Address (EA) bits
Type: number
Range: 0-23
port-start
Description Starting Port, Must be Power of 2 value
Type: number
Range: 1-32768
prefix-rule-list
Type: List
Refernce Object: /axapi/v3/cgnv6/map/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule/{name}
rule-ipv4-address-port-settings
Description ‘prefix-addr’: Each CE is assigned an IPv4 prefix; ‘single-addr’: Each CE is assigned an IPv4 address; ‘shared-addr’: Each CE is assigned a shared IPv4 address;
Type: string
Supported Values: prefix-addr, single-addr, shared-addr
share-ratio
Description Port sharing ratio for each NAT IP. Must be Power of 2 value
Type: number
Range: 1-65536
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
domain-list_basic-mapping-rule_prefix-rule-list¶
Specification
Type
list
Block object keys
ea-length
Description Length of Embedded Address (EA) bits
Type: number
Range: 0-23
ipv4-address-port-settings
Description ‘prefix-addr’: Each CE is assigned an IPv4 prefix; ‘single-addr’: Each CE is assigned an IPv4 address; ‘shared-addr’: Each CE is assigned a shared IPv4 address;
Type: string
Supported Values: prefix-addr, single-addr, shared-addr
ipv4-netmask
Description Subnet mask (subnet bigger than /8 is not allowed)
Type: string
Format: ipv4-netmask-brief
name
Description MAP BMR prefix rule name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-start
Description Starting Port, Must be Power of 2 value
Type: number
Range: 1-32768
rule-ipv4-prefix
Description IPv4 prefix of BMR
Type: string
Format: ipv4-address
rule-ipv6-prefix
Description IPv6 prefix of BMR
Type: string
Format: ipv6-address-plen
share-ratio
Description Port sharing ratio for each NAT IP. Must be Power of 2 value
Type: number
Range: 1-65536
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
domain-list_health-check-gateway¶
Specification
Type
object
address-list
Type: List
ipv6-address-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
withdraw-route
Description ‘all-link-failure’: Withdraw routes on health-check failure of all IPv4 gateways or all IPv6 gateways; ‘any-link-failure’: Withdraw routes on health-check failure of any gateway (default);
Type: string
Supported Values: all-link-failure, any-link-failure
Default: any-link-failure
domain-list_health-check-gateway_ipv6-address-list¶
Specification
Type
list
Block object keys
ipv6-gateway
Description IPv6 Gateway
Type: string
Format: ipv6-address
domain-list_health-check-gateway_address-list¶
Specification
Type
list
Block object keys
ipv4-gateway
Description IPv4 Gateway
Type: string
Format: ipv4-address