cgnv6 map encapsulation domain¶

MAP Encapsulation domain

domain Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name domain-list

Collection URI /axapi/v3/cgnv6/map/encapsulation/domain

Element Name domain

Element URI /axapi/v3/cgnv6/map/encapsulation/domain/{name}

Element Attributes domain_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/cgnv6/map/encapsulation/domain/{name}/stats

Schema domain schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/cgnv6/map/encapsulation/domain	domain attributes
POST /axapi/v3/cgnv6/map/encapsulation/domain/ Payload: { "domain": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/cgnv6/map/encapsulation/domain	domain attributes
Get Object	GET	/axapi/v3/cgnv6/map/encapsulation/domain/{name}	domain attributes
GET /axapi/v3/cgnv6/map/encapsulation/domain/a Reponse: { "domain": { "name": "a", "uuid": "db264418-4f7b-11ee-9e04-5d5bbc5e5064", "user-tag": "a", "a10-url": "/axapi/v3/cgnv6/map/encapsulation/domain/a" } }
Get List	GET	/axapi/v3/cgnv6/map/encapsulation/domain	domain-list
Modify Object	POST	/axapi/v3/cgnv6/map/encapsulation/domain/{name}	domain attributes
Replace Object	PUT	/axapi/v3/cgnv6/map/encapsulation/domain/{name}	domain attributes
PUT /axapi/v3/cgnv6/map/encapsulation/domain/a Payload: { "domain": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/cgnv6/map/encapsulation/domain	domain-list
Delete Object	DELETE	/axapi/v3/cgnv6/map/encapsulation/domain/{name}	domain attributes
DELETE /axapi/v3/cgnv6/map/encapsulation/domain/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

domain-list¶

domain-list is JSON List of domain attributes

domain-list : [

{ domain attributes },

{ domain attributes },

…

]

domain attributes¶

basic-mapping-rule

Description: basic-mapping-rule is a JSON Block. Please see below for basic-mapping-rule

Type: Object

Reference 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

Reference 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

packet-capture-template

Description Name of the packet capture template to be bind with this object

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/cgnv6-encap-domain-tmpl

sampling-enable

Type: List

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 Value

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 or zero

Type: number

Range: 0-32768

prefix-rule-list

Type: List

Reference 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 Value

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 or zero

Type: number

Range: 0-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

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘inbound_packet_received’: Inbound IPv4 Packets Received; ‘inbound_frag_packet_received’: Inbound IPv4 Fragment Packets Received; ‘inbound_addr_port_validation_failed’: Inbound IPv4 Destination Address Port Validation Failed; ‘inbound_rev_lookup_failed’: Inbound IPv4 Reverse Route Lookup Failed; ‘inbound_dest_unreachable’: Inbound IPv6 Destination Address Unreachable; ‘outbound_packet_received’: Outbound IPv6 Packets Received; ‘outbound_frag_packet_received’: Outbound IPv6 Fragment Packets Received; ‘outbound_addr_validation_failed’: Outbound IPv6 Source Address Validation Failed; ‘outbound_rev_lookup_failed’: Outbound IPv6 Reverse Route Lookup Failed; ‘outbound_dest_unreachable’: Outbound IPv4 Destination Address Unreachable; ‘packet_mtu_exceeded’: Packet Exceeded MTU; ‘frag_icmp_sent’: ICMP Packet Too Big Sent; ‘interface_not_configured’: Interfaces not Configured Dropped; ‘bmr_prefixrules_configured’: BMR prefix rules configured; ‘helper_count’: Helper Count; ‘active_dhcpv6_leases’: Active DHCPv6 leases;

Type: string

Supported Values: all, inbound_packet_received, inbound_frag_packet_received, inbound_addr_port_validation_failed, inbound_rev_lookup_failed, inbound_dest_unreachable, outbound_packet_received, outbound_frag_packet_received, outbound_addr_validation_failed, outbound_rev_lookup_failed, outbound_dest_unreachable, packet_mtu_exceeded, frag_icmp_sent, interface_not_configured, bmr_prefixrules_configured, helper_count, active_dhcpv6_leases

health-check-gateway¶

Specification Value

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 Value

Type list

Block object keys

ipv6-gateway

Description IPv6 Gateway

Type: string

Format: ipv6-address

health-check-gateway_address-list¶

Specification Value

Type list

Block object keys

ipv4-gateway

Description IPv4 Gateway

Type: string

Format: ipv4-address