add plex lun=n [noerr]

add tpgroup tportal= n[noerr]

plex lun=n

Specifies the LUN number to add as a plex to the currently selected LUN.

Caution
All data on the LUN being added as a plex will be deleted.

tpgroup tportal= n

Specifies the iSCSI target portal number to add to the currently selected iSCSI target portal group.

noerr

Specifies that any failures that occur while performing this operation will be ignored. This is useful in script mode.

associate controllers [add] n[,n [,…]]

associate ports [add]n-m[,n-m[,…]]

associate targets [add] n[,n [,…]]

controllers

For use with VDS 1.0 providers only. Adds to or replaces the list of controllers that are associated with the currently selected LUN.

ports

For use with VDS 1.1 providers only. Adds to or replaces the list of controller ports that are associated with the currently selected LUN.

targets

For use with VDS 1.1 providers only. Adds to or replaces the list of iSCSI targets that are associated with the currently selected LUN.

add

For VDS 1.0 providers, adds the specified controllers to the existing list of controllers associated with the LUN. If this parameter is not specified, the list of controllers replaces the existing list of controllers associated with this LUN.

For VDS 1.1 providers, adds the specified controller ports to the existing list of controller ports associated with the LUN. If this parameter is not specified, the list of controller ports replaces the existing list of controller ports associated with this LUN.

n [, n [, ...]]

For use with the controllers or targets parameter. Specifies the numbers of the controllers or iSCSI targets to set to active or associate.

n - m [, n - m [,…]]

For use with the ports parameter. Specifies the controller ports to set active using a controller number (n) and port number (m) pair.

The following example shows how to associate and add ports to a LUN that uses a VDS 1.1 provider.

automagic {set | clear | apply} allflag=value [flag=value [...]]

set

Sets the specified flags to the specified values.

clear

Clears the specified flags. The all keyword clears all the automagic flags.

apply

Applies the current flags to the selected LUN.

flag

Flags are identified by three-letter acronyms.

break plex=plex_number [noerr]

plex

Specifies the number of the plex to remove. The plex and the data it contained will not be retained, and the resources used by this plex will be reclaimed. The data contained on the LUN is not guaranteed to be consistent. If you want to retain this plex, use the Volume Shadow Copy Service (VSS).

noerr

Specifies that any failures that occur while performing this operation will be ignored. This is useful in script mode.

chap initiator set secret=[secret] [target=target]

chap initiator remember secret=[secret] target=target

chap target set secret=[secret] [initiator=initiatorname]

chap target remember secret=[secret] initiator=initiatorname

initiator set

Sets the shared secret in the local iSCSI initiator service used for mutual CHAP authentication when the initiator authenticates the target.

initiator remember

Communicates the CHAP secret of an iSCSI target to the local iSCSI initiator service so that the initiator service can use the secret in order to authenticate itself to the target during CHAP authentication.

target set

Sets the shared secret in the currently selected iSCSI target used for CHAP authentication when the target authenticates the initiator.

target remember

Communicates the CHAP secret of an iSCSI initiator to the current in-focus iSCSI target so that the target can use the secret in order to authenticate itself to the initiator during mutual CHAP authentication.

secret

Specifies the secret to use. If empty the secret will be cleared.

target

Specifies a target in the currently selected subsystem to associate with the secret. This is optional when setting a secret on the initiator and leaving it out indicates that the secret will be used for all targets that do not already have an associated secret.

initiatorname

Specifies an initiator iSCSI name to associate with the secret. This is optional when setting a secret on a target and leaving it out indicates that the secret will be used for all initiators that do not already have an associated secret.

create lun simple [size=n] [drives=n] [noerr]

create lun stripe [size=n] [drives=n, n[,...]] [stripesize=n] [noerr]

create lun raid [size=n] [drives=n, n[,...]] [stripesize=n] [noerr]

create lun mirror [size=n] [drives=n, n[,...]] [stripesize=n] [noerr]

create lun automagic size= n[noerr]

create target name= name[iscsiname=iscsiname] [noerr]

create tpgroup [noerr]

simple

Creates a simple LUN.

stripe

Creates a striped LUN.

RAID

Creates a striped LUN with parity.

mirror

Creates a mirrored LUN.

automagic

Creates a LUN using the automagic hints currently in effect. See the automagic sub-command for more information.

size=

Specifies the total LUN size in megabytes. If the size= parameter is not specified, the LUN created will be the largest possible size allowed by all the specified drives.

