Workflow
Versa - Modular Workflows
Overview
The integration of Itential and the Versa Networks solution enables network teams to utilize its REST API to build automations that can include common tasks for organization and device management. This is a library of related automations that can be used as modular components in your own larger, end-to-end workflows.
Workflows
| Name | Overview |
|---|---|
| Check Director Version - Versa Director - REST | Retrieve the version of the Versa Director Software Package for compliance checking |
| Check Organization - Versa Director - REST | Check if an organization is present in the Versa Director |
| Create Device Group - Versa Director - REST | Create a new device group in Versa Director |
| Create New Organization - Versa Director - REST | Create a new organization in Versa Director |
| Create Spoke Group - Versa Director - REST | Create a new spoke group in Versa Director |
| Deploy Device - Versa Director - REST | Deploy a device in Versa Director |
For further technical details on how to install and use this Workflow Project, please click the Technical Documentation tab.
Table of Contents
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 Versa - REST has been tested with:
- IAP 2023.2
External Dependencies
No external dependencies required to run this Workflow Project.
Adapters
| Name | Version | Configuration Notes |
|---|---|---|
| adapter-versa_director | 0.11.4 |
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.
Check Director Version - Versa Director - REST
Retrieve the version of the Versa Director Software Package for compliance checking
Capabilities include:
- Retrieve the version of the Versa Director Software Package
- Check version compliance
Entry Point IAP Component
The primary IAP component to run Check Director Version - Versa Director - REST is listed below:
| IAP Component Name | IAP Component Type | Check Director Version - Versa Director - REST | Workflow |
|---|
Inputs
The following table lists the inputs for Check Director Version - Versa Director - REST:
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| version | string | yes | Source IP address in path lookup | 20.2.2 |
| allowNewer | boolean | yes | Whether versions newer than the specified version are consider compliant | true |
| adapterId | string | yes | Versa Director adapter instance to be used | Versa |
Outputs
The following table lists the outputs for Check Director Version - Versa Director - REST:
| Name | Type | Description | Example Value |
|---|---|---|---|
| comply | boolean | Whether the version complies | false |
Query Output
The following items show how to query successful results from the output of Check Director Version - Versa Director - REST:
Compliance Check Result
comply
Example Inputs and Outputs
Example 1
Input:
{
"adapterId": "versa",
"version": "20.2.1",
"allowNewer": true
} Output:
{
"requestedVersionLength": 3,
"comply": true
} Example 2
Input:
{
"adapterId": "versa",
"version": "20.3.2",
"allowNewer": true
} Output:
{
"requestedVersionLength": 3,
"comply": false
} API Links
No API Links provided.
Check Organization - Versa Director - REST
Check if an organization is present in the Versa Director
Capabilities include:
- Retrieve organization list and check if the provided organization is present in Versa Dirctor
Entry Point IAP Component
The primary IAP component to run Check Organization - Versa Director - REST is listed below:
| IAP Component Name | IAP Component Type | Check Organization - Versa Director - REST | Workflow |
|---|
Inputs
The following table lists the inputs for Check Organization - Versa Director - REST:
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| organizationName | string | yes | Name of the organization to check for existence | orgA |
| adapterId | string | yes | Versa Director adapter instance to be used | Versa |
Outputs
The following table lists the outputs for Check Organization - Versa Director - REST:
| Name | Type | Description | Example Value |
|---|---|---|---|
| orgNameExists | boolean | Whether the organization exists in Versa | false |
Query Output
The following items show how to query successful results from the output of Check Organization - Versa Director - REST:
Organization Check Result
orgNameExists
Example Inputs and Outputs
Example 1
Input:
{
"organizationName": "orgA",
"adapterId": "versa"
} Output:
{
"orgNameExists": true
} Example 2
Input:
{
"organizationName": "orgC",
"adapterId": "versa"
} Output:
{
"orgNameExists": false
} API Links
No API Links provided.
Create Device Group - Versa Director - REST
Create a new device group in Versa Director
Capabilities include:
- Check existence of a provided device group and create one if none exists
Entry Point IAP Component
The primary IAP component to run Create Device Group - Versa Director - REST is listed below:
| IAP Component Name | IAP Component Type | Create Device Group - Versa Director - REST | Workflow |
|---|
Inputs
The following table lists the inputs for Create Device Group - Versa Director - REST:
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| deviceGroupName | string | yes | Name of the device group to be created | Multi_Tenant_DeviceGroup |
| description | string | no | A brief description or additional info about the device group | Device Group having multi tenant branches |
| organizationName | string | yes | Name of the organization associated with the device group | Tenant1 |
| string | yes | admin@versa-networks.com | ||
| phone | string | yes | Phone number | 408-480-4800 |
| postStagingTemplate | string | yes | The template used for post-staging configurations | controller1poststaging |
| stagingType | string | yes | Type of staging used | pre_staging |
| stagingController | string | yes | The controller that manages the staging process for devices in a device group | Controller1 |
| vnpProfileName | string | yes | Name of the VPN profile | wan1-staging1-StagingIpSec |
| caConfigOnBranchNotification | boolean | yes | Whether to configure CA on branch notification | true |
| enableStagingUrl | boolean | yes | Whether staging URL is enabled | true |
| enable2FactorAuth | boolean | yes | Whether Two-Factor Authentication is enabled | true |
| enableOneTimePassword | boolean | yes | Whether one-time passwword is enabled | true |
| adapterId | string | yes | Versa Director adapter instance to be used | versa |
Outputs
The following table lists the outputs for Create Device Group - Versa Director - REST:
| Name | Type | Description | Example Value |
|---|---|---|---|
| createdDG | object | Created device group result |
Query Output
There are no query output examples for Create Device Group - Versa Director - REST.
Example Inputs and Outputs
Example 1
Input:
{
"deviceGroupName": "Multi_Tenant_DeviceGroup",
"adapterId": "versa",
"organizationName": "Tenant1",
"email": "admin@versa-networks.com",
"phone": "408-480-4800",
"postStagingTemplate": "controller1poststaging",
"stagingType": "pre_statging",
"stagingController": "Controller1",
"vnpProfileName": "wan1-staging1-StagingIpSec",
"caConfigOnBranchNotification": true,
"enableStagingUrl": true,
"enable2FactorAuth": true,
"enableOneTimePassword": true,
"description": "Device Group having multi tenant branches"
} API Links
No API Links provided.
Create New Organization - Versa Director - REST
Create a new organization in Versa Director
Capabilities include:
- Create a new organization in Versa Director
Entry Point IAP Component
The primary IAP component to run Create New Organization - Versa Director - REST is listed below:
| IAP Component Name | IAP Component Type | Create New Organization - Versa Director - REST | Workflow |
|---|
Inputs
The following table lists the inputs for Create New Organization - Versa Director - REST:
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| ikeAuthType | string | yes | Authentication type used for IKE (Internet Key Exchange) protocol | PSK |
| vrfs | array | yes | List of Virtual Routing and Forwarding (VRF) instances configured for the organization. Each object within the "vrfs" array contains "name", "id", "description", "enableVPN", and "mode" | |
| supportedRole | array | yes | List of the roles supported within the organization | |
| analyticsClusters | array | yes | A list of names of analytics clusters associated with the organization | |
| cmsConnectors | array | yes | List of CMS connectors | |
| parentOrganization | string | yes | Parent organization to which the organization being created belongs | |
| organizationName | string | yes | Name of the organization being created | orgA |
| cpeDeploymentType | string | yes | Type of CPE (Customer Premises Equipment) deployment for the organization | |
| controllers | array | yes | List of the controllers | |
| sharedControlPlane | boolean | yes | Whether the organization shares a control plane with other organizations | true |
| adapterId | string | yes | Versa Director adapter instance to be used | Versa |
Outputs
There are no outputs for Create New Organization - Versa Director - REST.
Query Output
There are no query output examples for Create New Organization - Versa Director - REST.
Example Inputs and Outputs
No example inputs or outputs found.
API Links
No API Links provided.
Create Spoke Group - Versa Director - REST
Create a new spoke group in Versa Director
Capabilities include:
- Create a new spoke group in Versa Director
Entry Point IAP Component
The primary IAP component to run Create Spoke Group - Versa Director - REST is listed below:
| IAP Component Name | IAP Component Type | Create Spoke Group - Versa Director - REST | Workflow |
|---|
Inputs
The following table lists the inputs for Create Spoke Group - Versa Director - REST:
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| spokeGroupName | string | yes | The Name of the Spoke Group being created | SG1 |
| organization | string | yes | The Organization for which the Spoke Group is being created | orgA |
| hubType | string | yes | Type of hub | hub |
| region | string | yes | Region to which the spoke group belongs | west |
| vrfs | array | yes | List of Virtual Routing and Forwarding (VRF) instances. Each object within the "vrfs" array contains "name", "groupType", "communityRef", and "hubs" | [
{
"communityRef": 5,
"groupType": "HubAndSpoke",
"hubs": [
{
"name": "hub34",
"priority": 3
}
],
"name": "provider-org-vr"
}
] |
| adapterId | string | yes | Versa Director adapter instance to be used | Versa |
Outputs
There are no outputs for Create Spoke Group - Versa Director - REST.
Query Output
There are no query output examples for Create Spoke Group - Versa Director - REST.
Example Inputs and Outputs
Example 1
Input:
{
"spokeGroupName": "SpokeGroup1",
"adapterId": "versa",
"organization": "orgA",
"hubType": "hub",
"region": "west",
"vrfs": [
{
"communityRef": "5",
"groupType": "HubAndSpoke",
"hubs": [
{
"name": "hub34",
"priority": 3
}
],
"name": "provider-org-vr"
}
]
} API Links
No API Links provided.
Deploy Device - Versa Director - REST
Deploy a device in Versa Director
Capabilities include:
- Deploy a device in Versa Director
Entry Point IAP Component
The primary IAP component to run Deploy Device - Versa Director - REST is listed below:
| IAP Component Name | IAP Component Type | Deploy Device - Versa Director - REST | Workflow |
|---|
Inputs
The following table lists the inputs for Deploy Device - Versa Director - REST:
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| device | string | yes | Name of the device to be deployed | Device01 |
| adapterId | string | yes | Versa Director adapter instance to be used | Versa |
Outputs
The following table lists the outputs for Deploy Device - Versa Director - REST:
| Name | Type | Description | Example Value |
|---|---|---|---|
| status | string | Deploy device result | FAILED |
Query Output
The following items show how to query successful results from the output of Deploy Device - Versa Director - REST:
Deploy Device Result
status
Example Inputs and Outputs
Example 1
Input:
{
"device": "device01",
"adapterId": "versa"
} Output:
{
"status": "SUCCESS"
} 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.