APIRef_tm_gtm_monitor_soap

mgmt/tm/gtm/monitor/soap

/tm/gtm/monitor

SOAP monitor configuration.

REST Endpoints

Collection URI
/mgmt/tm/gtm/monitor/soap
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/gtm/monitor/soap/~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.).
expectFault string   optional read/write Specifies whether the method causes the monitor to expect a SOAP fault message. The default value is no.
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 Specifies the method by which the monitor contacts the resource.
namespace string   optional read/write Specifies the name space for the web service you are monitoring, for example, http://example.com/.
parameterName string   optional read/write If the method has a parameter, specifies the name of that parameter.
parameterType string   optional read/write Specifies the parameter type. The default value is none. The options are bool, int (integer), long, none, and string.
parameterValue string   optional read/write Specifies the value for the parameter.
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.
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.
protocol string   optional read/write Specifies the protocol that the monitor uses to communicate with the target, http or https. The default value is http.
returnType string   optional read/write Specifies the type for the returned parameter. The default value is none. The options are bool, int (integer), long, none, and string.
returnValue string   optional read/write Specifies the value for the returned parameter. The default value is none.
soapAction string   optional read/write Specifies the value for the SOAPAction header. The default value is the empty string.
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.
urlPath string   optional read/write Specifies the URL for the web service that you are monitoring, for example, /services/myservice.aspx.
username string   optional read/write Specifies the user name if the monitored target requires authentication.
iControl Reference Index
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.