Close-SmbOpenFile

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.

パラメーター

-AsJob

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

-ClientComputerName<String[]>

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

-ClientUserName<String[]>

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

-ClusterNodeName<String[]>

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

-FileId<UInt64[]>

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

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

-InputObject<CimInstance[]>

このコマンドレットへの入力を指定します。このパラメーターを使用するか、パイプを使用して入力をこのコマンドレットに渡すことができます。

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

-ScopeName<String[]>

Specifies the scope of the open files to be retrieved.

-SessionId<UInt64[]>

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

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

• None

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

• None

例

EXAMPLE 1

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

EXAMPLE 2

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

EXAMPLE 3

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