f5networks.f5_modules.bigip_monitor_tcp_half_open module – Manages F5 BIG-IP LTM TCP half-open monitors
Note
This module is part of the f5networks.f5_modules collection (version 1.33.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_tcp_half_open.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages F5 BIG-IP LTM TCP half-open monitors.
Parameters
Parameter |
Comments |
|---|---|
The description of the monitor. |
|
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 |
|
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is ‘*’. If this value is an IP address, and the |
|
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: |
|
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 is ‘*’. If specifying an IP address, you must specify 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 amount of time in seconds after the first successful response before a node will be marked up. A value of |
|
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 the default value is 16. |
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 TCP half-open Monitor
bigip_monitor_tcp_half_open:
state: present
ip: 10.10.10.10
name: my_tcp_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove TCP half-open Monitor
bigip_monitor_tcp_half_open:
state: absent
name: my_tcp_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add half-open monitor for all addresses, port 514
bigip_monitor_tcp_half_open:
port: 514
name: my_tcp_monitor
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The description of the monitor. Returned: changed Sample: |
|
The new interval in 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 time in which to mark a system as up after first successful response. Returned: changed Sample: |
|
The new timeout in which the remote system must respond to the monitor. Returned: changed Sample: |