Try SpotterManages F5 BIG-IP GTM TCP half-open monitors
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manages F5 BIG-IP GTM (now BIG-IP DNS) TCP half-open monitors.
- name: Create TCP half-open Monitor
bigip_gtm_monitor_tcp_half_open:
state: present
ip: 10.10.10.10
name: my_monitor
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove TCP half-open Monitor
bigip_gtm_monitor_tcp_half_open:
state: absent
name: my_monitor
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Add half-open monitor for all addresses, port 514
bigip_gtm_monitor_tcp_half_open:
port: 514
name: my_monitor
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
ip:
description:
- IP address part of the IP/port definition. If this parameter is not provided when
creating a new monitor, the default value will be '*'.
type: str
name:
description:
- Monitor name.
required: true
type: str
port:
description:
- Port address part of the IP/port definition. If this parameter is not provided when
creating a new monitor, the default value will be '*'. Note that if using an IP
address, you must specify a value between 1 and 65535.
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the monitor exists.
- When C(absent), ensures the monitor is removed.
type: str
parent:
default: /Common/tcp_half_open
description:
- The parent template of this monitor template. Once this value has been set, it cannot
be changed. By default, this value is the C(tcp_half_open) parent on the C(Common)
partition.
type: str
timeout:
description:
- Specifies the number of seconds the target has in which to 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.
- When this value is set to 0 (zero), the system uses the interval from the parent
monitor.
- When creating a new monitor, if this parameter is not provided, the default value
will be C(120).
type: int
interval:
description:
- Specifies, in seconds, the frequency at which the system issues the monitor check
when either the resource is down or the status of the resource is unknown.
- When creating a new monitor, if this parameter is not provided, then the default
value will be C(30). This value B(must) be less than the C(timeout) value.
type: int
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- 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 C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- 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 C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
transparent:
description:
- 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 C(ip)-C(port) combination specified in the monitor).
- 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 C(false).
type: bool
probe_timeout:
description:
- 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 C(5).
type: int
probe_attempts:
description:
- Specifies the number of times the system attempts to probe the host server, after
which the system considers the host server down or unavailable.
- When creating a new monitor, if this parameter is not provided, the default value
will be C(3).
type: int
probe_interval:
description:
- Specifies the number of seconds the big3d process waits before sending out a subsequent
probe attempt when a probe fails and multiple probe attempts have been requested.
- When creating a new monitor, if this parameter is not provided, then the default
value will be C(1).
type: int
ignore_down_response:
description:
- Specifies that the monitor allows more than one probe attempt per interval.
- When C(true), specifies the monitor ignores down responses for the duration of the
monitor timeout. Once the monitor timeout is reached without the system receiving
an up response, the system marks the object down.
- When C(false), specifies the monitor immediately marks an object down when it receives
a down response.
- When creating a new monitor, if this parameter is not provided, then the default
value will be C(false).
type: bool
interval:
description: The new interval in which to run the monitor check.
returned: changed
sample: 2
type: int
ip:
description: The new IP of IP/port definition.
returned: changed
sample: 10.12.13.14
type: str
parent:
description: New parent template of the monitor.
returned: changed
sample: tcp_half_open
type: str
probe_attempts:
description: The new number of attempts the system will make in checking the monitor
probe.
returned: changed
sample: 10
type: int
probe_interval:
description: The new interval in which the system will check the monitor probe.
returned: changed
sample: 10
type: int
probe_timeout:
description: The new timeout in which the system will timeout the monitor probe.
returned: changed
sample: 10
type: int
timeout:
description: The new timeout in which the remote system must respond to the monitor.
returned: changed
sample: 10
type: int