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

NAME

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

SYNOPSIS

9       vfs objects = shadow_copy
10

DESCRIPTION

12       This VFS module is part of the samba(7) suite.
13
14       The vfs_shadow_copy VFS module functionality that is similar to
15       Microsoft Shadow Copy services. When setup properly, this module allows
16       Microsoft Shadow Copy clients to browse "shadow copies" on Samba
17       shares.
18
19       This module is stackable.
20

CONFIGURATION

22       vfs_shadow_copy relies on a filesystem snapshot implementation. Many
23       common filesystems have native support for this.
24
25       Filesystem snapshots must be mounted on specially named directories in
26       order to be recognized by vfs_shadow_copy. The snapshot mount points
27       must be immediate children of a the directory being shared.
28
29       The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss, where:
30
31              •   YYYY is the 4 digit year
32
33              •   MM is the 2 digit month
34
35              •   DD is the 2 digit day
36
37              •   hh is the 2 digit hour
38
39              •   mm is the 2 digit minute
40
41              •   ss is the 2 digit second.
42
43
44       The vfs_shadow_copy snapshot naming convention can be produced with the
45       following date(1) command:
46
47                TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S
48
49

EXAMPLES

51       Add shadow copy support to user home directories:
52
53                   [homes]
54                vfs objects = shadow_copy
55

CAVEATS

57       This is not a backup, archival, or version control solution.
58
59       With Samba or Windows servers, vfs_shadow_copy is designed to be an
60       end-user tool only. It does not replace or enhance your backup and
61       archival solutions and should in no way be considered as such.
62       Additionally, if you need version control, implement a version control
63       system.
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_SHADOW_COPY(8)