Ubuntu Manpages

pgagroal-cli

Command line utility for pgagroal

pgagroal-cli [ -c CONFIG_FILE ] [ COMMAND ]

pgagroal-cli is a command line utility for pgagroal.

Set the path to the pgagroal.conf file
Set the host name
Set the port number
Set the user name
Set the password
Set the logfile

Set the output format
Compress the wire protocol
Encrypt the wire protocol

Output text string of result
Display version information

-?, --help
Display help

Flush connections according to [mode]. Allowed modes are:
  • 'gracefully' (default) to flush all connections gracefully
  • 'idle' to flush only idle connections
  • 'all' to flush all connections. USE WITH CAUTION!



If no [database] name is specified, applies to all databases.

Verifies if pgagroal is up and running and checks connectivity to configured PostgreSQL servers. With JSON output, the response includes per-server Host, Port, Status, Primary, and Behind on standbys.
Enable the specified database, or all databases if not specified
Disable the specified database, or all databases if not specified
  • 'gracefully' (default): waits for active connections to quit
  • 'immediate': forces connections to close and terminate
  • 'cancel': avoid a previously issued 'shutdown gracefully'


Status of pgagroal, with optional details. Per-server fields match ping. details adds limits and per-connection rows.
Switches to the specified primary server
  • 'reload': issue a configuration reload
  • 'ls': list the configuration files used
  • 'get': obtain information about a runtime configuration value Usage: conf get <parameter_name>
  • 'set': modify a configuration value Usage: conf set <parameter_name> <parameter_value>


Resets either the Prometheus statistics or the specified server. <what> can be:
  • 'server' (default) followed by a server name
  • a server name on its own
  • 'prometheus' to reset the Prometheus metrics




pgagroal is licensed under the 3-clause BSD License.

pgagroal.conf(5), pgagroal_hba.conf(5), pgagroal_databases.conf(5), pgagroal_vault.conf(5), pgagroal(1), pgagroal-admin(1), pgagroal-vault(1)