ltm monitor module-score
ltm monitor module-score(1) BIG-IP TMSH Manual ltm monitor module-score(1)
NAME
module-score - Configures a Module Score monitor that monitors the
performance of a pool or node, rather than the health of the pool or
node.
MODULE
ltm monitor
SYNTAX
Configure the module-score component within the ltm monitor module
using the syntax in the following sections.
CREATE/MODIFY
create module-score [name]
modify module-score [name]
options:
app-service [[string] | none]
debug [no | yes]
defaults-from [name]
description [string]
interval [integer]
pool [name]
snmp-community [none | [string] ]
snmp-ip-address [ [ip address] | none]
snmp-port [port]
snmp-version [string]
time-until-up [integer]
timeout [integer]
up-interval [integer]
edit module-score [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list module-score
list module-score [ [ [name] | [glob] | [regex] ] ... ]
show module-score [ [ [name] | [glob] | [regex] ] ... ]
show running-config module-score
show running-config module-score [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete module-score [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the module-score component to configure a custom monitor,
or you can use the default Module Score monitor that the Local Traffic
Manager provides. This type of monitor enables global and local traffic
management systems to load balance in a proportional manner to local
traffic management virtual servers associated with the Web
Accelerator(tm) and Application Security Manager modules. When you
configure a Module Score type of 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.
More specifically, 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(r) 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.
Note: If you want to distribute traffic to a cluster of WebAccelerator
or Application Security Manager virtual servers, you must create a
separate custom Module Score monitor for each back-end Local Traffic
Manager system.
EXAMPLES
create module-score my_module-score defaults-from module_score
Creates a monitor named my_module-score that inherits properties from
the default Module Score monitor.
list module-score
Displays the properties of all of the Module Score 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.
debug
Specifies whether the monitor sends error messages and additional
information to a log file created and labeled specifically for
this monitor. You can use the log information to help diagnose and
troubleshoot unsuccessful health checks. The default value is no.
The options are:
no Specifies that the system does not redirect error messages
and additional information related to this monitor.
yes Specifies that the system redirects error messages and
additional information to the
/var/log/monitors/--.log file.
defaults-from
Specifies the name of the monitor from which you want your custom
monitor to inherit settings. The default value is module_score.
description
User defined description.
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 10 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.
partition
Displays the administrative partition within which the component
resides.
pool Specifies a Local Traffic Manager pool name. Use this option if
you want the system to set dynamic ratios on a pool member instead
of on the associated node for the pool member. 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.
snmp-community
Specifies the identifier for the SNMP community. The default value
is public.
snmp-ip-address
Specifies the IP address of the SNMP server. The default value is
none.
snmp-port
Specifies the port associated with the SNMP server. The default
value is 161.
snmp-version
Specifies the SNMP version in use by the system. The default value
is v2c.
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 30 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.
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-2014. All rights
reserved.
BIG-IP 2014-07-10 ltm monitor module-score(1)