ansible.windows.win_ping_module.rst

ansible.windows.win_ping

A windows version of the classic ping module

• Synopsis
• Parameters
• See Also
• Examples
• Return Values
• Status

Synopsis

• Checks management connectivity of a windows host.
• This is NOT ICMP ping, this is just a trivial test module.
• For non-Windows targets, use the :ref:`ansible.builtin.ping <ansible.builtin.ping_module>` module instead.

Parameters

Parameter	Choices/Defaults	Comments
data string	Default: "pong"	Alternate data to return instead of 'pong'. If this parameter is set to crash, the module will cause an exception.

See Also

.. seealso::

   :ref:`ansible.builtin.ping_module`
      The official documentation on the **ansible.builtin.ping** module.

Examples

# Test connectivity to a windows host
# ansible winserver -m ansible.windows.win_ping

- name: Example from an Ansible Playbook
  ansible.windows.win_ping:

- name: Induce an exception to see what happens
  ansible.windows.win_ping:
    data: crash

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
ping string	success	Value provided with the data parameter. Sample: pong

Status

Authors

• Chris Church (@cchurch)