W3cubDocs

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
Parameters
See Also
Examples
Return Values

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.

Examples

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

- name: Example from an Ansible Playbook
  ping:

- name: Induce an exception to see what happens
  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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/builtin/ping_module.html