win_msg - Отправка сообщения зарегистрированным пользователям на хостах Windows

Новая версия 2.3.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Описание

Оборачивает команду msg.exe для отправки сообщений на хосты Windows.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
display_seconds	Значение по умолчанию: 10	Время ожидания подтверждения сообщения получателем в секундах.
msg	Значение по умолчанию: "Привет мир!"	Текст отображаемого сообщения. Длина сообщения должна быть меньше 256 символов.
to	Значение по умолчанию: "*"	Получатель сообщения. Может быть именем пользователя, именем сессии или идентификатором сессии.
wait bool	Варианты: нет ← да	Ожидать ответа от пользователей. Модуль будет ждать указанное в параметре display_seconds количество секунд или 10 секунд, если оно не указано. Однако, если wait `yes`, сообщение отправляется каждому вошедшему пользователю по очереди, ожидая, пока пользователь нажмёт 'ОК' или истечёт время ожидания, прежде чем перейти к следующему пользователю.

Примечания

Примечание

Этот модуль должен выполняться на хосте Windows, поэтому убедитесь, что ваши целевые хосты — хосты Windows или делегированы хосту Windows.
Сообщения отправляются только на локальный хост, где выполняется модуль.
Модуль не поддерживает отправку сообщения пользователям, перечисленным в файле.
Установка wait в yes может привести к длительному времени выполнения на системах с большим количеством вошедших пользователей.

Примеры

- name: Warn logged in users of impending upgrade
  win_msg:
    display_seconds: 60
    msg: Automated upgrade about to start.  Please save your work and log off before {{ deployment_start_time }}

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ	Возвращённое значение	Описание
display_seconds string	успех	Значение параметра модуля display_seconds. Пример: 10
msg string	изменено	Текст отправленного сообщения. Пример: Автоматическое обновление скоро начнётся. Сохраните свою работу и выйдите из системы до 22 июля 2016 г. 18:00:00
rc int	всегда	Код возврата API-вызова
runtime_seconds string	успех	Время выполнения модуля на удалённом хосте Windows. Пример: 22 июля 2016 г. 17:45:51
sent_localtime string	успех	Локальное время хоста Windows при отправке сообщения. Пример: 22 июля 2016 г. 17:45:51
wait boolean	успех	Значение параметра модуля wait.

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

Jon Hawkesworth (@jhawkesworth)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/win_msg_module.html