Monitor (object)¶

Declares a (possibly complex) monitor

Properties (* = required):

name	type(s)	allowed values	description
/*/
class*	string	“Monitor”
label	string	“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType*	string	“dns”, “external”, “ftp”, “http”, “https”, “http2”, “icmp”, “inband”, “ldap”, “mysql”, “postgresql”, “radius”, “sip”, “smtp”, “tcp”, “tcp-half-open”, “udp”	Specifies the type of monitor
remark	string	“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks

Monitor_DNS (object)¶

Additional Monitor class properties available when monitorType = dns

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
acceptRCODE	string	“no-error”	“anything”, “no-error”	Specifies the RCODE required in the response for an up status
adaptive	boolean	false	true, false	If true, use adaptive probe timing
adaptiveDivergenceMilliseconds	integer	500	1 - 10000	Probe fails if response latency exceeds mean by this number of milliseconds
adaptiveDivergencePercentage	integer	100	1 - 500	Probe fails if response latency exceeds mean by this percentage
adaptiveDivergenceType	string	“relative”	“absolute”, “relative”	Adaptive divergence, ‘absolute’ selects milliseconds, ‘relative’ (default) selects percentage
adaptiveLimitMilliseconds	integer	1000	1 - 10000	Probe fails if response latency exceeds this number of milliseconds
adaptiveWindow	integer	180	60 - 1800	Time window over which the system samples latency (seconds)
answerContains	string	“query-type”	“any-type”, “anything”, “query-type”	Specifies the type of DNS query that the monitor sends
class	string		“Monitor”
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
queryName*	string			Specifies a query name for the monitor to use in a DNS query
queryType	string	“a”	“a”, “aaaa”	Specifies the type of DNS query that the monitor sends.
receive	string			IP address that the monitor uses from the resource records sections of the DNS response
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
reverse	boolean	false	true, false	If true, mark node down upon receipt of ‘receive’ string
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
transparent	boolean	false	true, false	If true, treat pool member address as gateway to server (node) (default false)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)

Monitor_External (object)¶

Monitor External definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
arguments	string	“”		Arguments to specified external monitor (will be backquote-expanded)
class	string		“Monitor”
environmentVariables	object	{}		Specifies user defined command line parameters that the external program requires.
expand	boolean	true	true, false	If true (default), expand backquoted variables in script
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
pathname	string			Tmsh object path name of an imported existing external monitor (e.g. /Common/arg_example)
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
script				Bash(1) script which implements external monitor,The value can be either a string, text property, base64 property, url property, etc.
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)

Monitor_External.environmentVariables (object)¶

Specifies user defined command line parameters that the external program requires.

Default: {}

Properties (* = required):

name	type(s)	default	allowed values	description
/*/	string

Monitor_FTP (object)¶

Monitor FTP definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
class	string		“Monitor”
filename	string			Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
mode	string	“passive”	“passive”, “port”	Specifies the data transfer process (DTP) mode. The default value is passive.
monitorType	string			Specifies the type of monitor
passphrase	object			Passphrase if any for query authentication,A passphrase (passphrase property),A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)
username	string			Username if any for query authentication

Monitor_FTP.passphrase (object)¶

Passphrase if any for query authentication A passphrase (passphrase property) A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
allowReuse	boolean	false	true, false	If true, other declaration objects may reuse this value

Monitor_HTTP (object)¶

