Documentation

bigip_monitor_tcp - Manages F5 BIG-IP LTM tcp monitors.

New in version 1.4.

Synopsis

  • M
  • a
  • n
  • a
  • g
  • e
  • s
  • F
  • 5
  • B
  • I
  • G
  • I
  • P
  • L
  • T
  • M
  • t
  • c
  • p
  • m
  • o
  • n
  • i
  • t
  • o
  • r
  • s
  • v
  • i
  • a
  • i
  • C
  • o
  • n
  • t
  • r
  • o
  • l
  • S
  • O
  • A
  • P
  • A
  • P
  • I
  • .

Options

parameter required default choices comments
interval
no
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
no
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 '*'.
If this value is an IP address, and the type is tcp (the default), then a port number must be specified.
name
yes
Monitor name.

aliases: monitor
parent
no /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.
password
yes
The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable F5_PASSWORD is set.
port
no
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
This argument is not supported for TCP Echo types.
receive
no
The receive string for the monitor call.
send
no
The send string for the monitor call.
server
yes
The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
no 443
The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set.
time_until_up
no
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
no
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.
type
no tcp
  • tcp
  • tcp_echo
  • tcp_half_open
  • TTYPE_TCP
  • TTYPE_TCP_ECHO
  • TTYPE_TCP_HALF_OPEN
The template type of this monitor template.
Deprecated in 2.4. Use one of the bigip_monitor_tcp_echo or bigip_monitor_tcp_half_open modules instead.
user
yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable F5_USER is set.
validate_certs
(added in 2.0)
no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set.

Examples

- name: Create TCP Monitor
  bigip_monitor_tcp:
      state: "present"
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      name: "my_tcp_monitor"
      type: "tcp"
      send: "tcp string to send"
      receive: "tcp string to receive"
  delegate_to: localhost

- name: Remove TCP Monitor
  bigip_monitor_tcp:
      state: "absent"
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      name: "my_tcp_monitor"
  delegate_to: localhost

Return Values

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

name description returned type sample
parent
New parent template of the monitor.
changed string tcp
receive
The new receive string for this monitor.
changed string tcp string to receive
ip
The new IP of IP/port definition.
changed string 10.12.13.14
interval
The new interval in which to run the monitor check.
changed int 2
send
The new send string for this monitor.
changed string tcp string to send
time_until_up
The new time in which to mark a system as up after first successful response.
changed int 2
timeout
The new timeout in which the remote system must respond to the monitor.
changed int 10
port
The new port of IP/port definition.
changed string [email protected]


Notes

Note

  • Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
  • Requires BIG-IP software version >= 12

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.