Skip to main content

vserver cifs branchcache modify

Contributors
Suggest changes
PDFs

Modify the CIFS BranchCache service settings

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The vserver cifs branchcache modify command modifies the configuration for computing and retrieving BranchCache hash data.

Parameters

-vserver <vserver name> - Vserver

This parameter specifies the CIFS-enabled Vserver whose BranchCache service is to be modified.

[-versions {v1-enable|v2-enable|enable-all}] - Supported BranchCache Versions

This optional parameter specifies a list of versions of the BranchCache protocol that the storage system supports. The default is enable-all . This list can include one or more of the following:

  • v1-enable - This option enables BranchCache Version 1.

  • v2-enable - This option enables BranchCache Version 2.

  • enable-all - This option enables all supported versions of BranchCache.

[-operating-mode <BranchCache Mode>] - CIFS BranchCache Operating Modes

This optional parameter specifies the mode in which the BranchCache service operates. The default is per-share . Possible values include:

  • disable - This option disables the BranchCache service for the Vserver.

  • all-shares - This option enables the BranchCache service for all the shares on this Vserver.

  • per-share - This option enables the BranchCache service on a per-share basis. You can enable the BranchCache service on an existing share by adding the branchcache flag in the -share-properties parameter of the vserver cifs share modify command.

[-hash-store-max-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum Size of the Hash Store

This optional parameter specifies the maximum size to use for the hash data. If the size of the hash data exceeds this value, older hashes are deleted to make room for newer hashes. The default is 1 GB.

[-flush-hashes {true|false}] - Delete Existing Hashes

This parameter specifies whether to keep or delete all the existing hashes. This must be set to true when modifying the server key.

[-hash-store-path <text>] - Path to Hash Store

This parameter specifies an existing directory into which the hash data is stored. Read-only paths, such as snapshot directories, are not allowed.

[-server-key <text>] - Encryption Key Used to Secure the Hashes

This optional parameter specifies a server key that the BranchCache service uses to prevent clients from impersonating the BranchCache server. If you specify this parameter, all existing hashes for the Vserver are deleted.

Examples

The following example modifies the BranchCache service on the Vserver named vs1. The path to the hash store is /vs1_hash_store_2, the server key used to secure the hashes is set to "new vserver secret", all existing hashes are removed, the service supports all BranchCache versions, and is enabled on a per-share basis.

cluster1::> vserver cifs branchcache modify -vserver vs1 -hash-store-path /vs1_hash_store_2 -server-key "new vserver secret" -flush-hashes true -versions enable-all -operating-mode per-share
The following example modifies the BranchCache service on the Vserver vs1. The service is enabled on all the shares of the Vserver, supports BranchCache version 1, and supports a maximum of 1 TB of BranchCache hashes.
cluster1::> vserver cifs branchcache modify -vserver vs1 -operating-mode all-shares -versions v1-enable -hash-store-max-size 1TB