# bigip_monitor_gateway_icmp – Manages F5 BIG-IP LTM gateway ICMP monitors

New in version 2.8.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manages gateway 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.
description string |  | The description of the monitor.
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.
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 '*'.

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 that you must manually re-enable the resource after an unsuccessful monitor check.
When `no`, specifies that the system automatically changes the status of a resource to enabled at the next successful monitor check.

name string / required |  | Monitor name.
parent string | Default: "/Common/gateway_icmp" | The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `gateway_icmp` 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`.

sampling_timespan integer |  | Specifies the length, in seconds, of the probe history window that 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 that 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, then 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 that the system uses the interval specified in `interval` to check the health of the resource. When any other number, enables specification of 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 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 a monitor
      bigip_monitor_gateway_icmp:
        name: gw1
        adaptive: no
        interval: 1
        time_until_up: 0
        timeout: 3
        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
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.

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

- Tim Rupp (@caphrim007)

Hint

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