^^^^^^^^^^^^^
This version contains all fixes up to version 1.7.3.
Released: 2023-05-16
**Incompatible changes:**
* The default value for the 'full_properties' parameter of the 'list()' method
of some zhmcclient resource types (Console, LDAPServerDefinition,
PasswordRule, User, UserPattern, UserRole, Task) has been changed from 'True'
to 'False' in order to improve performance. This change also affects the
set of properties of resources returned by 'find()' and 'findall()'.
In many cases, this is not an incompatible change since property access by
methods such as 'get_property()' or 'prop()' causes resource property
retrieval under the covers if the full set of properties had not been
retrieved in 'list()'.
However, there are also cases where this change is incompatible, for example
when accessing the resource properties via the 'properties' property. In such
cases, you need to change the call to 'list()' by specifying
'full_properties=True'. In cases where you had used 'find()' or 'findall()',
that parameter cannot be specified, and you need to fall back to using
'list()'.
**Bug fixes:**
* Addressed safety issues by increasing minimum versions of packages, where
possible.
* Changed use of 'method_whitelist' in urllib3.Retry to 'allowed_methods'.
The old method was deprecated in urllib3 1.26.0 and removed in 2.0.0.
Related to that, increased the minimum versions of urllib3 to 1.26.5 and of
requests to 2.25.0. Added urllib3 to the dependencies for installing zhmcclient,
because the indirect depndency of requests is not sufficient. (issue 1145)
* Fixed RTD docs build issue with OpenSSL version by providing a .readthedocs.yaml
file that specifies Ubuntu 22.04 as the build OS.
* Added trouble shooting info for urllib3 2.0 ImportError requiring
OpenSSL 1.1.1+.
* Increased dependent package jsonschema to >=3.0.1 to resolve dependency
issue with jupyter. (issue 1165)
**Enhancements:**
* Disabled the default retrieval of the full set of properties in list()
methods that was enabled by default, for the following resource types:
Console, LDAPServerDefinition, PasswordRule, User, UserPattern, UserRole,
Task. This provides a performance boost in cases where find() or findall()
is used with filters that can be handled by the HMC, because in such cases
the resource properties do not need to be retrieved.
* Added a 'pull_properties()' method to zhmcclient resource classes, that
performs a "Get Properties" HMC operation with the 'properties' query
parameter defined. This can be used to speed up certain property retrieval
operations, for example on the Console or on CPCs. (issue 862)
* Added a 'list_sibling_adapters()' method to the zhmcclient.Adapter class
that lists the other Adapter objects on the same physical adapter card.
Added end2end testcases for the new method.
* Test: Added end2end testcases for property retrieval.
* Added zhmcclient.GroupManager and zhmcclient.Group to support Group resources.
Group resources represent user-defined groups of resources; they can be used
for example in User Role permissions. Added zhmcclient mock support for
Group resources. Added testcases for both of that. (issue 1017)
* Enhanced export_dpm_configuration() to include Certificate objects.
* Introduced Certificate objects as new category of resources and added new
methods to assign/unassign Certificate objects to/from DPM mode partitions and
classic mode LPARs and activation profiles.
* Added two new methods Console.list_api_features() and
Cpc.list_api_features() and accompanying documentation to support the
new "API features" concept.
**Cleanup:**
* So far, the `Partition.hbas` property was set to `None` for CPCs that have the
"dpm-storage-management" feature enabled (i.e. starting with z14), because
HBAs are then represented as Virtual Storage Resource objects. For
consistency, this property was changed to provide an `HbaManager` object.
Since that property uses lazy initialization, there is no change at runtime
unless the property is actually accessed.