napalm_parse_yang
=====================

Parse configuration/state from a file or device and returns a dict that


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>dev_os</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>OS of the device</td>
			</tr>
	
			<tr>
				<td>file_path</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Path to a file to load native config/state from. Note: Either file_path or data to connect to a device must be provided. Note: file_path takes precedence over a live 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>mode</td>
				<td>True</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>Whether to parse config/state or both. Note: `both` is not supported in combination with `file_path`.</td>
			</tr>
	
			<tr>
				<td>models</td>
				<td>True</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>A list that should match the SUPPORTED_MODELS in napalm-yang</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>profiles</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>A list profiles</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 if we want to parse from a device 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: Parse from device
	
	  napalm_parse_yang:
	
	    hostname: '{{ inventory_hostname }}'
	
	    username: '{{ user }}'
	
	    dev_os: '{{ os }}'
	
	    password: '{{ passwd }}'
	
	    mode: "config"
	
	    profiles: ["eos"]
	
	    models:
	
	        - models.openconfig_interfaces
	
	  register: running
	
	
	
	- name: Parse from file
	
	  napalm_parse_yang:
	
	    file_path: "eos.config"
	
	    mode: "config"
	
	    profiles: ["eos"]
	
	    models:
	
	        - models.openconfig_interfaces
	
	  register: config
	
	
	



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>Dict the representes a valid YANG object</td>
				<td>always</td>
				<td>dict</td>
				<td>{'interfaces': {'interface':'Et1': {...}, ... }}</td>
			</tr>
	
	</table>