docs-xml/manpages/vfs_shadow_copy.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="vfs_shadow_copy.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_shadow_copy</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">4.2</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_shadow_copy</refname>
  16         <refpurpose>Make a Samba share read only for a specified time period</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>vfs objects = shadow_copy</command>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This VFS module is part of the
  29         <citerefentry><refentrytitle>samba</refentrytitle>
  30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  31
  32         <para>The <command>vfs_shadow_copy</command> VFS module functionality
  33         that is similar to Microsoft Shadow Copy services. When setup properly,
  34         this module allows Microsoft Shadow Copy clients to browse
  35         "shadow copies" on Samba shares.
  36         </para>
  37
  38         <para>This module is stackable.</para>
  39
  40 </refsect1>
  41
  42 <refsect1>
  43         <title>CONFIGURATION</title>
  44
  45         <para><command>vfs_shadow_copy</command> relies on a filesystem
  46         snapshot implementation. Many common filesystems have native
  47         support for this.
  48         </para>
  49
  50         <para>Filesystem snapshots must be mounted on
  51         specially named directories in order to be recognized by
  52         <command>vfs_shadow_copy</command>. The snapshot mount points must
  53         be immediate children of a the directory being shared.</para>
  54
  55         <para>The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss,
  56         where:
  57         <itemizedlist>
  58                 <listitem><para><command>YYYY</command> is the 4 digit year</para></listitem>
  59                 <listitem><para><command>MM</command> is the 2 digit month</para></listitem>
  60                 <listitem><para><command>DD</command> is the 2 digit day</para></listitem>
  61                 <listitem><para><command>hh</command> is the 2 digit hour</para></listitem>
  62                 <listitem><para><command>mm</command> is the 2 digit minute</para></listitem>
  63                 <listitem><para><command>ss</command> is the 2 digit second.</para></listitem>
  64         </itemizedlist>
  65         </para>
  66
  67         <para>The <command>vfs_shadow_copy</command> snapshot naming convention can be produced with the following
  68         <citerefentry><refentrytitle>date</refentrytitle>
  69         <manvolnum>1</manvolnum></citerefentry> command:
  70         <programlisting>
  71         TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S
  72         </programlisting></para>
  73
  74 </refsect1>
  75
  76 <refsect1>
  77         <title>EXAMPLES</title>
  78
  79         <para>Add shadow copy support to user home directories:</para>
  80 <programlisting>
  81         <smbconfsection name="[homes]"/>
  82         <smbconfoption name="vfs objects">shadow_copy</smbconfoption>
  83 </programlisting>
  84
  85 </refsect1>
  86
  87 <refsect1>
  88         <title>CAVEATS</title>
  89
  90         <para>This is not a backup, archival, or version control solution.
  91         </para>
  92
  93         <para>With Samba or Windows servers,
  94         <command>vfs_shadow_copy</command> is designed to be an end-user
  95         tool only. It does not replace or enhance your backup and
  96         archival solutions and should in no way be considered as
  97         such. Additionally, if you need version control, implement a
  98         version control system.</para>
  99
 100 </refsect1>
 101
 102
 103
 104 <refsect1>
 105         <title>VERSION</title>
 106
 107         <para>This man page is correct for version 3.0.25 of the Samba suite.
 108         </para>
 109 </refsect1>
 110
 111 <refsect1>
 112         <title>AUTHOR</title>
 113
 114         <para>The original Samba software and related utilities
 115         were created by Andrew Tridgell. Samba is now developed
 116         by the Samba Team as an Open Source project similar
 117         to the way the Linux kernel is developed.</para>
 118
 119 </refsect1>
 120
 121 </refentry>