< Back
Get-InitiatorId
Post
NAME Get-InitiatorId
SYNOPSIS
Gets the InitiatorID objects for the specified iSCSI initiators.
SYNTAX
Get-InitiatorId [[-InitiatorAddress] <String[]>] [-CimSession <CimSession[]>] [-HostType <HostType[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-InitiatorId [-CimSession <CimSession[]>] [-StorageSubSystem <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-InitiatorId [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-UniqueId <String[]>] [<CommonParameters>]
Get-InitiatorId [-CimSession <CimSession[]>] [-MaskingSet <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-InitiatorId [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-VirtualDisk <CimInstance>] [<CommonParameters>]
DESCRIPTION
The Get-InitiatorId cmdlet gets the InitiatorID objects for the specified iSCSI initiators.
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
-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
-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.
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.
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.
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(s) of the InitiatorID(s) you want to get. Separate multiple UniqueIDs with commas, and enclose brackets in quotation marks.
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.
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_MaskingSet
http://msdn.microsoft.com/library/windo ... 30509.aspx
You can pipe a MaskingSet object to the MaskingSet 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_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_InitiatorId
http://msdn.microsoft.com/library/windo ... 30504.aspx
This cmdlet returns an object that represents an initiator ID.
Example 1: Get all InitiatorIDs
PS C:\\>Get-InitiatorID
This example gets and displays all iSCSI initiator IDs on the computer.
Example 2: Get the storage providers for each InitiatorID
PS C:\\>Get-InitiatorId | Get-StorageSubSystem | Get-StorageProvider
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.
Example 3:Get the InitatorID objects for a masking set
PS C:\\>Get-InitiatorId -MaskingSet (Get-MaskingSet -FriendlyName *EQLV1)
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816382
Get-InitiatorPort
Remove-InitiatorId
SYNOPSIS
Gets the InitiatorID objects for the specified iSCSI initiators.
SYNTAX
Get-InitiatorId [[-InitiatorAddress] <String[]>] [-CimSession <CimSession[]>] [-HostType <HostType[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-InitiatorId [-CimSession <CimSession[]>] [-StorageSubSystem <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-InitiatorId [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-UniqueId <String[]>] [<CommonParameters>]
Get-InitiatorId [-CimSession <CimSession[]>] [-MaskingSet <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-InitiatorId [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-VirtualDisk <CimInstance>] [<CommonParameters>]
DESCRIPTION
The Get-InitiatorId cmdlet gets the InitiatorID objects for the specified iSCSI initiators.
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
-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
-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.
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.
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.
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(s) of the InitiatorID(s) you want to get. Separate multiple UniqueIDs with commas, and enclose brackets in quotation marks.
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.
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_MaskingSet
http://msdn.microsoft.com/library/windo ... 30509.aspx
You can pipe a MaskingSet object to the MaskingSet 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_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_InitiatorId
http://msdn.microsoft.com/library/windo ... 30504.aspx
This cmdlet returns an object that represents an initiator ID.
Example 1: Get all InitiatorIDs
PS C:\\>Get-InitiatorID
This example gets and displays all iSCSI initiator IDs on the computer.
Example 2: Get the storage providers for each InitiatorID
PS C:\\>Get-InitiatorId | Get-StorageSubSystem | Get-StorageProvider
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.
Example 3:Get the InitatorID objects for a masking set
PS C:\\>Get-InitiatorId -MaskingSet (Get-MaskingSet -FriendlyName *EQLV1)
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816382
Get-InitiatorPort
Remove-InitiatorId