< Back
Connect-IscsiTarget
Post
NAME Connect-IscsiTarget
SYNOPSIS
Establishes a connection between the local iSCSI initiator and an iSCSI target device.
SYNTAX
Connect-IscsiTarget [-AuthenticationType <String>] [-ChapSecret <String>] [-ChapUsername <String>] [-CimSession <CimSession[]>]
[-InitiatorInstanceName <String>] [-InitiatorPortalAddress <String>] [-IsDataDigest <Boolean>] [-IsHeaderDigest <Boolean>] [-IsMultipathEnabled
<Boolean>] [-IsPersistent <Boolean>] [-ReportToPnP <Boolean>] [-TargetPortalAddress <String>] [-TargetPortalPortNumber <UInt16>] [-ThrottleLimit
<Int32>] -NodeAddress <String> [<CommonParameters>]
Connect-IscsiTarget [-AuthenticationType <String>] [-ChapSecret <String>] [-ChapUsername <String>] [-CimSession <CimSession[]>]
[-InitiatorInstanceName <String>] [-InitiatorPortalAddress <String>] [-IsDataDigest <Boolean>] [-IsHeaderDigest <Boolean>] [-IsMultipathEnabled
<Boolean>] [-ReportToPnP <Boolean>] [-TargetPortalAddress <String>] [-TargetPortalPortNumber <UInt16>] [-ThrottleLimit <Int32>]
[<CommonParameters>]
DESCRIPTION
The Connect-IscsiTarget cmdlet initiates a connection to the specified iSCSI target device.
PARAMETERS
-AuthenticationType [<String>]
Specifies the type of authentication to use when logging into the target. The acceptable values for this parameter are:
-- None
-- OneWayCHAP
-- MutualCHAP
The default value is None.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ChapSecret [<String>]
Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ChapUsername [<String>]
Specifies the user name to use when establishing a connection authenticated by using Mutual CHAP.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InitiatorInstanceName [<String>]
Specifies the name of the initiator instance that the iSCSI initiator service uses to send SendTargets requests to the target portal. If no
instance name is specified, the iSCSI initiator service chooses the initiator instance.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InitiatorPortalAddress [<String>]
Specifies the IP address or DNS name that is associated with the portal.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IsDataDigest [<Boolean>]
Indicates whether this cmdlet enables data digest when the initiator logs into the target portal. If you do not specify this parameter, the
digest setting is determined by the initiator kernel mode driver.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IsHeaderDigest [<Boolean>]
Indicates whether this cmdlet enables header digest when the initiator logs into the target portal. If you do not specify this parameter, the
digest setting is determined by the initiator kernel mode driver.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IsMultipathEnabled [<Boolean>]
Indicates whether the initiator has enabled Multipath I/O (MPIO) and uses it when logging into the target portal.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IsPersistent [<Boolean>]
Indicates whether the session is to be automatically connected after each restart.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-NodeAddress <String>
Specifies the IQN of the discovered target.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ReportToPnP [<Boolean>]
Indicates whether the operation is reported to PNP.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TargetPortalAddress [<String>]
Specifies the IP address or DNS name of the target portal.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TargetPortalPortNumber [<UInt16>]
Specifies the TCP/IP port number for the target portal. By default, the port number is 3260.
Required? false
Position? named
Default value none
Accept pipeline input? false
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
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.
Example 1: Disconnect and connect to an iSCSI target
The first command gets iSCSI targets by using the Get-IscsiTarget cmdlet.The second command gets iSCSI targets, and then stores them in the
$Target variable. The third command disconnects the iSCSI target identified by its NodeAddress by using the Disconnect-IscsiTarget cmdlet. The
final command connections the iSCSI target identified by its NodeAddress.
PS C:\\> Get-IscsiTarget
IsConnected NodeAddress
----------- -----------
True iqn.1991-05.com.contoso:testiscsi-deepcore-target
PS C:\\> $Target = Get-IscsiTarget
PS C:\\> Disconnect-IscsiTarget -NodeAddress $Target.NodeAddress
Confirm
Are you sure you want to perform this action?
Performing operation '' on Target ''.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
PS C:\\>Connect-IscsiTarget -NodeAddress $Target.NodeAddress
AuthenticationType : NONE
InitiatorInstanceName : ROOT\\ISCSIPRT\\0000_0
InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com
InitiatorPortalAddress :
InitiatorSideIdentifier : 400001370000
IsConnected : True
IsDataDigest : False
IsDiscovered : True
IsHeaderDigest : False
IsMultipathEnabled : False
IsPersistent : True
NumberOfConnections : 1
SessionIdentifier : fffffa800d008430-400001370000000b
TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target
TargetSideIdentifier : 0100
This example connects an iSCSI target, collects information about the target, and stores it in a variable, disconnects, and then connects using
this cmdlet.
RELATED LINKS
iSCSI on TechNet
Storage on TechNet
Disconnect-IscsiTarget
Get-IscsiTarget
SYNOPSIS
Establishes a connection between the local iSCSI initiator and an iSCSI target device.
SYNTAX
Connect-IscsiTarget [-AuthenticationType <String>] [-ChapSecret <String>] [-ChapUsername <String>] [-CimSession <CimSession[]>]
[-InitiatorInstanceName <String>] [-InitiatorPortalAddress <String>] [-IsDataDigest <Boolean>] [-IsHeaderDigest <Boolean>] [-IsMultipathEnabled
<Boolean>] [-IsPersistent <Boolean>] [-ReportToPnP <Boolean>] [-TargetPortalAddress <String>] [-TargetPortalPortNumber <UInt16>] [-ThrottleLimit
<Int32>] -NodeAddress <String> [<CommonParameters>]
Connect-IscsiTarget [-AuthenticationType <String>] [-ChapSecret <String>] [-ChapUsername <String>] [-CimSession <CimSession[]>]
[-InitiatorInstanceName <String>] [-InitiatorPortalAddress <String>] [-IsDataDigest <Boolean>] [-IsHeaderDigest <Boolean>] [-IsMultipathEnabled
<Boolean>] [-ReportToPnP <Boolean>] [-TargetPortalAddress <String>] [-TargetPortalPortNumber <UInt16>] [-ThrottleLimit <Int32>]
[<CommonParameters>]
DESCRIPTION
The Connect-IscsiTarget cmdlet initiates a connection to the specified iSCSI target device.
PARAMETERS
-AuthenticationType [<String>]
Specifies the type of authentication to use when logging into the target. The acceptable values for this parameter are:
-- None
-- OneWayCHAP
-- MutualCHAP
The default value is None.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ChapSecret [<String>]
Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ChapUsername [<String>]
Specifies the user name to use when establishing a connection authenticated by using Mutual CHAP.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InitiatorInstanceName [<String>]
Specifies the name of the initiator instance that the iSCSI initiator service uses to send SendTargets requests to the target portal. If no
instance name is specified, the iSCSI initiator service chooses the initiator instance.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InitiatorPortalAddress [<String>]
Specifies the IP address or DNS name that is associated with the portal.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IsDataDigest [<Boolean>]
Indicates whether this cmdlet enables data digest when the initiator logs into the target portal. If you do not specify this parameter, the
digest setting is determined by the initiator kernel mode driver.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IsHeaderDigest [<Boolean>]
Indicates whether this cmdlet enables header digest when the initiator logs into the target portal. If you do not specify this parameter, the
digest setting is determined by the initiator kernel mode driver.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IsMultipathEnabled [<Boolean>]
Indicates whether the initiator has enabled Multipath I/O (MPIO) and uses it when logging into the target portal.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IsPersistent [<Boolean>]
Indicates whether the session is to be automatically connected after each restart.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-NodeAddress <String>
Specifies the IQN of the discovered target.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ReportToPnP [<Boolean>]
Indicates whether the operation is reported to PNP.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TargetPortalAddress [<String>]
Specifies the IP address or DNS name of the target portal.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TargetPortalPortNumber [<UInt16>]
Specifies the TCP/IP port number for the target portal. By default, the port number is 3260.
Required? false
Position? named
Default value none
Accept pipeline input? false
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
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.
Example 1: Disconnect and connect to an iSCSI target
The first command gets iSCSI targets by using the Get-IscsiTarget cmdlet.The second command gets iSCSI targets, and then stores them in the
$Target variable. The third command disconnects the iSCSI target identified by its NodeAddress by using the Disconnect-IscsiTarget cmdlet. The
final command connections the iSCSI target identified by its NodeAddress.
PS C:\\> Get-IscsiTarget
IsConnected NodeAddress
----------- -----------
True iqn.1991-05.com.contoso:testiscsi-deepcore-target
PS C:\\> $Target = Get-IscsiTarget
PS C:\\> Disconnect-IscsiTarget -NodeAddress $Target.NodeAddress
Confirm
Are you sure you want to perform this action?
Performing operation '' on Target ''.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
PS C:\\>Connect-IscsiTarget -NodeAddress $Target.NodeAddress
AuthenticationType : NONE
InitiatorInstanceName : ROOT\\ISCSIPRT\\0000_0
InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com
InitiatorPortalAddress :
InitiatorSideIdentifier : 400001370000
IsConnected : True
IsDataDigest : False
IsDiscovered : True
IsHeaderDigest : False
IsMultipathEnabled : False
IsPersistent : True
NumberOfConnections : 1
SessionIdentifier : fffffa800d008430-400001370000000b
TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target
TargetSideIdentifier : 0100
This example connects an iSCSI target, collects information about the target, and stores it in a variable, disconnects, and then connects using
this cmdlet.
RELATED LINKS
iSCSI on TechNet
Storage on TechNet
Disconnect-IscsiTarget
Get-IscsiTarget