@@ -53,9 +53,9 @@ Cluster Commands
5353Create Cluster
5454++++++++++++++
5555
56- .. code :: bash
56+ .. prompt :: bash #
5757
58- $ 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> ] [--clustering=< clustering> ] [--password-filter=< password_filter> ] [--password-filter-out=< password_filter_out> ]
58+ 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>] [--clustering=<clustering>] [--password-filter=<password_filter>] [--password-filter-out=<password_filter_out>]
5959
6060Create a new logical cluster, identified by the cluster id value. The cluster
6161create command must specify the authentication mode the cluster will use. This
@@ -117,9 +117,9 @@ password_filter_out
117117Remove Cluster
118118++++++++++++++
119119
120- .. code :: bash
120+ .. prompt :: bash #
121121
122- $ ceph smb cluster rm < cluster_id> [--password-filter=< password_filter> ]
122+ ceph smb cluster rm <cluster_id> [--password-filter=<password_filter>]
123123
124124Remove a logical SMB cluster from the Ceph cluster.
125125
@@ -138,9 +138,9 @@ password_filter
138138List Clusters
139139++++++++++++++
140140
141- .. code :: bash
141+ .. prompt :: bash #
142142
143- $ ceph smb cluster ls [--format=< format> ]
143+ ceph smb cluster ls [--format=<format>]
144144
145145Print a listing of cluster ids. The output defaults to JSON, select YAML
146146encoding with the ``--format=yaml `` option.
@@ -152,9 +152,9 @@ Share Commands
152152Create Share
153153++++++++++++
154154
155- .. code :: bash
155+ .. prompt :: bash #
156156
157- $ ceph smb share create < cluster_id> < share_id> < cephfs_volume> < path> [--share-name=< share_name> ] [--subvolume=< subvolume> ] [--readonly]
157+ ceph smb share create <cluster_id> <share_id> <cephfs_volume> <path> [--share-name=<share_name>] [--subvolume=<subvolume>] [--readonly]
158158
159159Create a new SMB share, hosted by the named cluster, that maps to the given
160160CephFS volume and path.
@@ -182,19 +182,19 @@ readonly
182182Remove Share
183183++++++++++++
184184
185- .. code :: bash
185+ .. prompt :: bash #
186186
187- $ ceph smb share rm < cluster_id> < share_id>
187+ ceph smb share rm <cluster_id> <share_id>
188188
189189Remove an SMB Share from the cluster.
190190
191191
192192List Shares
193193+++++++++++
194194
195- .. code :: bash
195+ .. prompt :: bash #
196196
197- $ ceph smb share ls < cluster_id> [--format=< format> ]
197+ ceph smb share ls <cluster_id> [--format=<format>]
198198
199199Print a listing of share ids. The output defaults to JSON, select YAML
200200encoding with the ``--format=yaml `` option.
@@ -210,16 +210,16 @@ Resource specifications can be written in either JSON or YAML. These resource
210210specifications can be applied to the cluster using the ``ceph smb apply ``
211211command, for example:
212212
213- .. code :: bash
213+ .. prompt :: bash #
214214
215- $ ceph smb apply -i /path/to/resources.yaml
215+ ceph smb apply -i /path/to/resources.yaml
216216
217217In addition to the resource specification the ``apply `` sub-command accepts
218218options that control how the input and output of the command behave:
219219
220- .. code :: bash
220+ .. prompt :: bash #
221221
222- $ ceph smb apply [--format=< format> ] [--password-filter=< password_filter> ] [--password-filter-out=< password_filter_out> ] -i < input>
222+ ceph smb apply [--format=<format>] [--password-filter=<password_filter>] [--password-filter-out=<password_filter_out>] -i <input>
223223
224224Options:
225225
@@ -245,16 +245,16 @@ input
245245Resources that have already been applied to the Ceph cluster configuration can
246246be viewed using the ``ceph smb show `` command. For example:
247247
248- .. code :: bash
248+ .. prompt :: bash #
249249
250- $ ceph smb show ceph.smb.cluster.cluster1
250+ ceph smb show ceph.smb.cluster.cluster1
251251
252252The ``show `` command can show all resources, resources of a given type, or specific
253253resource items. Options can be provided that control the output of the command.
254254
255- .. code :: bash
255+ .. prompt :: bash #
256256
257- $ ceph smb show [resource_name...] [--format=< format> ] [--results=< results> ] [--password-filter=< password_filter> ]
257+ ceph smb show [resource_name...] [--format=<format>] [--results=<results>] [--password-filter=<password_filter>]
258258
259259Options:
260260
@@ -292,9 +292,9 @@ password_filter
292292
293293For example:
294294
295- .. code :: bash
295+ .. prompt :: bash #
296296
297- $ ceph smb show ceph.smb.cluster.bob ceph.smb.share.bob
297+ ceph smb show ceph.smb.cluster.bob ceph.smb.share.bob
298298
299299Will show one cluster resource (if it exists) for the cluster "bob" as well as
300300all share resources associated with the cluster "bob".
@@ -819,9 +819,9 @@ configuration file. First, create the YAML with the contents:
819819 Save this text to a YAML file named ``resources.yaml `` and make it available
820820on a cluster admin host. Then run:
821821
822- .. code :: bash
822+ .. prompt :: bash #
823823
824- $ ceph smb apply -i resources.yaml
824+ ceph smb apply -i resources.yaml
825825
826826The command will print a summary of the changes made and begin to automatically
827827deploy the needed resources. See `Accessing Shares `_ for more information
@@ -850,9 +850,9 @@ action with a new file ``removed.yaml`` containing:
850850
851851 By issuing the command:
852852
853- .. code :: bash
853+ .. prompt :: bash #
854854
855- $ ceph smb apply -i removed.yaml
855+ ceph smb apply -i removed.yaml
856856
857857
858858SMB Cluster Management
0 commit comments