Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_shell_snap.8

raw
1 '\" t
2 .\" Title: vfs_shell_snap
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "VFS_SHELL_SNAP" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 vfs_shell_snap \- Shell script callouts for snapshot creation and deletion
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = shell_snap
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(8)
39 suite\&.
40 .PP
41 The
42 vfs_shell_snap
43 VFS provides shell\-script callouts for snapshot creation and deletion operations issued by remote clients using the File Server Remote VSS Protocol (FSRVP)\&.
44 .PP
45 The following shell callouts may be configured in smb\&.conf:
46 .PP
47 \m[blue]\fBshell_snap:check path command\fR\m[]
48 .RS
49 .sp
50 .RS 4
51 .ie n \{\
52 \h'-04'\(bu\h'+03'\c
53 .\}
54 .el \{\
55 .sp -1
56 .IP \(bu 2.3
57 .\}
58 Called when an FSRVP client wishes to check whether a given share supports snapshot create/delete requests\&.
59 .RE
60 .sp
61 .RS 4
62 .ie n \{\
63 \h'-04'\(bu\h'+03'\c
64 .\}
65 .el \{\
66 .sp -1
67 .IP \(bu 2.3
68 .\}
69 The command is called with a single
70 \fIshare_path\fR
71 argument\&.
72 .RE
73 .sp
74 .RS 4
75 .ie n \{\
76 \h'-04'\(bu\h'+03'\c
77 .\}
78 .el \{\
79 .sp -1
80 .IP \(bu 2.3
81 .\}
82 The command must return 0 if
83 \fIshare_path\fR
84 is capable of being snapshotted\&.
85 .RE
86 .sp
87 .RE
88 .PP
89 \m[blue]\fBshell_snap:create command\fR\m[]
90 .RS
91 .sp
92 .RS 4
93 .ie n \{\
94 \h'-04'\(bu\h'+03'\c
95 .\}
96 .el \{\
97 .sp -1
98 .IP \(bu 2.3
99 .\}
100 Called when an FSRVP client wishes to create a snapshot\&.
101 .RE
102 .sp
103 .RS 4
104 .ie n \{\
105 \h'-04'\(bu\h'+03'\c
106 .\}
107 .el \{\
108 .sp -1
109 .IP \(bu 2.3
110 .\}
111 The command is called with a single
112 \fIshare_path\fR
113 argument\&.
114 .RE
115 .sp
116 .RS 4
117 .ie n \{\
118 \h'-04'\(bu\h'+03'\c
119 .\}
120 .el \{\
121 .sp -1
122 .IP \(bu 2.3
123 .\}
124 The command must return 0 status if the snapshot was successfully taken\&.
125 .RE
126 .sp
127 .RS 4
128 .ie n \{\
129 \h'-04'\(bu\h'+03'\c
130 .\}
131 .el \{\
132 .sp -1
133 .IP \(bu 2.3
134 .\}
135 The command must output the path of the newly created snapshot to stdout\&.
136 .RE
137 .sp
138 .RE
139 .PP
140 \m[blue]\fBshell_snap:delete command\fR\m[]
141 .RS
142 .sp
143 .RS 4
144 .ie n \{\
145 \h'-04'\(bu\h'+03'\c
146 .\}
147 .el \{\
148 .sp -1
149 .IP \(bu 2.3
150 .\}
151 Called when an FSRVP client wishes to delete a snapshot\&.
152 .RE
153 .sp
154 .RS 4
155 .ie n \{\
156 \h'-04'\(bu\h'+03'\c
157 .\}
158 .el \{\
159 .sp -1
160 .IP \(bu 2.3
161 .\}
162 The command is called with
163 \fIbase_share_path\fR
164 and
165 \fIsnapshot_share_path\fR
166 arguments\&.
167 .RE
168 .sp
169 .RS 4
170 .ie n \{\
171 \h'-04'\(bu\h'+03'\c
172 .\}
173 .el \{\
174 .sp -1
175 .IP \(bu 2.3
176 .\}
177 The command must return 0 status if the snapshot was successfully removed\&.
178 .RE
179 .sp
180 .RE
181 All commands are executed as the authenticated FSRVP client user\&.
182 .PP
183 This module is stackable\&.
184 .SH "CONFIGURATION"
185 .sp
186 .if n \{\
187 .RS 4
188 .\}
189 .nf
190 \fI[share]\fR
191 \m[blue]\fBvfs objects = shell_snap\fR\m[]
192 \m[blue]\fBshell_snap:check path command = snap_check_path\&.sh\fR\m[]
193 \m[blue]\fBshell_snap:create command = snap_create\&.sh\fR\m[]
194 \m[blue]\fBshell_snap:delete command = snap_delete\&.sh\fR\m[]
195 .fi
196 .if n \{\
197 .RE
198 .\}
199 .PP
200 Samba\*(Aqs FSRVP server must be configured in the [global] section:
201 .sp
202 .if n \{\
203 .RS 4
204 .\}
205 .nf
206 \fI[global]\fR
207 \m[blue]\fBregistry shares = yes\fR\m[]
208 \m[blue]\fBinclude = registry\fR\m[]
209 .fi
210 .if n \{\
211 .RE
212 .\}
213 .SH "VERSION"
214 .PP
215 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
216 .SH "AUTHOR"
217 .PP
218 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\&.