Set-SmbClientConfiguration

Set-SmbClientConfiguration

Sets the Server Message Block (SMB) client configuration.

Syntax

Parameter Set: SetConfiguration1
Set-SmbClientConfiguration [-AsJob] [-CimSession <CimSession[]> ] [-ConnectionCountPerRssNetworkInterface <UInt32> ] [-DirectoryCacheEntriesMax <UInt32> ] [-DirectoryCacheEntrySizeMax <UInt32> ] [-DirectoryCacheLifetime <UInt32> ] [-DormantFileLimit <UInt32> ] [-EnableBandwidthThrottling <Boolean> ] [-EnableByteRangeLockingOnReadOnlyFiles <Boolean> ] [-EnableLargeMtu <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>]

Detailed Description

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

Parameters

-AsJob

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	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ConnectionCountPerRssNetworkInterface<UInt32>

Specifies the SMB connection count per each RSS network interface.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DirectoryCacheEntriesMax<UInt32>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DirectoryCacheEntrySizeMax<UInt32>

Specifies the maximum size of directory cache entry.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DirectoryCacheLifetime<UInt32>

Specifies the directory cache lifetime.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DormantFileLimit<UInt32>

Specifies the dormant file limit.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EnableBandwidthThrottling<Boolean>

Indicates that bandwidth throttling is enabled.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EnableByteRangeLockingOnReadOnlyFiles<Boolean>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EnableLargeMtu<Boolean>

Indicates that large MTU is enabled.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EnableMultiChannel<Boolean>

Indicates that multi-channel is enabled.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EnableSecuritySignature<Boolean>

Indicates that the security signature is enabled.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ExtendedSessionTimeout<UInt32>

Specifies the extended session timeout.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-FileInfoCacheEntriesMax<UInt32>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-FileInfoCacheLifetime<UInt32>

Specifies the file information cache lifetime.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-FileNotFoundCacheEntriesMax<UInt32>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-FileNotFoundCacheLifetime<UInt32>

Specifies the file not found cache lifetime.

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

-KeepConn<UInt32>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MaxCmds<UInt32>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MaximumConnectionCountPerServer<UInt32>

Specifies the maximum connection count per server.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-OplocksDisabled<Boolean>

Indicates that opportunistic locks are disabled.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RequireSecuritySignature<Boolean>

Indicates that the security signature is required.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SessionTimeout<UInt32>

Specifies the session timeout.

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

-UseOpportunisticLocking<Boolean>

Indicates that opportunistic locks are used.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WindowSizeThreshold<UInt32>

Specifies the window size threshold.

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: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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

This example sets the SMB client configuration.

PS C:\> Set-SmbClientConfiguration -ConnectionCountPerRssNetworkInterface 8

EXAMPLE 2

This example sets the SMB client configuration without user confirmation.

PS C:\> Set-SmbClientConfiguration -ConnectionCountPerRssNetworkInterface 4 -Force

Related topics

Get-SmbClientConfiguration