{
    "id":"/axapi/v3/ddos/detection",
    "type":"object",
    "node-type":"scalar",
    "title":"detection",
    "partition-visibility":"shared",
    "auto-created-object":1,
    "description":"DDoS Detection Commands",
    "properties":{
        "disable":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Disable DDoS detection (default: enabled)",
            "optional":true
        },
        "uuid":{
            "type":"string",
            "format":"string",
            "minLength":1,
            "maxLength":64,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"uuid of the object",
            "optional":true
        },
        "resource-usage":{
            "type":"object",
            "$ref":"/axapi/v3/ddos/detection/resource-usage",
            "properties":{
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "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,
                    "partition-visibility":"shared",
                    "description":"startup-config local file name"
                },
                "action":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'delete': delete; ",
                    "enum":[
                        "delete"
                    ]
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "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",
                    "partition-visibility":"shared",
                    "description":"'standalone': Standalone detector; 'on-box': Mitigator and Detector on the same box; 'auto-svc-discovery': Auto Service discovery using Visibility module (Deprecatd); ",
                    "enum":[
                        "standalone",
                        "on-box",
                        "auto-svc-discovery"
                    ]
                },
                "pkt-sampling":{
                    "type":"object",
                    "properties":{
                        "override-rate":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":50000000,
                            "partition-visibility":"shared",
                            "description":"Sample 1 in X packets (default: X=1)"
                        },
                        "assign-index":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":64,
                            "partition-visibility":"shared",
                            "description":"Lower index is more aggressive sampling"
                        },
                        "assign-rate":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":50000000,
                            "partition-visibility":"shared",
                            "description":"Assign rate to given index"
                        }
                    }
                },
                "detection-window-size":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":60,
                    "default":1,
                    "partition-visibility":"shared",
                    "description":"Configure detection window size in seconds (DDoS detection window size in seconds(default: 1))"
                },
                "initial-learning-interval":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":168,
                    "partition-visibility":"shared",
                    "description":"Initial learning interval (in hours) before processing"
                },
                "notification-debug-log":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'enable': Enable detection notification debug log (default: disabled); ",
                    "enum":[
                        "enable"
                    ]
                },
                "de-escalation-quiet-time":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":60,
                    "partition-visibility":"shared",
                    "description":"Configure de-escalation needed time in minutes from level 1 to 0.(default 1 minutes)"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                },
                "standalone-settings":{
                    "type":"object",
                    "$ref":"/axapi/v3/ddos/detection/settings/standalone-settings",
                    "properties":{
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "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,
                                    "partition-visibility":"shared",
                                    "description":"sFlow port to receive packets (sFlow port number(default 6343))"
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "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,
                                    "partition-visibility":"shared",
                                    "description":"Netflow port to receive packets (Netflow port number(default 9996))"
                                },
                                "template-active-timeout":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":2,
                                    "maximum":300,
                                    "default":30,
                                    "partition-visibility":"shared",
                                    "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,
                                    "partition-visibility":"shared",
                                    "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,
                            "partition-visibility":"shared",
                            "description":"Specify name for the agent",
                            "optional":false
                        },
                        "agent-v4-addr":{
                            "type":"string",
                            "format":"ipv4-address",
                            "partition-visibility":"shared",
                            "description":"Configure agent's IPv4 address",
                            "optional":true
                        },
                        "agent-v6-addr":{
                            "type":"string",
                            "format":"ipv6-address",
                            "partition-visibility":"shared",
                            "description":"Configure agent's IPv6 address",
                            "optional":true
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object",
                            "optional":true
                        },
                        "user-tag":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Customized tag",
                            "optional":true
                        },
                        "sflow":{
                            "type":"object",
                            "$ref":"/axapi/v3/ddos/detection/agent/{agent-name}/sflow",
                            "properties":{
                                "sflow-pkt-samples-collection":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"enable",
                                    "partition-visibility":"shared",
                                    "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,
                                    "partition-visibility":"shared",
                                    "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",
                                    "partition-visibility":"shared",
                                    "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,
                                    "partition-visibility":"shared",
                                    "description":"Configure agent's netflow sampling rate"
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object"
                                }
                            }
                        }
                    },
                    "required":[
                        "agent-name"
                    ]
                }
            ]
        },
        "statistics":{
            "type":"object",
            "$ref":"/axapi/v3/ddos/detection/statistics",
            "properties":{
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        }
    }
}