Клиентское приложение для управления резервным копированием и восстановлением данных

recovery-manager – утилита командной строки для управления резервным копированием и восстановлением данных. Если команда вызывается без дополнительных флагов, будет отображен интерактивный сеанс для работы с утилитой (prompt-режим).

Список консольных команд

Команды в разделе сгруппированы по их назначению:

• Служебные команды
• Действия с PBR-Agent
• Задачи резервного копирования и восстановления данных
• Управление хранилищами резервных копий (компонент Storage Service)
• Использование AI-Advisor для получения рекомендаций по настройке политики резервного копирования

Подсказка

Для всех команд доступен флаг -h|--help – показать справку по команде.

Для перехода к информации о команде нажмите на ее описание в таблице.

Служебные команды

Команда	Описание
recovery-manager login	Вход в CLI компонента Recovery Manager
recovery-manager help	Справка по командам утилиты recovery-manager
recovery-manager version	Вывод версии установленной утилиты recovery-manager
recovery-manager config set	Изменение параметров конфигурационного файла recovery-manager.yaml
recovery-manager config show	Просмотр параметров конфигурационного файла recovery-manager.yaml

Действия с PBR-Agent

Команда	Описание
recovery-manager agent create	Регистрация агентского приложения
recovery-manager agent list	Просмотр списка агентских приложений
recovery-manager agent recreate	Повторная регистрация агентского приложения
recovery-manager agent revoke	Отзыв регистрации агентского приложения
recovery-manager agent delete	Удаление агентского приложения
recovery-manager agent info	Получение детальной информации об агентском приложении

Задачи резервного копирования и восстановления данных

Команда	Описание
recovery-manager backup list	Просмотр списка резервных копий для определенного экземпляра агента
recovery-manager backup-task list	Просмотр списка задач создания резервной копии
recovery-manager backup-task info	Просмотр подробной информации о задаче создания резервной копии
recovery-manager backup-task cancel	Отмена задачи на создание резервной копии
recovery-manager recovery-task list	Просмотр списка задач восстановления из резервной копии
recovery-manager recovery-task info	Просмотр информации о конкретной задаче восстановления из резервной копии
recovery-manager recovery-task cancel	Отмена задачи на восстановление из резервной копии

Управление хранилищами резервных копий (компонент Storage Service)

Команда	Описание
recovery-manager storage create	Регистрация хранилища
recovery-manager storage recreate	Повторная регистрация хранилища
recovery-manager storage list	Просмотр списка хранилищ
recovery-manager storage info	Вывод подробной информации о хранилище
recovery-manager storage delete	Удаление хранилища из системы

Использование AI-Advisor для получения рекомендаций по настройке политики резервного копирования

Команда	Описание
recovery-manager advisor recommend	Запрос рекомендации настройки политики резервного копирования
recovery-manager advisor apply	Применение рекомендации политики резервного копирования, полученной от AI-Advisor

Описание команд

recovery-manager login

Описание:

Вход в CLI компонента Recovery Manager.

Синтаксис:

