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:

--all-file-systems <boolean>
Include all mounted subdirectories.
--backup-id <string>
Backup ID.
--backup-time <integer> (1547797308 - N)
Backup time (Unix epoch.)
--backup-type vm|ct|host
Backup type.
--chunk-size <integer> (64 - 4096)   (default=4096)
Chunk size in KB. Must be a power of 2.
--crypt-mode none|encrypt|sign-only   (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.
--master-pubkey-fd <integer> (0 - N)
Pass a master public key via an already opened file descriptor.
--master-pubkey-file <string>
Path to master public key. The encryption key used for a backup will be encrypted using this key and appended to the backup.
--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 text|json|json-pretty
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 garbage-collect [OPTIONS]

Start garbage collection for a specific repository.

Optional parameters:

--output-format text|json|json-pretty
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:

--hint <string>
Password hint.
--kdf none|scrypt|pbkdf2   (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:

--hint <string>
Password hint.
--kdf none|scrypt|pbkdf2   (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.

The imported key will be used as default master key for future invocations by the same local user.

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

proxmox-backup-client key import-with-master-key [<path>] --encrypted-keyfile <string> --master-keyfile <string> [OPTIONS]

Import an encrypted backup of an encryption key using a (private) master key.

<path> : <string>
Output file. Without this the key will become the new default encryption key.
--encrypted-keyfile <string>
RSA-encrypted keyfile to import.
--master-keyfile <string>
(Private) master key to use.

Optional parameters:

--hint <string>
Password hint.
--kdf none|scrypt|pbkdf2   (default=scrypt)
Key derivation function for password protected encryption keys.

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 text|html
Paperkey output format
--subject <string>
Include the specified subject as title text.

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

Print the encryption key's metadata.

<path> : <string>
Key file. Without this the default key's metadata will be shown.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-backup-client key show-master-pubkey [<path>] [OPTIONS]

List information about master key

<path> : <string>
Path to the PEM formatted RSA public key. Default location will be used if not specified.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-backup-client list [OPTIONS]

List backup groups.

Optional parameters:

--output-format text|json|json-pretty
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 text|json|json-pretty
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 extract '.pxar' archives when writing to standard output.

Optional parameters:

--allow-existing-dirs <boolean>
Do not fail if directories already exists.
--crypt-mode none|encrypt|sign-only   (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 snapshot files <snapshot> [OPTIONS]

List snapshot files.

<snapshot> : <string>
Snapshot path.

Optional parameters:

--output-format text|json|json-pretty
Output format.
--repository <string>
Repository URL.

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

Forget (remove) backup snapshots.

<snapshot> : <string>
Snapshot path.

Optional parameters:

--repository <string>
Repository URL.

proxmox-backup-client snapshot list [<group>] [OPTIONS]

List backup snapshots.

<group> : <string>
Backup group.

Optional parameters:

--output-format text|json|json-pretty
Output format.
--repository <string>
Repository URL.

proxmox-backup-client snapshot notes show <snapshot> [OPTIONS]

Show notes

<snapshot> : <string>
Snapshot path.

Optional parameters:

--output-format text|json|json-pretty
Output format.
--repository <string>
Repository URL.

proxmox-backup-client snapshot notes update <snapshot> <notes> [OPTIONS]

Update Notes

<snapshot> : <string>
Snapshot path.
<notes> : <string>
The Notes.

Optional parameters:

--repository <string>
Repository URL.

proxmox-backup-client snapshot 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 none|encrypt|sign-only   (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 status [OPTIONS]

Get repository status.

Optional parameters:

--output-format text|json|json-pretty
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 text|json|json-pretty
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 version [OPTIONS]

Show client and optional server version

Optional parameters:

--output-format text|json|json-pretty
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 text|json|json-pretty
Output format.

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

Update Access Control List (ACLs).

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

Enum representing roles via their [PRIVILEGES] combination.

Since privileges are implemented as bitflags, each unique combination of privileges maps to a single, unique u64 value that is used in this enum definition.

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 acme account deactivate <name> [OPTIONS]

Deactivate an ACME account.

<name> : <string>
ACME account name.

Optional parameters:

--force <boolean>   (default=false)
Delete account data even if the server refuses to deactivate the account.

proxmox-backup-manager acme account info <name> [OPTIONS]

Show acme account information.

<name> : <string>
ACME account name.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-backup-manager acme account list [OPTIONS]

List acme accounts.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-backup-manager acme account register <name> <contact> [OPTIONS]

Register an ACME account.

<name> : <string>
ACME account name.
<contact> : <string>
List of email addresses.

Optional parameters:

--directory <string>
The ACME Directory.

proxmox-backup-manager acme account update <name> [OPTIONS]

Update an ACME account.

<name> : <string>
ACME account name.

Optional parameters:

--contact <string>
List of email addresses.

proxmox-backup-manager acme cert order [OPTIONS]

Order a new ACME certificate.

Optional parameters:

--force <boolean>   (default=false)
Force renewal even if the certificate does not expire soon.

proxmox-backup-manager acme cert revoke

Order a new ACME certificate.

proxmox-backup-manager acme plugin add <type> [<id>] --data <string> [OPTIONS]

Show acme account information.

<type> : <string>
The ACME challenge plugin type.
<id> : <string>
ACME Challenge Plugin ID.
--data <string>
File containing the plugin data.

Optional parameters:

--api <string>
DNS API Plugin Id.
--disable <boolean>   (default=false)
Flag to disable the config.
--validation-delay <integer> (0 - 172800)   (default=30)

Extra delay in seconds to wait before requesting validation.

Allows to cope with long TTL of DNS records.

proxmox-backup-manager acme plugin config <id> [OPTIONS]

Show acme account information.

<id> : <string>
Plugin ID

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-backup-manager acme plugin list [OPTIONS]

List acme plugins.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-backup-manager acme plugin remove <id>

Delete an ACME plugin configuration.

<id> : <string>
ACME Challenge Plugin ID.

proxmox-backup-manager acme plugin set [<id>] [OPTIONS]

Update an ACME plugin configuration.

<id> : <string>
ACME Challenge Plugin ID.

Optional parameters:

--data <string>
DNS plugin data (base64 encoded with padding).
--delete <string>
Options to remove from the configuration
--digest <string>
Digest to protect against concurrent updates
--api <string>
DNS API Plugin Id.
--disable <boolean>   (default=false)
Flag to disable the config.
--validation-delay <integer> (0 - 172800)   (default=30)

Extra delay in seconds to wait before requesting validation.

Allows to cope with long TTL of DNS records.

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 <calendar-event>
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 [[gc=<enum>] [,sync=<enum>] [,verify=<enum>]]
Datastore notification setting
--notify-user <string>
User ID
--prune-schedule <calendar-event>
Run prune job at specified schedule.

proxmox-backup-manager datastore list [OPTIONS]

Datastore list.

Optional parameters:

--output-format text|json|json-pretty
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 text|json|json-pretty
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 <calendar-event>
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 [[gc=<enum>] [,sync=<enum>] [,verify=<enum>]]
Datastore notification setting
--notify-user <string>
User ID
--prune-schedule <calendar-event>
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 ext4|xfs

proxmox-backup-manager disk fs list [OPTIONS]

List systemd datastore mount units.

Optional parameters:

--output-format text|json|json-pretty
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 text|json|json-pretty
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 text|json|json-pretty
Output format.

proxmox-backup-manager disk zpool create <name> --devices [<string>, ...] --raidlevel single|mirror|raid10|raidz|raidz2|raidz3 [OPTIONS]

create a zfs pool

<name> : <string>
Datastore name.
--devices [<string>, ...]
A list of disk names, comma separated.
--raidlevel single|mirror|raid10|raidz|raidz2|raidz3
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 gzip|lz4|lzjb|zle|on|off   (default=On)
The ZFS compression algorithm to use.

proxmox-backup-manager disk zpool list [OPTIONS]

Local zfs pools.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-backup-manager dns get [OPTIONS]

Read DNS settings

Optional parameters:

--output-format text|json|json-pretty
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 text|json|json-pretty
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 text|json|json-pretty
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 balance-rr|active-backup|balance-xor|broadcast|802.3ad|balance-tlb|balance-alb
Linux Bond Mode
--bond_xmit_hash_policy layer2|layer2+3|layer3+4
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 manual|static|dhcp|loopback
Interface configuration method
--method6 manual|static|dhcp|loopback
Interface configuration method
--mtu <integer> (46 - 65535)   (default=1500)
Maximum Transmission Unit.
--slaves [<string>, ...]
A list of network devices, comma separated.
--type loopback|eth|bridge|bond|vlan|alias|unknown
Network interface type

proxmox-backup-manager network list [OPTIONS]

Network device list.

Optional parameters:

--output-format text|json|json-pretty
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 balance-rr|active-backup|balance-xor|broadcast|802.3ad|balance-tlb|balance-alb
Linux Bond Mode
--bond_xmit_hash_policy layer2|layer2+3|layer3+4
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 manual|static|dhcp|loopback
Interface configuration method
--method6 manual|static|dhcp|loopback
Interface configuration method
--mtu <integer> (46 - 65535)   (default=1500)
Maximum Transmission Unit.
--slaves [<string>, ...]
A list of network devices, comma separated.
--type loopback|eth|bridge|bond|vlan|alias|unknown
Network interface type

proxmox-backup-manager node show [OPTIONS]

Show node configuration

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-backup-manager node update [OPTIONS]

Update the node configuration

Optional parameters:

--delete <string>
Options to remove from the configuration
--digest <string>
Digest to protect against concurrent updates
--acme [account=<string>]
The acme account to use on this node.
--acmedomain0 [domain=<string> [,alias=<string>] [,plugin=<string>]]
ACME domain configuration string
--acmedomain1 [domain=<string> [,alias=<string>] [,plugin=<string>]]
ACME domain configuration string
--acmedomain2 [domain=<string> [,alias=<string>] [,plugin=<string>]]
ACME domain configuration string
--acmedomain3 [domain=<string> [,alias=<string>] [,plugin=<string>]]
ACME domain configuration string
--acmedomain4 [domain=<string> [,alias=<string>] [,plugin=<string>]]
ACME domain configuration string
--http-proxy [http://]<host>[:port]
HTTP proxy configuration [http://]<host>[:port]

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 text|json|json-pretty
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 text|json|json-pretty
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 text|json|json-pretty
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 text|json|json-pretty
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 <calendar-event>
Run sync job at specified schedule.

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

Sync job list.

Optional parameters:

--output-format text|json|json-pretty
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 text|json|json-pretty
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 <calendar-event>
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 text|json|json-pretty
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 - use a full Authid for such use cases.

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 - use a full Authid for such use cases.

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 text|json|json-pretty
Output format.

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

List tokens associated with user.

<userid> : <string>
User ID

Optional parameters:

--output-format text|json|json-pretty
Output format.

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

List permissions of user/token.

<auth-id> : <string>
Authentication ID

Optional parameters:

--output-format text|json|json-pretty
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).
--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.
--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 text|json|json-pretty
Output format.

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

Create a new verification job.

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

Optional parameters:

--comment <string>
Comment (single line).
--ignore-verified <boolean>   (default=true)
Do not verify backups that are already verified if their verification is not outdated.
--outdated-after <integer> (1 - N)
Days after that a verification becomes outdated
--schedule <calendar-event>
Run verify job at specified schedule.

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

List all verification jobs

Optional parameters:

--output-format text|json|json-pretty
Output format.

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

Remove a verification 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 verify-job show <id> [OPTIONS]

Show verification job configuration

<id> : <string>
Job ID.

Optional parameters:

--output-format text|json|json-pretty
Output format.

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

Update verification 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.
--ignore-verified <boolean>   (default=true)
Do not verify backups that are already verified if their verification is not outdated.
--outdated-after <integer> (1 - N)
Days after that a verification becomes outdated
--schedule <calendar-event>
Run verify job at specified schedule.
--store <string>
Datastore name.

proxmox-backup-manager versions [OPTIONS]

List package versions for important Proxmox Backup Server packages.

Optional parameters:

--output-format text|json|json-pretty
Output format.
--verbose <boolean>   (default=false)
Output verbose package information. It is ignored if output-format is specified.

proxmox-tape

proxmox-tape backup <store> <pool> [OPTIONS]

Backup datastore to tape media pool

<store> : <string>
Datastore name.
<pool> : <string>
Media pool name.

Optional parameters:

--drive <string>
Drive Identifier.
--eject-media <boolean>
Eject media upon job completion.
--export-media-set <boolean>
Export media set upon job completion.
--latest-only <boolean>
Backup latest snapshots only.
--output-format text|json|json-pretty
Output format.

proxmox-tape backup-job create <id> --drive <string> --pool <string> --store <string> [OPTIONS]

Create a new tape backup job.

<id> : <string>
Job ID.
--drive <string>
Drive Identifier.
--pool <string>
Media pool name.
--store <string>
Datastore name.

Optional parameters:

--comment <string>
Comment (single line).
--schedule <calendar-event>
Run sync job at specified schedule.
--eject-media <boolean>
Eject media upon job completion.
--export-media-set <boolean>
Export media set upon job completion.
--latest-only <boolean>
Backup latest snapshots only.
--notify-user <string>
User ID

proxmox-tape backup-job list [OPTIONS]

Tape backup job list.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape backup-job remove <id> [OPTIONS]

Remove a tape backup 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-tape backup-job run <id>

Run THape Backup Job

<id> : <string>
Job ID.

proxmox-tape backup-job show <id> [OPTIONS]

Show tape backup job configuration

<id> : <string>
Job ID.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape backup-job update <id> [OPTIONS]

Update the tape backup job

<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.
--drive <string>
Drive Identifier.
--eject-media <boolean>
Eject media upon job completion.
--export-media-set <boolean>
Export media set upon job completion.
--latest-only <boolean>
Backup latest snapshots only.
--notify-user <string>
User ID
--pool <string>
Media pool name.
--schedule <calendar-event>
Run sync job at specified schedule.
--store <string>
Datastore name.

proxmox-tape barcode-label [OPTIONS]

Label media with barcodes from changer device

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.
--pool <string>
Media pool name.

proxmox-tape cartridge-memory [OPTIONS]

Read Cartridge Memory (Medium auxiliary memory attributes)

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.

proxmox-tape catalog [OPTIONS]

Scan media and record content

Optional parameters:

--drive <string>
Drive Identifier.
--force <boolean>
Force overriding existing index.
--output-format text|json|json-pretty
Output format.
--scan <boolean>
Re-read the whole tape to reconstruct the catalog instead of restoring saved versions.
--verbose <boolean>
Verbose mode - log all found chunks.

proxmox-tape changer config <name> [OPTIONS]

Get tape changer configuration

<name> : <string>
Tape Changer Identifier.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape changer create <name> --path <string> [OPTIONS]

Create a new changer device

<name> : <string>
Tape Changer Identifier.
--path <string>
Path to Linux generic SCSI device (e.g. '/dev/sg4')

Optional parameters:

--export-slots [<integer>, ...]
A list of slot numbers, comma separated. Those slots are reserved for Import/Export, i.e. any media in those slots are considered to be 'offline'.

proxmox-tape changer list [OPTIONS]

List changers

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape changer remove <name>

Delete a tape changer configuration

<name> : <string>
Tape Changer Identifier.

proxmox-tape changer scan [OPTIONS]

Scan for SCSI tape changers

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape changer status [<name>] [OPTIONS]

Get tape changer status

<name> : <string>
Tape Changer Identifier.

Optional parameters:

--cache <boolean>   (default=true)
Use cached value.
--output-format text|json|json-pretty
Output format.

proxmox-tape changer transfer [<name>] --from <integer> (1 - N) --to <integer> (1 - N)

Transfers media from one slot to another

<name> : <string>
Tape Changer Identifier.
--from <integer> (1 - N)
Source slot number
--to <integer> (1 - N)
Destination slot number

proxmox-tape changer update <name> [OPTIONS]

Update a tape changer configuration

<name> : <string>
Tape Changer Identifier.

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.
--export-slots [<integer>, ...]
A list of slot numbers, comma separated. Those slots are reserved for Import/Export, i.e. any media in those slots are considered to be 'offline'.
--path <string>
Path to Linux generic SCSI device (e.g. '/dev/sg4')

proxmox-tape clean [OPTIONS]

Clean drive

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.

proxmox-tape drive config <name> [OPTIONS]

Get pool configuration

<name> : <string>
Drive Identifier.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape drive create <name> --path <string> [OPTIONS]

Create a new drive

<name> : <string>
Drive Identifier.
--path <string>
The path to a LTO SCSI-generic tape device (i.e. '/dev/sg0')

Optional parameters:

--changer <string>
Tape Changer Identifier.
--changer-drivenum <integer> (0 - 8)   (default=0)
Associated changer drive number (requires option changer)

proxmox-tape drive list [OPTIONS]

List drives

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape drive remove <name>

Delete a drive configuration

<name> : <string>
Drive Identifier.

proxmox-tape drive scan [OPTIONS]

Scan for drives

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape drive update <name> [OPTIONS]

Update a drive configuration

<name> : <string>
Drive Identifier.

Optional parameters:

--changer <string>
Tape Changer Identifier.
--changer-drivenum <integer> (0 - 8)   (default=0)
Associated changer drive number (requires option changer)
--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.
--path <string>
The path to a LTO SCSI-generic tape device (i.e. '/dev/sg0')

proxmox-tape eject [OPTIONS]

Eject/Unload drive media

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.

proxmox-tape eod [OPTIONS]

Move to end of media (MTEOM, used to debug)

Optional parameters:

--drive <string>
Drive Identifier.

proxmox-tape export-media <label-text> [OPTIONS]

Export media with specified label

<label-text> : <string>
Media Label/Barcode.

Optional parameters:

--drive <string>
Drive Identifier.

proxmox-tape format [OPTIONS]

Format media

Optional parameters:

--drive <string>
Drive Identifier.
--fast <boolean>   (default=true)
Use fast erase.
--output-format text|json|json-pretty
Output format.

proxmox-tape 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-tape inventory [OPTIONS]

List (and update) media labels (Changer Inventory)

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.
--read-all-labels <boolean>
Load all tapes and try read labels (even if already inventoried)
--read-labels <boolean>
Load unknown tapes and try read labels

proxmox-tape key change-passphrase <fingerprint> [OPTIONS]

Change the encryption key's password.

<fingerprint> : <string>
Tape encryption key fingerprint (sha256).

Optional parameters:

--hint <string>
Password hint.
--kdf none|scrypt|pbkdf2   (default=scrypt)
Key derivation function for password protected encryption keys.

proxmox-tape key create --hint <string> [OPTIONS]

Create key (read password from stdin)

--hint <string>
Password restore hint.

Optional parameters:

--kdf none|scrypt|pbkdf2   (default=scrypt)
Key derivation function for password protected encryption keys.

proxmox-tape key list [OPTIONS]

List keys

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape key paperkey <fingerprint> [OPTIONS]

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

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

<fingerprint> : <string>
Tape encryption key fingerprint (sha256).

Optional parameters:

--output-format text|html
Paperkey output format
--subject <string>
Include the specified subject as title text.

proxmox-tape key remove <fingerprint> [OPTIONS]

Remove a encryption key from the database

Please note that you can no longer access tapes using this key.

<fingerprint> : <string>
Tape encryption key fingerprint (sha256).

Optional parameters:

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

proxmox-tape key restore [OPTIONS]

Restore encryption key from tape (read password from stdin)

Optional parameters:

--drive <string>
Drive Identifier.

proxmox-tape key show <fingerprint> [OPTIONS]

Print the encryption key's metadata.

<fingerprint> : <string>
Tape encryption key fingerprint (sha256).

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape label --label-text <string> [OPTIONS]

Label media

--label-text <string>
Media Label/Barcode.

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.
--pool <string>
Media pool name.

proxmox-tape load-media <label-text> [OPTIONS]

Load media with specified label

<label-text> : <string>
Media Label/Barcode.

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.

proxmox-tape load-media-from-slot <source-slot> [OPTIONS]

Load media from the specified slot

<source-slot> : <integer> (1 - N)
Source slot number.

Optional parameters:

--drive <string>
Drive Identifier.

proxmox-tape media content [OPTIONS]

List media content

Optional parameters:

--output-format text|json|json-pretty
Output format.
--backup-id <string>
Backup ID.
--backup-type vm|ct|host
Backup type.
--label-text <string>
Media Label/Barcode.
--media <string>
Media Uuid.
--media-set <string>
MediaSet Uuid (We use the all-zero Uuid to reseve an empty media for a specific pool).
--pool <string>
Media pool name.

proxmox-tape media destroy <label-text> [OPTIONS]

Destroy media (completely remove from database)

<label-text> : <string>
Media Label/Barcode.

Optional parameters:

--force <boolean>
Force removal (even if media is used in a media set).

proxmox-tape media list [OPTIONS]

List pool media

Optional parameters:

--output-format text|json|json-pretty
Output format.
--pool <string>
Media pool name.
--update-status <boolean>   (default=true)
Try to update tape library status (check what tapes are online).
--update-status-changer <string>
Tape Changer Identifier.

proxmox-tape pool config <name> [OPTIONS]

Get media pool configuration

<name> : <string>
Media pool name.

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape pool create <name> [OPTIONS]

Create a new media pool

<name> : <string>
Media pool name.

Optional parameters:

--allocation <string>
Media set allocation policy ('continue', 'always', or a calendar event).
--comment <string>
Comment (single line).
--encrypt <string>
Tape encryption key fingerprint (sha256).
--retention <string>
Media retention policy ('overwrite', 'keep', or time span).
--template <string>
Media set naming template (may contain strftime() time format specifications).

proxmox-tape pool list [OPTIONS]

List media pool

Optional parameters:

--output-format text|json|json-pretty
Output format.

proxmox-tape pool remove <name>

Delete a media pool configuration

<name> : <string>
Media pool name.

proxmox-tape pool update <name> [OPTIONS]

Update media pool settings

<name> : <string>
Media pool name.

Optional parameters:

--allocation <string>
Media set allocation policy ('continue', 'always', or a calendar event).
--comment <string>
Comment (single line).
--delete <array>
List of properties to delete.
--encrypt <string>
Tape encryption key fingerprint (sha256).
--retention <string>
Media retention policy ('overwrite', 'keep', or time span).
--template <string>
Media set naming template (may contain strftime() time format specifications).

proxmox-tape read-label [OPTIONS]

Read media label

Optional parameters:

--drive <string>
Drive Identifier.
--inventorize <boolean>
Inventorize media
--output-format text|json|json-pretty
Output format.

proxmox-tape restore <media-set> <store> [{<snapshots>}] [OPTIONS]

Restore data from media-set

<media-set> : <string>
Media set UUID.
<store> : [(<source>=)?<target>, ...]
A list of Datastore mappings (or single datastore), comma separated. For example 'a=b,e' maps the source datastore 'a' to target 'b and all other sources to the default 'e'. If no default is given, only the specified sources are mapped.
<snapshots> : <array>
List of snapshots.

Optional parameters:

--drive <string>
Drive Identifier.
--notify-user <string>
User ID
--output-format text|json|json-pretty
Output format.
--owner <string>
Authentication ID

proxmox-tape rewind [OPTIONS]

Rewind tape

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.

proxmox-tape scan [OPTIONS]

Rewind, then read media contents and print debug info

Note: This reads unless the driver returns an IO Error, so this method is expected to fails when we reach EOT.

Optional parameters:

--drive <string>
Drive Identifier.

proxmox-tape status [OPTIONS]

Get drive/media status

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.

proxmox-tape unload [OPTIONS]

Unload media via changer

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.
--target-slot <integer> (1 - N)
Target slot number. If omitted, defaults to the slot that the drive was loaded from.

proxmox-tape volume-statistics [OPTIONS]

Read Volume Statistics (SCSI log page 17h)

Optional parameters:

--drive <string>
Drive Identifier.
--output-format text|json|json-pretty
Output format.

pmt

All commands support the following parameters to specify the tape device:

--device <path>
 Path to the Linux tape device
--drive <name> Use drive from Proxmox Backup Server configuration.

Commands which generate output support the --output-format parameter. It accepts the following values:

text:Text format (default). Human readable.
json:JSON (single line).
json-pretty:JSON (multiple lines, nicely formatted).

pmt asf <count>

Position the tape at the beginning of the count file (after filemark count)

<count> : <integer> (0 - 2147483647)
File mark position (0 is BOT).

pmt bsf <count>

Backward space count files (position before file mark).

The tape is positioned on the last block of the previous file.

<count> : <integer> (1 - 2147483647)
File mark count.

pmt bsfm <count>

Backward space count files, then forward space one record (position after file mark).

This leaves the tape positioned at the first block of the file that is count - 1 files before the current file.

<count> : <integer> (1 - 2147483647)
File mark count.

pmt bsr <count>

Backward space records.

<count> : <integer> (1 - 2147483647)
Record count.

pmt cartridge-memory

Read Cartridge Memory

pmt eject

Eject drive media

pmt eod

Move to end of media

pmt erase [OPTIONS]

Erase media (from current position)

Optional parameters:

--fast <boolean>   (default=true)
Use fast erase.

pmt format [OPTIONS]

Format media, single partition

Optional parameters:

--fast <boolean>   (default=true)
Use fast erase.

pmt fsf <count>

Forward space count files (position after file mark).

The tape is positioned on the first block of the next file.

<count> : <integer> (1 - 2147483647)
File mark count.

pmt fsfm <count>

Forward space count files, then backward space one record (position before file mark).

This leaves the tape positioned at the last block of the file that is count - 1 files past the current file.

<count> : <integer> (1 - 2147483647)
File mark count.

pmt fsr <count>

Forward space records.

<count> : <integer> (1 - 2147483647)
Record count.

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

pmt load

Load media

pmt lock

Lock the tape drive door

pmt options [OPTIONS]

Set varios drive options

Optional parameters:

--blocksize <integer> (0 - 8388608)
Set tape drive block_length (0 is variable length).
--buffer_mode <boolean>
Use drive buffer.
--compression <boolean>
Enable/disable compression.
--defaults <boolean>
Set default options

pmt rewind

Rewind the tape

pmt scan

Scan for existing tape changer devices

pmt status

Drive Status

pmt tape-alert-flags

Read Tape Alert Flags

pmt unlock

Unlock the tape drive door

pmt volume-statistics

Volume Statistics

pmt weof [<count>]

Write count (default 1) EOF marks at current position.

<count> : <integer> (1 - 2147483647)
File mark count.

pmtx

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

pmtx inquiry

Inquiry

pmtx inventory

Inventory

pmtx load <slot> [OPTIONS]

Load

<slot> : <integer>
Storage slot number (source).

Optional parameters:

--drivenum <integer>
Target drive number (defaults to Drive 0)

pmtx scan

Scan for existing tape changer devices

pmtx status

Changer Status

pmtx transfer <from> <to>

Transfer

<from> : <integer>
Source storage slot number.
<to> : <integer>
Target storage slot number.

pmtx unload [OPTIONS]

Unload

Optional parameters:

--drivenum <integer>
Target drive number (defaults to Drive 0)
--slot <integer>
Storage slot number (target). If omitted, defaults to the slot that the drive was loaded from.

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