Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Get-NfsClientLock

Updated: October 15, 2012

Applies To: Windows Server 2012

Get-NfsClientLock

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

Syntax

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

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




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

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


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

-ComputerName<String>

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.


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-LockType<ClientLockType[]>

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.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Path<String[]>

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.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-StateId<String>

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.


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.

Outputs

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

  • Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/NFS/MSFT_NfsNlmClientLock, Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/NFS/MSFT_Nfsv4ClientLock

Examples

Example 1: Get locked files on a local NFS server

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


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

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

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


PS C:\> Get-NfsClientLock –LockType NLM

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.