Retrieve Attribute Names (QmrRtvAttributeNames) API
Required Parameter Group:
| 1 | Receiver variable | Ouput | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Receiver variable format name | Input | Char(8) |
| 4 | Resource information | Input | Char(*) |
| 5 | Resource information format name | Input | Char(8) |
| 6 | Server information | Input | Char(*) |
| 7 | Server information format name | Input | Char(8) |
| 8 | Error Code | I/O | Char(*) |
Service Program: QMRAP1
Default Public Authority: *USE
Threadsafe: Yes
The Retrieve Attribute Names (QmrRtvAttributeNames) API returns a list of supported attributes for a monitored resource entry (MRE). Supported attributes can be monitored for changes in a cluster administrative domain by adding a monitored resource entry specifying the list of attributes. Different attributes may be supported for different cluster versions. The list of supported attribute names returned can be the attributes supported for the current cluster version of the cluster, the attributes supported for the potential cluster version of the local node, or the attributes supported for a specified cluster version. For more information about monitored resources, see Cluster administrative domain.
Restrictions:
- The list of supported attributes for *AUTL or *PRTDEV resource types can only be retrieved when the IBM® PowerHA™ for i licensed program product is installed.
Authorities and Locks
- Network Server Description
- *USE
- Network Server Configuration
- *USE
-
Printer Device Description - *USE
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The receiver variable that holds the information requested.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable in bytes. The minimum length is 8 bytes. If the length of receiver variable is not large enough to hold the entire list of supported attributes for the monitored resource, no records are returned. If the length of the receiver variable specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable.
- Receiver variable format name
- INPUT; CHAR(8)
The content and format of the information that is returned. The possible format names are as follows:
ATTR0100 Returns a list of supported attribute names.
- Resource information
- Input; CHAR(*)
The resource information for which supported attribute names are returned.
- Resource information format name
- INPUT; CHAR(8)
The content and format of the information which is desired. The possible format names are as follows:
RSCI0100 Specifies information about a specific resource or a resource type.
- Server information
- Input; CHAR(*)
The cluster information used to return the appropriate attribute information.
- Server information format name
- INPUT; CHAR(8)
The content and format of the information for a cluster. The possible format names are as follows:
SVRI0200 Specifies information about a specific cluster or a cluster version.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
ATTR0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Offset to attribute names |
| 12 | C | BINARY(4) | Number of attribute names |
| These fields repeat for each attribute in the supported attribute list. | BINARY(4) | Displacement to next attribute name | |
| BINARY(4) | Attribute type | ||
| BINARY(4) | Length of attribute name | ||
| CHAR(*) | Attribute name | ||
Field Descriptions
Attribute name. The name of the attribute. See Attributes that can be monitored in the Implementing high availability topic collection for a list of different attributes for each resource type.
Attribute type. The type of the attribute. Valid values are:
| 0 | SIMPLE | The attribute is represented by a single value. |
| 1 | COMPOUND | The attribute is represented by a variable number of compound attribute entries. |
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.
Displacement to next attribute name. The displacement in bytes from the start of the current entry to the next entry.
Length of attribute name. The length, in bytes, of the attribute name.
Number of attribute names. The number of attribute names returned.
Offset to attribute names. The offset, in bytes, from the beginning of the receiver variable to the attribute information. If no entries are returned, the offset is set to 0.
Reserved. Set to hex zeros.
RSCI0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of fixed fields |
| 4 | 4 | CHAR(10) | Library name |
| 14 | E | CHAR(10) | Resource type |
| 24 | 18 | BINARY(4) | Length of resource name |
| 28 | 1C | BINARY(4) | Offset to resource name |
| CHAR(*) | Resource name | ||
Field Descriptions
Length of fixed fields. The length of the fixed fields in the format description. For RSCI0100 this value must be 32.
Length of resource name. The length, in bytes, of the resource name. The specified length must be at least 1 byte but not longer than 256 bytes.
Offset of resource name. The offset, in bytes, from the beginning of this structure to the first byte of the resource name.
Library name. The name of the library for the resource. This field must be set to blanks.
Resource name. The name of the resource for which the supported attribute names is returned. Valid values are:
| *ANY | Specified for any resource type except *NWSD, *NWSCFG or *PRTDEV to return the list of supported attribute names for the resource type. If the resource type is *SYSVAL, *NETA, *TCPA or *ENVVAR, the list of all supported resources of the specified type are returned. |
| name | The name of the resource for which the list of supported attribute names is to be returned. A resource name must be specified for a resource of type *NWSD, *NWSCFG or *PRTDEV. A resource name can be specified if the resource type is *SYSVAL, *NETA, *TCPA or *ENVVAR. |
Resource type. The type of resource. Possible values are:
| *ASPDEV | Independent auxiliary storage pool (ASP) device description |
| *AUTL | Authorization list |
| *CLS | Class |
| *ENVVAR | System environment variable |
| *ETHLIN | Ethernet line description |
| *JOBD | Job description |
| *NETA | Network attribute |
| *NWSCFG | Network server configuration |
| *NWSD | Network server description of type *WINDOWSNT, *IXSVR, or *ISCSI |
| *NWSHDEV | NWSH device description |
| *NWSSTG | NWS storage space |
| *OPTDEV | Optical device description |
| *PRTDEV | Printer device description |
| *SBSD | Subsystem description |
| *SYSVAL | System value |
| *TAPDEV | Tape device description |
| *TCPA | TCP/IP attribute |
| *TRNLIN | Token-ring line description |
| *USRPRF | User profile |
SVRI0200 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of fixed fields |
| 4 | 4 | BINARY(4) | Cluster version |
| 8 | 8 | BINARY(4) | Cluster modification level |
| 12 | C | BINARY(4) | Length of server defined output |
| 16 | 10 | CHAR(10) | Cluster name |
| 26 | 1A | CHAR(10) | Cluster administrative domain name |
| 36 | 24 | CHAR(30) | Results information queue |
Field Descriptions
Cluster administrative domain name. The name of the cluster administrative domain for which the list of attribute names is retrieved. The cluster administrative domain must exist if a name is specified. If a name is not specified, this field must be set to hex zeros.
Cluster name. The name of the cluster for which the list of attribute names is retrieved. The attribute names which are returned are those that are valid for the current version of the specified cluster. The cluster must exist. If a cluster does not exist, or the list of names to be returned is for a specific supported cluster version or potential cluster version, this field must be set to hex zeros.
Cluster modification level. The specific cluster modification level for which a list of supported attribute names is returned. This field must be set to hex zeros if a cluster name is specified.
Cluster version. The cluster version for which a list of supported attribute names is returned. This field must be set to hex zeros if a cluster name is specified. If a cluster name is not specified, the possible values are:
| -1 | Returns the attribute names supported for the potential cluster version of the local node. |
| >4 | Returns the attribute names supported for a specific cluster version. The first cluster version for which support is provided is cluster version 5. |
Length of fixed fields. The length, in bytes, of the server information format.
Length of server defined output. This field is not used and must be set to hex zeros.
Results information queue. This field is not used and must be set to hex zeros.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C19 E | Error occurred with receiver variable specified. |
| 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. |
| 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. |
| CPF9820 E | Not authorized to use library &1. |
| CPFA0AA E | Error occurred while attempting to obtain space. |
| CPFAA04 E | Resource &1 of type &3 is not valid. Reason code is &5. |
| CPFAA07 E | Field value within structure is not valid. |
| CPFAA0B E | Internal error in procedure &2. Reason code is &1. |
| CPFAA0C E | Resource &2 not found or not supported. |
| CPFAA0F E | Request &1 not supported with specified cluster version and modification level. |
| CPFAA10 E | Combination of parmameter values not valid. |
| CPFBB02 E | Cluster &1 does not exist. |
| CPFBB70 E | Request &1 not compatible with current cluster version. |
| CPFBBBD E | Resource type &1 not valid. |
| CPFBBC4 E | Request not valid for cluster node &1. |
API introduced: V6R1
[ Back to top | Cluster APIs | APIs by category ]