Workflow
Juniper JUNOS Device - Example Use Cases - Managed by CLI in IAG
Overview
This Pre-Built Automation bundle contains several example use cases that are applicable when the Itential Automation Platform is integrated with Juniper JUNOS using the device CLI. Because every environment is different, these use cases are fully functioning examples that can be easily modified to operate in your specific environment. These workflows have been written with modularity in mind to make them easy to understand and simple to modify to suit your needs.
Workflows
Name | Overview |
---|---|
Software Upgrade - JUNOS | Upgrade software on a Juniper JUNOS device. |
Port Turn Up - JUNOS | Enable a port on a Juniper JUNOS device |
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 Juniper - JUNOS - IAG has been tested with:
- IAP 2023.2
External Dependencies
Name | OS Version | API Version |
---|---|---|
Itential Automation Gateway (IAG) | ^3.227.0+2023.1.33 |
Adapters
Name | Version | Configuration Notes |
---|---|---|
adapter-automation_gateway | 4.29.0-2023.1.12.0 |
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 - JUNOS
Enable a port on a Juniper JUNOS device
Capabilities include:
- Perform a Pre-Check to verify the port does not already exist
- Perform configuration change dry-run
- Configure the port after optional verification
- Perform a Post-Check to verify the state of the port
Entry Point IAP Component
The primary IAP component to run Port Turn Up - JUNOS is listed below:
IAP Component Name | IAP Component Type | Port Turn Up - JUNOS | Workflow |
---|
Inputs
The following table lists the inputs for Port Turn Up - JUNOS:
Name | Type | Required | Description | Example Value |
---|---|---|---|---|
device | string | yes | Name of the device in IAG | junos_device |
suppressSuccessMessage | boolean | yes | Set to false if want to approve changes before pushing to device | false |
suppressFailureMessage | boolean | yes | Set to false if want to view failure messages before proceeding | false |
interface | string | yes | Interface name | ge-0/0/1 |
cidr | string | yes | CIDR Size | 30 |
subInterface | string | yes | Subinterface unit/id | 1 |
description | string | yes | Interface description | Test |
ipAddress | string | yes | IPv4 Address assigned to the interface | 10.0.0.6 |
vlan | string | yes | VLAN Id | 106 |
Outputs
There are no outputs for Port Turn Up - JUNOS.
Query Output
There are no query output examples for Port Turn Up - JUNOS.
Example Inputs and Outputs
Example 1
Input:
{ "device": "JUNOS", "suppressFailureMessage": false, "suppressSuccessMessage": false, "interface": "ge-0/0/1", "cidr": "30", "subInterface": "1", "description": "test", "ipAddress": "10.0.0.6", "vlan": "106" }
Output:
{}
API Links
No API Links provided.
Software Upgrade - JUNOS
Upgrade software on a Juniper JUNOS device.
Capabilities include:
- Run pre-check commands
- Upgrade software
- Reboot device
- Run post-check commands
Entry Point IAP Component
The primary IAP component to run Software Upgrade - JUNOS is listed below:
IAP Component Name | IAP Component Type | Software Upgrade - JUNOS | Workflow |
---|
Inputs
The following table lists the inputs for Software Upgrade - JUNOS:
Name | Type | Required | Description | Example Value |
---|---|---|---|---|
device | string | yes | Name of the device in IAG to upgrade | JUNOS |
suppressSuccessMessage | boolean | yes | Set to false if want to approve changes before pushing to device | false |
suppressFailureMessage | boolean | yes | Set to false if want to view failure messages before proceeding | false |
directory | string | yes | Directory containing image file | /var/tmp |
fileName | string | yes | Image file used to upgrade | junos-install-vsrx3-x86-64-22.4R2.8.tgz |
Outputs
There are no outputs for Software Upgrade - JUNOS.
Query Output
There are no query output examples for Software Upgrade - JUNOS.
Example Inputs and Outputs
Example 1
Input:
{ "device": "JUNOS", "suppressSuccessMessage": false, "suppressFailureMessage": false, "directory": "/var/tmp", "fileName": "junos-install-vsrx3-x86-64-22.4R2.8.tgz" }
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.