Add-Virtual Disk ToMasking Set

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[]>
   [-VirtualDisknames <String[]>]
   [-DeviceNumbers <UInt16[]>]
   [-DeviceAccesses <DeviceAccess[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-VirtualDiskToMaskingSet
   -MaskingSetUniqueId <String[]>
   [-VirtualDisknames <String[]>]
   [-DeviceNumbers <UInt16[]>]
   [-DeviceAccesses <DeviceAccess[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-VirtualDiskToMaskingSet
   -InputObject <CimInstance[]>
   [-VirtualDisknames <String[]>]
   [-DeviceNumbers <UInt16[]>]
   [-DeviceAccesses <DeviceAccess[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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.

Required Parameters

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-MaskingSetUniqueId

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

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

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Position: Named
Default value: None
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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

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

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: 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[]
Parameter Sets: Unknown, ReadWrite, ReadOnly, NoAccess
Position: Named
Default value: None
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
Accept pipeline input: False
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
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
Accept pipeline input: False
Accept wildcard characters: False
-VirtualDisknames

Specifies one or more virtual disk names to add to the masking set.

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

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

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

Inputs

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_MaskingSet

You can pipe a MaskingSet object to the InputObject parameter.

Outputs

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_MaskingSet

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