Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_snapper.8

raw
1 '\" t
2 .\" Title: vfs_snapper
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "VFS_SNAPPER" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 vfs_snapper \- Expose snapshots managed by snapper as shadow\-copies
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = snapper
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(8)
39 suite\&.
40 .PP
41 The
42 vfs_snapper
43 VFS module exposes snapshots managed by snapper for use by Samba\&. This provides the ability for remote SMB clients to access shadow\-copies via Windows Explorer using the "previous versions" dialog\&.
44 .PP
45 Snapshots can also be created and remove remotely, using the File Server Remote VSS Protocol (FSRVP)\&. Snapshot creation and deletion requests are forwarded to snapper via DBus\&.
46 .PP
47 This module is stackable\&.
48 .SH "CONFIGURATION"
49 .PP
50 The underlying share path must have a corresponding snapper configuration file\&. The snapshot directory tree must allow access for relevant users\&.
51 .sp
52 .if n \{\
53 .RS 4
54 .\}
55 .nf
56 \fI[share]\fR
57 \m[blue]\fBvfs objects = snapper\fR\m[]
58 .fi
59 .if n \{\
60 .RE
61 .\}
62 .PP
63 For remote snapshot creation and deletion, Samba\*(Aqs FSRVP server must be configured in the [global] section:
64 .sp
65 .if n \{\
66 .RS 4
67 .\}
68 .nf
69 \fI[global]\fR
70 \m[blue]\fBregistry shares = yes\fR\m[]
71 \m[blue]\fBinclude = registry\fR\m[]
72 .fi
73 .if n \{\
74 .RE
75 .\}
76 .SH "PERMISSIONS"
77 .PP
78 Snapper stores snapshots under a \&.snapshots subdirectory\&. This directory must permit traversal for any users wishing to access snapshots via the Windows Explorer previous versions dialog\&. By default, traversal is forbidden for all non\-root users\&. Additionally, users must be granted permission to list snapshots managed by snapper, via snapper\*(Aqs ALLOW_USERS or ALLOW_GROUPS options\&. Snapper can grant these users and groups \&.snapshots traversal access automatically via the SYNC_ACL option\&.
79 .PP
80 Remote snapshot creation and deletion is only permitted by Samba for Active Directory administrators, backup operators, or users explicitly granted SeBackupPrivilege\&. Snapper must also permit creation and deletion for the appropriate user, via snapper\*(Aqs ALLOW_USERS or ALLOW_GROUPS options\&.
81 .PP
82 The DiskShadow\&.exe FSRVP client initially authenticates as the Active Directory computer account\&. This account must therefore be granted the same permissions as the user account issuing the snapshot creation and deletion requests\&.
83 .SH "VERSION"
84 .PP
85 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
86 .SH "AUTHOR"
87 .PP
88 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\&.