Man page - barman-receive-wal(1)

Packages contas this manual

Package: barman-cli
apt-get install barman-cli

Manuals in package:

Documentations in package:

barman-cli

Package: barman-cli
apt-get install barman-cli

Manuals in package:

Documentations in package:

barman-cli

Manual

BARMAN-RECEIVE-WAL(1)

Barman

BARMAN-RECEIVE-WAL(1)

NAME

barman-receive-wal - Barman Sub-Commands

SYNOPSIS

receive-wal


    [ --create-slot ]


    [ --if-not-exists ]


    [ --drop-slot ]


    [ { -h | --help } ]


    [ --reset ]


    [ --stop ]


    SERVER_NAME

DESCRIPTION

Initiate the streaming of transaction logs for a server. This process uses pg_receivewal or pg_receivexlog to receive WAL files from Postgres servers via the streaming protocol.

PARAMETERS

SERVER_NAME: Name of the server in barman node.
--create-slot: Create the physical replication slot configured with the slot_name configuration parameter.
--if-not-exists: Do not error out when --create-slot is specified and a slot with the specified name already exists.
--drop-slot: Drop the physical replication slot configured with the slot_name configuration parameter.
-h / --help: Show a help message and exit. Provides information about command usage.
--reset: Reset the status of receive-wal, restarting the streaming from the current WAL file of the server.
--stop: Stop the process for the server.

WARNING:

The --stop option for the barman receive-wal command will be obsoleted in a future release. Users should favor using the terminate-process command instead, which is the new way of handling this feature.

AUTHOR

EnterpriseDB

COPYRIGHT

January 7, 2026

3.17