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.
--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.
--maintenance-mode
[type=<enum> [,message=<string>]]
Maintenance mode, type is either 'offline' or 'read-only', message should be enclosed in "
--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.
--tuning
[[chunk-order=<enum>]]
Datastore tuning options
--verify-new
<boolean>
If enabled, all new backups will be verified right after completion.
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.
--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.
--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.
--maintenance-mode
[type=<enum> [,message=<string>]]
Maintenance mode, type is either 'offline' or 'read-only', message should be enclosed in "
--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.
--tuning
[[chunk-order=<enum>]]
Datastore tuning options
--verify-new
<boolean>
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|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 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 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:
--group-filter
<type:<vm|ct|host>|group:GROUP|regex:RE>
List of group filters. Can be specified more than once.
--output-format
text|json|json-pretty
Output format.
--remove-vanished
<boolean> (default=false)
Delete vanished backups. This remove the local copy if the remote backup was deleted.
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 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.
--owner
<string>
Authentication ID
--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.
--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 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
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.
--owner
<string>
Authentication ID
--remote
<string>
Remote ID.
--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.
--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 means always)
--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> (0 - N)
Days after that a verification becomes outdated. (0 means always)
--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:
--delete
ignore-verified|comment|schedule|outdated-after
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.
--outdated-after
<integer> (0 - N)
Days after that a verification becomes outdated. (0 means always)
--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.