Learn About the Script Editor

Many storage management options available through the also can be sent to the using statements in scripts. Use the Script Editor to create or edit a script file, save a script file to the local disk, or load a script file from disk.

The Script Editor has an engine that verifies statement syntax, interprets the statements, converts statements to the appropriate protocol-compliant commands, and passes the commands to the storage array where they are executed by the storage array's RAID controller modules.

The Script Editor provides two views in the window:

• Script View - Provides an area for inputting or editing script commands.
• Output View - Displays verification or execution results.

A splitter bar divides the window between Script View and Output View. You can use the splitter bar to resize the views.

Usage Guidelines

The following guidelines must be followed when using the script editor:

• All statements must end with a semicolon (;).
• Each base command and its associated primary and secondary parameters must be separated with a space.
• The parameters you enter into the script editor are not case sensitive.
• Each statement must be on a separate line.
• You can add comments to your scripts to make it easier for you and future users to understand the purpose of the command statements.

There are two ways to insert comments into a script. (Refer to the following notes for proper syntax.)

Important: The comment must start with /* and end with */. If the script engine does not find both a beginning and an ending comment notations, an error message is displayed, and the script execution is terminated. You must end a comment beginning with // with an end-of-line character, inserted by pressing the Enter key. If the script engine does not find an end-of-line character in the script after processing a comment, an error message is displayed, and the script execution is terminated. This error commonly occurs when a comment is placed at the end of a script, and you have forgotten to press Enter.

Interpreting the Script Execution Results

During script execution, messages are displayed in the Output View beginning with:

Executing script...

After a successful script execution, the following message is displayed:

Script execution complete.

If there is an error during the parse phase, an error is displayed in the Output View, giving the line and column number and a description of the syntax error.

Example: If you type the following statement in a script:

set RAID controller module[a] mod = passive;

Then, the resulting syntax error is displayed in the Output View as follows:

Encountered "mod" at line 2, column 19

Was expecting one of...

"mode"...

"availability"...

"NVSRAMbyte"...

If there is an error during the execution of a script, a message is displayed in the Output View stating that the command failed and reporting a description of the error.

Example: If you type the following statement in a script:

set virtual disk [three] userLabel = "OneOne";

Then the resulting error is displayed in the following Output View. The command could not be sent to the storage array because it was in an state.

Unable to change the virtual disk user label using the Set Virtual Disk command at line 1

Error - 1 - Could not communicate with the storage array to complete this request.

Important: Certain execution errors, including the inability to communicate with the storage array, always cause script execution to halt. In these cases, execution stops even if you have used the On Error Continue statement.

Related Topics

Using the Script Editor

Command Reference Overview

Command Reference Table of Contents