bigip_monitor_gateway_icmp – Manages F5 BIG-IP LTM gateway ICMP monitors
bigip_monitor_gateway_icmp – Manages F5 BIG-IP LTM gateway ICMP monitors
New in version 2.8.
Synopsis
- Manages gateway ICMP monitors on a BIG-IP.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
adaptive boolean |
|
Specifies whether adaptive response time monitoring is enabled for this monitor. When When | |
adaptive_limit integer |
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 | ||
allowed_divergence_type string |
|
When specifying a new monitor, if When When | |
allowed_divergence_value integer |
When specifying a new monitor, if | ||
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 |
|
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 | |
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 | |
partition string |
Default: "Common" |
Device partition to manage resources on. | |
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
| ||
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. | ||
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
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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 | ||
timeout integer |
Default: 10 |
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 |
|
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
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 | ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
state string |
|
When When | |
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 | ||
transparent boolean |
|
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, then the default value will be whatever is provided by the | |
up_interval integer |
Specifies the interval for the system to use to perform the health check when a resource is up. When When any other number, enables specification of a different interval to use when checking the health of a resource that is up. | ||
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 | ||
validate_certs boolean added in 2.0 |
|
If You may omit this option by setting the environment variable |
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
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_monitor_gateway_icmp_module.html