Command Syntax

proxmox-backup-client

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 change-owner <group> <new-owner> [OPTIONS]

Change owner of a backup group

<group> <string>:
 Backup group.
<new-owner> <string>:
 Authentication ID

Optional parameters:

--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 paperkey [<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 map <snapshot> <archive-name> [OPTIONS]

Map a drive image from a VM backup to a local loopback device. Use ‘unmap’ to undo. WARNING: Only do this with trusted backups!

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

Optional parameters:

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

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 and stay in foreground.

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 unmap [<name>]

Unmap a loop device mapped with ‘map’ and release all resources.

<name> <string>:
 Archive name, path to loopdev (/dev/loopX) or loop device number. Omit to list all current mappings and force cleaning up leftover instances.

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.

Catalog Shell Commands

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

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

cd [<path>]

Change the current working directory to the new directory

<path> <string>:
 target path.

clear-selected

Clear the list of files selected for restore.


deselect <path>

Deselect an entry for restore.

This will return an error if the entry was not found in the list of entries selected for restore.

<path> <string>:
 path to entry to remove from list.

exit

Exit the shell


find <pattern> [OPTIONS]

Find entries in the catalog matching the given match pattern.

<pattern> <string>:
 Match pattern for matching files in the catalog.

Optional parameters:

--select <boolean>   (default=false):
 Add matching filenames to list for restore.

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.

list-selected [OPTIONS]

List entries currently selected for restore.

Optional parameters:

--patterns <boolean>   (default=false):
 List match patterns instead of the matching files.

ls [<path>]

List the content of working directory or given path.

<path> <string>:
 target path.

pwd

List the current working directory.


restore <target> [OPTIONS]

Restore the sub-archive given by the current working directory to target.

By further providing a pattern, the restore can be limited to a narrower subset of this sub-archive. If pattern is not present or empty, the full archive is restored to target.

<target> <string>:
 target path for restore on local filesystem.

Optional parameters:

--pattern <string>:
 match pattern to limit files for restore.

restore-selected <target>

Restore the selected entries to the given target path.

Target must not exist on the clients filesystem.

<target> <string>:
 target path for restore on local filesystem.

select <path>

Select an entry for restore.

This will return an error if the entry is already present in the list or if an invalid path was provided.

<path> <string>:
 target path.

stat <path>

Read the metadata for a given directory entry.

This is expensive because the data has to be read from the pxar archive, which means reading over the network.

<path> <string>:
 target path.

proxmox-backup-manager

proxmox-backup-manager acl list [OPTIONS]

Access Control list.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager acl update <path> <role> [OPTIONS]

Update Access Control List (ACLs).

<path> <string>:
 Access control path.
<role> <string>:
 Role

Optional parameters:

--auth-id <string>:
 Authentication ID
--delete <boolean>:
 Remove permissions (instead of adding it).
--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--group <string>:
 Group ID
--propagate <boolean>   (default=true):
 Allow to propagate (inherit) permissions.

proxmox-backup-manager cert info

Display node certificate information.


proxmox-backup-manager cert update [OPTIONS]

Update node certificates and generate all needed files/directories.

Optional parameters:

--force <boolean>:
 Force generation of new SSL certifate.

proxmox-backup-manager datastore create <name> <path> [OPTIONS]

Create new datastore config.

<name> <string>:
 Datastore name.
<path> <string>:
 Directory name

Optional parameters:

--comment <string>:
 Comment (single line).
--gc-schedule <string>:
 Run garbage collection job at specified schedule.
--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.
--notify <string>:
 Datastore notification setting
--notify-user <string>:
 User ID
--prune-schedule <string>:
 Run prune job at specified schedule.

proxmox-backup-manager datastore list [OPTIONS]

Datastore list.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager datastore remove <name> [OPTIONS]

Remove a datastore configuration.

<name> <string>:
 Datastore name.

Optional parameters:

--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.

proxmox-backup-manager datastore show <name> [OPTIONS]

Show datastore configuration

<name> <string>:
 Datastore name.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager datastore update <name> [OPTIONS]

Update datastore config.

<name> <string>:
 Datastore name.

Optional parameters:

--comment <string>:
 Comment (single line).
--delete <array>:
 List of properties to delete.
--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--gc-schedule <string>:
 Run garbage collection job at specified schedule.
--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.
--notify <string>:
 Datastore notification setting
--notify-user <string>:
 User ID
--prune-schedule <string>:
 Run prune job at specified schedule.
--verify-new <boolean>   (default=false):
 If enabled, all new backups will be verified right after completion.

proxmox-backup-manager disk fs create <name> --disk <string> [OPTIONS]

Create a Filesystem on an unused disk. Will be mounted under ‘/mnt/datastore/<name>’.

<name> <string>:
 Datastore name.
--disk <string>:
 Block device name (/sys/block/<name>).

Optional parameters:

--add-datastore <boolean>:
 Configure a datastore using the directory.
--filesystem <string>:
 

proxmox-backup-manager disk fs list [OPTIONS]

List systemd datastore mount units.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager disk initialize <disk> [OPTIONS]

Initialize empty Disk with GPT

<disk> <string>:
 Block device name (/sys/block/<name>).

Optional parameters:

--uuid <string>:
 UUID for the GPT table.

proxmox-backup-manager disk list [OPTIONS]

Local disk list.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager disk smart-attributes <disk> [OPTIONS]

Show SMART attributes.

<disk> <string>:
 Block device name (/sys/block/<name>).

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager disk zpool create <name> --devices <string> --raidlevel <string> [OPTIONS]

create a zfs pool

<name> <string>:
 Datastore name.
--devices <string>:
 A list of disk names, comma separated.
--raidlevel <string>:
 The ZFS RAID level to use.

Optional parameters:

--add-datastore <boolean>:
 Configure a datastore using the zpool.
--ashift <integer> (9 - 16)   (default=12):
 Pool sector size exponent.
--compression <string>   (default=On):
 The ZFS compression algorithm to use.

proxmox-backup-manager disk zpool list [OPTIONS]

Local zfs pools.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager dns get [OPTIONS]

Read DNS settings

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager dns set [OPTIONS]

Update DNS settings.

Optional parameters:

--delete <array>:
 List of properties to delete.
--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--dns1 <string>:
 First name server IP address.
--dns2 <string>:
 Second name server IP address.
--dns3 <string>:
 Third name server IP address.
--search <string>:
 Search domain for host-name lookup.

proxmox-backup-manager garbage-collection start <store> [OPTIONS]

Start garbage collection for a specific datastore.

<store> <string>:
 Datastore name.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager garbage-collection status <store> [OPTIONS]

Show garbage collection status for a specific datastore.

<store> <string>:
 Datastore name.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager 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-manager network changes

Show pending configuration changes (diff)


proxmox-backup-manager network create <iface> [OPTIONS]

Create network interface configuration.

<iface> <string>:
 Network interface name.

Optional parameters:

--autostart <boolean>:
 Autostart interface.
--bond-primary <string>:
 Network interface name.
--bond_mode <string>:
 Linux Bond Mode
--bond_xmit_hash_policy <string>:
 Bond Transmit Hash Policy for LACP (802.3ad)
--bridge_ports <string>:
 A list of network devices, comma separated.
--bridge_vlan_aware <boolean>:
 Enable bridge vlan support.
--cidr <string>:
 IPv4 address with netmask (CIDR notation).
--cidr6 <string>:
 IPv6 address with netmask (CIDR notation).
--comments <string>:
 Comments (inet, may span multiple lines)
--comments6 <string>:
 Comments (inet5, may span multiple lines)
--gateway <string>:
 IPv4 address.
--gateway6 <string>:
 IPv6 address.
--method <string>:
 Interface configuration method
--method6 <string>:
 Interface configuration method
--mtu <integer> (46 - 65535)   (default=1500):
 Maximum Transmission Unit.
--slaves <string>:
 A list of network devices, comma separated.
--type <string>:
 Network interface type

proxmox-backup-manager network list [OPTIONS]

Network device list.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager network reload

Reload network configuration (requires ifupdown2).


proxmox-backup-manager network remove <iface> [OPTIONS]

Remove network interface configuration.

<iface> <string>:
 Network interface name.

Optional parameters:

--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.

proxmox-backup-manager network revert

Revert network configuration (rm /etc/network/interfaces.new).


proxmox-backup-manager network update <iface> [OPTIONS]

Update network interface config.

<iface> <string>:
 Network interface name.

Optional parameters:

--autostart <boolean>:
 Autostart interface.
--bond-primary <string>:
 Network interface name.
--bond_mode <string>:
 Linux Bond Mode
--bond_xmit_hash_policy <string>:
 Bond Transmit Hash Policy for LACP (802.3ad)
--bridge_ports <string>:
 A list of network devices, comma separated.
--bridge_vlan_aware <boolean>:
 Enable bridge vlan support.
--cidr <string>:
 IPv4 address with netmask (CIDR notation).
--cidr6 <string>:
 IPv6 address with netmask (CIDR notation).
--comments <string>:
 Comments (inet, may span multiple lines)
--comments6 <string>:
 Comments (inet5, may span multiple lines)
--delete <array>:
 List of properties to delete.
--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--gateway <string>:
 IPv4 address.
--gateway6 <string>:
 IPv6 address.
--method <string>:
 Interface configuration method
--method6 <string>:
 Interface configuration method
--mtu <integer> (46 - 65535)   (default=1500):
 Maximum Transmission Unit.
--slaves <string>:
 A list of network devices, comma separated.
--type <string>:
 Network interface type

proxmox-backup-manager pull <remote> <remote-store> <local-store> [OPTIONS]

Sync datastore from another repository

<remote> <string>:
 Remote ID.
<remote-store> <string>:
 Datastore name.
<local-store> <string>:
 Datastore name.

Optional parameters:

--output-format <string>:
 Output format.
--remove-vanished <boolean>   (default=true):
 Delete vanished backups. This remove the local copy if the remote backup was deleted.

proxmox-backup-manager remote create <name> --auth-id <string> --host <string> --password <string> [OPTIONS]

Create new remote.

<name> <string>:
 Remote ID.
--auth-id <string>:
 Authentication ID
--host <string>:
 DNS name or IP address.
--password <string>:
 Password or auth token for remote host.

Optional parameters:

--comment <string>:
 Comment (single line).
--fingerprint <string>:
 X509 certificate fingerprint (sha256).
--port <integer>   (default=8007):
 The (optional) port.

proxmox-backup-manager remote list [OPTIONS]

List configured remotes.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager remote remove <name> [OPTIONS]

Remove a remote from the configuration file.

<name> <string>:
 Remote ID.

Optional parameters:

--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.

proxmox-backup-manager remote show <name> [OPTIONS]

Show remote configuration

<name> <string>:
 Remote ID.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager remote update <name> [OPTIONS]

Update remote configuration.

<name> <string>:
 Remote ID.

Optional parameters:

--auth-id <string>:
 Authentication ID
--comment <string>:
 Comment (single line).
--delete <array>:
 List of properties to delete.
--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--fingerprint <string>:
 X509 certificate fingerprint (sha256).
--host <string>:
 DNS name or IP address.
--password <string>:
 Password or auth token for remote host.
--port <integer>:
 The (optional) port.

proxmox-backup-manager report

System report

proxmox-backup-manager subscription get [OPTIONS]

Read subscription info.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager subscription remove

Delete subscription info.


proxmox-backup-manager subscription set <key>

Set a subscription key and check it.

<key> <string>:Proxmox Backup Server subscription key.

proxmox-backup-manager subscription update [OPTIONS]

Check and update subscription status.

Optional parameters:

--force <boolean>   (default=false):
 Always connect to server, even if information in cache is up to date.

proxmox-backup-manager sync-job create <id> --remote <string> --remote-store <string> --store <string> [OPTIONS]

Create a new sync job.

<id> <string>:Job ID.
--remote <string>:
 Remote ID.
--remote-store <string>:
 Datastore name.
--store <string>:
 Datastore name.

Optional parameters:

--comment <string>:
 Comment (single line).
--owner <string>:
 Authentication ID
--remove-vanished <boolean>   (default=true):
 Delete vanished backups. This remove the local copy if the remote backup was deleted.
--schedule <string>:
 Run sync job at specified schedule.

proxmox-backup-manager sync-job list [OPTIONS]

Sync job list.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager sync-job remove <id> [OPTIONS]

Remove a sync job configuration

<id> <string>:Job ID.

Optional parameters:

--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.

proxmox-backup-manager sync-job show <id> [OPTIONS]

Show sync job configuration

<id> <string>:Job ID.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager sync-job update <id> [OPTIONS]

Update sync job config.

<id> <string>:Job ID.

Optional parameters:

--comment <string>:
 Comment (single line).
--delete <array>:
 List of properties to delete.
--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--owner <string>:
 Authentication ID
--remote <string>:
 Remote ID.
--remote-store <string>:
 Datastore name.
--remove-vanished <boolean>   (default=true):
 Delete vanished backups. This remove the local copy if the remote backup was deleted.
--schedule <string>:
 Run sync job at specified schedule.
--store <string>:
 Datastore name.

proxmox-backup-manager task list [OPTIONS]

List running server tasks.

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.

proxmox-backup-manager task log <upid>

Display the task log.

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

proxmox-backup-manager task stop <upid>

Try to stop a specific task.

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

proxmox-backup-manager user create <userid> [OPTIONS]

Create new user.

<userid> <string>:
 User ID

Optional parameters:

--comment <string>:
 Comment (single line).
--email <string>:
 E-Mail Address.
--enable <boolean>   (default=true):
 Enable the account (default). You can set this to ‘0’ to disable the account.
--expire <integer> (0 - N)   (default=0):
 Account expiration date (seconds since epoch). ‘0’ means no expiration date.
--firstname <string>:
 First name.
--lastname <string>:
 Last name.
--password <string>:
 User Password.

proxmox-backup-manager user delete-token <userid> <tokenname> [OPTIONS]

Delete a user’s API token

<userid> <string>:
 

User ID

<tokenname> <string>:
 

The token ID part of an API token authentication id.

This alone does NOT uniquely identify the API token and therefore does not implement Eq. In order to compare token IDs directly, they need to be explicitly compared as strings by calling .as_str().

`compile_fail fn test(a: Tokenname, b: Tokenname) -> bool { a == b // illegal and does not compile } `

Optional parameters:

--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.

proxmox-backup-manager user generate-token <userid> <tokenname> [OPTIONS]

Generate a new API token with given metadata

<userid> <string>:
 

User ID

<tokenname> <string>:
 

The token ID part of an API token authentication id.

This alone does NOT uniquely identify the API token and therefore does not implement Eq. In order to compare token IDs directly, they need to be explicitly compared as strings by calling .as_str().

`compile_fail fn test(a: Tokenname, b: Tokenname) -> bool { a == b // illegal and does not compile } `

Optional parameters:

--comment <string>:
 Comment (single line).
--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--enable <boolean>   (default=true):
 Enable the account (default). You can set this to ‘0’ to disable the account.
--expire <integer> (0 - N)   (default=0):
 Account expiration date (seconds since epoch). ‘0’ means no expiration date.

proxmox-backup-manager user list [OPTIONS]

List configured users.

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager user list-tokens <userid> [OPTIONS]

List tokens associated with user.

<userid> <string>:
 User ID

Optional parameters:

--output-format <string>:
 Output format.

proxmox-backup-manager user permissions <auth-id> [OPTIONS]

List permissions of user/token.

<auth-id> <string>:
 Authentication ID

Optional parameters:

--output-format <string>:
 Output format.
--path <string>:
 Access control path.

proxmox-backup-manager user remove <userid> [OPTIONS]

Remove a user from the configuration file.

<userid> <string>:
 User ID

Optional parameters:

--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.

proxmox-backup-manager user update <userid> [OPTIONS]

Update user configuration.

<userid> <string>:
 User ID

Optional parameters:

--comment <string>:
 Comment (single line).
--digest <string>:
 Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--email <string>:
 E-Mail Address.
--enable <boolean>   (default=true):
 Enable the account (default). You can set this to ‘0’ to disable the account.
--expire <integer> (0 - N)   (default=0):
 Account expiration date (seconds since epoch). ‘0’ means no expiration date.
--firstname <string>:
 First name.
--lastname <string>:
 Last name.
--password <string>:
 User Password.

proxmox-backup-manager verify <store> [OPTIONS]

Verify backups

<store> <string>:
 Datastore name.

Optional parameters:

--output-format <string>:
 Output format.

pxar

pxar create <archive> <source> [OPTIONS]

Create a new .pxar archive.

<archive> <string>:
 Archive name.
<source> <string>:
 Source directory.

Optional parameters:

--all-file-systems <boolean>   (default=false):
 Include mounted sudirs.
--entries-max <integer> (0 - 9223372036854775807)   (default=1048576):
 Max number of entries loaded at once into memory
--exclude <array>:
 List of paths or pattern matching files to exclude.
--no-acls <boolean>   (default=false):
 Ignore access control list entries.
--no-device-nodes <boolean>   (default=false):
 Ignore device nodes.
--no-fcaps <boolean>   (default=false):
 Ignore file capabilities.
--no-fifos <boolean>   (default=false):
 Ignore fifos.
--no-sockets <boolean>   (default=false):
 Ignore sockets.
--no-xattrs <boolean>   (default=false):
 Ignore extended file attributes.
--verbose <boolean>   (default=false):
 Verbose output.

pxar extract <archive> [<target>] [OPTIONS]

Extract an archive.

<archive> <string>:
 Archive name.
<target> <string>:
 Target directory

Optional parameters:

--allow-existing-dirs <boolean>   (default=false):
 Allows directories to already exist on restore.
--files-from <string>:
 File containing match pattern for files to restore.
--no-acls <boolean>   (default=false):
 Ignore access control list entries.
--no-device-nodes <boolean>   (default=false):
 Ignore device nodes.
--no-fcaps <boolean>   (default=false):
 Ignore file capabilities.
--no-fifos <boolean>   (default=false):
 Ignore fifos.
--no-sockets <boolean>   (default=false):
 Ignore sockets.
--no-xattrs <boolean>   (default=false):
 Ignore extended file attributes.
--pattern <array>:
 List of paths or pattern matching files to restore
--strict <boolean>   (default=false):
 Stop on errors. Otherwise most errors will simply warn.
--verbose <boolean>   (default=false):
 Verbose output.

pxar 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.

pxar list <archive> [OPTIONS]

List the contents of an archive.

<archive> <string>:
 Archive name.

Optional parameters:

--verbose <boolean>   (default=false):
 Verbose output.

pxar mount <archive> <mountpoint> [OPTIONS]

Mount the archive to the provided mountpoint via FUSE.

<archive> <string>:
 Archive name.
<mountpoint> <string>:
 Mountpoint for the file system.

Optional parameters:

--verbose <boolean>   (default=false):
 Verbose output, running in the foreground (for debugging).