Summary of API version updates

• Added the properties=common query parameter to the Get Virtual Server Properties operation.
• Added the virtual-server-common category and power-vm-virtual-server-common, prsm-virtual-server-common, x-hyp-virtual-server-common and zvm-virtual-server-common classes to the Get Inventory operation.

• Added the Mount Virtual Media Image operation.
• Increased API version number from 1.1 to 1.2.

• Increased API version number from 1.2 to 1.3.
• Added the power-saving-state property to the BladeCenter and Blade objects data models, and added the cpc-power-saving-state and zcpc-power-saving-state properties to the CPC object data model.
• Added "not-supported" as a possible enumeration value for the power-save-allowed and power-cap-allowed properties of BladeCenter and Blade objects, and added "not-supported" as a possible enumeration value of the cpc-power-save-allowed, cpc-power-cap-allowed, zcpc-power-save-allowed and zcpc-power-cap-allowed properties of the CPC object.
• Added the status (read-only), acceptable-status (writable), perf-status (read-only) and compliant-perf-status (writable) properties to the Workload Resource Group object data model.
• Added most-severe-perf-status and perf-status-data-points fields, and related perf-status-data-point nested object to the response from the Generate Workload Resource Groups Report operation.
• Added the perf-policies property to the Virtual Server object data model, and also added related virtual server performance policy nested object.
• Added "data-retrieval-error" as a possible enumeration value for the status-detailed field in the response for the Generate Load Balancing Report operation.
• Added an optional request body containing an optional force input field to the Unmount Virtual Media operation.
• Changed the Create Virtual Server operation for a zVM virtual server to require the password field on input rather than allowing it to be optional. This change has been made to improve security.
• Added HTTP status code 409 (Conflict) as a possible error response reported by the following Storage Management operations:
  • Import Storage Access List
  • Create Virtualization Host Storage Resource
  • Delete Virtualization Host Storage Resource
  • Add Virtualization Host Storage Resource Paths
  • Remove Virtualization Host Storage Resource Paths
  • Discover Virtualization Host Storage Resources.

The following extensions are provided by the HMC Web Services API for HMCs at version 2.12.0, but apply only to CPCs with SE version 2.12.0:

• Added cp-cpu-consumption-percent, ifl-cpu-consumption-percent and other-cpu-consumption-percent fields to the response from the Generate Hypervisor Report operation for zVM virtualization hosts. These new fields are provided for zVM virtualization hosts running at version 6.2 or greater.
• Added the following in support of IBM® zAware partitions. These changes apply only for partitions of the new "zaware" type:
  • Added "zaware" as a possible value of the activation-mode property of Logical Partition and Image Activation Profile objects.
  • Added the zaware-network, network-ip-info and ip-info nested objects as common nested object definitions used for new properties of Logical Partition objects.
  • Added the zaware-host-name, zaware-master-userid, zaware-master-pw, zaware-network-info, zaware-gateway-info and zaware-dns-info properties to the Logical Partition and Image Activation Profile object data models.
  • Added HTTP status 400 reason code 306 as a possible error response from the Load Logical Partition, PSW Restart, Start Logical Partition, Stop Logical Partition, and Update Image Activation Profile Properties operations when these operations are attempted on an IBM zAware partition.
• Added the Cryptos and Flash Memory Adapters metric groups for CPC objects. Data entries are provided for a CPC in these metric groups if the CPC has one or more Cryptos or Flash Memory Adapters installed.
• Added new cp-cpu-time, ifl-cpu-time, zaap-cpu-time, ziip-cpu-time and icf-cpu-time metrics to the Virtualization Host CPU and Memory metric group (for zVM virtualization hosts).

• Increased API version number from 1.3 to 1.4.
• Added the Get Network Adapter Properties operation for Virtual Server objects.
• Added the List Virtualization Host Storage Resources of a Storage Resource operation for Storage Resource objects.
• Added the List Virtual Disks of a Virtualization Host Storage Resource operation for Virtualization Host objects.
• Added API support for absolute capping to the Logical Partition and Image Activation Profile objects, including the following API extensions:
  • Added the absolute-processing-capping, absolute-aap-capping, absolute-ifl-capping, absolute-ziip-capping and absolute-cf-capping properties to the data model for Logical Partition objects.
  • Added the absolute-general-purpose-capping, absolute-aap-capping, absolute-ifl-capping, absolute-ziip-capping and absolute-icf-capping properties to the data model for Image Activation Profile elements of CPC objects.
• Added the partition-identifier property to the data model for Logical Partition objects.

The following extensions are provided by the HMC Web Services API for HMCs at version 2.12.1 or later, but primarily apply only to CPCs with SE version 2.12.1 or later:

• Added support for management of processor performance for virtual servers on x-hyp virtualization hosts, comprising the following API extensions:
  • Added the cpu-perf-mgmt-enabled-x-hyp property to the data model for Ensemble objects.
  • Added the cpu-shares-supported property to the data model for Virtualization Host objects.
  • Extended the existing cpu-perf-mgmt-enabled, initial-shares, minimum-shares and maximum-shares properties of Virtual Server objects to now also be applicable to virtual servers of type x-hyp.
  • Added the workload-processor-mgmt-status, workload-processor-mgmt-status-reason, initial-shares, shares, min-shares, and max-shares fields to the response for the Generate Hypervisor Report operation of Ensemble objects. when issued for x-hyp virtualization hosts. These fields were previously provided for PowerVM and/or z/VM® virtualization hosts but not for x-hyp virtualization hosts
• Added support for ensemble availability management, comprising the following API extensions:
  • Added the workload-element-groups, active-avail-policy, default-avail-policy, custom-avail-policies, avail-status, and compliant-avail-status properties and related nested objects to the data model for Workload Resource Group objects.
  • Added the Availability Policy element of a Workload Resource Group and corresponding operations for elements of this class, including List, Create, Delete, Get Properties, Update Properties and Activate operations for Availability Policy elements of Workload Resource Group objects.
  • Added the Workload Element Group object and corresponding operations on objects of this class, including List, Create, Delete, Get Properties and Update Properties operations for Workload Element Group objects.
  • Added Add To and Remove From operations for managing the inclusion of Workload Element Groups within Workload Resource Group objects.
  • Added List, Add To and Remove From operations for managing the inclusion of Virtual Servers within Workload Element Group objects.
  • Added reporting operations for availability management, including the Generate Workload Resource Groups Report (Ensemble Availability Management), Generate Workload Resource Group Availability Status Report, Generate Virtual Server Report (Ensemble Availability Management), and Generate Availability Status Report operations.
  • Added an enumeration value of "workload-element-group" as a possible value of the inclusion-type field in the response for the List Virtual Servers of a Workload Resource Group operation, to specify the additional way in which virtual servers can become members of a Workload Resource Group.
  • Added the avail-status, acceptable-avail-status, avail-policies and workload-element-group properties and related nested objects to the data model for Virtual Server objects.
• Added the heat-load, heat-load-forced-air and heat-load-water metrics to the zCPC Environmentals and Power metric group.
• Added RoCE Adapters and Ensemble Power Metric groups.

• Increased API version number from 1.4 to 1.5.
• Added the enumeration value "virtual-server-shutdown-timeout-override-support" as a possible feature identifier included in the feature-list property of the Virtualization Host object to indicate the availability of this new capability to virtual servers hosted on a Virtualization Host instance.
• Added the shutdown-timeout-source and shutdown-timeout properties to the data model of the Virtual Server object to allow a customized default shutdown timeout to be configured for a particular virtual server.
• Added the shutdown-timeout field as an optional request body field for the Deactivate Virtual Server operation to allow an individual deactivation action to be performed using a shutdown timeout that is different than the timeout configured as a default for the virtual server or its hosting virtualization host.

• The renaming of the zaci-host-name, zaci-master-userid, zaci-master-pw, zaci-network-info, and zaci-gateway-info Logical Partition object properties to ssc-host-name, ssc-master-userid, ssc-master-pw, ssc-network-info, and ssc-gateway-info, respectively.
• The change of the "zaci" enum value for the Logical Partition object's activation-mode property to "ssc".
• The renaming of the  zaci-host-name, zaci-master-userid, zaci-master-pw, zaci-network-info, zaci-gateway-info and zaci-boot-selection Image Activation Profile object properties to ssc-host-name, ssc-master-userid, ssc-master-pw, ssc-network-info, ssc-gateway-info, and ssc-boot-selection, respectively.
• The change of the "zaci" enum value for the Image Activation Profile object's operating-mode property to "ssc".

• Increased API version number from 2.1 to 2.2.
• Added the String/Hostname data type.
• Provided a more granular value for the sysplex-name property of the Logical Partition to differentiate when the z/OS® logical partition is not in a sysplex.

• Increased API version number from 2.2 to 2.3.
• Removed the write qualifier from the crypto-number property of the Adapter object. This property was never in fact writable.
• Corrected the default behavior of the Import DPM Configuration operation to assign new object IDs, element IDs and WWPNs to import object so as to avoid the possibility of introducing objects with duplicate IDs and WWPNs. Added the preserve-uris and preserve-wwpns fields to the request body for the Import DPM Configuration operation to override that behavior when appropriate.

