Connect-IscsiTarget

Connect-IscsiTarget

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

Syntax

Parameter Set: ByNodeAddress
Connect-IscsiTarget -NodeAddress <String> [-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> ] [ <CommonParameters>]

Parameter Set: ByObject
Connect-IscsiTarget -InputObject <CimInstance[]> [-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> ] [ <CommonParameters>]

Detailed Description

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

Parameters

-AsJob

-AuthenticationType<String>

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

-ChapSecret<String>

Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP.

-ChapUsername<String>

Specifies the user name to use when establishing a connection authenticated by using Mutual CHAP.

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

-InitiatorInstanceName<String>

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.

-InitiatorPortalAddress<String>

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

-InputObject<CimInstance[]>

Accepts an object from the pipeline as input.

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

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

-IsMultipathEnabled<Boolean>

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

-IsPersistent<Boolean>

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

-NodeAddress<String>

Represents the IQN of the discovered target.

-ReportToPnP<Boolean>

Specifies that the operation is reported to PNP.

-TargetPortalAddress<String>

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

-TargetPortalPortNumber<UInt16>

Specifies the TCP/IP port number for the target portal. By default, the port number is 3260.

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

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

• None

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

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

PS C:\> $Tar = Get-IscsiTarget

PS C:\> Disconnect-IscsiTarget -NodeAddress $Tar.NodeAddress

[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

Related topics

N:MPIO

N:Storage

iSCSI on TechNet

Storage on TechNet