f5networks / f5networks.f5_modules / 1.28.0 / module / bigip_monitor_ldap Manages BIG-IP LDAP monitors | "added in version" 1.0.0 of f5networks.f5_modules" Authors: Tim Rupp (@caphrim007), Greg Crosby (@crosbygw)f5networks.f5_modules.bigip_monitor_ldap (1.28.0) — module
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections: - name: f5networks.f5_modules version: 1.28.0
Manages BIG-IP LDAP monitors.
- name: Create a LDAP monitor bigip_monitor_ldap: name: foo provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost
ip: description: - IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '*'. type: str base: description: - Specifies the location in the LDAP tree from which the monitor starts the health check. type: str name: description: - Monitor name. required: true type: str port: description: - 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. type: str debug: description: - Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. type: bool state: choices: - present - absent default: present description: - When C(present), ensures the monitor exists. - When C(absent), ensures the monitor is removed. type: str filter: description: - Specifies an LDAP key for which the monitor searches. type: str parent: default: /Common/ldap description: - The parent template of this monitor template. Once this value has been set, it cannot be changed. - By default, this value is the C(ldap) parent on the C(Common) partition. type: str timeout: description: - 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 C(timeout) and C(time_until_up) combine to control when a resource is set to up. type: int interval: description: - 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. type: int 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 security: choices: - none - ssl - tls description: - Specifies the secure protocol type for communication with the target. type: str partition: default: Common description: - Device partition to manage resources on. type: str description: description: - Specifies descriptive text that identifies the monitor. type: str up_interval: description: - Specifies the interval for the system to use to perform the health check when a resource is up. - When C(0), specifies the system uses the interval specified in C(interval) to check the health of the resource. - When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. type: int manual_resume: description: - Specifies whether the system automatically changes the status of a resource to B(enabled) at the next successful monitor check. - If you set this option to C(true), you must manually re-enable the resource before the system can use it for load balancing connections. - When C(true), specifies you must manually re-enable the resource after an unsuccessful monitor check. - When C(false), specifies the system automatically changes the status of a resource to B(enabled) at the next successful monitor check. type: bool time_until_up: description: - 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. type: int chase_referrals: description: - Upon receipt of an LDAP referral entry, specifies whether the target follows (or chases) that referral. type: bool target_password: description: - Specifies the password, if the monitored target requires authentication. type: str target_username: description: - Specifies the user name, if the monitored target requires authentication. type: str update_password: choices: - always - on_create default: always description: - C(always) will update passwords if the C(target_password) is specified. - C(on_create) will only set the password for newly created monitors. type: str mandatory_attributes: description: - Specifies whether the target must include attributes in its response to be considered up. type: bool
base: description: The new LDAP Base setting of the resource. returned: changed sample: base type: str chase_referrals: description: The new Chase Referrals setting of the resource. returned: changed sample: true type: bool debug: description: The new Debug setting of the resource. returned: changed sample: true type: bool description: description: The description of the monitor. returned: changed sample: Important_Monitor type: str filter: description: The new LDAP Filter setting of the resource. returned: changed sample: filter1 type: str interval: description: The new interval in which to run the monitor check. returned: changed sample: 2 type: int ip: description: The new IP of IP/port definition. returned: changed sample: 10.12.13.14 type: str mandatory_attributes: description: The new Mandatory Attributes setting of the resource. returned: changed sample: false type: bool manual_resume: description: The new Manual Resume setting of the resource. returned: changed sample: false type: bool parent: description: New parent template of the monitor. returned: changed sample: ldap type: str security: description: The new Security setting of the resource. returned: changed sample: ssl type: str time_until_up: description: The new time in which to mark a system as up after first successful response. returned: changed sample: 2 type: int timeout: description: The new timeout in which the remote system must respond to the monitor. returned: changed sample: 10 type: int