---
name: "barman-wal-restore"
section: "1"
platform: "linux"
package: "barman-cli"
version: "3.13.3-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/barman-wal-restore"
---

# barman-wal-restore(1)

Barman-cli Commands

## NAME

barman-wal-restore - Barman-cli Commands

## SYNOPSIS

```
barman-wal-restore
    [ { -h | --help } ]
    [ { -V | --version } ]
    [ { -U | --user } USER ]
    [ --port PORT ]
    [ { -s | --sleep } SECONDS ]
    [ { -p | --parallel } JOBS ]
    [ --spool-dir SPOOL_DIR ]
    [ { -P | --partial } ]
    [ { { -z | --gzip } | { -j | --bzip2 } | --keep-compression } ]
    [ { -c | --config } CONFIG ]
    [ { -t | --test } ]
    BARMAN_HOST SERVER_NAME WAL_NAME WAL_DEST
```

## DESCRIPTION

This script serves as a **restore\_command** for Postgres servers, enabling the retrieval of WAL files through Barman's **get-wal** feature. It establishes an SSH connection to the Barman host and facilitates the integration of Barman within Postgres clusters, enhancing business continuity.

**Exit Statuses** are:

- •

  **0** for **SUCCESS**.

- •

  **1** for remote get-wal command **FAILURE**, likely because the requested WAL could not be found.

- •

  **2** for ssh connection **FAILURE**.

- •

  Any other **non-zero** for **FAILURE**.

## PARAMETERS

- **SERVER\_NAME**

  The server name configured in Barman for the Postgres server from which the WAL file is retrieved.

- **BARMAN\_HOST**

  The host of the Barman server.

- **WAL\_NAME**

  The value of the '%f' keyword (according to **restore\_command**).

- **WAL\_DEST**

  The value of the '%p' keyword (according to **restore\_command**).

- **-h / --help**

  Display a help message and exit.

- **-V / --version**

  Display the program's version number and exit.

- **-U / --user**

  Specify the user for the SSH connection to the Barman server (defaults to **barman**).

- **--port**

  Define the port used for the SSH connection to the Barman server.

- **-s / --sleep**

  Pause for **SECONDS** after a failed **get-wal** request (defaults to **0** - no wait).

- **-p / --parallel**

  Indicate the number of files to **peek** and transfer simultaneously (defaults to **0** - disabled).

- **--spool-dir**

  Specify the spool directory for WAL files (defaults to **/var/tmp/walrestore**).

- **-P / --partial**

  Include partial WAL files (.partial) in the retrieval.

- **-z / --gzip**

  Transfer WAL files compressed with **gzip**.

- **-j / --bzip2**

  Transfer WAL files compressed with **bzip2**.

- **--keep-compression**

  If specified, compressed files will be trasnfered as-is and decompressed on arrival on the client-side.

- **-c / --config**

  Specify the configuration file on the Barman server.

- **-t / --test**

  Test the connection and configuration of the specified Postgres server in Barman to ensure it is ready to receive WAL files. This option ignores the mandatory arguments **WAL\_NAME** and **WAL\_DEST**.

**WARNING:**

**-z** / **--gzip** and **-j** /  **--bzip2** options are deprecated and will be removed in the future. For WAL compression, please make sure to enable it directly on the Barman server via the **compression** configuration option.

## AUTHOR

EnterpriseDB

## COPYRIGHT

© Copyright EnterpriseDB UK Limited 2011-2025