f5networks.f5_modules.bigip_monitor_tcp (1.28.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
ip:
    aliases:
    - alias_address
    description:
    - 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 C(type) is C(tcp) (the default), then a
      C(port) number must be specified.
    - In BIG IP Management UI, this field is B(Alias Address).
    type: str

name:
    description:
    - Monitor name.
    required: true
    type: str

port:
    aliases:
    - alias_service_port
    description:
    - 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 B(Alias Service Port).
    type: str

send:
    description:
    - The Send string for the monitor call.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(present), ensures the monitor exists.
    - When C(absent), ensures the monitor is removed.
    type: str

parent:
    default: /Common/tcp
    description:
    - The parent template of this monitor template. Once this value has been set, it cannot
      be changed. By default, this value is the C(tcp) parent on the C(Common) partition.
    type: str

receive:
    description:
    - The Receive string for the monitor call.
    type: str

timeout:
    description:
    - 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.
    type: int

interval:
    description:
    - 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 B(must) be less than the C(timeout) value.
    type: int

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP or the BIG-IQ.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - 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.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
          privileges on the device.
        - You may omit this option by setting the environment variable C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(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 C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules

partition:
    default: Common
    description:
    - Device partition to manage resources on.
    type: str

description:
    description:
    - The description of the monitor.
    type: str

time_until_up:
    description:
    - Specifies the amount of time in seconds after the first successful response before
      a node will be marked up. A value of C(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 C(0).
    type: int

receive_disable:
    description:
    - The Receive Disable string for the monitor call. This setting works like C(receive),
      except the system marks the node or pool member disabled when its response matches
      the C(receive_disable) string but not C(receive). To use this setting, you must
      specify both C(receive_disable) and C(receive).
    type: str

Outputs

description:
  description: The description of the monitor.
  returned: changed
  sample: Important Monitor
  type: str
interval:
  description: The new interval at which to run the monitor check.
  returned: changed
  sample: 2
  type: int
ip:
  description: The new IP of IP/port definition.
  returned: changed
  sample: 10.12.13.14
  type: str
parent:
  description: New parent template of the monitor.
  returned: changed
  sample: tcp
  type: str
port:
  description: The new port of IP/port definition.
  returned: changed
  sample: admin@root.local
  type: str
receive:
  description: The new Receive string for this monitor.
  returned: changed
  sample: tcp string to receive
  type: str
receive_disable:
  description: The new Receive Disable string for this monitor.
  returned: changed
  sample: tcp string to receive
  type: str
send:
  description: The new Send string for this monitor.
  returned: changed
  sample: tcp string to send
  type: str
time_until_up:
  description: The new time in which to mark a system as up after first successful
    response.
  returned: changed
  sample: 2
  type: int
timeout:
  description: The new timeout in which the remote system must respond to the monitor.
  returned: changed
  sample: 10
  type: int