vzdump: minimally rework backup notes, mostly formatting

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
master
Thomas Lamprecht 2022-04-28 15:17:23 +02:00
parent 3cb107b7fa
commit 3b5307ff0a
1 changed files with 16 additions and 7 deletions

View File

@ -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