Command Syntax¶

Note

Logging verbosity for the command line tools can be controlled with the PBS_LOG (for pxar: PXAR_LOG) environment variable. Possible values are off, error, warn, info, debug and trace with info being the default.

`proxmox-backup-client`¶

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

Create (host) backup.

<backupspec><string>: List of backup source specifications ([<label.ext>:<path>] ...) Can be specified more than once.

Optional parameters:

--all-file-systems <boolean> (default=false): Include all mounted subdirectories.
--backup-id <string>: Backup ID.
--backup-time <integer> (1 - N): Backup time (Unix epoch.)
--backup-type vm|ct|host: Backup type.
--burst <integer> (1000 - N): Size of the token bucket (for Token bucket filter) in bytes.
--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.
--dry-run <boolean> (default=false): Just show what backup would do, but do not upload anything.
--entries-max <integer> (default=1048576): Max number of entries to hold in memory.
--exclude <string>: List of paths or patterns for matching files to exclude. Can be specified more than once.
--include-dev <string>: Include mountpoints with same st_dev number (see man fstat) as specified files. Can be specified more than once.
--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.
--ns <string>: Namespace.
--rate <integer> (100000 - N): Rate limit (for Token bucket filter) in bytes/second.
--repository <string>: Repository URL.
--skip-lost-and-found <boolean> (default=false): Skip lost+found directory.

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.

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.
--ns <string>: Namespace.
--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.
--ns <string>: Namespace.
--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:

--ns <string>: Namespace.
--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><string>: Command. This may be a list in order to spefify nested sub-commands. Can be specified more than once.

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:

--ns <string>: Namespace.
--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.
--ns <string>: Namespace.
--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.
--ns <string>: Namespace.
--repository <string>: Repository URL.
--verbose <boolean> (default=false): Verbose output and stay in foreground.

proxmox-backup-client namespace create [<ns>] [OPTIONS]

Create a new namespace.

<ns><string>: Namespace.

Optional parameters:

--repository <string>: Repository URL.

proxmox-backup-client namespace delete [<ns>] [OPTIONS]

Delete an existing namespace.

<ns><string>: Namespace.

Optional parameters:

--repository <string>: Repository URL.

proxmox-backup-client namespace list [<ns>] [OPTIONS]

List namespaces in a repository.

<ns><string>: Namespace.

Optional parameters:

--max-depth <integer> (0 - N): maximum recursion depth
--output-format text|json|json-pretty: Output format.
--repository <string>: Repository URL.

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.
--output-format text|json|json-pretty: Output format.
--quiet <boolean> (default=false): Minimal output - only show removals.
--repository <string>: Repository URL.
--max-depth <integer> (0 - 7): How many levels of namespaces should be operated on (0 == no recursion, empty == automatic full recursion, namespace depths reduce maximum allowed value)
--ns <string>: Namespace.
--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.

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> (default=false): Do not fail if directories already exists.
--burst <integer> (1000 - N): Size of the token bucket (for Token bucket filter) in bytes.
--crypt-mode none|encrypt|sign-only (default=encrypt): Defines whether data is encrypted (using an AEAD cipher), only signed, or neither.
--ignore-acls <boolean> (default=false): ignore acl settings
--ignore-ownership <boolean> (default=false): ignore owner settings (no chown)
--ignore-permissions <boolean> (default=false): ignore permission settings (no chmod)
--ignore-xattrs <boolean> (default=false): ignore xattr settings
--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.
--ns <string>: Namespace.
--overwrite <boolean> (default=false): overwrite already existing files
--rate <integer> (100000 - N): Rate limit (for Token bucket filter) in bytes/second.
--repository <string>: Repository URL.

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

List snapshot files.

<snapshot><string>: Snapshot path.

Optional parameters:

--ns <string>: Namespace.
--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:

--ns <string>: Namespace.
--repository <string>: Repository URL.

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

List backup snapshots.

<group><string>: Backup group.

Optional parameters:

--ns <string>: Namespace.
--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:

--ns <string>: Namespace.
--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:

--ns <string>: Namespace.
--repository <string>: Repository URL.

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

Show protection status of the specified snapshot

