win_toast – Sends Toast windows notification to logged in users on Windows 10 or later hosts
win_toast – Sends Toast windows notification to logged in users on Windows 10 or later hosts
New in version 2.4.
Synopsis
- Sends alerts which appear in the Action Center area of the windows desktop.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
expire integer |
Default: 45 |
How long in seconds before the notification expires. |
group - |
Default: "Powershell" |
Which notification group to add the notification to. |
msg - |
Default: "Hello, World!" |
The message to appear inside the notification. May include \n to format the message to appear within the Action Center. |
popup boolean |
|
If |
tag - |
Default: "Ansible" |
The tag to add to the notification. |
title - |
Default: "Notification HH:mm" |
The notification title, which appears in the pop up.. |
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.
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, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
expire_at_utc string |
allways |
Calculated utc date time when the notification expires.
Sample: 07 July 2017 04:50:54 |
no_toast_sent_reason string |
when no logged in users are detected |
Text containing the reason why a notification was not sent.
Sample: No logged in users to notify |
sent_localtime string |
allways |
local date time when the notification was sent.
Sample: 07 July 2017 05:45:54 |
time_taken float |
allways |
How long the module took to run on the remote windows host in seconds.
Sample: 0.3706631999999997 |
toast_sent boolean |
allways |
Whether the module was able to send a toast notification or not.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- 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