From: Paul Cuzner <pcuzner@redhat.com>
Date: Fri, 2 Dec 2022 03:37:34 +0000 (+1300)
Subject: orchestrator: update docs for host ls
X-Git-Tag: v18.1.0~492^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=166e0fb5d5cb83265577f6538a29f0532173ddbb;p=ceph-ci.git

orchestrator: update docs for host ls

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
---

diff --git a/doc/cephadm/host-management.rst b/doc/cephadm/host-management.rst
index 586664ab78c..bd1b9192f99 100644
--- a/doc/cephadm/host-management.rst
+++ b/doc/cephadm/host-management.rst
@@ -11,9 +11,9 @@ 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>]
+   ceph orch host ls [--format yaml] [--host-pattern <name>] [--label <label>] [--host-status <status>] [--detail]
 
-In commands of this form, the arguments "host-pattern", "label" and
+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
@@ -24,6 +24,16 @@ In commands of this form, the arguments "host-pattern", "label" and
 - Any combination of these filtering flags is valid. You may filter against
   name, label and/or status simultaneously.
 
+The "detail" parameter provides more host related information for cephadm based
+clusters. For example:
+
+.. prompt:: bash #
+
+   # ceph orch host ls --detail 
+   HOSTNAME     ADDRESS         LABELS  STATUS  VENDOR/MODEL                           CPU    HDD      SSD  NIC  
+   ceph-master  192.168.122.73  _admin          QEMU (Standard PC (Q35 + ICH9, 2009))  4C/4T  4/1.6TB  -    1    
+   1 hosts in cluster
+
 .. _cephadm-adding-hosts:    
     
 Adding Hosts