DB2 Version 10.1 for Linux, UNIX, and Windows

db2ResetAlertCfg API - Reset the alert configuration of health indicators

Resets the health indicator settings for specific objects to the current defaults for that object type or resets the current default health indicator settings for an object type to the install defaults.

Important: This command or API has been deprecated and might be removed in a future release because the health monitor has been deprecated in Version 9.7. It is not supported in DB2® pureScale® environments. For more information, see Health monitor has been deprecated..

Authorization

One of the following authorities:

SYSADM
SYSMAINT
SYSCTRL

Required connection

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

API include file

db2ApiDf.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  db2ResetAlertCfg (
   db2Uint32 versionNumber,
   void * pParmStruct,
   struct sqlca * pSqlca);

typedef SQL_STRUCTURE db2ResetAlertCfgData
{
   db2Uint32 iObjType;
   char *piObjName;
   char *piDbName;
   db2Uint32 iIndicatorID;
} db2ResetAlertCfgData;

db2ResetAlertCfg API parameters

versionNumber: Input. Specifies the version and release level of the structure passed as the second parameter pParmStruct.
pParmStruct: Input. A pointer to the db2ResetAlertCfgData structure.
pSqlca: Output. A pointer to the sqlca structure.

db2ResetAlertCfgData data structure parameters

iObjType

Input. Specifies the type of object for which configuration should be reset. Valid values (defined in db2ApiDf header file, located in the include directory) are:

DB2ALERTCFG_OBJTYPE_DBM
DB2ALERTCFG_OBJTYPE_DATABASES
DB2ALERTCFG_OBJTYPE_TABLESPACES
DB2ALERTCFG_OBJTYPE_TS_CONTAINERS
DB2ALERTCFG_OBJTYPE_DATABASE
DB2ALERTCFG_OBJTYPE_TABLESPACE
DB2ALERTCFG_OBJTYPE_TS_CONTAINER

piObjName

Input. The name of the table space or table space container when object type, iObjType, is set to DB2ALERTCFG_OBJTYPE_TS_CONTAINER or DB2ALERTCFG_OBJTYPE_TABLESPACE. The name of the table space container is defined as tablespace-numericalID.tablespace-container-name.

piDbname

Input. The alias name for the database for which configuration should be reset when object type, iObjType, is set to DB2ALERTCFG_OBJTYPE_TS_CONTAINER, DB2ALERTCFG_OBJTYPE_TABLESPACE, and DB2ALERTCFG_OBJTYPE_DATABASE.

iIndicatorID

Input. The health indicator for which the configuration resets are to apply.

Usage notes

The current default for the object type is reset when iObjType is DB2ALERTCFG_OBJTYPE_DBM, DB2ALERTCFG_OBJTYPE_DATABASES, DB2ALERTCFG_OBJTYPE_TABLESPACES, DB2ALERTCFG_OBJTYPE_TS_CONTAINERS or when piObjName and piDbName are both NULL. If iObjType is DB2ALERTCFG_OBJTYPE_DATABASE, DB2ALERTCFG_OBJTYPE_TABLESPACE, DB2ALERTCFG_OBJTYPE_TS_CONTAINER and piDbName and piObjName (not needed for database) are specified, then the current settings for that specific object will be reset.