Spec-Zone.ru › Ansible

lowlydba.sqlserver.backup модуль — Выполняет операцию резервного копирования

Примечание

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

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

azure_credential

string

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

block_size

string

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

Варианты:

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

buffer_count

integer

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

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

build_path

boolean

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

Варианты:

  • false ← (default)
  • true

checksum

boolean

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

Варианты:

  • false ← (default)
  • true

compress

boolean

Если установлено, используйте сжатие при создании резервной копии, если это поддерживается версией и выпуском.

Варианты:

  • false ← (default)
  • true

copy_only

boolean

Резервная копия будет CopyOnly.

Варианты:

  • false ← (default)
  • true

create_folder

boolean

Если установлено, база данных резервируется в свою собственную подпапку в пути.

Варианты:

  • false ← (default)
  • true

database

string / required

База данных для обработки.

encryption_algorithm

string

Указывает используемый алгоритм шифрования.

Варианты:

  • "AES128"
  • "AES192"
  • "AES256"
  • "TRIPLEDES"

encryption_certificate

string

Имя сертификата, который будет использоваться для шифрования резервных копий.

file_count

integer

Количество полосатых файлов для создания резервной копии.

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

file_path

string

Имя файла для резервного копирования.

Если имя не указано, файлы резервных копий будут называться DatabaseName_yyyyMMddHHmm (т.е. Database1_201714022131)

ignore_file_checks

boolean

Если установлено, останавливает функцию проверки допустимости пути.

Варианты:

  • false ← (default)
  • true

increment_prefix

boolean

Если установлено, это будет добавлять префикс к файлам резервных копий с помощью целого числа с нарастанием (т.е.; 1-, 2-).

Использование этого, как утверждается, улучшает время восстановления на некоторых платформах баз данных SQL на основе Azure.

Варианты:

  • false ← (default)
  • true

initialize

boolean

Инициализирует носитель как часть операции резервного копирования.

Варианты:

  • false ← (default)
  • true

max_transfer_size

integer

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

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

no_recovery

boolean

Если установлено, выполняется резервное копирование хвоста журнала.

Варианты:

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

path

string

Путь для размещения файлов резервной копии.

Если не указано, резервные копии будут размещены в стандартном месте резервного копирования для SqlInstance.

replace_in_name

boolean

Если установлено, следующий список строк будет заменён в строках FilePath и Path. instancename - будет заменено именем экземпляра servername - будет заменено именем сервера dbname - будет заменено именем базы данных timestamp - будет заменено отметкой времени (либо значением по умолчанию, либо предоставленным форматом) backuptype - будет заменено на Full, Log, или Differential соответственно

Варианты:

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

sql_instance

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

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

sql_password

string

Пароль для проверки подлинности SQL.

sql_username

string

Имя пользователя для проверки подлинности SQL.

timestamp_format

string

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

type

string

Тип резервного копирования, который нужно выполнить.

Варианты:

  • "full"
  • "log"
  • "differential"
  • "diff"
  • "database" ← (по умолчанию)

verify

boolean

Если установлено, резервная копия будет проверена с помощью RESTORE VERIFYONLY

Варианты:

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

with_format

boolean

Форматирует носитель как первый шаг операции резервного копирования.

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Может работать в режиме check_mode и возвращать прогноз изменения статуса без изменения целевого объекта.

platform

Платформы: все

Целевые ОС/семейства, на которых можно работать.

Примеры

- 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

словарь

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

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

Авторы

  • John McCall (@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/backup_module.html

Spec-Zone.ru

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