Proxmox Backup Server Documentation

https://pbs.proxmox.com/docs
Admin
Proxmox Backup Server is a powerful, open-source backup solution designed for enterprise...
Tokens:363,857
Snippets:2,774
Trust Score:10
Update:13 hours ago
Show doc for...
Tokens:
Raw
### user.cfg example with user and token sections

Source: https://pbs.proxmox.com/docs/configuration-files.html

Shows the file format for user.cfg, with a user section starting with 'user: <name>' and a token section starting with 'token: <userid!token_name>'. The example includes a root@pam user and a token root@pam!token1, with options like comment, email, enable, and expire.

```plaintext
user: root@pam
      comment Superuser
      email test@example.local
      ...

token: root@pam!token1
      comment API test token
      enable true
      expire 0

user: ...
```

--------------------------------

### Example output of lsblk -o +FSTYPE

Source: https://pbs.proxmox.com/docs/sysadmin.html

Example output showing two 512M vfat partitions (sda2 and sdb2) that are the ESPs on a ZFS RAID-1 installation.

```text
NAME   MAJ:MIN RM  SIZE RO TYPE MOUNTPOINTS FSTYPE
sda      8:0    0   32G  0 disk
├─sda1   8:1    0 1007K  0 part
├─sda2   8:2    0  512M  0 part             vfat
└─sda3   8:3    0 31.5G  0 part             zfs_member
sdb      8:16   0   32G  0 disk
├─sdb1   8:17   0 1007K  0 part
├─sdb2   8:18   0  512M  0 part             vfat
└─sdb3   8:19   0 31.5G  0 part             zfs_member
```

--------------------------------

### datastore.cfg file format example

Source: https://pbs.proxmox.com/docs/configuration-files.html

Shows the general structure of the datastore.cfg file, with multiple datastore sections. Each section starts with 'datastore: <name>' and includes a 'path' option.

```plaintext
datastore: <name1>
   path <path1>
   <option1> <value1>
   ...

datastore: <name2>
   path <path2>
   ...
```

--------------------------------

### Example directory structure with .pxarexclude files

Source: https://pbs.proxmox.com/docs/backup-client.html

Shows the directory tree used in the example, including .pxarexclude files in the root and subfolder0.

```bash
# ls -aR folder
folder/:
.  ..  .pxarexclude  subfolder0  subfolder1

folder/subfolder0:
.  ..  file0  file1  file2  file3  .pxarexclude

folder/subfolder1:
.  ..  file0  file1  file2  file3
```

--------------------------------

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

Source: https://pbs.proxmox.com/docs/command-syntax.html

Starts garbage collection for a specific datastore.

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

### Description
Starts garbage collection for a specific datastore.

### Method
CLI

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

### Parameters
#### Positional Parameters
- **store** (string) - Required - Datastore name.

#### Optional Parameters
- **--output-format** (enum: text|json|json-pretty) - Optional - Output format.

### Response
No structured response documented.
```

--------------------------------

### Example openssl certificate request prompts

Source: https://pbs.proxmox.com/docs/sysadmin.html

Example output shown when running the openssl command. Fill in your own values; the challenge password and optional company name are not necessary.

```text
Country Name (2 letter code) [AU]: AT
State or Province Name (full name) [Some-State]:Vienna
Locality Name (eg, city) []:Vienna
Organization Name (eg, company) [Internet Widgets Pty Ltd]: Proxmox GmbH
Organizational Unit Name (eg, section) []:Proxmox Backup
Common Name (eg, YOUR name) []: yourproxmox.yourdomain.com
Email Address []:support@yourdomain.com

