.. _junos_jsnapy:


junos_jsnapy
++++++++++++

:Author: Roslan Zaki & Damien Garros, Juniper Networks

.. contents::
   :local:
   :depth: 1

Synopsis
--------

.. versionadded:: 1.4.0

Execute JSNAPy test from Ansible. Attention, to not break Ansible behavior, this module only report "failed" if the module itself fails, not if a test fails. To check the test results you need to subscribe to the result and assert the returned value. An experimental Callback_Plugin for junos_jsnapy is available to provide additional information about tests that failed. To enable it, you need to add "callback_whitelist = jsnapy" in your ansible configuration file.

Options
-------

.. raw:: html

    <table border=1 cellpadding=4>
    <tr>
    <th class="head">parameter</th>
    <th class="head">required</th>
    <th class="head">default</th>
    <th class="head">choices</th>
    <th class="head">comments</th>
    </tr>
            <tr>
    <td>action</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Possible actions available - jsnapcheck - check - snap_pre - snap_post</td>
    </tr>
            <tr>
    <td>config_file</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>The YAML configuration file for the JSNAPy tests</td>
    </tr>
            <tr>
    <td>dir</td>
    <td>no</td>
    <td>/etc/jsnapy/testfiles</td>
        <td><ul></ul></td>
        <td>Path for the JSNAPy yaml testfiles/configuration file</td>
    </tr>
            <tr>
    <td>host</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Set to {{ inventory_hostname }}</td>
    </tr>
            <tr>
    <td>logfile</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Path on the local server where the progress status is logged for debugging purposes</td>
    </tr>
            <tr>
    <td>mode</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>mode of console connection (telnet/serial). If mode is not provided SSH connection is used.</td>
    </tr>
            <tr>
    <td>passwd</td>
    <td>no</td>
    <td>assumes ssh-key active</td>
        <td><ul></ul></td>
        <td>Login password</td>
    </tr>
            <tr>
    <td>port</td>
    <td>no</td>
    <td>830</td>
        <td><ul></ul></td>
        <td>port number to use when connecting to the device</td>
    </tr>
            <tr>
    <td>ssh_private_key_file</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>This can be used if you need to provide a private key rather than loading the key into the ssh-key-ring/environment.  if your ssh-key requires a password, then you must provide it via **passwd**</td>
    </tr>
            <tr>
    <td>test_files</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Test files which need to executed</td>
    </tr>
            <tr>
    <td>user</td>
    <td>no</td>
    <td>$USER</td>
        <td><ul></ul></td>
        <td>Login username</td>
    </tr>
        </table>


.. note:: Requires junos-eznc >= 1.2.2


Examples
--------

.. raw:: html

    <br/>


::

    
       - name: JUNOS Post Checklist
         junos_jsnapy:
           host: "{{ inventory_hostname}}"
           passwd: "{{ tm1_password }}"
           action: "snap_post"
           config_file: "first_test.yml"
           logfile: "migration_post.log"
         register: test1
    
       - name: Check JSNAPy tests results
         assert:
         that:
           - "test1.passPercentage == 100"
    
       - name: Debug jsnapy
         debug: msg=test1
    
    ---------
       - name: Test based on a test_file directly
         junos_jsnapy:
           host: "{{ junos_host }}"
           port: "{{ netconf_port }}"
           user: "{{ ansible_ssh_user }}"
           passwd: "{{ ansible_ssh_pass }}"
           test_files: tests/test_junos_interface.yaml
           action: snapcheck
         register: test1
    
       - name: Check JSNAPy tests results
         assert:
         that:
           - "test1.passPercentage == 100"
    ---------
       - name: "Collect Pre Snapshot"
        junos_jsnapy:
          host: "{{ junos_host }}"
          port: "{{ netconf_port }}"
          user: "{{ ansible_ssh_user }}"
          passwd: "{{ ansible_ssh_pass }}"
          test_files: tests/test_loopback.yml
          action: snap_pre
        register: test_pre
    
    ---------
      - name: "Collect Post Snapshot"
        junos_jsnapy:
          host: "{{ junos_host }}"
          port: "{{ netconf_port }}"
          user: "{{ ansible_ssh_user }}"
          passwd: "{{ ansible_ssh_pass }}"
          test_files: tests/test_loopback.yml
          action: snap_post
        register: test_post
    
    ---------
      - name: "Check after PRE - POST check"
        junos_jsnapy:
          host: "{{ junos_host }}"
          port: "{{ netconf_port }}"
          user: "{{ ansible_ssh_user }}"
          passwd: "{{ ansible_ssh_pass }}"
          test_files: tests/test_loopback.yml
          action: check
        register: test_check
    
        - name: Check Results
          assert:
            that:
              - test_check|succeeded
              - test_check.passPercentage == 100