Docs4dev
Docs
ansible / latest / collections / f5networks / f5_modules / bigip_monitor_icmp_module.html

f5networks.f5_modules.bigip_monitor_icmp – Manages F5 BIG-IP LTM ICMP monitors

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in version 1.1.0: of f5networks.f5_modules

Synopsis

  • Manages ICMP monitors on a BIG-IP.

Parameters

Parameter Choices/Defaults Comments
adaptive
boolean
    Choices:
  • no
  • yes
Specifies whether adaptive response time monitoring is enabled for this monitor.
When yes, the monitor determines the state of a service based on how divergent from the mean latency a monitor probe for that service is allowed to be. Also, values for the allowed_divergence, adaptive_limit, and and sampling_timespan will be enforced.
When disabled, the monitor determines the state of a service based on the interval, up_interval, time_until_up, and timeout monitor settings.
adaptive_limit
integer
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of allowed_divergence setting, for a probe to be considered successful.
This value applies regardless of the value of the allowed_divergence setting.
While this value can be configured when adaptive is no, it will not take effect on the system until adaptive is yes.
allowed_divergence_type
string
    Choices:
  • relative
  • absolute
When specifying a new monitor, if adaptive is yes, the default is relative.
When absolute, the number of milliseconds the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed. In typical cases, if the monitor detects three probes in a row that miss the latency value you set, the pool member or node is marked down.
When relative, the percentage of deviation the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed.
allowed_divergence_value
integer
When specifying a new monitor, if adaptive is yes, and type is relative, the default is 25 percent.
app_service
string
The iApp service to be associated with this profile. When no service is specified, the default is None.
description
string
The description of the monitor.
interval
integer
Specifies the frequency, in seconds, at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.
ip
string
Specifies the IP address of the resource that is the destination of this monitor.
When set to *, the device performs a health check on the IP address of the node.
When set to an <IP> the device performs a health check on that IP address and marks the associated node up or down as a result of the response. This option is set by the device by default when not defined during monitor creation.
When set to an <IP> and transparent is yes, the device performs a health check on that IP address, routes the check through the associated node IP address, and marks the associated node IP address up or down accordingly.
manual_resume
boolean
    Choices:
  • no
  • yes
Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check.
If you set this option to yes, you must manually re-enable the resource before the system can use it for load balancing connections.
When yes, specifies you must manually re-enable the resource after an unsuccessful monitor check.
When no, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check.
name
string / required
Specifies the name of the monitor.
parent
string
The parent template of this monitor template. Once this value has been set, it cannot be changed.
When creating a new monitor, if this parameter is not specified, the default is the system-supplied icmp monitor.
partition
string
Default:
"Common"
Device partition to manage resources on.
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
    Choices:
  • no ←
  • yes
If yes, TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TELEMETRY_OFF.
Previously used variable F5_TEEM is deprecated as its name was confusing.
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
    Choices:
  • 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.
sampling_timespan
integer
Specifies the length, in seconds, of the probe history window the system uses to calculate the mean latency and standard deviation of a monitor probe.
While this value can be configured when adaptive is no, it will not take effect on the system until adaptive is yes.
state
string
    Choices:
  • present ←
  • absent
When present, ensures that the monitor exists.
When absent, ensures the monitor is removed.
time_until_up
integer
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to 'up'.
During the interval, all responses from the resource must be correct.
When the interval expires, the resource is marked 'up'.
A value of 0 means the resource is marked up immediately upon receipt of the first correct response.
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.
Note that timeout and time_until_up combine to control when a resource is set to up.
transparent
boolean
    Choices:
  • no
  • yes
Specifies whether the monitor operates in transparent mode.
A monitor in transparent mode directs traffic through the associated pool members or nodes (usually a router or firewall) to the aliased destination (that is, it probes the ip-port combination specified in the monitor).
If the monitor cannot successfully reach the aliased destination, the pool member or node through which the monitor traffic was sent is marked down.
When creating a new monitor, if this parameter is not provided, the default value will be whatever is provided by the parent.
up_interval
integer
Specifies the interval for the system to use to perform the health check when a resource is up.
When 0, specifies the system uses the interval specified in interval to check the health of the resource.
When any other number, enables you to specify a different interval to use when checking the health of a resource that is up.

Notes

Note

  • 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 an ICMP monitor
  bigip_monitor_icmp:
    name: icmp1
    adaptive: no
    interval: 1
    time_until_up: 0
    timeout: 3
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update an ICMP monitor
  bigip_monitor_icmp:
    name: icmp1
    manual_resume: yes
    interval: 5
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove an ICMP monitor
  bigip_monitor_icmp:
    name: icmp1
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Return Values

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

Key Returned Description
adaptive
boolean
changed
Whether adaptive is enabled or not.

Sample:
True
adaptive_limit
integer
changed
Absolute number of milliseconds that may not be exceeded by a monitor probe.

Sample:
200
allowed_divergence_type
string
changed
Type of divergence used for adaptive response time monitoring.

Sample:
absolute
allowed_divergence_value
integer
changed
Value of the type of divergence used for adaptive response time monitoring.
May be percent or ms depending on whether relative or absolute.

Sample:
25
app_service
string
changed
The iApp service associated with this monitor.

Sample:
/Common/good_service.app/good_service
description
string
changed
The description of the monitor.

Sample:
Important Monitor
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:
gateway-icmp
port
string
changed
Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated.

Sample:
80
sampling_timespan
integer
changed
Absolute number of milliseconds that may not be exceeded by a monitor probe.

Sample:
200
time_until_up
integer
changed
The new time in which to mark a system as up after first successful response.

Sample:
2
timeout
integer
changed
The new timeout in which the remote system must respond to the monitor.

Sample:
10
transparent
boolean
changed
Whether the monitor operates in transparent mode.

up_interval
integer
changed
Interval for the system to use to perform the health check when a resource is up.



Authors

  • 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/latest/collections/f5networks/f5_modules/bigip_monitor_icmp_module.html