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
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.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="vfs_shadow_copy2"><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" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = shadow_copy2</code></p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id2528905"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the
2
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
3
that is similar to Microsoft Shadow Copy services. When setup properly,
4
4
this module allows Microsoft Shadow Copy clients to browse
5
5
"shadow copies" on Samba shares.
6
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
7
version has the following features:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>You don't need to populate your shares with symlinks to the
8
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
9
shares, or use [homes].</p></li><li class="listitem"><p>The inode number of the files is altered so it is different
10
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
11
without a sharing violation.</p></li></ol></div><p>This module is stackable.</p></div><div class="refsect1" title="CONFIGURATION"><a name="id2489330"></a><h2>CONFIGURATION</h2><p><code class="literal">vfs_shadow_copy2</code> relies on a filesystem
12
12
snapshot implementation. Many common filesystems have native
14
14
</p><p>Filesystem snapshots must be mounted on
16
16
<code class="literal">vfs_shadow_copy2</code>. The snapshot mount points must
17
17
be immediate children of a the directory being shared.</p><p>The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss,
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>
19
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="literal">YYYY</code> is the 4 digit year</p></li><li class="listitem"><p><code class="literal">MM</code> is the 2 digit month</p></li><li class="listitem"><p><code class="literal">DD</code> is the 2 digit day</p></li><li class="listitem"><p><code class="literal">hh</code> is the 2 digit hour</p></li><li class="listitem"><p><code class="literal">mm</code> is the 2 digit minute</p></li><li class="listitem"><p><code class="literal">ss</code> is the 2 digit second.</p></li></ul></div><p>
20
20
</p><p>The <code class="literal">vfs_shadow_copy2</code> snapshot naming convention can be
21
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
22
</p><pre class="programlisting">
23
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
24
</pre></div><div class="refsect1" title="OPTIONS"><a name="id2489564"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">shadow:snapdir = SNAPDIR
25
25
</span></dt><dd><p>Path to the directory where snapshots are kept.
26
26
</p></dd><dt><span class="term">shadow:basedir = BASEDIR
27
27
</span></dt><dd><p>Path to the base directory that snapshots are from.
34
34
files (such as happens with GPFS snapshots). If you don't set
35
35
this option then the 'restore' button in the shadow copy UI
36
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">
37
</p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id2489631"></a><h2>EXAMPLES</h2><p>Add shadow copy support to user home directories:</p><pre class="programlisting">
38
38
<em class="parameter"><code>[homes]</code></em>
39
39
<a class="link" href="smb.conf.5.html#VFSOBJECTS" target="_top">vfs objects = shadow_copy2</a>
40
40
<a class="link" href="smb.conf.5.html#SHADOW:SNAPDIR" target="_top">shadow:snapdir = /data/snaphots</a>
41
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.
42
</pre></div><div class="refsect1" title="CAVEATS"><a name="id2487457"></a><h2>CAVEATS</h2><p>This is not a backup, archival, or version control solution.
43
43
</p><p>With Samba or Windows servers,
44
44
<code class="literal">vfs_shadow_copy2</code> is designed to be an end-user
45
45
tool only. It does not replace or enhance your backup and
46
46
archival solutions and should in no way be considered as
47
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
48
version control system.</p></div><div class="refsect1" title="VERSION"><a name="id2487480"></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" title="AUTHOR"><a name="id2487491"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
50
50
were created by Andrew Tridgell. Samba is now developed
51
51
by the Samba Team as an Open Source project similar
52
52
to the way the Linux kernel is developed.</p></div></div></body></html>