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:
- Register an Archive File in the Archive Directory
by creating an Archive entry. The entry records the database tables
from which the data was archived, the date the data was archived,
the Optim™ Server on which the
Archive File resides, and the name of any associated Archive Index
File or Storage Profile. The Directory entry includes a globally unique
identifier (GUID) for the Archive File, which was generated in the
Archive Process, and also identifies each Archive File by Name, Group,
and Description. Although Archive Files are registered automatically
when they are created, you may need to register a file that was previously
registered in a different Optim Directory
or for which the original entry has been deleted, in order to process
it using Archive functions.
- Delete (unregister) an Archive entry for an Archive
File. During the removal process, you may also delete the associated
Archive File from disk storage. This function is useful for managing
Archive Files that have outlived their usefulness or have been exported
to another location.
- Update information in an Archive entry, such as:
- Group name or Description information.
- Name and location of the associated Archive Index
File.
- Storage Profile name.
- Duplicate Archive File information.
- Add an Archive File to one or more Archive File Collections while
registering the file or updating the file information.
- Validate, create or edit index entries for Archive Files.
- Register, export, or update the security information for a secured
Archive File.
Migration Process Tasks
Use the command-line interface to:
- Convert an Archive File created on a z/OS® DB2® platform
to one that can be processed by Archive. You must provide an Access
Definition name and DB Alias for the converted file.
- Migrate an Archive File from disk to backup storage.
- Replace an Archive Directory entry. You can copy
an Archive File to replace another Archive Directory entry only if
the Archive File name and Server match.
- Copy an Archive File to add, change, or delete a
File Access Definition.
- Copy an uncompressed Archive File to create a compressed
Archive File.
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:
- command-line keywords can be specified in any order,
separated by one or more spaces without commas.
- Keywords can be specified in mixed case. (Most keywords
are shown in this chapter using bold and uppercase for emphasis.)
- command-line keywords and associated arguments must
be separated with an equals sign (=) or a colon (:).
- ARCMAINT, MIG, M,
and FMF must be prefixed by a forward slash (/) or
dash (-).
- An argument that includes spaces must be enclosed
in single or double quotation marks.
- Use double quotation marks to enclose a command-line
keyword argument that includes a macro.
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.