ansible.windows.win_ping module – A windows version of the classic ping module
Note
This module is part of the ansible.windows collection (version 2.5.0).
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
.
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 ansible.builtin.ping module instead.
Parameters
Parameter |
Comments |
---|---|
Alternate data to return instead of ‘pong’. If this parameter is set to Default: |
See Also
See also
- ansible.builtin.ping
Try to connect to host, verify a usable python and return
pong
on success.
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 |
Description |
---|---|
Value provided with the data parameter. Returned: success Sample: |