| 1 |
'\" t |
| 2 |
.\" Title: vfs_shadow_copy |
| 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_SHADOW_COPY" "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_shadow_copy \- Expose snapshots to Windows clients as shadow copies\&. |
| 32 |
.SH "SYNOPSIS" |
| 33 |
.HP \w'\ 'u |
| 34 |
vfs objects = shadow_copy |
| 35 |
.SH "DESCRIPTION" |
| 36 |
.PP |
| 37 |
This VFS module is part of the |
| 38 |
\fBsamba\fR(7) |
| 39 |
suite\&. |
| 40 |
.PP |
| 41 |
The |
| 42 |
vfs_shadow_copy |
| 43 |
VFS module functionality that is similar to Microsoft Shadow Copy services\&. When setup properly, this module allows Microsoft Shadow Copy clients to browse "shadow copies" on Samba shares\&. |
| 44 |
.PP |
| 45 |
This module is stackable\&. |
| 46 |
.SH "CONFIGURATION" |
| 47 |
.PP |
| 48 |
vfs_shadow_copy |
| 49 |
relies on a filesystem snapshot implementation\&. Many common filesystems have native support for this\&. |
| 50 |
.PP |
| 51 |
Filesystem snapshots must be mounted on specially named directories in order to be recognized by |
| 52 |
vfs_shadow_copy\&. The snapshot mount points must be immediate children of the directory being shared\&. |
| 53 |
.PP |
| 54 |
The snapshot naming convention is @GMT\-YYYY\&.MM\&.DD\-hh\&.mm\&.ss, where: |
| 55 |
.RS |
| 56 |
.sp |
| 57 |
.RS 4 |
| 58 |
.ie n \{\ |
| 59 |
\h'-04'\(bu\h'+03'\c |
| 60 |
.\} |
| 61 |
.el \{\ |
| 62 |
.sp -1 |
| 63 |
.IP \(bu 2.3 |
| 64 |
.\} |
| 65 |
YYYY |
| 66 |
is the 4 digit year |
| 67 |
.RE |
| 68 |
.sp |
| 69 |
.RS 4 |
| 70 |
.ie n \{\ |
| 71 |
\h'-04'\(bu\h'+03'\c |
| 72 |
.\} |
| 73 |
.el \{\ |
| 74 |
.sp -1 |
| 75 |
.IP \(bu 2.3 |
| 76 |
.\} |
| 77 |
MM |
| 78 |
is the 2 digit month |
| 79 |
.RE |
| 80 |
.sp |
| 81 |
.RS 4 |
| 82 |
.ie n \{\ |
| 83 |
\h'-04'\(bu\h'+03'\c |
| 84 |
.\} |
| 85 |
.el \{\ |
| 86 |
.sp -1 |
| 87 |
.IP \(bu 2.3 |
| 88 |
.\} |
| 89 |
DD |
| 90 |
is the 2 digit day |
| 91 |
.RE |
| 92 |
.sp |
| 93 |
.RS 4 |
| 94 |
.ie n \{\ |
| 95 |
\h'-04'\(bu\h'+03'\c |
| 96 |
.\} |
| 97 |
.el \{\ |
| 98 |
.sp -1 |
| 99 |
.IP \(bu 2.3 |
| 100 |
.\} |
| 101 |
hh |
| 102 |
is the 2 digit hour |
| 103 |
.RE |
| 104 |
.sp |
| 105 |
.RS 4 |
| 106 |
.ie n \{\ |
| 107 |
\h'-04'\(bu\h'+03'\c |
| 108 |
.\} |
| 109 |
.el \{\ |
| 110 |
.sp -1 |
| 111 |
.IP \(bu 2.3 |
| 112 |
.\} |
| 113 |
mm |
| 114 |
is the 2 digit minute |
| 115 |
.RE |
| 116 |
.sp |
| 117 |
.RS 4 |
| 118 |
.ie n \{\ |
| 119 |
\h'-04'\(bu\h'+03'\c |
| 120 |
.\} |
| 121 |
.el \{\ |
| 122 |
.sp -1 |
| 123 |
.IP \(bu 2.3 |
| 124 |
.\} |
| 125 |
ss |
| 126 |
is the 2 digit second\&. |
| 127 |
.RE |
| 128 |
.sp |
| 129 |
.RE |
| 130 |
.PP |
| 131 |
The |
| 132 |
vfs_shadow_copy |
| 133 |
snapshot naming convention can be produced with the following |
| 134 |
\fBdate\fR(1) |
| 135 |
command: |
| 136 |
.sp |
| 137 |
.if n \{\ |
| 138 |
.RS 4 |
| 139 |
.\} |
| 140 |
.nf |
| 141 |
TZ=GMT date +@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S |
| 142 |
.fi |
| 143 |
.if n \{\ |
| 144 |
.RE |
| 145 |
.\} |
| 146 |
.SH "EXAMPLES" |
| 147 |
.PP |
| 148 |
Add shadow copy support to user home directories: |
| 149 |
.sp |
| 150 |
.if n \{\ |
| 151 |
.RS 4 |
| 152 |
.\} |
| 153 |
.nf |
| 154 |
\fI[homes]\fR |
| 155 |
\m[blue]\fBvfs objects = shadow_copy\fR\m[] |
| 156 |
.fi |
| 157 |
.if n \{\ |
| 158 |
.RE |
| 159 |
.\} |
| 160 |
.SH "CAVEATS" |
| 161 |
.PP |
| 162 |
This is not a backup, archival, or version control solution\&. |
| 163 |
.PP |
| 164 |
With Samba or Windows servers, |
| 165 |
vfs_shadow_copy |
| 166 |
is designed to be an end\-user tool only\&. It does not replace or enhance your backup and archival solutions and should in no way be considered as such\&. Additionally, if you need version control, implement a version control system\&. |
| 167 |
.SH "VERSION" |
| 168 |
.PP |
| 169 |
This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&. |
| 170 |
.SH "AUTHOR" |
| 171 |
.PP |
| 172 |
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\&. |