win_msg - Отправка сообщения зарегистрированным пользователям на хостах Windows.
Новое в версии 2.3.
Описание
- Оборачивает команду msg.exe для отправки сообщений на хосты Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| display_seconds | По умолчанию: 10 | Время ожидания подтверждения сообщения получателем в секундах. |
| msg | По умолчанию: Привет мир! | Текст отображаемого сообщения. Сообщение должно содержать менее 256 символов. |
| to | По умолчанию: * | Получатель сообщения. Может быть именем пользователя, именем сеанса или идентификатором сеанса. |
| wait |
| Ожидать ответа от пользователей. Модуль будет ждать указанное в display_seconds количество секунд или 10 секунд, если не указано иначе. Однако, если wait имеет значение true, сообщение отправляется каждому вошедшему в систему пользователю по очереди, ожидая, пока пользователь нажмет «ОК» или истечет время ожидания, прежде чем перейти к следующему пользователю. |
Примечания
Примечание
- Этот модуль должен выполняться на хосте Windows, поэтому убедитесь, что ваши целевые хосты — хосты Windows или делегированы хосту Windows.
- Сообщения отправляются только на локальный хост, где выполняется модуль.
- Модуль не поддерживает отправку сообщения пользователям, перечисленным в файле.
- Установка wait в значение true может привести к длительному времени выполнения на системах с большим количеством вошедших в систему пользователей.
Примеры
- 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 |
| 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.5/modules/win_msg_module.html