A provider typically creates a LUN at least as big as the requested size, but the provider may have to round up to the next largest size in some cases. For example, if size is specified as .99 GB and the provider can only allocate GB disk extents, the resulting LUN would be 1 GB.

To specify the size using other units, use one of the following recognized suffixes immediately after the size:

• B for byte.
  
  
• KB for kilobyte.
  
  
• MB for megabyte.
  
  
• GB for gigabyte.
  
  
• TB for terabyte.
  
  
• PB for petabyte.
  
  

drives=

Specifies the drive_number for the drives to use to create a LUN. If the size= parameter is not specified, the LUN created is the largest possible size allowed by all the specified drives. If the size= parameter is specified, providers will select drives from the specified drive list to create the LUN. Providers will attempt to use the drives in the order specified when possible.

stripesize=

Specifies the size in megabytes for a stripe or RAID LUN. The stripesize cannot be changed after the LUN is created.

To specify the size using other units, use one of the following recognized suffixes immediately after the size:

• B for byte.
  
  
• KB for kilobyte.
  
  
• MB for megabyte.
  
  
• GB for gigabyte.
  
  
• TB for terabyte.
  
  
• PB for petabyte.
  
  

target

Creates a new iSCSI target on the currently selected subsystem.

name

Supplies the friendly name for the target.

iscsiname

Supplies the iSCSI name for the target and can be omitted to have the provider generate a name.

tpgroup

Creates a new iSCSI target portal group on the currently selected target.

noerr

Specifies that any failures that occur while performing this operation will be ignored. This is useful in script mode.

• Either the size= or the drives= parameter must be specified. They can also be used together.
  
  
• The stripe size for a LUN cannot be changed after creation.
  
  

delete lun [noerr]

delete target [noerr]

delete tpgroup [noerr]

lun

Deletes the currently selected LUN and all data on it.

target

Deletes the currently selected iSCSI target if no LUNs are associated with the target.

tpgroup

Deletes the currently selected iSCSI target portal group.

noerr

Specifies that any failures that occur while performing this operation will be ignored. This is useful in script mode.

Detail {hbaport | iadapter | iportal | provider | subsystem | controller | port | drive | lun | tportal | target | tpgroup} [verbose]

hbaport

Lists detailed information about the currently selected host bus adapter (HBA) port.

iadapter

Lists detailed information about the currently selected iSCSI initiator adapter.

iportal

Lists detailed information about the currently selected iSCSI initiator portal.

provider

Lists detailed information about the currently selected provider.

subsystem

Lists detailed information about the currently selected subsystem.

controller

Lists detailed information about the currently selected controller.

port

Lists detailed information about the currently selected controller port.

drive

Lists detailed information about the currently selected drive, including the occupying LUNs.

lun

Lists detailed information about the currently selected LUN, including the contributing drives. The output differs slightly depending on whether the LUN is part of a Fibre Channel or iSCSI subsystem.

tportal

Lists detailed information about the currently selected iSCSI target portal.

target

Lists detailed information about the currently selected iSCSI target.

tpgroup

Lists detailed information about the currently selected iSCSI target portal group.

verbose

For use only with the LUN parameter. Lists additional information, including its plexes.

dissociate controllers n[,n[,...]]

dissociate ports n - m[,n-m[,…]]

dissociate targets n[,n[,…]]

controllers

For use with VDS 1.0 providers only. Removes controllers from the list of controllers that are associated with the currently selected LUN.

ports

For use with VDS 1.1 providers only. Removes controller ports from the list of controller ports that are associated with the currently selected LUN.

targets

For use with VDS 1.1 providers only. Removes targets from the list of iSCSI targets that are associated with the currently selected LUN.

n[,n[,…]]

For use with the controllers or targets parameter. Specifies the numbers of the controllers or iSCSI targets to set as inactive or dissociate.

n - m[,n-m[,…]]

For use with the ports parameter. Specifies the controller ports to set as inactive by using a controller number (n) and port number (m) pair.

exit

extend lun [size=LUN_size] [drives=drive_number, [drive_number, ...]] [noerr]

size=

Specifies the size in megabytes to extend the LUN. If the size= parameter is not specified, the LUN is extended by the largest possible size allowed by all the specified drives. If the size= parameter is specified, providers select drives from the list specified by the drives= parameter to create the LUN.

To specify the size using other units, use one of the following recognized suffixes immediately after the size:

