Limited supportBMC provides limited support for this version of the product. As a result, BMC no longer accepts comments in this space. If you encounter problems with the product version or the space, contact BMC Support.BMC recommends upgrading to the latest version of the product. To see documentation for that version, see UNLOAD PLUS for DB2 13.1.

UNLOAD PLUS EXEC statement

The UNLOAD PLUS EXEC statement specifies the module to be executed for the UNLOAD PLUS utility.

The UNLOAD PLUS module name is ADUUMAIN. The EXEC statement also specifies the utility parameters, which are described in Utility parameters on the UNLOAD PLUS EXEC statement.

You can use the REGION parameter to specify the region size on either your EXEC statement or your JOB statement. For recommendations, see REGION parameter.

REGION parameter

Include the REGION parameter on either your JOB statement or your EXEC statement to specify the region size (the amount of virtual storage used by the utility).

For the best performance, we recommend that you specify REGION=0M to allocate the optimal amount available virtual storage to the utility job. If your data center does not permit you to specify REGION=0M, specify the amount that allows the most virtual storage both above and below the 16-megabyte line. Using a region size that is less than optimal risks the following potential issues:

  • Running less efficiently, which could result in additional CPU and elapsed time
  • Encountering memory failures or jobs that fail when new versions implement changes that require additional memory

Important

If you specify a value for REGION other than 0M, ensure that you have an appropriate value set for the MEMLIMIT parameter, either as your site’s default SMF option or on your JOB statement or EXEC statement:

  • Specify NOLIMIT to allow unlimited above-the-bar memory.
  • If you are unable to specify NOLIMIT, specify at least 4 GB; if you are operating on LOB or XML data, specify at least 32 GB.

Utility parameters on the UNLOAD PLUS EXEC statement

The UNLOAD PLUS EXEC statement includes the following utility parameters:

  • Db2 subsystem ID or group attachment name
  • Utility ID
  • Restart parameter
  • TSO user ID for notification of progress made on the unload job
  • Message level
  • Installation options module

The following illustration shows the format of the EXEC statement:

 //<stepName> EXEC PGM=ADUUMAIN,
//  PARM='<ssid>,<utilityID>,<restartParameter>,<userID>,MSGLEVEL(n),<optionsModule>'

The UNLOAD PLUS utility parameters are positional. If you do not specify a value for a parameter (thus allowing the default value), you must substitute a comma for that parameter if additional parameters follow. The comma indicates that a parameter was omitted.

Db2 subsystem identifier (SSID)

This parameter specifies the four-character Db2 subsystem ID where the object resides.

If you do not specify the SSID, the utility uses the Db2 installation default from the DSNHDECP module. The utility depends on the application defaults module being named DSNHDECP. If you do not specify an SSID and the utility cannot find a module named DSNHDECP in your LINKLIST or STEPLIB, the utility terminates.

Note the following considerations when running the utility in a data sharing environment:

  • The utility supports the Db2 group attachment name capability. When you supply a group attachment name as the SSID, the utility uses it to connect all plans. The utility then determines the actual Db2 SSID from within that group to use for the current reorganization.
  • When you are restarting in a data sharing environment, the utility can use either the same member that was chosen in the original reorganization or any other member in the specified group.
  • When both of the following conditions exist, specify a member SSID for your reorganization job instead of a group attachment name. Ensure that the Db2 version of the SSID that you specify corresponds to the version of the Db2 load library that you specify in your STEPLIB.
    • You are using table space compression.
    • The subsystems in your data sharing group are not all at the same Db2 version level.

Utility identifier (utility ID)

This parameter specifies the 1- to 16-character utility ID that gives a unique name to a utility job. If you omit this parameter, the utility uses the default, userID.jobName. Each BMC utility job should have a unique ID.

Utility IDs that include special characters might cause the utility to generate invalid data set names when using dynamic allocation. For more information, see the DSNPAT or DSNAME option description.

Restart parameter

The restart parameter can have one of the following values:

  • Blank or not specified
  • NEW
  • TERM
  • MAINT

Important

Although UNLOAD PLUS accepts the restart values RESTART, RESTART(PHASE), NEW/RESTART, or NEW/RESTART(PHASE) if you specify one of them, the utility executes as if you specified NEW.

Blank or not specified

By not specifying a restart parameter, UNLOAD PLUS initiates a new BMC utility job. The utility ID that you specify cannot currently exist in the BMCUTIL table.

NEW

Specifying this value initiates a new BMC utility job or replaces an existing utility ID. Specifying this value allows you to start a utility without having to end the utility ID separately.

If you specify NEW and the utility ID has a status of X (executing), UNLOAD PLUS issues error message BMC50012E and ends with return code 8. For message explanations, access the BMC Documentation Center from the BMC Support Central site http://www.bmc.com/support.

TERM

Specifying this value terminates an existing utility, removes the utility ID from the BMCUTIL table, and removes the corresponding rows from the BMCSYNC table. After removing sync point and restart information, UNLOAD PLUS terminates without unloading. UNLOAD PLUS terminates with return code 0 regardless of whether the utility ID exists.

When specifying TERM, you need only minimal JCL. Your JCL must include at least a SYSPRINT DD statement and STEPLIB to the UNLOAD PLUS load library.

MAINT

Specifying this value forces MSGLEVEL(1) and causes UNLOAD PLUS to print the following information:

  • An options module report that lists the values in the installation options module that you are using
  • The values in the DSNHDECP module that UNLOAD PLUS uses
  • A summary report of all of the product fixes that you have applied

When you specify the MAINT parameter, the job ends without affecting any utility that is running.

For this parameter, you need only minimal JCL. Your JCL must include at least a SYSPRINT DD statement and STEPLIB to the UNLOAD PLUS and Db2 load libraries.

User identifier (user ID)

This parameter specifies the TSO user ID that the utility notifies after it completes each phase and after it completes the command execution.

Message level (MSGLEVEL)

This parameter controls which messages UNLOAD PLUS returns in the SYSPRINT and SYSPRIN2 data sets. MSGLEVEL(0) returns minimal messages. MSGLEVEL(1) returns additional messages to help you diagnose problems and fine-tune performance.

You can use the MSGLEVEL installation option to change the default value of this parameter.

Installation options module

This parameter allows you to identify which installation options module to use. If you include this parameter, you must specify the full name of the options module. If you omit this parameter, UNLOAD PLUS uses the default installation options module, ADU$OPTS.

For more information about installation options, see Installation-options. For information about how to create multiple installation options modules, see the Installation System documentation.

Related topics

Building-the-UNLOAD-PLUS-job

Running-UNLOAD-PLUS-jobs

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*