source: vendor/current/docs/manpages/vfs_snapper.8

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 3.8 KB
Line 
1'\" t
2.\" Title: vfs_snapper
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: System Administration tools
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "VFS_SNAPPER" "8" "10/25/2016" "Samba 4\&.4" "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"
31vfs_snapper \- Expose snapshots managed by snapper as shadow\-copies
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34vfs objects = snapper
35.SH "DESCRIPTION"
36.PP
37This VFS module is part of the
38\fBsamba\fR(8)
39suite\&.
40.PP
41The
42vfs_snapper
43VFS 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
45Snapshots 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
47This module is stackable\&.
48.SH "CONFIGURATION"
49.PP
50The underlying share path must have a corresponding snapper configuration file\&. The snapshot directory tree must allow access for relavent 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
59.fi
60.if n \{\
61.RE
62.\}
63.PP
64For remote snapshot creation and deletion, Samba\*(Aqs FSRVP server must be configured in the [global] section:
65.sp
66.if n \{\
67.RS 4
68.\}
69.nf
70 \fI[global]\fR
71 \m[blue]\fBrpc_daemon:fssd = fork\fR\m[]
72 \m[blue]\fBregistry shares = yes\fR\m[]
73 \m[blue]\fBinclude = registry\fR\m[]
74
75.fi
76.if n \{\
77.RE
78.\}
79.SH "PERMISSIONS"
80.PP
81Snapper 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\&.
82.PP
83Remote 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\&.
84.PP
85The 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\&.
86.SH "VERSION"
87.PP
88This man page is correct for version 4\&.3\&.0 of the Samba suite\&.
89.SH "AUTHOR"
90.PP
91The 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\&.
Note: See TracBrowser for help on using the repository browser.