@itentialopensource/command-template-runner v0.0.9-2023.1.0

Command Template Runner

Table of Contents

• Overview
• Installation Prerequisites
• Requirements
• Features
• How to Install
• Input Variables
• How to Run

Overview

This pre-built is a light solution to provide the ability for command templates to be run with little external assitance. More specifically, this solution provides built-in error handling that allows for retrying if necessary. This is necessary for workflows that may utilize multiple different command templates and reduces the need for further input. This workflow is intended to be run in a workflow through a ChildJob task, requiring an existing command template that needs to be run in a workflow as well as the device to run the command template on.

This solution consists of the following:

• Workflow (Command Template Runner)

Estimated Run Time: 0-10 minutes (largely dependent on the Command Template that is being run)

Installation Prerequisites

Users must satisfy the following pre-requisites:

• Itential Automation Platform
  • ^2022.1.x

Requirements

This pre-built requires the following:

• Existing command templates
• A workflow that requires the utilization of command templates

Features

The main benefits and features of the pre-built are outlined below.

• Provides a standardized method of running command templates with little input
• Sufficient error handling to allow the user to see errors and retry if desired
• Two modes of operation: Zero-Touch and Verbose

• Proper outcome variables so that the parent workflow can easily handle the command template results

  Example Scenarios:

• Upgrading a device - install all [...]

• Checking device version - show version
• Check device contents - show dir
• Verify device contents - install verify packages
• Remove device packages - install remove inactive all

How to Install

To install the pre-built:

• 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.
• The pre-built can be installed from within Admin Essentials app. Simply search for the name of your desired pre-built and click the install button (as shown below).

Input Variables

• Template Name - A string containing the name of the command template
• Template Variables - An object containing the variables to be used by the command template
• Devices - An array of strings containing the name(s) of the target device(s) on which the command template will be executed against
• Zero Touch - A boolean to determine whether or not the command template results should be shown
• Failure Type - A string variable to display the severity of failure in the case the command template does not pass (e.g. skip or abort)

Example:

{
  "templateName": "Cisco NX-OS Upgrade - Pre Checks",
  "templateVariables": {
    "variable1": "variable1",
    "variable2": "variable2"
  },
  "devices": [
    "device1",
    "device2",
    "device3"
  ],
  "zeroTouch": true,
  "failureType": "abort"
}

How to Run

• Navigate to any workflow that necessitates the use of a command template
• Place the ChildJob task on the canvas
• Select Command Template Runner and fill in the variables as desired, ensuring that the input command template name exists in the environment
• Run the workflow as desired