bigip_monitor_tcp - Manages F5 BIG-IP LTM tcp monitors

New in version 1.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
This is an Extras Module

Synopsis

Manages F5 BIG-IP LTM tcp monitors via iControl SOAP API

Requirements (on host that executes module)

bigsuds

Options

parameter	required	default	choices	comments
interval	no	none		The interval specifying how frequently the monitor instance of this template will run. By default, this interval is used for up and down states. The default API setting is 5.
ip	no	none		IP address part of the ipport definition. The default API setting is "0.0.0.0".
name	yes			Monitor name aliases: monitor
parent	no	tcp	tcp tcp_echo tcp_half_open	The parent template of this monitor template
parent_partition	no	Common		Partition for the parent monitor
partition	no	Common		Partition for the monitor
password	yes			BIG-IP password
port	no	none		port address part op the ipport definition. The default API setting is 0.
receive	yes	none		The receive string for the monitor call
send	yes	none		The send string for the monitor call
server	yes			BIG-IP host
state	no	present	present absent	Monitor state
time_until_up	no	none		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. The default API setting is 0.
timeout	no	none		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. The default API setting is 16.
type	no	tcp	TTYPE_TCP TTYPE_TCP_ECHO TTYPE_TCP_HALF_OPEN	The template type of this monitor template
user	yes			BIG-IP username
validate_certs (added in 2.0)	no	yes	yes no	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites. Prior to 2.0, this module would always validate on python >= 2.7.9 and never validate on python <= 2.7.8

Examples

- name: BIGIP F5 | Create TCP Monitor
  local_action:
    module:             bigip_monitor_tcp
    state:              present
    server:             "{{ f5server }}"
    user:               "{{ f5user }}"
    password:           "{{ f5password }}"
    name:               "{{ item.monitorname }}"
    type:               tcp
    send:               "{{ item.send }}"
    receive:            "{{ item.receive }}"
  with_items: f5monitors-tcp
- name: BIGIP F5 | Create TCP half open Monitor
  local_action:
    module:             bigip_monitor_tcp
    state:              present
    server:             "{{ f5server }}"
    user:               "{{ f5user }}"
    password:           "{{ f5password }}"
    name:               "{{ item.monitorname }}"
    type:               tcp
    send:               "{{ item.send }}"
    receive:            "{{ item.receive }}"
  with_items: f5monitors-halftcp
- name: BIGIP F5 | Remove TCP Monitor
  local_action:
    module:             bigip_monitor_tcp
    state:              absent
    server:             "{{ f5server }}"
    user:               "{{ f5user }}"
    password:           "{{ f5password }}"
    name:               "{{ monitorname }}"
  with_flattened:
  - f5monitors-tcp
  - f5monitors-halftcp

Notes

Note

Requires BIG-IP software version >= 11

Note

F5 developed module ‘bigsuds’ required (see http://devcentral.f5.com)

Note

Best run as a local_action in your playbook

Note

Monitor API documentation: https://devcentral.f5.com/wiki/iControl.LocalLB__Monitor.ashx

This is an Extras Module

For more information on what this means please read Extras Modules

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