Zhmcclient

^^^^^^^^^^^^^^

Released: 2019-12-18

**Bug fixes:**

* Docs: Fixed incorrect statement about HMC version 2.14.0 supporting both
GA generations of z14 machines.

**Enhancements:**

* Docs: Added HMC version 2.14.1 in "Bibliography" and "Introduction" sections.

* Added support for following LPAR operations:

- Lpar.psw_restart() (HMC: “PSW Restart”)
- Lpar.scsi_dump() (HMC: “SCSI Dump”)

* Added support for Storage Template objects in DPM mode (see issue 589).

^^^^^^^^^^^^^^

Released: 2019-08-15

**Incompatible changes:**

* Operations that resulted in HTTP status 403, reason 1 ("The user under which
the API request was authenticated does not have the required authority to
perform the requested action.") so far raised `ServerAuthError`. However,
that exception does not represent that situation properly, because the
login user is actually properly authenticated.
The handling of this case was changed to now raise `HTTPError` instead of
`ServerAuthError`.
This change is only incompatible to users of the zhmcclient API who have
code handling this exception specifically.

**Bug fixes:**

* Fixed LookupError on unknown encoding ISO-5589-1 in test_session.py test
that occurred with latest requests_mock package.

* Increased minimum version of flake8 to 3.7.0 due to difficulties with
recognizing certain 'noqa' statements. This required explicitly specifying
its dependent pycodestyle and pyflakes packages with their minimum versions,
because the dependency management did not work with our minimum
package versions.

* Fixed use of incorrect HTTP method in `Console.get_audit_log()` and
`Console.get_security_log()`. See issue 580.

**Enhancements:**

* Improved end2end test support for zhmcclient and its using projects.
The zhmcclient.testutils package already provides some support for end2end
tests by users of the zhmcclient package. It is also used by the end2end
tests of the zhmcclient package itself. This change improves that support,
mainly from a perspective of projects using zhmcclient.

* Improved the show_os_messages.py example.

* Blanked out the session ID value in the log record for logging off.

* Changed import of 'stomp' module used for notifications from the HMC, to be
lazy, in order to speed up the import of 'zhmcclient' for its users.
The 'stomp' module is now imported when the first
`zhmcclient.NotificationReceiver` object is created. Also, only the class
needed is imported now, instead of the entire module.

* Added timezone support to the utility function
`zhmcclient.datetime_from_timestamp()`. The desired timezone for the returned
object can now be specified as an optional argument, defaulting to UTC for
compatibility. This allows displaying HMC timestamps in local time rather
than just UTC time.

* Added support for specifying multiple notification topics to
`zhmcclient.NotificationReceiver`.

^^^^^^^^^^^^^^

Released: 2019-04-04

**Bug fixes:**

* Fixed the list_storage_groups.py example. It used a non-existing property
on the Cpc class.

* Passwords and session tokens are now correctly blanked out in logs.
See issue 560.

**Enhancements:**

* Added support for the new "Zeroize Crypto Domain" operation that allows
zeroizing a single crypto domain on a crypto adapter. This operation is
supported on z14 GA2 and higher, and the corresponding LinuxOne systems.

* Changes in logging support:

- Removed the notion of module-specific loggers from the description
of the logging chapter, because that was not used at all, and is not
expected to be used in the future: Errors are supposed to be raised
as exceptions and not logged, and warnings are supposed to be issued
as Python warnings and not logged.

- Escaped newlines to blanks in log messages, so that all log messages
are now on a single line.

- Changed the syntax for zhmcclient.api log messages, to start with
"Called:" and "Return:" instead of "==>" and "<==".

- Changed the syntax for zhmcclient.hmc log messages, to start with
"Request:" and "Respons:" instead of "HMC request:" and
"HMC response:", in order to have the URLs column-adjusted.

^^^^^^^^^^^^^^

Released: 2019-01-07

**Enhancements:**

* Added a mitigation for a firmware defect that causes filtering of
adapters by adapter-id to return an empty result when the specified
adapter-id contains hex digits ('a' to 'f'). See issue 549.

^^^^^^^^^^^^^^

Released: 2018-10-31

**Bug fixes:**

* Update Requests package to 2.20.0 to fix following vulnerability of
the National Vulnerability Database:
https://nvd.nist.gov/vuln/detail/CVE-2018-18074

^^^^^^^^^^^^^^

Released: 2018-10-24

**Bug fixes:**

* Docs: Added missing support statements for the LinuxOne Emperor II machine
generations to the documentation (The corresponding z14 was already listed).

**Enhancements:**

* Docs: Streamlined, improved and fixed the description how to release a version
and how to start a new version, in the development section of the documentation.

* Added support for Python 3.7. This required increasing the minimum versions
of several Python packages in order to pick up their Python 3.7 support:

- `pyzmq` from 16.0.2 to 16.0.4 (While 16.0.4 works for this, only
17.0.0 declares Python 3.6(!) support on Pypi, and Python 3.7 support is not
officially declared on Pypi yet for this package).
- `PyYAML` from 3.12 to 3.13 (see PyYAML issue
https://github.com/yaml/pyyaml/issues/126).

* Docs: Added support statements for the z14-ZR1 and LinuxONE Rockhopper II
machine generations to the documentation.

* Added support for the z14-ZR1 and LinuxONE Rockhopper II machine generations
to the `Cpc.maximum_active_partitions()` method.

* Provided direct access to the (one) `Console` object, from the
`ConsoleManager` and `CpcManager` objects, via a new `console` property.
This is for convenience and avoids having to code `find()` or `list()` calls.
The returned `Console` object is cached in the manager object.

Also, added a `console` property to the `FakedConsoleManager` class in the
mock support, for the same purpose.

* Added a property `client` to class `CpcManager` for navigating from a `Cpc`
object back to the `Client` object which is the top of the resource tree.

* Added support for the new concept of firmware features to Cpcs and Partitions,
by adding methods `feature_enabled()` and `feature_info()` to classes `Cpc`
and `Partition` for inspection of firmware features. The firmware feature
concept was introduced starting with the z14-ZR1 and LinuxONE Rockhopper II
machine generation. The DPM storage management feature is the first of these
new firmware features.

* Added support for the DPM storage management feature that is available starting
with the z14-ZR1 and LinuxONE Rockhopper II machine generation. This includes
new resources like Storage Groups, Storage Volumes, and Virtual Storage Resources.
It also includes new methods for managing storage group attachment to Partitions.
The new items in the documentation are:

- In 5.1. CPCs: `list_associated_storage_groups()`, `validate_lun_path()`.
- In 5.5. Partitions: `attach_storage_group()`, `detach_storage_group()`,
`list_attached_storage_groups()`.
- 5.12. Storage Groups
- 5.13. Storage Volumes
- 5.14. Virtual Storage Resources
- In 5.15 Console: `storage_groups`

* Added support for changing the type of storage adapters between FICON and FCP,
via a new method `Adapter.change_adapter_type()`. This capability was introduced
with the z14-ZR1 and LinuxONE Rockhopper II machine generation.