ansible/library/ping

53 lines
1.6 KiB
Text
Raw Normal View History

2012-02-23 20:18:51 +01:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
2012-02-23 20:18:51 +01:00
# (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
2012-09-29 16:21:00 +02:00
DOCUMENTATION = '''
---
module: ping
2012-11-21 18:49:30 +01:00
short_description: Try to connect to host and return C(pong) on success.
2012-09-29 16:21:00 +02:00
description:
2012-11-21 18:49:30 +01:00
- 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
2012-10-01 09:18:54 +02:00
C(/usr/bin/ansible)
options: {}
2012-09-29 16:21:00 +02:00
examples:
- code: ansible webservers -m ping
description: Test 'webservers' status
2012-09-29 16:23:58 +02:00
author: Michael DeHaan
2012-09-29 16:21:00 +02:00
'''
def main():
module = AnsibleModule(
2013-02-17 21:01:49 +01:00
argument_spec = dict(
data=dict(required=False, default=None),
),
supports_check_mode = True
)
2013-02-17 21:01:49 +01:00
result = dict(ping='pong')
if module.params['data']:
result['ping'] = module.params['data']
module.exit_json(**result)
# this is magic, see lib/ansible/module_common.py
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
main()