pve-storage-pbs.adoc

   1 [[storage_pbs]]
   2 Proxmox Backup Server
   3 ---------------------
   4 ifdef::wiki[]
   5 :pve-toplevel:
   6 :title: Storage: Proxmox Backup Server
   7 endif::wiki[]
   8
   9 Storage pool type: `pbs`
  10
  11 This backend allows direct integration of a Proxmox Backup Server into {pve}
  12 like any other storage.
  13 A Proxmox Backup storage can be added directly through the {pve} API, CLI or
  14 the webinterface.
  15
  16 Configuration
  17 ~~~~~~~~~~~~~
  18
  19 The backend supports all common storage properties, except the shared flag,
  20 which is always set. Additionally, the following special properties to Proxmox
  21 Backup Server are available:
  22
  23 server::
  24
  25 Server IP or DNS name. Required.
  26
  27 username::
  28
  29 The username for the Proxmox Backup Server storage. Required.
  30
  31 TIP: Do not forget to add the realm to the username. For example, `root@pam` or
  32 `archiver@pbs`.
  33
  34 password::
  35
  36 The user password. The value will be saved in a file under
  37 `/etc/pve/priv/storage/<STORAGE-ID>.pw` with access restricted to the root
  38 user. Required.
  39
  40 datastore::
  41
  42 The ID of the Proxmox Backup Server datastore to use. Required.
  43
  44 fingerprint::
  45
  46 The fingerprint of the Proxmox Backup Server API TLS certificate. You can get
  47 it in the Servers Dashboard or using the `proxmox-backup-manager cert info`
  48 command. Required for self-signed certificates or any other one where the host
  49 does not trusts the servers CA.
  50
  51 encryption-key::
  52
  53 A key to encrypt the backup data from the client side. Currently only
  54 non-password protected (no key derive function (kdf)) are supported. Will be
  55 saved in a file under `/etc/pve/priv/storage/<STORAGE-ID>.enc` with access
  56 restricted to the root user.  Use the magic value `autogen` to automatically
  57 generate a new one using `proxmox-backup-client key create --kdf none <path>`.
  58 Optional.
  59
  60 .Configuration Example (`/etc/pve/storage.cfg`)
  61 ----
  62 pbs: backup
  63         datastore main
  64         server enya.proxmox.com
  65         content backup
  66         fingerprint 09:54:ef:..snip..:88:af:47:fe:4c:3b:cf:8b:26:88:0b:4e:3c:b2
  67         maxfiles 0
  68         username archiver@pbs
  69 ----
  70
  71 Storage Features
  72 ~~~~~~~~~~~~~~~~
  73
  74 Proxmox Backup Server only supports backups, they can be block-level or
  75 file-level based. {pve} uses block-level for virtual machines and file-level for
  76 container.
  77
  78 .Storage features for backend `cifs`
  79 [width="100%",cols="m,4*d",options="header"]
  80 |===============================================================
  81 |Content types |Image formats |Shared |Snapshots |Clones
  82 |backup        |n/a           |yes    |n/a       |n/a
  83 |===============================================================
  84
  85 Examples
  86 ~~~~~~~~
  87
  88 // TODO: FIXME: add once available
  89 //You can get a list of exported CIFS shares with:
  90 //
  91 //----
  92 //# pvesm scan pbs <server> [--username <username>] [--password]
  93 //----
  94
  95 Then you could add this share as a storage to the whole {pve} cluster
  96 with:
  97
  98 ----
  99 # pvesm add pbs <id> --server <server> --datastore <datastore> --username <username> --fingerprint 00:B4:... --password
 100 ----
 101
 102 ifdef::wiki[]
 103
 104 See Also
 105 ~~~~~~~~
 106
 107 * link:/wiki/Storage[Storage]
 108
 109 endif::wiki[]