napalm_get_facts
=====================

Gathers facts from a network device via the Python module 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>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>dictionary of kwargs arguments to pass to the filter. The outer key is the name of the getter (same as the filter)</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>filter</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>A list of facts to retreive from a device and provided though C(ansible_facts) The list of facts available are maintained at: http://napalm.readthedocs.io/en/latest/support/ Note- not all getters are implemented on all supported device types</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>ignore_notimplemented</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Ignores NotImplementedError for filters which aren't supported by the driver. Returns invalid filters in a list called: not_implemented</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>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>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>username</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Username</td>
			</tr>
	

	</table>


Examples
--------

.. code-block:: yaml

	
	
	
	- name: get facts from device
	
	  napalm_get_facts:
	
	    hostname: '{{ inventory_hostname }}'
	
	    username: '{{ user }}'
	
	    dev_os: '{{ os }}'
	
	    password: '{{ passwd }}'
	
	    filter: ['facts']
	
	  register: result
	
	
	
	- name: print data
	
	  debug:
	
	    var: result
	
	
	
	- name: Getters
	
	  napalm_get_facts:
	
	    provider: "{{ ios_provider }}"
	
	    filter:
	
	      - "lldp_neighbors_detail"
	
	      - "interfaces"
	
	
	
	- name: get facts from device
	
	  napalm_get_facts:
	
	    hostname: "{{ host }}"
	
	    username: "{{ user }}"
	
	    dev_os: "{{ os }}"
	
	    password: "{{ password }}"
	
	    optional_args:
	
	      port: "{{ port }}"
	
	    filter: ['facts', 'route_to', 'interfaces']
	
	    args:
	
	        route_to:
	
	            protocol: static
	
	            destination: 8.8.8.8
	
	
	
	
	



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>whether the command has been executed on the device</td>
				<td>always</td>
				<td>bool</td>
				<td>True</td>
			</tr>
	
			<tr>
				<td>ansible_facts</td>
				<td>Facts gathered on the device provided via C(ansible_facts)</td>
				<td>certain keys are returned depending on filter</td>
				<td>dict</td>
				<td></td>
			</tr>
	
	</table>