< Back
Get-MaskingSet
Post
NAME Get-MaskingSet
SYNOPSIS
Gets masking sets. Masking sets are used to grant access to a virtual disk or iSCSI VHD for one or more servers.
SYNTAX
Get-MaskingSet [[-FriendlyName] <String[]>] [-CimSession <CimSession[]>] [-HostType <HostType[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-MaskingSet [-CimSession <CimSession[]>] [-InitiatorId <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-MaskingSet [-CimSession <CimSession[]>] [-TargetPort <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-MaskingSet [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-VirtualDisk <CimInstance>] [<CommonParameters>]
Get-MaskingSet [-CimSession <CimSession[]>] [-StorageSubSystem <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-MaskingSet [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-UniqueId <String[]>] [<CommonParameters>]
DESCRIPTION
The Get-MaskingSet cmdlet returns a list of created masking sets. Masking sets are used to grant access to a virtual disk or iSCSI VHD for one or more
servers.
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
-FriendlyName [<String[]>]
Gets the masking set with the specified friendly name or friendly name pattern.
Required? false
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-HostType [<HostType[]>]
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. If the HostType property is blank for the object you want to get, omit this parameter.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InitiatorId [<CimInstance>]
Gets the masking set associated with the specified InitiatorId object. Enter an InitiatorID CIM object, which is exposed by the Get-InitiatorId
cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-StorageSubSystem [<CimInstance>]
Gets the masking set associated with the specified StorageSubSystem object. Enter a StorageSubSystem CIM object, which is exposed by the
Get-StorageSubSystem cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-TargetPort [<CimInstance>]
Gets the masking set associated with the specified TargetPort object. Enter a TargetPort CIM object, which is exposed by the Get-TargetPort cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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
-UniqueId [<String[]>]
Specifies the UniqueID of the masking set to get.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualDisk [<CimInstance>]
Gets the masking set associated with the specified VirtualDisk object. Enter a VirtualDisk CIM object, which is exposed by the Get-VirtualDisk
cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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_InitiatorId
http://msdn.microsoft.com/library/windo ... 30504.aspx
You can pipe an InitiatorId object to the InitiatorId parameter.
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 StorageSubsystem parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_TargetPort
http://msdn.microsoft.com/library/windo ... 30582.aspx
You can pipe a TargetPort object to the TargetPort parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk
http://msdn.microsoft.com/library/windo ... 30584.aspx
You can pipe a VirtualDisk object to the VirtualDisk 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 that represents a masking set.
Example 1: Get all masking sets
PS C:\\> Get-MaskingSet
This example gets and displays all existing MaskingSet objects which have been created using any available Storage Management Providers across all
visible storage subsystems.
Example 2: Get all Microsoft Windows masking sets
PS C:\\> Get-MaskingSet -HostType MicrosoftWindows
This example gets and displays all masking sets hosted by a computer running Microsoft Windows.
Example 3: Get the masking set for a specific virtual disk
PS C:\\> Get-MaskingSet -VirtualDisk (Get-VirtualDisk -FriendlyName CompanyData)
This example gets the masking set for the CompanyData virtual disk. It does so by using the Get-VirtualDisk cmdlet to get the appropriate VirtualDisk
object and provide it to the VirtualDisk parameter of Get-MaskingSet.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816390
Get-InitiatorPort
Get-TargetPort
New-MaskingSet
Remove-MaskingSet
Rename-MaskingSet
Get-VirtualDisk
SYNOPSIS
Gets masking sets. Masking sets are used to grant access to a virtual disk or iSCSI VHD for one or more servers.
SYNTAX
Get-MaskingSet [[-FriendlyName] <String[]>] [-CimSession <CimSession[]>] [-HostType <HostType[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-MaskingSet [-CimSession <CimSession[]>] [-InitiatorId <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-MaskingSet [-CimSession <CimSession[]>] [-TargetPort <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-MaskingSet [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-VirtualDisk <CimInstance>] [<CommonParameters>]
Get-MaskingSet [-CimSession <CimSession[]>] [-StorageSubSystem <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-MaskingSet [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-UniqueId <String[]>] [<CommonParameters>]
DESCRIPTION
The Get-MaskingSet cmdlet returns a list of created masking sets. Masking sets are used to grant access to a virtual disk or iSCSI VHD for one or more
servers.
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
-FriendlyName [<String[]>]
Gets the masking set with the specified friendly name or friendly name pattern.
Required? false
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-HostType [<HostType[]>]
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. If the HostType property is blank for the object you want to get, omit this parameter.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InitiatorId [<CimInstance>]
Gets the masking set associated with the specified InitiatorId object. Enter an InitiatorID CIM object, which is exposed by the Get-InitiatorId
cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-StorageSubSystem [<CimInstance>]
Gets the masking set associated with the specified StorageSubSystem object. Enter a StorageSubSystem CIM object, which is exposed by the
Get-StorageSubSystem cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-TargetPort [<CimInstance>]
Gets the masking set associated with the specified TargetPort object. Enter a TargetPort CIM object, which is exposed by the Get-TargetPort cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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
-UniqueId [<String[]>]
Specifies the UniqueID of the masking set to get.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualDisk [<CimInstance>]
Gets the masking set associated with the specified VirtualDisk object. Enter a VirtualDisk CIM object, which is exposed by the Get-VirtualDisk
cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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_InitiatorId
http://msdn.microsoft.com/library/windo ... 30504.aspx
You can pipe an InitiatorId object to the InitiatorId parameter.
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 StorageSubsystem parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_TargetPort
http://msdn.microsoft.com/library/windo ... 30582.aspx
You can pipe a TargetPort object to the TargetPort parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk
http://msdn.microsoft.com/library/windo ... 30584.aspx
You can pipe a VirtualDisk object to the VirtualDisk 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 that represents a masking set.
Example 1: Get all masking sets
PS C:\\> Get-MaskingSet
This example gets and displays all existing MaskingSet objects which have been created using any available Storage Management Providers across all
visible storage subsystems.
Example 2: Get all Microsoft Windows masking sets
PS C:\\> Get-MaskingSet -HostType MicrosoftWindows
This example gets and displays all masking sets hosted by a computer running Microsoft Windows.
Example 3: Get the masking set for a specific virtual disk
PS C:\\> Get-MaskingSet -VirtualDisk (Get-VirtualDisk -FriendlyName CompanyData)
This example gets the masking set for the CompanyData virtual disk. It does so by using the Get-VirtualDisk cmdlet to get the appropriate VirtualDisk
object and provide it to the VirtualDisk parameter of Get-MaskingSet.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816390
Get-InitiatorPort
Get-TargetPort
New-MaskingSet
Remove-MaskingSet
Rename-MaskingSet
Get-VirtualDisk