a10_aam_aaa_policy_aaa_rule
Synopsis
Rules of AAA policy
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 |
||
aaa_policy_name str/required |
Key to identify parent object |
||
index int/required |
Specify AAA rule index |
||
uri list |
Field uri |
||
match_type str |
‘contains’= Match URI if request URI contains specified URI; ‘ends-with’= Match URI if request URI ends with specified URI; ‘equals’= Match URI if request URI equals specified URI; ‘starts-with’= Match URI if request URI starts with specified URI; |
||
uri_str str |
Specify URI string |
||
host list |
Field host |
||
host_match_type str |
‘contains’= Match HOST if request HTTP HOST header contains specified hostname; ‘ends-with’= Match HOST if request HTTP HOST header ends with specified hostname; ‘equals’= Match HOST if request HTTP HOST header equals specified hostname; ‘starts-with’= Match HOST if request HTTP HOST header starts with specified hostname; |
||
host_str str |
Specify URI string |
||
domain_whitelist str |
Specify the AC type class-list for the domain-whitelist |
||
port int |
Specify port number for aaa-rule, default is 0 for all port numbers |
||
match_encoded_uri bool |
Enable URL decoding for URI matching |
||
access_list dict |
Field access_list |
||
acl_id int |
ACL id |
||
acl_name str |
‘ip-name’= Apply an IP named access list; ‘ipv6-name’= Apply an IPv6 named access list; |
||
name str |
Specify Named Access List |
||
domain_name str |
Specify domain name to bind to the AAA rule (ex= a10networks.com, www.a10networks.com) |
||
user_agent list |
Field user_agent |
||
user_agent_match_type str |
‘contains’= Match request User-Agent header if it contains specified string; ‘ends-with’= Match request User-Agent header if it ends with specified string; ‘equals’= Match request User-Agent header if it equals specified string; ‘starts-with’= Match request User-Agent header if it starts with specified string; |
||
user_agent_str str |
Specify request User-Agent string |
||
action str |
‘allow’= Allow traffic that matches this rule; ‘deny’= Deny traffic that matches this rule; |
||
authentication_template str |
Specify authentication template name to bind to the AAA rule |
||
authorize_policy str |
Specify authorization policy to bind to the AAA rule |
||
captcha_authz_policy str |
Specify authorization policy for CAPTCHA (Authorization policy name) |
||
auth_failure_bypass bool |
Forward client request even though authentication has failed |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
||
sampling_enable list |
Field sampling_enable |
||
counters1 str |
‘all’= all; ‘total_count’= total_count; ‘hit_deny’= hit_deny; ‘hit_auth’= hit_auth; ‘hit_bypass’= hit_bypass; ‘failure_bypass’= failure_bypass; |
||
stats dict |
Field stats |
||
total_count str |
Field total_count |
||
hit_deny str |
Field hit_deny |
||
hit_auth str |
Field hit_auth |
||
hit_bypass str |
Field hit_bypass |
||
failure_bypass str |
Field failure_bypass |
||
index int |
Specify AAA rule index |
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.