f5networks.f5_modules.bigip_gtm_monitor_bigip – Manages F5 BIG-IP GTM BIG-IP monitors

From Get docs
Ansible/docs/2.11/collections/f5networks/f5 modules/bigip gtm monitor bigip module


f5networks.f5_modules.bigip_gtm_monitor_bigip – Manages F5 BIG-IP GTM BIG-IP monitors

Note

This plugin is part of the f5networks.f5_modules collection (version 1.7.1).

To install it use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_gtm_monitor_bigip.


New in version 1.0.0: of f5networks.f5_modules


Synopsis

  • Manages F5 BIG-IP GTM (now BIG-IP DNS) BIG-IP monitors. This monitor is used by GTM to monitor BIG-IPs themselves.

Parameters

Parameter Choices/Defaults Comments

aggregate_dynamic_ratios

string

  • none
  • average-nodes
  • sum-nodes
  • average-members
  • sum-members

Specifies how the system combines the module values to create the proportion (score) for the load balancing operation.

The score represents the module's estimated capacity for handing traffic.

Averaged values are appropriate for downstream Web Accelerator or Application Security Manager (ASM) virtual servers.

When creating a new monitor, if this parameter is not specified, the default of none is used, meaning the system does not use the scores in the load balancing operation.

When none, specifies the monitor ignores the nodes and pool member scores.

When average-nodes, specifies the system averages the dynamic ratios on the nodes associated with the monitor's target virtual servers and returns that average as the virtual servers' score.

When sum-nodes, specifies the system adds together the scores of the nodes associated with the monitor's target virtual servers and uses that value in the load balancing operation.

When average-members, specifies the system averages the dynamic ratios on the pool members associated with the monitor's target virtual servers and returns that average as the virtual servers' score.

When sum-members, specifies the system adds together the scores of the pool members associated with the monitor's target virtual servers and uses that value in the load balancing operation.

ignore_down_response

boolean

  • no
  • yes

Specifies the monitor allows more than one probe attempt per interval.

When yes, specifies the monitor ignores down responses for the duration of the monitor timeout. Once the monitor timeout is reached without the system receiving an up response, the system marks the object down.

When no, specifies the monitor immediately marks an object down when it receives a down response.

When creating a new monitor, if this parameter is not provided, the default value will be no.

interval

integer

Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.

When creating a new monitor, if this parameter is not provided, the default value will be 30. This value must be less than the timeout value.

ip

string

IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '*'.

name

string / required

Name of the monitor.

parent

string

Default:

"/Common/bigip"

The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the bigip parent on the Common partition.

partition

string

Default:

"Common"

Device partition to manage resources on.

port

string

Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '*'. Note that if specifying an IP address, you must use a value between 1 and 65535.

provider

dictionary

added in 1.0.0 of f5networks.f5_modules

A dict object containing connection details.

auth_provider

string

Configures the auth provider for to obtain authentication tokens from the remote device.

This option is really used when working with BIG-IQ devices.

no_f5_teem

boolean

  • no
  • yes

If yes, TEEM telemetry data is not sent to F5.

You may omit this option by setting the environment variable F5_TEEM.

password

string / required

The password for the user account used to connect to the BIG-IP.

You may omit this option by setting the environment variable F5_PASSWORD.


aliases: pass, pwd

server

string / required

The BIG-IP host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

integer

Default:

443

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

timeout

integer

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.

transport

string

  • rest

Configures the transport connection to use when connecting to the remote device.

user

string / required

The username to connect to the BIG-IP with. This user must have administrative privileges on the device.

You may omit this option by setting the environment variable F5_USER.

validate_certs

boolean

  • no
  • yes

If 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 F5_VALIDATE_CERTS.

state

string

  • present

  • absent

When present, ensures the monitor exists.

When absent, ensures the monitor is removed.

timeout

integer

Specifies the number of seconds the target has in which to 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.

When this value is set to 0 (zero), the system uses the interval from the parent monitor.

When creating a new monitor, if this parameter is not provided, the default value will be 90.



Notes

Note

  • Requires BIG-IP software version >= 12
  • For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
  • Requires BIG-IP software version >= 12.
  • The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.


Examples

- name: Create BIG-IP Monitor
  bigip_gtm_monitor_bigip:
    state: present
    ip: 10.10.10.10
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove BIG-IP Monitor
  bigip_gtm_monitor_bigip:
    state: absent
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add BIG-IP monitor for all addresses, port 514
  bigip_gtm_monitor_bigip:
    port: 514
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Return Values

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

Key Returned Description

aggregate_dynamic_ratios

string

changed

The new aggregate of to the monitor.


Sample:

sum-members

ignore_down_response

boolean

changed

Whether to ignore the down response or not.


Sample:

True

interval

integer

changed

The new interval at which to run the monitor check.


Sample:

2

ip

string

changed

The new IP of IP/port definition.


Sample:

10.12.13.14

parent

string

changed

New parent template of the monitor.


Sample:

bigip

timeout

integer

changed

The new timeout in which the remote system must respond to the monitor.


Sample:

10




Authors

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_gtm_monitor_bigip_module.html