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="id266341"></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="id266340"></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
8
8
snapshots. This can be very important when you have thousands of
9
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" title="CONFIGURATION"><a name="id266854"></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="id266853"></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
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" title="OPTIONS"><a name="id265759"></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="id265758"></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.
28
</p></dd><dt><span class="term">shadow:sort = asc/desc, or not specified for unsorted (default)
29
</span></dt><dd><p>By this parameter one can specify that the shadow
30
copy directories should be sorted before they are sent to the
31
client. This can be beneficial as unix filesystems are usually
32
not listed alphabetically sorted. If enabled, you typically
33
want to specify descending order.
34
</p></dd><dt><span class="term">shadow:localtime = yes/no
35
</span></dt><dd><p>This is an optional parameter that indicates whether the
36
snapshot names are in UTC/GMT or in local time. By default
38
</p></dd><dt><span class="term">shadow:format = format specification for snapshot names
39
</span></dt><dd><p>This is an optional parameter that specifies the format
40
specification for the naming of snapshots. The format must
41
be compatible with the conversion specifications recognized
42
by str[fp]time. The default value is "@GMT-%Y.%m.%d-%H.%M.%S".
28
43
</p></dd><dt><span class="term">shadow:fixinodes = yes/no
29
44
</span></dt><dd><p>If you enable <code class="literal">shadow:fixinodes
30
45
</code> then this module will modify the apparent inode
34
49
files (such as happens with GPFS snapshots). If you don't set
35
50
this option then the 'restore' button in the shadow copy UI
36
51
will fail with a sharing violation.
37
</p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id265819"></a><h2>EXAMPLES</h2><p>Add shadow copy support to user home directories:</p><pre class="programlisting">
52
</p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id265863"></a><h2>EXAMPLES</h2><p>Add shadow copy support to user home directories:</p><pre class="programlisting">
38
53
<em class="parameter"><code>[homes]</code></em>
39
54
<a class="link" href="smb.conf.5.html#VFSOBJECTS" target="_top">vfs objects = shadow_copy2</a>
40
55
<a class="link" href="smb.conf.5.html#SHADOW:SNAPDIR" target="_top">shadow:snapdir = /data/snaphots</a>
41
56
<a class="link" href="smb.conf.5.html#SHADOW:BASEDIR" target="_top">shadow:basedir = /data/home</a>
42
</pre></div><div class="refsect1" title="CAVEATS"><a name="id265974"></a><h2>CAVEATS</h2><p>This is not a backup, archival, or version control solution.
57
<a class="link" href="smb.conf.5.html#SHADOW:SORT" target="_top">shadow:sort = desc</a>
58
</pre></div><div class="refsect1" title="CAVEATS"><a name="id265927"></a><h2>CAVEATS</h2><p>This is not a backup, archival, or version control solution.
43
59
</p><p>With Samba or Windows servers,
44
60
<code class="literal">vfs_shadow_copy2</code> is designed to be an end-user
45
61
tool only. It does not replace or enhance your backup and
46
62
archival solutions and should in no way be considered as
47
63
such. Additionally, if you need version control, implement a
48
version control system.</p></div><div class="refsect1" title="VERSION"><a name="id307051"></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="id307060"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
64
version control system.</p></div><div class="refsect1" title="VERSION"><a name="id265949"></a><h2>VERSION</h2><p>This man page is correct for version 3.2.7 of the Samba suite.
65
</p></div><div class="refsect1" title="AUTHOR"><a name="id265959"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
50
66
were created by Andrew Tridgell. Samba is now developed
51
67
by the Samba Team as an Open Source project similar
52
68
to the way the Linux kernel is developed.</p></div></div></body></html>