OS Manuals

/usr/bin/barman

Backup and Recovery Manager for PostgreSQL

From barman 3.20.1-r3 (enterprise-packages), captured 2026-11-08 by running barman --help (exit 0). permalink

Also provided by 1 other package version
usage: barman [-h] [-v] [-c CONFIG] [--color {never,always,auto}]
              [--log-level {NOTSET,DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-q] [-d]
              [-f {console,json}]
              {archive-wal,backup,check,check-archived-wal-range,check-backup,check-wal-archive,cloud-wal-archive,cloud-wal-restore,config-switch,config-update,cron,delete,diagnose,export-backup,generate-manifest,get-wal,help,import-backup,keep,list-backup,list-backups,list-files,list-process,list-processes,list-server,list-servers,lock-directory-cleanup,put-wal,rebuild-xlogdb,receive-wal,recover,replication-status,restore,show-backup,show-backups,show-server,show-servers,status,switch-wal,switch-xlog,sync-backup,sync-info,sync-wals,terminate-process,verify,verify-backup}
              ...

positional arguments:
  {archive-wal,backup,check,check-archived-wal-range,check-backup,check-wal-archive,cloud-wal-archive,cloud-wal-restore,config-switch,config-update,cron,delete,diagnose,export-backup,generate-manifest,get-wal,help,import-backup,keep,list-backup,list-backups,list-files,list-process,list-processes,list-server,list-servers,lock-directory-cleanup,put-wal,rebuild-xlogdb,receive-wal,recover,replication-status,restore,show-backup,show-backups,show-server,show-servers,status,switch-wal,switch-xlog,sync-backup,sync-info,sync-wals,terminate-process,verify,verify-backup}
    archive-wal         Execute maintenance operations on WAL files for a given server. This
                        command processes any incoming WAL files for the server and archives them
                        along the catalogue.
    backup              Perform a full backup for the given server (supports 'all')
    check               Check if the server configuration is working. This command returns success
                        if every checks pass, or failure if any of these fails
    check-archived-wal-range
                        Verify that all WAL segments between begin_wal and end_wal are present in
                        the server's WAL archive. Returns exit code 0 when the sequence is
                        complete. Returns a non-zero exit code and lists any missing segments when
                        gaps are found.
    check-backup        Make sure that all the required WAL files to check the consistency of a
                        physical backup (that is, from the beginning to the end of the full
                        backup) are correctly archived. This command is automatically invoked by
                        the cron command and at the end of every backup operation.
    check-wal-archive   Check the WAL archive can be safely used for a new server. This will fail
                        if there are any existing WALs in the archive. If the --timeline option is
                        used then any WALs on earlier timelines than that specified will not cause
                        the check to fail.
    cloud-wal-archive   Push a WAL file from the local disk to a configured cloud object storage.
                        This command is intended to be used as 'archive_command' in Postgres when
                        using the 'local-to-cloud' backup method for taking base backups.
    cloud-wal-restore   Pull a WAL file from a configured cloud object storage to the local disk.
                        This command is intended to be used as 'restore_command' in Postgres when
                        restoring WALs from a cloud object storage.
    config-switch       Change the active configuration for a server by applying a named model on
                        top of it, or by resetting the active model.
    config-update       Receives a set of configuration changes in json format and applies them.
    cron                Run maintenance tasks (global command)
    delete              Delete a backup
    diagnose            Diagnostic command (for support and problems detection purpose)
    export-backup       Export a backup for the given server and backup ID to a tarball.
    generate-manifest   Generate a manifest-backup for the given server and backup id
    get-wal             Retrieve WAL_NAME file from SERVER_NAME archive. The content will be
                        streamed on standard output unless the --output-directory option is
                        specified.
    help                show this help message and exit
    import-backup       Import a previously exported backup tarball into the Barman catalog.
    keep                Tag the specified backup so that it will never be deleted
    list-backups (list-backup)
                        List available backups for the given server (supports 'all')
    list-files          List all the files for a single backup
    list-processes (list-process)
                        List all the active subprocesses started by the specified server.
    list-servers (list-server)
                        List available servers, with useful information
    lock-directory-cleanup (lock-directory-cleanup)
                        Cleanup command for the lock directory, takes care of leftover lock files.
    put-wal             Receive a WAL file from SERVER_NAME and securely store it in the incoming
                        directory. The file will be read from standard input in tar format.
    rebuild-xlogdb      Rebuild the WAL file database guessing it from the disk content.
    receive-wal         Start a receive-wal process. The process uses the streaming protocol to
                        receive WAL files from the PostgreSQL server.
    replication-status  Shows live information and status of any streaming client
    restore (recover)   Restore a server at a given time, name, LSN or xid
    show-backup (show-backups)
                        This method shows a single backup information
    show-servers (show-server)
                        Show all configuration parameters for the specified servers
    status              Shows live information and status of the PostgreSQL server
    switch-wal (switch-xlog)
                        Execute the switch-wal command on the target server
    sync-backup         Command that synchronises a backup from a master to a passive node
    sync-info           Output the internal synchronisation status. Used to sync_backup with a
                        passive node
    sync-wals           Command that synchronises WAL files from a master to a passive node
    terminate-process   Terminate a Barman server subprocess specified by task name.
    verify-backup (verify)
                        verify a backup for the given server and backup id

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -c CONFIG, --config CONFIG
                        uses a configuration file (defaults: ~/.barman.conf, /etc/barman.conf,
                        /etc/barman/barman.conf)
  --color {never,always,auto}, --colour {never,always,auto}
                        Whether to use colors in the output
  --log-level {NOTSET,DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        Override the default log level
  -q, --quiet           be quiet
  -d, --debug           debug output
  -f {console,json}, --format {console,json}
                        output format

Barman by EnterpriseDB (www.enterprisedb.com)
Options (5)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
-v, --versionshow program's version number and exithelp
--log-level NOTSETOverride the default log levelhelp
-q, --quietbe quiethelp
-d, --debugdebug outputhelp

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