Parameters
Refer to this section to look up the names, definitions, and valid values for all parameters that are used by Advanced Archive for DFSMShsm processing.
The maximum length that is acceptable for a parameter value is 50 bytes unless otherwise specified.
- ARCHIVE-ACTIVE-LOG-GDG-BASE-DSN
This parameter specifies the name of the GDG base for the Active Log (sometimes referred to as the Archive Database log). The log is a GDG data set. - ARCHIVE-DATABASE-CLUSTER-NAME
This parameter specifies the full VSAM cluster name of the Archive Database. The Archive Database holds records for the files that have been archived and the location information for those files. - ARCHIVE-DATABASE-NUMBER-OF-RECORDS
This parameter specifies the maximum number of records that are expected to be in the Archive Database. - ARCHIVE-DB-BKUP-GDG-BASE-DSN
This parameter specifies the name of the GDG base for the Archive Database backup file. The backup is a GDG data set. - ARCHIVE-LOG-BKUP-GDG-BASE-DSN
This parameter specifies the name of the GDG base for the Archive Database backup log. The backup log is a GDG data set. - ARCHIVE-MINIMUM-SIZE
This parameter establishes the minimum size in gigabytes of a “tape’s worth” of data. Unless the selected group size is greater than or equal to the values of this parameter, the selected candidate group is rejected. - ARCHIVE-SELECTION-MAXIMUM-FILES
This parameter establishes the maximum number of candidate data sets that can be selected for archiving. After this limit is reached, the selection of candidate data sets is curtailed and the selected candidates are passed on for archiving. - ARCHIVE-SELECTION-MAXIMUM-GB
This parameter establishes the maximum size (in gigabytes) of candidate data sets that can be selected for archiving. After this limit is reached, the selection of candidate data sets is curtailed and the selected candidates are passed on for archiving. - ARCHIVE-TAPE-ALLOCATION-DATACLAS
This parameter specifies the DFSMS data class name that is used to allocate the tape data set that will contain the archived files. - ARCHIVE-TAPE-ALLOCATION-MGMTCLAS
This parameter specifies the DFSMS management class name that is used to allocate the tape data set that will contain the archived files. - ARCHIVE-TAPE-ALLOCATION-STORCLAS
This parameter specifies the DFSMS storage class name that is used to allocate the tape data set that will contain the archived files. - ARCHIVE-TAPE-ALLOCATION-UNIT-NAME
This parameter specifies the unit name that is used to allocate the tape data set that will contain the archived files. - ARCHIVE-TAPE-DATA-SET-NAME
This parameter specifies the name of the primary copy of the tape data set that will contain the archived files. If you are archiving to a cloud storage environment, this parameter is used as the prefix of the file name that will contain the archived data. - ARCHIVE-TAPE-EXPIRATION-DAYS
This parameter specifies the number of days that an expired archive tape will be retained by the tape management system. - ARCHIVE-TAPE2-ALLOCATION-DATACLAS
- ARCHIVE-TAPE2-ALLOCATION-MGMTCLAS
This parameter specifies the DFSMS management class name that is used to allocate the second tape data set that will contain the archived files. - ARCHIVE-TAPE2-ALLOCATION-STORCLAS
This parameter specifies the DFSMS storage class name that is used to allocate the second tape data set that will contain the archived files. - ARCHIVE-TAPE2-ALLOCATION-UNIT-NAME
This parameter specifies the unit name that is used to allocate the second tape data set that will contain the archived files. - ARCHIVE-TAPE2-DATA-SET-NAME
This parameter specifies the name of the second copy of the tape data set that will contain the archived files. This data set will not be cataloged in the ICF catalog. - ARCHIVE-TAPE3-ALLOCATION-DATACLAS
This parameter specifies the DFSMS data class name that is used to allocate the third tape data set that will contain the archived files. - ARCHIVE-TAPE3-ALLOCATION-MGMTCLAS
This parameter specifies the DFSMS management class name that is used to allocate the third tape data set that will contain the archived files. - ARCHIVE-TAPE3-ALLOCATION-STORCLAS
This parameter specifies the DFSMS storage class name that is used to allocate the third tape data set that will contain the archived files. - ARCHIVE-TAPE3-ALLOCATION-UNIT-NAME
This parameter specifies the unit name that is used to allocate the third tape data set that will contain the archived files. - ARCHIVE-TAPE3-DATA-SET-NAME
This parameter specifies the name of the third copy of the tape data set that will contain the archived files. This data set will not be cataloged in the ICF catalog. - ARCHIVE-TAPE4-ALLOCATION-DATACLAS
This parameter specifies the DFSMS data class name that is used to allocate the fourth tape data set that will contain the archived files. - ARCHIVE-TAPE4-ALLOCATION-MGMTCLAS
This parameter specifies the DFSMS management class name that is used to allocate the fourth tape data set that will contain the archived files. - ARCHIVE-TAPE4-ALLOCATION-STORCLAS
This parameter specifies the DFSMS storage class name that is used to allocate the fourth tape data set that will contain the archived files. - ARCHIVE-TAPE4-ALLOCATION-UNIT-NAME
This parameter specifies the unit name that is used to allocate the fourth tape data set that will contain the archived files. - ARCHIVE-TAPE4-DATA-SET-NAME
This parameter specifies the name of the fourth copy of the tape data set that will contain the archived files. This data set will not be cataloged in the ICF catalog. - ARCHIVE-TARGET
This parameter determines how the Archive function routes the candidate file to its destination. - ARCHIVE-TARGET-SIZE
This parameter establishes the limit for a “tape’s worth” of data in terms of gigabytes. Candidate groups whose size exceeds this value will be cut off after the target size is reached. Remaining entries in the candidate group will be reevaluated after current group is processed. - CLOUDDEF-DATABASE-CLUSTER-NAME
This parameter specifies the full VSAM cluster name of the Cloud Definitions Database. The Cloud Definitions Database holds records for definitions that are used to connect to cloud storage systems. If you are not archiving files to cloud storage systems, you do not need to customize this value. - CLOUDDEF-DATABASE-NUMBER-OF-RECORDS
This parameter specifies the maximum number of records that are expected to be in the Cloud Definitions Database. There would be one record for each cloud location that is defined. - DATA-CENTER-NAME
This parameter specifies the data center name that will appear on all report headings generated by Advanced Archive for DFSMShsm. - DELETE-HSM-BACKUP-VERSIONS-AFTER-ARCHIVE
This parameter specifies whether the DFSMShsm backup copies of the files that are archived will be deleted. - DELETE-WORK-DATASET-WHEN-FINISHED
This parameter specifies whether the Advanced Archive for DFSMShsm program work data sets are scratched at data set close time. - DYNAMIC-ALLOCATION-DATA-CLASS
This parameter specifies which SMS data class is used when Advanced Archive for DFSMShsm dynamically allocates a work file on DASD. - DYNAMIC-ALLOCATION-DATASET-NAME-PREFIX
This parameter specifies which data set name prefix is used when Advanced Archive for DFSMShsm dynamically allocates a work file on DASD. - DYNAMIC-ALLOCATION-GDG-LIMIT
This parameter specifies the default GDG limit setting to use if a GDG base for a new data set name allocated on DASD is not found during Advanced Archive for DFSMShsm processing. - DYNAMIC-ALLOCATION-MANAGEMENT-CLASS
This parameter specifies the SMS management class to use when Advanced Archive for DFSMShsm dynamically allocates a work file on DASD. - DYNAMIC-ALLOCATION-RETRY-LIMIT
This parameter specifies the number of times that dynamic allocation for a given resource is retried before Advanced Archive for DFSMShsm terminates with a U0100 abend. - DYNAMIC-ALLOCATION-SORTWORK-UNIT
This parameter specifies the unit name to use when Advanced Archive for DFSMShsm dynamically allocates a sort work file. - DYNAMIC-ALLOCATION-SPACE-UNIT-TRACK-LIMIT
If this parameter is set to a value other than NONE, allocations for the Advanced Archive for DFSMShsm program work files will have their primary allocation size reduced to the specified number of tracks (if the allocation request was for more than specified number of tracks) and the secondary allocation will also be set to the number of tracks specified by this parameter. - DYNAMIC-ALLOCATION-STORAGE-CLASS
This parameter specifies the SMS storage class to use when Advanced Archive for DFSMShsm dynamically allocates a work file on DASD. - DYNAMIC-ALLOCATION-UNIT
This parameter specifies the unit name to use when Advanced Archive for DFSMShsm dynamically allocates a work file. - DYNAMIC-ALLOCATION-VOLSER
This parameter specifies the DASD volume serial number to use when Advanced Archive for DFSMShsm dynamically allocates a work file. - DYNAMIC-ALLOCATION-VSAM-DATA-CLASS
This parameter specifies the SMS data class to use when Advanced Archive for DFSMShsm dynamically allocates a VSAM data set. - DYNAMIC-ALLOCATION-VSAM-DATA-VOLSER
This parameter specifies the DASD volume serial number to use when Advanced Archive for DFSMShsm needs to dynamically allocate a VSAM work file data component. - DYNAMIC-ALLOCATION-VSAM-DATASET-NAME-PREFIX
This parameter specifies the data set name prefix to use when Advanced Archive for DFSMShsm dynamically allocates a VSAM work file on DASD. - DYNAMIC-ALLOCATION-VSAM-INDEX-VOLSER
This parameter specifies the DASD volume serial number to use when Advanced Archive for DFSMShsm dynamically allocates a VSAM work file index component. - DYNAMIC-ALLOCATION-VSAM-MANAGEMENT-CLASS
This parameter specifies the SMS management class to use when Advanced Archive for DFSMShsm dynamically allocates a VSAM data set on DASD. - DYNAMIC-ALLOCATION-VSAM-STORAGE-CLASS
This parameter specifies the SMS storage class to use when Advanced Archive for DFSMShsm dynamically allocates a VSAM data set on DASD. - GREGORIAN-DATE-FORMAT
This parameter specifies the date format that Advanced Archive for DFSMShsm will use when displaying dates on the reports. - ML2-MINIMUM-SIZE
This parameter specifies the minimum amount of data (in gigabytes) that is written to a DFSMShsm migration level 2 tape during Restore processing. - ML2-TAPE-ALLOCATION-DATACLAS
This parameter specifies the DFSMS data class name that is used to allocate the ML2 data set that will contain the restored files. - ML2-TAPE-ALLOCATION-MGMTCLAS
This parameter specifies the DFSMS management class name that is used to allocate the ML2 data set that will contain the restored files. - ML2-TAPE-ALLOCATION-STORCLAS
This parameter specifies the DFSMS storage class name that is used to allocate the ML2 data set that will contain the restored files. - ML2-TAPE-ALLOCATION-UNIT-NAME
This parameter specifies the unit name that is used to allocate the ML2 data set that will contain the restored files. - ML2-TAPE-DATA-SET-NAME
This parameter specifies the name of the DFSMShsm migration level 2 tape data sets. It is used when archiving files from DFSMShsm ML2 tapes as well as when archived files are restored. - ML2-TARGET-SIZE
This parameter specifies maximum amount of data (in gigabytes) that is written to a DFSMShsm migration level 2 tape during Restore processing. If the amount of data that is selected for processing exceeds this value, the selected data is split into subgroups and written to separate tapes. - RECYCLE-FROM-ARCHIVE-COPY-NUM
This parameter specifies which of the four archive volume copies are to be used by the AXQRECYC program that is currently executing. - RECYCLE-THRESHOLD-PERCENTAGE
This parameter defines the utilization percent threshold value at which an Archive Database tape entry is considered ineligible for Recycle. - REPORT-PAGE-LENGTH
This parameter specifies how many lines are included in each report page. - RESTORE-FROM-ARCHIVE-COPY-NUM
This parameter specified which of the four archive volume copies are to be used by the program currently executing. - RESTORE-QUEUE-CLUSTER-NAME
This parameter specifies the full VSAM cluster name of the Restore Queue database. The Restore Queue holds records for the files that have been selected for restore processing. - RESTORE-QUEUE-NUMBER-OF-RECORDS
This parameter specifies the number of records that are expected to be in the Restore Queue database. The value of this parameter is used when the database is created. - RESTORE-SELECTION-MAXIMUM-FILES
This parameter establishes the maximum number of candidate data sets that can be selected for restoration. After this limit is reached, the selection of candidate data sets is curtailed and the selected candidates are passed on for restoration. - RESTORE-SELECTION-MAXIMUM-GB
This parameter establishes the maximum size (in gigabytes) of candidate data sets that can be selected for restoration. After this limit is reached, the selection of candidate data sets is curtailed and the selected candidates are passed on for restoration. - RESTORE-TO-DRIVE-DYNAMIC-HRECALL
This parameter controls whether Advanced Archive for DFSMShsm dynamically drives DFSMShsm HRECALL processing for files as they are restored to ML2. - SORT-PRODUCT-NAME
This parameter specifies the sort product that is installed so that Advanced Archive for DFSMShsm can set up the appropriate dynamic interface for internal sorts. - SORT-PRODUCT-PARAMETERS-DDNAME
This parameter specifies the DD name that Advanced Archive for DFSMShsm should assign to the sort statement file used by the sort product.