Get-MaskingSet

  • [アーティクル]

Get-MaskingSet

Gets masking sets. Masking sets are used to grant access to a virtual disk or iSCSI VHD for one or more servers.

Syntax

Parameter Set: ByFriendlyName
Get-MaskingSet [[-FriendlyName] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-HostType <HostType[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByInitiatorId
Get-MaskingSet [-AsJob] [-CimSession <CimSession[]> ] [-InitiatorId <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByStorageSubSystem
Get-MaskingSet [-AsJob] [-CimSession <CimSession[]> ] [-StorageSubSystem <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByTargetPort
Get-MaskingSet [-AsJob] [-CimSession <CimSession[]> ] [-TargetPort <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByUniqueId
Get-MaskingSet [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-UniqueId <String[]> ] [ <CommonParameters>]

Parameter Set: ByVirtualDisk
Get-MaskingSet [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-VirtualDisk <CimInstance> ] [ <CommonParameters>]

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

Parameters

-AsJob

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

-FriendlyName<String[]>

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

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

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

Aliases

none

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.

Aliases

none

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.

Aliases

none

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.

Aliases

none

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.

Aliases

none

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.

Aliases

Id

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.

Aliases

none

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_InitiatorId

    You can pipe an InitiatorId object to the InitiatorId parameter.

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageSubsystem

    You can pipe a StorageSubsystem object to the StorageSubsystem parameter.

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_TargetPort

    You can pipe a TargetPort object to the TargetPort parameter.

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk

    You can pipe a VirtualDisk object to the VirtualDisk parameter.

Outputs

The output type is the type of the objects that the cmdlet emits.

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

    This cmdlet outputs an object that represents a masking set.

Notes

  • The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

Example 1: Get all masking sets

This example gets and displays all existing MaskingSet objects which have been created using any available Storage Management Providers across all visible storage subsystems.

PS C:\> Get-MaskingSet

Example 2: Get all Microsoft Windows masking sets

This example gets and displays all masking sets hosted by a computer running Microsoft Windows.

PS C:\> Get-MaskingSet -HostType MicrosoftWindows

Example 3: Get the masking set for a specific virtual disk

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.

PS C:\> Get-MaskingSet -VirtualDisk (Get-VirtualDisk -FriendlyName CompanyData)

Get-InitiatorPort

Get-TargetPort

New-MaskingSet

Remove-MaskingSet

Rename-MaskingSet

Get-VirtualDisk