Skip to main content

Synopsis of the script commands

Because you can use the script commands to define and manage the different aspects of a storage array (such as host topology, drive configuration, controller configuration, volume definitions, and volume group definitions), the actual number of commands is extensive. The commands, however, fall into general categories that are reused when you apply the commands to configure or maintain a storage array. The following table lists the general form of the script commands and a definition of each command.

SyntaxDescription
accept <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280534" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280535" className="keyword varname">statement-data</var>}

Performs the pending operation.
activate <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280534" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280535" className="keyword varname">statement-data</var>}

Sets up the environment so that an operation can take place or performs the operation if the environment is already set up correctly.
autoConfigure storageArray 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280536" className="keyword varname">statement-data</var>}

Automatically creates a configuration that is based on the parameters that are specified in the command.
check <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280537" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280538" className="keyword varname">statement-data</var>}

Starts an operation to report on errors in the object, which is a synchronous operation.
clear <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280539" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280540" className="keyword varname">statement-data</var>}

Discards the contents of some attributes of an object. This operation is destructive and cannot be reversed.
create <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280541" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280542" className="keyword varname">statement-data</var>}

Creates an object of the specified type.
deactivate <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280543" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280544" className="keyword varname">statement-data</var>}

Removes the environment for an operation.
delete <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280545" className="keyword varname">object</var>

Deletes a previously created object.
diagnose <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280546" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280547" className="keyword varname">statement-data</var>}

Runs a test and shows the results.
disable <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280548" className="keyword varname">object</var> {<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280549" className="keyword varname">statement-data</var>}

Prevents a feature from operating.
download <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280550" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280551" className="keyword varname">statement-data</var>}

Transfers data to the storage array or to the hardware that is associated with the storage array.
enable <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280552" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280553" className="keyword varname">statement-data</var>}

Sets a feature to operate.
load <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280554" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280555" className="keyword varname">statement-data</var>}

Transfers data to the storage array or to the hardware that is associated with the storage array. This command is functionally similar to the download command.
recopy <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280556" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280557" className="keyword varname">statement-data</var>}

Restarts a volume copy operation by using an existing volume copy pair. You can change the parameters before the operation is restarted.
recover <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280558" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280559" className="keyword varname">statement-data</var>}

Re-creates an object from saved configuration data and the statement parameters. (This command is similar to the create command.)
remove <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280562" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280563" className="keyword varname">statement-data</var>}

Removes a relationship between objects.
repair <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280564" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280565" className="keyword varname">statement-data</var>}

Repairs errors found by the check command.
replace <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280564" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280565" className="keyword varname">statement-data</var>}

The specified object replaces an existing object in the storage array.
reset <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280566" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280567" className="keyword varname">statement-data</var>}

Returns the hardware or an object to an initial state.
resume <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280568" className="keyword varname">object</var>

Starts a suspended operation. The operation starts where it left off when it was suspended.
revive <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280569" className="keyword varname">object</var>

Forces the object from the Failed state to the Optimal state. Use this command only as part of an error recovery procedure.
save <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280570" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280571" className="keyword varname">statement-data</var>}

Writes information about the object to a file.
set <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280572" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280573" className="keyword varname">statement-data</var>}

Changes object attributes. All changes are completed when the command returns.
show <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280574" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280575" className="keyword varname">statement-data</var>}

Shows information about the object.
start <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280576" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280577" className="keyword varname">statement-data</var>}

Starts an asynchronous operation. You can stop some operations after they have started. You can query the progress of some operations.
stop <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280578" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280579" className="keyword varname">statement-data</var>}

Stops an asynchronous operation.
suspend <var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280580" className="keyword varname">object</var> 
{<var id="GUID-8DA6AFCB-DDB2-4641-9198-A13BA0D608CC__V1280581" className="keyword varname">statement-data</var>}

Stops an operation. You can then restart the suspended operation, and it continues from the point where it was suspended.
validate object 
{statement-data}

Validates a security key.