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

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: community.windows.win_msg.

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

Краткое описание

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

Параметры

Параметр	Комментарии
display_seconds integer	Время ожидания подтверждения получения сообщения, в секундах. По умолчанию: `10`
msg string	Текст отображаемого сообщения. Длина сообщения не должна превышать 256 символов. По умолчанию: `"Hello world!"`
to string	Получатель сообщения. Может быть именем пользователя, именем сеанса или идентификатором сеанса. По умолчанию: `"*"`
wait boolean	Ожидать ли ответа пользователей. Модуль будет ждать только указанное в display_seconds количество секунд или 10 секунд, если параметр не задан. Однако если значение wait равно `yes`, сообщение отправляется каждому вошедшему в систему пользователю по очереди; перед переходом к следующему пользователю модуль ожидает, пока текущий пользователь нажмёт «ok» или истечёт время ожидания. Варианты: `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 string	Значение параметра модуля display_seconds. Возвращается: success Пример: `"10"`
msg string	Текст отправленного сообщения. Возвращается: changed Пример: `"Automated upgrade about to start. Please save your work and log off before 22 July 2016 18:00:00"`
rc integer	Код возврата вызова API. Возвращается: always Пример: `0`
runtime_seconds string	Время выполнения модуля на удалённом узле Windows. Возвращается: success Пример: `"22 July 2016 17:45:51"`
sent_localtime string	Местное время на узле Windows в момент отправки сообщения. Возвращается: success Пример: `"22 July 2016 17:45:51"`
wait boolean	Значение параметра модуля wait. Возвращается: success Пример: `false`

Авторы

Jon Hawkesworth (@jhawkesworth)

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

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