a10_aam_authentication_server_ldap_instance¶
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 |
||
name str/required |
Specify LDAP authentication server name |
||
host dict |
Field host |
||
hostip str |
Server’s hostname(Length 1-31) or IP address |
||
hostipv6 str |
Server’s IPV6 address |
||
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 |
||
username_attr str |
Specify attribute name of username |
||
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 |
||
counters1 str |
‘all’= all; ‘admin-bind-success’= Admin Bind Success; ‘admin-bind-failure’= Admin Bind Failure; ‘bind-success’= User Bind Success; ‘bind-failure’= User Bind Failure; ‘search-success’= Search Success; ‘search-failure’= Search Failure; ‘authorize-success’= Authorization Success; ‘authorize-failure’= Authorization Failure; ‘timeout-error’= Timeout; ‘other-error’= Other Error; ‘request’= Request; ‘ssl-session-created’= TLS/SSL Session Created; ‘ssl- session-failure’= TLS/SSL Session Failure; ‘pw_expiry’= Password expiry; ‘pw_change_success’= Password change success; ‘pw_change_failure’= Password change failure; |
||
stats dict |
Field stats |
||
admin_bind_success str |
Admin Bind Success |
||
admin_bind_failure str |
Admin Bind Failure |
||
bind_success str |
User Bind Success |
||
bind_failure str |
User Bind Failure |
||
search_success str |
Search Success |
||
search_failure str |
Search Failure |
||
authorize_success str |
Authorization Success |
||
authorize_failure str |
Authorization Failure |
||
timeout_error str |
Timeout |
||
other_error str |
Other Error |
||
request str |
Request |
||
ssl_session_created str |
TLS/SSL Session Created |
||
ssl_session_failure str |
TLS/SSL Session Failure |
||
pw_expiry str |
Password expiry |
||
pw_change_success str |
Password change success |
||
pw_change_failure str |
Password change failure |
||
name str |
Specify LDAP authentication server name |
||