pgexporter

Appearance

pgexporter-admin ​

pgexporter-admin exists to manage list of admins/users allowed to access pgexporter. It is the administration utility of pgexporter.

Usage:

pgexporter-admin -f <user-file> [options] <command>
pgexporter-admin -?
pgexporter-admin -V
pgexporter-admin -f <user-file> [options] <command>
pgexporter-admin -?
pgexporter-admin -V

NOTE

The notation standard used for describing usage can be found here.

Meta Options ​

Help ​

Usage

sh
$ pgexporter-admin -?
# or
$ pgexporter-admin --help
$ pgexporter-admin -?
# or
$ pgexporter-admin --help

Output:

pgexporter-admin 0.6.1
  Administration utility for pgexporter

USAGE:
  pgexporter-admin -f <user-file> [options] [command]
  pgexporter-admin -?
  pgexporter-admin -V

OPTIONS:

  -f, --file FILE         Set the path to a user file\n");
  -U, --user USER         Set the user name\n");
  -P, --password PASSWORD Set the password for the user\n");
  -g, --generate          Generate a password\n");
  -l, --length            Password length\n");
  -V, --version           Display version information\n");
  -F, --format text|json  Set the output format\n");
  -?, --help              Display help\n");

COMMANDS:
  master-key              Create or update the master key
  user <subcommand>       Manage a specific user, where <subcommand> can be
                          - add  to add a new user
                          - del  to remove an existing user
                          - edit to change the password for an existing user
                          - ls   to list all available users

pgexporter: https://pgexporter.github.io/
Report bugs: https://github.com/pgexporter/pgexporter/issues
pgexporter-admin 0.6.1
  Administration utility for pgexporter

USAGE:
  pgexporter-admin -f <user-file> [options] [command]
  pgexporter-admin -?
  pgexporter-admin -V

OPTIONS:

  -f, --file FILE         Set the path to a user file\n");
  -U, --user USER         Set the user name\n");
  -P, --password PASSWORD Set the password for the user\n");
  -g, --generate          Generate a password\n");
  -l, --length            Password length\n");
  -V, --version           Display version information\n");
  -F, --format text|json  Set the output format\n");
  -?, --help              Display help\n");

COMMANDS:
  master-key              Create or update the master key
  user <subcommand>       Manage a specific user, where <subcommand> can be
                          - add  to add a new user
                          - del  to remove an existing user
                          - edit to change the password for an existing user
                          - ls   to list all available users

pgexporter: https://pgexporter.github.io/
Report bugs: https://github.com/pgexporter/pgexporter/issues

Version ​

Usage:

sh
$ pgexporter-admin -V
# or
$ pgexporter-admin --version
$ pgexporter-admin -V
# or
$ pgexporter-admin --version

Output:

pgexporter-admin 0.6.1
pgexporter-admin 0.6.1

Commands: ​

master-key ​

Description: Set master key.

sh
$ pgexporter-admin add-user # -f <users-file> [options]
# or
$ pgexporter-admin add-user # -f <users-file> [options]
$ pgexporter-admin add-user # -f <users-file> [options]
# or
$ pgexporter-admin add-user # -f <users-file> [options]

user add ​

Description: Add a user.

sh
$ pgexporter-admin user add # -f <users-file> [options]
$ pgexporter-admin user add # -f <users-file> [options]

user edit ​

Description: Update password of a user.

sh
$ pgexporter-admin user edit # -f <users-file> [options]
$ pgexporter-admin user edit # -f <users-file> [options]

user del ​

Description: Remove a user.

sh
$ pgexporter-admin user del # -f <users-file> [options]
$ pgexporter-admin user del # -f <users-file> [options]

user ls ​

Description: Provides list of users configured for pgexporter.

sh
$ pgexporter-admin user ls # -f <users-file> [options]
$ pgexporter-admin user ls # -f <users-file> [options]