{ "id":"/axapi/v3/ddos/network-object-template/{name}", "type":"object", "node-type":"list", "title":"network-object-template", "partition-visibility":"shared", "description":"Network-object Template Configuration", "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"DDOS network-object-template name", "optional":false }, "operational-mode":{ "type":"string", "format":"enum", "default":"learning", "partition-visibility":"shared", "description":"'monitor': Monitor mode; 'learning': Learning mode; ", "enum":[ "monitor", "learning" ], "optional":true }, "threshold-sensitivity":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "default":"OFF", "partition-visibility":"shared", "description":"tune threshold ranges with levels LOW/MEDIUM/HIGH/OFF (default) or multiplier of threshold value (available options are LOW=5x/MEDIUM=3x/HIGH=1.5x/OFF=1x, or float value between 1.0-10.0)", "optional":true }, "histogram-mode":{ "type":"string", "format":"enum", "default":"observe", "partition-visibility":"shared", "description":"'off': histogram feature disabled; 'monitor': histogram feature enabled with anomaly escalation; 'observe': histogram feature enabled and observe only; ", "enum":[ "off", "monitor", "observe" ], "optional":true }, "anomaly-detection-trigger":{ "type":"string", "format":"enum", "default":"all", "partition-visibility":"shared", "description":"'all': Use both learned and static thresholds (static thresholds take precedence); 'static-threshold-only': Use static thresholds only; ", "enum":[ "all", "static-threshold-only" ], "optional":true }, "service-discovery":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'disable': Disable service discovery for hosts (default: enabled); ", "enum":[ "disable" ], "optional":true }, "flooding-multiplier":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "default":2, "partition-visibility":"shared", "description":"multiplier for flooding detection threshold in network objects (default 2x threshold)", "optional":true }, "service-break-down-threshold-local":{ "type":"object", "properties":{ "svc-percentage":{ "type":"number", "format":"number", "minimum":5, "maximum":99, "partition-visibility":"shared", "description":"percentage of parent ip node" } } }, "host-anomaly-threshold":{ "type":"object", "properties":{ "host-pkt-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Forward packet rate of per host" }, "host-bit-rate":{ "type":"number", "format":"number", "minimum":800, "maximum":34359738360, "partition-visibility":"shared", "description":"Forward bit rate of per host" }, "host-rev-pkt-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Reverse packet rate of per host" }, "host-rev-bit-rate":{ "type":"number", "format":"number", "minimum":800, "maximum":34359738360, "partition-visibility":"shared", "description":"Reverse bit rate of per host" }, "host-undiscovered-pkt-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Undiscovered forward packet rate of per host" }, "host-flow-count":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Flow count of per host" }, "host-syn-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"SYN packet rate of per host" }, "host-fin-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"FIN packet rate of per host" }, "host-rst-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"RST packet rate of per host" }, "host-tcp-pkt-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Tcp packet rate of per host" }, "host-udp-pkt-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Udp packet rate of per host" }, "host-icmp-pkt-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"ICMP packet rate of per host" }, "host-undiscovered-host-pkt-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"forward packet rate of per undiscovered host" }, "host-undiscovered-host-bit-rate":{ "type":"number", "format":"number", "minimum":800, "maximum":34359738360, "partition-visibility":"shared", "description":"Forward bit rate of per undiscovered host" } } }, "network-object-anomaly-threshold":{ "type":"object", "properties":{ "network-object-pkt-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":10995116277760, "partition-visibility":"shared", "description":"Packet rate of the network-object" }, "network-object-bit-rate":{ "type":"number", "format":"number", "minimum":800, "maximum":87960930222080, "partition-visibility":"shared", "description":"Bit rate of the network-object" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "sport-anomaly-threshold":{ "type":"object", "$ref":"/axapi/v3/ddos/network-object-template/{name}/sport-anomaly-threshold", "properties":{ "packet-rate":{ "type":"object", "$ref":"/axapi/v3/ddos/network-object-template/{name}/sport-anomaly-threshold/packet-rate", "properties":{ "value":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Packet rate of a source port entry" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "packet-rate-percentage":{ "type":"object", "$ref":"/axapi/v3/ddos/network-object-template/{name}/sport-anomaly-threshold/packet-rate-percentage", "properties":{ "value":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "partition-visibility":"shared", "description":"Percentage of source port entry's parent entry" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "bit-rate":{ "type":"object", "$ref":"/axapi/v3/ddos/network-object-template/{name}/sport-anomaly-threshold/bit-rate", "properties":{ "value":{ "type":"number", "format":"number", "minimum":800, "maximum":34359738360, "partition-visibility":"shared", "description":"Bit rate of a source port entry" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "bit-rate-percentage":{ "type":"object", "$ref":"/axapi/v3/ddos/network-object-template/{name}/sport-anomaly-threshold/bit-rate-percentage", "properties":{ "value":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "partition-visibility":"shared", "description":"Percentage of source port entry's parent entry" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "indicators-to-monitor":{ "type":"object", "$ref":"/axapi/v3/ddos/network-object-template/{name}/indicators-to-monitor", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared" }, "monitor-pkt-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Forward packet rate" }, "monitor-bit-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Forward bit rate" }, "monitor-rev-pkt-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Reverse packet rate" }, "monitor-rev-bit-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Reverse bit rate" }, "monitor-undiscovered-pkt-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Undiscovered forward packet rate" }, "monitor-flow-count":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Flow count" }, "monitor-syn-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"SYN packet rate" }, "monitor-fin-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"FIN packet rate" }, "monitor-rst-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"RST packet rate" }, "monitor-tcp-pkt-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"TCP packet rate" }, "monitor-udp-pkt-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"UDP packet rate" }, "monitor-icmp-pkt-rate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"ICMP packet rate" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "object-keys":[ "name" ], "required":[ "name" ] }