win_toast – Отправляет уведомления в виде тостов зарегистрированным пользователям на хостах Windows 10 или более поздних версий
Новое в версии 2.4.
Описание
- Отправляет уведомления, которые отображаются в области Центра действий на рабочем столе Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| expire целое число | Значение по умолчанию: 45 | Время в секундах, через которое уведомление истекает. |
| group строка | Значение по умолчанию: "Powershell" | Группа уведомлений, к которой добавляется уведомление. |
| msg строка | Значение по умолчанию: "Hello, World!" | Сообщение, которое будет отображаться внутри уведомления. Можно использовать \n для форматирования сообщения в Центре действий. |
| popup логическое значение |
| Если no, уведомление не будет отображаться всплывающим окном, а только в Центре действий. |
| tag строка | Значение по умолчанию: "Ansible" | Тег, добавляемый к уведомлению. |
| title строка | Значение по умолчанию: "Уведомление ЧЧ:мм" | Заголовок уведомления, отображаемый во всплывающем окне. |
Примечания
Примечание
- Этот модуль должен выполняться на хостах Windows 10 или Server 2016, поэтому убедитесь, что ваши игровые цели направлены на хосты Windows или делегированы хосту Windows.
- Модуль не завершается ошибкой, если нет зарегистрированных пользователей для уведомления.
- Сообщения отправляются только на локальный хост, где выполняется модуль.
- Вы должны запускать этот модуль с использованием async, в противном случае он будет зависать, пока не истечёт период ожидания.
См. также
См. также
- win_msg – Отправка сообщений зарегистрированным пользователям на хостах Windows
- Официальная документация модуля win_msg.
- win_say – Модуль текстовой речи для Windows для чтения сообщений и (необязательно) воспроизведения звуков
- Официальная документация модуля win_say.
Примеры
- name: Warn logged in users of impending upgrade (note use of async to stop the module from waiting until notification expires).
win_toast:
expire: 60
title: System Upgrade Notification
msg: Automated upgrade about to start. Please save your work and log off before {{ deployment_start_time }}
async: 60
poll: 0
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| expire_at_utc строка | всегда | Вычисленное значение UTC, когда уведомление истекает. Пример: 07 июля 2017 г. 04:50:54 |
| no_toast_sent_reason строка | при обнаружении отсутствия зарегистрированных пользователей | Текст, содержащий причину, по которой уведомление не было отправлено. Пример: Пользователи не вошли в систему для уведомления |
| sent_localtime строка | всегда | Локальное время отправки уведомления. Пример: 07 июля 2017 г. 05:45:54 |
| time_taken число с плавающей точкой | всегда | Время выполнения модуля на удалённом хосте Windows в секундах. Пример: 0.3706631999999997 |
| toast_sent логическое значение | всегда | Указывает, удалось ли модулю отправить уведомление в виде тоста. |
Статус
- Для этого модуля не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/win_toast_module.html