<snapshot><string>: Snapshot path.

Optional parameters:

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

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

Update Protection Status of a snapshot

<snapshot><string>: Snapshot path.
<protected><boolean>: The protection status.

Optional parameters:

--ns <string>: Namespace.
--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.
--ns <string>: Namespace.
--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 Identifier

Optional parameters:

--repository <string>: Repository URL.

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

Try to stop a specific task.

<upid><string>: Unique Process/Task Identifier

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¶

The following commands are available in 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><string>: Command. This may be a list in order to spefify nested sub-commands. Can be specified more than once.

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> --api <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.
--api <string>: DNS API Plugin Id.

Optional parameters:

--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 disable|validation-delay

List of properties to delete. Can be specified more than once.

--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:

--output-format text|json|json-pretty: Output format.
--comment <string>: Comment (single line).
--gc-schedule <calendar-event>: Run garbage collection job at specified schedule.
--maintenance-mode [type=<enum> [,message=<string>]]: Maintenance mode, type is either 'offline' or 'read-only', message should be enclosed in "
--notify [[gc=<enum>] [,prune=<enum>] [,sync=<enum>] [,verify=<enum>]]: Datastore notification setting
--notify-user <string>: User ID
--prune-schedule <calendar-event>: Run prune job at specified schedule.
--tuning [[chunk-order=<enum>] [,sync-level=<enum>]]: Datastore tuning options
--verify-new <boolean>: If enabled, all new backups will be verified right after completion.
--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.

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:

--destroy-data <boolean> (default=false): Delete the datastore's underlying contents
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--keep-job-configs <boolean> (default=false): If enabled, the job configurations related to this datastore will be kept.

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:

--delete comment|gc-schedule|prune-schedule|keep-last|keep-hourly|keep-daily|keep-weekly|keep-monthly|keep-yearly|verify-new|notify-user|notify|tuning|maintenance-mode: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--comment <string>: Comment (single line).
--gc-schedule <calendar-event>: Run garbage collection job at specified schedule.
--maintenance-mode [type=<enum> [,message=<string>]]: Maintenance mode, type is either 'offline' or 'read-only', message should be enclosed in "
--notify [[gc=<enum>] [,prune=<enum>] [,sync=<enum>] [,verify=<enum>]]: Datastore notification setting
--notify-user <string>: User ID
--prune-schedule <calendar-event>: Run prune job at specified schedule.
--tuning [[chunk-order=<enum>] [,sync-level=<enum>]]: Datastore tuning options
--verify-new <boolean>: If enabled, all new backups will be verified right after completion.
--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.

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.

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|zstd|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 dns1|dns2|dns3: List of properties to delete. Can be specified more than once.
--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><string>: Command. This may be a list in order to spefify nested sub-commands. Can be specified more than once.

Optional parameters:

--verbose <boolean>: Verbose help.

proxmox-backup-manager ldap create <realm> --base-dn <string> --server1 <string> --user-attr <string> [OPTIONS]

Create a new LDAP realm

<realm><string>: Realm name.
--base-dn <string>: LDAP Domain
--server1 <string>: LDAP server address
--user-attr <string>: Username attribute. Used to map a userid to LDAP to an LDAP dn.

Optional parameters:

--password <string>: LDAP bind password
--bind-dn <string>: LDAP Domain
--capath <string>: CA certificate to use for the server. The path can point to either a file, or a directory. If it points to a file, the PEM-formatted X.509 certificate stored at the path will be added as a trusted certificate. If the path points to a directory, the directory replaces the system's default certificate store at /etc/ssl/certs - Every file in the directory will be loaded as a trusted certificate.
--comment <string>: Comment (single line).
--filter <string>: Custom LDAP search filter for user sync
--mode ldap|ldap+starttls|ldaps (default=ldap): LDAP connection type
--port <integer> (0 - 65535): Port
--server2 <string>: Fallback LDAP server address
--sync-attributes [[email=<string>] [,firstname=<string>] [,lastname=<string>]]: Comma-separated list of key=value pairs for specifying which LDAP attributes map to which PBS user field. For example, to map the LDAP attribute mail to PBS's email, write email=mail.
--sync-defaults-options [[enable-new=<1|0>] [,remove-vanished=<string>]]: sync defaults options
--user-classes [<string>, ...] (default=inetorgperson,posixaccount,person,user): Comma-separated list of allowed objectClass values for user synchronization. For instance, if user-classes is set to person,user, then user synchronization will consider all LDAP entities where objectClass: person or objectClass: user.
--verify <boolean> (default=false): Verify server certificate

