APIRef_tm_gtm_monitor_tcp¶

mgmt/tm/gtm/monitor/tcp

TCP monitor configuration.

REST Endpoints

Collection URI: /mgmt/tm/gtm/monitor/tcp
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/gtm/monitor/tcp/~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.
`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 an 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 specified in the pool member configuration, 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.
`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 seconds.
`recv`	string	optional	read/write	Specifies the text string that the monitor looks for in the returned resource. The most common receive expressions contain a text string that is included in an HTML file on your site. The text string can be regular text, HTML tags, or image names. If you do not specify both a Send String and a Receive String, the monitor performs a simple service check and connect only.
`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 GET /, which retrieves a default HTML file for a web site. To retrieve a specific page from a web site, specify a fully-qualified path name, for example, GET /www/company/index.html. Since the string may have special characters, the system may require that the string be enclosed with single quotation marks. If this value is null, then a valid connection suffices to determine that the service is up. In this case, the system does not need the recv, recv-row, and recv-column options and ignores the options even if not null.
`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 120 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.
`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.