Note
This plugin is part of the ansible.windows collection (version 1.7.3).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ansible.windows
.
To use it in a playbook, specify: ansible.windows.win_ping
.
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
The official documentation on the ansible.builtin.ping module.
# 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
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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/windows/win_ping_module.html