From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id CC32A1FF13B for ; Wed, 11 Mar 2026 10:45:27 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id B886E12561; Wed, 11 Mar 2026 10:45:17 +0100 (CET) From: Fiona Ebner To: pve-devel@lists.proxmox.com Subject: [PATCH storage v2 01/11] plugin: document volume_snapshot_info() method Date: Wed, 11 Mar 2026 10:44:40 +0100 Message-ID: <20260311094506.22359-2-f.ebner@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260311094506.22359-1-f.ebner@proxmox.com> References: <20260311094506.22359-1-f.ebner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1773222275000 X-SPAM-LEVEL: Spam detection results: 0 AWL -1.502 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy 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 URIBL_BLACK 3 Contains an URL listed in the URIBL blacklist [plugin.pm] Message-ID-Hash: OGQUMKGUXPYEKQNMASSATJHLPD4RFMV4 X-Message-ID-Hash: OGQUMKGUXPYEKQNMASSATJHLPD4RFMV4 X-MailFrom: f.ebner@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: The method was originally only used for ZFS replication and then it got re-used for snapshot-as-volume-chain which returns quite different information. Document this and the possible values in each case. Signed-off-by: Fiona Ebner --- src/PVE/Storage/Plugin.pm | 51 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 47 insertions(+), 4 deletions(-) diff --git a/src/PVE/Storage/Plugin.pm b/src/PVE/Storage/Plugin.pm index 6f3d691..d901853 100644 --- a/src/PVE/Storage/Plugin.pm +++ b/src/PVE/Storage/Plugin.pm @@ -1812,10 +1812,53 @@ sub status { return ($res->{total}, $res->{avail}, $res->{used}, 1); } -# Returns a hash with the snapshot names as keys and the following data: -# id - Unique id to distinguish different snapshots even if the have the same name. -# timestamp - Creation time of the snapshot (seconds since epoch). -# Returns an empty hash if the volume does not exist. +=head3 volume_snapshot_info + + my $snapshots = $plugin->volume_snapshot_info($scfg, $storeid, $volname); + my $childsnap = $snapshots->{$snap}->{child}; + my $childpath = $snapshots->{$childsnap}->{file}; + +Query information about snapshots for C<$volname>. The result is a hash reference with snapshot +names as keys and additional information as values. Different information is required for supporting +the C storage configuration option and for supporting replication (note +that replication is currently limited to native ZFS plugins). + +For C support, an entry with key C exists for the current state. +Required values are: + +=over + +=item C: The image filename of the external snapshot volume. + +=item C: The volume name of the external snapshot volume. + +=item C: The volume ID of the external snapshot volume. + +=item C: The name of the child snapshot in the volume chain. Not set if there is no child. + +=item C: The name of the parent snapshot in the volume chain. Not set if there is no parent. + +=item C: Number that determines the position in the backing chain. C<0> for the current +image, one more for each step further back in the volume chain. + +=item C: May be set if the snapshot is external when internal snapshots are also supported by +the storage. + +=back + +For replication support, returns an empty hash if the volume does not exist. Required values are: + +=over + +=item C: Unique identifier of the snapshot. Must be the same for the replicated instance. Must +be different for different snapshots even if they share the same name. + +=item C: Creation time of the snapshot (seconds since epoch). + +=back + +=cut + sub volume_snapshot_info { my ($class, $scfg, $storeid, $volname) = @_; -- 2.47.3