.. _cgnv6_map_translation: cgnv6 map translation ===================== MAP Translation (MAP-T) translation Specification ------------------------- ===================================== ============================================================== **Parameter** **Value** ===================================== ============================================================== **Type** *Intermediate Resource* **Element Name** translation **Element URI** /axapi/v3/cgnv6/map/translation **Element Attributes** translation_attributes **Partition Visibility** shared **Schema** :download:`translation schema ` ===================================== ============================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/cgnv6/map/translation .. raw:: html translation_attributes .. raw:: html
.. _456_translation_attributes: translation attributes ---------------------- **default-domain** **Description:** default-domain is a **JSON Block**. Please see below for :ref:`456_default-domain` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cgnv6/map/translation/default-domain ` **domain-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain/{name} ` **fragmentation** **Description:** fragmentation is a **JSON Block**. Please see below for :ref:`456_fragmentation` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cgnv6/map/translation/fragmentation ` .. _456_fragmentation: fragmentation ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **inbound** **Description:** inbound is a **JSON Block**. Please see below for :ref:`456_fragmentation_inbound` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cgnv6/map/translation/fragmentation/inbound ` **outbound** **Description:** outbound is a **JSON Block**. Please see below for :ref:`456_fragmentation_outbound` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cgnv6/map/translation/fragmentation/outbound ` .. _456_fragmentation_inbound: fragmentation_inbound ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **df-set** **Description** 'drop': Drop Silently; '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, ipv6, send-icmp **Default:** send-icmp **frag-action** **Description** 'drop': Drop Silently; 'ipv6': Use IPv6 fragmentation for oversize packets (default); **Type:** string **Supported Values:** drop, ipv6 **Default:** ipv6 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _456_fragmentation_outbound: fragmentation_outbound ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **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 .. _456_domain-list: domain-list ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **basic-mapping-rule** **Description:** basic-mapping-rule is a **JSON Block**. Please see below for :ref:`456_domain-list_basic-mapping-rule` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain/{name}/basic-mapping-rule ` **default-mapping-rule** **Description:** default-mapping-rule is a **JSON Block**. Please see below for :ref:`456_domain-list_default-mapping-rule` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain/{name}/default-mapping-rule ` **description** **Description** MAP-T domain description **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **health-check-gateway** **Description:** health-check-gateway is a **JSON Block**. Please see below for :ref:`456_domain-list_health-check-gateway` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain/{name}/health-check-gateway ` **mtu** **Description** Domain MTU **Type:** number **name** **Description** MAP-T 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:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/cgnv6-map-trans-domain-tmpl ` **sampling-enable** **Type:** List **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`456_domain-list_tcp` **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 .. _456_domain-list_default-mapping-rule: domain-list_default-mapping-rule ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **rule-ipv6-prefix** **Description** Rule IPv6 prefix **Type:** string **Format:** ipv6-address-plen **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _456_domain-list_sampling-enable: domain-list_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 .. _456_domain-list_tcp: domain-list_tcp ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **mss-clamp** **Description:** mss-clamp is a **JSON Block**. Please see below for :ref:`456_domain-list_tcp_mss-clamp` **Type:** Object .. _456_domain-list_tcp_mss-clamp: domain-list_tcp_mss-clamp ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **min** **Description** Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: 516)) **Type:** number **Range:** 0-1440 **Default:** 516 **mss-clamp-type** **Description** 'fixed': Specify a fixed max value for the TCP MSS; 'none': No TCP MSS clamping(default); 'subtract': Specify the value to subtract from the TCP MSS; **Type:** string **Supported Values:** fixed, none, subtract **Default:** none **mss-subtract** **Description** Specify the value to subtract from the TCP MSS **Type:** number **Range:** 0-1440 **mss-value** **Description** The max value allowed for the TCP MSS **Type:** number **Range:** 0-1440 .. _456_domain-list_health-check-gateway: domain-list_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 .. _456_domain-list_health-check-gateway_ipv6-address-list: domain-list_health-check-gateway_ipv6-address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-gateway** **Description** IPv6 Gateway **Type:** string **Format:** ipv6-address .. _456_domain-list_health-check-gateway_address-list: domain-list_health-check-gateway_address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-gateway** **Description** IPv4 Gateway **Type:** string **Format:** ipv4-address .. _456_domain-list_basic-mapping-rule: domain-list_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:** :doc:`/axapi/v3/cgnv6/map/translation/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 .. _456_domain-list_basic-mapping-rule_prefix-rule-list: domain-list_basic-mapping-rule_prefix-rule-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **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 **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 **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 .. _456_default-domain: default-domain ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **name** **Description** MAP-T domain name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters