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

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

Описание

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

Параметры

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

Примечания

Примечание

Этот модуль должен выполняться на хосте 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.9/modules/win_msg_module.html