From: Fabian Ebner <f.ebner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH docs 1/1] vzdump: add section for notes and notes-template
Date: Thu, 28 Apr 2022 10:07:41 +0200 [thread overview]
Message-ID: <20220428080741.55308-3-f.ebner@proxmox.com> (raw)
In-Reply-To: <20220428080741.55308-1-f.ebner@proxmox.com>
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
---
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
prev parent reply other threads:[~2022-04-28 8:07 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-28 8:07 [pve-devel] [PATCH manager 1/1] vzdump: check that notes-template is a single line Fabian Ebner
2022-04-28 8:07 ` [pve-devel] [PATCH guest-common 1/1] vzdump: update notes-template description Fabian Ebner
2022-04-28 8:07 ` Fabian Ebner [this message]
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=20220428080741.55308-3-f.ebner@proxmox.com \
--to=f.ebner@proxmox.com \
--cc=pve-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