Set-SmbServerConfiguration

Set-SmbServerConfiguration

Sets the SMB Service configuration.

Syntax

Parameter Set: SetConfiguration1
Set-SmbServerConfiguration [-AnnounceComment <String> ] [-AnnounceServer <Boolean> ] [-AsynchronousCredits <UInt32> ] [-AutoDisconnectTimeout <UInt32> ] [-AutoShareServer <Boolean> ] [-AutoShareWorkstation <Boolean> ] [-CachedOpenLimit <UInt32> ] [-CimSession <CimSession[]> ] [-DurableHandleV2TimeoutInSeconds <UInt32> ] [-EnableAuthenticateUserSharing <Boolean> ] [-EnableDownlevelTimewarp <Boolean> ] [-EnableForcedLogoff <Boolean> ] [-EnableLeasing <Boolean> ] [-EnableMultiChannel <Boolean> ] [-EnableOplocks <Boolean> ] [-EnableSecuritySignature <Boolean> ] [-EnableSMB1Protocol <Boolean> ] [-EnableSMB2Protocol <Boolean> ] [-EnableStrictNameChecking <Boolean> ] [-EncryptData <Boolean> ] [-Force] [-IrpStackSize <UInt32> ] [-KeepAliveTime <UInt32> ] [-MaxChannelPerSession <UInt32> ] [-MaxMpxCount <UInt32> ] [-MaxSessionPerConnection <UInt32> ] [-MaxThreadsPerQueue <UInt32> ] [-MaxWorkItems <UInt32> ] [-NullSessionPipes <String> ] [-NullSessionShares <String> ] [-OplockBreakWait <UInt32> ] [-PendingClientTimeoutInSeconds <UInt32> ] [-RejectUnencryptedAccess <Boolean> ] [-RequireSecuritySignature <Boolean> ] [-ServerHidden <Boolean> ] [-Smb2CreditsMax <UInt32> ] [-Smb2CreditsMin <UInt32> ] [-SmbServerNameHardeningLevel <UInt32> ] [-ThrottleLimit <Int32> ] [-TreatHostAsStableStorage <Boolean> ] [-ValidateAliasNotCircular <Boolean> ] [-ValidateShareScope <Boolean> ] [-ValidateShareScopeNotAliased <Boolean> ] [-ValidateTargetName <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]




Detailed Description

The Set-SmbServerConfiguration cmdlet sets the Server Message Block (SMB) Service configuration.

Parameters

-AnnounceComment<String>

Specifies the announce comment string.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AnnounceServer<Boolean>

Indicates that this server announces itself by using browser announcements.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AsynchronousCredits<UInt32>

Specifies the asynchronous credits.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AutoDisconnectTimeout<UInt32>

Specifies the auto disconnect time-out.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AutoShareServer<Boolean>

Indicates that the default server shares are shared out.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AutoShareWorkstation<Boolean>

Indicates whether the default workstation shares are shared out.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CachedOpenLimit<UInt32>

Specifies the maximum number of cached open files.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DurableHandleV2TimeoutInSeconds<UInt32>

Specifies the durable handle v2 time-out period, in seconds.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableAuthenticateUserSharing<Boolean>

Indicates whether authenticate user sharing is enabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableDownlevelTimewarp<Boolean>

Indicates whether down-level timewarp support is disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableForcedLogoff<Boolean>

Indicates whether forced logoff is enabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableLeasing<Boolean>

Indicates whether leasing is disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableMultiChannel<Boolean>

Indicates whether multi-channel is disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableOplocks<Boolean>

Indicates whether the opportunistic locks are enabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableSecuritySignature<Boolean>

Indicates whether the security signature is enabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableSMB1Protocol<Boolean>

Indicates whether the SMB1 protocol is enabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableSMB2Protocol<Boolean>

Indicates whether the SMB2 protocol is enabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableStrictNameChecking<Boolean>

Indicates whether the server should perform strict name checking on incoming connects.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EncryptData<Boolean>

Indicates whether the sessions established on this server are encrypted.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Forces the command to run without asking for user confirmation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IrpStackSize<UInt32>

Specifies the default IRP stack size.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-KeepAliveTime<UInt32>

Specifies the keep alive time.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MaxChannelPerSession<UInt32>

Specifies the maximum channels per session.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MaxMpxCount<UInt32>

Specifies the maximum MPX count for SMB1.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MaxSessionPerConnection<UInt32>

Specifies the maximum sessions per connection.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MaxThreadsPerQueue<UInt32>

Specifies the maximum threads per queue.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MaxWorkItems<UInt32>

Specifies the maximum SMB1 work items.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NullSessionPipes<String>

Specifies the null session pipes.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NullSessionShares<String>

Specifies the null session shares.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OplockBreakWait<UInt32>

Specifies how long the create caller waits for an opportunistic lock break.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PendingClientTimeoutInSeconds<UInt32>

Specifies the pending client time-out period, in seconds.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RejectUnencryptedAccess<Boolean>

Indicates whether the client that does not support encryption is denied access if it attempts to connect to an encrypted share.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RequireSecuritySignature<Boolean>

Indicates whether the security signature is required.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServerHidden<Boolean>

Indicates whether the server announces itself.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Smb2CreditsMax<UInt32>

Specifies the maximum SMB2 credits.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Smb2CreditsMin<UInt32>

Specifies the minimum SMB2 credits.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SmbServerNameHardeningLevel<UInt32>

Specifies the SMB Service name hardening level.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TreatHostAsStableStorage<Boolean>

Indicates whether the host is treated as the stable storage.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ValidateAliasNotCircular<Boolean>

Indicates whether the aliases that are not circular are validated.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ValidateShareScope<Boolean>

Indicates that the existence of share scopes is checked during share creation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ValidateShareScopeNotAliased<Boolean>

Indicates whether the share scope being aliased is validated.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ValidateTargetName<Boolean>

Indicates whether the target name is validated.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

<WorkflowParameters>

This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see    about_WorkflowCommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Examples

Example 1: Set the SMB Service configuration

This command sets the SMB Service configuration.


PS C:\> Set-SmbServerConfiguration -MaxChannelPerSession 16

Example 2: Set the SMB Service configuration without confirmation

This command sets the SMB Service configuration without user confirmation.


PS C:\> Set-SmbServerConfiguration -MaxChannelPerSession 32 -Force

Related topics

Community Additions

ADD
Show: