Unregister-IscsiSession
Removes an active iSCSI session from being persistent using the session identifier as input.
Syntax
Unregister-IscsiSession
-SessionIdentifier <String[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>]
Unregister-IscsiSession
-InputObject <CimInstance[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>]
Description
The Unregister-IscsiSession cmdlet removes a registered iSCSI session to prevent it from automatically reconnection on restart.
Examples
Example 1: Remove a session
The first command gets information about all iSCSI sessions across all iSCSI connections by using the **Get-IscsiSession** cmdlet.
PS C:\> Get-IscsiSession
AuthenticationType : NONE
InitiatorInstanceName : ROOT\ISCSIPRT\0000_0
InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com
InitiatorPortalAddress :
InitiatorSideIdentifier : 400001370001
IsConnected : True
IsDataDigest : False
IsDiscovered : True
IsHeaderDigest : False
IsMultipathEnabled : False
IsPersistent : True
NumberOfConnections : 1
SessionIdentifier : fffffa800d008430-4000013700000001
TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target
TargetSideIdentifier : 0200
AuthenticationType : NONE
InitiatorInstanceName : ROOT\ISCSIPRT\0000_0
InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com
InitiatorPortalAddress :
InitiatorSideIdentifier : 400001370004
IsConnected : True
IsDataDigest : False
IsDiscovered : True
IsHeaderDigest : False
IsMultipathEnabled : False
IsPersistent : True
NumberOfConnections : 1
SessionIdentifier : fffffa800d008430-4000013700000002
TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target
TargetSideIdentifier : 0100
AuthenticationType : NONE
InitiatorInstanceName : ROOT\ISCSIPRT\0000_0
InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com
InitiatorPortalAddress :
InitiatorSideIdentifier : 400001370002
IsConnected : True
IsDataDigest : False
IsDiscovered : True
IsHeaderDigest : False
IsMultipathEnabled : False
IsPersistent : True
NumberOfConnections : 1
SessionIdentifier : fffffa800d008430-4000013700000003
TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target
TargetSideIdentifier : 0300
The second command removes the session that has the specified session ID.
PS C:\> Unregister-IscsiSession -SessionIdentifier "fffffa800d008430-4000013700000001"
This example gets a list of sessions, and then uses this cmdlet to remove the session.
Parameters
-AsJob
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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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.
Type: | CimSession[] |
Aliases: | Session |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Type: | CimInstance[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SessionIdentifier
Specifies the session identifier.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ThrottleLimit
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.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None
Outputs
None
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for