VFS_SHELL_SNAP

Section: System Administration tools (8)
Updated: 04/07/2021
Page Index

NAME

vfs_shell_snap - Shell script callouts for snapshot creation and deletion

SYNOPSIS

: vfs objects = shell_snap

DESCRIPTION

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:

m[blue]shell_snap:check path commandm[]

: • 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.

m[blue]shell_snap:create commandm[]

: • 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.

m[blue]shell_snap:delete commandm[]

: • 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]
                m[blue]vfs objects = shell_snapm[]
                m[blue]shell_snap:check path command = snap_check_path.shm[]
                m[blue]shell_snap:create command = snap_create.shm[]
                m[blue]shell_snap:delete command = snap_delete.shm[]

Samba's FSRVP server must be configured in the [global] section:

                [global]
                m[blue]rpc_daemon:fssd = forkm[]
                m[blue]registry shares = yesm[]
                m[blue]include = registrym[]

VERSION

This man page is part of version 4.14.2 of the Samba suite.

AUTHOR

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.