Zhmccli

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

Released: 2024-10-10

**Incompatible changes:**

* Dev: Changed 'make install' to install the package in non-editable mode.
Support for editable mode has been deprecated by pip.

**Bug fixes:**

* Addressed safety issues up to 2024-08-18.

* Dev: Fixed step that creates the release start tag when starting a new version.

* Dev: Fixed new issue 'too-many-positional-arguments' reported by Pylint 3.3.0.

* Test: Upgraded GitHub actions plugin versions to warnings about using deprecated
node.js version 16.

* Fixed incorrect checks in 'make release_publish' and 'make start_tag'.

* Dev: In the make commands to create/update AUTHORS.md, added a reftag to the
'git shortlog' command to fix the issue that without a terminal (e.g. in GitHub
Actions), the command did not display any authors.

* Increased minimum versions of PyYAML to 6.0.2 and pyrsistent to 0.20.0 to fix
install errors with Python 3.13 on Windows. (`612 <https://github.com/zhmcclient/zhmccli/issues/612>`_)

* Increased minimum version of zhmcclient to 1.17.0 (and dependent packages
accordingly) to pick up fixes and functionality. (`623 <https://github.com/zhmcclient/zhmccli/issues/623>`_)

* Increased minimum version of zhmcclient to 1.18.0 (and dependent packages
accordingly) to pick up fixes. (`659 <https://github.com/zhmcclient/zhmccli/issues/659>`_)

* Fixed incorrect check for start branch in 'make start_tag'. (`662 <https://github.com/zhmcclient/zhmccli/issues/662>`_)

* Test: Fixed the issue that coveralls was not found in the test workflow on MacOS
with Python 3.9-3.11, by running it without login shell. Added Python 3.11 on
MacOS to the normal tests. (`1665 <https://github.com/zhmcclient/zhmccli/issues/1665>`_)

**Enhancements:**

* Added support for and tests on Python 3.13.0-rc.1. (`612 <https://github.com/zhmcclient/zhmccli/issues/612>`_)

* Dev: Migrated from setup.py to pyproject.toml with setuptools as build backend.
This provides for automatic determination of the package version without
having to edit a version file. (`617 <https://github.com/zhmcclient/zhmccli/issues/617>`_)

* Test: Added support for running the 'ruff' checker via "make ruff" and added
that to the test workflow. (`618 <https://github.com/zhmcclient/zhmccli/issues/618>`_)

* Test: Added support for running the 'bandit' checker with a new make target
'bandit', and added that to the GitHub Actions test workflow. Adjusted
the code in order to pass the bandit check. (`619 <https://github.com/zhmcclient/zhmccli/issues/619>`_)

* Test: Added tests for Python 3.13 (final version). (`620 <https://github.com/zhmcclient/zhmccli/issues/620>`_)

* Added support for building a local docker image. (`627 <https://github.com/zhmcclient/zhmccli/issues/627>`_)

* Dev: Migrated to using towncrier for managing the change log. (`632 <https://github.com/zhmcclient/zhmccli/issues/632>`_)

* Dev: Encapsulated the releasing of a version to PyPI into new 'release_branch'
and 'release_publish' make targets. See the development documentation for
details. (`645 <https://github.com/zhmcclient/zhmccli/issues/645>`_)

* Dev: Encapsulated the starting of a new version into new 'start_branch' and
'start_tag' make targets. See the development documentation for details. (`645 <https://github.com/zhmcclient/zhmccli/issues/645>`_)

**Cleanup:**

* Fixed new issues reported by new flake8 7.0.0.

* Dev: Relaxed the conditions when safety issues are tolerated:
Issues in development dependencies are now tolerated in normal and scheduled
test workflow runs (but not in local make runs and release test workflow runs).
Issues in installation dependencies are now tolerated in normal test workflow
runs (but not in local make runs and scheduled/release test workflow runs).

* Dev: Added to the release instructions to roll back fixes for safety issues
into any maintained stable branches.