• Increased API version number from 2.2 to 2.20.
• Added the following common request validation reason codes:
  • HTTP status 400 with reason codes 19 and 20
  • HTTP status 409 with reason code 11
• Added API support for the IBM HMC Mobile app, comprising the following API extensions:
  • Added the mobile-app-preferences property to the Console object data model.

  • Added the Get Mobile App Preferences and Set Mobile App Preferences operations for the Console object to manage the console-wide mobile app settings.

  • Added the Get CPC Notification Preferences for Device and Update CPC Notification Preferences for Device operations for the Console object to manage the mobile app notification preferences for a CPC to a mobile device.

  • Added the client-tag field to the request body for the Logon operation.
• Added API support to manage and interact with the console's multi-factor authentication support, comprising the following API extensions:
  • Added the multi-factor-authentication-required and force-shared-secret-key-change properties to the User object data model.
  • Added the multi-factor-authentication-required field to the request body for the Create User operation.
  • Added the multi-factor-authentication-code field to the request body for the Logon operation.
  • Added the shared-secret-key and session-credential fields to the response for the Logon operation.
  • New HTTP status 201 on the Logon operation.
  • New HTTP status 400 with reason codes 46, 47, 48 and 49 on the Logon operation.
  • Added the Establish Shared Secret Key operation.
  • Added the hmc-time field to the response for the Query API Version operation.
  • Expanded the authentication options when connecting to the API message broker; the session ID and session-specific credential are required for multi-factor authentication users.
• Relaxed the definition of a pseudo property to no longer require a pseudo property to also be a container property.
• Added the (c) data model qualifier to the connected-vnic-uris pseudo property of Virtual Switch objects to denote that it is a container property. Since psuedo properties were also container properties in previous versions of the API, this is a documentation-only change and not a behavioral change.

• Added API enhancements that allow quicker responses when fetching the properties of certain object types, comprising the following API extensions:
  • Added a properties query parameter to the following operations to allow an API client to avoid the overhead involved with fetching object properties in which it has no interest: Get CPC Properties, Get Logical Partition Properties.
  • Added a cached-acceptable query parameter to the following operations to allow an API client to indicate that cached (but potentially out-of-date) property values are acceptable: Get CPC Properties, Get Logical Partition Properties, Get Reset Activation Profile Properties, Get Image Activation Profile Properties, and Get Load Activation Profile Properties.
• Added the Delete Partition Asynchronously and Update Partition Properties Asynchronously operations for Partition objects.
• Added the fid property to the data model for Virtual Function elements of Partition objects.
• Made the mac-address property of NIC elements of Partition objects writable in certain cases.
• Added the vlan-type property to the data model for NIC elements of Partition objects.
• Relaxed the authorization requirements for access to Load Activation Profile objects through the List Load Activation Profiles and Get Load Activation Profile Properties operations to allow access without requiring CPC object-access permission under certain circumstances. This is consistent with existing HMC UI behavior.
• Relaxed the authorization requirements for access to Image Activation Profile objects through the List Image Activation Profiles and Get Image Activation Profile Properties operations to allow access without requiring CPC object-access permission under certain circumstances. This is consistent with existing HMC UI behavior.
• Added synchronous interfaces for retrieving operating system messages, comprising the following API extensions:
  • Added the List OS Messages of a Partition operation for Partition objects.
  • Added the List OS Messages of a Logical Partition operation for Logical Partition objects.
• Added the sequence-number field to the os-message-info object in operating system message notifications.
• Added support for more efficient access to certain Partition and Logical Partition information, comprising the following API extensions:
  • Added the List Permitted Partitions operation.
  • Added the List Permitted Logical Partitions operation.
• Added the has-unacceptable-status, dpm-enabled and se-version properties to the response for the List CPC Objects operation.
• Added the classification-text field to the response for the Query API Version operation.
• Added the last-used-iocds property to the CPC object data model.
• Added the last-used-load-address and last-used-load-parameter properties to the Logical Partition object data model.
• Relaxed the requirements on the boot-iso-image-name property of Partition objects and documented the requirements in the Partition object data model. This affects the Mount ISO Image operation for Partition objects.
• Corrected the documentation for the Create Partition operation; several fields were missing from the request body definition.
• Added the following as a possible enumeration value for the detected-card-type property of an Adapter object: "roce-express-2".

• Added support for IBM Virtual Flash Memory, comprising the following API extensions:
  • Added the storage-vfm-increment-size and storage-vfm-total properties to the CPC object data model.
  • Added the initial-vfm-storage, maximum-vfm-storage and current-vfm-storage properties to the Logical Partition object data model.
  • Added the initial-vfm-storage and maximum-vfm-storage properties to the Image Activation Profile object data model.
