BACKDSN

The BACKDSN command creates a backup of a single data set. This command applies to both SMS-managed and non-SMS-managed data sets and is intended to supplement the scheduled policies.

BACKDSN - Logic

Several considerations pertain when backing up data sets using the BACKDSN command:

  1. When specifying RETENTIONPERIOD, the new expiration date will override previous definitions, including the DFSMS Management Class specification.
  2. NEWNAME supports VSAM data sets only if a data set with the new name exists in the catalog and only VSAM data sets without AIX nor PATH.

Once backed up, the backup is immediately available for LISTDSN and RESTDSN.

Related topic

CLI-Command-Reference

The backup 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 SYNC WITH STORAGE in the Agents tab.

The command supports the following additional keywords.

  • RETENTIONPERIOD—Used to specify a retention period for the archived data set
  • RESET—By default, the BACKDSN doesn’t reset the backup change bit. In order to reset it, RESET must be specified.
  • NEWNAME, NEWDATE, NEWTIME—Optional parameters used to assign a new name to the backup that is created. NEWDATE and NEWTIME are optional parameters that are only valid with the NEWNAME parameter.

Important

When using NEWDATE with a new RETENTIONPERIOD set, the new value will be calculated based on the new date value plus the new retention period.

BACKDSN - Syntax

M9CLI BACKDSN <dsname>
 [RETENTIONPERIOD|RETPD(<nnn>d|<nnn>w|<nnn>m|<nnn>y)]
 [RESET]
 [NEWNAME<dsname>
 [NEWDATE<date> NEWTIME<time>]

BACKDSN - Required Parameters

Parameter

Description

dsname

A specific data set name

The data set must be cataloged.

Important

BACKDSN does not support data set aliases.

BACKDSN - Optional Parameters

Option[Short option]

Description

Format

Examples

RETENTIONPERIOD[RETPD]

Specifying RETENTIONPERIOD will set the retention period manually, regardless of any DFSMS Management Class. Not specifying RETPD requires special permissions and implies that this backup doesn’t have any expiration date and will never be deleted automatically. To omit the keyword, the user must have READ access to the BMC AMI Cloud Resource M9.CLI.BACKDSN.PERM

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

RESET

When specifying RESET, the backup will reset the change bit



NEWNAME

the user must have READ access to the BMC AMI Cloud Resource M9.CLI.BACKDSN.NEWNAME

dsname


NEWDATE

Specifies the date to assign to the backup

If you specify NEWDATE without the NEWNAME parameter, the BACKDSN command fails. If you specify NEWDATE without NEWTIME, the current time is used. If the NEWDATE is in the future date, the command fails.

The user must have READ access to the BMC AMI Cloud Resource M9.CLI.BACKDSN.NEWDATE

DATE
yyyy/mm/dd


NEWTIME

Specifies the time to assign to the new backup

If you specify NEWTIME without NEWDATE, the current date is used. If the NEWDATE with the NEWTIME is in the future, the command fails.

The user must have READ access to the BMC AMI Cloud Resource M9.CLI.BACKDSN.NEWTIME

TIME hh:mm


BACKDSN - Output

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

ZM9I051I Data set <dsname> was backed up successfully with UNIQUEID <uniqueid>

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

ZM9I050E An eligible data set was not found for the backup command

BACKDSN - Examples

Backing up a data set with no expiration date (requires permission):

 TSO M9CLI BACKDSN M9.USER.SOURCE 

Backing up a data set to be deleted after a year:

 TSO M9CLI BACKDSN M9.USER.SOURCE RETPD(1Y) 

Backing up a data set with a new name to be deleted after a month:

 TSO M9CLI BACKDSN M9.USER.SOURCE NEWNAME(M9.USER.SOURCE.NEW) RETPD(1M) 

Backing up a data set with a new name, new date and new time to be deleted after 10 days:

TSO M9CLI BACKDSN M9.USER.SOURCE NEWNAME(M9.USER.SOURCE.NEW) NEWDATE(2012/12/30) NEWTIME(14:00) RETPD(10D) 

 

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