f5networks.f5_modules.bigip_monitor_tcp – Manages F5 BIG-IP LTM TCP monitors

Note

This plugin is part of the f5networks.f5_modules collection (version 1.12.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.

New in version 1.0.0: of f5networks.f5_modules

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Manages F5 BIG-IP LTM TCP monitors via iControl REST API.

Parameters

Parameter		Choices/Defaults	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 ''. If this value is an IP address, and the `type` is `tcp` (the default), then a `port` number must be specified. In BIG IP Management UI, this field is Alias Address*. aliases: alias_address
name string / required			Monitor name.
parent string		Default: "/Common/tcp"	The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `tcp` 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. This argument is not supported for TCP Echo types. In BIG IP Management UI, this field is Alias Service Port*. aliases: alias_service_port
provider dictionary added in 1.0.0 of f5networks.f5_modules			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	Choices: no ← yes	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. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd
	server string / required		The BIG-IP 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	Choices: rest ←	Configures the transport connection to use when connecting to the remote device.
	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	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 string			The Receive string for the monitor call.
receive_disable string			The Receive Disable string for the monitor call. 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`.
send string			The Send string for the monitor call.
state string		Choices: present ← absent	When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed.
time_until_up integer			Specifies the amount of time in seconds after the first successful response before a node will be 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 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, 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 Monitor
  bigip_monitor_tcp:
    state: present
    name: my_tcp_monitor
    send: tcp string to send
    receive: tcp string to receive
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove TCP Monitor
  bigip_monitor_tcp:
    state: absent
    name: my_tcp_monitor
    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	Returned	Description
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: tcp
port string	changed	The new port of IP/port definition. Sample: [email protected]
receive string	changed	The new Receive string for this monitor. Sample: tcp string to receive
receive_disable string	changed	The new Receive Disable string for this monitor. Sample: tcp string to receive
send string	changed	The new Send string for this monitor. Sample: tcp string to send
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

Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_monitor_tcp_module.html