To remove a TARA job file or a TARA script, use:
TARAJobRM -u <username to logon to TARA server> -p <password to logon to TARA server> OR -e <path to encoded password file> -s <taraserver> -P <port> -S [<script_name> : -f <input_file] [-v 0:1:2:3] OR TARAJobRM -u <username to logon to TARA server> -p <password to logon to TARA server> OR -e <path to encoded password file> -s <taraserver> -P <port> -J [<jobfile_name> : -f <input_file>] [-v 0:1:2:3] -F
TARAJobRM allows the DBA to remove script files or job files from the TARA server repository, using one of the following job specifications:
Parameter | Description | Required |
---|---|---|
-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 TARAJobRM -u administrator |
Yes |
-p <password> | Specifies the password for the user name the utility uses to connect to the TARA Server. Example TARAJobRM -u administrator -p xjmT94Rs |
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 TaraJobRM -u administrator -p xflu7H3g -j MyBackupJob -P 55555The default is 54323. |
No |
-e <path to encoded password file> | Specifies the path to the file that contains the encoded password to the User Name. Example TARAJobRM -u administrator -e C:\Teradata\tara.pwdThe 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 |
-S <script_name> | Specifies a script name, or the name of a file that has a list of script names to delete. If specifying a single file, the name of the file must immediately follow -S. If specifying a file that has a list of script names, precede the file name with -f (see the -f <input_filename> parameter). In the file containing the list:
|
This parameter, or the -J <jobfile_name> parameter, is required. |
-f <input_filename> | Specifies the name of a file that has a list of script or job names to delete. | No |
-J <jobfile_name> | Specifies a job name, or the name of a file that has a list of jobfile names to delete. If specifying a single file, the name of the file must immediately follow -J. If specifying a file that has a list of jobfile names, precede the file name with -f (see the -f <input_filename> parameter). In the file containing the list:
To obtain a list of all jobs in the TARA server repository, use tarajobquery -L. Then, copy those jobfiles to be deleted into a file for TARAJobRM.
|
This parameter, or the -S <script_name> parameter, is required. |
-s <TARAServer_name> | This option is not required if the TARA server resides on the same BAR server where this utility is launched. Otherwise, the TARAServer_name value is the name of the BAR server running TARAServer. | No |
-v | Specifies the verbosity of the utility after parameter validation. The range is 0 to 3. The default is 1. |
No |
-F | For a TARA JobFile only. Forces removal of the JobFile even if there is a valid image in the NetBackup image catalog. | No |
When a single job or script is deleted, the deletion occurs after parameter validation, without verification of the file to be deleted. In contrast, when multiple scripts or jobs are deleted, the user is prompted by the following line:
X files will be deleted. Is this correct? (y,n)
The following table lists TARAJobRM return codes.
Return Code | Description |
---|---|
Return codes 101 - 111 designate errors that can occur during a jobfile or script removal. | |
101 | Unable to connect to the TARA server. |
102 | Network failure sending the file remove request to the TARA server. |
103 | Network failure receiving the file remove response from the TARA 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 designate parameter validation errors. | |
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 a -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 a TARA 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 | Either 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 neither the -S or -J parameters, one of which is required, is found. |
753 | Invalid level specified for -v (0, 1, 2 or 3). |