Manual Chapter :
Monitors Settings Reference
Applies To:
Show Versions
BIG-IP LTM
- 17.1.0, 17.0.0, 16.1.5, 16.1.4, 16.1.3, 16.1.2, 16.1.1, 16.1.0, 16.0.1, 16.0.0
Monitors Settings Reference
Health monitor functional categories
These tables describe the functional categories of health monitors, and list the
available BIG-IP monitors within each category.
Address-check monitors
An
address-check monitor
is a simple monitor that pings an IP address to
verify that the address can be reached on a network.Address-check monitor | Description |
|---|---|
Gateway ICMP | Uses Internet Control Message Protocol (ICMP) to make a simple resource check.
The check is successful if the monitor receives a response to an
ICMP_ECHO datagram. |
ICMP | Makes a simple node check. The check is successful if the monitor receives a
response to an ICMP_ECHO datagram. |
TCP Echo | Verifies Transmission Control Protocol (TCP) connections. The check is
successful if the BIG-IP system receives a response to a TCP Echo message. |
Service-check monitors
A
service-check monitor
determines whether a service is available by opening a
connection to an IP address and port.Service-check monitor | Description |
|---|---|
Diameter | Monitors the servers that are running the Diameter authentication service.
After configuring a Diameter monitor, associate the monitor with a load balancing
pool. The BIG-IP system then attempts to establish a TCP connection with a server in
the pool. After successfully establishing a connection, the Diameter monitor sends a
Capabilities-Exchanging-Request (CER) message to the server. The monitor then waits
to receive a Capabilities-Exchanging-Answer (CEA) message, as well as a result code
of DIAMETER_SUCCESS (2001) . |
FirePass | Checks the health of FirePass systems. |
Inband | Performs passive monitoring as part of client requests. This monitor, when
acting as a client, attempts to connect to a pool member. If the pool member does
not respond to a connection request after a user-specified number of tries within a
user-specified period, the monitor marks the pool member as down .
After the monitor has marked the pool member as down , and after a
user-specified period has passed, the monitor again tries to connect to the pool
member (if so configured). |
NNTP | Checks the status of Usenet News traffic. The check is successful if the
monitor retrieves a newsgroup identification line from the server. An
NNTP monitor requires a newsgroup name (for example,
alt.cars.mercedes ) and, if necessary, a user name and
password. |
MSSQL | Performs service checks on Microsoft SQL Server-based
services such as Microsoft SQL Server versions 6.5 and
7.0. |
MQTT | Checks the status of an MQTT server. The check is successful if the monitor is
able to connect to the server, log in as the indicated user, and log out. |
MySQL | Checks the status of a MySQL database server. The check is
successful if the monitor is able to connect to the server, log in as the indicated
user, and log out. |
Oracle | Checks the status of an Oracle database server. The check
is successful if the monitor is able to connect to the server, log in as the
indicated user, and log out. |
POP3 | Checks the status of Post Office Protocol (POP) traffic. The check is
successful if the monitor is able to connect to the server, log in as the indicated
user, and log out. A POP3 monitor requires a user name and password. |
PostgreSQL | Checks the status of a PostgreSQL database server. The check is successful if
the monitor is able to connect to the server, log in as the indicated user, and log
out. |
RADIUS | Checks the status of Remote Access Dial-in User Service (RADIUS) servers. The
check is successful if the server authenticates the requesting user. A RADIUS
monitor requires a user name, a password, and a shared secret string for the code
number. |
RADIUS Accounting | Checks the status of Remote Access Dial-in User Service (RADIUS) accounting
servers. A RADIUS Accounting monitor requires a user name and a shared secret string
for the code number. |
RPC | Checks the availability of specific programs that reside on a remote procedure
call (RPC) server. This monitor uses the rpcinfo command to query
the RPC server and verify the availability of a given program. |
SASP | Verifies the availability of a IBM Enterprise Workload
Manager (EWLM, formerly Group Workload Manager). This monitor uses the
Server/Application State Protocol (SASP) to communicate with the EWLM. The monitor
queries the EWLM for information on the current weights of each managed resource.
These weights determine which resource currently provides the best response time.
When the monitor receives this information from the EWLM), it configures the dynamic
ratio option for the resources, allowing the BIG-IP system to select the most
appropriate resource to respond to a connection request. When you assign an SASP monitor,
the monitor initially marks the resources as down . This change in
status occurs because the EWLM might not yet have information pertaining to its
resources. As soon as the monitor receives the results of its query, it changes
the status as needed. In most configurations, the monitor receives these results
within a few seconds. |
SIP | Checks the status of SIP Call-ID services. By default, this monitor type issues
an SIP OPTIONS request to a server device. However, you can use
alternative protocols instead: TCP, UDP, TLS, and SIPS (that is, Secure
SIP). |
SMB | Verifies the availability of a Server Message Block/Common Internet File System
(SMB/CIFS) server. Use this monitor to check the availability of the server as a
whole, the availability of a specific service on the server, or the availability of
a specific file used by a service. |
SOAP | Tests a web service based on the Simple Object Access Protocol (SOAP). The
monitor submits a request to a SOAP-based web service, and optionally, verifies a
return value or fault. |
TCP Half Open | Monitors the associated service by sending a TCP SYN packet to
the service. As soon as the monitor receives the SYN-ACK packet,
the monitor marks the service as up . |
UDP | Verifies the User Datagram Protocol (UDP) service by attempting to send UDP
packets to a pool, pool member, or virtual server and receiving a reply. |
Content-check monitors
A
content-check monitor
sends a command to a server and examines that server's
response to ensure that it is serving appropriate content.Content-check monitor | Description |
|---|---|
DNS | Checks the status of Domain Name System (DNS) servers, by sending a specific
string, and verifying receipt of that string. The check is successful if the DNS
server responds with a specified string within a specified period. |
HTTP | Checks the status of Hypertext Transfer Protocol (HTTP) traffic. Like a TCP
monitor, an HTTP monitor attempts to receive specific content from a web page, and
unlike a TCP monitor, might send a user name and password. An HTTP monitor can monitor Outlook Web Access
(OWA) in Microsoft Exchange Server 2007 and Microsoft
SharePoint 2007 web sites that require NT LAN Manager (NTLM)
authentication. NTLM authentication requires a send string that complies with
HTTP/1.1, a user name, and a password. |
HTTPS | Checks the status of Hypertext Transfer Protocol Secure (HTTPS) traffic. An
HTTPS monitor attempts to receive specific content from a web page protected by SSL
security. The check is successful when the content matches the Receive
String value.An HTTP monitor can
monitor Outlook Web Access (OWA) in Microsoft Exchange Server 2007 and Microsoft
SharePoint 2007 web sites that require NT LAN Manager (NTLM)
authentication. NTLM authentication requires a send string that complies with
HTTP/1.1, a user name, and a password. |
https_443 | Checks the status of Hypertext Transfer Protocol Secure (HTTPS) traffic, by
using port 443. |
LDAP | Checks the status of Lightweight Directory Access Protocol (LDAP) servers. A
check is successful if entries are returned for the base and filter specified. An
LDAP monitor requires a user name, a password, and base and filter strings. |
Scripted | Generates a simple script that reads a file that you create. The file contains
send and expect strings to specify lines that
you want to send or that you expect to receive. |
SMTP | Checks the status of Simple Mail Transport Protocol (SMTP) servers. This
monitor type checks only that the server is up and responding to commands. The check
is successful if the mail server responds to the standard SMTP HELO
and QUIT commands. |
TCP | Verifies the Transmission Control Protocol (TCP) service by attempting to
receive specific content from a resource. The check is successful when the content
matches the value of the Receive String setting. |
WAP | Monitors Wireless Application Protocol (WAP) servers. The common usage for the
WAP monitor is to specify the Send String and
Receive String settings only. The WAP monitor functions by
requesting a URL and finding the string in the Receive String
setting in the data returned by the URL response. |
Path-check monitors
A
path-check monitor
determines whether traffic can flow through a given
device to an arbitrary endpoint. The monitor sends a packet through the network device, or
to a remote server, to verify that the traffic can actually pass through the network device,
and not just to the device.Path-check monitor | Description |
|---|---|
Gateway ICMP | Uses Internet Control Message Protocol (ICMP) to make a simple resource check.
The check is successful if the monitor receives a response to an
ICMP_ECHO datagram. |
ICMP | Makes a simple node check. The check is successful if the monitor receives a
response to an ICMP_ECHO datagram. |
TCP Echo | Verifies Transmission Control Protocol (TCP) connections. The check is
successful if the BIG-IP system receives a response to a TCP Echo
message. |
Application-check monitors
An
application-check monitor
is typically a custom monitor or external monitor
that tests a specific application. For example, an FTP monitor connects, logs in by using a
user ID and password, changes to a specified directory, and requests a specific file. This
monitor succeeds when the file is received.Application-check monitor | Description |
|---|---|
BIG-IP | Gathers metrics and statistics information that the Local Traffic Manager (LTM)
acquires through the monitoring of its own resources. Typically, it is sufficient to
assign only the BIG-IP monitor to a Local Traffic Manager. When you want to verify
the availability of a specific resource managed by the LTM, F5 Networks recommends
that you first assign the appropriate monitor to the resource through the Local
Traffic Manager, and then assign a BIG-IP monitor to the LTM through the BIG-IP DNS
(formerly GTM). This configuration provides the most efficient
means of tracking resources managed by a BIG-IP system. |
BIG-IP Link | Gathers metrics and statistics information that the Link
Controller acquires through the monitoring of its own resources. When you use
BIG-IP DNS in a network that contains a Link Controller, you must assign a BIG-IP
Link monitor to the Link Controller. This monitor is automatically assigned to the
Link Controller if you do not manually assign it. |
External | Enables you to create your own monitor type. |
FTP | Attempts to download a specified file to the /var/tmp
directory, and if the file is retrieved, the check is successful. Note that once the
file has been successfully downloaded, the BIG-IP system does not save it. |
IMAP | Checks the status of Internet Message Access Protocol (IMAP) traffic. An IMAP
monitor is essentially a POP3 type of monitor with the addition of the Folder
setting. The check is successful if the monitor is able to log into a server and
open the specified mail folder. |
Module Score | Enables global and local traffic management systems to load balance in a
proportional manner to local traffic management virtual servers associated with the
BIG-IP
Application Acceleration Manager and Application Security Manager. When you configure a Module Score monitor, the
local traffic management system uses SNMP to pull the gtm_score
values from the downstream virtual servers and set the dynamic ratios on the
associated upstream local traffic management pool members or nodes. The Module
Score monitor retrieves the gtm_score values from the virtual
server and the gtm_vs_score values associated with the virtual
server. Then, if a pool name is not specified, this monitor sets the dynamic ratio
on the node that is associated with the virtual server.The BIG-IP system uses the lowest non-zero value of the
gtm_vs_score values to set the dynamic ratio. If all
gtm_vs_score values are zero, then the
gtm_score value is used to set the dynamic ratios. If you
specify a pool name in the monitor definition, then the dynamic ratio is set on
the pool member. |
Virtual Location | Optimizes end-user response time in environments with dynamic distribution of
application resources across multiple data centers. When using the
Virtual Location monitor, the BIG-IP system sets the
Priority Group value of all local pool members to
2 (a higher priority). When a member of a load balancing
pool migrates to a remote data center the Virtual Location monitor lowers the
members Priority Group value to 1 (a
lower priority). This value adjustment results in subsequent connections being sent
to local pool members only if available. If no local pool members are available,
connections are sent to the remote pool member. |
Performance monitor functional category
This information describes the functional category of performance monitors, and lists
the available BIG-IP monitors.
Performance monitors
A
performance monitor
interacts with the server (as opposed to virtual server)
to examine the server load and to acquire information about the condition of virtual
servers.Performance monitor | Description |
|---|---|
BIG-IP | Collects data from BIG-IP-DNS (formerly GTM) and Local Traffic Manager. Typically,
the Local Traffic Manager probes local pool members and provides the results to
BIG-IP-DNS. When the BIG-IP monitor fails, all virtual
servers for that Local Traffic Manager system are marked unavailable, regardless
of the results of individual virtual server probes. |
BIG-IP Link | Gathers metrics and statistics information acquired through the monitoring of
BIG-IP-DNS or Link Controller resources. |
SNMP | Checks the performance of a server that runs an SNMP agent to load balance to
that server. A custom snmp_gtm import setting is assigned to
servers that are not developed by F5 Networks. |
SNMP DCA | Checks the performance of a server running an SNMP agent such as UC Davis, for
the purpose of load balancing traffic to that server. With this monitor you can
define ratio weights for CPU, memory, and disk use. |
SNMP DCA Base | Checks the performance of servers that are running an SNMP agent, such as UC
Davis. However, you should use this monitor only when you want the load balancing
destination to be based solely on user data, and not CPU, memory, or disk
use. |
Real Server | Checks the performance of a node that is running the RealSystem Server data
collection agent. The monitor then dynamically load balances traffic
accordingly. |
WMI | Checks the performance of a node that is running the Windows Management
Infrastructure (WMI) data collection agent, and then dynamically load balances
traffic accordingly. Generally, you would use a WMI monitor with dynamic ratio load
balancing. When using the GetWinMediaInfo
command with a WMI monitor, Microsoft
Windows Server 2003 and Microsoft
Windows Server 2008 require the applicable version of Windows Media Services to be installed on each server. |
Diameter monitor settings
This table describes the Diameter monitor configuration settings and default
values.
Setting | Value | Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
31
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
31 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Origin Host | No default | Specifies the IP address on the BIG-IP system that generates the request to the
servers. If you provide no value for this setting, the system uses the self IP address on
the VLAN that generates the request to the server. |
Origin Realm | f5.com | Specifies the realm of the BIG-IP system that generates the request to the
servers. By default, this value is f5.com . |
Host IP Address | No default | Specifies the IP address of the diameter server. If no value is specified, the
system uses the BIG-IP system's IP address on the VLAN that the system uses to generate
traffic to the server. |
Vendor ID | 3375 | Specifies the vendor identification number assigned to your diameter server by the
Internet Assigned Numbers Authority (IANA). The default is 3375 ,
the IANA ID for F5 Networks. |
Product Name | F5 BIGIP Diameter Health Monitoring | Specifies the name of the product used to monitor the servers running the Diameter
service. By default, this value is F5 BIGIP Diameter Health
Monitoring . |
Auth Application ID | None | Specifies the Authentication and Authorization identifier for an application, as
described in RFC 3588. The default is None . If enabled, any value
that you specify must be a 32-bit unsigned value.The Auth Application ID
must also be present in all Authentication and/or Authorization messages that are
defined in a separate Diameter specification and have an Application ID assigned. |
Acct Application ID | None | Specifies the Accounting identifier for an application, as described in RFC 3588.
The default is None .The Acct Application ID must
also be present in all Accounting messages. Exactly one of the Auth Application ID
attribute-value pairs and Acct Application ID attribute-value pairs can be
present. |
Vendor Specific Application ID | None | Specifies the vendor-specific grouped values for the diameter application, as
described in RFC 3588. The default is None .Exactly
one of the Vendor Specific Auth Application ID attribute-value pairs
and Vendor Specific Acct Application ID attribute-value pairs can be
present. This value must also be present as the first attribute-value pair in
all experimental commands defined in the vendor-specific application. |
Vendor Specific Vendor ID | No default | Specifies an attribute-value pair associated with the Vendor Specific
Application ID monitor setting. |
Vendor Specific Auth Application ID | No default | Specifies an attribute-value pair associated with the Vendor Specific
Application ID monitor setting. |
Vendor Specific Acct Application ID | No default | Specifies an attribute-value pair associated with the Vendor Specific
Application ID monitor setting. |
DNS monitor settings
This table describes the DNS monitor configuration settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Reverse |
No |
Specifies whether the monitor operates in reverse mode. When monitor is in reverse
mode, a successful receive string marks the monitored object down instead of up. You can
use this mode only if you specify a receive string. The default value is
No , which specifies that the monitor does not operate in reverse
mode. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Query Name
|
No default |
Specifies a query name for
the monitor to use in a DNS query, for example, www.siterequest.com . |
Query Type
|
a
|
Specifies the type of DNS
query that the monitor sends. The default value is a . This setting provides the
following options.
|
Answer Section Contains |
Query Type |
Specifies the record types required in the answer section of the response in order
to mark the status of a node up. The default value is Query Type .
This setting includes the following options.
|
Accept RCODE |
No Error |
Specifies the RCODE required in the response for an up status.
The default value is No Error . This setting provides the following
options.
|
Receive String |
No default |
Specifies the IP address that the monitor uses from the resource record sections
of the DNS response. The IP address should be specified in the dotted-decimal notation or
IPv6 notation. The default value is none. If a receive string is not specified, the DNS
message is checked against Accept RCODE and Answer
Section Contains settings respectively. |
Adaptive
|
Disabled |
Specifies whether adaptive
response time monitoring is enabled for this monitor.
|
Allowed Divergence
|
Relative,
25% |
Specifies the type of
divergence used when the Adaptive setting is enabled (check box selected). In typical
cases, if the monitor detects three consecutive probes that miss the latency
value you set, the system marks the pool member or node as down. There are two
options:
|
Adaptive Limit
|
200
milliseconds |
Specifies the maximum
number of milliseconds that the latency of a monitor probe can exceed the mean
latency of a monitor probe, for the service being probed. This value applies
regardless of the Allowed
Divergence setting value. For example, when the Adaptive setting is enabled
(check box selected) with a value set to 500 , the monitor probe
latency cannot exceed 500 milliseconds, even if that value is below the value of
the Allowed Divergence
setting. Setting an adaptive monitor's adaptive-limit below the value
of the db variable bigd.adaptive.default_noise_floor behaves as though the limit
is the same as the noise
floor . By default this is 100ms . |
Sampling Timespan
|
300 seconds (5
minutes) |
Specifies the length, in
seconds, of the probe history window that the system uses to calculate the mean
latency and standard deviation of a monitor probe. For example, when the
Adaptive setting
is enabled (check box selected) with a value set to 300 seconds (that is five
minutes), then the BIG-IP system uses the last five minutes of probe history to
determine the mean latency and standard deviation of a probe. |
External monitor settings
This table describes the External monitor configuration
settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
External Program |
No default |
Specifies the name of the file for
the monitor to use. In order to reference a file, you must first import it using options
on the screen. The BIG-IP system automatically places the file in the proper
location on the file system. |
Arguments |
No default |
Specifies any command-line
arguments that the script requires. |
Variables |
No default |
Specifies any variables that the
script requires. |
Alias Address |
*All Addresses |
Specifies an alias IP address for
the monitor to check, on behalf of the pools or pool members with which the monitor is
associated. The default setting is *All
Addresses . If the health check for the alias address is successful, the
system marks all associated objects up. If the health check for the alias address is not
successful, then the system marks all associated objects down. |
Alias Service Port |
*All Ports |
Specifies an alias port or service
for the monitor to check, on behalf of the pools or pool members with which the monitor is
associated. The default setting is *All
Ports . If the health check for the alias port or service is successful, the
system marks all associated objects up. If the health check for the alias port or service
is not successful, then the system marks all associated objects down. |
FTP monitor settings
This table describes the FTP monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
31
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
31 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Path/Filename |
No default |
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. |
Mode |
Passive |
|
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
Gateway ICMP monitor settings
This table describes the Gateway ICMP monitor configuration
settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Transparent
|
No
|
Specifies whether the
monitor operates in transparent mode. A monitor in transparent mode uses a path
through the associated pool members or nodes to monitor the aliased destination
(that is, it monitors the Alias
Address -Alias
Service Port combination specified in the monitor). The default
is No . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Adaptive
|
Disabled |
Specifies whether adaptive
response time monitoring is enabled for this monitor.
|
Allowed Divergence
|
Relative,
25% |
Specifies the type of
divergence used when the Adaptive setting is enabled (check box selected). In typical
cases, if the monitor detects three consecutive probes that miss the latency
value you set, the system marks the pool member or node as down. There are two
options:
|
Adaptive Limit
|
200
milliseconds |
Specifies the maximum
number of milliseconds that the latency of a monitor probe can exceed the mean
latency of a monitor probe, for the service being probed. This value applies
regardless of the Allowed
Divergence setting value. For example, when the Adaptive setting is enabled
(check box selected) with a value set to 500 , the monitor probe
latency cannot exceed 500 milliseconds, even if that value is below the value of
the Allowed Divergence
setting. Setting an adaptive monitor's adaptive-limit below the value
of the db variable bigd.adaptive.default_noise_floor behaves as though the limit
is the same as the noise
floor . By default this is 100ms . |
Sampling Timespan
|
300 seconds (5
minutes) |
Specifies the length, in
seconds, of the probe history window that the system uses to calculate the mean
latency and standard deviation of a monitor probe. For example, when the
Adaptive setting
is enabled (check box selected) with a value set to 300 seconds (that is five
minutes), then the BIG-IP system uses the last five minutes of probe history to
determine the mean latency and standard deviation of a probe. |
HTTP monitor settings
This table describes the HTTP monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Send String
|
GET /
|
Specifies the text string
that the monitor sends to the target object. You must include \r\n at the end of a
non-empty send string. The default setting is GET /\r\n , which retrieves a
default HTML file for a web site. To retrieve a specific page from a web site,
specify a fully-qualified path name, for example: GET
/www/siterequest/index.html\r\n . When the send string specifies HTTP/1.0 or
HTTP/1.1 ,
the monitor checks the result code before indicating the monitor as up.
Additionally, the server response code must include a 200 status code, regardless
of the receive-string content, in order for the monitor to mark the
server as up. The monitor marks the server as down for any other
response, without further processing. When the send string does not specify HTTP/1.0 or
HTTP/1.1 ,
the monitor uses HTTP/0.9 and makes no response code checks. Search
string matches on the received reply can further affect the result.
When you create a new TCP, HTTP, or
HTTPS monitor in version 10.2.0 and later, you must include a return and
new-line entry ( \r\n ) at the end of a non-empty send string, for example
GET /\r\n
instead of GET / .
If you do not include \r\n at the end of the send string, the TCP, HTTP, or HTTPS
monitor fails. When you include a host in a send string, you must duplicate
the return and new-line entries (\r\n\r\n ), for example,
"GET / HTTP/1.1\r\nHost:
server.com\r\n\r\n" or "GET / HTTP/1.1\r\nHost:
server.com\r\nConnection: close\r\n\r\n" . |
Receive String
|
No default |
Specifies the regular
expression representing the text string that the monitor looks for in the
returned resource. The most common receive expressions contain a text string
that is included in an HTML file on your site. The text string can be regular
text, HTML tags, or image names, and the associated operation is not
case-sensitive. The only monitors that support regular expression matching are
HTTP, HTTPS, HTTP/2, TCP, and UDP monitors. If you do not specify both a Send String and a
Receive
String , the monitor performs a simple service check and connect
only. |
Receive Disable String
|
No default |
Use a Receive String value together
with a Receive Disable
String value to match the value of a response from the origin
web server and create one of three states for a pool member or node: Up (Enabled) , when only
Receive String
matches the response, or when both Receive String and Receive Disable String match
the response; Up
(Disabled) , when only Receive Disable String
matches the response; or Down , when neither Receive String nor Receive Disable String
matches the response. If you choose to
set the Reverse
setting to Yes ,
the Receive Disable
String option becomes unavailable and the monitor marks the
pool, pool member, or node Down when the test is successful. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Reverse
|
No
|
Instructs the system to
mark the target resource down when the test is successful. This setting is
useful, for example, if the content on your web site home page is dynamic and
changes frequently, you might want to set up a reverse ECV service check that
looks for the string Error . A match for this string means that the web server was
down. You can use Reverse only if you configure both Send String and Receive String . |
Transparent
|
No
|
Specifies whether the
monitor operates in transparent mode. A monitor in transparent mode uses a path
through the associated pool members or nodes to monitor the aliased destination
(that is, it monitors the Alias
Address -Alias
Service Port combination specified in the monitor). The default
is No . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Adaptive
|
Disabled |
Specifies whether adaptive
response time monitoring is enabled for this monitor.
|
Allowed Divergence
|
Relative,
25% |
Specifies the type of
divergence used when the Adaptive setting is enabled (check box selected). In typical
cases, if the monitor detects three consecutive probes that miss the latency
value you set, the system marks the pool member or node as down. There are two
options:
|
Adaptive Limit
|
200
milliseconds |
Specifies the maximum
number of milliseconds that the latency of a monitor probe can exceed the mean
latency of a monitor probe, for the service being probed. This value applies
regardless of the Allowed
Divergence setting value. For example, when the Adaptive setting is enabled
(check box selected) with a value set to 500 , the monitor probe
latency cannot exceed 500 milliseconds, even if that value is below the value of
the Allowed Divergence
setting. Setting an adaptive monitor's adaptive-limit below the value
of the db variable bigd.adaptive.default_noise_floor behaves as though the limit
is the same as the noise
floor . By default this is 100ms . |
Sampling Timespan
|
300 seconds (5
minutes) |
Specifies the length, in
seconds, of the probe history window that the system uses to calculate the mean
latency and standard deviation of a monitor probe. For example, when the
Adaptive setting
is enabled (check box selected) with a value set to 300 seconds (that is five
minutes), then the BIG-IP system uses the last five minutes of probe history to
determine the mean latency and standard deviation of a probe. |
HTTP/2 monitor settings
This table describes the HTTP/2 monitor configuration settings and default values.
Setting | Value | Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Send String
|
GET /\r\n
|
Specifies the text string
that the monitor sends to the target object. You must include \r\n at the end of a
non-empty send string. The default setting retrieves a default HTML file for a
web site. To retrieve a specific page from a web site, specify a fully-qualified
path name, for example: GET
/www/siterequest/index.html\r\n . The server response code must include a 200 status code, regardless of
the receive-string content, in order for the monitor to mark the server as
up. The monitor marks the server as down for any other response, without
further processing. Search string matches on the received reply can further
affect the result.When you create a new TCP, HTTP,
HTTPS, or HTTP/2 monitor, you must include a return and new-line entry
( \r\n ) at the
end of a non-empty send string, for example GET /\r\n instead of
GET / . If you
do not include \r\n at the end of the send string, the TCP, HTTP, HTTPS,
or HTTP/2 monitor fails. When you include a host in a send string, you must
duplicate the return and new-line entries (\r\n\r\n ). |
Receive String
|
No default |
Specifies the regular
expression representing the text string that the monitor looks for in the
returned resource. The most common receive expressions contain a text string
that is included in an HTML file on your site. The text string can be regular
text, HTML tags, or image names, and the associated operation is not
case-sensitive. The only monitors that support regular expression matching are
HTTP, HTTPS, HTTP/2, TCP, and UDP monitors. If you do not specify both a Send String and a
Receive
String , the monitor performs a simple service check and connect
only. |
Receive Disable String
|
No default |
Use a Receive String value together
with a Receive Disable
String value to match the value of a response from the origin
web server and create one of three states for a pool member or node: Up (Enabled) , when only
Receive String
matches the response, or when both Receive String and Receive Disable String match
the response; Up
(Disabled) , when only Receive Disable String
matches the response; or Down , when neither Receive String nor Receive Disable String
matches the response. If you choose to
set the Reverse
setting to Yes ,
the Receive Disable
String option becomes unavailable and the monitor marks the
pool, pool member, or node Down when the test is successful. |
SSL Profile
|
serverssl-secure
|
Specifies the relevant
Server SSL profile. The default profile is serverssl-secure . |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Reverse
|
No
|
Instructs the system to
mark the target resource down when the test is successful. This setting is
useful, for example, if the content on your web site home page is dynamic and
changes frequently, you might want to set up a reverse ECV service check that
looks for the string Error . A match for this string means that the web server was
down. You can use Reverse only if you configure both Send String and Receive String . |
Transparent
|
No
|
Specifies whether the
monitor operates in transparent mode. A monitor in transparent mode uses a path
through the associated pool members or nodes to monitor the aliased destination
(that is, it monitors the Alias
Address -Alias
Service Port combination specified in the monitor). The default
is No . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
IP DSCP | 0 | Specifies the Differentiated Services Code Point (DSCP) value found in the DS field of an IP header, for packet classification purposes. |
Adaptive
|
Disabled |
Specifies whether adaptive
response time monitoring is enabled for this monitor.
|
Allowed Divergence
|
Relative,
25% |
Specifies the type of
divergence used when the Adaptive setting is enabled (check box selected). In typical
cases, if the monitor detects three consecutive probes that miss the latency
value you set, the system marks the pool member or node as down. There are two
options:
|
Adaptive Limit
|
200
milliseconds |
Specifies the maximum
number of milliseconds that the latency of a monitor probe can exceed the mean
latency of a monitor probe, for the service being probed. This value applies
regardless of the Allowed
Divergence setting value. For example, when the Adaptive setting is enabled
(check box selected) with a value set to 500 , the monitor probe
latency cannot exceed 500 milliseconds, even if that value is below the value of
the Allowed Divergence
setting. Setting an adaptive monitor's adaptive-limit below the value
of the db variable bigd.adaptive.default_noise_floor behaves as though the limit
is the same as the noise
floor . By default this is 100ms . |
Sampling Timespan
|
300 seconds (5
minutes) |
Specifies the length, in
seconds, of the probe history window that the system uses to calculate the mean
latency and standard deviation of a monitor probe. For example, when the
Adaptive setting
is enabled (check box selected) with a value set to 300 seconds (that is five
minutes), then the BIG-IP system uses the last five minutes of probe history to
determine the mean latency and standard deviation of a probe. |
HTTPS monitor settings
This table describes the HTTPS monitor configuration
settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Send String
|
GET /
|
Specifies the text string
that the monitor sends to the target object. You must include \r\n at the end of a
non-empty send string. The default setting is GET /\r\n , which retrieves a
default HTML file for a web site. To retrieve a specific page from a web site,
specify a fully-qualified path name, for example: GET
/www/siterequest/index.html\r\n . When the send string specifies HTTP/1.0 or
HTTP/1.1 ,
the monitor checks the result code before indicating the monitor as up.
Additionally, the server response code must include a 200 status code, regardless
of the receive-string content, in order for the monitor to mark the
server as up. The monitor marks the server as down for any other
response, without further processing. When the send string does not specify HTTP/1.0 or
HTTP/1.1 ,
the monitor uses HTTP/0.9 and makes no response code checks. Search
string matches on the received reply can further affect the result.
When you create a new TCP, HTTP, or
HTTPS monitor in version 10.2.0 and later, you must include a return and
new-line entry ( \r\n ) at the end of a non-empty send string, for example
GET /\r\n
instead of GET / .
If you do not include \r\n at the end of the send string, the TCP, HTTP, or HTTPS
monitor fails. When you include a host in a send string, you must duplicate
the return and new-line entries (\r\n\r\n ), for example,
"GET / HTTP/1.1\r\nHost:
server.com\r\n\r\n" or "GET / HTTP/1.1\r\nHost:
server.com\r\nConnection: close\r\n\r\n" . |
Receive String
|
No default |
Specifies the regular
expression representing the text string that the monitor looks for in the
returned resource. The most common receive expressions contain a text string
that is included in an HTML file on your site. The text string can be regular
text, HTML tags, or image names, and the associated operation is not
case-sensitive. The only monitors that support regular expression matching are
HTTP, HTTPS, HTTP/2, TCP, and UDP monitors. If you do not specify both a Send String and a
Receive
String , the monitor performs a simple service check and connect
only. |
Receive Disable String
|
No default |
Use a Receive String value together
with a Receive Disable
String value to match the value of a response from the origin
web server and create one of three states for a pool member or node: Up (Enabled) , when only
Receive String
matches the response, or when both Receive String and Receive Disable String match
the response; Up
(Disabled) , when only Receive Disable String
matches the response; or Down , when neither Receive String nor Receive Disable String
matches the response. If you choose to
set the Reverse
setting to Yes ,
the Receive Disable
String option becomes unavailable and the monitor marks the
pool, pool member, or node Down when the test is successful. |
Cipher List |
DEFAULT:+SHA:+3DES:+kEDH |
Specifies the list of ciphers for
this monitor. The default list is DEFAULT:+SHA:+3DES:+kEDH . |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Compatibility |
Enabled |
Specifies, when enabled, that the
SSL options setting (in OpenSSL) is set to ALL . The default is Enabled . |
Client Certificate
|
None
|
For TLS and SIPS modes only, specifies a
client certificate that the monitor sends to the target SSL server. The default
is None . |
Client Key
|
None
|
For TLS and SIPS modes only, specifies a
key for a client certificate that the monitor sends to the target SSL server.
The default is None . |
Reverse
|
No
|
Instructs the system to
mark the target resource down when the test is successful. This setting is
useful, for example, if the content on your web site home page is dynamic and
changes frequently, you might want to set up a reverse ECV service check that
looks for the string Error . A match for this string means that the web server was
down. You can use Reverse only if you configure both Send String and Receive String . |
Transparent
|
No
|
Specifies whether the
monitor operates in transparent mode. A monitor in transparent mode uses a path
through the associated pool members or nodes to monitor the aliased destination
(that is, it monitors the Alias
Address -Alias
Service Port combination specified in the monitor). The default
is No . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Adaptive
|
Disabled |
Specifies whether adaptive
response time monitoring is enabled for this monitor.
|
Allowed Divergence
|
Relative,
25% |
Specifies the type of
divergence used when the Adaptive setting is enabled (check box selected). In typical
cases, if the monitor detects three consecutive probes that miss the latency
value you set, the system marks the pool member or node as down. There are two
options:
|
Adaptive Limit
|
200
milliseconds |
Specifies the maximum
number of milliseconds that the latency of a monitor probe can exceed the mean
latency of a monitor probe, for the service being probed. This value applies
regardless of the Allowed
Divergence setting value. For example, when the Adaptive setting is enabled
(check box selected) with a value set to 500 , the monitor probe
latency cannot exceed 500 milliseconds, even if that value is below the value of
the Allowed Divergence
setting. Setting an adaptive monitor's adaptive-limit below the value
of the db variable bigd.adaptive.default_noise_floor behaves as though the limit
is the same as the noise
floor . By default this is 100ms . |
Sampling Timespan
|
300 seconds (5
minutes) |
Specifies the length, in
seconds, of the probe history window that the system uses to calculate the mean
latency and standard deviation of a monitor probe. For example, when the
Adaptive setting
is enabled (check box selected) with a value set to 300 seconds (that is five
minutes), then the BIG-IP system uses the last five minutes of probe history to
determine the mean latency and standard deviation of a probe. |
ICMP monitor settings
This table describes the ICMP monitor configuration settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Transparent
|
No
|
Specifies whether the
monitor operates in transparent mode. A monitor in transparent mode uses a path
through the associated pool members or nodes to monitor the aliased destination
(that is, it monitors the Alias
Address -Alias
Service Port combination specified in the monitor). The default
is No . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Adaptive
|
Disabled |
Specifies whether adaptive
response time monitoring is enabled for this monitor.
|
Allowed Divergence
|
Relative,
25% |
Specifies the type of
divergence used when the Adaptive setting is enabled (check box selected). In typical
cases, if the monitor detects three consecutive probes that miss the latency
value you set, the system marks the pool member or node as down. There are two
options:
|
Adaptive Limit
|
200
milliseconds |
Specifies the maximum
number of milliseconds that the latency of a monitor probe can exceed the mean
latency of a monitor probe, for the service being probed. This value applies
regardless of the Allowed
Divergence setting value. For example, when the Adaptive setting is enabled
(check box selected) with a value set to 500 , the monitor probe
latency cannot exceed 500 milliseconds, even if that value is below the value of
the Allowed Divergence
setting. Setting an adaptive monitor's adaptive-limit below the value
of the db variable bigd.adaptive.default_noise_floor behaves as though the limit
is the same as the noise
floor . By default this is 100ms . |
Sampling Timespan
|
300 seconds (5
minutes) |
Specifies the length, in
seconds, of the probe history window that the system uses to calculate the mean
latency and standard deviation of a monitor probe. For example, when the
Adaptive setting
is enabled (check box selected) with a value set to 300 seconds (that is five
minutes), then the BIG-IP system uses the last five minutes of probe history to
determine the mean latency and standard deviation of a probe. |
IMAP monitor settings
This table describes the IMAP monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
31
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
31 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Folder |
INBOX |
Specifies the name of the folder
on the IMAP server that the monitor tries to open. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
Inband monitor settings
This table describes the Inband monitor configuration settings and default
values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Failures |
3 |
Specifies the number of failed responses that a pool member may send in the
Failure Interval before the monitor marks the pool member down.
The total number of failures can be any combination of failed connection attempts or
failures to return data within the interval specified in the Response
Time box. The default is 3 . Systems
with multiple tmm processes use a per-process number to calculate
failures, depending on the specified load balancing method. For example, for the Round
Robin load balancing method, if any tmm receives L failures, the
node will be marked down by that tmm. |
Failure Interval |
30 |
Specifies that if the system receives the specified number of
Failures within this period of time, the monitor marks the pool
member down. The default is 30 seconds. |
Response Time |
10 |
Specifies the interval in which a pool member must respond with data. If the pool
member responds after the specified amount of time, the monitor reports a failure.
Specifying a value of 0 (zero) disables this feature. The default
is 10 seconds. |
Retry Time |
300 |
Specifies the period of time a monitor waits after marking a pool member down,
before the monitor requests status from that pool member. If you specify a value of
0 (zero), once the inband monitor marks a pool member down, that
pool member is not marked up without outside intervention, either by explicitly marking
the pool member up, or by using by using the Check Until Up setting
in any other monitor (except another Inband monitor) configured on
the same pool member. (In this case, the other monitor is known as the active monitor, and
the Inband monitor is known as the passive monitor. If you have
this active-passive monitor configuration, do not set Retry Time to
a value other than 0 (zero). For this active-passive monitor
configuration, the active monitor should be the one to mark the pool member up, and
setting a value here could result in a possible conflict between two separate processes
marking a pool member up at different times.) The default is 300
seconds. |
LDAP monitor settings
This table describes the LDAP monitor configuration settings and default values.
Setting | Value | Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
31
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
31 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Base | No default | Specifies the location in the LDAP tree from which the monitor starts the health check. A sample value is: dc=bigip-test,dc=net |
Filter | No default | Specifies an LDAP key for which the monitor searches. A sample value is: objectclass=* . |
Security | None | Specifies the secure protocol type for communications with the target. The default is None . |
Mandatory Attributes | No | Specifies whether the target must include attributes in its response to be considered up. The default is No . |
Chase Referrals | Yes | Specifies whether, upon receipt of an LDAP referral entry, the target follows (or chases) that referral. The default is Yes . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
Module Score monitor settings
This table describes the Module Score monitor configuration settings and default
values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
30
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
30 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. |
SNMP Community |
Public |
Specifies the community name that the system must use to authenticate with the
host server through SNMP. The default value is public . Note that
this value is case sensitive. |
SNMP Version |
v2c |
Specifies the version of SNMP that the host server uses. The default is
v2c . |
SNMP IP Address |
No default |
Specifies the IP address the system uses for communicating the module score
information. |
SNMP Port |
161 |
Specifies the port associated with the IP address the system uses for
communicating the module score information. |
Pool Name
|
No default |
Requires the name of an
existing pool. |
MQTT monitor settings
This table describes the MQTT monitor configuration settings and default
values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
MQTT Version
|
3.1.1
|
Specifies the protocol
version that the monitor will use to communicate with the monitoring object. The
default is 3.1.1 . |
Client ID
|
No default |
Specifies the Client ID
that the monitor will send to communicate with the monitoring object. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
MSSQL monitor settings
This table describes the MSSQL monitor configuration
settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
30
|
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. The default value is
30 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
91
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
91 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Send String
|
No default |
Specifies the SQL
statement that the monitor runs on the target. A sample is: SELECT * FROM
<db_name> . This is an optional setting. If you do not specify
a send string, the monitor simply tries to establish a connection with the
target. If the monitor is successful, the system marks the target up. If the
system cannot establish the connection, then it marks the target
down. |
Receive String |
No default |
Specifies the response the monitor
expects from the target, when the target receives the send string. This is an optional
setting, and is applicable only if you configure the Send String setting. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Database
|
No default |
Specifies the name of the
database that the monitor tries to access, for example, sales or hr . |
Receive Row
|
No default |
Specifies the row in the
database where the specified Receive String should be located. This is an optional setting,
and is applicable only if you configure the Send String and the
Receive String
settings. |
Receive Column
|
No default |
Specifies the column in
the database where the specified Receive String should be located. This is an optional setting,
and is applicable only if you configure the Send String and the
Receive String
settings. |
Count
|
0
|
Specifies how the system
handles open connections for monitor instances. The default is 0 (zero). By default, when
you assign instances of this monitor to a resource, the system keeps the
connection to the database open. This functionality allows you to assign
multiple instances to the database while reducing the overhead that multiple
open connections could cause. The Count option allows you to determine the number of instances
for which the system keeps a connection open. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
MySQL monitor settings
This table describes the MySQL monitor configuration settings and default
values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
30
|
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. The default value is
30 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
91
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
91 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Send String
|
No default |
Specifies the SQL
statement that the monitor runs on the target. A sample is: SELECT * FROM
<db_name> . This is an optional setting. If you do not specify
a send string, the monitor simply tries to establish a connection with the
target. If the monitor is successful, the system marks the target up. If the
system cannot establish the connection, then it marks the target
down. |
Receive String
|
No default |
Specifies the response the
monitor expects from the target, when the target receives the send string. This
is an optional setting, and is applicable only if you configure the Send String
setting. If you do not specify both a
Send String
and a Receive
String , the monitor performs a simple service check and
connect only. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Database
|
No default |
Specifies the name of the
database that the monitor tries to access, for example, sales or hr . |
Receive Row
|
No default |
Specifies the row in the
database where the specified Receive String should be located. This is an optional setting,
and is applicable only if you configure the Send String and the
Receive String
settings. |
Receive Column
|
No default |
Specifies the column in
the database where the specified Receive String should be located. This is an optional setting,
and is applicable only if you configure the Send String and the
Receive String
settings. |
Count
|
0
|
Specifies how the system
handles open connections for monitor instances. The default is 0 (zero). By default, when
you assign instances of this monitor to a resource, the system keeps the
connection to the database open. This functionality allows you to assign
multiple instances to the database while reducing the overhead that multiple
open connections could cause. The Count option allows you to determine the number of instances
for which the system keeps a connection open. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
NNTP monitor settings
This table describes the NNTP monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Newsgroup |
No default |
Specifies the name of the
newsgroup that you are monitoring, for example alt.car.mercedes . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
Oracle monitor settings
This table describes the Oracle monitor configuration
settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
30
|
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. The default value is
30 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
91
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
91 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Send String
|
No default |
Specifies the SQL
statement that the monitor runs on the target. A sample is: SELECT * FROM
<db_name> . This is an optional setting. If you do not specify
a send string, the monitor simply tries to establish a connection with the
target. If the monitor is successful, the system marks the target up. If the
system cannot establish the connection, then it marks the target
down. |
Receive String
|
No default |
Specifies the response the
monitor expects from the target, when the target receives the send string. This
is an optional setting, and is applicable only if you configure the Send String
setting. If you do not specify both a
Send String
and a Receive
String , the monitor performs a simple service check and
connect only. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Connection String
|
No default |
Specifies the name of the
database that the monitor tries to access, for example, sales or hr . An
example for this entry is as follows, where you specify the IP address for
the node being monitored, the port for the node being monitored, and the
name for the database: (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=%node_ip%)(PORT=%node_port%))
(CONNECT_DATA=(SID=<db name>)) (SERVER=dedicated)) |
Receive Row
|
No default |
Specifies the row in the
database where the specified Receive String should be located. This is an optional setting,
and is applicable only if you configure the Send String and the
Receive String
settings. |
Receive Column
|
No default |
Specifies the column in
the database where the specified Receive String should be located. This is an optional setting,
and is applicable only if you configure the Send String and the
Receive String
settings. |
Count
|
0
|
Specifies how the system
handles open connections for monitor instances. The default is 0 (zero). By default, when
you assign instances of this monitor to a resource, the system keeps the
connection to the database open. This functionality allows you to assign
multiple instances to the database while reducing the overhead that multiple
open connections could cause. The Count option allows you to determine the number of instances
for which the system keeps a connection open. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
POP3 monitor settings
This table describes the POP3 monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
Real Server monitor settings
This table describes the Real Server monitor configuration
settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Method |
GET |
Displays the method the monitor
uses to contact the server. The setting is GET . You cannot modify the method. |
Command |
GetServerStats |
Specifies the command that the
system uses to obtain the metrics from the resource. |
Metrics |
ServerBandwidth:1.5, CPUPercentUsage, MemoryUsage,
TotalClientCount |
Specifies the performance metrics
that the commands collect from the target. The default is ServerBandwidth:1.5, CPUPercentUsage, MemoryUsage,
TotalClientCount . |
Agent |
Mozilla/4.0 (compatible: MSIE 5.0; Windows NT)
|
Displays the agent for the
monitor. The default agent is Mozilla/4.0
(compatible: MSIE 5.0; Windows NT) . You cannot modify the agent. |
PostgreSQL monitor settings
This table describes the PostgreSQL monitor configuration settings and default values.
Setting | Value | Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
30
|
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. The default value is
30 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
91
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
91 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Send String
|
No default |
Specifies the SQL
statement that the monitor runs on the target. A sample is: SELECT * FROM
<db_name> . This is an optional setting. If you do not specify
a send string, the monitor simply tries to establish a connection with the
target. If the monitor is successful, the system marks the target up. If the
system cannot establish the connection, then it marks the target
down. |
Receive String
|
No default |
Specifies the response the
monitor expects from the target, when the target receives the send string. This
is an optional setting, and is applicable only if you configure the Send String
setting. If you do not specify both a
Send String
and a Receive
String , the monitor performs a simple service check and
connect only. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Database
|
No default |
Specifies the name of the
database that the monitor tries to access, for example, sales or hr . |
Receive Row
|
No default |
Specifies the row in the
database where the specified Receive String should be located. This is an optional setting,
and is applicable only if you configure the Send String and the
Receive String
settings. |
Receive Column
|
No default |
Specifies the column in
the database where the specified Receive String should be located. This is an optional setting,
and is applicable only if you configure the Send String and the
Receive String
settings. |
Count
|
0
|
Specifies how the system
handles open connections for monitor instances. The default is 0 (zero). By default, when
you assign instances of this monitor to a resource, the system keeps the
connection to the database open. This functionality allows you to assign
multiple instances to the database while reducing the overhead that multiple
open connections could cause. The Count option allows you to determine the number of instances
for which the system keeps a connection open. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
RADIUS monitor settings
This table describes the RADIUS monitor configuration
settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10
seconds. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
31
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
31 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Secret
|
No default |
Specifies the secret the
monitor needs to access the resource. |
NAS IP Address
|
No default |
Specifies the network
access server’s IP address (NAS IP address) for a RADIUS monitor. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
RADIUS Accounting monitor settings
This table describes the RADIUS Accounting monitor
configuration settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
31
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
31 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Secret
|
No default |
Specifies the secret the
monitor needs to access the resource. |
NAS IP Address
|
No default |
Specifies the network
access server’s IP address (NAS IP address) for a RADIUS monitor. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
RPC monitor settings
This table describes the RPC monitor configuration settings and default
values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
31
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
31 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Mode |
TCP |
Specifies whether the monitor should verify the availability of the RPC server
through TCP or UDP. |
Program Number |
No default |
Specifies the number of the program or application whose availability the monitor
needs to verify. |
Version Number |
No default |
Specifies an exact version number of the program identified in the
Program Number setting. This setting verifies that a version of
the given program is available. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
SASP monitor settings
This table describes the SASP monitor configuration settings and default
values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
GWM Interval |
Automatic |
Specifies the frequency at which the system queries Group Workload Manager (GWM).
The default is Automatic . |
Mode |
Pull |
Specifies whether the load balancer should send Get Weight Request messages (Pull)
or receive Send Weights messages (Push) from the GWM server. The default is
Pull . When configured in the Pull mode,
the monitor polls the pool member weights by periodically sending a Get Weights Request
message to the GWM server. When configured in the Push mode, the
monitor waits indefinitely to receive pool member weights by means of Send Weights
messages from the GWM server. The SASP monitor updates the dynamic ratio for the pool
members once it receives the weights. |
GWM Primary Address |
No default |
Specifies the IP address of the primary GWM server. |
GWM Secondary Address |
No default |
Specifies the IP address of the secondary GWM server. When both the GWM primary
address and GWM secondary address are configured, but the GWM primary address or GWM
secondary address is unreachable, the monitor attempts to reconnect to the unreachable
address every 30 seconds. When both the GWM primary address and GWM secondary
address are available, only the weights reported by the primary address are used to
update the pool-member dynamic ratio. When the GWM primary address is
unavailable, the monitor uses the weights reported by the GWM secondary address to
update the pool-member dynamic ratio. If the primary address again becomes available,
then the monitor uses the weights reported by the primary address to update the
pool-member dynamic ratio. When both the GWM primary address and GWM secondary
address are unavailable, the monitor uses the weights reported by the first GWM address
that becomes available. |
GWM Service Port |
Specifies the port through which the SASP monitor communicates with the Group
Workload Manager. The default is 3860 . |
|
GWM Protocol |
TCP |
Specifies the communications protocol the monitor uses. You can specify
TCP or UDP . The default is
TCP . |
Scripted monitor settings
This table describes the Scripted monitor configuration
settings and default values.
When using scripts for monitor settings, you will want to observe the
following conditions.
- Scripts must use hard-return line endings (LF), not soft-return line endings (CR-LF).
- Exactly one character space must be used to separate thesendorexpectinstruction keywords from the text to send or match.
- The text to send or match extends to the end of the line, even when using quotation marks. Any characters that follow a closing quotation mark will break the match.
- Matching text can match the prefix of a response, but cannot match a substring that is not a prefix, that is, a substring that starts other than at the beginning of the response.
Additionally, within scripts, the following escape sequences apply.
Name |
Escape Sequence |
|---|---|
Bell |
\a |
Backspace |
\b |
Form feed |
\f |
New line |
\n |
Return |
\r |
Tab |
\t |
Vertical tab |
\v |
Backslash |
\\ |
Single quotation mark |
\' |
For example, the following script specifies a simple SMTP sequence. Note
that the lines of the file are always read in the sequence specified.
expect 220 send "HELO bigip1.somecompany.net\r\n" expect "250" send "quit\r\n"
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
31
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
31 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
File Name |
No default |
Specifies the name of a file in
the /config/eav/ directory on the
system. The user-created file contains the and
data that the monitor uses for the monitor
check. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
SIP monitor settings
This table describes the SIP monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Mode
|
UDP
|
Specifies the protocol
that the monitor uses to communicate with the target object. The default is
UDP . |
Client Certificate
|
None
|
For TLS and SIPS modes only, specifies a
client certificate that the monitor sends to the target SSL server. The default
is None . |
Client Key
|
None
|
For TLS and SIPS modes only, specifies a
key for a client certificate that the monitor sends to the target SSL server.
The default is None . |
Additional Accepted Status
Codes
|
None
|
Specifies the additional
SIP status codes that the monitor uses to determine target status. The default
is None . The monitor always marks the target up in
response to status code 200
OK . |
Additional Rejected Status
Codes
|
Status Code List
|
This list functions
identically to the Additional
Accepted Status Codes list, except that the monitor treats the
list items as error codes, rather than success codes, and so marks the target
down. |
Header List
|
No default |
Specifies one or more
headers that the monitor recognizes. |
SIP Request
|
No default |
Type the request line of
the SIP message, specifying a complete SIP request line minus the trailing
\r\n characters.
The system uses the response code to determine whether the server is up or down.
The monitor performs a simple, customized query to a SIP server. The monitor
does not establish connections, perform hand-shaking, or process SIP traffic or
requests. It only sends a request to a server and looks at the response code and
(aside from matching the response to the request) ignores the rest of the
response. As a result, this monitor does not support requests such as INVITE , because the monitor
does not enter into a dialog. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
SMB monitor settings
This table describes the SMB monitor configuration settings and default
values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
31
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
31 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Path/Filename |
No default |
Specifies a specific file associated with a service. The monitor uses the relative
path to the service itself when attempting to locate the file. You are not required to
specify a value for this option; however, if you elect to use this option you must also
specify a value for Service Name . |
SMB/CIFS Server |
No default |
Specifies the NetBIOS server name of the SMB/CIFS server for which the monitor
checks for availability. You must specify a server for this monitor to
function. |
Service Name |
No default |
Specifies a specific service on the SMB/CIFS for which you want to verify
availability. You are not required to specify a service name. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
SMTP monitor settings
This table describes the SMTP monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Domain |
No default |
Specifies the domain name to
check, for example, bigipinternal.com. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
SNMP DCA monitor settings
This table describes the SNMP DCA monitor configuration settings and default
values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
30
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
30 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. |
Community
|
Public
|
Specifies the community
name that the system must use to authenticate with the host server through SNMP.
The default value is public . Note that this value is case sensitive. |
Version
|
v1
|
Specifies the version of
SNMP that the host server uses. The default is V1 . |
Agent Type |
UCD |
Specifies the SNMP agent running on the monitored server. The default is
UCD (UC-Davis). |
CPU Coefficient |
1.5 |
Specifies the coefficient that the system uses to calculate the weight of the CPU
threshold in the dynamic ratio load balancing algorithm. The default is
1.5 . |
CPU Threshold |
80 |
Specifies the maximum acceptable CPU usage on the target server. The default is
80 percent. |
Memory Coefficient |
1.0 |
Specifies the coefficient that the system uses to calculate the weight of the
memory threshold in the dynamic ratio load balancing algorithm. The default is
1.0 . |
Memory Threshold |
70 |
Specifies the maximum acceptable memory usage on the target server. The default is
70 percent. |
Disk Coefficient |
2.0 |
Specifies the coefficient that the system uses to calculate the weight of the disk
threshold in the dynamic ratio load balancing algorithm. The default is
2.0 . |
Disk Threshold |
90 |
Specifies the maximum acceptable disk usage on the target server. The default is
90 percent. |
Variables
|
No default |
Presents text fields for
specifying unique variable names and value pairs (which represent coefficient
and threshold values for other types of data, such as user metrics) and a list
containing existing variable definitions that the monitor uses. |
SNMP DCA Base monitor settings
This table describes the SNMP DCA Base monitor configuration settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
30
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
30 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. |
Community
|
Public
|
Specifies the community
name that the system must use to authenticate with the host server through SNMP.
The default value is public . Note that this value is case sensitive. |
Version
|
v1
|
Specifies the version of
SNMP that the host server uses. The default is V1 . |
Variables
|
No default |
Presents text fields for
specifying unique variable names and value pairs (which represent coefficient
and threshold values for other types of data, such as user metrics) and a list
containing existing variable definitions that the monitor uses. |
SOAP monitor settings
This table describes the SOAP monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
SOAP Action |
No default |
Specifies the value for the SOAPAction header. |
Protocol |
HTTP |
Specifies the protocol that the
monitor uses for communications with the target. The default is HTTP . |
URL Path |
No default |
Specifies the URL for the web
service that you are monitoring, for example, /services/myservice.aspx . |
Namespace |
No default |
Specifies the name space for the
web service you are monitoring, for example, http://example.com/ . |
Method |
No default |
Specified the method by which the
monitor contacts the resource. |
Parameter Name |
No default |
Specifies, if the method has
parameters, the parameter name. |
Parameter Type |
Bool |
Specifies the parameter type. The
default is bool
(boolean). |
Parameter Value |
No default |
Specifies the value for the
parameter. |
Return Type |
Bool |
Specifies the type for the
returned parameter. The default is bool (boolean). |
Return Value |
No default |
Specifies the value for the
returned parameter. |
Expect Fault |
No |
Specifies whether the method
causes the monitor to expect a SOAP fault message. The default is No . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
TCP monitor settings
This table describes the TCP monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Send String
|
No default |
Specifies the text string
that the monitor sends to the target object. |
Receive String
|
No default |
Specifies the regular
expression representing the text string that the monitor looks for in the
returned resource. The most common receive expressions contain a text string
that is included in an HTML file on your site. The text string can be regular
text, HTML tags, or image names, and the associated operation is not
case-sensitive. The only monitors that support regular expression matching are
HTTP, HTTPS, HTTP/2, TCP, and UDP monitors. If you do not specify both a Send String and a
Receive
String , the monitor performs a simple service check and connect
only. |
Receive Disable String
|
No default |
Use a Receive String value together
with a Receive Disable
String value to match the value of a response from the origin
web server and create one of three states for a pool member or node: Up (Enabled) , when only
Receive String
matches the response, or when both Receive String and Receive Disable String match
the response; Up
(Disabled) , when only Receive Disable String
matches the response; or Down , when neither Receive String nor Receive Disable String
matches the response. If you choose to
set the Reverse
setting to Yes ,
the Receive Disable
String option becomes unavailable and the monitor marks the
pool, pool member, or node Down when the test is successful. |
Reverse
|
No
|
Instructs the system to
mark the target resource down when the test is successful. This setting is
useful, for example, if the content on your web site home page is dynamic and
changes frequently, you might want to set up a reverse ECV service check that
looks for the string Error . A match for this string means that the web server was
down. You can use Reverse only if you configure both Send String and Receive String . |
Transparent
|
No
|
Specifies whether the
monitor operates in transparent mode. A monitor in transparent mode uses a path
through the associated pool members or nodes to monitor the aliased destination
(that is, it monitors the Alias
Address -Alias
Service Port combination specified in the monitor). The default
is No . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Adaptive
|
Disabled |
Specifies whether adaptive
response time monitoring is enabled for this monitor.
|
Allowed Divergence
|
Relative,
25% |
Specifies the type of
divergence used when the Adaptive setting is enabled (check box selected). In typical
cases, if the monitor detects three consecutive probes that miss the latency
value you set, the system marks the pool member or node as down. There are two
options:
|
Adaptive Limit
|
200
milliseconds |
Specifies the maximum
number of milliseconds that the latency of a monitor probe can exceed the mean
latency of a monitor probe, for the service being probed. This value applies
regardless of the Allowed
Divergence setting value. For example, when the Adaptive setting is enabled
(check box selected) with a value set to 500 , the monitor probe
latency cannot exceed 500 milliseconds, even if that value is below the value of
the Allowed Divergence
setting. Setting an adaptive monitor's adaptive-limit below the value
of the db variable bigd.adaptive.default_noise_floor behaves as though the limit
is the same as the noise
floor . By default this is 100ms . |
Sampling Timespan
|
300 seconds (5
minutes) |
Specifies the length, in
seconds, of the probe history window that the system uses to calculate the mean
latency and standard deviation of a monitor probe. For example, when the
Adaptive setting
is enabled (check box selected) with a value set to 300 seconds (that is five
minutes), then the BIG-IP system uses the last five minutes of probe history to
determine the mean latency and standard deviation of a probe. |
TCP Echo monitor settings
This table describes the TCP Echo monitor configuration settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Transparent
|
No
|
Specifies whether the
monitor operates in transparent mode. A monitor in transparent mode uses a path
through the associated pool members or nodes to monitor the aliased destination
(that is, it monitors the Alias
Address -Alias
Service Port combination specified in the monitor). The default
is No . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
TCP Half Open monitor settings
This table describes the TCP Half Open monitor configuration
settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Transparent
|
No
|
Specifies whether the
monitor operates in transparent mode. A monitor in transparent mode uses a path
through the associated pool members or nodes to monitor the aliased destination
(that is, it monitors the Alias
Address -Alias
Service Port combination specified in the monitor). The default
is No . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
UDP monitor settings
This table describes the UDP monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Send String |
default send string |
Specifies the text string that the
monitor sends to the target object. The default is default send string . |
Receive String
|
No default |
Specifies the regular
expression representing the text string that the monitor looks for in the
returned resource. The most common receive expressions contain a text string
that is included in an HTML file on your site. The text string can be regular
text, HTML tags, or image names, and the associated operation is not
case-sensitive. The only monitors that support regular expression matching are
HTTP, HTTPS, HTTP/2, TCP, and UDP monitors. If you do not specify both a Send String and a
Receive
String , the monitor performs a simple service check and connect
only. |
Receive Disable String
|
No default |
Use a Receive String value together
with a Receive Disable
String value to match the value of a response from the origin
web server and create one of three states for a pool member or node: Up (Enabled) , when only
Receive String
matches the response, or when both Receive String and Receive Disable String match
the response; Up
(Disabled) , when only Receive Disable String
matches the response; or Down , when neither Receive String nor Receive Disable String
matches the response. If you choose to
set the Reverse
setting to Yes ,
the Receive Disable
String option becomes unavailable and the monitor marks the
pool, pool member, or node Down when the test is successful. |
Reverse
|
No
|
Instructs the system to
mark the target resource down when the test is successful. This setting is
useful, for example, if the content on your web site home page is dynamic and
changes frequently, you might want to set up a reverse ECV service check that
looks for the string Error . A match for this string means that the web server was
down. You can use Reverse only if you configure both Send String and Receive String . |
Transparent
|
No
|
Specifies whether the
monitor operates in transparent mode. A monitor in transparent mode uses a path
through the associated pool members or nodes to monitor the aliased destination
(that is, it monitors the Alias
Address -Alias
Service Port combination specified in the monitor). The default
is No . |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
Adaptive
|
Disabled |
Specifies whether adaptive
response time monitoring is enabled for this monitor.
|
Allowed Divergence
|
Relative,
25% |
Specifies the type of
divergence used when the Adaptive setting is enabled (check box selected). In typical
cases, if the monitor detects three consecutive probes that miss the latency
value you set, the system marks the pool member or node as down. There are two
options:
|
Adaptive Limit
|
200
milliseconds |
Specifies the maximum
number of milliseconds that the latency of a monitor probe can exceed the mean
latency of a monitor probe, for the service being probed. This value applies
regardless of the Allowed
Divergence setting value. For example, when the Adaptive setting is enabled
(check box selected) with a value set to 500 , the monitor probe
latency cannot exceed 500 milliseconds, even if that value is below the value of
the Allowed Divergence
setting. Setting an adaptive monitor's adaptive-limit below the value
of the db variable bigd.adaptive.default_noise_floor behaves as though the limit
is the same as the noise
floor . By default this is 100ms . |
Sampling Timespan
|
300 seconds (5
minutes) |
Specifies the length, in
seconds, of the probe history window that the system uses to calculate the mean
latency and standard deviation of a monitor probe. For example, when the
Adaptive setting
is enabled (check box selected) with a value set to 300 seconds (that is five
minutes), then the BIG-IP system uses the last five minutes of probe history to
determine the mean latency and standard deviation of a probe. |
Virtual Location monitor settings
This table describes the Virtual Location monitor configuration settings and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
Pool Name
|
No default |
Requires the name of an
existing pool. |
WAP monitor settings
This table describes the WAP monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
10
|
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. The default value is
10 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Up Interval
|
Disabled
|
Specifies, in seconds, the
frequency at which the system issues the monitor check when the resource is up.
The enabled default value is 0 (zero), which specifies that the system uses the value of the
interval option whether the resource is up or down. F5 Networks recommends that when you configure this
option and the Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
31
|
Specifies the number of
seconds in which the target must respond to the monitor request. The default is
31 seconds. If the
target responds within the set time period, the target is considered to be up.
If the target does not respond within the set time period, the target is
considered to be down. The Timeout value should be three times the Interval
value, plus one second. |
Manual Resume
|
No
|
Specifies whether the
system automatically changes the status of a resource to Enabled at the next
successful monitor check. The default is No . If you set this option to Yes , you must manually
re-enable the resource before the system can use it for load balancing
connections. |
Send String
|
No default |
Specifies the text string
that the monitor sends to the target object. |
Receive String
|
No default |
Specifies the response the
monitor expects from the target, when the target receives the send string. This
is an optional setting, and is applicable only if you configure the Send String
setting. If you do not specify both a
Send String
and a Receive
String , the monitor performs a simple service check and
connect only. |
Secret
|
No default |
Specifies the secret the
monitor needs to access the resource. |
Accounting Node |
No default |
Specifies the RADIUS server that
provides authentication for the WAP target. This setting is optional. Note that if you
configure the Accounting Port, but you do not configure the Accounting Node, the system
assumes that the RADIUS server and the WAP server are the same system. |
Accounting Port |
No default |
Specifies the port that the
monitor uses for RADIUS accounting. The default is 0 , which disables RADIUS
accounting. |
Server ID |
No default |
Specifies the RADIUS NAS-ID for
this system, in the RADIUS server's configuration. |
Call ID |
No default |
Specifies the 11-digit phone
number for the RADIUS server. This setting is optional. |
Session ID |
No default |
Specifies the RADIUS session
identification number. This setting is optional. |
Framed Address |
No default |
Specifies the RADIUS framed IP
address. This setting is optional. |
Alias Address
|
*All Addresses
|
Specifies an alias IP
address for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Addresses . If the health
check for the alias address is successful, the system marks all associated
objects up. If the health check for the alias address is not successful, then
the system marks all associated objects down. |
Alias Service Port
|
*All Ports
|
Specifies an alias port or
service for the monitor to check, on behalf of the pools or pool members with
which the monitor is associated. The default setting is *All Ports . If the health
check for the alias port or service is successful, the system marks all
associated objects up. If the health check for the alias port or service is not
successful, then the system marks all associated objects down. |
Debug
|
No
|
Specifies whether the
monitor sends error messages and additional information to a log file created
and labeled specifically for this monitor. The default setting is No , which specifies that the
system does not redirect error messages and additional information related to
this monitor. The Yes
setting specifies that the system redirects error messages and additional
information to the /var/log/<monitor_type>_<ip_address>.<port>.log
file. |
WMI monitor settings
This table describes the WMI monitor configuration settings
and default values.
Setting |
Value |
Description |
|---|---|---|
Name
|
No default |
Provides a name for the
monitor. |
Description
|
No default |
Provides a description of
the monitor. |
Type
|
Selected monitor
type |
Specifies the type of
monitor you are creating. |
Import
Settings
Parent
Monitor
|
Selected predefined or
user-defined monitor |
Specifies the selected
predefined or user-defined monitor. |
Interval
|
5
|
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. The default value is
5 seconds. F5 Networks recommends that when you
configure this option and the Up Interval option, whichever value is greater should be a
multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors. |
Time Until Up
|
0
|
Delays the marking of a
pool member or node as up for the specified number of seconds after receiving
the first correct response. When this attribute is set to 0 (the default value), the
BIG-IP system marks the resource as up immediately after receiving the first
correct response. |
Timeout
|
120
|
Specifies the maximum
amount of time that gtmd will wait for a big3d agent to send a probe reply
before making a target down with a reason of 'big3d: timed out'. The default is
120 seconds.
|
User Name
|
No default |
Specifies the user name,
if the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Password
|
No default |
Specifies the password, if
the monitored target requires authentication. When creating tmsh, if there is no password security,
you must use blank strings ("") for the User Name and Password settings.
Example: tmsh create ltm monitor
http test-http-pwd password "" . This does not apply to the GUI;
do not type double quotes ("") for the Password field. |
Method
|
POST
|
Displays the method the
monitor uses to contact the server. The setting is POST . You cannot modify the
method. |
URL
|
/scripts/F5Isapi.dll
|
Specifies the URL that the
monitor uses. The default is /scripts/f5Isapi.dll . |
Command
|
GetCPUInfo, GetDiskInfo,
GetOSInfo
|
Specifies the command that
the system uses to obtain the metrics from the resource. See the documentation
for the resource for information on available commands. The default is
GetCPUInfo, GetDiskInfo,
GetOSInfo . When using
the GetWinMediaInfo command
with a WMI monitor, MicrosoftWindows Server 2003 and MicrosoftWindows Server
2008 require the applicable version of Windows Media Services to be
installed on each server. |
Metrics
|
LoadPercentage, DiskUsage,
PhysicalMemoryUsage:1.5, VirtualMemoryUsage:2.0
|
Specifies the performance
metrics that the commands collect from the target. The default is LoadPercentage, DiskUsage,
PhysicalMemoryUsage:1.5, VirtualMemoryUsage:2.0 . |
Agent
|
Mozilla/4.0 (compatible: MSIE 5.0;
Windows NT)
|
Displays the agent for the
monitor. The default agent is Mozilla/4.0 (compatible: MSIE 5.0; Windows NT) . You cannot
modify the agent. |
Post
|
RespFormat=HTML
|
Displays the mechanism
that the monitor uses for posting. The default is RespFormat=HTML . You cannot
change the post format for WMI monitors. |
