{
    "id":"/axapi/v3/ddos/detection/agent/{agent-name}",
    "type":"object",
    "node-type":"list",
    "title":"agent",
    "partition-visibility":"shared",
    "description":"Configure DDoS detection agent",
    "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
        },
        "agent-type":{
            "type":"string",
            "format":"enum",
            "partition-visibility":"shared",
            "description":"'Cisco': Cisco; 'Juniper': Juniper; ",
            "enum":[
                "Cisco",
                "Juniper"
            ],
            "optional":true
        },
        "uuid":{
            "type":"string",
            "format":"string",
            "minLength":1,
            "maxLength":64,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"uuid of the object",
            "optional":true
        },
        "user-tag":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":127,
            "partition-visibility":"shared",
            "description":"Customized tag",
            "optional":true
        },
        "sampling-enable":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object"
            },
            "uniqueItems":true,
            "array":[
                {
                    "properties":{
                        "counters1":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'all': all; 'sflow-packets-received': sFlow Packets Received; 'sflow-samples-received': sFlow Samples Received; 'sflow-samples-bad-len': sFlow Samples Bad Length; 'sflow-samples-non-std': sFlow Samples Non-standard; 'sflow-samples-skipped': sFlow Samples Skipped; 'sflow-sample-record-bad-len': sFlow Sample Records Bad Length; 'sflow-samples-sent-for-detection': sFlow Samples Processed For Detection; 'sflow-sample-record-invalid-layer2': sFlow Sample Records Unknown Layer-2; 'sflow-sample-ipv6-hdr-parse-fail': sFlow Sample IPv6 Record Header Parse Failures; 'sflow-disabled': sFlow Packet Samples Processing Disabled; 'netflow-disabled': Netflow Flow Samples Processing Disabled; 'netflow-v5-packets-received': Netflow v5 Packets Received; 'netflow-v5-samples-received': Netflow v5 Samples Received; 'netflow-v5-samples-sent-for-detection': Netflow v5 Samples Processed For Detection; 'netflow-v5-sample-records-bad-len': Netflow v5 Sample Records Bad Length; 'netflow-v5-max-records-exceed': Netflow v5 Sample Max Records Error; 'netflow-v9-packets-received': Netflow v9 Packets Received; 'netflow-v9-samples-received': Netflow v9 Samples Received; 'netflow-v9-samples-sent-for-detection': Netflow v9 Samples Processed For Detection; 'netflow-v9-sample-records-bad-len': Netflow v9 Sample Records Bad Length; 'netflow-v9-sample-flowset-bad-padding': Netflow v9 Sample Flowset Bad Padding; 'netflow-v9-max-records-exceed': Netflow v9 Sample Max Records Error; 'netflow-v9-template-not-found': Netflow v9 Template Not Found; 'netflow-v10-packets-received': Netflow v10 Packets Received; 'netflow-v10-samples-received': Netflow v10 Samples Received; 'netflow-v10-samples-sent-for-detection': Netflow v10 Samples Procssed For Detection; 'netflow-v10-sample-records-bad-len': Netflow v10 Sample Records Bad Length; 'netflow-v10-max-records-exceed': Netflow v10 Sample Max records Error; 'netflow-tcp-sample-received': Netflow TCP Samples Received; 'netflow-udp-sample-received': Netflow UDP Samples received; 'netflow-icmp-sample-received': Netflow ICMP Samples Received; 'netflow-other-sample-received': Netflow OTHER Samples Received; 'netflow-record-copy-oom-error': Netflow Data Record Copy Fail, Local MEM size error; 'netflow-record-rse-invalid': Netflow Data Record Reduced Size Invalid; 'netflow-sample-flow-dur-error': Netflow Sample Flow Duration Error; 'flow-dst-entry-miss': DDoS Destination Entry Lookup Failures; 'flow-ip-proto-or-port-miss': DDoS Destination Service Lookup Failures; 'flow-detection-msgq-full': Detection Message Enqueue Failures; 'flow-network-entry-miss': DDoS Destination Network-object Entry Lookup Failures; ",
                            "enum":[
                                "all",
                                "sflow-packets-received",
                                "sflow-samples-received",
                                "sflow-samples-bad-len",
                                "sflow-samples-non-std",
                                "sflow-samples-skipped",
                                "sflow-sample-record-bad-len",
                                "sflow-samples-sent-for-detection",
                                "sflow-sample-record-invalid-layer2",
                                "sflow-sample-ipv6-hdr-parse-fail",
                                "sflow-disabled",
                                "netflow-disabled",
                                "netflow-v5-packets-received",
                                "netflow-v5-samples-received",
                                "netflow-v5-samples-sent-for-detection",
                                "netflow-v5-sample-records-bad-len",
                                "netflow-v5-max-records-exceed",
                                "netflow-v9-packets-received",
                                "netflow-v9-samples-received",
                                "netflow-v9-samples-sent-for-detection",
                                "netflow-v9-sample-records-bad-len",
                                "netflow-v9-sample-flowset-bad-padding",
                                "netflow-v9-max-records-exceed",
                                "netflow-v9-template-not-found",
                                "netflow-v10-packets-received",
                                "netflow-v10-samples-received",
                                "netflow-v10-samples-sent-for-detection",
                                "netflow-v10-sample-records-bad-len",
                                "netflow-v10-max-records-exceed",
                                "netflow-tcp-sample-received",
                                "netflow-udp-sample-received",
                                "netflow-icmp-sample-received",
                                "netflow-other-sample-received",
                                "netflow-record-copy-oom-error",
                                "netflow-record-rse-invalid",
                                "netflow-sample-flow-dur-error",
                                "flow-dst-entry-miss",
                                "flow-ip-proto-or-port-miss",
                                "flow-detection-msgq-full",
                                "flow-network-entry-miss"
                            ]
                        }
                    }
                }
            ]
        },
        "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"
                },
                "active-timeout":{
                    "type":"number",
                    "format":"number",
                    "minimum":10,
                    "maximum":600,
                    "partition-visibility":"shared",
                    "description":"Configure agent's flow active timeout (seconds)"
                },
                "inactive-timeout":{
                    "type":"number",
                    "format":"number",
                    "minimum":10,
                    "maximum":600,
                    "partition-visibility":"shared",
                    "description":"Configure agent's flow inactive timeout (seconds)"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        }
    },
    "object-keys":[
        "agent-name"
    ],
    "required":[
        "agent-name"
    ]
}