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

Примечание

Этот плагин входит в коллекцию community.windows (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.windows.

Чтобы использовать его в книге задач, укажите: community.windows.win_msg.

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

Обзор

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

Параметры

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

Примечания

Примечание

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

См. также

community.windows.win_say: Официальная документация по модулю community.windows.win_say.
community.windows.win_toast: Официальная документация по модулю community.windows.win_toast.

Примеры

- name: Warn logged in users of impending upgrade
  community.windows.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 модуля.

Авторы

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.10/collections/community/windows/win_msg_module.html