{ "id":"/axapi/v3/ddos/network-object/{object-name}", "type":"object", "node-type":"list", "title":"network-object", "partition-visibility":"shared", "description":"Configure DDoS a static Monitor Network Object", "properties":{ "object-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "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 }, "ip":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "subnet-ip-addr":{ "type":"string", "format":"ipv4-cidr", "partition-visibility":"shared", "description":"IP Subnet, supported prefix range is from 8 to 31" } } } ] }, "ipv6":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "subnet-ipv6-addr":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "description":"IPV6 Subnet, supported prefix range is from 40 to 63" } } } ] }, "histogram-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable histogram statistics (Default: Disabled)", "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 }, "relative-auto-break-down-threshold":{ "type":"object", "properties":{ "network-percentage":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "partition-visibility":"shared", "description":"percentage of parent node" }, "permil":{ "type":"number", "format":"number", "minimum":1, "maximum":999, "partition-visibility":"shared", "description":"permil of root node" } } }, "static-auto-break-down-threshold":{ "type":"object", "properties":{ "network-pkt-rate":{ "type":"number", "format":"number", "minimum":100, "maximum":2000000, "partition-visibility":"shared", "description":"packet rate of current node" } } }, "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":"Packet rate of per host" }, "host-byte-rate":{ "type":"number", "format":"number", "minimum":100, "maximum":4294967295, "partition-visibility":"shared", "description":"Byte rate of per 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-byte-rate":{ "type":"number", "format":"number", "minimum":100, "maximum":10995116277760, "partition-visibility":"shared", "description":"Byte 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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'subnet_learned': Subnet Entry Learned; 'subnet_aged': Subnet Entry Aged; 'subnet_create_fail': Subnet Entry Create Failures; 'ip_learned': IP Entry Learned; 'ip_aged': IP Entry Aged; 'ip_create_fail': IP Entry Create Failures; 'service_learned': Service Entry Learned; 'service_aged': Service Entry Aged; 'service_create_fail': Service Entry Create Failures; ", "enum":[ "all", "subnet_learned", "subnet_aged", "subnet_create_fail", "ip_learned", "ip_aged", "ip_create_fail", "service_learned", "service_aged", "service_create_fail" ] } } } ] }, "notification":{ "type":"object", "$ref":"/axapi/v3/ddos/network-object/{object-name}/notification", "properties":{ "configuration":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'configuration': configuration; ", "enum":[ "configuration" ] }, "notification":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "notification-template-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/ddos/notification-template", "description":"Specify the notification template name" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "sub-network-list":{ "type":"array", "minItems":1, "items":{ "type":"sub-network" }, "uniqueItems":true, "$ref":"/axapi/v3/ddos/network-object/{object-name}/sub-network/{subnet-ip-addr}", "array":[ { "properties":{ "subnet-ip-addr":{ "type":"string", "format":"ipv4-cidr", "partition-visibility":"shared", "description":"IPv4 Subnet/host, supported prefix range is from 24 to 32", "optional":false }, "host-anomaly-threshold":{ "type":"object", "properties":{ "static-pkt-rate-threshold":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Packet rate of per host" }, "static-byte-rate-threshold":{ "type":"number", "format":"number", "minimum":100, "maximum":4294967295, "partition-visibility":"shared", "description":"Byte rate of per host" } } }, "sub-network-anomaly-threshold":{ "type":"object", "properties":{ "static-sub-network-pkt-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Packet rate of the sub-network" }, "static-sub-network-byte-rate":{ "type":"number", "format":"number", "minimum":100, "maximum":4294967295, "partition-visibility":"shared", "description":"Byte rate of the sub-network" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "subnet-ip-addr" ] } ] } }, "object-keys":[ "object-name" ], "required":[ "object-name" ] }