Retrieve PowerHA Information (QhaRetrieveHAInfo) APIRetrieve PowerHA Information (QhaRetrieveHAInfo) API| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
The Retrieve PowerHA Information (QhaRetrieveHAInfo) API retrieves information about the PowerHA environment on a requesting node. The PowerHA environment is defined as a cluster managed by the PowerHA licensed program product. The requesting node does not need to be active in a cluster to retrieve the PowerHA information. However, some of the information will not be returned if the requesting node is not currently a member of a cluster and the requesting node was never activated.
None.
The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.
The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.
The content and format of the information that is returned. The possible format names are as follows:
| RHAI0100 | PowerHA information |
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) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Cluster name |
| 18 | 12 | CHAR(8) | Requesting node id |
| 26 | 1A | CHAR(10) | Current PowerHA version |
| 36 | 24 | CHAR(10) | Potential PowerHA version |
| 46 | 2E | CHAR(2) | Reserved |
| 48 | 30 | BINARY(4) | Current PowerHA version for programmer use |
| 52 | 34 | BINARY(4) | Current PowerHA modification for programmer use |
| 56 | 38 | BINARY(4) | Current cluster version |
| 60 | 3C | BINARY(4) | Current cluster version modification level |
| 64 | 40 | BINARY(4) | Potential node version |
| 68 | 44 | BINARY(4) | Potential node version modification level |
Bytes available. The number of bytes of data available to be returned to the user.
Bytes returned. The number of bytes of data returned to the user.
Cluster name. The name of the cluster. If no cluster exists on the system, *NONE is returned.
Current cluster version. The version at which the nodes in the cluster are actively communicating with each other. This value in conjunction with the potential node version determines what nodes can join in the cluster. This value also determines the cluster's ability to use new functions supported by the node's potential node version. It is set when the cluster is created and can be changed by the Adjust Cluster Version (QcstAdjustClusterVersion) API. If no cluster exists, the field will be set to 0.
Current cluster version modification level. The modification level of the current cluster version. The modification level further identifies the version at which the nodes in the cluster communicate. It is updated when code changes that impact the version are applied to the system. If no cluster exists, the field will be set to 0.
Current PowerHA version. The version at which the nodes in the cluster 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. This value also indicates what function is supported by the known PowerHA nodes. The value is set when a 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 field should be used for printed output only. The current PowerHA version can be changed with the Change Cluster Version (CHGCLUVER) command.
Current PowerHA version for programmer use. The integer representation of the current PowerHA version. This field should be used for verifying code compatibility between the PowerHA product version and an application using the PowerHA functionality provided in the version.
Current PowerHA modification for programmer use. The integer representation of the current PowerHA modification. This field should be used for verifying code compatibility between PowerHA modification levels and applications using the PowerHA functionality provided in the modification.
Potential PowerHA version. The version at which the PowerHA product installed on the node in the cluster is capable of communicating with other known PowerHA nodes. A node is known to the PowerHA product if the PowerHA product is installed on a node in the same cluster and the potential PowerHA version of the node is compatible with the current PowerHA version.
Potential node version. The version at which the node is capable of communicating with the other nodes in the cluster. This is the value associated with the cluster code installed on the node. It will be used to determine if the node can join a cluster.
Potential node version modification level. The modification level of the potential node version. The modification level further identifies the version at which the node is capable of communicating with the other nodes in the cluster. It is updated when code changes that impact the version are applied to the system and will also be used to determine if the node can join a cluster.
Requesting node id. The node id of the requesting cluster node. If no cluster exists or if the cluster has been created but never started on the system, *NONE is returned.
Reserved. This field will contain hexadecimal zeroes.
Messages that are delivered through the error code parameter are listed here.
| Message ID | Error Message Text |
|---|---|
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| HAE0047 E | No valid license for IBM PowerHA for i found. |
[ Back to top | Cluster APIs | APIs by category ]