Monitor HTTP definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
adaptive	boolean	false	true, false	If true, use adaptive probe timing
adaptiveDivergenceMilliseconds	integer	500	1 - 10000	Probe fails if response latency exceeds mean by this number of milliseconds
adaptiveDivergencePercentage	integer	100	1 - 500	Probe fails if response latency exceeds mean by this percentage
adaptiveDivergenceType	string	“relative”	“absolute”, “relative”	Adaptive divergence, ‘absolute’ selects milliseconds, ‘relative’ (default) selects percentage
adaptiveLimitMilliseconds	integer	1000	1 - 10000	Probe fails if response latency exceeds this number of milliseconds
adaptiveWindow	integer	180	1 - 1800	Time window over which the system samples latency (seconds)
class	string		“Monitor”
dscp	integer	0	0 - 63	Value for IP DSCP (ex-TOS) field (default 0)
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
passphrase	object			A passphrase (passphrase property),A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL,Passphrase if any for query authentication
receive	string	“HTTP/1.”		Mark node up upon receipt of this (backquote-expanded) string
receiveDown	string	“”		Mark node down upon receipt of this (backquote-expanded) string (optional; must be empty when ‘reverse’ is true)
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
reverse	boolean	false	true, false	If true, mark node down upon receipt of ‘receive’ string
send	string	“HEAD / HTTP/1.0rnrn”		Send this (backquote-expanded) string to query node
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
transparent	boolean	false	true, false	If true, treat pool member address as gateway to server (node) (default false)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)
username	string			Username if any for query authentication

Monitor_HTTP.passphrase (object)¶

A passphrase (passphrase property) A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL Passphrase if any for query authentication

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
allowReuse	boolean	false	true, false	If true, other declaration objects may reuse this value

Monitor_HTTP2 (object)¶

Monitor HTTP2 definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
adaptive	boolean	false	true, false	If true, use adaptive probe timing
adaptiveDivergenceMilliseconds	integer	500	1 - 10000	Probe fails if response latency exceeds mean by this number of milliseconds
adaptiveDivergencePercentage	integer	100	1 - 500	Probe fails if response latency exceeds mean by this percentage
adaptiveDivergenceType	string	“relative”	“absolute”, “relative”	Adaptive divergence, ‘absolute’ selects milliseconds, ‘relative’ (default) selects percentage
adaptiveLimitMilliseconds	integer	1000	1 - 10000	Probe fails if response latency exceeds this number of milliseconds
adaptiveWindow	integer	180	1 - 1800	Time window over which the system samples latency (seconds)
class	string		“Monitor”
clientTLS	object			BIG-IP AS3 pointer to client TLS Profile,Reference to a TLS Client
dscp	integer	0	0 - 63	Value for IP DSCP (ex-TOS) field (default 0)
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
passphrase	object			A passphrase (passphrase property),A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL,Passphrase if any for query authentication
receive	string	“HTTP/2.”		Mark node up upon receipt of this (backquote-expanded) string
receiveDown	string	“”		Mark node down upon receipt of this (backquote-expanded) string (optional; must be empty when ‘reverse’ is true)
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
reverse	boolean	false	true, false	If true, mark node down upon receipt of ‘receive’ string
send	string	“GET /rnrn”		Send this (backquote-expanded) string to query node
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
transparent	boolean	false	true, false	If true, treat pool member address as gateway to server (node) (default false)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)
username	string			Username if any for query authentication

Monitor_HTTP2.clientTLS (object)¶

BIG-IP AS3 pointer to client TLS Profile Reference to a TLS Client

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP TLS Client
use	string			AS3 pointer to TLS Client declaration

Monitor_HTTP2.passphrase (object)¶

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
allowReuse	boolean	false	true, false	If true, other declaration objects may reuse this value

Monitor_HTTPS (object)¶

