Edit

Add-VirtualDiskToMaskingSet

  • Reference
Module:
Storage

Adds a virtual disk to a specified masking set and grants access to the virtual disk to all initiator IDs defined in the masking set.

Syntax

Add-VirtualDiskToMaskingSet
   [-MaskingSetFriendlyName] <String[]>
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-DeviceAccesses <DeviceAccess[]>]
   [-DeviceNumbers <UInt16[]>]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-VirtualDisknames <String[]>]
   [-Confirm]
   [-WhatIf]
Add-VirtualDiskToMaskingSet
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-DeviceAccesses <DeviceAccess[]>]
   [-DeviceNumbers <UInt16[]>]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-VirtualDisknames <String[]>]
   -MaskingSetUniqueId <String[]>
   [-Confirm]
   [-WhatIf]
Add-VirtualDiskToMaskingSet
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-DeviceAccesses <DeviceAccess[]>]
   [-DeviceNumbers <UInt16[]>]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-VirtualDisknames <String[]>]
   -InputObject <CimInstance[]>
   [-Confirm]
   [-WhatIf]

Description

The Add-VirtualDiskToMaskingSet cmdlet adds a virtual disk to a specified masking set and grants access to the virtual disk to all initiator IDs defined in the masking set.

ps_storage_spacesubsystem_not_remark

Examples

Example 1: Add a virtual disk to an existing masking set

PS C:\>$maskingSet = Get-MaskingSet Cluster1MaskingSet PS C:\>$virtualDisk = Get-VirtualDisk Volume12 PS C:\>$maskingSet | Add-VirtualDiskToMaskingSet -VirtualDisknames $virtualDisk.Name -DeviceAccesses ReadWrite

This example adds the virtual disks named Volume12 to a masking set named Cluster1MaskingSet, and sets the device access to read-write.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeviceAccesses

Specifies the way in which initiators can access the virtual disk(s) that are part of this masking set. You must specify a DeviceAccesses value for each virtual disk specified by the VirtualDiskNames parameter. Allowed values are NoAccess, ReadOnly, ReadWrite, and Unknown

Type:DeviceAccess[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeviceNumbers

Specifies the device numbers for one or more virtual disks.

Type:UInt16[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the MaskingSet object to which you want to a virtual disk. Specify a MaskingSet CIM object, which are output by the Get-MaskingSet and New-MaskingSet cmdlets.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MaskingSetFriendlyName

Specifies the friendly name of the masking set to which you want to add a virtual disk.

Type:String[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MaskingSetUniqueId

Specifies an UniqueID of the masking set to which you want to add a virtual disk.

Type:String[]
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Specifies that the cmdlet should output an object representing the masking set to which it added a virtual disk. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualDisknames

Specifies one or more virtual disk names that are to be added to the masking set.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance

You can pipe a MaskingSet object to the InputObject parameter.

Outputs

CimInstance

If you specify the Passthru parameter, this cmdlet outputs an object that represents the masking set to which you added a virtual disk.