docs/manpages/vfs_shadow_copy2.8

   1 .\"     Title: vfs_shadow_copy2
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 09/30/2009
   5 .\"    Manual: System Administration tools
   6 .\"    Source: Samba 3.4
   7 .\"  Language: English
   8 .\"
   9 .TH "VFS_SHADOW_COPY2" "8" "09/30/2009" "Samba 3\&.4" "System Administration tools"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 vfs_shadow_copy2 \- Expose snapshots to Windows clients as shadow copies\&.
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\ 'u
 174 \FCvfs objects = shadow_copy2\F[]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 This VFS module is part of the
 179 \fBsamba\fR(7)
 180 suite\&.
 181 .PP
 182 The
 183 \FCvfs_shadow_copy2\F[]
 184 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\&.
 185 .PP
 186 This is a 2nd implementation of a shadow copy module\&. This version has the following features:
 187 .sp
 188 .RS 4
 189 .ie n \{\
 190 \h'-04' 1.\h'+01'\c
 191 .\}
 192 .el \{\
 193 .sp -1
 194 .IP "  1." 4.2
 195 .\}
 196 You don\'t need to populate your shares with symlinks to the snapshots\&. This can be very important when you have thousands of shares, or use [homes]\&.
 197 .RE
 198 .sp
 199 .RS 4
 200 .ie n \{\
 201 \h'-04' 2.\h'+01'\c
 202 .\}
 203 .el \{\
 204 .sp -1
 205 .IP "  2." 4.2
 206 .\}
 207 The inode number of the files is altered so it is different from the original\&. This allows the \'restore\' button to work without a sharing violation\&.
 208 .RE
 209 .sp
 210 .RE
 211 .PP
 212 This module is stackable\&.
 213 .SH "CONFIGURATION"
 214 .PP
 215 \FCvfs_shadow_copy2\F[]
 216 relies on a filesystem snapshot implementation\&. Many common filesystems have native support for this\&.
 217 .PP
 218 Filesystem snapshots must be mounted on specially named directories in order to be recognized by
 219 \FCvfs_shadow_copy2\F[]\&. The snapshot mount points must be immediate children of a the directory being shared\&.
 220 .PP
 221 The snapshot naming convention is @GMT\-YYYY\&.MM\&.DD\-hh\&.mm\&.ss, where:
 222 .sp
 223 .RS 4
 224 .ie n \{\
 225 \h'-04'\(bu\h'+03'\c
 226 .\}
 227 .el \{\
 228 .sp -1
 229 .IP \(bu 2.3
 230 .\}
 231 \FCYYYY\F[]
 232 is the 4 digit year
 233 .RE
 234 .sp
 235 .RS 4
 236 .ie n \{\
 237 \h'-04'\(bu\h'+03'\c
 238 .\}
 239 .el \{\
 240 .sp -1
 241 .IP \(bu 2.3
 242 .\}
 243 \FCMM\F[]
 244 is the 2 digit month
 245 .RE
 246 .sp
 247 .RS 4
 248 .ie n \{\
 249 \h'-04'\(bu\h'+03'\c
 250 .\}
 251 .el \{\
 252 .sp -1
 253 .IP \(bu 2.3
 254 .\}
 255 \FCDD\F[]
 256 is the 2 digit day
 257 .RE
 258 .sp
 259 .RS 4
 260 .ie n \{\
 261 \h'-04'\(bu\h'+03'\c
 262 .\}
 263 .el \{\
 264 .sp -1
 265 .IP \(bu 2.3
 266 .\}
 267 \FChh\F[]
 268 is the 2 digit hour
 269 .RE
 270 .sp
 271 .RS 4
 272 .ie n \{\
 273 \h'-04'\(bu\h'+03'\c
 274 .\}
 275 .el \{\
 276 .sp -1
 277 .IP \(bu 2.3
 278 .\}
 279 \FCmm\F[]
 280 is the 2 digit minute
 281 .RE
 282 .sp
 283 .RS 4
 284 .ie n \{\
 285 \h'-04'\(bu\h'+03'\c
 286 .\}
 287 .el \{\
 288 .sp -1
 289 .IP \(bu 2.3
 290 .\}
 291 \FCss\F[]
 292 is the 2 digit second\&.
 293 .sp
 294 .RE
 295 .PP
 296 The
 297 \FCvfs_shadow_copy2\F[]
 298 snapshot naming convention can be produced with the following
 299 \fBdate\fR(1)
 300 command:
 301 .sp
 302 .if n \{\
 303 .RS 4
 304 .\}
 305 .fam C
 306 .ps -1
 307 .nf
 308 .if t \{\
 309 .sp -1
 310 .\}
 311 .BB lightgray adjust-for-leading-newline
 312 .sp -1
 313
 314         TZ=GMT date +@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S
 315
 316 .EB lightgray adjust-for-leading-newline
 317 .if t \{\
 318 .sp 1
 319 .\}
 320 .fi
 321 .fam
 322 .ps +1
 323 .if n \{\
 324 .RE
 325 .\}
 326 .SH "OPTIONS"
 327 .PP
 328 shadow:snapdir = SNAPDIR
 329 .RS 4
 330 Path to the directory where snapshots are kept\&.
 331 .RE
 332 .PP
 333 shadow:basedir = BASEDIR
 334 .RS 4
 335 Path to the base directory that snapshots are from\&.
 336 .RE
 337 .PP
 338 shadow:fixinodes = yes/no
 339 .RS 4
 340 If you enable
 341 \FCshadow:fixinodes \F[]
 342 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\'t set this option then the \'restore\' button in the shadow copy UI will fail with a sharing violation\&.
 343 .RE
 344 .SH "EXAMPLES"
 345 .PP
 346 Add shadow copy support to user home directories:
 347 .sp
 348 .if n \{\
 349 .RS 4
 350 .\}
 351 .fam C
 352 .ps -1
 353 .nf
 354 .if t \{\
 355 .sp -1
 356 .\}
 357 .BB lightgray adjust-for-leading-newline
 358 .sp -1
 359
 360         \fI[homes]\fR
 361         \m[blue]\fBvfs objects = shadow_copy2\fR\m[]
 362         \m[blue]\fBshadow:snapdir = /data/snaphots\fR\m[]
 363         \m[blue]\fBshadow:basedir = /data/home\fR\m[]
 364 .EB lightgray adjust-for-leading-newline
 365 .if t \{\
 366 .sp 1
 367 .\}
 368 .fi
 369 .fam
 370 .ps +1
 371 .if n \{\
 372 .RE
 373 .\}
 374 .SH "CAVEATS"
 375 .PP
 376 This is not a backup, archival, or version control solution\&.
 377 .PP
 378 With Samba or Windows servers,
 379 \FCvfs_shadow_copy2\F[]
 380 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\&.
 381 .SH "VERSION"
 382 .PP
 383 This man page is correct for version 3\&.2\&.7 of the Samba suite\&.
 384 .SH "AUTHOR"
 385 .PP
 386 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\&.