cgnv6 map encapsulation domain¶
MAP Encapsulation domain
domain Specification¶
Type
Collection
Object Key(s)
name
Collection Name
Collection URI
/axapi/v3/cgnv6/map/encapsulation/domain
Element Name
domain
Element URI
/axapi/v3/cgnv6/map/encapsulation/domain/{name}
Element Attributes
domain_attributes
Statistics Data URI
/axapi/v3/cgnv6/map/encapsulation/domain/{name}/stats
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/cgnv6/map/encapsulation/domain | ||
Create List | POST | /axapi/v3/cgnv6/map/encapsulation/domain | ||
Get Object | GET | /axapi/v3/cgnv6/map/encapsulation/domain/{name} | ||
Get List | GET | /axapi/v3/cgnv6/map/encapsulation/domain | ||
Modify Object | POST | /axapi/v3/cgnv6/map/encapsulation/domain/{name} | ||
Replace Object | PUT | /axapi/v3/cgnv6/map/encapsulation/domain/{name} | ||
Replace List | PUT | /axapi/v3/cgnv6/map/encapsulation/domain | ||
Delete Object | DELETE | /axapi/v3/cgnv6/map/encapsulation/domain/{name} |
domain-list¶
domain-list is JSON List of domain attributes
domain-list : [
]
domain attributes¶
basic-mapping-rule
Description: basic-mapping-rule is a JSON Block. Please see below for 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 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
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
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
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
health-check-gateway_ipv6-address-list¶
Specification
Type
list
Block object keys
ipv6-gateway
Description IPv6 Gateway
Type: string
Format: ipv6-address
health-check-gateway_address-list¶
Specification
Type
list
Block object keys
ipv4-gateway
Description IPv4 Gateway
Type: string
Format: ipv4-address
stats data¶
Counter |
Size |
Description |
|
|---|---|---|---|
interface_not_configured |
8 |
Interfaces not Configured Dropped |
|
inbound_packet_received |
8 |
Inbound IPv4 Packets Received |
|
frag_icmp_sent |
8 |
ICMP Packet Too Big Sent |
|
outbound_dest_unreachable |
8 |
Outbound IPv4 Destination Address Unreachable |
|
outbound_packet_received |
8 |
Outbound IPv6 Packets Received |
|
inbound_dest_unreachable |
8 |
Inbound IPv6 Destination Address Unreachable |
|
inbound_rev_lookup_failed |
8 |
Inbound IPv4 Reverse Route Lookup Failed |
|
bmr_prefixrules_configured |
8 |
BMR prefix rules configured |
|
outbound_frag_packet_received |
8 |
Outbound IPv6 Fragment Packets Received |
|
packet_mtu_exceeded |
8 |
Packet Exceeded MTU |
|
inbound_addr_port_validation_failed |
8 |
Inbound IPv4 Destination Address Port Validation Failed |
|
outbound_addr_validation_failed |
8 |
Outbound IPv6 Source Address Validation Failed |
|
inbound_frag_packet_received |
8 |
Inbound IPv4 Fragment Packets Received |
|
outbound_rev_lookup_failed |
8 |
Outbound IPv6 Reverse Route Lookup Failed |