vserver cifs branchcache create

Create the CIFS BranchCache service

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

Description

The vserver cifs branchcache create command creates the configuration for computing and retrieving BranchCache hash data. Only a single instance of the BranchCache service can be created on a Vserver.

Parameters

-vserver <vserver name> - Vserver
This parameter specifies the CIFS-enabled Vserver on which you want to set up the BranchCache service.
[-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.
-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.
[-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.
[-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.
[-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.

Examples

The following example creates the BranchCache service on the Vserver named vs1. The path to the hash store is /vs1_hash_store.
cluster1::> vserver cifs branchcache create -vserver vs1 -hash-store-path /vs1_hash_store
The following example creates the BranchCache service on the Vserver vs1. The path to the hash store is /vs_hash_store. The service is enabled on all the shares of the Vserver, supports BranchCache version 2, supports a maximum of 1 GB of BranchCache hashes, and secures the hashes using the key "vs1 secret".
cluster1::> vserver cifs branchcache create -vserver vs1 -hash-store-path /vs1_hash_store -operating-mode all-shares -versions v2-enable -hash-store-max-size 1GB -server-key "vs1 secret"