< Back
New-MaskingSet
Post
NAME New-MaskingSet
SYNOPSIS
Creates a new masking set.
SYNTAX
New-MaskingSet [-StorageSubSystemFriendlyName] <String[]> [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers <String[]>]
[-FriendlyName <String>] [-HostType {Unknown | Other | Standard | Solaris | HPUX | OpenVMS | Tru64 | Netware | Sequent | AIX | DGUX | Dynix | Irix |
CiscoISCSIStorageRouter | Linux | MicrosoftWindows | OS400 | TRESPASS | HIUX | VMwareESXi | MicrosoftWindowsServer2008 | MicrosoftWindowsServer2003}]
[-InitiatorAddresses <String[]>] [-TargetPortAddresses <String[]>] [-ThrottleLimit <Int32>] [-VirtualDiskNames <String[]>] [<CommonParameters>]
New-MaskingSet [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers <String[]>] [-FriendlyName <String>] [-HostType {Unknown
| Other | Standard | Solaris | HPUX | OpenVMS | Tru64 | Netware | Sequent | AIX | DGUX | Dynix | Irix | CiscoISCSIStorageRouter | Linux |
MicrosoftWindows | OS400 | TRESPASS | HIUX | VMwareESXi | MicrosoftWindowsServer2008 | MicrosoftWindowsServer2003}] [-InitiatorAddresses <String[]>]
[-TargetPortAddresses <String[]>] [-ThrottleLimit <Int32>] [-VirtualDiskNames <String[]>] -StorageSubSystemName <String[]> [<CommonParameters>]
New-MaskingSet [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers <String[]>] [-FriendlyName <String>] [-HostType {Unknown
| Other | Standard | Solaris | HPUX | OpenVMS | Tru64 | Netware | Sequent | AIX | DGUX | Dynix | Irix | CiscoISCSIStorageRouter | Linux |
MicrosoftWindows | OS400 | TRESPASS | HIUX | VMwareESXi | MicrosoftWindowsServer2008 | MicrosoftWindowsServer2003}] [-InitiatorAddresses <String[]>]
[-TargetPortAddresses <String[]>] [-ThrottleLimit <Int32>] [-VirtualDiskNames <String[]>] -StorageSubSystemUniqueId <String[]> [<CommonParameters>]
New-MaskingSet [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers <String[]>] [-FriendlyName <String>] [-HostType {Unknown
| Other | Standard | Solaris | HPUX | OpenVMS | Tru64 | Netware | Sequent | AIX | DGUX | Dynix | Irix | CiscoISCSIStorageRouter | Linux |
MicrosoftWindows | OS400 | TRESPASS | HIUX | VMwareESXi | MicrosoftWindowsServer2008 | MicrosoftWindowsServer2003}] [-InitiatorAddresses <String[]>]
[-TargetPortAddresses <String[]>] [-ThrottleLimit <Int32>] [-VirtualDiskNames <String[]>] [<CommonParameters>]
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.
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 [<String[]>]
Specifies the device numbers for one or more virtual disks. Some storage providers do not use device numbers.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InitiatorAddresses [<String[]>]
Specifies the initiator addresses.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-StorageSubSystemFriendlyName <String[]>
Specifies the friendly name of the storage subsystem.
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.
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.
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.
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 include in the masking set.
Required? false
Position? named
Default value none
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_StorageSubsystem
http://msdn.microsoft.com/library/windo ... 30569.aspx
You can pipe a StorageSubsystem object to the InputObject parameter.
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_MaskingSet
http://msdn.microsoft.com/library/windo ... 30509.aspx
This cmdlet outputs an object representing the newly created masking set.
Example 1: Create a masking set
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
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816433
Get-MaskingSet
Get-InitiatorPort
Get-TargetPort
Get-VirtualDisk
Remove-MaskingSet
Rename-MaskingSet
SYNOPSIS
Creates a new masking set.
SYNTAX
New-MaskingSet [-StorageSubSystemFriendlyName] <String[]> [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers <String[]>]
[-FriendlyName <String>] [-HostType {Unknown | Other | Standard | Solaris | HPUX | OpenVMS | Tru64 | Netware | Sequent | AIX | DGUX | Dynix | Irix |
CiscoISCSIStorageRouter | Linux | MicrosoftWindows | OS400 | TRESPASS | HIUX | VMwareESXi | MicrosoftWindowsServer2008 | MicrosoftWindowsServer2003}]
[-InitiatorAddresses <String[]>] [-TargetPortAddresses <String[]>] [-ThrottleLimit <Int32>] [-VirtualDiskNames <String[]>] [<CommonParameters>]
New-MaskingSet [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers <String[]>] [-FriendlyName <String>] [-HostType {Unknown
| Other | Standard | Solaris | HPUX | OpenVMS | Tru64 | Netware | Sequent | AIX | DGUX | Dynix | Irix | CiscoISCSIStorageRouter | Linux |
MicrosoftWindows | OS400 | TRESPASS | HIUX | VMwareESXi | MicrosoftWindowsServer2008 | MicrosoftWindowsServer2003}] [-InitiatorAddresses <String[]>]
[-TargetPortAddresses <String[]>] [-ThrottleLimit <Int32>] [-VirtualDiskNames <String[]>] -StorageSubSystemName <String[]> [<CommonParameters>]
New-MaskingSet [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers <String[]>] [-FriendlyName <String>] [-HostType {Unknown
| Other | Standard | Solaris | HPUX | OpenVMS | Tru64 | Netware | Sequent | AIX | DGUX | Dynix | Irix | CiscoISCSIStorageRouter | Linux |
MicrosoftWindows | OS400 | TRESPASS | HIUX | VMwareESXi | MicrosoftWindowsServer2008 | MicrosoftWindowsServer2003}] [-InitiatorAddresses <String[]>]
[-TargetPortAddresses <String[]>] [-ThrottleLimit <Int32>] [-VirtualDiskNames <String[]>] -StorageSubSystemUniqueId <String[]> [<CommonParameters>]
New-MaskingSet [-CimSession <CimSession[]>] [-DeviceAccesses <DeviceAccess[]>] [-DeviceNumbers <String[]>] [-FriendlyName <String>] [-HostType {Unknown
| Other | Standard | Solaris | HPUX | OpenVMS | Tru64 | Netware | Sequent | AIX | DGUX | Dynix | Irix | CiscoISCSIStorageRouter | Linux |
MicrosoftWindows | OS400 | TRESPASS | HIUX | VMwareESXi | MicrosoftWindowsServer2008 | MicrosoftWindowsServer2003}] [-InitiatorAddresses <String[]>]
[-TargetPortAddresses <String[]>] [-ThrottleLimit <Int32>] [-VirtualDiskNames <String[]>] [<CommonParameters>]
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.
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 [<String[]>]
Specifies the device numbers for one or more virtual disks. Some storage providers do not use device numbers.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InitiatorAddresses [<String[]>]
Specifies the initiator addresses.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-StorageSubSystemFriendlyName <String[]>
Specifies the friendly name of the storage subsystem.
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.
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.
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.
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 include in the masking set.
Required? false
Position? named
Default value none
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_StorageSubsystem
http://msdn.microsoft.com/library/windo ... 30569.aspx
You can pipe a StorageSubsystem object to the InputObject parameter.
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_MaskingSet
http://msdn.microsoft.com/library/windo ... 30509.aspx
This cmdlet outputs an object representing the newly created masking set.
Example 1: Create a masking set
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
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816433
Get-MaskingSet
Get-InitiatorPort
Get-TargetPort
Get-VirtualDisk
Remove-MaskingSet
Rename-MaskingSet