ddos detection agent¶
Configure DDoS detection agent
agent Specification¶
Type Collection Object Key(s) agent-name Collection Name agent-list Collection URI /axapi/v3/ddos/detection/agent Element Name agent Element URI /axapi/v3/ddos/detection/agent/{agent-name} Element Attributes agent_attributes Statistics Data URI /axapi/v3/ddos/detection/agent/{agent-name}/stats Schema agent schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/ddos/detection/agent | ||
Create List | POST | /axapi/v3/ddos/detection/agent | ||
Get Object | GET | /axapi/v3/ddos/detection/agent/{agent-name} | ||
Get List | GET | /axapi/v3/ddos/detection/agent | ||
Modify Object | POST | /axapi/v3/ddos/detection/agent/{agent-name} | ||
Replace Object | PUT | /axapi/v3/ddos/detection/agent/{agent-name} | ||
Replace List | PUT | /axapi/v3/ddos/detection/agent | ||
Delete Object | DELETE | /axapi/v3/ddos/detection/agent/{agent-name} |
agent-list¶
agent-list is JSON List of agent attributes
agent-list : [
]
agent attributes¶
agent-name
Description Specify name for the agent
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
agent-v4-addr
Description Configure agent’s IPv4 address
Type: string
Format: ipv4-address
agent-v6-addr
Description Configure agent’s IPv6 address
Type: string
Format: ipv6-address
netflow
Description: netflow is a JSON Block. Please see below for netflow
Type: Object
Refernce Object: /axapi/v3/ddos/detection/agent/{agent-name}/netflow
sflow
Description: sflow is a JSON Block. Please see below for sflow
Type: Object
Refernce Object: /axapi/v3/ddos/detection/agent/{agent-name}/sflow
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sflow¶
Specification Type object sflow-pkt-samples-collection
Description ‘enable’: Enable sflow packet samples collection(default); ‘disable’: Disable sflow packet samples collection;
Type: string
Supported Values: enable, disable
Default: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
netflow¶
Specification Type object netflow-samples-collection
Description ‘enable’: Enable Netflow flow samples collection(default); ‘disable’: Disable Netflow flow samples collection;
Type: string
Supported Values: enable, disable
Default: enable
netflow-sampling-rate
Description Configure agent’s netflow sampling rate
Type: number
Range: 1-65535
Default: 1
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stats data¶
Counter | Size | Description | |
---|---|---|---|
netflow-v10-packets-received | 8 | Netflow v10 Packets Received | |
netflow-v9-sample-records-bad-len | 8 | Netflow v9 Sample Records Bad Length | |
flow-detection-msgq-full | 8 | Detection Message Enqueue Failures | |
sflow-disabled | 8 | sFlow Packet Samples Processing Disabled | |
netflow-v5-max-records-exceed | 8 | Netflow v5 Sample Max Records Error | |
netflow-v5-sample-records-bad-len | 8 | Netflow v5 Sample Records Bad Length | |
netflow-tcp-sample-received | 8 | Netflow TCP Samples Received | |
netflow-v10-samples-received | 8 | Netflow v10 Samples Received | |
netflow-record-rse-invalid | 8 | Netflow Data Record Reduced Size Invalid | |
sflow-samples-skipped | 8 | sFlow Samples Skipped | |
netflow-v10-max-records-exceed | 8 | Netflow v10 Sample Max records Error | |
netflow-v9-samples-received | 8 | Netflow v9 Samples Received | |
netflow-v9-sample-flowset-bad-padding | 8 | Netflow v9 Sample Flowset Bad Padding | |
sflow-samples-received | 8 | sFlow Samples Received | |
sflow-sample-record-invalid-layer2 | 8 | sFlow Sample Records Unknown Layer-2 | |
flow-ip-proto-or-port-miss | 8 | DDoS Destination Service Lookup Failures | |
netflow-v10-sample-records-bad-len | 8 | Netflow v10 Sample Records Bad Length | |
netflow-icmp-sample-received | 8 | Netflow ICMP Samples Received | |
netflow-udp-sample-received | 8 | Netflow UDP Samples received | |
netflow-v9-packets-received | 8 | Netflow v9 Packets Received | |
netflow-v10-samples-sent-for-detection | 8 | Netflow v10 Samples Procssed For Detection | |
sflow-packets-received | 8 | sFlow Packets Received | |
sflow-samples-sent-for-detection | 8 | sFlow Samples Processed For Detection | |
netflow-v9-max-records-exceed | 8 | Netflow v9 Sample Max Records Error | |
netflow-v5-samples-received | 8 | Netflow v5 Samples Received | |
netflow-sample-flow-dur-error | 8 | Netflow Sample Flow Duration Error | |
flow-dst-entry-miss | 8 | DDoS Destination Entry Lookup Failures | |
sflow-samples-non-std | 8 | sFlow Samples Non-standard | |
netflow-other-sample-received | 8 | Netflow OTHER Samples Received | |
netflow-v5-packets-received | 8 | Netflow v5 Packets Received | |
netflow-v9-template-not-found | 8 | Netflow v9 Template Not Found | |
sflow-sample-record-bad-len | 8 | sFlow Sample Records Bad Length | |
sflow-sample-ipv6-hdr-parse-fail | 8 | sFlow Sample IPv6 Record Header Parse Failures | |
netflow-disabled | 8 | Netflow Flow Samples Processing Disabled | |
netflow-v5-samples-sent-for-detection | 8 | Netflow v5 Samples Processed For Detection | |
sflow-samples-bad-len | 8 | sFlow Samples Bad Length | |
netflow-record-copy-oom-error | 8 | Netflow Data Record Copy Fail OOM | |
netflow-v9-samples-sent-for-detection | 8 | Netflow v9 Samples Processed For Detection |