{ "id":"/axapi/v3/ip", "type":"object", "node-type":"intermediate", "title":"ip", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "auto-created-object":1, "description":"Global IP configuration subcommands", "properties":{ "address":{ "type":"object", "$ref":"/axapi/v3/ip/address", "properties":{ "ip-addr":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"IP address" }, "ip-mask":{ "type":"string", "format":"ipv4-netmask", "partition-visibility":"shared", "description":"IP subnet mask" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "default-gateway":{ "type":"object", "$ref":"/axapi/v3/ip/default-gateway", "properties":{ "gateway-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "$ref":"/axapi/v3/ip/address", "description":"Default gateway address" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "fib":{ "type":"object", "$ref":"/axapi/v3/ip/fib", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "fib-summary":{ "type":"object", "$ref":"/axapi/v3/ip/fib-summary", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "access-list-list":{ "type":"array", "minItems":1, "items":{ "type":"access-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/access-list/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":16, "partition-visibility":"shared", "description":"IP Access List Name. Does not support name as digits or start with digit.", "optional":false }, "rules":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "seq-num":{ "type":"number", "format":"number", "minimum":1, "maximum":8192, "partition-visibility":"shared", "description":"Sequence Number" }, "action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Deny; 'permit': Permit; 'l3-vlan-fwd-disable': Disable L3 forwarding between VLANs; ", "enum":[ "deny", "permit", "l3-vlan-fwd-disable" ] }, "remark":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Access list entry comment (Notes for this ACL)" }, "icmp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "tcp", "udp", "ip", "service-obj-group" ], "description":"Internet Control Message Protocol" }, "tcp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "icmp", "udp", "ip", "service-obj-group" ], "description":"protocol TCP" }, "udp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "icmp", "tcp", "ip", "service-obj-group" ], "description":"protocol UDP" }, "ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "icmp", "tcp", "udp", "service-obj-group" ], "description":"Any Internet Protocol" }, "service-obj-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not-list":[ "icmp", "tcp", "udp", "ip" ], "description":"Service object group (Source object group name)" }, "geo-location":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify geo-location name" }, "icmp-type":{ "type":"number", "format":"number", "minimum":0, "maximum":254, "partition-visibility":"shared", "not-list":[ "any-type", "special-type" ], "description":"ICMP type number" }, "any-type":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "icmp-type", "special-type" ], "description":"Any ICMP type" }, "special-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "icmp-type", "any-type" ], "description":"'echo-reply': Type 0, echo reply; 'echo-request': Type 8, echo request; 'info-reply': Type 16, information reply; 'info-request': Type 15, information request; 'mask-reply': Type 18, address mask reply; 'mask-request': Type 17, address mask request; 'parameter-problem': Type 12, parameter problem; 'redirect': Type 5, redirect message; 'source-quench': Type 4, source quench; 'time-exceeded': Type 11, time exceeded; 'timestamp': Type 13, timestamp; 'timestamp-reply': Type 14, timestamp reply; 'dest-unreachable': Type 3, destination unreachable; ", "enum":[ "echo-reply", "echo-request", "info-reply", "info-request", "mask-reply", "mask-request", "parameter-problem", "redirect", "source-quench", "time-exceeded", "timestamp", "timestamp-reply", "dest-unreachable" ] }, "any-code":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "icmp-code", "special-code" ], "description":"Any ICMP code" }, "icmp-code":{ "type":"number", "format":"number", "minimum":0, "maximum":254, "partition-visibility":"shared", "not-list":[ "any-code", "special-code" ], "description":"ICMP code number" }, "special-code":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "any-code", "icmp-code" ], "description":"'frag-required': Code 4, fragmentation required; 'host-unreachable': Code 1, destination host unreachable; 'network-unreachable': Code 0, destination network unreachable; 'port-unreachable': Code 3, destination port unreachable; 'proto-unreachable': Code 2, destination protocol unreachable; 'route-failed': Code 5, source route failed; ", "enum":[ "frag-required", "host-unreachable", "network-unreachable", "port-unreachable", "proto-unreachable", "route-failed" ] }, "src-any":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "src-host", "src-subnet", "src-object-group" ], "description":"Any source host" }, "src-host":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not-list":[ "src-any", "src-subnet", "src-object-group" ], "description":"A single source host (Host address)" }, "src-subnet":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not-list":[ "src-any", "src-host", "src-object-group" ], "description":"Source Address" }, "src-mask":{ "type":"string", "format":"ipv4-rev-netmask", "partition-visibility":"shared", "description":"Source Mask 0=apply 255=ignore" }, "src-object-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not-list":[ "src-any", "src-host", "src-subnet" ], "description":"Network object group (Source network object group name)" }, "src-eq":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "not-list":[ "src-gt", "src-lt", "src-range" ], "description":"Match only packets on a given source port (port number)" }, "src-gt":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "partition-visibility":"shared", "not-list":[ "src-eq", "src-lt", "src-range" ], "description":"Match only packets with a greater port number" }, "src-lt":{ "type":"number", "format":"number", "minimum":2, "maximum":65535, "partition-visibility":"shared", "not-list":[ "src-eq", "src-gt", "src-range" ], "description":"Match only packets with a lower port number" }, "src-range":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "not-list":[ "src-eq", "src-gt", "src-lt" ], "description":"match only packets in the range of port numbers (Starting Port Number)" }, "src-port-end":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Ending Port Number" }, "dst-any":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "dst-host", "dst-subnet", "dst-object-group" ], "description":"Any destination host" }, "dst-host":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not-list":[ "dst-any", "dst-subnet", "dst-object-group" ], "description":"A single destination host (Host address)" }, "dst-subnet":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not-list":[ "dst-any", "dst-host", "dst-object-group" ], "description":"Destination Address" }, "dst-mask":{ "type":"string", "format":"ipv4-rev-netmask", "partition-visibility":"shared", "description":"Destination Mask 0=apply 255=ignore" }, "dst-object-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not-list":[ "dst-any", "dst-host", "dst-subnet" ], "description":"Destination network object group name" }, "dst-eq":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "not-list":[ "dst-gt", "dst-lt", "dst-range" ], "description":"Match only packets on a given destination port (port number)" }, "dst-gt":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "partition-visibility":"shared", "not-list":[ "dst-eq", "dst-lt", "dst-range" ], "description":"Match only packets with a greater port number" }, "dst-lt":{ "type":"number", "format":"number", "minimum":2, "maximum":65535, "partition-visibility":"shared", "not-list":[ "dst-eq", "dst-gt", "dst-range" ], "description":"Match only packets with a lesser port number" }, "dst-range":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "not-list":[ "dst-eq", "dst-gt", "dst-lt" ], "description":"Match only packets in the range of port numbers (Starting Destination Port Number)" }, "dst-port-end":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Edning Destination Port Number" }, "fragments":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"IP fragments" }, "vlan":{ "type":"number", "format":"number", "minimum":1, "maximum":4094, "partition-visibility":"shared", "description":"VLAN ID" }, "ethernet":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet interface (Port number)" }, "trunk":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet trunk (trunk number)" }, "dscp":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "partition-visibility":"shared", "description":"DSCP" }, "established":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"TCP established" }, "acl-log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log matches against this entry" }, "transparent-session-only":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Only log transparent sessions" } } } ] }, "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" ] } ] }, "anomaly-drop":{ "type":"object", "$ref":"/axapi/v3/ip/anomaly-drop", "properties":{ "packet-deformity":{ "type":"object", "properties":{ "packet-deformity-layer-3":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop packets with layer 3 anomaly" }, "packet-deformity-layer-4":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop packets with layer 4 anomaly" } } }, "security-attack":{ "type":"object", "properties":{ "security-attack-layer-3":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop packets with layer 3 anomaly" }, "security-attack-layer-4":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop packets with layer 4 anomaly" } } }, "bad-content":{ "type":"number", "format":"number", "minimum":1, "maximum":127, "partition-visibility":"shared", "description":"bad content threshold (threshold value)" }, "drop-all":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop all IP anomaly packets" }, "frag":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop all fragmented packets" }, "ip-option":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop packets with IP options" }, "land-attack":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop IP packets with the same source and destination addresses" }, "out-of-sequence":{ "type":"number", "format":"number", "minimum":1, "maximum":127, "partition-visibility":"shared", "description":"out of sequence packet threshold (threshold value)" }, "ping-of-death":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop oversize ICMP packets" }, "tcp-no-flag":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop TCP packets with no flag" }, "tcp-syn-fin":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop TCP packets with both syn and fin flags set" }, "tcp-syn-frag":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"drop fragmented TCP packets with syn flag set" }, "zero-window":{ "type":"number", "format":"number", "minimum":1, "maximum":127, "partition-visibility":"shared", "description":"zero window size threshold (threshold value)" }, "ipv6-ext-header":{ "type":"object", "properties":{ "ipv6-eh-frag":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Filter fragmentation extension header" }, "ipv6-eh-auth":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Filter authentication extension header" }, "ipv6-eh-esp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Filter ESP extension header" }, "ipv6-eh-mobility":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Filter mobility extension header" }, "ipv6-eh-nonext":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Filter no-next-header extension header" }, "ipv6-eh-malformed":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Filter malformed extension headers (check for order and occurrences)" }, "ipv6-eh-hbh":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Filter hop by hop extension header" }, "ipv6-eh-dest":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Filter destination extension header" }, "ipv6-eh-routing":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Filter routing extension header" }, "hbh-option-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "hbh-otype-from":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Filter hop by hop option type (Option type value)" }, "hbh-otype-to":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Option type range end" } } } ] }, "dst-option-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "dst-otype-from":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Filter destination header option type (Option type value)" }, "dst-otype-to":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Option type range end" } } } ] }, "routing-option-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "routing-otype-from":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Filter routing header option type (Option type value)" }, "routing-otype-to":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Option type range end" } } } ] }, "unknown-ext-header-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "eh-type-from":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Filter unknown extension header (eh) type (Extension header type value)" }, "eh-type-to":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Extension header type range end" } } } ] } } }, "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; 'land': Land Attack Drop; 'emp_frg': Empty Fragment Drop; 'emp_mic_frg': Micro Fragment Drop; 'opt': IPv4 Options Drop; 'frg': IPv4 Fragment Drop; 'bad_ip_hdrlen': Bad IP Header Len Drop; 'bad_ip_flg': Bad IP Flags Drop; 'bad_ip_ttl': Bad IP TTL Drop; 'no_ip_payload': No IP Payload drop; 'over_ip_payload': Oversize IP Payload Drop; 'bad_ip_payload_len': Bad IP Payload Len Drop; 'bad_ip_frg_offset': Bad IP Fragment Offset Drop; 'csum': Bad IP Checksum Drop; 'pod': ICMP Ping of Death Drop; 'bad_tcp_urg_offset': TCP Bad Urgent Offset Drop; 'tcp_sht_hdr': TCP Short Header Drop; 'tcp_bad_iplen': TCP Bad IP Length Drop; 'tcp_null_frg': TCP Null Flags Drop; 'tcp_null_scan': TCP Null Scan Drop; 'tcp_syn_fin': TCP Syn and Fin Drop; 'tcp_xmas': TCP XMAS Flags Drop; 'tcp_xmas_scan': TCP XMAS Scan Drop; 'tcp_syn_frg': TCP Syn Fragment Drop; 'tcp_frg_hdr': TCP Fragmented Header Drop; 'tcp_bad_csum': TCP Bad Checksum Drop; 'udp_srt_hdr': UDP Short Header Drop; 'udp_bad_len': UDP Bad Length Drop; 'udp_kerb_frg': UDP Kerberos Fragment Drop; 'udp_port_lb': UDP Port Loopback Drop; 'udp_bad_csum': UDP Bad Checksum Drop; 'runt_ip_hdr': Runt IP Header Drop; 'runt_tcp_udp_hdr': Runt TCP/UDP Header Drop; 'ipip_tnl_msmtch': IP-over-IP Tunnel Mismatch Drop; 'tcp_opt_err': TCP Option Error Drop; 'ipip_tnl_err': IP-over-IP Tunnel Error Drop; 'vxlan_err': VXLAN Tunnel Error Drop; 'nvgre_err': GRE Tunnel Error Drop; 'gre_pptp_err': GRE PPTP Error Drop; 'ipv6_eh_hbh': IPv6 Hop by Hop Header Drop; 'ipv6_eh_dest': IPv6 Destination Header Drop; 'ipv6_eh_routing': IPv6 Routing Header Drop; 'ipv6_eh_frag': IPv6 Fragmentation Header Drop; 'ipv6_eh_ah': IPv6 Authentication Header Drop; 'ipv6_eh_esp': IPv6 ESP Header Drop; 'ipv6_eh_mobility': IPv6 Mobility Header Drop; 'ipv6_eh_none': IPv6 No Next Header Drop; 'ipv6_eh_other': IPv6 Unknown Extension Header Drop; 'ipv6_eh_malformed': IPv6 Malformed Extension Header Drop; ", "enum":[ "all", "land", "emp_frg", "emp_mic_frg", "opt", "frg", "bad_ip_hdrlen", "bad_ip_flg", "bad_ip_ttl", "no_ip_payload", "over_ip_payload", "bad_ip_payload_len", "bad_ip_frg_offset", "csum", "pod", "bad_tcp_urg_offset", "tcp_sht_hdr", "tcp_bad_iplen", "tcp_null_frg", "tcp_null_scan", "tcp_syn_fin", "tcp_xmas", "tcp_xmas_scan", "tcp_syn_frg", "tcp_frg_hdr", "tcp_bad_csum", "udp_srt_hdr", "udp_bad_len", "udp_kerb_frg", "udp_port_lb", "udp_bad_csum", "runt_ip_hdr", "runt_tcp_udp_hdr", "ipip_tnl_msmtch", "tcp_opt_err", "ipip_tnl_err", "vxlan_err", "nvgre_err", "gre_pptp_err", "ipv6_eh_hbh", "ipv6_eh_dest", "ipv6_eh_routing", "ipv6_eh_frag", "ipv6_eh_ah", "ipv6_eh_esp", "ipv6_eh_mobility", "ipv6_eh_none", "ipv6_eh_other", "ipv6_eh_malformed" ] } } } ] } } }, "mgmt-traffic-list":{ "type":"array", "minItems":1, "items":{ "type":"mgmt-traffic" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/mgmt-traffic/{traffic-type}", "array":[ { "properties":{ "traffic-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': All; 'ftp': FTP; 'ntp': NTP; 'snmp-trap': SNMP Trap; 'ssh': SSH and SCP; 'syslog': SYSLOG; 'telnet': Telnet; 'tftp': TFTP; 'web': Web - HTTP and HTTPS; ", "enum":[ "all", "ftp", "ntp", "snmp-trap", "ssh", "syslog", "telnet", "tftp", "web" ], "optional":false }, "source-interface":{ "type":"object", "properties":{ "loopback":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Loopback interface (Port number)" }, "ethernet":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet interface (Port number)" }, "ve":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Virtual ethernet interface (Virtual ethernet interface number)" }, "trunk":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Trunk interface (Trunk interface number)" }, "lif":{ "type":"number", "format":"number", "minimum":1, "maximum":128, "partition-visibility":"shared", "description":"Logical interface (Lif interface number)" }, "tunnel":{ "type":"number", "format":"number", "minimum":1, "maximum":128, "partition-visibility":"shared", "description":"Tunnel interface (Tunnel interface number)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "traffic-type" ] } ] }, "frag":{ "type":"object", "$ref":"/axapi/v3/ip/frag", "properties":{ "buff":{ "type":"number", "format":"number", "minimum":10000, "maximum":3000000, "partition-visibility":"shared", "description":"Max buff used for fragmentation (Buffer Value(10000-3000000))" }, "max-reassembly-sessions":{ "type":"number", "format":"number", "minimum":1, "maximum":200000, "partition-visibility":"shared", "description":"Max number of pending reassembly sessions allowed (default 100000)" }, "max-packets-per-reassembly":{ "type":"number", "format":"number", "minimum":2, "maximum":16, "partition-visibility":"shared", "description":"Max number of fragmented packets allowed per reassembly(0 is unlimited) (default 0)" }, "timeout":{ "type":"number", "format":"number", "minimum":4, "maximum":65535, "default":60000, "partition-visibility":"shared", "description":"Fragmentation timeout (in milliseconds 4 - 65535 (default is 60000))" }, "cpu-threshold":{ "type":"object", "properties":{ "high":{ "type":"number", "format":"number", "minimum":0, "maximum":100, "default":75, "partition-visibility":"shared", "description":"When CPU usage reaches this value, it will stop processing fragments (default: 75%)" }, "low":{ "type":"number", "format":"number", "minimum":0, "maximum":100, "default":60, "partition-visibility":"shared", "description":"When CPU usage remains under this value, it will resume processing fragments (default: 60%)" } } }, "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; 'session-inserted': Session Inserted; 'session-expired': Session Expired; 'icmp-rcv': ICMP Received; 'icmpv6-rcv': ICMPv6 Received; 'udp-rcv': UDP Received; 'tcp-rcv': TCP Received; 'ipip-rcv': IP-in-IP Received; 'ipv6ip-rcv': IPv6-in-IP Received; 'other-rcv': Other Received; 'icmp-dropped': ICMP Dropped; 'icmpv6-dropped': ICMPv6 Dropped; 'udp-dropped': UDP Dropped; 'tcp-dropped': TCP Dropped; 'ipip-dropped': IP-in-IP Dropped; 'ipv6ip-dropped': IPv6-in-IP Dropped; 'other-dropped': Other Dropped; 'overlap-error': Overlapping Fragment Dropped; 'bad-ip-len': Bad IP Length; 'too-small': Fragment Too Small Drop; 'first-tcp-too-small': First TCP Fragment Too Small Drop; 'first-l4-too-small': First L4 Fragment Too Small Drop; 'total-sessions-exceeded': Total Sessions Exceeded Drop; 'no-session-memory': Out of Session Memory; 'fast-aging-set': Fragmentation Fast Aging Set; 'fast-aging-unset': Fragmentation Fast Aging Unset; 'fragment-queue-success': Fragment Queue Success; 'unaligned-len': Payload Length Unaligned; 'exceeded-len': Payload Length Out of Bounds; 'duplicate-first-frag': Duplicate First Fragment; 'duplicate-last-frag': Duplicate Last Fragment; 'total-fragments-exceeded': Total Queued Fragments Exceeded; 'fragment-queue-failure': Fragment Queue Failure; 'reassembly-success': Fragment Reassembly Success; 'max-len-exceeded': Fragment Max Data Length Exceeded; 'reassembly-failure': Fragment Reassembly Failure; 'policy-drop': MTU Exceeded Policy Drop; 'error-drop': Fragment Processing Drop; 'high-cpu-threshold': High CPU Threshold Reached; 'low-cpu-threshold': Low CPU Threshold Reached; 'cpu-threshold-drop': High CPU Drop; 'ipd-entry-drop': DDoS Protection Drop; 'max-packets-exceeded': Too Many Packets Per Reassembly Drop; 'session-packets-exceeded': Session Max Packets Exceeded; 'frag-session-count': Fragmentation Session Count; 'sctp-rcv': SCTP Received; 'sctp-dropped': SCTP Dropped; 'first-gtp-packet-too-small': First GTP Fragment Too Small Drop; ", "enum":[ "all", "session-inserted", "session-expired", "icmp-rcv", "icmpv6-rcv", "udp-rcv", "tcp-rcv", "ipip-rcv", "ipv6ip-rcv", "other-rcv", "icmp-dropped", "icmpv6-dropped", "udp-dropped", "tcp-dropped", "ipip-dropped", "ipv6ip-dropped", "other-dropped", "overlap-error", "bad-ip-len", "too-small", "first-tcp-too-small", "first-l4-too-small", "total-sessions-exceeded", "no-session-memory", "fast-aging-set", "fast-aging-unset", "fragment-queue-success", "unaligned-len", "exceeded-len", "duplicate-first-frag", "duplicate-last-frag", "total-fragments-exceeded", "fragment-queue-failure", "reassembly-success", "max-len-exceeded", "reassembly-failure", "policy-drop", "error-drop", "high-cpu-threshold", "low-cpu-threshold", "cpu-threshold-drop", "ipd-entry-drop", "max-packets-exceeded", "session-packets-exceeded", "frag-session-count", "sctp-rcv", "sctp-dropped", "first-gtp-packet-too-small" ] } } } ] } } }, "tcp":{ "type":"object", "$ref":"/axapi/v3/ip/tcp", "properties":{ "syn-cookie":{ "type":"object", "properties":{ "threshold":{ "type":"number", "format":"number", "minimum":1, "maximum":100, "default":4, "partition-visibility":"shared", "description":"SYN cookie expire threshold (seconds (default is 4))" }, "sack-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable HW Syn-Cookie SACK support" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "route":{ "type":"object", "$ref":"/axapi/v3/ip/route", "properties":{ "static":{ "type":"object", "$ref":"/axapi/v3/ip/route/static", "properties":{ "bfd-list":{ "type":"array", "minItems":1, "items":{ "type":"bfd" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/route/static/bfd/{local-ip}+{nexthop-ip}", "array":[ { "properties":{ "local-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Local IP address", "optional":false }, "nexthop-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Nexthop IP address", "optional":false }, "template":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Configure tracking template (bind tracking template name)", "optional":true }, "threshold":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"action triggering threshold", "optional":true }, "action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'down': BFD down; (BFD state)", "enum":[ "down" ], "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":[ "local-ip", "nexthop-ip" ] } ] } } }, "source":{ "type":"object", "$ref":"/axapi/v3/ip/route/source", "properties":{ "ve-list":{ "type":"array", "minItems":1, "items":{ "type":"ve" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/route/source/ve/{ve-num}+{nexthop-ip}", "array":[ { "properties":{ "ve-num":{ "type":"number", "format":"number", "minimum":1, "maximum":4094, "partition-visibility":"shared", "optional":false }, "nexthop-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Nexthop IP address", "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":[ "ve-num", "nexthop-ip" ] } ] } } }, "rib-list":{ "type":"array", "minItems":1, "items":{ "type":"rib" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/route/rib/{ip-dest-addr}+{ip-mask}", "array":[ { "properties":{ "ip-dest-addr":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Destination prefix", "optional":false }, "ip-mask":{ "type":"string", "format":"ipv4-netmask-brief", "partition-visibility":"shared", "description":"Destination prefix mask", "optional":false }, "ip-nexthop-ipv4":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ip-next-hop":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Forwarding router's address" }, "distance-nexthop-ip":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "default":1, "partition-visibility":"shared", "description":"Distance value for this route" }, "description-nexthop-ip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Description for static route" } } } ] }, "ip-nexthop-lif":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "lif":{ "type":"string", "format":"string", "minLength":1, "maxLength":15, "partition-visibility":"shared", "description":"LIF Interface (Logical tunnel interface name)" }, "description-nexthop-lif":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Description for static route" } } } ] }, "ip-nexthop-tunnel":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "tunnel":{ "type":"number", "format":"number", "minimum":1, "maximum":128, "partition-visibility":"shared", "description":"Tunnel interface (Tunnel interface number)" }, "ip-next-hop-tunnel":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Forwarding router's address" }, "distance-nexthop-tunnel":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "default":1, "partition-visibility":"shared", "description":"Distance value for this route" }, "description-nexthop-tunnel":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Description for static route" } } } ] }, "ip-nexthop-partition":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "partition-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":14, "partition-visibility":"shared", "description":"Name of network partition" }, "vrid-num-in-partition":{ "type":"number", "format":"number", "minimum":0, "maximum":31, "partition-visibility":"shared", "description":"Specify ha VRRP-A vrid" }, "description-nexthop-partition":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Description for static route" }, "description-partition-vrid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Description for static route" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "ip-dest-addr", "ip-mask" ] } ] } } }, "dns":{ "type":"object", "$ref":"/axapi/v3/ip/dns", "properties":{ "primary":{ "type":"object", "$ref":"/axapi/v3/ip/dns/primary", "properties":{ "ip-v4-addr":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not":"ip-v6-addr", "description":"DNS server address" }, "ip-v6-addr":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"ip-v4-addr", "description":"DNS server address" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "secondary":{ "type":"object", "$ref":"/axapi/v3/ip/dns/secondary", "properties":{ "ip-v4-addr":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not":"ip-v6-addr", "description":"DNS server address" }, "ip-v6-addr":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"ip-v4-addr", "description":"DNS server address" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "suffix":{ "type":"object", "$ref":"/axapi/v3/ip/dns/suffix", "properties":{ "domain-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":32, "partition-visibility":"shared", "description":"DNS suffix" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "icmp":{ "type":"object", "$ref":"/axapi/v3/ip/icmp", "properties":{ "redirect":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable outbound ICMP redirect messages" }, "unreachable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable outbound ICMP unreachable messages" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "map-list-list":{ "type":"array", "minItems":1, "items":{ "type":"map-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/map-list/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify name of the IP Map List", "optional":false }, "file":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Create/Edit a IP Map List stored as a file", "optional":true }, "mapping-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "local-start-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Local Start IPv4 Address of this list" }, "global-start-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Global Start IPv4 Address of this list" }, "count":{ "type":"number", "format":"number", "minimum":1, "maximum":16777216, "partition-visibility":"shared", "description":"Number of addresses to be translated in this range" } } } ] }, "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" ] } ] }, "nat":{ "type":"object", "$ref":"/axapi/v3/ip/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-list":["/axapi/v3/access-list/standard", "/axapi/v3/access-list/extended"], "description":"Acl id", "optional":false }, "pool":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref-list":["/axapi/v3/ip/nat/pool", "/axapi/v3/ip/nat/pool-group"], "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-list":["/axapi/v3/ip/nat/pool", "/axapi/v3/ip/nat/pool-group"], "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" } } } } } } }, "nat-global":{ "type":"object", "$ref":"/axapi/v3/ip/nat-global", "properties":{ "reset-idle-tcp-conn":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Reset Idle TCP Connections" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "reroute":{ "type":"object", "$ref":"/axapi/v3/ip/reroute", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "suppress-protocols":{ "type":"object", "$ref":"/axapi/v3/ip/reroute/suppress-protocols", "properties":{ "ospf":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"OSPF" }, "ebgp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"EBGP" }, "ibgp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"IBGP" }, "static":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared" }, "isis":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"ISIS" }, "rip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"RIP" }, "connected":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "unnumbered":{ "type":"object", "$ref":"/axapi/v3/ip/unnumbered", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "use-source-ip":{ "type":"object", "$ref":"/axapi/v3/ip/unnumbered/use-source-ip", "properties":{ "update-source-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"IP address" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "telemetry":{ "type":"object", "$ref":"/axapi/v3/ip/telemetry", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "prefix-list-list":{ "type":"array", "minItems":1, "items":{ "type":"prefix-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/prefix-list/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Name of a prefix list", "optional":false }, "rules":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "seq":{ "type":"number", "format":"number", "minimum":1, "maximum":4294967295, "partition-visibility":"shared", "description":"Sequence number of an entry" }, "description":{ "type":"string", "format":"string", "minLength":1, "maxLength":80, "partition-visibility":"shared", "description":"Prefix-list specific description (Up to 80 characters describing this prefix-list)" }, "action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify packets to reject; 'permit': Specify packets to forward; ", "enum":[ "deny", "permit" ] }, "any":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Any prefix match. Same as \"0.0.0.0/0 le 32\"" }, "ipaddr":{ "type":"string", "format":"ipv4-cidr", "partition-visibility":"shared", "description":"IP prefix, e.g., 35.0.0.0/8" }, "ge":{ "type":"number", "format":"number", "minimum":0, "maximum":32, "partition-visibility":"shared", "description":"Minimum prefix length to be matched" }, "le":{ "type":"number", "format":"number", "minimum":0, "maximum":32, "partition-visibility":"shared", "description":"Maximum prefix length to be matched" } } } ] }, "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" ] } ] }, "rib":{ "type":"object", "$ref":"/axapi/v3/ip/rib", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "as-path-list":{ "type":"array", "minItems":1, "items":{ "type":"as-path" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/as-path/{access-list}+{action}+{value}", "array":[ { "properties":{ "access-list":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Specify an access list name (Regular expression access-list name)", "optional":false }, "action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify packets to reject; 'permit': Specify packets to forward; ", "enum":[ "deny", "permit" ], "optional":false }, "value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"A regular-expression to match the BGP AS paths", "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":[ "access-list", "action", "value" ] } ] }, "community-list":{ "type":"object", "$ref":"/axapi/v3/ip/community-list", "properties":{ "standard-num-list":{ "type":"array", "minItems":1, "items":{ "type":"standard-num" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/community-list/standard-num/{std-list-num}", "array":[ { "properties":{ "std-list-num":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "partition-visibility":"shared", "description":"Community list number (standard)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "std-list-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify community to reject; 'permit': Specify community to accept; ", "enum":[ "deny", "permit" ] }, "std-list-comm-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "std-list-num" ] } ] }, "expanded-num-list":{ "type":"array", "minItems":1, "items":{ "type":"expanded-num" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/community-list/expanded-num/{ext-list-num}", "array":[ { "properties":{ "ext-list-num":{ "type":"number", "format":"number", "minimum":100, "maximum":199, "partition-visibility":"shared", "description":"Community list number (expanded)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ext-list-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify community to reject; 'permit': Specify community to accept; ", "enum":[ "deny", "permit" ] }, "ext-list-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"An ordered list as a regular-expression" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "ext-list-num" ] } ] }, "standard-list":{ "type":"array", "minItems":1, "items":{ "type":"standard" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/community-list/standard/{standard}", "array":[ { "properties":{ "standard":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Add a standard community-list entry (Community list name)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "standard-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify community to reject; 'permit': Specify community to accept; ", "enum":[ "deny", "permit" ] }, "standard-comm-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "standard" ] } ] }, "expanded-list":{ "type":"array", "minItems":1, "items":{ "type":"expanded" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/community-list/expanded/{expanded}", "array":[ { "properties":{ "expanded":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Add an expanded community-list entry (Community list name)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "expanded-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify community to reject; 'permit': Specify community to accept; ", "enum":[ "deny", "permit" ] }, "expanded-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"An ordered list as a regular-expression" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "expanded" ] } ] } } }, "extcommunity-list":{ "type":"object", "$ref":"/axapi/v3/ip/extcommunity-list", "properties":{ "standard-num-list":{ "type":"array", "minItems":1, "items":{ "type":"standard-num" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/extcommunity-list/standard-num/{std-list-num}", "array":[ { "properties":{ "std-list-num":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "partition-visibility":"shared", "description":"Extended Community list number (standard)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "std-list-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify community to reject; 'permit': Specify community to accept; ", "enum":[ "deny", "permit" ] }, "std-list-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"rt Route Target extended community in aa:nn or IPaddr:nn format OR soo Site-of-Origin extended community in aa:nn or IPaddr:nn " } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "std-list-num" ] } ] }, "expanded-num-list":{ "type":"array", "minItems":1, "items":{ "type":"expanded-num" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/extcommunity-list/expanded-num/{ext-list-num}", "array":[ { "properties":{ "ext-list-num":{ "type":"number", "format":"number", "minimum":100, "maximum":199, "partition-visibility":"shared", "description":"Extended Community list number (expanded)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ext-list-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify community to reject; 'permit': Specify community to accept; ", "enum":[ "deny", "permit" ] }, "ext-list-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"An ordered list as a regular-expression" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "ext-list-num" ] } ] }, "standard-list":{ "type":"array", "minItems":1, "items":{ "type":"standard" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/extcommunity-list/standard/{standard}", "array":[ { "properties":{ "standard":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Add a standard extcommunity-list entry (Extended Community list name)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "standard-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify community to reject; 'permit': Specify community to accept; ", "enum":[ "deny", "permit" ] }, "standard-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"rt Route Target extended community in aa:nn or IPaddr:nn format OR soo Site-of-Origin extended community in aa:nn or IPaddr:nn " } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "standard" ] } ] }, "expanded-list":{ "type":"array", "minItems":1, "items":{ "type":"expanded" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/extcommunity-list/expanded/{expanded}", "array":[ { "properties":{ "expanded":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Add an expanded extcommunity-list entry (Extended Community list name)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "expanded-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify community to reject; 'permit': Specify community to accept; ", "enum":[ "deny", "permit" ] }, "expanded-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"An ordered list as a regular-expression" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "expanded" ] } ] } } }, "large-community-list":{ "type":"object", "$ref":"/axapi/v3/ip/large-community-list", "properties":{ "standard-num-list":{ "type":"array", "minItems":1, "items":{ "type":"standard-num" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/large-community-list/standard-num/{std-list-num}", "array":[ { "properties":{ "std-list-num":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "partition-visibility":"shared", "description":"Large Community list number (standard)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "std-list-lcom-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify large community to reject; 'permit': Specify large community to accept; ", "enum":[ "deny", "permit" ] }, "std-list-lcomm-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"Large community value in the format XX:YY:ZZ" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "std-list-num" ] } ] }, "expanded-num-list":{ "type":"array", "minItems":1, "items":{ "type":"expanded-num" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/large-community-list/expanded-num/{ext-list-num}", "array":[ { "properties":{ "ext-list-num":{ "type":"number", "format":"number", "minimum":100, "maximum":199, "partition-visibility":"shared", "description":"Large community list number (expanded)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ext-list-lcom-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify large community to reject; 'permit': Specify large community to accept; ", "enum":[ "deny", "permit" ] }, "ext-list-lcom-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"An ordered list as a regular-expression" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "ext-list-num" ] } ] }, "standard-list":{ "type":"array", "minItems":1, "items":{ "type":"standard" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/large-community-list/standard/{standard}", "array":[ { "properties":{ "standard":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Add a standard large community-list entry (Large community list name)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "standard-lcom-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify large community to reject; 'permit': Specify large community to accept; ", "enum":[ "deny", "permit" ] }, "standard-lcomm-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"Large community value in the format XX:YY:ZZ" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "standard" ] } ] }, "expanded-list":{ "type":"array", "minItems":1, "items":{ "type":"expanded" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/large-community-list/expanded/{expanded}", "array":[ { "properties":{ "expanded":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Add an expanded large community-list entry (Large community list name)", "optional":false }, "rules-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "expanded-lcom-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'deny': Specify large community to reject; 'permit': Specify large community to accept; ", "enum":[ "deny", "permit" ] }, "expanded-lcom-value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"An ordered list as a regular-expression" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "expanded" ] } ] } } }, "app-protocol-port":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port", "properties":{ "monitor":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/monitor", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enables global port processing" }, "disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enables global port processing" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "tcp":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/tcp", "properties":{ "passthrough":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/tcp/passthrough", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enables passthrough mode" }, "disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable passthrough mode" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "port":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/tcp/port", "properties":{ "add-list":{ "type":"array", "minItems":1, "items":{ "type":"add" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/app-protocol-port/tcp/port/add/{port}", "array":[ { "properties":{ "port":{ "type":"number", "format":"number", "minimum":0, "maximum":65534, "partition-visibility":"shared", "description":"Port Number", "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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "app-name-list":{ "type":"array", "minItems":1, "items":{ "type":"app-name" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/app-protocol-port/tcp/port/add/{port}/app-name/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Application Protocol Port 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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "interface":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/tcp/port/add/{port}/app-name/{name}/interface", "properties":{ "management":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Management Interface" }, "ve-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ve-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"VE port (VE Interface number)" }, "ve-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"VE port" } } } ] }, "eth-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ethernet-start":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet port (Ethernet Interface number)" }, "ethernet-end":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet port" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] } }, "required":[ "port" ] } ] }, "disable-list":{ "type":"array", "minItems":1, "items":{ "type":"disable" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/app-protocol-port/tcp/port/disable/{port}", "array":[ { "properties":{ "port":{ "type":"number", "format":"number", "minimum":0, "maximum":65534, "partition-visibility":"shared", "description":"Port Number", "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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "interface":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/tcp/port/disable/{port}/interface", "properties":{ "management":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Management Interface" }, "ve-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ve-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"VE port (VE Interface number)" }, "ve-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"VE port" } } } ] }, "eth-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ethernet-start":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet port (Ethernet Interface number)" }, "ethernet-end":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet port" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "port" ] } ] } } } } }, "udp":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/udp", "properties":{ "passthrough":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/udp/passthrough", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enables global port processing" }, "disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable global port processing" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "port":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/udp/port", "properties":{ "add-list":{ "type":"array", "minItems":1, "items":{ "type":"add" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/app-protocol-port/udp/port/add/{port}", "array":[ { "properties":{ "port":{ "type":"number", "format":"number", "minimum":0, "maximum":65534, "partition-visibility":"shared", "description":"Port Number", "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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "app-name-list":{ "type":"array", "minItems":1, "items":{ "type":"app-name" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/app-protocol-port/udp/port/add/{port}/app-name/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Application Protocol Port 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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "interface":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/udp/port/add/{port}/app-name/{name}/interface", "properties":{ "management":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Management Interface" }, "ve-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ve-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"VE port (VE Interface number)" }, "ve-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"VE port" } } } ] }, "eth-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ethernet-start":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet port (Ethernet Interface number)" }, "ethernet-end":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet port" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] } }, "required":[ "port" ] } ] }, "disable-list":{ "type":"array", "minItems":1, "items":{ "type":"disable" }, "uniqueItems":true, "$ref":"/axapi/v3/ip/app-protocol-port/udp/port/disable/{port}", "array":[ { "properties":{ "port":{ "type":"number", "format":"number", "minimum":0, "maximum":65534, "partition-visibility":"shared", "description":"Port Number", "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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "interface":{ "type":"object", "$ref":"/axapi/v3/ip/app-protocol-port/udp/port/disable/{port}/interface", "properties":{ "management":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Management Interface" }, "ve-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ve-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"VE port (VE Interface number)" }, "ve-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"VE port" } } } ] }, "eth-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ethernet-start":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet port (Ethernet Interface number)" }, "ethernet-end":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet port" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "port" ] } ] } } } } } } } } }