APIRef_tm_gtm_monitor_wmi¶

mgmt/tm/gtm/monitor/wmi

WMI monitor configuration.

REST Endpoints

Collection URI: /mgmt/tm/gtm/monitor/wmi
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/gtm/monitor/wmi/~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	Specifies the command that the system uses to obtain the metrics from the resource. See the documentation for this resource for information on available commands.
`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 of the resource that is the destination of this monitor. Possible values are: * (Specifies to perform a health check on the IP address of the node.), and <IP> (Specifies to perform a health check on the IP address that you specify, route the check through the IP address of the associated node, and mark the IP address of the associated node 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.
`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. The default value is LoadPercentage, DiskUsage, PhysicalMemoryUsage:1.5, VirtualMemoryUsage:2.0
`tmPartition`	string	optional	read/write	Displays the administrative partition within which the monitor resides.
`password`	string	optional	read/write	Specifies the password if the monitored target requires authentication.
`post`	string	optional	read/write	Specifies the mechanism that the monitor uses for posting. The default value is RespFormat=HTML. You cannot change the post format for WMI monitors.
`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.
`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.
`url`	string	optional	read/write	Specifies the URL that the monitor uses. The default value is /scripts/f5Isapi.dll.
`username`	string	optional	read/write	Specifies the user name if the monitored target requires authentication.

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.