Skip to content

ping

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin
Added in version historical.

Synopsis

  • A trivial test module, this module always returns V(pong) on successful contact. It does not make sense in playbooks, but it is useful from C(/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 M(ansible.windows.win_ping) module instead.
  • For Network targets, use the M(ansible.netcommon.net_ping) module instead.

Parameters

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

Examples

# 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

Return Values

Key Data Type Description Returned
ping str Value provided with the O(data) parameter. success

Authors

  • Ansible Core Team
  • Michael Dehaan