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

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
display_seconds целое число	По умолчанию: 10	Время ожидания подтверждения сообщения получателем в секундах.
msg -	По умолчанию: "Привет мир!"	Текст отображаемого сообщения. Сообщение должно быть меньше 256 символов.
to -	По умолчанию: "*"	Получатель сообщения. Может быть именем пользователя, именем сеанса или идентификатором сеанса.
wait логическое	Варианты: нет ← да	Ожидать ответа от пользователей. Модуль будет ожидать указанное в 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 строка	успешно	Значение параметра модуля 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. [community]

Авторы

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.7/modules/win_msg_module.html