Close-SmbSession

Close-SmbSession

Forcibly ends the Server Message Block (SMB) session.

Syntax

Parameter Set: InputObject (cdxml)
Close-SmbSession -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Query
Close-SmbSession [[-SessionId] <UInt64[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ClientComputerName <String[]> ] [-ClientUserName <String[]> ] [-ClusterNodeName <String[]> ] [-Force] [-PassThru] [-ScopeName <String[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Close-SmbSession cmdlet forcibly ends the Server Message Block (SMB) session. Using this cmdlet may result in 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

-AsJob

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

-ClientComputerName<String[]>

Specifies the client computer name from which the only sessions are returned.

-ClientUserName<String[]>

Specifies the name of the user whose sessions are retrieved.

-ClusterNodeName<String[]>

Specifies, in case of a share hosted by a Windows cluster, the name of the server which is hosting the sessions are retrieved.

-Force

Forces the command to run without asking for user confirmation.

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-ScopeName<String[]>

Specifies the scope of the sessions being retrieved.

-SessionId<UInt64[]>

Specifies the identifier (ID) that uniquely identifies the session that is being ended.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

• None

Examples

EXAMPLE 1

This example ends the SMB session.

PS C:\> Close-SmbSession -SessionId 8813272891621

EXAMPLE 2

This example ends the SMB session without user confirmation.

PS C:\> Close-SmbSession -SessionId 8813272891621 -Force

Related topics

Get-SmbSession