clarified ping module purpose

This commit is contained in:
Brian Coca 2015-10-21 13:57:47 -04:00
parent bc3b1abd68
commit 83b5220068

View file

@ -23,19 +23,20 @@ DOCUMENTATION = '''
---
module: ping
version_added: historical
short_description: Try to connect to host and return C(pong) on success.
short_description: Try to connect to host, veryify a usable python and return C(pong) on success.
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)
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.
options: {}
author:
author:
- "Ansible Core Team"
- "Michael DeHaan"
'''
EXAMPLES = '''
# Test 'webservers' status
# Test we can logon to 'webservers' and execute python with json lib.
ansible webservers -m ping
'''