Parameter Definitions - Tivoli

Teradata Extension for Tivoli Storage Manager Administrator Guide
Product
Tivoli
Release Number
16.20
16.10
Published
May 2017
Language
English (United States)
Last Update
2019-03-22
dita:mapPath
beb1489436039198.ditamap
dita:ditavalPath
beb1489436039198.ditaval
dita:id
wkq1486409855180
Product Category
Teradata Tools and Utilities

The Teradata Access Module for Tivoli uses the IOPARM parameters shown in the following table. In some cases, if a parameter is not specified, the default value in the description column is assigned as the parameter name.

Parameter Definitions 
Parameter Value Type Description
CONFIG Directory Path Path to TSM client configuration file, dsm.opt. The DSMI_CONFIG environment variable typically establishes a basic environment context.
CONFIG, if indicated, is used for the actual TSM server connection.
DATASETNAME Directory Path User-defined high-level name of backup file in storage.

No default value exists, but if this parameter is not defined, the high-level name becomes the external name defined on the ARCMAIN FILEDEF parameter or the name on the FILE= clause. The FILE= clause is limited to eight alphanumeric values.

DATASETNAME can also contain substitute variables that generate unique names for the backup. However, if either of these variables are used, specify DATASETNAME in a file of command line defaults:
  • %time% is a substitution token replaced by the local date/time in the form: YYYYMMDD_HHMMSS where YYYY=Year, MM=Month, DD=Day, HH=Hour, MM=Minutes, and SS=seconds.
  • %date% is a substitute token replaced by the local date in the form: YYYYMMDD where YYYY=Year, MM=Month, and DD=Day.
DEFAULT Directory Path Path to the file of Teradata Access Module for Tivoli command line defaults. The parameter settings in this file are merged with parameter settings in the file indicated by the BARAM_DEFAULT environment variable and with any explicit command line parameters.

Parameter assignments are expanded at the point where DEFAULT is indicated with the last specification in left-to-right order-taking precedence. For example, the following command line causes the TDDSMC utility to use the TSM Client Options file (indicated in myopts.txt) last:

Tddsmc -config=mydsm.opt -default=myopts.txt

DIRDELIM Single non-blank character Override TSM default directory path delimiters in storage object names. By default, this value is a backslash (\) on Windows platforms and a forward slash (/) on UNIX platforms.
Specify this parameter only in the DEFAULT file.
FORMAT Quote string Default format string for Query Backup and Query Object command output of the TDDSMC utility.

This parameter has no bearing on ARCMAIN processing.
GENERATION Integer The backup file generation name to use for restore. The default value, 0 (zero), corresponds to the latest generation. A value that is:
  • Positive indicates the specific generation number in storage (active or inactive).
  • Negative indicates the relative generation number since the latest generation. For example, if the latest generation is 15, then Generation -2 is Generation 13.

    However, in this example, GENERATION=15 corresponds to the fifteenth backup that was ever performed, using the indicated DATASETNAME name.

Not specifying GENERATION restores the latest backup.
MGMTCLASS Name The TSM management class for all storage objects created by a backup operation. This parameter overrides any INCLUDE list specified in the TSM Client Options file, dsm.opt. Before using the parameter, define a management class with this name and a valid backup copy group with the TSM server. For more information, see the Tivoli Storage Manager for Windows: Administrator’s Guide.
NOHEADER Not applicable A single keyword to suppress the display of column headers for Query Backup and Query Object commands of the TDDSMC utility. Use this parameter to pipe the output to the sort utility.

This parameter has no bearing on ARCMAIN processing.