• Added the port property to the ssc-network nested object definition used by the Logical Partition and Image Activation Profile data models.
• Extended the set of characters permitted in a load parameter, comprising the following API extensions:
  • Allow the following three additional characters (@, $, #) in the load-parameter field of the request body for the Load Logical Partition, SCSI Load, and SCSI Dump operations.
  • Allow the following three additional characters (@, $, #) in the ipl-parameter property in the Image Activation Profile and Load Activation Profile data models.
• Removed support for controlling whether a Logical Partition entering a wait state causes termination of a time slice:
  • The does-wait-state-end-time-slice property of the CPC object is no longer directly writable through the API. The (w) qualifier has been removed from that property in the data model for CPC objects and it is now a read-only property whose value is always false.
  • The end-timeslice-on-wait property of the Reset Activation Profile object is no longer directly writable through the API. The (w) qualifier has been removed from that property in the data model for Reset Activation Profile objects and it is now a read-only property whose value is always false.
  • New HTTP status 400 with reason code 19 on the Update CPC Properties and Update Reset Activation Profile Properties operations.
• Replaced the "esa390" and "esa390-tpf" logical partition activation modes with the new "general" activation mode, comprising the following API changes:
  • Added the enumeration value "general" as a possible value for the activation-mode property of a Logical Partition object.
  • Added the enumeration value "general" as a possible value for the operating-mode property of an Image Activation Profile object.
• Due to the removal of support for dynamic changes to the SSC configuration, the SSC-related properties of the Logical Partition object are no longer directly writable through the API. The (w) qualifier has been removed from those properties in the data model for Logical Partition objects and they are now read-only properties. The affected properties are ssc-host-name, ssc-master-userid, ssc-master-pw, ssc-network-info, ssc-gateway-info and ssc-dns-info.
• Added the ssc-gateway-ipv6-info property to the Image Activation Profile object data model.
• Added the last-energy-advice-time property to the CPC object data model (applicable to SE version 2.13.1 or later).

• Increased API version number from 2.20 to 2.21.
• Added the following as possible enumeration values for the detected-card-type property of the Adapter objects: "osa-express-6s-1gb", "osa-express-6s-10gb", "osa-express-6s-1000base-t", "crypto-express-6s", "ficon-express-16s", and "ficon-express-16s-plus".
• Added more granular controls over which OS message notifications are presented to a mobile device, comprising the following API extensions:
  • Added the new-os-message-filtered field to the response for the Get CPC Notification Preferences for Device operation.
  • Added the new-os-message-filtered field to the request body for the Update CPC Notification Preferences for Device operation.

• Increased API version number from 2.21 to 2.22.
• Added API support for accessing the ASCII console of partitions of DPM-enabled CPCs through WebSockets, comprising the following API extension:
  • Added the Get ASCII Console WebSocket URI operation for Partition objects.

• Increased API version number from 2.22 to 2.23.
• Added the following common request validation reason codes:
  • HTTP status 409 with reason codes 12 and 13
• Added support for object-specific firmware features, comprising the following API extensions:
  • Added the available-features-list property to the CPC object data model.
  • Added the available-features-list property to the Partition object data model.
• Added enumeration values for classes of managed objects within User Role objects, due to new managed object types added to this HMC version.
• Added enumeration values for the name property of User Role objects, due to new system-defined user roles added to this HMC version.
• Added enumeration values for the name property of Task objects, due to new tasks added to this HMC version.
• Removed enumeration values for the name property of Task objects for tasks that are not provided in this HMC version.
• Changed the descriptive name of some classes of managed objects. Those descriptive names are not part of the programming API. The enumeration values for the managed object classes are part of the programming API and are not changed.
• Changed the descriptive name of some tasks. Those descriptive names are not part of the programming API. The enumeration values for the name property of the corresponding Task objects are part of the programming API and are not changed.

• Added support for managing a FICON® configuration for DPM-enabled CPCs and their Partitions, comprising the following API extensions (The majority of these extensions are only available if the dpm-storage-management feature is enabled on the CPC or Partition of interest):
  • Added the Storage Site object, representing a single storage site in a FICON configuration, and corresponding operations on objects of this class, including List, Create, Delete, Get Properties, Update Properties for Storage Site objects.
  • Added the Storage Fabric object, representing a single storage fabric in a FICON configuration, and corresponding operations on objects of this class, including List, Create, Delete, Get Properties, Update Properties for Storage Fabric objects.
  • Added the Storage Switch object, representing a single storage switch in a FICON configuration, and corresponding operations on objects of this class, including List, Define, Undefine, Get Properties, Update Properties, Move Storage Switch to Storage Site and Move Storage Switch to Storage Fabric for Storage Switch objects.
  • Added the Storage Subsystem object, representing a single storage subsystem in a FICON configuration, and corresponding operations on objects of this class, including List, Define, Undefine, Get Properties, Update Properties, Move Storage Subsystem to Storage Site, Add Connection Endpoint and Remove Connection Endpoint for Storage Subsystem objects.
  • Added the Storage Control Unit object, representing a single storage control unit in a FICON configuration, and corresponding operations on objects of this class, including List, Define, Undefine, Get Properties, Update Properties, Add Volume Range, Remove Volume Range for Storage Control Unit objects.
  • Added the Storage Path element of a Storage Control Unit and corresponding operations on elements of this class, including Create, Delete, Get Properties and Update Properties for Storage Path elements of Storage Control Unit objects.
  • Added the Storage Group object, representing a single storage group in a FICON configuration, and corresponding operations on objects of this class, including List, Create, Delete, Get Properties, Modify Storage Group Properties, Add Candidate Adapter Ports to an FCP Storage Group, Remove Candidate Adapter Ports from an FCP Storage Group, Get Partitions for a Storage Group and Validate LUN Path for Storage Group objects.
  • Added the Storage Volume element of a Storage Group object and corresponding operations on elements of this class, including List, Get Properties, Fulfill FICON Storage Volume, and Fulfill FCP Storage Volume for Storage Volume elements of Storage Group objects.
  • Added the Virtual Storage Resource element of a Storage Group object and corresponding operations on elements of this class, including List, Get Properties, and Update Properties for Virtual Storage Resource elements of Storage Group objects.
  • Added the Start Dump Program, Attach Storage Group to Partition, and Detach Storage Group from Partition operations for Partition objects.
  • Added the enumeration value "storage-volume" as a possible value for the boot-device property in the Partition object data model.
  • Added the boot-storage-volume and boot-load-parameters properties to the Partition object data model.

• (cont'd)
  • New HTTP status 409 with reason codes 119, 120, 121 and 122 on the Update Partition Properties operation.
  • New HTTP status 409 with reason code 122 on the Start Partition operation.
  • New HTTP status 409 with reason code 12 on the following operations when the dpm-storage-management feature is enabled on the targeted CPC: Export WWPN List, Dump Partition and Create HBA.
  • Added the enumeration values "fc" and "not-configured" as possible values for the type field in the Adapter object data model.
  • Added the connection-endpoint-uri and connection-endpoint-class properties to the data model for Storage Port elements of Adapter objects.
  • Added the Change Adapter Type operation for Partition objects.
  • Added the enumeration values "storage-site", "storage-fabric", "storage-switch", "storage-subsystem", "storage-control-unit", and "storage-group" as possible object class values for the Inventory Service.
• Added support for Container Based Processors, comprising the following API extensions:
  • Added new cpb-shared-processor-usage, cpb-dedicated-processor-usage, and cpb-all-processor-usage metrics to the CPC overview metric group.
  • Added new cpb-processor-usage metric to the Logical partitions metric group.
  • Added "cbp" as a possible value for the processor-type metric in the zCPC processors metric group.
  • Added the processor-count-cbp and processor-count-pending-cbp properties to the CPC object data model.
  • Added the initial-cbp-processing-weight, initial-cbp-processing-weight-capped, minimum-cbp-processing-weight, maximum-cbp-processing-weight, current-cbp-processing-weight, current-cbp-processing-weight-capped, and absolute-cbp-capping properties to the Logical Partition object data model.
  • Added the initial-cbp-processing-weight, initial-cbp-processing-weight-capped, minimum-cbp-processing-weight, maximum-cbp-processing-weight, absolute-cbp-capping, number-dedicated-cbp-processors, number-reserved-dedicated-cbp-processors, number-shared-cbp-processors, and number-reserved-shared-cbp-processors properties to the Image Activation Profile object data model.
  • Added the absolute-cbp-capping and effective-absolute-cbp-capping properties to the Group Profile object data model.
  • Added the enumeration value "cbp" as a possible value for the type field in the Capacity Record object data model.
  • Added the enumeration value "cbp" as a possible value for the processor-type field in the request body for the Add Temporary Capacity and Remove Temporary Capacity operations.

• Increased API version number from 2.23 to 2.24.
• Added the vendor field to the response for the Query API Version operation.
• Added the maximum-partitions property to the CPC object data model.

• Increased API version number from 2.24 to 2.25.
• Removed the write qualifier from the crypto-number property of the Adapter object. This property was never in fact writable.
• Added HTTP status 409 with reason code 496 on the Change Adapter Type operation.
• Corrected HTTP status 404 with reason code 2 to reason code 1 on the Undefine Storage Control Unit operation.
• Added HTTP status 409 with reason code 497 to the Create Storage Path and Update Storage Path Properties operations.
• Added enumeration value "unknown" as a possible value for the status field in the worldwide port name information nested object.
• Added HTTP status 409 with reason code 493 to the Create Storage Group, Delete Storage Group, and Modify Storage Group operations.
• Added object-access permission on the associated partition for Update Virtual Storage Resource Properties operations that update the adapter-port-uri or device-number properties.
• Added HTTP status 403 with reason code 420 to the Update Virtual Storage Resource Properties operation.
• Added HTTP status 409 with reason code 498 to the Update Virtual Storage Resource Properties operation.

• Increased API version number to 2.35.
• Added support to delete operating system messages, comprising the following API extensions:
  • Added the Delete Partition OS Message operation for Partition objects.
  • Added the Delete Logical Partition OS Message operation for Logical Partition objects.
• Added the last-used-world-wide port-name, last-used-logical-unit-number, last-used-disk-partition-id, last-used-operating-system-specific-load-parameters and last-used-boot-record-logical-block-address properties to the Logical Partition object data model.
• Added the se-version field to the response for the List Permitted Partitions and List Permitted Logical Partitions operations.
• Added more detailed information about hardware messages, comprising the following API extensions:
  • Added the details property to the data model for Hardware Message elements of the Console object.
  • Added the details property to the data model for Hardware Message elements of the CPC object.
  • Added the details property to the data model for Hardware Message elements of the zBX (Node) object.
• Added request aggregation services which allow what would otherwise be multiple API requests to be submitted as a single request, with their multiple results likewise returned in a single response, comprising the following API extension:
  • Added the Submit Requests operation.
• Added the enumeration value "storage-template" as a possible object class value for the Inventory Service.
• New HTTP status 400 with reason code 453 on the Modify Storage Group operation.
• New HTTP status 400 with reason code 452 on the Update Virtual Storage Resource Properties operation.
• New HTTP status 400 with reason code 453 on the Create Storage Group operation.
• New HTTP status 409 with reason code 478 on the Create Storage Group operation.
• Due to the removal of CIM actions from the HMC, the authorization requirements for some operations have changed. The affected operations are Import Profiles, Export Profiles, Add Temporary Capacity and Remove Temporary Capacity operations for CPC objects.
• Added enumeration values for classes of managed objects within User Role objects, due to new managed object types added to this HMC version.
• Added several enumeration values for the name property of Task objects, due to new tasks added to this HMC version.
• Changed the descriptive name of some tasks. Those descriptive names are not part of the programming API. The enumeration values for the name property of the corresponding Task objects are part of the programming API and are not changed.
• Added the following as possible enumeration values for the detected-card-type property of an Adapter object: "osa-express-7s-25gb", "roce-express-2-25gb", and "fcp-express-32s".
• Added Change Object Options task permission for Update Logical Partition Properties operations that update the next-activation-profile-name property.

• Added the Accept Mismatched FCP Storage Volumes and Reject Mismatched FCP Storage Volumes operations for Storage Group objects.
• Added the Zeroize Crypto Domain operation for Partition objects.
• Added support for not clearing memory before loading a Logical Partition from a SCSI device, comprising the following API extensions:
  • Added the clear-indicator field to the request body for the SCSI Load operation for Logical Partition objects.
  • Allow the clear-indicator property of the Load Activation Profile to be set to false for SCSI loads.
• Added support for storage group templates for DPM-enabled CPCs to facilitate the creation of storage groups with certain initial property values, comprising the following API extensions:
  • Added the Storage Template object, representing a single storage template, and corresponding operations on objects of this class, including List, Create, Delete, Get Properties and Modify Properties for Storage Template objects.
  • Added the Storage Template Volume element of a Storage Template object and corresponding operations on elements of this class, including List and Get Properties for Storage Template Volume elements of Storage Template objects.
  • Added the template-uri field in the request body for the Create Storage Group operation.
  • Changed the adapter-port-uri property of the Virtual Storage Resource element object from a read-only property to a writable property.

• Increased API version number from 2.35 to 2.36.
• Removed the write qualifier from the crypto-number property of the Adapter object. This property was never in fact writable.
• Added HTTP status 409 with reason code 496 to the Change Adapter Type operation.
• Corrected HTTP status 404 with reason code 2 to reason code 1 on the Undefine Storage Control Unit operation.
• Added HTTP status 409 with reason code 497 to the Create Storage Path and Update Storage Path operations.
• Added enumeration value "unknown" as a possible value for the status field in the worldwide port name information nested object.
• Added HTTP status 409 with reason code 493 to the Create Storage Group, Delete Storage Group, and Modify Storage Group operations.
• Added object access permission on the associated partition for Update Virtual Storage Resource Properties operations that update the adapter-port-uri or device-number properties.
• Added HTTP status 403 with reason code 450 to the Update Virtual Storage Resource Properties operation.
• Added HTTP status 409 with reason code 498 to the Update Virtual Storage Resource Properties operation.
• Added HTTP status 400 with reason code 451 to the Reject Mismatched FCP Storage Volumes operation.

• Increased API version number from 2.36 to 2.37
• Added Start FCP Storage Discovery, Get Connection Report, and Get Storage Group Histories operations for Storage Group objects
• Added a new field, paths to the Storage Volume element object's Data Model.

• Increased API version number from 2.37 to 2.38
• Added Worldwide Port Name information nested object to the Virtual Storage Resource element object.
• Added "incomplete" status to the list of WWPN status values in Table 2.
• Added object access permission on the referenced storage adapter for Update Storage Path Properties operations that update the adapter-port-uri property.
• Added HTTP status 404 with reason code 442 to the Create Storage Path operation.
• Added HTTP status 409 with reason code 441 to the Update Storage Port Properties, Define Storage Switch, Create Storage Group, Add Candidate Adapter Ports to an FCP Storage Group, Fulfill FICON Storage Volume, Fulfill FCP Storage Volume, Update Virtual Storage Resource Properties, and Validate LUN Path operations.
• Added HTTP status 409 with reason code 457 to the Add Connection Endpoint operation.
• Added HTTP status 409 with reason code 499 to the Modify Storage Group Properties operation.

• Increased API version number from 2.38 to 2.39.
• Added API support for fulfilling multiple FICON storage volumes with a single request, comprising the following API extension:
  • Added the Fulfill FICON Storage Volumes operation to the Storage Group object.

• Increased API version number to 2.40.
• Corrected the handling of the properties query parameter of the Get CPC Properties and Get Logical Partition Properties operations to no longer return HTTP status 400 for properties the HMC supports but the target CPC or Logical Partition does not support. Such properties are simply omitted from the response.

• Increased API version number to 3.1. Note that the change in the major portion of the version number indicates that this version is not compatible with the previous version. The vast majority of the incompatibilities are due to the removal of zManager's support for IBM z BladeCenter Extension (zBX), the blades of a zBX, alternate HMC, Ensembles, and related components. More detailed information is provided below.
• Removed support for IBM z BladeCenter Extension (zBX), the blades of a zBX, alternate HMC, Ensembles, and related components. The majority of that support is described in Part 4: "Ensemble and zBX management" of the Hardware Management Console Web Services API, SC27-2637. The changes are:
  • Removed support for the following managed object and element object classes and types. This includes removal of all operations, inventory classes, inventory categories, and metric groups related to these object classes and types.
    • ensemble
    • node
    • zbx
    • top-of-rack-switch
    • rack
    • bladecenter
    • blade
    • virtualization-host
    • virtual-switch
    • virtual-server
    • storage-resource
    • virtualization-host-storage-resource
    • virtualization-host-storage-group
    • network adapter of a virtual server
    • virtual disk
    • performance policy
    • availability policy
  • Removed all operations described in Part 4: "Ensemble and zBX management" of the Hardware Management Console Web Services API, SC27-2637. As that is a considerable number of operations, they are not listed here.
  • Removed the following inventory categories and all classes contained therein from the Inventory Service:
    • zvm-resources
    • power-vm-resourses
    • x-hyp-resources
    • prsm-resources
    • virtual-server-common
    • zbx-resources
    • ensemble-wide-resources

• (cont'd.)
  • Removed the following metric groups from the Metrics Service:
    • BladeCenter temperature and power metric group
    • Blade power
    • zBX (Node) overview
    • Blade CPU and memory metric group
    • Ensemble power
    • Virtual server CPU and memory metrics group
    • Virtualization host CPU and memory metrics group
    • Workload service class data metrics group
    • Virtualization host (vSwitch) uplink metric group
    • Virtualization host (vSwitch) by virtual network metric group
    • Attached virtual server network adapters metric group
    • Optimizer IEDN virtual network interface metric group
    • Optimizer IEDN physical network adapter metric group
    • Top-of-rack switch ports metrics
    • ESM switch port metrics
  • Removed the following operations not previously described in the "Ensemble and zBX management" section:
    • Make Console Primary
    • List Ensemble CPC Objects
    • List Unmanaged zBX Nodes
  • Removed the following object properties:
    • Removed the paired-role, is-auto-switch-enabled, paired-hmc, and ip-swapping-available properties of the Console object
    • Removed is-ensemble-member and management-enablement-level properties of the CPC object
  • Removed several object types from those eligible for membership in pattern-matching groups. The following are no longer valid enumeration values for the types property of a Group object:
    • "zvm-virtual-machines"
    • "blade-center"
    • "data-power-xi50z-blades"
    • "ibm-smart-analytics-optimizer-blades"
    • "power-blade"
    • "system-x-blade"
    • "power-vm-virtual-server"
    • "system-x-virtual-server"
    • "workload"
    • "defined-zbx-node"
    • "director-timer-console"
    • "ibm-fiber-saver"

• (cont'd.)
  • Removed several object types from those that can be permitted in user roles. The following are no longer valid enumeration values for the permitted-object property of a User Role object:
    • "alternate-console"
    • "blade-center"
    • "datapower-device"
    • "default-workload"
    • "eckd-storage-resource"
    • "ensemble"
    • "fcp-storage-resource"
    • "p-blade"
    • "p-virtual-server"
    • "undefined-zbx-node"
    • "virtual-network"
    • "workload-element-group"
    • "workload-resource-group"
    • "x-blade"
    • "x-virtual-server"
    • "zbx-node"
    • "zvm-fcp-storage-resource"
    • "zvm-virtual-machine"
  • Removed several system-defined User Roles. User Roles with the following enumeration values for the name property have been removed:
    • "hmc-bladecenter-objects"
    • "hmc-dpxi50z-blade-objects"
    • "hmc-ensemble-administrator-tasks"
    • "hmc-ensemble-object"
    • "hmc-ibm-blade-objects"
    • "hmc-ibm-blade-virtual-server-objects"
    • "hmc-policy-administrator-tasks"
    • "hmc-policy-operator-tasks"
    • "hmc-storage-resource-administrator-tasks"
    • "hmc-storage-resource-objects"
    • "hmc-virtual-network-administrator-tasks"
    • "hmc-virtual-network-objects"
    • "hmc-virtual-server-administrator-tasks"
    • "hmc-virtual-server-operator-tasks"
    • "hmc-workload-administrator-tasks"
    • "hmc-workload-objects"
    • "hmc-z-vm-virtual-machine-objects"
    • "hmc-z-vm-virtual-machine-tasks"
  • Removed all tasks related to zBX and Ensemble components. Enumeration values for the name property of those Task objects are not provided in this HMC version. As that is a considerable number of tasks, they are not listed here.

• (cont'd.)
• Added the Resend Request operation for Storage Group objects.
• Added the enumeration value "auto-created" as a possible value for the action field of a storage-group-action-info nested object related to Storage Group histories.
• Corrected HTTP status 404 with reason code 2 to be reason code 1 on the Undefine Storage Switch operation.
• Added support for more granular action permissions for the HMC Mobile app, comprising the following API extensions:
  • Added several new action settings properties, one for each action that supports the new granular permission settings, to the mobile-app-preferences nested object of the Console object. These settings are updated with the Set Mobile App Preferences and included in the response to the Get Mobile App Preferences operation.
  • New HTTP status 400 with reason code 337 and HTTP status 404 with reason code 2 on the Set Mobile App Preferences operation
  • Added the user-template-uri property to the User object data model
• Added the ability for an API client to request cancellation of the Start Partition, Stop Partition and Start CPC operations with the Cancel Job operation.

• Added detailed information about the processors in a logical partition, including the number of allocated and reserved processors of various types and whether they are dedicated or shared. Added the processor-usage, number-general-purpose-processors, number-reserved-general-purpose-processors, number-general-purpose-cores, number-reserved-general-purpose-cores, number-icf-processors, number-reserved-icf-processors, number-icf-cores, number-reserved-icf-cores, number-ifl-processors, number-reserved-ifl-processors, number-ifl-cores, number-reserved-ifl-cores, number-ziip-processors, number-reserved-ziip-processors, number-ziip-cores, and number-reserved-ziip-cores properties to the Logical Partition object data model.
• Added the ability to increase the number of allocated and reserved processor cores in a logical partition through the APIs, comprising the following API extensions:
  • Added writable properties containing the number of allocated or reserved cores for various processor types to the Logical Partition data model.
  • Add the authorization requirement of action/task permission for the Logical Processor Add task when increasing the number of allocated or reserved cores.
• Added support to control whether Elliptic Curve Cryptography (ECC) keys can be used for computing digital signatures, comprising the following API extensions:
  • Added the permit-ecc-key-import-functions property to the Image Activation Profile object data model
• Added support to determine whether System Recovery Boost is enabled for a logical partition, comprising the following API extensions:
  • Added the is-sub-capacity-boost-active property to the Logical Partition object data model
• Added support to determine whether zIIP Boost is enabled a logical partition, comprising the following API extensions:
  • Added the is-ziip-capacity-boost-active property to the Logical Partition object data model
  • Added the enumeration value "boost" as a possible value for the record-type property of a Capacity Record element of a CPC object.
  • Added the maximum-real-hours, maximum-test-hours, remaining-real-hours and remaining-test-hours properties to the data model for Capacity Record elements of CPC objects.

• Increased API version number from 3.1 to 3.2.
• Added API support to manage and interact with the console's multi-factor authentication support provided in conjunction with MFA servers, comprising the following API extensions:
  • Added the MFA Server Definition object representing the configuration of an MFA server used for HMC authentication and associated List, Create, Delete, Get Properties and Update Properties operations for MFA Server Definition objects.
  • Added the mfa-types, primary-mfa-server-definition-uri, backup-mfa-server-definition, mfa-policy, mfa-userid and mfa-userid-override properties to the User object data model.
  • Added the mfa-types, primary-mfa-server-definition-uri, backup-mfa-server-definition, mfa-policy, mfa-userid and mfa-userid-override fields to the request body for the Create User operation.
  • Added the rsa-securid-passcode field to the request body for the Logon operation.
  • Added the shared-secret-key and session-credential fields to the response for the Logon operation.
  • New HTTP status 400 with reason code 337 and HTTP status 404 with reason codes 338 and 339 on the Create User operation.
  • New HTTP status 400 with reason code 337, HTTP status 404 with reason codes 338 and 339, and HTTP status 409 with reason code 337 on the Update User Properties operation.
  • New HTTP status 400 with reason code 53, HTTP status 409 with reason codes 50, 51 and 52, HTTP status 500 with reason code 40, and HTTP status 503 with reason code 40 on the Logon operation.
  • New HTTP status 409 with reason code 51 on the Establish Shared Secret Key operation.
  • Added the Provide Requested MFA Information operation.
  • Added the Change Logon Password operation.
• Added API support for fulfilling multiple FICON storage volumes with a single request, comprising the following API extension:
  • Added the Fulfill FICON Storage Volumes operation to the Storage Group object.
• Added support for importing a DPM configuration from a z14 system on which the "dpm-storage-management" feature is enabled, comprising the following API extensions:
  • Added the following fields to the request body for the Import DPM Configuration operation for CPC objects: storage-sites, storage-subsystems, storage-fabrics, storage-switches, storage-control-units, storage-paths, storage-groups, storage-volumes, storage-templates, storage-template-volumes, virtual-storage-resources, storage-ports, and network-ports.
  • New HTTP status code 200 on the Import DPM Configuration operation. When HTTP status code 200 is returned a response body is provided that contains information about the parts of the configuration that were not restored.

• Added support to control the enablement of IBM Secure Boot for Linux®, comprising the following API extension:
  • Added the secure-boot property to the Partition object data model
  • Added the secure-boot property to the Image Activation Profile object data model
  • Added the secure-boot property to the Load Activation Profile object data model
  • Added the last-used-secure-boot property to the Logical Partition object data model
  • Added the secure-boot field to the request body for the SCSI Load operation for Logical Partition objects.
  • Added the secure-boot field to the request body for the SCSI Dump operation for Logical Partition objects.
• Added support to control whether Elliptic Curve Cryptography (ECC) keys can be used for computing digital signatures, comprising the following API extensions:
  • Added the permit-ecc-key-import-functions property to the Partition object data model.
• New HTTP status 400 with reason code 20 on the Update Partition Properties operation.

• Increased API version number from 3.2 to 3.3.
• New HTTP status 400 with reason code 54 on the Logon operation.
• Added a note to the workload-manager-enabled property of Logical Partition object to point out that changing that property may have no effect in some situations.

• Removed the checking for unrecognized X-* HTTP request headers, and, therefore, removed the following common request validation reason code: HTTP status 400 with reason code 10.

• New HTTP status 409 with reason 130 and HTTP status 500 with reason 130 on the Start Partition operation.
• Added the optional bootloader-error-id field to the job-results object in the asynchronous result of the Start Partition operation.

• Increased API version number to 3.4.
• Added the following as possible enumeration values for the vendor field in the response body for the Query API Version operation: "d", "e", "f", "g", "h" and "i".
• New HTTP status 403 with reason code 40 on the Provide Requested MFA Information operation.
• Added support for cloud network adapters, comprising the following API extensions:
  • Added the enumeration value "cna" as a possible value for the type property of an Adapter object.
  • Added the enumeration value "cna" as a possible value for the adapter-family property of an Adapter object.
  • Added the following as possible enumeration values for the detected-card-type property of an Adapter object: "ficon-express-16sa", and "cloud-network-x5".
  • Added the enumeration value "cna" as a possible value for the type property of a NIC element of a Partition object.
  • Added the function-number and function-range properties to the data model for NIC elements of Partition objects.
  • Added the function-number and function-range fields to the request body for the Create NIC operation.
  • New HTTP status 409 with reason code 18 on the Update NIC Properties operation.
• New HTTP status 409 with reason code 125 on the Start Partition operation.
• Documented that the template-uri and type fields of the request body for the Create Storage Group operation are mutually exclusive.
• Added support to request service for Console Hardware Messages, comprising the following API extensions:
  • Added the Request Console Service, Get Console Service Request Information and Decline Console Service operations for the Console object.
  • Added the service-supported property to the data model for the hardware-message nested object of the Console object.
• Added support to request service for CPC Hardware Messages, comprising the following API extensions:
  • Added the Request CPC Service, Get CPC Service Request Information and Decline CPC Service operations for the CPC object.
  • Added the service-supported property to the data model for the hardware-message nested object of CPC objects.
• Added additional information about degraded adapters, comprising the following API extensions:
  • The degraded-adapters property of Partition objects may now include Virtual Storage Resource element URIs.
  • Added the degraded-reasons property to the data model for Virtual Storage Resource elements of Storage Group objects.

• Added support to determine whether Secure Execution for Linux is enabled for a logical partition or partition, comprising the following API extensions:
  • Added the is-secure-execution-enabled, is-global-key-installed and is-host-key-installed properties to the CPC object data model.
  • Added the is-secure-execution-enabled property to the Logical Partition object data model.
  • Added the secure-execution property to the Partition object data model.
• Added the Power Status metric group for CPC objects.
• Added the zcpc-minimum-inlet-air-temperature, zcpc-maximum-inlet-air-temperature, zcpc-maximum-inlet-liquid-temperature and zcpc-environmental-class properties to the CPC object data model.

• Increased API version number to 3.5.
• Corrected the handling of the properties query parameter of the Get CPC Properties and Get Logical Partition Properties operations to no longer return HTTP status 400 for properties the HMC supports but the target CPC or Logical Partition does not support. Such properties are simply omitted from the response.

• Increased API version number to 3.6.
• Removed the requirement for object-access permission to the logical partition's parent CPC object from the following Logical Partition operations: Activate Logical Partition, Deactivate Logical Partition, Reset Normal, Reset Clear, Load Logical Partition, PSW Restart, Start Logical Partition, Stop Logical Partition, SCSI Load, and SCSI Dump. The authorization requirements for these operations now matches the requirements for the corresponding HMC UI tasks, and they allow for more granular control of permissions relating to Logical Partitions and CPCs.
• Added support for the request service action permission for the HMC Mobile app, comprising the following API extensions:
  • Added the action-settings-request-service-hardware-message property to the mobile-app-preferences nested object of the Console object.
• Added the ability to control whether a Hardware Message is deleted when requesting service for it and to obtain customer contact information for a Hardware Message, comprising the following API extensions:
  • Added the delete query parameter to the Get Console Service Request Information and Get CPC Service Request Information operations.
  • Added the customer-name and customer-phone fields to the response body for the Get Console Service Request Information and Get CPC Service Request Information operations.
• Added additional information to storage group histories, comprising the following API extensions:
  • Added the storage-group-name and storage-group-type query parameters to the Get Storage Group Histories operation.
  • Added the storage-group-name and storage-group-type fields to the storage-group-history-info nested object in the response body of the Get Storage Group Histories operation.

• Increased API version number to 3.7.
• Added the storage-volumes-in-error and storage-volumes-recovered fields to the storage-group-configuration nested object in the response body of the Get Storage Group Histories operation.
• Added the adapter-uri, old-serial-number, and new-serial-number fields to the storage-volume-info nested object in the response body of the Get Storage Group Histories operation.
• Added the last-used-load-type property to the Logical Partition object data model.
• The last-used-load-address property of the Logical Partition object may be now 4 or 5 characters in length. Previously, it was always 5 characters, but it is 4 characters for NVMe load addresses.
• The load-parameter request body field of the Load Logical Partition, SCSI Load, and SCSI Dump operations may now be 0-length. Previously, it was required to be 1-256 characters.
• The operating-system-specific-load-parameters request body field of the SCSI Load and SCSI Dump operations may now be 0-length. Previously, it was required to be 1-256 characters.
• Added the force field to the request body for the SCSI Dump operation.

The following extensions are provided by the HMC Web Services API for HMCs at version 2.15.0 but primarily apply only to managed systems with SE version 2.15.0 or later:

• Added support for Non-volatile Memory Express (NVMe) adapters, comprising the following API extensions:
  • Added the enumeration value "nvme" as a possible value for the type property of an Adapter object.
  • Added the enumeration value "nvme" as a possible value for the adapter-family property of an Adapter object.
  • Added the ssd-is-installed, ssd-capacity, ssd-model-number, ssd-serial-number, ssd-subsystem-vendor-id, and ssd-vendor-id properties to the Adapter object data model.
  • Added the enumeration value "nvme" as a possible value for the type property of a Storage Group object.
  • Added the adapter-uri, serial-number, and fid properties Storage Volume elements of Storage Group objects.
  • New HTTP status 400 with reason code 452, HTTP status 404 with reason code 446, HTTP status 409 with reason code 446, HTTP status 409 with reason code 500 on the Create Storage Group operation.
  • New storage-volume-request-info nested object format for "create" and "modify" operations on NVMe storage volumes, for use on the Modify Storage Group Properties operation.
  • New HTTP status 400 with reason code 452, HTTP status 409 with reason code 446, HTTP status 409 with reason code 500 on the Modify Storage Group operation.
  • New HTTP status 404 with reason code 4 on the Resend Request operation.
  • New HTTP status 404 with reason code 4 on the Accept Mismatched Storage Volumes operation.
  • Added the enumeration values "nvme-ssd-removed", "nvme-ssd-installed", "nvme-volume-mismatch", and "nvme-volumes-accepted" as a possible value for the action field of the storage-group-action-info nested object in the response body of the Get Storage Group Histories operation.
  • Added the NVMe Load and NVMe Dump operations for Logical Partition objects.
  • Added the enumeration values "ipltype-nvmeload" and "ipltype-nvmedump" as a possible value for the ipl-type property of an Image Activation Profile object.
  • Added the enumeration values "ipltype-nvmeload" and "ipltype-nvmedump" as a possible value for the ipl-type property of a Load Activation Profile object.

• Increased API version number to 3.8.
• Documented HTTP status 409 on the Update Logical Partition Properties operation.

The following extensions are provided by the HMC Web Services API for HMCs at version 2.15.0 but primarily apply only to managed systems with SE version 2.15.0 or later:

• Added the global-primary-key-hash, global-secondary-key-hash, host-primary-key-hash, and host-secondary-key-hash properties to the CPC object data model.

• Increased API version number to 3.9.
• Added the Remote Firmware Update element object to the Console object.
• Added the List Remote Firmware Updates of the Console, Get Console Remote Firmware Update Properties, Delete Console Remote Firmware Update, and Authorize Remote Firmware Updates operations for the Console object.
• Added enumeration values for tasks within User Role objects.
• Added the sna-name property to the CPC object data model.
• Added the sna-name property to the Console object data model.
• Added the has-important-unviewed-operating-system-messages property to the Logical Partition object data model.
• Added group-uri query parameter to the Get CPC Properties operation for the CPC object.
• Added group-uri query parameter to the Update CPC Properties operation for the CPC object.
• Added group-uri query parameter to the Get Logical Partition Properties operation for the Logical Partition object.
• Added group-uri query parameter to the Update Logical Partition Properties operation for the Logical Partition object.
• Added the is-held, is-priority, and max-messages query parameters to the List OS Messages of a Logical Partition operation for the Logical Partition object.
• Added the Get Console Events Log operation for the Console object.
• Added the event-id and max-entries query parameters to the following operations:
  • Get Console Audit Log operation for the Console object.
  • Get Console Security Log operation for the Console object.
  • Get CPC Audit Log operation for the CPC object.
  • Get CPC Security Log operation for the CPC object.
• Added the Get CPC Events Log, Get LPAR Resource Assignments, Get LPAR Controls, and Update LPAR Controls operations for the CPC object.
• Added properties query parameter to the Get Console Properties operation for the Console object.
• Added properties query parameter to the Get Reset Activation Profile Properties operation for the Reset Activation Profile object.
• Added properties query parameter to the Get Image Activation Profile Properties operation for the Image Activation Profile object.
• Added properties query parameter to the Get Load Activation Profile Properties operation for the Load Activation Profile object.
• Added properties query parameter to the Get Group Profile Properties operation for the Group Profile object.
• Added the partition-identifier property to the Image Activation Profile object data model.
• Added the logical-partition-names and effective-logical-partition-names properties to the Group Profile object data model.
• Added properties query parameter to the Get Capacity Record Properties operation for the Capacity Record object.

• Added support to determine which user template to use during logon processing based on the user's LDAP group membership, comprising the following API extensions.
  • Added the specific-template-uri, template-name-override-ldap-server-definition-uri, template-name-override-default-template-uri, ldap-group-to-template-mappings, ldap-group-ldap-server-definition-uri, ldap-group-default-template-uri, and domain-name-restrictions-ldap-server-definition-uri properties to the data model for User Pattern elements of Console objects.
  • Added the specific-template-uri, template-name-override-ldap-server-definition-uri, template-name-override-default-template-uri, ldap-group-to-template-mappings, ldap-group-ldap-server-definition-uri, ldap-group-default-template-uri, and domain-name-restrictions-ldap-server-definition-uri fields to the request body for the Create User Pattern operation.
  • New HTTP status 404 with reason codes 343, 344, 345, 346, 347, 348, and 349 on the Create User Pattern operation.
  • New HTTP status 404 with reason codes 343, 344, 345, 346, 347, 348, and 349 on the Update User Pattern Properties operation.

The following extensions are provided by the HMC Web Services API for HMCs at version 2.15.0 but primarily apply only to managed systems with SE version 2.15.0 or later:

• Added the Remote Firmware Update element object to the CPC object.
• Added the List Remote Firmware Updates of the CPC, Get CPC Remote Firmware Update Properties, and Delete CPC Remote Firmware Update operations for the CPC object.
• The following object classes and operations are now supported using the BCPii interface:
  • Session management services:
    • Query API Version
  • Asynchronous job processing:
    • Query Job Status, Delete Completed Job Status, Cancel Job
  • Console object:
    • Get Console Properties, Restart Console, Shutdown Console, Get Console Audit Log, Get Console Security Log, Get Console Events Log, List Hardware Messages, Get Console Hardware Message Properties, Delete Console Hardware Message, Requet Console Service, Get Console Service Request Information, and Decline Console Service.
  • Group object:
    • List Custom Groups, Get Custom Group Properties, Create Custom Group, Delete Custom Group, Add Member to Custom Group, Remove Member from Custom Group, and List Custom Group Members.
  • CPC object:
    • List CPC Objects, Get CPC Properties, Update CPC Properties, Activate CPC, Deactivate CPC, Import Profiles, Export Profiles, Add Temporary Capacity, Remove Temporary Capacity, Swap Current Time Server,Set STP Configuration, Change STP-only Coordinated Timing Network, Join STP-only Coordinated Timing Network, Leave STP-only Coordinated Timing Network, List CPC Hardware Messages, Get CPC Hardware Message Properties, Delete CPC Hardware Message, Request CPC Service, Get CPC Service Request Information, Decline CPC Service, Get CPC Audit Log, Get CPC Security Log, Get CPC Events Log, Get LPAR Resource Assignments, Get LPAR Controls, and Update LPAR Controls.

• (cont'd.)
  • Logical Partition object:
    • List Logical Partitions of a CPC, List Permitted Logical Partitions, Get Logical Partition Properties, Update Logical Partition Properties, Activate Logical Partitions, Deactivate Logical Partition, Reset Normal, Reset Clear, Load Logical Partition, PSW Restart, Start Logical Partition, Stop Logical Partition, Send OS Command, List OS Message of a Logical Partition, Delete Logical Partition OS Message, SCSI Load, SCSI Dump, NVMe Load, and NVMe Dump.
  • Reset activation profile:
    • List Reset Activation Profiles, Get Reset Activation Profile Properties, and Update Reset Activation Profile Properties.
  • Image activation profile:
    • List Image Activation Profiles, Get Image Activation Profile Properties, and Update Image Activation Profile Properties.
  • Load activation profile:
    • List Load Activation Profiles, Get Load Activation Profile Properties, and Update Load Activation Profile Properties.
  • Group profile:
    • List Group Profiles, Get Group Profile Properties, and Update Group Profile Properties.
  • Capacity records:
    • List Capacity Records
    • Get Capacity Record Properties
  • Energy Management:
    • Set CPC Power Save, Set CPC Power Capping, Set zCPC Power Save, Set zCPC Power Capping, Get CPC Energy Management Data, Get Energy Optimization Advice Summary, and Get Energy Optimization Advice Details.

• Added the target-name property to the Console object data model.
• Added the primary-se property to the network-info object returned from the Get Console Properties operation of the Console object.
• Added the name property to the detailed-network-info object returned from the Get Console Properties operation of the Console object.
• Added the request-origin property to the logical-partition-info object returned from the List Logical Partitions of a CPC and List Permitted Logical Partitions operations of the Logical Partition object.
• Added the target-name property to the CPC object data model.
• Added the target-name property to the Logical Partition object data model.
• Added the target-name property to the Reset activation profile object data model.
• Added the target-name property to the Image activation profile object data model.
• Added the target-name property to the Load activation profile object data model.
• Added the target-name property to the Group profile object data model.
• Added the target-name property to the Capacity records object data model.
• Added the request-origin property to the Logical Partition object data model.
• Added the enumeration value acceptable as a possible status value for the CPC object.
• Added target-name and location properties to the cpc-info object returned for the List CPC Objects operation of the CPC object.
• Added the enumeration value acceptable as a possible status value for the Logical Partition object.
• Added HTTP status 403 with reason code 0 on operations using the BCPii interface from source partitions that do not have the necessary BCPii security controls permission.

• Increased API version number to 3.10.
• Added enumeration values for classes of managed objects within User Role objects, due to new managed object types added to this HMC version.

The following extensions are provided by the HMC Web Services API for HMCs at version 2.15.0 but primarily apply only to managed systems with SE version 2.14.1 or later:

• Added support for managing an FCP tape library and related components for DPM-enabled CPCs and their partitions, comprising the following API extensions. (The majority of these extensions are only available if the dpm-fcp-tape-management feature is enabled on the CPC or Partition of interest):
  • Added the Tape Library object, representing a single physical tape storage unit associated with a DPM-enabled CPC, and corresponding operations on objects of this class, including List, Undefine, Get Properties, Update Properties, Request Tape Library Zoning, and Discover Tape Libraries, for Tape Library objects.
  • Added the Tape Link object, representing a single tape link to a tape library, and corresponding operations on objects of this class, including List, Create, Delete, Get Properties, Modify Tape Link Properties, Add Adapter Ports, Remove Adapter Ports, Replace Adapter Port, Resend Request, Get Partitions for a Tape Link, Get Tape Link Histories, Update Tape Link Environment Report, and Get Tape Link Environment Report, for Tape Link objects.
  • Added the Virtual Tape Resource element of a Tape Link object and corresponding operations on elements of this class, including List, Get Properties, and Update Properties for Virtual Tape Resource elements of Tape Link objects.
  • Added the enumeration values "tape-link" and "tape-library" as possible object class values for the Inventory Service.
  • Added the tape-link-uris property to the Partition object data model.
  • Added the Attach Tape Link to Partition and Detach Tape Link from Partition operations, for Partition objects.
  • Added the management-world-wide-port-name property to the CPC object data model.
  • Added the enumeration value "dpm-fcp-tape-management" as a possible value for the name property of the cpc-feature-info nested object in the CPC object data model.
  • Added the enumeration value "dpm-fcp-tape-management" as a possible value for the name property of the partition-feature-info nested object in the Partition object data model.
• New HTTP status 409 with reason code 153 on the Detach Storage Group from Partition operation.

For z14 Systems, P41414.332, Bundle S59, is required.

• Increased API version number to 3.11.
• Removed the (pc) qualifier from the Tape Link incomplete-reasons property.

The following extensions are provided by the HMC Web Services API for HMCs at version 2.15.0 but primarily apply only to managed systems with SE version 2.15.0 or later:

• Added the node-name and target-name fields to the stp-node shared nested object table.

• Increased API version number to 3.12.
• Corrected an error that caused the remote firmware update operations to end with an internal server error.
• Corrected the documentation to add reason code 2 as a possible HTTP status code 404 (Not Found) error condition reported by the Create User Role operation.
• Clarified the descriptions for the cp-processors and ifl-processors properties in the Partition object to state that partitions can have only CPs or only IFLs but not a mix of both.

The following extensions are provided by the HMC Web Services API for HMCs at version 2.15.0 but primarily apply only to managed systems with SE version 2.15.0 or later:

• Clarified the qualifier information for the access-coprocessor-group-set property of the Partition object to indicate that when the se-version property of the associated CPC is "2.15.0" or later, this property is not permitted on an Update Partition Properties operation, and its value is always false.
• Added reason code 19 as a possible HTTP status code 400® (Bad Request) error condition reported by the Update Partition Properties operation.

• Increased API version number to 3.13.
• Added the action-settings-manage-remote-firmware-updates field to the request body of the Set Mobile App Preferences operation.
• Added the action-settings-manage-remote-firmware-updates property to the mobile-app-preferences nested object in the Console object's data model.
• Added the partition-links property to the request body contents of the Import DPM Configuration operation, and added information to reason code 7 of HTTP status code 400 (Bad Request) to state that the Firmware Feature enablement of the designated CPC does not support the provided configuration objects.
• Added reason code 8 to HTTP Status code 409 (Conflict) as a possible error response from the Update Group Profile Properties operation.

• Increased API version number to 4.1. Note that the change in the major portion of the version number indicates that this version is not compatible with the previous version. The majority of these incompatibilities are due to the removal of zManager's support for Container Based Processors. For security reasons, several specific HTTP status codes and reason codes have been removed from Logon and related operations; instead, a HTTP status code 403 (Forbidden) with a generic reason code is returned. More detailed information is provided below.
• Removed support for Container Based Processors, comprising the following API extensions:
  • Removed cpb-shared-processor-usage, cpb-dedicated-processor-usage, and cpb-all-processor-usage metrics from the CPC overview metric group.
  • Removed cpb-processor-usage metric from the Logical partitions metric group.
  • Removed "cbp" as a possible value for the processor-type metric in the zCPC processors metric group.
  • Removed the processor-count-cbp and processor-count-pending-cbp properties from the CPC object data model.
  • Removed the initial-cbp-processing-weight, initial-cbp-processing-weight-capped, minimum-cbp-processing-weight, maximum-cbp-processing-weight, current-cbp-processing-weight, current-cbp-processing-weight-capped, and absolute-cbp-capping properties from the Logical Partition object data model.
  • Removed the initial-cbp-processing-weight, initial-cbp-processing-weight-capped, minimum-cbp-processing-weight, maximum-cbp-processing-weight, absolute-cbp-capping, number-dedicated-cbp-processors, number-reserved-dedicated-cbp-processors, number-shared-cbp-processors, and number-reserved-shared-cbp-processors properties from the Image Activation Profile object data model.
  • Removed the absolute-cbp-capping and effective-absolute-cbp-capping properties from the Group Profile object data model.
  • Removed the enumeration value "cbp" as a possible value for the type field in the Capacity Record object data model.
  • Removed the enumeration value "cbp" as a possible value for the processor-type field in the request body for the Add Temporary Capacity and Remove Temporary Capacity operations.
• For security reasons, several specific HTTP status codes and reason codes have been removed from Logon and related operations; instead, a HTTP status code 403 (Forbidden) with a generic reason code is returned. The affected operations are: Logon, Establish Shared Secret Key, and Provide Requested MFA Information.
• There are instances when it is convenient to provide a property of a related object as a property of itself. For this reason, an ancillary property (a) qualifier was added.
• Added (pc) qualifiers to several properties in the CPC object, Logical Partition object, and the Reset Activation Profile object.
• Added the Load Logical Partition from FTP operation to the Logical Partition object.
• Added the Update Welcome Text operation to the Console object.
• Updated the Query API Version operation to include two new fields: welcome-text and reflow-welcome-text.
• Added the Verify Logon Password operation to the session management services.
• Added support for additional MFA types to the Logon operation, including the authentication-code field.
• Added the cpc-machine-info property to the Console Object data model, and updated descriptions of the machine-info object properties.
• Updated the Get LPAR Controls and Update LPAR Controls operations descriptions and examples.
• Updated the authorization requirements for Update Logical Partition Properties and Update Group Profile Properties operations.
• Changed the view-only-mode support to true for the Change LPAR Controls and Change LPAR Group Controls tasks in Enum values for the Task object.

• Added Console Shutting Down notification information to the notification message formats section of Asynchronous notification.
• Added the following properties to the Image Activation Profile data model: assigned-crypto-domains, and assigned-cryptos.
• Added last-used-clear-indicator property to the Logical Partition object data model.
• Added the following properties to the Console object data model: shutdown-in-process, shutdown-delay-allowed, shutdown-delay-remaining, shutdown-delay-apps, and shutdown-delay-disable-reasons.
• The Adapter object, which was previously in DPM mode CPCs only, now has limited API support when attached to non-DPM CPCs. As a result, the following items have been added:
  • Two new operations are available for adapters attached to DPM mode CPCs and non-DPM CPCs: List Permitted Adapters and Update Adapter Firmware
  • The following adapter types were added to the type property for the Adapter object data model: "osc" (OSA Integrated Console Controller), "ose" (OSE for non-QDIO), "roc2" (RDMA over Converged Ethernet version 2), "cl5" (long range coupling), "cs5" (short range coupling), "icp" (Internal Coupling Link), "hyl" (zHyperLink Express), and "ism" (Internal Shared Memory).
  • The following values were added to the adapter-family property for the Adapter object data model: "coupling" (a coupling card), "ism" (an Internal Shared Memory card), "zhyperlink" (a zHyperLink Express), and "not-defined" (to indicate the adapter-family is not defined).
  • Added HTTP status code 404 with reason code 4 to the following operations: Get Adapter Properties, Update Adapter Properties, Create Hipersocket, Get Storage Port Properties, and Change Adapter Type.
  • Updated the description for reason code 4 as a possible HTTP status code 404 (Not Found) for the following operations: Change Crypto Type, Delete Hipersocket, Get Partitions Assigned to Adapter, Get Network Port Properties, Update Network Port Properties, and Update Storage Port Properties.
  • Added HTTP status code 409 with reason code 5 to the List Adapters of a CPC operation.
• To enable the ability to query Hardware Management Appliance (HMA) information, the hma-info property was added to the Console object. The following nested objects were also added: hma-info, hma-peer-hmc-info, hma-guest-info, and hma-guest-info type-specific properties when the type value is "se".

• Support has been added for Server-Sent Events (SSE) over HTTP for unidirectional data flow where a client subscribes to events and receives a streamed response as notifications are emitted:
  • Two new primitive data types were added: String/Object URI Pattern, and String/Element URI Pattern.
  • HTTP/2 protocol standard is now supported.
  • Added reason code 7 as a possible reason code for HTTP status code 404 (Not Found) in the Common request validation reason codes table.
  • Added reason code 5 as a possible reason code for HTTP status code 503 (Service Unavailable) in the Common request processing reason codes table.
  • A new section on Server-Sent Events (SSE) was added to Asynchronous notification.
  • Four new session management services operations were added in General API services: Create Server-Sent Events Stream, Update Server-Sent Events Stream, Delete Server-Sent Events Stream, and Open Server-Sent Events Stream.
• The following class specific additional properties were added to the Partition object's data model: cpc-name and se-version.
• The class specific additional property has-hardware-messages was added to the Console object's data model.
• Two class specific additional properties were added to the Logical Partition object's data model: cpc-name and se-version.
• Two new operations were added to the Console object to support HMC Mobile hardware messages notifications: Get Console Notification Preferences for Device and Update Console Notification Preferences for Device.
• Added the action-settings-manage-remote-firmware-updates field to the request body of the Set Mobile App Preferences operation.
• Added the action-settings-manage-remote-firmware-updates property to the mobile-app-preferences nested object in the Console object's data model.
• For the Console object and the CPC object, the descriptions of the Remote Firmware Update element object properties service-contact-name, service-contact-telephone-number, and service-contact-email-address were corrected to indicate that their values may be empty.
• New single step operations were added. For the Console object, the Console Single Step Install operation was added and for the CPC object the CPC Single Step Install operation was added. Also, four new objects were added to the ec-mcl-description shared nested object: lic-control-level, driver-level, bundle-level, and arom-info.
• Removed the List Managed Virtual Machines of a Logical Partition operation.

The following extensions are provided by the HMC Web Services API for HMCs at version 2.16.0 but primarily apply only to managed systems with SE version 2.16.0 or later:

• Updated the Activate Logical Partition operation to optionally load the Logical Partition object during activation. This added several new optional fields to the request body and additional authorization requirements and status/reason codes.
• Added the speed-boost and ziip-boost properties to the Logical Partition object. Each of these properties contains a boost-info nested object which contains the following properties: boost-type, total-rpb-time, and remaining-rpb-time.
• Added the following properties to the CPC object: software-model-purchased, msu-purchased, processor-count-permanent-ifl, processor-count-unassigned-ifl, processor-count-permanent-icf, processor-count-unassigned-icf, processor-count-permanent-iip, processor-count-unassigned-iip, processor-count-permanent-service-assist, and processor-count-unassigned-service-assist.
• Added the following String Enums to the record-type property of the Capacity Records object:
  • "z-flexible-capacity" - IBM zSystems Flexible Capacity Disaster Recovery
  • "z-flexible-capacity-oocod" - IBM zSystems Flexible Capacity On/Off Capacity on Demand record
  • "tfp-hw" - Tailored Fit Pricing Hardware.
• Added the Partition Link object to support the configuration of SMC-Dv2 partition links for DPM-enabled systems. The following operations have been added for this support:
  • Create Partition Link
  • Delete Partition Link
  • Get Partition Link Properties
  • List Partition Links
  • Modify Partition Link
  In order to support partition links, the following additional changes were made:

  • Three new properties were added to the CPC object: maximum-ism-vchids, minimum-fid-number, and maximum-fid-number.
  • For the CPC object, the cpc-feature-info object nested properties, the name field has an additional value: "dpm-smcd-partition-link-management".
  • For the List Adapters of a CPC, List Partitions of a CPC and List Virtual Switches of a CPC operations: a new query parameter, additional-properties, was added.
  • For the Partition object, the partition-link-uris field was added, and for partition-feature-info object nested properties, the name field has an additional value: "dpm-smcd-partition-link-management".
  • For the Create NIC and Update NIC Properties operations, added reason code 557 to error code 409.
  • Added the properties query parameter to the Get Partition Properties operation.
  • For the Get Partitions for a Storage Group and Get Partitions for a Tape Link operations, updated the description of the object-uri field in the partition-info object nested objects table to specify the property will be null when the current user has no object access permission to the partition.
  • For the Get Inventory operation: added the "partition-link" class to the "dpm-resources" category in the description for the resources field.

• Increased API version number to 4.2.
• Added the partition-links property to the request body contents of the Import DPM Configuration operation, and added information to reason code 7 of HTTP status code 400 (Bad Request) to state that the Firmware Feature enablement of the designated CPC does not support the provided configuration objects.

• Increased API version number to 4.10.
• Introduced the concept of API Features. Beginning with API version 4.10 API clients must use API feature information rather than the API version to determine if specific new API functionality is available on the HMC and CPC. The feature names are listed in Table 1. The following operations have been added for this support :
  • List Console API Features
  • List CPC API Features
• Added three new properties to the Adapter object: io-domain, drawer, and ficon-usage.
• Updated the Storage Port element object properties:
  • Updated the description of the connection-endpoint-uri property.
  • Updated the description of the connection-endpoint-class property to include the "adapter" value.
  • Added the port-id property.
• Added reason codes 502, 503, and 504 as possible HTTP status code 409 (Conflict) error conditions reported by the Update Storage Port Properties operation.
• Added two new properties to the CPC object: is-host-import-key-installed, and primary-host-import-key-id-pattern.
• Added two new operations to the CPC object: Import Secure Execution Key and Delete Secure Execution Key.
• A new Certificate Object was added, which contains the following operations: Delete Certificate, Get Certificate Properties, Get Encoded Certificate, List Certificates, and Update Certificate Properties.
• A new operation was added to the CPC object: Import CPC Certificate.
• Changes that were made to the Image activation profiles include a new assigned-certificate-uris property containing the URIs of the certificates assigned to the image activation profile, new operations to assign/unassign a certificate to/from an Image activation profile (Assign Certificate to Image Activation Profile and Unassign Certificate from Image Activation Profile), and a new additional-properties query parameter on the List Image Activation Profiles operation.
  Note: Image activation profiles named "DEFAULT" or whose name begins with "0D0" do not have any certificates in them and cannot be assigned certificates. These are special image activation profiles that are firmware created and owned.
• Changes that were made to the Logical Partition object include a new property assigned-certificate-uris containing the URIs of the certificates assigned to the logical partition, new operations to assign/unassign a certificate to/from a logical partition (Assign Certificate to Logical Partition and Unassign Certificate from Logical Partition, and a new additional-properties query parameter on the List Permitted Logical Partitions operation.
• Corrected the Open Server-Sent Events Stream operation URI to be GET, not POST.
• Added new operations to support problem reporting: Report a Console Problem, Report a CPC Problem, Report a Logical Partition Problem, and Report a Partition Problem.
• For the Query API Version operation, a new vendor value was added: "n" - a numeric vendor value, where n is an integer between 0 and 255.
• BCPii support was added to include the support of the following operations:
  • Adapter Object: support the List Permitted Adapters operation on the non-DPM Support Element. Also added support for the MAC address and port number for this operation.
  • Console Object: support added for the Alternate SE's MAC address.
• Added enhanced notifications for the IBM HMC Mobile app, comprising the following updates:
  • General API Services: Added the Get Server-Sent Events Stream Last Event ID operation.
  • Console object: Added the enhanced-notifications-enabled field.

P30805.014 (Bundle H14)

• A new single-load operation, Load, was added.
  Note: This is the recommended operation for all operating system and dump program loads.

  For the pre-existing profiles and activate operations that deal with load-type/ipl-type already, new Enums were added, as well as support for the new load fields and options:

  • Activate Logical Partition operation: disk-partition-id-automatic, boot-record-location-use-volume-label, boot-record-location-cylinder, boot-record-location-head, and boot-record-location-record.
  • Image Activation Profile data model: disk-partition-id-automatic, last-used-boot-record-location-cylinder, last-used-boot-record-location-head, last-used-boot-record-location-record, and last-used-boot-record-location-volume-label.
  • Load Activation Profile data model: disk-partition-id-automatic, last-used-boot-record-location-cylinder, last-used-boot-record-location-head, last-used-boot-record-location-record, and last-used-boot-record-location-volume-label.
  • Logical Partition data model: last-used-boot-record-location-cylinder, last-used-boot-record-location-head, last-used-boot-record-location-record, last-used-boot-record-location-volume-label, last-used-device-type, last-used-load-program-type, last-used-load-operation-type, and last-used-disk-partition-id-automatic.

  No updates were made to Load Logical Partition, SCSI Load, SCSI Dump, NVMe Load, or NVMe Dump. These operations will not support any of the new functionality.

dpm-hipersockets-partition-link-management

hmc-delete-retrieved-internal-code