From: Zac Dover <zac.dover@gmail.com>
Date: Thu, 3 Nov 2022 14:12:25 +0000 (+1000)
Subject: doc/cephadm: arrange "listing hosts" section
X-Git-Tag: v16.2.11~199^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F48724%2Fhead;p=ceph.git

doc/cephadm: arrange "listing hosts" section

Collect the material at the top of this page into a
"Listing Hosts" section and clean the English so that
it is clearer.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit d16e4e0737f8852f00b88c4f30b44a13096e6f42)
---

diff --git a/doc/cephadm/host-management.rst b/doc/cephadm/host-management.rst
index 647619539953..694b55335b89 100644
--- a/doc/cephadm/host-management.rst
+++ b/doc/cephadm/host-management.rst
@@ -4,17 +4,25 @@
 Host Management
 ===============
 
-To list hosts associated with the cluster:
+Listing Hosts
+=============
+
+Run a command of this form to list hosts associated with the cluster:
 
 .. prompt:: bash #
 
    ceph orch host ls [--format yaml] [--host-pattern <name>] [--label <label>] [--host-status <status>]
 
-where the optional arguments "host-pattern", "label" and "host-status" are used for filtering.
-"host-pattern" is a regex that will match against hostnames and will only return matching hosts
-"label" will only return hosts with the given label
-"host-status" will only return hosts with the given status (currently "offline" or "maintenance")
-Any combination of these filtering flags is valid. You may filter against name, label and/or status simultaneously
+In commands of this form, the arguments "host-pattern", "label" and
+"host-status" are optional and are used for filtering. 
+
+- "host-pattern" is a regex that will match against hostnames and will only
+  return matching hosts.
+- "label" returns only hosts with the specified label.
+- "host-status" returns only hosts with the specified status (currently
+  "offline" or "maintenance").
+- Any combination of these filtering flags is valid. You may filter against
+  name, label and/or status simultaneously.
 
 .. _cephadm-adding-hosts: