ansible.builtin.ping (v2.16.5) — module

Install Ansible via pip

Install with pip install ansible-core==2.16.5

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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:

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
data:
    default: pong
    description:
    - Data to return for the RV(ping) return value.
    - If this parameter is set to V(crash), the module will cause an exception.
    type: str

Outputs

ping:
  description: Value provided with the O(data) parameter.
  returned: success
  sample: pong
  type: str

See also

• ansible.netcommon.net_ping
• ansible.windows.win_ping