Add-VirtualDiskToMaskingSet

Add-VirtualDiskToMaskingSet

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

Parameter Set: ByFriendlyName
Add-VirtualDiskToMaskingSet [-MaskingSetFriendlyName] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-DeviceAccesses <DeviceAccess[]> ] [-DeviceNumbers <UInt16[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-VirtualDisknames <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByUniqueId
Add-VirtualDiskToMaskingSet -MaskingSetUniqueId <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-DeviceAccesses <DeviceAccess[]> ] [-DeviceNumbers <UInt16[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-VirtualDisknames <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Add-VirtualDiskToMaskingSet -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-DeviceAccesses <DeviceAccess[]> ] [-DeviceNumbers <UInt16[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-VirtualDisknames <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed 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.

Parameters

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CimSession<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.

Aliases	Session
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DeviceAccesses<DeviceAccess[]>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DeviceNumbers<UInt16[]>

Specifies the device numbers for one or more virtual disks.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InputObject<CimInstance[]>

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.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-MaskingSetFriendlyName<String[]>

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

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-MaskingSetUniqueId<String[]>

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

Aliases	Id
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ThrottleLimit<Int32>

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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VirtualDisknames<String[]>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

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

  You can pipe a MaskingSet object to the InputObject parameter.

Outputs

The output type is the type of the objects that the cmdlet emits.

• 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.

Notes

• The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

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

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

PS C:\> $maskingSet = Get-MaskingSet Cluster1MaskingSet

PS C:\> $virtualDisk = Get-VirtualDisk Volume12

PS C:\> $maskingSet | Add-VirtualDiskToMaskingSet -VirtualDisknames $virtualDisk.Name -DeviceAccesses ReadWrite

Related topics

Get-MaskingSet

Get-VirtualDisk