From 498d7a06a1f17c769c11da7ba9f83bcf2c0e433d Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Mon, 22 Jan 2018 12:03:18 -0500 Subject: [PATCH] doc/man/ceph-volume add docs for list sub-command Signed-off-by: Alfredo Deza --- doc/man/8/ceph-volume.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/doc/man/8/ceph-volume.rst b/doc/man/8/ceph-volume.rst index 1d43ce6c57a..2eb72cc976a 100644 --- a/doc/man/8/ceph-volume.rst +++ b/doc/man/8/ceph-volume.rst @@ -108,6 +108,33 @@ Positional arguments: * 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: + +* Either in the form of ``vg/lv`` for logical volumes or + ``/path/to/sda1`` for regular devices. + + Availability ============ -- 2.47.3