You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

f5networks.f5_modules.bigip_monitor_http module – Manages F5 BIG-IP LTM HTTP monitors

Note

This module is part of the f5networks.f5_modules collection (version 1.25.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_monitor_http.

New in f5networks.f5_modules 1.0.0

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis 

Manages F5 BIG-IP LTM HTTP monitors.

Parameters 

Parameter	Comments
description string	The description of the monitor.
interval integer	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 is 5. This value must be less than the `timeout` value.
ip string	IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is ‘*’.
name string / required	Monitor name.
parent string	The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `http` parent on the `Common` partition. Default: `"/Common/http"`
partition string	Device partition to manage resources on. Default: `"Common"`
port string	Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is ‘*’. If specifying an IP address, you must specify a value between 1 and 65535.
provider dictionary added in f5networks.f5_modules 1.0.0	A dict object containing connection details.
auth_provider string	Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
no_f5_teem boolean	If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. Choices: `false` ← (default) `true`
password aliases: pass, pwd string / required	The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`.
server string / required	The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
server_port integer	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. Default: `443`
timeout integer	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.
transport string	Configures the transport connection to use when connecting to the remote device. Choices: `"rest"` ← (default)
user string / required	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 `F5_USER`.
validate_certs boolean	If `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 `F5_VALIDATE_CERTS`. Choices: `false` `true` ← (default)
receive string	The Receive string for the monitor call.
receive_disable string	This setting works like `receive`, except the system marks the node or pool member disabled when its response matches the `receive_disable` string but not `receive`. To use this setting, you must specify both `receive_disable` and `receive`.
reverse boolean	Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful receive string match marks the monitored object down instead of up. You can use the this mode only if you configure the `receive` option. This parameter is not compatible with the `time_until_up` parameter. If `time_until_up` is specified, it must be `0`. Or, if it already exists, it must be `0`. Choices: `false` `true`
send string	The Send string for the monitor call. When creating a new monitor, if this value is not provided, the default `GET /\r\n` is used.
state string	When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. Choices: `"present"` ← (default) `"absent"`
target_password string	Specifies the password, if the monitored target requires authentication.
target_username string	Specifies the user name, if the monitored target requires authentication.
time_until_up integer	Specifies the amount of time in seconds after the first successful response before a node is marked up. A value of 0 causes a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, the default value is 0.
timeout integer	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, the default value is 16.
up_interval integer added in f5networks.f5_modules 1.22.0	Specifies the interval for the system to use to perform the health check when a resource is up. When `0`, specifies the system uses the interval specified in `interval` to check the health of the resource. When any other number, enables you to specify a different interval when checking the health of a resource that is up.

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 HTTP Monitor
  bigip_monitor_http:
    state: present
    ip: 10.10.10.10
    name: my_http_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove HTTP Monitor
  bigip_monitor_http:
    state: absent
    name: my_http_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Include a username and password in the HTTP monitor
  bigip_monitor_http:
    state: absent
    name: my_http_monitor
    target_username: monitor_user
    target_password: monitor_pass
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
description string	The description of the monitor. Returned: changed Sample: `"Important_Monitor"`
interval integer	The new interval at which to run the monitor check. Returned: changed Sample: `2`
ip string	The new IP of IP/port definition. Returned: changed Sample: `"10.12.13.14"`
parent string	New parent template of the monitor. Returned: changed Sample: `"http"`
reverse boolean	Whether the monitor operates in reverse mode. Returned: changed Sample: `true`
time_until_up integer	The new time in which to mark a system as up after first successful response. Returned: changed Sample: `2`
timeout integer	The new timeout in which the remote system must respond to the monitor. Returned: changed Sample: `10`
up_interval integer	Interval for the system to use to perform the health check when a resource is up. Returned: changed Sample: `0`

Authors

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Collection links

Issue Tracker Homepage Repository (Sources)

f5networks.f5_modules.bigip_monitor_http module – Manages F5 BIG-IP LTM HTTP monitors

Synopsis

Parameters

Notes

Examples

Return Values