Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-SmbClientConfiguration

Set-SmbClientConfiguration

smbclientconfiguration.cdxml

Synopsis

Sets the Server Message Block (SMB) client configuration.

Syntax

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

Detailed Description

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

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

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

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

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

None

Notes

None

Examples

EXAMPLE 1

This example sets 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"): 

EXAMPLE 2

This example sets the SMB client configuration without user confirmation.

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


Online Version
Get-SmbClientConfiguration