From 480d91bce77c792092cf6ab13f25304cd11728d1 Mon Sep 17 00:00:00 2001
From: neeraj pratap singh
 <neerajpratapsingh@li-ff7f0d4c-3462-11b2-a85c-d4004c0fa1a0.ibm.com>
Date: Wed, 9 Apr 2025 23:16:44 +0530
Subject: [PATCH] doc: document the ls commands with string filters

Fixes: https://tracker.ceph.com/issues/70688
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
---
 doc/cephfs/fs-volumes.rst | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/doc/cephfs/fs-volumes.rst b/doc/cephfs/fs-volumes.rst
index 27715f4a63c..9a23385ebc6 100644
--- a/doc/cephfs/fs-volumes.rst
+++ b/doc/cephfs/fs-volumes.rst
@@ -89,6 +89,12 @@ List volumes by running the following command:
 
    ceph fs volume ls
 
+List volumes using search string filter by running following command:
+
+.. prompt:: bash #
+
+   ceph fs volume ls [--vol_filter <filter_string>]
+
 Rename a volume by running the following command:
 
 .. prompt:: bash #
@@ -225,6 +231,12 @@ List subvolume groups by running a command of the following form:
 
    ceph fs subvolumegroup ls <vol_name>
 
+List subvolume groups using search string filter by running a command of the following form:
+
+.. prompt:: bash #
+
+   ceph fs subvolumegroup ls <vol_name> [--group_filter <filter_string>]
+
 .. note:: Subvolume group snapshot feature is no longer supported in mainline CephFS (existing group
           snapshots can still be listed and deleted)
 
@@ -300,6 +312,12 @@ List snapshots of a subvolume group by running a command of the following form:
 
    ceph fs subvolumegroup snapshot ls <vol_name> <group_name>
 
+List snapshots of a subvolume group with search string filter by running a command of the following form:
+
+.. prompt:: bash #
+
+   ceph fs subvolumegroup snapshot ls <vol_name> <group_name> [--snap_filter <filter_string>]
+
 
 FS Subvolumes
 -------------
@@ -541,6 +559,12 @@ Use a command of the following form to list subvolumes:
 
    ceph fs subvolume ls <vol_name> [--group_name <subvol_group_name>]
 
+Use a command of the following form to list subvolumes with search string filter:
+
+.. prompt:: bash #
+
+   ceph fs subvolume ls <vol_name> [--group_name <subvol_group_name>] [--subvol_filter <filter_string>]
+
 .. note:: Subvolumes that have been removed but have snapshots retained, are
    also listed.
 
@@ -681,6 +705,12 @@ Use a command of the following from to list the snapshots of a subvolume:
 
    ceph fs subvolume snapshot ls <vol_name> <subvol_name> [--group_name <subvol_group_name>]
 
+Use a command of the following from to list the snapshots of a subvolume with search string filter:
+
+.. prompt:: bash #
+
+   ceph fs subvolume snapshot ls <vol_name> <subvol_name> [--group_name <subvol_group_name>] [--snap_filter <filter_string>]
+
 Fetching a Snapshot's Information
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.39.5