APIRef_tm_gtm_monitor_udp¶

mgmt/tm/gtm/monitor/udp

UDP monitor configuration.

REST Endpoints

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

Properties

Name	Type	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.), <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.), and <IP>:<port> (with the transparent option enabled) (Specifies to perform a health check on the server at the IP address and port that you specify, route the check through the IP address and port supplied by the pool member, and mark the pool member (the gateway) up or down accordingly.).
`ignoreDownResponse`	string	optional	read/write	Specifies whether the monitor ignores a down response from the system it is monitoring. The default value is disabled.
`interval`	integer	optional	read/write	Specifies the frequency at which the system issues the monitor check. The default value is 30 seconds.
`tmPartition`	string	optional	read/write	Displays the administrative partition within which the monitor resides.
`probeAttempts`	integer	optional	read/write	Specifies the number of times the BIG-IP system attempts to probe the host server, after which the BIG-IP system considers the host server down or unavailable. The default value is 3 attempts.
`probeInterval`	integer	optional	read/write	Specifies the frequency at which the BIG-IP system probes the host server. The default value is 1 second.
`probeTimeout`	integer	optional	read/write	Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system. The default value is 5 second.
`reverse`	string	optional	read/write	Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful check marks the monitored object down instead of up. You can use the Reverse mode only if you configure both the options send and recv. The default value is no. The no option specifies that the monitor does not operate in reverse mode. The yes option specifies that the monitor operates in reverse mode.
`send`	string	optional	read/write	Specifies the text string that the monitor sends to the target object. The default setting is ‘default send string’.
`timeout`	integer	optional	read/write	Specifies the number of seconds in which to wait for an ICMP error message. If an ICMP error message is received the node is marked down. If the timeout interval expires and no ICMP packet has been received the node is marked up. The default value is 120 seconds.
`transparent`	string	optional	read/write	Specifies whether the monitor operates in transparent mode. Monitors in transparent mode can monitor pool members through firewalls. The default value is disabled.

iControl Reference Index

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.