Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Connect-IscsiTarget

Connect-IscsiTarget

iscsitarget.cdxml

Synopsis

Establishes a connection between the local iSCSI initiator, and the specified iSCSI target device.

Syntax

Connect-IscsiTarget [-AsJob] [-AuthenticationType] [-ChapSecret] [-ChapUsername] [-CimSession] [-InitiatorInstanceName] [-InitiatorPortalAddress] [-IsDataDigest] [-IsHeaderDigest] [-IsMultipathEnabled] [-IsPersistent] [-ReportToPnP] [-TargetPortalAddress] [-TargetPortalPortNumber] [-ThrottleLimit] [-NodeAddress] [<CommonParameters>]

Connect-IscsiTarget [-AsJob] [-AuthenticationType] [-ChapSecret] [-ChapUsername] [-CimSession] [-InitiatorInstanceName] [-InitiatorPortalAddress] [-IsDataDigest] [-IsHeaderDigest] [-IsMultipathEnabled] [-ReportToPnP] [-TargetPortalAddress] [-TargetPortalPortNumber] [-ThrottleLimit] [-InputObject] [<CommonParameters>]

Detailed Description

The Connect-IscsiTarget cmdlet initiates a connection to the specified iSCSI target device.

Parameters

-AsJob <SwitchParameter>

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

-AuthenticationType <String>

Specifies the type of authentication to use when logging into the target. Valid values are None (the default), OneWayCHAP, and MutualCHAP.

Aliases

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.

Aliases

None

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.

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

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InitiatorPortalAddress <String>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Accepts an object from the pipeline as input.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-IsDataDigest <Boolean>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IsHeaderDigest <Boolean>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IsMultipathEnabled <Boolean>

Indicates that the initiator has enabled Multipath I/O (MPIO) and it will be used when logging into the target portal.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IsPersistent <Boolean>

Specifies that the session is to be automatically connected after each restart.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NodeAddress <String>

Represents the IQN of the discovered target.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ReportToPnP <Boolean>

Specifies that the operation is reported to PNP.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-TargetPortalAddress <String>

Represents the IP address or DNS name of the target portal.

Aliases

TA

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.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.Ciminstance#MSFT_IscsiSession

Notes

None

Examples

EXAMPLE 1

This example connects an iSCSI target, collects information about the target, and stores it in a variable, disconnects, and then connects using this cmdlet

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    : 0100 

Online Version
iSCSI on TechNet
Storage on TechNet
N:MPIO
N:Storage