Zhmcclient

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

Released: 2020-09-10

This version contains all fixes up to 0.26.2.

**Bug fixes:**

* Fixed Travis setup by removing circumventions for old issues that caused
problems meanwhile.

* Adjusted versions of dependent packages for development environment to
fix issues on Python 3.4.

* Fixed AttributeError when calling partition.list_attached_storage_groups().
(See issue 629)

* Docs: Fixed description to start a new version that was missing updating the
version to the new development version.
(See issue 639)

* Docs: Fixed description of installation from a repo branch.
(See issue 638)

* Test: Fixed missing ffi.h file on CygWin when testing (See issue 655)

* Docs: Fixed links to HMC WS API books that have become invalid.
(See issue 665)

* Fixed empty port list returned by PortManager.list() for CNA adapters.

* Install: Fixed the broken installation from the source distribution archive
on Pypi (see issue 651)

* Test: Pinned 'pyrsistent' package (used by jupyter notebook) to <0.16.0 on
Python 2.7 and to <0.15.0 on Python 3.4.

* Test: Fixed issue where virtualenv on pypy3 created env one level higher.
(see issue 673)

**Enhancements:**

* Added an easy way to print debug information for inclusion into issues, via
`python -m zhmcclient.debuginfo`.
(See issue 640)

* Added `discover_fcp()` and `get_connection_report()` methods to the
`StorageGroup` resource. Added an example `discover_storage_group.py` that
uses the two new methods.
(See issue 623)

* Test: Running coveralls for all Python versions in order to cover Python
version-specific code. The coveralls.io web site consolidates these runs
properly into a single result.

* Docs: Added links to HMC WS APi and Operations books for z15.
(Related to issue 665)

* Added the z15 machine types 8561 and 8562 for detecting the maximum number
of partitions, and started exploiting the new 'maximum-partitions' property
of the CPC for this purpose.

**Cleanup**

* Docs: Removed link to "KVM for IBM z Systems - System Administration" book,
because the product is no longer supported. (Related to issue 665)

* Changed the theme of the documentation on RTD from classic to sphinx_rtd_theme
(See issue 668)

* Test: Added 'make installtest' to the Makefile to test installation of the
package into an empty virtualenv using all supported installation methods.
Added these install tests to the Travis CI tests. (related to issue 651)

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

Released: 2020-01-24

This version contains all changes from 0.25.1.

**Bug fixes:**

* Added the missing os_ipl_token parameter to Lpar.scsi_dump().

* Migrated from using the yamlordereddictloader package to using the
yamlloader package, because yamlordereddictloader got deprecated.
(See issue 605)

* Pinned version of PyYAML to <5.3 for Python 3.4 because 5.3 removed support
for Python 3.4

* Increased minimum version of stomp.py to 4.1.23 to pick up a fix for
hangs during NotificationReceiver.close(). (See issue 572)

**Enhancements:**

* Promoted the development status of the zhmcclient package on Pypi from
3 - Alpha to 4 - Beta.

* Added support for Python 3.8 to the package metadata and to the Travis and
Appveyor and Tox environments. (See issue 596)

* Dropped the use of the pbr package. The package version is now managed
in zhmcclient/_version.py. (See issue 594)

* Test: Added support for TESTOPTS env var to Makefile to be able to specify
py.test options when invoking make test.

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

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.