* Dev: Added to the release instructions to check and fix dependabot issues,
and to roll back any fixes into any maintained stable branches.

* Consolidated the names and emails of the authors shown in AUTHORS.md.

* Dev: Dropped the 'make upload' target, because the release to PyPI has
been migrated to using a publish workflow. (`645 <https://github.com/zhmcclient/zhmccli/issues/645>`_)

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

This version contains all fixes up to version 1.10.1.

Released: 2024-05-18

**Incompatible changes:**

* cpc command dpm-export now adds additional meta information to the export
data (can be suppressed using --exclude-meta-fields). Export configuration
files created with this version of zhmc can only be imported using this
or any newer version of zhmc, too!

* cpc command dpm-import now honours the configuration file content regarding
the preserve-uris, preserve-wwpns, and adapter-mapping information. That
information was previously ignored, and always overwritten by zhmc before
import.

**Bug fixes:**

* Fixed safety issues up to 2024-05-17.

* In the Github Actions test workflow for Python 3.5, 3.6 and 3.7, changed
macos-latest back to macos-12 because macos-latest got upgraded from macOS 12
to macOS 14 which no longer supports these Python versions.

* Fixed an error in the 'cpc autostart add' command.

* Dev: Fixed new issue 'possibly-used-before-assignment' in Pylint 3.2.0.

* Docs: Fixed formatting of badges on README page by converting it to
Markdown. (issue 604)

**Enhancements:**

* Test: Added the option 'ignore-unpinned-requirements: False' to both
safety policy files because for safety 3.0, the default is to ignore
unpinned requirements (in requirements.txt).
Increased safety minimum version to 3.0 because the new option is not
tolerated by safety 2.x. Safety now runs only on Python >=3.7 because
that is what safety 3.0 requires.

* Changed safety run for install dependencies to use the exact minimum versions
of the dependent packages, by moving them into a separate
minimum-constraints-install.txt file that is included by the existing
minimum-constraints.txt file.

* The safety run for all dependencies now must succeed when the test workflow
is run for a release (i.e. branch name 'release\_...').

* Improved performance of 'list' commands by pulling only the properties
needed for the output, instead of all of them. This reduced the time to list
CPCs from over 20 seconds to under 1 second on a test system.

* Improved performance of the 'partition list' command on newer HMCs, by using
the 'additional-properties' query parameter introduced in HMC version 2.16.0.
This improved the time for listing partitions on a test system with many
partitions from about 20 seconds to below 3 seconds.

* cpc command dpm-export now prints a summary of the exported configuration
data.

* cpc command dpm-import now prints summary information regarding the
preserve-uris, preserve-wwpns, and adapter-mapping fields. It also prints
a summary of the concrete configuration data that gets passed to the HMC
for import prior asking for confirmation.

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

This version contains all fixes up to version 1.9.3.

Released: 2024-02-13

**Incompatible changes:**

* Dropped support for Python 2.7 and 3.5. These Python versions went out
of support by the PSF in 2020. If you still use these Python versions
today, you should seriously consider upgrading to a supported Python
version.
As far as the zhmccli package goes, you can still use versions up to
1.9.x on Python 2.7 and 3.5.

**Bug fixes:**

* Addressed safety issues up to 2024-02-11.

* Increased minimum version of 'prompt-toolkit' package to 3.0.13.

* Fixed missing 'CPC' argument in "zhmc cpc upgrade" command. (issue 487).

* Fixed that lpar ''--defined-capacity' option takes boolean argument.
(issue 534)

* Docs: Increased minimum Sphinx versions to 7.1.0 on Python 3.8 and to 7.2.0 on
Python >=3.9 and adjusted dependent package versions in order to fix a version
incompatibility between sphinxcontrib-applehelp and Sphinx.
Disabled Sphinx runs on Python <=3.7 in order to no longer having to deal
with older Sphinx versions. (issue 547)