proxmox-backup-manager ldap delete <realm> [OPTIONS]

Remove an LDAP realm configuration

<realm><string>: Realm 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 ldap list [OPTIONS]

List configured LDAP realms

Optional parameters:

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

proxmox-backup-manager ldap show <realm> [OPTIONS]

Show LDAP realm configuration

<realm><string>: Realm name.

Optional parameters:

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

proxmox-backup-manager ldap sync <realm> [OPTIONS]

Sync a given LDAP realm

<realm><string>: Authentication domain ID

Optional parameters:

--dry-run <boolean> (default=false): If set, do not create/delete anything
--enable-new <boolean>: Enable newly synced users immediately
--remove-vanished [acl|entry|properties, ...]: A semicolon-seperated list of things to remove when they or the user vanishes during user synchronization. The following values are possible: entry removes the user when not returned from the sync; properties removes any properties on existing user that do not appear in the source. acl removes ACLs when the user is not returned from the sync.

proxmox-backup-manager ldap update <realm> [OPTIONS]

Update an LDAP realm configuration

<realm><string>: Realm name.

Optional parameters:

--delete server2|port|comment|verify|mode|bind-dn|password|filter|sync-defaults-options|sync-attributes|user-classes: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--password <string>: LDAP bind password
--base-dn <string>: LDAP Domain
--bind-dn <string>: LDAP Domain
--capath <string>: CA certificate to use for the server. The path can point to either a file, or a directory. If it points to a file, the PEM-formatted X.509 certificate stored at the path will be added as a trusted certificate. If the path points to a directory, the directory replaces the system's default certificate store at /etc/ssl/certs - Every file in the directory will be loaded as a trusted certificate.
--comment <string>: Comment (single line).
--filter <string>: Custom LDAP search filter for user sync
--mode ldap|ldap+starttls|ldaps (default=ldap): LDAP connection type
--port <integer> (0 - 65535): Port
--server1 <string>: LDAP server address
--server2 <string>: Fallback LDAP server address
--sync-attributes [[email=<string>] [,firstname=<string>] [,lastname=<string>]]: Comma-separated list of key=value pairs for specifying which LDAP attributes map to which PBS user field. For example, to map the LDAP attribute mail to PBS's email, write email=mail.
--sync-defaults-options [[enable-new=<1|0>] [,remove-vanished=<string>]]: sync defaults options
--user-attr <string>: Username attribute. Used to map a userid to LDAP to an LDAP dn.
--user-classes [<string>, ...] (default=inetorgperson,posixaccount,person,user): Comma-separated list of allowed objectClass values for user synchronization. For instance, if user-classes is set to person,user, then user synchronization will consider all LDAP entities where objectClass: person or objectClass: user.
--verify <boolean> (default=false): Verify server certificate

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 cidr|cidr6|gateway|gateway6|method|method6|comments|comments6|mtu|autostart|bridge_ports|bridge_vlan_aware|slaves|bond-primary|bond_xmit_hash_policy: List of properties to delete. Can be specified more than once.
--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 acme|acmedomain0|acmedomain1|acmedomain2|acmedomain3|acmedomain4|http-proxy|email-from|ciphers-tls-1.3|ciphers-tls-1.2|default-lang|description|task-log-max-days: List of properties to delete. Can be specified more than once.
--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
--ciphers-tls-1.2 <string>: OpenSSL cipher list used by the proxy for TLS <= 1.2
--ciphers-tls-1.3 <string>: OpenSSL ciphersuites list used by the proxy for TLS 1.3
--default-lang ar|ca|da|de|en|es|eu|fa|fr|gl|he|hu|it|ja|kr|nb|nl|nn|pl|pt_BR|ru|sl|sv|tr|zh_CN|zh_TW: All available languages in Proxmox. Taken from proxmox-i18n repository. pt_BR, zh_CN, and zh_TW use the same case in the translation files.
--description <string>: Comment (multiple lines).
--email-from <string>: E-Mail Address.
--http-proxy [http://]<host>[:port]: HTTP proxy configuration [http://]<host>[:port]
--task-log-max-days <integer> (0 - N): Maximum days to keep Task logs

proxmox-backup-manager openid create <realm> --client-id <string> --issuer-url <string> [OPTIONS]

Create a new OpenId realm

<realm><string>: Realm name.
--client-id <string>: OpenID Client ID
--issuer-url <string>: OpenID Issuer Url

Optional parameters:

--acr-values [<string>, ...]: OpenID ACR List
--autocreate <boolean> (default=false): Automatically create users if they do not exist.
--client-key <string>: OpenID Client Key
--comment <string>: Comment (single line).
--prompt <string>: OpenID Prompt
--scopes [<string>, ...] (default=email profile): OpenID Scope List
--username-claim <string>: Use the value of this attribute/claim as unique user name. It is up to the identity provider to guarantee the uniqueness. The OpenID specification only guarantees that Subject ('sub') is unique. Also make sure that the user is not allowed to change that attribute by himself!

proxmox-backup-manager openid delete <realm> [OPTIONS]

Remove a OpenID realm configuration

<realm><string>: Realm 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 openid list [OPTIONS]

List configured OpenId realms

Optional parameters:

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

proxmox-backup-manager openid show <realm> [OPTIONS]

Show OpenID realm configuration

<realm><string>: Realm name.

Optional parameters:

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

proxmox-backup-manager openid update <realm> [OPTIONS]

Update an OpenID realm configuration

<realm><string>: Realm name.

Optional parameters:

--delete client-key|comment|autocreate|scopes|prompt|acr-values: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--acr-values [<string>, ...]: OpenID ACR List
--autocreate <boolean> (default=false): Automatically create users if they do not exist.
--client-id <string>: OpenID Client ID
--client-key <string>: OpenID Client Key
--comment <string>: Comment (single line).
--issuer-url <string>: OpenID Issuer Url
--prompt <string>: OpenID Prompt
--scopes [<string>, ...] (default=email profile): OpenID Scope List

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

Create a new prune job.

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

Optional parameters:

--comment <string>: Comment (single line).
--disable <boolean> (default=false): Disable this job.
--schedule <calendar-event>: Run prune job at specified schedule.
--max-depth <integer> (0 - 7): How many levels of namespaces should be operated on (0 == no recursion, empty == automatic full recursion, namespace depths reduce maximum allowed value)
--ns <string>: Namespace.
--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.

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

List all prune jobs

Optional parameters:

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

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

Remove a prune 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 prune-job run <id> [OPTIONS]

Run the specified prune job

<id><string>: Job ID.

Optional parameters:

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

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

Show prune job configuration

<id><string>: Job ID.

Optional parameters:

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

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

Update prune job config.

<id><string>: Job ID.

Optional parameters:

--delete comment|disable|ns|max-depth|keep-last|keep-hourly|keep-daily|keep-weekly|keep-monthly|keep-yearly: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--comment <string>: Comment (single line).
--disable <boolean> (default=false): Disable this job.
--schedule <calendar-event>: Run prune job at specified schedule.
--store <string>: Datastore name.
--max-depth <integer> (0 - 7): How many levels of namespaces should be operated on (0 == no recursion, empty == automatic full recursion, namespace depths reduce maximum allowed value)
--ns <string>: Namespace.
--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.

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

Sync datastore from another repository

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

Optional parameters:

--group-filter <type:<vm|ct|host>|group:GROUP|regex:RE>: List of group filters. Can be specified more than once.
--max-depth <integer> (0 - 7) (default=7): How many levels of namespaces should be operated on (0 == no recursion)
--ns <string>: Namespace.
--output-format text|json|json-pretty: Output format.
--remote-ns <string>: Namespace.
--remove-vanished <boolean> (default=false): Delete vanished backups. This remove the local copy if the remote backup was deleted.
--transfer-last <integer> (1 - N): Limit transfer to last N snapshots (per group), skipping others
--burst-in <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--burst-out <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--rate-in <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--rate-out <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).

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

