Get-SmbOpenFile

Get-SmbOpenFile

Retrieves basic information about the files that are open on behalf of the clients of the Server Message Block (SMB) server.

Syntax

Parameter Set: Query
Get-SmbOpenFile [[-FileId] <UInt64[]> ] [[-SessionId] <UInt64[]> ] [[-ClientComputerName] <String[]> ] [[-ClientUserName] <String[]> ] [[-ScopeName] <String[]> ] [[-ClusterNodeName] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-SMBOpenFile cmdlet retrieves basic information about the files that are open on behalf of the clients of the Server Message Block (SMB) server.

Parameters

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ClientComputerName<String[]>

Specifies the filters for the returned open files so that only files opened from the specified client computer are returned.

Aliases	none
Required?	false
Position?	4
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ClientUserName<String[]>

Specifies the name of the user whose open files will be retrieved.

Aliases	none
Required?	false
Position?	5
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ClusterNodeName<String[]>

Specifies. in the case of a share hosted by a windows cluster, the name of the server which is hosting the open files being retrieved.

Aliases	none
Required?	false
Position?	7
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-FileId<UInt64[]>

Specifies the file identifier (ID) of the file for which the information is retrieved.

Aliases	none
Required?	false
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-IncludeHidden

Indicates that handles that are created and used internally will be enumerated as well.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ScopeName<String[]>

Specifies the scope of the open files being retrieved.

Aliases	none
Required?	false
Position?	6
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SessionId<UInt64[]>

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

Aliases	none
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

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

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbOpenFile

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
  The MSFT_SmbOpenFile object represents the files opened on the SMB server.

Examples

EXAMPLE 1

This example retrieves basic information about the files that are open on behalf of the clients of the SMB server.

PS C:\> Get-SMBOpenFile

EXAMPLE 2

This example retrieves all of information about the file identified as 4415226383569 that is open on behalf of the clients of the SMB server.

PS C:\> Get-SmbOpenFile -FileId 4415226383569 | Select-Object -Property *

EXAMPLE 3

This example retrieves basic information about the files that are open on behalf of the SMB client identified as 4415226380393of the SMB server.

PS C:\> Get-SmbOpenFile -SessionId 4415226380393

EXAMPLE 4

This example retrieves basic information about the files that are open on behalf of the SMB client of the SMB server named Contoso-SO.

PS C:\> Get-SmbOpenFile -ScopeName Contoso-SO

EXAMPLE 5

This example retrieves basic information about the files with the file extension of .VHDX that are open on behalf of the SMB client of the SMB server.

PS C:\> Get-SmbOpenFile | Where-Object -Property ShareRelativePath -Match ".VHDX"

Related topics

Close-SmbOpenFile