recovery-manager login [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-u|--username <login>	Имя пользователя для выполнения операции входа (login)
--password-stdin	Передать пароль через стандартный поток ввода (stdin)

Сценарии использования:

Вход в Recovery Manager.

recovery-manager version

Описание:

Выводит версию установленной утилиты recovery-manager.

Синтаксис:

recovery-manager version [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Как определить версию продукта.

recovery-manager config set

Описание:

Изменение параметров конфигурационного файла recovery-manager.yaml.

Синтаксис:

recovery-manager config set [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
--api-gateway-address <http://api.example.host:port>	Адрес точки входа в API Gateway
--api-gateway-trusted-certificate-path <path>	Путь к доверенному сертификату для безопасного взаимодействия с API Gateway
--client-id <id>	Идентификатор клиента из KeyCloak
--client-secret <secret value>	Секрет клиента, используемый вместе с client-id для аутентификации
--log-compress-backups	Определяет необходимость сжатия файлов логов
--log-dir-mode <permissions>	Задает права доступа для директории логов (по умолчанию – 0700)
--log-file-mode <permissions>	Задает права доступа для файлов логов (по умолчанию – 0600)
--log-max-age <days>	Максимальный срок хранения логов (в днях)
--log-max-backups <number>	Максимальное количество резервных копий логов
--log-max-size <size>	Максимальный размер файла логов до ротации
--log-path	Путь к директории c логами
--log-use-local-time	Флаг использования локального времени
--open-id-trusted-certificate-path <path>	Путь к доверенному сертификату сервиса авторизации
--realm-url <url>	Адрес сервиса авторизации
--timeout <duration>	Общий тайм-аут для подключений

Сценарии использования:

Изменение параметров конфигурационного файла компонента Recovery Manager.

recovery-manager config show

Описание:

Выводит параметры конфигурационного файла recovery-manager.yaml.

Синтаксис:

recovery-manager config show [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Просмотр параметров конфигурационного файла компонента Recovery Manager.

recovery-manager agent create

Описание:

Генерация регистрационного токена для регистрации агентского приложения.

Синтаксис:

recovery-manager agent create [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Регистрация агентского приложения.

recovery-manager agent list

Описание:

Выводит список зарегистрированных агентских приложений.

Синтаксис:

recovery-manager agent list [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-a|--all	Показать все доступные агентские приложения
-p|--page <page number>	Выбор номера страницы
-s|--size <page size>	Количество агентских приложений на одной странице

Сценарии использования:

Просмотр списка агентских приложений.

recovery-manager agent recreate

Описание:

Генерирует регистрационный токен для повторной регистрации агентского приложения.

Синтаксис:

recovery-manager agent recreate <agent-id | agent-name> [flags]

Обязательные параметры:

<agent-id | agent-name> – уникальный идентификатор агента или уникальное имя агента.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Повторная регистрация агентского приложения.

recovery-manager agent revoke

Описание:

Отзывает регистрацию агентского приложения.

Синтаксис:

recovery-manager agent revoke <agent-id | agent-name> [flags]

Обязательные параметры:

<agent-id | agent-name> – уникальный идентификатор агента или уникальное имя агента.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Отзыв регистрации агентского приложения.

recovery-manager agent delete

Описание:

Удаление агентского приложения. Удаленный агент не будет отображаться при вызове recovery-manager agent list.

Синтаксис:

recovery-manager agent delete <agent-id | agent-name> [flags]

Обязательные параметры:

<agent-id | agent-name> – уникальный идентификатор агента или уникальное имя агента.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Удаление агентского приложения.

recovery-manager agent info

Описание:

Выводит информацию об агентском приложении.

Синтаксис:

recovery-manager agent info <agent-id | agent-name> [flags]

Обязательные параметры:

<agent-id | agent-name> – уникальный идентификатор агента или уникальное имя агента.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Получение детальной информации об агентском приложении.

recovery-manager backup list

Описание:

Вывод информации о резервных копиях определенного агентского приложения.

Синтаксис:

recovery-manager backup list <instance-name> [flags]

Обязательные параметры:

<instance-name> – уникальное имя агента.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-a|--all	Показать все задачи
-p|--page <page number>	Выбор номера страницы
-s|--size <page size>	Количество задач на одной странице
--inventory-status <status>	Фильтрация резервных копий по статусу инвентаризации: - success – успешная инвентаризация; - deleted – удаленные резервные копии; - merged – объединенные резервные копии; - failed – неуспешная инвентаризация

Сценарии использования:

Просмотр списка резервных копий для определенного экземпляра агента.

recovery-manager backup-task list

Описание:

Вывод списка задач на создание резервной копии.

Синтаксис:

recovery-manager backup-task list <agent-id> [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-a|--all	Показать все задачи
-p|--page <page number>	Выбор номера страницы
-s|--size <page size>	Количество задач на одной странице

Сценарии использования:

Просмотр списка задач создания резервной копии.

recovery-manager backup-task info

Описание:

Вывод подробной информации о задаче резервного копирования.

Синтаксис:

recovery-manager backup-task info <task-id> [flags]

Обязательные параметры:

• <task-id> – уникальный идентификатор задачи.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Просмотр списка задач создания резервной копии.

recovery-manager backup-task cancel

Описание:

Отмена задачи на создание резервной копии.

Синтаксис:

recovery-manager backup-task cancel <task-id> [flags]

Обязательные параметры:

• <task-id> – уникальный идентификатор задачи.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

–

recovery-manager recovery-task list

Описание:

Вывод списка задач на восстановление из резервной копии.

Синтаксис:

recovery-manager recovery-task list <agent-id> [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-a|--all	Показать все задачи
-p|--page <page number>	Выбор номера страницы
-s|--size <page size>	Количество задач на одной странице

Сценарии использования:

Просмотр списка задач восстановления из резервной копии.

recovery-manager recovery-task info

Описание:

Вывод подробной информации о конкретной задаче восстановления из резервной копии.

Синтаксис:

recovery-manager recovery-task info <task-id> [flags]

Обязательные параметры:

• <task-id> – уникальный идентификатор задачи.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Просмотр подробной информации о задаче восстановления из резервной копии.

recovery-manager recovery-task cancel

Описание:

Отмена задачи на восстановление из резервной копии.

Синтаксис:

recovery-manager recovery-task cancel <task-id> [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

–

recovery-manager storage create

Описание:

Генерация регистрационного токена для регистрации компонента Storage Service.

Синтаксис:

recovery-manager storage create <storage-name> [flags]

Обязательные параметры:

<storage-name> – имя хранилища.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Регистрация хранилища.

recovery-manager storage recreate

Описание:

Генерирует регистрационный токен для повторной регистрации компонента Storage Service.

Синтаксис:

recovery-manager storage recreate <storage-id | storage-name> [flags]

Обязательные параметры:

<storage-id | storage-name> – уникальный идентификатор или имя хранилища.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Повторная регистрация хранилища.

recovery-manager storage list

Описание:

Выводит список доступных пользователю хранилищ s2.

Синтаксис:

recovery-manager storage list [flags]

Обязательные параметры:

<storage-id | storage-name> – уникальный идентификатор или имя хранилища.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-a|--all	Показать все хранилища
-p|--page <page number>	Выбор номера страницы
-s|--size <page size>	Количество хранилищ на одной странице

Сценарии использования:

Просмотр списка хранилищ.

recovery-manager storage info

Описание:

Выводит информацию о конкретном хранилище s2.

Синтаксис:

recovery-manager storage info <storage-id | storage-name> [flags]

Обязательные параметры:

<storage-id | storage-name> – уникальный идентификатор или имя хранилища.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Вывод подробной информации о хранилище.

recovery-manager storage delete

Описание:

Удаление конкретного хранилища s2. Удаленное хранилище не будет отображаться при вызове recovery-manager storage list.

Синтаксис:

recovery-manager storage delete <storage-id | storage-name> [flags]

Обязательные параметры:

<storage-id | storage-name> – уникальный идентификатор или имя хранилища.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Отзыв регистрации хранилища.

recovery-manager advisor recommend

Описание:

Запрос рекомендации по настройке политики резервного копирования для заданного агента PBR-Agent на основании целевых значений RPO (Recovery Point Objective) и RTO (Recovery Time Objective). Если значения RPO и RTO не переданы в команде флагами --rpo и --rto, используются значения по умолчанию: RPO = 15m (15 минут), RTO = 1h (1 час).

Команда анализирует последние 500 задач резервного копирования, агрегирует результаты по уникальным конфигурациям политик и с помощью AI-агента (внешнего LLM-провайдера) формирует рекомендацию с оценкой уверенности модели и уровня риска.

Синтаксис:

recovery-manager advisor recommend <agent-id> [flags]

Обязательные параметры:

<agent-id> – уникальный идентификатор агента PBR-Agent, для которого необходимо получить рекомендацию.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
--rto <duration>	Целевой Recovery Time Objective (по умолчанию: 1h). Пример значений: 4h, 30m
--rpo <duration>	Целевой Recovery Point Objective (по умолчанию: 15m). Пример значений: 15m, 1h

Сценарии использования:

Запрос рекомендации настройки политики резервного копирования с помощью AI-Advisor.

recovery-manager advisor apply

Описание:

Применение ранее полученной рекомендации политики резервного копирования для заданного агента PBR-Agent. Команда извлекает сохраненную политику, полученную при выполнении команды recovery-manager advisor recommend, и применяет ее к указанному агенту. В результате применения происходит обновление значений параметров конфигурационного файла copywala.yaml согласно полученной рекомендации.

примечание

Команда advisor apply работает только в prompt-режиме (интерактивном сеансе) после предварительного выполнения advisor recommend в той же сессии. При вызове advisor apply как отдельной команды из командной строки (например, сразу после recovery-manager advisor recommend) рекомендация не будет найдена, так как она хранится в оперативной памяти запущенного экземпляра утилиты и обнуляется после его завершения.

Синтаксис:

recovery-manager advisor apply <agent-id> [flags]

Обязательные параметры:

<agent-id> – уникальный идентификатор агента PBR-Agent, к которому необходимо применить рекомендацию.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде

Сценарии использования:

Запрос рекомендации настройки политики резервного копирования с помощью AI-Advisor.