Recurring syntax elements are a general category of variables and parameters you can use in one or more script commands. The recurring syntax is used in the general definitions of the script commands that are listed in "Script Commands" on page 105. Table 2-4 lists the recurring syntax and the syntax values that you can use with the syntax.
show object {statement-data} Displays information about the object.
start object {statement-data} Starts an asynchronous operation. You can stop some operations after they have started. You can query the progress of some operations.
stop object {statement-data} Stops an asynchronous operation. suspend object
{statement-data}
Suspends an operation. You can then restart the suspended operation, and it continues from the point at which it was suspended.
Table 2-4. Recurring Syntax Elements
Recurring Syntax Syntax Value
raid-level (0 | 1 | 5| 6)
snapshot-repository-raid-level (1 | 5 | 6)
capacity-spec integer-literal [KB | MB | GB | TB | Bytes]
segment-size-spec integer-literal
boolean (TRUE | FALSE)
user-label string-literal
user-label-list user-label {user-label}
create-raid-vol-attr-value-list create-raid-virtual disk-attribute-value- pair
{create-raid-virtual disk-attribute-value- pair}
Table 2-3. General Form of the Script Commands (continued) Command Syntax Description
create-raid-virtual disk-attribute-value-pair capacity=capacity-spec | owner=(0 | 1) |
segmentSize=integer-literal RAID controller module-enclosureId (0–99)
slot-id (0–31)
port-id (0–127)
physical disk-spec enclosureID, slotID
physical disk-spec-list physical disk-spec {physical disk-spec} enclosure-id-list enclosureID {enclosureID}
hex-literal 0x hexadecimal-literal
virtual disk-group-number integer-literal
filename string-literal
error-action (stop | continue)
physical disk-channel-identifier (1 | 2)
physical disk-channel-identifier-list physical disk-channel-identifier {physical disk-channel-identifier} host-channel-identifier (01 | 02 | 11 | 12)
physical disk-type (Serial Attached SCSI [SAS] | Serial Advanced Technology Attachment [SATA])
feature-identifier (snapshot | virtualDiskCopy) repository-spec instance-based-repository-spec |
count-based-repository-spec ethernet-port-options IPV4Address=ipv4-address|
IPV4ConfigurationMethod=[(static | dhcp)] |
IPV4GatewayIP=ipv4-address|
IPV4SubnetMask=ipv4-address| Table 2-4. Recurring Syntax Elements (continued)
iscsi-host-port-options IPV4Address=ipv4-address | IPV6LocalAddress=ipv6-address | IPV6RoutableAddress=ipv6-address | IPV6RouterAddress=ipv6-address | enableIPV4= boolean | enableIPV6=boolean | enableIPV4Vlan=boolean | enableIPV6Vlan=boolean | enableIPV6Priority=boolean | enableIPV6Priority=boolean | IPV4ConfigurationMethod=(static | dhcp) | IPV6ConfigurationMethod=(static | auto) | IPV4GatewayIP= ipv4-address | IPV6HopLimit=integer | IPV6NdDetectDuplicateAddress= integer | IPV6NdReachableTime=integer | IPV6NdRetransmitTime=integer | IPV6NdTimeOut=integer | IPV4Priority=integer | IPV6Priority=integer | IPV4SubnetMask=ipv4-address | IPV4VlanID=integer | IPV6VlanID=integer | maxFramePayload=integer | tcpListeningPort=tcp-port-id| NOTE: You must set the enableIPV4 parameter or the enableIPV6 parameter to TRUE to ensure that the specific IPV4 or IPV6 setting is applied.
NOTE: The IPV6 address space is 128 bits. It is represented by eight 16-bit hexadecimal blocks separated by colons. You may drop leading zeros, and use a double colon to represent consecutive blocks of zeroes.
Table 2-4. Recurring Syntax Elements (continued)
instance-based-repository-spec repositoryRAIDLevel=repository-raid- level
repositoryPhysicalDisks=(physical disk- spec-list)
[enclosureLossProtect=boolean] repositoryDiskGroup=virtual-disk- group-number
[freeCapacityArea=integer-literal] Specify repositoryRAIDLevel with repositoryPhysicalDisks. Do not specify RAID level or physical disks with a disk group. Do not set enclosureLossProtect
when specifying a disk group.
NOTE: For enclosure loss protection to work, each physical disk in a disk group must be on a separate enclosure. If you set enclosureLossProtect=TRUE and have selected more than one physical disk from any one enclosure, the storage array returns an error. If you set
enclosureLossProtect=FALSE, the storage array performs operations, but the disk group you create might not have enclosure loss protection.
NOTE: To determine if a free capacity
area exists, issue the show diskGroup
command.
count-based-repository-spec repositoryRAIDLevel=repository-raid- level
repositoryPhysicalDiskCount=integer- literal
[physicalDiskType=physical disk-type] [enclosureLossProtect=boolean]
WWID string-literal.
For hostPort identifiers this is a 16-digit hex number without any colon delimiters.
Table 2-4. Recurring Syntax Elements (continued)
nvsram-offset hexadecimal-literal
host-type string-literal | integer-literal
nvsram-byte-setting nvsram-value
(0x hexadecimal | integer-literal) nvsram-bit-setting nvsram-mask, nvsram-value
(0x hexadecimal, 0x hexadecimal | integer-literal) ipv4-address (0–255).(0–255).(0–255).(0–255) ipv6-address (0-FFFF):(0-FFFF):(0-FFFF): (0-FFFF):(0-FFFF):(0-FFFF): (0-FFFF):(0-FFF) autoconfigure-vols-attr-value-list autoconfigure-vols-attr-value-pair {autoconfigure-vols-attr-value-pair} autoconfigure-vols-attr-value-pair physicalDiskType=physical disk-type|
raidLevel=raid-level | diskGroupWidth=integer-literal | diskGroupCount=integer-literal | virtualDisksPerGroupCount=integer- literal| hotSpareCount=integer-literal | segmentSize=segment-size-spec NOTE: The physicalDiskType parameter is not required if only one type of physical disk is in the storage array. If you use the
physicalDiskTypeparameter, you must
also use the hotSpareCount and
diskGroupWidth parameters. If you do not
use the physicalDiskType parameter, the
configuration defaults to SAS physical disks.
NOTE: The virtualDisksPerGroupCount
parameter is the number of equal- capacity virtual disks per disk group.
Table 2-4. Recurring Syntax Elements (continued)
create-virtual-disk-copy-attr-value-list create-virtual-disk-copy-attr-value-pair {create-virtual-disk-copy-attr-value-pair} create-virtual-disk-copy-attr-value-pair copyPriority=highest | high | medium |
low | lowest |
targetReadOnlyEnabled=boolean recover-raid-virtual-disk-attr-value-list recover-raid-virtual-disk-attr-value-pair
{recover-raid-virtual-disk-attr-value-pair} recover-raid-virtual-disk-attr-value-pair owner=(0 | 1)
Table 2-5. Range of Values for Recurring Syntax Elements
Recurring Syntax Syntax Values
IPV4Priority 0 to 7
IPV4VlanID 1 to 4094
IPV6Priority 0 to 7
IPV6VlanID 1 to 4094
IPV6HopLimit 0 to 255 (default value is 64)
IPV6NdDetectDuplicateAddress 0 to 256
IPV6NdReachableTime 0 to 65535 (default value is 30000 milliseconds)
IPV6RetransmitTime 0 to 65535 (default value is 1000 milliseconds)
IPV6NDTimeOut 0 to 65535 (default value is 3000 milliseconds) Table 2-4. Recurring Syntax Elements (continued)