DB2 Version 10.1 for Linux, UNIX, and Windows

db2UtilityControl API - Set the priority level of running utilities

Controls the priority level of running utilities. Can be used to throttle and unthrottle utility invocations.

Authorization

One of the following authorities:

SYSADM
SYSCTRL
SYSMAINT

Required connection

Instance

API include file

db2ApiDf.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  db2UtilityControl (
   db2Uint32 version,
   void * pUtilityControlStruct,
   struct sqlca * pSqlca);

typedef SQL_STRUCTURE db2UtilityControlStruct
{
   db2Uint32 iID;
   db2Uint32 iAttribute;
   void *pioValue;
} db2UtilityControlStruct;

SQL_API_RC SQL_API_FN
  db2gUtilityControl (
   db2Uint32 version,
   void * pgUtilityControlStruct,
   struct sqlca * pSqlca);

typedef SQL_STRUCTURE db2gUtilityControlStruct
{
   db2Uint32 iID;
   db2Uint32 iAttribute;
   void *pioValue;
} db2gUtilityControlStruct;

db2UtilityControl API parameters

version: Input. Specifies the version and release level of the structure passed in as the second parameter, pUtilityControlStruct.
pUtilityControlStruct: Input. A pointer to the db2UtilityControlStruct structure.
pSqlca: Output. A pointer to the sqlca structure.

db2UtilityControlStruct data structure parameters

iId

Input. Specifies the ID of the utility to modify.

iAttribute

Input. Specifies the attribute to modify. Valid values (defined in db2ApiDf header file, located in the include directory) are:

DB2UTILCTRL_PRIORITY_ATTRIB: Modify the throttling priority of the utility.

pioValue

Input. Specifies the new attribute value associated with the iAttribute parameter.

Note: If the iAttribute parameter is set to DB2UTILCTRL_PRIORITY_ATTRIB, then the pioValue parameter must point to a db2Uint32 containing the priority.

Usage notes

SQL1153N will be returned if there is no existing utility with the specified iId. This may indicate that the function was invoked with invalid arguments or that the utility has completed.

SQL1154N will be returned if the utility does not support throttling.