lowlydba.sqlserver.tcp_port 模块 – 设置实例的 TCP 端口

注意

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

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

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

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

lowlydba.sqlserver 0.10.0 中的新增功能

概要

  • 设置 SQL Server 实例的 TCP 端口。

要求

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

参数

参数

注释

force

布尔值

在 lowlydba.sqlserver 1.2.0 中添加

自动重启 SQL Server 和 SQL Agent 服务。

选择

  • false ←（默认）

  • true

ip_address

字符串

IPv4 地址。

password

字符串

用于使用 Windows 进行身份验证的备用凭据的密码。

port

整数 / 必需

SQL Server 要侦听的端口。

sql_instance

字符串 / 必需

要修改的 SQL Server 实例。

sql_password

字符串

用于 SQL 身份验证的密码。

sql_username

字符串

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

username

字符串

用于使用 Windows 进行身份验证的备用凭据的用户名。

属性

属性

支持

描述

check_mode

支持：完全

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

platform

平台： Windows

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

示例

- name: Set the default port
  lowlydba.sqlserver.tcp_port:
    sql_instance: sql-01.myco.io
    port: 1433

- name: Set a non-standard default port
  lowlydba.sqlserver.tcp_port:
    sql_instance: sql-01.myco.io
    port: 1933

返回值

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

键

描述

data

字典

来自 Set-DbaTcpPort 函数的输出。

如果更改需要重启服务才能生效，则返回 RestartRequired。

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

作者

  • John McCall (@lowlydba)