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