a10_ddos_detection_agent

Synopsis

Configure DDoS detection agent

Parameters

Parameters

Choices/Defaults

Comment

state

str/required

[‘noop’, ‘present’, ‘absent’]

State of the object to be created.

ansible_host

str/required

Host for AXAPI authentication

ansible_username

str/required

Username for AXAPI authentication

ansible_password

str/required

Password for AXAPI authentication

ansible_port

int/required

Port for AXAPI authentication

a10_device_context_id

int

[‘1-8’]

Device ID for aVCS configuration

a10_partition

str

Destination/target partition for object/command

agent_name

str/required

Specify name for the agent

agent_v4_addr

str

Configure agent’s IPv4 address

agent_v6_addr

str

Configure agent’s IPv6 address

agent_type

str

‘Cisco’= Cisco; ‘Juniper’= Juniper;

uuid

str

uuid of the object

user_tag

str

Customized tag

sampling_enable

list

Field sampling_enable

counters1

str

‘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;

sflow

dict

Field sflow

sflow_pkt_samples_collection

str

‘enable’= Enable sflow packet samples collection(default); ‘disable’= Disable sflow packet samples collection;

uuid

str

uuid of the object

netflow

dict

Field netflow

netflow_samples_collection

str

‘enable’= Enable Netflow flow samples collection(default); ‘disable’= Disable Netflow flow samples collection;

netflow_sampling_rate

int

Configure agent’s netflow sampling rate

active_timeout

int

Configure agent’s flow active timeout (seconds)

inactive_timeout

int

Configure agent’s flow inactive timeout (seconds)

uuid

str

uuid of the object

stats

dict

Field stats

sflow_packets_received

str

sFlow Packets Received

sflow_samples_received

str

sFlow Samples Received

sflow_samples_bad_len

str

sFlow Samples Bad Length

sflow_samples_non_std

str

sFlow Samples Non-standard

sflow_samples_skipped

str

sFlow Samples Skipped

sflow_sample_record_bad_len

str

sFlow Sample Records Bad Length

sflow_samples_sent_for_detection

str

sFlow Samples Processed For Detection

sflow_sample_record_invalid_layer2

str

sFlow Sample Records Unknown Layer-2

sflow_sample_ipv6_hdr_parse_fail

str

sFlow Sample IPv6 Record Header Parse Failures

sflow_disabled

str

sFlow Packet Samples Processing Disabled

netflow_disabled

str

Netflow Flow Samples Processing Disabled

netflow_v5_packets_received

str

Netflow v5 Packets Received

netflow_v5_samples_received

str

Netflow v5 Samples Received

netflow_v5_samples_sent_for_detection

str

Netflow v5 Samples Processed For Detection

netflow_v5_sample_records_bad_len

str

Netflow v5 Sample Records Bad Length

netflow_v5_max_records_exceed

str

Netflow v5 Sample Max Records Error

netflow_v9_packets_received

str

Netflow v9 Packets Received

netflow_v9_samples_received

str

Netflow v9 Samples Received

netflow_v9_samples_sent_for_detection

str

Netflow v9 Samples Processed For Detection

netflow_v9_sample_records_bad_len

str

Netflow v9 Sample Records Bad Length

netflow_v9_sample_flowset_bad_padding

str

Netflow v9 Sample Flowset Bad Padding

netflow_v9_max_records_exceed

str

Netflow v9 Sample Max Records Error

netflow_v9_template_not_found

str

Netflow v9 Template Not Found

netflow_v10_packets_received

str

Netflow v10 Packets Received

netflow_v10_samples_received

str

Netflow v10 Samples Received

netflow_v10_samples_sent_for_detection

str

Netflow v10 Samples Procssed For Detection

netflow_v10_sample_records_bad_len

str

Netflow v10 Sample Records Bad Length

netflow_v10_max_records_exceed

str

Netflow v10 Sample Max records Error

netflow_tcp_sample_received

str

Netflow TCP Samples Received

netflow_udp_sample_received

str

Netflow UDP Samples received

netflow_icmp_sample_received

str

Netflow ICMP Samples Received

netflow_other_sample_received

str

Netflow OTHER Samples Received

netflow_record_copy_oom_error

str

Netflow Data Record Copy Fail, Local MEM size error

netflow_record_rse_invalid

str

Netflow Data Record Reduced Size Invalid

netflow_sample_flow_dur_error

str

Netflow Sample Flow Duration Error

flow_dst_entry_miss

str

DDoS Destination Entry Lookup Failures

flow_ip_proto_or_port_miss

str

DDoS Destination Service Lookup Failures

flow_detection_msgq_full

str

Detection Message Enqueue Failures

flow_network_entry_miss

str

DDoS Destination Network-object Entry Lookup Failures

agent_name

str

Specify name for the agent

Examples


Return Values

modified_values (changed, dict, )

Values modified (or potential changes if using check_mode) as a result of task operation

axapi_calls (always, list, )

Sequential list of AXAPI calls made by the task

endpoint (, str, [‘/axapi/v3/slb/virtual_server’, ‘/axapi/v3/file/ssl-cert’])

The AXAPI endpoint being accessed.

http_method (, str, [‘POST’, ‘GET’])

HTTP method being used by the primary task to interact with the AXAPI endpoint.

request_body (, complex, )

Params used to query the AXAPI

response_body (, complex, )

Response from the AXAPI

Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]

  • This module is maintained by community.

Authors

  • A10 Networks