CLI Overview

Installation considerations

Using the CLI requires:

• A listener that is installed as part of the agent’s installation procedure.
• The M9CLI REXX to be concatenated to TSO.

For more information, see Installing and Upgrading.

Security considerations

• Any user running the CLI must have an OMVS UID defined in RACF.
• Some CLI commands require permissions:
  • ARCHIVE - UPDATE access is required for the target data set.
  • RECALL - READ access is required for the target data set.
  • BACKDSN -
    • ALTER access is required for the target data set.
    • When specifying NEWNAME: READ access is required for the backed up data set name, and UPDATE access for the target new name.
  • DELBACK - ALTER access is required for the target data set.
  • RESTDSN - ALTER access is required for the target data set, READ access is required for the source data set.

• Additionally, Individual permissions are required per command, in the following pattern: 

  Action	Class	Profile	Access
  Enable a user to execute <command> from the CLI	XFACILIT	M9.CLI.<command>	READ

• Some keywords require individual permissions: 

  Action	Class	Profile	Access
  Enable a user to recall a data set while bypassing the ACS routines option	XFACILIT	M9.CLI.RECALL.BYPASSACS	READ
  Enable a user to restore a data set while bypassing the ACS routines option	XFACILIT	M9.CLI.RESTDSN.BYPASSACS	READ
  Enable a user to delete an archived data set although it has a valid date that has not expired	XFACILIT	M9.CLI.DELARC.PURGE	READ
  Enable a user to archive a data set without checking whether the data set has a backup	XFACILIT	M9.CLI.ARCHIVE.NOBCK	READ
  Enable a user to specify a retention period and set an expiration date while archiving a data set. The user-specified retention period overrides all other definitions, including DFSMS Management Class attributes.	XFACILIT	M9.CLI.ARCHIVE.RETPD	READ
  Enable the user to specify a new data set name during data set backup	XFACILIT	M9.CLI.BACKDSN.NEWNAME	READ
  Enable the user to specify a new data set backup date during data set backup	XFACILIT	M9.CLI.BACKDSN.NEWDATE	READ
  Enable the user to specify a new data set backup time during data set backup	XFACILIT	M9.CLI.BACKDSN.NEWTIME	READ
  Enable a user to delete a dataset backup without checking the backup's expiration date	XFACILIT	M9.CLI.DELBACK.PURGE	READ

CLI Commands

The supported commands are shown in the following table:

Identifying the data set and volume for the command

The LISTDSN and LISTVOL commands must include either a specific name or a pattern as a parameter. The issued command will display all the backup copies, archives, and volume full dump copies that meet the criteria. The accepted pattern adheres to the z/OS ISPF conventions.

Data set name pattern

Volume serial pattern

The RESTDSN and RESTVOL commands operate on a single data set or volume. The input can be a specific data set or volume name, or a pattern, as long as it matches one data set or volume. A user can use the LISTDSN and  LISTVOL command to identify a data set or volume to be restored, and then change the command name to RESTDSN or RESTVOL while leaving the rest of the parameters the same in order to perform the restore. The command will be executed for the latest backup copy, archive, or volume full dump copy that meets the criteria, unless specified otherwise. For these commands, further filtering is possible by using:

The ARCHIVE and RECALL commands must receive a specific data set name, no further filtering is available.

Output

The command is processed synchronously and the output is redirected to STDOUT. When invoked in TSO, the output will be displayed on the screen. When invoked in a batch job, it will be redirected to a SYSPRINT DD card. If the requester of the command is not available, in the event that the job or TSO session was cancelled, the output will be printed in the executing agent's log. The exception is LISTDSN and LISTVOL outputs, which will not be printed to the agent's log as their outputs may be very large.

Return Codes

The following table lists the possible return codes from CLI commands.