Get-IscsiSession

Get-IscsiSession

Retrieves information about established iSCSI sessions.

Syntax

Parameter Set: ByDisk
Get-IscsiSession [-AsJob] [-CimSession <CimSession[]> ] [-Disk <CimInstance> ] [-NumberOfConnections <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByInitiatorPort
Get-IscsiSession [-AsJob] [-CimSession <CimSession[]> ] [-InitiatorPort <CimInstance> ] [-NumberOfConnections <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByInitiatorSideIdentifier
Get-IscsiSession [-AsJob] [-CimSession <CimSession[]> ] [-InitiatorSideIdentifier <String[]> ] [-NumberOfConnections <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByiSCSIConnection
Get-IscsiSession [-AsJob] [-CimSession <CimSession[]> ] [-IscsiConnection <CimInstance> ] [-NumberOfConnections <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByiSCSITarget
Get-IscsiSession [-AsJob] [-CimSession <CimSession[]> ] [-IscsiTarget <CimInstance> ] [-NumberOfConnections <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByiSCSITargetPortal
Get-IscsiSession [-AsJob] [-CimSession <CimSession[]> ] [-IscsiTargetPortal <CimInstance> ] [-NumberOfConnections <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByTargetSideIdentifier
Get-IscsiSession [-AsJob] [-CimSession <CimSession[]> ] [-NumberOfConnections <UInt32[]> ] [-SessionIdentifier <String[]> ] [-TargetSideIdentifier <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-IscsiSession cmdlet returns information about iSCSI sessions.

Note: There is an association between the iSCSI session and the disk object, so it is possible to return all disks connected via a specific iSCSI session by running the following cmdlet.
- Get-iSCSISession | Get-Disk

Parameters

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

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

Aliases	Session
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Disk<CimInstance>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-InitiatorPort<CimInstance>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-InitiatorSideIdentifier<String[]>

Specifies the initiator side identifier.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-IscsiConnection<CimInstance>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-IscsiTarget<CimInstance>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-IscsiTargetPortal<CimInstance>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-NumberOfConnections<UInt32[]>

Specifies the number of connections.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SessionIdentifier<String[]>

Specifies the session identifier.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-TargetSideIdentifier<String[]>

Specifies the target side identifier.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<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#MSFT_DISK

  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.

• Microsoft.Management.Infrastructure.Ciminstance#MSFT_InitiatorPort

  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.

• Microsoft.Management.Infrastructure.Ciminstance#MSFT_IscsiConnection

  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.

• Microsoft.Management.Infrastructure.Ciminstance#MSFT_IscsiTarget

  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.

• Microsoft.Management.Infrastructure.Ciminstance#MSFT_IscsiTargetPortal

  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

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.Ciminstance#MSFT_IscsiSession

  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

PS C:\> Get-IscsiSession

Related topics

Get-IscsiConnection

Get-IscsiTarget

Get-IscsiTargetPortal

Get-Disk

Get-InitiatorPort

N:MPIO

N:Storage

iSCSI on TechNet

Storage on TechNet