vfs_shell_snap8
Shell script callouts for snapshot creation and deletion
Usage
vfs objects
=
shell_snap
Overview
This VFS module is part of the samba(8) suite.
The vfs_shell_snap VFS provides shell-script callouts for snapshot creation and deletion operations issued by remote clients using the File Server Remote VSS Protocol (FSRVP).
The following shell callouts may be configured in smb.conf:
shell_snap:check path command
• Called when an FSRVP client wishes to check whether a given share supports snapshot create/delete requests.
• The command is called with a single share_path argument.
• The command must return 0 if share_path is capable of being snapshotted.
shell_snap:create command
• Called when an FSRVP client wishes to create a snapshot.
• The command is called with a single share_path argument.
• The command must return 0 status if the snapshot was successfully taken.
• The command must output the path of the newly created snapshot to stdout.
shell_snap:delete command
• Called when an FSRVP client wishes to delete a snapshot.
• The command is called with base_share_path and snapshot_share_path arguments.
• The command must return 0 status if the snapshot was successfully removed.
All commands are executed as the authenticated FSRVP client user.
This module is stackable.
Configuration
[share] vfs objects = shell_snap shell_snap:check path command = snap_check_path.sh shell_snap:create command = snap_create.sh shell_snap:delete command = snap_delete.sh
Samba's FSRVP server must be configured in the [global] section:
[global] registry shares = yes include = registry
Version
This man page is part of version 4.25.1 of the Samba suite.
Releases
6 releases since Debian 9 (Stretch); the text changed 5 times.