Change PowerHA Version (QhaChangeHAVersion) APIChange PowerHA Version (QhaChangeHAVersion) API| 1 | Request handle | Output | Char(16) |
| 2 | Cluster name | Input | Char(10) |
| 3 | PowerHA version information | Input | Char(*) |
| 4 | Format name | Input | Char(8) |
| 5 | Results information | Input | Char(30) |
| 6 | Error code | I/O | Char(*) |
The Change PowerHA Version (QhaChangeHAVersion) API is used to adjust the current version of the PowerHA product. The current PowerHA version is the version at which the nodes which are known by the PowerHA product are actively communicating with each other. Nodes are known by the PowerHA product if the PowerHA product is installed on the node in the same cluster and the potential PowerHA version of the node is compatible with the current PowerHA version. In addition, the current PowerHA version indicates what function is supported by the known PowerHA nodes. It is set when the cluster is created, or is assumed to be the lowest supported PowerHA version if a cluster already exists when the PowerHA product is installed.
This API will not cause the Cluster Resource Group Exit Program to be called.
The following conditions apply to this API:
This API operates in an asynchronous mode. See Behavior of Cluster Resource Services APIs for more information.
The program that calls this API must be running under a user profile with *IOSYSCFG special authority.
A unique string or handle that identifies this API call. It is used to associate this call to any responses placed on the user queue specified in the results information parameter.
The name of the cluster being managed by the PowerHA product.
Additional details for changing the PowerHA version.
The format of the PowerHA version information. The possible format names are:
| CHAV0100 | PowerHA version information |
A library qualified user queue name followed by a reserved field.
Library qualified user queue: A user queue, which exists on the node from which the API was called, that receives results information after the function has completed on all active nodes in the cluster. See the Usage Notes section of this API for a description of the data that is placed on this queue. This is a 20 character field. The first 10 characters contain the user queue name and the second 10 characters contain the user queue library name. No special values are supported. QTEMP, *LIBL, and *CURLIB are not valid for the library name. The attributes of this user queue must be keyed.
Reserved: The last 10 characters of results information are reserved and must be set to hexadecimal zero.
The structure in which to return error information. For the format of the structure, see Error code parameter.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of fixed fields |
| 4 | 4 | BINARY(4) | Version change option |
Length of fixed fields. This is the total length of data provided (including this field) for the PowerHA version information.
Version change option. Indicates how the PowerHA version or modification level should be changed. Valid values are:
| 1 | The current PowerHA version will be incremented by 1. For example, if the local node's potential PowerHA version is 3.0, and the current PowerHA version is 2.0, the current PowerHA version will be 3.0 after this API completes. |
| 10 | The current PowerHA modification level will be incremented by 1. For example, if the local node's potential PowerHA version is 2.1, and the current PowerHA version is 2.0, the current PowerHA version will be 2.1 after this API completes. |
Asynchronous results are returned to a user queue specified by the Results Information parameter of the API. See Cluster APIs Use of User Queues and Using Results Information for details on how to create the results information user queue, the format of the entries, and how to use the data placed on the queue. The data is sent to the user queue in the form of a message identifier and the substitution data for the message (if any exists). The following identifies the data sent to the user queue (excluding the message text).
| Message ID | Message Text |
|---|---|
| CPF3CF2 D | Error(s) occurred during running of &1 API. |
| CPFBB2F D | Cluster version &1 cannot be adjusted. |
| CPFBB39 D | Current user does not have IOSYSCFG special authority. |
| CPFBB46 D | Cluster Resource Services internal error. |
| HAC0026 C | PowerHA protocol completed for &1. |
| HAE0048 D | &1 API cannot be processed in cluster &2. |
| HAE0049 D | Current PowerHA version cannot be changed from &1 to &2. |
Messages that are delivered through the error code parameter are listed here. The data (messages) sent to the results information user queue are listed in the Usage Notes above.
| Message ID | Error Message Text |
|---|---|
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPFBB02 E | Cluster &1 does not exist. |
| CPFBB32 E | Attributes of user queue &1 in library &2 are not valid. |
| CPFBB5F E | Field value within structure is not valid. |
| HAE0043 E | PowerHA detected an unexpected error. |
| HAE0047 E | No valid license for IBM PowerHA for i found. |
| HAE0048 E | &1 API cannot be processed in cluster &2. |
| HAE0049 E | Current PowerHA version cannot be changed from &1 to &2. |
[ Back to top | Cluster APIs | APIs by category ]