win_msg — Отправка сообщения зарегистрированным пользователям на хостах Windows.
Новая версия 2.3.
Описание
- Оборачивает команду msg.exe для отправки сообщений хостам Windows.
Параметры
| параметр | обязательный | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| display_seconds | нет | 10 | Время ожидания подтверждения сообщения получателем в секундах. | |
| msg | нет | Привет мир! | Текст отображаемого сообщения. Сообщение должно быть менее 256 символов. | |
| to | нет | * | Получатель сообщения. Может быть именем пользователя, именем сессии или идентификатором сессии. | |
| wait | нет | нет |
| Ожидать ответа от пользователей. Модуль будет ждать указанное в параметре display_seconds количество секунд или 10 секунд, если оно не указано. Однако, если wait установлено в значение «да», сообщение отправляется каждому вошедшему пользователю по очереди, ожидая нажатия пользователем «ОК» или истечения таймаута, прежде чем переходить к следующему пользователю. |
Примеры
- 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. | всегда | целое число | 0 |
| runtime_seconds | Время выполнения модуля на удалённом хосте Windows. | успешно | строка | 22 июля 2016 г. 17:45:51 |
| sent_localtime | Локальное время на хосте Windows при отправке сообщения. | успешно | строка | 22 июля 2016 г. 17:45:51 |
| wait | Значение параметра модуля wait. | успешно | булево | False |
Примечания
Примечание
- Этот модуль должен выполняться на хосте Windows, убедитесь, что ваши целевые хосты — это хосты Windows или хосты, к которым делегировано выполнение.
- Сообщения отправляются только на локальный хост, где выполняется модуль.
- Модуль не поддерживает отправку сообщения пользователям, перечисленным в файле.
- Установка wait в «да» может привести к длительному времени выполнения на системах с множеством зарегистрированных пользователей.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если у вас есть желание, прочтите Информацию о сообществе и внесении вклада, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_msg_module.html
