OS Manuals

/usr/bin/ldap2pg

Synchronize PostgreSQL roles and privileges from YAML or LDAP directory (FIPS variant)

From ldap2pg-fips 6.6.0-r13 (enterprise-packages), captured 2026-11-08 by running ldap2pg --help (exit 0). permalink

usage: /usr/bin/ldap2pg [OPTIONS] [dbname]

      --check                      Check mode: exits with 1 if Postgres instance is unsynchronized.
      --color                      Force color output.
  -c, --config string              Path to YAML configuration file. Use - for stdin.
  -C, --directory string           Path to directory containing configuration files.
  -?, --help                       Show this help message and exit.
  -y, --ldappassword-file string   Path to LDAP password file.
  -q, --quiet count                Decrease log verbosity.
  -R, --real                       Real mode. Apply changes to Postgres instance.
  -P, --skip-privileges            Turn off privilege synchronisation.
  -v, --verbose count              Increase log verbosity.
  -V, --version                    Show version and exit.


Optional argument dbname is alternatively the database name or a conninfo string or an URI.
See man psql(1) for more information.

By default, ldap2pg runs in dry mode.
ldap2pg requires a configuration file to describe LDAP searches and mappings.
See https://ldap2pg.readthedocs.io/en/latest/ for further details.
Options (11)
OptionDescriptionSource
--checkCheck mode: exits with 1 if Postgres instance is unsynchronized.help
--colorForce color output.help
-c, --config stringPath to YAML configuration file.help
-C, --directory stringPath to directory containing configuration files.help
-?, --helpShow this help message and exit.help
-y, --ldappassword-file stringPath to LDAP password file.help
-q, --quiet countDecrease log verbosity.help
-R, --realReal mode.help
-P, --skip-privilegesTurn off privilege synchronisation.help
-v, --verbose countIncrease log verbosity.help
-V, --versionShow version and exit.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.