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 A35C91FF0DA for ; Thu, 19 Nov 2026 20:24:22 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id 7868F21AE6; Thu, 19 Nov 2026 20:20:21 +0100 (CET) From: Thomas Lamprecht To: pve-devel@lists.proxmox.com Subject: [PATCH docs v5 41/41] vzdump: notes: document the uid template variable Date: Thu, 19 Nov 2026 20:19:13 +0100 Message-ID: <20261119191914.2336934-42-t.lamprecht@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20261119191914.2336934-1-t.lamprecht@proxmox.com> References: <20261119191914.2336934-1-t.lamprecht@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1795115961685 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.156 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: CHTQTIR7LH4KCZIDEXJ4LFGMJ5KCNC4X X-Message-ID-Hash: CHTQTIR7LH4KCZIDEXJ4LFGMJ5KCNC4X X-MailFrom: t.lamprecht@proxmox.com 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 X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: The notes template of backups can contain the uid of the guest identity that the backup includes. Add it to the list of variables. Nodes with an older version check the template against the variables they know and refuse the whole backup job otherwise. So warn that a job using the variable backs up none of the guests on such nodes, for example while a cluster gets upgraded. Signed-off-by: Thomas Lamprecht Reviewed-by: Dominik Csapak Tested-by: Dominik Csapak --- no changes since v4 changes v3 -> v4: * new in v4, with a warning that nodes with an older version refuse a backup job that uses the variable vzdump.adoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/vzdump.adoc b/vzdump.adoc index dda1b8f..87e903a 100644 --- a/vzdump.adoc +++ b/vzdump.adoc @@ -445,8 +445,14 @@ Currently supported are: * `{{cluster}}` the cluster name, if any * `{{guestname}}` the virtual guest's assigned name * `{{node}}` the host name of the node the backup is being created +* `{{uid}}` the `uid` of the xref:guest_identity[guest identity] in the backup, + if any * `{{vmid}}` the numerical VMID of the guest +WARNING: Nodes running a {pve} version older than 9.3 refuse a backup job whose +notes template contains `{{uid}}` and back up none of their guests for it. Use +the variable only once all nodes are upgraded. + 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. -- 2.47.3