docs/managing-remotes.rst

   1 Managing Remotes
   2 ================
   3
   4 .. _backup_remote:
   5
   6 :term:`Remote`
   7 --------------
   8
   9 A remote refers to a separate Proxmox Backup Server installation and a user on that
  10 installation, from which you can `sync` datastores to a local datastore with a
  11 `Sync Job`. You can configure remotes in the web interface, under **Configuration
  12 -> Remotes**. Alternatively, you can use the ``remote`` subcommand. The
  13 configuration information for remotes is stored in the file
  14 ``/etc/proxmox-backup/remote.cfg``.
  15
  16 .. image:: images/screenshots/pbs-gui-remote-add.png
  17   :align: right
  18   :alt: Add a remote
  19
  20 To add a remote, you need its hostname or IP, a userid and password on the
  21 remote, and its certificate fingerprint. To get the fingerprint, use the
  22 ``proxmox-backup-manager cert info`` command on the remote, or navigate to
  23 **Dashboard** in the remote's web interface and select **Show Fingerprint**.
  24
  25 .. code-block:: console
  26
  27   # proxmox-backup-manager cert info |grep Fingerprint
  28   Fingerprint (sha256): 64:d3:ff:3a:50:38:53:5a:9b:f7:50:...:ab:fe
  29
  30 Using the information specified above, you can add a remote from the **Remotes**
  31 configuration panel, or by using the command:
  32
  33 .. code-block:: console
  34
  35   # proxmox-backup-manager remote create pbs2 --host pbs2.mydomain.example --userid sync@pam --password 'SECRET' --fingerprint 64:d3:ff:3a:50:38:53:5a:9b:f7:50:...:ab:fe
  36
  37 Use the ``list``, ``show``, ``update``, ``remove`` subcommands of
  38 ``proxmox-backup-manager remote`` to manage your remotes:
  39
  40 .. code-block:: console
  41
  42   # proxmox-backup-manager remote update pbs2 --host pbs2.example
  43   # proxmox-backup-manager remote list
  44   ┌──────┬──────────────┬──────────┬───────────────────────────────────────────┬─────────┐
  45   │ name │ host         │ userid   │ fingerprint                               │ comment │
  46   ╞══════╪══════════════╪══════════╪═══════════════════════════════════════════╪═════════╡
  47   │ pbs2 │ pbs2.example │ sync@pam │64:d3:ff:3a:50:38:53:5a:9b:f7:50:...:ab:fe │         │
  48   └──────┴──────────────┴──────────┴───────────────────────────────────────────┴─────────┘
  49   # proxmox-backup-manager remote remove pbs2
  50
  51
  52 .. _syncjobs:
  53
  54 Sync Jobs
  55 ---------
  56
  57 .. image:: images/screenshots/pbs-gui-syncjob-add.png
  58   :align: right
  59   :alt: Add a Sync Job
  60
  61 Sync jobs are configured to pull the contents of a datastore on a **Remote** to
  62 a local datastore. You can manage sync jobs under **Configuration -> Sync Jobs**
  63 in the web interface, or using the ``proxmox-backup-manager sync-job`` command.
  64 The configuration information for sync jobs is stored at
  65 ``/etc/proxmox-backup/sync.cfg``. To create a new sync job, click the add button
  66 in the GUI, or use the ``create`` subcommand. After creating a sync job, you can
  67 either start it manually on the GUI or provide it with a schedule (see
  68 :ref:`calendar-events`) to run regularly.
  69
  70 .. code-block:: console
  71
  72   # proxmox-backup-manager sync-job create pbs2-local --remote pbs2 --remote-store local --store local --schedule 'Wed 02:30'
  73   # proxmox-backup-manager sync-job update pbs2-local --comment 'offsite'
  74   # proxmox-backup-manager sync-job list
  75   ┌────────────┬───────┬────────┬──────────────┬───────────┬─────────┐
  76   │ id         │ store │ remote │ remote-store │ schedule  │ comment │
  77   ╞════════════╪═══════╪════════╪══════════════╪═══════════╪═════════╡
  78   │ pbs2-local │ local │ pbs2   │ local        │ Wed 02:30 │ offsite │
  79   └────────────┴───────┴────────┴──────────────┴───────────┴─────────┘
  80   # proxmox-backup-manager sync-job remove pbs2-local
  81
  82 For setting up sync jobs, the configuring user needs the following permissions:
  83
  84 #. ``Remote.Read`` on the ``/remote/{remote}/{remote-store}`` path
  85 #. at least ``Datastore.Backup`` on the local target datastore (``/datastore/{store}``)
  86
  87 If the ``remove-vanished`` option is set, ``Datastore.Prune`` is required on
  88 the local datastore as well. If the ``owner`` option is not set (defaulting to
  89 ``backup@pam``) or set to something other than the configuring user,
  90 ``Datastore.Modify`` is required as well.
  91
  92 .. note:: A sync job can only sync backup groups that the configured remote's
  93   user/API token can read. If a remote is configured with a user/API token that
  94   only has ``Datastore.Backup`` privileges, only the limited set of accessible
  95   snapshots owned by that user/API token can be synced.