Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
VFS_SHELL_SNAP(8)	   System Administration tools	       VFS_SHELL_SNAP(8)

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 Re-
     mote 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	success-
		fully 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   snap-
		shot_share_path arguments.

	    *	The  command  must  return 0 status if the snapshot was success-
		fully 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.23.8 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.

Samba 4.23.8			   08/01/2026		       VFS_SHELL_SNAP(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=vfs_shell_snap&sektion=8&manpath=FreeBSD+Ports+15.1.quarterly>

home | help