DFSMShsm Storage Administration Reference

This topic contains detailed explanations of the operator, storage administrator, and system programmer commands, which are listed in alphabetical order.

Purposes of DFSMShsm commands

  • Define DFSMShsm values and volumes,
  • Determine status,
  • Maintain and recover the control data sets and the DFSMShsm address space,
  • Maintain data sets and volumes,
  • Operate DFSMShsm.
Use the following commands to define the values and volumes for DFSMShsm:
Command Purpose
ADDVOL Adds a new volume to the set of volumes owned or managed by DFSMShsm and changes existing volume information defined with earlier ADDVOL commands.
AUTH If the RACF® FACILITY class is not active, DFSMShsm uses the AUTH command to protect storage administrator DFSMShsm commands.
DEFINE Defines the structure of DASD level 2 volumes for DFSMShsm and defines a data set or volume pool related to non-SMS recalls. It also defines the automatic backup cycle, the secondary space management cycle, the dump cycle, dump classes, the volumes for aggregate recovery, and times for automatically demounting tapes currently in use by data set backup.
DELVOL Removes a volume from the list of volumes managed by DFSMShsm and changes existing volume information.
SETSYS Changes the values of various DFSMShsm parameters from their current values or defaults.
Use the following commands and parameters to determine status:
Command Purpose
AUDIT Detects and reports discrepancies about data set information in the computing system catalog, the aggregate backup and recovery ABR record, the DFSMShsm control data set records, and the VTOC of the DASD storage volume on which the data set resides.
Note: This command also corrects discrepancies in the common recall queue.
LIST Lists data set, user, volume, TTOC, and control data set record-serialization records from the DFSMShsm control data sets.
QUERY Lists values of parameters specified with DFSMShsm commands, lists DFSMShsm statistics, or lists the status of pending requests.
REPORT Generates reports based on the DFSMShsm statistics recorded in the MCDS.
Use the following commands to maintain and recover the control data sets and the DFSMShsm address space. Note, that the first four commands are only for diagnosis and repair.
Command Purpose
DISPLAY Displays the contents of locations within the DFSMShsm address space identified by an absolute address, a relative address, or a qualified address.
FIXCDS Displays, modifies, and adds and deletes records in the MCDS, BCDS, and OCDS.
PATCH Modifies storage within the DFSMShsm address space.
TRAP Specifies whether DFSMShsm should write a log entry or cause a dump to be taken when the error specified with the TRAP command occurs.
UPDATEC Combines the entries in the journal data set with a restored backup copy of one or all of the control data sets. See Recovering control data sets using the enhanced CDS recovery function for the recommended way to recover control data sets that run outside the DFSMShsm address space.
Use the following commands to directly manage data sets or volumes (as opposed to the automatic management functions of DFSMShsm):
Command Purpose
ALTERDS Changes the number of backup versions maintained and the frequency of creating backup versions for a non-SMS-managed data set.
ABACKUP Backs up aggregate groups of user-defined data sets for recovery at another location.
ARECOVER Recovers the data sets that were backed up by the ABACKUP command.
BACKDS Creates a backup version of a specific data set.
BACKVOL Requests that DFSMShsm back up eligible data sets on one or more volumes, in one or more storage groups, or on all primary volumes; or that it back up the control data sets. This command can also request that DFSMShsm invoke DFSMSdss to dump one or more volumes, or one or more storage groups.
BDELETE Deletes all the backup versions or specific backup versions of a specific data set.
DELETE Deletes a migrated data set without recalling the data set.
EXPIREBV Deletes all eligible expired backup versions from all backup volumes.
FRBACKUP Creates a fast replication backup version for each volume in a specified copy pool.
FRDELETE Deletes one or more unneeded fast replication backup versions.
FREEVOL Moves all migration copies meeting a specified age criteria between DFSMShsm migration or backup volumes.
FRRECOV Uses fast replication to recover a single volume or a pool of volumes from the managed backup versions.
MIGRATE Moves eligible data sets from DFSMShsm-managed volumes to migration volumes or from migration volumes to other migration volumes. It can also delete non-SMS-managed data sets from either DFSMShsm-managed volumes or migration volumes.
RECALL Returns migrated data sets to DFSMShsm-managed volumes.
RECOVER Obtains backed-up or dumped data sets and copies them to DFSMShsm-managed volumes.
RECYCLE Consolidates onto fewer DFSMShsm-owned tapes valid data that is interspersed with invalid data on many DFSMShsm-owned tapes.
SETMIG Changes the space management status of a specific data set or group of data sets on DFSMShsm-managed, non-SMS-managed volumes.
TAPECOPY Makes copies of classes of DFSMShsm-owned tapes or of individual DFSMShsm-owned tapes and identifies the copies as alternate tapes to the original tapes.
TAPEREPL Replaces references to original tapes with references to alternate tapes.
Use the following commands to operate DFSMShsm:
Command Purpose
CANCEL Cancels existing queued DFSMShsm requests for:
  • A specific request number
  • All requests for a particular user
  • All requests for a particular data set
