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