ansible.builtin.ping 模块 – 尝试连接主机，验证可用的 Python 并成功返回 pong

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使不指定 collections 关键字，您也可以使用短模块名称 ping。但是，我们建议您使用 完全限定集合名称 (FQCN) ansible.builtin.ping，以便轻松链接到模块文档并避免与其他可能具有相同模块名称的集合冲突。

概要

  • 一个简单的测试模块，此模块在成功连接时始终返回 pong。它在 playbook 中没有意义，但从 /usr/bin/ansible 中验证登录能力和配置可用的 Python 非常有用。

  • 这不是 ICMP ping，这只是一个简单的测试模块，需要在远程节点上安装 Python。

  • 对于 Windows 目标，请改用 ansible.windows.win_ping 模块。

  • 对于网络目标，请改用 ansible.netcommon.net_ping 模块。

参数

参数

注释

data

字符串

为 ping 返回值返回的数据。

如果此参数设置为 crash，则该模块将导致异常。

默认值： "pong"

属性

属性

支持

描述

check_mode

支持： 完全

可以在 check_mode 中运行，并返回已更改的状态预测，而无需修改目标。如果不被支持，将跳过该操作。

diff_mode

支持： 无

当处于 diff 模式时，将返回已更改的内容的详细信息（或可能需要在 check_mode 中更改的内容）

platform

平台： posix

可以操作的目标操作系统/系列

参见

参见

ansible.netcommon.net_ping

关于 ansible.netcommon.net_ping 模块的官方文档。

ansible.windows.win_ping

关于 ansible.windows.win_ping 模块的官方文档。

示例

# Test we can logon to 'webservers' and execute python with json lib.
# ansible webservers -m ansible.builtin.ping

- name: Example from an Ansible Playbook
  ansible.builtin.ping:

- name: Induce an exception to see what happens
  ansible.builtin.ping:
    data: crash

返回值

通用返回值记录在此处，以下是此模块独有的字段

键

描述

ping

字符串

使用 data 参数提供的值。

返回： 成功

示例： "pong"

作者

  • Ansible Core 团队

  • Michael DeHaan