NAME

       vfs_ceph_new - Utilize features provided by libcephfs low-level APIs

SYNOPSIS

       vfs objects = ceph_new

DESCRIPTION

       This VFS module is part of the samba(8) suite.

       The vfs_ceph_new VFS module exposes CephFS specific features for use by Samba.

       Ceph is a distributed network file system designed to provide excellent performance, reliability, and
       scalability. This is a shared library allowing applications to access a Ceph distributed file system via
       a POSIX-like interface.

       This module can be combined with other modules, but it should be the last module in the vfs objects list.
       Modules added to this list to the right of the ceph entry may not have any effect at all.

       vfs_ceph_new performs mapping between Windows and POSIX Access Control Lists (ACLs). To ensure correct
       processing and enforcement of POSIX ACLs, the following Ceph configuration parameters are automatically
       applied:

                     client acl type = posix_acl
                     fuse default permissions = false

       NOTE: This is a second implementation of a ceph module which uses libcephfs low-level APIs (compared to
       the original vfs_ceph(8) module which uses path-based APIs). Using the low-level API allows more
       optimized and fine-grained access to the Ceph storage layer.

CONFIGURATION

       vfs_ceph_new requires that the underlying share path is a Ceph filesystem.

                     [share]
                     vfs objects = ceph_new
                     path = /non-mounted/cephfs/path
                     kernel share modes = no

       Since vfs_ceph_new does not require a filesystem mount, the share path is treated differently: it is
       interpreted as an absolute path within the Ceph filesystem on the attached Ceph cluster. In a ctdb
       cluster environment where ctdb manages Samba, CTDB_SAMBA_SKIP_SHARE_CHECK=yes must be configured to
       disable local share path checks, otherwise ctdb will not reach a healthy state.

       Note that currently kernel share modes have to be disabled in a share running with the CephFS vfs module
       for file serving to work properly.

OPTIONS

       ceph_new:config_file = path
           Allows one to define a ceph configfile to use. Empty by default.

           Example: ceph_new:config_file = /etc/ceph/ceph.conf

       ceph_new:user_id = name
           Allows one to explicitly set the client ID used for the CephFS mount handle. Empty by default (use
           the libcephfs client default).

           Example: ceph_new:user_id = samba

       ceph_new:filesystem = fs_name
           Allows one to explicitly select the CephFS file system to use when the Ceph cluster supports more
           than one file system. Empty by default (use the default file system of the Ceph cluster).

           Example: ceph_new:filesystem = myfs2

       ceph_new:proxy = [ yes | no | auto ]
           Allows one to indicate use of the libcephfs proxy library for optimized resource utilization,
           allowing more simultaneous client connections. Prerequisites include the presence of
           libcephfs_proxy.so.X shared library file under loadable locations for dynamic linker and an
           active(running) libcephfsd daemon.

                  •   no (default) - Do not use the proxy library but regular connection through libcephfs.so.X.

                  •   yes - Always use the proxy library and fail the client connection request if prerequisites
                      are unmet.

                  •   auto - Attempt to use the proxy library but fall back to the regular cephfs connection if
                      prerequisites are unmet.

VERSION

       This man page is part of version 4.22.2-Ubuntu-4.22.2+dfsg-1ubuntu1 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.22.2-Ubuntu-4.22.2+dfs                     06/18/2025                                    VFS_CEPH_NEW(8)