Edit

Share via

Get-MaskingSet

  • Reference
Module:
Storage

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[]>]
   [-HostType <HostType[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-MaskingSet
   [-UniqueId <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-MaskingSet
   [-TargetPort <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-MaskingSet
   [-InitiatorId <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-MaskingSet
   [-StorageSubSystem <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-MaskingSet
   [-VirtualDisk <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<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

Examples

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.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FriendlyName

Gets the masking set with the specified friendly name or friendly name pattern.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

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

Type:HostType[]
Accepted values:Unknown, Other, Standard, Solaris, HPUX, OpenVMS, Tru64, Netware, Sequent, AIX, DGUX, Dynix, Irix, CiscoISCSIStorageRouter, Linux, MicrosoftWindows, OS400, TRESPASS, HIUX, VMwareESXi, MicrosoftWindowsServer2008, MicrosoftWindowsServer2003
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InitiatorId

Gets the masking set associated with the specified InitiatorId object. Enter an InitiatorID CIM object, which is exposed by the Get-InitiatorId cmdlet.

Type:CimInstance
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageSubSystem

Gets the masking set associated with the specified StorageSubSystem object. Enter a StorageSubSystem CIM object, which is exposed by the Get-StorageSubSystem cmdlet.

Type:CimInstance
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TargetPort

Gets the masking set associated with the specified TargetPort object. Enter a TargetPort CIM object, which is exposed by the Get-TargetPort cmdlet.

Type:CimInstance
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UniqueId

Specifies the UniqueID of the masking set to get.

Type:String[]
Aliases:Id
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VirtualDisk

Gets the masking set associated with the specified VirtualDisk object. Enter a VirtualDisk CIM object, which is exposed by the Get-VirtualDisk cmdlet.

Type:CimInstance
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

CimInstance

You can pipe an InitiatorId object to the InitiatorId parameter.

CimInstance

You can pipe a StorageSubsystem object to the StorageSubsystem parameter.

CimInstance

You can pipe a TargetPort object to the TargetPort parameter.

CimInstance

You can pipe a VirtualDisk object to the VirtualDisk parameter.

Outputs

CimInstance

This cmdlet outputs an object that represents a masking set.

Notes

  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).