Use the following keywords for archive directory maintenance.
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:
- REGISTER
- Create a directory entry for an archive file.
- UNREGISTER
- Delete the directory entry for an archive file,
with or without deleting the corresponding file from disk.
- UPDATE
- Update directory entry for an archive file.
- AUTODELETE_{SUSPEND|RESUME|STATUS}
- Turn automatic deletion of archive files off (SUSPEND) or on (RESUME),
or queries the automatic deletion status (STATUS), for the specified
directory or for all known directories.
- EXPORTSF
- Export the security file information for a source archive file
into an output security file. This parameter applies only to an archive
file secured with a file access definition.
- securefilename password
- Name of the security file to be created and password for the file.
- 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={optimdirectory |
*}
- The Optim™ directory
for maintenance. If maintenance is for the current (default) directory,
this keyword is not needed.
- optimdirectory
- Directory name.
- *
- All known directories.
Register
- AFFILE=
- The archive file for processing.
- arcfilename.af
- The name of the archive file. Provide the full path
if the file is not in the default archive directory.
- SERVER=
- Server, if any, on which the file resides.
- arcservername
- The name of a server that is referenced in the configuration
file.
- (local)
- The local server. (Default)
- COLLECTION=
- The name of one or more archive file collections.
- SFFILE=
- Name of the security file to be created. Specify:
- arcfilename.SF
- Name of the security file. If the archive file for which the security
file is being created is not in the default directory, specify the
full path.
- PASSWORD=
- Password for the security file.
- GROUP=
- Override for the group designation in the original
archive request.
- groupidentifier
- 1- to 8-character name of the group for the file.
Group names can help qualify and categorize archive files and the
corresponding archived data and can be referenced to locate one or
more files for browsing or restoring data.
- NONE
- Use no group designation.
- DESC=
- Override for file description in the original archive
request.
- description
- 1- to 40-character description.
- NONE
- Use no description.
- AFXFILE=
- Override for the index file name in the archive
request.
- idxfilename.afx
- The name of the file. Provide the full path if the
file is not in the default archive directory.
- NONE
- Use no index file.
- PROFILE=
- Override for the storage profile referenced in the
archive request.
- profilename
- The name of a storage profile in the current directory.
- NONE
- Use no associated storage profile.
- CalculateFrom=
- Determines the date from which the automatic delete date is calculated.
This parameter is valid only if you also specify the PROFILE= profilename parameter.
- CurrentDate
- Calculate the automatic delete date from the current date. This
is the default.
- ArchiveDate
- Calculate the automatic delete date from the archive file creation
date.
- YYYY/MM/DD
- Calculate the automatic delete date from the specified date. The
date you specify must be less than or equal to the current date. Use
the format: yyyy/mm/dd.
- OVERWRITE
- Indicator for processing when directory entry for
the archive file exists (that is, the file and server names for the
entry match those entered on the command line).
- +
- Overwrite directory entry.
- –
- Abort process (default).
Unregister
- AFFILE=
- The archive file for processing.
- arcfilename.af
- The name of the archive file. Provide the full path
if the file is not in the default archive directory.
- SERVER=
- Server, if any, on which the file resides.
- arcservername
- The name of a server that is referenced in the configuration
file.
- (local)
- The local server. (Default)
- AFID=
- The identifier for the archive file. You can obtain
the archive file identifier programmatically, using PST_ARCHIVE_ID,
a built-in variable, with an action.
- n
- An integer that identifies the file.
- GUID=
- The globally unique identifier (GUID) for the file.
You can obtain the GUID programmatically, using PST_ARCHIVE_GUID,
a built-in variable, with an action.
- string
- A 38-character string that identifies the file.
- DELETEFILE
- Indicator for disposition of the file after the
directory entry has been removed.
- +
- Delete the file from disk storage after the directory
entry is removed.
- –
- Retain the file after the directory entry is removed
(default).
Update
- AFFILE=
- The archive file for processing.
- arcfilename.af
- The name of the archive file. Provide the full path
if the file is not in the default archive directory.
- SERVER=
- Server, if any, on which the file resides.
- arcservername
- The name of a server that is referenced in the configuration
file.
- (local)
- The local server. (Default)
- AFID=
- The identifier for the archive file. You can obtain
the archive file identifier programmatically, using PST_ARCHIVE_ID,
a built-in variable, with an action.
- n
- An integer that identifies the file.
- GUID=
- The globally unique identifier (GUID) for the file.
You can obtain the GUID programmatically, using PST_ARCHIVE_GUID,
a built-in variable, with an action.
- string
- A 38-character string that identifies the file.
- COLLECTION=
- The name of one or more archive file collections that the file
is added to.
Note: To add a secured archive file to a collection, you
must first register the security file in the directory.
- GROUP=
- Override for the group designation in the original
archive request.
- groupidentifier
- 1- to 8-character name of the group for the file.
Group names can help qualify and categorize archive files and the
corresponding archived data and can be referenced to locate one or
more files for browsing or restoring data.
- NONE
- Use no group designation.
- DESC=
- Override for file description in the original archive
request.
- description
- 1- to 40-character description.
- NONE
- Use no description.
- PROFILE=
- Override for the storage profile referenced in the
archive request.
- profilename
- The name of a storage profile in the current directory.
- NONE
- Use no associated storage profile.
- CalculateFrom=
- Determines the date from which the automatic delete date is calculated.
This parameter is valid only if you also specify the PROFILE= profilename parameter.
- CurrentDate
- Calculate the automatic delete date from the current date. This
is the default.
- ArchiveDate
- Calculate the automatic delete date from the archive file creation
date.
- YYYY/MM/DD
- Calculate the automatic delete date from the specified date. The
date you specify must be less than or equal to the current date. Use
the format: yyyy/mm/dd.
- Search=
- Updates the archive directory entries for archive files that belong
to a specified collection, group, or storage profile. The Search=
parameter can be specified once and with one value only. This parameter
cannot be used with AFFILE=, AFID=, or GUID= parameters.
- CollectionName
- Name of the archive file collection.
- GroupName
- Name of the group.
- ProfileName
- Name of the storage profile.
- DUPLICATE=
- Duplicate archive file to be registered. (If the
duplicate file is already 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 directory.
- REPLACEPRIMARY
- Register a duplicate archive file as the primary.
(If a duplicate file is not registered, an error occurs.)
- +
- Designate the duplicate file as the primary and
remove the duplicate designation from the directory entry.
- –
- Retain the primary registration.
- REMOVEDUPLICATE
- Unregister a duplicate file. (If a duplicate file
is not registered, an error occurs.)
- +
- Remove the duplicate file designation from the directory
entry.
- –
- Retain the duplicate file designation.
- SWAP
- Reverse primary and duplicate file designations.
(If a duplicate file is not registered, an error occurs.)
- +
- Reverse primary and duplicate file designations.
- –
- Retain primary and duplicate file designations.
ExportSF
- AFFILE=
- The archive file for processing.
- arcfilename.af
- The name of the archive file. Provide the full path
if the file is not in the default archive directory.
- SERVER=
- Server, if any, on which the file resides.
- arcservername
- The name of a server that is referenced in the configuration
file.
- (local)
- The local server. (Default)
- PASSWORD=
- Password for the security file.
- DUPLICATE=
- This parameter is required if the file for which security information
is being exported is a secondary or duplicate file.
- arcfilename.af
- The name of the archive file. Provide the full path
if the file is not in the default archive directory.
- SFFILE=
- Name of the security file to be created. Specify:
- arcfilename.SF
- Name of the archive file for which security file is being created.
If the archive file is not in the default directory, specify the full
path. If you do not specify a name for the security file, the name
of the archive file is used and the security file suffix, .SF, is
appended to it.