napalm_cli
=====================

Executes network device CLI commands and returns response using NAPALM


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>args</td>
				<td>True</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Keyword arguments to pass to the `cli` method</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>password</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Password</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>username</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Username</td>
			</tr>
	

	</table>


Examples
--------

.. code-block:: yaml

	
	
	
	- napalm_cli:
	
	    hostname: "{{ inventory_hostname }}"
	
	    username: "napalm"
	
	    password: "napalm"
	
	    dev_os: "eos"
	
	    args:
	
	        commands:
	
	            - show version
	
	            - show snmp chassis
	
	
	
	- napalm_cli:
	
	    provider: "{{ napalm_provider }}"
	
	    args:
	
	        commands:
	
	            - show version
	
	            - show snmp chassis
	
	
	



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>string of command output</td>
				<td>always</td>
				<td>dict</td>
				<td>{ "show snmp chassis": "Chassis: 1234 ", "show version": "Arista vEOS Hardware version: Serial number: System MAC address:  0800.27c3.5f28\nSoftware image version: 4.17.5M Architecture:           i386 Internal build version: 4.17.5M-4414219.4175M Internal build ID:      d02143c6-e42b-4fc3-99b6-97063bddb6b8\nUptime:                 1 hour and 21 minutes Total memory:           1893416 kB Free memory:            956488 kB\n"  # noqa }</td>
			</tr>
	
	</table>