jsnapy

Execute JSNAPy tests on a Junos device

Synopsis

• Execute Junos SNAPshot Adminsitrator (JSNAPy) tests against a Junos device. JSNAPy is documented on Github and this Day One Book

• This module only reports failed if the module encounters an error and fails to execute the JSNAPy tests. If does NOT report failed if one or more of the JSNAPy tests fail. To check the test results, register the module’s response and use the assert module to verify the expected result in the response. (See Examples.)

• A callback plugin which formats and prints JSNAPy test results for human consumption is also available. This callback plugin is enabled by adding callback_whitelist = jsnapy to the Ansible configuration file.

Requirements

The following software packages must be installed on hosts that execute this module:

• junos-eznc >= 2.5.2

• Python >= 3.5

Module-specific Options

The following options may be specified for this module:

parameter	type	required	default	choices	comments
action	str	yes	none	check snapcheck snap_pre snap_post	The JSNAPy action to perform.
config_file	path	no	none		The filename of a JSNAPy configuration file (in YAML format). The test_files option and the config_file option are mutually exclusive. Either the test_files option or the config_file option is required.
dir	path	no	/etc/jsnapy/testfiles		The path to the directory containing the JSNAPy test file(s) specified by the test_files option or the JSNAPy configuration file specified by the config_file option. aliases: directory
test_files	list of path	no	none		The filename of file(s) in the dir directory. Each file contains JSNAPy test case definitions. The test_files option and the config_file option are mutually exclusive. Either the test_files option or the config_file option is required.

Common Connection-related Options

In addition to the Module-specific Options, the following connection-related options are also supported by this module:

parameter	type	required	default	choices	comments
attempts	int	no	10		The number of times to try connecting and logging in to the Junos device. This option is only applicable when using mode = 'telnet' or mode = 'serial'. Mutually exclusive with the console option.
baud	int	no	9600		The serial baud rate, in bits per second, used to connect to the Junos device. This option is only applicable when using mode = 'serial'. Mutually exclusive with the console option.
console	str	no	none		An alternate method of specifying a NETCONF over serial console connection to the Junos device using Telnet to a console server. The value of this option must be a string in the format --telnet <console_hostname>,<console_port_number>. This option is deprecated. It is present only for backwards compatibility. The string value of this option is exactly equivalent to specifying host with a value of <console_hostname>, mode with a value of telnet, and port with a value of <console_port_number>. Mutually exclusive with the mode, port, baud, and attempts options.
cs_passwd	str	no			The password used to authenticate with the console server over SSH. This option is only required if you want to connect to a device over console using SSH as transport. Mutually exclusive with the console option. aliases: console_password
cs_user	str	no			The username used to authenticate with the console server over SSH. This option is only required if you want to connect to a device over console using SSH as transport. Mutually exclusive with the console option. aliases: console_username
host	str	yes	{{ inventory_hostname }}		The hostname or IP address of the Junos device to which the connection should be established. This is normally the Junos device itself, but is the hostname or IP address of a console server when connecting to the console of the device by setting the mode option to the value telnet. This option is required, but does not have to be specified explicitly by the user because it defaults to {{ inventory_hostname }}. aliases: hostname, ip
mode	str	no	none	none telnet serial	The PyEZ mode used to establish a NETCONF connection to the Junos device. A value of none uses the default NETCONF over SSH mode. Depending on the values of the host and port options, a value of telnet results in either a direct NETCONF over Telnet connection to the Junos device, or a NETCONF over serial console connection to the Junos device using Telnet to a console server. A value of serial results in a NETCONF over serial console connection to the Junos device. Mutually exclusive with the console option.
passwd	str	no	The first defined value from the following list 1) The ANSIBLE_NET_PASSWORD environment variable. (used by Ansible Tower) 2) The value specified using the -k or --ask-pass command line arguments to the ansible or ansible-playbook command. 3) none (An empty password/passphrase)		The password, or ssh key's passphrase, used to authenticate with the Junos device. If this option is not specified, authentication is attempted using an empty password, or ssh key passphrase. aliases: password
port	int or str	no	830 if mode = none, 23 if mode = 'telnet', '/dev/ttyUSB0' if (mode = 'serial')		The TCP port number or serial device port used to establish the connection. Mutually exclusive with the console option.
ssh_config	path	no			The path to the SSH client configuration file. If this option is not specified, then the PyEZ Device instance by default queries file ~/.ssh/config.
ssh_private_key_file	path	no	The first defined value from the following list 1) The ANSIBLE_NET_SSH_KEYFILE environment variable. (used by Ansible Tower) 2) The value specified using the --private-key or --key-file command line arguments to the ansible or ansible-playbook command. 3) none (the file specified in the user's SSH configuration, or the operating-system-specific default)		The path to the SSH private key file used to authenticate with the Junos device. If this option is not specified, and no default value is found using the algorithm below, then the SSH private key file specified in the user's SSH configuration, or the operating-system-specific default is used. This must be in the RSA PEM format, and not the newer OPENSSH format. To check if the private key is in the correct format, issue the command `head -n1 ~/.ssh/some_private_key` and ensure that it's RSA and not OPENSSH. To create a key in the RSA PEM format, issue the command `ssh-keygen -m PEM -t rsa -b 4096`. To convert an OPENSSH key to an RSA key, issue the command `ssh-keygen -p -m PEM -f ~/.ssh/some_private_key` aliases: ssh_keyfile
timeout	int	no	30		The maximum number of seconds to wait for RPC responses from the Junos device. This option does NOT control the initial connection timeout value.
user	str	yes	The first defined value from the following list 1) The ANSIBLE_NET_USERNAME environment variable. (used by Ansible Tower) 2) The remote_user as defined by Ansible. Ansible sets this value via several methods including a) -u or --user command line arguments to the ansible or ansible-playbook command. b) ANSIBLE_REMOTE_USER environment variable. c) remote_user configuration setting. See the Ansible documentation for the precedence used to set the remote_user value. 3) The USER environment variable.		The username used to authenticate with the Junos device. This option is required, but does not have to be specified explicitly by the user due to the algorithm for determining the default value. aliases: username

