1VFS_CEPH_SNAPSHOTS(8)     System Administration tools    VFS_CEPH_SNAPSHOTS(8)
2
3
4

NAME

6       vfs_ceph_snapshots - Expose CephFS snapshots as shadow-copies
7

SYNOPSIS

9       vfs objects = ceph_snapshots
10

DESCRIPTION

12       This VFS module is part of the samba(8) suite.
13
14       The vfs_ceph_snapshots VFS module exposes CephFS snapshots for use by
15       Samba. When enabled, SMB clients such as Windows Explorer's Previous
16       Versions dialog, can enumerate snapshots and access them via "timewarp"
17       tokens.
18
19       This module can be combined with vfs_ceph, but vfs_ceph_snapshots must
20       be listed first in the vfs objects parameter list.
21
22       CephFS support for ceph.snap.btime virtual extended attributes is
23       required for this module to work properly. This support was added via
24       https://tracker.ceph.com/issues/38838.
25

CONFIGURATION

27       When used atop vfs_ceph, path refers to an absolute path within the
28       Ceph filesystem and should not be mounted locally:
29
30                     [share]
31                     vfs objects = ceph_snapshots ceph
32                     path = /non-mounted/cephfs/path
33                     kernel share modes = no
34
35
36       vfs_ceph_snapshots can also be used atop a kernel CephFS mounted share
37       path, without vfs_ceph. In this case Samba's default VFS backend
38       vfs_default is used:
39
40                     [share]
41                     vfs objects = ceph_snapshots
42                     path = /mnt/cephfs/
43
44

OPTIONS

46       ceph:snapdir = subdirectory
47           Allows for the configuration of the special CephFS snapshot
48           subdirectory name. This parameter should only be changed from the
49           ".snap" default if the ceph.conf client snapdir or snapdirname
50           mount option settings are changed from their matching ".snap"
51           defaults.
52
53           Default: ceph:snapdir = .snap
54
55           Example: ceph:snapdir = .snapshots
56

VERSION

58       This man page is part of version 4.13.7 of the Samba suite.
59

AUTHOR

61       The original Samba software and related utilities were created by
62       Andrew Tridgell. Samba is now developed by the Samba Team as an Open
63       Source project similar to the way the Linux kernel is developed.
64
65
66
67Samba 4.13.7                      03/25/2021             VFS_CEPH_SNAPSHOTS(8)
Impressum