community.windows.win_msg – Sends a message to logged in users on Windows 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_msg
.
Parameters¶
Notes¶
Note
This module must run on a windows host, so ensure your play targets windows hosts, or delegates to a windows host.
Messages are only sent to the local host where the module is run.
The module does not support sending to users listed in a file.
Setting wait to
yes
can result in long run times on systems with many logged in users.
See Also¶
See also
- community.windows.win_say
The official documentation on the community.windows.win_say module.
- community.windows.win_toast
The official documentation on the community.windows.win_toast module.
Examples¶
- name: Warn logged in users of impending upgrade
community.windows.win_msg:
display_seconds: 60
msg: Automated upgrade about to start. Please save your work and log off before {{ deployment_start_time }}
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Jon Hawkesworth (@jhawkesworth)