Recovery Agent command-line interface overview

When you use the commands, some parameters are not required. See the following sections for details regrading required parameters.

For the parameters that are not required and not entered, default values are used. Parameters with spaces must be enclosed in quotation marks. For example, if you want to use the Accounting, Daily parameter, type "Accounting, Daily".

To read a syntax diagram for entering a command, follow the path of the line. Read from left to right, and from top to bottom, and use the following guidelines:

  • The >>- character sequence indicates the beginning of a syntax diagram.
  • The --> character sequence at the end of a line indicates that the syntax diagram continues on the next line.
  • The >-- character sequence at the beginning of a line indicates that a syntax diagram continues from the previous line.
  • The -->< character sequence indicates the end of a syntax diagram.

Symbols

Enter these symbols exactly as they are displayed in the syntax diagram:
*
Asterisk
{}
Braces
:
Colon
,
Comma
=
Equal sign
-
Hyphen
()
Parentheses
.
Period
Space
"
Quotation mark
'
Single quotation mark

Variables

Italicized lowercase items such as <variable_name> indicate variables. In this example, you can specify a <variable_name> when you enter the cmd_name command.

Read syntax diagramSkip visual syntax diagram-cmd_name<variable_name>

Required choices

When two or more items are in a stack and one of them is on the line, you must specify one item. In the following example, you must choose either A, B, or C:

Read syntax diagramSkip visual syntax diagram-cmd_name ABC

Optional choices

When an item is below the line, that item is optional. In the following example, you can select either A or nothing at all:

Read syntax diagramSkip visual syntax diagram-cmd_name ?A

When two or more items are in a stack below the line, all items are optional. In the following example, you can choose either A, B,C, or nothing.

Read syntax diagramSkip visual syntax diagram-cmd_name ?ABC