blob: 319d825cfafec287b5702678980a63cfd9cd5c64 (
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
<?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_shell_snap.8">
<refmeta>
<refentrytitle>vfs_shell_snap</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
<refmiscinfo class="version">&doc.version;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vfs_shell_snap</refname>
<refpurpose>
Shell script callouts for snapshot creation and deletion
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>vfs objects = shell_snap</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> suite.</para>
<para>
The <command>vfs_shell_snap</command> VFS provides shell-script
callouts for snapshot creation and deletion operations issued
by remote clients using the File Server Remote VSS Protocol
(FSRVP).
</para>
<para>
The following shell callouts may be configured in smb.conf:
</para>
<para>
<smbconfoption name="shell_snap:check path command"></smbconfoption>
<itemizedlist>
<listitem><para>
Called when an FSRVP client wishes to check
whether a given share supports snapshot
create/delete requests.
</para></listitem>
<listitem><para>
The command is called with a single
<parameter>share_path</parameter> argument.
</para></listitem>
<listitem><para>
The command must return 0 if
<parameter>share_path</parameter> is capable of
being snapshotted.
</para></listitem>
</itemizedlist>
</para>
<para>
<smbconfoption name="shell_snap:create command"></smbconfoption>
<itemizedlist>
<listitem><para>
Called when an FSRVP client wishes to create
a snapshot.
</para></listitem>
<listitem><para>
The command is called with a single
<parameter>share_path</parameter> argument.
</para></listitem>
<listitem><para>
The command must return 0 status if the
snapshot was successfully taken.
</para></listitem>
<listitem><para>
The command must output the path of the newly
created snapshot to stdout.
</para></listitem>
</itemizedlist>
</para>
<para>
<smbconfoption name="shell_snap:delete command"></smbconfoption>
<itemizedlist>
<listitem><para>
Called when an FSRVP client wishes to delete
a snapshot.
</para></listitem>
<listitem><para>
The command is called with
<parameter>base_share_path</parameter> and
<parameter>snapshot_share_path</parameter>
arguments.
</para></listitem>
<listitem><para>
The command must return 0 status if the
snapshot was successfully removed.
</para></listitem>
</itemizedlist>
All commands are executed as the authenticated FSRVP client
user.
</para>
<para>
This module is stackable.
</para>
</refsect1>
<refsect1>
<title>CONFIGURATION</title>
<programlisting>
<smbconfsection name="[share]"/>
<smbconfoption name="vfs objects">shell_snap</smbconfoption>
<smbconfoption name="shell_snap:check path command">
snap_check_path.sh</smbconfoption>
<smbconfoption name="shell_snap:create command">
snap_create.sh</smbconfoption>
<smbconfoption name="shell_snap:delete command">
snap_delete.sh</smbconfoption>
</programlisting>
<para>
Samba's FSRVP server must be configured in the [global] section:
</para>
<programlisting>
<smbconfsection name="[global]"/>
<smbconfoption name="registry shares">yes</smbconfoption>
<smbconfoption name="include">registry</smbconfoption>
</programlisting>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>
This man page is part of version &doc.version; 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>
|
