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

Set-BCCache

branchcacheorchestrator.cdxml

Synopsis

Modifies the cache file configuration.

Syntax

Set-BCCache [-Path] [-AsJob] [-CimSession] [-Defragment] [-Force] [-MoveTo] [-PassThru] [-Percentage] [-SizeBytes] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-BCCache [-Cache] [-AsJob] [-CimSession] [-Defragment] [-Force] [-MoveTo] [-PassThru] [-Percentage] [-SizeBytes] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-BCCache cmdlet modifies the cache file configuration. Use the Cache parameter to specify which cache should be configured.

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

-Cache <CimInstance[]>

Specifies the cache which should be modified.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByValue)

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

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Defragment <SwitchParameter>

Specifies that the cache should be defragmented. Fragmented cache files store data less effectively. The BranchCache service detects cache fragmentation and raises an event in the Windows Event Log when it is time to defragment the cache.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Runs the cmdlet without prompting for confirmation. By default the cmdlet asks for confirmation from the user before proceeding.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MoveTo <String>

Specifies the new location on disk for this cache file.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output. To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Path <String>

Runs the cmdlet on the specified cache file.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Percentage <UInt32>

Specifies the new size of this cache file. The size is a percentage of the disk.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-SizeBytes <UInt64>

Specifies the new size of the cache file.

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

-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

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimV2\MSFT_NetBranchCacheCache[]

Notes

None

Examples

Example 1

This example moves the cache file from C:\datacache to D:\datacache.

PS C:\>Set-BCCache -Path C:\datacache –MoveTo D:\datacache

Example 2

This example increases data cache files from 10% to 20%.

PS C:\>Get-BCDataCacheExtension | Where-Object –FilterScript {$_.MaxCacheSizeAsPercentageOfDiskVolume –Eq 10} | Set-BCCache -Percentage 20

Online Version
Where-Object
Clear-BCCache
Get-BCDataCacheExtension