Get-IscsiConnection
Updated: August 15, 2012
Applies To: Windows Server 2012
Get-IscsiConnection
Syntax
Parameter Set: ByConnectionIdentifier Get-IscsiConnection [-AsJob] [-CimSession <CimSession> ] [-ConnectionIdentifier <String> ] [-InitiatorPortalPortNumber <UInt16> ] [-InititorIPAdressListNumber <UInt16> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByDisk Get-IscsiConnection [-AsJob] [-CimSession <CimSession> ] [-Disk <CimInstance> ] [-InitiatorPortalPortNumber <UInt16> ] [-InititorIPAdressListNumber <UInt16> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByInitiatorPort Get-IscsiConnection [-AsJob] [-CimSession <CimSession> ] [-InitiatorPort <CimInstance> ] [-InitiatorPortalPortNumber <UInt16> ] [-InititorIPAdressListNumber <UInt16> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByInitiatorPortalAddress Get-IscsiConnection [-AsJob] [-CimSession <CimSession> ] [-InitiatorPortalAddress <String> ] [-InitiatorPortalPortNumber <UInt16> ] [-InititorIPAdressListNumber <UInt16> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByInitiatorSideIdentifier Get-IscsiConnection [-AsJob] [-CimSession <CimSession> ] [-InitiatorPortalPortNumber <UInt16> ] [-InitiatorSideIdentifier <String> ] [-InititorIPAdressListNumber <UInt16> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByiSCSISession Get-IscsiConnection [-AsJob] [-CimSession <CimSession> ] [-InitiatorPortalPortNumber <UInt16> ] [-InititorIPAdressListNumber <UInt16> ] [-IscsiSession <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByiSCSITarget Get-IscsiConnection [-AsJob] [-CimSession <CimSession> ] [-InitiatorPortalPortNumber <UInt16> ] [-InititorIPAdressListNumber <UInt16> ] [-IscsiTarget <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByiSCSITargetPortal Get-IscsiConnection [-AsJob] [-CimSession <CimSession> ] [-InitiatorPortalPortNumber <UInt16> ] [-InititorIPAdressListNumber <UInt16> ] [-iSCSITargetPortal <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByTargetSideIdentifier Get-IscsiConnection [-AsJob] [-CimSession <CimSession> ] [-InitiatorPortalPortNumber <UInt16> ] [-InititorIPAdressListNumber <UInt16> ] [-TargetSideIdentifier <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-IscsiConnection cmdlet returns information about active iSCSI initiator connections.
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.
|
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 |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ConnectionIdentifier<String>
Specifies the connection identifier for an iSCSI session.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByPropertyName) |
|
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 |
-InitiatorPortalAddress<String>
Represents the IP address or DNS name associated with the portal.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByPropertyName) |
|
Accept Wildcard Characters? |
false |
-InitiatorPortalPortNumber<UInt16>
Specifies the TCP/IP port number for the initiator portal.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByPropertyName) |
|
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 |
-InititorIPAdressListNumber<UInt16>
Represents the index to the initiator IP address list.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByPropertyName) |
|
Accept Wildcard Characters? |
false |
-IscsiSession<CimInstance>
Accepts a MSFT iSCSI session object as an input. The MSFT iSCSI session object is output from the Get-IscsiSession 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 |
-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 |
-iSCSITargetPortal<CimInstance>
Allows passing a MSFT iSCSI target portal CIM object as an input. The MSFT iSCSI target portal CIM 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 |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- System.String
-
Microsoft.Management.Infrastructure.Ciminstance#MSFT_DISK
The
Microsoft.Management.Infrastructure.CimInstanceobject 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.CimInstanceobject 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_IscsiSession
The
Microsoft.Management.Infrastructure.CimInstanceobject 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.CimInstanceobject 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.CimInstanceobject 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_iSCSIConnection
The
Microsoft.Management.Infrastructure.CimInstanceobject 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
The example shows information returned by this cmdlet from a connected iSCSI target.
PS C:\> Get-IscsiConnection
ConnectionIdentifier : fffffa8005313020-2 InitiatorNodeAddress : 0.0.0.0 InitiatorPortNumber : 41458 TargetNodeAddress : 10.121.235.126 TargetPortNumber : 3260
Related topics
Get-IscsiTarget
Get-IscsiTargetPortal
Get-Disk
Get-InitiatorPort
MPIO
Storage
iSCSI on TechNet
Storage on TechNet
