1.. _ansible.windows.win_ping_module:
2
3
4************************
5ansible.windows.win_ping
6************************
7
8**A windows version of the classic ping module**
9
10
11
12.. contents::
13   :local:
14   :depth: 1
15
16
17Synopsis
18--------
19- Checks management connectivity of a windows host.
20- This is NOT ICMP ping, this is just a trivial test module.
21- For non-Windows targets, use the :ref:`ansible.builtin.ping <ansible.builtin.ping_module>` module instead.
22
23
24
25
26Parameters
27----------
28
29.. raw:: html
30
31    <table  border=0 cellpadding=0 class="documentation-table">
32        <tr>
33            <th colspan="1">Parameter</th>
34            <th>Choices/<font color="blue">Defaults</font></th>
35            <th width="100%">Comments</th>
36        </tr>
37            <tr>
38                <td colspan="1">
39                    <div class="ansibleOptionAnchor" id="parameter-"></div>
40                    <b>data</b>
41                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
42                    <div style="font-size: small">
43                        <span style="color: purple">string</span>
44                    </div>
45                </td>
46                <td>
47                        <b>Default:</b><br/><div style="color: blue">"pong"</div>
48                </td>
49                <td>
50                        <div>Alternate data to return instead of &#x27;pong&#x27;.</div>
51                        <div>If this parameter is set to <code>crash</code>, the module will cause an exception.</div>
52                </td>
53            </tr>
54    </table>
55    <br/>
56
57
58
59See Also
60--------
61
62.. seealso::
63
64   :ref:`ansible.builtin.ping_module`
65      The official documentation on the **ansible.builtin.ping** module.
66
67
68Examples
69--------
70
71.. code-block:: yaml
72
73    # Test connectivity to a windows host
74    # ansible winserver -m ansible.windows.win_ping
75
76    - name: Example from an Ansible Playbook
77      ansible.windows.win_ping:
78
79    - name: Induce an exception to see what happens
80      ansible.windows.win_ping:
81        data: crash
82
83
84
85Return Values
86-------------
87Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
88
89.. raw:: html
90
91    <table border=0 cellpadding=0 class="documentation-table">
92        <tr>
93            <th colspan="1">Key</th>
94            <th>Returned</th>
95            <th width="100%">Description</th>
96        </tr>
97            <tr>
98                <td colspan="1">
99                    <div class="ansibleOptionAnchor" id="return-"></div>
100                    <b>ping</b>
101                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
102                    <div style="font-size: small">
103                      <span style="color: purple">string</span>
104                    </div>
105                </td>
106                <td>success</td>
107                <td>
108                            <div>Value provided with the data parameter.</div>
109                    <br/>
110                        <div style="font-size: smaller"><b>Sample:</b></div>
111                        <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">pong</div>
112                </td>
113            </tr>
114    </table>
115    <br/><br/>
116
117
118Status
119------
120
121
122Authors
123~~~~~~~
124
125- Chris Church (@cchurch)
126