๐ก What You'll Learn: Complete step-by-step configuration of BranchCache on NetApp CIFS shares, Windows client setup, performance testing, and troubleshooting common issues.
To enable BranchCache on selected NetApp CIFS shares, run vserver cifs branchcache create to configure the hash store on the SVM, check that each share has oplocks and manual Offline Files caching, then add the branchcache share property with vserver cifs share properties add. A new BranchCache configuration defaults to per-share mode; -versions enable-all can be set if both content-information versions are needed. On the client side, enable Distributed or Hosted Cache mode (via Enable-BCDistributed or Group Policy). When requested content is present in the branch cache and the client meets its network-file latency threshold, it can fetch cached segments over the LAN instead of fetching those segments across the WAN.
That's the summary an AI Overview gives you. What it can't show you is how the pieces hand off to each other โ where the hash comes from, what crosses the WAN versus the LAN, and which of the two cache modes fits your branch. Here's the animated request flow, a mode/version comparison you can decide from, the exact ONTAP and PowerShell commands in order, and a symptom-to-fix table for when nothing caches.
How BranchCache Actually Moves Data
Before the commands, understand the handoff. The NetApp system sends content information to authorized clients, which use it to find and validate cached segments on a local peer (Distributed mode) or a branch server (Hosted mode). SMB requests and metadata still cross the WAN. If segments are missing, changed, or evicted from the branch cache, the client may fetch them from the content server across the WAN.
Microsoft's BranchCache protocol overview describes these cache retrieval and validation steps.
Prerequisites
Before enabling BranchCache on your NetApp CIFS shares, ensure that your environment meets these critical requirements:
ONTAP Version Compatibility
BranchCache is supported from clustered Data ONTAP 8.2 onward, including ONTAP 9. Check your installed version with:
cluster version show
NetApp's clustered Data ONTAP 8.2 CIFS guide documents BranchCache on that release.
SMB Protocol Requirements
For BranchCache to function, your SMB server must support the correct protocol version:
-
BranchCache v1 requires SMB 2.1 or later
-
BranchCache v2 requires SMB 3.0 or later
At the ONTAP CLI, enter the advanced privilege level before checking or changing these SMB options:
set -privilege advanced
Verify your SMB protocol settings:
vserver cifs options show -vserver <vserver_name>
Return to the admin privilege level after the SMB option checks or changes:
set -privilege admin
Windows Client Compatibility
BranchCache is a Windows feature, so ensure your remote clients are running:
-
Windows 7 Enterprise or Ultimate, or a later BranchCache-capable Windows client
-
A BranchCache-capable Windows Server edition, if used as a client
Pick Your Mode and Version Before You Configure
Two decisions shape the deployment: which cache mode the branch uses, and which BranchCache content-information version the participating systems can use. Check these before running the commands below.
| Decision | Distributed Cache | Hosted Cache | BranchCache v1 | BranchCache v2 |
|---|---|---|---|---|
| Where content lives | Spread across client PCs (peer-to-peer) | One Windows Server in the branch | n/a | n/a |
| Extra server needed | No | Yes; use a supported Windows Server edition (see note below) | n/a | n/a |
| Survives client reboot / sleep | Coverage can drop as PCs leave | Hosted content can remain available | n/a | n/a |
| Hashing granularity | n/a | n/a | Fixed-size file segments | Smaller variable-size segments |
| Minimum SMB version | n/a | n/a | SMB 2.1 | SMB 3.0 |
| Client OS floor | Windows 7 Enterprise or Ultimate | Windows 7 Enterprise or Ultimate; supported Windows Server for cache | Windows 7 Enterprise or Ultimate / Server 2008 R2 | Windows 8 / Server 2012 |
| Which should I use? | Small branch without a local cache server | Branch with a supported local cache server | Needed for Windows 7 clients and Windows Server 2008 R2 hosted caches | Available when the client and hosted cache server support v2 |
Microsoft's BranchCache overview and version matrix describe the segment formats and version selection. For a Windows Server 2008 R2 hosted cache, Microsoft lists specific Enterprise and Datacenter variants and Windows Server 2008 R2 for Itanium-Based Systems; other 2008 R2 editions are not covered by that hosted-cache list. Check the Microsoft page for supported editions and current deployment guidance.
Set the NetApp SVM to -versions enable-all when you need to serve both content-information versions. The version actually used depends on the client, content server, and hosted cache server; a Windows Server 2008 R2 hosted cache limits even newer clients to v1. Choose the cache mode on the Windows side based on whether the branch has a supported server.
Step 1: Verify SMB Protocol Settings
Before enabling BranchCache, you must ensure that the correct SMB protocol versions are enabled on your NetApp storage system.
Enable SMB 2.1 and SMB 3.0
Enter the advanced privilege level, check the current settings, and enable only the SMB versions your clients need:
set -privilege advanced
Enable SMB 2.1 for BranchCache v1 support if it is disabled:
vserver cifs options modify -vserver <vserver_name> -smb2-enabled true
Enable SMB 3.0 for BranchCache v2 support if it is disabled:
vserver cifs options modify -vserver <vserver_name> -smb3-enabled true
After modifying SMB settings, confirm the changes with vserver cifs options show -vserver <vserver_name>, then return to the admin privilege level:
set -privilege admin
Step 2: Configure BranchCache on NetApp CIFS Server
Now that SMB protocols are enabled, configure BranchCache on your NetApp CIFS server by setting up a hash store and enabling the service.
Create BranchCache Hash Store
BranchCache requires a dedicated hash store where metadata for cached files is stored. Create a writable directory for the hash store on the SVM before running this command, and replace the example path below with the path you created:
vserver cifs branchcache create -vserver <vserver_name> -hash-store-path /vol/branchcache -hash-store-max-size 20GB
The 20GB value is an example allocation; NetApp documents a 1GB default when -hash-store-max-size is omitted. Size the store for your workload and monitor whether older hashes are discarded.
Configure BranchCache Versions and Operating Mode
Enable both BranchCache content-information versions if your clients need them:
vserver cifs branchcache modify -vserver <vserver_name> -versions enable-all
Per-share is the default operating mode for a new configuration. To set it explicitly or change an existing configuration:
vserver cifs branchcache modify -vserver <vserver_name> -operating-mode per-share
Step 3: Enable BranchCache on CIFS Shares
With BranchCache configured at the SVM level, you now need to enable it on specific CIFS shares to control which data is cached.
List Available CIFS Shares
First, check existing CIFS shares on your NetApp system:
vserver cifs share show -vserver <vserver_name>
Enable BranchCache on Specific Shares
Check the share's Offline Files setting and share properties in the listing above. NetApp requires Offline Files set to manual for a BranchCache share; if it differs, change it:
vserver cifs share modify -vserver <vserver_name> -share-name <share_name> -offline-files manual
Ensure the share has the oplocks property. If it is absent, add it while retaining the share's other properties:
vserver cifs share properties add -vserver <vserver_name> -share-name <share_name> -share-properties oplocks
Enable BranchCache on the share:
vserver cifs share properties add -vserver <vserver_name> -share-name <share_name> -share-properties branchcache
Verify BranchCache is enabled on the share:
vserver cifs share show -vserver <vserver_name> -share-name <share_name>
โ ๏ธ Important: Check for branchcache and oplocks under Share Properties and manual under Offline Files. If any setting is absent, review the share configuration before testing.
Step 4: Configure Windows Clients
After enabling BranchCache on NetApp CIFS shares, configure Windows client devices to take advantage of local caching.
Enable BranchCache on Individual Clients
Open PowerShell as administrator and check BranchCache status:
Get-BCStatus
If BranchCache is disabled, enable the mode used by your branch. For Distributed Cache mode, run:
Enable-BCDistributed
For Hosted Cache mode, configure clients with the hosted cache server name as shown below, or use Group Policy discovery with a registered service connection point.
Deploy a Hosted Cache Server (Hosted Cache Mode)
On a supported Windows Server in the branch, open PowerShell as administrator. The following commands follow Microsoft's hosted cache deployment procedure for Windows Server 2012 and later; use the separate guidance linked below for Windows Server 2008 R2:
Install-WindowsFeature BranchCache -IncludeManagementTools
For a domain-joined server, register a service connection point (SCP) so domain clients can discover it:
Enable-BCHostedServer -RegisterSCP
Get-BCStatus
For a server without domain membership, run Enable-BCHostedServer without -RegisterSCP, then Get-BCStatus. Confirm HostedCacheServerIsEnabled is True; for SCP discovery, also confirm HostedCacheScpRegistrationEnabled is True. On clients that will use a server by name instead of SCP discovery, run:
Enable-BCHostedClient -ServerNames <hosted_cache_server_name>
Get-BCStatus
Confirm the client's CurrentClientMode is HostedCacheClient and HostedCacheServerList names the intended server. See Microsoft's client configuration procedure for manual setup and its Group Policy procedure for domain clients and firewall rules. A Windows Server 2008 R2 hosted cache needs its separate deployment guide and certificate setup.
Group Policy Configuration (Enterprise Recommended)
For enterprise environments, use Group Policy to configure BranchCache across multiple clients:
-
Open Group Policy Management Console (GPMC)
-
Navigate to: Computer Configuration โ Policies โ Administrative Templates โ Network โ BranchCache
-
Enable "Turn on BranchCache"
-
Enable "Set BranchCache Distributed Cache mode". If a hosted cache server is deployed and registered in Active Directory, also enable "Enable Automatic Hosted Cache Discovery by Service Connection Point" so clients can switch to Hosted Cache mode when they discover it
-
Apply the policy to your Active Directory OU containing branch office computers
These policies select which computers use BranchCache and their cache mode. Share and file permissions determine which users can access the content.
Force Group Policy update on client machines:
gpupdate /force
Step 5: Test and Verify BranchCache
After configuration, it's essential to verify that BranchCache is working correctly and providing performance benefits.
Verify Client Status
On Windows clients, confirm BranchCache is running:
Get-BCStatus
Check cached data:
Get-BCDataCache
Performance Testing
Test file retrieval performance:
-
Open a representative file from the CIFS share
-
Close the file and note the access time
-
Open the file from another BranchCache client in the branch and compare cache retrieval counters with WAN traffic; a same-client reopen can reflect the local file cache
Check the NetApp BranchCache configuration:
vserver cifs branchcache show -vserver <vserver_name>
For hash generation and BranchCache activity, use NetApp's hashd and cifs statistics counters at the advanced privilege level. vserver cifs branchcache show displays configuration, not performance counters. On the Windows client, review BranchCache cache and retrieval counters; compare a second client's retrieval with WAN traffic and the network-file latency threshold.
๐ฏ Success Indicators: BranchCache is active, cached data accumulates on clients, and cache-hit statistics increase when another branch client reads the same content.
Best Practices and Optimization
Follow these best practices to ensure optimal BranchCache performance, security, and long-term maintenance.
Performance Optimization
-
Adjust Hash Store Size: NetApp's default is 1GB; increase it if hash eviction is frequent for your workload
-
Use SSD Storage: Store BranchCache data on SSD-backed volumes for improved read speeds
-
Monitor Cache Utilization: Regularly check cache usage with
Get-BCDataCache -
Network Performance: Review Windows BranchCache cache and retrieval counters alongside WAN traffic
Security Considerations
-
NTFS Permissions: Ensure CIFS shares have proper read/write permissions
-
BitLocker Encryption: Configure Windows BitLocker to encrypt cached content on clients
-
Audit Logging: If file-access auditing is needed, create an SVM audit configuration and configure the relevant file or directory audit settings first; then enable it with
vserver audit enable -vserver <vserver_name>(command reference) -
Access Controls: Apply BranchCache Group Policy to the intended computers, and use share and file permissions to control user access to content
Maintenance and Updates
-
Keep ONTAP Updated: Regular updates provide performance improvements and security patches
-
Windows Updates: Ensure clients receive latest BranchCache updates via Windows Update or WSUS
-
Regular Testing: Periodically test file access speeds to confirm BranchCache effectiveness
-
Documentation: Maintain records of configured shares and client deployments
Troubleshooting: When Nothing Caches
When BranchCache is not serving cached content, use these checks to narrow down the cause.
| Symptom | Likely cause | Fix |
|---|---|---|
| Files never cache on any client | Share settings incomplete | Check for branchcache and oplocks share properties and Offline Files set to manual; correct missing settings and confirm with vserver cifs share show |
| Service configured but no hashes generated | BranchCache configuration missing or disabled on the SVM, or no eligible client requests | Check vserver cifs branchcache show; create a configuration if none exists, or change an existing disable operating mode to per-share. Then inspect hashd and cifs statistics counters for activity |
| Only some clients benefit | SMB version mismatch (client below 2.1/3.0) | Enable SMB 2.1/3.0 on the SVM and confirm the client negotiates it; set SVM -versions enable-all |
| Files do not produce cache hits | Client mode, network-file latency threshold, or branch cache availability | Check Get-BCStatus for the intended mode, review the network-file caching threshold, and test available content from a second client |
Get-BCStatus shows service stopped | Client BranchCache service not enabled | Enable-BCDistributed (peer mode) or Enable-BCHostedClient (hosted mode), or push via Group Policy |
| Cache hits work on LAN but WAN still saturated | Cache coverage is incomplete or other SMB traffic remains | Compare WAN traffic with cache activity; check for missing or evicted segments and clients that leave Distributed Cache mode |
| Hashes stale after files change | Content changed and cached segments are no longer reusable | Re-test access to the changed content and inspect hashd and cifs statistics counters for hash generation and retrieval activity |
| Group Policy set but clients ignore it | Policy not applied to the right OU | Confirm the OU targets branch computers, then gpupdate /force and re-check Get-BCStatus |
Conclusion
BranchCache on NetApp CIFS shares can improve remote file access and reduce WAN content transfers when the client's network-file latency threshold is met and the needed segments are available in the branch cache. Results depend on cache coverage, file changes, and the remaining SMB traffic.
After configuring BranchCache on the SVM, shares, and Windows clients, verify the share settings and use client and ONTAP statistics counters to evaluate whether the deployment is serving cached content.
๐ Related Resources: For additional NetApp optimization techniques, explore our guide on connecting to storage systems using iSCSI, NFS, and CIFS/SMB.