Close-SmbOpenFile

Forcibly closes a file that is open by one of the clients of the Server Message Block (SMB) server.

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

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

The Close-SMBOpenFile cmdlet forcibly closes a file that is open by one of the clients of the Server Message Block (SMB) server. This cmdlet should be used with care as it may result in data loss to the client for which the file is being closed if the client has not flushed all of the file modifications back to the server before the file is closed.

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.

Specifies the client computer name to filter the returned open files so that only the matching files are opened.

Specifies the name of the user for which the open files are retrieved.

Specifies, if a share is hosted by a windows cluster, the name of the server which is hosting the open files to be retrieved.

Specifies the file identifier (ID) of the file to forcibly close.

Forces the command to run without asking for user confirmation.

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

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

Specifies the scope of the open files to be retrieved.

Specifies a session ID. Only files that have been opened in the specified session will be returned.

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.

Prompts you for confirmation before running the cmdlet.

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

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

The input type is the type of the objects that you can pipe to the cmdlet.

• None

The output type is the type of the objects that the cmdlet emits.

• None

This example closes a file identified as 4415226383589 that is open by one of the clients of the SMB server.

PS C:\> Close-SmbOpenFile -FileId 4415226383589

This example closes one or more files that are open by one of the client identified with the session identifier (ID) 4415226380393 of the SMB server.

PS C:\> Close-SmbOpenFile -SessionId 4415226380393

This example closes, without user confirmation, one or more files that are open by one of the clients of the SMB server and that match the file extension ".DOCX".

PS C:\> Get-SmbOpenFile | Where-Object -Property ShareRelativePath -Match ".DOCX" | Close-SmbOpenFile –Force

Get-SmbOpenFile