Модуль lowlydba.sqlserver.restore — выполняет операцию восстановления
Примечание
Этот модуль входит в коллекцию lowlydba.sqlserver (версия 2.8.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install lowlydba.sqlserver. Для использования этого модуля нужны дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: lowlydba.sqlserver.restore.
Добавлено в lowlydba.sqlserver 0.9.0
Краткое описание
- Выполняет операцию восстановления базы данных.
Требования
Следующие требования должны быть выполнены на узле, который выполняет этот модуль.
- Модуль PowerShell dbatools
Параметры
Параметр | Комментарии |
|---|---|
azure_credential string | Имя учетных данных SQL Server, которые будут использоваться при восстановлении из резервной копии, размещенной в Azure и использующей ключи доступа к хранилищу. |
block_size string | Задает используемый размер блока. Варианты:
|
buffer_count integer | Количество используемых буферов ввода-вывода. По умолчанию: |
database string | Обрабатываемая база данных. |
destination_data_directory string | Путь на целевом экземпляре SQL Server, в который следует восстановить резервные копии. Если указан только этот параметр, все файлы базы данных (данные и журнал) будут восстановлены в это расположение |
destination_file_prefix string | Это значение будет добавлено в начало имен всех восстанавливаемых файлов (журнала и данных). |
destination_file_suffix string | Это значение будет добавлено в конец имен всех восстанавливаемых файлов (журнала и данных). |
destination_filestream_directory string | Путь для восстановления данных FileStream. Этот параметр можно указать только вместе с destination_data_directory. |
destination_log_directory string | Путь для восстановления файлов журнала базы данных. Этот параметр можно указать только вместе с destination_data_directory. |
directory_recurse boolean | Если параметр указан, поиск будет выполняться рекурсивно в указанном каталоге (переопределяя поведение по умолчанию). Варианты:
|
ignore_diff_backup boolean | Указывает, что восстановление всех дифференциальных резервных копий следует пропустить. Варианты:
|
ignore_log_backup boolean | Указывает, что восстановление всех резервных копий журнала следует пропустить. Варианты:
|
keep_cdc boolean | Указывает, следует ли восстанавливать сведения CDC вместе с базой данных. Варианты:
|
keep_replication boolean | Указывает, следует ли восстанавливать конфигурацию репликации вместе с базой данных при выполнении операции восстановления. Варианты:
|
maintenance_solution_backup boolean | Переключатель, указывающий, что файлы резервных копий находятся в структуре каталогов, создаваемой скриптами обслуживания Ola Hallengreen. Это позволяет ускорить анализ файлов. Варианты:
|
max_transfer_size integer | Задает размер единицы передачи. Значение должно быть кратно 64 КБ. По умолчанию: |
no_recovery boolean | Указывает, следует ли переводить базы данных в рабочее состояние после последнего восстановления. Варианты:
|
no_xp_dir_recurse boolean | Если параметр указан, он запрещает процессу Варианты:
|
path string / обязательный | Путь к файлам резервных копий SQL Server. Пути, переданные в виде строк, будут проверены выбранным способом; по умолчанию выполняется рекурсивный поиск в каталогах. Принимает несколько путей, разделенных символом |
replace_db_name_in_file boolean | Если переключатель включен, все вхождения исходного имени базы данных в файле данных или журнала будут заменены именем, указанным в параметре database_name. Варианты:
|
restore_time string | Укажите строку даты и времени По умолчанию используется последняя доступная точка в указанных резервных копиях. |
restored_database_name_prefix string | Строка, которая будет добавлена в начало имени восстанавливаемой базы данных. |
reuse_source_folder_structure boolean | По умолчанию базы данных переносятся в каталоги данных и журналов по умолчанию целевого экземпляра SQL Server. Это поведение можно переопределить с помощью Варианты:
|
sql_instance string / обязательный | Экземпляр SQL Server, который требуется изменить. |
sql_password string | Пароль для аутентификации SQL. |
sql_username string | Имя пользователя для аутентификации SQL. |
standby_directory string | Если указан каталог, база(ы) данных будут восстановлены в режиме ожидания, а файл ожидания будет помещен в этот каталог (каталог должен существовать и быть доступным для записи целевому экземпляру SQL Server). |
stop_after_date string | По умолчанию восстановление останавливается при первом обнаружении stop_mark в цепочке. Передача строки даты и времени |
stop_before boolean | Переключатель, указывающий, что восстановление должно остановиться до появления stop_mark. По умолчанию восстановление останавливается при создании метки. Варианты:
|
stop_mark string | Метка в журнале транзакций, на которой следует остановить восстановление. |
use_destination_default_directories boolean | Переключатель, указывающий, что для восстановления следует использовать расположения данных и журналов по умолчанию на целевом сервере. Если они не существуют, функция попытается создать их. Варианты:
|
verify_only boolean | Указывает, что следует только проверить возможность восстановления. Варианты:
|
with_replace boolean | Указывает, разрешено ли при восстановлении заменить существующую базу данных. Варианты:
|
xp_dirtree boolean | Переключатель, указывающий, что поиск файлов должен выполняться экземпляром SQL Server с помощью Поиск будет выполняться рекурсивно начиная с переданного пути. Для работы этой функции у вас должна быть роль sysadmin в экземпляре. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект. |
platform | Платформы: все | Целевые ОС и семейства ОС, с которыми можно работать. |
Примеры
- name: Restore a Database
lowlydba.sqlserver.restore:
sql_instance: sql-01.myco.io
database: LowlyDB
- name: Restore a Database and allow future T-Log restores
lowlydba.sqlserver.restore:
sql_instance: sql-01.myco.io
database: LowlyDB1
no_recovery: true
- name: Verify backup files, no restore
lowlydba.sqlserver.restore:
sql_instance: sql-01.myco.io
database: LowlyDB2
verify_only: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
data dictionary | Измененный результат функции Возвращается: при успешном выполнении, но не в режиме check_mode. |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/lowlydba/sqlserver/restore_module.html