• B for byte.
  
  
• KB for kilobyte.
  
  
• MB for megabyte.
  
  
• GB for gigabyte.
  
  
• TB for terabyte
  
  
• PB for petabyte
  
  

drives=

Specifies the drive_number for the drives to use when creating a LUN. If the size= parameter is not specified, the LUN created is the largest possible size allowed by all the specified drives. Providers use the drives in the order specified when possible.

noerr

Specifies that any failures that occur while performing this operation should be ignored. This is useful in script mode.

• Either the size or the drive parameter must be specified. They can also be used together.
  
  

flushcache controller

help

importtarget subsystem [set target]

set target

If specified, sets the currently selected target to the VSS import target for the currently selected subsystem. If not specified, the command retrieves the current VSS import target that is set for the currently selected subsystem.

initiator

invalidatecache controller

ipsec iportal tportal= tportal

ipsec iportal set key=[key] tportal=tportal[flag [flag[…]]]

ipsec iportal set tunnel= tunneladdress destination=destinationaddress

ipsec tportal iportal= iportal

ipsec tportal set key=[key] {initiator | iportal=iportal} [flag [flag […]]]

ipsec tportal set tunnel= tunneladdress destination= destinationaddress

ipsec initiator set groupkey=[groupkey]

ipsec initiator set key=[key] tportal=tportal[flag [flag […]]]

ipsec initiator set tunnel= tunneladdress destination= destinationaddress

ipsec subsystem set groupkey=[key]

iportal tportal= tportal

Displays the IPsec configuration of the currently selected initiator portal that is associated with the specified target portal on the currently selected subsystem.

tportal iportal= iportal

Displays the IPsec configuration of the currently selected target portal that is associated with the specified initiator portal on the currently selected initiator adapter.

iportal set

Sets the IPsec configuration of the currently selected initiator portal with either the IPsec key and flags, or the IPsec tunnel address.

tportal set

Sets the IPsec configuration of the currently selected target portal with either the IPsec key and flags, or the IPsec tunnel address.

initiator set

Sets the IPsec configuration of all the initiator portals in the local iSCSI initiator service with the IPsec key and flags, the IPsec tunnel address, or group IPsec key.

subsystem set

Sets the group IPsec key of the target portals in the currently selected subsystem.

key

Specifies the pre-shared key to be used for IPsec. If not specified, the existing key is cleared.

tportal

Specifies the target portal in currently selected subsystem to associate with the key.

iportal

Specifies the initiator portal in the currently selected initiator adapter to associate the key with.

initiator

Associates the key with all initiator portals in the service.

flag

Flags are identified by three letter acronyms:

IKE: Enable IPsec/Internet Key Exchange (IKE)

NMM: Enable IPsec negotiating through main mode

NAM: Enable IPsec negotiating through aggressive mode

PFS: Enable perfect forward secrecy

TRA: Prefer transport mode

TUN: Prefer tunnel mode

tunneladdress

Sets the tunnel mode address for the currently selected initiator portal, currently selected target portal, or all initiator portals in the service. Specifies the outer IP address used to create a connection if tunnel mode is used.

destinationaddress

Specifies the destination address to associate with the tunnel mode address.

groupkey

Specifies the group pre-shared key to be used for IPsec in the local iSCSI initiator service (if initiator set is specified) or the currently subsystem (if subsystem set is specified). If empty the key will be cleared.

lbpolicy set lun type= type[paths=path-{primary | weight}[,path-{primary | weight}[,…]]]

lbpolicy set lun paths= path -{primary | weight}[,path-{primary | weight}[,…]]

type

Specifies the load balance policy. If the type is not specified, then the path parameter must be specified. Type can be one of the following:

FAILOVER: Uses one primary path with other paths being backup paths.

ROUNDROBIN: Uses all paths in round-robin fashion, which tries each path sequentially.

SUBSETROUNDROBIN: Uses all primary paths in round-robin fashion; backup paths are used only if all primary paths fail.

DYNLQD: Uses the path with the least number of active requests.

WEIGHTED: Uses the path with the least weight (each path must be assigned a weight).

LEASTBLOCKS: Uses the path with the least blocks.

VENDORSPECIFIC: Uses a vendor-specific policy.

paths

Specifies whether a path is primary or has a particular weight. Any paths not specified are implicitly set as backup. Any paths listed must be one of the currently selected LUN’s paths.

List {hbaports | iadapters | iportals | providers | subsystems | controllers | ports | drives | LUNs | tportals | targets | tpgroups}

hbaports

