{
    "id":"/axapi/v3/ip/nat/pool/{pool-name}",
    "type":"object",
    "node-type":"list",
    "title":"pool",
    "partition-visibility":"shared",
    "description":"Configure IP pool name",
    "properties":{
        "pool-name":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":63,
            "partition-visibility":"shared",
            "description":"Specify pool name or pool group",
            "optional":false
        },
        "start-address":{
            "type":"string",
            "format":"ipv4-address",
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "not":"use-if-ip",
            "description":"Configure start IP address of NAT pool",
            "optional":true
        },
        "end-address":{
            "type":"string",
            "format":"ipv4-address",
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"Configure end IP address of NAT pool",
            "optional":true
        },
        "netmask":{
            "type":"string",
            "format":"ipv4-netmask-brief",
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"Configure mask for pool",
            "optional":true
        },
        "gateway":{
            "type":"string",
            "format":"ipv4-address",
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"Configure gateway IP",
            "optional":true
        },
        "vrid":{
            "type":"number",
            "format":"number",
            "minimum":1,
            "maximum":31,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "$ref":"/axapi/v3/vrrp-a/vrid",
            "description":"Configure VRRP-A vrid (Specify ha VRRP-A vrid)",
            "optional":true
        },
        "scaleout-device-id":{
            "type":"number",
            "format":"number",
            "minimum":1,
            "maximum":16,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"Configure Scaleout device id to which this NAT pool is to be bound (Specify Scaleout device id)",
            "optional":true
        },
        "ip-rr":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"Use IP address round-robin behavior",
            "optional":true
        },
        "port-overload":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Nat Pool Port overload",
            "optional":true
        },
        "use-if-ip":{
            "type":"number",
            "format":"flag",
            "plat-pos-list":["aten-sp-mode"],
            "default":0,
            "partition-visibility":"shared",
            "not":"start-address",
            "description":"Use Interface IP",
            "optional":true
        },
        "ethernet":{
            "type":"number",
            "format":"interface",
            "plat-pos-list":["aten-sp-mode"],
            "partition-visibility":"shared",
            "description":"Ethernet interface",
            "optional":true
        },
        "chunk-sharing":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"Share NAT pool chunk across CPUs",
            "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
        }
    },
    "object-keys":[
        "pool-name"
    ],
    "required":[
        "pool-name"
    ]
}