New in version 2.3.
parameter | required | default | choices | comments |
---|---|---|---|---|
display_seconds |
no | 10 | How long to wait for receiver to acknowledge message, in seconds. | |
msg |
no | Hello world! | The text of the message to be displayed. | |
to |
no | * | Who to send the message to. Can be a username, sessionname or sessionid. | |
wait |
no | Whether to wait for users to respond. Module will only wait for the number of seconds specified in display_seconds or 10 seconds if not specified. However, if wait is true, the message is sent to each logged on user in turn, waiting for the user to either press 'ok' or for the timeout to elapse before moving on to the next user. |
# Warn logged in users of impending upgrade win_msg: display_seconds: 60 msg: "Automated upgrade about to start. Please save your work and log off before {{ deployment_start_time }}"
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
msg | Test of the message that was sent. | changed | string | Automated upgrade about to start. Please save your work and log off before 22 July 2016 18:00:00 |
wait | Value of wait module parameter. | success | boolean | False |
display_seconds | Value of display_seconds module parameter. | success | string | 10 |
runtime_seconds | How long the module took to run on the remote windows host. | success | string | 22 July 2016 17:45:51 |
sent_localtime | local time from windows host when the message was sent. | success | string | 22 July 2016 17:45:51 |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.