napalm_validate
=====================

Performs deployment validation via 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>data</td>
				<td>False</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>dict to load into the YANG object</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>models</td>
				<td>True</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>List of models to parse Note - data to connect to the device is not necessary when using YANG models</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>
	
			<tr>
				<td>validation_file</td>
				<td>True</td>
				<td>N/A</td>
				<td>N/A</td>
				<td>YAML Validation file containing resources desired states.</td>
			</tr>
	

	</table>


Examples
--------

.. code-block:: yaml

	
	
	
	- name: GET VALIDATION REPORT
	
	  napalm_validate:
	
	    username: "{{ un }}"
	
	    password: "{{ pwd }}"
	
	    hostname: "{{ inventory_hostname }}"
	
	    dev_os: "{{ dev_os }}"
	
	    validation_file: validate.yml
	
	
	
	- name: GET VALIDATION REPORT USING PROVIDER
	
	  napalm_validate:
	
	    provider: "{{ ios_provider }}"
	
	    validation_file: validate.yml
	
	
	
	# USING YANG
	
	- name: Let's gather state of interfaces
	
	  napalm_parse_yang:
	
	    dev_os: "{{ dev_os }}"
	
	    hostname: "{{ hostname }}"
	
	    username: "{{ username }}"
	
	    password: "{{ password }}"
	
	    mode: "state"
	
	    optional_args:
	
	        port: "{{ port }}"
	
	    models:
	
	        - models.openconfig_interfaces
	
	  register: interfaces
	
	
	
	- name: Check all interfaces are up
	
	  napalm_validate:
	
	    data: "{{ interfaces.yang_model }}"
	
	    models:
	
	        - models.openconfig_interfaces
	
	    validation_file: "validate.yaml"
	
	  register: report
	
	
	



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>check to see if a change was made on the device.</td>
				<td>always</td>
				<td>bool</td>
				<td>False</td>
			</tr>
	
			<tr>
				<td>compliance_report</td>
				<td>validation report obtained via napalm.</td>
				<td>always</td>
				<td>dict</td>
				<td></td>
			</tr>
	
	</table>