Lists summary information about all HBA ports known to VDS. The currently selected HBA port is marked by an asterisk (*).

iadapters

Lists summary information about all iSCSI initiator adapters known to VDS. The currently selected initiator adapter is marked by an asterisk (*).

iportals

Lists summary information about all iSCSI initiator portals in the currently selected initiator adapter. The currently selected initiator portal is marked by an asterisk (*).

providers

Lists summary information about each provider known to VDS. The currently selected provider is marked by an asterisk (*).

subsystems

Lists summary information about each subsystem in the system. The currently selected subsystem is marked by an asterisk (*).

controllers

Lists summary information about each controller in the currently selected subsystem. The currently selected controller is marked by an asterisk (*).

ports

Lists summary information about each controller port in the currently selected controller. The currently selected port is marked by an asterisk (*).

drives

Lists summary information about each drive in the currently selected subsystem. The currently selected drive is marked by an asterisk (*).

luns

Lists summary information about each LUN in the currently selected subsystem. The currently selected LUN is marked by an asterisk (*).

tportals

Lists summary information about all iSCSI target portals in the currently selected subsystem. The currently selected target portal is marked by an asterisk (*).

targets

Lists summary information about all iSCSI targets in the currently selected subsystem. The currently selected target is marked by an asterisk (*).

tpgroups

Lists outputs summary information about all iSCSI target portal groups in the currently selected target. The currently selected portal group is marked by an asterisk (*).

login target iadapter= iadapter [type={manual | persistent | boot}][chap={none | oneway | mutual}] [iportal=iportal] [tportal=tportal] [flag[flag[…]]]

type

Specifies the type of login to perform: manual, persistent, or boot. If unspecified, a manual login will be performed.

manual - Login manually.

persistent - Automatically use the same login when the computer is restarted.

boot - This option is for future development and is not currently used.

chap

Specifies the type of CHAP authentication to use: none, oneway CHAP, or mutual CHAP; if unspecified, no authentication will be used.

tportal

Specifies an optional target portal in the currently selected subsystem to use for the log in.

iportal

Specifies an optional initiator portal in the specified initiator adapter to use for the log in.

flag

Identified by three letter acronyms:

IPS: Require IPsec

EMP: Enable multipath

EHD: Enable header digest

EDD: Enable data digest

logout target iadapter= iadapter

iadapter

Specifies the initiator adapter with a login session to logout from.

maintenance object operation [count=iteration]

object

Specifies the type of object on which to perform the operation. The object type can be a subsystem, controller, port, drive or LUN.

operation

Specifies the maintenance operation to perform. The operation type can be spinup, spindown, blink, beep or ping. An operation must be specified.

count=

Specifies the number of times to repeat the operation. This is typically used with blink, beep,or ping.

name {subsystem | lun | target} [name]

name

Specifies a name for the subsystem, LUN, or target. The name must be less than 64 characters in length. If no name is supplied, the existing name, if any, is deleted.

offline object

object

Specifies the type of object on which to perform this operation. The object type can be subsystem, controller, drive, LUN, or tportal.

online object

object

Specifies the type of object on which to perform this operation. The object type can be hbaport, subsystem, controller, drive, LUN, or tportal.

recover lun

reenumerate {subsystems | drives}

subsystems

Queries the provider to discover any new subsystems that were added in the currently selected provider.

drives

Queries the internal I/O buses to discover any new drives that were added in the currently selected subsystem.

refresh provider

Rem comment

remove tpgroup tportal= tportal[noerr]

tpgroup tportal= tportal

Specifies the iSCSI target portal to remove.

noerr

Specifies that any failures that occur while performing this operation should be ignored. This is useful in script mode.

replace drive=drive_number

drive=

Specifies the drive_number for the drive to be replaced.

• The specified drive may not be the currently selected drive.
  
  

Reset {controller | port}

controller

Resets the controller.

port

Resets the port.

Select {hbaport | iadapter | iportal | provider | subsystem | controller | port | drive | lun | tportal | target | tpgroup } [n]

object

Specifies the type of object to select. The object type can be provider, subsystem, controller, drive, or LUN.

hbaport [n]

Sets the focus to the specified local HBA port. If no HBA port is specified, the command displays the currently selected HBA port (if any). Specifying an invalid HBA port index results in no in-focus HBA port. Selecting an HBA port deselects any selected initiator adapters and initiator portals.

iadapter [n]