Common Logging-related Options

In addition to the Module-specific Options, the following logging-related options are also supported by this module:

parameter	type	required	default	choices	comments
level	str	no	WARNING	INFO DEBUG	The level of information to be logged can be modified using this option 1) By default, messages at level WARNING or higher are logged. 2) If the -v or --verbose command-line options to the ansible-playbook command are specified, messages at level INFO or higher are logged. 3) If the -vv (or more verbose) command-line option to the ansible-playbook command is specified, or the ANSIBLE_DEBUG environment variable is set, then messages at level DEBUG or higher are logged. 4) If level is mentioned then messages at level level or more are logged.
logdir	path	no	none		The path to a directory, on the Ansible control machine, where debugging information for the particular task is logged. If this option is specified, debugging information is logged to a file named {{ inventory_hostname }}.log in the directory specified by the logdir option. The log file must be writeable. If the file already exists, it is appended. It is the users responsibility to delete/rotate log files. The level of information logged in this file is controlled by Ansible's verbosity, debug options and level option in task 1) By default, messages at level WARNING or higher are logged. 2) If the -v or --verbose command-line options to the ansible-playbook command are specified, messages at level INFO or higher are logged. 3) If the -vv (or more verbose) command-line option to the ansible-playbook command is specified, or the ANSIBLE_DEBUG environment variable is set, then messages at level DEBUG or higher are logged. 4) If level is mentioned then messages at level level or more are logged. The logfile and logdir options are mutually exclusive. The logdir option is recommended for all new playbooks. aliases: log_dir
logfile	path	no	none		The path to a file, on the Ansible control machine, where debugging information for the particular task is logged. The log file must be writeable. If the file already exists, it is appended. It is the users responsibility to delete/rotate log files. The level of information logged in this file is controlled by Ansible's verbosity, debug options and level option in task 1) By default, messages at level WARNING or higher are logged. 2) If the -v or --verbose command-line options to the ansible-playbook command are specified, messages at level INFO or higher are logged. 3) If the -vv (or more verbose) command-line option to the ansible-playbook command is specified, or the ANSIBLE_DEBUG environment variable is set, then messages at level DEBUG or higher are logged. 4) If level is mentioned then messages at level level or more are logged. When tasks are executed against more than one target host, one process is forked for each target host. (Up to the maximum specified by the forks configuration. See forks for details.) This means that the value of this option must be unique per target host. This is usually accomplished by including {{ inventory_hostname }} in the logfile value. It is the user's responsibility to ensure this value is unique per target host. For this reason, this option is deprecated. It is maintained for backwards compatibility. Use the logdir option in new playbooks. The logfile and logdir options are mutually exclusive. aliases: log_file

Examples

---
- name: Examples of jsnapy
  hosts: junos-all
  connection: local
  gather_facts: no
  collections:
    - juniper.device

  tasks:
    - name: JUNOS Post Checklist
      jsnapy:
        action: "snap_post"
        config_file: "first_test.yml"
        logfile: "migration_post.log"
      register: test1
    - name: Verify all JSNAPy tests passed
      assert:
        that:
          - "test1.passPercentage == 100"
    - name: Print the full test response
      debug:
        var: test1

    - name: Test based on a test_file directly
      jsnapy:
       action: "snapcheck"
       test_files: "tests/test_junos_interface.yaml"
      register: test2
    - name: Verify all JSNAPy tests passed
      assert:
        that:
          - "test2.passPercentage == 100"
    - name: Print the full test response
      debug:
        var: test2

    - name: "Collect Pre Snapshot"
      jsnapy:
        action: "snap_pre"
        test_files: "tests/test_loopback.yml"

    - name: "Collect Post Snapshot"
      jsnapy:
        action: "snap_post"
        test_files: "tests/test_loopback.yml"

    - name: "Check after Pre and Post Snapshots"
      jsnapy:
        action: "check"
        test_files: "tests/test_loopback.yml"
      register: test3
    - name: Verify all JSNAPy tests passed
      assert:
        that:
          - "test3.|succeeded"
          - "test3.passPercentage == 100"
    - name: Print the full test response
      debug:
        var: test3

Return Values

name	description	returned	type	sample
action	The JSNAPy action performed as specified by the action option.	success	str
changed	Indicates if the device's state has changed. Since this module doesn't change the operational or configuration state of the device, the value is always set to false.	success	bool
failed	Indicates if the task failed.	always	bool
msg	A human-readable message indicating the result of the JSNAPy tests.	always	str

Notes

Note

• The NETCONF system service must be enabled on the target Junos device.

Author

• Juniper Networks

• Roslan Zaki

• Damien Garros

• Stacy Smith (@stacywsmith)”

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.