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 булево	Варианты: no ← yes	Ожидать ответа от пользователей. Модуль будет ожидать указанное количество секунд в параметре `display_seconds` или 10 секунд, если не указано. Однако, если wait `yes`, сообщение отправляется каждому вошедшему пользователю по очереди, ожидая, пока пользователь нажмет «ОК» или истечёт время ожидания, прежде чем перейти к следующему пользователю.

Примечания

Примечание

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

Авторы

Jon Hawkesworth (@jhawkesworth)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/windows/win_msg_module.html