.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "PGAGROAL-CLI" 1 "" ""
.SH NAME
pgagroal-cli \- Command line utility for pgagroal
.SH SYNOPSIS
.sp
pgagroal\-cli [ \-c CONFIG_FILE ] [ COMMAND ]
.SH DESCRIPTION
.sp
pgagroal\-cli is a command line utility for pgagroal.
.SH OPTIONS
.INDENT 0.0
.TP
.BI \-c\fP,\fB  \-\-config \ CONFIG_FILE
Set the path to the pgagroal.conf file
.TP
.BI \-h\fP,\fB  \-\-host \ HOST
Set the host name
.TP
.BI \-p\fP,\fB  \-\-port \ PORT
Set the port number
.TP
.BI \-U\fP,\fB  \-\-user \ USERNAME
Set the user name
.TP
.BI \-P\fP,\fB  \-\-password \ PASSWORD
Set the password
.TP
.BI \-L\fP,\fB  \-\-logfile \ FILE
Set the logfile
.TP
.B  \-v\fP,\fB  \-\-verbose
Output text string of result
.TP
.B  \-V\fP,\fB  \-\-version
Display version information
.UNINDENT
.INDENT 0.0
.TP
.B \-?, \-\-help
Display help
.UNINDENT
.SH COMMANDS
.INDENT 0.0
.TP
.B flush\-idle
Flush idle connections
.TP
.B flush\-gracefully
Flush all connections gracefully
.TP
.B flush\-all
Flush all connections. USE WITH CAUTION !
.TP
.B is\-alive
Is pgagroal alive
.TP
.B enable
Enable a database. Optional parameter with the
database name, if not specified all will be enabled
.TP
.B disable
Disable a database. Optional parameter with the
database name, if not specified all will be disabled
.TP
.B gracefully
Stop pgagroal gracefully
.TP
.B stop
Stop pgagroal
.TP
.B cancel\-shutdown
Cancel the graceful shutdown
.TP
.B status
Status of pgagroal
.TP
.B details
Detailed status of pgagroal
.TP
.B switch\-to
Switch to another primary
.TP
.B reset
Reset the Prometheus statistics
.TP
.B reset\-server
Reset the state of a server. Requires a server name as an argument
.UNINDENT
.SH REPORTING BUGS
.sp
pgagroal is maintained on GitHub at \fI\%https://github.com/agroal/pgagroal\fP
.SH COPYRIGHT
.sp
pgagroal is licensed under the 3\-clause BSD License.
.SH SEE ALSO
.sp
pgagroal.conf(5), pgagroal_hba.conf(5), pgagroal_databases.conf(5), pgagroal(1), pgagroal\-admin(1)
.\" Generated by docutils manpage writer.
.