{
    "id":"/axapi/v3/cgnv6/nat",
    "type":"object",
    "node-type":"intermediate",
    "title":"nat",
    "operation-not-allowed": ["PUT", "POST", "DELETE"],
    "partition-visibility":"shared",
    "auto-created-object":1,
    "description":"Configure CGNv6 NAT",
    "properties":{
        "exclude-port":{
            "type":"object",
            "$ref":"/axapi/v3/cgnv6/nat/exclude-port",
            "properties":{
                "tcp":{
                    "type":"object",
                    "$ref":"/axapi/v3/cgnv6/nat/exclude-port/tcp",
                    "properties":{
                        "port-list":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"object"
                            },
                            "uniqueItems":true,
                            "array":[
                                {
                                    "properties":{
                                        "port":{
                                            "type":"number",
                                            "format":"number",
                                            "partition-visibility":"shared",
                                            "description":"Single Port or Port Range Start"
                                        },
                                        "port-end":{
                                            "type":"number",
                                            "format":"number",
                                            "partition-visibility":"shared",
                                            "description":"Port Range End"
                                        }
                                    }
                                }
                            ]
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                },
                "udp":{
                    "type":"object",
                    "$ref":"/axapi/v3/cgnv6/nat/exclude-port/udp",
                    "properties":{
                        "port-list":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"object"
                            },
                            "uniqueItems":true,
                            "array":[
                                {
                                    "properties":{
                                        "port":{
                                            "type":"number",
                                            "format":"number",
                                            "partition-visibility":"shared",
                                            "description":"Single Port or Port Range Start"
                                        },
                                        "port-end":{
                                            "type":"number",
                                            "format":"number",
                                            "partition-visibility":"shared",
                                            "description":"Port Range End"
                                        }
                                    }
                                }
                            ]
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                }
            }
        },
        "histogram":{
            "type":"object",
            "$ref":"/axapi/v3/cgnv6/nat/histogram",
            "properties":{
                "bin-count":{
                    "type":"number",
                    "format":"number",
                    "minimum":10,
                    "maximum":100,
                    "default":50,
                    "partition-visibility":"shared",
                    "description":"Number of bins in the histogram (default: 50)"
                },
                "bin-skew":{
                    "type":"number",
                    "format":"number",
                    "minimum":50,
                    "maximum":80,
                    "default":75,
                    "partition-visibility":"shared",
                    "description":"Percentage of bins that represent the upper bound (default: 75)"
                },
                "data-skew":{
                    "type":"number",
                    "format":"number",
                    "minimum":5,
                    "maximum":50,
                    "default":25,
                    "partition-visibility":"shared",
                    "description":"Percentage of data that represents the upper bound (default: 25)"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "pool-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"pool"
            },
            "uniqueItems":true,
            "$ref":"/axapi/v3/cgnv6/nat/pool/{pool-name}",
            "array":[
                {
                    "properties":{
                        "pool-name":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Specify pool name",
                            "optional":false
                        },
                        "start-address":{
                            "type":"string",
                            "format":"ipv4-address",
                            "partition-visibility":"shared",
                            "description":"Configure start IP address of NAT pool",
                            "optional":true
                        },
                        "end-address":{
                            "type":"string",
                            "format":"ipv4-address",
                            "partition-visibility":"shared",
                            "description":"Configure end IP address of NAT pool",
                            "optional":true
                        },
                        "netmask":{
                            "type":"string",
                            "format":"ipv4-netmask-brief",
                            "partition-visibility":"shared",
                            "description":"Configure mask for pool",
                            "optional":true
                        },
                        "exclude-ip":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"object"
                            },
                            "uniqueItems":true,
                            "array":[
                                {
                                    "properties":{
                                        "exclude-ip-start":{
                                            "type":"string",
                                            "format":"ipv4-address",
                                            "partition-visibility":"shared",
                                            "description":"Single IP address or IP address range start"
                                        },
                                        "exclude-ip-end":{
                                            "type":"string",
                                            "format":"ipv4-address",
                                            "partition-visibility":"shared",
                                            "description":"Address range end"
                                        }
                                    }
                                }
                            ]
                        },
                        "vrid":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":31,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Configure VRRP-A vrid (Specify ha VRRP-A vrid)",
                            "optional":true
                        },
                        "max-users-per-ip":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":64512,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Number of users that can be assigned to a NAT IP",
                            "optional":true
                        },
                        "shared":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Share this pool with other partitions (default: not shared)",
                            "optional":true
                        },
                        "group":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Share with a partition group (Partition Group Name)",
                            "optional":true
                        },
                        "partition":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":14,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Share with a single partition (Partition Name)",
                            "optional":true
                        },
                        "all":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Share with all partitions",
                            "optional":true
                        },
                        "port-batch-v2-size":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"'64': Allocate 64 ports at a time; '128': Allocate 128 ports at a time; '256': Allocate 256 ports at a time; '512': Allocate 512 ports at a time; '1024': Allocate 1024 ports at a time; '2048': Allocate 2048 ports at a time; '4096': Allocate 4096 ports at a time; ",
                            "enum":[
                                "64",
                                "128",
                                "256",
                                "512",
                                "1024",
                                "2048",
                                "4096"
                            ],
                            "optional":true
                        },
                        "simultaneous-batch-allocation":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Allocate same TCP and UDP batches at once",
                            "optional":true
                        },
                        "per-batch-port-usage-warning-threshold":{
                            "type":"number",
                            "format":"number",
                            "minimum":32,
                            "maximum":4096,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Configure warning log threshold for per batch port usage (default: disabled) (Number of ports)",
                            "optional":true
                        },
                        "tcp-time-wait-interval":{
                            "type":"number",
                            "format":"number",
                            "minimum":0,
                            "maximum":10,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Minutes before TCP NAT ports can be reused",
                            "optional":true
                        },
                        "usable-nat-ports":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Configure usable NAT ports",
                            "optional":true
                        },
                        "usable-nat-ports-start":{
                            "type":"number",
                            "format":"number",
                            "minimum":1024,
                            "maximum":65535,
                            "partition-visibility":"shared",
                            "description":"Start Port of Usable NAT Ports (needs to be even)",
                            "optional":true
                        },
                        "usable-nat-ports-end":{
                            "type":"number",
                            "format":"number",
                            "minimum":1024,
                            "maximum":65535,
                            "partition-visibility":"shared",
                            "description":"End Port of Usable NAT Ports",
                            "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
                        }
                    },
                    "required":[
                        "pool-name"
                    ]
                }
            ]
        },
        "icmp":{
            "type":"object",
            "$ref":"/axapi/v3/cgnv6/nat/icmp",
            "properties":{
                "always-source-nat-errors":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Source NAT intermediate routers' IPs for ICMP errors (default: disabled)"
                },
                "respond-to-ping":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Respond to ICMP echo requests to NAT pool IPs (default: disabled)"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "icmpv6":{
            "type":"object",
            "$ref":"/axapi/v3/cgnv6/nat/icmpv6",
            "properties":{
                "respond-to-ping":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Respond to ICMPv6 echo requests to NAT pool IPs (default: disabled)"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "pool-group-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"pool-group"
            },
            "uniqueItems":true,
            "$ref":"/axapi/v3/cgnv6/nat/pool-group/{pool-group-name}",
            "array":[
                {
                    "properties":{
                        "pool-group-name":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Specify pool group name",
                            "optional":false
                        },
                        "vrid":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":31,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Specify VRRP-A vrid",
                            "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
                        },
                        "member-list":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"member"
                            },
                            "uniqueItems":true,
                            "$ref":"/axapi/v3/cgnv6/nat/pool-group/{pool-group-name}/member/{pool-name}",
                            "array":[
                                {
                                    "properties":{
                                        "pool-name":{
                                            "type":"string",
                                            "format":"string-rlx",
                                            "minLength":1,
                                            "maxLength":63,
                                            "partition-visibility":"shared",
                                            "description":"Specify CGNv6 NAT pool name",
                                            "optional":false
                                        },
                                        "uuid":{
                                            "type":"string",
                                            "format":"string",
                                            "minLength":1,
                                            "maxLength":64,
                                            "partition-visibility":"shared",
                                            "modify-not-allowed":1,
                                            "description":"uuid of the object",
                                            "optional":true
                                        }
                                    },
                                    "required":[
                                        "pool-name"
                                    ]
                                }
                            ]
                        }
                    },
                    "required":[
                        "pool-group-name"
                    ]
                }
            ]
        },
        "shared-pool":{
            "type":"object",
            "$ref":"/axapi/v3/cgnv6/nat/shared-pool",
            "properties":{
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "shared-pool-group":{
            "type":"object",
            "$ref":"/axapi/v3/cgnv6/nat/shared-pool-group",
            "properties":{
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                },
                "members":{
                    "type":"object",
                    "$ref":"/axapi/v3/cgnv6/nat/shared-pool-group/members",
                    "properties":{
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                }
            }
        },
        "inside":{
            "type":"object",
            "$ref":"/axapi/v3/cgnv6/nat/inside",
            "properties":{
                "source":{
                    "type":"object",
                    "$ref":"/axapi/v3/cgnv6/nat/inside/source",
                    "properties":{
                        "static-list":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"static"
                            },
                            "uniqueItems":true,
                            "$ref":"/axapi/v3/cgnv6/nat/inside/source/static/{src-address}+{partition}",
                            "array":[
                                {
                                    "properties":{
                                        "src-address":{
                                            "type":"string",
                                            "format":"ipv4-address",
                                            "partition-visibility":"shared",
                                            "description":"Original Source Address",
                                            "optional":false
                                        },
                                        "partition":{
                                            "type":"string",
                                            "format":"string",
                                            "minLength":1,
                                            "maxLength":63,
                                            "partition-visibility":"shared",
                                            "modify-not-allowed":1,
                                            "description":"Inside User Partition (Partition Name)",
                                            "optional":false
                                        },
                                        "nat-address":{
                                            "type":"string",
                                            "format":"ipv4-address",
                                            "partition-visibility":"shared",
                                            "modify-not-allowed":1,
                                            "description":"NAT Address",
                                            "optional":true
                                        },
                                        "vrid":{
                                            "type":"number",
                                            "format":"number",
                                            "minimum":1,
                                            "maximum":31,
                                            "partition-visibility":"shared",
                                            "description":"VRRP-A vrid (Specify ha VRRP-A vrid)",
                                            "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
                                        }
                                    },
                                    "required":[
                                        "src-address",
                                        "partition"
                                    ]
                                }
                            ]
                        },
                        "statistics":{
                            "type":"object",
                            "$ref":"/axapi/v3/cgnv6/nat/inside/source/statistics",
                            "properties":{
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object"
                                }
                            }
                        }
                    }
                }
            }
        },
        "range-list-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"range-list"
            },
            "uniqueItems":true,
            "$ref":"/axapi/v3/cgnv6/nat/range-list/{name}+{partition}",
            "array":[
                {
                    "properties":{
                        "name":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Name for this Static List",
                            "optional":false
                        },
                        "local-start-ipv4-addr":{
                            "type":"string",
                            "format":"ipv4-address",
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Local Start IPv4 Address of this list",
                            "optional":true
                        },
                        "local-netmaskv4":{
                            "type":"string",
                            "format":"ipv4-netmask",
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Mask for this Address range",
                            "optional":true
                        },
                        "partition":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Inside User Partition (Partition Name)",
                            "optional":false
                        },
                        "global-start-ipv4-addr":{
                            "type":"string",
                            "format":"ipv4-address",
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Global Start IPv4 Address of this list",
                            "optional":true
                        },
                        "global-netmaskv4":{
                            "type":"string",
                            "format":"ipv4-netmask",
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Mask for this Address range",
                            "optional":true
                        },
                        "v4-count":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":200000,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"Number of addresses to be translated in this range",
                            "optional":true
                        },
                        "v4-vrid":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":31,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"VRRP-A vrid (Specify ha VRRP-A vrid)",
                            "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
                        }
                    },
                    "required":[
                        "name",
                        "partition"
                    ]
                }
            ]
        }
    }
}