From 38517ca053469ee9a833e87d23d3090078ab6be5 Mon Sep 17 00:00:00 2001 From: Dominik Csapak Date: Wed, 27 Oct 2021 13:22:38 +0200 Subject: [PATCH] docs: add info about protection flag to client docs and mention that sync/pull does not sync the protected flag Signed-off-by: Dominik Csapak Signed-off-by: Wolfgang Bumiller --- docs/backup-client.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index 2b51c62c..fec6ae59 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -654,6 +654,25 @@ shows the list of existing snapshots and what actions prune would take. in the chunk-store. The chunk-store still contains the data blocks. To free space you need to perform :ref:`client_garbage-collection`. +It is also possible to protect single snapshots from being pruned or deleted: + +.. code-block:: console + + # proxmox-backup-client snapshot protected update true + +This will set the protected flag on the snapshot and prevent pruning or manual +deletion of this snapshot untilt he flag is removed again with: + +.. code-block:: console + + # proxmox-backup-client snapshot protected update false + +When a group is with a protected snapshot is deleted, only the non-protected +ones are removed and the group will remain. + +.. note:: This flag will not be synced when using pull or sync jobs. If you + want to protect a synced snapshot, you have to manually to this again on + the target :ref:`backup server. .. _client_garbage-collection: