From a44d01f62618d8e25f01f3e91f3abe22ca2470a8 Mon Sep 17 00:00:00 2001 From: John Mulligan Date: Mon, 6 May 2024 19:29:25 -0400 Subject: [PATCH] doc: document smb share login_control and restrict_access options Signed-off-by: John Mulligan --- doc/mgr/smb.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/mgr/smb.rst b/doc/mgr/smb.rst index a19b392ad33ee..d48c638dbee60 100644 --- a/doc/mgr/smb.rst +++ b/doc/mgr/smb.rst @@ -480,6 +480,21 @@ cephfs provider Optional. One of ``samba-vfs`` or ``kcephfs`` (``kcephfs`` is not yet supported) . Selects how CephFS storage should be provided to the share +restrict_access + Optional boolean, defaulting to false. If true the share will only permit + access by users explicitly listed in ``login_control``. +login_control + Optional list of objects. Fields: + + name + Required string. Name of the user or group. + category + Optional. One of ``user`` (default) or ``group``. + access + One of ``read`` (alias ``r``), ``read-write`` (alias ``rw``), ``none``, + or ``admin``. Specific access level to grant to the user or group when + logging into this share. The ``none`` value denies access to the share + regardless of the ``restrict_access`` value. custom_smb_share_options Optional mapping. Specify key-value pairs that will be directly added to the ``smb.conf`` (or equivalent) of a Samba server. Do *not* use this -- 2.39.5