The KeyWords for Job Scripts table describes valid keywords for backup and restore job scripts.
Keyword | Required for Backup | Required for Restore | Rules | Description |
---|---|---|---|---|
CATALOG | No | No | The CATALOG keyword must be used in the backup job script that is associated with a restore job. | CATALOG specifies positioning data so that when an object is restored, the object can be located without searching the entire tape. If the CATALOG keyword is used in a backup job script, positioning information is saved so that is can be used in the associated restore job. |
COMMANDLINE | Yes | Yes | COMMANDLINE specifies the optional arguments that are passed to each ARC stream when the stream is launched. | |
ENDSCRIPT | Yes | Yes | ENDSCRIPT must be the last keyword in the script. | ENDSCRIPT marks the end of the ARC script section. |
JOB | Yes | Yes | The value is the name assigned to the TARA job. | |
MULTISTREAM | Yes | Yes | MULTISTREAM specifies the number of streams that will be launched for the job. | |
TIVPOLICY | Yes | No | There must be the same number of TIVPOLICY keywords as the MULTISTREAM value, unless TIVPOLICYGROUP is used instead of TIVPOLICY. | The value is the name of the policy defined by the Backup Administrator. |
TIVPOLICYGROUP | Yes | No | The value is the Client Group name, which is configured in TARA and contains Tivoli policy names. | |
ONLINELOGOFF | No | N/A | Users must not add the _ONLINE_LOGOFF suffix to backup job file names because the suffix is used by TARA. A backup job file name that has been specified with a suffix by the user does not appear in the RESTORE object selection dialog box. | When ONLINELOGOFF is used, two jobs are launched. The first job is an active backup job. Status of the second job is pending until the first job completes, at which point the second job sets online logging off. The name of the second job appends _ONLINE_LOGOFF to the name of the first job. |
OTB | Yes | No | The value of OTB is "Tivoli". | |
PASSWORD | No | No | PASSWORD is used with the USERID keyword. This value cannot be manually generated. | PASSWORD is used by the ARC userid logon and Teradata Database. |
SCRIPT | Yes | Yes | SCRIPT must immediately precede the ARC script. | SCRIPT marks the end of the TARA script section and the beginning of the ARC script section. |
SESSIONS | Yes | Yes | SESSIONS specifies the number of data sessions per stream that ARC establishes with Teradata Database for a backup or restore job. | |
SOURCEUID | No | Yes | SOURCEUID identifies the backup job that created the dataset used for the restore job. SOURCEUID is the file name and internal TARA job identifier. | |
STREAM | Yes | Yes | There must be the same number of STREAM keywords as the MULTISTREAM value. | STREAM is one of the following:
|
STREAMNAME | N/A | No | If used, there must be the same number of STREAMNAME keywords as the MULTISTREAM value. | In a restore job, STREAMNAME overrides the image name that is stored in the backup jobfile (SourceUID). |
TDPID | Yes | Yes | The TDP identifier of the Teradata Database to which Teradata ARC connects to perform a backup or restore. | |
USERID | No | No | If used, there must be a PASSWORD keyword. | USERID is the Teradata user database logon account that Teradata ARC uses. |