lowlydba.sqlserver.backup 模块 – 执行备份操作

注意

此模块是 lowlydba.sqlserver 集合 (版本 2.3.4) 的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install lowlydba.sqlserver。您需要进一步的要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定： lowlydba.sqlserver.backup。

lowlydba.sqlserver 0.8.0 中的新增功能

概要

  • 执行任何类型的数据库备份操作。

要求

在执行此模块的主机上需要以下要求。

参数

参数

注释

azure_base_url

字符串

用于将备份写入的 Azure 存储帐户的基本容器的 URL。

azure_credential

字符串

SQL 实例上可以写入 *azure_base_url* 的凭据的名称，仅在使用存储访问密钥时需要。如果使用 SAS 凭据，该命令将查找名称与 *azure_base_url* 匹配的凭据。

block_size

字符串

指定要使用的块大小。

选择

  • "0.5kb"

  • "1kb"

  • "2kb"

  • "4kb"

  • "8kb"

  • "16kb"

  • "32kb"

  • "64kb"

buffer_count

整数

要使用的 I/O 缓冲区数。

默认: 0

build_path

布尔值

默认情况下，此命令不会尝试创建缺少的路径，此开关将更改行为，使其可以创建。

选择

  • false ← (默认)

  • true

checksum

布尔值

如果设置，将计算备份校验和。

选择

  • false ← (默认)

  • true

compress

布尔值

如果设置，则在创建备份时使用压缩（如果版本和版本支持）。

选择

  • false ← (默认)

  • true

copy_only

布尔值

备份将是 CopyOnly。

选择

  • false ← (默认)

  • true

create_folder

布尔值

如果设置，数据库将备份到路径中的自己的子文件夹中。

选择

  • false ← (默认)

  • true

database

字符串 / 必需

要处理的数据库。

encryption_algorithm

字符串

指定要使用的加密算法。

选择

  • "AES128"

  • "AES192"

  • "AES256"

  • "TRIPLEDES"

encryption_certificate

字符串

用于加密备份的证书的名称。

file_count

整数

用于创建备份的条带化文件的数量。

默认: 0

file_path

字符串

要备份到的文件的名称。

如果未指定名称，则备份文件将命名为 DatabaseName_yyyyMMddHHmm (即 Database1_201714022131)

ignore_file_checks

布尔值

如果设置，则停止该函数检查路径有效性。

选择

  • false ← (默认)

  • true

increment_prefix

布尔值

如果设置，这将为备份文件添加一个递增的整数前缀（即；1-，2-）。

据称，在某些基于 Azure 的 SQL 数据库平台上使用此方法可以缩短还原时间。

选择

  • false ← (默认)

  • true

initialize

布尔值

在备份操作中初始化介质。

选择

  • false ← (默认)

  • true

max_transfer_size

整数

设置传输单元的大小。值必须是 64kb 的倍数。

默认: 0

no_recovery

布尔值

如果设置，则执行尾日志备份。

选择

  • false ← (默认)

  • true

path

字符串

用于放置备份文件的路径。

如果未指定，备份将放置在 SqlInstance 的默认备份位置。

replace_in_name

布尔值

如果设置，则将在 FilePath 和 Path 字符串中替换以下字符串列表。instancename - 将替换为实例名称 servername - 将替换为服务器名称 dbname - 将替换为数据库名称 timestamp - 将替换为时间戳（默认或提供的格式） backuptype - 将根据需要替换为 Full，Log 或 Differential

选择

  • false ← (默认)

  • true

sql_instance

字符串 / 必需

要修改的 SQL Server 实例。

sql_password

字符串

用于 SQL 身份验证的密码。

sql_username

字符串

用于 SQL 身份验证的用户名。

timestamp_format

字符串

默认情况下，命令使用格式 yyyyMMddHHmm 为备份添加时间戳。使用此选项可以覆盖此设置。

type

字符串

要执行的备份类型。

选择

  • "full"

  • "log"

  • "differential"

  • "diff"

  • "database" ← (默认)

verify

布尔值

如果设置，则将通过 RESTORE VERIFYONLY 验证备份

选择

  • false ← (默认)

  • true

with_format

布尔值

将介质格式化为备份操作的第一步。

选择

  • false ← (默认)

  • true

属性

属性

支持

描述

check_mode

支持: 完全

可以在检查模式下运行，并返回更改状态预测，而不会修改目标。

平台

平台： 全部

可以操作的目标操作系统/系列。

示例

- 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

返回值

常见的返回值记录在这里，以下是此模块特有的字段

键

描述

数据

字典

来自 Backup-DbaDatabase 函数的修改后的输出。

已返回： 成功，但不在检查模式下。

作者

  • John McCall (@lowlydba)