| 1 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_shadow_copy2</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_shadow_copy2.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_shadow_copy2 — Expose snapshots to Windows clients as shadow copies.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = shadow_copy2</code></p></div></div><div class="refsect1" lang="en"><a name="id2522930"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the
|
|---|
| 2 | <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_shadow_copy2</code> VFS module functionality
|
|---|
| 3 | that is similar to Microsoft Shadow Copy services. When setup properly,
|
|---|
| 4 | this module allows Microsoft Shadow Copy clients to browse
|
|---|
| 5 | "shadow copies" on Samba shares.
|
|---|
| 6 | </p><p>This is a 2nd implementation of a shadow copy module. This
|
|---|
| 7 | version has the following features:</p><div class="orderedlist"><ol type="1"><li><p>You don't need to populate your shares with symlinks to the
|
|---|
| 8 | snapshots. This can be very important when you have thousands of
|
|---|
| 9 | shares, or use [homes].</p></li><li><p>The inode number of the files is altered so it is different
|
|---|
| 10 | from the original. This allows the 'restore' button to work
|
|---|
| 11 | without a sharing violation.</p></li></ol></div><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id2483366"></a><h2>CONFIGURATION</h2><p><code class="literal">vfs_shadow_copy2</code> relies on a filesystem
|
|---|
| 12 | snapshot implementation. Many common filesystems have native
|
|---|
| 13 | support for this.
|
|---|
| 14 | </p><p>Filesystem snapshots must be mounted on
|
|---|
| 15 | specially named directories in order to be recognized by
|
|---|
| 16 | <code class="literal">vfs_shadow_copy2</code>. The snapshot mount points must
|
|---|
| 17 | be immediate children of a the directory being shared.</p><p>The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss,
|
|---|
| 18 | where:
|
|---|
| 19 | </p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">YYYY</code> is the 4 digit year</p></li><li><p><code class="literal">MM</code> is the 2 digit month</p></li><li><p><code class="literal">DD</code> is the 2 digit day</p></li><li><p><code class="literal">hh</code> is the 2 digit hour</p></li><li><p><code class="literal">mm</code> is the 2 digit minute</p></li><li><p><code class="literal">ss</code> is the 2 digit second.</p></li></ul></div><p>
|
|---|
| 20 | </p><p>The <code class="literal">vfs_shadow_copy2</code> snapshot naming convention can be
|
|---|
| 21 | produced with the following <a class="citerefentry" href="date.1.html"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> command:
|
|---|
| 22 | </p><pre class="programlisting">
|
|---|
| 23 | TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S
|
|---|
| 24 | </pre></div><div class="refsect1" lang="en"><a name="id2483590"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">shadow:snapdir = SNAPDIR
|
|---|
| 25 | </span></dt><dd><p>Path to the directory where snapshots are kept.
|
|---|
| 26 | </p></dd><dt><span class="term">shadow:basedir = BASEDIR
|
|---|
| 27 | </span></dt><dd><p>Path to the base directory that snapshots are from.
|
|---|
| 28 | </p></dd><dt><span class="term">shadow:fixinodes = yes/no
|
|---|
| 29 | </span></dt><dd><p>If you enable <code class="literal">shadow:fixinodes
|
|---|
| 30 | </code> then this module will modify the apparent inode
|
|---|
| 31 | number of files in the snapshot directories using a hash of the
|
|---|
| 32 | files path. This is needed for snapshot systems where the
|
|---|
| 33 | snapshots have the same device:inode number as the original
|
|---|
| 34 | files (such as happens with GPFS snapshots). If you don't set
|
|---|
| 35 | this option then the 'restore' button in the shadow copy UI
|
|---|
| 36 | will fail with a sharing violation.
|
|---|
| 37 | </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2483657"></a><h2>EXAMPLES</h2><p>Add shadow copy support to user home directories:</p><pre class="programlisting">
|
|---|
| 38 | <em class="parameter"><code>[homes]</code></em>
|
|---|
| 39 | <a class="link" href="smb.conf.5.html#VFSOBJECTS" target="_top">vfs objects = shadow_copy2</a>
|
|---|
| 40 | <a class="link" href="smb.conf.5.html#SHADOW:SNAPDIR" target="_top">shadow:snapdir = /data/snaphots</a>
|
|---|
| 41 | <a class="link" href="smb.conf.5.html#SHADOW:BASEDIR" target="_top">shadow:basedir = /data/home</a>
|
|---|
| 42 | </pre></div><div class="refsect1" lang="en"><a name="id2481488"></a><h2>CAVEATS</h2><p>This is not a backup, archival, or version control solution.
|
|---|
| 43 | </p><p>With Samba or Windows servers,
|
|---|
| 44 | <code class="literal">vfs_shadow_copy2</code> is designed to be an end-user
|
|---|
| 45 | tool only. It does not replace or enhance your backup and
|
|---|
| 46 | archival solutions and should in no way be considered as
|
|---|
| 47 | such. Additionally, if you need version control, implement a
|
|---|
| 48 | version control system.</p></div><div class="refsect1" lang="en"><a name="id2481511"></a><h2>VERSION</h2><p>This man page is correct for version 3.2.7 of the Samba suite.
|
|---|
| 49 | </p></div><div class="refsect1" lang="en"><a name="id2481522"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
|
|---|
| 50 | were created by Andrew Tridgell. Samba is now developed
|
|---|
| 51 | by the Samba Team as an Open Source project similar
|
|---|
| 52 | to the way the Linux kernel is developed.</p></div></div></body></html>
|
|---|
