proxmox-backup-client backup {<backupspec>} [OPTIONS]

Create (host) backup.

<backupspec> <array>:
 List of backup source specifications ([<label.ext>:<path>] …)

Optional parameters:

--backup-id <string>:
 Backup ID.
--backup-time <integer> (1547797308 - N):
 Backup time (Unix epoch.)
--backup-type <string>:
 Backup type.
--chunk-size <integer> (64 - 4096)   (default=4096):
 Chunk size in KB. Must be a power of 2.
--crypt-mode <string>   (default=encrypt):
 Defines whether data is encrypted (using an AEAD cipher), only signed, or neither.
--entries-max <integer>   (default=1048576):
 Max number of entries to hold in memory.
--exclude <array>:
 List of paths or patterns for matching files to exclude.
--include-dev <array>:
 Include mountpoints with same st_dev number (see man fstat) as specified files.
--keyfd <integer> (0 - N):
 Pass an encryption key via an already opened file descriptor.
--keyfile <string>:
 Path to encryption key. All data will be encrypted using this key.
--repository <string>:
 Repository URL.
--skip-lost-and-found <boolean>:
 Skip lost+found directory.
--verbose <boolean>:
 Verbose output.

proxmox-backup-client benchmark [OPTIONS]

Run benchmark tests

Optional parameters:

--keyfile <string>:
 Path to encryption key. All data will be encrypted using this key.
--output-format <string>:
 Output format.
--repository <string>:
 Repository URL.
--verbose <boolean>:
 Verbose output.

proxmox-backup-client catalog dump <snapshot> [OPTIONS]

Dump catalog.

<snapshot> <string>:
 Snapshot path.

Optional parameters:

--keyfd <integer> (0 - N):
 Pass an encryption key via an already opened file descriptor.
--keyfile <string>:
 Path to encryption key.
--repository <string>:
 Repository URL.

proxmox-backup-client catalog shell <snapshot> <archive-name> [OPTIONS]

Shell to interactively inspect and restore snapshots.

<snapshot> <string>:
 Group/Snapshot path.
<archive-name> <string>:
 Backup archive name.

Optional parameters:

--keyfd <integer> (0 - N):
 Pass an encryption key via an already opened file descriptor.
--keyfile <string>:
 Path to encryption key.
--repository <string>:
 Repository URL.

proxmox-backup-client files <snapshot> [OPTIONS]

List snapshot files.

<snapshot> <string>:
 Snapshot path.

Optional parameters:

--output-format <string>:
 Output format.
--repository <string>:
 Repository URL.

proxmox-backup-client forget <snapshot> [OPTIONS]

Forget (remove) backup snapshots.

<snapshot> <string>:
 Snapshot path.

Optional parameters:

--repository <string>:
 Repository URL.

proxmox-backup-client garbage-collect [OPTIONS]

Start garbage collection for a specific repository.

Optional parameters:

--output-format <string>:
 Output format.
--repository <string>:
 Repository URL.

proxmox-backup-client help [{<command>}] [OPTIONS]

Get help about specified command (or sub-command).

<command> <array>:
 Command. This may be a list in order to spefify nested sub-commands.

Optional parameters:

--verbose <boolean>:
 Verbose help.

proxmox-backup-client key change-passphrase [<path>] [OPTIONS]

Change the encryption key’s password.

<path> <string>:
 Key file. Without this the default key’s password will be changed.

Optional parameters:

--kdf <string>   (default=scrypt):
 Key derivation function for password protected encryption keys.

proxmox-backup-client key create [<path>] [OPTIONS]

Create a new encryption key.

<path> <string>:
 Output file. Without this the key will become the new default encryption key.

Optional parameters:

--kdf <string>   (default=scrypt):
 Key derivation function for password protected encryption keys.

proxmox-backup-client key create-master-key

Create an RSA public/private key pair used to put an encrypted version of the symmetric backup encryption key onto the backup server along with each backup.

proxmox-backup-client key import-master-pubkey <path>

Import an RSA public key used to put an encrypted version of the symmetric backup encryption key onto the backup server along with each backup.

<path> <string>:
 Path to the PEM formatted RSA public key.

proxmox-backup-client key paper-key [<path>] [OPTIONS]

Generate a printable, human readable text file containing the encryption key.

This also includes a scanable QR code for fast key restore.

<path> <string>:
 Key file. Without this the default key’s will be used.

Optional parameters:

--output-format <string>:
 Paperkey output format
