From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40]) by lore.proxmox.com (Postfix) with ESMTPS id 679DD1FF0B7 for ; Fri, 13 Nov 2026 10:06:05 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id E914B21709; Fri, 13 Nov 2026 10:06:04 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=stuttgart.de; s=s1022; t=1794560287; bh=9OykfA/a7rpCgqCaDolvDr2vzmof5anrBz+a51KnqAU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=FkGdM7CXgw2mRWBXlpkpmJ9RMCwD2rVrez8I2ZCKwcVfqyEDkHVTMbZvH6V7r0sX8 GJHrr8YqbgLY7DJjXdt9NTPvcAauKWKutk36w/h8InN4F47DsYn8qoKYiDFAgRQLtD 6BypmJqZpJ38ZkLm9F8T7AmJqX0mQLotVst1U7XCgwjfot58hI9rvNZVqTrPG1fB16 FBUhKTf3eucwbIbhRe5XgUQy5dR2+zWThUsyS3hUpfylfYRVNXSfMUPk70emzkJYaf B7JmymKlgFpHAjx0YM2l5qf91R/+R/FNYINWE1rEcArwhdhFbhhKy6e8kTJnQWzOw8 xggP40JJlLP4Q== From: Jakob-Tobias Winter To: pbs-devel@lists.proxmox.com Subject: [RFC PATCH docs 12/12] vzdump: describe snapshot attributes on Proxmox Backup Server Date: Fri, 13 Nov 2026 09:56:39 +0100 Message-ID: <20261113085637.57360-15-tobias@stuttgart.de> X-Mailer: git-send-email 2.53.0 In-Reply-To: <20261113085637.57360-3-tobias@stuttgart.de> References: <20261113085637.57360-3-tobias@stuttgart.de> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.027 Adjusted score from AWL reputation of From: address DKIM_SIGNED 0.1 Message has a DKIM or DK signature, not necessarily valid DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's domain DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from domain DMARC_PASS -0.1 DMARC pass policy RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_PASS -0.001 SPF: HELO matches SPF record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: 6QDYX37OLVJ7RO3XEX7MH2R7MK5N2LSE X-Message-ID-Hash: 6QDYX37OLVJ7RO3XEX7MH2R7MK5N2LSE X-MailFrom: prvs=d19b210678=tobias@stuttgart.de X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: Jakob-Tobias Winter X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox Backup Server development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: 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 --- 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