Retrieve
HA Configuration Description (QhaRetrieveConfigurationDesc) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Receiver variable format name | Input | Char(8) |
| 4 | Cluster name | Input | Char(10) |
| 5 | Selection format name | Input | Char(8) |
| 6 | Selection information | Input | Char(*) |
| 7 | Error Code | I/O | Char(*) |
Service Program: QHASM/QHAAPI
Default Public Authority: *USE
Threadsafe: Yes
The Retrieve High Availability (HA) Configuration Description (QhaRetrieveConfigurationDesc) API is used to retrieve information about HA configuration descriptions.
Authorities and Locks
- None
Required Parameter Group
- Receiver variable here)
- OUTPUT; CHAR(*)
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.
- Length of receiver variable
- INPUT; BINARY(4)
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.
- Receiver variable format name
- INPUT; CHAR(8)
The content and format of the HA configuration description information that is returned. The possible format names are:
RHAD0100 HA configuration description information that is returned. - Cluster name
- INPUT; CHAR(10)
The name of the cluster.
- Selection format name
- INPUT; CHAR(10)
The format name of the selection. The possible format names are:
IHAD0100 Specify the selection information about HA configuration description to be retrieved. - Selection information
- INPUT; CHAR(*)
The information in this parameter is used to determine what to include in the HA configuration description information to be returned.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
RHAD0100 format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes provided |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Length of fixed fields |
| 12 | C | BINARY(4) | Number of entries returned |
| 16 | 10 | Binary(4) | Offset to configuration description array |
| Array(*) of CHAR(*) | Configuration description entry | ||
RHAD0100 Field Descriptions
The field descriptions are always in alphabetical order.Bytes available. The number of bytes of data available to be returned.
Bytes provided. The number of bytes that the calling application has provided for the HA configuration description data.
Length of fixed fields. The length of the fixed portion of the format.
Number of entries returned. The number of HA configuration descriptions that were returned.
Offset to configuration description array. The offset from the beginning of the receiver variable to the HA configuration description array.
RHAD0100 format - Configuration description entry
The following is the information for configuration description entry:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of configuration description entry |
| 4 | 4 | BINARY(4) | Length of fixed fields |
| 8 | 8 | CHAR(10) | Configuration name |
| 18 | 12 | CHAR(10) | Configuration description type |
| 28 | 1C | CHAR(10) | Configuration description subtype |
| 38 | 26 | CHAR(2) | Reserved |
| 40 | 28 | BINARY(4) | Offset to configuration description information |
| Array(*) of CHAR(*) | Information for specific configuration type and subtype | ||
The following information is for the configuration type *HYSSTG and subtype *DS:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of configuration description |
| 4 | 4 | CHAR(8) | System serial number |
| 12 | C | CHAR(16) | IBM system storage device |
Field Descriptions
The field descriptions are always in alphabetical order.Configuration name. The name of the HA configuration description.
Configuration description subtype. The subtype of the HA configuration description. The possible values for *HYSSTG configuration type are:
| *DS | IBM system storage device. |
Configuration description type. The type of the HA configuration description. The possible values for HA configuration type are:
| *HYSSTG | HyperSwap storage description. |
IBM system storage device. The name of the IBM system storage device.
Length of configuration description entry. The total length of the configuration description entry, which include the length of fixed fields and length of specific configuration description.
Length of fixed fields. The length of the fixed portion of the configuration description entry.
Length of specific configuration description. The length of the specific HA configuration description.
Offset to configuration description information. The offset from the beginning of the receiver variable to the HA configuration description information.
Reserved. This field is not used and is set to binary zeroes.
System serial number. The serial number of the system.
IHAD0100 format
The following is the selection information for format IHAD0100:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of selections |
| Array(*) of CHAR(*) | Selection information | ||
Selection information:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of fixed fields |
| 4 | 4 | BINARY(4) | Selection type |
| 8 | 8 | CHAR(10) | Selection name |
| 18 | 12 | CHAR(2) | Reserved |
IHAD0100 Field Descriptions
The field descriptions are always in alphabetical order.Length of fixed fields. The length of the fixed portion of the selection information.
Number of selections. The number of selections provided. Selections with the same type will be treated as if a logical 'or' existed between them. Selections with different types will be treated as if a logical 'and' existed between them. For example, if you have two selections, the first of which specifies a name of 'EXAMPLE' and the second which specifies a type of '*HYSSTG' then all HA configuration descriptions with the name 'EXAMPLE' and the type '*HYSSTG' will be returned. If you add another selection which specifies a name of 'EXAMPLE2' then all entries with type '*HYSSTG' and a name of either 'EXAMPLE' or 'EXAMPLE2' will be returned.
Reserved. This field is not used and is set to binary zeroes.
Selection type. The type of the selection. The possible values for the selection type are:
| 0 | Select all HA configuration descriptions. |
| 1 | Selection based on the HA configuration description type. |
| 2 | Selection based on the HA configuration description subtype. |
| 3 | Selection based on the HA configuration description name. |
Selection name. The name of the selection.
- This field is ignored for selection type 0.
- The possible values for the selection type 1 are:
*HYSSTG HyperSwap storage description. - The possible values for the selection type 2 are:
*DS IBM system storage device. - A configuration description name should be specified for selection type 3.
Error Messages
The following messages may be sent from this function:
| Message ID | Error Message Text |
|---|---|
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| 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. |
API introduced: IBM® i 7.2 PTF
[ Back to top | Cluster APIs | APIs by category ]