lowlydba.sqlserver.availability_group 模块 – 配置可用性组

注意

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

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

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

要在 playbook 中使用它,请指定:lowlydba.sqlserver.availability_group

lowlydba.sqlserver 0.4.0 中的新增功能

概要

  • 配置最多包含一个副本的 SQL Server 可用性组。

要求

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

参数

参数

注释

ag_name

字符串 / 必需

可用性组的名称。

all_ags

布尔值

将更改应用于实例上的所有可用性组。仅用于配置现有的可用性组。

选项

  • false

  • true

allow_null_backup

布尔值

如果不存在且 *seeding_mode=Automatic*,则允许将完整备份到 NULL

选项

  • false

  • true

automated_backup_preference

字符串

默认情况下如何处理备份请求。

选项

  • "None"

  • "Primary"

  • "Secondary" ← (默认)

  • "SecondaryOnly"

availability_mode

字符串

副本应为异步还是同步。

仅在创建新的可用性组时使用。

选项

  • "AsynchronousCommit"

  • "SynchronousCommit" ← (默认)

basic_availability_group

布尔值

指示可用性组是否为基本可用性组。

选项

  • false

  • true

cluster_type

字符串

可用性组的集群类型。仅在 SQL Server 2017 及更高版本中支持。

选项

  • "Wsfc" ← (默认)

  • "External"

  • "None"

数据库

别名:database_name

字符串

要为其创建可用性组的数据库的名称。

database_health_trigger

布尔值

指示可用性组是否触发数据库运行状况。

选项

  • false

  • true

dtc_support_enabled

布尔值

启用 Dtc 支持。

选项

  • false

  • true

failover_mode

字符串

副本是否具有自动或手动故障转移。

选项

  • "Automatic" ← (默认)

  • "Manual"

failure_condition_level

字符串

指定可在可用性组中触发自动故障转移的不同条件。

选项

  • "OnAnyQualifiedFailureCondition"

  • "OnCriticalServerErrors"

  • "OnModerateServerErrors"

  • "OnServerDown"

  • "OnServerUnresponsive"

force

布尔值

使用新的备份在远程服务器上删除并重新创建数据库。

选项

  • false

  • true

healthcheck_timeout

整数

此设置用于指定 SQL Server 资源 DLL 在报告 Always On 故障转移群集实例 (FCI) 无响应之前,应等待 sp_server_diagnostics 存储过程返回信息的时间长度(以毫秒为单位)。

对超时设置所做的更改会立即生效,不需要重新启动 SQL Server 资源。

is_distributed_ag

布尔值

指示可用性组是否为分布式组。

选项

  • false

  • true

seeding_mode

字符串

副本的默认种子模式。否则应保持默认值,否则可能需要手动设置。

选项

  • "Automatic"

  • "Manual" ← (默认)

shared_path

字符串

将从中备份和还原备份的网络共享。

sql_instance

字符串 / 必需

要修改的 SQL Server 实例。

sql_instance_secondary

字符串

新可用性组的辅助 SQL Server 实例。

sql_password

字符串

SQL 身份验证的密码。

sql_password_secondary

字符串

辅助副本的 SQL 身份验证密码。

sql_username

字符串

SQL 身份验证的用户名。

sql_username_secondary

字符串

辅助副本的 SQL 身份验证用户名。

state

字符串

对象应该是 present 还是 absent

选项

  • "present" ← (默认)

  • "absent"

use_last_backup

布尔值

使用数据库的最后一个完整备份和日志备份。日志备份必须是最后一个备份。

选项

  • false

  • true

属性

属性

支持

描述

check_mode

支持: 完全支持

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

平台

平台: 全部

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

示例

- name: Create Availability Group
  lowlydba.sqlserver.availability_group:
    sql_instance: sql-01.myco.io
    ag_name: AG_MyDatabase

返回值

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

描述

数据

字典

来自 New-DbaAvailabilityGroupSet-DbaAvailabilityGroup 函数的输出。

返回: 成功,但不在检查模式下。

作者

  • John McCall (@lowlydba)