Administrative API Reference

db2ResetMonitor - Reset Monitor

Resets the database system monitor data of a specified database, or of all active databases, for the application issuing the call.

Scope

This API only affects the node on which it is issued.

Authorization

One of the following:

• sysadm
• sysctrl
• sysmaint

Required Connection

Instance. If there is no instance attachment, a default instance attachment is created.

To reset the monitor switches for a remote instance (or a different local instance), it is necessary to first attach to that instance.

Version

db2ApiDf.h

C API Syntax

int db2ResetMonitor  (db2Uint32	version,
                        void*           pParamStruct,
                        struct sqlca*   sqlca);
 
typedef struct
{
        db2Uint32                       iResetAll;
        char                            *piDbAlias;
        db2Uint32                       iVersion;
        db2int32                        iNodeNumber;
}db2ResetMonitorData;

API Parameters

version

Input. Specifies the version and release level of the structure passed as the second parameter pParamStruct.

pParamStruct

Input. A pointer to the db2ResetMonitorData structure.

sqlca

Output. A pointer to the sqlca structure. For more information about this structure, see SQLCA.

iResetAll

Input. The reset flag.

piDbAlias

Input. A pointer to the database alias.

iVersion

Input. Version ID of the database monitor data to collect. The database monitor only returns data that was available for the requested version. Set this parameter to one of the following symbolic constants:

• SQLM_DBMON_VERSION1
• SQLM_DBMON_VERSION2
• SQLM_DBMON_VERSION5
• SQLM_DBMON_VERSION5_2
• SQLM_DBMON_VERSION6
• SQLM_DBMON_VERSION7

Note:

If SQLM_DBMON_VERSION1 is specified as the version, the APIs cannot be run remotely.

iNodeNumber

Input. The node where the request is to be sent. Based on this value, the request will be processed for the current node, all nodes or a user specified node. Valid values are:

• SQLM_CURRENT_NODE
• SQLM_ALL_NODES
• node value

Note:

For standalone instances SQLM_CURRENT_NODE must be used.

Usage Notes

Each process (attachment) has its own private view of the monitor data. If one user resets, or turns off a monitor switch, other users are not affected. When an application first calls any database monitor function, it inherits the default switch settings from the database manager configuration file (see sqlfxsys - Get Database Manager Configuration). These settings can be overridden with db2MonitorSwitches - Get/Update Monitor Switches.

If all active databases are reset, some database manager information is also reset to maintain the consistency of the data that is returned.

This API cannot be used to selectively reset specific data items or specific monitor groups. However, a specific group can be reset by turning its switch off, and then on, using db2MonitorSwitches - Get/Update Monitor Switches.

For detailed information about the use of the database monitor APIs, and for a summary of all database monitor data elements and monitoring groups, see the System Monitor Guide and Reference.

See Also

db2MonitorSwitches - Get/Update Monitor Switches

db2GetSnapshot - Get Snapshot

db2GetSnapshotSize - Estimate Size Required for db2GetSnapshot() Output Buffer.