f5networks.f5_modules.bigip_device_auth_ldap module – Manage LDAP device authentication settings on BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.30.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_device_auth_ldap
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage LDAP device authentication settings on BIG-IP.
Parameters
Parameter |
Comments |
---|---|
Specifies the distinguished name for the Active Directory or LDAP server user ID. The BIG-IP client authentication module does not support Active Directory or LDAP servers that do not perform bind referral when authenticating referred accounts. Therefore, if you plan to use Active Directory or LDAP as your authentication source and want to use referred accounts, make sure your servers perform bind referral. |
|
Specifies a password for the Active Directory or LDAP server user ID. |
|
Specifies the name of an SSL certificate from a certificate authority (CA). To remove this value, use the reserved value |
|
Checks the member attribute of the user in the remote LDAP or AD group. Choices:
|
|
Specifies the name of an SSL client certificate. To remove this value, use the reserved value |
|
Specifies the name of an SSL client key. To remove this value, use the reserved value |
|
Specifies the system uses the Local authentication method if the remote authentication method is not available. Option only available on Choices:
|
|
Specifies the LDAP directory attribute containing the local user name that is associated with the selected directory entry. If this parameter is not specified, when configuring LDAP device authentication for the first time, the default port is |
|
Specifies the port the system uses for access to the remote host server. When configuring LDAP device authentication for the first time, the default port is |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies whether automatic referral chasing should be enabled. Option only available on Choices:
|
|
Specifies the file location (tree) of the user authentication database on the server. |
|
Specifies the level of the remote Active Directory or LDAP directory the system should search for the user authentication. Choices:
|
|
Specifies the LDAP servers the system must use to obtain authentication information. You must specify a server when you create an LDAP configuration object. |
|
Specifies the auth source for user authentication, should be used with Choices:
|
|
Specifies whether the system uses an SSL port to communicate with the LDAP server. Choices:
|
|
When When When Choices:
|
|
Choices:
|
|
Specifies whether or not this auth source is put in use on the system. If If Choices:
|
|
Specifies the distinguished name of the user who is logging on. You specify the template as a variable that the system replaces with user-specific information during the logon attempt. For example, you could specify a user template such as When a user attempts to log on, the system replaces The system passes the associated password as the password for the bind operation. This field can contain only one |
|
Specifies whether the system checks an SSL peer, as a result of which the system requires and verifies the server certificate. Choices:
|
Notes
Note
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Create an LDAP authentication object
bigip_device_auth_ldap:
name: foo
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The distinguished name for the Active Directory or LDAP server user ID. Returned: changed Sample: |
|
The name of an SSL certificate from a certificate authority. Returned: changed Sample: |
|
The user’s member attribute in the remote LDAP or AD group. Returned: changed Sample: |
|
The name of an SSL client certificate. Returned: changed Sample: |
|
The name of an SSL client key. Returned: changed Sample: |
|
Specifies the system uses the Local authentication method as fallback Returned: changed Sample: |
|
The LDAP directory attribute containing the local user name associated with the selected directory entry. Returned: changed Sample: |
|
The port the system uses for access to the remote LDAP server. Returned: changed Sample: |
|
Specifies whether automatic referral chasing should be enabled Returned: changed Sample: |
|
File location (tree) of the user authentication database on the server. Returned: changed Sample: |
|
The level of the remote Active Directory or LDAP directory searched for user authentication. Returned: changed Sample: |
|
LDAP servers used by the system to obtain authentication information. Returned: changed Sample: |
|
Specifies whether the system uses an SSL port to communicate with the LDAP server. Returned: changed Sample: |
|
The distinguished name of the user who is logging on. Returned: changed Sample: |
|
Indicates if the system checks an SSL peer. Returned: changed Sample: |