Edit

Share via

Get-NfsOpenFile

  • Reference
Module:
NFS

Gets information about files that are open on an NFS server for a client computer.

Syntax

Get-NfsOpenFile
   [[-Path] <String[]>]
   [[-StateId] <String[]>]
   [[-ClientId] <UInt64[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-NfsOpenFile cmdlet gets information about files that are in a Network File System (NFS) share and hosted by an NFS server, and that a client computer is currently holding open. You can specify a client identifier to view all files that are in an open state for the specified client.

Examples

Example 1: Get all open files on an NFS server

PS C:\> Get-NfsOpenFile

This command gets all open files on an NFS server.

Example 2: Get all open files for a specified client computer on an NFS server

PS C:\> Get-NfsOpenFile -ClientId 101

This command gets all open files on an NFS server for a client computer that has the ID 101.

Example 3: Get all open files on an NFS server by path and file name by using a wildcard

PS C:\> Get-NfsOpenFile -Path "C:\Windows\Setup*"

This command gets all open files on an NFS server that are in the C:\Windows folder and that contain the word Setup.

Parameters

-AsJob

Indicates that this cmdlet runs the command as a background job on a remote computer. Use this parameter to run commands that take an extensive time to finish.

When you use the AsJob parameter, the command returns an object that represents the job, and then displays the command prompt. You can continue to work in the session while the job finishes. To manage the job, use the Job cmdlets. To get the job results, use the Receive-Job cmdlet.

The AsJob parameter resembles using the Invoke-Command cmdlet to run a Start-Job command remotely. However, with AsJob, the job is created on the local computer, even though the job runs on a remote computer, and the results of the remote job are automatically returned to the local computer.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ClientId

Specifies the ID of one or more client computers.

Type:UInt64[]
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Path

Specifies the path and file name of an open file on an NFS server. For example, C:\Windows\Setup.log. You can also use a wildcard to specify multiple paths and files.

Type:String[]
Aliases:FileName, File
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StateId

Specifies the state ID of one or more open files.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
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 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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

CimInstance