lowlydba.sqlserver.ag_replica 模块 – 配置可用性组副本

注意

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

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

要安装它，请使用：ansible-galaxy collection install lowlydba.sqlserver。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。

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

lowlydba.sqlserver 0.5.0 中的新增功能

概要

  • 配置可用性组副本。

要求

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

参数

参数

注释

ag_name

字符串 / 必需

将新副本加入其中的可用性组的名称。

availability_mode

字符串

副本应该是异步的还是同步的。

选项

  • "AsynchronousCommit" ← (默认)

  • "SynchronousCommit"

backup_priority

整数

设置备份优先级可用性组副本。

默认： 50

cluster_type

字符串

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

选项

  • "Wsfc" ← (默认)

  • "External"

  • "None"

configure_xe_session

布尔值

配置 AlwaysOn_health 扩展事件会话以像 SSMS 向导一样自动启动。

选项

  • false ← (默认)

  • true

connection_mode_in_primary_role

字符串

数据库处于主角色时可以建立哪些连接。

选项

  • "AllowReadIntentConnectionsOnly"

  • "AllowAllConnections" ← (默认)

connection_mode_in_secondary_role

字符串

数据库处于辅助角色时可以建立哪些连接。

选项

  • "AllowNoConnections" ← (默认)

  • "AllowReadIntentConnectionsOnly"

  • "AllowAllConnections"

endpoint

字符串

默认情况下，此命令将尝试查找 DatabaseMirror 端点。如果不存在，它将创建它。

默认： "hadr_endpoint"

endpoint_url

字符串

默认情况下，Get-DbaEndpoint 的 Fqdn 属性用作 _endpoint_url_。如果由于特殊的网络配置需要不同的 URL，请使用 _endpoint_url_。

failover_mode

字符串

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

选项

  • "Automatic"

  • "Manual" ← (默认)

read_only_routing_connection_url

字符串

设置可用性副本的只读路由连接 URL。

read_only_routing_list

字符串

设置在通过此可用性副本重定向只读连接时使用的副本服务器名称的有序列表。

seeding_mode

字符串

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

选项

  • "Automatic" ← (默认)

  • "Manual"

session_timeout

整数

可用性副本在认为连接已失败之前等待连接的副本的 ping 响应的秒数。

sql_instance

字符串 / 必需

要修改的 SQL Server 实例。

sql_instance_replica

字符串 / 必需

要配置的副本的 SQL Server 实例。

sql_password

字符串

SQL 身份验证的密码。

sql_password_replica

字符串

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

sql_username

字符串

SQL 身份验证的用户名。

sql_username_replica

字符串

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

state

字符串

对象是否应该是 present 或 absent。

选项

  • "present" ← (默认)

  • "absent"

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 下运行并返回更改状态预测，而无需修改目标。

platform

平台： 所有

可以对其进行操作的目标操作系统/系列。

示例

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

- name: Add a DR replica
  lowlydba.sqlserver.ag_replica:
    ag_name: 'AG_MyDatabase'
    sql_instance_primary: sql-01.myco.io
    sql_instance_replica: sql-02.myco.io
    failover_mode: 'Manual'
    availability_mode: 'Asynchronous'
    seeding_mode: 'Automatic'
    connection_mode_in_primary_role: 'AllowAllConnections'
    connection_mode_in_secondary_role: 'AllowNoConnections'

返回值

常见的返回值已在 此处 记录，以下是此模块独有的字段

键

描述

data

字典

Add-DbaAgReplica 或 Set-DbaAgReplica 函数的输出。

返回：成功，但不在 check_mode 中。

作者

  • John McCall (@lowlydba)