Register-IscsiSession

Register-IscsiSession

Registers an active iSCSI session to be persistent using the session identifier as input.

Syntax

Parameter Set: BySessionIdentifier
Register-IscsiSession -SessionIdentifier <String[]> [-AsJob] [-ChapSecret <String> ] [-ChapUsername <String> ] [-CimSession <CimSession[]> ] [-IsMultipathEnabled <Boolean> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Register-IscsiSession -InputObject <CimInstance[]> [-AsJob] [-ChapSecret <String> ] [-ChapUsername <String> ] [-CimSession <CimSession[]> ] [-IsMultipathEnabled <Boolean> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Register-IscsiSession cmdlet registers an existing iSCSI session to make it persistent. Once an iSCSI session is registered, it will automatically attempt to reconnect on reboot.

Note: Registering a connection multiple times will automatically re-establish multiple sessions for use with Multipath I/O (MPIO).

Parameters

-AsJob

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

-InputObject<CimInstance[]>

Accepts an object from the pipeline as input.

-IsMultipathEnabled<Boolean>

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

-PassThru

Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output.
To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.

-SessionIdentifier<String[]>

Specifies the session identifier.

-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 registers the iSCSI session with the session ID fffffa800d008430-4000013700000001 to be persistent across reboots.

PS C:\> Register-IscsiSession -SessionIdentifier fffffa800d008430-4000013700000001

Related topics

N:MPIO

N:Storage

iSCSI on TechNet

Storage on TechNet