Share via

MSFT_NfsServerConfig class

  • Article

Represents configuration settings for a Windows NFS server.

MSFT_NfsServerConfig is a singleton class; there is only one instance.

This class supersedes the legacy MSNFS_Server class.

The following syntax is simplified from Managed Object Format (MOF) code.

Syntax

[ClassVersion("1.0"), dynamic, provider("nfscimprov"), AMENDMENT]
class MSFT_NfsServerConfig
{
  string  Name;
  uint32  State;
  string  LogActivity[];
  string  CharacterTranslationFile;
  uint32  DirectoryCacheSize;
  boolean EnableAuthRenewal;
  uint32  AuthRenewalInterval;
  boolean EnableNFSV2;
  boolean EnableNFSV3;
  boolean EnableNFSV4;
  boolean HideFilesBeginningInDot;
  uint32  NlmGracePeriod;
  string  MapsvrProtocol[];
  string  MountProtocol[];
  string  NfsProtocol[];
  string  NisProtocol[];
  string  NlmProtocol[];
  string  NsmProtocol[];
  string  PortmapProtocol[];
  uint32  GracePeriod;
  uint32  NetgroupCacheTimeout;
  boolean PreserveInheritance;
  string  UnmappedUserAccount;
  string  WorldAccount;
  boolean AlwaysOpenByName;
  uint32  LeasePeriod;
  boolean ClearMappingCache;
  uint32  OnlineTimeoutInSeconds;
};

Members

The MSFT_NfsServerConfig class has these types of members:

Properties

The MSFT_NfsServerConfig class has these properties.

AlwaysOpenByName

Data type: boolean

Access type: Read/write

If TRUE, the Windows NFS server tries to open files and directories by name, instead of by NTFS file ID, with the following limitations:

  • In some cases, the server cannot open the file by name and must open it by file ID.
  • If a file has multiple hard links, the server chooses one of them as the file name. It is not predictable which name the server will choose. As a result, the name used for the file open may or may not be the name that the application is attempting to watch for.

For performance reasons, this property is FALSE by default, and the Windows NFS server opens files and directories by file ID.

Set this property to TRUE if your application requires compatibility with file system filter drivers that intercept open by file names, or if it relies on directory change notifications to work against NFS shares.

AuthRenewalInterval

Data type: uint32

Access type: Read/write

The interval, in seconds, at which the Windows NFS Server renews authentication. The default value is 600. The minimum value is 1, and the maximum value is 0x7FFFFFFF.

CharacterTranslationFile

Data type: string

Access type: Read/write

The name of the file to use for character translation.

ClearMappingCache

Data type: boolean

Access type: Read/write

If TRUE, the Windows NFS server purges its mapping cache.

Note

Even though this property is declared as Read/write, it is in fact write-only.

DirectoryCacheSize

Data type: uint32

Access type: Read/write

The size, in KB, of the directory cache. This value must be a multiple of 4. The default value is 4. The minimum value is 4, and the maximum value is 128.

EnableAuthRenewal

Data type: boolean

Access type: Read/write

If TRUE, the Windows NFS server will renew authentication when cached credentials expire.

EnableNFSV2

Data type: boolean

Access type: Read/write

If TRUE, the Windows NFS server will export shares over the NFS version 2 protocol.

EnableNFSV3

Data type: boolean

Access type: Read/write

If TRUE, the Windows NFS server will export shares over the NFS version 3 protocol.

EnableNFSV4

Data type: boolean

Access type: Read/write

If TRUE, the Windows NFS server will export shares over the NFS version 4.1 protocol.

GracePeriod

Data type: uint32

Access type: Read/write

The NFS version 4.1 server lock recovery grace period, in seconds. The default value is 240. The minimum value is 10, and the maximum value is 600.

The value of the GracePeriod property must be at least twice as large as the value of the LeasePeriod property.

HideFilesBeginningInDot

Data type: boolean

Access type: Read/write

If TRUE, the Windows NFS server will create files with names beginning with a period (".") as hidden files.

LeasePeriod

Data type: uint32

Access type: Read/write

The NFS v4.1 server lease time, in seconds. The default value is 120. The minimum value is 5, and the maximum value is 300.

