Get-InitiatorId
Gets the InitiatorID objects for the specified iSCSI initiators.
Syntax
ByAddress (Default)
Get-InitiatorId
[[-InitiatorAddress] <String[]>]
[-HostType <HostType[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByUniqueId
Get-InitiatorId
[-UniqueId <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByMaskingSet
Get-InitiatorId
[-MaskingSet <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByVirtualDisk
Get-InitiatorId
[-VirtualDisk <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByStorageSubSystem
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-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 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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | HostType[] |
| Default value: | None |
| Accepted values: | Unknown, Other, Standard, Solaris, HPUX, OpenVMS, Tru64, Netware, Sequent, AIX, DGUX, Dynix, Irix, CiscoISCSIStorageRouter, Linux, MicrosoftWindows, OS400, TRESPASS, HIUX, VMwareESXi, MicrosoftWindowsServer2008, MicrosoftWindowsServer2003 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByAddress
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByAddress
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByMaskingSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByStorageSubSystem
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Id |
Parameter sets
ByUniqueId
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByVirtualDisk
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
CimInstance
You can pipe a MaskingSet object to the MaskingSet parameter.
CimInstance
You can pipe a StorageSubsystem object to the StorageSubsystem parameter.
CimInstance
You can pipe a VirtualDisk object to the VirtualDisk parameter.
Outputs
CimInstance
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).