Command Line Keywords For Archive File Migration

Use the following commands and parameters on the command line for Archive File Migration.

Process

PR0CMND
Type PR0CMND to initiate command line processing. Note that the character following PR is the number 0 (zero).
/MIGRATE
Command to perform Archive File Migration. Specify /MIGRATE or –MIGRATE. The abbreviated forms are /M and –M.
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.
MDESCRIPTION=
Description for the Archive File Migration Process.
description
(NONE)
IAF=
Name of the source or input Archive File to migrate. If a File Access Definition secures the file, the file must be registered.
inarcfilename
The name of the Archive File. Provide the full path if the file is not in the default Archive File Directory.

Migrated File

OAF=
Name of the output Archive File. Use one of the following options:
outarcfilename
The name of the migrated Archive File. This name must be different from the fully qualified source file name. Provide the full path if the file is not in the default Archive File Directory.
*
Give the output Archive File the name of the source Archive File. The source file is automatically de-registered and replaced by the output file, which is given a new Directory entry.
SERVER=
Server, if any, on which the migrated Archive File resides.
servername
The name of an Optim™ Server that is referenced in the Product Configuration File.
(local)
The local server. (Default)
STORAGEPROFILE=
A Storage Profile is needed for a file that is migrated to a supported backup device (Centera, Tivoli®, etc.) or is segmented. If you do not use this keyword, the Storage Profile for the source file is used.
storeprofilename
Name of a Storage Profile in the Optim Directory.
(NONE)
Do not use a Storage Profile.
OVERWRITE
Indicator for file processing when the Archive File name and Server name for the migrated file match those of an existing file.
+
Overwrite file.
Do not overwrite file.
COMPRESS
Compression indicator for the migrated file.
+
Compress the file (default).
Do not compress the file.
AD=
An Access Definition name for the output file is required if the source file was created on a z/OS® platform. (z/OS only)
identifier
1- to 8-character qualifier.
name
1- to 12-character base name.
DBALIAS=
An Access Definition on a z/OS platform typically includes a Default Creator ID that is applied to the names of DB2® tables that are referenced in the Table List without a specific Creator ID (in other words, cid.tablename). The Access Definition for the migrated file must have a two-part Default ID that includes the DBAlias needed for access to the data base (in other words, dbalias.cid.tablename). When migrating a file from a z/OS platform, you must provide the DBAlias for tables in the migrated file.

If you do not use this keyword, the default, DBZOS, is used. (z/OS only)

dbaliasname
1- to 12-character DB Alias name. The DB Alias not need exist in the Optim Directory.
REGISTER
Registration indicator for the migrated file.
Note: If an FAD secures the file, the file must be registered.
+
Register the file (default).
Do not register the file.
PST=
The Optim Directory in which the migrated file is registered. If the file is registered in the current (default) Optim Directory, this keyword is not needed.
optimdirectory
Optim Directory name.
REPLACEDIR
Indicator for Directory entry processing when the Archive File name and Server name for the migrated file match those of a previously registered file.
+
Replace an Archive Directory entry.
Do not replace an Archive Directory entry (default).
ALLOWORPHAN
If migrating and registering an Archive File stored on a backup device, the Directory entry for the migrated file will not record the copy on the backup device. If the new Directory entry replaces the previous entry for a source file on a backup device, the file is “orphaned.” In general, an orphaned file is deleted from the backup device and, if not, it can be removed from the device manually. However, you cannot delete a Centera file that is assigned a retention period.

Use ALLOWORPHAN to manage migration of a Centera file that has a retention period.

+
Replace the Directory entry for a Centera file with retention period. (The file cannot be removed from the Centera device until the retention period has lapsed, but can be registered.)
Do not replace the entry for any Centera file with a retention period (default).
RETAINGUID
Indicator for Globally Unique Identifier (GUID) processing. If the source file was created on a z/OS platform, this parameter is ignored and a warning given.
+
Retain the GUID (default). If registering the migrated file, you must replace any entry with the same GUID or file name and server.
Generate a new GUID for the migrated file (default).
FAD=
The File Access Definition (FAD) for the migrated and registered file. User privilege for the Secured Archive File Task to Modify Security is required. If you do not use this keyword, the FAD for the source file is used.
identifier.name
If an FAD is specified, you must register the file.
(NONE)
Do not secure the migrated file.
GROUP=
The Group for the migrated and registered file. If the output file is not registered during Archive File Migration, this parameter is ignored. If you do not use this keyword, the Group designation for the source file is used.
groupname
1- to 8-character Group designation for the migrated file.
(NONE)
Do not use a Group designation for the migrated file.
DESCRIPTION=
The description for the migrated and registered file. If the output file is not registered during Archive File Migration, this parameter is ignored. If you do not use this keyword, the description for the source file is used.
description
1- to 40-character description for the migrated file.
(NONE)
Do not use a description for the migrated file.