ansible.builtin.ping – Try to connect to host, verify a usable python and return pong on success

Note

This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name ping even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

Synopsis

  • A trivial test module, this module always returns pong on successful contact. It does not make sense in playbooks, but it is useful from /usr/bin/ansible to verify the ability to login and that a usable Python is configured.
  • This is NOT ICMP ping, this is just a trivial test module that requires Python on the remote-node.
  • For Windows targets, use the ansible.windows.win_ping module instead.
  • For Network targets, use the ansible.netcommon.net_ping module instead.

Parameters

Parameter Choices/Defaults Comments
data
string
Default:
"pong"
Data to return for the ping return value.
If this parameter is set to crash, the module will cause an exception.

Notes

Note

  • Supports check_mode.

See Also

See also

ansible.netcommon.net_ping

The official documentation on the ansible.netcommon.net_ping module.

ansible.windows.win_ping

The official documentation on the ansible.windows.win_ping module.

Examples

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

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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
ping
string
success
Value provided with the data parameter.

Sample:
pong


Authors

  • Ansible Core Team
  • Michael DeHaan

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/ping_module.html