Sets the focus to the specified local iSCSI initiator adapter. If no initiator adapter is specified, the command displays the currently selected initiator adapter (if any). Specifying an invalid initiator adapter index results in no in-focus initiator adapter. Selecting an initiator adapter deselects any selected HBA ports and initiator portals.

iportal [n]

Sets the focus to the specified local iSCSI initiator portal within the selected iSCSI initiator adapter. If no initiator portal is specified, the command displays the currently selected initiator portal (if any). Specifying an invalid initiator portal index results in no selected initiator portal.

provider [n]

Sets the focus to the specified provider. If no provider is specified, the command displays the currently selected provider (if any). Specifying an invalid provider index results in no in-focus provider.

subsystem [n]

Sets the focus to the specified subsystem. If no subsystem is specified, the command displays the subsystem with focus (if any). Specifying an invalid subsystem index results in no in-focus subsystem. Selecting a subsystem implicitly selects its associated provider.

controller [n]

Sets the focus to the specified controller within the currently selected subsystem. If no controller is specified, the command displays the currently selected controller (if any). Specifying an invalid controller index results in no in-focus controller. Selecting a controller deselects any selected controller ports, drives, LUNs, target portals, targets, and target portal groups.

port [n]

Sets the focus to the specified controller port within the currently selected controller. If no port is specified, the command displays the currently selected port (if any). Specifying an invalid port index results in no selected port.

drive [n]

Sets the focus to the specified drive, or physical spindle, within the currently selected subsystem. If no drive is specified, the command displays the currently selected drive (if any). Specifying an invalid drive index results in no in-focus drive. Selecting a drive deselects any selected controllers, controller ports, LUNs, target portals, targets, and target portal groups.

lun [n]

Sets the focus to the specified LUN within the currently selected subsystem. If no LUN is specified, the command displays the currently selected LUN (if any). Specifying an invalid LUN index results in no selected LUN. Selecting a LUN deselects any selected controllers, controller ports, drives, target portals, targets, and target portal groups.

tportal [n]

Sets the focus to the specified iSCSI target portal within the currently selected subsystem. If no target portal is specified, the command displays the currently selected target portal (if any). Specifying an invalid target portal index results in no selected target portal. Selecting a target portal deselects any controllers, controller ports, drives, LUNs, targets, and target portal groups.

target [n]

Sets the focus to the specified iSCSI target within the currently selected subsystem. If no target is specified, the command displays the currently selected target (if any). Specifying an invalid target index results in no selected target. Selecting a target deselects any controllers, controller ports, drives, LUNs, target portals, and target portal groups.

tpgroup [n]

Sets the focus to the specified iSCSI target portal group within the currently selected iSCSI target. If no target portal group is specified, the command displays the currently selected target portal group (if any). Specifying an invalid target portal group index results in no in-focus target portal group.

n

Specifies the object number to select. If the object number specified is not valid, any existing selections for objects of the specified type are cleared. If no object number is specified, the current object is displayed.

setflag drive hotspare={true | false}

true

Selects the currently selected drive as a hot spare.

false

Unselects the currently selected drive as a hot spare.

• Hot spares cannot be used for ordinary LUN binding operations. They are reserved for fault handling only. The drive must not be currently bound to any existing LUN.
  
  

standby hbaport

hbaport

Changes the status of the paths to the currently selected host bus adapter (HBA) port to STANDBY.

unmask LUN {all | none | [add] wwn=hexadecimal_number [;hexadecimal_number [;…]] | [add] initiator=initiator[;initiator[;…]]} [uninstall]

all

Specifies that the LUN should be made accessible from all hosts. However, you cannot unmask the LUN to all targets in an iSCSI subsystem.

none

Specifies that the LUN should not be accessible to any host.

add

Specifies that the hosts specified must be added to the existing list of hosts that this LUN is accessible from. If this parameter is not specified, the list of hosts supplied replaces the existing list of hosts that this LUN is accessible from.

WWN=

Specifies a list of hexadecimal numbers representing world-wide names from which the LUN or hosts should be made accessible. To mask/unmask to a specific set of hosts in a Fibre Channel subsystem, you can type a semicolon-separated list of WWN’s for the ports on the host machines of interest.

initiator=

Specifies a list of iSCSI initiators to which the currently selected LUN should be made accessible. To mask/unmask to a specific set of hosts in an iSCSI subsystem, you can type a semicolon-separated list of iSCSI initiator names for the initiators on the host computers of interest.

uninstall

If specified, uninstalls the disk associated with the LUN on the local system before the LUN is masked.