APIRef_tm_ltm_monitor_external

mgmt/tm/ltm/monitor/external

/tm/ltm/monitor

External monitor configuration.

REST Endpoints

Collection URI
/mgmt/tm/ltm/monitor/external
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/ltm/monitor/external/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
appService string   optional read/write The application service to which the object belongs.
args string   optional read/write Specifies any command-line arguments that the external program requires.
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 Specifies the IP address and service port of the resource that is the destination of this monitor. Possible values are: *:* (Specifies to perform a health check on the IP 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.), and <IP>:<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.)
interval integer   optional read/write Specifies the frequency at which the system issues the monitor check. The default value is 5 seconds.
manualResume string   optional read/write Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. The default value of the manual-resume option is disabled. Note that if you set the manual-resume option to enabled, you must manually mark the resource as up before the system can use it for load balancing connections.
tmPartition string   optional read/write Displays the administrative partition within which the monitor resides.
run string   optional read/write Specifies the path and file name of a program to run as the external monitor, for example /config/monitors/myMonitor.
timeUntilUp integer   optional read/write Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. The default setting is 0.
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.
userDefined string   optional read/write Specifies user defined command line parameters that the external program requires. The name and value of the parameter must be specified. If “none” is specified as the value then the parameter is removed from the list of user-defined parameters.
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.