win_toast — Отправка уведомлений Toast на Windows 10 или более поздних хостах
Новое в версии 2.4.
Описание
- Отправляет уведомления, которые появляются в области Центра действий на рабочем столе Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| expire | По умолчанию: 45 |
Время в секундах, через которое уведомление истекает. |
| group | По умолчанию: Powershell |
Группа уведомлений, к которой добавить уведомление. |
| msg | По умолчанию: Привет, мир! |
Сообщение, которое будет отображаться внутри уведомления. Может содержать \n для форматирования сообщения в Центре действий. |
| popup |
|
Если значение ложь, уведомление не будет всплывать и будет отображаться только в Центре действий. |
| tag | По умолчанию: Ansible |
Тег, который добавить к уведомлению. |
| title | По умолчанию: Уведомление ЧЧ:мм |
Заголовок уведомления, который отображается во всплывающем окне. |
Примечания
Примечание
- Этот модуль должен выполняться на хосте с Windows 10 или Server 2016, поэтому убедитесь, что ваши целевые хосты — Windows, или что делегирование выполняется на хосте с Windows.
- Модуль не завершается ошибкой, если нет залогиненных пользователей для уведомления.
- Сообщения отправляются только на локальный хост, где выполняется модуль.
- Вы должны запустить этот модуль с использованием асинхронного режима, иначе он будет приостановлен до истечения срока действия уведомления.
Примеры
- 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.3706632 |
| toast_sent булево |
всегда | Указывает, удалось ли модулю отправить уведомление Toast или нет. |
Статус
Этот модуль помечен как предварительный, что означает, что интерфейс не гарантируется обратно совместимым.
Автор
- 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_toast_module.html
