]
Close-SmbSession [[-SessionId] ] [-CimSession ] [-ClientComputerName ]
[-ClientUserName ] [-ClusterNodeName ] [-Force] [-PassThru] [-ScopeName ]
[-SmbInstance {Default | CSV}] [-ThrottleLimit ] [-Confirm] [-WhatIf] []
DESCRIPTION
The Close-SmbSession cmdlet forcibly ends the Server Message Block (SMB) session. This cmdlet may cause loss of
data if the client for which session is being stopped has not flushed all of the file modifications back to the
server before the session is ended.
PARAMETERS
-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
-ClientComputerName []
Specifies the client computer name from which the only sessions are returned.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ClientUserName []
Specifies the name of the user whose sessions are retrieved.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ClusterNodeName []
Specifies, in case of a share hosted by a Windows cluster, the name of the server which is hosting the
sessions are retrieved.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Force []
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ScopeName []
Specifies the scope of the sessions being retrieved.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SessionId []
Specifies the identifier (ID) that uniquely identifies the session that is being ended.
Required? false
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SmbInstance []
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
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 PowerShellr 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
-Confirm []
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf []
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
None
Example 1: End an SMB session
PS C:\>Close-SmbSession -SessionId 8813272891621
Confirm
Are you sure you want to perform this action?
Performing operation 'Close-Session' on Target '8813272891621'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): N
This command ends an SMB session.
Example 2: End an SMB session without confirmation
PS C:\>Close-SmbSession -SessionId 8813272891621 -Force
This command ends an SMB session without user confirmation.
RELATED LINKS
Get-SmbSession