VFS_BTRFS(8)

πŸ’š VFS_BTRFS(8) β€” System Administration tools πŸ’š

okay bestie, welcome to the vfs_btrfs page, section 8 of the system administration tools manuals πŸ¦‹ she's part of the samba(8) suite and she's here to make your Btrfs filesystem do cute little tricks for SMB clients. no cap.


✨ NAME ✨

vfs_btrfs β€” Utilize features provided by the Btrfs filesystem πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

vfs objects = btrfs

🌸 DESCRIPTION 🌸

so this VFS module is part of the samba(8) suite 🫢 and what she does is expose Btrfs specific features for use by Samba. main character energy, honestly.

here's the tea on the cloned ranges thing πŸ“ Btrfs allows for multiple files to share the same on-disk data through the use of cloned ranges. when an SMB client issues a request to copy duplicate data (via FSCTL_SRV_COPYCHUNK), this module maps the request to a Btrfs clone range IOCTL, instead of performing reads and writes required by a traditional copy. literally the glow-up: it saves storage capacity and greatly reduces disk IO. we love an efficient queen πŸ‘‘

this module also exposes Btrfs per-file compression support to SMB clients via the get/set compression fsctls ✨

and Btrfs snapshots can be manipulated by Samba's FSRVP server 🧚 but listen β€” snapshot manipulation using this module is currently considered experimental, and is therefore disabled by default. the vfs_snapper module is instead recommended for this purpose, so like, keep that in mind πŸ™ˆ

this module is stackable πŸ’– (she plays well with others, obviously)


πŸ’… OPTIONS πŸ’…

  • btrfs: manipulate snapshots = [yes|no] β€” when you set this to yes, experimental support for the creation and deletion of snapshots via corresponding Btrfs IOCTLs will be enabled πŸ”₯ the default is no, which means that such requests are passed through to any underlying VFS module. so if you don't touch it, she minds her business and lets the next module in the stack handle it πŸ€·β™€οΈ

🌈 CONFIGURATION 🌈

vfs_btrfs requires that the underlying share path is a Btrfs subvolume. non-negotiable bestie πŸ’€

[share]
vfs objects = btrfs
btrfs: manipulate snapshots = no

to use the experimental snapshot manipulation functionality provided by this module, it must be explicitly enabled, and Samba's FSRVP server must be running πŸƒβ™€οΈ both. not one. both.

the vfs_shadow_copy module can be used to expose snapshots created by vfs_btrfs to Windows Explorer as file / directory "previous versions" πŸ‘‘ iconic behaviour honestly.

[global]
registry shares = yes
include = registry

[share]
vfs objects = btrfs shadow_copy
btrfs: manipulate snapshots = yes

⭐ VERSION ⭐

this man page is part of version 4.24.7-Ubuntu-4.24.7+dfsg-1ubuntu1 of the Samba suite 🌟


πŸ‘‘ AUTHOR πŸ‘‘

the original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed 🌈


okay that's the whole page bestie, go forth and clone those ranges πŸ¦‹πŸ’–

and that's a wrap from VFS_BTRFS(8) β€” Samba version 4.24.7-Ubuntu-4.24.7+dfsg-1ubuntu1, dated 09/13/2026. periodt, mwah πŸ’‹

πŸ“¦ where this page comes from