APIRef_tm_ltm_monitor_real-server¶

mgmt/tm/ltm/monitor/real-server

Real Server monitor configuration.

REST Endpoints

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

Properties

Name	Type	Required	Access	Description
`agent`	string	optional	read/write	Displays the agent for the monitor. The default agent is Mozilla/4.0 (compatible: MSIE 5.0; Windows NT). You cannot modify the agent.
`appService`	string	optional	read/write	The application service to which the object belongs.
`tmCommand`	string	optional	read/write	Displays the command that the system uses to obtain the metrics from the resource. See the documentation for this resource for information on available commands. You cannot modify the command.
`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 the frequency at which the system issues the monitor check. The default value is 5 seconds.
`method`	string	optional	read/write	Displays the GET method. You cannot modify the method.
`metrics`	string	optional	read/write	Specifies the performance metrics that the commands collect from the target.
`tmPartition`	string	optional	read/write	Displays the administrative partition within which the monitor resides.
`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.

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.