You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

win_toast - Sends Toast windows notification to logged in users on Windows 10 or later hosts¶

New in version 2.4.

Synopsis
Options
Examples
Return Values
Notes
- Status

Synopsis ¶

Sends alerts which appear in the Action Center area of the windows desktop.

Options ¶

parameter	required	default	choices	comments
expire	no	45		How long in seconds before the notification expires.
group	no	Powershell		Which notification group to add the notification to.
msg	no	Hello, World!		The message to appear inside the notification. May include \n to format the message to appear within the Action Center.
popup	no	True	yes no	If false, the notification will not pop up and will only appear in the Action Center.
tag	no	Ansible		The tag to add to the notification.
title	no	Notification HH:mm		The notification title, which appears in the pop up..

Examples ¶

- 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

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
expire_at_utc	Calculated utc date time when the notification expires.	allways	string	07 July 2017 04:50:54
no_toast_sent_reason	Text containing the reason why a notification was not sent.	when no logged in users are detected	string	No logged in users to notify
sent_localtime	local date time when the notification was sent.	allways	string	07 July 2017 05:45:54
time_taken	How long the module took to run on the remote windows host in seconds.	allways	float	0.3706632
toast_sent	Whether the module was able to send a toast notification or not.	allways	boolean	False

Notes ¶

Note

This module must run on a windows 10 or Server 2016 host, so ensure your play targets windows hosts, or delegates to a windows host.
The module does not fail if there are no logged in users to notify.
Messages are only sent to the local host where the module is run.
You must run this module with async, otherwise it will hang until the expire period has passed.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.