TARAJobQuery - Tivoli

The TARAJobQuery utility allows the display of job-related information for all TARA jobs that have run (even those that have failed) without having to use the Teradata TARA GUI. TARAJobQuery is a stand-alone, command-line utility.

The job information that TARAJobQuery accesses is stored in a Job Information file, which resides in the Job Repository (JIR directory) on a TARA server host. Only one Job Information file can be accessed at a time.

TARAJobQuery provides two options for displaying job information:

The List option allows the listing of summary job information for each Job Information file in the Job Repository. The information provided in this option allows the user to determine what data is stored in each Job Information file.
The Query option allows the display of specific job information for a single Job Information file. Only one Job Information file can be accessed at a time.

A typical scenario is to run TARAJobQuery using the List option first to find the Job Information file that you want to query. Then, rerun TARAJobQuery using the Query option to display the job data from that Job Information file.

Run the TARAJobQuery utility by using the following job specifications. The command-line parameter indicators are case sensitive, therefore use the correct case when specifying the individual parameters. Also, specify each parameter only once in the command-line.

To query for a list of summary information from each Job Information file, use:

TARAJobQuery -u <username to log onto TARA server>
             -p <password to log onto TARA server>
						OR
             -e <path to encoded password file>**
             -L or -j is required.


-L                             - (required) -- display summary list
-s <TARA servername>           - (optional)
-P <port>                      - (optional)
-f <output file name>          - (optional)
-v <verbose level:  1|2|3>     - (optional)
full_name                      - (optional)

The full_name option prints the entire job name. If you do not use the full_name option, only the first 30 characters are displayed.

To query for specific job information from a single Job Information file, use:

TARAJobQuery -u <username to log onto TARA server>
             -p <password to log onto TARA server>
						OR
             -e <path to encoded password file>

-j [-s -S -O -f -l -L -N -P -v]
       -j <jobid>            - (required)
       -s <TARA servername>  - [Optional]
       -P <port>             - [Optional]
       -S <stream options>   - [Optional]
       -O <object options>   - [Optional]       
       -f <output file name> - [Optional]       
       -l <output ARC logs>  - [Optional]
       -L <output ARC logs>  - (optional parameter that is not valid with Tivoli)
       -N <output NetBackup job data> - (optional parameter that is not valid with Tivoli)
       -v <verbose level:  1|2|3>     - [Optional]

The following table describes TARAJobQuery parameters, and indicates if the parameter is required.

Parameters for TARAJobQuery
Parameter	Description	Required	Default
-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 TARAJobQuery -u administrator	Yes	Not Applicable
-p <password>	Specifies the password for the user name the utility uses to connect to the TARA Server. Example TARAJobQuery -u administrator -p xjmT94Rs	Yes	Not Applicable
-e <path to encoded password file>	Specifies the path to the file that contains the encoded password to the User Name. Example TARAJobQuery -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	Not Applicable
-L	This is the List option, which enables the listing of summary job information for each Job Information file in the Job Repository. The information provided for each Job Information file includes the file's associated jobid that is needed to run TARAJobQuery using the Query option (see the -j parameter). There is no value specified with this parameter. Example -L If you specify -L, you cannot use the -j <jobid> parameter.	Yes	Not Applicable
full_name	Modifies the -L option only. Prints the entire name of the job. If you do not use the full_name option, only the first 30 characters of the job are displayed. (The JobId (-j) option always displays the entire TARA job name.)	No
-j <jobid>	This is the Query option. This parameter enables the display of the job information stored in a single Job Information file. The jobid value specifies the Job ID of the Job Information file whose information is to be retrieved. The jobid value is typically a 16 digit number and is typically used as the name of the Job Information file. The names of the available Job Information files are in the Job Repository (JIR directory) on the specified TARA server host (see -s parameter). To determine what data is stored in a Job Information file (and its associated jobid), execute TARAJobQuery using the List option (see the -L parameter). Example -j 43c2ac5800000001 If you specify -j <jobid>, you cannot use the -L parameter.	Yes	Not Applicable
-s <TARAServer_name>	This parameter specifies the TARA server host where the Job Information file and Job Repository are 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). Example -s localhost Example -s 153.64.14.142 This parameter is valid with the List option and the Query option. The default is localhost.	No	localhost
-P <port number>	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 TaraJobQuery -u administrator -p xflu7k3M -j MyBackupJob -P 55555 The default is 54323.	No	54323
-S <stream options>	This parameter specifies the job's stream information that will appear. The stream options value is a string of characters in which each character specifies a type of stream information. The string value can include one or more of the following characters: 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) Example -S cefgnst This parameter is valid only with the Query option. The default is cest.	No	cest
-O <object options>	This parameter specifies the job's object information that will appear. The object options value is a string of characters in which each character specifies a type of object information. The string value can include one or more of the following characters: 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's 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/child relationship. In a Hierarchical view, the objects appear in alphabetical order according to their parent/child relationship. Example -O chosty This parameter is valid only with the Query option. The default is sty.	No	sty
-f <output file name>	This parameter specifies the name to be used in creating files for the output that is generated by TARAJobQuery. If the List option is specified, the output file name value is the full name given to the output file. If the Query option is specified, the output file name value is the base name given to these output files: <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) This parameter is optional. If not specified, the output generated will be sent to stdout, which is usually the monitor. When sending output to the monitor, a permanent copy of the file is not kept. If a fully-qualified output file name is used, the files are created in the specified directory. If a fully-qualified output file name is not used, the files are created in the current directory. Log records stored in the <name>_log_%d.txt file are the output lines from the ARC job that the TARA job executes. In other words, the log file contains output from the ARC job. In a multi-stream job, each stream-specific log file contains the output from the corresponding stream in the ARC job. Example -f myname If the List option is used, a single file, myname, would be created to store the output from TARAJobQuery. If the Query option is used, these files would be created: myname_job.txt myname_obj.txt myname_log_1.txt (if there is one stream and -l is specified) Example If the name contains embedded spaces or special characters, enclose the entire name in double quotes: "my name" OR "mydir/My Documents/myname" This parameter is valid with the List option and the Query option.	No	Not Applicable
-l	This parameter enables the creation of a file(s) to store ARC log information. There is one file created for each stream that is defined for the job. There is no value specified with this parameter. If you specify -l, the -f <output file name> parameter is also necessary. Example -l The -f <output file name> parameter generates a file(s) for ARC output (for example, myname_log_1.txt). This parameter is valid only with the Query option. If this parameter is not specified, the ARC output that the TARA job generates will not be stored in a user-specified file.	No	If this parameter is not specified, the ARC output that the TARA job generates will not be stored in a user-specified file.
-v <verbose level: 1\|2\|3>	This parameter specifies the level of debug information to display. There are three valid debug levels (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. Example -v 3 Specifying 3 results in the highest level of debug information. This parameter is valid with the List option and the Query option. If this parameter is not specified, debug information will not display.	No	If this parameter is not specified debug information will not display