Set-SmbClientConfiguration
Sets the Server Message Block (SMB) client configuration.
Syntax
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] Description
The Set-SmbClientConfiguration cmdlet sets the Server Message Block (SMB) client configuration.
Examples
EXAMPLE 1
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 example sets the SMB client configuration.
EXAMPLE 2
PS C:\>Set-SmbClientConfiguration -ConnectionCountPerRssNetworkInterface 4 -ForceThis example sets the SMB client configuration without user confirmation.
Parameters
-AsJob
ps_cimcommon_asjob
| 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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| 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 |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConnectionCountPerRssNetworkInterface
Specifies the SMB connection count per each RSS network interface.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectoryCacheEntriesMax
Specifies the maximum cache entries that can be in the directory cache.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectoryCacheEntrySizeMax
Specifies the maximum size of directory cache entry.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectoryCacheLifetime
Specifies the directory cache lifetime.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DormantFileLimit
Specifies the dormant file limit.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableBandwidthThrottling
Indicates that bandwidth throttling is enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableByteRangeLockingOnReadOnlyFiles
Indicates that byte range locking on read-only files is enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableLargeMtu
Indicates that large MTU is enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableMultiChannel
Indicates that multi-channel is enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableSecuritySignature
Indicates that the security signature is enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExtendedSessionTimeout
Specifies the extended session timeout.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FileInfoCacheEntriesMax
Specifies the maximum number entries that can be in the file information cache.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FileInfoCacheLifetime
Specifies the file information cache lifetime.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FileNotFoundCacheEntriesMax
Specifies the maximum number entries that can be in the file not found cache.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FileNotFoundCacheLifetime
Specifies the file not found cache lifetime.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeepConn
Specifies the time, in seconds, before the SMB client session is automatically disconnected.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxCmds
Specifies the maximum number of concurrent outstanding network requests that the SMB client supports.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumConnectionCountPerServer
Specifies the maximum connection count per server.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OplocksDisabled
Indicates that opportunistic locks are disabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequireSecuritySignature
Indicates that the security signature is required.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionTimeout
Specifies the session timeout.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| 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 |
-UseOpportunisticLocking
Indicates that opportunistic locks are used.
| Type: | Boolean |
| 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 |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WindowSizeThreshold
Specifies the window size threshold.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
None
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for