abulaunch - BAR

Purpose

This command allows you to run a job script without using the Appliance Backup Utility GUI. The script must already exist and be stored in the script repository (SR directory) on an Appliance Backup Utility server. You can launch only one script at a time.

Parameters

-u username

Specifies the user name for the Appliance Backup Utility server. Valid names are administrator and user. The user has read-only privilege.

abulaunch -u administrator

-p password

Specifies the password for the user name.

abulaunch -u administrator -p xjmT9

-e path to encoded password file

Specifies the file path for the username password. The file abu.pwd is located in /opt/teradata/abu_service/service/bin.

abulaunch -u administrator -e /opt/teradata/abu_service/service/bin/abu.pwd

-j jobname

Specifies the job name, which must match the name of an existing job in the script repository on the specified Appliance Backup Utility server.

Do not include a path qualifier or any of the following characters in the jobname: < > ~ “ * , ? . \ /

If you create or modify a script and the job name contains embedded spaces, enclose the entire name inside straight quotation marks. For example, -j "My Backup Job".

abulaunch -j MyBackupJob.bkp

-P port number

[Optional] Specifies the port number that the Appliance Backup Utility server uses. The default port is 54323.

abulaunch -u administrator -p xflu7 -j MyBackupJob.bkp -P 55555

-s ABU service SMP node name

[Optional] Specifies the Appliance Backup Utility server where the job-information file and job repository are stored. The ABU service SMP node name value can be a host name or a host IP address. This parameter is valid with the List and Query options.

abulaunch -s localhost

abulaunch -s 153.64.14.142

-v verbose level: 1|2|3

[Optional] Specifies the level of debug information.

Higher values provide more extensive information. This information typically is only useful for utility developers when gathering information about a reported problem.

• Level 0 - Suppresses most debug information. The exception is parameter validation errors, which are useful when you use ABULaunch in a shell script. The shell script checks $? to obtain the ABULaunch return code.
• Level 1 - Default. This level displays a successful launch message, any error messages indicating what prevented the job launch, and errors that occurred during monitoring if the -w parameter is used.
• Level 2 - Most useful with ABULaunch -w parameter, to display job states and elapsed time in seconds until the job ends or the maximum wait time is exceeded.
• Level 3 - Provides the most debug information.

abulaunch -v 3

-w seconds to wait

[Optional] Keeps ABULaunch active until the job completes or the specified seconds have elapsed. Then ABULaunch closes with the return value set to the ARC job severity code (0, 4, 8, 12, 16).

If an external error occurs, such as a network error, the return code represents the type of error. If the -w option is specified without a seconds-to-wait value, ABULaunch waits indefinitely for the job to terminate. If the seconds-to-wait value is exceeded, ABULaunch exits with a 126 return code. However, the active job is not affected.

abulaunch -w 45

Return Codes

Return Codes 0 - 16

ABULaunch return codes 0 - 16 indicate if the job launched successfully.

Code Number	Description
0	Successful ARC job termination.
4	ARC job completed with warnings.
8	ARC job completed with non-fatal errors.
12	ARC job terminated with fatal errors.
16	Internal ARC failure.

Return Codes 100 - 199

ABULaunch return codes 100 - 119 are parameter validation errors.

Code Number	Description
101	Incorrect number of parameters given to ABULaunch.
102	Missing parameter (-j -s -v -w) and value is greater than 256 characters.
103	Parameters (-j -s -v -w) must begin with a hyphen.
104	The parameter value is more than one word.
105	The -j parameter is specified more than once.
106	The initial parameter is -j and is not followed by a value.
107	The -j value is longer than 255 characters.
108	The -j parameter is not followed by a value.
109	The -s parameter is specified more than once.
110	The initial parameter is -s and is not followed by a value.
111	The -s value is longer than 100 characters.
112	The -s parameter is not followed by a value.
113	The -v parameter is specified more than once.
114	The -v parameter is not followed by a value.
115	The -v value is too long.
116	The initial parameter is -v and is not followed by a value.
117	The -v value must be one character.
118	The -w value must be a non-zero decimal number.
119	The parameter is not -j, -s, -v or -w.

Return Codes 126 and 127

ABULaunch return codes 126 and 127 indicate that the job was successfully launched with the Wait-for-Completion option, but ABULaunch could not continue monitoring the job.

Code Number	Description
126	The seconds-to-wait time expired during the wait-for-job-completion monitoring.
127	A network error terminated the ABULaunch connection to the ABU server during the wait-for-job-completion monitoring.

Return Codes 201 - 206

ABULaunch return codes 201 - 206 indicate that ABULaunch was unsuccessful in attempting to launch the job.

Code Number	Description
201	ABULaunch could not make the initial connection to the ABU server.
202	Network error terminated the initial send to the ABU server.
203	Network error terminated the initial receive from the ABU server.
204	The ABU server rejected the request.
205	Network error during job launch request transmission.
206	Network error waiting for response of job launch request.