mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
89 lines
2.3 KiB
Python
89 lines
2.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
|
|
# (c) 2016, Toshio Kuratomi <tkuratomi@ansible.com>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: ping
|
|
version_added: historical
|
|
short_description: Try to connect to host, verify a usable python and return V(pong) on success
|
|
description:
|
|
- A trivial test module, this module always returns V(pong) on successful
|
|
contact. It does not make sense in playbooks, but it is useful from
|
|
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 that requires Python on the remote-node.
|
|
- For Windows targets, use the M(ansible.windows.win_ping) module instead.
|
|
- For Network targets, use the M(ansible.netcommon.net_ping) module instead.
|
|
options:
|
|
data:
|
|
description:
|
|
- Data to return for the RV(ping) return value.
|
|
- If this parameter is set to V(crash), the module will cause an exception.
|
|
type: str
|
|
default: pong
|
|
extends_documentation_fragment:
|
|
- action_common_attributes
|
|
attributes:
|
|
check_mode:
|
|
support: full
|
|
diff_mode:
|
|
support: none
|
|
platform:
|
|
platforms: posix
|
|
seealso:
|
|
- module: ansible.netcommon.net_ping
|
|
- module: ansible.windows.win_ping
|
|
author:
|
|
- Ansible Core Team
|
|
- Michael DeHaan
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Test we can logon to 'webservers' and execute python with json lib.
|
|
# ansible webservers -m ansible.builtin.ping
|
|
|
|
- name: Example from an Ansible Playbook
|
|
ansible.builtin.ping:
|
|
|
|
- name: Induce an exception to see what happens
|
|
ansible.builtin.ping:
|
|
data: crash
|
|
'''
|
|
|
|
RETURN = '''
|
|
ping:
|
|
description: Value provided with the O(data) parameter.
|
|
returned: success
|
|
type: str
|
|
sample: pong
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
data=dict(type='str', default='pong'),
|
|
),
|
|
supports_check_mode=True
|
|
)
|
|
|
|
if module.params['data'] == 'crash':
|
|
raise Exception("boom")
|
|
|
|
result = dict(
|
|
ping=module.params['data'],
|
|
)
|
|
|
|
module.exit_json(**result)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|