Интерфейс командной строки rv-backup
Функционал rv-backup разбит на субкоманды, каждая из которых имеет свою справку. Таким образом один функционал может инкапсулировать другой. Это сделано для того, чтобы избежать ошибок и подтолкнуть пользователя к дополнительному осмыслению своих действий.
Примечание – Угловые скобки <имя_аргумента> обозначают обязательный аргумент.
rv-backup
Usage:
rv-backup [vm|transfers|locks|emergency|list]
Common:
vm‒ Working with virtual machines. See "rv-backup vm --help".
transfers‒ Working with transfer objects, mainly for unusual situations. See "rv-backup
transfers --help".
locks‒ Working with file locks.
storage‒ Helpers for connecting storage for backups. See "rv-backup storage --help".
emergency‒ Working with emergency situations.
list‒ Working with lists that do not require specifying a virtual machine. See
"rv-backup list --help"
--token <token_str>‒ Use authorization by token. The session to which the token is bound will
not be terminated.
-h --help‒ Show this message and exit.
Settings:
--debug‒ Enables logging to stdout with traceback's.
--json-human‒ Converts all output to human readable json format.
--make-config‒ Generate config file with defaults.
--set-auth‒ Interactive setting of login\password for authorization in virtualization.
-j --json‒ Convert all output to json format.
-q --quiet‒ Suppress all output.
-w --width‒ Sets the width of the console output in columns.
Other:
--collect-logs <file> [--tmp-dir]‒ Collect information about the operation of rv-backup and
save it to the archive(tar.gz) at <file>. The suffix
".tar.gz" will be added to the file name. You can also
specify the directory for temporary storage of collected
data.
m.mosolov@rosa.ru // www.rosa.ru 2022©
где:
vm‒ обращение к функционалу rv-backup vm для работы с ВМ;transfers‒ обращение к функционалу rv-backup transfers для работы с трансферами;locks‒ обращение к функционалу rv-backup locks для работы с файловыми блокировками;storage‒ обращение к функционалу rv-backup storage для работы с хранилищами;emergency‒ обращение к функционалу rv-backup emergency для работы с экстренными ситуациями;-t,--token <token_str>‒ авторизоваться с помощью токена token_str. Сессия, к которой привязан токен, не будет завершена вместе с приложением;-h,--help‒ вызов справки;--set-auth‒ интерактивная процедура установки логина/пароля для авторизации в ЦУ виртуализации. Пароль сохраняется в маскированном виде. См. также настройки конфигурации п. Настройка конфигурационного файла.
Примечание ‒ Эта команда поддерживает переменные окружения, которые позволят пропустить интерактивную процедуру ввода пароля пользователем:
RV_BACKUP_AUTH_LOGIN‒ логин администратора ЦУ (СУСВ);RV_BACKUP_AUTH_PASS‒ пароль администратора ЦУ (СУСВ).
--make-config‒ сгенерировать конфигурационный файл со значениями по умолчанию;-j--json‒ заменяет весь вывод rv-backup на вывод в формате JSON;
Примечание ‒ В этом режиме выводятся только результаты и ошибки. Статусы и отладочная информация выведены не будут.
Примечание ‒ Некоторые команды, которые требуют интерактивного диалога с пользователем, могут вызывать исключения, если не будет использован параметр
--yesили переменные окружения.
-q--quiet‒ отключает вывод сообщений в терминал, за исключением сообщений с критическими ошибками;--json-human‒ тоже самое, что и-j--json, но с отступами;-w--width‒ установить ширину (в столбцах) вывода в консоль. Значение по умолчанию ‒ auto. Имеет более высокий приоритет, чем аналогичный параметр, указываемый в конфигурации (см. п. Настройка конфигурационного файла). Возможные значения: auto и любое целое число;--debug‒ режим отладки. Сообщения любого уровня серьезности, а также трассировки будут поступать как в journal, так и в stdout;--collect-logs <file> [--tmp-dir]‒ собирает различную информацию о работе rv-backup в архив по адресу<file>. Перед архивацией rv-backup сложит всю собранную информацию во временную директорию с префиксом rv-backup-collector- и предложит проверить её на наличие "чувствительных" данных (например, ключи, токены, пароли и др.). После завершения операции по сбору или в случае, если пользователь отменил её, временная директория будет удалена. В п. Сбор информации для отладки можно ознакомиться с вероятным сценарием.
Важно – Все решения о передаче какой-либо информации принимает исключительно пользователь. rv-backup не собирает и не отправляет какую-либо информацию без его ведома и намерения. rv-backup использует передачу информации исключительно для взаимодействия с ЦУ виртуализации при выполнении задач резервного копирования.
Важно – Директория в которой хранятся резервные копии (указывается в конфигурации п. Настройка конфигурационного файла) не должна содержать посторонних файлов или каталогов.
--tmp-dir‒ указать директорию для временного хранения собранных данных перед их архивацией. Если не указана, то будет создана временная директория в /tmp. Может быть полезно, если в /tmp мало доступного пространства.
Важно – Если временная директория указана пользователем, то она не будет очищена автоматически. На экран будет выведено сообщение с напоминанием об этом.
Пример:
rv-backup --make-config
rv-backup -h
rv-backup --collect-logs ~/debuginfo
rv-backup --collect-logs ~/debuginfo --tmp-dir ~/temp/data/dir
rv-backup list
Usage:
rv-backup list <entity>
Common:
-h --help‒ Show this message and exit.
--local‒ Retrieve information from local storage. (Default for any Entity)
--remote‒ By default. Retrieve information from Virtualization\Disaster Recovery
Virtualization.
--residual‒ Display information about VMs that are residual (do not have a checkpoint map).
Only for vms entity.
--disaster‒ Display VMs that are associated with Disaster Recovery operations.
Entities:
domains‒ Show storage domains.
events [-s -n]‒ Show Virtualization events.
-s --severity <level>‒ Show only events with severity <level>. Available levels: alert,
warning, error, normal
-n <number>‒ Show only the last number events.
vms [--local | --remote | --residual | --disaster]
- Show available virtual machines.
--disaster [--local | --remote]
- Choose which information to display for VMs related to Disaster
Recovery.
--local [--vm-id] [--info] (default for --disaster)
- Show info about the VM from the local configuration.
--vm-id <str>‒ Show only VMs whose names contain part of str.
-i --info <X[,Y [,...]]>
- Show only selected sections. X or Y can take the following values:
'all', 'sql_header', 'cache', 'meta_files', 'lease_files'.
--remote [--latest]‒ Show info about the VM from the DR storage. Requires a valid
connection to the DR Virtualization.
--latest‒ Show data only from the latest database increment.
Examples:
rv-backup list vms --disaster --local -i cache,sql_header --vm-id fb9
rv-backup list vms --disaster --remote --latest
rv-backup list vms --remote
rv-backup list events -s error -n 10
где:
<entity>‒ сущность из списка Entities (обязательный аргумент);--local‒ используется по умолчанию; получить информацию из локального хранилища резервных копий;--remote‒ получить информацию от виртуализации;--residual‒ получить информацию об остаточных (не имеющих карту чек-пойнтов) ВМ, находящихся в хранилище резервных копий;--disaster‒ получить информацию только о ВМ, ассоциированных с процедурой Disaster Recovery. См. также главу конфигурации Options.DisasterRecovery.vm.UUID;-h--help‒ вызов справки;
Список Entities:
domains‒ отобразить домены хранилища;events [-s -n]‒ отобразить события виртуализации. Полезно для расследования в случае ошибок;-s <level>,--severity <level>‒ отобразить только события с уровнем серьезности level. Доступны уровни: alert, warning, error, normal;-n <number>‒ отобразить только последних number событий;vms‒ отобразить ВМ;--disaster [--local [[--vm-id] [-i, --info]] | --remote [--latest]]‒ отобразить виртуальные машины, ассоциированные с процедурой Disaster Recovery;--disaster --local [--vm-id] [-i, --info]‒ отобразить виртуальные машины, для которых созданы рабочие директории Disaster Recovery. Информация будет взята из метаданных сформированных инкрементов базы данных;--vm-id <UUID>‒ искать виртуальную машину по UUID (строка). UUID может быть указан частично, обнаруженная часть будет подсвечена при выводе в терминал;-i,--info‒ указать из каких именно данных сформировать таблицы по каждой ВМ. Доступные значения:all(по умолчанию),sql_header,cache,meta_files,lease_files;
Пример вывода для команды:
rv-backup list vms --disaster --local --vm-id 4c41 -i cache,lease_files
│ │ │
│ VM 078fd21e-7942-4c41-8281-560759dc6555 │ /BACKUPS/vm_078fd21e-7942-4c41-8281-560759dc6555/dr/20251124T165718+0300 │
│ │ │
│ cache │ │
│ create_date │ 2025-11-24T16:57:18+0300 │
│ metadata │ [binary data] │
│ db_increment │ [binary data] │
│ submitted_state │ cba7f969-bc30-40b6-b5a9-e8a1a4afe0c9 │
│ │ │
│ lease_files │ │
│ 0e2bf468-de52-44f2-94bd-1cc69c3c1367 │ │
│ leader │ │
│ magic │ 0x06152010 │
│ version │ 0x00000006|0x00000004 │
│ flags │ 0x00000010 │
│ sector_size │ 0x00000200 │
│ num_hosts │ 2000 │
│ max_hosts │ 2000 │
│ owner_id │ 0 │
│ owner_generation │ 0 │
│ lver │ 0 │
│ space_name │ 7e91e01a-1f09-4d41-a60f-b8543b801760 │
│ resource_name │ 80c58887-3e2c-4d31-aa40-0a37cf62effa │
│ timestamp │ 0 │
│ unused1 │ 0 │
│ checksum │ 3090489723 │
│ unused2 │ 0 │
│ io_timeout │ 0 │
│ write_id │ 0 │
│ write_generation │ 0 │
│ write_timestamp │ 0 │
│ request │ │
│ magic │ 0x08292011 │
│ version │ 0x00000001|0x00000001 │
│ lver │ 0x0000000000000000 │
│ force_mode │ 0x00000000 │
│ │ │
--disaster--remote [--latest]‒ отобразить ВМ, которые были синхронизированы с резервным хранилищем. Информация будет взята из метаданных сформированных инкрементов базы данных (инкременты находятся в резервном хранилище);--latest‒ отобразить данные о ВМ, которая была задействована в процедуре Disaster Recovery, самой последней на текущий момент. Пример вывода:
┌──────────────────────┬───────────────────────────────┐
│ Disaster VM (config) │ 078fd21e-7942-4c41-8281-560759dc6555 │
╞══════════════════════╪═══════════════════════════════╡
│ cluster_id │ 7c9a549e-bfe4-11f0-8554-000005a0b0c0│
│ cpu_profile_id │ 58ca604e-01a7-003f-01de-000000000250│
│ network_ids │ 00000000-0000-0000-0000-000000000009│
│ check_interval │ 1500 │
├──────────────────────┼───────────────────────────────┤
│ DB Increment │ 2025-11-24T16:57:18+0300 (latest) │
├──────────────────────┼───────────────────────────────┤
│ hash │ b206b4eeedf5c719f1856fa6dfcbff8fc0d0375aa3efd9e8d9e03482c6e73bb5 │
│ checkpoint │ cba7f969-bc30-40b6-b5a9-e8a1a4afe0c9 │
│ disks │ [0e2bf468-de52-44f2-94bd-1cc69c3c1367] (overall disks) │
│ other │ SQLAlchemy: 1.4.45 PostgreSQL: 16.8 │
└──────────────────────┴───────────────────────────────┘
Пример:
rv-backup list domains
rv-backup list events -n 5 -s error
rv-backup list vms --local
rv-backup list vms --remote
rv-backup list vms --residual
rv-backup list vms --disaster --local
rv-backup list vms --disaster --local --vm-id 4c41 -i cache,lease_files
rv-backup list vms --disaster --remote
rv-backup list vms --disaster --remote --latest
rv-backup vm
Usage:
rv-backup vm <UUID> <action>
Common:
<UUID> Uuid or name of the virtual machine to work with.
<action> See "Actions:" below.
-h --help Show this message and exit.
Actions:
backup‒ Backup management. See "rv-backup vm‒ backup --help".
disaster‒ Disaster recovery operations. See "rv-backup vm‒ disaster --help"
up‒ Start virtual machine.
down‒ Stop virtual machine.
restart‒ Restart(down+up) virtual machine.
list‒ Lists of entities such as checkpoints, events, backups, storage domains. See
"rv-backup vm list --help".
где:
<UUID>‒ идентификатор(или имя) ВМ (обязательный аргумент). В большинстве случаев ВМ, которой принадлежит этот идентификатор должна существовать на сервере виртуализации;<action>‒ действие из списка Actions. (обязательный аргумент);-h \--help‒ вызов справки.
Список Actions:
backup‒ функцииrv-backup vm backupдля работы с резервными копиями;disaster‒ функции Disaster Recovery;up‒ запустить ВМ;down‒ остановить ВМ;restart‒ перезапустить ВМ. Если ВМ уже была остановлена, будет произведен только ее запуск;list‒ обращение к функционалуrv-backup vm listдля работы со списками объектов виртуализации.
Пример:
rv-backup vm -h
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 up
rv-backup vm MyVm1 disaster -h
rv-backup vm‒ disaster -h
rv-backup transfers
Usage:
rv-backup transfers <action>
Common:
-h --help‒ Show this message and exit.
Actions:
list [-i]‒ Show list of transfers.
-i‒ Show list of unfinished transfers.
finish <transfer_id>‒ Finish transfer with <transfer_id>.
где:
<action>‒ действие из списка Actions (обязательный аргумент);-h --help‒ вызов справки.
Список Actions:
list [-i]‒ отобразить список трансферов;-i‒ отобразить только незавершенные трансферы;finish <transfer_id>‒ завершить трансфер с идентификатором transfer_id.
Пример:
rv-backup transfers list -i
rv-backup transfers finish 3488aebe-bb79-42a2-828c-80446f534287
rv-backup storage
Usage:
rv-backup storage <action>
Common:
-h --help‒ Show this message and exit.
Actions:
info‒ Display information about the backup storage, for example, the size of the VM
backup, the number of checkpoints, the VM name, etc.
nfs‒ Working with nfs storage.
smb‒ Working with smb storage.
disaster‒ Working with disaster storage.
SMB, NFS only:
check‒ Check backup structure for errors.
Note: If the storage was moved from another location, the paths in the qcow metadata
of the images will be corrected.
umount‒ Unmounts the storage previously mounted using smb, nfs commands, restores /etc/fstab
to its original state. It is recommended to use a command with the same name for the
nfs, smb subcommands.
move [[USER@]HOST:]/new/backup/dir [--compress-level=0]
- Move the storage to another directory. You can use SSH connection.
After moving, the storage will be checked for errors. Disk metadata
will be changed according to their new location.
--compress-level 0‒ Use compression during synchronization to save traffic. The
compression level can be from 0 to 9, with the default being 0
compression is not used. It works only when using SSH (if a host is
specified in the destination).
где:
<action>‒ действие из списка Actions (обязательный аргумент);-h --help‒ вызов справки.
Список Actions:
info‒ отображает информацию о резервных копиях ВМ, которые содержатся в хранилище резервных копий. Предоставляемая информация: путь к директории с резервной копией, занимаемый размер копии, количество чек-пойнтов, имя ВМ, дата последнего чек-пойнта, диски для каждого чек-пойнта (не для "остаточных ВМ"‒ не имеющих карты чек-пойнтов);nfs‒ помощник для подключения NFS в качестве хранилища для резервных копий. См. также rv-backup storage nfs;smb‒ помощник для подключения общей папки SMB в качестве хранилища для резервных копий. См. также rv-backup storage smb;disaster‒ помощник для подключение резервного хранилища;umount‒ размонтировать хранилище, которое было смонтировано командами smb, nfs;
Важно – Рекомендуется использовать другой способ размонтирования ‒ с использованием команд smb и nfs.
check‒ проверить структуру хранилища резервных копий на ошибки;
Примечания:
- Может быть полезно, если хранилище было перенесено. В этом случае метаданные qcow-дисков будут обновлены в соответствие с их новым местоположением.
- Обычно ручной запуск этой процедуры не требуется, т. к. проверка хранилища (целевой ВМ) осуществляется при каждом вызове команд, затрагивающих его.
move [[USER@]HOST:]/new/backup/dir [--compress-level=0]‒ переместить хранилище в новую директорию. Будет использована rsync, что гарантирует консистентность переданных данных, а также позволяет продолжить перемещение (при условии, что были использованы те же параметры при вызове), если оно было прервано. Также можно использовать подключение SSH.
Важно ‒ Команда move работает только с директориями. Это означает, что если в качестве целевой директории выбрана сетевая (тип smb или nfs), то после перемещения хранилища необходимо указать эту директорию в конфигурации вручную таким образом, как это указано в разделе Настройка конфигурационного файла. Иначе в конфигурации останется путь к старому расположению хранилища.
Важно – Для использования подключения SSH требуется настроенная авторизация по ключам на стороне назначения. Если сервер на стороне назначения потребует пароль, будет выдана ошибка и перемещение не начнется:
USER‒ логин пользователя SSH;HOST‒ адрес хоста назначения.--compress-level 0‒ использовать сжатие файлов для экономии трафика при перемещении хранилища резервных копий. Можно указать степень сжатия от 0 до 9 (по возрастанию степени сжатия). Работает только при использовании SSH (в назначении указан хост). Пример:
rv-backup storage nfs -h
rv-backup storage smb -h
rv-backup storage disaster -h
rv-backup storage check
rv-backup storage info
rv-backup storage --json-human info
rv-backup storage move /home/backups
rv-backup storage move /home/backups --compress-level 5
rv-backup storage move root@192.168.1.20:/home/backups --compress-level 9
rv-backup storage nfs
Usage:
rv-backup storage nfs <action>
WARNING! The actions described below can perform operations on fstab. An fstab backup will be
created in /etc/fstab.backup.
Common:
-h --help‒ Show this message and exit.
Actions:
mount <host:dir> <local_dir>‒ Mount the specified storage. On successful mount, saves fstab
entry and configuration.
host‒ NFS server host.
dir‒ NFS server directory. The directory must begin with a slash
"/".
local_dir‒ Local directory to mount.
test <host:dir> <local_dir>‒ Same as the mount command, but without saving the parameters.
check‒ Prints the storage entries found in fstab.
umount‒ Unmount storage. Delete entry from fstab.
где:
Важно – Команды mount и umount осуществляют операции записи в fstab. Команда mount создаст резервную копию fstab по пути /etc/fstab.backup.
Важно – Не следует менять вручную директорию хранилища в конфигурационном файле rv-backup после использования команды mount. Перед этим необходимо выполнить команду umount. Таким образом rv-backup вернёт исходное содержимое /etc/fstab.
<action>‒ действие из списка Actions (обязательный аргумент);-h --help‒ вызов справки.
Список Actions:
mount <host:dir> <local_dir>‒ смонтировать указанное хранилище host:dir в директорию local_dir, где:host‒ сервер NFS;dir‒ директория сервера NFS. Путь к директории должен начинаться с символа "/" (косая черта);local_dir‒ локальная директория для монтирования. Если она не существует, то будет создана;
Примечание‒ Команда mount в случае успешного выполнения, добавит запись в fstab для автоматического подключения указанного хранилища NFS после перезапуска машины, а также изменит значение параметра storage_dir конфигурации (см. п. Настройка конфигурационного файла).
test <host:dir> <local_dir>‒ делает то же, что и mount, но fstab и конфигурация приложения остаются неизменными;
Примечание‒ Полезно для предварительной проверки доступности NFS хранилища. Будет произведена попытка записи тестового файла в указанное хранилище. В случае успеха, тестовый файл будет удален.
check‒ проверяет наличие записей rv-backup в fstab. Если они там есть, они будут выведены на экран. Примерный вывод команды:FSTAB contains the following entries: rv-backup storage mount host1.test.dom:/BACKUPS /mnt/backups nfs4 rw,relatime,nosuid,namlen=255,nointr,hard,nosharecache,proto=tcp,retrans=3,sec=sys 0 0umount‒ размонтирует директорию хранилища, которая указана в качестве параметра storage_dir в конфигурации (см. п. Настройка конфигурационного файла).
Примечание ‒ После успешного выполнения команды umount fstab будет восстановлен из ранее созданной (в процессе выполнения команды mount) резервной копии.
Пример:
rv-backup storage nfs test host1.test.dom:/BACKUPS /mnt/backups
rv-backup storage nfs mount host1.test.dom:/BACKUPS /mnt/backups
rv-backup storage nfs check
rv-backup storage nfs umount
rv-backup storage smb
Usage:
rv-backup storage smb <action>
WARNING! The actions described below can perform operations on fstab. An fstab backup will be
created in /etc/fstab.backup. Also note that the password for accessing the SMB server is
stored in clear text!
Common:
-h --help‒ Show this message and exit.
Actions:
mount <host> <dir> <local_dir> <username> [domain]
- Mount the specified storage. On successful mount, saves
fstab entry, configuration, SMB credentials.
host‒ SMB server host.
dir‒ SMB server directory. The directory must begin with a
slash "/".
local_dir‒ Local directory to mount.
username‒ Username.
domain‒ Domain. If not specified, "WORKGROUP" domain will be
used.
test <host> <dir> <local_dir> <username> [domain]
- Same as the mount command, but without saving the
parameters.
check‒ Prints the storage entries found in fstab.
umount‒ Unmount storage. Delete entry from fstab.
```
где:
**Важно** – Команды `mount` и `umount` осуществляют операции записи в fstab. Команда `mount` создаст резервную копию fstab по пути /etc/fstab.backup, а также файл данных авторизации /root/rv-backup-smb.cred.
**Важно** – Не следует менять вручную директорию хранилища в конфигурационном файле rv-backup после использования команды `mount`. Перед этим необходимо выполнить команду `umount`. Таким образом rv-backup вернёт исходное содержимое /etc/fstab.
<action>‒ действие из списка Actions (обязательный аргумент);-h --help‒ вызов справки.
Список Actions:
mount <host> <dir> <local_dir> <username> [domain]‒ смонтировать указанное хранилище в директорию local_dir, где:host‒ сервер SMB;dir‒ директория сервера SMB. Путь к директории должен начинаться с символа"/"(косая черта);local_dir‒ локальная директория для монтирования. Если она не существует, то будет создана;username‒ имя пользователя для авторизации;domain‒ домен авторизации. Если не указан, будет использован "WORKGROUP".
Примечание ‒ Команда
mountв случае успешного выполнения добавит запись в fstab для автоматического подключения указанного хранилища SMB после перезапуска машины, изменит значение параметра storage_dir конфигурации (см. п. Настройка конфигурационного файла). Также пользователю будет предложено ввести пароль для авторизации на сервере SMB, он будет храниться в файле с остальными данными авторизации /root/rv-backup-smb.cred. Пример вида файла с данными авторизации SMB:
username=jack
password=12345678
domain=WORKGROUP
test <host> <dir> <local_dir> <username> [domain]‒ делает то же, что и mount, но fstab и конфигурация приложения остаются неизменными.
Примечание ‒ Полезно для предварительной проверки доступности SMB хранилища. Будет произведена попытка записи тестового файла в указанное хранилище. В случае успеха тестовый файл будет удален. Также во время процесса тестирования будет создан тестовый файл с данными авторизации /root/rv-backup-smb.cred.test, который по завершению тестирования будет удален.
check‒ Проверяет наличие записей rv-backup в fstab. Если они там есть, они будут выведены на экран. Примерный вывод команды:FSTAB contains the following entries: rv-backup storage mount //192.168.1.17/BACKUPS /mnt/backups cifs rw,vers=3.0,credentials=/root/rv-backup-smb.cred,nosetuids,cache=none,hard 0 0umount‒ размонтирует директорию хранилища, которая указана в качестве параметра storage_dir в конфигурации (см. п. Настройка конфигурационного файла).
Примечание‒ После успешного выполнения команды
umountfstab будет восстановлен из ранее созданной (в процессе выполнения командыmount) резервной копии, а файл с данными авторизации /root/rv-backup-smb.cred будет удален.
Пример:
rv-backup storage smb test 192.168.1.17 /BACKUPS /mnt/backups admin WORKGROUP
rv-backup storage smb mount 192.168.1.17 /BACKUPS /mnt/backups admin WORKGROUP
rv-backup storage smb check
rv-backup storage smb umount
rv-backup storage disaster
Usage:
rv-backup storage disaster <action>
Common:
-h --help‒ Show this message and exit.
Actions:
setup‒ Configure access to the main database and disaster storage domain. This is required
for creating database increments.
status [--apply-history | --disks-history]
- Show the current status of the storage.
--apply-history‒ Show the history of applying database increments.
--disks-history‒ Show the history of disk transfers.
clean‒ Clean DR storage. The "disaster_data" directory will be deleted.
--include-disks‒ Also delete disks involved in DR.
```
где:
<action>‒ действие из списка Actions (обязательный аргумент);-h --help‒ вызов справки.
Список Actions:
setup‒ настроить доступ к резервному хранилищу. Будет настроен SSH-доступ к хосту со смонтированным резервным хранилищем, а также к хосту с ЦУ (СУСВ). Хосты должны быть указаны в конфигурации в разделе Options.DisasterRecovery (см. п. Настройка конфигурационного файла);
Примечание ‒ Эта команда поддерживает следующие переменные окружения, которые позволят пропускать интерактивные диалоги запрашивают пароль:
RV_BACKUP_SSH_MAIN_DB_PASS‒ пароль для авторизации на хосте с ЦУ (СУСВ) для доступа к базе данных основной виртуализации.RV_BACKUP_SSH_DR_HOST_PASS‒ пароль для авторизации на хосте с смонтированным резервным хранилищем.
status [--apply-history | --disks-history]‒ прочитать state-файл в резервном хранилище и вывести информацию о текущем состоянии Disaster Recovery.
Примечание ‒ Эта команда поддерживает флаги
-j –jsonи–json-human(см. rv-backup).
Пример вывода:
15:29:58 [A6]Current state of DR storage [//root@host2.local:22/data/hs]: {'vm_id':'078fd21e-7942-4c41-8281-560759dc6555', 'checkpoint_id':'cba7f969-bc30-40b6-b5a9-e8a1a4afe0c9', 'db_inc':'20251124T165718+0300'}
Пример вывода --json:
{
"disks_history": [
{
"transfer_id": 0,
"db_inc": "20251124T165718+0300",
"vm_id": "078fd21e-7942-4c41-8281-560759dc6555",
"disks": [
"0e2bf468-de52-44f2-94bd-1cc69c3c1367"
]
}
],
"current_state": {
"vm_id": "078fd21e-7942-4c41-8281-560759dc6555",
"checkpoint_id": "cba7f969-bc30-40b6-b5a9-e8a1a4afe0c9",
"db_inc": "20251124T165718+0300"
},
"apply_history": [
{
"vm_id": "078fd21e-7942-4c41-8281-560759dc6555",
"db_inc": "20251124T165718+0300",
"disks": [
"0e2bf468-de52-44f2-94bd-1cc69c3c1367"]
}
]
}
--apply-history‒ показывает только историю применений инкрементов базы данных;
Пример вывода:
History of applying database increments for DR storage "7e91e01a-1f09-4d41-a60f-b8543b801760"
(from latest to earliest)
│ DB Increment │ VM id │ Disk ids│
│ 20251124T165718+0300 │ 078fd21e-7942-4c41-8281-560759dc6555│ 0e2bf468-de52-44f2-94bd-1cc69c3c1367 │
--disks-history‒ показывает только историю трансферов дисков ВМ;
Пример вывода:
History of disk delivery to DR storage "7e91e01a-1f09-4d41-a60f-b8543b801760"
(from latest to earliest)
│ Transfer id │ VM id │ Disk ids│
│ 0 │ 078fd21e-7942-4c41-8281-560759dc6555 │ 0e2bf468-de52-44f2-94bd-1cc69c3c1367 │
clean [--include-disks]‒ очистить резервное хранилище (по умолчанию удаляет только директорию disaster_data из резервного хранилища);--include-disks‒ удалить диски, которые были образованы синхронизацией Disaster Recovery. Команда сработает, только если в резервном хранилище сохранился state-файл (директория disaster_data), т. к. он хранит историю трансферов дисков.
Пример:
rv-backup --json storage disaster status
rv-backup --json-human storage disaster status
rv-backup storage disaster status --apply-history
rv-backup storage disaster status --disks-history
rv-backup storage disaster clean
rv-backup storage disaster clean --include-disks
rv-backup emergency
Usage:
rv-backup emergency <action>
WARNING! The following functions are intended for emergencies and, if used incorrectly, may
result in virtualization disruption and data loss!
Common:
-h --help‒ Show this message and exit.
Actions:
deploy_ssh_keys‒ Generate ssh keys and organize secure access to engine. See configuration
setting.
test_ssh_to_he‒ Check ssh connection to engine considering all settings.
unlock_transfers‒ Start interactive unlocking of transfers. Requires access(ssh) to engine.
unlock_disks‒ Start interactive unlocking of disks. Requires access(ssh) to engine.
где:
Важно – По умолчанию эти функции отключены, т. к. неправильное их использование может привести к сбою системы виртуализации или потере данных (см. конфигурацию для emergency, см. п. Настройка конфигурационного файла).
<action>‒ действие из списка Actions (обязательный аргумент);-h --help‒ вызов справки.
Список Actions:
Примечание‒ Некоторые действия требуют SSH-доступ к engine. Настроить его можно командой
deploy_ssh_keys(выполняется один раз после установки rv-backup), проверить ‒test_ssh_to_he.
deploy_ssh_keys‒ сгенерировать SSH-ключи и организовать защищенный доступ к engine (см. п. Настройка конфигурационного файла);test_ssh_to_he‒ проверить соединение с engine, учитывая имеющиеся настройки;unlock_transfers‒ начать процедуру разблокировки трансферов. Требуется участие пользователя и SSH-доступ к engine;unlock_disks‒ начать процедуру разблокировки дисков. Требуется участие пользователя и SSH-доступ к engine.
Пример:
rv-backup emergency deploy_ssh_keys
rv-backup emergency test_ssh_to_he
rv-backup locks
Usage:
rv-backup locks <action>
WARNING! The following steps are necessary in special cases and may result in data loss!
Use with caution!
Common:
-h --help‒ Show this message and exit.
Actions:
list‒ Displays a list of file locks.
unlock <name | all>‒ Unlock a file or directory.
name <filename> [--no-strict]‒ Remove the lock with the name "filename". If "--no-strict"
is specified, the file search will check for a partial
occurrence of "filename" in the lock name.
all‒ All locks will be removed.
где:
<action>‒ действие из списка Actions (обязательный аргумент);-h --help‒ вызов справки.
Список Actions:
list‒ отобразить список файловых блокировок;unlock <name | all>‒ разблокировать файл или директорию;name <filename> [--no-strict]‒ разблокировать файл/директорию с именем filename. Если указать–no-strict, то для поиска файла/директории будет использовано вхождение (не строгий поиск) filename в имя файла блокировки.
Пример:
rv-backup locks list
rv-backup unlock name cp_630e4d97-305f-444a-80b6-5a40db2b2029
rv-backup unlock name cp_630 --no-strict
rv-backup unlock all
rv-backup vm backup
Важно ‒ Все действия связанные непосредственно с резервными копиями должны выполняться с ВМ, находящейся на SPM-хосте.
SPM ‒ Storage Pool Manager‒ статус, определяющий, что хост имеет право на запись метаданных в системе виртуализации.
Если rv-backup будет запущен на ВМ, не относящейся к SPM-хосту, он автоматически инициирует процесс миграции ВМ на SPM-хост.
При этом описанное выше не имеет значения, если rv-backup используется в режиме клиента.
Usage:
rv-backup vm <UUID> backup <action>
Common:
-h --help‒ Show this message and exit.
--yes‒ Answer "Yes" where the user's decision is required. May be useful when using
"rv-backup --json" option.
Actions:
enable <disk_UUID>‒ Enables incremental backup for disk.
rotate [--backup-size] [--checks-count] [--apply | [[--unsafe] | [--remote-too]] ]
- Rotate the backup or configure the rotation of the VM. The
second checkpoint will be merged with the first one (full
backup). If no parameters are specified, the backup rotation
will be performed forcibly (without conditions).
The priority of settings for rotation in descending order:
command line, individual VM options, rv-backup configuration.
--backup-size <size>‒ Specify the size of the VM backup that will be maintained by
the rotation.
Example: --backup-size 10GB
--backup-size 1TB
--backup-size 500MB
--checks-count <count>‒ Specify the count of VM checkpoints that will be maintained
by the rotation.
--apply‒ Save the settings for VM rotation. It only makes sense when
specifying parameter --backup-size or --checks-count. In
this case, the --unsafe parameter is ignored, and the
--remote-too parameter will be used by default.
--unsafe‒ Do not backup the VM backup directory before rotation. This
may result in data loss if something goes wrong! For safe
rotation, space equal to the size of the rotated VM backup
is also required in the backup storage.
--remote-too‒ Also rotate the checkpoints on virtualization.
start [from_checkpoint | full] [flags]
- Initiate backup. This will freeze the resources of the virtual
machine. If the checkpoint is not specified, the latest
checkpoint will be selected. If there is no latest checkpoint,
a full backup will be performed. You can specify "full"
instead of UUID to force a full backup.
WARNING! Do not turn off the virtual machine BEFORE the backup
is complete!
-d --download‒ Download the disks included in the backup right after it
starts.
-f --finish‒ Finalize the backup right after downloading.
-c --comment <text>‒ Add a comment to a backup. It will be saved in the checkpoint
map.
finish [backup_UUID] [--force-finish]
- Finalize backup. Releases virtual machine resources. If backup_UUID
is not specified, the last started backup will be finalized.
--force-finish‒ Backup will be finished even if it has not been downloaded.
WARNING! Remote checkpoint map will become invalid!
cancel [backup_UUID]‒ Finalizes the specified active backup and removes created
checkpoint from the virtualization server. If backup_UUID is not
specified, the last started backup will be finalized. See also
"finish".
upload‒ Upload backup to Virtualization. "See upload --help".
download [backup_UUID] [--force-download]
- Download all disks involved in the backup. The disk can be
downloaded incrementally or completely, depending on the
availability of previous backups. If backup_UUID is not specified,
the latest backup will be downloaded.
--force-download‒ Completely overwrite the checkpoint directory. This may be useful
if an error occurred during backup and you need to re-initiate the
backup download.
remove < --local | --remote >
[--last-check | --select-check <UUID> [--unsafe, --remote-too, --yes]]
- Remove all checkpoints from Virtualization database.
--local‒ Remove the local checkpoint map.
--last-check‒ Removes only the last (by time) checkpoint. Can be used with
"--local".
--select-check <UUID>
- Select a checkpoint with <UUID> to remove it from the chain of
checkpoints. This operation implies merging checkpoints, so no data
will be lost. For more details on the merge mechanism, see "rotate".
--unsafe‒ See "rotate".
--remote-too‒ See "rotate".
clean < --remote | --local >
- Removing obsolete checkpoints from disk.
--local‒ Clean according to local checkpoint map.
--remote‒ Clean according to remote checkpoint map.
show <meta>‒ Displays various information about the current backup. At the
moment, it supports the output of intermediate information between
backup stages: "meta".
где:
<action>‒ действие из списка Actions (обязательный аргумент);-h--help‒ вызов справки;--yes‒ отвечать утвердительно в ситуациях, когда требуется решение пользователя.
Список Actions:
- enable <disk_UUID> ‒ включить поддержку инкрементального резервного копирования для диска с указанным идентификатором disk_UUID;
Примечание ‒ Возможность включения инкрементального резервного копирования диска также зависит от формата диска. Если формат диска ‒ RAW, то включение инкрементального резервного копирования для него невозможно. Чтобы это стало возможно, необходимо удалить все снапшоты ВМ, кроме снапшота с именем Active VM (как правило, он самый первый).
rotate [--backup-size] [--checks-count] [--apply | [[--unsafe] | [--remote-too]] ]‒ произвести одну итерацию ротации резервных копий ВМ. Одна итерация ротации включает в себя объединение первого чек-пойнта (полная резервная копия) со вторым ‒ эта ротация считается "ручной". "Автоматической" считается ротация, которая была запущена rv-backup в соответствии с заранее заданными параметрами.
Если никакие параметры для команды rotate не указаны, ротация будет произведена без проверки условий.
Параметры для ротации могут быть заданы следующими способами (в порядке убывания приоритета):
- Командная строка;
- Индивидуальный файл настроек виртуальной машины;
- Конфигурация приложения rv-backup (см. Настройка конфигурационного файла).
Примечание ‒ Минимальное количество чек-пойнтов равно 1, то есть максимальное количество ротаций приводит к полной резервной копии ВМ. По достижению минимального количества чек-пойнтов ротация не будет производить какого-либо эффекта.
Примечание ‒ Если параметры ротации не указаны (или принимают нулевые значения) ни в одном из источников (конфигурация, индивидуальный файл, командная строка), ротация применяться не будет (будет считаться отключенной).
Параметры ротации могут быть сохранены для автоматического применения с помощью параметра --apply. В этом случае указанные параметры будут сохранены в индивидуальный файл настроек ВМ.
"Автоматическая" ротация по умолчанию применяет параметр --remote-too.
--backup-size <size>‒ предел размера резервной копии ВМ (см. одноименный параметр в конфигурации в п. Настройка конфигурационного файла). Параметр командной строки рекомендуется задавать в кавычках, например:
backup rotate --backup-size "20 GB"
--checks-count <count>‒ предел количества чек-пойнтов ВМ (см. одноименный параметр в конфигурации в п. Настройка конфигурационного файла);--apply‒ не запускать ротацию; сохранить указанные параметры --backup-size и --checks-count в качестве индивидуальной настройки для ВМ, которые будут использованы "автоматической" ротацией. Создает файл options.json в директории ВМ;
Следует обратить внимание, что этот параметр не совместим с параметрами --remote-too и --unsafe.
--unsafe‒ не делать резервную копию директории ВМ для безопасной ротации. Если этот параметр не указан, будет создана резервная копия директории ВМ (см. Ошибка: источник перекрёстной ссылки не найден), из которой, в случае возникновения ошибок, будет восстановлено состояние резервной копии ВМ до ротации. Применение этого параметра может временно сэкономить место в хранилище и время затрачиваемое на ротацию;--remote-too‒ при указании этого параметра чек-пойнты, хранящиеся на сервере виртуализации, также будут подвергнуты ротации. Используется по умолчанию при "автоматической" ротации;start [from_checkpoint | full] [flags]‒ запустить резервное копирование. Тип резервного копирования (полное или инкрементальное) будет определен автоматически. Если ВМ уже имеет чек-пойнты, в качестве основы инкрементальной копии будет выбран последний из них. Если ВМ не имеет чек-пойнтов, то будет выполнено полное резервное копирование. На время резервного копирования будут заморожены все ресурсы ВМ;
Важно – Не выключайте ВМ до того, как резервное копирование будет финализировано, это может привести к серьезным проблемам.
Важно – После старта резервного копирования строго необходимо начать его скачивание, т. к. в момент старта происходит регистрация чек-пойнта. Если не скачать его, чек-пойнт не будет обеспечен данными, когда они потребуются для основы инкрементальной резервной копии. Консистентность иерархии чек-пойнтов будет нарушена.
-[from_checkpoint] ‒ идентификатор чек-пойнта, который будет взят за основу инкрементальной копии. Если не указан, в качестве основы инкрементальной копии будет выбран последний чек-пойнт;
[full]‒ позволяет принудительно создать полную резервную копию;
Важно – В случае указания full при том, что ВМ уже имеет чек-пойнты, rv-backup выдаст предупреждение о том, что очередная полная резервная копия может быть избыточной и будет занимать пространство хранилища. Рекомендуется удалять предыдущие чек-пойнты перед созданием полной резервной копии. У пользователя есть возможность отказаться от продолжения операции.
-d--download‒ сохранить резервную копию на диск после его успешного запуска;-f--finish‒ финализировать резервное копирование после его успешного запуска или сохранения;-c--comment <text>‒ добавить комментарий к чек-пойнту. Комментарий хранится в карте чек-пойнтов в хранилище резервных копий и доступен при выводе списка чек-пойнтов;finish [backup_UUID] [--force-finish]‒ финализировать резервное копирование с идентификатором backup_UUID. Крайне важно это сделать для каждого запущенного резервного копирования, до того как ВМ будет выключена по каким-либо причинам. Если backup_UUID не будет указан, будет произведена попытка финализировать единственное (для ВМ) нефинализированное резервное копирование;--force-finish‒ финализировать резервное копирование, даже если копия не была скачана;
Важно – Финализация резервного копирования без скачивания копии приведет к инвалидации чек-пойнтов, хранящихся на сервере виртуализации (также см. предупреждение rv-backup vm backup).
cancel [backup_UUID]‒ финализирует резервное копирование с идентификатором backup_UUID и удаляет созданный чек-пойнт. Если backup_UUID не указан, в качестве цели будет выбрано единственное активное (со статусом ready) резервное копирование;upload‒ обращение к функционалу rv-backup vm backup upload для загрузки резервной копии на сервер (восстановления из резервной копии);download [backup_UUID] [--force-download]‒ сохранить резервную копию с идентификатором backup_UUID на локальный диск. Сохранение будет либо полным, либо инкрементальным в зависимости от того, в каком режиме резервное копирование было начато. Для инкрементального сохранения в качестве основы будет использован последний чек-пойнт. Инкрементальный вариант сохранения гораздо быстрее полного. Если параметр backup_UUID не указан, то для скачивания будет выбрано единственное (см. ниже) начатое резервное копирование;
Примечание ‒ В фазе ready может существовать только одно резервное копирование, т. к. при его старте виртуализация замораживает ресурсы ВМ. Старт второго резервного копирования означал бы повторную заморозку ресурсов ВМ.
--force-download‒ форсировать скачивание резервной копии. Директория, в которой хранится чек-пойнт, будет полностью перезаписана. Это может пригодиться, если по каким-либо причинам процедура резервного копирования была прервана;
Примечание ‒ Если резервное копирование было прервано, возможно, в хранилище останется файл блокировки с расширением .lock, который будет препятствовать скачиванию резервной копии. В таком случае необходимо воспользоваться функционалом rv-backup locks для снятия блокировки.
remove < --local | --remote > [--last-check | --select-check <UUID> [--unsafe, --remote-too, --yes]]‒ удаление всех чек-пойнтов из базы данных виртуализации, где:--local‒ осуществлять действия с картой чек-пойнтов, находящейся в хранилище резервных копий;--remote‒ осуществлять действия с картой чек-пойнтов на сервере виртуализации;--last-check‒ удалить только последний (по времени) чек-пойнт. Можно использовать вместе с флагом--local, в таком случае будет удален последний чек-пойнт из локальной карты чек-пойнтов;--yes‒ отвечать "Yes" на вопрос "Уверены ли вы, что хотите удалить все чек-пойнты?";--select-check <UUID>‒ выбрать для удаления чек-пойнт с UUID;
Примечание ‒ Для удаления чек-пойнта из цепочки чек-пойнтов используется механизм объединения чек-пойнтов, который используется при ротации. За счет этого обеспечивается сохранность данных и целостность цепи чек-пойнтов. Подробнее про ротацию описано в п. Ротация резервных копий.
--unsafe‒ см. п. Ротация резервных копий;--remote-too‒ см. п. Ротация резервных копий;clean < --remote | --local >‒ удалить с локального диска чек-пойнты, которые не существуют в карте чек-пойнтов виртуализации или локальной карте чек-пойнтов;--local‒ определять статус чек-пойнта, руководствуясь локальной картой чек-пойнтов;--remote‒ определять статус чек-пойнта, руководствуясь картой чек-пойнтов виртуализации.show <meta>‒ показывает различную информацию о текущем резервном копировании. На данный момент поддерживает вывод meta ‒ информация, которая хранится между этапами резервного копирования. Дополнительная информация по метафайлу в Ошибка: источник перекрёстной ссылки не найден.
Пример:
полное резервное копирование
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 backup start
инкрементальное резервное копирование с сохранением и финализацией
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 backup start 2c0c20f5-5f3f-474c-bb75-37795d6af78e -d -f
удалить чек-пойнты с базы данных виртуализации
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 backup remove --remote
удалить чек-пойнты хранящиеся локально, но отсутствующие в базе данных виртуализации
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 backup clean
запустить ротацию "вручную"
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 backup rotate --backup-size "10GB" --checks-count 5
применить\сохранить параметры ротации для ВМ
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 backup rotate --backup-size "10GB" --checks-count 5 --apply
запустить ротацию "вручную" в небезопасном режиме, также слить чек-пойнты хранящиеся в Виртуализации
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 backup rotate --backup-size "10GB" --checks-count 5 --remote-too --unsafe
удалить чек-пойнт "2c1f8c33-4df8-41c0-8912-51451686991a" из цепочки чек-пойнтов, также удалить этот чек-пойнт из карты
чек-пойнтов на сервере виртуализации
rv-backup vm TestVM backup remove --select-check 2c1f8c33-4df8-41c0-8912-51451686991a --remote-too
rv-backup vm backup upload
Note:
Any action specified here assumes that locally stored checkpoints will be merged into disks,
which in turn can be uploaded to the Virtualization server as a disk, snapshot, VM clone.
Usage:
rv-backup vm <UUID> backup upload <action> [--select-check]
Common:
-h --help‒ Show this message and exit.
--select-check‒ Select a checkpoint to restore. The choice can be made in two ways:
1) specify the UUID of the checkpoint,
example: '2afeb474-cf9e-4dbf-8163-bfb5b496f8e9'.
2) specify the date and time (GOST R 7.0.64-2018), the checkpoint closest to
this time will be selected,
example: '2022-11-30T16:00:33+0300'.
Actions:
disks <domain_name>‒ Upload disks to Virtualization storage domain with the
name <domain_name>.
Disk name format: UUID_%d%m%Y_%H%M%S.
Example: 123-123-123-123-123_20052022_160159.
vm <vm_name> <cluster_name> <domain_name>
- Create a VM with the name <vm_name> on the Virtualization
<cluster_name> and upload its disks to the storage domain
with the name <domain_name>.
snapshot‒ Create a new snapshot for the VM. The VM configuration
will not be changed. This operation requires the VM to be
turned off.
```
где:
<action>‒ действие из списка Actions (обязательный аргумент);-h--help‒ вызов справки;--select-check‒ выбрать чек-пойнт для восстановления. Выбор может быть сделан двумя способами:- указать UUID чек-пойнта, например
'2afeb474-cf9e-4dbf-8163-bfb5b496f8e9'; - указать дату и время в формате "ГОСТ Р 7.0.64-2018", например '2022-11-30T16:00:33+0300'.
Следует обратить внимание, что дата и время должны быть взяты в кавычки (одинарные или двойные).
Список Actions:
Примечание ‒ Любое действие объединяет локально хранящиеся чек-пойнты в диск(и) для последующей загрузки их на сервер виртуализации.
disks <domain_name>‒ загрузить резервную копию на домен хранилища с именем domain_name в качестве отдельного(ых) диска(ов). Имя диска будет иметь форматUUID_%d%m%Y_%H%M%S, где:UUID‒ идентификатор диска;%d‒ текущий день(две цифры);%m‒ текущий месяц(две цифры);%Y‒ текущий год(четыре цифры);%H‒ часы(две цифры);%M‒ минуты(две цифры);%S‒ секунды(две цифры);vm <vm_name> <cluster_name> <domain_name>‒ создать на виртуализации новую ВМ с именем vm_name в кластере с именем cluster_name и загрузить диск(и) на домен хранилища с именем domain_name. Все имена обязательны.snapshot‒ создать новый снапшот для выбранной ВМ из резервной копии в хранилище. Конфигурация ВМ изменена не будет.
Важно – Эта операция требует чтобы ВМ была выключена.
Пример:
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 backup upload disks hosted_storage
rv-backup vm TestVM backup upload disks hosted_storage --select-check 2afeb474-cf9e-4dbf-8163-bfb5b496f8e9
rv-backup vm TestVM backup upload disks hosted_storage --select-check '30.11.2022 16:00:33 +0300'
rv-backup vm TestVM backup upload snapshot --select-check 2afeb474-cf9e-4dbf-8163-bfb5b496f8e9
rv-backup vm TestVM backup upload snapshot --select-check '30.11.2022 16:00:33 +0300'
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 backup upload vm new_vm1 Default hosted_storage
rv-backup vm list
Usage:
rv-backup vm <UUID> list <entity>
Common:
-h --help Show this message and exit.
Entities:
disks [-i]‒ Show vm disks.
-i‒ Show disks with incremental backup enabled.
events [-s -n]‒ Show vm events.
-s --severity <level>‒ Show only events with severity <level>. Available levels: alert,
warning, error, normal
-n <number>‒ Show only the last number events.
backups‒ Show vm backups.
snapshots‒ Show vm checkpoints.
checkpoints < --remote | --local > [-n -r -f | -n -f]‒ Show vm checkpoints.
-n <number>‒ Show only the last number checkpoints.
-r‒ Show checkpoints in tree view.
-f‒ Show full UUID in tree. See -t.
-t‒ Show checkpoints in tree tables.
--local‒ Show checkpoints stored locally.
--remote‒ Show checkpoints stored remotely.
networks‒ Show vm networks.
```
где:
- Субкоманда
listработает с сущностями, а не действиями, как остальные команды. <entity>‒ сущность из списка Entities (обязательный аргумент);-h--help‒ вызов справки.
Список Entities:
disks [-i]‒ отобразить диски;-i‒ отобразить только диски с поддержкой инкрементального резервного копирования;events‒ отобразить события виртуализации, имеющие отношение к выбранной ВМ. Полезно для расследования в случае ошибок;-s <level>,--severity <level>‒ отобразить только события с уровнем серьезности level. Доступны уровни: alert, warning, error, normal;-n <number>‒ отобразить только последних number событий;backups‒ отобразить запущенные процессы резервного копирования. Как правило, виртуализация удаляет данные об этих сущностях сразу после того, как резервное копирование будет финализировано;snapshots‒ отобразить снапшоты;checkpoints < --remote | --local > [-n -r -f | -n -f]‒ отобразить чек-пойнты, где:-r‒ отобразить чек-пойнты в виде дерева;-f‒ отобразить полный UUID чек-пойнта при построении дерева;-t‒ отрисовывать чек-пойнты в дереве как таблицы;--local‒ использовать для отображения чек-пойнты, хранящиеся локально;--remote‒ использовать для отображения чек-пойнты, хранящиеся на сервере виртуализации;networks‒ отобразить сетевые интерфейсы указанной ВМ.
Примечание ‒ Команда поддерживает флаг
--json.
Приблизительный вывод:
┌──────────────────────────────┬─────────┬──────┬───────────────┐
│ Net id │ Net name │ Nic name│ Nic MAC │
══════════════════════════════╪═════════╪══════╪═══════════════╡
│ 00000000-0000-0000-0000-000000000009│ ovirtmgmt│ nic1 │ 56:6f:14:34:00:00 │
└──────────────────────────────┴─────────┴──────┴───────────────┘
Пример:
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 list checkpoints -r -f
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 list backups
rv-backup vm b0e5d298-4a7b-4bf2-abf7-3420b4e446a7 list events -n 5
rv-backup vm MyVm1 list networks
rv-backup --json vm MyVm1 list networks
rv-backup vm disaster
Usage:
rv-backup vm <UUID> disaster <action>
Common:
-h --help‒ Show this message and exit.
Actions:
run [--cluster-id][--cpu-profile-id][--network-ids]
- Start disaster-recovery iteration. Specified parameters override
configuration settings.
--cluster-id‒ Target cluster in backup virtualization environment.
--cpu-profile-id‒ CPU profile for target cluster in backup virtualization.
--network-ids‒ Mapping of networks (comma-separated) <current>:<target>, where
<current> is the UUID of the source network and <target> is the
UUID of the target network. It is recommended to set this parameter
via configuration.
config‒ Manage VM disaster-recovery parameters in the configuration.
remove‒ Remove the disaster-recovery temporary files directory from the backup storage.
Example: rv-backup vm c858dc1c-d10f-4253-ac5e-8d0b39a66f05 disaster run \
--cluster-id 8e1d7e29-ae42-41c2-acf9-cffffc2fe602 \
--cpu-profile-id 11960329-ae73-49e1-84d0-2168ffe39200 \
--network-ids
881f2a46-d751-4070-a92a-499f7ffc9170:c825e5cf-5f70-4638-8087-209ec553b056,c59f6201-360d-4f6c-91
7f-d9366539bbb8:53200cb2-1cd9-4f2d-ac86-93dc326944e5
```
где:
<action>‒ действие из списка Actions (обязательный аргумент);-h--help‒ вызов справки.
Список Actions:
run [--cluster-id][--cpu-profile-id][--network-ids] ‒ запустить итерацию (синхронизацию ВМ с резервной виртуализацией) Disaster Recovery. Текущее состояние ВМ будет проверено на соответствие состоянию таковой в резервной виртуализации. Если состояние отличается, то будет инициирована отправка дисков ВМ, их .meta-, .lease-файлов, а также инкремента базы данных (все данные ассоциированные с этой ВМ).
Важно – Для правильной работы этой функции необходимо заполнить два раздела конфигурации Options.DisasterRecovery и Options.DisasterRecovery.vm.UUID (см. п. Настройка конфигурационного файла).
Примечание ‒ Значения, указанные в конфигурации, можно временно подменить при вызове
run, для этого можно воспользоваться флагами --cluster-id, --cpu-profile-id, --network-ids. Параметры, значения которых указаны в командной строке, всегда более приоритетны, чем параметры в конфигурации. Конфигурация изменена не будет.
--cluster-id‒ подменить UUID кластера;--cpu-profile-id‒ подменить UUID CPU-профиля;--network-ids‒ подменить UUID сетевых интерфейсов (как правильно указать сопоставление сетевых интерфейсов см. п. Настройка конфигурационного файла);config‒ вспомогательные функции для управление конфигурацией Disaster Recovery для указанной ВМ из командной строки;remove‒ удалить директорию dr из хранилища резервных копий. Все данные ВМ, ассоциированные с процедурой Disaster Recovery, будут удалены. Конфигурация изменена не будет.
Пример:
rv-backup vm MyVm1 disaster run
rv-backup vm MyVm1 disaster run --cpu-profile-id 11960329-ae73-49e1-84d0-2168ffe39200
rv-backup vm MyVm1 disaster run --network-ids 881f2a46-d751-4070-a92a-499f7ffc9170:c825e5cf-5f70-4638-8087-209ec553b056,c59f6201-360d-4f6c-917f-d9366539bbb8:53200cb2-1cd9-4f2d-ac86-93dc326944e5
rv-backup vm MyVm1 disaster config -h
rv-backup vm MyVm1 disaster remove
rv-backup vm disaster config
Usage:
rv-backup vm <UUID> disaster config <action>
Common:
-h --help‒ Show this message and exit.
Actions:
add <cluster-id> <cpu-profile-id> [--network-ids] [--check-interval]
- Add DR parameters to the configuration.
update < [--cluster-id] [--cpu-profile-id] [--network-ids] [--check-interval] >
- Update DR parameters in the configuration.
remove‒ Remove DR parameters from the configuration.
--cluster-id‒ Target cluster in backup virtualization environment.
--cpu-profile-id‒ CPU profile for target cluster in backup virtualization.
--network-ids‒ Mapping of networks (comma-separated) <current>:<target>, where <current>
is the UUID of the source network and <target> is the UUID of the target
network.
--check-interval‒ Interval for checking database and disk increments
(in seconds, Defaults to 15).
```
где:
<action>‒ действие из списка Actions (обязательный аргумент);-h--help‒ вызов справки.
Список Actions:
add <cluster-id> <cpu-profile-id> [--network-ids] [--check-interval]‒ добавить Disaster Recovery настройки для ВМ в конфигурацию (подробнее см. в разделе Options.DisasterRecovery.vm.UUID п. Настройка конфигурационного файла), где:cluster-id‒ UUID кластера на резервной виртуализации, за которым будет закреплена ВМ.cpu-profile-id‒ UUID CPU-профиля на резервной виртуализации, который будет закреплен за ВМ;--network-ids‒ сопоставленные UUID сетевых интерфейсов ВМ (как правильно указать сопоставление сетевых интерфейсов, см. Настройка конфигурационного файла).--check-interval‒ интервал в секундах, с которым будет осуществляться проверка актуальности состояния ВМ относительно состояния таковой в резервной виртуализации;update < [--cluster-id] [--cpu-profile-id] [--network-ids] [--check-interval] >‒ обновить Disaster Recovery настройки для ВМ в конфигурации (подробнее см. в разделе Options.DisasterRecovery.vm.UUID, см. п. Настройка конфигурационного файла);
Информацию по параметрам см. выше в описании команды add.
remove‒ удалить настройки Disaster Recovery для ВМ из конфигурации.
Пример:
rv-backup vm MyVm1 disaster config add 37891748-759f-4438-a0bc-15afb100af93 d99a07e3-c5fe-4cd9-b4cc-51d6de43f117
rv-backup vm MyVm1 disaster config add 37891748-759f-4438-a0bc-15afb100af93 d99a07e3-c5fe-4cd9-b4cc-51d6de43f117 --network-ids 881f2a46-d751-4070-a92a-499f7ffc9170:c825e5cf-5f70-4638-8087-209ec553b056,c59f6201-360d-4f6c-917f-d9366539bbb8:53200cb2-1cd9-4f2d-ac86-93dc326944e5
rv-backup vm MyVm1 disaster config update --cpu-profile-id d99a07e3-c5fe-4cd9-b4cc-51d6de43f117 --check-interval 900
rv-backup vm MyVm1 disaster config remove