ANSIBLE.BIGIP_MONITOR_TCP(3)    ANSIBLE MODULES   ANSIBLE.BIGIP_MONITOR_TCP(3)



NAME
       bigip_monitor_tcp - Manages F5 BIG-IP LTM tcp monitors

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

OPTIONS
       interval
              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. (default: none)

       ip     IP address part of the ipport definition. The default API
              setting is "0.0.0.0". (default: none)

       name   Monitor name(required)

       parent The parent template of this monitor template Choices:
              tcp,tcp_echo,tcp_half_open. (default: tcp)

       parent_partition
              Partition for the parent monitor (default: Common)

       partition
              Partition for the monitor (default: Common)

       password
              BIG-IP password(required)

       port   port address part op the ipport definition. Tyhe default API
              setting is 0. (default: none)

       receive
              The receive string for the monitor call(required) (default:
              none)

       send   The send string for the monitor call(required) (default: none)

       server BIG-IP host(required)

       state  Monitor state Choices: present,absent. (default: present)

       time_until_up
              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. (default: none)

       timeout
              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. (default: none)

       type   The template type of this monitor template Choices:
              TTYPE_TCP,TTYPE_TCP_ECHO,TTYPE_TCP_HALF_OPEN. (default: tcp)

       user   BIG-IP username(required).

NOTES
       Requires BIG-IP software version >= 11

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

       Best run as a local_action in your playbook

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

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




AUTHOR
       Serge van Ginderachter

SEE ALSO
       ansible(1), http://ansible.github.com/modules.html#bigip-monitor-tcp



1.4.5                             2014-02-12      ANSIBLE.BIGIP_MONITOR_TCP(3)
