< Back

Add-VirtualDiskToMaskingSet

Wed Jan 30, 2019 6:01 pm

NAME Add-VirtualDiskToMaskingSet



SYNOPSIS

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[]> [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers

<UInt16[]>] [-PassThru] [-ThrottleLimit <Int32>] [-VirtualDisknames <String[]>] [-Confirm] [-WhatIf] [<CommonParameters>]



Add-VirtualDiskToMaskingSet [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers <UInt16[]>] [-PassThru] [-ThrottleLimit

<Int32>] [-VirtualDisknames <String[]>] -MaskingSetUniqueId <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]



Add-VirtualDiskToMaskingSet [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers <UInt16[]>] [-PassThru] [-ThrottleLimit

<Int32>] [-VirtualDisknames <String[]>] [-Confirm] [-WhatIf] [<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





PARAMETERS

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



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.



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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-MaskingSetFriendlyName <String[]>

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



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-MaskingSetUniqueId <String[]>

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



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

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.



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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-VirtualDisknames [<String[]>]

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



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.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, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

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

http://msdn.microsoft.com/library/windo ... 30509.aspx





You can pipe a MaskingSet object to the InputObject parameter.





OUTPUTS

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

http://msdn.microsoft.com/library/windo ... 30509.aspx





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





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.







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=809331

Get-MaskingSet

Get-VirtualDisk