win_toast – Отправка уведомлений 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.9/modules/win_toast_module.html