ltm monitor firepass
ltm monitor firepass(1) BIG-IP TMSH Manual ltm monitor firepass(1)
NAME
firepass - Configures a FirePass(r) monitor.
MODULE
ltm monitor
SYNTAX
Configure the firepass component within the ltm 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 [ip address][port]
interval [integer]
max-load-average [integer]
password [password]
time-until-up [integer]
timeout [integer]
up-interval [integer]
username [ [name] | none]
edit firepass [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list firepass
list firepass [ [ [name] | [glob] | [regex] ] ... ]
show 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 Local Traffic Manager
provides. This type of monitor checks the health of FirePass systems.
EXAMPLES
create firepass my_firepass defaults-from firepass
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.
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 IP address and port you
specify.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax.
interval
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.
Important: F5 Networks recommends that when you configure this
option and the up-interval option, whichever value is greater be a
multiple of the lesser value to allow for an even distribution of
monitor checks among all monitors.
name Specifies a unique name for the component. This option is required
for the commands create, delete, and modify.
max-load-average
Specifies the number that the monitor uses to mark the FirePass
system up or down. The system compares the value of this option to
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
value, 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.
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.
time-until-up
Specifies the amount of time, in seconds, after the first
successful response before a node is marked up. A value of 0
(zero) causes a node to be marked up immediately after a valid
response is received from the node. The default value is 0 (zero).
timeout
Specifies the number of seconds the target has in which to respond
to the monitor request. The default value is 16 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.
up-interval
Specifies, in seconds, the frequency at which the system issues
the monitor check when the resource is up. The default value is 0
(zero), which specifies that the system uses the value of the
interval option whether the resource is up or down.
Important: F5 Networks recommends that when you configure this
option and the interval option, whichever value is greater be a
multiple of the lesser value to allow for an even distribution of
monitor checks among all monitors.
username
Specifies the username, if the monitored target requires
authentication. The default value is gtmuser.
SEE ALSO
create, delete, edit, glob, 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 2013-09-10 ltm monitor firepass(1)