Skip to content

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.4.1
  Administration utility for pgexporter

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

OPTIONS:
  -f, --file <user-file>    Set the path to a user file
  -U, --user <username>     Set the user name
  -P, --password <password> Set the password for the user
  -g, --generate            Generate a password
  -l, --length              Password length
  -V, --version             Display version information
  -?, --help                Display help

Commands:
  master-key              Create or update the master key
  add-user                Add a user
  update-user             Update a user
  remove-user             Remove a user
  list-users              List all users

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

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

OPTIONS:
  -f, --file <user-file>    Set the path to a user file
  -U, --user <username>     Set the user name
  -P, --password <password> Set the password for the user
  -g, --generate            Generate a password
  -l, --length              Password length
  -V, --version             Display version information
  -?, --help                Display help

Commands:
  master-key              Create or update the master key
  add-user                Add a user
  update-user             Update a user
  remove-user             Remove a user
  list-users              List all 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.4.1
pgexporter-admin 0.4.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]

add-users

Description: Add a user.

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]

update-user

Description: Update password of a user.

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

remove-user

Description: Remove a user.

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

list-users

Description: Provides list of users configured for pgexporter.

sh
$ pgexporter-admin list-users # -f <users-file> [options]
# or
$ pgexporter-admin list-users # -f <users-file> [options]
$ pgexporter-admin list-users # -f <users-file> [options]
# or
$ pgexporter-admin list-users # -f <users-file> [options]
txt
pgexporter
pgexporter