f5networks.f5_modules.bigip_gtm_monitor_bigip module – Manages F5 BIG-IP GTM BIG-IP monitors
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_gtm_monitor_bigip
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages F5 BIG-IP GTM (now BIG-IP DNS) BIG-IP monitors. This monitor is used by GTM to monitor BIG-IPs themselves.
Parameters
Parameter |
Comments |
---|---|
Specifies how the system combines the module values to create the proportion (score) for the load balancing operation. The score represents the module’s estimated capacity for handing traffic. Averaged values are appropriate for downstream Web Accelerator or Application Security Manager (ASM) virtual servers. When creating a new monitor, if this parameter is not specified, the default of When When When When When Choices:
|
|
Specifies the monitor allows more than one probe attempt per interval. When When When creating a new monitor, if this parameter is not provided, the default value is Choices:
|
|
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. When creating a new monitor, if this parameter is not provided, the default value is |
|
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is ‘*’. |
|
Name of the monitor. |
|
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 will be ‘*’. Note that if specifying an IP address, you must use 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:
|
|
When When Choices:
|
|
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. When creating a new monitor, if this parameter is not provided, the default value is |
Notes
Note
Requires BIG-IP software version >= 12
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 BIG-IP Monitor
bigip_gtm_monitor_bigip:
state: present
ip: 10.10.10.10
name: my_monitor
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove BIG-IP Monitor
bigip_gtm_monitor_bigip:
state: absent
name: my_monitor
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Add BIG-IP monitor for all addresses, port 514
bigip_gtm_monitor_bigip:
port: 514
name: my_monitor
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The new aggregate of to the monitor. Returned: changed Sample: |
|
Whether to ignore the down response or not. Returned: changed Sample: |
|
The new interval at which to run the monitor check. Returned: changed Sample: |
|
The new IP of IP/port definition. Returned: changed Sample: |
|
New parent template of the monitor. Returned: changed Sample: |
|
The new timeout in which the remote system must respond to the monitor. Returned: changed Sample: |