Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

vfs_shell_snap (8)

Name

vfs_shell_snap - Shell script callouts for snapshot creation and deletion

Synopsis

vfs objects = shell_snap

Description

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 Remote VSS Protocol (FSRVP).

       The following shell callouts may be configured in smb.conf:

       shell_snap:check path command

              o   Called when an FSRVP client wishes to check whether a given
                  share supports snapshot create/delete requests.

              o   The command is called with a single share_path argument.

              o   The command must return 0 if share_path is capable of being
                  snapshotted.


       shell_snap:create command

              o   Called when an FSRVP client wishes to create a snapshot.

              o   The command is called with a single share_path argument.

              o   The command must return 0 status if the snapshot was
                  successfully taken.

              o   The command must output the path of the newly created
                  snapshot to stdout.


       shell_snap:delete command

              o   Called when an FSRVP client wishes to delete a snapshot.

              o   The command is called with base_share_path and
                  snapshot_share_path arguments.

              o   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]
                     rpc_daemon:fssd = fork
                     registry shares = yes
                     include = registry


VERSION
       This man page is part of version 4.9.3 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.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | service/network/samba |
       +---------------+-----------------------+
       |Stability      | Volatile              |
       +---------------+-----------------------+
NOTES
       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://download.samba.org/pub/samba/stable/samba-4.9.3.tar.gz

       Further information about this software can be found on the open source
       community website at http://www.samba.org/.



Samba 4.9.3                       01/24/2019                 VFS_SHELL_SNAP(8)