proxmox-backup-manager acl list [OPTIONS]

Access Control list.

Optional parameters:

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

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

Update Access Control List (ACLs).

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

Enum representing roles via their [PRIVILEGES] combination.

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

Optional parameters:

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

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

Deactivate an ACME account.

<name> : <string>
ACME account name.

Optional parameters:

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

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

Show acme account information.

<name> : <string>
ACME account name.

Optional parameters:

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

proxmox-backup-manager acme account list [OPTIONS]

List acme accounts.

Optional parameters:

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

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

Register an ACME account.

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

Optional parameters:

--directory <string>
The ACME Directory.

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

Update an ACME account.

<name> : <string>
ACME account name.

Optional parameters:

--contact <string>
List of email addresses.

proxmox-backup-manager acme cert order [OPTIONS]

Order a new ACME certificate.

Optional parameters:

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

proxmox-backup-manager acme cert revoke

Order a new ACME certificate.

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

Show acme account information.

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

Optional parameters:

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

Extra delay in seconds to wait before requesting validation.

Allows to cope with long TTL of DNS records.


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

Show acme account information.

<id> : <string>
Plugin ID

Optional parameters:

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

proxmox-backup-manager acme plugin list [OPTIONS]

List acme plugins.

Optional parameters:

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

proxmox-backup-manager acme plugin remove <id>

Delete an ACME plugin configuration.

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

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

Update an ACME plugin configuration.

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

Optional parameters:

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

Extra delay in seconds to wait before requesting validation.

Allows to cope with long TTL of DNS records.

proxmox-backup-manager cert info

Display node certificate information.


proxmox-backup-manager cert update [OPTIONS]

Update node certificates and generate all needed files/directories.

Optional parameters:

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

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

Create new datastore config.

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

Optional parameters:

--comment <string>
Comment (single line).
--gc-schedule <calendar-event>
Run garbage collection job at specified schedule.
--keep-daily <integer> (1 - N)
Number of daily backups to keep.
--keep-hourly <integer> (1 - N)
Number of hourly backups to keep.
--keep-last <integer> (1 - N)
Number of backups to keep.
--keep-monthly <integer> (1 - N)
Number of monthly backups to keep.
--keep-weekly <integer> (1 - N)
Number of weekly backups to keep.
--keep-yearly <integer> (1 - N)
Number of yearly backups to keep.
--notify [[gc=<enum>] [,sync=<enum>] [,verify=<enum>]]
Datastore notification setting
--notify-user <string>
User ID
--prune-schedule <calendar-event>
Run prune job at specified schedule.

proxmox-backup-manager datastore list [OPTIONS]

Datastore list.

Optional parameters:

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

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

Remove a datastore configuration.

<name> : <string>
Datastore name.

Optional parameters:

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

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

Show datastore configuration

<name> : <string>
Datastore name.

Optional parameters:

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

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

Update datastore config.

<name> : <string>
Datastore name.

Optional parameters:

--comment <string>
Comment (single line).
--delete <array>
List of properties to delete.
--digest <string>
Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--gc-schedule <calendar-event>
Run garbage collection job at specified schedule.
--keep-daily <integer> (1 - N)
Number of daily backups to keep.
--keep-hourly <integer> (1 - N)
Number of hourly backups to keep.
--keep-last <integer> (1 - N)
Number of backups to keep.
--keep-monthly <integer> (1 - N)
Number of monthly backups to keep.
--keep-weekly <integer> (1 - N)
Number of weekly backups to keep.
--keep-yearly <integer> (1 - N)
Number of yearly backups to keep.
--notify [[gc=<enum>] [,sync=<enum>] [,verify=<enum>]]
Datastore notification setting
--notify-user <string>
User ID
--prune-schedule <calendar-event>
Run prune job at specified schedule.
--verify-new <boolean>   (default=false)
If enabled, all new backups will be verified right after completion.

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

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

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

Optional parameters:

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

--filesystem ext4|xfs


proxmox-backup-manager disk fs list [OPTIONS]

List systemd datastore mount units.

Optional parameters:

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

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

Initialize empty Disk with GPT

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

Optional parameters:

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

proxmox-backup-manager disk list [OPTIONS]

Local disk list.

Optional parameters:

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

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

Show SMART attributes.

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

Optional parameters:

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

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

create a zfs pool

<name> : <string>
Datastore name.
--devices [<string>, ...]
A list of disk names, comma separated.
--raidlevel single|mirror|raid10|raidz|raidz2|raidz3
The ZFS RAID level to use.

Optional parameters:

--add-datastore <boolean>
Configure a datastore using the zpool.
--ashift <integer> (9 - 16)   (default=12)
Pool sector size exponent.
--compression gzip|lz4|lzjb|zle|on|off   (default=On)
The ZFS compression algorithm to use.

proxmox-backup-manager disk zpool list [OPTIONS]

Local zfs pools.

Optional parameters:

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

proxmox-backup-manager dns get [OPTIONS]

Read DNS settings

Optional parameters:

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

proxmox-backup-manager dns set [OPTIONS]

Update DNS settings.

Optional parameters:

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

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

Start garbage collection for a specific datastore.

<store> : <string>
Datastore name.

Optional parameters:

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

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

Show garbage collection status for a specific datastore.

<store> : <string>
Datastore name.

Optional parameters:

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

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

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

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

Optional parameters:

--verbose <boolean>
Verbose help.

proxmox-backup-manager network changes

Show pending configuration changes (diff)


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

Create network interface configuration.

<iface> : <string>
Network interface name.

