Модуль lowlydba.sqlserver.backup — выполняет операцию резервного копирования
Примечание
Этот модуль входит в коллекцию lowlydba.sqlserver (версия 2.8.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install lowlydba.sqlserver. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: lowlydba.sqlserver.backup.
Добавлено в lowlydba.sqlserver 0.8.0
Краткое описание
- Выполняет резервное копирование базы данных любого типа.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- Модуль PowerShell dbatools
Параметры
Параметр | Описание |
|---|---|
azure_base_url string | URL базового контейнера учетной записи Azure Storage, в который следует записывать резервные копии. |
azure_credential string | Имя учетных данных на экземпляре SQL, которым разрешена запись в azure_base_url. Требуется только при использовании ключей доступа Storage. При использовании учетных данных SAS команда будет искать учетные данные с именем, совпадающим с azure_base_url. |
block_size string | Задает размер используемого блока. Варианты:
|
buffer_count integer | Количество используемых буферов ввода-вывода. По умолчанию: |
build_path boolean | По умолчанию эта команда не пытается создавать отсутствующие пути. Этот параметр изменяет поведение, позволяя создавать их. Варианты:
|
checksum boolean | Если параметр задан, будет вычислена контрольная сумма резервной копии. Варианты:
|
compress boolean | Если параметр задан, при создании резервной копии используется сжатие, если оно поддерживается данной версией и редакцией. Варианты:
|
copy_only boolean | Резервная копия будет создана в режиме CopyOnly. Варианты:
|
create_folder boolean | Если параметр задан, резервная копия базы данных сохраняется в отдельную вложенную папку в указанном пути. Варианты:
|
database string / обязательный | Обрабатываемая база данных. |
encryption_algorithm string | Задает используемый алгоритм шифрования. Варианты:
|
encryption_certificate string | Имя сертификата, используемого для шифрования резервных копий. |
file_count integer | Количество файлов, на которые будет разделена резервная копия. По умолчанию: |
file_path string | Имя файла, в который будет сохранена резервная копия. Если имя не указано, файлы резервной копии будут называться |
ignore_file_checks boolean | Если параметр задан, функция не проверяет допустимость пути. Варианты:
|
increment_prefix boolean | Если параметр задан, перед именами файлов резервных копий добавляется возрастающее целое число (например, Утверждается, что использование этого параметра сокращает время восстановления на некоторых платформах баз данных SQL на базе Azure. Варианты:
|
initialize boolean | Инициализирует носитель в рамках операции резервного копирования. Варианты:
|
max_transfer_size integer | Задает размер единицы передачи. Значения должны быть кратны 64 КБ. По умолчанию: |
no_recovery boolean | Если параметр задан, выполняется резервное копирование хвоста журнала транзакций. Варианты:
|
path string | Путь для сохранения файлов резервной копии. Если путь не указан, резервные копии сохраняются в расположении по умолчанию для SqlInstance. |
replace_in_name boolean | Если параметр задан, следующие строки будут заменены в строках FilePath и Path. Варианты:
|
sql_instance string / обязательный | Экземпляр SQL Server, который требуется изменить. |
sql_password string | Пароль для аутентификации SQL. |
sql_username string | Имя пользователя для аутентификации SQL. |
timestamp_format string | По умолчанию команда добавляет к резервным копиям временные метки в формате |
type string | Тип выполняемого резервного копирования. Варианты:
|
verify boolean | Если параметр задан, резервная копия будет проверена с помощью Варианты:
|
with_format boolean | Форматирует носитель в качестве первого шага операции резервного копирования. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: full | Может работать в режиме check_mode и возвращать прогнозируемый статус изменения, не изменяя целевой объект. |
platform | Платформы: all | Целевые ОС и семейства ОС, с которыми может работать модуль. |
Примеры
- name: Create striped full database backup in default dir
lowlydba.sqlserver.backup:
sql_instance: sql-01.myco.io
database: LowlyDB
type: full
file_count: 8
- name: Create t-log backup
lowlydba.sqlserver.backup:
sql_instance: sql-01.myco.io
database: LowlyDB
type: log
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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/backup_module.html
