VFS_SHELL_SNAP(8)

💅 VFS_SHELL_SNAP — the manual, but make it cute

okay bestie, welcome to VFS_SHELL_SNAP(8) from the System Administration tools corner of the manual-verse. This is vfs_shell_snap, and no cap, it's the little VFS module that lets your shell scripts do the snapshot thing when remote clients come knocking. Let's get into it. 🦋

---

✨ NAME ✨

vfs_shell_snap — shell script callouts for snapshot creation and deletion. literally what it says on the tin, she's honest 💖

---

🌸 SYNOPSIS 🌸

vfs objects = shell_snap

that's it. one line. iconic behavior honestly 👑

---

🎀 DESCRIPTION 🎀

This VFS module is part of the samba(8) suite, so she runs with the big girls ✨

The vfs_shell_snap VFS hands your shell scripts the callouts for snapshot creation and deletion operations that remote clients ask for using the File Server Remote VSS Protocol (FSRVP). basically: client says "snapshot pls", Samba says "hold on, lemme call your script" 🫶

Here's the callouts you can configure in smb.conf:

• shell_snap:check path command
  • Called when an FSRVP client wants to check whether a given share even supports snapshot create/delete requests. vibe check first, always 💅
  • The command gets one argument: share_path.
  • The command must return 0 if share_path is capable of being snapshotted. no zero, no snapshot, periodt.
• shell_snap:create command
  • Called when an FSRVP client wants to create a snapshot.
  • The command gets one argument: share_path.
  • 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. yes bestie, stdout, don't get shy on us 😭
• shell_snap:delete command
  • Called when an FSRVP client wants to delete a snapshot.
  • The command gets base_share_path and snapshot_share_path as arguments. two of them, both, in that order 🔥
  • The command must return 0 status if the snapshot was successfully removed. bye bye snapshot 🧚

heads up: all commands are executed as the authenticated FSRVP client user. so whatever that user can do, your script can do. plan accordingly bestie 🙈

This module is stackable. she plays well with others 💜

---

🌈 CONFIGURATION 🌈

Here's the whole setup, and it's giving very much "yes and":

[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

And plot twist — Samba's FSRVP server itself must be configured over in the [global] section, or none of this goes anywhere:

[global]
registry shares = yes
include = registry

that's the whole recipe babe, no secret ingredients 💖

---

⭐ VERSION ⭐

This man page is part of version 4.24.7-Ubuntu-4.24.7+dfsg-1ubuntu1 of the Samba suite. write it down, she's specific 💅

---

👑 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. legends, all of them 🔥

---

and that's the whole page, bestie!! from Samba 4.24.7-Ubuntu-4.24.7+dfsg-1ubuntu1, dated 09/13/2026 — mwah, go snapshot something gorgeous 💖✨🎀🦋🌸💅🫶