Zhmcclient

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

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.

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

This version contains all fixes up to version 0.21.2.

Released: 2021-07-02

**Incompatible changes:**

* The zhmc command now verifies HMC server certificates by default, using the
CA certificates in the 'certifi' Python package. This verification will reject
the self-signed certificates the HMC is set up with initially. To deal with
this, install a CA-verifiable certificate in the HMC and specify the correct
CA certificates with the new '-c / --ca-certs' option. As a temporary quick
fix, you can disable the verification with the new '-n / --no-verify'
option.

**Bug fixes:**

* Fixed install error on Python>=3.6 caused by click-repl being incompatible
with click 8.0.

* Fixed the issue that some commands (e.g. cpc list) stopped the spinner too
early. (issue 142)

* Docs: Added statement that the command group for HBAs can be used only on
z13 and earlier. (issue 199)

* Docs: Clarified which command groups can only be used in DPM mode or in
classic mode. (issue 200)

**Enhancements:**

* The zhmc command now supports verification of the HMC server certificate.
There are two new command line options '-n / --no-verify' and '-c / --ca-certs'
that control the verification behavior.

* Increased the minimum version of zhmcclient to 0.32.0. Adjusted code to
accommodate the immutable properties of resource objects.

* Added a '-T' / '--operation-timeout' general option to the following commands,
that specifies the operation timeout when waiting for completion of
asynchronous HMC operations. (issue 126)

- lpar activate
- lpar deactivate
- lpar load
- lpar stop
- lpar psw_restart
- lpar scsi-load
- lpar scsi-dump
- partition start
- partition stop
- partition dump
- storagegroup discover-fcp

* Partition commands: On HMC 2.14.0 and later, the partition commands now use
the "List Permitted Partitions" operation instead of going through the CPC,
which improves the response time, and no longer requires that the user has
object access permission to the targeted CPC.
In addition, the CPC on the 'partition list' command is now optional. If not
specified, permitted partitions on all managed CPCs are listed.
(issue 192)

* Lpar commands: On HMC 2.14.0 and later, the lpar commands now use the
"List Permitted Logical Partitions" operation instead of going through the
CPC, which improves the response time.
In addition, on HMC API version 3.6 or later (an update to HMC 2.15.0),
the lpar commands no longer require that the user has object access permission
to the targeted CPC.
In addition, the CPC on the 'lpar list' command is now optional. If not
specified, permitted LPARs on all managed CPCs are listed.
(issue 192)

* The 'nic create' and 'nic update' commands can now specify the backing port
with the --adapter and --port options for all types of network adapters.
Previously, they could be used only for OSA and Hipersocket adapters.
The --virtual-switch option has been deprecated but for compatibility reasons
is still supported for OSA and Hipersocket adapters. (issues 201, 198)

**Cleanup:**

* Added the missing closing of the image file in the 'partition mount-iso'
command.

* Disabled a Pylint 'consider-using-with' issue on a Popen in test code that
was properly terminated again.

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

Released: 2021-04-06

**Enhancements:**

* Increased minimum version of zhmcclient to 0.30.0.

* Added an option `--secure-boot` to `lpar scsi-load` command (issue 148).

* Added an option `--force` to `lpar scsi-dump` command (issue 148).

* Added support for DPM capacity groups with a new 'capacitygroup' command
group. (issue 157)