Get-InitiatorId

Get-InitiatorId

Gets the InitiatorID objects for the specified iSCSI initiators.

Syntax

Parameter Set: ByAddress
Get-InitiatorId [[-InitiatorAddress] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-HostType <HostType[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

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

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

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

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

Detailed Description

The Get-InitiatorId cmdlet gets the InitiatorID objects for the specified iSCSI initiators.

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

-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

-InitiatorAddress<String[]>

Specifies the address of the InitiatorID object you want to get. These are the port addresses of the hosts to which the virtual disks will be made available.

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-MaskingSet<CimInstance>

Gets the InitiatorID objects associated with the specified MaskingSet object. Enter a MaskingSet CIM object, which is exposed by the Get-MaskingSet cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-StorageSubSystem<CimInstance>

Gets the InitiatorID objects 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

-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(s) of the InitiatorID(s) you want to get. Separate multiple UniqueIDs with commas, and enclose brackets in quotation marks.

Aliases	Id
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-VirtualDisk<CimInstance>

Gets the InitiatorID objects 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_MaskingSet

  You can pipe a MaskingSet object to the MaskingSet 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_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_InitiatorId

  This cmdlet returns an object that represents an initiator ID.

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 InitiatorIDs

This example gets and displays all iSCSI initiator IDs on the computer.

PS C:\> Get-InitiatorID

Example 2: Get the storage providers for each InitiatorID

This example gets and displays the storage providers for each InitiatorID by piping the output from the Get-InitiatorId cmdlet to the Get-StorageSubSystem cmdlet, and then piping that cmdlet’s output to the Get-StorageProvider cmdlet.

PS C:\> Get-InitiatorId | Get-StorageSubSystem | Get-StorageProvider

Example 3:Get the InitatorID objects for a masking set

This example uses the Get-MaskingSet cmdlet to get the masking set with a friendly name that ends with EQLV1, and then gets all associated InitiatorID objects.

PS C:\> Get-InitiatorId -MaskingSet (Get-MaskingSet -FriendlyName *EQLV1)

Related topics

Connect-iSCSITarget

Get-InitiatorPort

Remove-InitiatorId