docs-xml/manpages/vfs_shell_snap.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_shell_snap.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_shell_snap</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_shell_snap</refname>
  16         <refpurpose>
  17                 Shell script callouts for snapshot creation and deletion
  18         </refpurpose>
  19 </refnamediv>
  20
  21 <refsynopsisdiv>
  22         <cmdsynopsis>
  23                 <command>vfs objects = shell_snap</command>
  24         </cmdsynopsis>
  25 </refsynopsisdiv>
  26
  27 <refsect1>
  28         <title>DESCRIPTION</title>
  29
  30         <para>This VFS module is part of the
  31         <citerefentry><refentrytitle>samba</refentrytitle>
  32         <manvolnum>8</manvolnum></citerefentry> suite.</para>
  33
  34         <para>
  35                 The <command>vfs_shell_snap</command> VFS provides shell-script
  36                 callouts for snapshot creation and deletion operations issued
  37                 by remote clients using the File Server Remote VSS Protocol
  38                 (FSRVP).
  39         </para>
  40
  41         <para>
  42                 The following shell callouts may be configured in smb.conf:
  43         </para>
  44         <para>
  45                 <smbconfoption name="shell_snap:check path command"></smbconfoption>
  46                 <itemizedlist>
  47                         <listitem><para>
  48                                 Called when an FSRVP client wishes to check
  49                                 whether a given share supports snapshot
  50                                 create/delete requests.
  51                         </para></listitem>
  52                         <listitem><para>
  53                                 The command is called with a single
  54                                 <parameter>share_path</parameter> argument.
  55                         </para></listitem>
  56                         <listitem><para>
  57                                 The command must return 0 if
  58                                 <parameter>share_path</parameter> is capable of
  59                                 being snapshotted.
  60                         </para></listitem>
  61                 </itemizedlist>
  62         </para>
  63         <para>
  64                 <smbconfoption name="shell_snap:create command"></smbconfoption>
  65                 <itemizedlist>
  66                         <listitem><para>
  67                                 Called when an FSRVP client wishes to create
  68                                 a snapshot.
  69                         </para></listitem>
  70                         <listitem><para>
  71                                 The command is called with a single
  72                                 <parameter>share_path</parameter> argument.
  73                         </para></listitem>
  74                         <listitem><para>
  75                                 The command must return 0 status if the
  76                                 snapshot was successfully taken.
  77                         </para></listitem>
  78                         <listitem><para>
  79                                 The command must output the path of the newly
  80                                 created snapshot to stdout.
  81                         </para></listitem>
  82                 </itemizedlist>
  83         </para>
  84         <para>
  85                 <smbconfoption name="shell_snap:delete command"></smbconfoption>
  86                 <itemizedlist>
  87                         <listitem><para>
  88                                 Called when an FSRVP client wishes to delete
  89                                 a snapshot.
  90                         </para></listitem>
  91                         <listitem><para>
  92                                 The command is called with
  93                                 <parameter>base_share_path</parameter> and
  94                                 <parameter>snapshot_share_path</parameter>
  95                                 arguments.
  96                         </para></listitem>
  97                         <listitem><para>
  98                                 The command must return 0 status if the
  99                                 snapshot was successfully removed.
 100                         </para></listitem>
 101                 </itemizedlist>
 102                 All commands are executed as the authenticated FSRVP client
 103                 user.
 104         </para>
 105
 106         <para>
 107                 This module is stackable.
 108         </para>
 109 </refsect1>
 110
 111 <refsect1>
 112         <title>CONFIGURATION</title>
 113
 114         <programlisting>
 115                 <smbconfsection name="[share]"/>
 116                 <smbconfoption name="vfs objects">shell_snap</smbconfoption>
 117                 <smbconfoption name="shell_snap:check path command">
 118                         snap_check_path.sh</smbconfoption>
 119                 <smbconfoption name="shell_snap:create command">
 120                         snap_create.sh</smbconfoption>
 121                 <smbconfoption name="shell_snap:delete command">
 122                         snap_delete.sh</smbconfoption>
 123         </programlisting>
 124
 125         <para>
 126                 Samba's FSRVP server must be configured in the [global] section:
 127         </para>
 128
 129         <programlisting>
 130                 <smbconfsection name="[global]"/>
 131                 <smbconfoption name="rpc_daemon:fssd">fork</smbconfoption>
 132                 <smbconfoption name="registry shares">yes</smbconfoption>
 133                 <smbconfoption name="include">registry</smbconfoption>
 134         </programlisting>
 135 </refsect1>
 136
 137 <refsect1>
 138         <title>VERSION</title>
 139
 140         <para>
 141                 This man page is part of version &doc.version; of the Samba suite.
 142         </para>
 143 </refsect1>
 144
 145 <refsect1>
 146         <title>AUTHOR</title>
 147
 148         <para>The original Samba software and related utilities
 149         were created by Andrew Tridgell. Samba is now developed
 150         by the Samba Team as an Open Source project similar
 151         to the way the Linux kernel is developed.</para>
 152
 153 </refsect1>
 154
 155 </refentry>