{ "id":"/axapi/v3/ip/nat", "type":"object", "node-type":"intermediate", "title":"nat", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "description":"Configure NAT", "properties":{ "nat-global":{ "type":"object", "$ref":"/axapi/v3/ip/nat/nat-global", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'cross_cpu_helper_created': Cross CPU Helper Created; 'cross_cpu_helper_free': Cross CPU Helper Free; 'cross_cpu_sent': Cross CPU Helper Packets Sent; 'cross_cpu_rcv': Cross CPU Helper Packets Received; 'cross_cpu_helper_nat_pool_standby': Cross CPU Helper Standby; 'cross_cpu_helper_cpu_mismatch': Cross CPU Helper CPU Mismatch; 'cross_cpu_bad_l3': Cross CPU Unsupported L3; 'cross_cpu_bad_l4': Cross CPU Unsupported L4; 'cross_cpu_no_session': Cross CPU No Session Found; 'cross_cpu_helper_deleted': Cross CPU Helper Deleted; 'cross_cpu_helper_free_retry_lookup': Cross CPU Helper Free Retry Lookup; 'cross_cpu_helper_free_not_found': Cross CPU Helper Free Not Found; ", "enum":[ "all", "cross_cpu_helper_created", "cross_cpu_helper_free", "cross_cpu_sent", "cross_cpu_rcv", "cross_cpu_helper_nat_pool_standby", "cross_cpu_helper_cpu_mismatch", "cross_cpu_bad_l3", "cross_cpu_bad_l4", "cross_cpu_no_session", "cross_cpu_helper_deleted", "cross_cpu_helper_free_retry_lookup", "cross_cpu_helper_free_not_found" ] } } } ] } } }, "pool-list":{ "type":"array", "minItems":1, "items":{ "type":"pool" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/nat/pool/{pool-name}", "array":[ { "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 } }, "required":[ "pool-name" ] } ] }, "pool-group-list":{ "type":"array", "minItems":1, "items":{ "type":"pool-group" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/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, "$ref":"/axapi/v3/vrrp-a/vrid", "description":"Specify 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 }, "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; 'Failed': Failed; ", "enum":[ "all", "Failed" ] } } } ] }, "member-list":{ "type":"array", "minItems":1, "items":{ "type":"member" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/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 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" ] } ] }, "icmp":{ "type":"object", "$ref":"/axapi/v3/ip/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" } } }, "inside":{ "type":"object", "$ref":"/axapi/v3/ip/nat/inside", "properties":{ "source":{ "type":"object", "$ref":"/axapi/v3/ip/nat/inside/source", "properties":{ "class-list":{ "type":"object", "$ref":"/axapi/v3/ip/nat/inside/source/class-list", "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Class List Name" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "list":{ "type":"object", "$ref":"/axapi/v3/ip/nat/inside/source/list", "properties":{ "acl-id-list-list":{ "type":"array", "minItems":1, "items":{ "type":"acl-id-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/nat/inside/source/list/acl-id-list/{acl-id}", "array":[ { "properties":{ "acl-id":{ "type":"number", "format":"number", "minimum":1, "maximum":199, "partition-visibility":"shared", "$ref":"/axapi/v3/access-list/standard", "description":"Acl id", "optional":false }, "pool":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "description":"Pool or Pool Group (Pool or Pool Group Name)", "optional":true }, "msl":{ "type":"number", "format":"number", "minimum":1, "maximum":1800, "partition-visibility":"shared", "description":"Maximum Session Life Value", "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":[ "acl-id" ] } ] }, "acl-name-list-list":{ "type":"array", "minItems":1, "items":{ "type":"acl-name-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/nat/inside/source/list/acl-name-list/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":16, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/access-list", "description":"Apply an access list", "optional":false }, "pool":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "description":"Pool or Pool Group (Pool or Pool Group Nam)", "optional":true }, "msl":{ "type":"number", "format":"number", "minimum":1, "maximum":1800, "partition-visibility":"shared", "description":"Maximum Session Life Value", "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" ] } ] } } }, "static-list":{ "type":"array", "minItems":1, "items":{ "type":"static" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/nat/inside/source/static/{src-address}+{nat-address}", "array":[ { "properties":{ "src-address":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Original Source Address", "optional":false }, "nat-address":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"NAT Address", "optional":false }, "vrid":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "$ref":"/axapi/v3/vrrp-a/vrid", "description":"VRRP-A vrid (Specify ha VRRP-A vrid)", "optional":true }, "action":{ "type":"string", "format":"enum", "default":"enable", "partition-visibility":"shared", "description":"'enable': Enable static mapping (default); 'disable': Disable static mapping; ", "enum":[ "enable", "disable" ], "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", "nat-address" ] } ] } } } } }, "template":{ "type":"object", "$ref":"/axapi/v3/ip/nat/template", "properties":{ "logging-list":{ "type":"array", "minItems":1, "items":{ "type":"logging" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/nat/template/logging/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"NAT logging template name", "optional":false }, "log":{ "type":"object", "properties":{ "port-mappings":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'creation': Log creation of NAT mappgins; 'disable': Disable Log creation and deletion of NAT mappings; ", "enum":[ "creation", "disable" ] } } }, "include-destination":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include the destination IP and port in logs", "optional":true }, "include-rip-rport":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include the IP and port of real server in logs", "optional":true }, "facility":{ "type":"string", "format":"enum", "default":"local0", "partition-visibility":"shared", "description":"'kernel': 0: Kernel; 'user': 1: User-level; 'mail': 2: Mail; 'daemon': 3: System daemons; 'security-authorization': 4: Security/authorization; 'syslog': 5: Syslog internal; 'line-printer': 6: Line printer; 'news': 7: Network news; 'uucp': 8: UUCP subsystem; 'cron': 9: Time-related; 'security-authorization-private': 10: Private security/authorization; 'ftp': 11: FTP; 'ntp': 12: NTP; 'audit': 13: Audit; 'alert': 14: Alert; 'clock': 15: Clock-related; 'local0': 16: Local use 0; 'local1': 17: Local use 1; 'local2': 18: Local use 2; 'local3': 19: Local use 3; 'local4': 20: Local use 4; 'local5': 21: Local use 5; 'local6': 22: Local use 6; 'local7': 23: Local use 7; ", "enum":[ "kernel", "user", "mail", "daemon", "security-authorization", "syslog", "line-printer", "news", "uucp", "cron", "security-authorization-private", "ftp", "ntp", "audit", "alert", "clock", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7" ], "optional":true }, "severity":{ "type":"object", "properties":{ "severity-string":{ "type":"string", "format":"enum", "default":"debug", "partition-visibility":"shared", "not":"severity-val", "description":"'emergency': 0: Emergency; 'alert': 1: Alert; 'critical': 2: Critical; 'error': 3: Error; 'warning': 4: Warning; 'notice': 5: Notice; 'informational': 6: Informational; 'debug': 7: Debug; ", "enum":[ "emergency", "alert", "critical", "error", "warning", "notice", "informational", "debug" ] }, "severity-val":{ "type":"number", "format":"number", "minimum":0, "maximum":7, "default":7, "partition-visibility":"shared", "not":"severity-string", "description":"Logging severity level" } } }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Set NAT logging service-group", "optional":true }, "source-port":{ "type":"object", "properties":{ "source-port-num":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":514, "partition-visibility":"shared", "not":"any", "description":"Set source port for sending NAT syslogs (default: 514)" }, "any":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"source-port-num", "description":"Use any source port" } } }, "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" ] } ] } } }, "translation":{ "type":"object", "$ref":"/axapi/v3/ip/nat/translation", "properties":{ "icmp-timeout":{ "type":"object", "properties":{ "icmp-timeout":{ "type":"string", "format":"enum", "default":"fast", "partition-visibility":"shared", "description":"'age': Expiration time; 'fast': Use Fast aging; ", "enum":[ "age", "fast" ] }, "icmp-timeout-val":{ "type":"number", "format":"number", "minimum":2, "maximum":15000, "partition-visibility":"shared", "description":"Timeout in seconds (Interval of 60 seconds)" } } }, "tcp-timeout":{ "type":"number", "format":"number", "minimum":2, "maximum":15000, "default":300, "partition-visibility":"shared", "description":"TCP protocol extended translations (Timeout in seconds (Interval of 60 seconds), default is 300 seconds (5 minutes))" }, "udp-timeout":{ "type":"number", "format":"number", "minimum":2, "maximum":15000, "default":300, "partition-visibility":"shared", "description":"UDP protocol extended translations (Timeout in seconds (Interval of 60 seconds), default is 300 seconds (5 minutes))" }, "ignore-tcp-msl":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"reclaim TCP resource immediately without MSL" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "service-timeout-list":{ "type":"array", "minItems":1, "items":{ "type":"service-timeout" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/nat/translation/service-timeout/{service-type}+{port}", "array":[ { "properties":{ "service-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'tcp': TCP Protocol; 'udp': UDP Protocol; ", "enum":[ "tcp", "udp" ], "optional":false }, "port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Port Number", "optional":false }, "timeout-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'age': Expiration time; 'fast': Use Fast aging; ", "enum":[ "age", "fast" ], "optional":true }, "timeout-val":{ "type":"number", "format":"number", "minimum":2, "maximum":15000, "partition-visibility":"shared", "description":"Timeout in seconds (Interval of 60 seconds)", "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":[ "service-type", "port" ] } ] } } }, "range-list-list":{ "type":"array", "minItems":1, "items":{ "type":"range-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/nat/range-list/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "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 }, "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-acl-id":{ "type":"number", "format":"number", "minimum":1, "maximum":199, "partition-visibility":"shared", "description":"Access list ID", "optional":true }, "v4-acl-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":16, "partition-visibility":"shared", "description":"Access list name", "optional":true }, "v4-vrid":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "modify-not-allowed":1, "$ref":"/axapi/v3/vrrp-a/vrid", "description":"VRRP-A vrid (Specify ha VRRP-A vrid)", "optional":true }, "local-start-ipv6-addr":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "modify-not-allowed":1, "description":"Local Start IPv6 Address of this list", "optional":true }, "global-start-ipv6-addr":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "modify-not-allowed":1, "description":"Global Start IPv6 Address of this list", "optional":true }, "v6-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 }, "v6-acl-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":16, "partition-visibility":"shared", "description":"Access list name", "optional":true }, "v6-vrid":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "modify-not-allowed":1, "$ref":"/axapi/v3/vrrp-a/vrid", "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" ] } ] }, "alg":{ "type":"object", "$ref":"/axapi/v3/ip/nat/alg", "properties":{ "pptp":{ "type":"object", "$ref":"/axapi/v3/ip/nat/alg/pptp", "properties":{ "pptp":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'disable': Disable PPTP NAT ALG; 'enable': Enable PPTP NAT ALG; ", "enum":[ "disable", "enable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'current-smp-sessions': current-smp-sessions; 'current-gre-sessions': current-gre-sessions; 'smp-session-creation-failure': smp-session-creation-failure; 'truncated-pns-message': truncated-pns-message; 'truncated-pac-message': truncated-pac-message; 'mismatched-pns-call-id': mismatched-pns-call-id; 'mismatched-pac-call-id': mismatched-pac-call-id; 'retransmitted-pns-message': retransmitted-pns-message; 'retransmitted-pac-message': retransmitted-pac-message; 'truncated-gre-packet': truncated-gre-packet; 'unknown-gre-version': unknown-gre-version; 'no-matching-gre-session': no-matching-gre-session; ", "enum":[ "all", "current-smp-sessions", "current-gre-sessions", "smp-session-creation-failure", "truncated-pns-message", "truncated-pac-message", "mismatched-pns-call-id", "mismatched-pac-call-id", "retransmitted-pns-message", "retransmitted-pac-message", "truncated-gre-packet", "unknown-gre-version", "no-matching-gre-session" ] } } } ] } } }, "dns":{ "type":"object", "$ref":"/axapi/v3/ip/nat/alg/dns", "properties":{ "dns-alg":{ "type":"string", "format":"enum", "default":"enable", "partition-visibility":"shared", "description":"'disable': Disable DNS NAT ALG; 'enable': Enable DNS NAT ALG; ", "enum":[ "disable", "enable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } } } }