f5networks.f5_modules.bigip_monitor_icmp module – Manages F5 BIG-IP LTM ICMP monitors
Note
This module is part of the f5networks.f5_modules collection (version 1.30.1).
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 f5networks.f5_modules 1.1.0
Synopsis
Manages ICMP monitors on a BIG-IP.
Parameters
Parameter |
Comments |
---|---|
Specifies whether adaptive response time monitoring is enabled for this monitor. When When Choices:
|
|
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of This value applies regardless of the value of the While this value can be configured when |
|
When specifying a new monitor, if When When Choices:
|
|
When specifying a new monitor, if |
|
The iApp service to be associated with this profile. When no service is specified, the default is None. |
|
The description of the monitor. |
|
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. |
|
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 |
|
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 When When Choices:
|
|
Specifies the name of the monitor. |
|
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 |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
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 |
|
When When Choices:
|
|
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. |
|
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 |
|
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 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 Choices:
|
|
Specifies the interval for the system to use to perform the health check when a resource is up. When 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: false
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: true
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 |
Description |
---|---|
Whether adaptive is enabled or not. Returned: changed Sample: |
|
Absolute number of milliseconds that may not be exceeded by a monitor probe. Returned: changed Sample: |
|
Type of divergence used for adaptive response time monitoring. Returned: changed Sample: |
|
Value of the type of divergence used for adaptive response time monitoring. May be Returned: changed Sample: |
|
The iApp service associated with this monitor. Returned: changed Sample: |
|
The description of the monitor. Returned: changed Sample: |
|
The new interval in which to run the monitor check. Returned: changed Sample: |
|
The new IP of IP/port definition. Returned: changed Sample: |
|
New parent template of the monitor. Returned: changed Sample: |
|
Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. Returned: changed Sample: |
|
Absolute number of milliseconds that may not be exceeded by a monitor probe. Returned: changed Sample: |
|
The new time in which to mark a system as up after first successful response. Returned: changed Sample: |
|
The new timeout in which the remote system must respond to the monitor. Returned: changed Sample: |
|
Whether the monitor operates in transparent mode. Returned: changed Sample: |
|
Interval for the system to use to perform the health check when a resource is up. Returned: changed Sample: |