Overview

Scripts allows you to store scripts in the Universal Controller database.

When a task that specifies a stored script is executed, the script is transmitted to the remote machine for execution.

You can use scripts with the following task types: Windows, Linux/Unix, SAP, and File Transfer (UDM scripts for UDM File Transfer tasks).

You cannot import compiled executables into Scripts. The content of scripts must be text that can be processed by some shell, script host, or command interpreter.

You can embed Universal Controller variables in the script content. Embedded variables are resolved at trigger/run time before the script is sent to an Agent.

Controller variables can be passed as parameters, but the script still has to be written to parse the variables. However, you cannot pass variables as parameters that contain data longer than the parameter field (for example, SQL results).

For example, the following script shows how a Controller variable could be used.

#!/bin/bash
echo Task Name: ${ops_task_name}
echo Task Instance: ${ops_task_id}

Types of Scripts

There are five types of scripts:

Data Scripts

Data Scripts (Script Type = Data) are meant to be used with scripts and commands specified in tasks, and resolved when the script or command is executed. Data Scripts provide the script or command with access to a path on the UAG file system where the temporary Data Script content resides.
 

Using Data Scripts in a Script

To use a Data Script with a script, embed the Data Script in any of the following:

• Content of a Script specified in the Script field in a Linux/Unix or Windows task.
• Content of a Data Script.
• Universal Template Script (Script, Linux/Unix Script, or Windows Script field).

Using Data Scripts in a Task

To use a Data Script with a task, embed the Data Script in any of the following:

• Command field in a Linux/Unix or Windows task
• Parameters field in a Linux/Unix or Windows task

Embedding a Data Script

To embed a Data Script, use the following Script Function:

Upon task instance execution, the Controller will resolve ${_scriptPath('<script_name>')} and replace it with a token representing the path to the embedded Data Script in the following format: $(ops_unv_script_path_<script-sys_id>).

For every Data Script embedded in a Data Script, the Controller will resolve ${_scriptPath('script_name')} (if Resolve UAC Variables is enabled for the Data Script), and look for additional Data Script references (and Resolvable Credentials references). This process will continue until no additional Data Script references are found.

For each Data Script reference, the Controller will send UAG the Data Script Content, file extension, and the corresponding token - $(ops_unv_script_path_<script-sys_id>) - that would represent a reference to that Content, which would ultimately be temporarily written to the UAG file system.

UAG will replace any tokens within the Script Content, Universal Template Script, Command, or Parameters with the appropriate file path associated with the Data Script Content. UAG also will replace any tokens within each Data Script Content.

Additionally, for a Universal Template, you can create a Field of Type = Script, which lets you select or create Data Scripts. The Controller will create a variable for the Data Script Field, which you can embed in the Universal Template script using the Script Functions. This also lets you change Scripts when you run a Universal Task based on the Universal Template.

Restrictions on Embedding Data Scripts

For every embedded Script, the Script Type must be Data; otherwise, the task will transition to the Start Failure status with one of the following status descriptions:

Execution for script "script-name", contained within the Universal Template Script, prohibited due to script type constraint; only Data script type permitted.

Execution for script "script-name", contained within the command field or parameters field prohibited due to script type constraint; only Data script type permitted.

Execution for script "script-name", contained within the script "script-name", prohibited due to script type constraint; only Data script type permitted.
 

For every embedded Data Script, the Execution User must have Execute permission for the Data Script; otherwise, the task instance will transition to the Start Failure status with one of the following status descriptions:

Execution for script "script-name", contained within a Universal Template Script or script, prohibited due to security constraints.

Execution for script "script-name", contained within a script, command field, or parameters field, prohibited due to security constraints.

Creating a Script

Script Details

The following Script Details is for an existing script. See the field descriptions, below, for a description of all fields that display in the Script Details.

For information on how to access additional details - such as Metadata and complete database Details - for Scripts (or any type of record), see Records.

Script Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the Script Details.
 

Uploading a Script

To upload a script into the Content field in the Script Details: