Connect-IscsiTarget
Establishes a connection between the local iSCSI initiator, and the specified iSCSI target device.
Syntax
Connect-IscsiTarget
[-AsJob]
[-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> Connect-IscsiTarget
[-AsJob]
[-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>]
-InputObject <CimInstance[]> Description
The Connect-IscsiTarget cmdlet initiates a connection to the specified iSCSI target device.
Examples
EXAMPLE 1
PS C:\>Get-IscsiTarget
IsConnected NodeAddress
----------- -----------
True iqn.1991-05.com.contoso:testiscsi-deepcore-target
PS C:\>$Tar = Get-IscsiTarget
PS C:\>Disconnect-IscsiTarget -NodeAddress $Tar.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 $Tar.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 : 0100This example connects an iSCSI target, collects information about the target, and stores it in a variable, disconnects, and then connects using this cmdlet
Parameters
-AsJob
ps_cimcommon_asjob
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AuthenticationType
Specifies the type of authentication to use when logging into the target. Valid values are None, OneWayCHAP, and MutualCHAP.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ChapSecret
Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ChapUsername
Specifies the user name to use when establishing a connection authenticated by using Mutual CHAP.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InitiatorInstanceName
Specifies the name of the initiator via which the SendTargets operation is performed. If not specified, then the initiator used is selected by the iSCSI initiator service.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InitiatorPortalAddress
Specifies the IP address or DNS name associated with the portal.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Accepts an object from the pipeline as input.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsDataDigest
Enables data digest when the initiator logs into the target portal. By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsHeaderDigest
Enables header digest when the initiator logs into the target portal. By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsMultipathEnabled
Indicates that the initiator has enabled Multipath I/O (MPIO) and it will be used when logging into the target portal.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsPersistent
Specifies that the session is to be automatically connected after each restart.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NodeAddress
Represents the IQN of the discovered target.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ReportToPnP
Specifies that the operation is reported to PNP.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetPortalAddress
Represents the IP address or DNS name of the target portal.
| Type: | String |
| Aliases: | TA |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetPortalPortNumber
Specifies the TCP/IP port number for the target portal.
By default, the port number is 3260.
| Type: | UInt16 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
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
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for