HOLD Prevents all or part of DFSMShsm’s functions from running. Also causes the data set backup switchtapes action to occur immediately.
HSENDCMD Issues DFSMShsm-authorized-user commands from a TSO terminal.
LOG Enters information into the DFSMShsm log.
RELEASE Releases for processing all or part of the DFSMShsm functions that have been held.
STOP Causes an orderly shutdown of DFSMShsm.
SWAPLOG Causes DFSMShsm to exchange its LOGX data set for its LOGY data set or exchange its PDOX data set for its PDOY data set.

Command function changes for SMS

In a non-SMS environment, DFSMShsm is controlled by commands and several parameters that describe the configuration and determine how and when DFSMShsm functions are performed. In an SMS environment, the storage management functions defined in the management class and the storage group control the SMS-managed data sets in place of the parameter or command definitions within DFSMShsm. The parameters formerly used on the SETSYS command and shown in Table 1 do not apply to SMS-managed data sets.
Table 1. SETSYS Parameters Not Applicable to SMS-Managed Data Sets
DFSMShsm Parameter, Non-SMS SMS Equivalent
DAYS PRIMARY DAYS NON-USAGE
MIGRATIONLEVEL1DAYS LEVEL 1 DAYS NON-USAGE
None PARTIAL RELEASE
SETMIG (command) COMMAND OR AUTO MIGRATE
None ADMIN OR USER COMMAND BACKUP
None # GDG ELEMENTS ON PRIMARY
None ROLLED-OFF GDS ACTION
FREQUENCY BACKUP FREQUENCY
None GUARANTEED BACKUP FREQUENCY
VERSIONS NUMBER OF BACKUP VERSIONS (DATA SET EXISTS)
None NUMBER OF BACKUP VERSIONS (DATA SET DELETED)
None RETAIN DAYS ONLY BACKUP VERSION (DATA SET DELETED)
None RETAIN DAYS EXTRA BACKUP VERSIONS
None EXPIRE AFTER DAYS NON-USAGE
None EXPIRE AFTER DATE/DAYS
The functions of certain DFSMShsm commands are assumed by management class and storage group attributes for SMS-managed data sets and volumes. Table 2 shows these commands and the SMS construct that assumes their functions.
Table 2. DFSMShsm Commands Not Used for SMS Storage Management
DFSMShsm Command, Non-SMS SMS Class
DEFINE POOL Storage group
DEFINE VOLUMEPOOL Storage group
ADDVOL Storage group
ALTERDS Management class
SETMIG Management class
SETMIG VOLUME Storage group

Long-running commands

The AUDIT, EXPIREBV, LIST, RECYCLE, REPORT, and TAPECOPY commands are known as long-running commands. Long-running commands are limited to having only one of each such command being performed by DFSMShsm at any time.

Other commands can also run for a long time. If a command is running for a long time and is returning data to your terminal, you can be prevented from performing other operations at your terminal. An example might be a LIST or AUDIT command that is returning large amounts of data. To stop such a command from interfering with your use of your terminal, have the computer system operator issue a HOLD command for the function that is causing the interference. The operator can then issue a RELEASE command for the function, but the command that was being performed does not restart. For example, if a LIST command returns data to your terminal and prevents you from using it, have the operator issue a HOLD LIST and RELEASE LIST command sequence. The list command that is causing you trouble does not restart.