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

NAME

6       vfs_shadow_copy2 - Expose snapshots to Windows clients as shadow
7       copies.
8

SYNOPSIS

10       vfs objects = shadow_copy2
11

DESCRIPTION

13       This VFS module is part of the samba(7) suite.
14
15       The vfs_shadow_copy2 VFS module functionality that is similar to
16       Microsoft Shadow Copy services. When setup properly, this module allows
17       Microsoft Shadow Copy clients to browse "shadow copies" on Samba
18       shares.
19
20       This is a 2nd implementation of a shadow copy module. This version has
21       the following features:
22
23        1. You don´t need to populate your shares with symlinks to the
24           snapshots. This can be very important when you have thousands of
25           shares, or use [homes].
26
27        2. The inode number of the files is altered so it is different from
28           the original. This allows the ´restore´ button to work without a
29           sharing violation.
30
31
32       This module is stackable.
33

CONFIGURATION

35       vfs_shadow_copy2 relies on a filesystem snapshot implementation. Many
36       common filesystems have native support for this.
37
38       Filesystem snapshots must be mounted on specially named directories in
39       order to be recognized by vfs_shadow_copy2. The snapshot mount points
40       must be immediate children of a the directory being shared.
41
42       The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss, where:
43
44       ·   YYYY is the 4 digit year
45
46       ·   MM is the 2 digit month
47
48       ·   DD is the 2 digit day
49
50       ·   hh is the 2 digit hour
51
52       ·   mm is the 2 digit minute
53
54       ·   ss is the 2 digit second.
55
56
57       The vfs_shadow_copy2 snapshot naming convention can be produced with
58       the following date(1) command:
59
60                TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S
61
62

OPTIONS

64       shadow:snapdir = SNAPDIR
65           Path to the directory where snapshots are kept.
66
67       shadow:basedir = BASEDIR
68           Path to the base directory that snapshots are from.
69
70       shadow:fixinodes = yes/no
71           If you enable shadow:fixinodes then this module will modify the
72           apparent inode number of files in the snapshot directories using a
73           hash of the files path. This is needed for snapshot systems where
74           the snapshots have the same device:inode number as the original
75           files (such as happens with GPFS snapshots). If you don´t set this
76           option then the ´restore´ button in the shadow copy UI will fail
77           with a sharing violation.
78

EXAMPLES

80       Add shadow copy support to user home directories:
81
82                   [homes]
83                vfs objects = shadow_copy2
84                shadow:snapdir = /data/snaphots
85                shadow:basedir = /data/home
86

CAVEATS

88       This is not a backup, archival, or version control solution.
89
90       With Samba or Windows servers, vfs_shadow_copy2 is designed to be an
91       end-user tool only. It does not replace or enhance your backup and
92       archival solutions and should in no way be considered as such.
93       Additionally, if you need version control, implement a version control
94       system.
95

VERSION

97       This man page is correct for version 3.2.7 of the Samba suite.
98

AUTHOR

100       The original Samba software and related utilities were created by
101       Andrew Tridgell. Samba is now developed by the Samba Team as an Open
102       Source project similar to the way the Linux kernel is developed.
103
104
105
106Samba 3.5                         08/02/2011               VFS_SHADOW_COPY2(8)