a10_ddos_network_object
Synopsis
Configure DDoS a static Monitor Network Object
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 |
||
object_name str/required |
Field object_name |
||
operational_mode str |
‘monitor’= Monitor mode; ‘learning’= Learning mode; |
||
threshold_sensitivity str |
tune threshold ranges with levels LOW/MEDIUM/HIGH/OFF (default) or multiplier of threshold value (available options are LOW=5x/MEDIUM=3x/HIGH=1.5x/OFF=1x, or float value between 1.0-10.0) |
||
histogram_mode str |
‘off’= histogram feature disabled; ‘monitor’= histogram feature enabled with anomaly escalation; ‘observe’= histogram feature enabled and observe only; |
||
anomaly_detection_trigger str |
‘all’= Use both learned and static thresholds (static thresholds take precedence); ‘static-threshold-only’= Use static thresholds only; |
||
service_discovery str |
‘disable’= Disable service discovery for hosts (default= enabled); |
||
sport_discovery str |
‘disable’= Disable source port discovery (default= enabled); |
||
sport_anomaly_detection str |
‘disable’= Disable source port anomaly detection (default= enabled); |
||
flooding_multiplier int |
multiplier for flooding detection threshold in network objects (default 2x threshold) |
||
relative_auto_break_down_threshold dict |
Field relative_auto_break_down_threshold |
||
network_percentage int |
percentage of parent node |
||
permil int |
permil of root node |
||
static_auto_break_down_threshold dict |
Field static_auto_break_down_threshold |
||
network_pkt_rate int |
packet rate of current node |
||
service_break_down_threshold_local dict |
Field service_break_down_threshold_local |
||
svc_percentage int |
percentage of parent ip node |
||
host_anomaly_threshold dict |
Field host_anomaly_threshold |
||
host_pkt_rate int |
Forward packet rate of per host |
||
host_bit_rate int |
Forward bit rate of per host |
||
host_rev_pkt_rate int |
Reverse packet rate of per host |
||
host_rev_bit_rate int |
Reverse bit rate of per host |
||
host_undiscovered_pkt_rate int |
Undiscovered forward packet rate of per host |
||
host_flow_count int |
Flow count of per host |
||
host_syn_rate int |
SYN packet rate of per host |
||
host_fin_rate int |
FIN packet rate of per host |
||
host_rst_rate int |
RST packet rate of per host |
||
host_tcp_pkt_rate int |
Tcp packet rate of per host |
||
host_udp_pkt_rate int |
Udp packet rate of per host |
||
host_icmp_pkt_rate int |
ICMP packet rate of per host |
||
host_undiscovered_host_pkt_rate int |
forward packet rate of per undiscovered host |
||
host_undiscovered_host_bit_rate int |
Forward bit rate of per undiscovered host |
||
sport_discovery_threshold dict |
Field sport_discovery_threshold |
||
sport_heavy_hitter_percentage int |
Percentage of the bit rate of undiscovered source ports (default= 50) |
||
sport_discovery_bit_rate_percentage int |
Percentage of the bit rate of source port’s parent entry (default= 5) |
||
network_object_anomaly_threshold dict |
Field network_object_anomaly_threshold |
||
network_object_pkt_rate int |
Packet rate of the network-object |
||
network_object_bit_rate int |
Bit rate of the network-object |
||
enable_top_k list |
Field enable_top_k |
||
topk_type str |
‘destination’= Topk destination IP; |
||
topk_dst_num_records int |
Maximum number of records to show in topk |
||
topk_sort_key str |
‘average’= window average; ‘max-peak’= max peak; |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
||
sampling_enable list |
Field sampling_enable |
||
counters1 str |
‘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; ‘packet_rate’= PPS; ‘bit_rate’= B(bits)PS; ‘topk_allocate_fail’= Topk Allocate Failures; ‘sport_learned’= Source Port Entry Learned; ‘sport_aged’= Source Port Entry Aged; ‘sport_create_fail’= Source Port Entry Create Failures; |
||
ip_list list |
Field ip_list |
||
subnet_ip_addr str |
IP Subnet, supported prefix range is from 8 to 31 |
||
prefix_anomaly_threshold dict |
Field prefix_anomaly_threshold |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
||
sampling_enable list |
Field sampling_enable |
||
ipv6_list list |
Field ipv6_list |
||
subnet_ipv6_addr str |
IPV6 Subnet, supported prefix range is from 40 to 63 |
||
prefix_anomaly_threshold dict |
Field prefix_anomaly_threshold |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
||
sampling_enable list |
Field sampling_enable |
||
notification dict |
Field notification |
||
configuration str |
‘configuration’= configuration; |
||
notification list |
Field notification |
||
uuid str |
uuid of the object |
||
sub_network dict |
Field sub_network |
||
sub_network_v4_list list |
Field sub_network_v4_list |
||
sub_network_v6_list list |
Field sub_network_v6_list |
||
topk_destinations dict |
Field topk_destinations |
||
uuid str |
uuid of the object |
||
sport_anomaly_threshold dict |
Field sport_anomaly_threshold |
||
packet_rate dict |
Field packet_rate |
||
packet_rate_percentage dict |
Field packet_rate_percentage |
||
bit_rate dict |
Field bit_rate |
||
bit_rate_percentage dict |
Field bit_rate_percentage |
||
ip_list list |
Field ip_list |
||
ipv6_list list |
Field ipv6_list |
||
sport_list list |
Field sport_list |
||
sport_list list |
Field sport_list |
||
port_num int |
Port Number |
||
protocol str |
‘udp’= UDP port; ‘tcp’= TCP Port; |
||
uuid str |
uuid of the object |
||
oper dict |
Field oper |
||
entry_list list |
Field entry_list |
||
entry_count int |
Field entry_count |
||
details bool |
Field details |
||
victim_list bool |
Field victim_list |
||
discovered_list bool |
Field discovered_list |
||
sport_list bool |
Field sport_list |
||
subnet_ip_addr str |
Field subnet_ip_addr |
||
subnet_ipv6_addr str |
Field subnet_ipv6_addr |
||
ipv4 str |
Field ipv4 |
||
discovered_ip_list bool |
Field discovered_ip_list |
||
anomaly_ip_list bool |
Field anomaly_ip_list |
||
sport bool |
Field sport |
||
port_start int |
Field port_start |
||
port_end int |
Field port_end |
||
protocol int |
Field protocol |
||
single_layer_discovered_list bool |
Field single_layer_discovered_list |
||
object_name str |
Field object_name |
||
topk_destinations dict |
Field topk_destinations |
||
stats dict |
Field stats |
||
subnet_learned str |
Subnet Entry Learned |
||
subnet_aged str |
Subnet Entry Aged |
||
subnet_create_fail str |
Subnet Entry Create Failures |
||
ip_learned str |
IP Entry Learned |
||
ip_aged str |
IP Entry Aged |
||
ip_create_fail str |
IP Entry Create Failures |
||
service_learned str |
Service Entry Learned |
||
service_aged str |
Service Entry Aged |
||
service_create_fail str |
Service Entry Create Failures |
||
packet_rate str |
PPS |
||
bit_rate str |
B(bits)PS |
||
topk_allocate_fail str |
Topk Allocate Failures |
||
sport_learned str |
Source Port Entry Learned |
||
sport_aged str |
Source Port Entry Aged |
||
sport_create_fail str |
Source Port Entry Create Failures |
||
object_name str |
Field object_name |
||
ip_list list |
Field ip_list |
||
ipv6_list list |
Field ipv6_list |
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.