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
 

Add-BCDataCacheExtension

Add-BCDataCacheExtension

branchcacheorchestrator.cdxml

Synopsis

Increases the amount of cache storage space that is available on a hosted cache server by adding a new cache file.

Syntax

Add-BCDataCacheExtension [-Percentage] [-Path] [-AsJob] [-CimSession] [-Force] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-BCDataCacheExtension [-Path] [-AsJob] [-CimSession] [-Force] [-PassThru] [-ThrottleLimit] [-SizeBytes] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-BCDataCacheExtension cmdlet adds a new data cache file to increase the amount of cache storage space that is available on a hosted cache server. Data cache files can be spread across multiple disks to maximize performance.

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

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Runs the cmdlet without prompting for confirmation.

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>

Specifies the location where the data cache file is created.

Aliases

None

Required?

false

Position

3

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Percentage <UInt32>

Specifies the size of the cache file as a percentage of the disk space. For example, if the value of 15 is provided, then the data cache file has a maximum size of fifteen percent of the disk space on the hard drive where the file is created.

Aliases

None

Required?

false

Position

2

Default value

5

Accept pipeline input?

false

Accept wildcard characters?

false

-SizeBytes <UInt64>

Specifies the size of the cache file in bytes.

Aliases

None

Required?

true

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_NetBranchCacheDataCacheExtension

Notes

None

Examples

EXAMPLE 1

This example creates a data cache extension in the default location reserving 5% of the drive.

PS C:\>Add-BCDataCacheExtension

EXAMPLE 2

This example adds a data cache extension in the C:\datacache directory reserving 10% of the drive C.

PS C:\>Add-BCDataCacheExtension –Path C:\datacache –Percentage 10

Online Version
Get-BCDataCacheExtension
Remove-BCDataCacheExtension