gtm monitor postgresql
gtm monitor postgresql(1) BIG-IP TMSH Manual gtm monitor postgresql(1)
NAME
postgresql - Configures a PostgreSQL(r) monitor.
MODULE
gtm monitor
SYNTAX
Configure the postgresql component within the gtm monitor module using the syntax in the following sections.
CREATE/MODIFY
create postgresql [name]
modify postgresql [name]
options:
count [0 | 1]
database [ [name] | none]
debug [no | yes]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
ignore-down-response [enabled | disabled]
interval [integer]
password [none | [password] ]
probe-timeout [integer]
recv [none | [string] ]
recv-column [none | [string] ]
recv-row [none | [string] ]
send [none | [string] ]
timeout [integer]
username [ [name] | none]
edit postgresql [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list postgresql
list postgresql [ [ [name] | [glob] | [regex] ] ... ]
show running-config postgresql
show running-config postgresql [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete postgresql [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the postgresql component to configure a custom monitor, or you can use the default PostgreSQL
monitor that the Global Traffic Manager provides. This type of monitor verifies Microsoft(r) Windows(r) SQL-
based services.
EXAMPLES
create postgresql my_postgresql defaults-from postgresql
Creates a monitor named my_postgresql that inherits properties from the default PostgreSQL monitor.
list postgresql
Displays the properties of all of the PostgreSQL monitors.
OPTIONS
count
Specifies the number of instances for which the system keeps a connection open. By default, when you
assign instances of this monitor to a resource, the system keeps the connection to the database open.
With this option you can assign multiple instances to the database while reducing the overhead that
multiple open connections can cause.
A value of 0 (zero), the default, keeps the connection open for all instances. A value of 1 opens a new
connection for each instance. Any other positive value keeps the connection open for that many instances;
for example, a value of 5 keeps the connection open for five instances of this monitor.
database
Specifies the name of the database with which the monitor attempts to communicate. The default value is
none.
debug
Specifies whether the monitor sends error messages and additional information to a log file created and
labeled specifically for this monitor. You can use the log information to help diagnose and troubleshoot
unsuccessful health checks. The default value is no.
The options are:
no Specifies that the system does not redirect error messages and additional information related to
this monitor.
yes Specifies that the system redirects error messages and additional information to the
/var/log/monitors/--.log file.
defaults-from
Specifies the name of the monitor from which you want your custom monitor to inherit settings. The
default value is postgresql.
description
User defined description.
destination
Specifies the IP address and service port of the resource that is the destination of this monitor. The
default value is *:*.
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 address: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.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
ignore-down-response
Specifies whether the monitor ignores a down response from the system it is monitoring. The default value
is disabled.
interval
Specifies the frequency at which the system issues the monitor check. The default value is 30 seconds.
name Specifies a unique name for the component. This option is required for the commands create, delete, and
modify.
partition
Displays the administrative partition within which the component resides.
password
Specifies the password if the monitored target requires authentication. The default value is none.
probe-timeout
Specifies the number of seconds after which the BIG-IP(r) system times out the probe request to the BIG-
IP system. The default value is 5 seconds.
recv Specifies the text string that the monitor looks for in the returned resource. The default value is none.
The most common receive expressions contain a text string that is included in a field in your database.
If you do not specify a value for both the send and recv options, the monitor performs a simple service
check and connect only.
recv-column
Specifies the column in the database where the system expects the specified Receive String to be located.
Specify this option only if you configure the send and recv options. The default value is none.
recv-row
Specifies the row in the database where the system expects the specified Receive String to be located.
Specify this option only if you configure the send and recv options. The default value is none.
regex
Displays the items that match the regular expression. The regular expression must be preceded by an at
sign (@[regular expression]) to indicate that the identifier is a regular expression. See help regex for
a description of regular expression syntax.
send Specifies the SQL query that the monitor sends to the target database, for example, SELECT count(*) FROM
mytable.
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 option and ignores the option even if not null.
timeout
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
Specifies the username, if the monitored target requires authentication. The default value is none.
SEE ALSO
create, delete, edit, glob, gtm pool, list, modify, regex, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2009-2010, 2013-2014. All rights reserved.
BIG-IP 2017-08-15 gtm monitor postgresql(1)