Create new remote.

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

Optional parameters:

--comment <string>: Comment (single line).
--fingerprint <string>: X509 certificate fingerprint (sha256).
--port <integer>: 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:

--delete comment|fingerprint|port: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--password <string>: Password or auth token for remote host.
--auth-id <string>: Authentication ID
--comment <string>: Comment (single line).
--fingerprint <string>: X509 certificate fingerprint (sha256).
--host <string>: DNS name or IP address.
--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 set-offline-key <data>

(Internal use only!) Set a signed subscription info blob as offline key

<data><string>: base64-encoded signed subscription info

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).
--group-filter <type:<vm|ct|host>|group:GROUP|regex:RE>: List of group filters. Can be specified more than once.
--max-depth <integer> (0 - 7): How many levels of namespaces should be operated on (0 == no recursion, empty == automatic full recursion, namespace depths reduce maximum allowed value)
--ns <string>: Namespace.
--owner <string>: Authentication ID
--remote-ns <string>: Namespace.
--remove-vanished <boolean> (default=false): Delete vanished backups. This remove the local copy if the remote backup was deleted.
--schedule <calendar-event>: Run sync job at specified schedule.
--transfer-last <integer> (1 - N): Limit transfer to last N snapshots (per group), skipping others
--burst-in <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--burst-out <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--rate-in <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--rate-out <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).

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 run <id> [OPTIONS]

