all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Jakob-Tobias Winter <tobias@stuttgart.de>
To: pbs-devel@lists.proxmox.com
Cc: Jakob-Tobias Winter <tobias@stuttgart.de>
Subject: [RFC PATCH docs 12/12] vzdump: describe snapshot attributes on Proxmox Backup Server
Date: Fri, 13 Nov 2026 09:56:39 +0100	[thread overview]
Message-ID: <20261113085637.57360-15-tobias@stuttgart.de> (raw)
In-Reply-To: <20261113085637.57360-3-tobias@stuttgart.de>

Explain which attributes are stored with a backup on a Proxmox
Backup Server, what they can be used for, that they are not
encrypted and how to disable them.

Signed-off-by: Jakob-Tobias Winter <tobias@stuttgart.de>
---

 vzdump.adoc | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/vzdump.adoc b/vzdump.adoc
index 44db027..25ace9e 100644
--- a/vzdump.adoc
+++ b/vzdump.adoc
@@ -450,6 +450,42 @@ Currently supported are:
 When specified via API or CLI, it needs to be a single line, where newline and
 backslash need to be escaped as literal `\n` and `\\` respectively.
 
+[[vzdump_pbs_snapshot_attributes]]
+Snapshot Attributes on Proxmox Backup Server
+--------------------------------------------
+
+When a guest is backed up to a Proxmox Backup Server, its tags and its resource
+pool are stored as attributes of the backup snapshot:
+
+* `pve-tag` has one value for each tag of the guest
+* `pve-pool` has the resource pool of the guest as its value, and for a nested
+  pool also each of its parent pools
+
+For example, a guest in the pool `customers/acme` gets the `pve-pool` values
+`customers/acme` and `customers`.
+
+The attributes describe the guest at the time of the backup. On the Proxmox
+Backup Server they can be used to select backups, for example to write the
+backups of all guests with a certain tag to a separate tape media pool.
+Selecting by a pool also covers the guests of the pools nested in it.
+
+NOTE: The attributes are not encrypted, also if the backup itself is encrypted.
+Everyone who can see the backup snapshot on the Proxmox Backup Server can read
+them, and they are part of synced copies and tape backups of the snapshot.
+
+If the tags and the resource pool should not be known to the backup server,
+disable the `pbs-snapshot-attributes` option. This can be done for single backup
+jobs, or for all backups created on a node, by adding the following line to
+`/etc/vzdump.conf`:
+
+----
+pbs-snapshot-attributes: 0
+----
+
+Attributes can only be stored if the Proxmox Backup Server supports them. With
+older versions the backup works as before, and the backup log notes that the
+attributes were not stored.
+
 [[vzdump_restore]]
 Restore
 -------

base-commit: 3f9fbc189be60dc64c1213191cafee3fffa30981
-- 
2.53.0




  parent reply	other threads:[~2026-11-13  9:06 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-13  8:56 [RFC PATCH many 00/12] snapshot attributes for tags and pools of PVE guests, tape job filter Jakob-Tobias Winter
2026-11-13  8:56 ` [RFC PATCH proxmox 01/12] pbs-api-types: add types and schemas for snapshot attributes Jakob-Tobias Winter
2026-11-16 14:57   ` Christian Ebner
2026-11-18 12:54   ` Samuel Rufinatscha
2026-11-13  8:56 ` [RFC PATCH proxmox 02/12] pbs-api-types: tape: add attribute filter to backup jobs Jakob-Tobias Winter
2026-11-16 14:57   ` Christian Ebner
2026-11-13  8:56 ` [RFC PATCH proxmox-backup 03/12] datastore: add attributes to backup snapshots Jakob-Tobias Winter
2026-11-16 14:57   ` Christian Ebner
2026-11-18 12:55   ` Samuel Rufinatscha
2026-11-13  8:56 ` [RFC PATCH proxmox-backup 04/12] fix #7452: api: datastore: add endpoints for snapshot attributes Jakob-Tobias Winter
2026-11-16 14:57   ` Christian Ebner
2026-11-13  8:56 ` [RFC PATCH proxmox-backup 05/12] tape: backup job: allow selecting groups by " Jakob-Tobias Winter
2026-11-18 13:06   ` Samuel Rufinatscha
2026-11-18 15:19     ` Christian Ebner
2026-11-13  8:56 ` [RFC PATCH proxmox-backup 06/12] ui: tape backup job: add attribute filter Jakob-Tobias Winter
2026-11-13  8:56 ` [RFC PATCH proxmox-backup 07/12] docs: describe snapshot attributes and the tape job " Jakob-Tobias Winter
2026-11-13  8:56 ` [RFC PATCH storage 08/12] pbs: add helper to set the attributes of a backup snapshot Jakob-Tobias Winter
2026-11-13  8:56 ` [RFC PATCH guest-common 09/12] vzdump: add pbs-snapshot-attributes option Jakob-Tobias Winter
2026-11-13  8:56 ` [RFC PATCH manager 10/12] vzdump: store guest tags and pool as snapshot attributes on PBS Jakob-Tobias Winter
2026-11-13  8:56 ` [RFC PATCH manager 11/12] ui: backup job: add selector for PBS snapshot attributes Jakob-Tobias Winter
2026-11-13  8:56 ` Jakob-Tobias Winter [this message]
2026-11-16 14:57 ` [RFC PATCH many 00/12] snapshot attributes for tags and pools of PVE guests, tape job filter Christian Ebner
2026-11-18 13:07   ` Samuel Rufinatscha
2026-11-18 14:22 ` Samuel Rufinatscha
2026-11-19 11:58   ` Jakob-Tobias Winter

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261113085637.57360-15-tobias@stuttgart.de \
    --to=tobias@stuttgart.de \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal