summaryrefslogtreecommitdiff
path: root/docs-xml/manpages-3/vfs_shadow_copy.8.xml
blob: 49f79542d3fc29693a2a09ca510981636cfe6b2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="vfs_shadow_copy.8">

<refmeta>
	<refentrytitle>vfs_shadow_copy</refentrytitle>
	<manvolnum>8</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">System Administration tools</refmiscinfo>
	<refmiscinfo class="version">3.2</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>vfs_shadow_copy</refname>
	<refpurpose>Make a Samba share read only for a specified time period</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>vfs objects = shadow_copy</command>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This VFS module is part of the
	<citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para>The <command>vfs_shadow_copy</command> 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.
	</para>

	<para>This module is stackable.</para>

</refsect1>

<refsect1>
	<title>CONFIGURATION</title>

	<para><command>vfs_shadow_copy</command> relies on a filesystem
	snapshot implementation. Many common filesystems have native
	support for this.
	</para>

	<para>Filesystem snapshots must be mounted on
	specially named directories in order to be recognized by
	<command>vfs_shadow_copy</command>. The snapshot mount points must
	be immediate children of a the directory being shared.</para>

	<para>The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss,
	where:
       	<itemizedlist>
       		<listitem><para><command>YYYY</command> is the 4 digit year</para></listitem>
       		<listitem><para><command>MM</command> is the 2 digit month</para></listitem>
       		<listitem><para><command>DD</command> is the 2 digit day</para></listitem>
       		<listitem><para><command>hh</command> is the 2 digit hour</para></listitem>
       		<listitem><para><command>mm</command> is the 2 digit minute</para></listitem>
       		<listitem><para><command>ss</command> is the 2 digit second.</para></listitem>
       	</itemizedlist>
	</para>

       	<para>The <command>vfs_shadow_copy</command> snapshot naming convention can be produced with the following
	<citerefentry><refentrytitle>date</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry> command:
	<programlisting>
	TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S
	</programlisting></para>

</refsect1>

<refsect1>
	<title>EXAMPLES</title>

	<para>Add shadow copy support to user home directories:</para>
<programlisting>
        <smbconfsection name="[homes]"/>
	<smbconfoption name="vfs objects">shadow_copy</smbconfoption>
</programlisting>

</refsect1>

<refsect1>
	<title>CAVEATS</title>

	<para>This is not a backup, archival, or version control solution.
	</para>

	<para>With Samba or Windows servers,
	<command>vfs_shadow_copy</command> 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.</para>

</refsect1>



<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3.0.25 of the Samba suite.
	</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>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.</para>

</refsect1>

</refentry>