W3cubDocs

/Ansible 2.9

bigip_gtm_monitor_bigip – Manages F5 BIG-IP GTM BIG-IP monitors

New in version 2.6.

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
aggregate_dynamic_ratios
string
    Choices:
  • 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 virtual servers.
When creating a new monitor, if this parameter is not specified, the default of none is used, meaning that the system does not use the scores in the load balancing operation.
When none, specifies that the monitor ignores the nodes and pool member scores.
When average-nodes, specifies that 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 that 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 that 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 that 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
    Choices:
  • no
  • yes
Specifies that the monitor allows more than one probe attempt per interval.
When yes, specifies that 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 that the monitor immediately marks an object down when it receives a down response.
When creating a new monitor, if this parameter is not provided, then 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, then 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, then the default value will be '*'.
name
string / required
Monitor name.
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, then the default value will be '*'. Note that if specifying an IP address, a value between 1 and 65535 must be specified
provider
dictionary
added in 2.5
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.
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.
ssh_keyfile
path
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.
You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE.
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
    Choices:
  • cli
  • 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
    Choices:
  • 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
    Choices:
  • present ←
  • absent
When present, ensures that 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, then 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 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 in 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


Status

Authors

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

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_gtm_monitor_bigip_module.html