ARCHIVE

The ARCHIVE command archives a single data set.

ARCHIVE - Logic

This command applies to both SMS-managed and non-SMS-managed data sets and is intended to supplement the scheduled policies. Several considerations pertain when archiving SMS-managed data sets using the ARCHIVE command:

  1. The command verifies that the DFSMS Management Class parameter, “Command or Auto Migrate” is set to either COMMAND or BOTH.

  2. The command will archive the data set regardless of the DFSMS Management Class “primary days non-usage” parameter’s value.

  3. When specifying RETENTIONPERIOD, the new expiration date will override previous definitions, including the DFSMS Management Class specification.

Once archived, the archived data set is immediately available for LISTDSN and RECALL.

The archived data set will be available in the UI after a periodic synchronization, which by default, is performed automatically every 5 minutes. If needed, on-demand synchronization can be performed via the UI, by clicking the “SYNC WITH STORAGE” button in the “Agents” tab. See the Administrator and User Guide for more information.

The command supports the following additional keywords. Use of the keywords requires permission.

  • NOBACKUP - allows archive without a backup copy

  • RETENTIONPERIOD - used to specify a retention period for the archived data set.

ARCHIVE - Syntax

M9CLI ARCHIVE <dsname> 
 [NOBACKUP|NOBCK]
 [RETENTIONPERIOD|RETPD(<nnn>d|<nnn>w|<nnn>m|<nnn>y)] 

ARCHIVE - Required parameters

ARCHIVE - Optional Parameters

ARCHIVE - Output

The output displays the given ARCHIVE command and parameters, followed by the requested information:

ZM9I043I Data set <dsname> was archived successfully

If the data set could not be archived, message ZM9I044E will be displayed, followed by the relevant error messages:

ZM9I044E An eligible data set was not found for the archive command

ARCHIVE - Examples

Archiving a data set

TSO M9CLI ARCHIVE M9.APPL.DUMP.D082020

Archiving a data set without a backup, to be deleted within a year

TSO M9CLI ARCHIVE M9.APPL.DUMP.D082020 NOBCK RETPD(1Y)

Last updated