COMMAND EVERYTHING.

Set-NfsServerConfiguration

Changes configuration settings for an NFS server.

PowerShell · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft NFS reference: Changes configuration settings for an NFS server. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Set-NfsServerConfiguration [-InputObject <CimInstance[]>] [-PortmapProtocol <String[]>]
 [-MountProtocol <String[]>] [-Nfsprotocol <String[]>] [-NlmProtocol <String[]>] [-NsmProtocol <String[]>]
 [-MapServerProtocol <String[]>] [-NisProtocol <String[]>] [-EnableNFSV2 <Boolean>] [-EnableNFSV3 <Boolean>]
 [-EnableNFSV4 <Boolean>] [-EnableAuthenticationRenewal <Boolean>] [-AuthenticationRenewalIntervalSec <UInt32>]
 [-DirectoryCacheSize <UInt32>] [-CharacterTranslationFile <String>] [-HideFilesBeginningInDot <Boolean>]
 [-NlmGracePeriodSec <UInt32>] [-LogActivity <String[]>] [-GracePeriodSec <UInt32>]
 [-NetgroupCacheTimeoutSec <UInt32>] [-PreserveInheritance <Boolean>] [-UnmappedUserAccount <String>]
 [-WorldAccount <String>] [-AlwaysOpenByName <Boolean>] [-LeasePeriodSec <UInt32>] [-ClearMappingCache]
 [-OnlineTimeoutSec <UInt32>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Set-NfsServerConfiguration. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / NFS · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-AlwaysOpenByName: Specifies whether an NFS server opens files and directories by name, instead of opening by file ID. You can enable this setting for compatibility with filter drivers that intercept requests for opening files and directories by file name, or for applications that rely on directory change notifications to work with NFS shares. The default value is $False. By default, an NFS server opens files and directories by ID to improve performance.
-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.
-AuthenticationRenewalIntervalSec: Specifies an interval, in seconds, when an NFS server renews authentication.
-CharacterTranslationFile: Specifies a path for a file that an NFS server uses for character translation.
-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.
-ClearMappingCache: Specifies whether to clear the mapping and netgroup cache of an NFS server.
-Confirm: Prompts you for confirmation before running the cmdlet.
-DirectoryCacheSize: Specifies the size of the directory cache, in kilobytes. This value is a multiple of 4.
-EnableAuthenticationRenewal: Specifies whether an NFS server renews authentication when cached credentials expire.
-EnableNFSV2: Specifies whether an NFS server can export shares via the NFS v2 protocol.
-EnableNFSV3: Specifies whether an NFS server can export shares via the NFS v3 protocol.

Prerequisites

Windows with the NFS module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Set a grace period on a local NFS server

Set-NfsServerConfiguration -NlmGracePeriodSec 45 -GracePeriodSec 240

This command sets the grace period for the NLM protocol to 45 seconds and sets the grace period for NFS v4.1 to 240 seconds on a local NFS server. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/NFS/Set-NfsServerConfiguration.md

https://learn.microsoft.com/powershell/module/nfs/set-nfsserverconfiguration?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands