gtm monitor https
gtm monitor https(1) BIG-IP TMSH Manual gtm monitor https(1)
NAME
https - Configures a Hypertext Transfer Protocol over Secure Socket Layer (HTTPS) monitor.
MODULE
gtm monitor
SYNTAX
Configure the https component within the gtm monitor module using the syntax in the following sections.
CREATE/MODIFY
create https [name]
modify https [name]
options:
cert [ [cert list] | none]
cipherlist [string]
compatibility [enabled | disabled]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
ignore-down-response [enabled | disabled]
interval [integer]
key [ [key] | none]
password [none | [password] ]
probe-timeout [integer]
recv [none | [string] ]
recv-status-code [none | [string] ]
reverse [enabled | disabled]
send [none | [string] ]
timeout [integer]
transparent [enabled | disabled]
username [ [name] | none]
edit https [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list https
list https [ [ [name] | [glob] | [regex] ] ... ]
show running-config https
show running-config https [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete https [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the http component to configure a custom monitor, or you can use the default HTTPS monitor that
the Global Traffic Manager provides. This type of monitor verifies the HTTPS service by attempting to receive
specific content from a Web page protected by Secure Socket Layer (SSL) security.
EXAMPLES
create https my_https defaults-from https
Creates a monitor named my_https that inherits properties from the default HTTPS monitor.
list https
Displays the properties of all of the HTTPS monitors.
OPTIONS
cert Specifies a fully-qualified path for a client certificate that the monitor sends to the target SSL
server. The default value is none.
cipherlist
Specifies the list of ciphers for this monitor. The default list DEFAULT:+SHA:+3DES:+kEDH:!EXPORT is
located in the file gtm_base_monitors.conf.
compatibility
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. The default value is
enabled.
defaults-from
Specifies the name of the monitor from which you want your custom monitor to inherit settings. The
default value is https.
description
User defined description.
destination
Specifies the IP address and service port of the resource that is the destination of this monitor. The
default value is *:*.
Possible values are:
*:* Specifies to perform a health check on the IP address and port supplied by a pool member.
*:port
Specifies to perform a health check on the server with the IP address supplied by the pool member
and the port you specify.
IP address:port
Specifies to mark a pool member up or down based on the response of the server at the IP address and
port you specify.
IP address:port (with the transparent option enabled)
Specifies to perform a health check on the server at the IP address and port specified in the
monitor, routing the check through the IP address and port supplied by the pool member. The pool
member (the gateway) is marked up or down accordingly.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
ignore-down-response
Specifies whether the monitor ignores a down response from the system it is monitoring. The default value
is disabled.
interval
Specifies the frequency at which the system issues the monitor check. The default value is 30 seconds.
key Specifies the RSA private key if the monitored target requires authentication. The key must be surrounded
by quotation marks, for example, key \"client.key\". Note that if you specify a key, you must also
specify a value for the cert option. The default value is none.
name Specifies a unique name for the component. This option is required for the commands create, delete, and
modify.
partition
Displays the administrative partition within which the component resides.
password
Specifies the password if the monitored target requires authentication. The default value is none.
probe-timeout
Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP
system. The default value is 5 seconds.
recv Specifies the text string that the monitor looks for in the returned resource. The default value is none.
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. If you do not specify a value for both the send and recv options, the monitor performs a
simple service check and connect only.
recv-status-code
Specifies the status codes that the monitor looks for in the returned resource. The default value is
none.
The status code can be a number within the range 100-999. Multiple values can be specified in a space
separated, quoted string like "200 300". User can also specify wildcard values like "2XX 4xx 300". If you
do not specify a value for send, recv and recv-status-code options, the monitor performs a simple service
check and connect only.
regex
Displays the items that match the regular expression. The regular expression must be preceded by an at
sign (@[regular expression]) to indicate that the identifier is a regular expression. See help regex for
a description of regular expression syntax.
reverse
Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful
check marks the monitored object down instead of up. You can use the this mode only if you configure both
the send and recv options.
The default value is disabled, which specifies that the monitor does not operate in reverse mode. The
enabled value specifies that the monitor operates in reverse mode.
send Specifies the text string that the monitor sends to the target object. The default value is GET /, 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/company/index.html. Since the string may have special characters, the system may require that the
string be enclosed with single quotation marks.
If this value is null, then a valid connection suffices to determine that the service is up. In this
case, the system does not need the recv option and ignores the option even if not null.
timeout
Specifies the number of seconds the target has in which to respond to the monitor request. The default
value is 120 seconds.
If the target responds within the set time period, it is considered up. If the target does not respond
within the set time period, it is considered down. Also, if the target responds with a RESET packet, the
system immediately flags the target as down without waiting for the timeout interval to expire.
transparent
Specifies whether the monitor operates in transparent mode. Monitors in transparent mode can monitor pool
members through firewalls. The default value is disabled.
username
Specifies the username, if the monitored target requires authentication. The default value is none.
SEE ALSO
create, delete, edit, glob, gtm pool, list, modify, regex, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2010, 2012-2013. All rights reserved.
BIG-IP 2019-08-29 gtm monitor https(1)