community.windows.win_toast – Отправляет уведомление Toast пользователям, вошедшим в систему, на хостах Windows 10 или более поздних версий
Примечание
Этот плагин входит в состав коллекции community.windows (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install community.windows.
Для использования в книге задач укажите: community.windows.win_toast.
Обзор
- Отправляет оповещения, которые появляются в области Центра действий на рабочем столе Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| expire целое число | Значение по умолчанию: 45 | Сколько секунд пройдет до истечения срока действия уведомления. |
| group строка | Значение по умолчанию: "Powershell" | Группа уведомлений, в которую будет добавлено уведомление. |
| msg строка | Значение по умолчанию: "Привет, мир!" | Сообщение, которое будет отображаться внутри уведомления. Может содержать \n для форматирования сообщения в Центре действий. |
| popup логическое значение |
| Если no, уведомление не будет выведено всплывающим окном, а будет отображаться только в Центре действий. |
| tag строка | Значение по умолчанию: "Ansible" | Тег, который будет добавлен к уведомлению. |
| title строка | Значение по умолчанию: "Уведомление ЧЧ:мм" | Заголовок уведомления, который отображается во всплывающем окне. |
Примечания
Примечание
- Этот модуль должен выполняться на хосте Windows 10 или Server 2016. Убедитесь, что ваши задачи направлены на хосты Windows или делегированы хосту Windows.
- Модуль не завершается ошибкой, если нет залогинившихся пользователей, которым нужно отправить уведомление.
- Сообщения отправляются только на локальный хост, где выполняется модуль.
- Этот модуль необходимо запускать с параметром async, иначе он будет приостановлен до истечения срока действия.
См. также
См. также
- community.windows.win_msg
-
Официальная документация по модулю community.windows.win_msg.
- community.windows.win_say
-
Официальная документация по модулю community.windows.win_say.
Примеры
- name: Warn logged in users of impending upgrade (note use of async to stop the module from waiting until notification expires).
community.windows.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 логическое значение | всегда | Указывает, удалось ли модулю отправить уведомление 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.10/collections/community/windows/win_toast_module.html
