Configuring Orchestration Scripts

Owned by Enterprise IT
Last updated: Apr 22, 2024 by Shilpa K (Deactivated)Version comment
3 min read

SummitAI Service Management Help

Orchestration

Orchestration Scripts need to be configured so that Analysts can execute the scripts on the Configuration Items (CIs). The configured scripts are used in Orchestration. As an Administrator, you need to configure the scripts, specify target platform, and add commands that need to be executed through the script. You need to run the ‘Incident Smart Action’ job in the Custom Scheduler. This option is useful for issuing operational commands as well (besides diagnostic ones), such as restarting processes, changing supervisor parameters, and so on.

To configure Orchestration Scripts:

  1. Select Admin> Advanced > Orchestration Scripts.
  2. On the ORCHESTRATION SCRIPTS page, click ADD NEW on the ACTIONS panel.
  3. Type in the new Orchestration Script details. For more information on the fields of ORCHESTRATION SCRIPTS page see, Field Description.
  4. Click SUBMIT. A new Orchestration Script  is configured.

    RUNBOOK SCRIPTS page

    Figure:  ORCHESTRATION page

Field Description

The following table describes the fields on the ORCHESTRATION SCRIPTS page:

Fields

Description

DETAILS

Script Name

Type in the Orchestration Script name.

Target Platform

Select the Operating System on the target machine.

Script Type

Select the script type of the Orchestration Script.

Access To

Select the Workgroups who can access this Orchestration Script from the Available Workgroups list and click the > icon to add it to the Selected Workgroups list. Select a Workgroup from the Selected Workgroups list and click the  < icon to remove the Workgroup from the Selected Workgroups list

Script Commands

Type in the script commands that should be performed when the Orchestration Script is executed.

Parameters

The parameters required to execute the script is configured in this section.
Type in the name, description, and click Add to add the parameter.
Click   to edit the parameter.
Click   to delete the parameter.

Max Runtime

Specify the maximum run time for the script.

Success/Failure Criteria

Specify the condition to define the success/ failure of the Orchestration Script .

  • Select the success or failure from the list.
  • Choose the condition from the list.
  • Specify the value for the condition.

Click the Add button to add an additional row of condition.

Output Parsing Criteria

Specify the condition to remove the additional output text and obtain only the valid output.

Specify the keywords in the Keyword text box and select the Criteria from the list box. The specified criteria will be removed from the output value and only the required output text is displayed.

Remote Execution By

Administrators can configure the Orchestration Scripts to capture the account under which the Script should get executed through Remote Executor Tool.

Enable License Validation

Enable this check box to enable license validation on the ORCHESTRATION AUTOMATION page for the selected script.

Active

Indicates the status set for the Orchestration Script .

  • If selected, the Orchestration Script is available for RBA configuration.
  • If not selected, the Orchestration Script is inactive and is not available while configuring the actions for Orchestrations.
ACTIONS
This section explains all the icons displayed on the ACTIONS panel of the ORCHESTRATION SCRIPTS page.

SHOW LIST
Click SHOW LIST to display the LIST table showing all the Orchestration Scripts configured in the SummitAI application.

  • To edit a Orchestration Script, click the Script Name. Make appropriate changes and click SUBMIT.
  • To display the inactive Orchestration Scripts, click the Include Inactive check box.

Note:

When the Orchestration Scripts are displayed under the LIST table, the ADD NEW action is displayed on the ACTIONS panel. Click ADD NEW to configure a new Orchestration Script.

References