Monitor HTTPS definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
adaptive	boolean	false	true, false	If true, use adaptive probe timing
adaptiveDivergenceMilliseconds	integer	500	1 - 10000	Probe fails if response latency exceeds mean by this number of milliseconds
adaptiveDivergencePercentage	integer	100	1 - 500	Probe fails if response latency exceeds mean by this percentage
adaptiveDivergenceType	string	“relative”	“absolute”, “relative”	Adaptive divergence, ‘absolute’ selects milliseconds, ‘relative’ (default) selects percentage
adaptiveLimitMilliseconds	integer	1000	1 - 10000	Probe fails if response latency exceeds this number of milliseconds
adaptiveWindow	integer	180	1 - 1800	Time window over which the system samples latency (seconds)
ciphers	string	“DEFAULT”		Ciphersuite selection string
class	string		“Monitor”
clientCertificate	string			BIG-IP AS3 pointer to client Certificate declaration, for TLS authentication (optional)
clientTLS	object			BIG-IP AS3 pointer to client TLS Profile,Reference to a TLS Client
dscp	integer	0	0 - 63	Value for IP DSCP (ex-TOS) field (default 0)
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
passphrase	object			A passphrase (passphrase property),A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL,Passphrase if any for query authentication
receive	string	“HTTP/1.”		Mark node up upon receipt of this (backquote-expanded) string
receiveDown	string	“”		Mark node down upon receipt of this (backquote-expanded) string (optional; must be empty when ‘reverse’ is true)
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
reverse	boolean	false	true, false	If true, mark node down upon receipt of ‘receive’ string
send	string	“HEAD / HTTP/1.0rnrn”		Send this (backquote-expanded) string to query node
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
transparent	boolean	false	true, false	If true, treat pool member address as gateway to server (node) (default false)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)
username	string			Username if any for query authentication

Monitor_HTTPS.clientTLS (object)¶

BIG-IP AS3 pointer to client TLS Profile Reference to a TLS Client

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP TLS Client
use	string			AS3 pointer to TLS Client declaration

Monitor_HTTPS.passphrase (object)¶

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
allowReuse	boolean	false	true, false	If true, other declaration objects may reuse this value

Monitor_ICMP (object)¶

Monitor ICMP definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
adaptive	boolean	false	true, false	If true, use adaptive probe timing
adaptiveDivergenceMilliseconds	integer	500	1 - 10000	Probe fails if response latency exceeds mean by this number of milliseconds
adaptiveDivergencePercentage	integer	100	1 - 500	Probe fails if response latency exceeds mean by this percentage
adaptiveDivergenceType	string	“relative”	“absolute”, “relative”	Adaptive divergence, ‘absolute’ selects milliseconds, ‘relative’ (default) selects percentage
adaptiveLimitMilliseconds	integer	1000	1 - 10000	Probe fails if response latency exceeds this number of milliseconds
adaptiveWindow	integer	180	5 - 1800	Time window over which the system samples latency (seconds)
class	string		“Monitor”
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
transparent	boolean	false	true, false	If true, treat pool member address as gateway to server (node) (default false)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)

Monitor_Inband (object)¶

Monitor Inband definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
class	string		“Monitor”
failureInterval	integer	30	2 - 1000	Specifies an interval, in seconds. If the number of failures specified in the failures option occurs within this interval, the system marks the pool member as being unavailable.
failures	integer	3	0 - 1000	Specifies the number of failures that the system allows to occur, within the time period specified in the failureInterval property, before marking a pool member unavailable. The multiple tmm processes use a per-process number to calculate failures, depending on the specified load. For example, for the Round Robin load balancing method, if there are N tmm processes and M pool members, and the Failures property is set to L, then up to NML+1 failures can occur before the system marks the node as down. Specifying a value of 0 disables this option. A failure can be either a failure to connect or a failure of the pool member to respond within the time specified in the responseTime property.
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
responseTime	integer	10	0 - 5000	Specifies an amount of time, in seconds. If the pool member does not respond with data after the specified amount of time has passed, the number of failures in this interval increments by 1. Specifying a value of 0 disables this option.
retryTime	integer	300	0 - 5000	Specifies the amount of time in seconds after the pool member has been marked unavailable before the system retries to connect to the pool member. Specifying a value of 0 disables this option.

Monitor_LDAP (object)¶

Monitor LDAP definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
base	string			Specifies the location in the LDAP tree from which the monitor starts the health check
chaseReferrals	boolean	true	true, false	Specifies, whether, upon receipt of an LDAP referral entry, the referral is followed
class	string		“Monitor”
filter	string			Specifies an LDAP key which the monitor searches
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
mandatoryAttributes	boolean	false	true, false	Specifies whether the target must include attributes in its response to be considered up
monitorType	string			Specifies the type of monitor
passphrase	object			Passphrase if any for query authentication,A passphrase (passphrase property),A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
security	string	“none”	“none”, “ssl”, “tls”	Specifies the secure protocol type for communications with the target
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)
username	string			Username if any for query authentication

