ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-26 14:41:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

clarified ping module purpose

Browse source
This commit is contained in:
Brian Coca 2015-10-21 13:57:47 -04:00 • committed by Matt Clay
commit 505467d2ff
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
lib/ansible/modules/system/ping.py
View file

@ -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
''' '''