From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 32440AE0C for ; Thu, 28 Apr 2022 10:07:46 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 231922E57E for ; Thu, 28 Apr 2022 10:07:46 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 3346D2E566 for ; Thu, 28 Apr 2022 10:07:45 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id E98C142F16 for ; Thu, 28 Apr 2022 10:07:44 +0200 (CEST) From: Fabian Ebner To: pve-devel@lists.proxmox.com Date: Thu, 28 Apr 2022 10:07:41 +0200 Message-Id: <20220428080741.55308-3-f.ebner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220428080741.55308-1-f.ebner@proxmox.com> References: <20220428080741.55308-1-f.ebner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.080 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pve-devel] [PATCH docs 1/1] vzdump: add section for notes and notes-template X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 28 Apr 2022 08:07:46 -0000 Signed-off-by: Fabian Ebner --- vzdump.adoc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/vzdump.adoc b/vzdump.adoc index 093f639..5a13d3a 100644 --- a/vzdump.adoc +++ b/vzdump.adoc @@ -306,6 +306,19 @@ backups per guest are allowed on the storage. Use `-1` for unlimited. The default is unlimited for users with `Datastore.Allocate` privilege and `5` for other users. +[[vzdump_notes]] +Backup Notes +------------ + +You can add notes to backups using the 'Edit Notes' button in the UI or via the +storage content API. It is also possible to specify a template for generating +notes dynamically for a backup job and for manual backup. The template string +can contain variables, surrounded by two curly braces, which will be replaced by +the corresponding value when the backup is executed. Currently supported are +`{{cluster}}`, `{{guestname}}`, `{{node}}`, and `{{vmid}}`. When specified via +API or CLI, it needs to be a single line, where newline and backslash need to be +escaped as `\n` and `\\` respectively. + [[vzdump_restore]] Restore ------- -- 2.30.2