Catalog Field Names

Table 1 shows the catalog field names.

Table 1. Catalog Field Names
Rep Type Length Name Description
no Character 36 ACTOKEN Active compression dictionary token
no Fixed 2 AKEYPOS The relative position in the data record of this AIX® key. Only applicable for catalog entry types of AIX. Note that the field is only valid if the component type is "D" and the record type is for a alternate index.
no Fixed 8 AMDCIREC Control interval size for 4 bytes and maximum record size for 4 bytes
no Fixed 4 AMDKEY Relative position of KSDS key for 2 bytes and key length of KSDS key for 2 bytes
yes Character 45 ASSOC A repeating list of catalog records associated with this entry. Consists of a 1-byte value similar to field name ENTYPE, followed by the 44-byte name of the association. If the name contains system symbolics, the name and type are resolved before being returned.
no Bitstring 1 ASSOCSYB Indicates whether the entry is a symbolic.
  • X'00' - The entry is not a symbolic
  • X'80' - The entry is a symbolic
yes Character 45 ASSOCSYM A repeating list of catalog records associated with this entry. Consists of a 1-byte value similar to field name ENTYPE, followed by the 44-byte name of the association. If the name contains system symbolics, they are not resolved.
no Bitstring 1 ATTR1 Attributes:
  1... ....     Speed
  .1.. ....     Unique
  ..1. ....     Reusable
  ...1 ....     Erase
  .... 1...     ECSHARING - ICF catalogs only
  .... .1..     Inhibit update
  .... ..1.     Temporary export
  .... ...1     Track overflow
no Bitstring 1 ATTR2 Share attributes
  11.. ....     Region (00 = 1, 01 = 2, 10 = 3, 11 = 4)
  ..11 ....     System (00 = 1, 01 = 2, 10 = 3, 11 = 4)
  .... xxxx     Reserved
no Fixed 2 BUFND The number of buffers requested for Data
no Fixed 2 BUFNI The number of buffers requested for Index
no Fixed 4 BUFSIZE Maximum buffer size
Start of changenoEnd of change Start of changeFixedEnd of change Start of change2End of change Start of changeCATACTEnd of change Start of changeCatalog Activity count (Z entry type only)End of change
Start of changenoEnd of change Start of changeBitstringEnd of change Start of change2End of change Start of changeCATFLAGSEnd of change Start of change(Z entry type only)End of change
Start of change End of change Start of changeFirst ByteEnd of change Start of change End of change Start of change End of change Start of change End of change
Start of change End of change Start of change1... …. End of change Start of change End of change Start of change End of change Start of changeCatalog is openEnd of change
Start of change End of change Start of change.1.. …. End of change Start of change End of change Start of change End of change Start of changeCatalog is the master catalog on this systemEnd of change
Start of change End of change Start of change..1. …. End of change Start of change End of change Start of change End of change Start of changeCatalog is active in In-Storage CacheEnd of change
Start of change End of change Start of change...1 …. End of change Start of change End of change Start of change End of change Start of changeCatalog is active in VLFEnd of change
Start of change End of change Start of change.... 1... End of change Start of change End of change Start of change End of change Start of changeCatalog is ECS-activeEnd of change
Start of change End of change Start of change.... .1.. End of change Start of change End of change Start of change End of change Start of changeCatalog is open in RLS modeEnd of change
Start of change End of change Start of change.... ..1. End of change Start of change End of change Start of change End of change Start of changeCatalog is deletedEnd of change
Start of change End of change Start of change.... …1 End of change Start of change End of change Start of change End of change Start of changeCatalog is lockedEnd of change
Start of change End of change Start of changeSecond ByteEnd of change Start of change End of change Start of change End of change Start of change End of change
Start of change End of change Start of changexxxx xxxxEnd of change Start of change End of change Start of change End of change Start of changeReservedEnd of change
no Bitstring 1 CATTR Attributes for pagespace and swapspace
  xxxx xx..     Reserved
  .... ..1.     Swap=1, noswap=0
  .... ...1     Data set is a pagespace
