New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
arguments |
Specifies any command-line arguments that the script requires.
|
||
external_program |
Specifies the name of the file for the monitor to use. In order to reference a file, you must first import it using options on the System > File Management > External Monitor Program File List > Import screen. The BIG-IP system automatically places the file in the proper location on the file system.
|
||
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 '*'.
|
||
name
required |
Specifies the name of the monitor.
|
||
parent |
Default: /Common/external
|
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the
http 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.
|
||
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
bool |
|
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.
|
|
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.
|
||
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
bool (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. |
|
variables |
Specifies any variables that the script requires.
Note that double quotes in values will be suppressed.
|
Note
pip install f5-sdk
.- name: Create an external monitor
bigip_gtm_monitor_external:
name: foo
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Create an external monitor with variables
bigip_gtm_monitor_external:
name: foo
timeout: 10
variables:
var1: foo
var2: bar
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Add a variable to an existing set
bigip_gtm_monitor_external:
name: foo
timeout: 10
variables:
var1: foo
var2: bar
cat: dog
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
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:
external
|
timeout
int
|
changed |
The new timeout in which the remote system must respond to the monitor.
Sample:
10
|
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.