CLI overview


This topic describes the available CLI commands, their output, and possible return codes. For detailed information about each CLI command, see CLI-command-reference.

CLI commands

The following tables lists all the available CLI commands:

Command

Description

LISTDSN

List all archives, backup copies and imported data sets that exist for the specified data set or pattern

LISTVOL

List volume full dump copies that exist for the specified volume or pattern

RESTDSN

Restore a data set from a backup copy

RESTVOL

Restore a volume from a volume full dump copy

ARCHIVE

Archive a data set

RECALL

Recall a data set from archive, allocate and recatalog it back on disk

DELARC

Delete an archived data set without recalling it first

BACKDSN

Backup a data set

DELBACK

Delete a backup created by the BACKDSN command

DELVOL

Delete a backup version of a volume

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.

RC

Description

0

The command was executed successfully.

4

The command ended with a warning or no records were selected. An appropriate message is displayed.

8

The command ended in an error. An appropriate message is displayed.

10

Syntax error

12

A timeout occurred while the request was being processed or queued at the agent

14

No agent available— Unable to send request to agent

16

Unexpected error

 

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