| 1 | '\" t
|
|---|
| 2 | .\" Title: vfs_shadow_copy2
|
|---|
| 3 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 4 | .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
|---|
| 5 | .\" Date: 09/18/2013
|
|---|
| 6 | .\" Manual: System Administration tools
|
|---|
| 7 | .\" Source: Samba 3.6
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "VFS_SHADOW_COPY2" "8" "09/18/2013" "Samba 3\&.6" "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_copy2 \- Expose snapshots to Windows clients as shadow copies\&.
|
|---|
| 32 | .SH "SYNOPSIS"
|
|---|
| 33 | .HP \w'\ 'u
|
|---|
| 34 | vfs objects = shadow_copy2
|
|---|
| 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_copy2
|
|---|
| 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 is a 2nd implementation of a shadow copy module\&. This version has the following features:
|
|---|
| 46 | .sp
|
|---|
| 47 | .RS 4
|
|---|
| 48 | .ie n \{\
|
|---|
| 49 | \h'-04' 1.\h'+01'\c
|
|---|
| 50 | .\}
|
|---|
| 51 | .el \{\
|
|---|
| 52 | .sp -1
|
|---|
| 53 | .IP " 1." 4.2
|
|---|
| 54 | .\}
|
|---|
| 55 | You don\*(Aqt need to populate your shares with symlinks to the snapshots\&. This can be very important when you have thousands of shares, or use [homes]\&.
|
|---|
| 56 | .RE
|
|---|
| 57 | .sp
|
|---|
| 58 | .RS 4
|
|---|
| 59 | .ie n \{\
|
|---|
| 60 | \h'-04' 2.\h'+01'\c
|
|---|
| 61 | .\}
|
|---|
| 62 | .el \{\
|
|---|
| 63 | .sp -1
|
|---|
| 64 | .IP " 2." 4.2
|
|---|
| 65 | .\}
|
|---|
| 66 | The inode number of the files is altered so it is different from the original\&. This allows the \*(Aqrestore\*(Aq button to work without a sharing violation\&.
|
|---|
| 67 | .RE
|
|---|
| 68 | .sp
|
|---|
| 69 | .RE
|
|---|
| 70 | .PP
|
|---|
| 71 | This module is stackable\&.
|
|---|
| 72 | .SH "CONFIGURATION"
|
|---|
| 73 | .PP
|
|---|
| 74 | vfs_shadow_copy2
|
|---|
| 75 | relies on a filesystem snapshot implementation\&. Many common filesystems have native support for this\&.
|
|---|
| 76 | .PP
|
|---|
| 77 | Filesystem snapshots must be mounted on specially named directories in order to be recognized by
|
|---|
| 78 | vfs_shadow_copy2\&. The snapshot mount points must be immediate children of a the directory being shared\&.
|
|---|
| 79 | .PP
|
|---|
| 80 | The snapshot naming convention is @GMT\-YYYY\&.MM\&.DD\-hh\&.mm\&.ss, where:
|
|---|
| 81 | .sp
|
|---|
| 82 | .RS 4
|
|---|
| 83 | .ie n \{\
|
|---|
| 84 | \h'-04'\(bu\h'+03'\c
|
|---|
| 85 | .\}
|
|---|
| 86 | .el \{\
|
|---|
| 87 | .sp -1
|
|---|
| 88 | .IP \(bu 2.3
|
|---|
| 89 | .\}
|
|---|
| 90 | YYYY
|
|---|
| 91 | is the 4 digit year
|
|---|
| 92 | .RE
|
|---|
| 93 | .sp
|
|---|
| 94 | .RS 4
|
|---|
| 95 | .ie n \{\
|
|---|
| 96 | \h'-04'\(bu\h'+03'\c
|
|---|
| 97 | .\}
|
|---|
| 98 | .el \{\
|
|---|
| 99 | .sp -1
|
|---|
| 100 | .IP \(bu 2.3
|
|---|
| 101 | .\}
|
|---|
| 102 | MM
|
|---|
| 103 | is the 2 digit month
|
|---|
| 104 | .RE
|
|---|
| 105 | .sp
|
|---|
| 106 | .RS 4
|
|---|
| 107 | .ie n \{\
|
|---|
| 108 | \h'-04'\(bu\h'+03'\c
|
|---|
| 109 | .\}
|
|---|
| 110 | .el \{\
|
|---|
| 111 | .sp -1
|
|---|
| 112 | .IP \(bu 2.3
|
|---|
| 113 | .\}
|
|---|
| 114 | DD
|
|---|
| 115 | is the 2 digit day
|
|---|
| 116 | .RE
|
|---|
| 117 | .sp
|
|---|
| 118 | .RS 4
|
|---|
| 119 | .ie n \{\
|
|---|
| 120 | \h'-04'\(bu\h'+03'\c
|
|---|
| 121 | .\}
|
|---|
| 122 | .el \{\
|
|---|
| 123 | .sp -1
|
|---|
| 124 | .IP \(bu 2.3
|
|---|
| 125 | .\}
|
|---|
| 126 | hh
|
|---|
| 127 | is the 2 digit hour
|
|---|
| 128 | .RE
|
|---|
| 129 | .sp
|
|---|
| 130 | .RS 4
|
|---|
| 131 | .ie n \{\
|
|---|
| 132 | \h'-04'\(bu\h'+03'\c
|
|---|
| 133 | .\}
|
|---|
| 134 | .el \{\
|
|---|
| 135 | .sp -1
|
|---|
| 136 | .IP \(bu 2.3
|
|---|
| 137 | .\}
|
|---|
| 138 | mm
|
|---|
| 139 | is the 2 digit minute
|
|---|
| 140 | .RE
|
|---|
| 141 | .sp
|
|---|
| 142 | .RS 4
|
|---|
| 143 | .ie n \{\
|
|---|
| 144 | \h'-04'\(bu\h'+03'\c
|
|---|
| 145 | .\}
|
|---|
| 146 | .el \{\
|
|---|
| 147 | .sp -1
|
|---|
| 148 | .IP \(bu 2.3
|
|---|
| 149 | .\}
|
|---|
| 150 | ss
|
|---|
| 151 | is the 2 digit second\&.
|
|---|
| 152 | .RE
|
|---|
| 153 | .sp
|
|---|
| 154 | .RE
|
|---|
| 155 | .PP
|
|---|
| 156 | The
|
|---|
| 157 | vfs_shadow_copy2
|
|---|
| 158 | snapshot naming convention can be produced with the following
|
|---|
| 159 | \fBdate\fR(1)
|
|---|
| 160 | command:
|
|---|
| 161 | .sp
|
|---|
| 162 | .if n \{\
|
|---|
| 163 | .RS 4
|
|---|
| 164 | .\}
|
|---|
| 165 | .nf
|
|---|
| 166 | TZ=GMT date +@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S
|
|---|
| 167 |
|
|---|
| 168 | .fi
|
|---|
| 169 | .if n \{\
|
|---|
| 170 | .RE
|
|---|
| 171 | .\}
|
|---|
| 172 | .SH "OPTIONS"
|
|---|
| 173 | .PP
|
|---|
| 174 | shadow:snapdir = SNAPDIR
|
|---|
| 175 | .RS 4
|
|---|
| 176 | Path to the directory where snapshots are kept\&.
|
|---|
| 177 | .RE
|
|---|
| 178 | .PP
|
|---|
| 179 | shadow:basedir = BASEDIR
|
|---|
| 180 | .RS 4
|
|---|
| 181 | Path to the base directory that snapshots are from\&.
|
|---|
| 182 | .RE
|
|---|
| 183 | .PP
|
|---|
| 184 | shadow:sort = asc/desc, or not specified for unsorted (default)
|
|---|
| 185 | .RS 4
|
|---|
| 186 | By this parameter one can specify that the shadow copy directories should be sorted before they are sent to the client\&. This can be beneficial as unix filesystems are usually not listed alphabetically sorted\&. If enabled, you typically want to specify descending order\&.
|
|---|
| 187 | .RE
|
|---|
| 188 | .PP
|
|---|
| 189 | shadow:localtime = yes/no
|
|---|
| 190 | .RS 4
|
|---|
| 191 | This is an optional parameter that indicates whether the snapshot names are in UTC/GMT or in local time\&. By default UTC is expected\&.
|
|---|
| 192 | .RE
|
|---|
| 193 | .PP
|
|---|
| 194 | shadow:format = format specification for snapshot names
|
|---|
| 195 | .RS 4
|
|---|
| 196 | This is an optional parameter that specifies the format specification for the naming of snapshots\&. The format must be compatible with the conversion specifications recognized by str[fp]time\&. The default value is "@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S"\&.
|
|---|
| 197 | .RE
|
|---|
| 198 | .PP
|
|---|
| 199 | shadow:fixinodes = yes/no
|
|---|
| 200 | .RS 4
|
|---|
| 201 | If you enable
|
|---|
| 202 | shadow:fixinodes
|
|---|
| 203 | then this module will modify the apparent inode number of files in the snapshot directories using a hash of the files path\&. This is needed for snapshot systems where the snapshots have the same device:inode number as the original files (such as happens with GPFS snapshots)\&. If you don\*(Aqt set this option then the \*(Aqrestore\*(Aq button in the shadow copy UI will fail with a sharing violation\&.
|
|---|
| 204 | .RE
|
|---|
| 205 | .SH "EXAMPLES"
|
|---|
| 206 | .PP
|
|---|
| 207 | Add shadow copy support to user home directories:
|
|---|
| 208 | .sp
|
|---|
| 209 | .if n \{\
|
|---|
| 210 | .RS 4
|
|---|
| 211 | .\}
|
|---|
| 212 | .nf
|
|---|
| 213 | \fI[homes]\fR
|
|---|
| 214 | \m[blue]\fBvfs objects = shadow_copy2\fR\m[]
|
|---|
| 215 | \m[blue]\fBshadow:snapdir = /data/snapshots\fR\m[]
|
|---|
| 216 | \m[blue]\fBshadow:basedir = /data/home\fR\m[]
|
|---|
| 217 | \m[blue]\fBshadow:sort = desc\fR\m[]
|
|---|
| 218 | .fi
|
|---|
| 219 | .if n \{\
|
|---|
| 220 | .RE
|
|---|
| 221 | .\}
|
|---|
| 222 | .SH "CAVEATS"
|
|---|
| 223 | .PP
|
|---|
| 224 | This is not a backup, archival, or version control solution\&.
|
|---|
| 225 | .PP
|
|---|
| 226 | With Samba or Windows servers,
|
|---|
| 227 | vfs_shadow_copy2
|
|---|
| 228 | 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\&.
|
|---|
| 229 | .SH "VERSION"
|
|---|
| 230 | .PP
|
|---|
| 231 | This man page is correct for version 3\&.2\&.7 of the Samba suite\&.
|
|---|
| 232 | .SH "AUTHOR"
|
|---|
| 233 | .PP
|
|---|
| 234 | 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\&.
|
|---|
