]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: list FS subvolumes, subvolume groups and their snapshots
authorJos Collin <jcollin@redhat.com>
Mon, 7 Oct 2019 09:58:23 +0000 (15:28 +0530)
committerRamana Raja <rraja@redhat.com>
Mon, 16 Mar 2020 09:48:58 +0000 (15:18 +0530)
Fixes: https://tracker.ceph.com/issues/41842
Signed-off-by: Jos Collin <jcollin@redhat.com>
(cherry picked from commit b5769367d53d0d1580a9007af1c5b5198f0ecba8)

doc/cephfs/fs-volumes.rst

index 641a99f4481bdfcf96364421f559b6def946e4d4..dff39347bef00d211093f917eb92c942fd13fb18 100644 (file)
@@ -88,6 +88,10 @@ Fetch the absolute path of a subvolume group using::
 
     $ ceph fs subvolumegroup getpath <vol_name> <group_name>
 
+List subvolume groups using::
+
+    $ ceph fs subvolumegroup ls <vol_name>
+
 Create a snapshot (see :doc:`/cephfs/experimental-features`) of a
 subvolume group using::
 
@@ -102,6 +106,10 @@ Remove a snapshot of a subvolume group using::
 Using the '--force' flag allows the command to succeed that would otherwise
 fail if the snapshot did not exist.
 
+List snapshots of a subvolume group using::
+
+    $ ceph fs subvolumegroup snapshot ls <vol_name> <group_name>
+
 
 FS Subvolumes
 -------------
@@ -120,7 +128,7 @@ subvolume is created within the default subvolume group, and with an octal file
 mode '755', uid of its subvolume group, gid of its subvolume group, data pool layout of
 its parent directory and no size limit.
 
-Remove a subvolume group using::
+Remove a subvolume using::
 
     $ ceph fs subvolume rm <vol_name> <subvol_name> [--group_name <subvol_group_name> --force]
 
@@ -146,6 +154,9 @@ Fetch the absolute path of a subvolume using::
 
     $ ceph fs subvolume getpath <vol_name> <subvol_name> [--group_name <subvol_group_name>]
 
+List subvolumes using::
+
+    $ ceph fs subvolume ls <vol_name> [--group_name <subvol_group_name>]
 
 Create a snapshot of a subvolume using::
 
@@ -159,5 +170,9 @@ Remove a snapshot of a subvolume using::
 Using the '--force' flag allows the command to succeed that would otherwise
 fail if the snapshot did not exist.
 
+List snapshots of a subvolume using::
+
+    $ ceph fs subvolume snapshot ls <vol_name> <subvol_name> [--group_name <subvol_group_name>]
+
 .. _manila: https://github.com/openstack/manila
 .. _CSI: https://github.com/ceph/ceph-csi