Retrieve Monitored Resource Information
(QfpadRtvMonitoredResourceInfo) APIRetrieve Monitored Resource Information
(QfpadRtvMonitoredResourceInfo) API| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format of receiver variable | Input | Char(8) |
| 4 | Manager type | Input | Char(10) |
| 5 | Monitored resource information | Input | Char(*) |
| 6 | Length of monitored resource information | Input | Binary(4) |
| 7 | Format of monitored resource information | Input | Char(8) |
| 8 | Server information | Input | Char(*) |
| 9 | Length of server information | Input | Binary(4) |
| 10 | Format of server information | Input | Char(8) |
| 11 | Server defined output | Output | Char(*) |
| 12 | Error code | I/O | Char(*) |
The Retrieve Monitored Resource Information (QfpadRtvMonitoredResourceInfo) API returns information about monitored resources.
A monitored resource may be a system object or a set of attributes not associated with a specific system object, such as the set of system environment variables. System objects and attributes are monitored by the system to allow notifications of changes to the attributes to be passed to a supporting system function or application for system management purposes.
This API will do the following when the manager type is *ADMDMN:
The receiver variable to hold the monitored resource entry information.
The length of the receiver variable in bytes. The minimum length is 8 bytes. If the length of the receiver variable is not large enough to hold the repeating fields of the information specified in the Monitored Resource Entry Information Format Name parameter, only the number of records specified by the Number of Records Returned field will be returned.
The format name of the monitored resource entry information which will be returned. The following format names are allowed:
DENR0100 Information about one or more monitored resource entries.
DENR0200 Information about the monitored attributes for a single monitored resource.
The management function which is to monitor the resource. *ADMDMN must be specified.
Information to identify the monitored resource or resources that are to be returned. See EENT0100 for a description of the monitored resource information.
The length of the monitored resource information.
The format name of the monitored resource information. The following format name is allowed:
EENT0100 The format of monitored resource input information in a cluster administrative domain.
Information about the server. When the manager type is *ADMDMN, the server is the cluster resource group associated with the cluster administrative domain.
The length of the server information. The length of the server information parameter must be set to the size of the SRVI0100 structure.
The format name of the server information. The following format name is allowed:
SRVI0100 The format of the server information when the server is a cluster.
Information returned which is specific to the server type. When the manager type is *ADMDMN, the following information is returned:
Information status. One byte which indicates the consistency of the retrieved information.
| 0 | The information is consistent for all active nodes in the cluster administrative domain. |
| 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: |
| Call this API on an active node in the cluster, if the node running the API is not active. | |
| Start Cluster Resource Services on the node running the API if it is not active. |
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 | BINARY(4) | Offset to first record |
| 12 | C | BINARY(4) | Length of fixed portion of record |
| 16 | 10 | BINARY(4) | Number of records returned |
| Note: Record entry information. These fields are repeated for each record entry returned. | |||
| BINARY(4) | Displacement to next record | ||
| CHAR(10) | Monitored resource type | ||
| CHAR(10) | Monitored resource library name | ||
| BINARY(4) | Global status | ||
| BINARY(4) | Resource status | ||
| BINARY(4) | Displacement to monitored resource name | ||
| BINARY(4) | Length of monitored resource name | ||
| BINARY(4) | Displacement to node array | ||
| BINARY(4) | Length of node array entry | ||
| BINARY(4) | Number of node array entries | ||
| BINARY(4) | Displacement to message information | ||
| BINARY(4) | Length of message information | ||
| Note: Use the displacements in the fixed portion of the record to get to the following fields. | |||
| CHAR(*) | Monitored resource name | ||
| CHAR(*) | Node array | ||
| CHAR(*) | Message information | ||
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Offset to first record |
| 12 | C | BINARY(4) | Length of fixed portion of record |
| 16 | 10 | BINARY(4) | Number of records returned |
| Note: Record entry information. These fields are repeated for each record entry returned. | |||
| BINARY(4) | Displacement to next record | ||
| CHAR(10) | Monitored resource type | ||
| CHAR(10) | Monitored resource library name | ||
| BINARY(4) | Global status | ||
| BINARY(4) | Resource status | ||
| BINARY(4) | Displacement to monitored resource name | ||
| BINARY(4) | Length of monitored resource name | ||
| BINARY(4) | Displacement to attribute list | ||
| BINARY(4) | Length of fixed portion of attribute list entry | ||
| BINARY(4) | Number of attribute list entries | ||
| Note: Use the displacements in the fixed portion of the record to get to the following fields. | |||
| CHAR(*) | Monitored resource name | ||
| CHAR(*) | Attribute list | ||
Attribute list. A list of attributes for the monitored resource described in the current record. This structure consists of a list of repeating entries. See Attribute List Entry Format for the format of a single entry.
Bytes available. The number of bytes of data available to be returned to the user. If all data is returned, this is the same as the number of bytes returned. If the receiver variable was not big enough to contain all of the data, this is the number of bytes that can be returned.
Bytes returned. The number of bytes of data returned to the user. This is the lesser of the number of bytes available to be returned or the length of the receiver variable. If the requested monitored resource is not monitored by the system, this value will be set to 20.
Displacement to attribute list. The displacement in bytes from the start of the current entry to the attribute list.
Displacement to message information. The displacement in bytes from the start of the current entry to the message information.
Displacement to monitored resource name. The displacement in bytes from the start of the current entry to the monitored resource name field.
Displacement to next record. The displacement in bytes from the start of the current entry to the next entry.
Displacement to node array. The displacement in bytes from the start of the current entry to the node array. This will be set to 0 if the global status for the monitored resource is not set to 1 (INCONSISTENT).
Global status. The status of the resource across the active cluster administrative domain. Possible values are:
| 0 | CONSISTENT | The values for all the resource's attributes monitored by the system are the same within the cluster administrative domain. |
| 1 | INCONSISTENT | One or more of the monitored attributes for a monitored resource entry are not set to the value known by the cluster administrative domain on one or more nodes in the domain. |
| 2 | PENDING | The values of the monitored attributes are in the process of being synchronized across the cluster administrative domain. |
| 3 | ADDED | The monitored resource entry and its attributes have been added to the monitored resource directory in the cluster administrative domain but has not yet been synchronized. |
Length of fixed portion of attribute list entry. The length, in bytes, of the fixed fields in an attribute list entry.
Length of fixed portion of record. The length of the fixed fields in the format description. If no records are returned, this field will be set to 0.
Length of message information. The length, in bytes, of the message information.
Length of monitored resource name. The length, in bytes, of the monitored resource entry name.
Length of node array entry. The length, in bytes, of the node array entry.
Message information. The message information associated with the monitored resource or attribute. See Message Information Format for the format of this data.
Monitored resource name. The name of the monitored resource entry for which information is returned.
Monitored resource library name. The name of the library of the monitored resource. Blanks will be returned for the monitored resource types *SYSVAL, *NETA, *ENVVAR, *TCPA, and *ALL.
Monitored resource type. The type of monitored resource. Possible values are:
| *USRPRF | User profile |
| *JOBD | Job description |
| *CLS | Class |
| *ASPDEV | Independent auxiliary storage pool (ASP) device description |
| *SYSVAL | System value |
| *NETA | Network attributes |
| *ENVVAR | System environment variable |
| *TCPA | TCP/IP attributes |
| *ALL | Return information for all monitored resource types |
Node array. The array of cluster node names that represents the list of nodes where a problem caused the global status of the monitored resource to be set to INCONSISTENT.
Number of attribute list entries. The number of entries in the attribute list. If the receiver variable is not large enough to hold all of the information, this number contains only the number of attribute list entries actually returned.
Number of node array entries. The number of entries in the node array.
Number of records returned. The number of entries in the DENR0100 or DENR0200 format returned. If the receiver variable is not large enough to hold all of the information, this number contains only the number of record entries actually returned. If no records are returned, this field is set to 0.
Offset to first record. The offset, in bytes, from the beginning of the receiver variable to the first record. If no entries are returned, the offset is set to zero.
Reserved. This field will be set to hexadecimal zeroes.
Resource status. The resource status of the monitored resource on the local node.The following values are valid:
| 0 | CURRENT | There are no pending updates for the monitored resource on this node. |
| 2 | DLTPND | The monitored resource has been deleted on a node in the cluster and the process has not fully completed for all nodes. |
| 3 | UPDPND | There are pending updates for the monitored resource on this node. |
| 4 | RSTPND | The monitored resource has been restored on a node in the cluster and the process has not fully completed for all nodes. |
| 5 | RNMPND | The monitored resource has been renamed on a node in the cluster and the process has not fully completed for all nodes. |
| 6 | MOVPND | The monitored resource has been moved on a node in the cluster and the process has not fully completed for all nodes. |
| 8 | DLTFAIL | The resource on has been deleted on a node in the cluster and the administrator needs to complete the process. |
| 9 | UPDFAIL | An update of the resource on this node has failed. |
| 10 | RSTFAIL | The resource has been restored on a node in the cluster and the administrator needs to complete the process. |
| 11 | RNMFAIL | The resource has been renamed on a node in the cluster and the administrator needs to complete the process. |
| 12 | MOVFAIL | The resource has been moved on a node in the cluster and the administrator needs to complete the process. |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Displacement to next attribute list entry |
| 4 | 4 | BINARY(4) | Global status |
| 8 | 8 | BINARY(4) | Data type |
| 12 | C | BINARY(4) | Displacement to attribute name |
| 16 | 10 | BINARY(4) | Length of attribute name |
| 20 | 14 | BINARY(4) | Displacement to attribute value |
| 24 | 18 | BINARY(4) | Length of attribute value |
| CHAR(*) | Attribute name | ||
| CHAR(*) | Attribute value | ||
Attribute name. The name of the attribute name.
Attribute value. The value of the attribute. If the global status for the resource is CONSISTENT, this is the value of the attribute across the active cluster administrative domain. If the global status is INCONSISTENT or PENDING, this value represents the last attempted change to the attribute within the active cluster administrative domain.
Data Type. The data type of the attribute value. Valid data types are:
| 0 | Character data |
| 1 | Binary data |
| 2 | Object data |
| 3 | Authority data |
| 4 | User profile options data |
| 5 | Supplemental groups data |
| 6 | Path data |
| 7 | Message log data |
| 8 | Text data |
| 9 | Environment variable data |
Displacement to attribute name. Displacement from the beginning of the current attribute list entry to the attribute name.
Displacement to attribute value. The displacement from the beginning of the current attribute list entry to the value.
Displacement to next attribute list entry. Displacement from the beginning of the current attribute list entry to the next attribute list entry. The value will be zero, if there are no more entries in the list.
Global status. The status of the resource attribute value across the active cluster administrative domain. Possible values are:
| 0 | CONSISTENT | The value for this attribute is the same on all active nodes in the cluster administrative domain. |
| 1 | INCONSISTENT | The value for this attribute is not the same on all active nodes in the cluster administrative domain. |
Length of attribute name. The length in bytes of the attribute name.
Length of attribute value. The length in bytes of the attribute value.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(7) | Message ID |
| 7 | 7 | CHAR(10) | Message file |
| 17 | 11 | CHAR(10) | Message library |
| 27 | 1B | CHAR(1) | Reserved |
| 28 | 1C | BINARY(4) | Displacement to message replacement data |
| 32 | 20 | BINARY(4) | Length of message replacement data |
| 36 | 24 | BINARY(4) | Message replacement data CCSID |
| 40 | 28 | CHAR(*) | Message replacement data |
Message information is available when the global status is INCONSISTENT.
Displacement to message replacement data. The displacement in bytes from the beginning of the message information to the message replacement data. If there is no message information data, this field is set to zero.
Length of message replacement data. The length, in bytes, of the message replacement data.
Message file. The message file.
Message ID. The message identifier.
Message library. The message library.
Message replacement data. The message replacement data.
Message replacement data CCSID. The coded character set identifier (CCSID) of the convertible character (CCHAR) portion of the exception data.
Reserved. Reserved field. This field will be set to hexadecimal zeroes.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Monitored resource input type |
| 10 | A | CHAR(10) | Monitored resource input library name |
| 20 | 14 | BINARY(4) | Length of monitored resource input name |
| 24 | 18 | CHAR(*) | Monitored resource input name |
Length of monitored resource input name. The length, in bytes, of the monitored resource name.
Monitored resource input library name. The name of the library for the specified monitored resource. Allowed values are:
| Blank | Specify a blank monitored resource library name for the monitored resource types *SYSVAL, *ENVVAR, *NETA, *TCPA, or *ALL. |
| Monitored resource library name | The name of the library for monitored resource types *USRPRF, *ASPDEV, *JOBD, and *CLS. Monitored resource types of *USRPRF and *ASPDEV must specify QSYS for the monitored resource library name. Library special values,e.g. *CURLIB or *LIBL, are not allowed. |
Monitored resource input name. The name of the monitored resource or list of resources for which information is returned. The allowed values are:
| Monitored resource name | The name of a monitored resource. |
| *ALL | Returns information for all monitored resources. |
Monitored resource input type. The type of monitored resource for which information is to be returned. Possible values are:
| *USRPRF | User profile |
| *SBSD | Subsystem description |
| *JOBD | Job description |
| *CLS | Class |
| *ASPDEV | Independent auxiliary storage pool (ASP) device description |
| *SYSVAL | System value |
| *NETA | Network attributes |
| *ENVVAR | System environment variable |
| *TCPA | TCP/IP attributes |
| *ALL | Return information for all monitored resource types |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of server defined output |
| 4 | 4 | CHAR(10) | Cluster name |
| 14 | D | CHAR(10) | Cluster administrative domain name |
| 24 | 18 | CHAR(30) | Reserved |
Cluster administrative domain name. The name of the cluster administrative domain where the monitored resource is monitored by the system.
Cluster name. The name of the cluster associated with the cluster administrative domain.
Length of server defined output. The length, in bytes, of the server defined output parameter. For a *ADMDMN manager type, this value must be 1.
Reserved. This field will be set to hexadecimal zeroes.
See Cluster basics for more information about using this API to retrieve monitored resource information in a cluster administrative domain.
Unless otherwise noted, all character strings are assumed to be in the CCSID of the program that calls this API.
| Message ID | Error Message Text |
|---|---|
| CPF1098 E | No authority to class &1 in library &2. |
| CPF2634 E | Not authorized to object &1. |
| CPF2697 E | The request did not complete in the time allotted. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C29 E | Object name &1 is not valid. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C3C E | Value for parameter &1 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 | Not authorized to object &2 in &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. |
| CPFA0AA E | Error occurred while attempting to obtain space. |
| CPFB0CE E | &1 special authority is required. |
| CPFBBB6 E | Library &1 not allowed for resource &2. |
| Top | Server Support APIs | APIs by category |