New in version 2.6.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| ignore_down_response |
|
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 |
The interval specifying how frequently the monitor instance of this template will run.
If this parameter is not provided when creating a new monitor, then the default value will be 30.
This value must be less than the
timeout value. |
||
| ip |
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 '*'.
If this value is an IP address, then a
port number must be specified. |
||
|
name
required |
Monitor name.
|
||
| parent |
Default: /Common/tcp
|
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the
tcp parent on the Common partition. |
|
| partition |
Default: Common
|
Device partition to manage resources on.
|
|
|
password
required |
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable
F5_PASSWORD is set.aliases: pass, pwd |
||
| port |
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
|
||
| probe_timeout |
Specifies the number of seconds after which the system times out the probe request to the system.
When creating a new monitor, if this parameter is not provided, then the default value will be
5. |
||
|
provider
(added in 2.5) |
A dict object containing connection details.
|
||
| ssh_keyfile |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
| timeout |
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.
|
|
|
server
required |
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER is set. |
||
|
user
required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable
F5_USER is set. |
||
| server_port |
Default: 443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set. |
|
|
password
required |
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable
F5_PASSWORD is set.aliases: pass, pwd |
||
| validate_certs |
|
If
no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. |
|
|
transport
required |
|
Configures the transport connection to use when connecting to the remote device.
|
|
| receive |
The receive string for the monitor call.
|
||
| reverse |
|
Instructs the system to mark the target resource down when the test is successful. This setting is useful, for example, if the content on your web site home page is dynamic and changes frequently, you may want to set up a reverse ECV service check that looks for the string Error.
A match for this string means that the web server was down.
To use this option, you must specify values for
send and receive. |
|
| send |
The send string for the monitor call.
|
||
|
server
required |
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER is set. |
||
|
server_port
(added in 2.2) |
Default: 443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set. |
|
| state |
|
When
present, ensures that the monitor exists.When
absent, ensures the monitor is removed. |
|
| timeout |
The number of seconds in which the node or service must 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. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second.
If this parameter is not provided when creating a new monitor, then the default value will be 120.
|
||
| transparent |
|
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
no. |
|
|
user
required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable
F5_USER is set. |
||
|
validate_certs
(added in 2.0) |
|
If
no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. |
|
Note
pip install f5-sdk.- name: Create a GTM TCP monitor
bigip_gtm_monitor_tcp:
name: my_monitor
ip: 1.1.1.1
port: 80
send: my send string
receive: my receive string
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Remove TCP Monitor
bigip_gtm_monitor_tcp:
name: my_monitor
state: absent
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add TCP monitor for all addresses, port 514
bigip_gtm_monitor_tcp:
name: my_monitor
server: lb.mydomain.com
user: admin
port: 514
password: secret
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
ignore_down_response
bool
|
changed |
Whether to ignore the down response or not.
Sample:
True
|
|
interval
int
|
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:
tcp
|
|
port
string
|
changed |
The new port the monitor checks the resource on.
Sample:
8080
|
|
probe_timeout
int
|
changed |
The new timeout in which the system will timeout the monitor probe.
Sample:
10
|
|
receive
string
|
changed |
The new receive string for this monitor.
Sample:
tcp string to receive
|
|
reverse
bool
|
changed |
The new value for whether the monitor operates in reverse mode.
|
|
send
string
|
changed |
The new send string for this monitor.
Sample:
tcp string to send
|
|
timeout
int
|
changed |
The new timeout in which the remote system must respond to the monitor.
Sample:
10
|
|
transparent
bool
|
changed |
The new value for whether the monitor operates in transparent mode.
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.