@itentialopensource/junos-file-transfer v0.0.7-2023.1.0

Junos File Transfer

Table of Contents

• Overview
• Installation Prerequisites
• Requirements
• Features
• Future Enhancements
• How to Install
• How to Run
• FAQ
• Additional Information

Overview

This Pre-Built Automation contains a workflow designed to perform file transfer for Junos OS devices orchestrated by NSO. The workflow utilizes the RPC command to execute shell commands such as SSH and SCP on the Junos device.

Estimated Run Time: 10 min. (depends on file size and network speed)

Installation Prerequisites

Users must satisfy the following pre-requisites:

• Itential Automation Platform
  • ^2021.2
• NSO adapter

Requirements

This Pre-Built Automation requires the following:

• Junos OS device
• NSO (with Juno NED)
• SSH Public Key Authentication for device to remote server access

Features

The main benefits and features of the Pre-Built Automation are outlined below.

• Utilize shell commands on the Juno device to perform MD5 and SCP commands
• Validate sufficient storage space before download
• Validate file integrity after download
• Allow zero-touch mode of operation
• Utilizes SSH public key authentication (to remote server) for enhanced security
• Exposes runtime outcome (as a job variable) to parent job

Future Enhancements

Add support for Junos Os devices managed by IAG (Ansible)

How to Install

To install the Pre-Built Automation:

• Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Requirements section in order to install the Pre-Built Automation.
• The Pre-Built Automation can be installed from within App-Admin_Essential. Simply search for the name of your desired Pre-Built and click the install button (as shown below).

How to Run

Use the following to run the Pre-Built Automation: Navigate to the Operations Manager app in IAP, then select to run the JunOS File Transfer Pre-Built. Fill up the form with the following details:

• Zero Touch (checkbox) - eliminate user interactions
• Perform MD5 check (checkbox) - validate file integrity (using MD5) after download
• Device Name - NSO Junos OS device name to perform SCP on
• Local Path - local device file system path to save file (Ex. /var/tmp/)
• Username - remote file server username to be used with SSH and SCP (Ex. user1)
• IP Address - remote file server IP address (Ex. 192.168.240.25)
• Path - remote file server path to file (Ex. /var/opt/)
• File Name - remote file server file to be downloaded (Ex. foo.bar)

FAQ

MD5 verification fails due to copy command timeout

The copy command may timeout when trying to copy large files from the remote server. The following error can appear in NSO logs:

{
  "jsonrpc": "2.0",
  "error": {
    "type": "rpc.method.failed",
    "code": -32000,
    "message": "Method failed",
    "data": {
      "reason": "DEVICE_NAME: transport timeout; closing session"
    },
    "internal": "jsonrpc_schema2181"
}

In order to fix this issue, make sure to give device read-timeout sufficient time to perform the copy command:

admin@ncs% set devices device DEVICE_NAME read-timeout 400
admin@ncs% comm
Commit complete.

Additional Information

Please use your Itential Customer Success account if you need support when using this Pre-Built Automation.