Remove Monitored Resource Entry (QfpadRmvMonitoredResourceEntry) API

The Remove Monitored Resource Entry (QfpadRmvMonitoredResourceEntry) API removes a Monitored Resource Entry (MRE) from the monitored resource directory. 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. Monitored resource entries are added using the Add Monitored Resource Entry (QfpadAddMonitoredResourceEntry) API.

This API will do the following when the manager type is *ADMDMN:

• Removes the monitored resource entries on 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 monitored resource directory will not be removed. The user must manually delete any resources that are no longer needed.

This API requires the following if the manager type is *ADMDMN:

• 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.
• Resources and attributes cannot be removed from the monitored resource directory 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 operates in an asynchronous mode. See Behavior of Cluster Resource Services APIs for more information.

Authorities and Locks

General Authority

System configuration (*IOSYSCFG) special authority is required to use this API.

The caller of the API will need authority to retrieve the value of the monitored resource entry's attributes on the source system and authority to create or change the monitored resource entry.

• Security Administrator (*SECADM) special authority is required to remove a monitored resource entry (MRE) for user profile.
• Job Control (*JOBCTL) special authority is required to remove a monitored resource entry (MRE) for system environment variable.
• *USE authority to the CHGSYSVAL command, plus the authority required to change the system value specified, are required to remove a monitored resource entry (MRE) for system value.

User queue

The following authorities and locks are required for the user queue specified in the results information parameter.

User Queue Authority

     *OBJOPR and *ADD

User Queue Library Authority

     *EXECUTE

User Queue Lock

     *EXCLRD

Required Parameter Group

Manager type

INPUT; CHAR(10)

The management function which is to monitor 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 where the monitored resource will be monitored by the system. When the manager type is *ADMDMN, the server is the cluster resource group associated with 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

Monitored Resource Entry (EENT0100 Format)

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:

Monitored resource name. The name of the monitored resource.

Monitored resource type. The type of monitored resource. The allowed values are:

Server Information (SRVI0100 Format)

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 basics for more information about using this API to remove a monitored resource entry in a cluster administrative domain.

Unless otherwise specified, all character strings are assumed to be in the CCSID of the program that calls this API.

The following identifies the data sent to the user queue (excluding the message text).

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.