Start of changenoEnd of change Start of changeAddrEnd of change Start of change4End of change Start of changeCATUCBEnd of change Start of changeUCB pointer for volume the catalog is on (Z entry type only)End of change
no Bitstring 1 COMPIND Compression indicator.
  x..x xxxx     Reserved
  .1.. ....     Data set is extended format
  ..1. ....     Data set is compressible
no Fixed 8 COMUDSIZ Compressed user data size
no Character VL DATACLAS SMS data class
yes Fixed 4 DEVTYP UCB device type
yes Fixed 3 DSCBTTR TTR of format-1 DSCB for non-VSAM data set
no Mixed 4 DSCRDT2 Creation date. Packed decimal YYDDDF for 3 bytes appended with one byte century indicator. If the century byte is 00 then add 1900 to get the year; if 01, add 2000.
no Mixed 4 DSEXDT2 Expiration date. Packed decimal YYDDDF for 3 bytes appended with one byte century indicator. If the century byte is 00 then add 1900 to get the year; if 01, add 2000.
no Binary 1 EATTR Data set attribute for controlling allocation of VSAM data sets (note that EATTR for Non-VSAM data sets is not carried in the catalog information for such data sets). The value of EATTR is as follows:
  • X'00' - EATTR not specified. Defaults for EAS eligibility should apply.
  • X'01' - EATTR=NO specified. The data set cannot have extended attributes have and cannot reside in EAS.
  • X'02' - EATTR=OPT specified. The data set can have extended attributes and can optionally reside in an EAS.
  • X'03' - Not used. EATTR value treated as not specified.
no Character 44 ENTNAME The name of the entry
no Character 1 ENTYPE Entry type, ex., 'C' is cluster, 'A' is non-VSAM, etc.
no Character 8 EXCPEXIT Exception exit
yes Fixed 2 FILESEQ File sequence number
no character 1 FSDSFLAG File System Data Set Flag

X'00'  - Not a zFS data set
X'80'  -  zFS data set
X'FF' - Attribute not applicable to entry

no Mixed 4 GDGALTDT Last alteration date. Packed decimal YYDDDF for 3 bytes appended with one byte century indicator. If the century byte is 00 then add 1900 to get the year; if 01, add 2000.
no Bitstring 1 GDGATTR Generation data group attributes
  0... ....     Delete oldest GDS when GATLIMIT exceeded
  1... ....     Delete all GDSs when GATLIMIT exceeded
  .0.. ....     Do not scratch data set when rolled off
  .1.. ....     Scratch data set when rolled off if volume mounted
  ..0. ....     Allocate GDSs in LIFO order
  ..1. ....     Allocate GDSs in FIFO order
  ...0 ....     GDS NOPURGE
  ...1....     GDS PURGE
Start of change End of change Start of change.... 0...End of change Start of change End of change Start of change End of change Start of changeGDG ClassicEnd of change
Start of change End of change Start of change.... 1..End of change Start of change End of change Start of change End of change Start of changeGDG ExtendedEnd of change
no Fixed 1 GDGLIMIT Maximum number of generation data sets allowed in the GDG
Start of changenoEnd of change Start of changeFixedEnd of change Start of change2End of change Start of changeGDGLIMTEEnd of change Start of changeMaximum number of generation data sets allowed in the GDG or GDG extended (GDGE)End of change
Start of change
Note: The use of the GDGLIMIT field name will be tracked by z/OS Generic Tracker when GDGLIMITE is not also present. The usage can be displayed with the DISPLAY GTZ,TRACKDATA console command when GDZTRACK is active. IBM recommends only using GDGLIMTE.
End of change
yes Character 4 GENLEVEL GDG generation level — 1 for each active generation in EBCDIC format c'0000'
yes Fixed 4 HARBA High-allocated RBA
no Fixed 4 HARBADS Data set high-allocated RBA
yes Character VL HIKEYV High Key on volume
no Fixed 4 HILVLRBA RBA of High Level Index Record
yes Fixed 4 HKRBA RBA of data control interval with high key
yes Fixed 4 HURBA High-used RBA for the volume requested
no Fixed 4 HURBADS Data set high-used RBA
no Fixed 2 INDXLVLS Number of Index Levels
yes Bitstring 1 ITYPEXT Type of extent
  1... ....     Sequence set with data, IMBED
  .1.. ...     Extents not preformatted
  ..1. ....     Converted VSAM data set volume
  ...x xxxx     Reserved