* Fixed KeyError in "zhmc passwordrule characterrule list" command.
(issue 552)

* Fixed that the "zhmc user create --like ..." command passed the LDAP and MFA
related properties from the like user to the new user even for non-LDAP
and non-MFA users, which was rejected by the HMC. Fixed by omitting LDAP
related properties for non-LDAP users and MFA-related properties for non-MFA
users. In addition, omitted 'min-pw-change-time' for non-local users.
(issue 557)

* Fixed the call to pipdeptree in the test workflow to use 'python -m'
because otherwise it does not show the correct packages of the virtual env.
(issue 539)

**Enhancements:**

* Added support for Python 3.12. Had to increase the minimum versions of
setuptools to 66.1.0 and pip to 23.1.2 in order to address removal of the
long deprecated pkgutils.ImpImporter in Python 3.12, as well as the
minimum version of click-spinner to 0.1.10, as well as several
packages used only for development. (issue 497)

* Help: The options in the help for partition, lpar, and user create/update
commands have been grouped to be more easily identifiable. This required
adding the "click-option-group" Python package to the dependencies.

* Increased minimum zhmcclient version to 1.13.4 to pick up fixes and
functionality. (issues 510, 528)

* Tests: Added an environment variable TESTLOG to enable logging for end2end
tests. (issue 414)

* Added command group 'resetprofile' for operations on reset activation
profiles in classic mode CPCs.

* Added command group 'imageprofile' for operations on image activation
profiles in classic mode CPCs.

* Added command group 'loadprofile' for operations on load activation
profiles in classic mode CPCs.

* Added most of the remaining missing options to the "zhmc lpar update" command.

* Fixed an error in the "zhmc lpar update" command when updating the
zAware and SSC master passwords.

* Added support for retrievel of firmware from an FTP server to the
'cpc/console upgrade' commands. (issue 518)

* Added support for the remaining zAware and SSC related properties for the
commands:

- lpar update
- imageprofile create
- imageprofile update

* Added support for the 'fenced-book-list' properts in the 'resetprofile
create' command.

* Test: Added Python 3.8 with latest package levels to normal tests because
that is now the minimum version to run Sphinx. (related to issue 547)

* Added support for Lpar start command (issue 500)

* Added support for user patterns with a new 'zhmc userpattern' command group.
(issue 550)

* Added support for installation of single firmware updates on the SE with a
new 'zhmc cpc install-firmware' command. (issue 528)

* Added support for deletion of uninstalled firmware updates from the SE with a
new 'zhmc cpc delete-uninstalled-firmware' command. (issue 528)

* Added support for listing firmware levels of SE/CPC and HMC with new
commands 'zhmc cpc list-firmware' and 'zzhmc console list-firmware'.
(issue 564)

* Added support for showing/adding/removing crypto adapters and domains on
partitions with new commands 'zhmc partition show/add/remove-crypto'.
(issue 105)

* Added support for showing crypto configuration of partitions using a specific
crypto adapter with a new command 'zhmc adapter show-crypto'.
(issue 105)

* Added support for zeroizing crypto domains with a new
command 'zhmc partition zeroize-crypto'. (issue 502)

* Fail partition/lpar list commands if the specified CPC does not exist.
(issue 514)

* Added support for a new make target 'authors' that generates an AUTHORS.md
file from the git commit history. Added the invocation of 'make authors' to
the description of how to release a version in the development
documentation. (issue 541)

**Cleanup:**

* Fixed copyright statements (issue 542)

* Increased versions of GitHub Actions plugins to increase node.js runtime
to version 20.

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

This version contains all fixes up to version 1.8.1.

Released: 2023-10-13

**Incompatible changes:**

* Installation of this package using "setup.py" is no longer supported.
Use "pip" instead.

**Bug fixes:**

* Fixed TypeError in ldap show/delete/update commands. (issue 460)

* Fixed safety issues from 2023-08-27.

