Merge "Add hypervisor docs"

doc/source/command-objects/hypervisor.rst

@@ -0,0 +1,36 @@
+==========
+hypervisor
+==========
+
+Compute v2
+
+hypervisor list
+---------------
+
+List hypervisors
+
+.. program:: hypervisor list
+.. code:: bash
+
+    os hypervisor list
+        [--matching <hostname>]
+
+.. option:: --matching <hostname>
+
+    Filter hypervisors using <hostname> substring
+
+hypervisor show
+---------------
+
+Display hypervisor details
+
+.. program:: hypervisor show
+.. code:: bash
+
+    os hypervisor show
+        <hypervisor>
+
+.. _hypervisor_show-flavor:
+.. describe:: <hypervisor>
+
+    Hypervisor to display (name or ID)

doc/source/commands.rst

@@ -87,7 +87,7 @@ referring to both Compute and Volume quotas.
 * ``flavor``: (**Compute**) predefined server configurations: ram, root disk, etc
 * ``group``: (**Identity**) a grouping of users
 * ``host``: Compute - the physical computer running a hypervisor
-* ``hypervisor``: Compute - the virtual machine manager
+* ``hypervisor``: (**Compute**) the virtual machine manager
 * ``identity provider``: (**Identity**) a source of users and authentication
 * ``image``: (**Image**) a disk image
 * ``ip fixed``: Compute, Network - an internal IP address assigned to a server

openstackclient/compute/v2/hypervisor.py

@@ -33,8 +33,8 @@ class ListHypervisor(lister.Lister):
         parser = super(ListHypervisor, self).get_parser(prog_name)
         parser.add_argument(
             "--matching",
-            metavar="<hostname-str>",
+            metavar="<hostname>",
-            help="Filter hypervisors using <hostname-str> substring",
+            help="Filter hypervisors using <hostname> substring",
         )
         return parser
 
@@ -58,23 +58,23 @@ class ListHypervisor(lister.Lister):
 
 
 class ShowHypervisor(show.ShowOne):
-    """Show hypervisor details"""
+    """Display hypervisor details"""
 
     log = logging.getLogger(__name__ + ".ShowHypervisor")
 
     def get_parser(self, prog_name):
         parser = super(ShowHypervisor, self).get_parser(prog_name)
         parser.add_argument(
-            "id",
+            "hypervisor",
-            metavar="<id>",
+            metavar="<hypervisor>",
-            help="ID of the hypervisor to display")
+            help="Hypervisor to display (name or ID)")
         return parser
 
     def take_action(self, parsed_args):
         self.log.debug("take_action(%s)", parsed_args)
         compute_client = self.app.client_manager.compute
         hypervisor = utils.find_resource(compute_client.hypervisors,
-                                         parsed_args.id)._info.copy()
+                                         parsed_args.hypervisor)._info.copy()
 
         hypervisor["service_id"] = hypervisor["service"]["id"]
         hypervisor["service_host"] = hypervisor["service"]["host"]