Start of changenoEnd of change Start of changeCharacterEnd of change Start of change16End of change Start of changeLOCKSTNMEnd of change Start of changeData Set Lock Structure Name (RLS eligible data sets only)End of change
no Binary 1 LOGPARMS

Value of LOG parameter set
by IDCAMS DEFINE/ALTER
X'00' - never set
X'01' - LOG(NONE)
X'02' - LOG(UNDO)
X'03' - LOG(ALL)            

no Character 26 LOGSTRID Value of LOGSTREAMID parameter set by IDCAMS DEFINE/ALTER
yes Character VL LOKEYV Low Key on volume
no Fixed 4 LRECL Average logical record size
no Fixed 8 LTBACKDT Last backup date in TOD format.
no Character VL MGMTCLAS SMS management class
yes Character 44 NAME The name of an associated entry
yes Fixed 2 NOBLKTRK Number of physical blocks per track. This is the value reported by IDCAMS LISTCAT as PHYRECS/TRK
yes Fixed 4 NOBYTAU Number of bytes per allocation unit
yes Fixed 4 NOBYTTRK Number of bytes per track
yes Fixed 1 NOEXTNT Number of extents. This is the value reported by IDCAMS LISTCAT as EXTENTS.
yes Fixed 2 NOTRKAU Number of tracks per allocation unit. This is the value reported by IDCAMS LISTCAT as TRACKS/CA.
no Character 1 NVSMATTR Non-VSAM attribute information
  c'H'     Active GDS
  c'N'     Deferred GDS
  c'M'     Rolled-off GDS
  c'L'     Extended partitioned data set (PDSE)
  c'P'     POSIX data set
  x'00'     Simple non-VSAM data set
  c'I'     Active GDS-PDSE
  c'J'     Deferred GDS-PDSE
  c'K'     Rolled-Off GDS-PDSE
no Bitstring 1 OPENIND Open indicator
  x... ....     Open =1, not open=0, 1 may mean that the data set was not closed properly
  .xxx xxxx     Reserved
no Character 8 OWNERID Owner of the data set
no Fixed 2 PASSATMP Number of attempts to prompt for password
no Character 8 PASSPRMT Password prompt code name
no Character 32 PASSWORD Four 8-byte passwords (VSAM data sets only)
yes Fixed 4 PHYBLKSZ Physical blocksize. This is the value reported by IDCAMS LISTCAT as PHYREC-SIZE .
no Fixed 3 PRIMSPAC Primary space allocation
no Binary 8 RECVTIME Recovery time, TOD value, local
no Binary 8 RECVTIMG Recovery time, TOD value, GMT
no Bitstring 1 RGATTR Alternate index/path attributes
  1... ....     Upgrade=1, noupgrade=0
  .1.. ....     Entry is an alternate index
  ..xx xxxx     Reserved
no Bit 1 RLSBWO

Value of BWO parameter set by
IDCAMS DEFINE/ALTER
xxxx 0000 - undefined or not set
xxxx 0001 - BWO(TYPECICS)
xxxx 0010 - reserved
xxxx 0011 - BWO(TYPEIMS)
xxxx 0100 - reserved            

no Bit 1 RLSFLAGS

xxxx 0xxx - Recovery not required
xxxx 1xxx - Recovery required
xxxx x0xx - Catalog is Enabled for RLS
xxxx x1xx - Catalog is Quiesced for RLS
xxxx xx0x - Catalog  is not being used in
RLS mode
XXXX XX1X - Catalog is being used in RLS
mode

no Fixed 3 SCONSPAC Secondary space allocation
no Bitstring 1 SECFLAGS Security flag information x'80' means the data set has a discrete RACF® profile
no Fixed 4 SEQSTRBA RBA of First Sequence Set Record. RRDS maximum record number if RRDs.
no Bitstring 1 SMSSFLAG SMS FLAGS
  1... ....     VSAM extended format
  .1.. ....     VSAM compressed format
  ..1. ....     RLS in use
  ...1 ....     RLS VSAM quiesced
  .... xxxx     Reserved
