1VFS_BTRFS(8)              System Administration tools             VFS_BTRFS(8)
2
3
4

NAME

6       vfs_btrfs - Utilize features provided by the Btrfs filesystem
7

SYNOPSIS

9       vfs objects = btrfs
10

DESCRIPTION

12       This VFS module is part of the samba(8) suite.
13
14       The vfs_btrfs VFS module exposes Btrfs specific features for use by
15       Samba.
16
17       Btrfs allows for multiple files to share the same on-disk data through
18       the use cloned ranges. When an SMB client issues a request to copy
19       duplicate data (via FSCTL_SRV_COPYCHUNK), this module maps the request
20       to a Btrfs clone range IOCTL, instead of performing reads and writes
21       required by a traditional copy. Doing so saves storage capacity and
22       greatly reduces disk IO.
23
24       This module also exposes Btrfs per-file compression support to SMB
25       clients via the get/set compression fsctls.
26
27       Btrfs snapshots can be manipulated by Samba's FSRVP server. Snapshot
28       manipulation using this module is currently considered experimental,
29       and is therefore disabled by default. The vfs_snapper module is instead
30       recommended for this purpose.
31
32       This module is stackable.
33

OPTIONS

35       btrfs: manipulate snapshots = [yes|no]
36           When set to yes, experimental support for the creation and deletion
37           of snapshots via corresponding Btrfs IOCTLs will be enabled. The
38           default is no, which means that such requests are passed through to
39           any underlying VFS module.
40

CONFIGURATION

42       vfs_btrfs requires that the underlying share path is a Btrfs subvolume.
43
44                     [share]
45                     vfs objects = btrfs
46                     btrfs: manipulate snapshots = no
47
48
49       To use the experimental snapshot manipulation functionality provided by
50       this module, it must be explicitly enabled, and Samba's FSRVP server
51       must be running.
52
53       The vfs_shadow_copy module can be used to expose snapshots created by
54       vfs_btrfs to Windows Explorer as file / directory "previous versions".
55
56                     [global]
57                     registry shares = yes
58                     include = registry
59
60                     [share]
61                     vfs objects = btrfs shadow_copy
62                     btrfs: manipulate snapshots = yes
63
64

VERSION

66       This man page is part of version 4.19.3 of the Samba suite.
67

AUTHOR

69       The original Samba software and related utilities were created by
70       Andrew Tridgell. Samba is now developed by the Samba Team as an Open
71       Source project similar to the way the Linux kernel is developed.
72
73
74
75Samba 4.19.3                      11/27/2023                      VFS_BTRFS(8)
Impressum