* Test: Circumvented a pip-check-reqs issue by excluding its version 2.5.0.

**Enhancements:**

* Test: Changed end2end tests to contribute coverage results to same data as
unit/function tests.

* Added the 'state' and 'physical-channel-status' properties to the output
of the "adapter list" command. Removed the redundant 'adapter-family' property
from the output. (issue 472)

* Added 'short-name' and 'reserved-resources' (only when usage options are used)
columns to the output of the 'partition list' command. (issue 468)

* Added 'description' column to the output of all list commands. (issue 468)

* Added support for missing property options for the 'partition create'
and 'partition update' commands. These commands now support options for
all properties of z16 HMCs.

* Added logging to a file as an additional log destination for the --log-dest
option (issue 415)

**Cleanup:**

* Dev: Increased minimum versins of some development packages and fixed
Makefile dependencies.

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

This version contains all fixes up to version 1.7.1.

Released: 2023-08-04

**Bug fixes:**

* Fixed automatic logoff: If a command (other than 'session create') creates a
new HMC session, the session is automatically deleted again at the end of the
command. (issue 421)

* Circumvented the removal of Python 2.7 from the Github Actions plugin
setup-python, by using the Docker container python:2.7.18-buster instead.

* Addressed safety issues from 6+7/2023, by increasing 'requests' to 2.31.0
on Python >=3.7, and by increasing other packages only needed for development.

* Increased minimum zhmcclient version to 1.9.1 to pick up fixes for
'console restart' and PyYAML install issue.

* Excluded certain PyYAML package versions to address the package install error
that happens due to the recently released Cython 3 when PyYAML has to build
its wheel archive during install.

**Enhancements:**

* Improved the end2end test cases for session management.

* Increased the minimum version of zhmcclient to 1.8.1 to pick up improvements
for session management.

* Added a 'zhmc console restart' command which restarts the targeted HMC.
Options are to force users, and to wait for restart with a timeout.

* Added support for upgrading HMC firmware to the 'zhmc console' command group
and for upgrading the SE firmware to the 'zhmc cpc' command group with
a new command 'upgrade'. Increased minimum zhmcclient version to 1.10.0.
(issue 440)

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

This version contains all fixes up to version 1.6.1.

Released: 2023-05-16

**Bug fixes:**

* Changed versions of packages used by zhmc:

- Increased zhmcclient to 1.8.0 to pick up fixes and functionality
- Increased jsonschema to 3.0.1, urllib3 to 1.26.5, requests to 2.25.0,
all for consistency with zhmcclient.

* Test: Fixed test_info.py test that broke with new urllib3 version 2.0.2.

* Fixed RTD docs build issue with OpenSSL by adding RTD config file that
specifies Ubuntu 22.04 for the OS.

* Fixed the incorrect representation of string values as floating point numbers
in the table output formats. (issue 391)

* Removed the option '--crypto-number' from the 'zhmc adapter update' command.
This is not an incompatible change, since it is not possible to change the
the crypto number of a Crypto Express adapter. (part of issue 108)

**Enhancements:**

* Added 'zhmc unmanaged_cpc' command group for dealing with unmanaged CPCs.

* Added support for changing the crypto type of Crypto Express adapters
and the type of FICON Express adapters to the 'zhmc adapter update'
command. (issue 108)

* Added a troubleshooting section to the docs.

* Added a hidden '--pdb' general option for having the zhmc command break right
before the invocation of the command. This can be used for debugging,
particularly in end2end tests.

* Added 'zhmc ldap' command group for managing LDAP server definitions.
(issue 393)

* Added initial support for end2end tests. For details, see the new
"Running end2end tests" section in the documentation.
A first end2end testcase for the 'zhmc session' command has been added.

* Added new commands to assign/unassign certificates to/from DPM partitions
and classic mode LPARs.

* Added new top level command group 'certificate'.

* Added two new commands 'console list-api-features' and 'cpc list-api-features'
to support the new "API features" concept.