List Device Domain Information (QcstListDeviceDomainInfo) API
Required Parameter Group:
| 1 | Qualified user space name | Input | Char(20) |
| 2 | Cluster name | Input | Char(10) |
| 3 | Device domain name | Input | Char(10) |
| 4 | Format name | Input | Char(8) |
| 5 | Error code | I/O | Char(*) |
Service Program: QCSTCTL1
Default Public Authority: *USE
Threadsafe: Yes
The List Device Domain Information (QcstListDeviceDomainInfo) API is used to
retrieve information about a device domain or all device domain names in 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
where cluster resource services is not active. This API
may be called from a cluster resource group exit program.
Authorities and Locks
- User Space Authority
- *CHANGE
- User Space Library Authority
- *EXECUTE
- User Queue Lock
- *EXCLRD
Required Parameter Group
- Qualified user space name
- OUTPUT; CHAR(20)
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. Special values are not allowed to be specified for the library name. QTEMP, *LIBL and *CURLIB are not valid for the library name.
- Cluster name
- INPUT; CHAR(10)
The name of the cluster.
- Device domain name
- INPUT; CHAR(10)
The name of the device domain for which information is retrieved. *ALL special value must be used if LDDI0200 is specified as the format name. The *ALL special value must be left-justified.
- Format name
- INPUT; CHAR(8)
The format of the information to be returned. Supported format names are:
LDDI0100 Returns information about all nodes in the device domain. LDDI0200 Returns information about all device domain names in the cluster.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format of Generated Lists
The cluster information list consists of:
- A user space
- A generic header
- An input parameter section
- A header section
- A list data section
- LDDI0100 format
- LDDI0200 format
For details about the user area and generic header, see User spaces. For detailed descriptions of the fields in
the list returned, see Field
Descriptions.
Input Parameter Section
| 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(10) | Device domain name |
| 40 | 28 | CHAR(8) | Format name |
Header Section
Global information about the cluster.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Information status |
LDDI0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| These fields are repeated for each node entry returned. | CHAR(8) | Node id | |
| BINARY(4) | Node status | ||
LDDI0200 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| This field is repeated for each device domain entry returned. | CHAR(10) | Device domain name | |
Field Descriptions
Cluster name. The name of the cluster.
Device domain name. The name of the 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:
|
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 node status.
User space library name. The name of the library in which the user space resides. No special values are supported for library name. *LIBL and *CURLIB are not valid for the library name.
User space name. The name of the user space.
Error Messages
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. |
| CPF3C4B E | Value not valid for field &1. |
| 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. |
| CPFBB38 E | Library name &1 not allowed for this request. |
| CPFBB70 E | API request &1 not compatible with current cluster version. |
| CPFBB77 E | Device domain &1 does not exist in cluster &2. |
API introduced: V5R1
[ Back to top | Cluster APIs | APIs by category ]