Please enter the following 'extra' attributes to be sent with your certificate request
A challenge password []: not necessary
An optional company name []: not necessary
```

--------------------------------

### Example systemd-boot entry.conf

Source: https://pbs.proxmox.com/docs/sysadmin.html

Example bootloader entry file for systemd-boot, placed in loader/entries/ on the ESP. The paths refer to the root of the ESP.

```plaintext
title    Proxmox
version  5.0.15-1-pve
options   root=ZFS=rpool/ROOT/pve-1 boot=zfs
linux    /EFI/proxmox/5.0.15-1-pve/vmlinuz-5.0.15-1-pve
initrd   /EFI/proxmox/5.0.15-1-pve/initrd.img-5.0.15-1-pve
```

--------------------------------

### Repository format examples

Source: https://pbs.proxmox.com/docs/proxmox-backup.pdf

Table of valid repository strings and their corresponding components (auth-id, host:port, datastore). These examples illustrate the accepted formats for specifying a backup repository.

```text
mydatastore root@pam localhost:8007 mydatastore
myhostname:mydatastore root@pam myhostname:8007 mydatastore
user@pbs@myhostname:mydatastore user@pbs myhostname:8007 mydatastore
user@pbs!token@host:store user@pbs!token host:8007 store
192.168.55.55:1234:mydatastore root@pam 192.168.55.55:1234 mydatastore
[ff80::51]:mydatastore root@pam [ff80::51]:8007 mydatastore
[ff80::51]:1234:mydatastore root@pam [ff80::51]:1234 mydatastore
```

--------------------------------

### Install GRUB and regenerate grub.cfg

Source: https://pbs.proxmox.com/docs/proxmox-backup.pdf

For grub, install GRUB to the new disk with grub-install, then regenerate the GRUB configuration with grub-mkconfig. The grub.cfg is usually located at /boot/grub/grub.cfg.

```bash
grub-install <new disk>
```

```bash
grub-mkconfig -o /path/to/grub.cfg
```

--------------------------------

### proxmox-tape restore single snapshot example

Source: https://pbs.proxmox.com/docs/proxmox-backup.pdf

Example command to restore a single snapshot from a media-set to a datastore. The snapshot is specified as sourcestore:host/hostname/2022-01-01T00:01:00Z.

```bash
# proxmox-tape restore 9da37a55-aac7-4deb-91c6-482b3b675f30 mystore sourcestore:host/hostname/
↪→2022-01-01T00:01:00Z
```

--------------------------------

### Install Proxmox Backup Client on Debian

Source: https://pbs.proxmox.com/docs/installation.html

Run these commands after configuring the APT-based Proxmox Backup Client Repository to install the standard client package.

```bash
# apt update
# apt install proxmox-backup-client
```

--------------------------------

### Install Statically Linked Proxmox Backup Client

Source: https://pbs.proxmox.com/docs/installation.html

Run these commands after configuring the APT-based Proxmox Backup Client Repository to install the statically linked client. This package conflicts with proxmox-backup-client because both provide the executable at /usr/bin/proxmox-backup-client.

```bash
# apt update
# apt install proxmox-backup-client-static
```

--------------------------------

### Initialize ESP with proxmox-boot-tool

Source: https://pbs.proxmox.com/docs/sysadmin.html

Run this command separately for each ESP to set it up for booting through Grub. Replace /dev/sda2 with the actual partition.

```bash
# proxmox-boot-tool init /dev/sda2 grub
```

--------------------------------

### Create ext4 filesystem with datastore using proxmox-backup-manager disk fs create

Source: https://pbs.proxmox.com/docs/storage.html

Creates an ext4 filesystem on a disk and automatically creates a datastore at `/mnt/datastore/store1` when `--add-datastore true` is passed. Replace `sdX` with the target disk device.

```bash
# proxmox-backup-manager disk fs create store1 --disk sdX --filesystem ext4 --add-datastore true
```

--------------------------------

### verification.cfg example entry

Source: https://pbs.proxmox.com/docs/configuration-files.html

Shows the format for a verification job entry, starting with the header 'verification: <name>' followed by job options. The example includes ignore-verified, outdated-after, schedule, and store options.

```plaintext
verification: verify-store2
      ignore-verified true
      outdated-after 7
      schedule daily
      store store2

verification: ...
```

--------------------------------

### Initialize an ESP with proxmox-boot-tool init

Source: https://pbs.proxmox.com/docs/sysadmin.html

Sets up an existing, unmounted ESP (e.g., /dev/sda2) for inclusion in Proxmox Backup Server's kernel update synchronization. The optional 'grub' argument forces initialization with Grub instead of systemd-boot, useful for Secure Boot support. After running, /etc/kernel/proxmox-boot-uuids should contain a new line with the partition's UUID, and a refresh of all configured ESPs is triggered automatically.

```bash
# proxmox-boot-tool init /dev/sda2
```

```bash
# proxmox-boot-tool init /dev/sda2 grub
```

--------------------------------

### ACL configuration example

Source: https://pbs.proxmox.com/docs/configuration-files.html

Example entries for the acl.cfg file. Each line starts with 'acl:', followed by propagate flag, path, user/token, and role. Use the 'proxmox-backup-manager acl' command to manipulate this file.

```plaintext
acl:1:/:root@pam!test:Admin
acl:1:/datastore/store1:user1@pbs:DatastoreAdmin
```

--------------------------------

### tape-job.cfg example configuration

Source: https://pbs.proxmox.com/docs/configuration-files.html

Shows the file format for a tape backup job entry, starting with 'backup: <name>' followed by indented options. This example configures a job named 'job1' with drive 'hh8', pool 'p4', store 'store3', and a daily schedule.

```plaintext
backup: job1
      drive hh8
      pool p4
      store store3
      schedule daily

