From: Alfredo Deza <adeza@redhat.com>
Date: Mon, 22 Jan 2018 17:03:18 +0000 (-0500)
Subject: doc/man/ceph-volume add docs for list sub-command
X-Git-Tag: v13.0.2~451^2~3
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=498d7a06a1f17c769c11da7ba9f83bcf2c0e433d;p=ceph.git

doc/man/ceph-volume add docs for list sub-command

Signed-off-by: Alfredo Deza <adeza@redhat.com>
---

diff --git a/doc/man/8/ceph-volume.rst b/doc/man/8/ceph-volume.rst
index 1d43ce6c57ae8..2eb72cc976a9b 100644
--- a/doc/man/8/ceph-volume.rst
+++ b/doc/man/8/ceph-volume.rst
@@ -108,6 +108,33 @@ Positional arguments:
 
 * <SYSTEMD_DATA>  Data from a systemd unit containing ID and UUID of the OSD.
 
+**list**
+List devices or logical volumes associated with Ceph. An association is
+determined if a device has information relating to an OSD. This is
+verified by querying LVM's metadata and correlating it with devices.
+
+The lvs associated with the OSD need to have been prepared previously by
+ceph-volume so that all needed tags and metadata exist.
+
+Usage::
+
+    ceph-volume lvm list
+
+List a particular device, reporting all metadata about it::
+
+    ceph-volume lvm list /dev/sda1
+
+List a logical volume, along with all its metadata (vg is a volume
+group, and lv the logical volume name)::
+
+    ceph-volume lvm list {vg/lv}
+
+Positional arguments:
+
+* <DEVICE>  Either in the form of ``vg/lv`` for logical volumes or
+  ``/path/to/sda1`` for regular devices.
+
+
 Availability
 ============