BACKDSN
Logic
Several considerations pertain when backing up data sets using the BACKDSN command:
- When specifying RETENTIONPERIOD, the new expiration date overrides previous definitions, including the DFSMS Management Class specification.
- 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.
The backup will be available in the UI after a periodic synchronization, which by default, is performed automatically every 5 minutes. If needed, you can perform an on-demand synchronization in 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, you must specify RESET.
- 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.
Syntax
[RETENTIONPERIOD|RETPD(<nnn>d|<nnn>w|<nnn>m|<nnn>y)]
[RESET]
[NEWNAME<dataSetName>
[NEWDATE<date> NEWTIME<time>]
Required parameters
Parameter | Description |
|---|---|
dataSetName | A specific data set name The data set must be cataloged. |
Optional parameters
Option (short option) | Description | Format |
|---|---|---|
RETENTIONPERIOD (RETPD) | Sets 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, you 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 For example, 3d means that the data set will expire in 3 days |
RESET | Resets the change bit | NA |
NEWNAME | New name for the backup You must have READ access to the BMC AMI Cloud resource M9.CLI.BACKDSN.NEWNAME | dataSetName |
NEWDATE | 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. You must have READ access to the BMC AMI Cloud resource M9.CLI.BACKDSN.NEWDATE | yyyy/mm/dd |
NEWTIME | 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. You must have READ access to the BMC AMI Cloud resource M9.CLI.BACKDSN.NEWTIME | hh:mm |
Output
The output displays the given BACKDSN command and parameters, followed by the requested information:
If the data set could not be backed up, message ZM9I044E will be displayed, followed by the relevant error messages:
Examples
The following examples demonstrate use of the command.
Backing up a data set with no expiration date (requires permission)
Backing up a data set to be deleted after a year
Backing up a data set with a new name to be deleted after a month
Backing up a data set with a new name, new date and new time to be deleted after ten days