Parameter |
Choices/Defaults |
Comments |
app_service
string
|
|
The iApp service to be associated with this profile. When no service is specified, the default is None.
|
debug
boolean
|
|
Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor.
When yes the system redirects error messages and additional information to the /var/log/monitors/<monitor_name>-<node_name>-<port>.log file.
|
description
string
|
|
The description of the monitor.
|
domain
string
|
|
Specifies the domain name to check.
|
interval
integer
|
|
The interval specifying how frequently the monitor instance of this template will run.
This value must be less than the timeout value.
When creating a new monitor, if this parameter is not provided, the default 5 will be used.
|
ip
string
|
|
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '*'.
|
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 yes , you must manually re-enable the resource before the system can use it for load balancing connections.
When creating a new monitor, if this parameter is not specified, the default value is no .
When yes , specifies you must manually re-enable the resource after an unsuccessful monitor check.
When no , specifies the system automatically changes the status of a resource to enabled at the next successful monitor check.
|
name
string
/ required
|
|
Specifies the name of the monitor.
|
parent
string
|
|
The parent template of this monitor template. Once this value has been set, it cannot be changed.
When creating a new monitor, if this parameter is not specified, the default is the system-supplied smtp monitor.
|
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 is '*'. If specifying an IP address, you must specify a value between 1 and 65535.
|
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 .
|
state
string
|
Choices:
present ←
- absent
|
When present , ensures the monitor exists.
When absent , ensures the monitor is removed.
|
time_until_up
integer
|
|
Specifies the amount of time in seconds after the first successful response before a node will be marked up.
A value of 0 will cause a node to be marked up immediately after a valid response is received from the node.
If this parameter is not provided when creating a new monitor, then the default value will be 0 .
|
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, the default value will be 31 .
|
up_interval
integer
|
|
Specifies the interval for the system to use to perform the health check when a resource is up.
When 0 , specifies the system uses the interval specified in interval to check the health of the resource.
When any other number, enables you to specify a different interval to use when checking the health of a resource that is up.
When creating a new monitor, if this parameter is not provided, the default 0 will be used.
|