Monitor_LDAP.passphrase (object)¶

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
allowReuse	boolean	false	true, false	If true, other declaration objects may reuse this value

Monitor_MySQL (object)¶

Monitor MySQL definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
class	string		“Monitor”
count	integer	0	0 - 2147483647	Number of monitor probes after which the connection to the database will be terminated. Count value of zero indicates that the connection will never be terminated.
database	string			The name of the database with which the monitor attempts to communicate.
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
passphrase	object			Passphrase if any for query authentication,A passphrase (passphrase property),A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL
receive	string			Mark node up upon receipt of this (backquote-expanded) string
receiveColumn	integer		1 - 4096	Specifies the column in the database where the system expects the specified Receive String to be located. Specify this property only if you configure the Send and Receive properties.
receiveRow	integer		1 - 65535	Specifies the row in the database where the system expects the specified Receive String to be located. Specify this property only if you configure the Send and Recieve properties.
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
send	string			Send this (backquote-expanded) string to query node
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)
username	string			Username if any for query authentication

Monitor_MySQL.passphrase (object)¶

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
allowReuse	boolean	false	true, false	If true, other declaration objects may reuse this value

Monitor_PostgreSQL (object)¶

Monitor PostgreSQL definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
class	string		“Monitor”
count	integer	0	0 - 2147483647	Number of monitor probes after which the connection to the database will be terminated. Count value of zero indicates that the connection will never be terminated.
database	string			The name of the database with which the monitor attempts to communicate.
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
passphrase	object			Passphrase if any for query authentication,A passphrase (passphrase property),A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL
receive	string			Mark node up upon receipt of this (backquote-expanded) string
receiveColumn	integer		1 - 1600	Specifies the column in the database where the system expects the specified Receive String to be located. Specify this property only if you configure the Send and Receive properties.
receiveRow	integer		1 - 4294967294	Specifies the row in the database where the system expects the specified Receive String to be located. Specify this property only if you configure the Send and Recieve properties.
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
send	string			Send this (backquote-expanded) string to query node
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)
username	string			Username if any for query authentication

Monitor_PostgreSQL.passphrase (object)¶

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
allowReuse	boolean	false	true, false	If true, other declaration objects may reuse this value

Monitor_RADIUS (object)¶

Monitor RADIUS definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
class	string		“Monitor”
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
nasIpAddress	string		“f5ip” formatted string	Specifies the networks access server’s IP address (NAS IP address) for a RADIUS monitor
passphrase	object			Passphrase if any for query authentication,A passphrase (passphrase property),A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
secret	object			Specifies the secret the monitor needs to access the resource,A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)
username	string			Specifies the user name, if the monitor target requires authentication

Monitor_RADIUS.passphrase (object)¶

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
allowReuse	boolean	false	true, false	If true, other declaration objects may reuse this value

Monitor_RADIUS.secret (object)¶

Specifies the secret the monitor needs to access the resource A value: (a) in a cryptogram in this object; (b) in a cryptogram elsewhere in this declaration; or (c) available from a URL

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
allowReuse	boolean	false	true, false	If true, other declaration objects may reuse this value

Monitor_SIP (object)¶

Monitor SIP definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
ciphers	string	“DEFAULT”		Ciphersuite selection string
class	string		“Monitor”
clientCertificate	string			BIG-IP AS3 pointer to client Certificate declaration, for TLS authentication (optional)
codesDown	array			List of status codes meaning service is down (0 matches any code)
codesUp	array			List of additional (to all 1/2/3xx) status codes meaning service is up (0 matches any code)
headers	string	“”		SIP headers to send in probes (if any)–separate by newlines (backquote-expanded)
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
protocol	string	“udp”	“sips”, “tcp”, “tls”, “udp”	SIP transport protocol
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
request	string	“”		SIP request to send in probes (default empty)
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)

Monitor_SMTP (object)¶

Monitor SMTP definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
class	string		“Monitor”
domain	string	“”	“hostname” formatted string	Mail domain to check, if any (backquote-expanded)
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)

Monitor_TCP (object)¶

Monitor TCP definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
adaptive	boolean	false	true, false	If true, use adaptive probe timing
adaptiveDivergenceMilliseconds	integer	500	1 - 10000	Probe fails if response latency exceeds mean by this number of milliseconds
adaptiveDivergencePercentage	integer	100	1 - 500	Probe fails if response latency exceeds mean by this percentage
adaptiveDivergenceType	string	“relative”	“absolute”, “relative”	Adaptive divergence, ‘absolute’ selects milliseconds, ‘relative’ (default) selects percentage
adaptiveLimitMilliseconds	integer	1000	1 - 10000	Probe fails if response latency exceeds this number of milliseconds
adaptiveWindow	integer	180	5 - 1800	Time window over which the system samples latency (seconds)
class	string		“Monitor”
dscp	integer	0	0 - 63	Value for IP DSCP (ex-TOS) field (default 0)
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
receive	string	“none”		Mark node up upon receipt of this (backquote-expanded) string
receiveDown	string	“”		Mark node down upon receipt of this (backquote-expanded) string (optional; must be empty when ‘reverse’ is true)
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
reverse	boolean	false	true, false	If true, mark node down upon receipt of ‘receive’ string
send	string	“none”		Send this (backquote-expanded) string to query node
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
transparent	boolean	false	true, false	If true, treat pool member address as gateway to server (node) (default false)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)

Monitor_TCP_Half_Open (object)¶

Monitor properties available when monitorType = tcp-half-open

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
class	string		“Monitor”
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
transparent	boolean	false	true, false	If true, treat pool member address as gateway to server (node) (default false)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)

Monitor_UDP (object)¶

Monitor UDP definition

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
adaptive	boolean	false	true, false	If true, use adaptive probe timing
adaptiveDivergenceMilliseconds	integer	500	1 - 10000	Probe fails if response latency exceeds mean by this number of milliseconds
adaptiveDivergencePercentage	integer	100	1 - 500	Probe fails if response latency exceeds mean by this percentage
adaptiveDivergenceType	string	“relative”	“absolute”, “relative”	Adaptive divergence, ‘absolute’ selects milliseconds, ‘relative’ (default) selects percentage
adaptiveLimitMilliseconds	integer	1000	1 - 10000	Probe fails if response latency exceeds this number of milliseconds
adaptiveWindow	integer	180	60 - 1800	Time window over which the system samples latency (seconds)
class	string		“Monitor”
interval	integer	5	0 - 3600	Poll interval (seconds)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitorType	string			Specifies the type of monitor
receive	string	“none”		Mark node up upon receipt of this (backquote-expanded) string
receiveDown	string	“”		Mark node down upon receipt of this (backquote-expanded) string (optional; must be empty when ‘reverse’ is true)
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
reverse	boolean	false	true, false	If true, mark node down upon receipt of ‘receive’ string
send	string	“default send string”		Send this (backquote-expanded) string to node
targetAddress	string	“”	“f5ip” formatted string	IP address monitor should probe; if empty (default) then pool member address
targetPort	integer	0	0 - 65535	L4 port (if any) monitor should probe; if 0 (default) then pool member port
timeout	integer	16	0 - 900	Time limit for node to respond (seconds)
timeUntilUp	integer	0	0 - 1800	Delay between successful probe and sending traffic to node (seconds)
transparent	boolean	false	true, false	If true, treat pool member address as gateway to server (node) (default false)
upInterval	integer	0	0 - 3600	Poll interval when service is already up (seconds)

Previous Next