OUTPUT syntax options common to disk and tape data sets


This topic describes options that you can use to write data sets to either disk or tape. 


image-2024-6-21_12-15-46.png

BUFNO integer

When you make copies using the product, specify BUFNO for the named descriptor when you want to set a new value for the number of Db2 BSAM buffers. If you do not provide a new value, BUFNO defaults to the value of the BUFNO installation option. BMC AMI Utilities installation option default is 10. Valid values for BUFNO are in the range 0 through 99.

CATLG

Specify CATLG and either YES or NO (as appropriate) to redefine the MVS catalog directive for the named descriptor. If you are using the BMC AMI Utilities installation option defaults, this is CATLG YES.

If any SMS option (STORCLAS, DATACLAS, or MGMTCLAS) is used, BMC AMI Utilities force CATLG YES.

DATACLAS name

Specify DATACLAS name when you want to provide a new SMS data class name for the named descriptor. The value of name must be a valid SMS data class name, not exceeding eight characters.

If you do not specify DATACLAS for the named descriptor, BMC AMI Utilities use the installation option value (if any). If you do not want to use a value for DATACLAS and a value exists in the current default output descriptor, specify DATACLAS NONE in the OUTPUT statement.

When you specify DATACLAS, BMC AMI Utilities force CATLG=YES.

DISP dataSetName(argument1,argument2,argument3)

The dataSetName takes three arguments that define the disposition of the specified data set:

Initial status (argument1)

Value

Description

OLD

The data set exists before this step and this step requires exclusive (unshared) use of the data set.

SHR

The data set exists before this step and other jobs can share it.

NEW

A new data set is to be created in this step.

MOD

The behavior differs for new or existing data sets:

  • The data set exists and records are to be added to the end of it.

    Important

    The data set must be sequential.

  • A new data set is to be created.

Normal termination status (argument2)

Value

Description

CATLG

If the step terminates normally, the system places an entry pointing to the data set in the catalog.

Important

The data set is kept on the volume.

KEEP

The data set is kept on the volume if this step terminates normally.

DELETE

The data set is no longer needed if this step terminates normally.

Abnormal termination status (argument3)

Value

Description

CATLG

If the step terminates abnormally, the system places an entry pointing to the data set in the catalog.

Important

The data set is kept on the volume.

KEEP

The data set is kept on the volume if this step terminates abnormally.

DELETE

The data set is no longer needed if this step terminates abnormally.

 The default values differ for new or existing data sets:

  • If the data set exists, the default values are MOD,KEEP,KEEP
  • if data set is new, the default values are NEW,CATLG,DELETE

DSNAME dataSetName

Specify DSNAME and a data set name (dataSetName) to set a new default data set name.

You can construct dataSetName using the supported symbolic variables:

Variable

Description

&ATTACH

Db2 group attachment name or subsystem ID (up to four characters)

&DATE 1

Current date (in the form MMDDYY).

For more information, see +DATEFMT parameter.

The value of &DATE depends on what is specified in +DATEFMT() parameter.

  • +DATEFMT(ISO) uses yymmdd format
  • +DATEFMT(EUR)uses ddmmyy format
  • +DATEFMT(JIS) uses yymmdd format
  • +DATEFMT(USA) uses mmddyy format
  • +DATEFMT(DECP) uses format set in ZPARM

&DATEJ 1

Current Julian date (in the form YYYYDDD)

&DAY 1

Current day (in the format DD)

&DB

Database containing the space being used for this data set allocation (up to eight characters)

&DDNAME

DDname being used for this data set allocation (up to eight characters)

&GRPNM

Db2 data-sharing group name In a nondata-sharing environment

GRPNM contains the DB2 SSID (up to eight characters).

&HOUR 1

Current hour (in the format HH)

&JDATE 1

Current Julian date (in the form YYDDD)

&JDAY 1

Current Julian day (in the format DDD)

&JOBNAME

JOB name used in the JCL (up to 8 characters)

&MIN 1

Current minute (in the format MM)

&MINUTE 1

Current minute (in the format MM)

&MONTH 1

Current month (in the format MM)

&OBID

OBID of the table space (up to four character)

&PART

Partition being used for this data set allocation (up to four characters)

&PART1

Partition being used for this data set allocation (one character)

&PART2

Partition being used for this data set allocation (two characters)

&PART3

Partition being used for this data set allocation (three characters)

&PART4

Partition being used for this data set allocation (four characters)

&PART5

Partition being used for this data set allocation 5-character partition numbers, as follows:

  • Partition 1 = 00001
  • Partition 10 = 00010
  • Partition 100 = 00100
  • Partition 1000 = 01000
  • Nonpartitioned = 0000

