f5networks.f5_modules.bigip_monitor_ldap module – Manages BIG-IP LDAP monitors
Note
This module is part of the f5networks.f5_modules collection (version 1.32.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_monitor_ldap
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages BIG-IP LDAP monitors.
Parameters
Parameter |
Comments |
---|---|
Specifies the location in the LDAP tree from which the monitor starts the health check. |
|
Upon receipt of an LDAP referral entry, specifies whether the target follows (or chases) that referral. Choices:
|
|
Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. Choices:
|
|
Specifies descriptive text that identifies the monitor. |
|
Specifies an LDAP key for which the monitor searches. |
|
Specifies the frequency, in seconds, at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. |
|
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is ‘*’. |
|
Specifies whether the target must include attributes in its response to be considered up. Choices:
|
|
Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to When When Choices:
|
|
Monitor name. |
|
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the Default: |
|
Device partition to manage resources on. Default: |
|
Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is ‘*’. Note that if specifying an IP address, you must specify a value between 1 and 65535. |
|
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 the secure protocol type for communication with the target. Choices:
|
|
When When Choices:
|
|
Specifies the password, if the monitored target requires authentication. |
|
Specifies the user name, if the monitored target requires authentication. |
|
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to ‘up’. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked ‘up’. A value of 0 means the resource is marked up immediately upon receipt of the first correct response. |
|
Specifies the number of seconds the target has in which to respond to the monitor request. If the target responds within the set time period, it is considered ‘up’. If the target does not respond within the set time period, it is considered ‘down’. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that |
|
Specifies the interval for the system to use to perform the health check when a resource is up. When When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. |
|
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 a LDAP monitor
bigip_monitor_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 new LDAP Base setting of the resource. Returned: changed Sample: |
|
The new Chase Referrals setting of the resource. Returned: changed Sample: |
|
The new Debug setting of the resource. Returned: changed Sample: |
|
The description of the monitor. Returned: changed Sample: |
|
The new LDAP Filter setting of the resource. Returned: changed Sample: |
|
The new interval in which to run the monitor check. Returned: changed Sample: |
|
The new IP of IP/port definition. Returned: changed Sample: |
|
The new Mandatory Attributes setting of the resource. Returned: changed Sample: |
|
The new Manual Resume setting of the resource. Returned: changed Sample: |
|
New parent template of the monitor. Returned: changed Sample: |
|
The new Security setting of the resource. Returned: changed Sample: |
|
The new time in which to mark a system as up after first successful response. Returned: changed Sample: |
|
The new timeout in which the remote system must respond to the monitor. Returned: changed Sample: |