| 1 | Qualified user space name | Input | Char(20) |
| 2 | Cluster name | Input | Char(10) |
| 3 | Format name | Input | Char(8) |
| 4 | Node id | Input | Char(8) |
| 5 | Error code | I/O | Char(*) |
The List Cluster Information (QcstListClusterInfo) API is used to retrieve
information about a cluster. It must be called from a program running on one of
the nodes in the cluster. The information returned may not be current if this
API is called from a program running on a node that has a status of Inactive or
Failed. This API may be called from a cluster resource group exit program.
The user space that receives the information and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the library name. No special values (QTEMP, *CURLIB, or *LIBL) can used for the library name.
The name of the cluster for which information is retrieved.
The format of the information to be returned. Supported format names are:
| LCTI0100 | Returns information about a specific node or all nodes in the cluster and additional information about the cluster. |
A valid simple name that uniquely identifies a node. *ALL special value can be used to return information about all nodes in the cluster. The *ALL special value must be left-justified.
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
The cluster information list consists of:
For details about the user area and generic header, see User Space Format for List APIs. For detailed descriptions of the fields in the list returned, see Field Descriptions.
When you retrieve list entry information from a user space, you must not use
the entry size returned in the generic header. Each entry may have a different
size. The size of each entry may be padded at the end.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name |
| 10 | A | CHAR(10) | User space library name |
| 20 | 14 | CHAR(10) | Cluster name |
| 30 | 1E | CHAR(8) | Format name |
| 38 | 26 | CHAR(8) | Node id |
Global information about the cluster.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Information status |
| 1 | 1 | CHAR(3) | Reserved |
| 4 | 4 | BINARY(4) | Current cluster version |
| 8 | 8 | BINARY(4) | Current cluster version modification level |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| These fields are repeated for each node entry returned. | Array(*) of CHAR(*) | Node entry array | |
| BINARY(4) | Length of node entry | ||
| CHAR(8) | Node id | ||
| BINARY(4) | Node status | ||
| BINARY(4) | Offset to first cluster interface entry | ||
| BINARY(4) | Number of cluster interfaces | ||
| BINARY(4) | Potential node version | ||
| BINARY(4) | Potential node version modification level | ||
| CHAR(10) | Device domain name | ||
| Array(*) of CHAR(16) | Cluster interface entry array | ||
| These fields are repeated for each cluster interface entry returned. | CHAR(16) | Cluster interface address | |
Cluster interface address. The cluster interface address is an IP address which is used by Cluster Resource Services to communicate with other nodes in the cluster. It is returned as a null-terminated string and represented in dotted decimal format.
Cluster interface address array. Array of cluster interface addresses in use by each node in the node entry array.
Cluster name. The name of the cluster for which information is retrieved.
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.
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.
Device domain name. The name of the device domain that this node belongs to. This field will contain hexadecimal zeros if the node does not belong to a device domain.
Format name. The content and format of the information returned in the user space.
Information status. Indicates the consistency of the retrieved information.
| 0 | The information is consistent for all active nodes in the cluster. |
| 1 | The information retrieved from the node running
the API may not be consistent with all active nodes in the cluster. In order to
obtain consistent information:
|
Length of node entry. The length of the node entry.
Node entry array. Array of cluster nodes for which information is being returned.
Node id. A valid simple name that uniquely identifies a node.
Node status. The status of the node in the cluster. See Cluster Node Status for the possible values and definitions of the status.
Number of cluster interfaces. The number of IP interfaces used by the node for Cluster Resource Services.
Offset to first cluster interface entry. The offset from the beginning of the user space to the first cluster interface entry.
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. If communications have not yet been established with the node (status of New), then the potential node version will be reported as 0.
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.
Reserved. The field will contain hexadecimal zeroes.
User space name. The name of the user space.
User space library name. The name of the library in which
the user space resides. No special values are supported for library name.
Messages that are delivered through the error code parameter are listed here.
| Message ID | Error Message Text |
|---|---|
| CPF2113 E | Cannot allocate library &1. |
| 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. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9804 E | Object &2 in library &3 damaged. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPFBB02 E | Cluster &1 does not exist. |
| CPFBB09 E | Cluster node &1 does not exist in cluster &2. |
| CPFBB38 E | Library name &1 not allowed for this request. |
| Top | Cluster APIs | APIs by category |