From: John Mulligan <jmulligan@redhat.com>
Date: Mon, 20 Apr 2026 20:07:19 +0000 (-0400)
Subject: mgr/smb: add --wildcard and --recursive to smb cluster rm
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=f2e250981bf2f3cb1f2e39e5e5eac5946d952509;p=ceph.git

mgr/smb: add --wildcard and --recursive to smb cluster rm

Add new --wildcard and --recursive flags to the smb cluster rm
subcommands. These allow deleting clusters in bulk.  The --wildcard
option works like the same option for share rm in that it allows the use
of globbing for the cluster IDs, this includes '*' to delete all
clusters. The --recursive option tells the command to also delete all
child resources (shares) when deleting a cluster.

This was previously doable by streaming the output of `ceph smb show
...` through (sed or) jq and flipping the intent to removed and piping
that to `ceph smb apply` - but this is clearly not obvious nor easy to
document versus  these new options.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
---

diff --git a/src/pybind/mgr/smb/module.py b/src/pybind/mgr/smb/module.py
index d3b50f8fcc0b..2a5dbfeef108 100644
--- a/src/pybind/mgr/smb/module.py
+++ b/src/pybind/mgr/smb/module.py
@@ -342,18 +342,106 @@ class Module(orchestrator.OrchestratorClientMixin, MgrModule):
             password_filter_out=password_filter_out,
         ).squash(cluster)
 
-    @SMBCLICommand('cluster rm', perm='rw')
+    @overload
     def cluster_rm(
         self,
         cluster_id: str,
+        wildcard: Literal[False] = False,
+        recursive: bool = False,
         password_filter: PasswordFilter = PasswordFilter.NONE,
     ) -> results.Result:
+        ...
+
+    @overload
+    def cluster_rm(
+        self,
+        cluster_id: str,
+        wildcard: Literal[True],
+        recursive: bool = False,
+        password_filter: PasswordFilter = PasswordFilter.NONE,
+    ) -> results.ResultGroup:
+        ...
+
+    @SMBCLICommand('cluster rm', perm='rw')
+    def cluster_rm(
+        self,
+        cluster_id: str,
+        wildcard: bool = False,
+        recursive: bool = False,
+        password_filter: PasswordFilter = PasswordFilter.NONE,
+    ) -> Union[results.Result, results.ResultGroup]:
         """Remove an smb cluster"""
+        if recursive or wildcard:
+            return self._cluster_multi_rm(
+                cluster_id,
+                password_filter=password_filter,
+                recursive=recursive,
+                wildcard=wildcard,
+            )
         cluster = resources.RemovedCluster(cluster_id=cluster_id)
         return self._apply_res(
             [cluster], password_filter_out=password_filter
         ).one()
 
+    def _cluster_multi_rm(
+        self,
+        cluster_id: str,
+        password_filter: PasswordFilter = PasswordFilter.NONE,
+        recursive: bool = False,
+        wildcard: bool = False,
+    ) -> results.ResultGroup:
+        """Remove >=1 cluster and optionally its shares."""
+        if wildcard:
+            # a wildcard cluster search will give 0-N matching clusters
+            matches = self._handler.matching_resources(
+                [f'ceph.smb.cluster.{cluster_id}'],
+                wildcard=True,
+            )
+            clusters = [
+                r for r in matches if isinstance(r, resources.Cluster)
+            ]
+            shares = []
+        else:
+            # a non-wildcard cluster - ids are expected to be exact
+            # belonging to the cluster
+            mixed = self._handler.matching_resources(
+                [
+                    f'ceph.smb.cluster.{cluster_id}',
+                    f'ceph.smb.share.{cluster_id}',
+                ],
+                wildcard=False,
+            )
+            clusters = [r for r in mixed if isinstance(r, resources.Cluster)]
+            shares = [r for r in mixed if isinstance(r, resources.Share)]
+        if not clusters:
+            raise cli.NoMatchingValue(f'no clusters matching "{cluster_id}"')
+        # get shares belonging to the clusters matched during wildcarding
+        if recursive and wildcard:
+            for cluster in clusters:
+                shares.extend(
+                    s
+                    for s in self._handler.matching_resources(
+                        [f'ceph.smb.share.{cluster.cluster_id}'],
+                        wildcard=False,
+                    )
+                    if isinstance(s, resources.Share)
+                )
+        # assemble the Removed{Share,Cluster} resources to submit
+        rm_res: list[resources.SMBResource] = [
+            resources.RemovedShare(
+                cluster_id=s.cluster_id, share_id=s.share_id
+            )
+            for s in shares
+        ]
+        rm_res.extend(
+            resources.RemovedCluster(cluster_id=c.cluster_id)
+            for c in clusters
+        )
+        return self._apply_res(
+            rm_res,
+            password_filter_out=password_filter,
+        )
+
     @SMBCLICommand('cluster update cephfs qos', perm='rw')
     def cluster_update_qos(
         self,