From: John Mulligan Date: Tue, 21 Apr 2026 20:36:18 +0000 (-0400) Subject: doc: document new options for smb share rm and cluster rm X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=dceaf47d633fa04e31c66cff5a95e441ac62c55e;p=ceph.git doc: document new options for smb share rm and cluster rm Signed-off-by: John Mulligan --- diff --git a/doc/mgr/smb.rst b/doc/mgr/smb.rst index b8e7c2aca226..5140a72263af 100644 --- a/doc/mgr/smb.rst +++ b/doc/mgr/smb.rst @@ -221,7 +221,7 @@ Remove Cluster .. prompt:: bash # - ceph smb cluster rm [--password-filter=] + ceph smb cluster rm [--recursive] [--wildcard] [--password-filter=] Remove a logical SMB cluster from the Ceph cluster. @@ -229,6 +229,14 @@ Options: cluster_id A ``cluster_id`` value identifying a cluster resource. +recursive + If the ``--recursive`` flag is included in the command the cluster + and the shares contained by that cluster will be automatically + removed. +wildcard + If the ``--wildcard`` flag is included in the command the ``cluster_id`` + value will be treated as a glob_ style wildcard. All clusters with an ID + matching the glob pattern will be removed. password_filter Optional. One of ``none``, ``base64``, or ``hidden``. If the filter is ``none`` the password fields in the output are emitted as plain text. If @@ -419,10 +427,24 @@ Remove Share .. prompt:: bash # - ceph smb share rm + ceph smb share rm [--wildcard] Remove an SMB Share from the cluster. +Options: + +cluster_id + A ``cluster_id`` value identifying a cluster resource that contains + the share resource. +share_id + A ``share_id`` value identifying the specific share within a cluster. +wildcard + If the ``--wildcard`` flag is included in the command the ``share_id`` + value will be treated as a glob_ style wildcard. All shares with an ID + matching the glob pattern will be removed. + +.. _glob: https://docs.python.org/3/library/fnmatch.html + List Shares +++++++++++