TARALaunch Parameters - NetBackup

Teradata Extension for NetBackup Administrator Guide

Product
NetBackup
Release Number
16.20
16.10
Published
May 2017
Language
English (United States)
Last Update
2018-05-02
dita:mapPath
bby1489436039204.ditamap
dita:ditavalPath
Audience_PDF_include.ditaval
dita:id
B035-2400
Product Category
Teradata Tools and Utilities

The following table describes TARALaunch parameters, and indicates if the parameter is required. TARALaunch parameter indicators are case sensitive, therefore use the correct case when specifying parameters. Each parameter can only be specified once in the command-line.

Parameters for TARALaunch
Parameter Description Required
-a <jobid> Specifies the 16-character TARA job identification name.

For this parameter, use the job ID that is generated when TARALaunch has launched a job or TARAJobQuery is used with the -L option.

Yes (abort option only)
-b Specifies batch mode, which suppresses interactive messages. No (optional for abort option only)
-j <jobname> Specifies the name of the job to be launched for execution. The jobname value must match the name of an existing job in the Script Repository on the specified TARA server host.

When specifying the jobname value, do not include a path qualifier, spaces, or any of the following characters:

<

>

~

*

,

?

\

/

Example

-j MyBackupJob

Scripts that are created or modified manually are not checked to see if the name contains spaces or characters.

If the job name contains embedded spaces, enclose the entire name in double quotes. Special characters, other than the characters listed above, are allowed.

Example

-j "My Backup Job"

Yes (job launch option only)
-u <User Name> Specifies the User Name that the utility uses to connect to the TARA Server. Currently the user names allowed are administrator and user. The user just has the read-only privilege.

Example

TARALaunch -u administrator

Yes
-p <password> Specifies the password for the user name the utility uses to connect to the TARA server.

Example

TARALaunch -u administrator -p xjmT9Rs

Yes
-e <path to encoded password file> Specifies the path to the file that contains the encoded password to the User Name.

Example

TARALaunch -u administrator -e C:\Teradata\tara.pwd

The file containing the encoded password is created during the post-install of the TARA Server, and is located in the TARA server bin directory: \Teradata\TARA\server\bin). The name of the file is tara.pwd. If the utility is running on a machine different from the TARA server, tara.pwd can be copied to the machine, and the path to the file containing the encoded password can be specified.

If you need to recreate a file with the encoded password, run the TARALogonGen executable located in the TARA server bin directory: \Teradata\TARA\server\bin. Enter the password and the tool creates a tara.pwd. This file contains the encoded password.

Yes
-P <port> Specifies the port number that the TARA server is running on. The default port is 54323. If the TARA Server port is changed to a different number, this option has to be specified with the correct TARA Server port number.

Example

TaraLaunch -u administrator -p xflu74Rs -j MyBackupJob -P 55555

The default is 54323.

No
-s <TARA servername> Specifies the TARA server host where the job to be launched is stored. The TARA servername value can be a host name (for example, taraserver1 or localhost) or an IP address of a host (for example, 153.64.14.142).

The launched job will be run on the specified TARA server host.

Example

-s taraserver1

Example

-s localhost

Example

-s 153.64.14.142

The default is localhost.

No
-v <verbose level:

0|1|2|3>

Specifies the level of debug information to display. There are four valid debug levels (0, 1, 2, and 3), with higher values providing more extensive debug information. More extensive information is typically only useful for utility developers when gathering information about a reported problem.

Level 0 suppresses most debug information, with the exception of some parameter validation errors. This is useful when TARALaunch is used in a batch file (Windows) or shell script (Linux). In this case, the batch file checks the %errorlevel% (Windows) or $? (Linux) to obtain the return code of TARALaunch. Refer to TARALaunch Return Codes for these return values.

Level 1 is the default level if the -v option is not specified. This level displays a successful launch message or any error message that prevented the job launch, plus any errors that occurred during monitoring (when the -w option is used).

Level 2 provides more detail in launching the job. It can be very useful when using TARALaunch interactively with the -w option. In this case, the TARA ARC job States and their associated elapsed time in seconds are displayed until the TARA job ends or the maximum wait time is exceeded.

Some States might not be displayed if they transition to another State within 30 seconds.

Level 3 is typically only useful for utility developers when gathering information about a reported problem.

Example

-v 3

Specifying 3 results in the highest level of debug information.

Example

-v 2

Specifying 2 results in state process level information. If this parameter is not specified, level 1 is used.

The default is level 1.

No
-w <seconds-to-wait> Enables the Wait-for-Completion option. If enabled, TARALaunch remains active until the TARA job it launched terminates. At that point, TARALaunch exits with the return value set to the severity code of the ARC job (0, 4, 8, 12, 16). If an external error occurs (for example, a network error), the return code represents the type of error. TARALaunch Return Codes documents all return codes.

If the -w option is specified without a seconds-to-wait value, TARALaunch waits indefinitely for the TARA job to terminate. If a seconds-to-wait value is specified, TARALaunch waits for that period of time. If the seconds-to-wait value is exceeded, TARALaunch exits with a return code set to 126. The exit of TARALaunch in this situation does not affect the active TARA job.

TARALaunch exits after the TARA job is launched by the TARA server.

No (optional for launch option only)