napalm_ping
=====================

This module logs into the device, issues a ping request, and returns the response


Parameters
----------

.. raw:: html

	<table border="1" class="docutils">
		<th>Parameter</th>
		<th>Required</th>
		<th>Default</th>
		<th>Choices</th>
		<th>Description</th>
	
			<tr>
				<td>count</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>N</td>
			</tr>
	
			<tr>
				<td>destination</td>
				<td>True</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>H</td>
			</tr>
	
			<tr>
				<td>dev_os</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>OS of the device</td>
			</tr>
	
			<tr>
				<td>hostname</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>IP or FQDN of the device you want to connect to</td>
			</tr>
	
			<tr>
				<td>optional_args</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Dictionary of additional arguments passed to underlying driver</td>
			</tr>
	
			<tr>
				<td>password</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Password</td>
			</tr>
	
			<tr>
				<td>ping_timeout</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>M</td>
			</tr>
	
			<tr>
				<td>provider</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Note - hostname, username, password and dev_os must be defined in either provider or local param Note - local param takes precedence, e.g. hostname is preferred to provider['hostname']</td>
			</tr>
	
			<tr>
				<td>size</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>S</td>
			</tr>
	
			<tr>
				<td>source</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>S</td>
			</tr>
	
			<tr>
				<td>source_interface</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>i</td>
			</tr>
	
			<tr>
				<td>timeout</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Time in seconds to wait for the device to respond</td>
			</tr>
	
			<tr>
				<td>ttl</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>M</td>
			</tr>
	
			<tr>
				<td>username</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Username</td>
			</tr>
	
			<tr>
				<td>vrf</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>v</td>
			</tr>
	

	</table>


Examples
--------

.. code-block:: yaml

	
	
	
	- napalm_ping:
	
	    hostname: "{{ inventory_hostname }}"
	
	    username: "napalm"
	
	    password: "napalm"
	
	    dev_os: "eos"
	
	    destination: 10.0.0.5
	
	    vrf: MANAGEMENT
	
	    count: 2
	
	
	
	- napalm_ping:
	
	    provider: "{{ napalm_provider }}"
	
	    destination: 8.8.8.8
	
	    count: 2
	
	
	



Return
------
.. raw:: html

	<table border="1" class="docutils">
		<th>Name</th>
		<th>Description</th>
		<th>Returned</th>
		<th>Type</th>
		<th>Sample</th>
	
			<tr>
				<td>changed</td>
				<td>ALWAYS RETURNS FALSE</td>
				<td>always</td>
				<td>bool</td>
				<td>True</td>
			</tr>
	
			<tr>
				<td>results</td>
				<td>structure response data of ping</td>
				<td>always</td>
				<td>dict</td>
				<td>{"success": {"packet_loss": 0, "probes_sent": 2, "results": [{"ip_address": "10.0.0.5:", "rtt": 1.71}, {"ip_address": "10.0.0.5:", "rtt": 0.733}], "rtt_avg": 1.225, "rtt_max": 1.718, "rtt_min": 0.733, "rtt_stddev": 0.493}}</td>
			</tr>
	
			<tr>
				<td>alt_results</td>
				<td>Example results key on failure</td>
				<td>always</td>
				<td>dict</td>
				<td>{"error": "connect: Network is unreachable "}}</td>
			</tr>
	
	</table>