Run the specified sync job

<id><string>: Job ID.

Optional parameters:

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

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:

--delete owner|comment|schedule|remove-vanished|group-filter|rate-in|burst-in|rate-out|burst-out|ns|remote-ns|max-depth|transfer-last: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--comment <string>: Comment (single line).
--group-filter <type:<vm|ct|host>|group:GROUP|regex:RE>: List of group filters. Can be specified more than once.
--max-depth <integer> (0 - 7): How many levels of namespaces should be operated on (0 == no recursion, empty == automatic full recursion, namespace depths reduce maximum allowed value)
--ns <string>: Namespace.
--owner <string>: Authentication ID
--remote <string>: Remote ID.
--remote-ns <string>: Namespace.
--remote-store <string>: Datastore name.
--remove-vanished <boolean> (default=false): 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.
--transfer-last <integer> (1 - N): Limit transfer to last N snapshots (per group), skipping others
--burst-in <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--burst-out <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--rate-in <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--rate-out <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).

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 Identifier

proxmox-backup-manager task stop <upid>

Try to stop a specific task.

<upid><string>: Unique Process/Task Identifier

proxmox-backup-manager traffic-control create <name> --network <string> [OPTIONS]

Create new traffic control rule.

<name><string>: Rule ID.
--network <string>: Rule applies to Source IPs within this networks Can be specified more than once.

Optional parameters:

--comment <string>: Comment (single line).
--timeframe <string>: Enable the rule at specific times Can be specified more than once.
--burst-in <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--burst-out <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--rate-in <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--rate-out <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).

proxmox-backup-manager traffic-control list [OPTIONS]

List configured traffic control rules.

Optional parameters:

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

proxmox-backup-manager traffic-control remove <name> [OPTIONS]

Remove a traffic control rule from the configuration file.

<name><string>: Rule 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 traffic-control show <name> [OPTIONS]

Show traffic control configuration

<name><string>: Rule ID.

Optional parameters:

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

proxmox-backup-manager traffic-control traffic [OPTIONS]

Show current traffic for all rules.

Optional parameters:

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

proxmox-backup-manager traffic-control update <name> [OPTIONS]

Update traffic control configuration.

<name><string>: Rule ID.

Optional parameters:

--delete rate-in|burst-in|rate-out|burst-out|comment|timeframe: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--comment <string>: Comment (single line).
--network <string>: Rule applies to Source IPs within this networks Can be specified more than once.
--timeframe <string>: Enable the rule at specific times Can be specified more than once.
--burst-in <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--burst-out <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--rate-in <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
--rate-out <string>: Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).

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

Create new user.

<userid><string>: User ID

Optional parameters:

--password <string>: User Password.
--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.

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

