Command Line Keywords

General

PR0CMND
The command to initiate command line processing. The character following PR is the number 0 (zero).
/ARCMAINT
Command to run Archive Directory Maintenance. Use /ARCMAINT or –ARCMAINT.
OPERATION=
Type of maintenance as one of the following:
REGISTER
Creates a Directory entry for an Archive File.
UNREGISTER
Delete the Directory entry for an Archive File, with or without deleting the corresponding Archive File (from disk).
UPDATE
Update Directory information for an Archive File.
VALIDATE
Validate Archive Indexes for specified Archive Files, with or without automatically fixing invalid indexes.
Note: The use of VALIDATE applies to only validation of Archive Indexes for Archive Files larger than 4 gigabytes that were created with Archive v6.1 or earlier.
OUTPUT=
File for the process report. If you do not use this keyword, the command echo and error messages display automatically after the process completes. In a UNIX or Linux environment, the report is displayed to the console.
filename
The name of the file. If you do not provide the full path, the file is saved in the default Data Directory, identified in Personal Options.
+
Append the report to an existing file.
PST=
The Optim™ Directory for maintenance. If maintenance is for the current (default) Optim Directory, this keyword is not needed.
optimdirectory
Optim Directory name.

Registration Process

AFFILE=
The Archive File to be registered in the Directory.
arcfilename.af
The name of the Archive File. Provide the full path if the file is not in the default Archive File Directory.
SERVER=
Server, if any, on which the Archive File resides.
arcservername
The name of an Optim Server that is referenced in the Product Configuration File.
(local)
The local server. (Default)
GROUP=
Override for Group designation in the original Archive Request.
groupidentifier
1- to 8-character name of the group for the Archive File. Group names can help qualify and categorize Archive Files and the corresponding archived data and can be referenced to locate one or more Archive Files for browsing or restoring data.
NONE
Register the Archive File with no Group designation.
DESC=
Override for Archive File Description in the original Archive Request.
description
1- to 8-character description.
NONE
Register the Archive File with no description.
AFXFILE=
Override for the Archive Index File name in the Archive Request.
idxfilename.afx
The name of the Archive Index File. Provide the full path if the file is not in the default Archive Index File Directory.
NONE
Register the Archive File with no Index File.
PROFILE=
Override for the Storage Profile referenced in the Archive Request.
profilename
The name of a Storage Profile in the current Optim Directory.
NONE
Register the Archive File with no associated Storage Profile.
OVERWRITE
Indicator for processing when Directory entry for the Archive File exists (i.e., the Archive File name and Server name for the entry match those entered on the command line).
+
Overwrite Directory entry.
Abort process (default).

Remove Registration Process

AFFILE=
The Archive File for which the Directory entry is removed.
arcfilename.af
The name of the Archive File. Provide the full path if the file is not in the default Archive File Directory.
SERVER=
Server, if any, on which the Archive File resides.
servername
The name of an Optim Server that is referenced in the Product Configuration File.
(local)
The local server. (Default)
AFID=
The identifier for the Archive File for which the directory entry is removed.
Note: You can obtain the Archive File identifier programmatically, using PST_ARCHIVE_ID, a built-in variable, with an Archive Action. Refer to the Common Elements Manual for additional information.
n
An integer that identifies the Archive File.
GUID=
The Globally Unique Identifier (GUID) for the Archive File for which the directory entry is removed.
Note: You can obtain the GUID programmatically, using PST_ARCHIVE_GUID, a built-in variable, with an Archive Action. Refer to the Common Elements Manual for additional information.
string
A 38-character string that identifies the Archive File.
DELETEFILE
Indicator for disposition of Archive File after the Directory entry has been removed.
+
Delete Archive File from disk storage after the Directory entry is removed.
Retain Archive File after the Directory entry is removed (default).

Update Process

AFFILE=
The Archive File for which the Directory entry is updated.
arcfilename.af
The name of the Archive File. Provide the full path if the file is not in the default Archive File Directory.
SERVER=
Server, if any, on which the Archive File resides.
servername
The name of an Optim Server that is referenced in the Product Configuration File.
(local)
The local server. (Default)
AFID=
The identifier for the Archive File for which the directory entry is updated.
Note: You can obtain the Archive File identifier programmatically, using PST_ARCHIVE_ID, a built-in variable, with an Archive Action. Refer to the Common Elements Manual for additional information.
n
An integer that identifies the Archive File.
GUID=
The Globally Unique Identifier (GUID) for the Archive File for which the directory entry is updated.
string
A 38-character string that identifies the Archive File.
GROUP=
Override for Group designation in the original Archive Request.
groupidentifier
1- to 8-character name of the group for the Archive File. Group names can help qualify and categorize Archive Files and the corresponding archived data and can be referenced to locate one or more Archive Files for browsing or restoring data.
NONE
Update the Archive entry with no Group designation.
DESC=
Override for Archive File Description in the original Archive Request.
description
1- to 8-character description.
NONE
Update the Archive entry with no description.
AFXFILE=
Override for the Archive Index File name in the Archive Request.
idxfilename.afx
The name of the Archive Index File. Provide the full path if the file is not in the default Archive Index File Directory.
NONE
Update the Archive entry with no Index File.
PROFILE=
Override for the Storage Profile referenced in the Archive Request.
profilename
The name of a Storage Profile in the current Optim Directory.
NONE
Update the Archive entry with no associated Storage Profile.
DUPLICATE=
Duplicate Archive File to be registered.

(If the duplicate file is registered, an error occurs.)

arcfilename.af
The name of the Archive File. Provide the full path if the file is not in the default Archive File Directory.
REPLACEPRIMARY
Option to register a duplicate Archive File as the primary Archive File.

(If a duplicate file is not registered in the Directory entry, an error occurs.)

+
Designate the duplicate Archive File as the primary Archive File and remove the duplicate designation from the Directory entry.
Retain the primary Archive File registration.
REMOVEDUPLICATE
Option to de-register a duplicate Archive File.

(If a duplicate file is not registered in the Directory entry, an error occurs.)

+
Remove the duplicate Archive File designation from the Directory entry.
Retain the duplicate Archive File designation.
SWAP
Option to reverse primary and duplicate Archive File designations in a Directory entry.

(If a duplicate file is not registered in the Directory entry, an error occurs.)

+
Reverse primary and duplicate Archive File designations.
Retain primary and duplicate Archive File designations.
AFFILE=
The registered Archive File(s) for which the Archive Index is validated.
arcfilename.af
Archive File name or a pattern using wildcards.
SERVER=
Optim Server(s) on which Archive Files reside.
arcservername
Name or pattern for Server(s).
(local)
Archive Files reside on the local Server. (Default)
GROUP=
Group identifier for Archive File(s).
groupidentifier
1- to 8-character identifier or pattern.
NONE
Only validate indexes for Archive Files with no Group designation.
AUTOFIX
Option to repair invalid Archive Indexes found by utility.
+
Repair Archive Index.
-
Do not repair Archive Index.