bigip_monitor_https – Manages F5 BIG-IP LTM HTTPS monitors¶
New in version 1.0.0.
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments | |
|---|---|---|---|---|
|
cipher_list
string
added in 1.3.0 |
Specifies the list of ciphers for this monitor.
The items in the cipher list are separated with a colon
:. |
|||
|
description
string
|
The description of the monitor.
|
|||
|
interval
integer
|
The interval specifying how frequently the monitor instance of this template runs. 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
|
Default: "/Common/https"
|
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the
https parent on the Common partition. |
||
|
partition
string
|
Default: "Common"
|
Device partition to manage resources on.
|
||
|
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 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. |
||
|
password
string
/ required
|
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
F5_PASSWORD.aliases: pass, pwd |
|||
|
server
string
/ required
|
The BIG-IP host or the BIG-IQ host.
You may omit this option by setting the environment variable
F5_SERVER. |
|||
|
server_port
integer
|
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT. |
||
|
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.
|
||
|
user
string
/ required
|
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
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. |
||
|
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
added in 1.12.0 |
|
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. |
||
|
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. |
|||
|
ssl_profile
string
|
Specifies the SSL profile to use for the HTTPS monitor.
Defining SSL profiles enables refined customization of the SSL attributes for an HTTPS monitor.
This parameter is only supported on BIG-IP versions 13.x and later.
|
|||
|
state
string
|
|
When
present, ensures the monitor exists.When
absent, ensures the monitor is removed. |
||
|
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, then 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
|
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 HTTPS Monitor
bigip_monitor_https:
name: my_http_monitor
state: present
ip: 10.10.10.10
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove HTTPS Monitor
bigip_monitor_https:
name: my_http_monitor
state: absent
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Return Values¶
The following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
cipher_list
string
|
changed |
The new value for the cipher list.
Sample:
+3DES:+kEDH
|
|
description
string
|
changed |
The description of the monitor.
Sample:
Important Monitor
|
|
interval
integer
|
changed |
The new interval at 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:
https
|
|
reverse
boolean
|
changed |
Whether the monitor operates in reverse mode.
Sample:
True
|
|
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
|
|
up_interval
integer
|
changed |
Interval for the system to use to perform the health check when a resource is up.
|