The CIM_NFS class represents a remote file system that is mounted, using the network file system (NFS) protocol, from a computer system. The properties of the NFS object correspond to the operational aspects of the mount and represent the client-side configuration for NFS access. The file system type should be set to indicate the type of file system as it appears to the client.
Important: The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.
Syntax
[Abstract, UUID("{75BCF4FB-DB46-11D2-B4C8-80080C7B6371}"), AMENDMENT]
class CIM_NFS : CIM_RemoteFileSystem
{
boolean AttributeCaching;
uint16 AttributeCachingForDirectoriesMax;
uint16 AttributeCachingForDirectoriesMin;
uint16 AttributeCachingForRegularFilesMax;
uint16 AttributeCachingForRegularFilesMin;
uint64 AvailableSpace;
uint64 BlockSize;
string Caption;
boolean CasePreserved;
boolean CaseSensitive;
uint16 CodeSet[];
string CompressionMethod;
string CreationClassName;
string CSCreationClassName;
string CSName;
string Description;
string EncryptionMethod;
uint64 FileSystemSize;
boolean ForegroundMount;
boolean HardMount;
datetime InstallDate;
boolean Interrupt;
uint32 MaxFileNameLength;
uint16 MountFailureRetries;
string Name;
uint64 ReadBufferSize;
boolean ReadOnly;
uint16 RetransmissionAttempts;
uint32 RetransmissionTimeout;
string Root;
uint32 ServerCommunicationPort;
string Status;
uint64 WriteBufferSize;
};
Members
The CIM_NFS class has these types of members:
Properties
The CIM_NFS class has these properties.
AttributeCaching
Data type: boolean
Access type: Read-only
If TRUE, control attribute caching is enabled. If FALSE, control attribute caching is disabled.
AttributeCachingForDirectoriesMax
Data type: uint16
Access type: Read-only
Qualifiers: Units ("seconds")
Maximum number of seconds that cached attributes are held after directory update.
AttributeCachingForDirectoriesMin
Data type: uint16
Access type: Read-only
Qualifiers: Units ("seconds")
Minimum number of seconds that cached attributes are held after directory update.
AttributeCachingForRegularFilesMax
Data type: uint16
Access type: Read-only
Qualifiers: Units ("seconds")
Maximum number of seconds that cached attributes are held after file modification.
AttributeCachingForRegularFilesMin
Data type: uint16
Access type: Read-only
Qualifiers: Units ("seconds")
Minimum number of seconds that cached attributes are held after file modification.
AvailableSpace
Data type: uint64
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Partition|002.4"), Units ("bytes")
Total amount of free space, in bytes, for the file system. If unknown, enter 0.
This property is inherited from CIM_FileSystem.
For more information about using uint64 values in scripts, see Scripting in WMI.
BlockSize
Data type: uint64
Access type: Read-only
Qualifiers: Units ("bytes")
File systems can read or write data in blocks that are defined independently of the underlying storage extents. This property captures the file system's block size for data storage and retrieval.
This property is inherited from CIM_FileSystem.
For more information about using uint64 values in scripts, see Scripting in WMI.
Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64), DisplayName ("Caption")
Short textual description of the object.
This property is inherited from CIM_ManagedSystemElement.
CasePreserved
Data type: boolean
Access type: Read-only
If TRUE, the case of file names are preserved.
This property is inherited from CIM_FileSystem.
CaseSensitive
Data type: boolean
Access type: Read-only
If TRUE, case-sensitive file names are supported.
This property is inherited from CIM_FileSystem.
CodeSet
Data type: uint16 array
Access type: Read-only
Character sets or encoding supported by the file system.
This property is inherited from CIM_FileSystem.
Unknown (0)
Other (1)
ASCII (2)
Unicode (3)
ISO2022 (4)
ISO8859 (5)
Extended UNIX Code (6)
UTF-8 (7)
UCS-2 (8)
CompressionMethod
Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Partition|002.7")
Free-form string that indicates the algorithm or tool used to compress the logical file. If the compression scheme is unknown or not described, use "Unknown". If the logical file is compressed, but the compression scheme is unknown or not described, use "Compressed". If the logical file is not compressed, use "Not Compressed".
This property is inherited from CIM_FileSystem.
CreationClassName
Data type: string
Access type: Read-only
Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified.
This property is inherited from CIM_FileSystem.
CSCreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256), Propagated ("CIM_ComputerSystem.CreationClassName")
Scoping computer system's creation class name.
This property is inherited from CIM_FileSystem.
CSName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256), Propagated ("CIM_ComputerSystem.Name")
Scoping computer system's name.
This property is inherited from CIM_FileSystem.
Description
Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Description")
Textual description of the object.
This property is inherited from CIM_ManagedSystemElement.
EncryptionMethod
Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Partition|002.8")
Free-form string that identifies the algorithm or tool used to encrypt a logical file. If the encryption scheme is not indulged (for security reasons, for example), use "Unknown". If the file is encrypted, but either its encryption scheme is unknown or not disclosed, use "Encrypted". If the logical file is not encrypted, use "Not Encrypted". This property is inherited from CIM_FileSystem.
FileSystemSize
Data type: uint64
Access type: Read-only
Qualifiers: Units ("bytes")
Total size of the file system, in bytes. If unknown, enter 0 (zero).
This property is inherited from CIM_FileSystem.
For more information about using uint64 values in scripts, see Scripting in WMI.
ForegroundMount
Data type: boolean
Access type: Read-only
If TRUE, retries are performed in the foreground. If FALSE, and the first mount attempt fails, retries are performed in the background.
HardMount
Data type: boolean
Access type: Read-only
If TRUE, after the file system is mounted, NFS requests are retried until the hosting system responds. If FALSE, after the file system is mounted, an error is returned if the hosting system does not respond.
InstallDate
Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")
Date and time the object was installed. This property does not need a value to indicate that the object is installed.
This property is inherited from CIM_ManagedSystemElement.
Interrupt
Data type: boolean
Access type: Read-only
If TRUE, interrupts are permitted for hard mounts. If FALSE, interrupts are ignored for hard mounts.
MaxFileNameLength
Data type: uint32
Access type: Read-only
Maximum length of a file name within the file system. A value of 0 (zero)indicates that there is no limit for file name length.
This property is inherited from CIM_FileSystem.
MountFailureRetries
Data type: uint16
Access type: Read-only
Maximum number of mount failure retries that are allowed.
Name
Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Name")
Label by which the object is known. When subclassed, this property can be overridden to be a key property.
This property is inherited from CIM_ManagedSystemElement.
ReadBufferSize
Data type: uint64
Access type: Read-only
Qualifiers: Units ("bytes")
Read buffer size, in bytes.
For more information about using uint64 values in scripts, see Scripting in WMI.
ReadOnly
Data type: boolean
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrFSAccess")
If TRUE, the file system is designated as read-only.
This property is inherited from CIM_FileSystem.
RetransmissionAttempts
Data type: uint16
Access type: Read-only
Maximum number of NFS retransmissions allowed.
RetransmissionTimeout
Data type: uint32
Access type: Read-only
Qualifiers: Units ("tenths of seconds")
NFS time-out, in tenths of a second.
Root
Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrFSMountPoint")
Path name or other information that defines the root of the file system.
This property is inherited from CIM_FileSystem.
ServerCommunicationPort
Data type: uint32
Access type: Read-only
Remote computer system's UDP port number.
Status
Data type: string
Access type: Read-only
Qualifiers: MaxLen (10), DisplayName ("Status")
Current status of the object.
This property is inherited from CIM_ManagedSystemElement.
Values include the following:
OK ("OK")
Error ("Error")
Degraded ("Degraded")
Unknown ("Unknown")
Pred Fail ("Pred Fail")
Starting ("Starting")
Stopping ("Stopping")
Service ("Service")
Stressed ("Stressed")
NonRecover ("NonRecover")
No Contact ("No Contact")
Lost Comm ("Lost Comm")
WriteBufferSize
Data type: uint64
Access type: Read-only
Qualifiers: Units ("bytes")
Write buffer size, in bytes.
For more information about using uint64 values in scripts, see Scripting in WMI.
Remarks
The CIM_NFS class is derived from CIM_RemoteFileSystem.
WMI does not implement this class.
This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Minimum supported server | Windows Server 2008 |
| Namespace | Root\CIMV2 |
| MOF | CIMWin32.mof |
| DLL | CIMWin32.dll |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
