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 9260E96221 for ; Mon, 23 Jan 2023 16:58:49 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 6B55429E70 for ; Mon, 23 Jan 2023 16:58:49 +0100 (CET) Received: from lana.proxmox.com (unknown [94.136.29.99]) by firstgate.proxmox.com (Proxmox) with ESMTP for ; Mon, 23 Jan 2023 16:58:48 +0100 (CET) Received: by lana.proxmox.com (Postfix, from userid 10043) id 7790B2C226A; Mon, 23 Jan 2023 16:58:48 +0100 (CET) From: Stefan Hanreich To: pve-devel@lists.proxmox.com Date: Mon, 23 Jan 2023 16:58:46 +0100 Message-Id: <20230123155847.598536-2-s.hanreich@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230123155847.598536-1-s.hanreich@proxmox.com> References: <20230123155847.598536-1-s.hanreich@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 2.141 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 KAM_LAZY_DOMAIN_SECURITY 1 Sending domain does not have any anti-forgery methods NO_DNS_FOR_FROM 0.001 Envelope sender has no MX or A DNS records RCVD_IN_DNSWL_HI -5 Sender listed at https://www.dnswl.org/, high trust RDNS_NONE 0.793 Delivered to internal network by a host with no rDNS SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_NONE 0.001 SPF: sender does not publish an SPF Record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [guest-example-hookscript.pl] Subject: [pve-devel] [PATCH pve-docs v3 1/1] examples: add pre/post/failed-snapshot hooks to example hookscript X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 23 Jan 2023 15:58:49 -0000 Added a section for each new snapshot hook to the example hookscript, as well as a short comment explaining when the respective section gets executed. Additionally added documentation for the different possible values of the envvar PVE_SNAPSHOT_PHASE. Signed-off-by: Stefan Hanreich --- examples/guest-example-hookscript.pl | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/examples/guest-example-hookscript.pl b/examples/guest-example-hookscript.pl index adeed59..51c1d61 100755 --- a/examples/guest-example-hookscript.pl +++ b/examples/guest-example-hookscript.pl @@ -54,6 +54,32 @@ if ($phase eq 'pre-start') { print "$vmid stopped. Doing cleanup.\n"; +} elsif ($phase eq 'pre-snapshot') { + + # Phase 'pre-snapshot' will be executed before taking a snapshot of + # the guest (via UI or CLI) + + print "$vmid will be snapshotted.\n"; + +} elsif ($phase eq 'post-snapshot') { + + # Phase 'post-snapshot' will be executed after taking a snapshot of + # the guest (via UI or CLI) + + print "$vmid has been successfully snapshotted.\n"; + +} elsif ($phase eq 'failed-snapshot') { + + # Phase 'failed-snapshot' will be executed when taking a snapshot of + # the guest fails and 'pre-snapshot' already ran (via UI or CLI) + # Envvar PVE_SNAPSHOT_PHASE can be one of the following: + # - pre-snapshot (when pre-snapshot hook failed) + # - prepare (when preparation step failed) + # - snapshot (when snapshotting the disks failed) + # - post-snapshot (when post-snapshot hook failed) + + print "$vmid snapshot failed in phase $ENV{PVE_SNAPSHOT_PHASE}.\n"; + } else { die "got unknown phase '$phase'\n"; } -- 2.30.2