Workflow to execute a script

Overview

The following workflow outlines the high-level steps necessary to create either CLI or XML API scripts. Each of the steps provides guidance on the type of XML requests required to perform a particular configuration action. See the XML API SDK Sample Code Navigator for sample XML scripts.

You can synchronously or asynchronously execute the scripts. For synchronous execution, a response attribute identifies the success or failure of script execution. For asynchronous execution, the OSS client can either wait for a JMS notification or poll for status on the execution of the script.

The script results are stored in a file for the OSS client to collect. When the OSS client retrieves the results using the SOAP interface, the result is stripped of non-printable characters embedded in the response.

Stages
 
1 

Create script object using the script.Scriptmanager class.

  1. Create CLI script object.

  2. Create XML API script object.

2 

Create script version.

  1. For CLI script version, include the CLI commands for the target NEs.

  2. For XML API script version, include velocity content and configuration details.

3 

Create script target on instance

  1. For CLI, create a script target that identifies the NE and specific NE parameter targets.

  2. For XML API, create a script instance for an XML API script that identifies the targetObjectFullName of the object and parameters to be configured.

4 

Preview scripts.

5 

Start and stop the execution of scripts.

6 

Retrieve script results of executions using FTP SFTP, or SOAP/XML.