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 444E871BC7 for ; Fri, 13 May 2022 15:40:12 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 3A718257E for ; Fri, 13 May 2022 15:39:42 +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)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 904BE2568 for ; Fri, 13 May 2022 15:39:40 +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 674F4434EB for ; Fri, 13 May 2022 15:39:40 +0200 (CEST) From: Dominik Csapak To: pbs-devel@lists.proxmox.com Date: Fri, 13 May 2022 15:39:39 +0200 Message-Id: <20220513133939.3845808-4-d.csapak@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220513133939.3845808-1-d.csapak@proxmox.com> References: <20220513133939.3845808-1-d.csapak@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.119 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 T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pbs-devel] [PATCH proxmox-backup 4/4] docs: tape: add information about namespaces X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 13 May 2022 13:40:12 -0000 which are backed up, how to use the new parameters and how to map them during restore Signed-off-by: Dominik Csapak --- docs/tape-backup.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/tape-backup.rst b/docs/tape-backup.rst index 0eb32412..8888dacb 100644 --- a/docs/tape-backup.rst +++ b/docs/tape-backup.rst @@ -681,6 +681,16 @@ To remove a job, please use: # proxmox-tape backup-job remove job2 +By default, all (recursive) namespaces of the datastore are included in a tape +backup. You can specify a single namespace wth ``ns`` and a depth with +``max-depth``. For example: + +.. code-block:: console + + # proxmox-tape backup-job update job2 --ns mynamespace --max-depth 3 + +If no `max-depth` is given, it will include all recursive namespaces. + .. image:: images/screenshots/pbs-gui-tape-backup-jobs-add.png :align: right :alt: Tape Backup: Add a backup job @@ -797,6 +807,16 @@ The following options are available: media set into import-export slots. The operator can then pick up those tapes and move them to a media vault. +--ns The namespace to backup. + + If you only want to backup a specific namespace. If omitted, the root + namespaces is assumed. + +--max-depth The depth to recurse namespaces. + + ``0`` means no recursion at all (only the given namespace). If omitted, + all namespaces are recursed (below the the given one). + Restore from Tape ~~~~~~~~~~~~~~~~~ @@ -855,6 +875,30 @@ multiple snapshots with one restore action. more than once, which, if you restore many snapshots at once, can take longer than restoring the whole datastore. +Namespaces +^^^^^^^^^^ + +It is also possible to select and map specific namespaces from a media-set +during a restore. This is possible with the ``namespaces`` parameter. +The format of the parameter is + +.. code-block:: console + + store=[,source=][,target=][,max-depth=] + +If ``source`` or ``target`` is not given, the root namespace is assumed. +When no ``max-depth`` is given, the source namespace will be fully recursed. + +An example restore command: + +.. code-block:: console + + # proxmox-tape restore 9da37a55-aac7-4deb-91c6-482b3b675f30 mystore --namespaces store=sourcedatastore,source=ns1,target=ns2,max-depth=2 + +The parameter can be given multiple times. It can also be combined with the +``snapshots`` parameter to only restore those snapshots and map them to different +namespaces. + Update Inventory ~~~~~~~~~~~~~~~~ -- 2.30.2