Table of Contents

• Getting Started
  • Helpful Background Information
  • Prerequisites
  • External Dependencies
  • Adapters
  • How to Install
  • Testing
• Using this Workflow Project
  • Port Turn Up - IOS - IAG
  • Software Upgrade - IOS - IAG
• Additional Information
  • Support

Getting Started

This section is helpful for deployments as it provides you with pertinent information on prerequisites and properties.

Helpful Background Information

Workflows often include logic that varies from business to business. As a result, we often find that our Workflow Projects are more useful as modular components that can be incorporated into a larger process. In addition, they often can add value as a learning tool on how we integrate with other systems and how we do things within the Itential Automation Platform.

While these can be utilized, you may find more value in using them as a starting point to build around.

Prerequisites

Itential Workflow Projects are built and tested on particular versions of IAP. In addition, Workflow Projects are often dependent on external systems and as such, these Workflow Projects will have dependencies on these other systems. This version of Cisco - IOS - IAG has been tested with:

• IAP 2023.1

External Dependencies

Adapters

How to Install

To install the Workflow Project:

• Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Supported IAP Versions section in order to install the Example Project.
• Import the Example Project in Admin Essentials.

Testing

Cypress is generally used to test all Itential Example Projects. While Cypress is an opensource tool, at Itential we have internal libraries that have been built around Cypress to allow us to test with a deployed IAP.

When certifying our Example Projects for a release of IAP we run these tests against the particular version of IAP and create a release branch in GitLab. If you do not see the Example Project available in your version of IAP please contact Itential.

While Itential tests this Example Project and its capabilities, it is often the case the customer environments offer their own unique circumstances. Therefore, it is our recommendation that you deploy this Example Project into a development/testing environment in which you can test the Example Project.

Using this Workflow Project

Workflow Projects contain 1 or more workflows. Each of these workflows have different inputs and outputs.

Port Turn Up - IOS - IAG

This example use case automates the configuration changes necessary to enable and activate a port on a Cisco IOS network device.

Capabilities include:

• Perform a Pre-Check to verify the port does not already exist
• Configure the port
• Perform a Post-Check to verify the state of the port
• Optionally display a diff of the Pre-Check and Post-Check to the user

Entry Point IAP Component

The primary IAP component to run Port Turn Up - IOS - IAG is listed below:

Inputs

The following table lists the inputs for Port Turn Up - IOS - IAG:

CSR1-1696619098000

false

false

GigabitEthernet

2

400

Test Interface 2.400

20.10.30.1

400

255.255.255.252

Outputs

There are no outputs for Port Turn Up - IOS - IAG.

Query Output

There are no query output examples for Port Turn Up - IOS - IAG.

Example Inputs and Outputs

Example 1

Input:

{
  "device": "IOS",
  "suppressFailureMessage": false,
  "suppressSuccessMessage": false,
  "type": "GigabitEthernet",
  "interface": 2,
  "subInterface": "400",
  "description": "Test Interface 2.400",
  "ipAddress": "20.10.30.1",
  "vlan": "400",
  "subnetMask": "255.255.255.252"
} 

Output:

{} 

API Links

No API Links provided.

Software Upgrade - IOS - IAG

This example use case automates the procedure of upgrading the firmware (software) on a Cisco IOS network device.

Capabilities include:

• Verify current software version and check if the image file used for upgrade is on the device
• Run pre-check commands
• Change the boot system image
• Reload the device
• Verify the new IOS image is now active on the device after reload
• Run post-check commands
• Show the difference between the pre-check and post-check results if autoApprove is not set

Entry Point IAP Component

The primary IAP component to run Software Upgrade - IOS - IAG is listed below:

Inputs

The following table lists the inputs for Software Upgrade - IOS - IAG:

IOS

false

false

csr1000v-universalk9.03.10.03.S.153-3.S3-ext.SPA.bin

bootflash:

Outputs

There are no outputs for Software Upgrade - IOS - IAG.

Query Output

There are no query output examples for Software Upgrade - IOS - IAG.

Example Inputs and Outputs

Example 1

Input:

{
  "device": "IOS",
  "suppressFailureMessage": false,
  "suppressSuccessMessage": false,
  "version": "csr1000v-universalk9.03.10.03.S.153-3.S3-ext.SPA.bin", 
  "flashMemory": "bootflash:"
} 

Output:

{} 

API Links

No API Links provided.

Additional Information

Support

Please use your Itential Customer Success account if you need support when using this Workflow Project.