New in version 2.6.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| aggregate_dynamic_ratios |
|
Specifies how the system combines the module values to create the proportion (score) for the load balancing operation.
The score represents the module's estimated capacity for handing traffic.
Averaged values are appropriate for downstream Web Accelerator or Application Security Manager virtual servers.
When creating a new monitor, if this parameter is not specified, the default of
none is used, meaning that the system does not use the scores in the load balancing operation.When
none, specifies that the monitor ignores the nodes and pool member scores.When
average-nodes, specifies that the system averages the dynamic ratios on the nodes associated with the monitor's target virtual servers and returns that average as the virtual servers' score.When
sum-nodes, specifies that the system adds together the scores of the nodes associated with the monitor's target virtual servers and uses that value in the load balancing operation.When
average-members, specifies that the system averages the dynamic ratios on the pool members associated with the monitor's target virtual servers and returns that average as the virtual servers' score.When
sum-members, specifies that the system adds together the scores of the pool members associated with the monitor's target virtual servers and uses that value in the load balancing operation. |
|
| 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 |
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.
When creating a new monitor, if this parameter is not provided, 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 |
Monitor name.
|
||
| parent |
Default: /Common/bigip
|
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the
bigip 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 |
|
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 |
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.
When creating a new monitor, if this parameter is not provided, then the default value will be
90. |
||
|
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 BIG-IP Monitor
bigip_gtm_monitor_bigip:
state: present
ip: 10.10.10.10
server: lb.mydomain.com
user: admin
password: secret
name: my_monitor
delegate_to: localhost
- name: Remove BIG-IP Monitor
bigip_gtm_monitor_bigip:
state: absent
server: lb.mydomain.com
user: admin
password: secret
name: my_monitor
delegate_to: localhost
- name: Add BIG-IP monitor for all addresses, port 514
bigip_gtm_monitor_bigip:
server: lb.mydomain.com
user: admin
port: 514
password: secret
name: my_monitor
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
aggregate_dynamic_ratios
string
|
changed |
The new aggregate of to the monitor.
Sample:
sum-members
|
|
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:
bigip
|
|
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.