Command Line Interface — Maintenance Utilities

The command-line interface allows you to automate Archive Directory, File, and Index Maintenance functions without using the graphical user interface. You can also use the command line to migrate Archive Files from one storage device or platform to another, a process that is unavailable from the graphical user interface.

For Archive Directory and File Maintenance processes, you can enter parameters on the command line or in a parameter file. Archive Migration functions must be entered on the command line; you cannot use a parameter file.

Archive Directory Maintenance Command Line Tasks

Archive directory maintenance tasks allow you to use the command-line interface to:

Migration Process Tasks

Use the command-line interface to:

File Maintenance Tasks

File Maintenance tasks allow you to use the command-line interface, based on selection criteria in a command file, to:
  • Selectively remove rows from a registered Archive File
  • Compress one or more Archive and/or Extract Files, based on user-specified compression ratio thresholds
  • Split an Archive File into subset files

Index Maintenance Tasks

Use Index Maintenance tasks to create or edit index entries for Archive Files. You can enter commands from the command line, or create a parameter file.

PSS Retention Policy Import

Use the command-line interface to import PSS retention policies into an Optim Directory. Imported PSS retention policies augment any retention policies defined in Optim.

Guidelines

The following guidelines apply to command-line processing of maintenance utilities:

Syntax Conventions

The syntax conventions used to describe the command-line import are:

KEYWORD
Keywords are shown in uppercase for emphasis, but can be specified in lower or mixed case.
text
Variable text is shown in lower-case italics.
( )
Statement delimiter to group a series of qualifiers for a parameter.
[ ]
Indicates an optional parameter. (Square brackets are not used in the command line.)
{ }
Indicates a choice of two or more settings from which one (and only one) must be selected. (Brackets are not used in the command line.)
|
Separates options.


Feedback