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
 

Register-IscsiSession

Register-IscsiSession

iscsisession.cdxml

Synopsis

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

Syntax

Register-IscsiSession [-AsJob] [-ChapSecret] [-ChapUsername] [-CimSession] [-IsMultipathEnabled] [-PassThru] [-ThrottleLimit] [-SessionIdentifier] [<CommonParameters>]

Register-IscsiSession [-AsJob] [-ChapSecret] [-ChapUsername] [-CimSession] [-IsMultipathEnabled] [-PassThru] [-ThrottleLimit] [-InputObject] [<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 <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

-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

-InputObject <CimInstance[]>

Accepts an object from the pipeline as input.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

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

-PassThru <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-SessionIdentifier <String[]>

Specifies the session identifier.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

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

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

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