community.windows.win_msg 模块 – 向 Windows 主机上的已登录用户发送消息

注意

此模块是 community.windows 集合 (版本 2.3.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.windows。

要在 playbook 中使用它，请指定： community.windows.win_msg。

概要

  • 封装 msg.exe 命令以向 Windows 主机发送消息。

参数

参数

注释

display_seconds

整数

等待接收方确认消息的时间（秒）。

默认值： 10

msg

字符串

要显示的消息文本。

消息必须少于 256 个字符。

默认值： "Hello world!"

to

字符串

发送消息的对象。可以是用户名、会话名或会话 ID。

默认值： "*"

wait

布尔值

是否等待用户响应。模块只等待在 display_seconds 中指定的时间（秒），如果未指定则等待 10 秒。但是，如果 wait 为 yes，则消息将依次发送给每个已登录用户，等待用户按下“确定”或超时后再继续下一个用户。

选项

  • false ← (默认)

  • true

备注

注意

  • 此模块必须在 Windows 主机上运行，因此请确保您的 playbook 针对 Windows 主机，或者委派给 Windows 主机。

  • 消息仅发送到运行模块的本地主机。

  • 此模块不支持向文件中列出的用户发送消息。

  • 将 wait 设置为 yes 可能会导致在登录用户众多的系统上运行时间过长。

另请参阅

另请参阅

community.windows.win_say

Windows 的文本转语音模块，用于朗读消息并可选播放声音。

community.windows.win_toast

向 Windows 10 或更高版本主机上的已登录用户发送 Toast Windows 通知。

示例

- 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 }}

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键

描述

display_seconds

字符串

display_seconds 模块参数的值。

返回：成功

示例： "10"

msg

字符串

已发送消息的文本。

返回：已更改

示例： "Automated upgrade about to start.  Please save your work and log off before 22 July 2016 18:00:00"

rc

整数

API 调用的返回代码。

返回：始终

示例： 0

runtime_seconds

字符串

模块在远程 Windows 主机上运行所需的时间。

返回：成功

示例： "22 July 2016 17:45:51"

sent_localtime

字符串

发送消息时 Windows 主机的本地时间。

返回：成功

示例： "22 July 2016 17:45:51"

wait

布尔值

wait 模块参数的值。

返回：成功

示例： false

作者

  • Jon Hawkesworth (@jhawkesworth)