W3cubDocs

/Ansible

bigip_monitor_tcp - Manages F5 BIG-IP LTM tcp monitors

New in version 1.4.

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
The password for the user account used to connect to the BIG-IP.
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
The BIG-IP host.
server_port
(added in 2.2)
 no 443
The BIG-IP server port.
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
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
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.

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: Create TCP half open 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: "http 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"

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, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/bigip_monitor_tcp_module.html