&REPLACE

LOAD REPLACE being done (Y or N)

&RESUME

LOAD RESUME being done (Y or N)

&RTYPE

REORG type (TS or IX)

&SEC 1

Current second (in the format SS)

&SECOND 1

Current second (in the format SS)

&SEQ

Sequence number (5-figure statement number)

&SSID

The Db2 subsystem name or group name specified on the PARM=name attribute (up to four characters)

&STEPNAME

STEP name used in the JCL (up to 8 characters)

&SUBSTR

Returns a substring of resolved variable text of a specified length starting at a specified position in the text

&SUBSTR syntax

&SUBSTR.png

The following table describes the &SUBSTR parameters:

Parameter

Description

variable

Variable name supported by 

BMC AMI Utilities

start

Indicates the character position within resolved variable text that is to be the first character of the substring. The first character in resolved variable text is character position 1.

length

(Optional) Total number of characters in resolved variable text to be used in the substring. The default value of length is (variable length - start position+1).

Example

OUTPUT COPYLP 
DSNAME NGT.LP.&SUBSTR(&DB,1,4).&TS..P&PART4(+1) 
STORCLAS NGT GDGLIMIT 4 SPACE(10, 10) CYL

&TIME 1

Current time (in the form HHMMSS)

&TIME4 1

Current time (in the form HHMM)

&TS

Table space (up to eight characters)

&TSIX

Table space or index space (up to eight characters)

&UID

Job user ID (up to eight characters)

&UNIQ

Unique characters (up to eight characters)

&USER1

The value of the +USER1(userVariable) parameter

&USER2

The value of the +USER2(userVariable) parameter

&USERID

Job user ID (up to eight characters)

&UTIL

BMC utility ID (up to sixteen characters)

&UTILPFX

BMC utility ID prefix (up to the first eight characters of UTIL id)

&VCAT

VCATNAME specified in the Db2 catalog for the table space (up to eight characters)

&VER

The version of the BMC AMI Utilities being executed (for example, 1310)

&VER2

The first two characters of the version of the BMC AMI Utilities being executed (for example, 13)

&VER3

The first three characters of the version of the BMC AMI Utilities being executed (for example, 131)

&YEAR 1

Current year (in the format YY)

 Use the +TIMESTAMP parameter to determine values for symbolic variables when a utility allocates the output data set. If +TIMESTAMP is set to CONSTANT, all TIMESTAMP &symbolics will have the same value. For more information, see TIMESTAMP.

ENCIPHER

Use the ENCIPHER option to indicate whether you want to make encrypted copies.

Value

Description

ENCIPHER NO

ENCIPHER NO is the default value and specifies that BMC AMI Copy should not make encrypted copies.

ENCIPHER YES

ENCIPHER YES indicates that you want to create encrypted copies. ENCIPHER YES in the OUTPUT command works with the COPY and COPY IMAGECOPY commands to encrypt all image copies sent to the device specified in the OUTPUT command.


Important

  • ENCIPHER is supported only by BMC AMI Copy, and is ignored if it appears in an OUTPUT statement for other BMC AMI Utilities.
  • Encryption is a feature of the Recovery Management for Db2 solution and requires a valid Recovery Management solution password.
  • ENCIPHER is incompatible with DSSNAP and with compressed indexes.

EXPOUT

Specify EXPOUT YES or NO to tell BMC AMI Utilities to create a migration file for data migration. The default value is NO.

Important

You need one of the following valid passwords to use this feature:

  • A Recovery Management solution password
  • A Database Administration solution password

EXPOUT YES on the OUTPUT command used with an EXPORT command creates a migration file in BMC AMI Copy. The migration file is then used by the BMC AMI Recover MIGRATE and IMPORT commands for data movement.

GDGLIMIT integer

This value is used for the GDG LIMIT if you need to define a base GDG.

MGMTCLAS name

Specify MGMTCLAS name when you want to provide a new SMS management class name for the named descriptor. The name value must be a valid SMS management class name, not exceeding eight characters.

If you do not specify MGMTCLAS for the named descriptor, BMC AMI Utilities use the installation option value (if any). If you do not want to use a value for MGMTCLAS and a value exists in the current default output descriptor, specify MGMTCLAS NONE in the OUTPUT statement.

When you specify MGMTCLAS, BMC AMI Utilities force CATLG=YES.

MODELDCB dataSetName

Specify MODELDCB and a cataloged data set name (dataSetName) to redefine the model DCB for the named descriptor. If you do not specify MODELDCB for the named descriptor, BMC AMI Utilities use the installation option value (if any).

To specify that no model DCB be used, use MODELDCB NONE.

