a10_fw_rate_limit

Synopsis 

View Rate Limit Entries

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
interval str			‘100’= 100 ms; ‘250’= 250 ms; ‘500’= 500 ms; ‘1000’= 1000 ms;
uuid str			uuid of the object
sampling_enable list			Field sampling_enable
	counters1 str		‘all’= all; ‘ratelimit_used_total_mem’= Total Memory Used For Rate-limiting (bytes); ‘ratelimit_used_spm_mem’= Total SPM Memory Used For Rate-limiting Infra in Bytes; ‘ratelimit_used_heap_mem’= Total Heap Memory Used For Rate- limiting Infra in Bytes; ‘ratelimit_entry_alloc_frm_spm_mem’= Total Number of Rate-limit Entries created using SPM Memory; ‘ratelimit_high_accurate_entry_alloc_fail’= Total Number of Failures to Create Highly Accurate Rate-limit Entries Due to Memory Allocation Failures; ‘ratelimit_high_perf_entry_alloc_fail’= Total Number of Failures to Create High-Perf Rate-limit Entries Due to Memory Allocation Failures; ‘ratelimit_high_perf_entry_secondary_alloc_fail’= Total Number of Failures to Allocate Additional Memory to Existing High-Perf Rate-limit Entries; ‘ratelimit_entry_alloc_fail_rate_too_high’= Total Number of Attempts to Configure Too High Rate Limits; ‘ratelimit_entry_alloc_fail_metric_count_gt_supported’= Total Number of Failures to Create High-Perf Rate-limit Entries Because of Too Many Metrics; ‘ratelimit_entry_count_t2_key’= Number of Total Rate-limit Entries; ‘ratelimit_entry_count_fw_rule_uid’= Number of Rate-limit Entries with Scope Aggregate; ‘ratelimit_entry_count_ip_addr’= Number of Rate-limit Entries with Scope IPv4 Address; ‘ratelimit_entry_count_ip6_addr’= Number of Rate-limit Entries with Scope IPv6 Address; ‘ratelimit_entry_count_session_id’= Number of Rate-limit Entries with Scope Session ID; ‘ratelimit_entry_count_rule_ipv4_prefix’= Number of Rate-limit Entries with Scope IPv4 Prefix; ‘ratelimit_entry_count_rule_ipv6_prefix’= Number of Rate- limit Entries with Scope IPv6 Prefix; ‘ratelimit_entry_count_parent_uid’= Number of Parent Rate-limit Entries with Scope Aggregate; ‘ratelimit_entry_count_parent_ipv4_prefix’= Number of Parent Rate-limit Entries with Scope IPv4 Prefix; ‘ratelimit_entry_count_parent_ipv6_prefix’= Number of Parent Rate-limit Entries with Scope IPv6 Prefix; ‘ratelimit_infra_generic_errors’= Current Number of Generic Errors Encountered in Ratelimit Infra; ‘ratelimit_entry_count_rule_ip’= Number of Rate-limit Entries with Scope IP; ‘ratelimit_entry_count_parent_ip’= Number of Parent Rate-limit Entries with Scope IP;
summary dict			Field summary
	uuid str		uuid of the object
oper dict			Field oper
	rate_limit_list list		Field rate_limit_list
	v4_address str		Field v4_address
	v4_netmask str		Field v4_netmask
	v6_prefix str		Field v6_prefix
	template_id int		Field template_id
	summary dict		Field summary
stats dict			Field stats
	ratelimit_used_total_mem str		Total Memory Used For Rate-limiting (bytes)
	ratelimit_entry_count_t2_key str		Number of Total Rate-limit Entries
	ratelimit_entry_count_fw_rule_uid str		Number of Rate-limit Entries with Scope Aggregate
	ratelimit_entry_count_ip_addr str		Number of Rate-limit Entries with Scope IPv4 Address
	ratelimit_entry_count_ip6_addr str		Number of Rate-limit Entries with Scope IPv6 Address
	ratelimit_entry_count_session_id str		Number of Rate-limit Entries with Scope Session ID
	ratelimit_entry_count_rule_ipv4_prefix str		Number of Rate-limit Entries with Scope IPv4 Prefix
	ratelimit_entry_count_rule_ipv6_prefix str		Number of Rate-limit Entries with Scope IPv6 Prefix
	ratelimit_entry_count_parent_uid str		Number of Parent Rate-limit Entries with Scope Aggregate
	ratelimit_entry_count_parent_ipv4_prefix str		Number of Parent Rate-limit Entries with Scope IPv4 Prefix
	ratelimit_entry_count_parent_ipv6_prefix str		Number of Parent Rate-limit Entries with Scope IPv6 Prefix
	ratelimit_entry_count_rule_ip str		Number of Rate-limit Entries with Scope IP
	ratelimit_entry_count_parent_ip str		Number of Parent Rate-limit Entries with Scope IP

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