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

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

A trivial test module, this module always returns C(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(win_ping) module instead.

For Network targets, use the M(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 ping

# Example from an Ansible Playbook
- ping:

Scanned by Steampunk Spotter

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

# Induce an exception to see what happens
- ping:
    data: crash

Inputs

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

Outputs

ping:
  description: value provided with the data parameter
  returned: success
  sample: pong
  type: str

See also

• net_ping
• win_ping