APIRef_tm_ltm_monitor_rpc

mgmt/tm/ltm/monitor/rpc

/tm/ltm/monitor

RPC monitor configuration.

REST Endpoints

Collection URI
/mgmt/tm/ltm/monitor/rpc
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/ltm/monitor/rpc/~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.
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 to the log file) 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 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 10 seconds.
manualResume string   optional read/write Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to yes, you must manually re-enable the resource before the system can use it for load balancing connections.
mode string   optional read/write Specifies the protocol that the monitor uses to communicate with the target. The default value is tcp. The options are tcp (Specifies that the monitor uses the TCP protocol to communicate with the target object.) and udp (Specifies that the monitor uses the UDP protocol to communicate with the target object.)
tmPartition string   optional read/write Displays the administrative partition within which the monitor resides.
programNumber string   optional read/write Specifies the number of the program for which you want the monitor to verify availability.
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 31 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.
versionNumber string   optional read/write Specifies the number of the version of the program for which you want the monitor to verify availability.
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.