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