bigip_monitor_http – Manages F5 BIG-IP LTM http monitors

New in version 2.5.

Synopsis

  • Manages F5 BIG-IP LTM http monitors.

Requirements

The below requirements are needed on the host that executes this module.

  • f5-sdk >= 3.0.16

Parameters

Parameter Choices/Defaults Comments
description
-
added in 2.7
The description of the monitor.
interval
-
The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 5. This value must be less than the timeout value.
ip
-
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'.
name
- / required
Monitor name.
parent
-
Default:
"/Common/http"
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.
partition
-
added in 2.5
Default:
"Common"
Device partition to manage resources on.
password
- / 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.

aliases: pass, pwd
port
-
Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. Note that if specifying an IP address, a value between 1 and 65535 must be specified.
provider
-
added in 2.5
Default:
null
A dict object containing connection details.
password
- / 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.

aliases: pass, pwd
server
- / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_port
-
Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
ssh_keyfile
-
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.
You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE.
timeout
-
Default:
10
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
- / required
    Choices:
  • rest
  • cli ←
Configures the transport connection to use when connecting to the remote device.
user
- / 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
    Choices:
  • no
  • yes ←
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.
receive
-
The receive string for the monitor call.
receive_disable
-
This setting works like receive, except that 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.
send
-
The send string for the monitor call. When creating a new monitor, if this value is not provided, the default GET /\r\n will be used.
server
- / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_port
-
added in 2.2
Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
state
-
added in 2.5
    Choices:
  • present ←
  • absent
When present, ensures that the monitor exists.
When absent, ensures the monitor is removed.
target_password
-
Specifies the password, if the monitored target requires authentication.
target_username
-
Specifies the user name, if the monitored target requires authentication.
time_until_up
-
Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause 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, then the default value will be 0.
timeout
-
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 number to any number you want, 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 the default value will be 16.
user
- / 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
added in 2.0
    Choices:
  • no
  • yes ←
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.

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 the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
  • 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 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
    server: lb.mydomain.com
    user: admin
    password: secret
    name: my_http_monitor
  delegate_to: localhost

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

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

Return Values

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

Key Returned Description
description
string
changed
The description of the monitor.

Sample:
Important_Monitor
interval
integer
changed
The new interval in which to run the monitor check.

Sample:
2
ip
string
changed
The new IP of IP/port definition.

Sample:
10.12.13.14
parent
string
changed
New parent template of the monitor.

Sample:
http
time_until_up
integer
changed
The new time in which to mark a system as up after first successful response.

Sample:
2
timeout
integer
changed
The new timeout in which the remote system must respond to the monitor.

Sample:
10


Status

Authors

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

Hint

If you notice any issues in this documentation you can edit this document to improve it.