Branch Cache Cmdlets in Windows PowerShell

Updated: September 2, 2016

Applies To: Windows 10, Windows PowerShell 5.0, Windows Server Technical Preview

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

BranchCache Manageability

This reference provides cmdlet descriptions and syntax for all BranchCache Manageability-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

 

Cmdlet Description

Add-BCDataCacheExtension

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

Clear-BCCache

Deletes all data in all data and hash files.

Disable-BC

Disables the BranchCache service.

Disable-BCDowngrading

Disables downgrading, so that client computers do not request previous versions of content information from content servers.

Disable-BCServeOnBattery

Configures a client to ignore content discovery requests in distributed cache mode when operating on battery power.

Enable-BCDistributed

Enables BranchCache and configures a computer to operate in distributed cache mode.

Enable-BCDowngrading

Instructs a client computer that is running an operating system in a downgraded mode.

Enable-BCHostedClient

Configures BranchCache to operate in hosted cache client mode.

Enable-BCHostedServer

Configures BranchCache to operate in hosted cache server mode.

Enable-BCLocal

Enables the BranchCache service in local caching mode.

Enable-BCServeOnBattery

Configures a client to listen for content discovery requests in distributed cache mode when operating on battery power.

Export-BCCachePackage

Exports a cache package.

Export-BCSecretKey

Exports a secret key to a file.

Get-BCClientConfiguration

Retrieves the current BranchCache client computer settings.

Get-BCContentServerConfiguration

Retrieves the current BranchCache content server settings.

Get-BCDataCache

Retrieves the BranchCache data cache.

Get-BCDataCacheExtension

Retrieves the BranchCache data cache extensions from a hosted cache server.

Get-BCHashCache

Retrieves the BranchCache hash cache.

Get-BCHostedCacheServerConfiguration

Retrieves the current BranchCache hosted cache server settings.

Get-BCNetworkConfiguration

Retrieves the current BranchCache network settings.

Get-BCStatus

Retrieves a set of objects that provide BranchCache status and configuration information.

Import-BCCachePackage

Imports a cache package.

Import-BCSecretKey

Imports the cryptographic key that BranchCache uses for the generation of segment secrets.

Publish-BCFileContent

Generates hashes for files in shared folders.

Publish-BCWebContent

Creates hashes for web content.

Remove-BCDataCacheExtension

Deletes a data cache file.

Reset-BC

Resets BranchCache to the default configuration.

Set-BCAuthentication

Specifies the BranchCache computer authentication mode.

Set-BCCache

Modifies the cache file configuration.

Set-BCDataCacheEntryMaxAge

Modifies the maximum amount of time that data can remain in the cache.

Set-BCMinSMBLatency

Sets the minimum latency that must exist between client and server before transparent caching functions are utilized.

Set-BCSecretKey

Sets the cryptographic key used in the generation of segment secrets.

noteNote
To list all the cmdlets that are available, use the Get-Command –Module BranchCache cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Examples
Get-Help <cmdlet name> -Full

Community Additions

ADD
Show: