diff --git a/docs/intro.rst b/docs/intro.rst index e8732a68..bfbd0d32 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -51,23 +51,28 @@ as well as completing the functionality of the REST API. Supported environments ---------------------- -This package is supported in these Operating System and Python environments: +This package is supported in these environments: -* on Windows, with Python 2.7, 3.4, 3.5, and higher 3.x +* Operating systems: Linux, Windows, OS-X -* on Linux, with Python 2.7, 3.4, 3.5, and higher 3.x +* Python versions: 2.7, 3.4 and higher 3.x -* OS-X has not been tested and is therefore not listed, above. You are welcome - to try it out and report any issues (TODO: Add link to issue tracker). +* HMC versions: 2.11 and higher -This package determines the API version supported by the HMC, and rejects -operation if it finds an API version that is not supported. This package -supports the following HMC API versions: +The following table shows for each HMC version the supported HMC API version +and the supported z System and LinuxOne machine generations: + +=========== =============== ====================== ================================= +HMC version HMC API version HMC API book Machine generations +=========== =============== ====================== ================================= +2.11.0 1.1 :term:`HMC API 2.11.0` up to z196/z114 +2.11.1 1.2 :term:`HMC API 2.11.1` up to z196/z114 +2.12.0 1.3 :term:`HMC API 2.12.0` up to zEC12/zBC12 +2.12.1 1.4/1.5 :term:`HMC API 2.12.1` up to zEC12/zBC12 +2.13.0 1.6 :term:`HMC API 2.13.0` up to z13/z13s/Emperor/Rockhopper +2.13.1 1.7 :term:`HMC API 2.13.1` up to z13/z13s/Emperor/Rockhopper +=========== =============== ====================== ================================= -* HMC API version 1.5 and above (i.e. IBM z13 machine, and above). The - :term:`HMC API` describes this version. Note that the *Version 2.13* - mentioned in the book title is not the HMC API version. - .. _`Deprecation policy`: Deprecation policy @@ -184,4 +189,20 @@ References `IETF RFC6874, Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers, February 2013 `_ HMC API - `IBM SC27-2627-00, z Systems Hardware Management Console Web Services API (Version 2.13.0) `_ + One of the following HMC API books: + + HMC API 2.11.1 + `IBM SC27-2616-01, z Systems Hardware Management Console Web Services API (Version 2.11.1) `_ + + HMC API 2.12.0 + `IBM SC27-2617-01, z Systems Hardware Management Console Web Services API (Version 2.12.0) `_ + + HMC API 2.12.1 + `IBM SC27-2626-00a, z Systems Hardware Management Console Web Services API (Version 2.12.1) `_ + + HMC API 2.13.0 + `IBM SC27-2627-00a, z Systems Hardware Management Console Web Services API (Version 2.13.0) `_ + + HMC API 2.13.1 + `IBM SC27-2634-01, z Systems Hardware Management Console Web Services API (Version 2.13.1) `_ +