ltm monitor virtual-location
ltm monitor virtual-location(1BIG-IP TMSH Manualtm monitor virtual-location(1)
NAME
virtual-location - Configures a Virtual Location monitor.
MODULE
ltm monitor
SYNTAX
Configure the virtual-location component within the ltm monitor module
using the syntax shown in the following sections.
CREATE/MODIFY
create virtual-location [name]
modify virtual-location [name]
options:
app-service [[string] | none]
debug [no | yes]
defaults-from [name]
description [string]
interval [integer]
pool [name]
time-until-up [integer]
timeout [integer]
up-interval [integer]
edit virtual-location [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list virtual-location
list virtual-location [ [ [name] | [glob] | [regex] ] ... ]
show virtual-location [ [ [name] | [glob] | [regex] ] ... ]
show running-config virtual-location
show running-config virtual-location
[ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete virtual-location [name]
Note: You cannot delete default monitors.
DESCRIPTION
The Virtual Location monitor will determine if a pool member which has
a virtual IP is currently a local pool member with its arp entry
existing on a local VLAN, or, a remote pool member with its ARP entry
existing on a tunnel VLAN. If the pool member is local it will set the
pool member's priority to 2. If the pool member is remote it will set
the priority to 1 (a lower priority). The Virtual Location will always
return up as the availability for the pool member. It is necessary to
use an additional monitor to check the availability status of the pool
member.
You can use the virtual-location component to configure a custom
monitor, or you can use the default Virtual Location monitor that the
Local Traffic Manager provides.
EXAMPLES
create virtual-location my_virtual-location defaults-from
virtual_location pool aPool
Creates a monitor named my_virtual-location that inherits properties
from the default Virtual Location monitor.
list virtual-location
Displays the properties of all of the Virtual Location 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. The default setting is no. You can use the log
information to help diagnose and troubleshoot unsuccessful health
checks. The options are no (specifies that the system does not
redirect error messages and additional information related to this
monitor.) and 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
virtual_location.
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 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.
partition
Displays the administrative partition within which the component
resides.
pool Specifies the pool for the target pool member. This is a required
argument.
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.
SEE ALSO
create, delete, edit, glob, list, ltm pool, modify, regex, 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 2010, 2012-2014, 2016. All rights
reserved.
BIG-IP 2016-03-14 ltm monitor virtual-location(1)