Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-MaskingSet

New-MaskingSet

storagesubsystem.cdxml

Synopsis

Creates a new masking set.

Syntax

New-MaskingSet [-StorageSubSystemFriendlyName] [-AsJob] [-CimSession] [-DeviceAccesses] [-DeviceNumbers] [-FriendlyName] [-HostType] [-InitiatorAddresses] [-TargetPortAddresses] [-ThrottleLimit] [-VirtualDiskNames] [<CommonParameters>]

New-MaskingSet [-AsJob] [-CimSession] [-DeviceAccesses] [-DeviceNumbers] [-FriendlyName] [-HostType] [-InitiatorAddresses] [-TargetPortAddresses] [-ThrottleLimit] [-VirtualDiskNames] [-StorageSubSystemUniqueId] [<CommonParameters>]

New-MaskingSet [-AsJob] [-CimSession] [-DeviceAccesses] [-DeviceNumbers] [-FriendlyName] [-HostType] [-InitiatorAddresses] [-TargetPortAddresses] [-ThrottleLimit] [-VirtualDiskNames] [-StorageSubSystemName] [<CommonParameters>]

New-MaskingSet [-AsJob] [-CimSession] [-DeviceAccesses] [-DeviceNumbers] [-FriendlyName] [-HostType] [-InitiatorAddresses] [-TargetPortAddresses] [-ThrottleLimit] [-VirtualDiskNames] [-InputObject] [<CommonParameters>]

Detailed Description

The New-MaskingSet cmdlet creates a new masking set. Masking sets allow management of groups of TargetPort, VirtualDisk, and InitiatorID objects to manage access to virtual disks, either for individual computers or multiple computers in the case of a Failover Cluster configuration. Once a masking set is created, adding or removing a virtual disk grants or removes access to all resources in the masking set. Adding or removing initiator addresses can show or hide the virtual disks in this masking set to hosts.

This cmdlet is not needed when using the Storage Spaces subsystem.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

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 <String[]>

Specifies the device numbers for one or more virtual disks. Some storage providers do not use device numbers.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-FriendlyName <String>

Specifies the friendly name for the new masking set.

Aliases

MaskingSetFriendlyName

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-HostType <HostMode>

Specifies the host operating system or other host environmental factors that may influence the behavior that the storage system should have when showing a virtual disk to an initiator.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InitiatorAddresses <String[]>

Specifies the initiator addresses.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Accepts a StorageSubsystem object from the pipeline as input. Enter a StorageSubsystem CIM object, which is returned by the Get-StorageSubSystem cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-StorageSubSystemFriendlyName <String[]>

Specifies the friendly name of the storage subsystem.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-StorageSubSystemName <String[]>

Specifies the name of the storage subsystem provided by the Storage Management.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-StorageSubSystemUniqueId <String[]>

Specifies the UniqueID of the storage subsystem to use.

Aliases

StorageSubsystemId

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-TargetPortAddresses <String[]>

Specifies one or more target port addresses.

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 to include in the masking set.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

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

Return Type

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

Notes

None

Examples

Example 1: Create a masking set

This example collects the necessary information and then creating a new masking set to expose the virtual disks that have the friendly names VirtualDisk01 and VirtualDisk02 to the local machine.

PS C:\> $StorageSubsystem = Get-StorageSubsystem
PS C:\> $VirtualDisks = Get-VirtualDisk -Name "Virtual01,Virtual02"
PS C:\> $Initiator = Get-InitiatorPort
PS C:\> $Target = Get-TargetPort
PS C:\> New-MaskingSet -StorageSubsystemFriendlyName $StorageSubsystem.FriendlyName -VirtualDiskNames $VirtualDisks.Name -FriendlyName "MyFirstMaskingSet" -InitiatorAddresses $Initiator.NodeAddress -TargetPortAddresses $Target.PortAddress

Online Version
Get-MaskingSet
Get-InitiatorPort
Get-StorageSubsystem
Get-TargetPort
Get-VirtualDisk
Remove-MaskingSet
Rename-MaskingSet