Get-NfsClientLock

Module:

NFS

Gets file locks that a client computer holds on an NFS server.

Syntax

Get-NfsClientLock
   [[-Path] <String[]>]
   [[-LockType] <ClientLockType[]>]
   [[-StateId] <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-NfsClientLock
   [[-Path] <String[]>]
   [[-LockType] <ClientLockType[]>]
   [[-ComputerName] <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-NfsClientLock cmdlet gets locks that client computers hold for files that a Network File System (NFS) server shares.

For NFS v3 protocol locks, this cmdlet gets NFS client locks based on the list of client computers that hold locks to a particular file, and the list of files that a particular client computer has locked.

For NFS v4 protocol locks, this cmdlet gets NFS client locks based on the list of files that a particular client computer has locked, and the state identifiers of the locked files.

You can also use the LockType parameter to get locked files on an NFS server based on the NFS protocol that the NFS client uses.

Examples

Example 1: Get locked files on a local NFS server

PS C:\> Get-NfsClientLock -Path "c:\shares\NFSshare01\*"

This command gets all the locked files on a local NFS server that have a path that begins with C:\shares\NFSshare01.

Example 2: Get locked files on a NFS server that have NLM lock type

PS C:\>Get-NfsClientLock -LockType NLM

This command gets all the locked files on the server that have a NLM lock type.

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

-ComputerName

Specifies the host name of a computer that holds a lock to files on the NFS server. All the locks that the specified computer holds are enumerated.

Type:	String
Aliases:	client, name, ClientComputer
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-LockType

Specifies an array of lock types. Get-NfsClientLock gets files that have the specified lock types. Valid values are NLM and NFS.

Locks acquired by NFS clients that mount files to an NFS share by using the NFS v2 or the NFS v3 protocol are Network Lock Manager (NLM) locks. Locks acquired by NFS clients that mount files by using the NFS v4.1 protocol are NFS locks.

Type:	ClientLockType[]
Aliases:	type
Accepted values:	NLM, NFS
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Path

Specifies an array of paths and file names on the NFS server. Get-NfsClientLock gets the locked files on an NFS server that have the specified paths. If there are multiple clients that have multiple locks on the same file, all the locks are revoked.

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

-StateId

Specifies the state identifier of the locks on the NFS server. StateId applies only to locks that an NFS client acquires by using the NFS v4.1 protocol.

Type:	String
Position:	2
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

Related Links

• Revoke-NfsClientLock