ansible.windows.win_ping 模块 – 经典 ping 模块的 Windows 版本

注意

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

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

要安装它,请使用:ansible-galaxy collection install ansible.windows

要在剧本中使用它,请指定:ansible.windows.win_ping

摘要

  • 检查 Windows 主机的管理连接。

  • 这不是 ICMP ping,只是一个简单的测试模块。

  • 对于非 Windows 目标,请改用 ansible.builtin.ping 模块。

参数

参数

注释

data

字符串

返回“pong”以外的其他数据的备选数据。

如果将此参数设置为 crash,则模块将引发异常。

默认值: "pong"

另请参见

另请参见

ansible.builtin.ping

尝试连接到主机,验证可用的 python 并返回 pong 以指示成功。

示例

# Test connectivity to a windows host
# ansible winserver -m ansible.windows.win_ping

- name: Example from an Ansible Playbook
  ansible.windows.win_ping:

- name: Induce an exception to see what happens
  ansible.windows.win_ping:
    data: crash

返回值

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

描述

ping

字符串

使用 data 参数提供的值。

返回:成功

示例: "pong"

作者

  • Chris Church (@cchurch)