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

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

Описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Описание

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

Параметры

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

Примечания

Примечание

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

См. также

win_say – Модуль преобразования текста в речь для Windows для озвучивания сообщений и, при необходимости, воспроизведения звуков: Официальная документация модуля win_say.
win_toast – Отправка уведомлений Toast в виде окон для зарегистрированных пользователей на хостах Windows 10 или более поздних версий: Официальная документация модуля win_toast.

Примеры

- 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 строка	успешно	Значение параметра модуля display_seconds. Пример: 10
msg строка	изменено	Отправленное сообщение. Пример: Автоматическое обновление скоро начнется. Пожалуйста, сохраните свою работу и выйдите из системы до 22 июля 2016 г. 18:00:00
rc целое число	всегда	Код возврата вызова API.
runtime_seconds строка	успешно	Время выполнения модуля на удалённом хосте Windows. Пример: 22 июля 2016 г. 17:45:51
sent_localtime строка	успешно	Локальное время хоста Windows при отправке сообщения. Пример: 22 июля 2016 г. 17:45:51
wait логическое значение	успешно	Значение параметра модуля wait.

Статус

Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается сообществом 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.8/modules/win_msg_module.html