Get-InitiatorId
Gets the InitiatorID objects for the specified iSCSI initiators.
Syntax
Get-InitiatorId
[[-InitiatorAddress] <String[]>]
[-HostType <HostType[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-InitiatorId
[-UniqueId <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-InitiatorId
[-MaskingSet <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-InitiatorId
[-VirtualDisk <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-InitiatorId
[-StorageSubSystem <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Description
The Get-InitiatorId cmdlet gets the InitiatorID objects for the specified iSCSI initiators.
Examples
Example 1: Get all InitiatorIDs
PS C:\>Get-InitiatorIDThis 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-StorageProviderThis 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 InitiatorID 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.
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 |
-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 |
-InitiatorAddress
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.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MaskingSet
Gets the InitiatorID objects associated with the specified MaskingSet object. Enter a MaskingSet CIM object, which is exposed by the Get-MaskingSet cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageSubSystem
Gets the InitiatorID objects 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 |
-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(s) of the InitiatorID(s) you want to get. Separate multiple UniqueIDs with commas, and enclose brackets in quotation marks.
| Type: | String[] |
| Aliases: | Id |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VirtualDisk
Gets the InitiatorID objects 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
You can pipe a MaskingSet object to the MaskingSet parameter.
You can pipe a StorageSubsystem object to the StorageSubsystem parameter.
You can pipe a VirtualDisk object to the VirtualDisk parameter.
Outputs
This cmdlet returns an object that represents an initiator ID.
Notes
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).