From 505467d2ff611a31241718f9246093a96d4fa7fa Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Wed, 21 Oct 2015 13:57:47 -0400 Subject: [PATCH] clarified ping module purpose --- lib/ansible/modules/system/ping.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/ansible/modules/system/ping.py b/lib/ansible/modules/system/ping.py index bea7fb22f1d..1449cf5dca9 100644 --- a/lib/ansible/modules/system/ping.py +++ b/lib/ansible/modules/system/ping.py @@ -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 '''