Optional parameters:

--autostart <boolean>
Autostart interface.
--bond-primary <string>
Network interface name.
--bond_mode balance-rr|active-backup|balance-xor|broadcast|802.3ad|balance-tlb|balance-alb
Linux Bond Mode
--bond_xmit_hash_policy layer2|layer2+3|layer3+4
Bond Transmit Hash Policy for LACP (802.3ad)
--bridge_ports [<string>, ...]
A list of network devices, comma separated.
--bridge_vlan_aware <boolean>
Enable bridge vlan support.
--cidr <string>
IPv4 address with netmask (CIDR notation).
--cidr6 <string>
IPv6 address with netmask (CIDR notation).
--comments <string>
Comments (inet, may span multiple lines)
--comments6 <string>
Comments (inet5, may span multiple lines)
--gateway <string>
IPv4 address.
--gateway6 <string>
IPv6 address.
--method manual|static|dhcp|loopback
Interface configuration method
--method6 manual|static|dhcp|loopback
Interface configuration method
--mtu <integer> (46 - 65535)   (default=1500)
Maximum Transmission Unit.
--slaves [<string>, ...]
A list of network devices, comma separated.
--type loopback|eth|bridge|bond|vlan|alias|unknown
Network interface type

proxmox-backup-manager network list [OPTIONS]

Network device list.

Optional parameters:

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

proxmox-backup-manager network reload

Reload network configuration (requires ifupdown2).


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

Remove network interface configuration.

<iface> : <string>
Network interface name.

Optional parameters:

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

proxmox-backup-manager network revert

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


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

Update network interface config.

<iface> : <string>
Network interface name.

Optional parameters:

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

proxmox-backup-manager node show [OPTIONS]

Show node configuration

Optional parameters:

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

proxmox-backup-manager node update [OPTIONS]

Update the node configuration

Optional parameters:

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

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

Sync datastore from another repository

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

Optional parameters:

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

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

Create new remote.

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

Optional parameters:

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

proxmox-backup-manager remote list [OPTIONS]

List configured remotes.

Optional parameters:

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

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

Remove a remote from the configuration file.

<name> : <string>
Remote ID.

Optional parameters:

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

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

Show remote configuration

<name> : <string>
Remote ID.

Optional parameters:

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

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

Update remote configuration.

<name> : <string>
Remote ID.

Optional parameters:

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

proxmox-backup-manager report

System report

proxmox-backup-manager subscription get [OPTIONS]

Read subscription info.

Optional parameters:

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

proxmox-backup-manager subscription remove

Delete subscription info.


proxmox-backup-manager subscription set <key>

Set a subscription key and check it.

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

proxmox-backup-manager subscription update [OPTIONS]

Check and update subscription status.

Optional parameters:

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

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

Create a new sync job.

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

Optional parameters:

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

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

Sync job list.

Optional parameters:

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

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

Remove a sync job configuration

<id> : <string>
Job ID.

Optional parameters:

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

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

Show sync job configuration

<id> : <string>
Job ID.

Optional parameters:

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

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

Update sync job config.

<id> : <string>
Job ID.

Optional parameters:

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

proxmox-backup-manager task list [OPTIONS]

List running server tasks.

Optional parameters:

--all <boolean>
Also list stopped tasks.
--limit <integer> (1 - 1000)   (default=50)
The maximal number of tasks to list.
--output-format text|json|json-pretty
Output format.

proxmox-backup-manager task log <upid>

Display the task log.

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

proxmox-backup-manager task stop <upid>

Try to stop a specific task.

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

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

Create new user.

<userid> : <string>
User ID

Optional parameters:

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

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

Delete a user's API token

<userid> : <string>
User ID
<tokenname> : <string>

The token ID part of an API token authentication id.

This alone does NOT uniquely identify the API token - use a full Authid for such use cases.

Optional parameters:

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

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

Generate a new API token with given metadata

<userid> : <string>
User ID
<tokenname> : <string>

The token ID part of an API token authentication id.

This alone does NOT uniquely identify the API token - use a full Authid for such use cases.

Optional parameters:

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

proxmox-backup-manager user list [OPTIONS]

List configured users.

Optional parameters:

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

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

List tokens associated with user.

<userid> : <string>
User ID

Optional parameters:

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

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

List permissions of user/token.

<auth-id> : <string>
Authentication ID

Optional parameters:

--output-format text|json|json-pretty
Output format.
--path <string>
Access control path.

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

Remove a user from the configuration file.

<userid> : <string>
User ID

Optional parameters:

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

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

Update user configuration.

<userid> : <string>
User ID

Optional parameters:

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

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

Verify backups

<store> : <string>
Datastore name.

Optional parameters:

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

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

Create a new verification job.

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

Optional parameters:

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

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

List all verification jobs

Optional parameters:

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

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

Remove a verification job configuration

<id> : <string>
Job ID.

Optional parameters:

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

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

Show verification job configuration

<id> : <string>
Job ID.

Optional parameters:

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

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

Update verification job config.

<id> : <string>
Job ID.

Optional parameters:

--comment <string>
Comment (single line).
--delete <array>
List of properties to delete.
--digest <string>
Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--ignore-verified <boolean>   (default=true)
Do not verify backups that are already verified if their verification is not outdated.
--outdated-after <integer> (1 - N)
Days after that a verification becomes outdated
--schedule <calendar-event>
Run verify job at specified schedule.
--store <string>
Datastore name.

proxmox-backup-manager versions [OPTIONS]

List package versions for important Proxmox Backup Server packages.

Optional parameters:

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