The value of the GracePeriod property must be at least twice as large as the value of the LeasePeriod property.

LogActivity

Data type: string array

Access type: Read/write

An array of strings that specify the activities that are to be logged by the Windows NFS server. Each string can be one of the following:

  • "mount"
  • "unmount"
  • "read"
  • "write"
  • "create"
  • "delete"
  • "lock"
  • "unlock"

In addition, the following values can be used to set or clear all activity logging:

"none"

Don't log any activity.

"all"

Log all activities (mount, unmount, read, write, create, delete, lock, unlock).

MapsvrProtocol

Data type: string array

Access type: Read/write

An array of strings that specify the preferred underlying transport protocols to be used by the Windows NFS server for the MAPSVR protocol. Possible values for this property are:

"tcp"

Use TCP.

"udp"

Use UDP.

MountProtocol

Data type: string array

Access type: Read/write

An array of strings that specify the preferred underlying transport protocol to be used by the Windows NFS server for the Mount protocol. Possible values for this property are:

"tcp"

Use TCP.

"udp"

Use UDP.

Name

Data type: string

Access type: Read-only

Qualifiers: key

This property is not used.

NetgroupCacheTimeout

Data type: uint32

Access type: Read/write

Cache time-out, in minutes, to be enforced by the Windows NFS server for entries in the netgroup cache.

NfsProtocol

Data type: string array

Access type: Read/write

An array of strings that specify the preferred underlying transport protocol to be used by the Windows NFS server for the NFS protocol. Possible values for this property are:

"tcp"

Use TCP.

"udp"

Use UDP.

NisProtocol

Data type: string array

Access type: Read/write

An array of strings that specify the preferred underlying transport protocol to be used by the Windows NFS server for the NIS protocol. Possible values for this property are:

"tcp"

Use TCP.

"udp"

Use UDP.

NlmGracePeriod

Data type: uint32

Access type: Read/write

The NFS v2/v3 server lock recovery grace period, in seconds. The default value is 45. The minimum value is 1, and the maximum value is 3600.

NlmProtocol

Data type: string array

Access type: Read/write

An array of strings that specify the preferred underlying transport protocol to be used by the Windows NFS server for the NLM protocol. Possible values for this property are:

"tcp"

Use TCP.

"udp"

Use UDP.

NsmProtocol

Data type: string array

Access type: Read/write

An array of strings that specify the preferred underlying transport protocol to be used by the Windows NFS server for the NSM protocol. Possible values for this property are:

"tcp"

Use TCP.

"udp"

Use UDP.

OnlineTimeoutInSeconds

Data type: uint32

Access type: Read/write

Time-out interval, in seconds, for the Windows NFS server to bring the shares scoped to a network name online when failing over from one node to another on a cluster. The default value is 180. The minimum value is 1, and the maximum value is 600.

PortmapProtocol

Data type: string array

Access type: Read/write

An array of strings that specify the preferred underlying transport protocols to be used by the Windows NFS server for the Portmapper. Possible values for this property are:

"tcp"

Use TCP.

"udp"

Use UDP.

PreserveInheritance

Data type: boolean

Access type: Read/write

If TRUE, the Windows NFS server must set inheritable ACEs and to make sure that these ACEs apply to newly created files and folders on NFS shares. By default, this property is FALSE.

State

Data type: uint32

Access type: Read-only

The current state of the Windows NFS server.

NotInstalled (0)

Stopped (1)

Running (2)

UnmappedUserAccount

Data type: string

Access type: Read/write

The Windows account that the Windows NFS server uses by default to represent users who have no mapping configured in the mapping store. The default value is "NT AUTHORITY\Anonymous Logon".

WorldAccount

Data type: string

Access type: Read/write

The Windows account that the Windows NFS server uses by default to represent World and Other permissions on files when using AUTH_UNIX security. The default value is "BUILTIN\Everyone".

Requirements
Minimum supported client
 Windows 8
Minimum supported server
 Windows Server 2012
Namespace
 Root\Microsoft\Windows\NFS
MOF
NfsCimProv.mof
DLL
NfsCimProv.dll