The specified model data set must be allocated on a mounted direct access volume; BMC AMI Utilities copy the DCB information from the data set label.

You can construct dataSetName using the supported symbolic variables.

STORCLAS name

Specify STORCLAS name when you want to provide a new SMS storage class name for the named descriptor. The value of name must be a valid SMS storage class name, not exceeding eight characters.

If you do not specify STORCLAS for the named descriptor, BMC AMI Utilities use the installation option value (if any). If you do not want to use a value for STORCLAS and a value exists in the current default output descriptor, specify STORCLAS NONE in the OUTPUT statement.

When you specify STORCLAS, BMC AMI Utilities force CATLG=YES.

THRESHOLD(limit limit_unittype, outputName

Use the THRESHOLD option to specify a threshold quantity above which BMC AMI Utilities will apply the OUTPUT option that you specify.

Important

Only COPYDDN and RECOVERYDDN data sets in BMC AMI Reorg and BMC AMI Load support the THRESHOLD option.

Valid values are as follows:

  • limit represents the maximum quantity that is allowed when you use the OUTPUT command.
    limit_unittype specifies the abbreviation for the unit type (cylinders, gigabytes, or megabytes):
    • CYL
    • GB
    • MB
  • outputName represents the name of the OUTPUT option that BMC AMI Utilities should use if the threshold limit is exceeded. Several restrictions apply:
    • Before the THRESHOLD option, the SYSIN must include a separate OUTPUT command that defines the output name that THRESHOLD will use.

      Example

      Valid SYSIN because the OUTPUT command in line 1 defines the output name (LPTAPE) that the THRESHOLD option uses in line 4:

      OUTPUT LPTAPE DSNAME(&USER..COPYLP.&DB..&TS..P&PART4(+1)
        UNIT(CART)
      OUTPUT LPDASD DSNAME(&USER..COPYLP.&DB..&TS..P&PART4(+1)
        UNIT(SYSDA) THRESHOLD(4 GB, LPTAPE)...
    • That initial OUTPUT command cannot contain a THRESHOLD option.

      Example

      Invalid because the output name in line 4 references an OUTPUT statement that also contains a THRESHOLD option (line 2):

      OUTPUT LPTAPE DSNAME(&USER..COPYLP.&DB..&TS..P&PART4(+1)
        UNIT(CART) THRESHOLD(256 GB, BIGTAPE)...
      OUTPUT LPDASD DSNAME(&USER..COPYLP.&DB..&TS..P&PART4(+1)
        UNIT(SYSDA) THRESHOLD(4 GB, LPTAPE)...
    • The statement that contains the THRESHOLD option cannot cite the same output name that the THRESHOLD option uses.

      Example

      Invalid because the THRESHOLD option and the statement that contains it use the same output name, LPDASD:

      OUTPUT LPDASD DSNAME(&USER..COPYLP.&DB..&TS..P&PART4(+1)
        UNIT(SYSDA) THRESHOLD(4 GB, LPDASD)...

UNIT

Specify UNIT and a new tape or disk unit name when you want to override the default unit name. The BMC AMI Utilities default is SYSALLDA. If you specify a new name, BMC AMI Utilities use it for UNIT.

UNITCNT 

Use UNITCNT to specify the unit count used for dynamic allocation. Valid values are 0 through 59. The default value is 0. The value 0 means that no unit count is specified for the allocation.

If you do not want to use a value for UNITCNT and a value exists in the current default output descriptor, specify UNITCNT 0 in the OUTPUT statement.

Specifying UNITCNT 2 for tape output will allocate two tape drives. When a tape volume is at the end of the tape, BMC AMI Utilities begins writing on the second drive immediately. This allows you to eliminate time spent waiting for tape rewind.

Specifying UNITCNT 11 for disk output enables BMC AMI Utilities to allocation of primary and 15 secondary extents on up to 11 volumes, reducing the risk of getting B37 abends.

VOLCNT

To set VOLCNT integer for the named descriptor, specify the largest number of volumes you expect BMC AMI Utilities to process when unloading a single data set. Valid values are 0 through 255. The default value is 1.

For disk data sets, this option limits the values of the VOLUMES, LPVOLS, LBVOLS, RPVOLS, and RBVOLS options. For both tape and disk data sets, the integer must be equal to or greater than the number of volumes produced for the single largest output data set, whether or not you use stacked output.  

For a nonspecific disk data set allocation, VOLCNT is ignored. Use UNITCNT to request a multi-volume disk data set.

If you do not specify VOLCNT for the named descriptor, BMC AMI Utilities computes the volume count based on the amount of data, adjusted for the estimated space required.

Important

System requirements restrict the number of volumes that can be used for one data set to 59.

 

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