MSFT_SmbServerConfiguration class

  • Article

Represents the configuration of an SMB server.

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

Syntax

[dynamic, provider("smbwmiv2"), ClassVersion("7")]
class MSFT_SmbServerConfiguration
{
  boolean AnnounceServer;
  uint32  AsynchronousCredits;
  boolean AutoShareServer;
  boolean AutoShareWorkstation;
  uint32  CachedOpenLimit;
  string  AnnounceComment;
  boolean EnableDownlevelTimewarp;
  boolean EnableLeasing;
  boolean EnableMultiChannel;
  boolean EnableStrictNameChecking;
  uint32  AutoDisconnectTimeout;
  uint32  DurableHandleV2TimeoutInSeconds;
  boolean EnableAuthenticateUserSharing;
  boolean EnableForcedLogoff;
  boolean EnableOplocks;
  boolean EnableSecuritySignature;
  boolean ServerHidden;
  uint32  IrpStackSize;
  uint32  KeepAliveTime;
  uint32  MaxChannelPerSession;
  uint32  MaxMpxCount;
  uint32  MaxSessionPerConnection;
  uint32  MaxThreadsPerQueue;
  uint32  MaxWorkItems;
  string  NullSessionPipes;
  string  NullSessionShares;
  uint32  OplockBreakWait;
  uint32  PendingClientTimeoutInSeconds;
  boolean RequireSecuritySignature;
  boolean EnableSMB1Protocol;
  boolean EnableSMB2Protocol;
  uint32  Smb2CreditsMax;
  uint32  Smb2CreditsMin;
  uint32  SmbServerNameHardeningLevel;
  boolean TreatHostAsStableStorage;
  boolean ValidateAliasNotCircular;
  boolean ValidateShareScope;
  boolean ValidateShareScopeNotAliased;
  boolean ValidateTargetName;
  boolean EncryptData;
  boolean RejectUnencryptedAccess;
  boolean AuditSmb1Access;
};

Members

The MSFT_SmbServerConfiguration class has these types of members:

Methods

The MSFT_SmbServerConfiguration class has these methods.

Method Description
GetConfiguration Retrieves SMB server configuration values.
SetConfiguration Sets SMB server configuration values.

Properties

The MSFT_SmbServerConfiguration class has these properties.

AnnounceComment

Data type: string

Access type: Read/write

A string to be used in browser announcements. See the AnnounceServer property.

AnnounceServer

Data type: boolean

Access type: Read/write

Controls whether the server announces itself via browser announcements.

AsynchronousCredits

Data type: uint32

Access type: Read/write

The maximum number of concurrent asynchronous SMB commands that are allowed on a single connection.

AuditSmb1Access

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 and Windows 10.

AutoDisconnectTimeout

Data type: uint32

Access type: Read/write

The number of minutes after which an idle connection will be disconnected.

AutoShareServer

Data type: boolean

Access type: Read/write

Controls whether default server shares will be shared out.

AutoShareWorkstation

Data type: boolean

Access type: Read/write

Controls whether default workstation shares will be shared out.

CachedOpenLimit

Data type: uint32

Access type: Read/write

Controls maximum number of cached open files.

DurableHandleV2TimeoutInSeconds

Data type: uint32

Access type: Read/write

Number of minutes after which a handle that has been preserved for durability will be closed by the system if a client has not reclaimed it.

EnableAuthenticateUserSharing

Data type: boolean

Access type: Read/write

Controls whether the connection can be shared among authenticated users.

EnableDownlevelTimewarp

Data type: boolean

Access type: Read/write

Controls whether down-level timewarp is enabled.

EnableForcedLogoff

Data type: boolean

Access type: Read/write

Controls whether forced logoff will be enabled.

EnableLeasing

Data type: boolean

Access type: Read/write

Controls whether leasing will be enabled.

EnableMultiChannel

Data type: boolean

Access type: Read/write

Controls whether SMB Multichannel is enabled for this server.

EnableOplocks

Data type: boolean

Access type: Read/write

Controls whether opportunistic locking is enabled.

EnableSecuritySignature

Data type: boolean

Access type: Read/write

Controls whether security signature is enabled.

EnableSMB1Protocol

Data type: boolean

Access type: Read/write

Controls whether SMB1 protocol is enabled.

EnableSMB2Protocol

Data type: boolean

Access type: Read/write

Controls whether SMB2 protocol is enabled.

EnableStrictNameChecking

Data type: boolean

Access type: Read/write

Controls whether the server should do strict name checking on incoming connection requests.

EncryptData

Data type: boolean

Access type: Read/write

Controls whether this server allows for SMB Encryption. To ensure security, data will be encrypted in flight if this property is True or if the EncryptData property of the corresponding MSFT_SmbShare object is True.

IrpStackSize

Data type: uint32

Access type: Read/write

Controls the default IRP stack size.

KeepAliveTime

Data type: uint32

Access type: Read/write

Controls how often TCP attempts to verify that an idle connection is still available by sending a Keep Alive packet. This property overrides the server Keep Alive time setting.

MaxChannelPerSession

Data type: uint32

Access type: Read/write

Maximum number of channels per session.

MaxMpxCount

Data type: uint32

Access type: Read/write

Controls the maximum MPX count for SMB1.

MaxSessionPerConnection

Data type: uint32

Access type: Read/write

Maximum number of sessions that can be served per connection.

MaxThreadsPerQueue

Data type: uint32

Access type: Read/write

Maximum threads per worker queue.

MaxWorkItems

Data type: uint32

Access type: Read/write

Controls the maximum SMB1 work items.

NullSessionPipes

Data type: string

Access type: Read/write

The pipes allowable by null sessions for this server.

NullSessionShares

Data type: string

Access type: Read/write

The shares allowable by null sessions for this server.

OplockBreakWait

Data type: uint32

Access type: Read/write

Controls how long the create caller will wait on an oplock break.

PendingClientTimeoutInSeconds

Data type: uint32

Access type: Read/write

Number of seconds after which a pending client request will be timed out.

RejectUnencryptedAccess

Data type: boolean

Access type: Read/write

True if unencrypted access requests should be rejected.

RequireSecuritySignature

Data type: boolean

Access type: Read/write

Controls whether security signature is required.

ServerHidden

Data type: boolean

Access type: Read/write

Controls whether the server will announce itself. If True, the server will not announce itself.

Smb2CreditsMax

Data type: uint32

Access type: Read/write

Maximum number of SMB2 credits.

Smb2CreditsMin

Data type: uint32

Access type: Read/write

Minimum number of SMB2 credits.

SmbServerNameHardeningLevel

Data type: uint32

Access type: Read/write

The SMB server name hardening level.

TreatHostAsStableStorage

Data type: boolean

Access type: Read/write

Controls whether the host is treated as stable storage.

ValidateAliasNotCircular

Data type: boolean

Access type: Read/write

Controls whether aliases not being circular will be validated.

ValidateShareScope

Data type: boolean

Access type: Read/write

Controls whether existence of share scopes will be checked during share creation.

ValidateShareScopeNotAliased

Data type: boolean

Access type: Read/write

Controls whether to validate share scopes that are not aliased on creation.

ValidateTargetName

Data type: boolean

Access type: Read/write

Controls whether to validate target name on alias creation.

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