abujobrm - BAR

Teradata Appliance Backup Utility Installation and User Guide

Product
BAR
Release Number
16.20
Published
November 2017
Language
English (United States)
Last Update
2018-07-13
dita:mapPath
myx1512701901323.ditamap
dita:ditavalPath
Audience_PDF_include.ditaval
dita:id
B035-3134
Product Category
Teradata Tools and Utilities

Purpose

This command allows the database administrator to remove script files or job files from the Appliance Backup Utility server repository.

ABUJobRM is located in /opt/teradata/abu_service/service/bin.

Syntax

abujobrm -u username {-p password | -e path to encoded password file} -P port {-S script_name -f input_file | -J jobfile_name -f input_file} [-F] [-s ABU server name] [-v verbose level: 1|2|3]

Command-line parameters are case-sensitive. Specify each parameter only once in the command line.

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.
abujobrm -u administrator
-p password
Specifies the password for the user name.
abujobrm -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.

To recreate a file with the encoded password, run /opt/teradata/abu_service/service/bin/abulogongen.exe. Enter the password and the tool creates an abu.pwd file that contains the encoded password.

abujobrm -u administrator -e /opt/teradata/abu_service/service/bin/abu.pwd
-P port number
[Optional] Specifies the port number that the Appliance Backup Utility server uses. The default port is 54323.
abujobrm -u administrator -p xflu7 -j MyBackupJob -P 55555
-S script_name
[Either -J or -S parameter is required] Specifies a script name or the name of a file that lists script names to delete.

Specify a single file name immediately following -S. Specify a file that has a list of script names by preceding the file name with -f. In the file that contains the list:

  • Each script name must be the first field in the line.
  • Spaces must delimit the fields in a line.
  • There can be only one script name on each line.
abujobrm -S acctscrpt.res
-J jobfile_name
[Either -J or -S parameter is required] Specifies a job name or the name of a file that has a list of job file names to delete.

Specify a single file name immediately following -J. Specify a file that has a list of job file names by preceding the file name with -f. In the file that contains the list:

  • Each job file name must be the first field in the line.
  • Spaces must delimit the fields in a line.
  • There can be only one job file name on each line.
To obtain a list of all jobs in the Appliance Backup Utility server repository, run abujobquery -L.
abujobrm -J 4c99084c00000002
-f input_filename
Used with -S or -J, this parameter specifies the name of a file that has a list of script or job names to delete.
abujobrm -S -f filelist, where filelist is a list of script names, such as script1.res or script2.bkp.
abujobrm -J -f filelist, where filelist is a list of file names or job IDs, such as 4c99084c00000002.
-F
[Optional] Forces removal of an Appliance Backup Utility job file.
abujobrm -F
-s ABUServer_name
[Optional] This option is not required if the Appliance Backup Utility server resides on the same Teradata Database node where the Appliance Backup Utility is launched. Otherwise, the ABUServer_name value is the name of the Teradata Database node running the Appliance Backup Utility server.
abujobrm -s tdnode1
-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.
abujobrm -v 3

Return Codes

Return Codes 101 - 111
ABUJobRM return codes 101 - 111 designate errors that occur during the removal of a job file or script.
Code Number Description
101 Unable to connect to the Appliance Backup Utility server.
102 Network failure sending the file remove request to the Appliance Backup Utility server.
103 Network failure receiving the file remove response from the Appliance Backup Utility server.
104 Cannot open the job list or script list file.
105 Cannot read the job list or script list file.
106 The job list or script list file contains an unrecognizable line.
110 Cannot read the y or n response to the file verification message.
111 Job terminated. User answered n to the file verification message.
Return Codes 700 - 753
ABUJobRM return codes 700 - 753 designate parameter validation errors.
Code Number Description
700 Incorrect number of parameters entered.
701 The parameter value is greater than the maximum size of 255 characters.
702 A parameter value is not preceded by a parameter key (-s, -S, -J, -f, or -v).
703 Unknown parameter key (not -s, -S, -J, -f or -v).
705 The -J parameter key is specified twice.
706 The -J parameter key is specified, but no value or -f filename is specified.
707 The -J parameter key is specified with a value, but the value is not 16 characters in length.
709 The -s parameter key is specified twice.
710 The -s parameter key does not have an Appliance Backup Utility server value following it.
711 The -s parameter key is specified with a value, but the value is greater than 100 characters in length.
713 The -S parameter key is specified twice.
714 The -S parameter key is specified, but no value or -f filename is specified.
715 The -S parameter key is specified with a value, but the value is greater than 255 characters in length.
738 The -f parameter key is specified twice.
739 The -f parameter key does not have a filename value following it.
740 The value associated with the -f parameter key is greater than 255 characters in length.
743 The -v parameter key is specified twice.
744 The -v parameter key must be followed by a value of 0, 1, 2 or 3.
749 The -S (script) or -J (Jobfile) parameter is required.
750 Both the -S and -J parameters are found. Only one can be specified.
751 The -f parameter is specified but the -S or -J parameter is not specified, one of which is required.
753 Invalid level specified for -v. Valid values are 0, 1, 2 or 3.