From 3b5307ff0a7b95e0fade7acd13754ebd08600ea0 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Thu, 28 Apr 2022 15:17:23 +0200 Subject: [PATCH] vzdump: minimally rework backup notes, mostly formatting Signed-off-by: Thomas Lamprecht --- vzdump.adoc | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/vzdump.adoc b/vzdump.adoc index 5a13d3a..544ed5e 100644 --- a/vzdump.adoc +++ b/vzdump.adoc @@ -311,13 +311,22 @@ 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. +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}}` the cluster name, if any +* `{{guestname}}` the virtual guest's assigned name +* `{{node}}` the host name of the node the backup is being created +* `{{vmid}}` the numerical VMID of the guest + +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_restore]] Restore