@itentialopensource/versa-device-onboarding-workfl

Versa Device Onboarding Workflow

Overview
Requirements
Features
How to Install
How to Run
Additional Information

Overview

This pre-built is used to onboard a new device in Versa Director.

Requirements

This Pre-Built requires the following:

Itential Automation Platform
- ^2023.1
A running instance of the Itential OpenSource Versa Director adapter, which can be installed from here.

Features

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

Every Itential Pre-built is designed to optimize network performance and configuration by focusing on reliability, flexibility and coordination of network changes with applications and IT processes. As the network evolves, Pre-builts allow customers to focus on effective management and compliance to minimize risks of disruption and outage that can negatively impact quality of service.

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 (as shown below).

How to Run

Use the following to run the Pre-Built:

The pre-built can be run as a standalone or as part of a parent job.

To run it as a standalone job, run the respective job from Operations Manager with the necessary JSON form.
The workflow or the job can also be used as part of another parent job.

The description of the formdata needed by the prebuilt is given below: The required values to be passed on are:

Versa Adapter ID: The adapter of Versa installed on IAP.

Name: Name of the device to be onboarded.\ Global Device ID: This is an automated value provided to uniquely identify the device that is onboarded.\ Organization: The organization to be attached to the device onboarded.\ Deployment Type: This identifies how the device is deployed as

Full Mesh: The device will establish the Data tunnels with all other devices in the tenant
Hub: The device will be onboarded as a Hub device that other Spokes in the region can use to connect to each other
Spoke: The device will be onboarded as a Spoke device and automatically connect to other Spokes directly or via a Hub in that region based on VRF priorities.

Serial Number: Hardware Serial Number of the device that is onboarded.\ Service Bandwidth: The bandwidth for which the specific device will be entitled to (multiple options can be selected to get to specific BW tier).

Device group: The name of the device group that this device will belong to (that way it can get the mapped configuration template automatically).\ Location information: The address of the location where the device will be onboarded at.\ Device service templates: The service level configuration template which describes specific set of services which can be mapped to the device being.onboarded.

Data Binding for Post staging template and Service template: Values for variables that are identified in each of the templates associated with the device.

Versa instance

The above onboarded device can be verified on the versa instance by logging in using the credentials provided.\ After logging in, select the workflows tab, choose 'Devices' from the left pane to view all the devices onboarded.

Click on the device onboarded to verify all the basic information, bind data and device service template details etc.,