clarified ping module purpose

pull/18777/head
Brian Coca 9 years ago committed by Matt Clay
parent a5d95b4047
commit 505467d2ff

@ -23,19 +23,20 @@ DOCUMENTATION = '''
--- ---
module: ping module: ping
version_added: historical 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: description:
- A trivial test module, this module always returns C(pong) on successful - 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 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: {} options: {}
author: author:
- "Ansible Core Team" - "Ansible Core Team"
- "Michael DeHaan" - "Michael DeHaan"
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Test 'webservers' status # Test we can logon to 'webservers' and execute python with json lib.
ansible webservers -m ping ansible webservers -m ping
''' '''

Loading…
Cancel
Save