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

NAME

6       vfs_snapper - Expose snapshots managed by snapper as shadow-copies
7

SYNOPSIS

9       vfs objects = snapper
10

DESCRIPTION

12       This VFS module is part of the samba(8) suite.
13
14       The vfs_snapper VFS module exposes snapshots managed by snapper for use
15       by Samba. This provides the ability for remote SMB clients to access
16       shadow-copies via Windows Explorer using the "previous versions"
17       dialog.
18
19       Snapshots can also be created and remove remotely, using the File
20       Server Remote VSS Protocol (FSRVP). Snapshot creation and deletion
21       requests are forwarded to snapper via DBus.
22
23       This module is stackable.
24

CONFIGURATION

26       The underlying share path must have a corresponding snapper
27       configuration file. The snapshot directory tree must allow access for
28       relevant users.
29
30                     [share]
31                     vfs objects = snapper
32
33
34       For remote snapshot creation and deletion, Samba's FSRVP server must be
35       configured in the [global] section:
36
37                     [global]
38                     registry shares = yes
39                     include = registry
40
41

PERMISSIONS

43       Snapper stores snapshots under a .snapshots subdirectory. This
44       directory must permit traversal for any users wishing to access
45       snapshots via the Windows Explorer previous versions dialog. By
46       default, traversal is forbidden for all non-root users. Additionally,
47       users must be granted permission to list snapshots managed by snapper,
48       via snapper's ALLOW_USERS or ALLOW_GROUPS options. Snapper can grant
49       these users and groups .snapshots traversal access automatically via
50       the SYNC_ACL option.
51
52       Remote snapshot creation and deletion is only permitted by Samba for
53       Active Directory administrators, backup operators, or users explicitly
54       granted SeBackupPrivilege. Snapper must also permit creation and
55       deletion for the appropriate user, via snapper's ALLOW_USERS or
56       ALLOW_GROUPS options.
57
58       The DiskShadow.exe FSRVP client initially authenticates as the Active
59       Directory computer account. This account must therefore be granted the
60       same permissions as the user account issuing the snapshot creation and
61       deletion requests.
62

VERSION

64       This man page is part of version 4.19.3 of the Samba suite.
65

AUTHOR

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