Parameter |
Choices/Defaults |
Comments |
ignore_down_response
boolean
|
|
Specifies the monitor allows more than one probe attempt per interval.
When yes , specifies 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 the monitor immediately marks an object down when it receives a down response.
When creating a new monitor, if this parameter is not provided, the default value will be no .
|
interval
integer
|
|
The interval specifying how frequently the monitor instance of this template will run.
If this parameter is not provided when creating a new monitor, the default value will be 30.
This value must be less than the timeout value.
|
ip
string
|
|
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '*'.
If this value is an IP address, then a port number must be specified.
|
name
string
/ required
|
|
Monitor name.
|
parent
string
|
Default:
"/Common/http"
|
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
string
|
Default:
"Common"
|
Device partition to manage resources on.
|
port
string
|
|
Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '*'. If specifying an IP address, you must use a value between 1 and 65535.
|
probe_timeout
integer
|
|
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, the default value will be 5 .
|
provider
dictionary
added in 1.0.0 of f5networks.f5_modules
|
|
A dict object containing connection details.
|
|
auth_provider
string
|
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
|
no_f5_teem
boolean
|
|
If yes , TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TEEM .
|
|
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 F5_PASSWORD .
aliases: pass, pwd
|
|
server
string
/ required
|
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER .
|
|
server_port
integer
|
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT .
|
|
timeout
integer
|
|
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 F5_USER .
|
|
validate_certs
boolean
|
|
If no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.
You may omit this option by setting the environment variable F5_VALIDATE_CERTS .
|
receive
string
|
|
The receive string for the monitor call.
|
reverse
boolean
|
|
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 the web server was down.
To use this option, you must specify values for send and receive .
|
send
string
|
|
The send string for the monitor call.
When creating a new monitor, if this parameter is not provided, the default of GET /\r\n will be used.
|
state
string
|
Choices:
present ←
- absent
|
When present , ensures the monitor exists.
When absent , ensures the monitor is removed.
|
target_password
string
|
|
Specifies the password, if the monitored target requires authentication.
|
target_username
string
|
|
Specifies the user name, if the monitored target requires authentication.
|
timeout
integer
|
|
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 to any number, 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 default value will be 120.
|
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 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, the default value will be no .
|
update_password
string
|
Choices:
always ←
- on_create
|
always will update passwords if the target_password is specified.
on_create will only set the password for newly created monitors.
|