Try SpotterManage LDAP device authentication settings on BIG-IP
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manage LDAP device authentication settings on BIG-IP.
- name: Create an LDAP authentication object
bigip_device_auth_ldap:
name: foo
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
ssl:
choices:
- 'yes'
- 'no'
- start-tls
description:
- Specifies whether the system uses an SSL port to communicate with the LDAP server.
type: str
port:
description:
- 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 C(389) if this parameter is not specified.
type: int
scope:
choices:
- sub
- one
- base
description:
- Specifies the level of the remote Active Directory or LDAP directory the system
should search for the user authentication.
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the device authentication method exists.
- When C(absent), ensures the device authentication method does not exist.
- When C(state) equal to (absent), before you can delete the LDAP configuration, the
system must set auth to some alternative. The system ships with a system auth called
C(local), therefore the system authentication type is set to that value on the device
upon removal of LDAP configuration.
type: str
bind_dn:
description:
- 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.
type: str
ca_cert:
aliases:
- ssl_ca_cert
description:
- Specifies the name of an SSL certificate from a certificate authority (CA).
- To remove this value, use the reserved value C(none).
type: str
servers:
description:
- Specifies the LDAP servers the system must use to obtain authentication information.
You must specify a server when you create an LDAP configuration object.
elements: str
type: list
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- 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 C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- 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 C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(no), SSL certificates are not validated. Use this only on personally controlled
sites using self-signed certificates.
- You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
referrals:
description:
- Specifies whether automatic referral chasing should be enabled.
- Option only available on C(TMOS 15.1.0) and above.
type: bool
version_added: 1.22.0
version_added_collection: f5networks.f5_modules
client_key:
aliases:
- ssl_client_key
description:
- Specifies the name of an SSL client key.
- To remove this value, use the reserved value C(none).
type: str
client_cert:
aliases:
- ssl_client_cert
description:
- Specifies the name of an SSL client certificate.
- To remove this value, use the reserved value C(none).
type: str
source_type:
choices:
- ldap
- active-directory
default: ldap
description:
- Specifies the auth source for user authentication, should be used with C(use_for_auth).
type: str
version_added: 1.13.0
version_added_collection: f5networks.f5_modules
use_for_auth:
description:
- Specifies whether or not this auth source is put in use on the system.
- If C(true), the module sets the current system auth type to the value of C(ldap).
- If C(false), the module sets the authentication type to C(local), similar behavior
to when C(state) is C(absent), without removing the configured LDAP resource.
type: bool
bind_password:
description:
- Specifies a password for the Active Directory or LDAP server user ID.
type: str
user_template:
description:
- 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 C(%s@siterequest.com) or
C(uxml:id=%s,ou=people,dc=siterequest,dc=com).
- When a user attempts to log on, the system replaces C(%s) with the name the user
specified in the Basic Authentication dialog box, and passes that as the distinguished
name for the bind operation.
- The system passes the associated password as the password for the bind operation.
- This field can contain only one C(%s) and cannot contain any other format specifiers.
type: str
validate_certs:
aliases:
- ssl_check_peer
description:
- Specifies whether the system checks an SSL peer, as a result of which the system
requires and verifies the server certificate.
type: bool
login_ldap_attr:
description:
- 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 C(samaccountname).
type: str
update_password:
choices:
- always
- on_create
default: always
description:
- C(always) always updates the C(bind_password).
- C(on_create) only sets the C(bind_password) for newly created authentication mechanisms.
type: str
check_member_attr:
description:
- Checks the member attribute of the user in the remote LDAP or AD group.
type: bool
fallback_to_local:
description:
- Specifies the system uses the Local authentication method if the remote authentication
method is not available.
- Option only available on C(TMOS 13.0.0) and above.
type: bool
remote_directory_tree:
description:
- Specifies the file location (tree) of the user authentication database on the server.
type: str
bind_dn:
description: The distinguished name for the Active Directory or LDAP server user
ID.
returned: changed
sample: user@foobar.local
type: str
ca_cert:
description: The name of an SSL certificate from a certificate authority.
returned: changed
sample: My-Trusted-CA-Bundle.crt
type: str
check_member_attr:
description: The user's member attribute in the remote LDAP or AD group.
returned: changed
sample: true
type: bool
client_cert:
description: The name of an SSL client certificate.
returned: changed
sample: MyCert.crt
type: str
client_key:
description: The name of an SSL client key.
returned: changed
sample: MyKey.key
type: str
fallback_to_local:
description: Specifies the system uses the Local authentication method as fallback
returned: changed
sample: true
type: bool
login_ldap_attr:
description: The LDAP directory attribute containing the local user name associated
with the selected directory entry.
returned: changed
sample: samaccountname
type: str
port:
description: The port the system uses for access to the remote LDAP server.
returned: changed
sample: 389
type: int
referrals:
description: Specifies whether automatic referral chasing should be enabled
returned: changed
sample: true
type: bool
remote_directory_tree:
description: File location (tree) of the user authentication database on the server.
returned: changed
sample: CN=Users,DC=FOOBAR,DC=LOCAL
type: str
scope:
description: The level of the remote Active Directory or LDAP directory searched
for user authentication.
returned: changed
sample: base
type: str
servers:
description: LDAP servers used by the system to obtain authentication information.
returned: changed
sample:
- 192.168.1.1
- 192.168.1.2
type: list
ssl:
description: Specifies whether the system uses an SSL port to communicate with the
LDAP server.
returned: changed
sample: start-tls
type: str
user_template:
description: The distinguished name of the user who is logging on.
returned: changed
sample: uid=%s,ou=people,dc=foobar,dc=local
type: str
validate_certs:
description: Indicates if the system checks an SSL peer.
returned: changed
sample: true
type: bool