Get-InitiatorPort

Get-InitiatorPort

Gets one or more host bus adapter (HBA) initiator ports.

Syntax

Parameter Set: ByNodeAddress
Get-InitiatorPort [[-NodeAddress] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ConnectionType <ConnectionType[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByInstanceName
Get-InitiatorPort [-AsJob] [-CimSession <CimSession[]> ] [-ConnectionType <ConnectionType[]> ] [-InstanceName <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByiSCSIConnection
Get-InitiatorPort [-AsJob] [-CimSession <CimSession[]> ] [-iSCSIConnection <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByiSCSISession
Get-InitiatorPort [-AsJob] [-CimSession <CimSession[]> ] [-iSCSISession <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByiSCSITarget
Get-InitiatorPort [-AsJob] [-CimSession <CimSession[]> ] [-iSCSITarget <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByObjectId
Get-InitiatorPort [-AsJob] [-CimSession <CimSession[]> ] [-ObjectId <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

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

Detailed Description

The Get-InitiatorPort cmdlet gets and displays host bus adapter (HBA) initiator ports, such as SAS, FibreChannel, and iSCSI ports. Typically used either for connection to an iSCSI target in the case of iSCSI, or for in the management of masking sets in the case of FibreChannel.

Parameters

-AsJob

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

-ConnectionType<ConnectionType[]>

Specifies the type of the connection. Acceptable values are: Other, FibreChannel, iSCSI, and SAS.

To specify a custom connection type, specify the Other value and specify a non-NULL value for the OtherConnectionTypeDescription property.

-InstanceName<String[]>

Specifies the instance name of the initiator.

-NodeAddress<String[]>

Specifies the node address for the initiator.

-ObjectId<String[]>

Specifies the ObjectID of the initiator.

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

-VirtualDisk<CimInstance>

Specifies the VirtualDisk object for which you want to get the initiator port. Enter a VirtualDisk CIM object, which is exposed by the Get-VirtualDisk cmdlet.

-iSCSIConnection<CimInstance>

Specifies the iSCSIConnection object for which you want to get the initiator port. Enter an iSCSIConnection CIM object, which is exposed by the Get-IscsiConnection cmdlet.

-iSCSISession<CimInstance>

Specifies the iSCSISession object for which you want to get the initiator port. Enter an iSCSISession CIM object, which is exposed by the Get-IscsiSession cmdlet.

-iSCSITarget<CimInstance>

Specifies the iSCSITarget object for which you want to get the initiator port. Enter an iSCSITarget CIM object, which is exposed by the Get-IscsiTarget cmdlet.

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

  You can pipe an iSCSIConnection object to the iSCSIConnection parameter.

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

  You can pipe an iSCSISession object to the iSCSISession parameter.

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

  You can pipe an IscsiTarget object to the IscsiTarget 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_InitiatorPort

  This cmdlet returns an object that represents the initiator port you specified.

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 initiator ports

This example gets all available initiator ports.

PS C:\> Get-InitiatorPort

Example 2: Get all initiator ports, and filter the display

This example gets all available initiator ports. selects only the NodeAddress and ConnectionType properties, and then displays this information.

PS C:\> Get-InitiatorPort | Select-Object -Property NodeAddress,ConnectionType | Format-Table -AutoSize

Related topics

Set-InitiatorPort

Format-Table

Select-Object