Delete a user's API token

<userid><string>

User ID

<token-name><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> <token-name> [OPTIONS]

Generate a new API token with given metadata

<userid><string>

User ID

<token-name><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:

--delete comment|firstname|lastname|email: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--password <string>: User Password.
--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.

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

Verify backups

<store><string>: Datastore name.

Optional parameters:

--ignore-verified <boolean> (default=true): Do not verify backups that are already verified if their verification is not outdated.
--outdated-after <integer> (0 - N): Days after that a verification becomes outdated. (0 is deprecated)'
--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.
--max-depth <integer> (0 - 7) (default=7): How many levels of namespaces should be operated on (0 == no recursion)
--ns <string>: Namespace.
--outdated-after <integer> (0 - N): Days after that a verification becomes outdated. (0 is deprecated)'
--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 run <id> [OPTIONS]

Run the specified verification job

<id><string>: Job ID.

Optional parameters:

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

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:

--delete ignore-verified|comment|schedule|outdated-after|ns|max-depth: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--comment <string>: Comment (single line).
--ignore-verified <boolean> (default=true): Do not verify backups that are already verified if their verification is not outdated.
--max-depth <integer> (0 - 7) (default=7): How many levels of namespaces should be operated on (0 == no recursion)
--ns <string>: Namespace.
--outdated-after <integer> (0 - N): Days after that a verification becomes outdated. (0 is deprecated)'
--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.
--force-media-set <boolean> (default=false): Ignore the allocation policy and start a new media-set.
--groups <type:<vm|ct|host>|group:GROUP|regex:RE>: List of group filters. Can be specified more than once.
--latest-only <boolean>: Backup latest snapshots only.
--max-depth <integer> (0 - 7) (default=7): How many levels of namespaces should be operated on (0 == no recursion)
--notify-user <string>: User ID
--ns <string>: Namespace.
--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.
--group-filter <type:<vm|ct|host>|group:GROUP|regex:RE>: List of group filters. Can be specified more than once.
--latest-only <boolean>: Backup latest snapshots only.
--max-depth <integer> (0 - 7) (default=7): How many levels of namespaces should be operated on (0 == no recursion)
--notify-user <string>: User ID
--ns <string>: Namespace.

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:

