Skip to content
PowerShell Commands

Set-SmbClientConfiguration

Set-SmbClientConfiguration [-CimSession <CimSession[]>] [-ConnectionCountPerRssNetworkInterface <UInt32>][-DirectoryCacheEntriesMax <UInt32>] [-DirectoryCacheEntrySizeMax <UInt32>] [-DirectoryCacheLifetime <UInt32>][-DormantFileLimit <UInt32>] [-EnableBandwidthThrottling <Boolean>] [-EnableByteRangeLockingOnReadOnlyFiles<Boolean>] [-EnableLargeMtu <Boolean>] [-EnableLoadBalanceScaleOut <System.Boolean>] [-EnableMultiChannel<Boolean>] [-EnableSecuritySignature <Boolean>] [-ExtendedSessionTimeout <UInt32>] [-FileInfoCacheEntriesMax<UInt32>] [-FileInfoCacheLifetime <UInt32>] [-FileNotFoundCacheEntriesMax <UInt32>] [-FileNotFoundCacheLifetime<UInt32>] [-Force] [-KeepConn <UInt32>] [-MaxCmds <UInt32>] [-MaximumConnectionCountPerServer <UInt32>][-OplocksDisabled <Boolean>] [-RequireSecuritySignature <Boolean>] [-SessionTimeout <UInt32>] [-ThrottleLimit<Int32>] [-UseOpportunisticLocking <Boolean>] [-WindowSizeThreshold <UInt32>] [-Confirm] [-WhatIf][<CommonParameters>]

The Set-SmbClientConfiguration cmdlet sets the Server Message Block (SMB) client configuration.

Parameters

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

-ConnectionCountPerRssNetworkInterface [<UInt32>]

Specifies the SMB connection count per each RSS network interface.

-DirectoryCacheEntriesMax [<UInt32>]

Specifies the maximum cache entries that can be in the directory cache.

-DirectoryCacheEntrySizeMax [<UInt32>]

Specifies the maximum size of directory cache entry.

-DirectoryCacheLifetime [<UInt32>]

Specifies the directory cache lifetime.

-DormantFileLimit [<UInt32>]

Specifies the dormant file limit.

-EnableBandwidthThrottling [<Boolean>]

Indicates that bandwidth throttling is enabled.

-EnableByteRangeLockingOnReadOnlyFiles [<Boolean>]

Indicates that byte range locking on read-only files is enabled.

-EnableLargeMtu [<Boolean>]

Indicates that large MTU is enabled.

-EnableLoadBalanceScaleOut [<System.Boolean>]

Indicates whether load balance scale out is enabled.

-EnableMultiChannel [<Boolean>]

Indicates that multi-channel is enabled.

-EnableSecuritySignature [<Boolean>]

Indicates that the security signature is enabled.

-ExtendedSessionTimeout [<UInt32>]

Specifies the extended session time-out.

-FileInfoCacheEntriesMax [<UInt32>]

Specifies the maximum number entries that can be in the file information cache.

-FileInfoCacheLifetime [<UInt32>]

Specifies the file information cache lifetime.

-FileNotFoundCacheEntriesMax [<UInt32>]

Specifies the maximum number entries that can be in the file not found cache.

-FileNotFoundCacheLifetime [<UInt32>]

Specifies the file not found cache lifetime.

-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.

-KeepConn [<UInt32>]

Specifies the time, in seconds, before the SMB client session is automatically disconnected.

-MaxCmds [<UInt32>]

Specifies the maximum number of concurrent outstanding network requests that the SMB client supports.

-MaximumConnectionCountPerServer [<UInt32>]

Specifies the maximum connection count per server.

-OplocksDisabled [<Boolean>]

Indicates that opportunistic locks are disabled.

-RequireSecuritySignature [<Boolean>]

Indicates that the security signature is required.

-SessionTimeout [<UInt32>]

Specifies the session time-out.

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

-UseOpportunisticLocking [<Boolean>]

Indicates that opportunistic locks are used.

-WindowSizeThreshold [<UInt32>]

Specifies the window size threshold.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

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

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs
None
Outputs
None
Examples
  1. Set the SMB client configuration:
    PS C:\> Set-SmbClientConfiguration -ConnectionCountPerRssNetworkInterface 8
Confirm Are you sure you want to perform this action? Performing operation 'Modify' on Target 'SMB Client Configuration'. [Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"):

    This command sets the SMB client configuration.

  2. Set the SMB client configuration without confirmation:
    PS C:\> Set-SmbClientConfiguration -ConnectionCountPerRssNetworkInterface 4 -Force

    This command sets the SMB client configuration without user confirmation.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands