From c19d6adaf5007c58ee3850bc8a7221ec017d15c9 Mon Sep 17 00:00:00 2001 From: Marco Vito Moscaritolo Date: Sat, 29 Sep 2012 16:21:00 +0200 Subject: [PATCH] Added DOCUMENTATION to ping module. --- ping | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/ping b/ping index a620a0943d2..31908743ca4 100755 --- a/ping +++ b/ping @@ -18,6 +18,20 @@ # You should have received a copy of the GNU General Public License # along with Ansible. If not, see . + +DOCUMENTATION = ''' +--- +module: ping +short_description: Try to connect to host and return pong on success. +description: + - A trivial test module, this module always returns 'pong' on successful contact. It does not make sense in playbooks, but is useful from /usr/bin/ansible +version_added: "0.7" +examples: + - code: ansible webservers -m ping + description: Test 'webservers' status +author: +''' + def main(): module = AnsibleModule( argument_spec = dict()