< Back
Set-BCMinSMBLatency
Post
NAME Set-BCMinSMBLatency
SYNOPSIS
Sets the minimum latency that must exist between client and server before transparent caching functions are utilized.
SYNTAX
Set-BCMinSMBLatency [-LatencyMilliseconds] <UInt32> [-CimSession <CimSession[]>] [-Force] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Set-BCMinSMBLatency cmdlet sets the minimum latency that must exist between client and server before transparent caching functions are used.
Use this cmdlet to specify when client computers in branch offices start caching content from content servers based on the network latency, or
delay, that occurs when the clients download content over a Wide Area Network (WAN) link. When a value for this cmdlet is specified, which is the
maximum round trip network latency allowed before caching begins, clients do not cache content until the network latency reaches the specified
value; when network latency is greater than the value, clients begin caching content after they receive it from the content servers.
For example, if the round trip network latency value is set to zero (0), the client computers always cache content that they receive from the
content servers, no matter how high or low the network latency is between their request for a file and their receipt of the file from the content
server. In another example, if the round trip network latency value is set to 100 milliseconds, then the clients do not cache content that they
receive before 100 milliseconds pass, but they do begin to cache content that they receive after 100 milliseconds pass.
By default, the value of this setting is 80 milliseconds. To make sure that that client computers always cache content, set the network latency
value to 0.
To prevent caching except in circumstances where network latency is very long, set the latency value to a very high value. If a high value is
used, however, then it is possible that network latency will not reach this long a delay, in which case BranchCache is disabled on your network.
Whether this setting is disabled or not configured, the client computer will cache network files if the round trip network latency of the wide
area network (WAN) link is above 80 milliseconds.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-LatencyMilliseconds <UInt32>
Specifies the minimum latency that must exist between client and server before BranchCache begins caching content.
Required? true
Position? 2
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.
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.Prompts you for confirmation before running the cmdlet.
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.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
None
Example 1: Set minimal latency
PS C:\\>Set-BCMinSMBLatency -LatencyMilliseconds 20
This command sets the minimum latency that must exist between client and server before transparent caching functions are used to 20 milliseconds.
RELATED LINKS
Disable-BC
Reset-BC
SYNOPSIS
Sets the minimum latency that must exist between client and server before transparent caching functions are utilized.
SYNTAX
Set-BCMinSMBLatency [-LatencyMilliseconds] <UInt32> [-CimSession <CimSession[]>] [-Force] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Set-BCMinSMBLatency cmdlet sets the minimum latency that must exist between client and server before transparent caching functions are used.
Use this cmdlet to specify when client computers in branch offices start caching content from content servers based on the network latency, or
delay, that occurs when the clients download content over a Wide Area Network (WAN) link. When a value for this cmdlet is specified, which is the
maximum round trip network latency allowed before caching begins, clients do not cache content until the network latency reaches the specified
value; when network latency is greater than the value, clients begin caching content after they receive it from the content servers.
For example, if the round trip network latency value is set to zero (0), the client computers always cache content that they receive from the
content servers, no matter how high or low the network latency is between their request for a file and their receipt of the file from the content
server. In another example, if the round trip network latency value is set to 100 milliseconds, then the clients do not cache content that they
receive before 100 milliseconds pass, but they do begin to cache content that they receive after 100 milliseconds pass.
By default, the value of this setting is 80 milliseconds. To make sure that that client computers always cache content, set the network latency
value to 0.
To prevent caching except in circumstances where network latency is very long, set the latency value to a very high value. If a high value is
used, however, then it is possible that network latency will not reach this long a delay, in which case BranchCache is disabled on your network.
Whether this setting is disabled or not configured, the client computer will cache network files if the round trip network latency of the wide
area network (WAN) link is above 80 milliseconds.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-LatencyMilliseconds <UInt32>
Specifies the minimum latency that must exist between client and server before BranchCache begins caching content.
Required? true
Position? 2
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.
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.Prompts you for confirmation before running the cmdlet.
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.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
None
Example 1: Set minimal latency
PS C:\\>Set-BCMinSMBLatency -LatencyMilliseconds 20
This command sets the minimum latency that must exist between client and server before transparent caching functions are used to 20 milliseconds.
RELATED LINKS
Disable-BC
Reset-BC