docs/pve-integration.rst

   1 .. _pve-integration:
   2
   3 `Proxmox VE`_ Integration
   4 -------------------------
   5
   6 Proxmox Backup Server can be integrated into a Proxmox VE standalone or cluster
   7 setup, by adding it as a storage in Proxmox VE.
   8
   9 See also the `Proxmox VE Storage - Proxmox Backup Server
  10 <https://pve.proxmox.com/pve-docs/pve-admin-guide.html#storage_pbs>`_ section
  11 of the Proxmox VE Administration Guide for Proxmox VE specific documentation.
  12
  13
  14 Using the Proxmox VE Web-Interface
  15 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16
  17 Proxmox VE has native API and web interface integration of Proxmox Backup
  18 Server as of `Proxmox VE 6.3
  19 <https://pve.proxmox.com/wiki/Roadmap#Proxmox_VE_6.3>`_.
  20
  21 A Proxmox Backup Server can be added under ``Datacenter -> Storage``.
  22
  23 Using the Proxmox VE Command-Line
  24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  25
  26 You need to define a new storage with type 'pbs' on your `Proxmox VE`_
  27 node. The following example uses ``store2`` as the storage's name, and
  28 assumes the server address is ``localhost`` and you want to connect
  29 as ``user1@pbs``.
  30
  31 .. code-block:: console
  32
  33   # pvesm add pbs store2 --server localhost --datastore store2
  34   # pvesm set store2 --username user1@pbs --password <secret>
  35
  36 .. note:: If you would rather not enter your password as plain text, you can pass
  37   the ``--password`` parameter, without any arguments. This will cause the
  38   program to prompt you for a password upon entering the command.
  39
  40 If your backup server uses a self signed certificate, you need to add
  41 the certificate fingerprint to the configuration. You can get the
  42 fingerprint by running the following command on the backup server:
  43
  44 .. code-block:: console
  45
  46   # proxmox-backup-manager cert info | grep Fingerprint
  47   Fingerprint (sha256): 64:d3:ff:3a:50:38:53:5a:9b:f7:50:...:ab:fe
  48
  49 Please add that fingerprint to your configuration to establish a trust
  50 relationship:
  51
  52 .. code-block:: console
  53
  54   # pvesm set store2 --fingerprint  64:d3:ff:3a:50:38:53:5a:9b:f7:50:...:ab:fe
  55
  56 After that, you should be able to view storage status with:
  57
  58 .. code-block:: console
  59
  60   # pvesm status --storage store2
  61   Name             Type     Status           Total            Used       Available        %
  62   store2            pbs     active      3905109820      1336687816      2568422004   34.23%
  63
  64 Having added the Proxmox Backup Server datastore to `Proxmox VE`_, you can
  65 backup VMs and containers in the same way you would for any other storage
  66 device within the environment (see `Proxmox VE Admin Guide: Backup and Restore
  67 <https://pve.proxmox.com/pve-docs/pve-admin-guide.html#chapter_vzdump>`_.
  68
  69