gtm monitor firepass
gtm monitor firepass(1) BIG-IP TMSH Manual gtm monitor firepass(1)
NAME
firepass - Configures a FirePass(r) monitor.
MODULE
gtm monitor
SYNTAX
Configure the firepass component within the gtm monitor module using the syntax in the following sections.
CREATE/MODIFY
create firepass [name]
modify firepass [name]
options:
app-service [[string] | none]
cipherlist [list]
concurrency-limit [integer]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
ignore-down-response [enabled | disabled]
interval [integer]
max-load-average [floating point value]
password [none | [password] ]
probe-timeout [integer]
timeout [integer]
username [name]
edit firepass [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list firepass
list firepass [ [ [name] | [glob] | [regex] ] ... ]
show running-config firepass
show running-config firepass [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete firepass [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the firepass component to configure a custom monitor, or you can use the default FirePass monitor
that the BIG-IP(r) Global Traffic Manager(tm) provides. The FirePass monitor is both a health and performance
monitor.
For more information about configuring monitors, refer to the Configuration Guide for BIG-IP(r) Global Traffic
Management.
EXAMPLES
create firepass my_firepass defaults-from firepass_gtm
Creates a monitor named my_firepass that inherits properties from the default FirePass monitor.
list firepass
Displays the properties of all of the FirePass monitors.
OPTIONS
app-service
Specifies the name of the application service to which the monitor belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
modify or delete the monitor. Only the application service can modify or delete the monitor.
cipherlist
Specifies the list of ciphers for this monitor. The default value is HIGH:!ADH.
concurrency-limit
Specifies the maximum percentage of licensed connections currently in use under which the monitor marks
the FirePass system up. The default value is 95.
For example, a value of 95 percent means that the monitor marks the FirePass system up until 95 percent
of licensed connections are in use. When the number of in-use licensed connections exceeds 95 percent,
the monitor marks the FirePass system down.
defaults-from
Specifies the name of the monitor from which you want your custom monitor to inherit settings. The
default value is firepass_gtm.
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 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 address you
supply.
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.
max-load-average
Specifies the number that the monitor uses to mark the FirePass system up or down. The system compares
value of this option against a one-minute average of the FirePass system load. When the FirePass system-
load average falls within the specified value, the monitor marks the FirePass system up. When the average
exceeds the setting, the monitor marks the system down.
The default value is 12.0.
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.
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.
timeout
Specifies the number of seconds the target has in which to respond to the monitor request. The default
value is 90 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.
username
Specifies the username, if the monitored target requires authentication. The default value is gtmuser.
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. All rights reserved.
BIG-IP 2017-08-15 gtm monitor firepass(1)