backup: ...
```

--------------------------------

### Initialize disk with GPT using proxmox-backup-manager disk initialize

Source: https://pbs.proxmox.com/docs/storage.html

Initializes a disk with a new GPT partition table. Replace `sdX` with the target disk device.

```bash
# proxmox-backup-manager disk initialize sdX
```

--------------------------------

### Create and update a user with proxmox-backup-manager

Source: https://pbs.proxmox.com/docs/user-management.html

Shows how to create a new user john@pbs with an email, then update the user's firstname, lastname, and comment. The create subcommand supports options like --email and --password.

```bash
# proxmox-backup-manager user create john@pbs --email john@example.com
# proxmox-backup-manager user update john@pbs --firstname John --lastname Smith
# proxmox-backup-manager user update john@pbs --comment "An example user."

```

--------------------------------

### remote.cfg entry format

Source: https://pbs.proxmox.com/docs/configuration-files.html

Shows the structure of a remote entry in remote.cfg, starting with the header 'remote: <name>' followed by indented options. The example includes host and auth-id options.

```plaintext
remote: server1
      host server1.local
      auth-id sync@pbs
      ...

remote: ...
```

--------------------------------

### sync.cfg entry format

Source: https://pbs.proxmox.com/docs/configuration-files.html

Shows the structure of a sync job entry in sync.cfg, starting with the header 'sync: <name>' followed by indented options. The example includes store, remote-store, and remote options.

```plaintext
sync: job1
      store store1
      remote-store store1
      remote lina

sync: ...
```

--------------------------------

### prune.cfg job entry example

Source: https://pbs.proxmox.com/docs/configuration-files.html

Shows the format for a prune job entry in prune.cfg. Each entry starts with 'prune: <name>' followed by indented options like schedule and store. The file can be manipulated using the 'proxmox-backup-manager prune-job' command.

```plaintext
prune: prune-store2
      schedule mon..fri 10:30
      store my-datastore

prune: ...
```

--------------------------------

### Add a kernel with proxmox-boot-tool kernel add

Source: https://pbs.proxmox.com/docs/sysadmin.html

Adds a specific kernel (by ABI version) to the list of kernels to keep installed and synced to all ESPs. Example adds kernel 5.0.15-1-pve. After manual addition, run proxmox-boot-tool refresh to update all ESPs.

```bash
# proxmox-boot-tool kernel add 5.0.15-1-pve
```

--------------------------------

### Format and initialize new ESP with systemd-boot

Source: https://pbs.proxmox.com/docs/proxmox-backup.pdf

For systemd-boot, format the new EFI System Partition (ESP) with proxmox-boot-tool format, then initialize it with proxmox-boot-tool init. ESP is partition #2 on bootable disks from the Proxmox Backup Server installer.

```bash
proxmox-boot-tool format <new ESP>
```

```bash
proxmox-boot-tool init <new ESP>
```

--------------------------------

### Install Proxmox Backup Server on Debian (full installer set)

Source: https://pbs.proxmox.com/docs/installation.html

Updates the package list and installs the proxmox-backup package, which installs all required packages, the Proxmox kernel with ZFS support, and a set of common and useful packages.

```bash
# apt update
# apt install proxmox-backup
```

--------------------------------

### Install Proxmox Backup Server on Debian

Source: https://pbs.proxmox.com/docs/proxmox-backup.pdf

Run this command after configuring the Debian Package Repositories to install the Proxmox Backup Server packages on a standard Debian installation.

```bash
apt install proxmox-backup
```

--------------------------------

### List datastores with proxmox-backup-manager

Source: https://pbs.proxmox.com/docs/storage.html

Command to list existing datastores from the command line, with example output showing datastore name, path, and comment.

```bash
# proxmox-backup-manager datastore list
┌────────┬──────────────────────┬─────────────────────────────┐
│ name   │ path                 │ comment                     │
╞════════╪══════════════════════╪═════════════════════════════╡
│ store1 │ /backup/disk1/store1 │ This is my default storage. │
└────────┴──────────────────────┴─────────────────────────────┘
```

--------------------------------

### Install Proxmox Backup Server on Debian (minimal)

Source: https://pbs.proxmox.com/docs/installation.html

Updates the package list and installs the proxmox-backup-server package, keeping the current Debian kernel and installing a minimal set of required packages.

```bash
# apt update
# apt install proxmox-backup-server
```
Tokens:
Raw