Docs: Added HMC userid requirement for WS access

Signed-off-by: Andreas Maier <[email protected]>
zhmcclient · Nov 27, 2023 · d225797 · d225797
1 parent d601833
commit d225797
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -68,6 +68,9 @@ Released: not yet
 * Added handling of exceptions raised by the built-in HTTP server during
   its startup, for the HTTP case. (related to issue #397)
 
+* Docs: Added the missing requirement for having the HMC userid enabled for
+  web services access. (issue #419)
+
 **Enhancements:**
 
 * Added support for Python 3.12. Had to increase the minimum versions of

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -161,6 +161,12 @@ the ``zhmc_prometheus_exporter`` command.
 To return all metrics supported by the command, the HMC userid must have the
 following permissions:
 
+* The HMC userid must have the following flag enabled:
+
+  - "Allow access to Web Services management interfaces" flag of the user in
+    the HMC GUI, or "allow-management-interfaces" property of the user at the
+    WS-API.
+
 * Object access permission to the objects for which metrics should be returned.
 
   If the userid does not have object access permission to a particular object,