MSFT_SmbClientConfiguration class

Article
05/31/2018

Represents the configuration settings for an SMB client.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[dynamic, provider("smbwmiv2"), ClassVersion("30")]
class MSFT_SmbClientConfiguration
{
  uint32  ConnectionCountPerRssNetworkInterface;
  uint32  DirectoryCacheEntriesMax;
  uint32  DirectoryCacheEntrySizeMax;
  uint32  DirectoryCacheLifetime;
  boolean EnableBandwidthThrottling;
  boolean EnableByteRangeLockingOnReadOnlyFiles;
  boolean EnableLargeMtu;
  boolean EnableMultiChannel;
  uint32  DormantFileLimit;
  boolean EnableSecuritySignature;
  uint32  ExtendedSessionTimeout;
  uint32  FileInfoCacheEntriesMax;
  uint32  FileInfoCacheLifetime;
  uint32  FileNotFoundCacheEntriesMax;
  uint32  FileNotFoundCacheLifetime;
  uint32  KeepConn;
  uint32  MaxCmds;
  uint32  MaximumConnectionCountPerServer;
  boolean OplocksDisabled;
  boolean RequireSecuritySignature;
  uint32  SessionTimeout;
  boolean UseOpportunisticLocking;
  uint32  WindowSizeThreshold;
  boolean EnableLoadBalanceScaleOut;
  boolean EnableInsecureGuestLogons;
};

Members

The MSFT_SmbClientConfiguration class has these types of members:

Methods
Properties

Methods

The MSFT_SmbClientConfiguration class has these methods.

Method	Description
GetConfiguration	Retrieves SMB client configuration settings.
SetConfiguration	Sets one or more SMB client configuration settings.

Properties

The MSFT_SmbClientConfiguration class has these properties.

ConnectionCountPerRssNetworkInterface

Data type: uint32
Access type: Read/write

The number of TCP connections per RSS network interface.

DirectoryCacheEntriesMax

Data type: uint32
Access type: Read/write

The maximum number of entries that can be stored in the directory cache.

DirectoryCacheEntrySizeMax

Data type: uint32
Access type: Read/write

The maximum size, in bytes, of an entry in the directory cache.

DirectoryCacheLifetime

Data type: uint32
Access type: Read/write

The maximum lifetime, in seconds, of the directory cache.

DormantFileLimit

Data type: uint32
Access type: Read/write

The maximum number of file handles the SMB network redirector can continue to keep open after the application has closed the corresponding handle.

EnableBandwidthThrottling

Data type: boolean
Access type: Read/write

Controls whether bandwidth throttling is enabled.

EnableByteRangeLockingOnReadOnlyFiles

Data type: boolean
Access type: Read/write

Controls whether byte-range locking is enabled on read-only files.

EnableInsecureGuestLogons

Data type: boolean
Access type: Read/write

TBD

Windows Server 2012 R2, Windows 8.1, Windows Server 2012 and Windows 8: This property is not supported before Windows Server 2016.

EnableLargeMtu

Data type: boolean
Access type: Read/write

Controls whether the Large MTU (maximum transmission unit) feature is enabled.

EnableLoadBalanceScaleOut

Data type: boolean
Access type: Read/write

Specifies whether load balancing is enabled with scale out clusters. True to enable load balancing with scale out clusters; False to disable it.

Windows Server 2012 and Windows 8: This property is not supported before Windows Server 2012 R2 and Windows 8.1.

EnableMultiChannel

Data type: boolean
Access type: Read/write

Enable the use of multiple physical network interfaces.

EnableSecuritySignature

Data type: boolean
Access type: Read/write

Controls whether security signatures are enabled.

ExtendedSessionTimeout

Data type: uint32
Access type: Read/write

An additional timeout, in seconds, for the SMB client to wait for servers that take more than 45 seconds to respond. (See the SessionTimeout property.) The default value is zero.

FileInfoCacheEntriesMax

Data type: uint32
Access type: Read/write

The maximum number of entries that can be stored in the file information cache.

FileInfoCacheLifetime

Data type: uint32
Access type: Read/write

The maximum lifetime, in seconds, of the file information cache.

FileNotFoundCacheEntriesMax

Data type: uint32
Access type: Read/write

The maximum number of entries that can be stored in the file not found cache.

FileNotFoundCacheLifetime

Data type: uint32
Access type: Read/write

The maximum lifetime, in seconds, of the file not found cache.

KeepConn

Data type: uint32
Access type: Read/write

Specifies the maximum amount of time, in seconds, that an idle connection can remain open. If the idle time for a connection reaches the value of this entry, the connection is closed. The default value is 600.

Note

This is an SMB1-only setting.

MaxCmds

Data type: uint32
Access type: Read/write

Specifies the maximum number of network control blocks that the redirector can reserve. The value of this entry coincides with the number of execution threads that can be outstanding simultaneously.

Note

This is an SMB1-only setting.

MaximumConnectionCountPerServer

Data type: uint32
Access type: Read/write

The maximum number of Multichannel client connections (across multiple interfaces) for a given server. The default value is 8.

OplocksDisabled

Data type: boolean
Access type: Read/write

True if opportunistic locking is disabled. See UseOpportunisticLocking.

RequireSecuritySignature

Data type: boolean
Access type: Read/write

Controls whether security signatures are required.

SessionTimeout

Data type: uint32
Access type: Read/write

The number of seconds that the client waits before disconnecting an inactive session. The default value is 45.

UseOpportunisticLocking

Data type: boolean
Access type: Read/write

Controls whether the opportunistic-locking (oplock) performance enhancement is enabled. If enabled, the redirector requests an opportunistic lock on any file opened in "Deny None" mode. As a result, the server performs automatic read-ahead and write-behind caching on behalf of the redirector.

WindowSizeThreshold

Data type: uint32
Access type: Read/write

The minimum window size before Multichannel will trigger the use of multiple connections. The default value is 1 for Windows Server operating systems and 8 for Windows client operating systems.

Requirements


Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Namespace	Root\Microsoft\Windows\Smb
MOF	SmbWmiV2.mof
DLL	SmbWmiV2.dll

Share via