From: Anoop C S <anoopcs@cryptolab.net>
Date: Wed, 10 Jul 2024 17:59:36 +0000 (+0530)
Subject: doc/mgr/smb: Add missing option for standalone mode
X-Git-Tag: v20.0.0~1490^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=770016d3acd623da0d66469d71e95299176937c3;p=ceph.git

doc/mgr/smb: Add missing option for standalone mode

'--define-user-pass' allows us to specify the list of users, along with
their passwords, permitted to access different shares within a cluster.
But this option was missing from the corresponding docs.

Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
---

diff --git a/doc/mgr/smb.rst b/doc/mgr/smb.rst
index d48c638dbee6..3cc7c07694c0 100644
--- a/doc/mgr/smb.rst
+++ b/doc/mgr/smb.rst
@@ -55,7 +55,7 @@ Create Cluster
 
 .. code:: bash
 
-    $ ceph smb cluster create <cluster_id> {user|active-directory} [--domain-realm=<domain_realm>] [--domain-join-user-pass=<domain_join_user_pass>] [--custom-dns=<custom_dns>] [--placement=<placement>]
+    $ ceph smb cluster create <cluster_id> {user|active-directory} [--domain-realm=<domain_realm>] [--domain-join-user-pass=<domain_join_user_pass>] [--define-user-pass=<define_user_pass>] [--custom-dns=<custom_dns>] [--placement=<placement>]
 
 Create a new logical cluster, identified by the cluster id value. The cluster
 create command must specify the authentication mode the cluster will use. This
@@ -78,6 +78,9 @@ domain_realm
 domain_join_user_pass
     A string in the form ``<username>%<password>`` that will be used to join
     Samba servers to the AD domain.
+define_user_pass
+    A string of the form ``<username>%<password>`` that will be used for
+    authentication in ``user`` auth_mode.
 custom_dns
     Optional. Can be specified multiple times. One or more IP Addresses that
     will be applied to the Samba containers to override the default DNS