APIRef_tm_gtm_monitor_oracle

mgmt/tm/gtm/monitor/oracle

/tm/gtm/monitor

Oracle monitor configuration.

REST Endpoints

Collection URI
/mgmt/tm/gtm/monitor/oracle
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/gtm/monitor/oracle/~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.
count string   optional read/write Specifies the number of monitor probes after which the connection to the database will be terminated. Count value of zero indicates that the connection will never be terminated. The default value is zero.
database string   optional read/write Specifies the name of the database that the monitor tries to access. The proper format for name is <node_ip>:<node_port>:<database_name>.
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.).
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.
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.
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 a field in your database. If you do not specify both a Send String and a Receive String, the monitor performs a simple service check and connect only.
recvColumn string   optional read/write Specifies the column in the database where the specified Receive String should be located. This is an optional setting, and is applicable only if you configure the Send String and the Receive String settings.
recvRow string   optional read/write Specifies the row in the database where the specified Receive String should be located. This is an optional setting, and is applicable only if you configure the Send String and the Receive String settings.
send string   optional read/write Specifies the SQL query that the monitor sends to the target object. For example, SELECT count(*) FROM mytable returns the number of rows in mytable. 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 91 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.
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.