GSLB_Monitor (object)

Declares a monitor that verifies the availability and/or performance status of a particular protocol, service or application

Properties (* = required):

name type(s) default allowed values description
/*/        
class* string   “GSLB_Monitor”  
ignoreDownResponseEnabled boolean false true, false Specifies whether the monitor immediately marks an object down when it receives a down response. If enabled, the monitor ignores the down response for the duration of timeout. The default is false (disabled)
interval integer 30 0 - 86399 Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown
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   “http”, “https”, “gateway-icmp”, “tcp”, “udp”, “external” Specifies the type of monitor
probeTimeout integer 5 0 - ∞ Specifies the number of seconds after which the system times out the probe request to the system
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
target string :   Specifies the IP address and service port of the resource that is the destination of this monitor. Format is ip:port
timeout integer 120 0 - 86400 Specifies the number of seconds the target has in which to respond to the monitor request

GSLB_Monitor_External (object)

Additional Monitor class properties available when monitorType = external

Properties (* = required):

name type(s) default allowed values description
/*/        
arguments string “”   Arguments to specified external monitor (will be backquote-expanded)
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
pathname string     Tmsh object path name of an imported existing external monitor (e.g. /Common/arg_example)
script       Bash(1) script which implements external monitor,String value optionally in base64 or from URL or AS3 pointer

GSLB_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      

GSLB_Monitor_HTTP (object)

Additional Monitor class properties available when monitorType = http

Properties (* = required):

name type(s) default allowed values description
/*/        
receive string “HTTP/1.”   Specifies the text string that the monitor looks for in the returned resource. If you do not specify a value for both the send and receive options, the monitor performs a simple service check and connect only
reverseEnabled boolean false true, false When enabled, a successful check marks the monitored object down instead of up. You can use the Reverse mode only if you configure both the send and receive options
send string “HEAD / HTTP/1.0rnrn”   Specifies the text string that the monitor sends to the target object. If you do not specify a value for both the send and receive options, the monitor performs a simple service check and connect only
transparent boolean false true, false Enables monitoring of pool members through firewalls. The default value is false (disabled)

GSLB_Monitor_HTTPS (object)

Additional Monitor class properties available when monitorType = https Additional Monitor class properties available when monitorType = http

Properties (* = required):

name type(s) default allowed values description
/*/        
ciphers string “DEFAULT”   Ciphersuite selection string
clientCertificate string     AS3 pointer to client Certificate declaration, for TLS authentication (optional)
receive string “HTTP/1.”   Specifies the text string that the monitor looks for in the returned resource. If you do not specify a value for both the send and receive options, the monitor performs a simple service check and connect only
reverseEnabled boolean false true, false When enabled, a successful check marks the monitored object down instead of up. You can use the Reverse mode only if you configure both the send and receive options
send string “HEAD / HTTP/1.0rnrn”   Specifies the text string that the monitor sends to the target object. If you do not specify a value for both the send and receive options, the monitor performs a simple service check and connect only
transparent boolean false true, false Enables monitoring of pool members through firewalls. The default value is false (disabled)

GSLB_Monitor_ICMP (object)

Additional Monitor class properties available when monitorType = gateway-icmp

Properties (* = required):

name type(s) default allowed values description
/*/        
probeAttempts integer 3 0 - ∞ Specifies the number of times the BIG-IP system attempts to probe the host server, after which the BIG-IP system considers the host server down or unavailable
probeInterval integer 1 0 - ∞ Specifies the frequency at which the BIG-IP system probes the host server
transparent boolean false true, false Enables monitoring of pool members through firewalls. The default value is false (disabled)

GSLB_Monitor_TCP (object)

Additional Monitor class properties available when monitorType = tcp

Properties (* = required):

name type(s) default allowed values description
/*/        
receive string “”   Specifies the text string that the monitor looks for in the returned resource. If you do not specify a value for both the send and receive options, the monitor performs a simple service check and connect only
reverseEnabled boolean false true, false When enabled, a successful check marks the monitored object down instead of up. You can use the Reverse mode only if you configure both the send and receive options
send string “”   Specifies the text string that the monitor sends to the target object. If you do not specify a value for both the send and receive options, the monitor performs a simple service check and connect only
transparent boolean false true, false Enables monitoring of pool members through firewalls. The default value is false (disabled)

GSLB_Monitor_UDP (object)

Additional Monitor class properties available when monitorType = udp

Properties (* = required):

name type(s) default allowed values description
/*/        
debugEnabled boolean false true, false When enabled, the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. The default is false (disabled)
probeAttempts integer 3 0 - ∞ Specifies the number of times the BIG-IP system attempts to probe the host server, after which the BIG-IP system considers the host server down or unavailable
probeInterval integer 1 0 - ∞ Specifies the frequency at which the BIG-IP system probes the host server
receive string “”   Specifies the text string that the monitor looks for in the returned resource. If you do not specify a value for both the send and receive options, the monitor performs a simple service check and connect only
reverseEnabled boolean false true, false When enabled, a successful check marks the monitored object down instead of up. You can use the Reverse mode only if you configure both the send and receive options
send string “default send string”   Specifies the text string that the monitor sends to the target object. If you do not specify a value for both the send and receive options, the monitor performs a simple service check and connect only
transparent boolean false true, false Enables monitoring of pool members through firewalls. The default value is false (disabled)