Get-IscsiConnection

Module:

iSCSI Module

Gets information about connected iSCSI initiator connections.

Syntax

ByConnectionIdentifier (Default)

Get-IscsiConnection
    [-ConnectionIdentifier <String[]>]
    [-InitiatorPortalPortNumber <UInt16[]>]
    [-InititorIPAdressListNumber <UInt16[]>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByInitiatorSideIdentifier

Get-IscsiConnection
    [-InitiatorSideIdentifier <String[]>]
    [-InitiatorPortalPortNumber <UInt16[]>]
    [-InititorIPAdressListNumber <UInt16[]>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByTargetSideIdentifier

Get-IscsiConnection
    [-TargetSideIdentifier <String[]>]
    [-InitiatorPortalPortNumber <UInt16[]>]
    [-InititorIPAdressListNumber <UInt16[]>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByInitiatorPortalAddress

Get-IscsiConnection
    [-InitiatorPortalAddress <String[]>]
    [-InitiatorPortalPortNumber <UInt16[]>]
    [-InititorIPAdressListNumber <UInt16[]>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByiSCSITarget

Get-IscsiConnection
    [-InitiatorPortalPortNumber <UInt16[]>]
    [-InititorIPAdressListNumber <UInt16[]>]
    [-IscsiTarget <CimInstance>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByInitiatorPort

Get-IscsiConnection
    [-InitiatorPortalPortNumber <UInt16[]>]
    [-InititorIPAdressListNumber <UInt16[]>]
    [-InitiatorPort <CimInstance>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByiSCSISession

Get-IscsiConnection
    [-InitiatorPortalPortNumber <UInt16[]>]
    [-InititorIPAdressListNumber <UInt16[]>]
    [-IscsiSession <CimInstance>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByiSCSITargetPortal

Get-IscsiConnection
    [-InitiatorPortalPortNumber <UInt16[]>]
    [-InititorIPAdressListNumber <UInt16[]>]
    [-iSCSITargetPortal <CimInstance>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByDisk

Get-IscsiConnection
    [-InitiatorPortalPortNumber <UInt16[]>]
    [-InititorIPAdressListNumber <UInt16[]>]
    [-Disk <CimInstance>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

The Get-IscsiConnection cmdlet returns information about active iSCSI initiator connections.

Examples

Example 1: Display information about a connected iSCI target

PS C:\> Get-IscsiConnection
ConnectionIdentifier : fffffa8005313020-2
InitiatorNodeAddress : 0.0.0.0
InitiatorPortNumber  : 41458
TargetNodeAddress    : 10.121.235.126
TargetPortNumber     : 3260

The command displays information returned by this cmdlet from a connected iSCSI target.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

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

-ConnectionIdentifier

Specifies the connection identifier for an iSCSI session.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByConnectionIdentifier

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Disk

Accepts a MSFT disk object as an input. The MSFT disk object is output from the Get-Disk cmdlet.

Parameter properties

Type:	CimInstance
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByDisk

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InitiatorPort

Accepts a MSFT initiator port object as an input. The MSFT initiator port object is output from the Get-InitiatorPort cmdlet.

Parameter properties

Type:	CimInstance
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByInitiatorPort

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InitiatorPortalAddress

Specifies the IP address or DNS name that is associated with the portal.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByInitiatorPortalAddress

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-InitiatorPortalPortNumber

Specifies the TCP/IP port number for the initiator portal.

Parameter properties

Type:	UInt16[]
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:	True
Value from remaining arguments:	False

-InitiatorSideIdentifier

Specifies the initiator side identifier.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByInitiatorSideIdentifier

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-InititorIPAdressListNumber

Specifies the index to the initiator IP address list.

Parameter properties

Type:	UInt16[]
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:	True
Value from remaining arguments:	False

-IscsiSession

Accepts a MSFT iSCSI session object as an input. The MSFT iSCSI session object is output from the Get-IscsiSession cmdlet.

Parameter properties

Type:	CimInstance
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByiSCSISession

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-IscsiTarget

Accepts a MSFT iSCSI target object as an input. The MSFT iSCSI target object is output from the Get-IscsiTarget cmdlet.

Parameter properties

Type:	CimInstance
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByiSCSITarget

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-iSCSITargetPortal

Accepts a MSFT iSCSI target portal CIM object as an input. The MSFT iSCSI target portal CIM object is output from the Get-IscsiTargetPortal cmdlet.

Parameter properties

Type:	CimInstance
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByiSCSITargetPortal

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TargetSideIdentifier

Specifies the target side identifier.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByTargetSideIdentifier

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
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

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

String

CimInstance

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.

CimInstance

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.

CimInstance

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.

CimInstance

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.

CimInstance

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.

Outputs

CimInstance

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.

Related Links

• iSCSI on TechNet
• Storage on TechNet
• Get-IscsiSession
• Get-IscsiTarget
• Get-IscsiTargetPortal