Spec-Zone.ru › Ansible

lowlydba.sqlserver.restore модуль – Выполняет операцию восстановления

Примечание

Этот модуль входит в коллекцию lowlydba.sqlserver (версия 2.3.4).

Возможно, эта коллекция уже установлена, если вы используете пакет 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

Указывает размер блока для использования.

Варианты:

  • "0.5kb"
  • "1kb"
  • "2kb"
  • "4kb"
  • "8kb"
  • "16kb"
  • "32kb"
  • "64kb"

buffer_count

integer

Количество используемых буферов ввода-вывода.

Значение по умолчанию: 0

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

Если указано, указанный каталог будет рекурсивно обработан (переопределяя поведение по умолчанию).

Варианты:

  • false ← (по умолчанию)
  • true

ignore_diff_backup

boolean

Указывает пропустить восстановление любых дифференциальных резервных копий.

Варианты:

  • false ← (по умолчанию)
  • true

ignore_log_backup

boolean

Указывает пропустить восстановление любых резервных копий журналов.

Варианты:

  • false ← (по умолчанию)
  • true

keep_cdc

boolean

Указывает, следует ли восстанавливать информацию CDC как часть базы данных.

Варианты:

  • false
  • true

keep_replication

boolean

Указывает, следует ли восстанавливать конфигурацию репликации как часть операции восстановления базы данных.

Варианты:

  • false ← (по умолчанию)
  • true

maintenance_solution_backup

boolean

Переключатель, указывающий, что файлы резервных копий находятся в структуре папок, созданной скриптами обслуживания Ola Hallengreen.

Это позволяет ускорить анализ файлов.

Варианты:

  • false ← (по умолчанию)
  • true

max_transfer_size

integer

Задает размер единицы передачи. Значения должны быть кратными 64 КБ.

Значение по умолчанию: 0

no_recovery

boolean

Указывает, следует ли восстанавливать базы данных после последнего восстановления.

Варианты:

  • false ← (по умолчанию)
  • true

no_xp_dir_recurse

boolean

Если указано, предотвращает рекурсию процесса XpDirTree (его поведение по умолчанию).

Варианты:

  • false ← (по умолчанию)
  • true

path

string / required

Путь к файлам резервных копий SQL Server.

Пути, переданные в виде строк, будут сканироваться с использованием выбранного метода, по умолчанию используется рекурсивное сканирование папок.

Принимает несколько путей, разделенных ,.

replace_db_name_in_file

boolean

Если переключатель установлен, все вхождения имени исходной базы данных в файлах данных или журналов будут заменены именем, указанным в параметре database_name.

Варианты:

  • false
  • true

restore_time

string

Укажите строку с датой и временем HH:MM:SS MM/DD/YYYY, на которое необходимо восстановить базу данных.

По умолчанию используется последнее доступное время в указанных резервных копиях.

restored_database_name_prefix

string

Строка, которая будет добавлена в начало имени восстанавливаемой базы данных.

reuse_source_folder_structure

boolean

По умолчанию базы данных будут перенесены в стандартные каталоги данных и журналов целевого экземпляра SQL Server.

Можно переопределить это, используя reuse_source_folder_structure.

Варианты:

  • false
  • true

sql_instance

string / обязательно

Экземпляр SQL Server, который нужно изменить.

sql_password

string

Пароль для SQL-аутентификации.

sql_username

string

Имя пользователя для SQL-аутентификации.

standby_directory

string

Если указан каталог, база данных будет восстановлена в резервное состояние, а резервный файл будет помещен в этот каталог (который должен существовать и быть доступным для записи целевому экземпляру SQL Server).

stop_after_date

string

По умолчанию восстановление остановится при первой встрече stop_mark в цепочке, передача строки даты и времени HH:MM:SS MM/DD/YYYY заставит его остановить первое stop_mark после этой даты.

stop_before

boolean

Переключатель, указывающий, что восстановление должно остановиться до появления stop_mark, по умолчанию оно останавливается, когда маркер создается.

Варианты:

  • false ← (по умолчанию)
  • true

stop_mark

string

Отмеченная точка в журнале транзакций, по которой следует остановить восстановление.

use_destination_default_directories

boolean

Переключатель, указывающий, что восстановление должно использовать стандартные расположения данных и журналов на целевом сервере.

Если они не существуют, функция попытается их создать.

Варианты:

  • false
  • true

verify_only

boolean

Указывает, что восстановление должно выполняться только для проверки.

Варианты:

  • false ← (по умолчанию)
  • true

with_replace

boolean

Указывает, разрешено ли восстановление с заменой существующей базы данных.

Варианты:

  • false ← (по умолчанию)
  • true

xp_dirtree

boolean

Переключатель, указывающий, что сканирование файлов должно выполняться экземпляром SQL Server с использованием xp_dirtree.

Это будет рекурсивно сканировать каталог, указанный в пути.

Для работы необходимо быть членом роли sysadmin в экземпляре.

Варианты:

  • false
  • true

Атрибуты

Атрибут

Поддержка

Описание

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

словарь

Изменённый вывод из функции Restore-DbaDatabase.

Возвращено: успех, но не в режиме проверки.

Авторы

  • Джон МакКалл (@lowlydba)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/lowlydba/sqlserver/restore_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API