ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / lib / python3.9 / site-packages / ansible / modules

# -*- 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 absolute_import, division, print_function
__metaclass__ = type

DOCUMENTATION = '''
---
module: ping
version_added: historical
short_description: Try to connect to host, verify 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) 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 C(ping) return value.
      - If this parameter is set to C(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 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()

[-] getent.py [edit]
[-] pause.py [edit]
[-] iptables.py [edit]
[+] __pycache__
[-] import_playbook.py [edit]
[-] stat.py [edit]
[-] copy.py [edit]
[-] slurp.py [edit]
[-] service_facts.py [edit]
[-] fetch.py [edit]
[-] tempfile.py [edit]
[-] pip.py [edit]
[-] yum_repository.py [edit]
[-] _include.py [edit]
[-] assemble.py [edit]
[-] user.py [edit]
[-] sysvinit.py [edit]
[-] lineinfile.py [edit]
[-] find.py [edit]
[-] replace.py [edit]
[-] blockinfile.py [edit]
[-] meta.py [edit]
[-] hostname.py [edit]
[-] reboot.py [edit]
[-] shell.py [edit]
[-] uri.py [edit]
[-] script.py [edit]
[-] async_status.py [edit]
[-] include_vars.py [edit]
[-] apt_repository.py [edit]
[-] ping.py [edit]
[-] expect.py [edit]
[-] import_tasks.py [edit]
[-] known_hosts.py [edit]
[-] include_role.py [edit]
[-] apt_key.py [edit]
[-] apt.py [edit]
[-] command.py [edit]
[-] assert.py [edit]
[-] subversion.py [edit]
[-] cron.py [edit]
[-] validate_argument_spec.py [edit]
[-] wait_for.py [edit]
[-] wait_for_connection.py [edit]
[-] package.py [edit]
[-] systemd.py [edit]
[-] get_url.py [edit]
[-] import_role.py [edit]
[-] set_fact.py [edit]
[-] group_by.py [edit]
[-] yum.py [edit]
[-] set_stats.py [edit]
[-] dpkg_selections.py [edit]
[-] add_host.py [edit]
[-] fail.py [edit]
[-] debug.py [edit]
[-] debconf.py [edit]
[-] setup.py [edit]
[-] rpm_key.py [edit]
[-] service.py [edit]
[-] gather_facts.py [edit]
[-] git.py [edit]
[-] unarchive.py [edit]
[-] include_tasks.py [edit]
[+] ..
[-] async_wrapper.py [edit]
[-] systemd_service.py [edit]
[-] template.py [edit]
[-] package_facts.py [edit]
[-] raw.py [edit]
[-] group.py [edit]
[-] dnf.py [edit]
[-] __init__.py [edit]
[-] file.py [edit]