< Back
Register-IscsiSession
Post
NAME Register-IscsiSession
SYNOPSIS
Registers an active iSCSI session to be persistent using the session identifier as input.
SYNTAX
Register-IscsiSession [-ChapSecret <String>] [-ChapUsername <String>] [-CimSession <CimSession[]>] [-IsMultipathEnabled <Boolean>] [-PassThru]
[-ThrottleLimit <Int32>] -SessionIdentifier <String[]> [<CommonParameters>]
Register-IscsiSession [-ChapSecret <String>] [-ChapUsername <String>] [-CimSession <CimSession[]>] [-IsMultipathEnabled <Boolean>] [-PassThru]
[-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The Register-IscsiSession cmdlet registers an existing iSCSI session to make it persistent. Once an iSCSI session is registered, it automatically
attempts to reconnect on restart.
Registering a connection multiple times will automatically re-establish multiple sessions for use with Multipath I/O (MPIO).
PARAMETERS
-ChapSecret [<String>]
Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IsMultipathEnabled [<Boolean>]
Indicates whether the initiator has enabled Multipath I/O (MPIO) and it will be used when logging into the target portal.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SessionIdentifier <String[]>
Specifies the session identifier.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
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.
Example 1: Register an iSCSI session
PS C:\\>Register-IscsiSession -SessionIdentifier "fffffa800d008430-4000013700000001"
This command registers the iSCSI session with the session ID fffffa800d008430-4000013700000001 to be persistent across restarts.
RELATED LINKS
iSCSI on TechNet
Storage on TechNet
SYNOPSIS
Registers an active iSCSI session to be persistent using the session identifier as input.
SYNTAX
Register-IscsiSession [-ChapSecret <String>] [-ChapUsername <String>] [-CimSession <CimSession[]>] [-IsMultipathEnabled <Boolean>] [-PassThru]
[-ThrottleLimit <Int32>] -SessionIdentifier <String[]> [<CommonParameters>]
Register-IscsiSession [-ChapSecret <String>] [-ChapUsername <String>] [-CimSession <CimSession[]>] [-IsMultipathEnabled <Boolean>] [-PassThru]
[-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The Register-IscsiSession cmdlet registers an existing iSCSI session to make it persistent. Once an iSCSI session is registered, it automatically
attempts to reconnect on restart.
Registering a connection multiple times will automatically re-establish multiple sessions for use with Multipath I/O (MPIO).
PARAMETERS
-ChapSecret [<String>]
Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IsMultipathEnabled [<Boolean>]
Indicates whether the initiator has enabled Multipath I/O (MPIO) and it will be used when logging into the target portal.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SessionIdentifier <String[]>
Specifies the session identifier.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
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.
Example 1: Register an iSCSI session
PS C:\\>Register-IscsiSession -SessionIdentifier "fffffa800d008430-4000013700000001"
This command registers the iSCSI session with the session ID fffffa800d008430-4000013700000001 to be persistent across restarts.
RELATED LINKS
iSCSI on TechNet
Storage on TechNet