1VFS_SHELL_SNAP(8) System Administration tools VFS_SHELL_SNAP(8)
2
3
4
6 vfs_shell_snap - Shell script callouts for snapshot creation and
7 deletion
8
10 vfs objects = shell_snap
11
13 This VFS module is part of the samba(8) suite.
14
15 The vfs_shell_snap VFS provides shell-script callouts for snapshot
16 creation and deletion operations issued by remote clients using the
17 File Server Remote VSS Protocol (FSRVP).
18
19 The following shell callouts may be configured in smb.conf:
20
21 shell_snap:check path command
22
23 • Called when an FSRVP client wishes to check whether a given
24 share supports snapshot create/delete requests.
25
26 • The command is called with a single share_path argument.
27
28 • The command must return 0 if share_path is capable of being
29 snapshotted.
30
31
32 shell_snap:create command
33
34 • Called when an FSRVP client wishes to create a snapshot.
35
36 • The command is called with a single share_path argument.
37
38 • The command must return 0 status if the snapshot was
39 successfully taken.
40
41 • The command must output the path of the newly created
42 snapshot to stdout.
43
44
45 shell_snap:delete command
46
47 • Called when an FSRVP client wishes to delete a snapshot.
48
49 • The command is called with base_share_path and
50 snapshot_share_path arguments.
51
52 • The command must return 0 status if the snapshot was
53 successfully removed.
54
55 All commands are executed as the authenticated FSRVP client user.
56
57 This module is stackable.
58
60 [share]
61 vfs objects = shell_snap
62 shell_snap:check path command = snap_check_path.sh
63 shell_snap:create command = snap_create.sh
64 shell_snap:delete command = snap_delete.sh
65
66
67 Samba's FSRVP server must be configured in the [global] section:
68
69 [global]
70 rpc_daemon:fssd = fork
71 registry shares = yes
72 include = registry
73
74
76 This man page is part of version 4.15.2 of the Samba suite.
77
79 The original Samba software and related utilities were created by
80 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
81 Source project similar to the way the Linux kernel is developed.
82
83
84
85Samba 4.15.2 11/13/2021 VFS_SHELL_SNAP(8)