abujobquery - BAR

Teradata Appliance Backup Utility Installation and User Guide

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

Purpose

This command allows you to view job-related information for all Appliance Backup Utility jobs, including jobs that have failed. The job information is stored in a job information file in the JIR directory on the Appliance Backup Utility server. You can see a list of all job-information files, but only one job-information file can be accessed at a time. You can run ABUJobQuery using the list parameter to find the name of the file that you want to query, then run ABUJobQuery using the job parameter to display job data from that job-information file.

Syntax

abujobquery -u username {-p password | -e path to encoded password file} {-L | -j jobid [-S stream options] [-O object options] [-l] } [-P port] [-s ABU server name] [-f output file 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.
abujobquery -u administrator
-p password
Specifies the password for the user name.
abujobquery -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. Enter the password and the tool creates an abu.pwd file that contains the encoded password.

abujobquery -u administrator -e /opt/teradata/abu_service/service/bin/abu.pwd
-L
Lists summary job information for each job-information file in the job repository (JIR directory) on the specified Appliance Backup Utility server. The list shows what data is stored in each job-information file, including the jobid required to run ABUJobQuery using the -j jobid parameter.
If you specify -L, you cannot use the -j jobid parameter.
abujobquery -L
-j jobid [-S stream options] [-O object options] [-l ]
Queries for job information in a single job-information file. The jobid value is typically a 16-digit number. The following parameters are optional.
If you specify -j jobid, you cannot use the -L parameter.
Parameter Description
-S stream options [Optional] Displays job stream information. The stream options value is a string of characters in which each character specifies a type of stream information:
  • c - Client machine name
  • e - Exit code
  • f - File type (archive or journal)
  • g - Group name
  • n - Dataset name
  • s - Stream size
  • t - Stream time to complete (displayed in HH:MM:SS format)
-O object options [Optional] Displays job object information. The object options value is a string of characters in which each character specifies a type of object information:
  • c - Object count
  • h - Hierarchical view (defaults to Traditional view)
  • o - Owner name
  • s - Object size
  • t - Object time (displayed in HH:MM:SS format)
  • y - Object type (table or journal)

The job object information can be displayed in a traditional or hierarchical view. In a traditional view, the objects appear in alphabetical order without regard to parent and child relationship. In a hierarchical view, the objects appear in alphabetical order according to their parent and child relationship.

-l [Optional] Creates a file to store ARC log information. There is one file created for each stream that is defined for the job. If you specify -l, the -f output file name parameter is also necessary. The -f output file name parameter generates one or more files for ARC output (for example, myname_log_1.txt).
abujobquery -j 43c2ac5800000001
abujobquery -S cefgnst
abujobquery -O chosty
abujobquery -l
-P port number
[Optional] Specifies the port number that the Appliance Backup Utility server uses. The default port is 54323.
abujobquery -u administrator -p xflu7 -j MyBackupJob -P 55555
-f output file name
[Optional] Names the output file that ABUJobQuery generates. This parameter is valid with the List and Query options.
For the Query option, the output file name is used as the base name for:
  • output file name_job.txt - Job information and stream info
  • output file name_obj.txt - Object information
  • output file name_log_%d.txt - Log file for stream %d (only if -l specified)

If you do not specify a value, the output is sent to stdout, which is usually the monitor. When sent to the monitor, a permanent copy of the file is not kept. A fully-qualified output file name creates files in the specified directory. An output file name that is not fully-qualified creates files in the current directory. Log records stored in the name_log_%d.txt file consist of the output lines from the ARC job that the Appliance Backup Utility job runs. In a multistream job, each stream-specific log file contains the output from the corresponding stream in the ARC job.

For the List option, the output files are created with the full name you specify for the output file:
  • myname_job.txt - Job information and stream info
  • myname_obj.txt - Object information
  • myname_log_1.txt - Log file for stream (if there is one stream and -l is specified)

If the name contains embedded spaces or special characters, enclose the entire name in straight quotation marks: "my name" or "mydir/My Documents/myname".

abujobquery -f myname
-s ABUServer_name
[Optional] Specifies the Appliance Backup Utility server where the job-information file and job repository are stored. The ABU service name value can be a host name or a host IP address. This parameter is valid with the List and Query parameters.
abujobquery -s localhost
abujobquery -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.
abujobrm -v 3