community.windows.win_toast 模块 – 向 Windows 10 或更高版本主机的已登录用户发送 Toast Windows 通知

注意

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

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

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

要在剧本中使用它，请指定：community.windows.win_toast。

概要

  • 发送出现在 Windows 桌面“操作中心”区域中的警报。

参数

参数

注释

expire

整数

通知过期前的时间（秒）。

默认值： 45

group

字符串

要将通知添加到哪个通知组。

默认值： "Powershell"

msg

字符串

要显示在通知中的消息。

可以使用 \n 格式化消息，以便在“操作中心”中显示。

默认值： "Hello, World!"

popup

布尔值

如果为 no，则通知不会弹出，只会出现在“操作中心”。

选项

  • false

  • true ← (默认)

tag

字符串

要添加到通知的标签。

默认值： "Ansible"

title

字符串

通知标题，显示在弹出窗口中。

默认值： "Notification HH:mm"

备注

注意

  • 此模块必须在 Windows 10 或 Server 2016 主机上运行，因此请确保您的剧本目标是 Windows 主机，或委派给 Windows 主机。

  • 如果没有已登录的用户需要通知，则模块不会失败。

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

  • 必须使用异步运行此模块，否则它将挂起，直到过期时间过去。

另请参见

另请参见

community.windows.win_msg

向 Windows 主机的已登录用户发送消息。

community.windows.win_say

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

示例

- 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

返回值

公共返回值在此处有记录 此处，以下是此模块特有的字段

键

描述

expire_at_utc

字符串

计算出的通知过期的 UTC 日期时间。

返回： 始终

示例： "07 July 2017 04:50:54"

no_toast_sent_reason

字符串

包含未发送通知原因的文本。

返回： 当未检测到已登录用户时

示例： "No logged in users to notify"

sent_localtime

字符串

发送通知的本地日期时间。

返回： 始终

示例： "07 July 2017 05:45:54"

time_taken

浮点数

模块在远程 Windows 主机上运行所花费的时间（秒）。

返回： 始终

示例： 0.3706631999999997

toast_sent

布尔值

模块是否能够发送 Toast 通知。

返回： 始终

示例： false

作者

  • Jon Hawkesworth (@jhawkesworth)