XSUTALLO (VSAM data set dynamic allocation) automation control point


Use the XSUTALLO automation control point to set space allocation values and a list of volumes for the data set allocation

The product invokes this automation control point immediately before invoking an IDCAMS DEFINE for a Db2 space (This occurs after the clustering index is read and the reorganization is initiated).

Variables

The following table describes the variables used in the XSUTALLO automation control point:


Variable name

Contents

Possible values

cisize

CI size

Not applicable

dataclas

SMS data class

Optional

Must not exceed 8 characters

db2dclas

ZPARM data class

You can change this variable.

  • SMSDCFL (for a table space)
  • SMSDCIX (for an index)

dbname

Database name of the object being processed

Not applicable

dsname

Name of the Db2 object data set name

Value in the following form:

VCATName.DSNDBC.databaseName.spaceName.I0001.Annn

dssize

Largest size for each partition or LOB data set

Value in kilobytes

A value of 0 indicates that no DSSIZE is specified.

freepage

Number of pages between empty pages in the table space

Not applicable

instance

Sequence number of the allocation attempt or retry

A value of 0 indicates that this is the first attempt to allocate the data set.

ixcreator

Creator of the index

Blank if not an index

ixname

Name of the index

Blank if not an index

large

Whether the object being processed was defined as LARGE

  • Y (yes)
  • N (no)

lob

Whether the object being processed is a LOB

  • Y (yes)
  • N (no)

maxretry

Maximum number of times to retry the call to XSUTALLO if a failure occurs while allocating the shadow VSAM data set

0 (default) through 255

mgmtclas

SMS management class

Optional

Must not exceed 8 characters

part

Partition number of the object

Not applicable

parts

Total number of partitions

Not applicable

pctfree

Percentage of free space ineach data page of the table space

Not applicable

piecesize

Value of the piece size for any nonpartitioned indexes

Same value as in the Db2 catalog, in kilobytes

primary

Primary quantity used to perform the DEFINE, in 4 KB units

This value will be limited by piecesize.

You can change this value.

Obtained from the value computed by the +ALLO parameter

priqty

Primary quantity from the Db2 catalog

Not applicable

rc

Return code for this automation control point

secondary

Secondary quantity used to perform the DEFINE, in 4 KB units

You can change this value.

Not applicable

seqty

Secondary quantity from the Db2 catalog

Not applicable

sortvols

Whether the list of SYSIBM.SYSVOLUMES, used for the ALTER ADDVOLUMES statement, is to be sorted according to the amount of available free space.

Warning

Important

Non-SMS related Db2-managed volumes only

  • Y (yes, default)
  • N (no)

stogroup

Storage group name (for Db2-managed objects)

8-character maximum

storclas

SMS storage class

Optional

Must not exceed 8 characters

stotype

Storage group type

  • I (Db2-managed)
  • E (user-managed)

stogvol

Volumes in a storage group, separated by blanks (for Db2-managed objects)

Not applicable

tsname

Table space name

Not applicable

used

Expected number of 4 KB pages for the object

For a nonpartitioned index, this will be the aggregate size of the entire index, regardless of piecesize.

Not applicable

volumes

List of volumes used to perform the IDCAMS DEFINE

You can change this value

Obtained from the current object or from the +VOLUMES parameter

Return codes

The XSUTALLO automation control point returns the following return codes:


Return code

Description

0

(default value) Signifies normal completion

No action is required.

Any other value

Abnormal termination

Set the return code to any non-zero value to cancel the entire job.

Usage considerations

You can use the _lspace REXX function with this automation control point to obtain space information from volumes and arrange a volume list that is suitable for the DEFINE. You can change primary and secondary values and you can base these on space statistics already gathered. For more information about the _lspace function, see _lspace-function.


 

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

BMC AMI Utility Manager for Db2 13.1