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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.windows.

Чтобы использовать её в плейбуке, укажите: community.windows.win_toast.

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

Краткое описание

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

Параметры

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

Примечания

Примечание

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

См. также

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

Авторы

Jon Hawkesworth (@jhawkesworth)

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

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