community.windows.win_toast – Sends Toast windows notification to logged in users on Windows 10 or later hosts¶
Note
This plugin is part of the community.windows collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.windows
.
To use it in a playbook, specify: community.windows.win_toast
.
Parameters¶
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.
See Also¶
See also
- community.windows.win_msg
The official documentation on the community.windows.win_msg module.
- community.windows.win_say
The official documentation on the community.windows.win_say module.
Examples¶
- 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Jon Hawkesworth (@jhawkesworth)