no Bitstring 1 SPACOPTN Equals '01' for record allocation, '10' for track allocation, and '11' for cylinder
  ..xx xxxx     Reserved
no Character VL STORCLAS SMS storage class. Start of changeWhen the data set is not SMS-managed, the length will be no longer than 8 and the value will be hexadecimal zeroes.End of change
no Fixed 2 STRIPCNT Striping counts for striped data sets
no Fixed 1 STRNO Number of concurrent requests
yes Fixed 4 TRACKS Total number of tracks per volume. This field pertains only to VSAM data sets.
yes Character 1 TYPE The type of an associated entry
no Fixed 8 UDATASIZ User data size
Restriction: This field is only valid for extended format VSAM and non-VSAM data sets.
no Character VL USERAREC User authorization record
no Character 8 USVRMDUL User security verification module
yes xxx. ....   VOLFLG '100' is the primary volume with space allocated, '010' is the candidate volume with no space allocated, '001' is the overflow volume (keyrange data set only) with no space allocated
yes Character 6 VOLSER Volume serial number. A VOLSER of all asterisks is the IPL volume. For a symbolic value (for example, "&xxxxx"), use the ASASYMBM service to convert the symbolic value to a valid character string.
no Bitstring 1 VSAMREUS VSAM data set information
  1... ....     Data set has RACF discrete profile
  .1.. ....     Index component data set
  ..1. ....     Reusable data set
  ...1 ....     Erase specified (cluster only)
  .... xx..     Reserved
  .... ..1.     Swap space (cluster only)
  .... ...1     Page space (cluster only)
no fixed 46 VSAMSTAT Statistics infomation for VSAM components.
    1   Percentage of free CIs in CA
    1   Percentage of bytes free in CI
    2   Number CIs/ CA
    4   Free CIs/ CA
    2   Free bytes/CI
    4   Number of logical records
    4   Number of deleted records
    4   Number of inserted records
    4   Number of updated records
    4   Number of retrieved records
    4   Bytes of free space in component. For non-extended addressability data sets, this field represents the actual amount of free space in the component. If the data set is extended addressable, the value in the field is the number of free CIs; the bytes of freespace can be obtained by multiplying the field value by the CI size.
    4   Number of CI splits
    4   Number of CA splits
    4   Number of EXCPs
no Bitstring 2 VSAMTYPE VSAM data set type information
  First Byte:      
  1... ....     KSDS=1, not KSDS=0
  .1.. ....     Write check
  ..1. ....     Imbed
  ...1 ....     Replicate
  .... x...     Reserved
  .... .1..     Key-range data set
  .... ..1.     RRDS
  .... ...1     Spanned records allowed
  Second Byte:      
  1... ....     Non-unique or unique keys allowed
  .x.. ....    
  • 0=CA-RECLAIM(YES),
  • 1=CA-RECLAIM(NO)
  ..1. ....     The data set was not closed properly and the recorded statistics are not accurate.
  .... .1..     LDS
  .... ...1     VRRDS
  ...x x.x.     Reserved
no Bitstring 2 VVRNFLGS Extended format flags
  First Byte:      
  1... ....     COMUDSIZ and UDATASIZ are invalid
  .1... ....     Block level compression
  ..xx xxxx     Reserved
  Second Byte:      
  1111 1111     Not defined
no Bitstring 1 XACIFLAG Extended attribute flags
  x... ....     Reserved, may be on
  .1.. ....     Data set can be greater than 4 GB
  ..xx ....     Reserved, may be on
yes Fixed 8 XHARBA High-allocated RBA
no Fixed 8 XHARBADS Data-set high-allocated RBA
yes Fixed 8 XHKRBA RBA of data control interval with high key
yes Fixed 8 XHURBA High-used RBA for the volume requested
no Fixed 8 XHURBADS Data-set high-used RBA
Note: If you attempt to retrieve a 4-byte RBA value (such as, HARBA, HURBA, HARBADS, HURBADS, or HKRBA) and the value will not fit in the 4-bytes provided, that length of that returned data will be zero as shown in Work Area Format Description. You can either change to always request the extended fields shown above, or request the setting of XACIFLAG and inspect bit 1 to determine whether or not RBAs can be greater than 4 bytes. If so, then request the fields with the names given here.