Модуль 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

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

Обзор

Устанавливает 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 словарь	Результат выполнения функции `Set-DbaTcpPort`. RestartRequired возвращается, если изменение требует перезапуска службы для вступления в силу. Возвращается: успех, но не в режиме check_mode.

Авторы

John McCall (@lowlydba)

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

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