Script Command Structure; Object Types And Identifiers - IBM System Storage DS3000 Programming Manual

Script Command Structure

All script commands have the following structure:
command operand-data (statement-data)
where command identifies the action to be performed, operand-data represents the objects associated with a
storage subsystem that you want to configure or manage, and statement-data provides the information
needed to perform the command.
The syntax for operand-data is as follows:
(object-type | allobject-types | [qualifier] (object-type [identifier]
{object-type [identifier]} |
object-types [identifier-list]))
An object can be identified four ways: object type, all parameter prefix, square brackets, or a list of
identifiers. Use an object type when the command is not referencing a specific object. The all parameter
prefix means all objects of the specified type in the storage subsystem (for example, allLogicalDrives).
To perform a command on a specific object, use square brackets to identify the object (for example,
logicalDrive [engineering]). Specify a subset of objects with a list of identifiers in square brackets (for
example, logicalDrives [sales engineering marketing]). A qualifier is required if you want to include
additional information to describe the objects.
The object type and the identifiers that are associated with each object type:
Table 2-2. Object Types and Identifiers
Object Type
controller
drive
replacementDrive
drivechannel
host
hostchannel
hostgroup
hostport
iscsiInitiator
iscsiTarget
remote mirror
flashcopy
storagesubsystem
enclosure
logicalDrive
VolumeCopy
2-2
IBM System Storage DS3000, DS4000, and DS5000: Command Line Interface and Script Commands Programming Guide
Identifier
a or b
Enclosure ID and slot ID only, or enclosure ID,
drawer ID, and slot ID, depending on the type of
storage enclosure
Enclosure ID and slot ID only, or enclosure ID,
drawer ID, and slot ID, depending on the type of
storage enclosure
Drive channel identifier
User label
Host channel identifier
User label
User label
Logical drive user label or iSCSI Qualified Name
(IQN)
Logical drive user label or IQN
Primary logical drive user label
Logical drive user label
Not applicable
Enclosure ID
Logical drive user label or logical drive World-Wide
Identifier (WWID) (set command only)
Target logical drive user label and, optionally, the
source logical drive user label