Remove Monitored Resource Entry (QfpadRmvMonitoredResourceEntry) API
Required Parameter Group:
| 1 | Manager type | Input | Char(10) |
| 2 | Monitored resource information | Input | Char(*) |
| 3 | Length of monitored resource information | Input | Binary(4) |
| 4 | Format of monitored resource information | Input | Char(8) |
| 5 | Server information | Input | Char(*) |
| 6 | Length of server information | Input | Binary(4) |
| 7 | Format of server information | Input | Char(8) |
| 8 | Server defined output | Output | Char(*) |
| 9 | Error code | I/O | Char(*) |
Service Program Name: QFPADAP1
Default Public Authority: *EXCLUDE
Threadsafe: Yes
The Remove Monitored Resource Entry (QfpadRmvMonitoredResourceEntry) API removes a Monitored Resource Entry (MRE) from a cluster administrative domain. A monitored resource is a system object or a set of attributes not associated with a specific system object, such as the set of system environment variables. Monitored resource entries are added using the Add Monitored Resource Entry (QfpadAddMonitoredResourceEntry) API.
This API will do the following when removing a monitored resource entry from a cluster administrative domain:
- Removes the monitored resource entries from all nodes in the cluster administrative domain.
- Once the monitored resource entry is removed, changes to the monitored resource will not be synchronized within the cluster administrative domain.
- Any system objects that were created or any system environment variables that were added when a monitored resource was added to the cluster administrative domain will not be deleted. The user must manually delete any resources that are no longer needed.
Restrictions:
- When removing monitored resource entries from a cluster administrative domain, the cluster administrative domain must exist and all nodes in the domain must be active.
- Monitored resources cannot be removed when the cluster administration domain is partitioned.
- The program that calls this API must be running under a user profile that exists on every node in the cluster administrative domain.
- This API can only be called from a cluster node in the domain node list of the cluster administrative domain.
- This API operates in an asynchronous mode. See Behavior of Cluster Resource Services APIs for more information.
Authorities and Locks
System configuration (*IOSYSCFG) special authority is required to use this API.
- Configuration Object Authority (applies to a configuration object for which the MRE is removed)
- *OBJMGT
- Library Authority
- *EXECUTE
- NWS Configuration Authority (applies to an NWS configuration for which the MRE is removed)
- *OBJEXIST
- NWS Storage Space Authority (applies to an NWS storage space for which the MRE is removed)
- *OBJEXIST
- Authorization List Authority (Applied to an authorization list for which the MRE is removed)
- *ALLOBJ or ownership
- Request Information User Queue Authority
- *OBJOPR, *ADD
- Request Information User Queue Library Authority
- *EXECUTE
- Request Information User Queue Lock
- *EXCLRD
Required Parameter Group
- Manager type
- INPUT; CHAR(10)
The management function which monitors the resource. *ADMDMN must be specified.
- Monitored resource information
- INPUT; CHAR(*)
The monitored resource information provided as input.
- Length of monitored resource information
- INPUT; BINARY(4)
The length of the monitored resource information.
- Format of monitored resource information
- INPUT; CHAR(8)
The format name of the monitored resource information. The following format name is allowed:
EENT0100 The format of monitored resource information in a cluster administrative domain.
- Server information
- INPUT; CHAR(*)
The information about the server which monitors the resource. When the manager type is *ADMDMN, the server is the cluster administrative domain.
- Length of server information
- INPUT; BINARY(4)
The length of the server information. The length of the server information parameter must be set to the size of the SRVI0100 structure.
- Format of server information
- INPUT; CHAR(8)
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.
- Server defined output
- OUTPUT; CHAR(*)
When the manager type is *ADMDMN, the server defined output contains the 16 character request handle. The request handle is a unique string or handle that identifies this API call. It is used to associate this call to any responses placed on the user queue specified in the results information parameter. The API will generate the request handle and return the handle to the caller of the API.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Input Parameter Section
The following information is returned in the input parameter section. For detailed descriptions of the fields in this table, see Field Descriptions.Monitored Resource Entry (EENT0100 Format)
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Monitored resource type |
| 10 | A | CHAR(10) | Monitored resource library name |
| 20 | 14 | BINARY(4) | Length of monitored resource name |
| 24 | 18 | CHAR(*) | Monitored resource name |
Field Descriptions
Length of monitored resource name. The length in bytes of the monitored resource name.
Monitored resource library name. The name of the monitored resource library. The allowed values are:
| Blank | Specify a blank monitored resource library name for the monitored resource entry types *SYSVAL, *ENVVAR, *NETA, *TCPA or *NWSSTG. |
| Monitored resource library name | Specify the library name for the monitored resource types which are system objects. The library name must be QSYS for user profiles, configuration objects or authorization lists. The library name must be QUSRSYS for *NWSCFG resources. Library special values, e.g. *CURLIB or *LIBL, are not allowed. |
Monitored resource name. The name of the monitored resource.
Monitored resource type. The type of monitored resource. The allowed 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. |
| *NWSH | NWSH device description. |
| *NWSSTG | Network server storage. |
| *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. |
Server Information (SRVI0100 Format)
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of server defined output |
| 4 | 4 | CHAR(10) | Cluster name |
| 14 | E | CHAR(10) | Cluster administrative domain name |
| 24 | 18 | CHAR(30) | Results information |
Field Descriptions
Cluster administrative domain name. The name of the cluster administrative domain.
Cluster name. The name of the cluster.
Length of server defined output. The length, in bytes, of the server defined output parameter for this API. If the manager type is *ADMDMN, this value must be 16.
Results information. This field identifies a qualified user queue field and is followed by a reserved field.
| Qualified user queue | Completion information is returned to this user queue, which exists on the node from which the API was called, after the function has completed. See the Usage Notes section of this API for a description of the data that is placed on this queue. This is a 20-character field. The first 10 characters contain the user queue name, and the second 10 characters contain the user queue library name. No special values are supported. QTEMP, *LIBL, *CURLIB are not valid library names. The attributes of this user queue must be keyed. |
| Reserved | The last 10 characters of the results information are reserved and must be set to hexadecimal zero. |
Usage Notes
Removing a Monitored Resource Entry (MRE) in a Cluster Administrative Domain
See Cluster administrative domain for more information about using this API to remove monitored resource entries in a cluster administrative domain.
Results Information User Queue
Asynchronous results are returned to a user queue specified by the Results Information parameter of the API. See Cluster APIs Use of User Queues and Using Results Information for details on how to create the results information user queue, the format of the entries, and how to use the data placed on the queue. The data is sent to the user queue in the form of a message identifier and the substitution data for the message (if any exists). The following identifies the data sent to the user queue (excluding the message text).
| Message ID | Message Text |
|---|---|
| CPCBB01 C | Cluster Resource Services API &1 completed. |
| CPF3C21 D | Format name &1 is not valid. |
| CPF3CF2 D | Error(s) occurred during running of &1 API. |
| CPFBB17 D | &1 API cannot be processed in cluster &2. |
| CPFBB2D D | Timeout detected while waiting for a response. |
| CPFBB35 D | The user profile name &1 is not valid for this request. |
| CPFBB39 E | Current user does not have IOSYSCFG special authority. |
| CPFBB47 D | Cluster Resource Services detected an error and may have ended abnormally. |
| CPFBB48 D | Cluster Resource Services error detected. |
| CPFBBB9 D | Cluster administrative domain &1 internal error. |
Error Messages
Messages that are delivered through the error code parameter are listed here. The data (messages) sent to the results information user queue are listed in the Usage Notes above.
| 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. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C29 E | Object name &1 is not valid. |
| CPF3C39 E | Value for reserved field 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 | 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. |
| CPFA0AA E | Error occurred while attempting to obtain space. |
| CPFAA03 E | Monitored resource entry not found. |
| CPFAA05 E | Value specified for Manager Type not valid. |
| CPFAA06 E | Length specified in parameter &1 not valid. |
| CPFAA07 E | Field value within structure is not valid. |
| CPFAA09 E | Length of monitored resource name not valid. |
| CPFAA0A E | Length of server information not valid. |
| CPFB0CE E | &1 special authority is required. |
| CPFBB02 E | Cluster &1 does not exist. |
| CPFBB0A E | Cluster node &1 in cluster &2 is not active. |
| CPFBB0F E | Cluster resource group &1 does not exist in cluster &2. |
| CPFBB20 E | Cluster partition detected for cluster &1 by cluster node &2. |
| CPFBB26 E | Cluster Resource Services is not active or not responding. |
| CPFBB32 E | Attributes of user queue &1 in library &1 are not valid. |
| CPFBB39 E | Current user does not have IOSYSCFG special authority. |
| CPFBB46 E | Cluster Resource Services internal error. |
| CPFBBB6 E | Library &1 not allowed for resource &2. |
| CPFBBBD E | Resource type &1 not valid. |
API introduced: V5R4
[ Back to top | Cluster APIs | APIs by category ]