Product SiteDocumentation Site

⁠30.4. Сценарии перехвата (hookscripts)

выполнять скрипты на узле PVE на определённых этапах жизненного цикла ВМ или контейнера: перед запуском (pre-start), после запуска (post-start), перед остановкой (pre-stop), после остановки (post-stop).
Сценарии перехвата должны находиться в хранилище, поддерживающем содержимое типа snippets (фрагменты скриптов, «мини-сценарии»).
Чтобы использовать эту функцию, создайте исполняемый файл скрипта в каталоге сниппетов. Например, для хранилища local при стандартной конфигурации это каталог /var/lib/vz/snippets), а для хранилища local-btrfs — /var/lib/pve/local-btrfs/snippets. Затем укажите скрипт в конфигурации ВМ или контейнера.

Примечание

Перед миграцией ВМ или контейнера убедитесь, что сценарий перехвата доступен на целевом узле. Хранилище со сниппетами должно быть доступно на всех узлах, на которые может выполняться миграция, либо файл должен быть другим способом размещён на целевом узле
Добавить сценарий перехвата к ВМ или контейнеру можно с помощью параметра hookscript:
# qm set <vmid> --hookscript <storage>:snippets/<script_file>
# pct set <vmid> --hookscript <storage>:snippets/<script_file>
где <script_file> — исполняемый файл сценария.
Например:
# qm set 103 --hookscript snippet:snippets/guest-hookscript.pl
update VM 103: -hookscript snippet:snippets/guest-hookscript.pl

Примечание

В настоящее время добавить сценарий перехвата можно только в командной строке. В веб-интерфейсе можно только просмотреть список скриптов в хранилище:
Хранилище snippet на узле pve01
и скрипт, добавленный к ВМ:
Скрипт-ловушка для ВМ 103
Пример сценария перехвата на Perl (файл guest-hookscript.pl):
#!/usr/bin/perl

# Example hookscript for PVE guests

use strict;
use warnings;

print "GUEST HOOK: " . join(' ', @ARGV). "\n";

# Первый аргумент — VMID

my $vmid = shift;

# Второй аргумент — этап выполнения

my $phase = shift;

if ($phase eq 'pre-start') {

    # Первый этап 'pre-start' перед запуском ВМ
    # Выход с code != 0 отменит запуск ВМ

    print "$vmid is starting, doing preparations.\n";

    # print "preparations failed, aborting."
    # exit(1);

} elsif ($phase eq 'post-start') {

    # Второй этап 'post-start' выполняется после успешного
    # запуска ВМ
    system("/root/date.sh $vmid");
    print "$vmid started successfully.\n";

} elsif ($phase eq 'pre-stop') {

    # Третий этап 'pre-stop' выполняется перед остановкой ВМ через API.
    # Не вызывается, если ВМ выключена изнутри,
    # например, с помощью 'poweroff'

    print "$vmid will be stopped.\n";
} elsif ($phase eq 'post-stop') {

    # Последний этап 'post-stop' выполняется после остановки ВМ,
    # в том числе после аварийной остановки.

    print "$vmid stopped. Doing cleanup.\n";

} else {
    die "got unknown phase '$phase'\n";
}

exit(0);
В этом примере функция system() запускает сценарий /root/date.sh, передавая VMID отдельным аргументом. Скрипт должен существовать и быть доступен для выполнения от имени пользователя, запускающего сценарий перехвата.
Текст отладки выводится в «консоль»/stdout. Текст будет помещен в журналы задач ВМ и узла PVE. Сообщения pre-start, post-start и pre-stop будут опубликованы в обоих журналах. Сообщения post-stop будут публиковаться только в журналах задач узла PVE (поскольку ВМ уже остановлена).
Выполнение скрипта guest-hookscript.pl при запуске ВМ
Пример сценария перехвата на Bash:
#!/bin/bash
if [ $2 == "pre-start" ]
then
echo "Запуск ВМ $1" >> /root/test.txt
date >> /root/test.txt
fi
В этом примере $1 — VMID, а $2 — этап выполнения сценария. При запуске ВМ на этапе pre-start скрипт записывает сообщение и дату в файл /root/test.txt.