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

Примечание

Этот модуль входит в коллекцию community.windows (версия 2.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Для использования в плейбуке укажите: community.windows.win_msg.

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

Описание

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

Параметры

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

Примечания

Примечание

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

См. также

community.windows.win_say: Модуль для воспроизведения текста на Windows для озвучивания сообщений и (необязательно) воспроизведения звуков.
community.windows.win_toast: Отправка уведомлений Toast на Windows 10 и более поздних версиях для авторизованных пользователей.

Примеры

- 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. Возвращается: success Пример: `"10"`
msg строка	Отправленное сообщение. Возвращается: changed Пример: `"Automated upgrade about to start. Please save your work and log off before 22 July 2016 18:00:00"`
rc целое число	Код возврата вызова API. Возвращается: всегда Пример: `0`
runtime_seconds строка	Время выполнения модуля на удалённом хосте Windows. Возвращается: success Пример: `"22 July 2016 17:45:51"`
sent_localtime строка	Локальное время хоста Windows, когда было отправлено сообщение. Возвращается: success Пример: `"22 July 2016 17:45:51"`
wait логическое значение	Значение параметра модуля wait. Возвращается: success Пример: `false`

Авторы

Jon Hawkesworth (@jhawkesworth)

Ссылки на коллекцию

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