.. _a10_aam_authentication_server_ldap_instance_module:


a10_aam_authentication_server_ldap_instance
===========================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

LDAP Authentication Server






Parameters
----------

 
| Parameters                    | Choices/Defaults              | Comment                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| state                         | ['noop', 'present', 'absent'] | State of the object to be created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str/required                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| ansible_host                  |                               | Host for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str/required                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| ansible_username              |                               | Username for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str/required                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| ansible_password              |                               | Password for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str/required                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| ansible_port                  |                               | Port for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| int/required                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| a10_device_context_id         | ['1-8']                       | Device ID for aVCS configuration                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| int                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| a10_partition                 |                               | Destination/target partition for object/command                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| name                          |                               | Specify LDAP authentication server name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str/required                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| host                          |                               | Field host                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| dict                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | hostip                    |                               | Server's hostname(Length 1-31) or IP address                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | hostipv6                  |                               | Server's IPV6 address                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| base                          |                               | Specify the LDAP server's search base                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| port                          |                               | Specify the LDAP server's authentication port, default is 389                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| int                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| port_hm                       |                               | Check port's health status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| port_hm_disable               |                               | Disable configured port health check configuration                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| bool                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| pwdmaxage                     |                               | 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))                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| int                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| admin_dn                      |                               | The LDAP server's admin DN                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| admin_secret                  |                               | Specify the LDAP server's admin secret password                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| bool                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| secret_string                 |                               | secret password                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| encrypted                     |                               | Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| timeout                       |                               | Specify timout for LDAP, default is 10 seconds (The timeout, default is 10 seconds)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| int                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| dn_attribute                  |                               | Specify Distinguished Name attribute, default is CN                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| default_domain                |                               | Specify default domain for LDAP                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| bind_with_dn                  |                               | Enforce using DN for LDAP binding(All user input name will be used to create DN)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| bool                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| derive_bind_dn                |                               | Field derive_bind_dn                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| dict                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | username_attr             |                               | Specify attribute name of username                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| health_check                  |                               | Check server's health status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| bool                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| health_check_string           |                               | Health monitor name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| health_check_disable          |                               | Disable configured health check configuration                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| bool                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| protocol                      |                               | 'ldap'= Use LDAP (default); 'ldaps'= Use LDAP over SSL; 'starttls'= Use LDAP StartTLS;                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| ca_cert                       |                               | Specify the LDAPS CA cert filename (Trusted LDAPS CA cert filename)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| ldaps_conn_reuse_idle_timeout |                               | Specify LDAPS connection reuse idle timeout value (in seconds) (Specify idle timeout value (in seconds), default is 0 (not reuse LDAPS connection))                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| int                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| auth_type                     |                               | 'ad'= Active Directory. Default; 'open-ldap'= OpenLDAP;                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| prompt_pw_change_before_exp   |                               | 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)                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| int                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| uuid                          |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| sampling_enable               |                               | Field sampling_enable                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| list                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | counters1                 |                               | '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; |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| packet_capture_template       |                               | Name of the packet capture template to be bind with this object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| stats                         |                               | Field stats                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| dict                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | admin_bind_success        |                               | Admin Bind Success                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | admin_bind_failure        |                               | Admin Bind Failure                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | bind_success              |                               | User Bind Success                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | bind_failure              |                               | User Bind Failure                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | search_success            |                               | Search Success                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | search_failure            |                               | Search Failure                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | authorize_success         |                               | Authorization Success                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | authorize_failure         |                               | Authorization Failure                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | timeout_error             |                               | Timeout                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | other_error               |                               | Other Error                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | request                   |                               | Request                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | ssl_session_created       |                               | TLS/SSL Session Created                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | ssl_session_failure       |                               | TLS/SSL Session Failure                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | pw_expiry                 |                               | Password expiry                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | pw_change_success         |                               | Password change success                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | pw_change_failure         |                               | Password change failure                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
|   | name                      |                               | Specify LDAP authentication server name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   | str                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 







Examples
--------

.. code-block:: yaml+jinja

    



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

