TARAScriptConv - NetBackup

Teradata Extension for NetBackup Administrator Guide

Product
NetBackup
Release Number
16.20
16.10
Published
May 2017
Language
English (United States)
Last Update
2018-05-02
dita:mapPath
bby1489436039204.ditamap
dita:ditavalPath
Audience_PDF_include.ditaval
dita:id
B035-2400
Product Category
Teradata Tools and Utilities

The TARAScriptConv utility allows the conversion of NetBackup ARC script files from an existing Backup Application Software format to the TARA format. (Currently, only the conversion of NetBackup ARC script files is supported.) TARAScriptConv is a stand-alone, command-line utility. Only one ARC script file can be converted at a time.

After the ARC script file(s) has been converted by TARAScriptConv, it can be stored as a stand-alone local script file or as a script file in a Script Repository (SR directory) on a TARA server host. See the output target parameter (-r) for information on how to do this.

TARAScriptConv parameter indicators are case sensitive, therefore use the correct case when specifying parameters. Each parameter can only be specified once in the command-line.

TARAScriptConv -t -i -r -U -W [-s -f -o -u -p -P -v]
       -t <Backup Application Software script type:  NB> - (required)   
       -i <input file name>                              - (required)
       -r <output target:  R|F|B>                        - (required)
       -U <username to logon to TARA server              - (required)
       -W <password to logon to TARA server              - (required)

OR

       -E <path to encoded password file> (required)
       -s <TARA servername>             - (optional)
       -P <port>                        - (optional)
       -f <script file name>            - (optional)
       -o <output name>                 - (optional)
       -u <user id>                     - (optional)
       -p <password>                    - (optional)
       -v <verbose level:  1|2|3>       - (optional)
If the .bch file that is being converted has more data streams listed than were specified by n in the DATASTREAMS field, only the number of streams that were designated by n will be included in the converted script.

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

Parameters for TARAScriptConv
Parameter Description Required
-t <Backup Application Software script type: NB> Specifies the type of Backup Application Software script to convert.

Currently, TARAScriptConv only supports the conversion of NetBackup ARC scripts. The Backup Application Software script type value is NB.

The Backup Application Software script type value is case sensitive.

Example

-t NB

Yes
-i <input file name> Specifies the name of the primary ARC script file to be converted. All Backup Application Software vendors must have a primary ARC script file. For NetBackup, the input file name value is the name of the NetBackup batch file and must have a .bch extension. A fully qualified input file name value can be specified.

Example

-i mybackup.bch"

Example

-i "/mydir/My Documents/mybackup.bch"

Example

-i "/usr/mybackup.bch"

If a fully-qualified input file name is specified, the file must exist in the specified location. If a fully-qualified input file name is not specified, the file must exist in the current directory.

If the input file name contains embedded spaces or special characters, enclose the entire name in double quotes.

Example

-i "my backup.bch"

Example

-i "C:\My Documents\mybackup.bch"

Yes
-r <output target: R|F|B> Specifies the target for the converted ARC script file. The output target values, which are case-sensitive, are:

R - repository

F - local file

B - repository and local file

Specify only one of these values at a time.

If R is specified, the converted ARC script file is stored in the Script Repository on the specified TARA server host with the specified name (see the -s and -o parameters).

If F is specified, the converted ARC script file is stored as a local file on the host on which you are executing TARAScriptConv (see -o parameter for name and location information).

If B is specified, the converted ARC script file is stored in the specified Script Repository and as a local file on the executing host.

Example

-r R

Example

-r F

Example

-r B

Local file names can be fully qualified. Repository file names cannot be qualified.

Yes
-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

TARAScriptConv -U administrator

Yes
-W <password> Specifies the password for the user name the utility uses to connect to the TARA Server.

Example

TARAScriptConv -U adminstrator -W xjmT9

Yes
-E <path to encoded password file> Specifies the path to the file that contains the encoded password to the User Name.

