Windows 11 netsh branchcache command

Microsoft Windows [Version 10.0.22621.2428]
(c) Microsoft Corporation.

C:\Windows>netsh branchcache ?

The following commands are available:

Commands in this context:
?              - Displays a list of commands.
dump           - Displays a configuration script.
exportkey      - Exports the content information key.
flush          - Flushes the contents of the cache.
help           - Displays a list of commands.
importkey      - Imports a new content information key.
reset          - Resets the BranchCache service.
set            - Sets configuration parameters.
show           - Displays configuration parameters.
smb            - Changes to the `netsh branchcache smb' context.

The following sub-contexts are available:
 smb

To view help for a command, type the command, followed by a space, and then
 type ?.

C:\Windows>netsh branchcache dump ?

Usage: dump

Remarks: 
    Creates a script that contains the current configuration.  If saved to a
    file, this script can be used to restore altered configuration settings.

C:\Windows>netsh branchcache exportkey ?

Usage: exportkey [outputfile=]<File Path> [passphrase]=<Pass Phrase>

Parameters: 

      Tag             Value
      outputfile      - The directory path and name of the file to which the
                        key should be exported
      passphrase      - A passphrase required in order to import the key

Remarks: This command will export the key which the BranchCache service uses to
         protect content information.  The key can then be imported on another
         machine by using the importkey command.

Examples: 

      exportkey %TMP%\secret.key "Key file password"
      exportkey outputfile=C:\KeyDirectory\secret.key "Key file password"

C:\Windows>netsh branchcache flush ?

Usage: flush

Flushes the contents of the local and publication caches.

Examples: 

      flush

C:\Windows>netsh branchcache help ?

Usage: help

Remarks: 
       Displays a list of commands.

C:\Windows>netsh branchcache importkey ?

Usage: importkey [inputfile=]<File Path> [passphrase]=<Pass Phrase>

Parameters: 

      Tag             Value
      inputfile       - The location of the file from which the key should be
                        imported
      passphrase      - The passphrase used when exporting the key using the
                        exportkey command

Remarks: This command will import a new key for the BranchCache service to use
         to protect content information.  The key must have been previously
         exported by means of the exportkey command. If the service is
         currently running, this command will stop and restart it in order to
         begin using the new key.

Examples: 

      importkey %TMP%\secret.key "Key file password"
      importkey inputfile=C:\KeyDirectory\secret.key "Key file password"

C:\Windows>netsh branchcache reset ?

Usage: reset

Remarks: Resets the BranchCache service. Flushes the local and publication
         caches. Every configuration parameter of BranchCache will be reset to its
         default value.

Examples: 

      reset

C:\Windows>netsh branchcache set ?

The following commands are available:

Commands in this context:
set cachesize  - Sets the size of the local cache.
set key        - Generates a new content information key.
set localcache - Sets the location of the local cache.
set publicationcache - Sets the location of the local publication cache.
set publicationcachesize - Sets the size of the local publication cache.
set service    - Sets the status of the BranchCache service.

C:\Windows>netsh branchcache set cachesize ?

Usage: set cachesize [size=]{DEFAULT|<number>} [[percent=]{TRUE|FALSE}]

Parameters: 

      Tag         Value
      size      - The size of the cache. Entered as either a percentage or an
                  exact number of bytes.  Set to DEFAULT to restore the
                  default configuration
      percent   - Determines if the size tag is treated as a percentage of the
                  size of the hard disk or as an exact number of bytes.
                  Ignored if the size tag is set to DEFAULT.
                  TRUE       - size is a percentage of the size of the hard
                               disk
                  FALSE      - size is an exact number of bytes (Default)

Remarks: Sets the size of the BranchCache service's local cache.  The size can
         be entered as either an exact number of bytes, or as a percentage of
         the size of the disk.  Note that this refers to the size of the disk
         on which the cache is located, not the total size of all disks present
         on this computer.

Examples: 

      set cachesize DEFAULT
      set cachesize 20971520
      set cachesize size=20 percent=TRUE

C:\Windows>netsh branchcache set key ?

Usage: set key [[passphrase=]<Pass Phrase>]
Parameters: 

      Tag             Value
      passphrase      - A passphrase to use to generate the key.  If a
                        passphrase is not provided, a random key will be
                        generated. Two keys generated using the same passphrase
                        will always be identical.  Using a passphrase is a
                        convenient way to duplicate the same key on another
                        machine. (Optional)

Remarks: Generates a new key for the BranchCache service to use to protect
         content information. If the service is currently running, this command
         will stop and restart it in order to begin using the new key.

Examples: 

      set key
      set key passphrase="I want my content to be secure"

C:\Windows>netsh branchcache set localcache ?

Usage: set localcache [directory=]{DEFAULT|<File Path>}

Parameters: 

      Tag              Value
      directory      - The fully qualified path to the directory in which the
                       local cache should be stored.  Set to DEFAULT to restore
                       the default cache location.

Remarks: Sets the location of the BranchCache service's local cache.  Note
         that the service will be stopped and restarted if necessary in order
         to complete the change.  Any existing cache files will be moved to the
         new location.
Examples: 

      set localcache DEFAULT
      set localcache directory=C:\BranchCache\Localcache

C:\Windows>netsh branchcache set publicationcache ?

Usage: set publicationcache [directory=]{DEFAULT|<File Path>}

Parameters: 

      Tag              Value
      directory      - The fully qualified path to the directory in which the
                       local publication cache should be stored.  Set to
                       DEFAULT to restore the default cache location.

Remarks: Sets the location of the BranchCache service's local publication cache.
         Note that the service will be stopped and restarted if necessary in
         order to complete the change.

Examples: 

      set publicationcache DEFAULT
      set publicationcache directory=C:\BranchCache\PublicationCache

C:\Windows>netsh branchcache set publicationcachesize ?

Usage: set publicationcachesize [size=]{DEFAULT|<number>} [[percent=]{TRUE|FALSE}]

Parameters: 

      Tag         Value
      size      - The size of the cache. Entered as either a percentage or an
                  exact number of bytes.  Set to DEFAULT to restore the
                  default configuration
      percent   - Determines if the size tag is treated as a percentage of the
                  size of the hard disk or as an exact number of bytes.
                  Ignored if the size tag is set to DEFAULT.
                  TRUE       - size is a percentage of the size of the hard
                               disk
                  FALSE      - size is an exact number of bytes (Default)

Remarks: Sets the size of the BranchCache service's local publication cache.
         The size can be entered as either an exact number of bytes, or as a
         percentage of the size of the disk.  Note that this refers to the size
         of the disk on which the cache is located, not the total size of all
         disks present on this computer.

Examples: 

      set publicationcachesize DEFAULT
      set publicationcachesize 20971520
      set publicationcachesize size=20 percent=TRUE

C:\Windows>netsh branchcache set service ?

Usage: set service [mode=]{DISABLED|LOCAL|DISTRIBUTED|HOSTEDSERVER|HOSTEDCLIENT}
                   [[location]=<Host Name>]
                   [[clientauthentication]={DOMAIN|NONE}]
                   [[serveonbattery]={TRUE|FALSE}]

Parameters: 

      Tag                    Value
      mode                 - Set the status of the BranchCache Service
                               DISABLED          - Disable the service
                               LOCAL             - Uses Local Caching Only
                               DISTRIBUTED       - Distributed Caching Enabled
                               HOSTEDSERVER      - Set as a Hosted Cache Server
                               HOSTEDCLIENT      - Set as a Hosted Cache Client
      location             - Set the location of the Hosted Cache Server.  This
                             tag is only necessary if the mode tag is set to
                             HOSTEDCLIENT and is invalid otherwise.
      clientauthentication - Set the mechanism used by a Hosted Cache Server to
                             authenticate clients.  This tag is only used
                             if the mode tag is set to HOSTEDSERVER and is
                             invalid otherwise.
                               DOMAIN            - Clients of the hosted cache
                                                   must be members of the same
                                                   domain
                               NONE              - No authentication mechanism
                                                   is used
      serveonbattery       - Enables the local client to respond to peers for
                             requests for cached data while on battery power
                             This tag is only used if the mode tag is set to
                             DISTRIBUTED and is invalid otherwise.
                               TRUE              - Enables serving data while
                                                   on battery power.
                               FALSE             - Disables serving data while
                                                   on batter power.

Remarks: Sets the status of the BranchCache service. This command will also
         ensure that the necessary firewall configuration for the chosen mode
         is in place.

         It is strongly recommended that you provide a fully qualified domain
         name as the location of the Hosted Cache when setting Hosted Cache
         Client mode.

Examples: 

      set service DISABLED
      set service mode=DISTRIBUTED
      set service mode=HOSTEDCLIENT location=SERVER123
      set service mode=HOSTEDSERVER clientauthentication=DOMAIN

C:\Windows>netsh branchcache show ?

The following commands are available:

Commands in this context:
show hostedcache - Displays the location of the hosted cache.
show localcache - Displays the status of the local cache.
show publicationcache - Displays the status of the local publication cache.
show status    - Displays the current status of the BranchCache service.

C:\Windows>netsh branchcache show hostedcache ?

Usage: show hostedcache

Remarks: Displays the location of the hosted cache

Examples: 

      show hostedcache

C:\Windows>netsh branchcache show localcache ?

Usage: show localcache

Remarks: Displays the status of the local cache.  The maximum size of the cache
         can be configured as either an exact number of bytes or as a
         percentage of the size of the disk.  Note that this refers to the size
         of the disk on which the cache is located, not the total size of all 
         disks present on this computer.

Examples: 

      show localcache

C:\Windows>netsh branchcache show publicationcache ?

Usage: show publicationcache

Remarks: Displays the status of the local publication cache.  The maximum size
         of the cache can be configured as either an exact number of bytes or
         as a percentage of the size of the disk.  Note that this refers to
         the size of the disk on which the cache is located, not the total size
         of all disks present on this computer.

Examples: 

      show publicationcache

C:\Windows>netsh branchcache show status ?

Usage: show status [[detail=]{BASIC|ALL}]

Parameters: 

      Tag         Value
      detail      - The level of detail to display (Optional)
                    BASIC      - Display only basic information (Default)
                    ALL        - Display all available information

Remarks: Displays the current status of the BranchCache service.

Examples: 

      show status
      show status ALL
      show status detail=ALL

C:\Windows>netsh branchcache smb ?

The following commands are available:

Commands in this context:
?              - Displays a list of commands.
dump           - Displays a configuration script.
help           - Displays a list of commands.
set            - Sets configuration parameters.
show           - Displays configuration parameters.

To view help for a command, type the command, followed by a space, and then
 type ?.

C:\Windows>netsh branchcache smb dump ?

Usage: dump

Remarks: 
    Creates a script that contains the current configuration.  If saved to a
    file, this script can be used to restore altered configuration settings.

C:\Windows>netsh branchcache smb help ?

Usage: help

Remarks: 
       Displays a list of commands.

C:\Windows>netsh branchcache smb set ?

The following commands are available:

Commands in this context:
set latency    - Sets BranchCache SMB latency.

C:\Windows>netsh branchcache smb set latency ?

Usage: set latency [latency=]<number>

      Parameters:

      Tag         Value
      latency      - Minimum link latency to the branch office before SMB will use BranchCache caching. In milliseconds
                  

C:\Windows>netsh branchcache smb show ?

The following commands are available:

Commands in this context:
show latency   - Displays BranchCache SMB latency settings.

C:\Windows>netsh branchcache smb show latency ?

Usage: get

      Parameters: None