@itentialopensource/ansible-port-turn-up NPM

Artifact Name

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

Overview

The Port Turn Up Pre-Built consists of several workflows and command templates meant to serve as a solution for performing a port turn up on Cisco routers running IOS software. In this Pre-Built, we are using Itential Automation Gateway (IAG) as the network orchestrator. The included pre and post checks should be customized to suit the needs of the target device. Additionally, the implementation of routing network traffic is left up to the user to provide. The Pre-Built provides an indication of where a failover and restore should take place, but assumes no responsibility for these tasks.

The Pre-Built consist of following:

Automation Catalog(IAP Artifacts Port Turn Up Ansible)
WorkFlow(IAP Artifacts Port Turn Up Ansible)
WorkFlow(IAP Artifacts Port Turn Up Ansible Deployment)
Command Template(IAP-Artifacts Port Turn Up Post-Check)
Command Template(IAP-Artifacts Port Turn Up Pre-Check)

Installation Prerequisites

In order to use the Port Turn Up Pre-Built, users will have to satisfy the following pre-requisites:

Itential Automation Platform
- ^2023.1.x
Itential Automation Gateway
- ^3.227.0+2023.1.15

Requirements

Cisco IOS Device

Features

Automatically checks for device type
Displays dry-run to user (asking for confirmation) prior to pushing config to the device
Turns up interface and changes IpAddress and Description

Future Enhancements

Provide support for different device operation system types like, IOSXR, Arista, F5, Nokia and etc

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 App-Admin_Essential. Simply search for the name of your desired Pre-Built and click the install button.

Alternatively, you may clone this repository and run npm pack to create a tarball which can then be installed via the offline installer in App-Artifacts. Please consult the documentation for App-Artifacts for further information.

How to Run

Use the following to run this artifact:

This Pre-Built may be run from Operations Manager by clicking Run for the IAP Pre-Built Port Turn UP JSON Form. The user will be presented with a form to select options customize which device type, interface type, IP Address and subnet mask. A description is requred to run this artifact. The shutdown option is to turn down the device.