Модуль community.windows.win_toast — Отправка уведомления Toast в Windows для пользователей, авторизованных на хостах с Windows 10 или более поздней версией

Примечание

Этот модуль входит в коллекцию community.windows (версия 2.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.windows.

Чтобы использовать его в книге задач, укажите: community.windows.win_toast.

Описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Отправляет уведомления, которые отображаются в области Центра действий на рабочем столе Windows.

Параметры

Параметр	Комментарии
expire целое число	Время в секундах, в течение которого уведомление будет отображаться, прежде чем истечёт срок его действия. Значение по умолчанию: `45`
group строка	Группа уведомлений, в которую нужно добавить уведомление. Значение по умолчанию: `"Powershell"`
msg строка	Текст сообщения, который отобразится внутри уведомления. Можно использовать \n для форматирования сообщения, чтобы оно отображалось в Центре действий. Значение по умолчанию: `"Hello, World!"`
popup логическое значение	Если `no`, уведомление не будет всплывать, а только отобразится в Центре действий. Доступные значения: `false` `true` ← (по умолчанию)
tag строка	Тег, который нужно добавить к уведомлению. Значение по умолчанию: `"Ansible"`
title строка	Заголовок уведомления, который отображается во всплывающем окне. Значение по умолчанию: `"Notification HH:mm"`

Примечания

Примечание

Этот модуль должен выполняться на хосте с Windows 10 или Server 2016. Убедитесь, что ваши задания выполняются на хостах с Windows или делегированы хосту с Windows.
Модуль не завершится ошибкой, если нет пользователей, авторизованных для получения уведомлений.
Сообщения отправляются только на хост, где выполняется модуль.
Необходимо запускать этот модуль с параметром async, иначе он будет зависать, пока не истечёт срок действия уведомления.

См. также

community.windows.win_msg: Отправка сообщения авторизованным пользователям на хостах Windows.
community.windows.win_say: Модуль преобразования текста в речь для Windows, произносящий сообщения и (по желанию) воспроизводящий звуки.

Примеры

- 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 July 2017 04:50:54"`
no_toast_sent_reason строка	Текст, содержащий причину, по которой уведомление не было отправлено. Возвращается: когда не обнаружено пользователей, авторизованных для получения уведомлений Пример: `"No logged in users to notify"`
sent_localtime строка	Локальная дата и время отправки уведомления. Возвращается: всегда Пример: `"07 July 2017 05:45:54"`
time_taken вещественное число	Время, затраченное модулем на выполнение на удалённом хосте с Windows в секундах. Возвращается: всегда Пример: `0.3706631999999997`
toast_sent логическое значение	Указывает, удалось ли модулю отправить уведомление Toast или нет. Возвращается: всегда Пример: `false`

Авторы

Jon Hawkesworth (@jhawkesworth)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/windows/win_toast_module.html