Example

TARAScriptConv -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
-s <TARA servername> Specifies the TARA server host where the converted ARC script file will be stored if the -r R or the -r B parameter was specified. If -r F is specified, this parameter is ignored.

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

The default is localhost.

No
-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

TaraScriptConv -U administrator -p xflu74Rs -j MyBackupJob -P 55555

The default is 54323.

No
-f <script file name> Specifies the name of a secondary ARC script file to be converted. Not all Backup Application Software vendors will have a secondary ARC script file. For NetBackup, the script file name value is the name of the ARCMAIN script file and must have an .scr extension. A fully qualified script file name value can be specified.

The script name must not have any spaces or any of the following characters:

<

>

~

"

*

,

?

\

/

Scripts that are created or modified manually are not checked to see if the name contains spaces or the characters listed above.

Example

-f mybackup.scr

Example

-f "/mydir/My Documents/mybackup.scr"

Example

-f "/usr/mybackup.scr"

If a fully-qualified script file name is specified, the file must exist in the specified location. If a fully-qualified script file name is not specified, the file must exist in the current directory.

If the script file name contains embedded spaces or special characters other than those listed above, enclose the entire name in double quotes.

Example

"my backup.scr"

Example

"/mydir/My Documents/mybackup.scr"

Yes, for NetBackup.

No, for other Backup Application Software products.

-o <output name> Assigns the name to the converted ARC script file. The output name value is used for the Repository file and the Local file. A fully qualified output name value can be specified.

Example

-o mybackup

Example

-o "/mydir/My Documents/mybackup"

Example

-o "/usr/mybackup"

Local file names can be fully qualified. Repository file names cannot be qualified.

If a fully qualified output name value is specified, that name will be used for any Local file that is created.

Repository files cannot be qualified, therefore any fully qualified output name value must be modified before it can be applied to the Repository file. Any path qualifier(s) will be stripped from the name and only the file name portion of the fully qualified output name value will be used.

Example

If the output name value is specified as:

-o “mydir/My Documents/mybackup”

then the Local file name will be:

mydir/My Documents/mybackup

and the Repository file name will be:

mybackup

If the output name value is specified as:

-o mybackup

then the Local file name will be:

mybackup

and the Repository file name will be:

mybackup

If this parameter is not specified, the name of the converted ARC script file will be the input file name value minus the .bch extension.

No
  Example

If the input file name value is specified as:

-i /mydir/My Documents/mybackup.bch

then the Local file name will be:

/mydir/My Documents/mybackup

and the Repository file name will be:

mybackup

 
  If a fully-qualified file name is specified, the Local script file will be created in the specified location. The Repository file will be created in the Script Repository on the specified TARA server host.

If a fully-qualified file name is not specified, the Local script file will be created in the current directory. The Repository file will be created in the Script Repository on the specified TARA server host.

The script name must not have any spaces or any of the following characters:

<

>

"

~

*

,

?

\

/

Scripts that are created or modified manually are not checked to see if the name contains spaces or the characters listed above.

If the output name value contains embedded spaces or special characters other than those listed above, enclose the entire name in double quotes.

Example

-o "my backup"

Example

-o "/mydir/My Documents/mybackup"
 
-u <user id> Specifies the User ID in the TARA script. This user ID, plus the password value, is required to log on to the host that the ARC script runs against. For example, if the ARC script performs an archive of host A, then the user id value must be the User ID needed to log on to host A.

Example

-u user1

If a user ID is not specified, TARA uses a default User ID in the ARC script.

No
-p <password> Specifies the password in the TARA script. This password, plus the user id value, is required to log on to the host that the ARC script runs against. For example, if the ARC script performs an archive of host A, then the password value must be the password needed to log on to host A.

Example

-p password1

If a password is not specified, TARA uses a default password in the ARC script.

No
-v <verbose level: 1|2|3> 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.

If this parameter is not specified, debug information does not display.

No