{ "id":"/axapi/v3/ddos", "type":"object", "node-type":"intermediate", "title":"ddos", "operation-not-allowed": ["PUT", "POST", "DELETE"], "auto-created-object":1, "description":"DDOS feature", "properties":{ "protection":{ "type":"object", "$ref":"/axapi/v3/ddos/protection", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"disable", "description":"'enable': enable; 'disable': disable; ", "enum":[ "enable", "disable" ] }, "rate-interval":{ "type":"string", "format":"enum", "default":"100ms", "description":"'100ms': 100ms; '1sec': 1sec; ", "enum":[ "100ms", "1sec" ] }, "traffic-distribution-mode":{ "type":"string", "format":"enum", "plat-pos-list":["chassis-duo"], "default":"dest-ip-based", "description":"'dest-ip-based': Distribute traffic to one slot using default distribution mechanism (Destination IP based); 'source-ip-based': Distribute traffic between slots, based on source ip; ", "enum":[ "dest-ip-based", "source-ip-based" ] }, "interblade-sync-accuracy":{ "type":"string", "format":"enum", "default":"Medium", "description":"'High': Enforced limit will be the same as configured value, but has worst under-commit issue in certain situations; 'Medium': Enforced limit is close to configured value, but has worse under-commit issue in certain situations; 'Low': Enforced limit is less close to configured value, but has least under-commit issue in certain situations; ", "enum":[ "High", "Medium", "Low" ] }, "force-routing-on-transp":{ "type":"number", "format":"flag", "default":0, "description":"Force use of routing in transparent mode" }, "disable-on-reboot":{ "type":"number", "format":"flag", "default":0, "description":"Disable DDoS protection upon reboot/reload" }, "use-route":{ "type":"number", "format":"flag", "default":0, "description":"Use route table, default use receive hop for device initiated traffic" }, "enable-now":{ "type":"number", "format":"flag", "default":0, "description":"Override disable-on-reboot to enable runtime DDOS protection" }, "mpls":{ "type":"number", "format":"flag", "default":0, "description":"Enable MPLS packet inspection" }, "fast-aging":{ "type":"object", "properties":{ "half-open-conn-ratio":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "default":25, "description":"Minimum half-open session to total session ratio before session fast aging will take effect (default 25)" }, "half-open-conn-threshold":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "default":1, "description":"Minimum half-open session (percentage) before session fast aging will take effect (default 1)" } } }, "src-dst-entry-limit":{ "type":"string", "format":"enum", "default":"16M", "description":"'8M': 8 Million; '16M': 16 Million; 'unlimited': Unlimited; 'platform-default': Half of platform maximum; ", "enum":[ "8M", "16M", "unlimited", "platform-default" ] }, "src-zone-port-entry-limit":{ "type":"string", "format":"enum", "default":"16M", "description":"'8M': 8 Million; '16M': 16 Million; 'unlimited': Unlimited; 'platform-default': Half of platform maximum; ", "enum":[ "8M", "16M", "unlimited", "platform-default" ] }, "hw-blocking-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable hardware blacklist blocking for src or dst default entries (default disabled)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "dns-cache-mode":{ "type":"object", "$ref":"/axapi/v3/ddos/dns-cache-mode", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable DNS Cache mode" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "signature-extraction":{ "type":"object", "$ref":"/axapi/v3/ddos/signature-extraction", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable Automatic Signature Extraction" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "pattern-recognition":{ "type":"object", "$ref":"/axapi/v3/ddos/pattern-recognition", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"disable", "description":"'enable': Enable Pattern Recognition; 'disable': Disable Pattern Recognition; ", "enum":[ "enable", "disable" ] }, "dedicated-cpus":{ "type":"number", "format":"number", "minimum":0, "maximum":6, "description":"Configure the number of dedicated cores for Pattern Recognition" }, "hardware-filter":{ "type":"string", "format":"enum", "plat-pos-list":["chassis-single"], "default":"disable", "description":"'enable': Enable Pattern Recognition hardware filter; 'disable': Disable Pattern Recognition harware filter; ", "enum":[ "enable", "disable" ] }, "sflow-event-periodic-interval":{ "type":"number", "format":"number", "minimum":0, "maximum":120, "default":5, "description":"Configure the interval in minutes of periodic event (Default: 5 minutes, 0: No periodic updates)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "cpu":{ "type":"object", "$ref":"/axapi/v3/ddos/pattern-recognition/cpu", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "event-filter-list":{ "type":"array", "minItems":1, "items":{ "type":"event-filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/event-filter/{filter-name}", "array":[ { "properties":{ "filter-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "drop":{ "type":"object", "properties":{ "drop-src":{ "type":"number", "format":"flag", "default":0, "description":"Packet is dropped because of src" }, "drop-dst":{ "type":"number", "format":"flag", "default":0, "description":"Packet is dropped because of dst" }, "drop-black-list":{ "type":"number", "format":"flag", "default":0, "description":"Packet is dropped because of black-list" } } }, "black-list":{ "type":"object", "properties":{ "black-list-dst":{ "type":"number", "format":"flag", "default":0, "description":"Dst entry/port is black-listed" }, "black-list-src":{ "type":"number", "format":"flag", "default":0, "description":"Src entry/port is black-listed" } } }, "white-list":{ "type":"object", "properties":{ "white-list-dst":{ "type":"number", "format":"flag", "default":0, "description":"Dst entry/port is white-listed" }, "white-list-src":{ "type":"number", "format":"flag", "default":0, "description":"Src entry/port is white-listed" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/event-filter/{filter-name}/l4-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; ", "enum":[ "tcp", "udp" ], "optional":false }, "tcp-auth":{ "type":"object", "properties":{ "tcp-auth-init":{ "type":"number", "format":"flag", "default":0, "description":"Packet that inits syn-auth/action-on-ack" }, "tcp-auth-pass":{ "type":"number", "format":"flag", "default":0, "description":"Packet that passes syn-auth/action-on-ack" }, "tcp-auth-fail":{ "type":"number", "format":"flag", "default":0, "description":"Packet that fails syn-auth/action-on-ack" } } }, "retrans-syn-cfg":{ "type":"object", "properties":{ "retrans-syn":{ "type":"number", "format":"flag", "default":0, "description":"TCP SYN retransmission" }, "retrans-syn-exceed":{ "type":"number", "format":"flag", "default":0, "description":"TCP SYN retransmission exceed" } } }, "out-of-seq":{ "type":"number", "format":"flag", "default":0, "description":"TCP out-of-seq pkts", "optional":true }, "zero-window":{ "type":"number", "format":"flag", "default":0, "description":"TCP zero window pkts", "optional":true }, "udp-auth":{ "type":"object", "properties":{ "udp-auth-init":{ "type":"number", "format":"flag", "default":0, "description":"Packet that inits spoof-detect" }, "udp-auth-pass":{ "type":"number", "format":"flag", "default":0, "description":"Packet that passes spoof-detect" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } }, "required":[ "filter-name" ] } ] }, "detection":{ "type":"object", "$ref":"/axapi/v3/ddos/detection", "properties":{ "disable":{ "type":"number", "format":"flag", "default":0, "description":"Disable DDoS detection (default: enabled)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "resource-usage":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/resource-usage", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "ddos-script":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/ddos-script", "properties":{ "file":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "description":"startup-config local file name" }, "action":{ "type":"string", "format":"enum", "description":"'delete': delete; ", "enum":[ "delete" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "settings":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/settings", "properties":{ "detector-mode":{ "type":"string", "format":"enum", "description":"'standalone': Standalone detector; 'on-box': Mitigator and Detector on the same box; 'auto-svc-discovery': Auto Service discovery using Visibility module; ", "enum":[ "standalone", "on-box", "auto-svc-discovery" ] }, "dedicated-cpus":{ "type":"number", "format":"number", "minimum":1, "maximum":32, "description":"Configure the number of dedicated cores for detection" }, "pkt-sampling":{ "type":"object", "properties":{ "override-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":50000000, "description":"Sample 1 in X packets (default: X=1)" }, "assign-index":{ "type":"number", "format":"number", "minimum":1, "maximum":64, "description":"Lower index is more aggressive sampling" }, "assign-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":50000000, "description":"Assign rate to given index" } } }, "detection-window-size":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "default":1, "description":"Configure detection window size in seconds (DDoS detection window size in seconds(default: 1))" }, "export-interval":{ "type":"number", "format":"number", "minimum":20, "maximum":3000, "default":20, "description":"Configure Baselining and export interval in seconds (DDoS Baselining and export interval in seconds(default: 20))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "standalone-settings":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/settings/standalone-settings", "properties":{ "de-escalation-quiet-time":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "description":"Configure de-escalation needed time in minutes from level 1 to 0.(default 6 minutes)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "sflow":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/settings/standalone-settings/sflow", "properties":{ "listening-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":6343, "description":"sFlow port to receive packets (sFlow port number(default 6343))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "netflow":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/settings/standalone-settings/netflow", "properties":{ "listening-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":9996, "description":"Netflow port to receive packets (Netflow port number(default 9996))" }, "template-active-timeout":{ "type":"number", "format":"number", "minimum":2, "maximum":300, "default":30, "description":"Configure active timeout of the netflow templates received in mins (Template active timeout(mins)(default 30mins))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } } } }, "agent-list":{ "type":"array", "minItems":1, "items":{ "type":"agent" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/detection/agent/{agent-name}", "array":[ { "properties":{ "agent-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Specify name for the agent", "optional":false }, "agent-v4-addr":{ "type":"string", "format":"ipv4-address", "description":"Configure agent's IPv4 address", "optional":true }, "agent-v6-addr":{ "type":"string", "format":"ipv6-address", "description":"Configure agent's IPv6 address", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "sflow":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/agent/{agent-name}/sflow", "properties":{ "sflow-pkt-samples-collection":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': Enable sflow packet samples collection(default); 'disable': Disable sflow packet samples collection; ", "enum":[ "enable", "disable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "netflow":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/agent/{agent-name}/netflow", "properties":{ "netflow-samples-collection":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': Enable Netflow flow samples collection(default); 'disable': Disable Netflow flow samples collection; ", "enum":[ "enable", "disable" ] }, "netflow-sampling-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":1, "description":"Configure agent's netflow sampling rate" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "agent-name" ] } ] }, "cpu-info":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/cpu-info", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "stat":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/stat", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "statistics":{ "type":"object", "$ref":"/axapi/v3/ddos/detection/statistics", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "dynamic-class-list":{ "type":"object", "$ref":"/axapi/v3/ddos/dynamic-class-list", "properties":{ "class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Specify name of the class list" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "resource-tracking":{ "type":"object", "$ref":"/axapi/v3/ddos/resource-tracking", "properties":{ "cpu":{ "type":"object", "$ref":"/axapi/v3/ddos/resource-tracking/cpu", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable CPU usage tracking per dst object (default: disabled)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "system-default":{ "type":"object", "$ref":"/axapi/v3/ddos/system-default", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "limit-list":{ "type":"array", "minItems":1, "items":{ "type":"limit" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/system-default/limit/{limit-type}", "array":[ { "properties":{ "limit-type":{ "type":"string", "format":"enum", "description":"'dst-entry': dst-entry; 'dst-icmp': dst-icmp; 'dst-other': dst-other; 'dst-tcp': dst-tcp; 'dst-udp': dst-udp; 'src-entry': src-entry; 'src-icmp': src-icmp; 'src-other': src-other; 'src-tcp': src-tcp; 'src-udp': src-udp; ", "enum":[ "dst-entry", "dst-icmp", "dst-other", "dst-tcp", "dst-udp", "src-entry", "src-icmp", "src-other", "src-tcp", "src-udp" ], "optional":false }, "default-over-limit-action":{ "type":"object", "properties":{ "drop":{ "type":"number", "format":"flag", "default":0, "description":"Silently Drop the new connection / new packet when it exceeds limit" } } }, "default-pkt-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Configure Default Packet rate limit", "optional":true }, "default-bit-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Configure Default Kibit (kibibit / 1024-bit) rate limit", "optional":true }, "default-frag-pkt-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Configure Default Fragmented packet rate limit", "optional":true }, "default-conn-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Configure Default Connection limit", "optional":true }, "default-conn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Configure Default Connection rate limit", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "limit-type" ] } ] } } }, "resource-usage":{ "type":"object", "$ref":"/axapi/v3/ddos/resource-usage", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "reporting":{ "type":"object", "$ref":"/axapi/v3/ddos/reporting", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"reject-on-limit-reached", "description":"'disable-on-limit-reached': Disable reporting on DST/Port entry when the max reporting count is reached; 'reject-on-limit-reached': Reject the configuration when the max reporting count is reached; ", "enum":[ "disable-on-limit-reached", "reject-on-limit-reached" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "zone-template":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-template", "properties":{ "encap-list":{ "type":"array", "minItems":1, "items":{ "type":"encap" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/encap/{encap-tmpl-name}", "array":[ { "properties":{ "encap-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS Tunnel Template Name", "optional":false }, "tunnel-encap":{ "type":"object", "properties":{ "ip-cfg":{ "type":"object", "properties":{ "ip-encap":{ "type":"number", "format":"flag", "default":0, "description":"Enable Tunnel encapsulation using IP in IP" }, "always":{ "type":"object", "properties":{ "ipv4-addr":{ "type":"string", "format":"ipv4-address", "description":"IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "ipv6-addr":{ "type":"string", "format":"ipv6-address", "description":"IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } } } }, "gre-cfg":{ "type":"object", "properties":{ "gre-encap":{ "type":"number", "format":"flag", "default":0, "description":"Enable Tunnel encapsulation using GRE" }, "gre-always":{ "type":"object", "properties":{ "gre-ipv4":{ "type":"string", "format":"ipv4-address", "description":"IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "key-ipv4":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "gre-ipv6":{ "type":"string", "format":"ipv6-address", "description":"IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "key-ipv6":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" } } } } } } }, "preserve-source-ip":{ "type":"number", "format":"flag", "default":0, "description":"Use original source ip for encapsulation", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "encap-tmpl-name" ] } ] }, "logging-list":{ "type":"array", "minItems":1, "items":{ "type":"logging" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/logging/{logging-tmpl-name}", "array":[ { "properties":{ "logging-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "default":"default", "description":"DDOS Logging Template Name", "optional":false }, "log-format-cef":{ "type":"number", "format":"flag", "default":0, "description":"Log in CEF format", "optional":true }, "use-obj-name":{ "type":"number", "format":"flag", "default":0, "description":"Show obj name instead of ip in the log", "optional":true }, "log-format-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":512, "description":"Customize log format", "optional":true }, "enable-action-logging":{ "type":"number", "format":"flag", "default":0, "description":"Log action taken", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "logging-tmpl-name" ] } ] }, "ssl-l4-list":{ "type":"array", "minItems":1, "items":{ "type":"ssl-l4" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/ssl-l4/{ssl-l4-tmpl-name}", "array":[ { "properties":{ "ssl-l4-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "renegotiation":{ "type":"object", "properties":{ "num-renegotiation":{ "type":"number", "format":"number", "minimum":0, "maximum":7, "description":"Number of renegotiation allowed" }, "ssl-l4-reneg-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"ssl-l4-reneg-action", "description":"Configure action-list to take" }, "ssl-l4-reneg-action":{ "type":"string", "format":"enum", "not":"ssl-l4-reneg-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "blacklist-src", "reset" ] } } }, "allow-non-tls":{ "type":"number", "format":"flag", "default":0, "description":"Allow Non-TLS (SSLv3 and lower) traffic (Warning: security may be compromised)", "optional":true }, "auth-handshake":{ "type":"object", "properties":{ "auth-handshake-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "default":5, "description":"Connection timeout (default 5 seconds) and trials (default 5 times) (DST support only)" }, "auth-handshake-trials":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":5, "description":"Number of failed handshakes before entry marked black" }, "cert-cfg":{ "type":"object", "properties":{ "cert":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "description":"SSL certificate" }, "key":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "description":"SSL key" }, "key-passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "description":"Password Phrase" }, "key-encrypted":{ "type":"encrypted", "format":"encrypted", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" } } }, "server-name-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "server-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "description":"Server name indication in Client hello extension (Server name String)" }, "server-cert":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "description":"Server Certificate associated to SNI (Server Certificate Name)" }, "server-key":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "description":"Server Private Key associated to SNI (Server Private Key Name)" }, "server-passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "description":"Password Phrase" }, "server-encrypted":{ "type":"encrypted", "format":"encrypted", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "optional":true } } ] }, "auth-handshake-pass-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"auth-handshake-pass-action", "description":"Configure action-list to take for passing the authentication" }, "auth-handshake-pass-action":{ "type":"string", "format":"enum", "not":"auth-handshake-pass-action-list-name", "description":"'authenticate-src': authenticate-src (Default); ", "enum":[ "authenticate-src" ] }, "auth-handshake-fail-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"auth-handshake-fail-action", "description":"Configure action-list to take for failing the authentication" }, "auth-handshake-fail-action":{ "type":"string", "format":"enum", "not":"auth-handshake-fail-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "blacklist-src", "reset" ] } } }, "src":{ "type":"object", "properties":{ "rate-limit":{ "type":"object", "properties":{ "request":{ "type":"object", "properties":{ "src-request-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 }, "src-request-rate-limit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-request-rate-limit-action", "description":"Configure action-list to take" }, "src-request-rate-limit-action":{ "type":"string", "format":"enum", "not":"src-request-rate-limit-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "reset" ] } } } } } } }, "dst":{ "type":"object", "properties":{ "rate-limit":{ "type":"object", "properties":{ "request":{ "type":"object", "properties":{ "dst-request-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 }, "dst-request-rate-limit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-request-rate-limit-action", "description":"Configure action-list to take" }, "dst-request-rate-limit-action":{ "type":"string", "format":"enum", "not":"dst-request-rate-limit-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "reset" ] } } } } } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "ssl-traffic-check":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-template/ssl-l4/{ssl-l4-tmpl-name}/ssl-traffic-check", "properties":{ "header-inspection":{ "type":"number", "format":"flag", "default":0, "description":"Inspect ssl header" }, "header-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets with bad ssl header; 'ignore': Forward packets with bad ssl header; ", "enum":[ "drop", "ignore" ] }, "check-resumed-connection":{ "type":"number", "format":"flag", "default":0, "description":"Apply checks to SSL connections initialized by ACK packets" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "ssl-l4-tmpl-name" ] } ] }, "http-list":{ "type":"array", "minItems":1, "items":{ "type":"http" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/http/{http-tmpl-name}", "array":[ { "properties":{ "http-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS HTTP Template Name", "optional":false }, "mss-timeout":{ "type":"object", "properties":{ "mss-percent":{ "type":"number", "format":"number", "minimum":1, "maximum":100, "description":"Configure percentage of mss such that if a packet size is below the mss times mss-percent, packet is considered bad." }, "number-packets":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"Specify percentage of mss. Default is 0, mss-timeout is not enabled." }, "mss-timeout-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"mss-timeout-action", "description":"Configure action-list to take" }, "mss-timeout-action":{ "type":"string", "format":"enum", "not":"mss-timeout-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "blacklist-src", "reset" ] } } }, "disallow-connect-method":{ "type":"number", "format":"flag", "default":0, "description":"Do not allow HTTP Connect method (asymmetric mode only)", "optional":true }, "challenge":{ "type":"object", "properties":{ "challenge-method":{ "type":"string", "format":"enum", "description":"'http-redirect': http-redirect; 'javascript': javascript; ", "enum":[ "http-redirect", "javascript" ] }, "challenge-redirect-code":{ "type":"string", "format":"enum", "default":"302", "description":"'302': 302 Found; '307': 307 Temporary Redirect; ", "enum":[ "302", "307" ] }, "challenge-uri-encode":{ "type":"number", "format":"flag", "default":0, "description":"Encode the challenge phrase in uri instead of in http cookie. Default encoded in http cookie" }, "challenge-cookie-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "default":"sto-idd", "description":"Set the cookie name used to send back to client. Default is sto-idd" }, "challenge-keep-cookie":{ "type":"number", "format":"flag", "default":0, "description":"Keep the challenge cookie from client and forward to backend. Default is do not keep" }, "challenge-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "default":8, "description":"Specify the challenge interval. Default is 8 seconds" }, "challenge-pass-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"challenge-pass-action", "description":"Configure action-list to take for passing the authentication" }, "challenge-pass-action":{ "type":"string", "format":"enum", "not":"challenge-pass-action-list-name", "description":"'authenticate-src': Authenticate-src (Default); ", "enum":[ "authenticate-src" ] }, "challenge-fail-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"challenge-fail-action", "description":"Configure action-list to take for failing the authentication" }, "challenge-fail-action":{ "type":"string", "format":"enum", "default":"reset", "not":"challenge-fail-action-list-name", "description":"'blacklist-src': Blacklist-src; 'reset': Reset client connection(Default); ", "enum":[ "blacklist-src", "reset" ] } } }, "non-http-bypass":{ "type":"number", "format":"flag", "default":0, "description":"Bypass non-http traffic instead of dropping", "optional":true }, "client-source-ip":{ "type":"object", "properties":{ "client-source-ip":{ "type":"number", "format":"flag", "default":0, "description":"Mitigate on src ip specified by http header for example X-Forwarded-For header. Default is disabled" }, "http-header-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "default":"X-Forwarded-For", "description":"Set the http header name to parse for client ip. Default is X-Forwarded-For" } } }, "request-header":{ "type":"object", "properties":{ "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":63 }, "header-timeout-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"header-timeout-action", "description":"Configure action-list to take" }, "header-timeout-action":{ "type":"string", "format":"enum", "default":"drop", "not":"header-timeout-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "blacklist-src", "reset" ] } } }, "src":{ "type":"object", "properties":{ "rate-limit":{ "type":"object", "properties":{ "http-post":{ "type":"object", "properties":{ "src-post-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 }, "src-post-rate-limit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-post-rate-limit-action", "description":"Configure action-list to take" }, "src-post-rate-limit-action":{ "type":"string", "format":"enum", "default":"drop", "not":"src-post-rate-limit-action-list-name", "description":"'drop': Drop packets(Default); 'ignore': Take no action; 'reset': Reset client connection; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "ignore", "reset", "blacklist-src" ] } } }, "http-request":{ "type":"object", "properties":{ "src-request-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 }, "src-request-rate-limit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-request-rate-limit-action", "description":"Configure action-list to take" }, "src-request-rate-limit-action":{ "type":"string", "format":"enum", "default":"drop", "not":"src-request-rate-limit-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'reset': Reset client connection; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "ignore", "reset", "blacklist-src" ] } } } } } } }, "dst":{ "type":"object", "properties":{ "rate-limit":{ "type":"object", "properties":{ "http-post":{ "type":"object", "properties":{ "dst-post-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 }, "dst-post-rate-limit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-post-rate-limit-action", "description":"Configure action-list to take" }, "dst-post-rate-limit-action":{ "type":"string", "format":"enum", "default":"drop", "not":"dst-post-rate-limit-action-list-name", "description":"'drop': Drop packets(Default); 'ignore': Take no action; 'reset': Reset client connection; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "ignore", "reset", "blacklist-src" ] } } }, "http-request":{ "type":"object", "properties":{ "dst-request-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 }, "dst-request-rate-limit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-request-rate-limit-action", "description":"Configure action-list to take" }, "dst-request-rate-limit-action":{ "type":"string", "format":"enum", "default":"drop", "not":"dst-request-rate-limit-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'reset': Reset client connection; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "ignore", "reset", "blacklist-src" ] } } }, "response-size":{ "type":"object", "properties":{ "less-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "obj-less":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response size configuration" }, "obj-less-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response rate limit" }, "optional":true } } ] }, "greater-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "obj-greater":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response size configuration" }, "obj-greater-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response rate limit" }, "optional":true } } ] }, "between-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "obj-between1":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response size configuration" }, "obj-between2":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response size configuration" }, "obj-between-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response rate limit" }, "optional":true } } ] }, "response-size-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"response-size-action", "description":"Configure action-list to take" }, "response-size-action":{ "type":"string", "format":"enum", "not":"response-size-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "blacklist-src", "reset" ] } } } } } } }, "slow-read":{ "type":"object", "properties":{ "min-window-size":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"minimum window size" }, "min-window-count":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"Number of packets" }, "slow-read-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"slow-read-action", "description":"Configure action-list to take" }, "slow-read-action":{ "type":"string", "format":"enum", "not":"slow-read-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; 'ignore': Take no action; 'reset': Reset client connection; ", "enum":[ "drop", "blacklist-src", "ignore", "reset" ] } } }, "out-of-order-queue-size":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":3, "description":"Set the number of packets for the out-of-order HTTP queue (asym mode only)", "optional":true }, "out-of-order-queue-timeout":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":3, "description":"Set the timeout value in seconds for out-of-order queue in HTTP (asym mode only)", "optional":true }, "idle-timeout":{ "type":"object", "properties":{ "idle-timeout-value":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"Set the the idle timeout value in seconds for HTTP connections" }, "ignore-zero-payload":{ "type":"number", "format":"flag", "default":0, "description":"Don't reset idle timer on packets with zero payload length from clients" }, "idle-timeout-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"idle-timeout-action", "description":"Configure action-list to take" }, "idle-timeout-action":{ "type":"string", "format":"enum", "not":"idle-timeout-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "blacklist-src", "reset" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/http/{http-tmpl-name}/filter/{http-filter-name}", "array":[ { "properties":{ "http-filter-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "http-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "description":"Sequence number", "optional":true }, "http-header-cfg":{ "type":"object", "properties":{ "http-filter-header-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression" }, "http-filter-header-inverse-match":{ "type":"number", "format":"flag", "default":0 } } }, "http-referer-cfg":{ "type":"object", "properties":{ "referer-equals-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-referer-equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "referer-contains-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-referer-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "referer-starts-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-referer-starts-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "referer-ends-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-referer-ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] } } }, "http-agent-cfg":{ "type":"object", "properties":{ "agent-equals-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-agent-equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "agent-contains-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-agent-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "agent-starts-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-agent-starts-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "agent-ends-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-agent-ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] } } }, "http-uri-cfg":{ "type":"object", "properties":{ "uri-equal-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-uri-equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127 }, "optional":true } } ] }, "uri-contains-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-uri-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127 }, "optional":true } } ] }, "uri-starts-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-uri-starts-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127 }, "optional":true } } ] }, "uri-ends-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-filter-uri-ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127 }, "optional":true } } ] } } }, "dst":{ "type":"object", "properties":{ "http-filter-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Set rate limit" } } }, "http-filter-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"http-filter-action", "description":"Configure action-list to take", "optional":true }, "http-filter-action":{ "type":"string", "format":"enum", "not":"http-filter-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "blacklist-src", "authenticate-src", "reset" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "http-filter-name" ] } ] }, "malformed-http":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-template/http/{http-tmpl-name}/malformed-http", "properties":{ "malformed-http":{ "type":"string", "format":"enum", "default":"check", "description":"'check': Configure malformed HTTP parameters; ", "enum":[ "check" ] }, "malformed-http-max-line-size":{ "type":"number", "format":"number", "minimum":1, "maximum":65280, "default":32512, "description":"Set the maximum line size. Default value is 32512" }, "malformed-http-max-num-headers":{ "type":"number", "format":"number", "minimum":1, "maximum":90, "default":90, "description":"Set the maximum number of headers. Default value is 90" }, "malformed-http-max-req-line-size":{ "type":"number", "format":"number", "minimum":1, "maximum":65280, "default":32512, "description":"Set the maximum request line size. Default value is 32512" }, "malformed-http-max-header-name-size":{ "type":"number", "format":"number", "minimum":1, "maximum":64, "default":64, "description":"Set the maxinum header name length. Default value is 64." }, "malformed-http-max-content-length":{ "type":"number", "format":"number", "minimum":1, "maximum":4294967295, "default":4294967295, "description":"Set the maxinum content-length header. Default value is 4294967295 bytes" }, "malformed-http-bad-chunk-mon-enabled":{ "type":"number", "format":"flag", "default":0, "description":"Enabling bad chunk monitoring. Default is disabled" }, "malformed-http-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"malformed-http-action", "description":"Configure action-list to take" }, "malformed-http-action":{ "type":"string", "format":"enum", "not":"malformed-http-action-list-name", "description":"'drop': Drop packets (Default); 'reset': Reset client connection; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "reset", "blacklist-src" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "http-tmpl-name" ] } ] }, "dns-list":{ "type":"array", "minItems":1, "items":{ "type":"dns" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/dns/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "dns-any-check":{ "type":"number", "format":"flag", "default":0, "description":"Drop DNS queries of Type ANY", "optional":true }, "dns-any-check-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dns-any-check-action", "description":"Configure action-list to take", "optional":true }, "dns-any-check-action":{ "type":"string", "format":"enum", "default":"drop", "not":"dns-any-check-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "blacklist-src", "reset" ], "optional":true }, "dns-udp-authentication":{ "type":"object", "properties":{ "force-tcp-cfg":{ "type":"object", "properties":{ "force-tcp":{ "type":"number", "format":"flag", "default":0, "not-list":[ "udp-timeout", "min-delay" ], "description":"Force DNS request over TCP" }, "force-tcp-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"UDP authentication timeout in seconds" }, "force-tcp-min-delay":{ "type":"number", "format":"number", "minimum":1, "maximum":15, "description":"Optional minimum delay (seconds) between DNS retransmits for authentication to pass" }, "force-tcp-ignore-client-source-port":{ "type":"number", "format":"flag", "default":0, "description":"Allow client to retransmit DNS request using different source port during udp-auth (supported in asymmetric mode only)" } } }, "udp-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "not":"force-tcp", "description":"UDP authentication timeout in seconds" }, "min-delay":{ "type":"number", "format":"number", "minimum":1, "maximum":80, "not":"force-tcp", "description":"Optional minimum delay between DNS retransmits for authentication to pass, unit is specified by min-delay-interval" }, "min-delay-interval":{ "type":"string", "format":"enum", "default":"1sec", "description":"'100ms': 100ms; '1sec': 1sec; ", "enum":[ "100ms", "1sec" ] }, "dns-udp-auth-pass-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dns-udp-auth-pass-action", "description":"Configure action-list to take for passing the authentication" }, "dns-udp-auth-pass-action":{ "type":"string", "format":"enum", "not":"dns-udp-auth-pass-action-list-name", "description":"'authenticate-src': authenticate-src (Default); ", "enum":[ "authenticate-src" ] }, "dns-udp-auth-fail-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dns-udp-auth-fail-action", "description":"Configure action-list to take for failing the authentication. (Applicable to dns-udp retry only)" }, "dns-udp-auth-fail-action":{ "type":"string", "format":"enum", "not":"dns-udp-auth-fail-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "blacklist-src" ] } } }, "fqdn-label-len-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "label-length":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"Maximum length of FQDN label" }, "fqdn-label-suffix":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Number of suffixes" }, "fqdn-label-length-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"fqdn-label-length-action", "description":"Configure action-list to take" }, "fqdn-label-length-action":{ "type":"string", "format":"enum", "not":"fqdn-label-length-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "blacklist-src", "reset" ] }, "optional":true } } ] }, "fqdn-label-count-cfg":{ "type":"object", "properties":{ "label-count":{ "type":"number", "format":"number", "minimum":1, "maximum":10, "description":"Maximum number of FQDN labels per FQDN" }, "fqdn-label-count-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"fqdn-label-count-action", "description":"Configure action-list to take" }, "fqdn-label-count-action":{ "type":"string", "format":"enum", "not":"fqdn-label-count-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'reset': Send reset to client; ", "enum":[ "drop", "ignore", "blacklist-src", "reset" ] } } }, "src":{ "type":"object", "properties":{ "rate-limit":{ "type":"object", "properties":{ "nxdomain":{ "type":"object", "properties":{ "dns-nxdomain-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Limiting rate" }, "dns-nxdomain-rate-limit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dns-nxdomain-rate-limit-action", "description":"Configure action-list to take" }, "dns-nxdomain-rate-limit-action":{ "type":"string", "format":"enum", "not":"dns-nxdomain-rate-limit-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "blacklist-src", "reset" ] } } }, "request":{ "type":"object", "properties":{ "type":{ "type":"object", "properties":{ "A-cfg":{ "type":"object", "properties":{ "A":{ "type":"number", "format":"flag", "default":0, "description":"Address record" }, "src-dns-a-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "AAAA-cfg":{ "type":"object", "properties":{ "AAAA":{ "type":"number", "format":"flag", "default":0, "description":"IPv6 address record" }, "src-dns-aaaa-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "CNAME-cfg":{ "type":"object", "properties":{ "CNAME":{ "type":"number", "format":"flag", "default":0, "description":"Canonical name record" }, "src-dns-cname-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "MX-cfg":{ "type":"object", "properties":{ "MX":{ "type":"number", "format":"flag", "default":0, "description":"Mail exchange record" }, "src-dns-mx-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "NS-cfg":{ "type":"object", "properties":{ "NS":{ "type":"number", "format":"flag", "default":0, "description":"Name server record" }, "src-dns-ns-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "SRV-cfg":{ "type":"object", "properties":{ "SRV":{ "type":"number", "format":"flag", "default":0, "description":"Service locator" }, "src-dns-srv-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"DNS request rate" } } }, "dns-type-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "src-dns-request-type":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Other type value" }, "src-dns-request-type-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"request rate limit" }, "optional":true } } ] } } }, "src-dns-request-rate-limit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-dns-request-rate-limit-action", "description":"Configure action-list to take" }, "src-dns-request-rate-limit-action":{ "type":"string", "format":"enum", "not":"src-dns-request-rate-limit-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "blacklist-src", "reset" ] } } } } } } }, "dst":{ "type":"object", "properties":{ "rate-limit":{ "type":"object", "properties":{ "fqdn":{ "type":"object", "properties":{ "dns-fqdn-rate-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "dns-fqdn-rate":{ "type":"number", "format":"number", "minimum":5, "maximum":16000000, "description":"Limiting rate (Range: 5-8000 for FQDN domain based rate limiting, 5-16000000 for FQDN label count based rate limiting)" }, "per":{ "type":"string", "format":"enum", "description":"'domain-name': Domain Name; 'src-ip': Source IP address; 'label-count': FQDN label count; ", "enum":[ "domain-name", "src-ip", "label-count" ] }, "per-domain-per-src-ip":{ "type":"number", "format":"flag", "default":0, "description":"Use both Domain Name and Source IP address for rate-limiting" }, "fqdn-rate-suffix":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Suffix count" }, "fqdn-rate-label-count":{ "type":"number", "format":"number", "minimum":1, "maximum":8, "description":"FQDN label count (Range: 1-8)" }, "optional":true } } ] }, "dns-fqdn-rate-limit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dns-fqdn-rate-limit-action", "description":"Configure action-list to take" }, "dns-fqdn-rate-limit-action":{ "type":"string", "format":"enum", "not":"dns-fqdn-rate-limit-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'reset': Reset client connection; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "ignore", "reset", "blacklist-src" ] } } }, "domain-group-rate-exceed-action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop the query (default); 'tunnel-encap-packet': Encapsulate the query and send on a tunnel; ", "enum":[ "drop", "tunnel-encap-packet" ] }, "encap-template":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template to sepcify the tunnel endpoint" }, "domain-group-rate-per-service":{ "type":"number", "format":"flag", "default":0, "description":"Enable per service domain rate checking" }, "request":{ "type":"object", "properties":{ "type":{ "type":"object", "properties":{ "A-cfg":{ "type":"object", "properties":{ "A":{ "type":"number", "format":"flag", "default":0, "description":"Address record" }, "dns-a-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "AAAA-cfg":{ "type":"object", "properties":{ "AAAA":{ "type":"number", "format":"flag", "default":0, "description":"IPv6 address record" }, "dns-aaaa-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "CNAME-cfg":{ "type":"object", "properties":{ "CNAME":{ "type":"number", "format":"flag", "default":0, "description":"Canonical name record" }, "dns-cname-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "MX-cfg":{ "type":"object", "properties":{ "MX":{ "type":"number", "format":"flag", "default":0, "description":"Mail exchange record" }, "dns-mx-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "NS-cfg":{ "type":"object", "properties":{ "NS":{ "type":"number", "format":"flag", "default":0, "description":"Name server record" }, "dns-ns-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "SRV-cfg":{ "type":"object", "properties":{ "SRV":{ "type":"number", "format":"flag", "default":0, "description":"Service locator" }, "dns-srv-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"DNS request rate" } } }, "dns-type-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "dns-request-type":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Other type value" }, "dns-request-type-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"request rate limit" }, "optional":true } } ] } } }, "dst-dns-request-rate-limit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-dns-request-rate-limit-action", "description":"Configure action-list to take" }, "dst-dns-request-rate-limit-action":{ "type":"string", "format":"enum", "not":"dst-dns-request-rate-limit-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'reset': Reset client connection; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "ignore", "reset", "blacklist-src" ] } } } } } } }, "domain-group-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"Apply a domain-group to the DNS template", "optional":true }, "on-no-match":{ "type":"string", "format":"enum", "default":"deny", "description":"'permit': permit; 'deny': deny (default); ", "enum":[ "permit", "deny" ], "optional":true }, "symtimeout-cfg":{ "type":"object", "properties":{ "sym-timeout":{ "type":"number", "format":"flag", "default":0, "description":"Timeout for DNS Symmetric session" }, "sym-timeout-value":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"Session timeout value in seconds" } } }, "allow-query-class":{ "type":"object", "properties":{ "allow-internet-query-class":{ "type":"number", "format":"flag", "default":0, "description":"INTERNET query class" }, "allow-csnet-query-class":{ "type":"number", "format":"flag", "default":0, "description":"CSNET query class" }, "allow-chaos-query-class":{ "type":"number", "format":"flag", "default":0, "description":"CHAOS query class" }, "allow-hesiod-query-class":{ "type":"number", "format":"flag", "default":0, "description":"HESIOD query class" }, "allow-none-query-class":{ "type":"number", "format":"flag", "default":0, "description":"NONE query class" }, "allow-any-query-class":{ "type":"number", "format":"flag", "default":0, "description":"ANY query class" }, "allow-query-class-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"allow-query-class-action", "description":"Configure action-list to take when query class doesn't match" }, "allow-query-class-action":{ "type":"string", "format":"enum", "not":"allow-query-class-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "blacklist-src", "reset" ] } } }, "allow-record-type":{ "type":"object", "properties":{ "allow-a-type":{ "type":"number", "format":"flag", "default":0, "description":"Address record" }, "allow-aaaa-type":{ "type":"number", "format":"flag", "default":0, "description":"IPv6 address record" }, "allow-cname-type":{ "type":"number", "format":"flag", "default":0, "description":"Canonical name record" }, "allow-mx-type":{ "type":"number", "format":"flag", "default":0, "description":"Mail exchange record" }, "allow-ns-type":{ "type":"number", "format":"flag", "default":0, "description":"Name server record" }, "allow-srv-type":{ "type":"number", "format":"flag", "default":0, "description":"Service locator" }, "record-num-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "allow-num-type":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Other record type value" }, "optional":true } } ] }, "allow-record-type-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"allow-record-type-action", "description":"Configure action-list to take" }, "allow-record-type-action":{ "type":"string", "format":"enum", "not":"allow-record-type-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "blacklist-src", "reset" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "malformed-query-check":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-template/dns/{name}/malformed-query-check", "properties":{ "validation-type":{ "type":"string", "format":"enum", "description":"'basic-header-check': Basic header validation for DNS TCP/UDP queries; 'extended-header-check': Extended header/query validation for DNS TCP/UDP queries; 'disable': Disable Malform query validation for DNS TCP/UDP; ", "enum":[ "basic-header-check", "extended-header-check", "disable" ] }, "non-query-opcode-check":{ "type":"string", "format":"enum", "description":"'disable': When malform check is enabled, TPS always drops DNS query with non query opcode, this option disables this opcode check; ", "enum":[ "disable" ] }, "skip-multi-packet-check":{ "type":"number", "format":"flag", "default":0, "description":"Bypass DNS fragmented and TCP segmented Queries(Default: dropped)" }, "dns-malformed-query-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dns-malformed-query-action", "description":"Configure action-list to take" }, "dns-malformed-query-action":{ "type":"string", "format":"enum", "not":"dns-malformed-query-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'reset': Reset client connection; ", "enum":[ "drop", "ignore", "blacklist-src", "reset" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] }, "quic-list":{ "type":"array", "minItems":1, "items":{ "type":"quic" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/quic/{quic-tmpl-name}", "array":[ { "properties":{ "quic-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "retry-token-authentication-static":{ "type":"string", "format":"time", "minLength":1, "maxLength":4294967295, "not":"retry-token-authentication-dynamic", "description":"Static retry token (Maximum of 4 bytes)", "optional":true }, "fixed-bit-check-disable":{ "type":"number", "format":"flag", "default":0, "description":"Disable fixed-bit malform check", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "version-supported-list":{ "type":"array", "minItems":1, "items":{ "type":"version-supported" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/quic/{quic-tmpl-name}/version-supported/{version-start}+{version-end}", "array":[ { "properties":{ "version-start":{ "type":"string", "format":"time", "minLength":1, "maxLength":4294967295, "description":"Configure versions supported", "optional":false }, "version-end":{ "type":"string", "format":"time", "minLength":1, "maxLength":4294967295, "description":"Version supported range end", "optional":false }, "version-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"version-action", "description":"Configure action-list to take", "optional":true }, "version-action":{ "type":"string", "format":"enum", "not":"version-action-list-name", "description":"'drop': Drop packets; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "blacklist-src" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "malformed-check":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-template/quic/{quic-tmpl-name}/version-supported/{version-start}+{version-end}/malformed-check", "properties":{ "malformed-enable":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': Enable malformed check; ", "enum":[ "enable" ] }, "max-source-cid-length":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "default":255, "description":"Set the maximum source CID length" }, "max-destination-cid-length":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "default":255, "description":"Set the maximum destination CID length" }, "malformed-check-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"malformed-check-action", "description":"Configure action-list to take. Overwrites version action" }, "malformed-check-action":{ "type":"string", "format":"enum", "not":"malformed-check-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "blacklist-src" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "version-start", "version-end" ] } ] } }, "required":[ "quic-tmpl-name" ] } ] }, "tcp-list":{ "type":"array", "minItems":1, "items":{ "type":"tcp" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/tcp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "age":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "default":2, "description":"Session age in minutes", "optional":true }, "syn-cookie":{ "type":"number", "format":"flag", "default":0, "description":"Enable SYN Cookie", "optional":true }, "create-conn-on-syn-only":{ "type":"number", "format":"flag", "default":0, "description":"Enable connection establishment on SYN only", "optional":true }, "out-of-seq-cfg":{ "type":"object", "properties":{ "out-of-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":64000, "not":"per-conn-out-of-seq-rate-limit", "description":"Take action if out-of-seq pkts exceed configured threshold" }, "out-of-seq-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"out-of-seq-action", "description":"Configure action-list to take for out-of-seq exceed" }, "out-of-seq-action":{ "type":"string", "format":"enum", "default":"drop", "not":"out-of-seq-action-list-name", "description":"'drop': Drop packets for out-of-seq exceed (Default); 'blacklist-src': help Blacklist-src for out-of-seq exceed; 'ignore': help Ignore out-of-seq exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "per-conn-out-of-seq-rate-cfg":{ "type":"object", "properties":{ "per-conn-out-of-seq-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"out-of-seq", "description":"Take action if out-of-seq pkt rate exceed configured threshold" }, "per-conn-out-of-seq-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"per-conn-out-of-seq-rate-action", "description":"Configure action-list to take for out-of-seq rate exceed" }, "per-conn-out-of-seq-rate-action":{ "type":"string", "format":"enum", "default":"drop", "not":"per-conn-out-of-seq-rate-action-list-name", "description":"'drop': Drop packets for out-of-seq rate exceed (Default); 'blacklist-src': help Blacklist-src for out-of-seq rate exceed; 'ignore': help Ignore out-of-seq rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "retransmit-cfg":{ "type":"object", "properties":{ "retransmit":{ "type":"number", "format":"number", "minimum":1, "maximum":64000, "not":"per-conn-retransmit-rate-limit", "description":"Take action if retransmit pkts exceed configured threshold" }, "retransmit-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"retransmit-action", "description":"Configure action-list to take for retransmit exceed" }, "retransmit-action":{ "type":"string", "format":"enum", "default":"drop", "not":"retransmit-action-list-name", "description":"'drop': Drop packets for retrans exceed (Default); 'blacklist-src': help Blacklist-src for retrans exceed; 'ignore': help Ignore retrans exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "per-conn-retransmit-rate-cfg":{ "type":"object", "properties":{ "per-conn-retransmit-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"retransmit", "description":"Take action if retransmit pkt rate exceed configured threshold" }, "per-conn-retransmit-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"per-conn-retransmit-rate-action", "description":"Configure action-list to take for retransmit rate exceed" }, "per-conn-retransmit-rate-action":{ "type":"string", "format":"enum", "default":"drop", "not":"per-conn-retransmit-rate-action-list-name", "description":"'drop': Drop packets for retrans rate exceed (Default); 'blacklist-src': help Blacklist-src for retrans rate exceed; 'ignore': help Ignore retrans rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "zero-win-cfg":{ "type":"object", "properties":{ "zero-win":{ "type":"number", "format":"number", "minimum":1, "maximum":250, "not":"per-conn-zero-win-rate-limit", "description":"Take action if zero window pkts exceed configured threshold" }, "zero-win-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"zero-win-action", "description":"Configure action-list to take for zero window exceed" }, "zero-win-action":{ "type":"string", "format":"enum", "default":"drop", "not":"zero-win-action-list-name", "description":"'drop': Drop packets for zero-win exceed (Default); 'blacklist-src': help Blacklist-src for zero-win exceed; 'ignore': Ignore zero-win exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "per-conn-zero-win-rate-cfg":{ "type":"object", "properties":{ "per-conn-zero-win-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"zero-win", "description":"Take action if zero window pkt rate exceed configured threshold" }, "per-conn-zero-win-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"per-conn-zero-win-rate-action", "description":"Configure action-list to take for zero window rate exceed" }, "per-conn-zero-win-rate-action":{ "type":"string", "format":"enum", "default":"drop", "not":"per-conn-zero-win-rate-action-list-name", "description":"'drop': Drop packets for zero-win rate exceed (Default); 'blacklist-src': help Blacklist-src for zero-win rate exceed; 'ignore': Ignore zero-win rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "per-conn-pkt-rate-cfg":{ "type":"object", "properties":{ "per-conn-pkt-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Packet rate limit per connection per rate-interval" }, "per-conn-pkt-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"per-conn-pkt-rate-action", "description":"Configure action-list to take for per-conn-pkt-rate exceed" }, "per-conn-pkt-rate-action":{ "type":"string", "format":"enum", "default":"drop", "not":"per-conn-pkt-rate-action-list-name", "description":"'drop': Drop packets for per-conn-pkt-rate exceed (Default); 'blacklist-src': help Blacklist-src for per-conn-pkt-rate exceed; 'ignore': Ignore per-conn-pkt-rate-exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "per-conn-rate-interval":{ "type":"string", "format":"enum", "default":"1sec", "description":"'100ms': 100ms; '1sec': 1sec; '10sec': 10sec; ", "enum":[ "100ms", "1sec", "10sec" ], "optional":true }, "dst":{ "type":"object", "properties":{ "rate-limit":{ "type":"object", "properties":{ "syn-rate-limit":{ "type":"object", "properties":{ "dst-syn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 }, "dst-syn-rate-action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop packets for syn-rate exceed (Default); 'ignore': Ignore syn-rate-exceed; ", "enum":[ "drop", "ignore" ] } } } } } } }, "src":{ "type":"object", "properties":{ "rate-limit":{ "type":"object", "properties":{ "syn-rate-limit":{ "type":"object", "properties":{ "src-syn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 }, "src-syn-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-syn-rate-action", "description":"Configure action-list to take for syn-rate exceed" }, "src-syn-rate-action":{ "type":"string", "format":"enum", "default":"drop", "not":"src-syn-rate-action-list-name", "description":"'drop': Drop packets for syn-rate exceed (Default); 'blacklist-src': Blacklist-src for syn-rate exceed; 'ignore': Ignore syn-rate-exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } } } } } }, "allow-synack-skip-authentications":{ "type":"number", "format":"flag", "default":0, "description":"Allow create sessions on SYNACK without syn-auth and ack-auth (ASYM Mode only)", "optional":true }, "synack-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"track-together-with-syn", "description":"Config SYNACK rate limit", "optional":true }, "track-together-with-syn":{ "type":"number", "format":"flag", "default":0, "not":"synack-rate-limit", "description":"SYNACK will be counted in Dst Syn-rate limit", "optional":true }, "allow-syn-otherflags":{ "type":"number", "format":"flag", "default":0, "description":"Treat TCP SYN+PSH as a TCP SYN (DST tcp ports support only)", "optional":true }, "allow-tcp-tfo":{ "type":"number", "format":"flag", "default":0, "description":"Allow TCP Fast Open", "optional":true }, "conn-rate-limit-on-syn-only":{ "type":"number", "format":"flag", "default":0, "description":"Only count SYN-initiated connections towards connection-rate tracking", "optional":true }, "action-on-syn-rto-retry-count":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "description":"Take action if syn-auth RTO-authentication fail over retry time(default:5)", "optional":true }, "action-on-ack-rto-retry-count":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "description":"Take action if ack-auth RTO-authentication fail over retry time(default:5)", "optional":true }, "ack-authentication-synack-reset":{ "type":"number", "format":"flag", "plat-neg-list":["soft-ax"], "default":0, "description":"Reset client TCP SYN+ACK for authentication (DST support only)", "optional":true }, "known-resp-src-port-cfg":{ "type":"object", "properties":{ "known-resp-src-port":{ "type":"number", "format":"flag", "default":0, "description":"Take action if src-port is less than 1024" }, "known-resp-src-port-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"known-resp-src-port-action", "description":"Configure action-list to take for well-known src-port" }, "known-resp-src-port-action":{ "type":"string", "format":"enum", "not":"known-resp-src-port-action-list-name", "description":"'drop': Drop packets from well-known src-port(Default); 'blacklist-src': Blacklist-src from well-known src-port; 'ignore': Ignore well-known src-port; ", "enum":[ "drop", "blacklist-src", "ignore" ] }, "exclude-src-resp-port":{ "type":"number", "format":"flag", "default":0, "description":"Exclude src port equal to dst port" } } }, "syn-authentication":{ "type":"object", "properties":{ "syn-auth-type":{ "type":"string", "format":"enum", "not-list":[ "syn-auth-timeout", "syn-auth-min-delay" ], "description":"'send-rst': Send reset to client after syn cookie check pass; 'force-rst-by-ack': Send client a bad ack after syn cookie check pass; 'force-rst-by-synack': Send client a bad synack after syn cookie check pass; 'send-rst-all': Send RST to client for all auth attempts; ", "enum":[ "send-rst", "force-rst-by-ack", "force-rst-by-synack", "send-rst-all" ] }, "syn-auth-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "not":"syn-auth-type", "description":"syn retransmit timeout in seconds(default timeout: 5 seconds)" }, "syn-auth-min-delay":{ "type":"number", "format":"number", "minimum":1, "maximum":80, "not":"syn-auth-type", "description":"Minimum delay (in 100ms intervals) between SYN retransmits for retransmit-check to pass" }, "syn-auth-rto":{ "type":"number", "format":"flag", "default":0, "description":"Estimate the RTO and apply the exponential back-off for authentication" }, "syn-auth-pass-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "not":"syn-auth-pass-action", "description":"Configure action-list to take for passing the authentication" }, "syn-auth-pass-action":{ "type":"string", "format":"enum", "not":"syn-auth-pass-action-list-name", "description":"'authenticate-src': authenticate-src (Default); ", "enum":[ "authenticate-src" ] }, "syn-auth-fail-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "not":"syn-auth-fail-action", "description":"Configure action-list to take for failing the authentication." }, "syn-auth-fail-action":{ "type":"string", "format":"enum", "not":"syn-auth-fail-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; 'reset': Send reset to client (Applicable to retransmit-check only); ", "enum":[ "drop", "blacklist-src", "reset" ] } } }, "ack-authentication":{ "type":"object", "properties":{ "ack-auth-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"ack retransmit timeout in seconds(default timeout: 5 seconds)" }, "ack-auth-min-delay":{ "type":"number", "format":"number", "minimum":1, "maximum":80, "description":"Minimum delay (in 100ms intervals) between ACK retransmits for retransmit-check to pass" }, "ack-auth-only":{ "type":"number", "format":"flag", "default":0, "description":"Apply retransmit-check only once per source address for authentication purpose" }, "ack-auth-rto":{ "type":"number", "format":"flag", "default":0, "description":"Estimate the RTO and apply the exponential back-off for authentication" }, "ack-auth-pass-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "not":"ack-auth-pass-action", "description":"Configure action-list to take for passing the authentication" }, "ack-auth-pass-action":{ "type":"string", "format":"enum", "not":"ack-auth-pass-action-list-name", "description":"'authenticate-src': authenticate-src (Default); ", "enum":[ "authenticate-src" ] }, "ack-auth-fail-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "not":"ack-auth-fail-action", "description":"Configure action-list to take for failing the authentication." }, "ack-auth-fail-action":{ "type":"string", "format":"enum", "not":"ack-auth-fail-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; 'reset': Send reset to client; ", "enum":[ "drop", "blacklist-src", "reset" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/tcp/{name}/filter/{tcp-filter-name}", "array":[ { "properties":{ "tcp-filter-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "tcp-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "description":"Sequence number", "optional":true }, "tcp-filter-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "tcp-filter-inverse-match":{ "type":"number", "format":"flag", "default":0, "description":"Inverse the result of the matching", "optional":true }, "byte-offset-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Filter using Berkeley Packet Filter syntax", "optional":true }, "tcp-filter-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"tcp-filter-action", "description":"Configure action-list to take", "optional":true }, "tcp-filter-action":{ "type":"string", "format":"enum", "default":"drop", "not":"tcp-filter-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; ", "enum":[ "drop", "ignore", "blacklist-src", "authenticate-src" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "tcp-filter-name" ] } ] } }, "required":[ "name" ] } ] }, "udp-list":{ "type":"array", "minItems":1, "items":{ "type":"udp" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/udp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS UDP Template Name", "optional":false }, "age":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "default":2, "description":"Configure session age(in minutes) for UDP sessions", "optional":true }, "per-conn-pkt-rate-cfg":{ "type":"object", "properties":{ "per-conn-pkt-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Packet rate limit per connection per rate-interval" }, "per-conn-pkt-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"per-conn-pkt-rate-action", "description":"Configure action-list to take for per-conn-pkt-rate exceed" }, "per-conn-pkt-rate-action":{ "type":"string", "format":"enum", "default":"drop", "not":"per-conn-pkt-rate-action-list-name", "description":"'drop': Drop packets for per-conn-pkt-rate exceed (Default); 'blacklist-src': help Blacklist-src for per-conn-pkt-rate exceed; 'ignore': Ignore per-conn-pkt-rate-exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "per-conn-rate-interval":{ "type":"string", "format":"enum", "default":"1sec", "description":"'100ms': 100ms; '1sec': 1sec; ", "enum":[ "100ms", "1sec" ], "optional":true }, "spoof-detect-retry-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"Timeout in seconds", "optional":true }, "spoof-detect-min-delay":{ "type":"number", "format":"number", "minimum":1, "maximum":80, "description":"Optional minimum delay between UDP retransmits for authentication to pass, unit is specified by min-delay-interval", "optional":true }, "spoof-detect-min-delay-interval":{ "type":"string", "format":"enum", "default":"1sec", "description":"'100ms': 100ms; '1sec': 1sec; ", "enum":[ "100ms", "1sec" ], "optional":true }, "spoof-detect-pass-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "not":"spoof-detect-pass-action", "description":"Configure action-list to take for passing the authentication", "optional":true }, "spoof-detect-pass-action":{ "type":"string", "format":"enum", "not":"spoof-detect-pass-action-list-name", "description":"'authenticate-src': authenticate-src (Default); ", "enum":[ "authenticate-src" ], "optional":true }, "spoof-detect-fail-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "not":"spoof-detect-fail-action", "description":"Configure action-list to take for failing the authentication", "optional":true }, "spoof-detect-fail-action":{ "type":"string", "format":"enum", "not":"spoof-detect-fail-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src for spoof-detect fail; ", "enum":[ "drop", "blacklist-src" ], "optional":true }, "token-authentication":{ "type":"number", "format":"flag", "default":0, "description":"Enable Token Authentication", "optional":true }, "token-authentication-hw-assist-disable":{ "type":"number", "format":"flag", "plat-neg-list":["non-fpga", "soft-ax"], "default":0, "description":"token-authentication disable hardware assistance", "optional":true }, "token-authentication-salt-prefix":{ "type":"number", "format":"flag", "default":0, "description":"token-authentication salt-prefix", "optional":true }, "token-authentication-salt-prefix-curr":{ "type":"number", "format":"number", "minimum":1, "maximum":4294967295, "optional":true }, "token-authentication-salt-prefix-prev":{ "type":"number", "format":"number", "minimum":1, "maximum":4294967295, "optional":true }, "token-authentication-formula":{ "type":"string", "format":"enum", "description":"'md5_Salt-SrcIp-SrcPort-DstIp-DstPort': md5 of Salt-SrcIp-SrcPort-DstIp-DstPort; 'md5_Salt-DstIp-DstPort': md5 of Salt-DstIp-DstPort; 'md5_Salt-SrcIp-DstIp': md5 of Salt-SrcIp-DstIp; 'md5_Salt-SrcPort-DstPort': md5 of Salt-SrcPort-DstPort; 'md5_Salt-UintDstIp-DstPort': Using the uint value of IP for md5 of Salt-DstIp-DstPort; 'sha1_Salt-SrcIp-SrcPort-DstIp-DstPort': sha1 of Salt-SrcIp-SrcPort-DstIp-DstPort; 'sha1_Salt-DstIp-DstPort': sha1 of Salt-DstIp-DstPort; 'sha1_Salt-SrcIp-DstIp': sha1 of Salt-SrcIp-DstIp; 'sha1_Salt-SrcPort-DstPort': sha1 of Salt-SrcPort-DstPort; 'sha1_Salt-UintDstIp-DstPort': Using the uint value of IP for sha1 of Salt-DstIp-DstPort; ", "enum":[ "md5_Salt-SrcIp-SrcPort-DstIp-DstPort", "md5_Salt-DstIp-DstPort", "md5_Salt-SrcIp-DstIp", "md5_Salt-SrcPort-DstPort", "md5_Salt-UintDstIp-DstPort", "sha1_Salt-SrcIp-SrcPort-DstIp-DstPort", "sha1_Salt-DstIp-DstPort", "sha1_Salt-SrcIp-DstIp", "sha1_Salt-SrcPort-DstPort", "sha1_Salt-UintDstIp-DstPort" ], "optional":true }, "token-authentication-public-address":{ "type":"number", "format":"flag", "default":0, "description":"The server public IP address", "optional":true }, "public-ipv4-addr":{ "type":"string", "format":"ipv4-address", "description":"IP address", "optional":true }, "public-ipv6-addr":{ "type":"string", "format":"ipv6-address", "description":"IPV6 address", "optional":true }, "known-resp-src-port-cfg":{ "type":"object", "properties":{ "known-resp-src-port":{ "type":"number", "format":"flag", "default":0, "description":"Take action if src-port is less than 1024" }, "known-resp-src-port-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"known-resp-src-port-action", "description":"Configure action-list to take for well-known src-port" }, "known-resp-src-port-action":{ "type":"string", "format":"enum", "not":"known-resp-src-port-action-list-name", "description":"'drop': Drop packets from well-known src-port(Default); 'blacklist-src': Blacklist-src from well-known src-port; 'ignore': Ignore well-known src-port; ", "enum":[ "drop", "blacklist-src", "ignore" ] }, "exclude-src-resp-port":{ "type":"number", "format":"flag", "default":0, "description":"Exclude src port equal to dst port" } } }, "ntp-monlist-cfg":{ "type":"object", "properties":{ "ntp-monlist":{ "type":"number", "format":"flag", "default":0, "description":"Take action for ntp monlist request/response" }, "ntp-monlist-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"ntp-monlist-action", "description":"Configure action-list to take for ntp-monlist" }, "ntp-monlist-action":{ "type":"string", "format":"enum", "default":"drop", "not":"ntp-monlist-action-list-name", "description":"'drop': Drop packets for ntp-monlist (Default); 'blacklist-src': Blacklist-src for ntp-monlist; 'ignore': Ignore ntp-monlist; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "max-payload-size-cfg":{ "type":"object", "properties":{ "max-payload-size":{ "type":"number", "format":"number", "minimum":1, "maximum":1470, "description":"Maximum UDP payload size for each single packet" }, "max-payload-size-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":64, "$ref":"/axapi/v3/ddos/action-list", "not":"max-payload-size-action", "description":"Configure action-list to take for max-payload-size exceed" }, "max-payload-size-action":{ "type":"string", "format":"enum", "default":"drop", "not":"max-payload-size-action-list-name", "description":"'drop': Drop packets for max-payload-size exceed (Default); 'blacklist-src': Blacklist-src for max-payload-size exceed; 'ignore': Do nothing for max-payload-size exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "min-payload-size-cfg":{ "type":"object", "properties":{ "min-payload-size":{ "type":"number", "format":"number", "minimum":1, "maximum":1470, "description":"Minimum UDP payload size for each single packet" }, "min-payload-size-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":64, "$ref":"/axapi/v3/ddos/action-list", "not":"min-payload-size-action", "description":"Configure action-list to take for min-payload-size exceed" }, "min-payload-size-action":{ "type":"string", "format":"enum", "default":"drop", "not":"min-payload-size-action-list-name", "description":"'drop': Drop packets for min-payload-size (Default); 'blacklist-src': Blacklist-src for min-payload-size; 'ignore': Do nothing for min-payload-size exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/udp/{name}/filter/{udp-filter-name}", "array":[ { "properties":{ "udp-filter-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "udp-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "description":"Sequence number", "optional":true }, "udp-filter-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "udp-filter-inverse-match":{ "type":"number", "format":"flag", "default":0, "description":"Inverse the result of the matching", "optional":true }, "byte-offset-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Filter using Berkeley Packet Filter syntax", "optional":true }, "udp-filter-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "not":"udp-filter-action", "description":"Configure action-list to take", "optional":true }, "udp-filter-action":{ "type":"string", "format":"enum", "default":"drop", "not":"udp-filter-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; ", "enum":[ "drop", "ignore", "blacklist-src", "authenticate-src" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "udp-filter-name" ] } ] } }, "required":[ "name" ] } ] }, "ip-proto-list":{ "type":"array", "minItems":1, "items":{ "type":"ip-proto" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/ip-proto/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS Ip-proto Template Name", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/ip-proto/{name}/filter/{other-filter-name}", "array":[ { "properties":{ "other-filter-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "other-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "description":"Sequence number", "optional":true }, "other-filter-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "other-filter-inverse-match":{ "type":"number", "format":"flag", "default":0, "description":"Inverse the result of the matching", "optional":true }, "byte-offset-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Filter using Berkeley Packet Filter syntax", "optional":true }, "other-filter-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"other-filter-action", "description":"Configure action-list to take", "optional":true }, "other-filter-action":{ "type":"string", "format":"enum", "not":"other-filter-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; ", "enum":[ "drop", "ignore", "blacklist-src", "authenticate-src" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "other-filter-name" ] } ] } }, "required":[ "name" ] } ] }, "icmp-v4-list":{ "type":"array", "minItems":1, "items":{ "type":"icmp-v4" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}", "array":[ { "properties":{ "icmp-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ICMPv4 Template Name", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "type-list":{ "type":"array", "minItems":1, "items":{ "type":"type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}/type/{type-number}", "array":[ { "properties":{ "type-number":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Specify ICMP type number", "optional":false }, "icmp-type-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"icmp-type-action", "description":"Configure action-list to take for this ICMP type", "optional":true }, "icmp-type-action":{ "type":"string", "format":"enum", "not":"icmp-type-action-list-name", "description":"'drop': Reject this ICMP type; 'blacklist-src': Blacklist-src this ICMP type; 'ignore': Ignore this ICMP type; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "v4-src-rate-cfg":{ "type":"object", "properties":{ "src-type-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the whole src rate for this type" }, "src-type-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-type-rate-action", "description":"Configure action-list to take for rate exceed" }, "src-type-rate-action":{ "type":"string", "format":"enum", "not":"src-type-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "v4-src-code-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "src-code-number":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Specify the ICMP code for this src rate" }, "src-code-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the rate with the code" }, "src-code-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-code-rate-action", "description":"Configure action-list to take for rate exceed" }, "src-code-rate-action":{ "type":"string", "format":"enum", "not":"src-code-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] }, "optional":true } } ] }, "src-code-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the rate with other code", "optional":true }, "src-code-other-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-code-other-rate-action", "description":"Configure action-list to take for rate exceed", "optional":true }, "src-code-other-rate-action":{ "type":"string", "format":"enum", "not":"src-code-other-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "v4-dst-rate-cfg":{ "type":"object", "properties":{ "dst-type-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the whole dst rate for this type" }, "dst-type-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-type-rate-action", "description":"Configure action-list to take for rate exceed" }, "dst-type-rate-action":{ "type":"string", "format":"enum", "not":"dst-type-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "v4-dst-code-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "dst-code-number":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Specify the ICMP code for this dst rate" }, "dst-code-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the rate with the code" }, "dst-code-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-code-rate-action", "description":"Configure action-list to take for rate exceed" }, "dst-code-rate-action":{ "type":"string", "format":"enum", "not":"dst-code-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] }, "optional":true } } ] }, "dst-code-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the rate with other code", "optional":true }, "dst-code-other-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-code-other-rate-action", "description":"Configure action-list to take for rate exceed", "optional":true }, "dst-code-other-rate-action":{ "type":"string", "format":"enum", "not":"dst-code-other-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "type-number" ] } ] }, "type-other":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-template/icmp-v4/{icmp-tmpl-name}/type-other", "properties":{ "icmp-type-other-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"icmp-type-other-action", "description":"Configure action-list to take for wildcard ICMP match" }, "icmp-type-other-action":{ "type":"string", "format":"enum", "not":"icmp-type-other-action-list-name", "description":"'drop': Reject wildcard ICMP type; 'blacklist-src': Blacklist-src wildcard ICMP type; 'ignore': Ignore wildcard ICMP type; ", "enum":[ "drop", "blacklist-src", "ignore" ] }, "src":{ "type":"object", "properties":{ "src-type-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the whole src rate for wildcard ICMP type" }, "src-type-other-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-type-other-rate-action", "description":"Configure action-list to take for rate exceed" }, "src-type-other-rate-action":{ "type":"string", "format":"enum", "not":"src-type-other-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "dst":{ "type":"object", "properties":{ "dst-type-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the whole dst rate for wildcard ICMP type" }, "dst-type-other-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-type-other-rate-action", "description":"Configure action-list to take for rate exceed" }, "dst-type-other-rate-action":{ "type":"string", "format":"enum", "not":"dst-type-other-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "icmp-tmpl-name" ] } ] }, "icmp-v6-list":{ "type":"array", "minItems":1, "items":{ "type":"icmp-v6" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/icmp-v6/{icmp-tmpl-name}", "array":[ { "properties":{ "icmp-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ICMPv6 Template Name", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "type-list":{ "type":"array", "minItems":1, "items":{ "type":"type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/icmp-v6/{icmp-tmpl-name}/type/{type-number}", "array":[ { "properties":{ "type-number":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Specify ICMP type number", "optional":false }, "icmp-type-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"icmp-type-action", "description":"Configure action-list to take for this ICMP type", "optional":true }, "icmp-type-action":{ "type":"string", "format":"enum", "not":"icmp-type-action-list-name", "description":"'drop': Reject this ICMP type; 'blacklist-src': Blacklist-src this ICMP type; 'ignore': Ignore this ICMP type; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "v6-src-rate-cfg":{ "type":"object", "properties":{ "src-type-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the whole src rate for this type" }, "src-type-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-type-rate-action", "description":"Configure action-list to take for rate exceed" }, "src-type-rate-action":{ "type":"string", "format":"enum", "not":"src-type-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "v6-src-code-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "src-code-number":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Specify the ICMP code for this src rate" }, "src-code-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the rate with the code" }, "src-code-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-code-rate-action", "description":"Configure action-list to take for rate exceed" }, "src-code-rate-action":{ "type":"string", "format":"enum", "not":"src-code-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] }, "optional":true } } ] }, "src-code-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the rate with other code", "optional":true }, "src-code-other-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-code-other-rate-action", "description":"Configure action-list to take for rate exceed", "optional":true }, "src-code-other-rate-action":{ "type":"string", "format":"enum", "not":"src-code-other-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "v6-dst-rate-cfg":{ "type":"object", "properties":{ "dst-type-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the whole dst rate for this type" }, "dst-type-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-type-rate-action", "description":"Configure action-list to take for rate exceed" }, "dst-type-rate-action":{ "type":"string", "format":"enum", "not":"dst-type-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "v6-dst-code-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "dst-code-number":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Specify the ICMP code for this dst rate" }, "dst-code-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the rate with the code" }, "dst-code-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-code-rate-action", "description":"Configure action-list to take for rate exceed" }, "dst-code-rate-action":{ "type":"string", "format":"enum", "not":"dst-code-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] }, "optional":true } } ] }, "dst-code-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the rate with other code", "optional":true }, "dst-code-other-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-code-other-rate-action", "description":"Configure action-list to take for rate exceed", "optional":true }, "dst-code-other-rate-action":{ "type":"string", "format":"enum", "not":"dst-code-other-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "type-number" ] } ] }, "type-other":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-template/icmp-v6/{icmp-tmpl-name}/type-other", "properties":{ "icmp-type-other-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"icmp-type-other-action", "description":"Configure action-list to take for wildcard ICMP match" }, "icmp-type-other-action":{ "type":"string", "format":"enum", "not":"icmp-type-other-action-list-name", "description":"'drop': Reject wildcard ICMP type; 'blacklist-src': Blacklist-src wildcard ICMP type; 'ignore': Ignore wildcard ICMP type; ", "enum":[ "drop", "blacklist-src", "ignore" ] }, "src":{ "type":"object", "properties":{ "src-type-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the whole src rate for wildcard ICMP type" }, "src-type-other-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-type-other-rate-action", "description":"Configure action-list to take for rate exceed" }, "src-type-other-rate-action":{ "type":"string", "format":"enum", "not":"src-type-other-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "dst":{ "type":"object", "properties":{ "dst-type-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the whole dst rate for wildcard ICMP type" }, "dst-type-other-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-type-other-rate-action", "description":"Configure action-list to take for rate exceed" }, "dst-type-other-rate-action":{ "type":"string", "format":"enum", "not":"dst-type-other-rate-action-list-name", "description":"'drop': Drop packets for rate exceed (Default); 'blacklist-src': Blacklist-src for rate exceed; 'ignore': Do nothing for rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "icmp-tmpl-name" ] } ] }, "sip-list":{ "type":"array", "minItems":1, "items":{ "type":"sip" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/sip/{sip-tmpl-name}", "array":[ { "properties":{ "sip-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS SIP Template Name", "optional":false }, "src":{ "type":"object", "properties":{ "sip-request-rate-limit":{ "type":"object", "properties":{ "src-sip-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"src-sip-rate-action", "description":"Configure action-list to take" }, "src-sip-rate-action":{ "type":"string", "format":"enum", "default":"drop", "not":"src-sip-rate-action-list-name", "description":"'drop': Drop packets(Default); 'ignore': Take no action; 'reset': Reset (sip-tcp) client connection; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "ignore", "reset", "blacklist-src" ] }, "method":{ "type":"object", "properties":{ "invite-cfg":{ "type":"object", "properties":{ "INVITE":{ "type":"number", "format":"flag", "default":0, "description":"INVITE method" }, "src-sip-invite-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "register-cfg":{ "type":"object", "properties":{ "REGISTER":{ "type":"number", "format":"flag", "default":0, "description":"REGISTER method" }, "src-sip-register-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "options-cfg":{ "type":"object", "properties":{ "OPTIONS":{ "type":"number", "format":"flag", "default":0, "description":"OPTIONS method" }, "src-sip-options-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "bye-cfg":{ "type":"object", "properties":{ "BYE":{ "type":"number", "format":"flag", "default":0, "description":"BYE method" }, "src-sip-bye-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "subscribe-cfg":{ "type":"object", "properties":{ "SUBSCRIBE":{ "type":"number", "format":"flag", "default":0, "description":"SUBSCRIBE method" }, "src-sip-subscribe-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "notify-cfg":{ "type":"object", "properties":{ "NOTIFY":{ "type":"number", "format":"flag", "default":0, "description":"NOTIFY method" }, "src-sip-notify-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "refer-cfg":{ "type":"object", "properties":{ "REFER":{ "type":"number", "format":"flag", "default":0, "description":"REFER method" }, "src-sip-refer-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "message-cfg":{ "type":"object", "properties":{ "MESSAGE":{ "type":"number", "format":"flag", "default":0, "description":"MESSAGE method" }, "src-sip-message-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "update-cfg":{ "type":"object", "properties":{ "UPDATE":{ "type":"number", "format":"flag", "default":0, "description":"UPDATE method" }, "src-sip-update-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } } } } } } } }, "dst":{ "type":"object", "properties":{ "sip-request-rate-limit":{ "type":"object", "properties":{ "dst-sip-rate-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"dst-sip-rate-action", "description":"Configure action-list to take" }, "dst-sip-rate-action":{ "type":"string", "format":"enum", "default":"drop", "not":"dst-sip-rate-action-list-name", "description":"'drop': Drop packets(Default); 'ignore': Take no action; 'reset': Reset (sip-tcp) client connection; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "ignore", "reset", "blacklist-src" ] }, "method":{ "type":"object", "properties":{ "invite-cfg":{ "type":"object", "properties":{ "INVITE":{ "type":"number", "format":"flag", "default":0, "description":"INVITE method" }, "dst-sip-invite-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "register-cfg":{ "type":"object", "properties":{ "REGISTER":{ "type":"number", "format":"flag", "default":0, "description":"REGISTER method" }, "dst-sip-register-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "options-cfg":{ "type":"object", "properties":{ "OPTIONS":{ "type":"number", "format":"flag", "default":0, "description":"OPTIONS method" }, "dst-sip-options-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "bye-cfg":{ "type":"object", "properties":{ "BYE":{ "type":"number", "format":"flag", "default":0, "description":"BYE method" }, "dst-sip-bye-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "subscribe-cfg":{ "type":"object", "properties":{ "SUBSCRIBE":{ "type":"number", "format":"flag", "default":0, "description":"SUBSCRIBE method" }, "dst-sip-subscribe-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "notify-cfg":{ "type":"object", "properties":{ "NOTIFY":{ "type":"number", "format":"flag", "default":0, "description":"NOTIFY method" }, "dst-sip-notify-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "refer-cfg":{ "type":"object", "properties":{ "REFER":{ "type":"number", "format":"flag", "default":0, "description":"REFER method" }, "dst-sip-refer-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "message-cfg":{ "type":"object", "properties":{ "MESSAGE":{ "type":"number", "format":"flag", "default":0, "description":"MESSAGE method" }, "dst-sip-message-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "update-cfg":{ "type":"object", "properties":{ "UPDATE":{ "type":"number", "format":"flag", "default":0, "description":"UPDATE method" }, "dst-sip-update-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } } } } } } } }, "idle-timeout":{ "type":"object", "properties":{ "idle-timeout-value":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"Set the the idle timeout value for SIP-TCP connections" }, "ignore-zero-payload":{ "type":"number", "format":"flag", "default":0, "description":"Don't reset idle timer on packets with zero payload length from clients" }, "idle-timeout-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"idle-timeout-action", "description":"Configure action-list to take" }, "idle-timeout-action":{ "type":"string", "format":"enum", "not":"idle-timeout-action-list-name", "description":"'drop': Drop packets (Default); 'blacklist-src': Blacklist-src; 'reset': Reset (sip-tcp) client connection; ", "enum":[ "drop", "blacklist-src", "reset" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "malformed-sip":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-template/sip/{sip-tmpl-name}/malformed-sip", "properties":{ "malformed-sip-check":{ "type":"string", "format":"enum", "description":"'enable-check': Enable malformed SIP parameters; ", "enum":[ "enable-check" ] }, "malformed-sip-max-line-size":{ "type":"number", "format":"number", "minimum":1, "maximum":32511, "default":32511, "description":"Set the maximum line size. Default value is 32511" }, "malformed-sip-max-uri-length":{ "type":"number", "format":"number", "minimum":1, "maximum":32511, "default":32511, "description":"Set the maximum uri size. Default value is 32511" }, "malformed-sip-max-header-name-length":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "default":63, "description":"Set the maximum header name length. Default value is 63" }, "malformed-sip-max-header-value-length":{ "type":"number", "format":"number", "minimum":1, "maximum":32511, "default":32511, "description":"Set the maximum header value length. Default value is 32511" }, "malformed-sip-call-id-max-length":{ "type":"number", "format":"number", "minimum":1, "maximum":32511, "default":32511, "description":"Set the maximum call-id length. Default value is 32511" }, "malformed-sip-sdp-max-length":{ "type":"number", "format":"number", "minimum":1, "maximum":32511, "default":32511, "description":"Set the maxinum SDP content length. Default value is 32511" }, "malformed-sip-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"malformed-sip-action", "description":"Configure action-list to take" }, "malformed-sip-action":{ "type":"string", "format":"enum", "default":"drop", "not":"malformed-sip-action-list-name", "description":"'drop': Drop packets (Default); 'reset': Reset (sip-tcp) client connection; 'blacklist-src': Blacklist-src; ", "enum":[ "drop", "reset", "blacklist-src" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "filter-header-list":{ "type":"array", "minItems":1, "items":{ "type":"filter-header" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/sip/{sip-tmpl-name}/filter-header/{sip-filter-name}", "array":[ { "properties":{ "sip-filter-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "sip-filter-header-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "description":"Sequence number", "optional":true }, "sip-header-cfg":{ "type":"object", "properties":{ "sip-filter-header-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression" }, "sip-filter-header-inverse-match":{ "type":"number", "format":"flag", "default":0 } } }, "sip-filter-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"sip-filter-action", "description":"Configure action-list to take", "optional":true }, "sip-filter-action":{ "type":"string", "format":"enum", "not":"sip-filter-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; 'reset': Reset client connection(for sip-tcp); ", "enum":[ "drop", "ignore", "blacklist-src", "authenticate-src", "reset" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "sip-filter-name" ] } ] } }, "required":[ "sip-tmpl-name" ] } ] }, "ips-list":{ "type":"array", "minItems":1, "items":{ "type":"ips" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-template/ips/{ips-tmpl-name}", "array":[ { "properties":{ "ips-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS IPS Template Name", "optional":false }, "ips-profile-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ips-profile-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"IPS Profile Name" }, "optional":true } } ] }, "high-serverity-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure action-list to take for high serverity signature", "optional":true }, "medium-serverity-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure action-list to take for medium serverity signature", "optional":true }, "low-serverity-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure action-list to take for low serverity signature", "optional":true }, "streaming-scan-disable":{ "type":"number", "format":"flag", "default":0, "description":"Disable IPS streaming scan", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "ips-tmpl-name" ] } ] } } }, "action-list-list":{ "type":"array", "minItems":1, "items":{ "type":"action-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/action-list/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS action-list name", "optional":false }, "action":{ "type":"object", "properties":{ "action":{ "type":"string", "format":"enum", "description":"'drop': Drop Packet (Default); 'ignore': Continue processing the packet; 'reset': Reset the connection; 'authenticate-src': Authenticate the source IP; 'blacklist-src': Black-list the source IP; 'tunnel-encap-packet': Encapsulate packet for tunneling. encap template need to be bound; ", "enum":[ "drop", "ignore", "reset", "authenticate-src", "blacklist-src", "tunnel-encap-packet" ] }, "blacklist-src-value":{ "type":"number", "format":"number", "minimum":1, "maximum":30, "description":"blacklist duration in minutes" }, "stateless":{ "type":"number", "format":"flag", "default":0, "description":"encapsulate all packests" }, "scrub-packet":{ "type":"number", "format":"flag", "default":0, "description":"allow packets to go through other DDoS checks before sent out" } } }, "zone-template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "$ref":"/axapi/v3/ddos/zone-template/logging", "description":"DDOS logging zone-template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "$ref":"/axapi/v3/ddos/zone-template/encap", "description":"DDOS encap template" } } }, "capture-config":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/capture-config", "description":"capture-config name", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "zone-src-port-template":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-src-port-template", "properties":{ "tcp-list":{ "type":"array", "minItems":1, "items":{ "type":"tcp" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-src-port-template/tcp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-src-port-template/tcp/{name}/filter/{tcp-filter-name}", "array":[ { "properties":{ "tcp-filter-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "tcp-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "description":"Sequence number", "optional":true }, "tcp-filter-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "tcp-filter-inverse-match":{ "type":"number", "format":"flag", "default":0, "description":"Inverse the result of the matching", "optional":true }, "byte-offset-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Filter using Berkeley Packet Filter syntax", "optional":true }, "tcp-filter-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"tcp-filter-action", "description":"Configure action-list to take", "optional":true }, "tcp-filter-action":{ "type":"string", "format":"enum", "not":"tcp-filter-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; ", "enum":[ "drop", "ignore", "blacklist-src", "authenticate-src" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "tcp-filter-name" ] } ] } }, "required":[ "name" ] } ] }, "udp-list":{ "type":"array", "minItems":1, "items":{ "type":"udp" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-src-port-template/udp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS UDP Template Name", "optional":false }, "ntp-monlist-cfg":{ "type":"object", "properties":{ "ntp-monlist":{ "type":"number", "format":"flag", "default":0, "description":"Take action for ntp monlist request/response" }, "ntp-monlist-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "not":"ntp-monlist-action", "description":"Configure action-list to take for ntp-monlist" }, "ntp-monlist-action":{ "type":"string", "format":"enum", "not":"ntp-monlist-action-list-name", "description":"'drop': Drop packets for ntp-monlist (Default); 'blacklist-src': Blacklist-src for ntp-monlist; 'ignore': Ignore ntp-monlist; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "max-payload-size-cfg":{ "type":"object", "properties":{ "max-payload-size":{ "type":"number", "format":"number", "minimum":1, "maximum":1470, "description":"Maximum UDP payload size for each single packet" }, "max-payload-size-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":64, "$ref":"/axapi/v3/ddos/action-list", "not":"max-payload-size-action", "description":"Configure action-list to take for max-payload-size exceed" }, "max-payload-size-action":{ "type":"string", "format":"enum", "not":"max-payload-size-action-list-name", "description":"'drop': Drop packets for max-payload-size exceed (Default); 'blacklist-src': Blacklist-src for max-payload-size exceed; 'ignore': Do nothing for max-payload-size exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "min-payload-size-cfg":{ "type":"object", "properties":{ "min-payload-size":{ "type":"number", "format":"number", "minimum":1, "maximum":1470, "description":"Minimum UDP payload size for each single packet" }, "min-payload-size-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":64, "$ref":"/axapi/v3/ddos/action-list", "not":"min-payload-size-action", "description":"Configure action-list to take for min-payload-size exceed" }, "min-payload-size-action":{ "type":"string", "format":"enum", "not":"min-payload-size-action-list-name", "description":"'drop': Drop packets for min-payload-size (Default); 'blacklist-src': Blacklist-src for min-payload-size; 'ignore': Do nothing for min-payload-size exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-src-port-template/udp/{name}/filter/{udp-filter-name}", "array":[ { "properties":{ "udp-filter-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "udp-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "description":"Sequence number", "optional":true }, "udp-filter-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "udp-filter-inverse-match":{ "type":"number", "format":"flag", "default":0, "description":"Inverse the result of the matching", "optional":true }, "byte-offset-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Filter using Berkeley Packet Filter syntax", "optional":true }, "udp-filter-action-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "not":"udp-filter-action", "description":"Configure action-list to take", "optional":true }, "udp-filter-action":{ "type":"string", "format":"enum", "not":"udp-filter-action-list-name", "description":"'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; ", "enum":[ "drop", "ignore", "blacklist-src", "authenticate-src" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "udp-filter-name" ] } ] } }, "required":[ "name" ] } ] }, "dns-list":{ "type":"array", "minItems":1, "items":{ "type":"dns" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-src-port-template/dns/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "query-resolution-check":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-src-port-template/dns/{name}/query-resolution-check", "properties":{ "session-timeout-value":{ "type":"number", "format":"number", "minimum":1, "maximum":30, "description":"max session timeout (secs) between DNS external server and Protected object" }, "domain-lockup-action":{ "type":"string", "format":"enum", "default":"default", "description":"'default': Default, No action for future connections; 'blacklist-src': Blacklist the external server for future connections; ", "enum":[ "default", "blacklist-src" ] }, "big-response-size":{ "type":"number", "format":"number", "minimum":1, "maximum":4096, "description":"Max DNS response size (in Bytes)" }, "big-response-action":{ "type":"string", "format":"enum", "default":"default", "description":"'default': Default, No action for future connections; 'blacklist-src': Blacklist the external server for future connections; ", "enum":[ "default", "blacklist-src" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] } } }, "template":{ "type":"object", "$ref":"/axapi/v3/ddos/template", "properties":{ "encap-list":{ "type":"array", "minItems":1, "items":{ "type":"encap" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/encap/{encap-tmpl-name}", "array":[ { "properties":{ "encap-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS Tunnel Template Name", "optional":false }, "tunnel-encap":{ "type":"object", "properties":{ "ip-cfg":{ "type":"object", "properties":{ "ip-encap":{ "type":"number", "format":"flag", "default":0, "description":"Enable Tunnel encap for IP packets" }, "always":{ "type":"object", "properties":{ "ipv4-addr":{ "type":"string", "format":"ipv4-address", "description":"IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "ipv6-addr":{ "type":"string", "format":"ipv6-address", "description":"IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } } } }, "gre-cfg":{ "type":"object", "properties":{ "gre-encap":{ "type":"number", "format":"flag", "default":0, "description":"Enable Tunnel encap for GRE packets" }, "gre-always":{ "type":"object", "properties":{ "gre-ipv4":{ "type":"string", "format":"ipv4-address", "description":"IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "key-ipv4":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "gre-ipv6":{ "type":"string", "format":"ipv6-address", "description":"IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "key-ipv6":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" } } } } } } }, "preserve-source-ip":{ "type":"number", "format":"flag", "default":0, "description":"Use original source ip for encapsulation", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "encap-tmpl-name" ] } ] }, "ssl-l4-list":{ "type":"array", "minItems":1, "items":{ "type":"ssl-l4" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/ssl-l4/{ssl-l4-tmpl-name}", "array":[ { "properties":{ "ssl-l4-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': drop; 'reset': reset; ", "enum":[ "drop", "reset" ], "optional":true }, "renegotiation":{ "type":"number", "format":"number", "minimum":0, "maximum":7, "description":"Configure renegotiation limiting for SSL (Number of renegotiation allowed)", "optional":true }, "request-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Configure rate limiting for SSL", "optional":true }, "allow-non-tls":{ "type":"number", "format":"flag", "default":0, "description":"Allow Non-TLS (SSLv3 and lower) traffic (Warning: security may be compromised)", "optional":true }, "auth-config-cfg":{ "type":"object", "properties":{ "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "default":5, "description":"Connection timeout" }, "trials":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":5, "description":"Number of failed handshakes" }, "auth-handshake-fail-action":{ "type":"string", "format":"enum", "description":"'blacklist-src': Blacklist-src when auth handshake fails; ", "enum":[ "blacklist-src" ] } } }, "cert-cfg":{ "type":"object", "properties":{ "cert":{ "type":"string", "format":"string", "plat-neg-list":["fips"], "minLength":1, "maxLength":255, "description":"SSL certificate" }, "key":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "description":"SSL key" }, "key-passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "description":"Password Phrase" }, "key-encrypted":{ "type":"encrypted", "format":"encrypted", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" } } }, "server-name-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "server-name":{ "type":"string", "format":"string", "plat-neg-list":["fips"], "minLength":1, "maxLength":255, "description":"Server name indication in Client hello extension (Server name String)" }, "server-cert":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "description":"Server Certificate associated to SNI (Server Certificate Name)" }, "server-key":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "description":"Server Private Key associated to SNI (Server Private Key Name)" }, "server-passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "description":"Password Phrase" }, "server-encrypted":{ "type":"encrypted", "format":"encrypted", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "optional":true } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "ssl-traffic-check":{ "type":"object", "$ref":"/axapi/v3/ddos/template/ssl-l4/{ssl-l4-tmpl-name}/ssl-traffic-check", "properties":{ "header-inspection":{ "type":"number", "format":"flag", "default":0, "description":"Inspect ssl header" }, "header-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets with bad ssl header; 'ignore': Forward packets with bad ssl header; ", "enum":[ "drop", "ignore" ] }, "check-resumed-connection":{ "type":"number", "format":"flag", "default":0, "description":"Apply checks to SSL connections initialized by ACK packets" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "ssl-l4-tmpl-name" ] } ] }, "http-list":{ "type":"array", "minItems":1, "items":{ "type":"http" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/http/{http-tmpl-name}", "array":[ { "properties":{ "http-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS HTTP Template Name", "optional":false }, "action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop packets for the connection; 'reset': Send RST for the connection; ", "enum":[ "drop", "reset" ], "optional":true }, "mss-cfg":{ "type":"object", "properties":{ "mss-timeout":{ "type":"number", "format":"flag", "default":0, "description":"Configure DDOS detection based on mss and packet size" }, "mss-percent":{ "type":"number", "format":"number", "minimum":1, "maximum":100, "description":"Configure percentage of mss such that if a packet size is below the mss times mss-percent, packet is considered bad." }, "number-packets":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"Specify percentage of mss. Default is 0, mss-timeout is not enabled." } } }, "disallow-connect-method":{ "type":"number", "format":"flag", "default":0, "description":"Do not allow HTTP Connect method (asymmetric mode only)", "optional":true }, "challenge-method":{ "type":"string", "format":"enum", "description":"'http-redirect': http-redirect; 'javascript': javascript; ", "enum":[ "http-redirect", "javascript" ], "optional":true }, "challenge-redirect-code":{ "type":"string", "format":"enum", "default":"302", "description":"'302': 302 Found; '307': 307 Temporary Redirect; ", "enum":[ "302", "307" ], "optional":true }, "challenge-uri-encode":{ "type":"number", "format":"flag", "default":0, "description":"Encode the challenge phrase in uri instead of in http cookie. Default encoded in http cookie", "optional":true }, "challenge-cookie-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "default":"sto-idd", "description":"Set the cookie name used to send back to client. Default is sto-idd", "optional":true }, "challenge-keep-cookie":{ "type":"number", "format":"flag", "default":0, "description":"Keep the challenge cookie from client and forward to backend. Default is do not keep", "optional":true }, "challenge-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "default":8, "description":"Specify the challenge interval. Default is 8 seconds", "optional":true }, "non-http-bypass":{ "type":"number", "format":"flag", "default":0, "description":"Bypass non-http traffic instead of dropping", "optional":true }, "malformed-http":{ "type":"object", "properties":{ "malformed-http-enabled":{ "type":"number", "format":"flag", "default":0, "description":"Enabling ddos malformed http protection. Default value is disabled." }, "malformed-http-max-line-size":{ "type":"number", "format":"number", "minimum":1, "maximum":65280, "default":32512, "description":"Set the maximum line size. Default value is 32512" }, "malformed-http-max-num-headers":{ "type":"number", "format":"number", "minimum":1, "maximum":90, "default":90, "description":"Set the maximum number of headers. Default value is 90" }, "malformed-http-max-req-line-size":{ "type":"number", "format":"number", "minimum":1, "maximum":65280, "default":32512, "description":"Set the maximum request line size. Default value is 32512" }, "malformed-http-max-header-name-size":{ "type":"number", "format":"number", "minimum":1, "maximum":64, "default":64, "description":"Set the maxinum header name length. Default value is 64." }, "malformed-http-max-content-length":{ "type":"number", "format":"number", "minimum":1, "maximum":4294967295, "default":4294967295, "description":"Set the maximum content-length header. Default value is 4294967295 bytes" }, "malformed-http-bad-chunk-mon-enabled":{ "type":"number", "format":"flag", "default":0, "description":"Enabling bad chunk monitoring. Default is disabled" } } }, "use-hdr-ip-cfg":{ "type":"object", "properties":{ "use-hdr-ip-as-source":{ "type":"number", "format":"flag", "default":0, "description":"Mitigate on src ip specified by http header for example X-Forwarded-For header. Default is disabled" }, "l7-hdr-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "default":"X-Forwarded-For", "description":"Set the http header name to parse for client ip. Default is X-Forwarded-For" } } }, "request-header":{ "type":"object", "properties":{ "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":63 } } }, "post-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Configure rate limiting for HTTP POST request", "optional":true }, "request-rate-limit":{ "type":"object", "properties":{ "request-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"HTTP request rate limit" }, "uri":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "equal-cfg":{ "type":"object", "properties":{ "url-equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Request rate-limit HTTP URI matching a specified pattern" }, "url-equals-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Request rate limit" } } }, "contains-cfg":{ "type":"object", "properties":{ "url-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Request rate-limit HTTP URI containing a specified pattern" }, "url-contains-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Request rate limit" } } }, "starts-cfg":{ "type":"object", "properties":{ "url-starts-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Request rate-limit HTTP URI strting with a specified pattern" }, "url-starts-with-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Request rate limit" } } }, "ends-cfg":{ "type":"object", "properties":{ "url-ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Request rate-limit HTTP URI ending with a specified pattern" }, "url-ends-with-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Request rate limit" } } }, "optional":true } } ] } } }, "response-rate-limit":{ "type":"object", "properties":{ "obj-size":{ "type":"object", "properties":{ "less-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "obj-less":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response size configuration" }, "obj-less-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response rate limit" }, "optional":true } } ] }, "greater-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "obj-greater":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response size configuration" }, "obj-greater-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response rate limit" }, "optional":true } } ] }, "between-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "obj-between1":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response size configuration" }, "obj-between2":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response size configuration" }, "obj-between-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Response rate limit" }, "optional":true } } ] } } } } }, "slow-read-drop":{ "type":"object", "properties":{ "min-window-size":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"minimum window size" }, "min-window-count":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"Number of packets" } } }, "idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"Set the the idle timeout value in seconds for HTTP connections", "optional":true }, "ignore-zero-payload":{ "type":"number", "format":"flag", "default":0, "description":"Don't reset idle timer on packets with zero payload length from clients", "optional":true }, "out-of-order-queue-size":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":3, "description":"Set the number of packets for the out-of-order HTTP queue (asym mode only)", "optional":true }, "out-of-order-queue-timeout":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":3, "description":"Set the timeout value in seconds for out-of-order queue in HTTP (asym mode only)", "optional":true }, "referer-filter":{ "type":"object", "properties":{ "ref-filter-blacklist":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist the source if the referer matches" }, "referer-equals-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "referer-equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "referer-contains-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "referer-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "referer-starts-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "referer-starts-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "referer-ends-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "referer-ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] } } }, "agent-filter":{ "type":"object", "properties":{ "agent-filter-blacklist":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist the source if the user-agent matches" }, "agent-equals-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "agent-equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "agent-contains-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "agent-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "agent-starts-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "agent-starts-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] }, "agent-ends-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "agent-ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63 }, "optional":true } } ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-header-list":{ "type":"array", "minItems":1, "items":{ "type":"filter-header" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/http/{http-tmpl-name}/filter-header/{http-filter-header-seq}", "array":[ { "properties":{ "http-filter-header-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Sequence number", "optional":false }, "http-filter-header-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "http-filter-header-unmatched":{ "type":"number", "format":"flag", "default":0, "description":"action taken when it does not match", "optional":true }, "http-filter-header-blacklist":{ "type":"number", "format":"flag", "default":0, "description":"Also blacklist the source when action is taken", "optional":true }, "http-filter-header-whitelist":{ "type":"number", "format":"flag", "default":0, "description":"Whitelist the source after filter passes, packets are dropped until then", "optional":true }, "http-filter-header-count-only":{ "type":"number", "format":"flag", "default":0, "description":"Take no action and continue processing the next filter", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "http-filter-header-seq" ] } ] } }, "required":[ "http-tmpl-name" ] } ] }, "dns-list":{ "type":"array", "minItems":1, "items":{ "type":"dns" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/dns/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop packets (Default action); 'reset': Send Client RST for TCP connections; ", "enum":[ "drop", "reset" ], "optional":true }, "dns-any-check":{ "type":"number", "format":"flag", "default":0, "description":"Drop DNS queries of Type ANY", "optional":true }, "dns-auth-cfg":{ "type":"object", "properties":{ "dns-auth":{ "type":"number", "format":"flag", "default":0, "description":"DNS authentication" }, "dns-auth-type":{ "type":"string", "format":"enum", "description":"'udp': Drop DNS request and monitor client retry; 'force-tcp': Force DNS request over TCP; ", "enum":[ "udp", "force-tcp" ] }, "udp-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"UDP authentication timeout in seconds" }, "min-retry-gap":{ "type":"number", "format":"number", "minimum":1, "maximum":80, "description":"Optional minimum sec gap in between 2 dns-udp packets for auth to pass, unit is specified by min-retry-gap-interval" }, "min-retry-gap-interval":{ "type":"string", "format":"enum", "default":"1sec", "description":"'100ms': 100ms; '1sec': 1sec; ", "enum":[ "100ms", "1sec" ] }, "with-udp-auth":{ "type":"number", "format":"flag", "default":0, "description":"Monitor client retry" }, "force-tcp-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"TCP authentication timeout in seconds" }, "force-tcp-min-retry-gap":{ "type":"number", "format":"number", "minimum":1, "maximum":15, "description":"Minimum sec gap in between 2 dns-udp packets for auth to pass" }, "force-tcp-ignore-client-source-port":{ "type":"number", "format":"flag", "default":0, "description":"Allow client to retransmit DNS request using different source port during udp-auth (supported in asymmetric mode only)" } } }, "fqdn-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "dns-fqdn-rate-limit":{ "type":"number", "format":"flag", "default":0, "description":"DNS Rate limiting on the basis of FQDN" }, "dns-fqdn-rate":{ "type":"number", "format":"number", "minimum":5, "maximum":16000000, "description":"Limiting rate (Range: 5-8000 for FQDN domain based rate limiting, 5-16000000 for FQDN label count based rate limiting)" }, "per":{ "type":"string", "format":"enum", "not":"by", "description":"'domain-name': Domain Name; 'src-ip': Source IP address; 'label-count': FQDN label count; ", "enum":[ "domain-name", "src-ip", "label-count" ] }, "per-domain-per-src-ip":{ "type":"number", "format":"flag", "default":0, "description":"Use both Domain Name and Source IP address for rate-limiting" }, "fqdn-rate-suffix":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Suffix count" }, "fqdn-rate-label-count":{ "type":"number", "format":"number", "minimum":1, "maximum":8, "description":"FQDN label count (Range: 1-8)" }, "fqdn-rate-suffix-by":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Number of suffixes" }, "optional":true } } ] }, "fqdn-label-len-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "fqdn-label-length":{ "type":"number", "format":"flag", "default":0, "description":"Maximum FQDN label length" }, "label-length":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"Maximum length of FQDN label" }, "fqdn-label-suffix":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Number of suffixes" }, "optional":true } } ] }, "fqdn-label-count":{ "type":"number", "format":"number", "minimum":1, "maximum":10, "description":"Maximum number of length of FQDN labels", "optional":true }, "nxdomain-cfg":{ "type":"object", "properties":{ "dns-nxdomain-rate-limit":{ "type":"number", "format":"flag", "default":0, "description":"DNS NXDOMAIN Rate Limiting (SRC support only)" }, "dns-nxdomain-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Limiting rate" }, "dns-nxdomain-rate-limit-action":{ "type":"string", "format":"enum", "description":"'drop': Drop queries if rate is exceeded; 'black-list': Black-List source if rate is exceeded; ", "enum":[ "drop", "black-list" ] } } }, "symtimeout-cfg":{ "type":"object", "properties":{ "sym-timeout":{ "type":"number", "format":"flag", "default":0, "description":"Timeout for DNS Symmetric session" }, "sym-timeout-value":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"Session timeout value in seconds" } } }, "dns-request-rate-limit":{ "type":"object", "properties":{ "type":{ "type":"object", "properties":{ "A-cfg":{ "type":"object", "properties":{ "A":{ "type":"number", "format":"flag", "default":0, "description":"Address record" }, "dns-a-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "AAAA-cfg":{ "type":"object", "properties":{ "AAAA":{ "type":"number", "format":"flag", "default":0, "description":"IPv6 address record" }, "dns-aaaa-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "CNAME-cfg":{ "type":"object", "properties":{ "CNAME":{ "type":"number", "format":"flag", "default":0, "description":"Canonical name record" }, "dns-cname-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "MX-cfg":{ "type":"object", "properties":{ "MX":{ "type":"number", "format":"flag", "default":0, "description":"Mail exchange record" }, "dns-mx-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "NS-cfg":{ "type":"object", "properties":{ "NS":{ "type":"number", "format":"flag", "default":0, "description":"Name server record" }, "dns-ns-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "SRV-cfg":{ "type":"object", "properties":{ "SRV":{ "type":"number", "format":"flag", "default":0, "description":"Service locator" }, "dns-srv-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"DNS request rate" } } }, "dns-type-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "dns-request-type":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Other type value" }, "dns-request-type-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"request rate limit" }, "optional":true } } ] } } } } }, "domain-group-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"Apply a domain-group to the DNS template", "optional":true }, "on-no-match":{ "type":"string", "format":"enum", "default":"deny", "description":"'permit': permit; 'deny': deny (default); ", "enum":[ "permit", "deny" ], "optional":true }, "domain-group-rate-exceed-action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop the query (default); 'tunnel-encap-packet': Encapsulate the query and send on a tunnel; ", "enum":[ "drop", "tunnel-encap-packet" ], "optional":true }, "encap-template":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template to sepcify the tunnel endpoint", "optional":true }, "domain-group-rate-per-service":{ "type":"number", "format":"flag", "default":0, "description":"Enable per service domain rate checking", "optional":true }, "query-rate-threshold-for-cache-serving":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"This is for DNS cache mode only, it sets a DNS query rate threshold such that queries under the rate threshold would be forward", "optional":true }, "allow-query-class":{ "type":"object", "properties":{ "allow-internet-query-class":{ "type":"number", "format":"flag", "default":0, "description":"INTERNET query class" }, "allow-csnet-query-class":{ "type":"number", "format":"flag", "default":0, "description":"CSNET query class" }, "allow-chaos-query-class":{ "type":"number", "format":"flag", "default":0, "description":"CHAOS query class" }, "allow-hesiod-query-class":{ "type":"number", "format":"flag", "default":0, "description":"HESIOD query class" }, "allow-none-query-class":{ "type":"number", "format":"flag", "default":0, "description":"NONE query class" }, "allow-any-query-class":{ "type":"number", "format":"flag", "default":0, "description":"ANY query class" } } }, "allow-record-type":{ "type":"object", "properties":{ "allow-a-type":{ "type":"number", "format":"flag", "default":0, "description":"Address record" }, "allow-aaaa-type":{ "type":"number", "format":"flag", "default":0, "description":"IPv6 address record" }, "allow-cname-type":{ "type":"number", "format":"flag", "default":0, "description":"Canonical name record" }, "allow-mx-type":{ "type":"number", "format":"flag", "default":0, "description":"Mail exchange record" }, "allow-ns-type":{ "type":"number", "format":"flag", "default":0, "description":"Name server record" }, "allow-srv-type":{ "type":"number", "format":"flag", "default":0, "description":"Service locator" }, "record-num-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "allow-num-type":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Other record type value" }, "optional":true } } ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "malformed-query-check":{ "type":"object", "$ref":"/axapi/v3/ddos/template/dns/{name}/malformed-query-check", "properties":{ "validation-type":{ "type":"string", "format":"enum", "description":"'basic-header-check': Basic header validation for DNS TCP/UDP queries; 'extended-header-check': Extended header/query validation for DNS TCP/UDP queries; 'disable': Disable Malform query validation for DNS TCP/UDP; ", "enum":[ "basic-header-check", "extended-header-check", "disable" ] }, "non-query-opcode-check":{ "type":"string", "format":"enum", "description":"'disable': When malform check is enabled, TPS always drops DNS query with non query opcode, this option disables this opcode check; ", "enum":[ "disable" ] }, "skip-multi-packet-check":{ "type":"number", "format":"flag", "default":0, "description":"Bypass DNS fragmented and TCP segmented Queries(Default: dropped)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] }, "tcp-list":{ "type":"array", "minItems":1, "items":{ "type":"tcp" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/tcp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "action-cfg":{ "type":"object", "properties":{ "action-on-ack":{ "type":"number", "format":"flag", "default":0, "description":"Monitor tcp ack for age-out session" }, "reset":{ "type":"number", "format":"flag", "default":0, "description":"Send RST to client" }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"ACK retry timeout in sec" }, "min-retry-gap":{ "type":"number", "format":"number", "minimum":1, "maximum":80, "description":"Min gap between 2 ACKs for action-on-ack pass in 100ms interval" }, "authenticate-only":{ "type":"number", "format":"flag", "default":0, "description":"Apply action-on-ack once per source address for authentication purpose" }, "rto-authentication":{ "type":"number", "format":"flag", "default":0, "description":"Estimate the RTO and apply the exponential back-off for authentication" } } }, "action-on-syn-rto-retry-count":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "description":"Take action if action-on-syn RTO-authentication fail over retry time(default:5)", "optional":true }, "action-on-ack-rto-retry-count":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "description":"Take action if action-on-ack RTO-authentication fail over retry time(default:5)", "optional":true }, "age":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"Session age in minutes", "optional":true }, "syn-cookie":{ "type":"number", "format":"flag", "default":0, "description":"Enable SYN Cookie", "optional":true }, "create-conn-on-syn-only":{ "type":"number", "format":"flag", "default":0, "description":"Enable connection establishment on SYN only", "optional":true }, "black-list-out-of-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":64000, "not":"per-conn-out-of-seq-rate-limit", "description":"Black list Src IP if out of seq pkts exceed configured threshold", "optional":true }, "black-list-retransmit":{ "type":"number", "format":"number", "minimum":1, "maximum":64000, "not":"per-conn-retransmit-rate-limit", "description":"Black list Src IP if retransmit pkts exceed configured threshold", "optional":true }, "black-list-zero-win":{ "type":"number", "format":"number", "minimum":1, "maximum":250, "not":"per-conn-zero-win-rate-limit", "description":"Black list Src IP if zero window pkts exceed configured threshold", "optional":true }, "syn-auth":{ "type":"string", "format":"enum", "default":"send-rst", "description":"'send-rst': Send RST to client upon client ACK; 'force-rst-by-ack': Force client RST via the use of ACK; 'force-rst-by-synack': Force client RST via the use of bad SYN|ACK; 'disable': Disable TCP SYN Authentication; 'send-rst-all': Send RST to client for all auth attempts; ", "enum":[ "send-rst", "force-rst-by-ack", "force-rst-by-synack", "disable", "send-rst-all" ], "optional":true }, "conn-rate-limit-on-syn-only":{ "type":"number", "format":"flag", "default":0, "description":"Only count SYN-initiated connections towards connection-rate tracking", "optional":true }, "per-conn-rate-interval":{ "type":"string", "format":"enum", "default":"1sec", "description":"'100ms': 100ms; '1sec': 1sec; '10sec': 10sec; ", "enum":[ "100ms", "1sec", "10sec" ], "optional":true }, "per-conn-pkt-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Packet rate limit per connection per rate-interval", "optional":true }, "per-conn-pkt-rate-action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop packets for per-conn-pkt-rate exceed (Default); 'blacklist-src': help Blacklist-src for per-conn-pkt-rate exceed; 'ignore': Ignore per-conn-pkt-rate-exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "per-conn-out-of-seq-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"black-list-out-of-seq", "description":"Take action if out-of-seq pkt rate exceed configured threshold", "optional":true }, "per-conn-out-of-seq-rate-action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop packets for out-of-seq rate exceed (Default); 'blacklist-src': help Blacklist-src for out-of-seq rate exceed; 'ignore': help Ignore out-of-seq rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "per-conn-retransmit-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"black-list-retransmit", "description":"Take action if retransmit pkt rate exceed configured threshold", "optional":true }, "per-conn-retransmit-rate-action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop packets for retransmit rate exceed (Default); 'blacklist-src': help Blacklist-src for retransmit rate exceed; 'ignore': help Ignore retransmit rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "per-conn-zero-win-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"black-list-zero-win", "description":"Take action if zero window pkt rate exceed configured threshold", "optional":true }, "per-conn-zero-win-rate-action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop packets for zero-win rate exceed (Default); 'blacklist-src': help Blacklist-src for zero-win rate exceed; 'ignore': help Ignore zero-win rate exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "dst":{ "type":"object", "properties":{ "rate-limit":{ "type":"object", "properties":{ "syn-rate-limit":{ "type":"object", "properties":{ "dst-syn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 }, "dst-syn-rate-action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop packets for syn-rate exceed (Default); 'ignore': Ignore syn-rate-exceed; ", "enum":[ "drop", "ignore" ] } } } } } } }, "src":{ "type":"object", "properties":{ "rate-limit":{ "type":"object", "properties":{ "syn-rate-limit":{ "type":"object", "properties":{ "src-syn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 }, "src-syn-rate-action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop packets for syn-rate exceed (Default); 'blacklist-src': Blacklist-src for syn-rate exceed; 'ignore': Ignore syn-rate-exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ] } } } } } } }, "allow-synack-skip-authentications":{ "type":"number", "format":"flag", "default":0, "description":"Allow create sessions on SYNACK without syn-auth and ack-auth (ASYM Mode only)", "optional":true }, "synack-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"track-together-with-syn", "description":"Config SYNACK rate limit", "optional":true }, "track-together-with-syn":{ "type":"number", "format":"flag", "default":0, "not":"synack-rate-limit", "description":"SYNACK will be counted in Dst Syn-rate limit", "optional":true }, "action-syn-cfg":{ "type":"object", "properties":{ "action-on-syn":{ "type":"number", "format":"flag", "default":0, "description":"Monitor tcp syn for age-out session" }, "action-on-syn-reset":{ "type":"number", "format":"flag", "default":0, "description":"Send RST to client" }, "action-on-syn-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"SYN retry timeout in sec" }, "action-on-syn-gap":{ "type":"number", "format":"number", "minimum":1, "maximum":80, "description":"Min gap between 2 SYNs for action-on-syn pass in 100ms interval" }, "action-on-syn-rto":{ "type":"number", "format":"flag", "default":0, "description":"Estimate the RTO and apply the exponential back-off for authentication" } } }, "allow-syn-otherflags":{ "type":"number", "format":"flag", "default":0, "description":"Treat TCP SYN+PSH as a TCP SYN (DST tcp ports support only)", "optional":true }, "allow-tcp-tfo":{ "type":"number", "format":"flag", "default":0, "description":"Allow TCP Fast Open", "optional":true }, "ack-authentication-synack-reset":{ "type":"number", "format":"flag", "plat-neg-list":["soft-ax"], "default":0, "description":"Enable Reset client TCP SYN+ACK for authentication (DST support only)", "optional":true }, "drop-known-resp-src-port-cfg":{ "type":"object", "properties":{ "drop-known-resp-src-port":{ "type":"number", "format":"flag", "default":0, "description":"Drop well-known if src-port is less than 1024" }, "exclude-src-resp-port":{ "type":"number", "format":"flag", "default":0, "description":"excluding src port equal destination port" } } }, "tunnel-encap":{ "type":"object", "properties":{ "ip-cfg":{ "type":"object", "properties":{ "ip-encap":{ "type":"number", "format":"flag", "default":0, "description":"Enable Tunnel encapsulation using IP in IP" }, "always":{ "type":"object", "properties":{ "ipv4-addr":{ "type":"string", "format":"ipv4-address", "description":"IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "preserve-src-ipv4":{ "type":"number", "format":"flag", "default":0, "description":"Use original source ip for encapsulation" }, "ipv6-addr":{ "type":"string", "format":"ipv6-address", "description":"IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "preserve-src-ipv6":{ "type":"number", "format":"flag", "default":0, "description":"Use original source ip for encapsulation" } } } } }, "gre-cfg":{ "type":"object", "properties":{ "gre-encap":{ "type":"number", "format":"flag", "default":0, "description":"Enable Tunnel encapsulation using GRE" }, "gre-always":{ "type":"object", "properties":{ "gre-ipv4":{ "type":"string", "format":"ipv4-address", "description":"IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "key-ipv4":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "preserve-src-ipv4-gre":{ "type":"number", "format":"flag", "default":0, "description":"Use original source ip for encapsulation" }, "gre-ipv6":{ "type":"string", "format":"ipv6-address", "description":"IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "key-ipv6":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "preserve-src-ipv6-gre":{ "type":"number", "format":"flag", "default":0, "description":"Use original source ip for encapsulation" } } } } } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/tcp/{name}/filter/{tcp-filter-seq}", "array":[ { "properties":{ "tcp-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Sequence number", "optional":false }, "tcp-filter-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "byte-offset-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Filter Expression using Berkeley Packet Filter syntax", "optional":true }, "tcp-filter-unmatched":{ "type":"number", "format":"flag", "default":0, "description":"action taken when it does not match", "optional":true }, "tcp-filter-action":{ "type":"string", "format":"enum", "description":"'blacklist-src': Also blacklist the source when action is taken; 'whitelist-src': Whitelist the source after filter passes, packets are dropped until then; 'count-only': Take no action and continue processing the next filter; ", "enum":[ "blacklist-src", "whitelist-src", "count-only" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "tcp-filter-seq" ] } ] } }, "required":[ "name" ] } ] }, "udp-list":{ "type":"array", "minItems":1, "items":{ "type":"udp" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/udp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS UDP Template Name", "optional":false }, "age":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"Configure session age(in minutes) for UDP sessions", "optional":true }, "per-conn-pkt-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Packet rate limit per connection per rate-interval", "optional":true }, "per-conn-rate-interval":{ "type":"string", "format":"enum", "default":"1sec", "description":"'100ms': 100ms; '1sec': 1sec; ", "enum":[ "100ms", "1sec" ], "optional":true }, "tunnel-encap":{ "type":"object", "properties":{ "ip-encap":{ "type":"number", "format":"flag", "default":0, "not":"gre-encap", "description":"Enable Tunnel encapsulation using IP in IP" }, "always":{ "type":"object", "properties":{ "ipv4-addr":{ "type":"string", "format":"ipv4-address", "description":"IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "preserve-src-ipv4":{ "type":"number", "format":"flag", "default":0, "description":"Use original source ip for encapsulation" }, "ipv6-addr":{ "type":"string", "format":"ipv6-address", "description":"IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "preserve-src-ipv6":{ "type":"number", "format":"flag", "default":0, "description":"Use original source ip for encapsulation" } } }, "gre-encap":{ "type":"number", "format":"flag", "default":0, "not":"ip-encap", "description":"Enable Tunnel encapsulation using GRE" }, "gre-always":{ "type":"object", "properties":{ "gre-ipv4":{ "type":"string", "format":"ipv4-address", "description":"IPv4 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "key-ipv4":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "preserve-src-ipv4-gre":{ "type":"number", "format":"flag", "default":0, "description":"Use original source ip for encapsulation" }, "gre-ipv6":{ "type":"string", "format":"ipv6-address", "description":"IPv6 address (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "key-ipv6":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Encapsulate with key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "preserve-src-ipv6-gre":{ "type":"number", "format":"flag", "default":0, "description":"Use original source ip for encapsulation" } } } } }, "spoof-detect-cfg":{ "type":"object", "properties":{ "spoof-detect":{ "type":"number", "format":"flag", "default":0, "description":"Force client to retry on udp" }, "min-retry-gap-interval":{ "type":"string", "format":"enum", "default":"1sec", "description":"'100ms': 100ms; '1sec': 1sec; ", "enum":[ "100ms", "1sec" ] }, "min-retry-gap":{ "type":"number", "format":"number", "minimum":1, "maximum":80, "description":"Optional minimum gap between 2 UDP packets for spoof-detect pass, unit is specified by min-retry-gap-interval" }, "spoof-detect-retry-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "default":5, "not":"spoof-detect-retry-timeout-val-only", "description":"timeout in seconds" } } }, "drop-known-resp-src-port-cfg":{ "type":"object", "properties":{ "drop-known-resp-src-port":{ "type":"number", "format":"flag", "default":0, "description":"Drop well-known if src-port is less than 1024" }, "exclude-src-resp-port":{ "type":"number", "format":"flag", "default":0, "description":"excluding src port equal destination port" } } }, "drop-ntp-monlist":{ "type":"number", "format":"flag", "default":0, "description":"Drop NTP monlist request/response", "optional":true }, "token-authentication":{ "type":"number", "format":"flag", "default":0, "description":"Enable Token Authentication", "optional":true }, "token-authentication-hw-assist-disable":{ "type":"number", "format":"flag", "plat-neg-list":["non-fpga", "soft-ax"], "default":0, "description":"token-authentication disable hardware assistance", "optional":true }, "token-authentication-salt-prefix":{ "type":"number", "format":"flag", "default":0, "description":"token-authentication salt-prefix", "optional":true }, "token-authentication-salt-prefix-curr":{ "type":"number", "format":"number", "minimum":1, "maximum":4294967295, "optional":true }, "token-authentication-salt-prefix-prev":{ "type":"number", "format":"number", "minimum":1, "maximum":4294967295, "optional":true }, "token-authentication-formula":{ "type":"string", "format":"enum", "description":"'md5_Salt-SrcIp-SrcPort-DstIp-DstPort': md5 of Salt-SrcIp-SrcPort-DstIp-DstPort; 'md5_Salt-DstIp-DstPort': md5 of Salt-DstIp-DstPort; 'md5_Salt-SrcIp-DstIp': md5 of Salt-SrcIp-DstIp; 'md5_Salt-SrcPort-DstPort': md5 of Salt-SrcPort-DstPort; 'md5_Salt-UintDstIp-DstPort': Using the uint value of IP for md5 of Salt-DstIp-DstPort; 'sha1_Salt-SrcIp-SrcPort-DstIp-DstPort': sha1 of Salt-SrcIp-SrcPort-DstIp-DstPort; 'sha1_Salt-DstIp-DstPort': sha1 of Salt-DstIp-DstPort; 'sha1_Salt-SrcIp-DstIp': sha1 of Salt-SrcIp-DstIp; 'sha1_Salt-SrcPort-DstPort': sha1 of Salt-SrcPort-DstPort; 'sha1_Salt-UintDstIp-DstPort': Using the uint value of IP for sha1 of Salt-DstIp-DstPort; ", "enum":[ "md5_Salt-SrcIp-SrcPort-DstIp-DstPort", "md5_Salt-DstIp-DstPort", "md5_Salt-SrcIp-DstIp", "md5_Salt-SrcPort-DstPort", "md5_Salt-UintDstIp-DstPort", "sha1_Salt-SrcIp-SrcPort-DstIp-DstPort", "sha1_Salt-DstIp-DstPort", "sha1_Salt-SrcIp-DstIp", "sha1_Salt-SrcPort-DstPort", "sha1_Salt-UintDstIp-DstPort" ], "optional":true }, "token-authentication-public-address":{ "type":"number", "format":"flag", "default":0, "description":"The server public IP address", "optional":true }, "public-ipv4-addr":{ "type":"string", "format":"ipv4-address", "description":"IP address", "optional":true }, "public-ipv6-addr":{ "type":"string", "format":"ipv6-address", "description":"IPV6 address", "optional":true }, "max-payload-size":{ "type":"number", "format":"number", "minimum":1, "maximum":1470, "description":"Maximum UDP payload size for each single packet", "optional":true }, "min-payload-size":{ "type":"number", "format":"number", "minimum":1, "maximum":1470, "description":"Minimum UDP payload size for each single packet", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/udp/{name}/filter/{udp-filter-seq}", "array":[ { "properties":{ "udp-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Sequence number", "optional":false }, "udp-filter-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "byte-offset-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Filter Expression using Berkeley Packet Filter syntax", "optional":true }, "udp-filter-unmatched":{ "type":"number", "format":"flag", "default":0, "description":"action taken when it does not match", "optional":true }, "udp-filter-action":{ "type":"string", "format":"enum", "description":"'blacklist-src': Also blacklist the source when action is taken; 'whitelist-src': Whitelist the source after filter passes, packets are dropped until then; 'count-only': Take no action and continue processing the next filter; ", "enum":[ "blacklist-src", "whitelist-src", "count-only" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "udp-filter-seq" ] } ] } }, "required":[ "name" ] } ] }, "other-list":{ "type":"array", "minItems":1, "items":{ "type":"other" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/other/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS OTHER Template Name", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/other/{name}/filter/{other-filter-seq}", "array":[ { "properties":{ "other-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Sequence number", "optional":false }, "other-filter-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "byte-offset-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Filter Expression using Berkeley Packet Filter syntax", "optional":true }, "other-filter-unmatched":{ "type":"number", "format":"flag", "default":0, "description":"action taken when it does not match", "optional":true }, "other-filter-action":{ "type":"string", "format":"enum", "description":"'blacklist-src': Also blacklist the source when action is taken; 'whitelist-src': Whitelist the source after filter passes, packets are dropped until then; 'count-only': Take no action and continue processing the next filter; ", "enum":[ "blacklist-src", "whitelist-src", "count-only" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "other-filter-seq" ] } ] } }, "required":[ "name" ] } ] }, "icmp-v4-list":{ "type":"array", "minItems":1, "items":{ "type":"icmp-v4" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/icmp-v4/{icmp-tmpl-name}", "array":[ { "properties":{ "icmp-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ICMPv4 Template Name", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "type-list":{ "type":"array", "minItems":1, "items":{ "type":"type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/icmp-v4/{icmp-tmpl-name}/type/{type-number}", "array":[ { "properties":{ "type-number":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Specify ICMP type number", "optional":false }, "type-deny":{ "type":"number", "format":"flag", "default":0, "not-list":[ "type-rate", "code-other-rate" ], "description":"Reject this ICMP type", "optional":true }, "type-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"type-deny", "description":"Specify the whole rate with this type", "optional":true }, "code":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "code-number":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Specify the ICMP code" }, "code-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the rate with the code" }, "optional":true } } ] }, "code-other":{ "type":"object", "properties":{ "code-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"type-deny", "description":"Specify rate with other code" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "type-number" ] } ] }, "type-other":{ "type":"object", "$ref":"/axapi/v3/ddos/template/icmp-v4/{icmp-tmpl-name}/type-other", "properties":{ "type-other-deny":{ "type":"number", "format":"flag", "default":0, "not":"type-other-rate", "description":"Deny all other type" }, "type-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"type-other-deny", "description":"Specify rate with other type" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "icmp-tmpl-name" ] } ] }, "icmp-v6-list":{ "type":"array", "minItems":1, "items":{ "type":"icmp-v6" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/icmp-v6/{icmp-tmpl-name}", "array":[ { "properties":{ "icmp-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ICMPv6 Template Name", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "type-list":{ "type":"array", "minItems":1, "items":{ "type":"type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/icmp-v6/{icmp-tmpl-name}/type/{type-number}", "array":[ { "properties":{ "type-number":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Specify ICMP type number", "optional":false }, "type-deny":{ "type":"number", "format":"flag", "default":0, "not-list":[ "type-rate", "code-other-rate" ], "description":"Reject this ICMP type", "optional":true }, "type-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"type-deny", "description":"Specify the whole rate with this type", "optional":true }, "code":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "code-number":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Specify the ICMP code" }, "code-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "description":"Specify the rate with the code" }, "optional":true } } ] }, "code-other":{ "type":"object", "properties":{ "code-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"type-deny", "description":"Specify rate with other code" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "type-number" ] } ] }, "type-other":{ "type":"object", "$ref":"/axapi/v3/ddos/template/icmp-v6/{icmp-tmpl-name}/type-other", "properties":{ "type-other-deny":{ "type":"number", "format":"flag", "default":0, "not":"type-other-rate", "description":"Deny all other type" }, "type-other-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000, "not":"type-other-deny", "description":"Specify rate with other type" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "icmp-tmpl-name" ] } ] }, "monitor-list":{ "type":"array", "minItems":1, "items":{ "type":"monitor" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/monitor/{id}", "array":[ { "properties":{ "id":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Monitor template ID Number", "optional":false }, "clear-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "sessions":{ "type":"string", "format":"enum", "description":"'all': Clear all sessions; 'sequence': Sequence number; ", "enum":[ "all", "sequence" ] }, "clear-all-sequence":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Sequence number (Specify the action sequence number)" }, "clear-sequence":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Specify the action sequence number" }, "optional":true } } ] }, "link-disable-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "diseth":{ "type":"number", "format":"interface", "minimum":3, "maximum":128, "description":"Specify the physical port number (Ethernet interface number)" }, "dis-sequence":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Sequence number (Specify the action sequence number)" }, "optional":true } } ] }, "link-enable-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "enaeth":{ "type":"number", "format":"interface", "minimum":3, "maximum":128, "description":"Specify the physical port number (Ethernet interface number)" }, "ena-sequence":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Sequence number (Specify the action sequence number)" }, "optional":true } } ] }, "monitor-relation":{ "type":"string", "format":"enum", "default":"monitor-and", "description":"'monitor-and': Configures the monitors in current template to work with AND logic; 'monitor-or': Configures the monitors in current template to work with OR logic; ", "enum":[ "monitor-and", "monitor-or" ], "optional":true }, "link-up-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "linkup-ethernet1":{ "type":"number", "format":"interface", "minimum":3, "maximum":128, "description":"Specify the port physical port number (Ethernet interface number)" }, "link-up-sequence1":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Sequence number (Specify the monitor sequence number)" }, "linkup-ethernet2":{ "type":"number", "format":"interface", "minimum":3, "maximum":128, "description":"Specify the port physical port number (Ethernet interface number)" }, "link-up-sequence2":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Sequence number (Specify the monitor sequence number)" }, "linkup-ethernet3":{ "type":"number", "format":"interface", "minimum":3, "maximum":128, "description":"Specify the port physical port number (Ethernet interface number)" }, "link-up-sequence3":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Sequence number (Specify the monitor sequence number)" }, "optional":true } } ] }, "link-down-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "linkdown-ethernet1":{ "type":"number", "format":"interface", "minimum":3, "maximum":128, "description":"Specify the port physical port number (Ethernet interface number)" }, "link-down-sequence1":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Sequence number (Specify the monitor sequence number)" }, "linkdown-ethernet2":{ "type":"number", "format":"interface", "minimum":3, "maximum":128, "description":"Specify the port physical port number (Ethernet interface number)" }, "link-down-sequence2":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Sequence number (Specify the monitor sequence number)" }, "linkdown-ethernet3":{ "type":"number", "format":"interface", "minimum":3, "maximum":128, "description":"Specify the port physical port number (Ethernet interface number)" }, "link-down-sequence3":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "description":"Sequence number (Specify the monitor sequence number)" }, "optional":true } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "id" ] } ] }, "logging-list":{ "type":"array", "minItems":1, "items":{ "type":"logging" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/logging/{logging-tmpl-name}", "array":[ { "properties":{ "logging-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "default":"default", "description":"DDOS Logging Template Name", "optional":false }, "log-format-cef":{ "type":"number", "format":"flag", "default":0, "description":"Log in CEF format", "optional":true }, "use-obj-name":{ "type":"number", "format":"flag", "default":0, "description":"Show obj name instead of ip in the log", "optional":true }, "log-format-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":512, "description":"Customize log format", "optional":true }, "enable-action-logging":{ "type":"number", "format":"flag", "default":0, "description":"Log action taken", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "logging-tmpl-name" ] } ] }, "sip-list":{ "type":"array", "minItems":1, "items":{ "type":"sip" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/sip/{sip-tmpl-name}", "array":[ { "properties":{ "sip-tmpl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS SIP Template Name", "optional":false }, "idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"Set the the idle timeout value for sip-tcp connections", "optional":true }, "ignore-zero-payload":{ "type":"number", "format":"flag", "default":0, "description":"Don't reset idle timer on packets with zero payload length from clients", "optional":true }, "action":{ "type":"string", "format":"enum", "default":"drop", "description":"'drop': Drop packets for sip connection; 'reset': Send RST for sip-tcp connection; ", "enum":[ "drop", "reset" ], "optional":true }, "dst":{ "type":"object", "properties":{ "sip-request-rate-limit":{ "type":"object", "properties":{ "method":{ "type":"object", "properties":{ "invite-cfg":{ "type":"object", "properties":{ "dst-sip-invite-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"INVITE method" }, "dst-sip-invite-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "register-cfg":{ "type":"object", "properties":{ "dst-sip-register-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"REGISTER method" }, "dst-sip-register-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "options-cfg":{ "type":"object", "properties":{ "dst-sip-options-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"OPTIONS method" }, "dst-sip-options-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "bye-cfg":{ "type":"object", "properties":{ "dst-sip-bye-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"BYE method" }, "dst-sip-bye-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "subscribe-cfg":{ "type":"object", "properties":{ "dst-sip-subscribe-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"SUBSCRIBE method" }, "dst-sip-subscribe-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "notify-cfg":{ "type":"object", "properties":{ "dst-sip-notify-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"NOTIFY method" }, "dst-sip-notify-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "refer-cfg":{ "type":"object", "properties":{ "dst-sip-refer-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"REFER method" }, "dst-sip-refer-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "message-cfg":{ "type":"object", "properties":{ "dst-sip-message-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"MESSAGE method" }, "dst-sip-message-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "update-cfg":{ "type":"object", "properties":{ "dst-sip-update-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"UPDATE method" }, "dst-sip-update-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } } } } } } } }, "src":{ "type":"object", "properties":{ "sip-request-rate-limit":{ "type":"object", "properties":{ "method":{ "type":"object", "properties":{ "invite-cfg":{ "type":"object", "properties":{ "src-sip-invite-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"INVITE method" }, "src-sip-invite-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "register-cfg":{ "type":"object", "properties":{ "src-sip-register-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"REGISTER method" }, "src-sip-register-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "options-cfg":{ "type":"object", "properties":{ "src-sip-options-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"OPTIONS method" }, "src-sip-options-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "bye-cfg":{ "type":"object", "properties":{ "src-sip-bye-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"BYE method" }, "src-sip-bye-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "subscribe-cfg":{ "type":"object", "properties":{ "src-sip-subscribe-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"SUBSCRIBE method" }, "src-sip-subscribe-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "notify-cfg":{ "type":"object", "properties":{ "src-sip-notify-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"NOTIFY method" }, "src-sip-notify-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "refer-cfg":{ "type":"object", "properties":{ "src-sip-refer-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"REFER method" }, "src-sip-refer-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "message-cfg":{ "type":"object", "properties":{ "src-sip-message-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"MESSAGE method" }, "src-sip-message-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } }, "update-cfg":{ "type":"object", "properties":{ "src-sip-update-cfg-flag":{ "type":"number", "format":"flag", "default":0, "description":"UPDATE method" }, "src-sip-update-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":16000000 } } } } } } } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "malformed-sip":{ "type":"object", "$ref":"/axapi/v3/ddos/template/sip/{sip-tmpl-name}/malformed-sip", "properties":{ "malformed-sip-check":{ "type":"string", "format":"enum", "description":"'enable-check': Enable malformed SIP parameters; ", "enum":[ "enable-check" ] }, "malformed-sip-max-line-size":{ "type":"number", "format":"number", "minimum":1, "maximum":32511, "default":32511, "description":"Set the maximum line size. Default value is 32511" }, "malformed-sip-max-uri-length":{ "type":"number", "format":"number", "minimum":1, "maximum":32511, "default":32511, "description":"Set the maximum uri size. Default value is 32511" }, "malformed-sip-max-header-name-length":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "default":63, "description":"Set the maximum header name length. Default value is 63" }, "malformed-sip-max-header-value-length":{ "type":"number", "format":"number", "minimum":1, "maximum":32511, "default":32511, "description":"Set the maximum header value length. Default value is 32511" }, "malformed-sip-call-id-max-length":{ "type":"number", "format":"number", "minimum":1, "maximum":32511, "default":32511, "description":"Set the maximum call-id length. Default value is 32511" }, "malformed-sip-sdp-max-length":{ "type":"number", "format":"number", "minimum":1, "maximum":32511, "default":32511, "description":"Set the maxinum SDP content length. Default value is 32511" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "filter-header-list":{ "type":"array", "minItems":1, "items":{ "type":"filter-header" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/template/sip/{sip-tmpl-name}/filter-header/{sip-filter-header-seq}", "array":[ { "properties":{ "sip-filter-header-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Sequence number", "optional":false }, "sip-filter-header-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "sip-filter-header-unmatched":{ "type":"number", "format":"flag", "default":0, "description":"action taken when it does not match", "optional":true }, "sip-filter-header-blacklist":{ "type":"number", "format":"flag", "default":0, "description":"Also blacklist the source when action is taken", "optional":true }, "sip-filter-header-whitelist":{ "type":"number", "format":"flag", "default":0, "description":"Whitelist the source after filter passes, packets are dropped until then", "optional":true }, "sip-filter-header-count-only":{ "type":"number", "format":"flag", "default":0, "description":"Take no action and continue processing the next filter", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "sip-filter-header-seq" ] } ] } }, "required":[ "sip-tmpl-name" ] } ] } } }, "src-port-template":{ "type":"object", "$ref":"/axapi/v3/ddos/src-port-template", "properties":{ "tcp-list":{ "type":"array", "minItems":1, "items":{ "type":"tcp" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src-port-template/tcp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src-port-template/tcp/{name}/filter/{tcp-filter-seq}", "array":[ { "properties":{ "tcp-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Sequence number", "optional":false }, "tcp-filter-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "byte-offset-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Filter Expression using Berkeley Packet Filter syntax", "optional":true }, "tcp-filter-unmatched":{ "type":"number", "format":"flag", "default":0, "description":"action taken when it does not match", "optional":true }, "tcp-filter-action":{ "type":"string", "format":"enum", "description":"'blacklist-src': Also blacklist the source when action is taken; 'whitelist-src': Whitelist the source after filter passes, packets are dropped until then; 'count-only': Take no action and continue processing the next filter; ", "enum":[ "blacklist-src", "whitelist-src", "count-only" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "tcp-filter-seq" ] } ] } }, "required":[ "name" ] } ] }, "udp-list":{ "type":"array", "minItems":1, "items":{ "type":"udp" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src-port-template/udp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS UDP Template Name", "optional":false }, "drop-ntp-monlist":{ "type":"number", "format":"flag", "default":0, "description":"Drop NTP monlist request/response", "optional":true }, "max-payload-size":{ "type":"number", "format":"number", "minimum":1, "maximum":1470, "description":"Maximum UDP payload size for each single packet", "optional":true }, "min-payload-size":{ "type":"number", "format":"number", "minimum":1, "maximum":1470, "description":"Minimum UDP payload size for each single packet", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src-port-template/udp/{name}/filter/{udp-filter-seq}", "array":[ { "properties":{ "udp-filter-seq":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "description":"Sequence number", "optional":false }, "udp-filter-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Regex Expression", "optional":true }, "byte-offset-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1275, "description":"Filter Expression using Berkeley Packet Filter syntax", "optional":true }, "udp-filter-unmatched":{ "type":"number", "format":"flag", "default":0, "description":"action taken when it does not match", "optional":true }, "udp-filter-action":{ "type":"string", "format":"enum", "description":"'blacklist-src': Also blacklist the source when action is taken; 'whitelist-src': Whitelist the source after filter passes, packets are dropped until then; 'count-only': Take no action and continue processing the next filter; ", "enum":[ "blacklist-src", "whitelist-src", "count-only" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "udp-filter-seq" ] } ] } }, "required":[ "name" ] } ] }, "dns-list":{ "type":"array", "minItems":1, "items":{ "type":"dns" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src-port-template/dns/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "query-resolution-check":{ "type":"object", "$ref":"/axapi/v3/ddos/src-port-template/dns/{name}/query-resolution-check", "properties":{ "session-timeout-value":{ "type":"number", "format":"number", "minimum":1, "maximum":30, "description":"max session timeout (secs) between DNS external server and Protected object" }, "domain-lockup-action":{ "type":"string", "format":"enum", "default":"default", "description":"'default': Default, No action for future connections; 'blacklist-src': Blacklist the external server for future connections; ", "enum":[ "default", "blacklist-src" ] }, "big-response-size":{ "type":"number", "format":"number", "minimum":1, "maximum":4096, "description":"Max DNS response size (in Bytes)" }, "big-response-action":{ "type":"string", "format":"enum", "default":"default", "description":"'default': Default, No action for future connections; 'blacklist-src': Blacklist the external server for future connections; ", "enum":[ "default", "blacklist-src" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] } } }, "dns-cache-config":{ "type":"object", "$ref":"/axapi/v3/ddos/dns-cache-config", "properties":{ "disable-zone-transfer-in-warm-up-mode":{ "type":"number", "format":"flag", "default":0, "description":"Disable warm up zone transfer" }, "disable-zone-transfer-in-oper-mode":{ "type":"number", "format":"flag", "default":0, "description":"Disable operational refreshing zone transfer" }, "enable-cache-warm-up-bgp-advertise":{ "type":"number", "format":"flag", "default":0, "description":"Enable route injection during cold boot" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "max-concurrent-zone-transfers":{ "type":"object", "$ref":"/axapi/v3/ddos/dns-cache-config/max-concurrent-zone-transfers", "properties":{ "warm-up-mode":{ "type":"number", "format":"number", "minimum":100, "maximum":65535, "default":65472, "description":"Number of concurrent zone transfers during cold boot (default 65472)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "dns-cache-list":{ "type":"array", "minItems":1, "items":{ "type":"dns-cache" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dns-cache/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DNS Cache Instance Name", "optional":false }, "zone-domain-lookup-miss-action":{ "type":"string", "format":"enum", "default":"respond-nxdomain", "description":"'respond-nxdomain': Send NxDomain response; 'drop': Drop the request; ", "enum":[ "respond-nxdomain", "drop" ], "optional":true }, "default-serving-action":{ "type":"string", "format":"enum", "default":"serve-from-cache", "description":"'serve-from-cache': Serve DNS records; 'forward': Forward to DNS server; 'drop': Drop the request; ", "enum":[ "serve-from-cache", "forward", "drop" ], "optional":true }, "any-query-action-str":{ "type":"string", "format":"enum", "default":"respond-refuse", "description":"'respond-refuse': Send refuse response (default); 'respond-empty': Send empty response; 'drop': Drop the request; ", "enum":[ "respond-refuse", "respond-empty", "drop" ], "optional":true }, "non-authoritative-zone-query-action-str":{ "type":"string", "format":"enum", "default":"respond-refuse", "description":"'default': Default action: respond-refuse; 'forward': Forward to DNS server; 'respond-refuse': Send refuse response; 'drop': Drop the request; ", "enum":[ "default", "forward", "respond-refuse", "drop" ], "optional":true }, "neg-cache-action-follow-q-rate":{ "type":"number", "format":"flag", "default":0, "description":"Negative cached response queries counted toward query-rate-threshold", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "zone-transfer":{ "type":"object", "$ref":"/axapi/v3/ddos/dns-cache/{name}/zone-transfer", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "domain-group":{ "type":"object", "$ref":"/axapi/v3/ddos/dns-cache/{name}/domain-group", "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DNS domain group" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "domain-list-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"domain-list-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dns-cache/{name}/domain-group/domain-list-policy/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DNS domain list policy", "optional":false }, "server-ipv4":{ "type":"string", "format":"ipv4-address", "description":"Master ipv4 address", "optional":true }, "server-v4-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":53, "description":"Port number (default 53)", "optional":true }, "client-ipv4":{ "type":"string", "format":"ipv4-address", "description":"Client ipv4 address", "optional":true }, "server-ipv6":{ "type":"string", "format":"ipv6-address", "description":"Master ipv6 address", "optional":true }, "server-v6-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":53, "description":"Port number (default 53)", "optional":true }, "client-ipv6":{ "type":"string", "format":"ipv6-address", "description":"Client ipv6 address", "optional":true }, "refresh-interval-hours":{ "type":"number", "format":"number", "minimum":0, "maximum":24, "default":4, "description":"Zone transfer refresh rate in hours (Default 4). 0 means no refresh", "optional":true }, "ttl-override":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "description":"Override the TTL value for zone transfer", "optional":true }, "respond-with-authority":{ "type":"number", "format":"flag", "default":0, "description":"Respond with authority section for all requests under this list", "optional":true }, "oversize-answer-response":{ "type":"string", "format":"enum", "default":"set-truncate-bit", "description":"'set-truncate-bit': Set the TC bit for oversize answer(default); 'disable-truncate-bit': Do not set TC bit for oversize answer; ", "enum":[ "set-truncate-bit", "disable-truncate-bit" ], "optional":true }, "resolve-cname-record":{ "type":"number", "format":"flag", "default":0, "description":"Always try to resolve domain in CNAME record answer section", "optional":true }, "manual-refresh":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":253, "description":"Manually refresh the particular zone", "optional":true }, "force":{ "type":"number", "format":"flag", "default":0, "description":"Force update even the serial is the same", "optional":true }, "cache-all-records":{ "type":"number", "format":"flag", "default":0, "description":"cache all fqdn records including uncommon types", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] } } }, "sharded-domain-group-list":{ "type":"array", "minItems":1, "items":{ "type":"sharded-domain-group" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dns-cache/{name}/sharded-domain-group/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DNS sharded domain group", "optional":false }, "match-action":{ "type":"string", "format":"enum", "default":"forward", "description":"'forward': Forward query to server (default); 'tunnel-encap': Encapsulate the query and send on a tunnel; ", "enum":[ "forward", "tunnel-encap" ], "optional":true }, "encap-template":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template to sepcify the tunnel endpoint", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "sharded-domain-list-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"sharded-domain-list-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dns-cache/{name}/sharded-domain-group/{name}/sharded-domain-list-policy/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DNS sharded domain list policy", "optional":false }, "server-ipv4":{ "type":"string", "format":"ipv4-address", "description":"Master ipv4 address", "optional":true }, "server-v4-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":53, "description":"Port number (default 53)", "optional":true }, "client-ipv4":{ "type":"string", "format":"ipv4-address", "description":"Client ipv4 address", "optional":true }, "server-ipv6":{ "type":"string", "format":"ipv6-address", "description":"Master ipv6 address", "optional":true }, "server-v6-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":53, "description":"Port number (default 53)", "optional":true }, "client-ipv6":{ "type":"string", "format":"ipv6-address", "description":"Client ipv6 address", "optional":true }, "refresh-interval-hours":{ "type":"number", "format":"number", "minimum":0, "maximum":24, "default":4, "description":"Zone transfer refresh rate in hours (Default 4). 0 means no refresh", "optional":true }, "manual-refresh":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":253, "description":"Manually refresh the particular zone", "optional":true }, "force":{ "type":"number", "format":"flag", "default":0, "description":"Force update even the serial is the same", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] } }, "required":[ "name" ] } ] }, "fqdn-manual-override-action-list":{ "type":"array", "minItems":1, "items":{ "type":"fqdn-manual-override-action" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dns-cache/{name}/fqdn-manual-override-action/{fqdn-name}", "array":[ { "properties":{ "fqdn-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":253, "description":"Specify fqdn name", "optional":false }, "action":{ "type":"string", "format":"enum", "description":"'default': Default; 'forward': Forward to DNS server; 'drop': Drop the request; 'serve-from-cache': Serve DNS records; ", "enum":[ "default", "forward", "drop", "serve-from-cache" ], "optional":true } }, "required":[ "fqdn-name" ] } ] }, "zone-manual-override-action-list":{ "type":"array", "minItems":1, "items":{ "type":"zone-manual-override-action" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dns-cache/{name}/zone-manual-override-action/{zone-name}", "array":[ { "properties":{ "zone-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":253, "description":"Specify zone name", "optional":false }, "action":{ "type":"string", "format":"enum", "description":"'default': Default; 'forward': Forward to DNS server; 'drop': Drop the request; 'serve-from-cache': Serve DNS records; ", "enum":[ "default", "forward", "drop", "serve-from-cache" ], "optional":true } }, "required":[ "zone-name" ] } ] } }, "required":[ "name" ] } ] }, "notification-template-list":{ "type":"array", "minItems":1, "items":{ "type":"notification-template" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/notification-template/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS nofitication template name", "optional":false }, "disable":{ "type":"number", "format":"flag", "default":0, "description":"Disable the notification template (Disable notification temaplate)", "optional":true }, "test-connectivity":{ "type":"number", "format":"flag", "default":0, "description":"Test connectivity to notification receiver", "optional":true }, "verbose":{ "type":"number", "format":"flag", "default":0, "description":"Dump zone IPs to the payload", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "api":{ "type":"object", "$ref":"/axapi/v3/ddos/notification-template/{name}/api", "properties":{ "host-ipv4-address":{ "type":"string", "format":"ipv4-address", "not-list":[ "host-ipv6-address", "hostname" ], "description":"Configure the host IPv4 address to send notification (IPv4 address of the host)" }, "host-ipv6-address":{ "type":"string", "format":"ipv6-address", "not-list":[ "host-ipv4-address", "hostname" ], "description":"Configure the host IPv6 address to send notification (IPv6 address of the host)" }, "hostname":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "not-list":[ "host-ipv4-address", "host-ipv6-address" ], "description":"host name(e.g www.a10networks.com)" }, "http-protocol":{ "type":"string", "format":"enum", "default":"https", "description":"'http': Use http protocol; 'https': Use https protocol(default); (http protocol)", "enum":[ "http", "https" ] }, "http-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":80, "description":"Configure the http port to use(default 80) (http port(default 80))" }, "https-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":443, "description":"Configure the https port to use(default 443) (https port(default 443))" }, "timeout":{ "type":"number", "format":"number", "minimum":5, "maximum":60, "default":10, "description":"Configure the api execution timeout(default 10secs) (api timeout)" }, "relative-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"/", "description":"Configure the relative uri for the api(e.g /example , default /) (api relative uri)" }, "disable-authentication":{ "type":"number", "format":"flag", "default":0, "description":"Disable authentication to communicate to the host" }, "use-mgmt-port":{ "type":"number", "format":"flag", "default":0, "description":"Use management port to send out notification" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "authentication":{ "type":"object", "$ref":"/axapi/v3/ddos/notification-template/{name}/api/authentication", "properties":{ "relative-login-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Configure the authentication login uri" }, "relative-logoff-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Configure the authentication logoff uri" }, "auth-username":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "description":"Configure the authentication user name" }, "auth-password":{ "type":"number", "format":"flag", "default":0, "description":"Configure the authentication user password (Authentication password)" }, "auth-password-val":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "description":"Configure the authentication user password (Authentication password)" }, "encrypted":{ "type":"encrypted", "format":"encrypted", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)" }, "api-key":{ "type":"number", "format":"flag", "default":0, "description":"Configure api-key as a mode of authentication" }, "api-key-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":64, "description":"Configure api-key as a mode of authentication" }, "api-key-encrypted":{ "type":"encrypted", "format":"encrypted", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } } }, "required":[ "name" ] } ] }, "notification-template-common":{ "type":"object", "$ref":"/axapi/v3/ddos/notification-template-common", "properties":{ "default-template":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "default-notification-template":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/notification-template", "description":"Specify the notification template name (Default notification template name)" }, "optional":true } } ] }, "on-box-gui-notification":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': enable; 'disable': disable; ", "enum":[ "enable", "disable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "violation-actions-list":{ "type":"array", "minItems":1, "items":{ "type":"violation-actions" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/violation-actions/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS violation-actions name", "optional":false }, "blacklist-src":{ "type":"number", "format":"number", "minimum":1, "maximum":30, "description":"Blacklist-src (in min) (applied only for source action)", "optional":true }, "blackhole":{ "type":"number", "format":"number", "minimum":0, "maximum":30, "description":"Blackhole the zone (in minute, 0 means infinite)", "optional":true }, "execute-script":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "description":"Specify DDOS script to run (applied only for zone action)", "optional":true }, "execute-script-timeout":{ "type":"number", "format":"number", "minimum":5, "maximum":20, "description":"Timeout for script execution (in seconds) (applied only for zone action)", "optional":true }, "notification":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "notification-template":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/notification-template", "description":"Specify the notification template name" }, "optional":true } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "zone-profile-list":{ "type":"array", "minItems":1, "items":{ "type":"zone-profile" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-profile/{profile-name}", "array":[ { "properties":{ "profile-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Profile for DDoS zone thresholds", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "port-list":{ "type":"array", "minItems":1, "items":{ "type":"port" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port Number", "optional":false }, "port-protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': dns-tcp; 'dns-udp': dns-udp; 'sip-tcp': sip-tcp; 'sip-udp': sip-udp; 'http': http; 'tcp': tcp; 'udp': udp; 'ssl-l4': ssl-l4; 'quic': quic; ", "enum":[ "dns-tcp", "dns-udp", "sip-tcp", "sip-udp", "http", "tcp", "udp", "ssl-l4", "quic" ], "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "indicator-list":{ "type":"array", "minItems":1, "items":{ "type":"indicator" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}/indicator/{indicator-name}", "array":[ { "properties":{ "indicator-name":{ "type":"string", "format":"enum", "description":"'pkt-rate': pkt-rate; 'pkt-drop-rate': pkt-drop-rate; 'pkt-drop-ratio': pkt-drop-ratio; 'bytes-to-bytes-from-ratio': bytes-to-bytes-from-ratio; 'concurrent-conns': concurrent-conns; 'conn-miss-rate': conn-miss-rate; 'syn-rate': syn-rate; 'fin-rate': fin-rate; 'rst-rate': rst-rate; 'small-window-ack-rate': small-window-ack-rate; 'empty-ack-rate': empty-ack-rate; 'small-payload-rate': small-payload-rate; 'syn-fin-ratio': syn-fin-ratio; 'cpu-utilization': cpu-utilization; 'interface-utilization': interface-utilization; ", "enum":[ "pkt-rate", "pkt-drop-rate", "pkt-drop-ratio", "bytes-to-bytes-from-ratio", "concurrent-conns", "conn-miss-rate", "syn-rate", "fin-rate", "rst-rate", "small-window-ack-rate", "empty-ack-rate", "small-payload-rate", "syn-fin-ratio", "cpu-utilization", "interface-utilization" ], "optional":false }, "src-threshold-cfg":{ "type":"object", "properties":{ "src-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Indicator per-src threshold" }, "src-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Indicator per-src threshold" } } }, "zone-threshold-cfg":{ "type":"object", "properties":{ "zone-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Threshold for the entire zone" }, "zone-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Threshold for the entire zone" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "indicator-name" ] } ] } }, "required":[ "port-num", "port-protocol" ] } ] }, "ip-proto":{ "type":"object", "$ref":"/axapi/v3/ddos/zone-profile/{profile-name}/ip-proto", "properties":{ "proto-number-list":{ "type":"array", "minItems":1, "items":{ "type":"proto-number" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-profile/{profile-name}/ip-proto/proto-number/{protocol-num}", "array":[ { "properties":{ "protocol-num":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Protocol Number", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "indicator-list":{ "type":"array", "minItems":1, "items":{ "type":"indicator" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-profile/{profile-name}/ip-proto/proto-number/{protocol-num}/indicator/{indicator-name}", "array":[ { "properties":{ "indicator-name":{ "type":"string", "format":"enum", "description":"'pkt-rate': pkt-rate; 'pkt-drop-rate': pkt-drop-rate; 'pkt-drop-ratio': pkt-drop-ratio; 'bytes-to-bytes-from-ratio': bytes-to-bytes-from-ratio; 'frag-rate': frag-rate; 'cpu-utilization': cpu-utilization; 'interface-utilization': interface-utilization; ", "enum":[ "pkt-rate", "pkt-drop-rate", "pkt-drop-ratio", "bytes-to-bytes-from-ratio", "frag-rate", "cpu-utilization", "interface-utilization" ], "optional":false }, "src-threshold-cfg":{ "type":"object", "properties":{ "src-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Indicator per-src threshold" }, "src-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Indicator per-src threshold" } } }, "zone-threshold-cfg":{ "type":"object", "properties":{ "zone-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Threshold for the entire zone" }, "zone-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Threshold for the entire zone" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "indicator-name" ] } ] } }, "required":[ "protocol-num" ] } ] }, "proto-name-list":{ "type":"array", "minItems":1, "items":{ "type":"proto-name" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-profile/{profile-name}/ip-proto/proto-name/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'icmp-v4': ip-proto icmp-v4; 'icmp-v6': ip-proto icmp-v6; 'gre': ip-proto gre; 'ipv4-encap': ip-proto IPv4 Encapsulation; 'ipv6-encap': ip-proto IPv6 Encapsulation; ", "enum":[ "icmp-v4", "icmp-v6", "gre", "ipv4-encap", "ipv6-encap" ], "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "indicator-list":{ "type":"array", "minItems":1, "items":{ "type":"indicator" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-profile/{profile-name}/ip-proto/proto-name/{protocol}/indicator/{indicator-name}", "array":[ { "properties":{ "indicator-name":{ "type":"string", "format":"enum", "description":"'pkt-rate': pkt-rate; 'pkt-drop-rate': pkt-drop-rate; 'pkt-drop-ratio': pkt-drop-ratio; 'bytes-to-bytes-from-ratio': bytes-to-bytes-from-ratio; 'frag-rate': frag-rate; 'cpu-utilization': cpu-utilization; 'interface-utilization': interface-utilization; ", "enum":[ "pkt-rate", "pkt-drop-rate", "pkt-drop-ratio", "bytes-to-bytes-from-ratio", "frag-rate", "cpu-utilization", "interface-utilization" ], "optional":false }, "src-threshold-cfg":{ "type":"object", "properties":{ "src-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Indicator per-src threshold" }, "src-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Indicator per-src threshold" } } }, "zone-threshold-cfg":{ "type":"object", "properties":{ "zone-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Threshold for the entire zone" }, "zone-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Threshold for the entire zone" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "indicator-name" ] } ] } }, "required":[ "protocol" ] } ] } } }, "port-range-list":{ "type":"array", "minItems":1, "items":{ "type":"port-range" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-profile/{profile-name}/port-range/{port-range-start}+{port-range-end}+{protocol}", "array":[ { "properties":{ "port-range-start":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port-Range Start Port Number", "optional":false }, "port-range-end":{ "type":"number", "format":"number", "minimum":2, "maximum":65535, "description":"Port-Range End Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; 'sip-tcp': SIP-TCP Port; 'sip-udp': SIP-UDP Port; 'quic': QUIC Port; ", "enum":[ "dns-tcp", "dns-udp", "http", "tcp", "udp", "ssl-l4", "sip-tcp", "sip-udp", "quic" ], "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "indicator-list":{ "type":"array", "minItems":1, "items":{ "type":"indicator" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/zone-profile/{profile-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/indicator/{indicator-name}", "array":[ { "properties":{ "indicator-name":{ "type":"string", "format":"enum", "description":"'pkt-rate': pkt-rate; 'pkt-drop-rate': pkt-drop-rate; 'pkt-drop-ratio': pkt-drop-ratio; 'bytes-to-bytes-from-ratio': bytes-to-bytes-from-ratio; 'concurrent-conns': concurrent-conns; 'conn-miss-rate': conn-miss-rate; 'syn-rate': syn-rate; 'fin-rate': fin-rate; 'rst-rate': rst-rate; 'small-window-ack-rate': small-window-ack-rate; 'empty-ack-rate': empty-ack-rate; 'small-payload-rate': small-payload-rate; 'syn-fin-ratio': syn-fin-ratio; 'cpu-utilization': cpu-utilization; 'interface-utilization': interface-utilization; ", "enum":[ "pkt-rate", "pkt-drop-rate", "pkt-drop-ratio", "bytes-to-bytes-from-ratio", "concurrent-conns", "conn-miss-rate", "syn-rate", "fin-rate", "rst-rate", "small-window-ack-rate", "empty-ack-rate", "small-payload-rate", "syn-fin-ratio", "cpu-utilization", "interface-utilization" ], "optional":false }, "src-threshold-cfg":{ "type":"object", "properties":{ "src-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Indicator per-src threshold" }, "src-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Indicator per-src threshold" } } }, "zone-threshold-cfg":{ "type":"object", "properties":{ "zone-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Threshold for the entire zone" }, "zone-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Threshold for the entire zone" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "indicator-name" ] } ] } }, "required":[ "port-range-start", "port-range-end", "protocol" ] } ] } }, "required":[ "profile-name" ] } ] }, "notification-template-debug-log":{ "type":"object", "$ref":"/axapi/v3/ddos/notification-template-debug-log", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "use-default-route":{ "type":"object", "$ref":"/axapi/v3/ddos/use-default-route", "properties":{ "ethernet-start-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ethernet-start":{ "type":"number", "format":"interface", "description":"Traffic receive from the ethernet port will use default route" }, "ethernet-end":{ "type":"number", "format":"interface" }, "optional":true } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "tap":{ "type":"object", "$ref":"/axapi/v3/ddos/tap", "properties":{ "ethernet-start-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ethernet-start":{ "type":"number", "format":"interface", "description":"Traffic receive from the ethernet port will be dropped" }, "ethernet-end":{ "type":"number", "format":"interface" }, "optional":true } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "local-address":{ "type":"object", "$ref":"/axapi/v3/ddos/local-address", "properties":{ "ip-list":{ "type":"array", "minItems":1, "items":{ "type":"ip" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/local-address/ip/{ip-addr}", "array":[ { "properties":{ "ip-addr":{ "type":"string", "format":"ipv4-address", "description":"DDoS IPv4 Address for syn cookie usage", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "ip-addr" ] } ] }, "ipv6-list":{ "type":"array", "minItems":1, "items":{ "type":"ipv6" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/local-address/ipv6/{ipv6-addr}", "array":[ { "properties":{ "ipv6-addr":{ "type":"string", "format":"ipv6-address", "description":"DDoS IPv6 Address for syn cookie usage", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "ipv6-addr" ] } ] } } }, "src-based-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"src-based-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src-based-policy/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Specify name of the policy", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "policy-class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"policy-class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src-based-policy/{name}/policy-class-list/{class-list-name}", "array":[ { "properties":{ "class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Class-list name", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "class-list-name" ] } ] } }, "required":[ "name" ] } ] }, "outbound-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"outbound-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/outbound-policy/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Specify name of the policy", "optional":false }, "allow-all-outbound-dst-port":{ "type":"number", "format":"flag", "default":0, "description":"Allow all outbound ip-proto and destination port", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "policy-class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"policy-class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/outbound-policy/{name}/policy-class-list/{class-list-name}", "array":[ { "properties":{ "class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/class-list", "description":"Class-list name", "optional":false }, "class-list-glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "class-list-name" ] } ] }, "policy-default-class-list":{ "type":"object", "$ref":"/axapi/v3/ddos/outbound-policy/{name}/policy-default-class-list", "properties":{ "configuration":{ "type":"number", "format":"flag", "default":0, "description":"Default class-list configuration" }, "class-list-glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] }, "src":{ "type":"object", "$ref":"/axapi/v3/ddos/src", "properties":{ "default-list":{ "type":"array", "minItems":1, "items":{ "type":"default" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/default/{default-address-type}", "array":[ { "properties":{ "default-address-type":{ "type":"string", "format":"enum", "description":"'ip': ip; 'ipv6': ipv6; ", "enum":[ "ip", "ipv6" ], "optional":false }, "disable":{ "type":"number", "format":"flag", "default":0, "description":"Disable", "optional":true }, "age":{ "type":"number", "format":"number", "minimum":2, "maximum":1023, "default":5, "description":"Idle age for ip entry", "optional":true }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" } } }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic src entry", "optional":true }, "apply-policy-on-overflow":{ "type":"number", "format":"flag", "default":0, "description":"Enable this flag to apply overflow policy when dynamic entry count overflows", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/default/{default-address-type}/l4-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS TCP template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS UDP template" }, "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS OTHER template" }, "template-icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v4 template" }, "template-icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v6 template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "app-type-list":{ "type":"array", "minItems":1, "items":{ "type":"app-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/default/{default-address-type}/app-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; ", "enum":[ "dns", "http", "ssl-l4", "sip" ], "optional":false }, "template":{ "type":"object", "properties":{ "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } }, "required":[ "default-address-type" ] } ] }, "dynamic-entry-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"dynamic-entry-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/dynamic-entry-overflow-policy/{default-address-type}", "array":[ { "properties":{ "default-address-type":{ "type":"string", "format":"enum", "description":"'ip': ip; 'ipv6': ipv6; ", "enum":[ "ip", "ipv6" ], "optional":false }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" }, "with-sflow-sample":{ "type":"number", "format":"flag", "default":0, "description":"Turn on sflow sample with log" } } }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/dynamic-entry-overflow-policy/{default-address-type}/l4-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS TCP template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS UDP template" }, "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS OTHER template" }, "template-icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v4 template" }, "template-icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v6 template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "app-type-list":{ "type":"array", "minItems":1, "items":{ "type":"app-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/dynamic-entry-overflow-policy/{default-address-type}/app-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; ", "enum":[ "dns", "http", "ssl-l4", "sip" ], "optional":false }, "template":{ "type":"object", "properties":{ "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } }, "required":[ "default-address-type" ] } ] }, "entry-list":{ "type":"array", "minItems":1, "items":{ "type":"entry" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/entry/{src-entry-name}", "array":[ { "properties":{ "src-entry-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "ipv6-addr":{ "type":"string", "format":"ipv6-address", "modify-not-allowed":1, "optional":true }, "ip-addr":{ "type":"string", "format":"ipv4-address", "modify-not-allowed":1, "optional":true }, "subnet-ip-addr":{ "type":"string", "format":"ipv4-cidr", "modify-not-allowed":1, "description":"IP Subnet", "optional":true }, "subnet-ipv6-addr":{ "type":"string", "format":"ipv6-address-plen", "modify-not-allowed":1, "description":"IPV6 Subnet", "optional":true }, "description":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Description for this Source Entry", "optional":true }, "bypass":{ "type":"number", "format":"flag", "default":0, "description":"Always permit for the Source to bypass all feature & limit checks", "optional":true }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" } } }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "hw-blacklist-blocking":{ "type":"object", "$ref":"/axapi/v3/ddos/src/entry/{src-entry-name}/hw-blacklist-blocking", "properties":{ "src-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable Src side hardware blocking" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "l4-type-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/entry/{src-entry-name}/l4-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "action":{ "type":"string", "format":"enum", "description":"'permit': Whitelist incoming packets for protocol; 'deny': Blacklist incoming packets for protocol; ", "enum":[ "permit", "deny" ], "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS TCP template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS UDP template" }, "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS OTHER template" }, "template-icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v4 template" }, "template-icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v6 template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "app-type-list":{ "type":"array", "minItems":1, "items":{ "type":"app-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/entry/{src-entry-name}/app-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; ", "enum":[ "dns", "http", "ssl-l4", "sip" ], "optional":false }, "template":{ "type":"object", "properties":{ "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } }, "required":[ "src-entry-name" ] } ] }, "geo-location-list":{ "type":"array", "minItems":1, "items":{ "type":"geo-location" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/geo-location/{geolocation-name}", "array":[ { "properties":{ "geolocation-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":15, "description":"Geolocation Name", "optional":false }, "description":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Description for this Geolocation Entry", "optional":true }, "bypass":{ "type":"number", "format":"flag", "default":0, "description":"Always permit for the Source to bypass all feature & limit checks", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/geo-location/{geolocation-name}/l4-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "action":{ "type":"string", "format":"enum", "description":"'permit': Whitelist incoming packets for protocol; 'deny': Blacklist incoming packets for protocol; ", "enum":[ "permit", "deny" ], "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS TCP template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS UDP template" }, "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS OTHER template" }, "template-icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS ICMP template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "app-type-list":{ "type":"array", "minItems":1, "items":{ "type":"app-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/src/geo-location/{geolocation-name}/app-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; ", "enum":[ "dns", "http", "ssl-l4", "sip" ], "optional":false }, "template":{ "type":"object", "properties":{ "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS DNS template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS HTTP template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } }, "required":[ "geolocation-name" ] } ] }, "dynamic-entry":{ "type":"object", "$ref":"/axapi/v3/ddos/src/dynamic-entry", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "dynamic-entries-resource-usage":{ "type":"object", "$ref":"/axapi/v3/ddos/src/dynamic-entries-resource-usage", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "dst":{ "type":"object", "$ref":"/axapi/v3/ddos/dst", "properties":{ "default-list":{ "type":"array", "minItems":1, "items":{ "type":"default" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/default/{default-address-type}", "array":[ { "properties":{ "default-address-type":{ "type":"string", "format":"enum", "description":"'ip': ip; 'ipv6': ipv6; ", "enum":[ "ip", "ipv6" ], "optional":false }, "disable":{ "type":"number", "format":"flag", "default":0, "description":"Disable", "optional":true }, "age":{ "type":"number", "format":"number", "minimum":5, "maximum":1023, "description":"Idle age for ip entry", "optional":true }, "exceed-log-dep-cfg":{ "type":"object", "properties":{ "exceed-log-enable":{ "type":"number", "format":"flag", "default":0, "description":"(Deprecated)Enable logging of limit exceed drop's" }, "log-with-sflow-dep":{ "type":"number", "format":"flag", "default":0, "description":"Turn on sflow sample with log" } } }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" }, "with-sflow-sample":{ "type":"number", "format":"flag", "default":0, "description":"Turn on sflow sample with log" } } }, "drop-disable":{ "type":"number", "format":"flag", "default":0, "description":"Disable certain drops during packet processing", "optional":true }, "drop-disable-fwd-immediate":{ "type":"number", "format":"flag", "default":0, "description":"Immediately forward L4 drops", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "drop-frag-pkt":{ "type":"number", "format":"flag", "default":0, "description":"Drop fragmented packets", "optional":true }, "inbound-forward-dscp":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"To set dscp value for inbound packets (DSCP Value for the clear traffic marking)", "optional":true }, "outbound-forward-dscp":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"To set dscp value for outbound", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic dst entry", "optional":true }, "apply-policy-on-overflow":{ "type":"number", "format":"flag", "default":0, "description":"Enable this flag to apply overflow policy when dynamic entry count overflows", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/default/{default-address-type}/l4-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "max-rexmit-syn-per-flow":{ "type":"number", "format":"number", "minimum":1, "maximum":6, "description":"Maximum number of re-transmit SYN per flow. Exceed action set to Drop", "optional":true }, "syn-auth":{ "type":"string", "format":"enum", "default":"send-rst", "description":"'send-rst': Send RST to client upon client ACK; 'force-rst-by-ack': Force client RST via the use of ACK; 'force-rst-by-synack': Force client RST via the use of bad SYN|ACK; 'disable': Disable TCP SYN Authentication; ", "enum":[ "send-rst", "force-rst-by-ack", "force-rst-by-synack", "disable" ], "optional":true }, "syn-cookie":{ "type":"number", "format":"flag", "default":0, "description":"Enable SYN Cookie", "optional":true }, "tcp-reset-client":{ "type":"number", "format":"flag", "default":0, "description":"Send reset to client when rate exceeds or session ages out", "optional":true }, "tcp-reset-server":{ "type":"number", "format":"flag", "default":0, "description":"Send reset to server when rate exceeds or session ages out", "optional":true }, "drop-on-no-port-match":{ "type":"string", "format":"enum", "default":"enable", "description":"'disable': disable; 'enable': enable; ", "enum":[ "disable", "enable" ], "optional":true }, "stateful":{ "type":"number", "format":"flag", "default":0, "description":"Enable stateful tracking of sessions (Default is stateless)", "optional":true }, "tunnel-decap":{ "type":"object", "properties":{ "ip-decap":{ "type":"number", "format":"flag", "default":0, "description":"Enable IP Tunnel decapsulation" }, "gre-decap":{ "type":"number", "format":"flag", "default":0, "description":"Enable GRE Tunnel decapsulation" }, "key-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "key":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Only decapsulate GRE packet with this key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "optional":true } } ] } } }, "tunnel-rate-limit":{ "type":"object", "properties":{ "ip-rate-limit":{ "type":"number", "format":"flag", "default":0, "description":"Enable inner IP rate limiting on IPinIP traffic" }, "gre-rate-limit":{ "type":"number", "format":"flag", "default":0, "description":"Enable inner IP rate limiting on GRE traffic" } } }, "drop-frag-pkt":{ "type":"number", "format":"flag", "default":0, "description":"Drop fragmented packets", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "port-list":{ "type":"array", "minItems":1, "items":{ "type":"port" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/default/{default-address-type}/port/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': dns-tcp; 'dns-udp': dns-udp; 'http': http; 'tcp': tcp; 'udp': udp; 'ssl-l4': ssl-l4; 'sip-udp': sip-udp; 'sip-tcp': sip-tcp; ", "enum":[ "dns-tcp", "dns-udp", "http", "tcp", "udp", "ssl-l4", "sip-udp", "sip-tcp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS udp template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num", "protocol" ] } ] }, "src-port-list":{ "type":"array", "minItems":1, "items":{ "type":"src-port" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/default/{default-address-type}/src-port/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'udp': udp; 'tcp': tcp; ", "enum":[ "udp", "tcp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "src-udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS udp src template" }, "src-tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS tcp src template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num", "protocol" ] } ] }, "ip-proto-list":{ "type":"array", "minItems":1, "items":{ "type":"ip-proto" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/default/{default-address-type}/ip-proto/{port-num}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Protocol Number", "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS other template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num" ] } ] } }, "required":[ "default-address-type" ] } ] }, "dynamic-entry-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"dynamic-entry-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/dynamic-entry-overflow-policy/{default-address-type}", "array":[ { "properties":{ "default-address-type":{ "type":"string", "format":"enum", "description":"'ip': ip; 'ipv6': ipv6; ", "enum":[ "ip", "ipv6" ], "optional":false }, "exceed-log-dep-cfg":{ "type":"object", "properties":{ "exceed-log-enable":{ "type":"number", "format":"flag", "default":0, "description":"(Deprecated)Enable logging of limit exceed drop's" }, "log-with-sflow-dep":{ "type":"number", "format":"flag", "default":0, "description":"Turn on sflow sample with log" } } }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" }, "with-sflow-sample":{ "type":"number", "format":"flag", "default":0, "description":"Turn on sflow sample with log" } } }, "drop-disable":{ "type":"number", "format":"flag", "default":0, "description":"Disable certain drops during packet processing", "optional":true }, "drop-disable-fwd-immediate":{ "type":"number", "format":"flag", "default":0, "description":"Immediately forward L4 drops", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "inbound-forward-dscp":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"To set dscp value for inbound packets (DSCP Value for the clear traffic marking)", "optional":true }, "outbound-forward-dscp":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "description":"To set dscp value for outbound", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/dynamic-entry-overflow-policy/{default-address-type}/l4-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "max-rexmit-syn-per-flow":{ "type":"number", "format":"number", "minimum":1, "maximum":6, "description":"Maximum number of re-transmit SYN per flow. Exceed action set to Drop", "optional":true }, "syn-auth":{ "type":"string", "format":"enum", "default":"send-rst", "description":"'send-rst': Send RST to client upon client ACK; 'force-rst-by-ack': Force client RST via the use of ACK; 'force-rst-by-synack': Force client RST via the use of bad SYN|ACK; 'disable': Disable TCP SYN Authentication; ", "enum":[ "send-rst", "force-rst-by-ack", "force-rst-by-synack", "disable" ], "optional":true }, "syn-cookie":{ "type":"number", "format":"flag", "default":0, "description":"Enable SYN Cookie", "optional":true }, "tcp-reset-client":{ "type":"number", "format":"flag", "default":0, "description":"Send reset to client when rate exceeds or session ages out", "optional":true }, "tcp-reset-server":{ "type":"number", "format":"flag", "default":0, "description":"Send reset to server when rate exceeds or session ages out", "optional":true }, "drop-on-no-port-match":{ "type":"string", "format":"enum", "default":"enable", "description":"'disable': disable; 'enable': enable; ", "enum":[ "disable", "enable" ], "optional":true }, "stateful":{ "type":"number", "format":"flag", "default":0, "description":"Enable stateful tracking of sessions (Default is stateless)", "optional":true }, "tunnel-decap":{ "type":"object", "properties":{ "ip-decap":{ "type":"number", "format":"flag", "default":0, "description":"Enable IP Tunnel decapsulation" }, "gre-decap":{ "type":"number", "format":"flag", "default":0, "description":"Enable GRE Tunnel decapsulation" }, "key-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "key":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Only decapsulate GRE packet with this key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "optional":true } } ] } } }, "tunnel-rate-limit":{ "type":"object", "properties":{ "ip-rate-limit":{ "type":"number", "format":"flag", "default":0, "description":"Enable inner IP rate limiting on IPinIP traffic" }, "gre-rate-limit":{ "type":"number", "format":"flag", "default":0, "description":"Enable inner IP rate limiting on GRE traffic" } } }, "drop-frag-pkt":{ "type":"number", "format":"flag", "default":0, "description":"Drop fragmented packets", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "port-list":{ "type":"array", "minItems":1, "items":{ "type":"port" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/dynamic-entry-overflow-policy/{default-address-type}/port/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': dns-tcp; 'dns-udp': dns-udp; 'http': http; 'tcp': tcp; 'udp': udp; 'ssl-l4': ssl-l4; 'sip-udp': sip-udp; 'sip-tcp': sip-tcp; ", "enum":[ "dns-tcp", "dns-udp", "http", "tcp", "udp", "ssl-l4", "sip-udp", "sip-tcp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS udp template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num", "protocol" ] } ] }, "src-port-list":{ "type":"array", "minItems":1, "items":{ "type":"src-port" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/dynamic-entry-overflow-policy/{default-address-type}/src-port/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'udp': udp; 'tcp': tcp; ", "enum":[ "udp", "tcp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "src-udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS udp src template" }, "src-tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS tcp src template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num", "protocol" ] } ] }, "ip-proto-list":{ "type":"array", "minItems":1, "items":{ "type":"ip-proto" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/dynamic-entry-overflow-policy/{default-address-type}/ip-proto/{port-num}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Protocol Number", "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS other template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num" ] } ] } }, "required":[ "default-address-type" ] } ] }, "entry-list":{ "type":"array", "minItems":1, "items":{ "type":"entry" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}", "array":[ { "properties":{ "dst-entry-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "ipv6-addr":{ "type":"string", "format":"ipv6-address", "modify-not-allowed":1, "optional":true }, "ip-addr":{ "type":"string", "format":"ipv4-address", "modify-not-allowed":1, "optional":true }, "subnet-ip-addr":{ "type":"string", "format":"ipv4-cidr", "modify-not-allowed":1, "description":"IP Subnet", "optional":true }, "subnet-ipv6-addr":{ "type":"string", "format":"ipv6-address-plen", "modify-not-allowed":1, "description":"IPV6 Subnet", "optional":true }, "description":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Description for this Destination Entry", "optional":true }, "exceed-log-dep-cfg":{ "type":"object", "properties":{ "exceed-log-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"(Deprecated)Enable logging of limit exceed drop's" }, "log-with-sflow-dep":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Turn on sflow sample with log" } } }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable logging of limit exceed drop's" }, "log-with-sflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Turn on sflow sample with log" }, "log-high-frequency":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable High frequency logging for non-event logs per entry" }, "rate-limit":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":1, "maximum":1000, "default":1, "description":"Rate limit per second per entry(Default : 1 per second)" } } }, "log-periodic":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "drop-frag-pkt":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Drop fragmented packets", "optional":true }, "sflow":{ "type":"object", "properties":{ "polling":{ "type":"object", "properties":{ "sflow-packets":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow packet-level counter polling. WARNING: Entry level Sflow polling might induce heavy CPU load depending on the tota" }, "sflow-layer-4":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow Layer 4 counter polling. WARNING: Entry level Sflow polling might induce heavy CPU load depending on the total num" }, "sflow-tcp":{ "type":"object", "properties":{ "sflow-tcp-basic":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow basic TCP counter polling. WARNING: Entry level Sflow polling might induce heavy CPU load depending on the total n" }, "sflow-tcp-stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow stateful TCP counter polling. WARNING: Entry level Sflow polling might induce heavy CPU load depending on the tota" } } }, "sflow-http":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow HTTP counter polling. WARNING: Entry level Sflow polling might induce heavy CPU load depending on the total number" }, "sflow-undef-port-hit-stats":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow undefined-port-hit-statistics polling" }, "sflow-undef-port-hit-stats-brief":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow undefined-port-hit-statistics polling in brief mode" } } }, "collector":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "sflow-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "$ref":"/axapi/v3/sflow/collector/custom", "description":"Name of configured custom sFlow collector" }, "optional":true } } ] } } }, "drop-on-no-src-dst-default":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Drop if no match with src-based-policy class-list, and default is not configured", "optional":true }, "blackhole-on-glid-exceed":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":1, "maximum":30, "description":"Blackhole destination entry for X minutes upon glid limit exceeded", "optional":true }, "source-nat-pool":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"Configure source NAT", "optional":true }, "dest-nat-ip":{ "type":"string", "format":"ipv4-address", "plat-neg-list":["softax-ddet"], "description":"Destination NAT IP address", "optional":true }, "dest-nat-ipv6":{ "type":"string", "format":"ipv6-address", "plat-neg-list":["softax-ddet"], "description":"Destination NAT IPv6 address", "optional":true }, "drop-disable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Disable certain drops during packet processing", "optional":true }, "drop-disable-fwd-immediate":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Immediately forward L4 drops", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "operational-mode":{ "type":"string", "format":"enum", "default":"protection", "description":"'protection': Protection mode; 'bypass': Bypass mode; ", "enum":[ "protection", "bypass" ], "optional":true }, "reporting-disabled":{ "type":"number", "format":"flag", "default":0, "description":"Disable Reporting", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-exceed-action":{ "type":"object", "properties":{ "stateless-encap-action-cfg":{ "type":"object", "properties":{ "stateless-encap-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'stateless-tunnel-encap': Encapsulate all packets; 'stateless-tunnel-encap-scrubbed': Encapsulate all packets and allow packets to go through other DDoS checks before sent (conn-limit exceeded packet can not be scrubbed, it will default to stateless-tunnel-encap); ", "enum":[ "stateless-tunnel-encap", "stateless-tunnel-encap-scrubbed" ] }, "encap-template":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "$ref":"/axapi/v3/ddos/template/encap", "description":"Apply legacy encap template for encap action" } } } } }, "advertised-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"BGP advertised", "optional":true }, "inbound-forward-dscp":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":1, "maximum":63, "description":"To set dscp value for inbound packets (DSCP Value for the clear traffic marking)", "optional":true }, "outbound-forward-dscp":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":1, "maximum":63, "description":"To set dscp value for outbound", "optional":true }, "pattern-recognition-hw-filter-enable":{ "type":"number", "format":"flag", "plat-pos-list":["chassis-single"], "plat-neg-list":["softax-ddet"], "default":0, "description":"to enable pattern recognition hardware filter", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "capture-config-list":{ "type":"array", "minItems":1, "items":{ "type":"capture-config" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/capture-config/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "$ref":"/axapi/v3/capture-config", "description":"Capture-config name", "optional":false }, "mode":{ "type":"string", "format":"enum", "description":"'drop': Apply capture-config to dropped packets; 'forward': Apply capture-config to forwarded packets; 'all': Apply capture-config to both dropped and forwarded packets; ", "enum":[ "drop", "forward", "all" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "name" ] } ] }, "hw-blacklist-blocking":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/hw-blacklist-blocking", "properties":{ "dst-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable Dst side hardware blocking" }, "src-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable Src side hardware blocking" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "l4-type-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/l4-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': L4-Type TCP; 'udp': L4-Type UDP; 'icmp': L4-Type ICMP; 'other': L4-Type OTHER; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-exceed-action":{ "type":"object", "properties":{ "stateless-encap-action-cfg":{ "type":"object", "properties":{ "stateless-encap-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'stateless-tunnel-encap': Encapsulate all packets; 'stateless-tunnel-encap-scrubbed': Encapsulate all packets and allow packets to go through other DDoS checks before sent (conn-limit exceeded packet can not be scrubbed, it will default to stateless-tunnel-encap); ", "enum":[ "stateless-tunnel-encap", "stateless-tunnel-encap-scrubbed" ] }, "encap-template":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "$ref":"/axapi/v3/ddos/template/encap", "description":"Apply legacy encap template for encap action" } } } } }, "deny":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "max-rexmit-syn-per-flow":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":1, "maximum":6, "description":"Maximum number of re-transmit SYN per flow", "optional":true }, "max-rexmit-syn-per-flow-exceed-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop the packet; 'black-list': Add the source IP into black list; ", "enum":[ "drop", "black-list" ], "optional":true }, "syn-auth":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "default":"send-rst", "description":"'send-rst': Send RST to client upon client ACK; 'force-rst-by-ack': Force client RST via the use of ACK; 'force-rst-by-synack': Force client RST via the use of bad SYN|ACK; 'disable': Disable TCP SYN Authentication; ", "enum":[ "send-rst", "force-rst-by-ack", "force-rst-by-synack", "disable" ], "optional":true }, "syn-cookie":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable SYN Cookie", "optional":true }, "tcp-reset-client":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Send reset to client when rate exceeds or session ages out", "optional":true }, "tcp-reset-server":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Send reset to server when rate exceeds or session ages out", "optional":true }, "drop-on-no-port-match":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "default":"enable", "description":"'disable': disable; 'enable': enable; ", "enum":[ "disable", "enable" ], "optional":true }, "stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable stateful tracking of sessions (Default is stateless)", "optional":true }, "tunnel-decap":{ "type":"object", "properties":{ "ip-decap":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable IP Tunnel decapsulation" }, "gre-decap":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable GRE Tunnel decapsulation" }, "key-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "key":{ "type":"string", "format":"string", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":10, "description":"Only decapsulate GRE packet with this key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "optional":true } } ] } } }, "tunnel-rate-limit":{ "type":"object", "properties":{ "ip-rate-limit":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable inner IP rate limiting on IPinIP traffic" }, "gre-rate-limit":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable inner IP rate limiting on GRE traffic" } } }, "drop-frag-pkt":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Drop fragmented packets", "optional":true }, "undefined-port-hit-statistics":{ "type":"object", "properties":{ "undefined-port-hit-statistics":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable port scanning statistics" }, "reset-interval":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":1, "maximum":64000, "default":60, "description":"Configure port scanning counter reset interval (minutes), Default 60 mins" } } }, "template":{ "type":"object", "properties":{ "template-icmp-v4":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS icmp-v4 template" }, "template-icmp-v6":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS icmp-v6 template" } } }, "detection-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos detection", "optional":true }, "enable-top-k":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos top-k entries", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "port-ind":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/l4-type/{protocol}/port-ind", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "topk-sources":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/l4-type/{protocol}/topk-sources", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "protocol" ] } ] }, "port-list":{ "type":"array", "minItems":1, "items":{ "type":"port" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; 'sip-udp': SIP-UDP Port; 'sip-tcp': SIP-TCP Port; ", "enum":[ "dns-tcp", "dns-udp", "http", "tcp", "udp", "ssl-l4", "sip-udp", "sip-tcp" ], "optional":false }, "detection-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos detection", "optional":true }, "enable-top-k":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos top-k entries", "optional":true }, "deny":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-exceed-action":{ "type":"object", "properties":{ "stateless-encap-action-cfg":{ "type":"object", "properties":{ "stateless-encap-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'stateless-tunnel-encap': Encapsulate all packets; 'stateless-tunnel-encap-scrubbed': Encapsulate all packets and allow packets to go through other DDoS checks before sent (conn-limit exceeded packet can not be scrubbed, it will default to stateless-tunnel-encap); ", "enum":[ "stateless-tunnel-encap", "stateless-tunnel-encap-scrubbed" ] }, "encap-template":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "$ref":"/axapi/v3/ddos/template/encap", "description":"Apply legacy encap template for encap action" } } } } }, "dns-cache":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/dns-cache", "description":"DNS Cache Instance", "optional":true }, "template":{ "type":"object", "properties":{ "dns":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "sip":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS udp template" } } }, "sflow":{ "type":"object", "properties":{ "polling":{ "type":"object", "properties":{ "sflow-packets":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow packet-level counter polling" }, "sflow-tcp":{ "type":"object", "properties":{ "sflow-tcp-basic":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow basic TCP counter polling" }, "sflow-tcp-stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow stateful TCP counter polling" } } }, "sflow-http":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow HTTP counter polling" } } } } }, "capture-config":{ "type":"object", "properties":{ "capture-config-name":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"Capture-config name" }, "capture-config-mode":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Apply capture-config to dropped packets; 'forward': Apply capture-config to forwarded packets; 'all': Apply capture-config to both dropped and forwarded packets; ", "enum":[ "drop", "forward", "all" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "port-ind":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}/port-ind", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "topk-sources":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}/topk-sources", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "signature-extraction":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}/signature-extraction", "properties":{ "algorithm":{ "type":"string", "format":"enum", "description":"'heuristic': heuristic algorithm; ", "enum":[ "heuristic" ] }, "manual-mode":{ "type":"number", "format":"flag", "default":0, "description":"Enable manual mode" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "pattern-recognition":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/port/{port-num}+{protocol}/pattern-recognition", "properties":{ "algorithm":{ "type":"string", "format":"enum", "description":"'heuristic': heuristic algorithm; ", "enum":[ "heuristic" ] }, "mode":{ "type":"string", "format":"enum", "description":"'capture-never-expire': War-time capture without rate exceeding and never expires; 'manual': Manual mode; ", "enum":[ "capture-never-expire", "manual" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "port-num", "protocol" ] } ] }, "port-range-list":{ "type":"array", "minItems":1, "items":{ "type":"port-range" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/port-range/{port-range-start}+{port-range-end}+{protocol}", "array":[ { "properties":{ "port-range-start":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port-Range Start Port Number", "optional":false }, "port-range-end":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port-Range End Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; 'sip-udp': SIP-UDP Port; 'sip-tcp': SIP-TCP Port; ", "enum":[ "dns-tcp", "dns-udp", "http", "tcp", "udp", "ssl-l4", "sip-udp", "sip-tcp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "detection-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos detection", "optional":true }, "enable-top-k":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos top-k entries", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-exceed-action":{ "type":"object", "properties":{ "stateless-encap-action-cfg":{ "type":"object", "properties":{ "stateless-encap-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'stateless-tunnel-encap': Encapsulate all packets; 'stateless-tunnel-encap-scrubbed': Encapsulate all packets and allow packets to go through other DDoS checks before sent (conn-limit exceeded packet can not be scrubbed, it will default to stateless-tunnel-encap); ", "enum":[ "stateless-tunnel-encap", "stateless-tunnel-encap-scrubbed" ] }, "encap-template":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "$ref":"/axapi/v3/ddos/template/encap", "description":"Apply legacy encap template for encap action" } } } } }, "template":{ "type":"object", "properties":{ "dns":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "sip":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS udp template" } } }, "sflow":{ "type":"object", "properties":{ "polling":{ "type":"object", "properties":{ "sflow-packets":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow packet-level counter polling" }, "sflow-tcp":{ "type":"object", "properties":{ "sflow-tcp-basic":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow basic TCP counter polling" }, "sflow-tcp-stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow stateful TCP counter polling" } } }, "sflow-http":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable sFlow HTTP counter polling" } } } } }, "capture-config":{ "type":"object", "properties":{ "capture-config-name":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"Capture-config name" }, "capture-config-mode":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Apply capture-config to dropped packets; 'forward': Apply capture-config to forwarded packets; 'all': Apply capture-config to both dropped and forwarded packets; ", "enum":[ "drop", "forward", "all" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "pattern-recognition":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition", "properties":{ "algorithm":{ "type":"string", "format":"enum", "description":"'heuristic': heuristic algorithm; ", "enum":[ "heuristic" ] }, "mode":{ "type":"string", "format":"enum", "description":"'capture-never-expire': War-time capture without rate exceeding and never expires; 'manual': Manual mode; ", "enum":[ "capture-never-expire", "manual" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "port-range-start", "port-range-end", "protocol" ] } ] }, "src-port-list":{ "type":"array", "minItems":1, "items":{ "type":"src-port" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-port/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-udp': DNS-UDP Port; 'dns-tcp': DNS-TCP Port; 'udp': UDP Port; 'tcp': TCP Port; ", "enum":[ "dns-udp", "dns-tcp", "udp", "tcp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "outbound-src-tracking":{ "type":"string", "format":"enum", "default":"disable", "description":"'enable': enable; 'disable': disable; ", "enum":[ "enable", "disable" ], "optional":true }, "template":{ "type":"object", "properties":{ "src-udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS udp src template" }, "src-tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS tcp src template" }, "src-dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns src template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num", "protocol" ] } ] }, "src-port-range-list":{ "type":"array", "minItems":1, "items":{ "type":"src-port-range" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}", "array":[ { "properties":{ "src-port-range-start":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Src Port-Range Start Port Number", "optional":false }, "src-port-range-end":{ "type":"number", "format":"number", "minimum":2, "maximum":65535, "description":"Src Port-Range End Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'udp': UDP Port; 'tcp': TCP Port; ", "enum":[ "udp", "tcp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "src-udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS udp src template" }, "src-tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS tcp src template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "src-port-range-start", "src-port-range-end", "protocol" ] } ] }, "ip-proto-list":{ "type":"array", "minItems":1, "items":{ "type":"ip-proto" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/ip-proto/{port-num}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Protocol Number", "optional":false }, "deny":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "esp-inspect":{ "type":"object", "properties":{ "auth-algorithm":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'AUTH_NULL': No Integrity Check Value; 'HMAC-SHA-1-96': 96 bit Auth Algo; 'HMAC-SHA-256-96': 96 bit Auth Algo; 'HMAC-SHA-256-128': 128 bit Auth Algo; 'HMAC-SHA-384-192': 192 bit Auth Algo; 'HMAC-SHA-512-256': 256 bit Auth Algo; 'HMAC-MD5-96': 96 bit Auth Algo; 'MAC-RIPEMD-160-96': 96 bit Auth Algo; ", "enum":[ "AUTH_NULL", "HMAC-SHA-1-96", "HMAC-SHA-256-96", "HMAC-SHA-256-128", "HMAC-SHA-384-192", "HMAC-SHA-512-256", "HMAC-MD5-96", "MAC-RIPEMD-160-96" ] }, "encrypt-algorithm":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'NULL': Null Encryption Algorithm; ", "enum":[ "NULL" ] }, "mode":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'transport': Transport mode; ", "enum":[ "transport" ] } } }, "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-exceed-action":{ "type":"object", "properties":{ "stateless-encap-action-cfg":{ "type":"object", "properties":{ "stateless-encap-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'stateless-tunnel-encap': Encapsulate all packets; 'stateless-tunnel-encap-scrubbed': Encapsulate all packets and allow packets to go through other DDoS checks before sent (conn-limit exceeded packet can not be scrubbed, it will default to stateless-tunnel-encap); ", "enum":[ "stateless-tunnel-encap", "stateless-tunnel-encap-scrubbed" ] }, "encap-template":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "$ref":"/axapi/v3/ddos/template/encap", "description":"Apply legacy encap template for encap action" } } } } }, "template":{ "type":"object", "properties":{ "other":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS other template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num" ] } ] }, "src-dst-pair":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair", "properties":{ "default":{ "type":"number", "format":"flag", "default":0, "description":"Configure default" }, "bypass":{ "type":"number", "format":"flag", "default":0, "description":"Always permit for the Source to bypass all feature & limit checks" }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" } } }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing" }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "l4-type-src-dst-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type-src-dst" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair/l4-type-src-dst/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS TCP template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS UDP template" }, "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS OTHER template" }, "template-icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v4 template" }, "template-icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v6 template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "app-type-src-dst-list":{ "type":"array", "minItems":1, "items":{ "type":"app-type-src-dst" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair/app-type-src-dst/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; ", "enum":[ "dns", "http", "ssl-l4", "sip" ], "optional":false }, "template":{ "type":"object", "properties":{ "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } } }, "src-dst-pair-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"src-dst-pair-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}", "array":[ { "properties":{ "src-based-policy-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Src-based-policy name", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "policy-class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"policy-class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}", "array":[ { "properties":{ "class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Class-list name", "optional":false }, "bypass":{ "type":"number", "format":"flag", "default":0, "description":"Always permit for the Source to bypass all feature & limit checks", "optional":true }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" } } }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic src-dst entry under class-list", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-src-dst-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type-src-dst" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/l4-type-src-dst/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS TCP template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS UDP template" }, "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS OTHER template" }, "template-icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v4 template" }, "template-icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v6 template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "app-type-src-dst-list":{ "type":"array", "minItems":1, "items":{ "type":"app-type-src-dst" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/app-type-src-dst/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; ", "enum":[ "dns", "http", "ssl-l4", "sip" ], "optional":false }, "template":{ "type":"object", "properties":{ "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "class-list-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"class-list-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure src dst dynamic entry count overflow policy for class-list; ", "enum":[ "configuration" ], "optional":false }, "bypass":{ "type":"number", "format":"flag", "default":0, "description":"Always permit for the Source to bypass all feature & limit checks", "optional":true }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" } } }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-src-dst-overflow-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type-src-dst-overflow" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}/l4-type-src-dst-overflow/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS TCP template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS UDP template" }, "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS OTHER template" }, "template-icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v4 template" }, "template-icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v6 template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "app-type-src-dst-overflow-list":{ "type":"array", "minItems":1, "items":{ "type":"app-type-src-dst-overflow" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}/app-type-src-dst-overflow/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; ", "enum":[ "dns", "http", "ssl-l4", "sip" ], "optional":false }, "template":{ "type":"object", "properties":{ "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } }, "required":[ "dummy-name" ] } ] } }, "required":[ "class-list-name" ] } ] } }, "required":[ "src-based-policy-name" ] } ] }, "src-dst-pair-settings-list":{ "type":"array", "minItems":1, "items":{ "type":"src-dst-pair-settings" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-settings/{all-types}", "array":[ { "properties":{ "all-types":{ "type":"string", "format":"enum", "description":"'all-types': Settings for all types (default or class-list); ", "enum":[ "all-types" ], "optional":false }, "age":{ "type":"number", "format":"number", "minimum":2, "maximum":1023, "default":5, "description":"Idle age for ip entry", "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic src-dst entry", "optional":true }, "apply-policy-on-overflow":{ "type":"number", "format":"flag", "default":0, "description":"Enable this flag to apply overflow policy when dynamic entry count overflows", "optional":true }, "enable-class-list-overflow":{ "type":"number", "format":"flag", "default":0, "description":"Apply class-list overflow policy upon exceeding dynamic entry count specified for DST entry or each class-list", "optional":true }, "src-prefix-len":{ "type":"number", "format":"number", "minimum":32, "maximum":127, "description":"Specify src prefix length for IPv6 (default: not set)", "optional":true }, "traffic-distribution-mode":{ "type":"string", "format":"enum", "plat-pos-list":["chassis-duo"], "default":"default", "description":"'default': Distribute traffic to one slot only; 'source-ip-based': Distribute traffic between slots, based on source ip; ", "enum":[ "default", "source-ip-based" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-src-dst-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type-src-dst" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-settings/{all-types}/l4-type-src-dst/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic src-dst entry", "optional":true }, "apply-policy-on-overflow":{ "type":"number", "format":"flag", "default":0, "description":"Enable this flag to apply overflow policy when dynamic entry count overflows", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } }, "required":[ "all-types" ] } ] }, "src-dst-pair-class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"src-dst-pair-class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}", "array":[ { "properties":{ "class-list-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "description":"Class-list name", "optional":false }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" } } }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-src-dst-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type-src-dst" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}/l4-type-src-dst/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS TCP template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS UDP template" }, "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS OTHER template" }, "template-icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v4 template" }, "template-icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v6 template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "app-type-src-dst-list":{ "type":"array", "minItems":1, "items":{ "type":"app-type-src-dst" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}/app-type-src-dst/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; ", "enum":[ "dns", "http", "ssl-l4", "sip" ], "optional":false }, "template":{ "type":"object", "properties":{ "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "cid-list":{ "type":"array", "minItems":1, "items":{ "type":"cid" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}/cid/{cid-num}", "array":[ { "properties":{ "cid-num":{ "type":"number", "format":"number", "minimum":1, "maximum":32, "description":"Class-list id", "optional":false }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" } } }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-src-dst-cid-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type-src-dst-cid" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}/cid/{cid-num}/l4-type-src-dst-cid/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS TCP template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS UDP template" }, "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS OTHER template" }, "template-icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v4 template" }, "template-icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v6 template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "app-type-src-dst-cid-list":{ "type":"array", "minItems":1, "items":{ "type":"app-type-src-dst-cid" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/src-dst-pair-class-list/{class-list-name}/cid/{cid-num}/app-type-src-dst-cid/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; ", "enum":[ "dns", "http", "ssl-l4", "sip" ], "optional":false }, "template":{ "type":"object", "properties":{ "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } }, "required":[ "cid-num" ] } ] } }, "required":[ "class-list-name" ] } ] }, "dynamic-entry-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"dynamic-entry-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/dynamic-entry-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure src dst dynamic entry count overflow policy; ", "enum":[ "configuration" ], "optional":false }, "bypass":{ "type":"number", "format":"flag", "default":0, "description":"Always permit for the Source to bypass all feature & limit checks", "optional":true }, "exceed-log-cfg":{ "type":"object", "properties":{ "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drop's" } } }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-src-dst-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type-src-dst" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/dynamic-entry-overflow-policy/{dummy-name}/l4-type-src-dst/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS TCP template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS UDP template" }, "other":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS OTHER template" }, "template-icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v4 template" }, "template-icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS icmp-v6 template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "app-type-src-dst-list":{ "type":"array", "minItems":1, "items":{ "type":"app-type-src-dst" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/entry/{dst-entry-name}/dynamic-entry-overflow-policy/{dummy-name}/app-type-src-dst/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; ", "enum":[ "dns", "http", "ssl-l4", "sip" ], "optional":false }, "template":{ "type":"object", "properties":{ "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS SSL-L4 template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS http template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS sip template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } }, "required":[ "dummy-name" ] } ] } }, "required":[ "dst-entry-name" ] } ] }, "interface-ip-list":{ "type":"array", "minItems":1, "items":{ "type":"interface-ip" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/interface-ip/{addr}", "array":[ { "properties":{ "addr":{ "type":"string", "format":"ipv4-address", "description":"IP address of interface", "optional":false }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drops", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable periodic log while event is continuing", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/interface-ip/{addr}/l4-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "tunnel-decap":{ "type":"object", "properties":{ "ip-decap":{ "type":"number", "format":"flag", "default":0, "description":"Enable IP Tunnel decapsulation" }, "gre-decap":{ "type":"number", "format":"flag", "default":0, "description":"Enable GRE Tunnel decapsulation" }, "key-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "key":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Only decapsulate GRE packet with this key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "optional":true } } ] } } }, "tunnel-rate-limit":{ "type":"object", "properties":{ "ip-rate-limit":{ "type":"number", "format":"flag", "default":0, "description":"Enable inner IP rate limiting on IPinIP traffic" }, "gre-rate-limit":{ "type":"number", "format":"flag", "default":0, "description":"Enable inner IP rate limiting on GRE traffic" } } }, "drop-frag-pkt":{ "type":"number", "format":"flag", "default":0, "description":"Drop fragmented packets", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "ip-proto-list":{ "type":"array", "minItems":1, "items":{ "type":"ip-proto" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/interface-ip/{addr}/ip-proto/{port-num}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"IP protocol number", "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num" ] } ] }, "port-list":{ "type":"array", "minItems":1, "items":{ "type":"port" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/interface-ip/{addr}/port/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; ", "enum":[ "tcp", "udp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num", "protocol" ] } ] } }, "required":[ "addr" ] } ] }, "interface-ipv6-list":{ "type":"array", "minItems":1, "items":{ "type":"interface-ipv6" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/interface-ipv6/{addr}", "array":[ { "properties":{ "addr":{ "type":"string", "format":"ipv6-address", "description":"IPv6 address of interface", "optional":false }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging of limit exceed drops", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "l4-type-list":{ "type":"array", "minItems":1, "items":{ "type":"l4-type" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/interface-ipv6/{addr}/l4-type/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; ", "enum":[ "tcp", "udp", "icmp", "other" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "tunnel-decap":{ "type":"object", "properties":{ "ip-decap":{ "type":"number", "format":"flag", "default":0, "description":"Enable IP Tunnel decapsulation" }, "gre-decap":{ "type":"number", "format":"flag", "default":0, "description":"Enable GRE Tunnel decapsulation" }, "key-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "key":{ "type":"string", "format":"string", "minLength":1, "maxLength":10, "description":"Only decapsulate GRE packet with this key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "optional":true } } ] } } }, "tunnel-rate-limit":{ "type":"object", "properties":{ "ip-rate-limit":{ "type":"number", "format":"flag", "default":0, "description":"Enable inner IP rate limiting on IPinIP traffic" }, "gre-rate-limit":{ "type":"number", "format":"flag", "default":0, "description":"Enable inner IP rate limiting on GRE traffic" } } }, "drop-frag-pkt":{ "type":"number", "format":"flag", "default":0, "description":"Drop fragmented packets", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] }, "ip-proto-list":{ "type":"array", "minItems":1, "items":{ "type":"ip-proto" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/interface-ipv6/{addr}/ip-proto/{port-num}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"IP protocol number", "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num" ] } ] }, "port-list":{ "type":"array", "minItems":1, "items":{ "type":"port" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/interface-ipv6/{addr}/port/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'tcp': tcp; 'udp': udp; ", "enum":[ "tcp", "udp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-num", "protocol" ] } ] } }, "required":[ "addr" ] } ] }, "zone-list":{ "type":"array", "minItems":1, "items":{ "type":"zone" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}", "array":[ { "properties":{ "zone-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "optional":false }, "operational-mode":{ "type":"string", "format":"enum", "default":"idle", "description":"'idle': Idle mode; 'monitor': Monitor mode; 'learning': Learning mode; ", "enum":[ "idle", "monitor", "learning" ], "optional":true }, "force-operational-mode":{ "type":"number", "format":"flag", "default":0, "description":"Force configure operational mode", "optional":true }, "traffic-distribution-mode":{ "type":"string", "format":"enum", "plat-pos-list":["chassis-duo"], "plat-neg-list":["softax-ddet"], "default":"default", "description":"'default': Distribute traffic to one slot using default distribution mechanism; 'source-ip-based': Distribute traffic between slots, based on source ip; 'slot': Assign traffic to a specific slot; ", "enum":[ "default", "source-ip-based", "slot" ], "optional":true }, "slot-number":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":1, "maximum":2, "description":"Slot number", "optional":true }, "ip":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ip-addr":{ "type":"string", "format":"ipv4-address", "description":"Specify IP address" }, "subnet-ip-addr":{ "type":"string", "format":"ipv4-cidr", "description":"IP Subnet" }, "expand-ip-subnet":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Expand this subnet to individual IP address" }, "expand-ip-subnet-mode":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "default":"default", "description":"'default': Default learning mechanism (Default: Dynamic); 'dynamic': Dynamic learning; 'static': Static learning; ", "enum":[ "default", "dynamic", "static" ] }, "optional":true } } ] }, "ipv6":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ip6-addr":{ "type":"string", "format":"ipv6-address", "description":"Specify IPv6 address" }, "subnet-ipv6-addr":{ "type":"string", "format":"ipv6-address-plen", "description":"IPV6 Subnet" }, "expand-ipv6-subnet":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Expand this subnet to individual IPv6 address" }, "expand-ipv6-subnet-mode":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "default":"default", "description":"'default': Default learning mechanism (Default: Dynamic); 'dynamic': Dynamic learning; 'static': Static learning; ", "enum":[ "default", "dynamic", "static" ] }, "optional":true } } ] }, "description":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Description for this Destination Zone", "optional":true }, "zone-profile":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/zone-profile", "description":"Apply threshold profile", "optional":true }, "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID for the whole zone", "optional":true }, "action-list":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure action-list to take", "optional":true }, "per-addr-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID per address", "optional":true }, "dest-nat-ip":{ "type":"string", "format":"ipv4-address", "plat-neg-list":["softax-ddet"], "description":"Destination NAT IP address", "optional":true }, "dest-nat-ipv6":{ "type":"string", "format":"ipv6-address", "plat-neg-list":["softax-ddet"], "description":"Destination NAT IPv6 address", "optional":true }, "source-nat-pool":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"Configure source NAT", "optional":true }, "drop-frag-pkt":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Drop fragmented packets", "optional":true }, "sflow-common":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not-list":[ "sflow-packets", "sflow-layer-4", "sflow-tcp-basic", "sflow-tcp-stateful", "sflow-http" ], "description":"Enable sFlow counter polling packets, tcp-basic, tcp-stateful and http. WARNING: Zone level Sflow polling might induce heavy CP", "optional":true }, "sflow-packets":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow packet-level counter polling. WARNING: Zone level Sflow polling might induce heavy CPU load depending on the total", "optional":true }, "sflow-layer-4":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow Layer 4 counter polling. WARNING: Zone level Sflow polling might induce heavy CPU load depending on the number of ", "optional":true }, "sflow-tcp":{ "type":"object", "properties":{ "sflow-tcp-basic":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow basic TCP counter polling. WARNING: Zone level Sflow polling might induce heavy CPU load depending on the total nu" }, "sflow-tcp-stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow stateful TCP counter polling. WARNING: Zone level Sflow polling might induce heavy CPU load depending on the total" } } }, "sflow-http":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow HTTP counter polling. WARNING: Zone level Sflow polling might induce heavy CPU load depending on the total number ", "optional":true }, "advertised-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"BGP advertised", "optional":true }, "telemetry-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable from-l3-peer flag for the zone, thus all the ip entries in the zone will be dynamically created/deleted based on the BGP", "optional":true }, "zone-template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"DDOS logging template" } } }, "inbound-forward-dscp":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":1, "maximum":63, "description":"To set dscp value for inbound packets (DSCP Value for the clear traffic marking)", "optional":true }, "outbound-forward-dscp":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":1, "maximum":63, "description":"To set dscp value for outbound", "optional":true }, "reporting-disabled":{ "type":"number", "format":"flag", "default":0, "description":"Disable Reporting", "optional":true }, "log-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable log periodic", "optional":true }, "log-high-frequency":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable High frequency logging for non-event logs per zone", "optional":true }, "rate-limit":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":1, "maximum":1000, "default":1, "description":"Rate limit per second per zone(Default : 1 per second)", "optional":true }, "pattern-recognition-hw-filter-enable":{ "type":"number", "format":"flag", "plat-pos-list":["chassis-single"], "plat-neg-list":["softax-ddet"], "default":0, "description":"to enable pattern recognition hardware filter", "optional":true }, "collector":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "sflow-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "$ref":"/axapi/v3/sflow/collector/custom", "description":"Name of configured custom sFlow collector" }, "optional":true } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "outbound-policy":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/outbound-policy", "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/outbound-policy", "description":"Specify name of the outbound policy" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "capture-config-list":{ "type":"array", "minItems":1, "items":{ "type":"capture-config" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/capture-config/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "$ref":"/axapi/v3/capture-config", "description":"Capture-config name", "optional":false }, "mode":{ "type":"string", "format":"enum", "description":"'drop': Apply capture-config to dropped packets; 'forward': Apply capture-config to forwarded packets; 'all': Apply capture-config to both dropped and forwarded packets; ", "enum":[ "drop", "forward", "all" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "name" ] } ] }, "hw-blacklist-blocking":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/hw-blacklist-blocking", "properties":{ "dst-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable Dst side hardware blocking" }, "src-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable Src side hardware blocking" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "src-port-range-list":{ "type":"array", "minItems":1, "items":{ "type":"src-port-range" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}", "array":[ { "properties":{ "src-port-range-start":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Src Port-Range Start Port Number", "optional":false }, "src-port-range-end":{ "type":"number", "format":"number", "minimum":2, "maximum":65535, "description":"Src Port-Range End Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'udp': UDP port; 'tcp': TCP Port; ", "enum":[ "udp", "tcp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid-cfg":{ "type":"object", "properties":{ "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID" }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "ignore" ] } } }, "zone-template":{ "type":"object", "properties":{ "src-udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS udp src template" }, "src-tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS tcp src template" } } }, "default-action-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure default-action-list", "optional":true }, "capture-config":{ "type":"object", "properties":{ "capture-config-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"Capture-config name" }, "capture-config-mode":{ "type":"string", "format":"enum", "description":"'drop': Apply capture-config to dropped packets; 'forward': Apply capture-config to forwarded packets; 'all': Apply capture-config to both dropped and forwarded packets; ", "enum":[ "drop", "forward", "all" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "src-port-range-start", "src-port-range-end", "protocol" ] } ] }, "src-port":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/src-port", "properties":{ "zone-src-port-list":{ "type":"array", "minItems":1, "items":{ "type":"zone-src-port" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/src-port/zone-src-port/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Source Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-udp': DNS-UDP Port; 'dns-tcp': DNS-TCP Port; 'udp': UDP port; 'tcp': TCP Port; ", "enum":[ "dns-udp", "dns-tcp", "udp", "tcp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid-cfg":{ "type":"object", "properties":{ "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID" }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "ignore" ] } } }, "outbound-src-tracking":{ "type":"string", "format":"enum", "default":"disable", "description":"'enable': enable; 'disable': disable; ", "enum":[ "enable", "disable" ], "optional":true }, "zone-template":{ "type":"object", "properties":{ "src-udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS udp src template" }, "src-tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS tcp src template" }, "src-dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS dns src template" } } }, "default-action-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure default-action-list", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "port-num", "protocol" ] } ] }, "zone-src-port-other-list":{ "type":"array", "minItems":1, "items":{ "type":"zone-src-port-other" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/src-port/zone-src-port-other/{port-other}+{protocol}", "array":[ { "properties":{ "port-other":{ "type":"string", "format":"enum", "description":"'other': other; ", "enum":[ "other" ], "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'udp': UDP port; 'tcp': TCP Port; ", "enum":[ "udp", "tcp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid-cfg":{ "type":"object", "properties":{ "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID" }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "ignore" ] } } }, "zone-template":{ "type":"object", "properties":{ "src-udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS udp src template" }, "src-tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "description":"DDOS tcp src template" } } }, "default-action-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure default-action-list", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "port-other", "protocol" ] } ] } } }, "ip-proto":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto", "properties":{ "proto-number-list":{ "type":"array", "minItems":1, "items":{ "type":"proto-number" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}", "array":[ { "properties":{ "protocol-num":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "description":"Protocol Number", "optional":false }, "manual-mode-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Toggle manual mode to use fix templates", "optional":true }, "deny":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Blacklist and Drop all incoming packets for this ip-proto", "optional":true }, "esp-inspect":{ "type":"object", "properties":{ "auth-algorithm":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'AUTH_NULL': No Integrity Check Value; 'HMAC-SHA-1-96': 96 bit Auth Algo; 'HMAC-SHA-256-96': 96 bit Auth Algo; 'HMAC-SHA-256-128': 128 bit Auth Algo; 'HMAC-SHA-384-192': 192 bit Auth Algo; 'HMAC-SHA-512-256': 256 bit Auth Algo; 'HMAC-MD5-96': 96 bit Auth Algo; 'MAC-RIPEMD-160-96': 96 bit Auth Algo; ", "enum":[ "AUTH_NULL", "HMAC-SHA-1-96", "HMAC-SHA-256-96", "HMAC-SHA-256-128", "HMAC-SHA-384-192", "HMAC-SHA-512-256", "HMAC-MD5-96", "MAC-RIPEMD-160-96" ] }, "encrypt-algorithm":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'NULL': Null Encryption Algorithm; ", "enum":[ "NULL" ] }, "mode":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'transport': Transport mode; ", "enum":[ "transport" ] } } }, "glid-cfg":{ "type":"object", "properties":{ "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID for the whole zone" }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default); 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "ignore" ] }, "action-list":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure action-list to take" }, "per-addr-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID per address" } } }, "drop-frag-pkt":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Drop fragmented packets", "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic source zone service entry", "optional":true }, "apply-policy-on-overflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable this flag to apply overflow policy when dynamic entry count overflows", "optional":true }, "enable-top-k":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos top-k detection", "optional":true }, "age":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":2, "maximum":1023, "default":5, "description":"Idle age for ip entry", "optional":true }, "enable-class-list-overflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Apply class-list overflow policy upon exceeding dynamic entry count specified for zone-port or class-list", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "src-based-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"src-based-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/src-based-policy/{src-based-policy-name}", "array":[ { "properties":{ "src-based-policy-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Specify name of the policy", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "policy-class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"policy-class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}", "array":[ { "properties":{ "class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Class-list name", "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic source zone service entry allowed for this class-list", "optional":true }, "zone-template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" }, "ip-proto":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ip-proto template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "class-list-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"class-list-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure overflow policy for class-list; ", "enum":[ "configuration" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "zone-template":{ "type":"object", "properties":{ "ip-proto":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ip-proto template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "dummy-name" ] } ] } }, "required":[ "class-list-name" ] } ] } }, "required":[ "src-based-policy-name" ] } ] }, "dynamic-entry-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"dynamic-entry-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/dynamic-entry-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure overflow policy; ", "enum":[ "configuration" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "zone-template":{ "type":"object", "properties":{ "ip-proto":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ip-proto template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "dummy-name" ] } ] }, "level-list":{ "type":"array", "minItems":1, "items":{ "type":"level" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/level/{level-num}", "array":[ { "properties":{ "level-num":{ "type":"string", "format":"enum", "description":"'0': Default policy level; '1': Policy level 1; '2': Policy level 2; '3': Policy level 3; '4': Policy level 4; ", "enum":[ "0", "1", "2", "3", "4" ], "optional":false }, "src-default-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "zone-escalation-score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Zone activation score of this level", "optional":true }, "zone-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions apply due to zone escalate from this level", "optional":true }, "src-escalation-score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Source activation score of this level", "optional":true }, "src-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions apply due to source escalate from this level", "optional":true }, "zone-template":{ "type":"object", "properties":{ "ip-proto":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS ip-proto template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "indicator-list":{ "type":"array", "minItems":1, "items":{ "type":"indicator" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/level/{level-num}/indicator/{type}", "array":[ { "properties":{ "type":{ "type":"string", "format":"enum", "description":"'pkt-rate': rate of incoming packets; 'pkt-drop-rate': rate of packets got dropped; 'pkt-drop-ratio': ratio of incoming packet rate divided by the rate of dropping packets; 'bytes-to-bytes-from-ratio': ratio of incoming packet rate divided by the rate of outgoing packets; 'frag-rate': rate of incoming fragmented packets; 'cpu-utilization': average data CPU utilization; 'interface-utilization': outside interface utilization; ", "enum":[ "pkt-rate", "pkt-drop-rate", "pkt-drop-ratio", "bytes-to-bytes-from-ratio", "frag-rate", "cpu-utilization", "interface-utilization" ], "optional":false }, "data-packet-size":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Expected minimal data size", "optional":true }, "score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Score corresponding to the indicator", "optional":true }, "src-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Indicator per-src threshold", "optional":true }, "src-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Indicator per-src threshold", "optional":true }, "src-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions to use when this src indicator threshold reaches", "optional":true }, "zone-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Threshold for the entire zone", "optional":true }, "zone-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Threshold for the entire zone", "optional":true }, "zone-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions to use when this zone indicator threshold reaches", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "type" ] } ] } }, "required":[ "level-num" ] } ] }, "manual-mode-list":{ "type":"array", "minItems":1, "items":{ "type":"manual-mode" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/manual-mode/{config}", "array":[ { "properties":{ "config":{ "type":"string", "format":"enum", "description":"'configuration': Manual-mode configuration; ", "enum":[ "configuration" ], "optional":false }, "src-default-glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "zone-template":{ "type":"object", "properties":{ "ip-proto":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ip-proto template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "config" ] } ] }, "port-ind":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/port-ind", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "topk-sources":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-number/{protocol-num}/topk-sources", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "protocol-num" ] } ] }, "proto-tcp-udp-list":{ "type":"array", "minItems":1, "items":{ "type":"proto-tcp-udp" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-tcp-udp/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'tcp': ip-proto tcp; 'udp': ip-proto udp; ", "enum":[ "tcp", "udp" ], "optional":false }, "deny":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Blacklist and Drop all incoming packets for this ip-proto", "optional":true }, "glid-cfg":{ "type":"object", "properties":{ "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID for the whole zone" }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default); 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "ignore" ] }, "per-addr-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID per address" }, "action-list":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure action-list to take" } } }, "drop-frag-pkt":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Drop fragmented packets", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "protocol" ] } ] }, "proto-name-list":{ "type":"array", "minItems":1, "items":{ "type":"proto-name" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-name/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'icmp-v4': ip-proto icmp-v4; 'icmp-v6': ip-proto icmp-v6; 'other': ip-proto other; 'gre': ip-proto gre; 'ipv4-encap': ip-proto IPv4 Encapsulation; 'ipv6-encap': ip-proto IPv6 Encapsulation; ", "enum":[ "icmp-v4", "icmp-v6", "other", "gre", "ipv4-encap", "ipv6-encap" ], "optional":false }, "manual-mode-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Toggle manual mode to use fix templates", "optional":true }, "deny":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Blacklist and Drop all incoming packets for ip-proto icmp-v4", "optional":true }, "glid-cfg":{ "type":"object", "properties":{ "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID for the whole zone" }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default); 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "ignore" ] }, "action-list":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure action-list to take" }, "per-addr-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID per address" } } }, "tunnel-decap":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable tunnel decapsulation", "optional":true }, "key-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "key":{ "type":"string", "format":"string", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":10, "description":"Only decapsulate GRE packet with this key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)" }, "optional":true } } ] }, "tunnel-rate-limit":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable DDOS-protection on tunnel traffic", "optional":true }, "drop-frag-pkt":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Drop fragmented packets", "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic source zone service entry", "optional":true }, "apply-policy-on-overflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable this flag to apply overflow policy when dynamic entry count overflows", "optional":true }, "enable-top-k":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos top-k detection", "optional":true }, "age":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":2, "maximum":1023, "default":5, "description":"Idle age for ip entry", "optional":true }, "enable-class-list-overflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Apply class-list overflow policy upon exceeding dynamic entry count specified for zone-port or class-list", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "level-list":{ "type":"array", "minItems":1, "items":{ "type":"level" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-name/{protocol}/level/{level-num}", "array":[ { "properties":{ "level-num":{ "type":"string", "format":"enum", "description":"'0': Default policy level; '1': Policy level 1; '2': Policy level 2; '3': Policy level 3; '4': Policy level 4; ", "enum":[ "0", "1", "2", "3", "4" ], "optional":false }, "src-default-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "zone-escalation-score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Zone activation score of this level", "optional":true }, "zone-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions apply due to zone escalate from this level", "optional":true }, "src-escalation-score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Source activation score of this level", "optional":true }, "src-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions apply due to source escalate from this level", "optional":true }, "zone-template":{ "type":"object", "properties":{ "icmp-v4":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS icmp-v4 template" }, "icmp-v6":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS icmp-v6 template" }, "ip-proto":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS ip-proto template" }, "encap":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "indicator-list":{ "type":"array", "minItems":1, "items":{ "type":"indicator" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-name/{protocol}/level/{level-num}/indicator/{type}", "array":[ { "properties":{ "type":{ "type":"string", "format":"enum", "description":"'pkt-rate': rate of incoming packets; 'pkt-drop-rate': rate of packets got dropped; 'pkt-drop-ratio': ratio of incoming packet rate divided by the rate of dropping packets; 'bytes-to-bytes-from-ratio': ratio of incoming packet rate divided by the rate of outgoing packets; 'frag-rate': rate of incoming fragmented packets; 'cpu-utilization': average data CPU utilization; 'interface-utilization': outside interface utilization; ", "enum":[ "pkt-rate", "pkt-drop-rate", "pkt-drop-ratio", "bytes-to-bytes-from-ratio", "frag-rate", "cpu-utilization", "interface-utilization" ], "optional":false }, "data-packet-size":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Expected minimal data size", "optional":true }, "score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Score corresponding to the indicator", "optional":true }, "src-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Indicator per-src threshold", "optional":true }, "src-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Indicator per-src threshold", "optional":true }, "src-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions to use when this src indicator threshold reaches", "optional":true }, "zone-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Threshold for the entire zone", "optional":true }, "zone-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Threshold for the entire zone", "optional":true }, "zone-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions to use when this zone indicator threshold reaches", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "type" ] } ] } }, "required":[ "level-num" ] } ] }, "manual-mode-list":{ "type":"array", "minItems":1, "items":{ "type":"manual-mode" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-name/{protocol}/manual-mode/{config}", "array":[ { "properties":{ "config":{ "type":"string", "format":"enum", "description":"'configuration': Manual-mode configuration; ", "enum":[ "configuration" ], "optional":false }, "src-default-glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "zone-template":{ "type":"object", "properties":{ "icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS icmp-v4 template" }, "icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS icmp-v6 template" }, "ip-proto":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ip-proto template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "config" ] } ] }, "src-based-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"src-based-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-name/{protocol}/src-based-policy/{src-based-policy-name}", "array":[ { "properties":{ "src-based-policy-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Specify name of the policy", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "policy-class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"policy-class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-name/{protocol}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}", "array":[ { "properties":{ "class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Class-list name", "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic source zone service entry allowed for this class-list", "optional":true }, "zone-template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" }, "icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS icmp-v4 template" }, "icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS icmp-v6 template" }, "ip-proto":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ip-proto template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "class-list-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"class-list-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-name/{protocol}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure overflow policy for class-list; ", "enum":[ "configuration" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "zone-template":{ "type":"object", "properties":{ "icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS icmp-v4 template" }, "icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS icmp-v6 template" }, "ip-proto":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ip-proto template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "dummy-name" ] } ] } }, "required":[ "class-list-name" ] } ] } }, "required":[ "src-based-policy-name" ] } ] }, "dynamic-entry-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"dynamic-entry-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-name/{protocol}/dynamic-entry-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure overflow policy; ", "enum":[ "configuration" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "zone-template":{ "type":"object", "properties":{ "icmp-v4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS icmp-v4 template" }, "icmp-v6":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS icmp-v6 template" }, "ip-proto":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ip-proto template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "dummy-name" ] } ] }, "port-ind":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-name/{protocol}/port-ind", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "topk-sources":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/ip-proto/proto-name/{protocol}/topk-sources", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "protocol" ] } ] } } }, "port":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port", "properties":{ "zone-service-list":{ "type":"array", "minItems":1, "items":{ "type":"zone-service" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; 'sip-udp': SIP-UDP Port; 'sip-tcp': SIP-TCP Port; 'quic': QUIC Port; ", "enum":[ "dns-tcp", "dns-udp", "http", "tcp", "udp", "ssl-l4", "sip-udp", "sip-tcp", "quic" ], "optional":false }, "manual-mode-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Toggle manual mode to use fix templates", "optional":true }, "deny":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid-cfg":{ "type":"object", "properties":{ "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID for the whole zone" }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default if default-action-list is not configured); 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "ignore" ] }, "action-list":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure action-list to take" }, "per-addr-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID per address" } } }, "stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable stateful tracking of sessions (Default is stateless)", "optional":true }, "default-action-list":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure default-action-list", "optional":true }, "sflow-common":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not-list":[ "sflow-packets", "sflow-tcp-basic", "sflow-tcp-stateful", "sflow-http" ], "description":"Enable all sFlow polling options under this zone port", "optional":true }, "sflow-packets":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow packet-level counter polling", "optional":true }, "sflow-tcp":{ "type":"object", "properties":{ "sflow-tcp-basic":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow basic TCP counter polling" }, "sflow-tcp-stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow stateful TCP counter polling" } } }, "sflow-http":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow HTTP counter polling", "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic source zone service entry", "optional":true }, "apply-policy-on-overflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable this flag to apply overflow policy when dynamic entry count overflows", "optional":true }, "enable-class-list-overflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Apply class-list overflow policy upon exceeding dynamic entry count specified for zone-port or class-list", "optional":true }, "enable-top-k":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos top-k detection", "optional":true }, "capture-config":{ "type":"object", "properties":{ "capture-config-name":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":128, "description":"Capture-config name" }, "capture-config-mode":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Apply capture-config to dropped packets; 'forward': Apply capture-config to forwarded packets; 'all': Apply capture-config to both dropped and forwarded packets; ", "enum":[ "drop", "forward", "all" ] } } }, "zone-template":{ "type":"object", "properties":{ "ips":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"IPS template" } } }, "outbound-only":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Only allow outbound traffic", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "signature-extraction":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/signature-extraction", "properties":{ "algorithm":{ "type":"string", "format":"enum", "description":"'heuristic': heuristic algorithm; ", "enum":[ "heuristic" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "pattern-recognition":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/pattern-recognition", "properties":{ "algorithm":{ "type":"string", "format":"enum", "description":"'heuristic': heuristic algorithm; ", "enum":[ "heuristic" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "level-list":{ "type":"array", "minItems":1, "items":{ "type":"level" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/level/{level-num}", "array":[ { "properties":{ "level-num":{ "type":"string", "format":"enum", "description":"'0': Default policy level; '1': Policy level 1; '2': Policy level 2; '3': Policy level 3; '4': Policy level 4; ", "enum":[ "0", "1", "2", "3", "4" ], "optional":false }, "src-default-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "zone-escalation-score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Zone activation score of this level", "optional":true }, "zone-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions apply due to zone escalate from this level", "optional":true }, "src-escalation-score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Source activation score of this level", "optional":true }, "src-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions apply due to source escalate from this level", "optional":true }, "zone-template":{ "type":"object", "properties":{ "quic":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS quic template" }, "dns":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "start-pattern-recognition":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Start pattern recognition from this level", "optional":true }, "apply-extracted-filters":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Apply extracted filters from this level", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "indicator-list":{ "type":"array", "minItems":1, "items":{ "type":"indicator" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/level/{level-num}/indicator/{type}", "array":[ { "properties":{ "type":{ "type":"string", "format":"enum", "description":"'pkt-rate': rate of incoming packets; 'pkt-drop-rate': rate of packets got dropped; 'pkt-drop-ratio': ratio of incoming packet rate divided by the rate of dropping packets; 'bytes-to-bytes-from-ratio': ratio of incoming packet rate divided by the rate of outgoing packets; 'concurrent-conns': number of concurrent connections; 'conn-miss-rate': rate of incoming packets for which no previously established connection exists; 'syn-rate': rate on incoming SYN packets; 'fin-rate': rate on incoming FIN packets; 'rst-rate': rate of incoming RST packets; 'small-window-ack-rate': rate of small window advertisement; 'empty-ack-rate': rate of incoming packets which have no payload; 'small-payload-rate': rate of short payload packet; 'syn-fin-ratio': ratio of incoming SYN packet rate divided by the rate of incoming FIN packets; 'cpu-utilization': average data CPU utilization; 'interface-utilization': outside interface utilization; ", "enum":[ "pkt-rate", "pkt-drop-rate", "pkt-drop-ratio", "bytes-to-bytes-from-ratio", "concurrent-conns", "conn-miss-rate", "syn-rate", "fin-rate", "rst-rate", "small-window-ack-rate", "empty-ack-rate", "small-payload-rate", "syn-fin-ratio", "cpu-utilization", "interface-utilization" ], "optional":false }, "tcp-window-size":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Expected minimal window size", "optional":true }, "data-packet-size":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Expected minimal data size", "optional":true }, "score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Score corresponding to the indicator", "optional":true }, "src-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Indicator per-src threshold", "optional":true }, "src-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Indicator per-src threshold", "optional":true }, "src-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions to use when this src indicator threshold reaches", "optional":true }, "zone-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Threshold for the entire zone", "optional":true }, "zone-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Threshold for the entire zone", "optional":true }, "zone-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions to use when this zone indicator threshold reaches", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "type" ] } ] } }, "required":[ "level-num" ] } ] }, "manual-mode-list":{ "type":"array", "minItems":1, "items":{ "type":"manual-mode" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/manual-mode/{config}", "array":[ { "properties":{ "config":{ "type":"string", "format":"enum", "description":"'configuration': Manual-mode configuration; ", "enum":[ "configuration" ], "optional":false }, "src-default-glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "zone-template":{ "type":"object", "properties":{ "quic":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS quic template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "config" ] } ] }, "ips":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/ips", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "port-ind":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/port-ind", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "topk-sources":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/topk-sources", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "src-based-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"src-based-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/src-based-policy/{src-based-policy-name}", "array":[ { "properties":{ "src-based-policy-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Specify name of the policy", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "policy-class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"policy-class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}", "array":[ { "properties":{ "class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Class-list name", "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic source zone service entry allowed for this class-list", "optional":true }, "zone-template":{ "type":"object", "properties":{ "quic":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS quic template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "ips":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"IPS template" }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "class-list-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"class-list-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure overflow policy for class-list; ", "enum":[ "configuration" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "zone-template":{ "type":"object", "properties":{ "quic":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS quic template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "dummy-name" ] } ] } }, "required":[ "class-list-name" ] } ] } }, "required":[ "src-based-policy-name" ] } ] }, "dynamic-entry-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"dynamic-entry-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service/{port-num}+{protocol}/dynamic-entry-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure overflow policy; ", "enum":[ "configuration" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "zone-template":{ "type":"object", "properties":{ "quic":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS quic template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "dummy-name" ] } ] } }, "required":[ "port-num", "protocol" ] } ] }, "zone-service-other-list":{ "type":"array", "minItems":1, "items":{ "type":"zone-service-other" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}", "array":[ { "properties":{ "port-other":{ "type":"string", "format":"enum", "description":"'other': other; ", "enum":[ "other" ], "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'tcp': TCP Port; 'udp': UDP Port; ", "enum":[ "tcp", "udp" ], "optional":false }, "manual-mode-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Toggle manual mode to use fix templates", "optional":true }, "enable-top-k":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos top-k detection", "optional":true }, "deny":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid-cfg":{ "type":"object", "properties":{ "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID for the whole zone" }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default if default-action-list is not configured); 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "ignore" ] }, "action-list":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure action-list to take" }, "per-addr-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID per address" } } }, "stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable stateful tracking of sessions (Default is stateless)", "optional":true }, "default-action-list":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure default-action-list", "optional":true }, "sflow-common":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not-list":[ "sflow-packets", "sflow-tcp-basic", "sflow-tcp-stateful" ], "description":"Enable all sFlow polling options under this zone port", "optional":true }, "sflow-packets":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow packet-level counter polling", "optional":true }, "sflow-tcp":{ "type":"object", "properties":{ "sflow-tcp-basic":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow basic TCP counter polling" }, "sflow-tcp-stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow stateful TCP counter polling" } } }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic source zone service entry", "optional":true }, "apply-policy-on-overflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable this flag to apply overflow policy when dynamic entry count overflows", "optional":true }, "enable-class-list-overflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Apply class-list overflow policy upon exceeding dynamic entry count specified for this zone port or each class-list", "optional":true }, "age":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":2, "maximum":1023, "default":5, "description":"Idle age for ip entry", "optional":true }, "outbound-only":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Only allow outbound traffic", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "pattern-recognition":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}/pattern-recognition", "properties":{ "algorithm":{ "type":"string", "format":"enum", "description":"'heuristic': heuristic algorithm; ", "enum":[ "heuristic" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "level-list":{ "type":"array", "minItems":1, "items":{ "type":"level" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}/level/{level-num}", "array":[ { "properties":{ "level-num":{ "type":"string", "format":"enum", "description":"'0': Default policy level; '1': Policy level 1; '2': Policy level 2; '3': Policy level 3; '4': Policy level 4; ", "enum":[ "0", "1", "2", "3", "4" ], "optional":false }, "src-default-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "zone-escalation-score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Zone activation score of this level", "optional":true }, "zone-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions apply due to zone escalate from this level", "optional":true }, "src-escalation-score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Source activation score of this level", "optional":true }, "src-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions apply due to source escalate from this level", "optional":true }, "zone-template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "start-pattern-recognition":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Start pattern recognition from this level", "optional":true }, "apply-extracted-filters":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Apply extracted filters from this level", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "indicator-list":{ "type":"array", "minItems":1, "items":{ "type":"indicator" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}/level/{level-num}/indicator/{type}", "array":[ { "properties":{ "type":{ "type":"string", "format":"enum", "description":"'pkt-rate': rate of incoming packets; 'pkt-drop-rate': rate of packets got dropped; 'pkt-drop-ratio': ratio of incoming packet rate divided by the rate of dropping packets; 'bytes-to-bytes-from-ratio': ratio of incoming packet rate divided by the rate of outgoing packets; 'concurrent-conns': number of concurrent connections; 'conn-miss-rate': rate of incoming packets for which no previously established connection exists; 'syn-rate': rate on incoming SYN packets; 'fin-rate': rate on incoming FIN packets; 'rst-rate': rate of incoming RST packets; 'small-window-ack-rate': rate of small window advertisement; 'empty-ack-rate': rate of incoming packets which have no payload; 'small-payload-rate': rate of short payload packet; 'syn-fin-ratio': ratio of incoming SYN packet rate divided by the rate of incoming FIN packets; 'cpu-utilization': average data CPU utilization; 'interface-utilization': outside interface utilization; ", "enum":[ "pkt-rate", "pkt-drop-rate", "pkt-drop-ratio", "bytes-to-bytes-from-ratio", "concurrent-conns", "conn-miss-rate", "syn-rate", "fin-rate", "rst-rate", "small-window-ack-rate", "empty-ack-rate", "small-payload-rate", "syn-fin-ratio", "cpu-utilization", "interface-utilization" ], "optional":false }, "tcp-window-size":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Expected minimal window size", "optional":true }, "data-packet-size":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Expected minimal data size", "optional":true }, "score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Score corresponding to the indicator", "optional":true }, "src-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Indicator per-src threshold", "optional":true }, "src-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Indicator per-src threshold", "optional":true }, "src-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions to use when this src indicator threshold reaches", "optional":true }, "zone-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Threshold for the entire zone", "optional":true }, "zone-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Threshold for the entire zone", "optional":true }, "zone-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions to use when this zone indicator threshold reaches", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "type" ] } ] } }, "required":[ "level-num" ] } ] }, "manual-mode-list":{ "type":"array", "minItems":1, "items":{ "type":"manual-mode" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}/manual-mode/{config}", "array":[ { "properties":{ "config":{ "type":"string", "format":"enum", "description":"'configuration': Manual-mode configuration; ", "enum":[ "configuration" ], "optional":false }, "src-default-glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "zone-template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "config" ] } ] }, "port-ind":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}/port-ind", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "topk-sources":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}/topk-sources", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "src-based-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"src-based-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}/src-based-policy/{src-based-policy-name}", "array":[ { "properties":{ "src-based-policy-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Specify name of the policy", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "policy-class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"policy-class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}", "array":[ { "properties":{ "class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Class-list name", "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic source zone service entry allowed for this class-list", "optional":true }, "zone-template":{ "type":"object", "properties":{ "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "ips":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"IPS template" }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "class-list-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"class-list-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure overflow policy for class-list; ", "enum":[ "configuration" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "zone-template":{ "type":"object", "properties":{ "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "dummy-name" ] } ] } }, "required":[ "class-list-name" ] } ] } }, "required":[ "src-based-policy-name" ] } ] }, "dynamic-entry-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"dynamic-entry-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port/zone-service-other/{port-other}+{protocol}/dynamic-entry-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure overflow policy; ", "enum":[ "configuration" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "zone-template":{ "type":"object", "properties":{ "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "dummy-name" ] } ] } }, "required":[ "port-other", "protocol" ] } ] } } }, "port-range-list":{ "type":"array", "minItems":1, "items":{ "type":"port-range" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}", "array":[ { "properties":{ "port-range-start":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port-Range Start Port Number", "optional":false }, "port-range-end":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port-Range End Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; 'sip-udp': SIP-UDP Port; 'sip-tcp': SIP-TCP Port; 'quic': QUIC Port; ", "enum":[ "dns-tcp", "dns-udp", "http", "tcp", "udp", "ssl-l4", "sip-udp", "sip-tcp", "quic" ], "optional":false }, "manual-mode-enable":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Toggle manual mode to use fix templates", "optional":true }, "deny":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Blacklist and Drop all incoming packets for protocol", "optional":true }, "glid-cfg":{ "type":"object", "properties":{ "glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID for the whole zone" }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default if default-action-list is not configured); 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "ignore" ] }, "action-list":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure action-list to take" }, "per-addr-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID per address" } } }, "stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable stateful tracking of sessions (Default is stateless)", "optional":true }, "default-action-list":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/action-list", "description":"Configure default-action-list", "optional":true }, "sflow-common":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not-list":[ "sflow-packets", "sflow-tcp-basic", "sflow-tcp-stateful", "sflow-http" ], "description":"Enable all sFlow polling options under this zone port", "optional":true }, "sflow-packets":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow packet-level counter polling", "optional":true }, "sflow-tcp":{ "type":"object", "properties":{ "sflow-tcp-basic":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow basic TCP counter polling" }, "sflow-tcp-stateful":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow stateful TCP counter polling" } } }, "sflow-http":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "not":"sflow-common", "description":"Enable sFlow HTTP counter polling", "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic source zone service entry", "optional":true }, "apply-policy-on-overflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Enable this flag to apply overflow policy when dynamic entry count overflows", "optional":true }, "enable-class-list-overflow":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Apply class-list overflow policy upon exceeding dynamic entry count specified under zone port or each class-list", "optional":true }, "enable-top-k":{ "type":"number", "format":"flag", "default":0, "description":"Enable ddos top-k detection", "optional":true }, "age":{ "type":"number", "format":"number", "plat-neg-list":["softax-ddet"], "minimum":2, "maximum":1023, "default":5, "description":"Idle age for ip entry", "optional":true }, "zone-template":{ "type":"object", "properties":{ "ips":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"IPS template" } } }, "outbound-only":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Only allow outbound traffic", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "pattern-recognition":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition", "properties":{ "algorithm":{ "type":"string", "format":"enum", "description":"'heuristic': heuristic algorithm; ", "enum":[ "heuristic" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "level-list":{ "type":"array", "minItems":1, "items":{ "type":"level" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/level/{level-num}", "array":[ { "properties":{ "level-num":{ "type":"string", "format":"enum", "description":"'0': Default policy level; '1': Policy level 1; '2': Policy level 2; '3': Policy level 3; '4': Policy level 4; ", "enum":[ "0", "1", "2", "3", "4" ], "optional":false }, "src-default-glid":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "plat-neg-list":["softax-ddet"], "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "zone-escalation-score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Zone activation score of this level", "optional":true }, "zone-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions apply due to zone escalate from this level", "optional":true }, "src-escalation-score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Source activation score of this level", "optional":true }, "src-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions apply due to source escalate from this level", "optional":true }, "zone-template":{ "type":"object", "properties":{ "quic":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS quic template" }, "dns":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "plat-neg-list":["softax-ddet"], "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "start-pattern-recognition":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Start pattern recognition from this level", "optional":true }, "apply-extracted-filters":{ "type":"number", "format":"flag", "plat-neg-list":["softax-ddet"], "default":0, "description":"Apply extracted filters from this level", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "indicator-list":{ "type":"array", "minItems":1, "items":{ "type":"indicator" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/level/{level-num}/indicator/{type}", "array":[ { "properties":{ "type":{ "type":"string", "format":"enum", "description":"'pkt-rate': rate of incoming packets; 'pkt-drop-rate': rate of packets got dropped; 'pkt-drop-ratio': ratio of incoming packet rate divided by the rate of dropping packets; 'bytes-to-bytes-from-ratio': ratio of incoming packet rate divided by the rate of outgoing packets; 'concurrent-conns': number of concurrent connections; 'conn-miss-rate': rate of incoming packets for which no previously established connection exists; 'syn-rate': rate on incoming SYN packets; 'fin-rate': rate on incoming FIN packets; 'rst-rate': rate of incoming RST packets; 'small-window-ack-rate': rate of small window advertisement; 'empty-ack-rate': rate of incoming packets which have no payload; 'small-payload-rate': rate of short payload packet; 'syn-fin-ratio': ratio of incoming SYN packet rate divided by the rate of incoming FIN packets; 'cpu-utilization': average data CPU utilization; 'interface-utilization': outside interface utilization; ", "enum":[ "pkt-rate", "pkt-drop-rate", "pkt-drop-ratio", "bytes-to-bytes-from-ratio", "concurrent-conns", "conn-miss-rate", "syn-rate", "fin-rate", "rst-rate", "small-window-ack-rate", "empty-ack-rate", "small-payload-rate", "syn-fin-ratio", "cpu-utilization", "interface-utilization" ], "optional":false }, "tcp-window-size":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Expected minimal window size", "optional":true }, "data-packet-size":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Expected minimal data size", "optional":true }, "score":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "description":"Score corresponding to the indicator", "optional":true }, "src-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Indicator per-src threshold", "optional":true }, "src-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Indicator per-src threshold", "optional":true }, "src-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions to use when this src indicator threshold reaches", "optional":true }, "zone-threshold-num":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Threshold for the entire zone", "optional":true }, "zone-threshold-str":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Threshold for the entire zone", "optional":true }, "zone-violation-actions":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/ddos/violation-actions", "description":"Violation actions to use when this zone indicator threshold reaches", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "type" ] } ] } }, "required":[ "level-num" ] } ] }, "manual-mode-list":{ "type":"array", "minItems":1, "items":{ "type":"manual-mode" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/manual-mode/{config}", "array":[ { "properties":{ "config":{ "type":"string", "format":"enum", "description":"'configuration': Manual-mode configuration; ", "enum":[ "configuration" ], "optional":false }, "src-default-glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "zone-template":{ "type":"object", "properties":{ "quic":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS quic template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "config" ] } ] }, "ips":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/ips", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "port-ind":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/port-ind", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "topk-sources":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/topk-sources", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "src-based-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"src-based-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy/{src-based-policy-name}", "array":[ { "properties":{ "src-based-policy-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Specify name of the policy", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "policy-class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"policy-class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}", "array":[ { "properties":{ "class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Class-list name", "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "glid-action":{ "type":"string", "format":"enum", "description":"'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; ", "enum":[ "drop", "blacklist-src", "ignore" ], "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "max-dynamic-entry-count":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "description":"Maximum count for dynamic source zone service entry allowed for this class-list", "optional":true }, "zone-template":{ "type":"object", "properties":{ "quic":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS quic template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "ips":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"IPS template" }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true }, "class-list-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"class-list-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure overflow policy for class-list; ", "enum":[ "configuration" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "zone-template":{ "type":"object", "properties":{ "quic":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS quic template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "dummy-name" ] } ] } }, "required":[ "class-list-name" ] } ] } }, "required":[ "src-based-policy-name" ] } ] }, "dynamic-entry-overflow-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"dynamic-entry-overflow-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/dynamic-entry-overflow-policy/{dummy-name}", "array":[ { "properties":{ "dummy-name":{ "type":"string", "format":"enum", "description":"'configuration': Configure overflow policy; ", "enum":[ "configuration" ], "optional":false }, "glid":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "$ref":"/axapi/v3/glid", "description":"Global limit ID", "optional":true }, "action":{ "type":"string", "format":"enum", "description":"'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; ", "enum":[ "bypass", "deny" ], "optional":true }, "log-enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable logging", "optional":true }, "log-periodic":{ "type":"number", "format":"flag", "default":0, "description":"Enable log periodic", "optional":true }, "zone-template":{ "type":"object", "properties":{ "quic":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS quic template" }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS dns template" }, "http":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS http template" }, "ssl-l4":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS ssl-l4 template" }, "sip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS sip template" }, "tcp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS tcp template" }, "udp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS udp template" }, "encap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)" }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"DDOS logging template" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "dummy-name" ] } ] } }, "required":[ "port-range-start", "port-range-end", "protocol" ] } ] }, "web-gui":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/web-gui", "properties":{ "status":{ "type":"string", "format":"enum", "default":"newly", "description":"'newly': newly; 'learning': learning; 'learned': learned; 'activated': activated; ", "enum":[ "newly", "learning", "learned", "activated" ] }, "activated-after-learning":{ "type":"number", "format":"flag", "default":0, "description":"Activate it after learning" }, "create-time":{ "type":"string", "format":"string", "minLength":1, "maxLength":13, "description":"Configure create time" }, "modify-time":{ "type":"string", "format":"string", "minLength":1, "maxLength":13, "description":"Configure modify time" }, "sensitivity":{ "type":"string", "format":"enum", "default":"3", "description":"'5': Low; '3': Medium; '1.5': High; ", "enum":[ "5", "3", "1.5" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "learning":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/learning", "properties":{ "duration":{ "type":"string", "format":"enum", "default":"6hour", "description":"'1minute': 1 minute; '6hour': 6 hours; '12hour': 12 hours; '24hour': 24 hours; '7day': 7 days; ", "enum":[ "1minute", "6hour", "12hour", "24hour", "7day" ] }, "starting-time":{ "type":"string", "format":"string", "minLength":1, "maxLength":13, "description":"Configure learning starting time" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "protection":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection", "properties":{ "port":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port", "properties":{ "zone-service-list":{ "type":"array", "minItems":1, "items":{ "type":"zone-service" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port/zone-service/{port-num}+{protocol}", "array":[ { "properties":{ "port-num":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; ", "enum":[ "dns-tcp", "dns-udp", "http", "tcp", "udp", "ssl-l4" ], "optional":false }, "pbe":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Peak Bandwidth Expected", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "port-num", "protocol" ] } ] }, "zone-service-other-list":{ "type":"array", "minItems":1, "items":{ "type":"zone-service-other" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port/zone-service-other/{port-other}+{protocol}", "array":[ { "properties":{ "port-other":{ "type":"string", "format":"enum", "description":"'other': other; ", "enum":[ "other" ], "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'tcp': TCP Port; 'udp': UDP Port; ", "enum":[ "tcp", "udp" ], "optional":false }, "pbe":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Peak Bandwidth Expected", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "port-other", "protocol" ] } ] } } }, "ip-proto":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/ip-proto", "properties":{ "proto-name-list":{ "type":"array", "minItems":1, "items":{ "type":"proto-name" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/ip-proto/proto-name/{protocol}", "array":[ { "properties":{ "protocol":{ "type":"string", "format":"enum", "description":"'icmp-v4': ip-proto icmp-v4; 'icmp-v6': ip-proto icmp-v6; ", "enum":[ "icmp-v4", "icmp-v6" ], "optional":false }, "pbe":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Peak Bandwidth Expected", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "protocol" ] } ] } } }, "port-range-list":{ "type":"array", "minItems":1, "items":{ "type":"port-range" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port-range/{port-range-start}+{port-range-end}+{protocol}", "array":[ { "properties":{ "port-range-start":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port-Range Start Port Number", "optional":false }, "port-range-end":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port-Range End Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; ", "enum":[ "dns-tcp", "dns-udp", "http", "tcp", "udp", "ssl-l4" ], "optional":false }, "pbe":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Peak Bandwidth Expected", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Customized tag", "optional":true } }, "required":[ "port-range-start", "port-range-end", "protocol" ] } ] } } } } } }, "required":[ "zone-name" ] } ] }, "dynamic-entry":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/dynamic-entry", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "dynamic-entries-resource-usage":{ "type":"object", "$ref":"/axapi/v3/ddos/dst/dynamic-entries-resource-usage", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "token-authentication":{ "type":"object", "$ref":"/axapi/v3/ddos/token-authentication", "properties":{ "player-mode":{ "type":"object", "$ref":"/axapi/v3/ddos/token-authentication/player-mode", "properties":{ "mode":{ "type":"string", "format":"enum", "default":"one-to-one", "description":"'one-to-one': Only one player talks to one server; 'many-to-one': Many player talk to one server; ", "enum":[ "one-to-one", "many-to-one" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "secret-salt":{ "type":"object", "$ref":"/axapi/v3/ddos/token-authentication/secret-salt", "properties":{ "current-salt":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "description":"Current salt value" }, "previous-salt":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "description":"Previous salt value" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "players-list":{ "type":"array", "minItems":1, "items":{ "type":"players" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/token-authentication/players/{src-ip}+{src-port}+{dst-ip}+{dst-port}", "array":[ { "properties":{ "src-ip":{ "type":"string", "format":"ipv4-address", "optional":false }, "src-port":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "optional":false }, "dst-ip":{ "type":"string", "format":"ipv4-address", "optional":false }, "dst-port":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "optional":false }, "magic-value":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "optional":true } }, "required":[ "src-ip", "src-port", "dst-ip", "dst-port" ] } ] }, "summary":{ "type":"object", "$ref":"/axapi/v3/ddos/token-authentication/summary", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "authenticated-list":{ "type":"object", "$ref":"/axapi/v3/ddos/token-authentication/authenticated-list", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "sync":{ "type":"object", "$ref":"/axapi/v3/ddos/sync", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "description":"Enable" }, "local-ip":{ "type":"string", "format":"ipv4-address", "description":"Local IP address for White list sync" }, "peer-ip-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "peer-ip":{ "type":"string", "format":"ipv4-address", "description":"IP Address" }, "optional":true } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "run-time-user-string":{ "type":"object", "$ref":"/axapi/v3/ddos/run-time-user-string", "properties":{ "value":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"Add run time user string" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "exec-script":{ "type":"object", "$ref":"/axapi/v3/ddos/exec-script/{protocol}", "properties":{ "script":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "description":"Specify script to execute" }, "mock":{ "type":"number", "format":"flag", "default":0, "description":"Use mock data" }, "alert-type":{ "type":"number", "format":"number", "minimum":1, "maximum":3, "description":"1: UDP Pkt Rate 2: TCP Pkt Rate 3: ICMP Pkt Rate" }, "level":{ "type":"number", "format":"number", "minimum":1, "maximum":4, "description":"Current Level" }, "threshold":{ "type":"number", "format":"number", "minimum":1, "maximum":3000, "description":"Threshold" }, "zone":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "description":"DST Zone name" }, "port-num":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Port Number" }, "protocol":{ "type":"string", "format":"enum", "description":"'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; 'sip-tcp': SIP-TCP Port; 'sip-udp': SIP-UDP Port; ", "enum":[ "dns-tcp", "dns-udp", "http", "tcp", "udp", "ssl-l4", "sip-tcp", "sip-udp" ] }, "src-ip":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ip-addr":{ "type":"string", "format":"ipv4-address", "description":"Specify IP address" }, "subnet-ip-addr":{ "type":"string", "format":"ipv4-cidr", "description":"IP Subnet" }, "optional":true } } ] }, "src-ipv6":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ip6-addr":{ "type":"string", "format":"ipv6-address", "description":"Specify IPv6 address" }, "subnet-ipv6-addr":{ "type":"string", "format":"ipv6-address-plen", "description":"IPV6 Subnet" }, "optional":true } } ] }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "description":"Timeout (Default: 10)" } }, "required":[ "protocol" ] }, "anomaly-drop":{ "type":"object", "$ref":"/axapi/v3/ddos/anomaly-drop", "properties":{ "security-attack-layer-3":{ "type":"object", "$ref":"/axapi/v3/ddos/anomaly-drop/security-attack-layer-3", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': enable; 'disable': disable; ", "enum":[ "enable", "disable" ] }, "log":{ "type":"number", "format":"flag", "default":0, "description":"Log the anomaly event (Can only configure when drop-disabled)" }, "capture-config":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"capture-config name (Can only configure when drop-disabled)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "security-attack-layer-4-tcp":{ "type":"object", "$ref":"/axapi/v3/ddos/anomaly-drop/security-attack-layer-4-tcp", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': enable; 'disable': disable; ", "enum":[ "enable", "disable" ] }, "log":{ "type":"number", "format":"flag", "default":0, "description":"Log the anomaly event (Can only configure when drop-disabled)" }, "capture-config":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"capture-config name (Can only configure when drop-disabled)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "security-attack-layer-4-udp":{ "type":"object", "$ref":"/axapi/v3/ddos/anomaly-drop/security-attack-layer-4-udp", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': enable; 'disable': disable; ", "enum":[ "enable", "disable" ] }, "log":{ "type":"number", "format":"flag", "default":0, "description":"Log the anomaly event (Can only configure when drop-disabled)" }, "capture-config":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"capture-config name (Can only configure when drop-disabled)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "packet-deformity-layer-3":{ "type":"object", "$ref":"/axapi/v3/ddos/anomaly-drop/packet-deformity-layer-3", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': enable; 'disable': disable; ", "enum":[ "enable", "disable" ] }, "log":{ "type":"number", "format":"flag", "default":0, "description":"Log the anomaly event (Can only configure when drop-disabled)" }, "capture-config":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"capture-config name (Can only configure when drop-disabled)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "packet-deformity-layer-4":{ "type":"object", "$ref":"/axapi/v3/ddos/anomaly-drop/packet-deformity-layer-4", "properties":{ "toggle":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': enable; 'disable': disable; ", "enum":[ "enable", "disable" ] }, "log":{ "type":"number", "format":"flag", "default":0, "description":"Log the anomaly event (Can only configure when drop-disabled)" }, "capture-config":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "description":"capture-config name (Can only configure when drop-disabled)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "geo-location":{ "type":"object", "$ref":"/axapi/v3/ddos/geo-location", "properties":{ "db":{ "type":"object", "$ref":"/axapi/v3/ddos/geo-location/db", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "file":{ "type":"object", "$ref":"/axapi/v3/ddos/geo-location/file", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "l4-tcp":{ "type":"object", "$ref":"/axapi/v3/ddos/l4-tcp", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "l4-udp":{ "type":"object", "$ref":"/axapi/v3/ddos/l4-udp", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "l4-icmp":{ "type":"object", "$ref":"/axapi/v3/ddos/l4-icmp", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "l4-other":{ "type":"object", "$ref":"/axapi/v3/ddos/l4-other", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "l7-dns":{ "type":"object", "$ref":"/axapi/v3/ddos/l7-dns", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "l7-http":{ "type":"object", "$ref":"/axapi/v3/ddos/l7-http", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "l4-ssl":{ "type":"object", "$ref":"/axapi/v3/ddos/l4-ssl", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "l7-sip":{ "type":"object", "$ref":"/axapi/v3/ddos/l7-sip", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "session":{ "type":"object", "$ref":"/axapi/v3/ddos/session", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "switch":{ "type":"object", "$ref":"/axapi/v3/ddos/switch", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "table":{ "type":"object", "$ref":"/axapi/v3/ddos/table", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "protect":{ "type":"object", "$ref":"/axapi/v3/ddos/protect", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "port":{ "type":"object", "$ref":"/axapi/v3/ddos/port", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "ip-proto":{ "type":"object", "$ref":"/axapi/v3/ddos/ip-proto", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "tunnel":{ "type":"object", "$ref":"/axapi/v3/ddos/tunnel", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "anomaly":{ "type":"object", "$ref":"/axapi/v3/ddos/anomaly", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "l4-sync":{ "type":"object", "$ref":"/axapi/v3/ddos/l4-sync", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "long":{ "type":"object", "$ref":"/axapi/v3/ddos/long", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "brief":{ "type":"object", "$ref":"/axapi/v3/ddos/brief", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "logging":{ "type":"object", "$ref":"/axapi/v3/ddos/logging", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "dns-cache-server":{ "type":"object", "$ref":"/axapi/v3/ddos/dns-cache-server", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "token-auth":{ "type":"object", "$ref":"/axapi/v3/ddos/token-auth", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }