{
    "id":"/axapi/v3/cgnv6/map/translation",
    "type":"object",
    "node-type":"intermediate",
    "title":"translation",
    "operation-not-allowed": ["PUT", "POST", "DELETE"],
    "partition-visibility":"shared",
    "auto-created-object":1,
    "description":"MAP Translation (MAP-T)",
    "properties":{
        "fragmentation":{
            "type":"object",
            "$ref":"/axapi/v3/cgnv6/map/translation/fragmentation",
            "properties":{
                "inbound":{
                    "type":"object",
                    "$ref":"/axapi/v3/cgnv6/map/translation/fragmentation/inbound",
                    "properties":{
                        "df-set":{
                            "type":"string",
                            "format":"enum",
                            "default":"send-icmp",
                            "partition-visibility":"shared",
                            "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); ",
                            "enum":[
                                "drop",
                                "ipv6",
                                "send-icmp"
                            ]
                        },
                        "frag-action":{
                            "type":"string",
                            "format":"enum",
                            "default":"ipv6",
                            "partition-visibility":"shared",
                            "description":"'drop': Drop Silently; 'ipv6': Use IPv6 fragmentation for oversize packets (default); ",
                            "enum":[
                                "drop",
                                "ipv6"
                            ]
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                },
                "outbound":{
                    "type":"object",
                    "$ref":"/axapi/v3/cgnv6/map/translation/fragmentation/outbound",
                    "properties":{
                        "frag-action":{
                            "type":"string",
                            "format":"enum",
                            "default":"ipv4",
                            "partition-visibility":"shared",
                            "description":"'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets (default); 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big); ",
                            "enum":[
                                "drop",
                                "ipv4",
                                "send-icmpv6"
                            ]
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                }
            }
        },
        "domain-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"domain"
            },
            "uniqueItems":true,
            "$ref":"/axapi/v3/cgnv6/map/translation/domain/{name}",
            "array":[
                {
                    "properties":{
                        "name":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"MAP-T domain name",
                            "optional":false
                        },
                        "description":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":255,
                            "partition-visibility":"shared",
                            "description":"MAP-T domain description",
                            "optional":true
                        },
                        "mtu":{
                            "type":"number",
                            "format":"number",
                            "platform-specific-range":1,
                            "platform-specific-default":1,
                            "partition-visibility":"shared",
                            "description":"Domain MTU",
                            "optional":true
                        },
                        "tcp":{
                            "type":"object",
                            "properties":{
                                "mss-clamp":{
                                    "type":"object",
                                    "properties":{
                                        "mss-clamp-type":{
                                            "type":"string",
                                            "format":"enum",
                                            "default":"none",
                                            "partition-visibility":"shared",
                                            "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; ",
                                            "enum":[
                                                "fixed",
                                                "none",
                                                "subtract"
                                            ]
                                        },
                                        "mss-value":{
                                            "type":"number",
                                            "format":"number",
                                            "minimum":0,
                                            "maximum":1440,
                                            "partition-visibility":"shared",
                                            "description":"The max value allowed for the TCP MSS"
                                        },
                                        "mss-subtract":{
                                            "type":"number",
                                            "format":"number",
                                            "minimum":0,
                                            "maximum":1440,
                                            "partition-visibility":"shared",
                                            "description":"Specify the value to subtract from the TCP MSS"
                                        },
                                        "min":{
                                            "type":"number",
                                            "format":"number",
                                            "minimum":0,
                                            "maximum":1440,
                                            "default":516,
                                            "partition-visibility":"shared",
                                            "description":"Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: 516))"
                                        }
                                    }
                                }
                            }
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object",
                            "optional":true
                        },
                        "user-tag":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Customized tag",
                            "optional":true
                        },
                        "sampling-enable":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"object"
                            },
                            "uniqueItems":true,
                            "array":[
                                {
                                    "properties":{
                                        "counters1":{
                                            "type":"string",
                                            "format":"enum",
                                            "partition-visibility":"shared",
                                            "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; ",
                                            "enum":[
                                                "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"
                                            ]
                                        }
                                    }
                                }
                            ]
                        },
                        "packet-capture-template":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":128,
                            "partition-visibility":"shared",
                            "$ref":"/axapi/v3/visibility/packet-capture/object-templates/cgnv6-map-trans-domain-tmpl",
                            "description":"Name of the packet capture template to be bind with this object",
                            "optional":true
                        },
                        "health-check-gateway":{
                            "type":"object",
                            "$ref":"/axapi/v3/cgnv6/map/translation/domain/{name}/health-check-gateway",
                            "properties":{
                                "address-list":{
                                    "type":"array",
                                    "minItems":1,
                                    "items":{
                                        "type":"object"
                                    },
                                    "uniqueItems":true,
                                    "array":[
                                        {
                                            "properties":{
                                                "ipv4-gateway":{
                                                    "type":"string",
                                                    "format":"ipv4-address",
                                                    "partition-visibility":"shared",
                                                    "description":"IPv4 Gateway"
                                                }
                                            }
                                        }
                                    ]
                                },
                                "ipv6-address-list":{
                                    "type":"array",
                                    "minItems":1,
                                    "items":{
                                        "type":"object"
                                    },
                                    "uniqueItems":true,
                                    "array":[
                                        {
                                            "properties":{
                                                "ipv6-gateway":{
                                                    "type":"string",
                                                    "format":"ipv6-address",
                                                    "partition-visibility":"shared",
                                                    "description":"IPv6 Gateway"
                                                }
                                            }
                                        }
                                    ]
                                },
                                "withdraw-route":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"any-link-failure",
                                    "partition-visibility":"shared",
                                    "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); ",
                                    "enum":[
                                        "all-link-failure",
                                        "any-link-failure"
                                    ]
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object"
                                }
                            }
                        },
                        "default-mapping-rule":{
                            "type":"object",
                            "$ref":"/axapi/v3/cgnv6/map/translation/domain/{name}/default-mapping-rule",
                            "properties":{
                                "rule-ipv6-prefix":{
                                    "type":"string",
                                    "format":"ipv6-address-plen",
                                    "partition-visibility":"shared",
                                    "description":"Rule IPv6 prefix"
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object"
                                }
                            }
                        },
                        "basic-mapping-rule":{
                            "type":"object",
                            "$ref":"/axapi/v3/cgnv6/map/translation/domain/{name}/basic-mapping-rule",
                            "properties":{
                                "rule-ipv4-address-port-settings":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "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; ",
                                    "enum":[
                                        "prefix-addr",
                                        "single-addr",
                                        "shared-addr"
                                    ]
                                },
                                "ea-length":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":0,
                                    "maximum":23,
                                    "partition-visibility":"shared",
                                    "description":"Length of Embedded Address (EA) bits"
                                },
                                "share-ratio":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65536,
                                    "partition-visibility":"shared",
                                    "description":"Port sharing ratio for each NAT IP. Must be Power of 2 value"
                                },
                                "port-start":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":0,
                                    "maximum":32768,
                                    "partition-visibility":"shared",
                                    "description":"Starting Port, Must be Power of 2 value or zero"
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object"
                                },
                                "prefix-rule-list":{
                                    "type":"array",
                                    "minItems":1,
                                    "items":{
                                        "type":"prefix-rule"
                                    },
                                    "uniqueItems":true,
                                    "$ref":"/axapi/v3/cgnv6/map/translation/domain/{name}/basic-mapping-rule/prefix-rule/{name}",
                                    "array":[
                                        {
                                            "properties":{
                                                "name":{
                                                    "type":"string",
                                                    "format":"string-rlx",
                                                    "minLength":1,
                                                    "maxLength":63,
                                                    "partition-visibility":"shared",
                                                    "description":"MAP BMR prefix rule name",
                                                    "optional":false
                                                },
                                                "rule-ipv6-prefix":{
                                                    "type":"string",
                                                    "format":"ipv6-address-plen",
                                                    "partition-visibility":"shared",
                                                    "description":"IPv6 prefix of BMR",
                                                    "optional":true
                                                },
                                                "rule-ipv4-prefix":{
                                                    "type":"string",
                                                    "format":"ipv4-address",
                                                    "partition-visibility":"shared",
                                                    "description":"IPv4 prefix of BMR",
                                                    "optional":true
                                                },
                                                "ipv4-netmask":{
                                                    "type":"string",
                                                    "format":"ipv4-netmask-brief",
                                                    "partition-visibility":"shared",
                                                    "description":"Subnet mask (subnet bigger than /8 is not allowed)",
                                                    "optional":true
                                                },
                                                "uuid":{
                                                    "type":"string",
                                                    "format":"string",
                                                    "minLength":1,
                                                    "maxLength":64,
                                                    "partition-visibility":"shared",
                                                    "modify-not-allowed":1,
                                                    "description":"uuid of the object",
                                                    "optional":true
                                                },
                                                "user-tag":{
                                                    "type":"string",
                                                    "format":"string-rlx",
                                                    "minLength":1,
                                                    "maxLength":127,
                                                    "partition-visibility":"shared",
                                                    "description":"Customized tag",
                                                    "optional":true
                                                }
                                            },
                                            "required":[
                                                "name"
                                            ]
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "required":[
                        "name"
                    ]
                }
            ]
        },
        "default-domain":{
            "type":"object",
            "$ref":"/axapi/v3/cgnv6/map/translation/default-domain",
            "properties":{
                "name":{
                    "type":"string",
                    "format":"string-rlx",
                    "minLength":1,
                    "maxLength":63,
                    "partition-visibility":"shared",
                    "$ref":"/axapi/v3/cgnv6/map/translation/domain",
                    "description":"MAP-T domain name"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        }
    }
}