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

注意

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

概要

  • 这是一个微不足道的测试模块，此模块在成功联系后始终返回 pong。它在剧本中没有意义，但它在 /usr/bin/ansible 中很有用，用于验证登录能力以及是否配置了可用的 Python。

  • 这不是 ICMP ping，它只是一个微不足道的测试模块，需要远程节点上的 Python。

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

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

别名：uses_redirected_action

参数

参数

注释

data

字符串

用于 ping 返回值的数据。

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

默认值： "pong"

属性

属性

支持

描述

check_mode

支持： 完全支持

可以在 check_mode 下运行并返回更改状态预测，而不会修改目标，如果不支持，则操作将被跳过。

diff_mode

支持： 不支持

将在差异模式下返回有关更改内容（或可能需要在 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 参数提供的 value。

已返回：成功

示例： "pong"

作者

  • Ansible 核心团队

  • Michael DeHaan