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:

  • The command verifies that the DFSMS Management Class parameter, Command or Auto Migrate, is set to either COMMAND or BOTH.
  • The command archives the data set regardless of the DFSMS Management Class primary days non-usage parameter’s value.
  • When specifying RETENTIONPERIOD, the new expiration date overrides previous definitions, including the DFSMS Management Class specification.

Related topic

CLI-Command-Reference

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

The archived data set is 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 SYNC WITH STORAGE in the Agents tab.

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

Parameter

Description

dsname

A specific data set name

The data set must be cataloged.

ARCHIVE - Optional Parameters

Option[Short option]

Description

Format

Examples

NOBACKUP[NOBCK]

By default, the command will not archive a data set that is marked as changed according to the change bit, and does not have a backup copy. The command does not check whether the backup copy is the most current one, and there is no protection from manually deleting a backup of an archived data set.

Specifying NOBCK performs ARCHIVE regardless of the change bit and backup copy status. To use the keyword, the user must have READ access to the BMC AMI Cloud Resource M9.CLI.ARCHIVE.NOBCK

-

-

RETENTIONPERIOD[RETPD]

By default, the expiration date of the data set will be set according to the logic described in Determining a data set expiration date.

Specifying RETENTIONPERIOD sets the retention period manually, regardless of previous dates in the VTOC, CATALOG or DFSMS Management Class. To use the keyword, the user must have READ access to the BMC AMI Cloud Resource M9.CLI.ARCHIVE.RETPD

A number followed by a character to specify:

d—Days

w—Weeks

m—Months

y—Years

3d—The data set will expire in 3 days

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)

 

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