Virtual Location monitor configuration

REST Endpoints

Collection URI
Collection Methods
Resource URI
/mgmt/tm/ltm/monitor/virtual-location/~resource id
Resource Methods
Resource Natural Key
name, partition, subPath


Name Type Default Value Required Access Description
appService string   optional read/write The application service to which the object belongs.
debug string   optional read/write 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/<monitor_name>-<node_name>-<port>.log file.)
defaultsFrom string   optional read/write Specifies the existing monitor from which the system imports settings for the new monitor.
description string   optional read/write User defined description.
destination string   optional read/write  
interval integer   optional read/write 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.
tmPartition string   optional read/write Displays the administrative partition within which the monitor resides.
pool string   required read/write Specifies the pool for the target pool member. This is a required argument.
timeUntilUp integer   optional read/write 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 integer   optional read/write 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.
upInterval integer   optional read/write Specifies how often in seconds that the system issues the monitor check when the node is up. The default value is the same as the (down) interval.
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.