| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
MaskingSet.cdxml-help.xml |
Storage |
12/20/2016 |
2.0.0 |
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.
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>]
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
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.
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns 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[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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: (All)
Aliases:
Accepted values: Unknown, ReadWrite, ReadOnly, NoAccess
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the device numbers for one or more virtual disks.
Type: UInt16[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the input object that is used in a pipeline command.
Type: CimInstance[]
Parameter Sets: InputObject (cdxml)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the friendly name of the masking set to which you want to add a virtual disk.
Type: String[]
Parameter Sets: ByFriendlyName
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the UniqueID of the masking set to which you want to add a virtual disk.
Type: String[]
Parameter Sets: ByUniqueId
Aliases: Id
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies one or more virtual disk names to add to the masking set.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe a MaskingSet object to the InputObject parameter.
If you specify the Passthru parameter, this cmdlet outputs an object that represents the masking set to which you added a virtual disk.
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).