--subject <string>:
 Include the specified subject as titel text.

proxmox-backup-client list [OPTIONS]

List backup groups.

Optional parameters:

--output-format <string>:
 Output format.
--repository <string>:
 Repository URL.

proxmox-backup-client login [OPTIONS]

Try to login. If successful, store ticket.

Optional parameters:

--repository <string>:
 Repository URL.

proxmox-backup-client logout [OPTIONS]

Logout (delete stored ticket).

Optional parameters:

--repository <string>:
 Repository URL.

proxmox-backup-client mount <snapshot> <archive-name> <target> [OPTIONS]

Mount pxar archive.

<snapshot> <string>:
 Group/Snapshot path.
<archive-name> <string>:
 Backup archive name.
<target> <string>:
 Target directory path.

Optional parameters:

--keyfile <string>:
 Path to encryption key.
--repository <string>:
 Repository URL.
--verbose <boolean>   (default=false):
 Verbose output.

proxmox-backup-client prune <group> [OPTIONS]

Prune a backup repository.

<group> <string>:
 Backup group.

Optional parameters:

--dry-run <boolean>:
 Just show what prune would do, but do not delete anything.
--keep-daily <integer> (1 - N):
 Number of daily backups to keep.
--keep-hourly <integer> (1 - N):
 Number of hourly backups to keep.
--keep-last <integer> (1 - N):
 Number of backups to keep.
--keep-monthly <integer> (1 - N):
 Number of monthly backups to keep.
--keep-weekly <integer> (1 - N):
 Number of weekly backups to keep.
--keep-yearly <integer> (1 - N):
 Number of yearly backups to keep.
--output-format <string>:
 Output format.
--quiet <boolean>:
 Minimal output - only show removals.
--repository <string>:
 Repository URL.

proxmox-backup-client restore <snapshot> <archive-name> <target> [OPTIONS]

Restore backup repository.

<snapshot> <string>:
 

Group/Snapshot path.
<archive-name> <string>:
 

Backup archive name.
<target> <string>:
 

Target directory path. Use ‘-‘ to write to standard output.

We do not extraxt ‘.pxar’ archives when writing to standard output.

Optional parameters:

--allow-existing-dirs <boolean>:
 Do not fail if directories already exists.
--crypt-mode <string>   (default=encrypt):
 Defines whether data is encrypted (using an AEAD cipher), only signed, or neither.
--keyfd <integer> (0 - N):
 Pass an encryption key via an already opened file descriptor.
--keyfile <string>:
 Path to encryption key. All data will be encrypted using this key.
--repository <string>:
 Repository URL.

proxmox-backup-client snapshots [<group>] [OPTIONS]

List backup snapshots.

<group> <string>:
 Backup group.

Optional parameters:

--output-format <string>:
 Output format.
--repository <string>:
 Repository URL.

proxmox-backup-client status [OPTIONS]

Get repository status.

Optional parameters:

--output-format <string>:
 Output format.
--repository <string>:
 Repository URL.

proxmox-backup-client task list [OPTIONS]

List running server tasks for this repo user

Optional parameters:

--all <boolean>:
 Also list stopped tasks.
--limit <integer> (1 - 1000)   (default=50):
 The maximal number of tasks to list.
--output-format <string>:
 Output format.
--repository <string>:
 Repository URL.

proxmox-backup-client task log <upid> [OPTIONS]

Display the task log.

<upid> <string>:
 Unique Process/Task ID.

Optional parameters:

--repository <string>:
 Repository URL.

proxmox-backup-client task stop <upid> [OPTIONS]

Try to stop a specific task.

<upid> <string>:
 Unique Process/Task ID.

Optional parameters:

--repository <string>:
 Repository URL.

proxmox-backup-client upload-log <snapshot> <logfile> [OPTIONS]

Upload backup log file.

<snapshot> <string>:
 Group/Snapshot path.
<logfile> <string>:
 The path to the log file you want to upload.

Optional parameters:

--crypt-mode <string>   (default=encrypt):
 Defines whether data is encrypted (using an AEAD cipher), only signed, or neither.
--keyfd <integer> (0 - N):
 Pass an encryption key via an already opened file descriptor.
--keyfile <string>:
 Path to encryption key. All data will be encrypted using this key.
--repository <string>:
 Repository URL.

proxmox-backup-client version [OPTIONS]

Show client and optional server version

Optional parameters:

--output-format <string>:
 Output format.
--repository <string>:
 Repository URL.