proxmox-backup-client

Synopsis

Catalog Shell Commands

Those command are available when you start an intercative restore shell:

proxmox-backup-client shell <snapshot> <name.pxar>

Common Options

Most commands that produce output support the --output-format parameter. This accepts the following values:

text:

Text format (default). Structured data is rendered as a table.

json:

JSON (single line).

json-pretty:

JSON (multiple lines, nicely formatted).

Also, the following environment variables can modify output behavior:

PROXMOX_OUTPUT_FORMAT

Defines the default output format.

PROXMOX_OUTPUT_NO_BORDER

If set (to any value), do not render table borders.

PROXMOX_OUTPUT_NO_HEADER

If set (to any value), do not render table headers.

Note

The text format is designed to be human readable, and not meant to be parsed by automation tools. Please use the json format if you need to process the output.

Description

This tool implements a backup server client, i.e. it can connect to a backup servers to issue management commands and to create or restore backups.