Get-SmbServerConfiguration

Module:

SmbShare

Retrieves the SMB server configuration.

Syntax

Get-SmbServerConfiguration
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-SmbServerConfiguration cmdlet retrieves the Server Message Block (SMB) server configuration.

Examples

Example 1: Get SMB server configuration

Get-SmbServerConfiguration

AnnounceComment                        :
AnnounceServer                         : False
AsynchronousCredits                    : 512
AuditSmb1Access                        : False
AutoDisconnectTimeout                  : 15
AutoShareServer                        : True
AutoShareWorkstation                   : True
CachedOpenLimit                        : 10
DisableSmbEncryptionOnSecureConnection : True
DurableHandleV2TimeoutInSeconds        : 180
EnableAuthenticateUserSharing          : False
EnableDownlevelTimewarp                : False
EnableForcedLogoff                     : True
EnableLeasing                          : True
EnableMultiChannel                     : True
EnableOplocks                          : True
EnableSecuritySignature                : False
EnableSMB1Protocol                     : False
EnableSMB2Protocol                     : True
EnableStrictNameChecking               : True
EncryptData                            : False
IrpStackSize                           : 15
KeepAliveTime                          : 2
MaxChannelPerSession                   : 32
MaxMpxCount                            : 50
MaxSessionPerConnection                : 16384
MaxThreadsPerQueue                     : 20
MaxWorkItems                           : 1
NullSessionPipes                       :
NullSessionShares                      :
OplockBreakWait                        : 35
PendingClientTimeoutInSeconds          : 120
RejectUnencryptedAccess                : True
RequireSecuritySignature               : False
ServerHidden                           : True
Smb2CreditsMax                         : 8192
Smb2CreditsMin                         : 512
SmbServerNameHardeningLevel            : 0
TreatHostAsStableStorage               : False
ValidateAliasNotCircular               : True
ValidateShareScope                     : True
ValidateShareScopeNotAliased           : True
ValidateTargetName                     : True
RestrictNamedpipeAccessViaQuic         : True
EnableSMBQUIC                          : True
EncryptionCiphers                      : AES_128_GCM, AES_128_CCM, AES_256_GCM, AES_256_CCM

This command retrieves the SMB server configuration.

Note

The EncryptionCiphers parameter is available beginning with 2022-06 Cumulative Update for Microsoft server operating system version 21H2 for x64-based Systems (KB5014665), and Cumulative Update for Windows 11, version 22H2 (KB5014668).

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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.

Type:	CimSession[]
Aliases:	Session
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

CimInstance

The MSFT_SmbServerConfiguration object represents the configuration of the SMB server.

Related Links

• Set-SmbServerConfiguration