a10_aam_authentication_server_ldap
Synopsis
LDAP Authentication Server
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 |
||
uuid str |
uuid of the object |
||
sampling_enable list |
Field sampling_enable |
||
counters1 str |
‘all’= all; ‘admin-bind-success’= Total Admin Bind Success; ‘admin-bind- failure’= Total Admin Bind Failure; ‘bind-success’= Total User Bind Success; ‘bind-failure’= Total User Bind Failure; ‘search-success’= Total Search Success; ‘search-failure’= Total Search Failure; ‘authorize-success’= Total Authorization Success; ‘authorize-failure’= Total Authorization Failure; ‘timeout-error’= Total Timeout; ‘other-error’= Total Other Error; ‘request’= Total Request; ‘request-normal’= Total Normal Request; ‘request-dropped’= Total Dropped Request; ‘response-success’= Total Success Response; ‘response- failure’= Total Failure Response; ‘response-error’= Total Error Response; ‘response-timeout’= Total Timeout Response; ‘response-other’= Total Other Response; ‘job-start-error’= Total Job Start Error; ‘polling-control-error’= Total Polling Control Error; ‘ssl-session-created’= TLS/SSL Session Created; ‘ssl-session-failure’= TLS/SSL Session Failure; ‘ldaps-idle-conn-num’= LDAPS Idle Connection Number; ‘ldaps-inuse-conn-num’= LDAPS In-use Connection Number; ‘pw-expiry’= Total Password expiry; ‘pw-change-success’= Total password change success; ‘pw-change-failure’= Total password change failure; |
||
instance_list list |
Field instance_list |
||
name str |
Specify LDAP authentication server name |
||
host dict |
Field host |
||
base str |
Specify the LDAP server’s search base |
||
port int |
Specify the LDAP server’s authentication port, default is 389 |
||
port_hm str |
Check port’s health status |
||
port_hm_disable bool |
Disable configured port health check configuration |
||
pwdmaxage int |
Specify the LDAP server’s default password expiration time (in seconds) (The LDAP server’s default password expiration time (in seconds), default is 0 (no expiration)) |
||
admin_dn str |
The LDAP server’s admin DN |
||
admin_secret bool |
Specify the LDAP server’s admin secret password |
||
secret_string str |
secret password |
||
encrypted str |
Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) |
||
timeout int |
Specify timout for LDAP, default is 10 seconds (The timeout, default is 10 seconds) |
||
dn_attribute str |
Specify Distinguished Name attribute, default is CN |
||
default_domain str |
Specify default domain for LDAP |
||
bind_with_dn bool |
Enforce using DN for LDAP binding(All user input name will be used to create DN) |
||
derive_bind_dn dict |
Field derive_bind_dn |
||
health_check bool |
Check server’s health status |
||
health_check_string str |
Health monitor name |
||
health_check_disable bool |
Disable configured health check configuration |
||
protocol str |
‘ldap’= Use LDAP (default); ‘ldaps’= Use LDAP over SSL; ‘starttls’= Use LDAP StartTLS; |
||
ca_cert str |
Specify the LDAPS CA cert filename (Trusted LDAPS CA cert filename) |
||
ldaps_conn_reuse_idle_timeout int |
Specify LDAPS connection reuse idle timeout value (in seconds) (Specify idle timeout value (in seconds), default is 0 (not reuse LDAPS connection)) |
||
auth_type str |
‘ad’= Active Directory. Default; ‘open-ldap’= OpenLDAP; |
||
prompt_pw_change_before_exp int |
Prompt user to change password before expiration in N days. This option only takes effect when server type is AD (Prompt user to change password before expiration in N days, default is not to prompt the user) |
||
uuid str |
uuid of the object |
||
sampling_enable list |
Field sampling_enable |
||
packet_capture_template str |
Name of the packet capture template to be bind with this object |
||
oper dict |
Field oper |
||
ldaps_server_list list |
Field ldaps_server_list |
||
stats dict |
Field stats |
||
admin_bind_success str |
Total Admin Bind Success |
||
admin_bind_failure str |
Total Admin Bind Failure |
||
bind_success str |
Total User Bind Success |
||
bind_failure str |
Total User Bind Failure |
||
search_success str |
Total Search Success |
||
search_failure str |
Total Search Failure |
||
authorize_success str |
Total Authorization Success |
||
authorize_failure str |
Total Authorization Failure |
||
timeout_error str |
Total Timeout |
||
other_error str |
Total Other Error |
||
request str |
Total Request |
||
request_normal str |
Total Normal Request |
||
request_dropped str |
Total Dropped Request |
||
response_success str |
Total Success Response |
||
response_failure str |
Total Failure Response |
||
response_error str |
Total Error Response |
||
response_timeout str |
Total Timeout Response |
||
response_other str |
Total Other Response |
||
job_start_error str |
Total Job Start Error |
||
polling_control_error str |
Total Polling Control Error |
||
ssl_session_created str |
TLS/SSL Session Created |
||
ssl_session_failure str |
TLS/SSL Session Failure |
||
ldaps_idle_conn_num str |
LDAPS Idle Connection Number |
||
ldaps_inuse_conn_num str |
LDAPS In-use Connection Number |
||
pw_expiry str |
Total Password expiry |
||
pw_change_success str |
Total password change success |
||
pw_change_failure str |
Total password change failure |
||
instance_list list |
Field instance_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.