Pre-Built Name

Table of Contents

• Pre-Built Name
  • Table of Contents
  • Overview
  • Supported IAP Versions
  • Getting Started
    • Prerequisites
    • Capabilities
    • How to Install
    • Testing
  • Using this Pre-Built
    • Input Schema
    • Output Schema
  • Additional Information

Overview

The Pre-Built Name pre-built is used for a repeatable task to automate your network operations.

• Estimated Run Time: < 1 minute

Supported IAP Versions

Itential pre-builts are built and tested on particular versions of IAP. In addition, pre-builts that work with devices are often dependent on certain orchestration systems (e.g. NSO and IAG). As such, these pre-builts will have dependencies on these other systems. This version of the IAG Update Device Details pre-built has been tested with:

• IAP 2022.1.x

Getting Started

These instructions will help you get a copy of the pre-built in your IAP instance for testing in your environment. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and capabilities.

Prerequisites

Users must satisfy the following prerequisites to install and run this pre-built:

• Itential Automation Platform
  • ^2022.1.x
• An instantiated adapter

Capabilities

• Does operation in external system
• Provides option to run with no manual tasks shown in job with auto approve

How to Install

To install this pre-built:

• Verify that you are running the documented prerequisites in order to install the pre-built.

• Follow the instructions on the Itential Documentation site for importing a pre-built.

Testing

While Itential tests this pre-built 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 pre-built into a development/testing environment in which you can test the pre-built.

Using this Pre-Built

This pre-built can be run in a childJob task.

Note: The entry point workflow to this pre-built is called Pre-Built Workflow. Use this workflow name if running this pre-built in a childJob task.

The input to and possible outputs from this pre-built are described here.

Input Schema

Example input:

{}

The following table details the property keys of the input object.

key	type	required	description

Output Schema

The preBuiltResponse job variable returned from the run pre-built workflow Pre-Built Workflow provides the reponse of the pre-built.

See an example output below.

{}

The preBuiltError job variable returned from the pre-built workflow Pre-Built Workflow provides the error response.

See an example output for this job variable when an error occurs.

{}

Additional Information

Please use your Itential Customer Success account if you need support when using this pre-built.