win_ping - A windows version of the classic ping module
New in version 1.7.
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 ping module instead.
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
data | no | pong | Alternate data to return instead of 'pong'. If this parameter is set to crash , the module will cause an exception. |
Examples
# Test connectivity to a windows host # ansible winserver -m win_ping # Example from an Ansible Playbook - win_ping: # Induce an exception to see what happens - win_ping: data: crash
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
ping | value provided with the data parameter | success | string | pong |
Notes
Note
- For non-Windows targets, use the ping module instead.
Status
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_ping_module.html