f5networks.f5_modules.bigip_gtm_monitor_http – Manages F5 BIG-IP GTM HTTP monitors
Note
This plugin is part of the f5networks.f5_modules collection (version 1.13.0).
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_http
.
New in version 1.0.0: of f5networks.f5_modules
Parameters
Parameter |
Comments |
---|---|
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 will be Choices:
|
|
The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value will be 30. This value must be less than the |
|
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be ‘*’. If this value is an IP address, then a |
|
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: “/Common/http” |
|
Device partition to manage resources on. Default: “Common” |
|
Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be ‘*’. If specifying an IP address, you must use a value between 1 and 65535. |
|
Specifies the number of seconds after which the system times out the probe request to the system. When creating a new monitor, if this parameter is not provided, the default value will be |
|
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. You may omit this option by setting the environment variable |
|
The BIG-IP 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: 443 |
|
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 with. 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:
|
|
The receive string for the monitor call. |
|
Instructs the system to mark the target resource down when the test is successful. This setting is useful, for example, if the content on your web site home page is dynamic and changes frequently, you may want to set up a reverse ECV service check that looks for the string Error. A match for this string means the web server was down. To use this option, you must specify values for Choices:
|
|
The send string for the monitor call. When creating a new monitor, if this parameter is not provided, the default of |
|
When When Choices:
|
|
Specifies the password, if the monitored target requires authentication. |
|
Specifies the user name, if the monitored target requires authentication. |
|
The number of seconds in which the node or service must 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. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then default value will be 120. |
|
Specifies whether the monitor operates in transparent mode. A monitor in transparent mode directs traffic through the associated pool members or nodes (usually a router or firewall) to the aliased destination (that is, it probes the If the monitor cannot successfully reach the aliased destination, the pool member or node through which the monitor traffic was sent is marked down. When creating a new monitor, if this parameter is not provided, the default value will be Choices:
|
|
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 GTM HTTP monitor
bigip_gtm_monitor_http:
name: my_monitor
ip: 1.1.1.1
port: 80
send: my send string
receive: my receive string
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove HTTP Monitor
bigip_gtm_monitor_http:
name: my_monitor
state: absent
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Add HTTP monitor for all addresses, port 514
bigip_gtm_monitor_http:
name: my_monitor
port: 514
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 |
---|---|
Whether to ignore the down response or not. Returned: changed Sample: true |
|
The new interval in which to run the monitor check. Returned: changed Sample: 2 |
|
The new IP of IP/port definition. Returned: changed Sample: “10.12.13.14” |
|
New parent template of the monitor. Returned: changed Sample: “http” |
|
The new port the monitor checks the resource on. Returned: changed Sample: 8080 |
|
The new timeout in which the system will timeout the monitor probe. Returned: changed Sample: 10 |
|
The new receive string for this monitor. Returned: changed Sample: “tcp string to receive” |
|
The new value for whether the monitor operates in reverse mode. Returned: changed Sample: false |
|
The new send string for this monitor. Returned: changed Sample: “tcp string to send” |
|
The new timeout in which the remote system must respond to the monitor. Returned: changed Sample: 10 |
|
The new value for whether the monitor operates in transparent mode. Returned: changed Sample: false |
Authors
Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)