Модуль lowlydba.sqlserver.tcp_port — задаёт TCP-порт экземпляра

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install lowlydba.sqlserver. Для работы с этим модулем необходимы дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: lowlydba.sqlserver.tcp_port.

Добавлено в lowlydba.sqlserver 0.10.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Задаёт TCP-порт экземпляра SQL Server.

Требования

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

Модуль PowerShell dbatools

Параметры

Параметр	Комментарии
force boolean добавлено в lowlydba.sqlserver 1.2.0	Автоматически перезапускать службы SQL Server и SQL Agent. Варианты: `false` ← (по умолчанию) `true`
ip_address string	Адрес IPv4.
password string	Пароль для альтернативных учётных данных, используемых для аутентификации в Windows.
port integer / обязательный	Порт, на котором SQL Server будет принимать подключения.
sql_instance string / обязательный	Экземпляр SQL Server, который необходимо изменить.
sql_password string	Пароль для аутентификации SQL.
sql_username string	Имя пользователя для аутентификации SQL.
username string	Имя пользователя для альтернативных учётных данных, используемых для аутентификации в 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 dictionary	Результат работы функции `Set-DbaTcpPort`. Возвращается RestartRequired, если для применения изменения требуется перезапустить службу. Возвращается: при успешном выполнении, кроме режима check_mode.

Авторы

John McCall (@lowlydba)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/lowlydba/sqlserver/tcp_port_module.html