--delete comment|schedule|eject-media|export-media-set|latest-only|notify-user|group-filter|max-depth|ns: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--comment <string>: Comment (single line).
--schedule <calendar-event>: Run sync job at specified schedule.
--drive <string>: Drive Identifier.
--eject-media <boolean>: Eject media upon job completion.
--export-media-set <boolean>: Export media set upon job completion.
--group-filter <type:<vm|ct|host>|group:GROUP|regex:RE>: List of group filters. Can be specified more than once.
--latest-only <boolean>: Backup latest snapshots only.
--max-depth <integer> (0 - 7) (default=7): How many levels of namespaces should be operated on (0 == no recursion)
--notify-user <string>: User ID
--ns <string>: Namespace.
--pool <string>: Media pool name.
--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 export-slots: List of properties to delete. Can be specified more than once.
--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 - 255) (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:

--delete changer|changer-drivenum: List of properties to delete. Can be specified more than once.
--digest <string>: Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--changer <string>: Tape Changer Identifier.
--changer-drivenum <integer> (0 - 255) (default=0): Associated changer drive number (requires option changer)
--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><string>: Command. This may be a list in order to spefify nested sub-commands. Can be specified more than once.

Optional parameters:

--verbose <boolean>: Verbose help.

proxmox-tape inventory [OPTIONS]

List (and update) media labels (Changer Inventory)

Optional parameters:

--catalog <boolean> (default=false): Try to restore catalogs from tapes.
--drive <string>: Drive Identifier.
--output-format text|json|json-pretty: Output format.
--read-all-labels <boolean> (default=false): Load all tapes and try read labels (even if already inventoried)
--read-labels <boolean> (default=false): Load unknown tapes and try read labels

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

Change the encryption key's password.

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

Optional parameters:

--force <boolean> (default=false): Reset the passphrase for a tape key, without asking for the old one.
--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 or from a backup file/string (reads password from stdin)

Optional parameters:

--drive <string>: Drive Identifier.
--key <string>: Import key from json string or an exported paperkey-format.
--key-file <string>: Import key from a file with either json or exported paperkey-format.

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 types.
--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:

--delete allocation|retention|template|encrypt|comment: List of properties to delete. Can be specified more than once.
--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 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>store:[ns/namespace/...]type/id/time: List of snapshots. Can be specified more than once.

Optional parameters:

--drive <string>: Drive Identifier.
--namespaces [store=<string> [,max-depth=<integer>] [,source=<string>] [,target=<string>]]: List of namespace to restore. Can be specified more than once.
--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><string>: Command. This may be a list in order to spefify nested sub-commands. Can be specified more than once.

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><string>: Command. This may be a list in order to spefify nested sub-commands. Can be specified more than once.

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 <string>: List of paths or pattern matching files to exclude. Can be specified more than once.
--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.

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.
--overwrite <boolean> (default=false): overwrite already existing files
--pattern <string>: List of paths or pattern matching files to restore Can be specified more than once.
--strict <boolean> (default=false): Stop on errors. Otherwise most errors will simply warn.

pxar help [{<command>}] [OPTIONS]

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

<command><string>: Command. This may be a list in order to spefify nested sub-commands. Can be specified more than once.

Optional parameters:

--verbose <boolean>: Verbose help.

pxar list <archive>

List the contents of an archive.

<archive><string>: Archive name.

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

`proxmox-file-restore`¶

proxmox-file-restore extract <snapshot> <path> [<target>] [OPTIONS]

Restore files from a backup snapshot.

<snapshot><string>: Group/Snapshot path.
<path><string>: Path to restore. Directories will be restored as archive files if extracted to stdout.
<target><string>: Target directory path. Use '-' to write to standard output.

Optional parameters:

--base64 <boolean> (default=false): If set, 'path' will be interpreted as base64 encoded.
--crypt-mode none|encrypt|sign-only (default=encrypt): Defines whether data is encrypted (using an AEAD cipher), only signed, or neither.

--driver Qemu

--format plain|pxar|zip|tar: The desired format of the result.
--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.
--ns <string>: Namespace.
--repository <string>: Repository URL.
--verbose <boolean> (default=false): Print verbose information
--zstd <boolean> (default=false): If true, output will be zstd compressed.

proxmox-file-restore help [{<command>}] [OPTIONS]

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

<command><string>: Command. This may be a list in order to spefify nested sub-commands. Can be specified more than once.

Optional parameters:

--verbose <boolean>: Verbose help.

proxmox-file-restore list <snapshot> <path> [OPTIONS]

List a directory from a backup snapshot.

<snapshot><string>: Group/Snapshot path.
<path><string>: (Sub-)Path to list.

Optional parameters:

--base64 <boolean> (default=false): If set, 'path' will be interpreted as base64 encoded.
--crypt-mode none|encrypt|sign-only (default=encrypt): Defines whether data is encrypted (using an AEAD cipher), only signed, or neither.

--driver Qemu

--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.
--ns <string>: Namespace.
--output-format text|json|json-pretty: Output format.
--repository <string>: Repository URL.
--timeout <integer> (1 - N): Defines the maximum time the call can should take.

proxmox-file-restore status [OPTIONS]

Retrieve status information about currently running/mapped restore images

Optional parameters:

--driver Qemu

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

proxmox-file-restore stop <name>

Immediately stop/unmap a given image. Not typically necessary, as VMs will stop themselves after a timer anyway.

<name><string>: The name of the VM to stop.

`proxmox-backup-debug`¶

proxmox-backup-debug api create <api-path> [OPTIONS]

Call API on <api-path>

<api-path><string>: API path.

Optional parameters:

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

proxmox-backup-debug api delete <api-path> [OPTIONS]

Call API on <api-path>

<api-path><string>: API path.

Optional parameters:

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

proxmox-backup-debug api get <api-path> [OPTIONS]

Call API on <api-path>

<api-path><string>: API path.

Optional parameters:

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

proxmox-backup-debug api ls [<path>] [OPTIONS]

Get API usage information for <path>

<path><string>: API path.

Optional parameters:

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

proxmox-backup-debug api set <api-path> [OPTIONS]

Call API on <api-path>

<api-path><string>: API path.

Optional parameters:

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

proxmox-backup-debug api usage <path> [OPTIONS]

Get API usage information for <path>

<path><string>: API path.

Optional parameters:

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

proxmox-backup-debug diff archive <prev-snapshot> <snapshot> <archive-name> [OPTIONS]

Diff an archive in two snapshots. The command will output a list of added, modified and deleted files. For modified files, the file metadata (e.g. mode, uid, gid, size, etc.) will be considered. For detecting modification of file content, only mtime will be used by default. If the --compare-content flag is provided, mtime is ignored and file content will be compared.

<prev-snapshot><string>: Path for the first snapshot.
<snapshot><string>: Path for the second snapshot.
<archive-name><string>: Name of the .pxar archive

Optional parameters:

--color always|auto|never (default=auto): Color output options
--compare-content <boolean> (default=false): Compare file content rather than solely relying on mtime for detecting modified files.
--keyfd <integer> (0 - N): Pass an encryption key via an already opened file descriptor.
--keyfile <string>: Path to encryption key.
--ns <string>: Namespace.
--repository <string>: Repository URL.

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

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

<command><string>: Command. This may be a list in order to spefify nested sub-commands. Can be specified more than once.

Optional parameters:

--verbose <boolean>: Verbose help.

proxmox-backup-debug inspect chunk <chunk> [OPTIONS]

Inspect a chunk

<chunk><string>: The chunk file.

Optional parameters:

--decode <string>: Path to the file to which the chunk should be decoded, '-' -> decode to stdout.
--digest <string>: Needed when searching for references, if set, it will be used for verification when decoding.
--keyfile <string>: Path to the keyfile with which the chunk was encrypted.
--output-format text|json|json-pretty: Output format.
--reference-filter <string>: Path to the directory that should be searched for references.
--use-filename-as-digest <boolean> (default=true): The filename should be used as digest for reference search and decode verification, if no digest is specified.

proxmox-backup-debug inspect file <file> [OPTIONS]

Inspect a file, for blob file without decode only the size and encryption mode is printed

<file><string>: Path to the file.

Optional parameters:

--decode <string>: Path to the file to which the file should be decoded, '-' -> decode to stdout.
--keyfile <string>: Path to the keyfile with which the file was encrypted.
--output-format text|json|json-pretty: Output format.

proxmox-backup-debug recover index <file> <chunks> [OPTIONS]

Restore the data from an index file, given the directory of where chunks are saved, the index file and a keyfile, if needed for decryption.

<file><string>: Path to the index file, either .fidx or .didx.
<chunks><string>: Path to the directory that contains the chunks, usually <datastore>/.chunks.

Optional parameters:

--ignore-corrupt-chunks <boolean> (default=false): If a chunk is corrupt, warn and write 0-bytes instead to attempt partial recovery.
--ignore-missing-chunks <boolean> (default=false): If a chunk is missing, warn and write 0-bytes instead to attempt partial recovery.
--keyfile <string>: Path to a keyfile, if the data was encrypted, a keyfile is needed for decryption.
--output-path <string>: Output file path, defaults to file without extension, '-' means STDOUT.
--skip-crc <boolean> (default=false): Skip the crc verification, increases the restore speed by lot.

Proxmox Backup

Navigation

Related Topics

Command Syntax¶

`proxmox-backup-client`¶

Catalog Shell Commands¶

`proxmox-backup-manager`¶

`proxmox-tape`¶

`pmt`¶

`pmtx`¶

`pxar`¶

`proxmox-file-restore`¶

`proxmox-backup-debug`¶

Command Syntax¶

proxmox-backup-client¶

Catalog Shell Commands¶

proxmox-backup-manager¶

proxmox-tape¶

pmt¶

pmtx¶

pxar¶

proxmox-file-restore¶

proxmox-backup-debug¶

`proxmox-backup-client`¶

`proxmox-backup-manager`¶

`proxmox-tape`¶

`pmt`¶

`pmtx`¶

`pxar`¶

`proxmox-file-restore`¶

`proxmox-backup-debug`¶