ansible.windows.win_ping – A windows version of the classic ping module
From Get docs
Ansible/docs/2.11/collections/ansible/windows/win ping module
ansible.windows.win_ping – A windows version of the classic ping module
Note
This plugin is part of the ansible.windows collection (version 1.3.0).
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 | Choices/Defaults | Comments |
---|---|---|
data string |
Default: "pong" |
Alternate data to return instead of 'pong'. If this parameter is set to |
See Also
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 |
Authors
- Chris Church (@cchurch)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/windows/win_ping_module.html