The interval specifying how frequently the monitor instance of this template will run. By default, this interval is used for up and down states. The default API setting is 5.

ip

no

none

IP address part of the ipport definition. The default API setting is "0.0.0.0".

name

yes

Monitor name

aliases: monitor

parent

no

http

The parent template of this monitor template

parent_partition

no

Common

Partition for the parent monitor

partition

no

Common

Partition for the monitor

password

yes

The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable F5_PASSWORD is set.

port

no

none

Port address part of the ip/port definition. The default API setting is 0.

receive

yes

none

The receive string for the monitor call

receive_disable

yes

none

The receive disable string for the monitor call

send

yes

none

The send string for the monitor call

server

yes

The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set.

server_port

(added in 2.2)

no

443

The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set.

state

no

present

present

absent

Monitor state

time_until_up

no

none

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. The default API setting is 0.

timeout

no

none

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. The default API setting is 16.

user

yes

The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable F5_USER is set.

validate_certs

(added in 2.0)

no

True

True

False

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set.