Using the Backup Export Utility
The backup export utility has the following restrictions:
| • | Export does not include run-time history such as log files or probe history. |
| • | The -pkgname and -description flags are optional. They let you include a name and notes within the contents.xml to assist in later identification. |
| • | The System user of the Operating System where the TDV Server is running on, should have write access to TDV_INSTALL/conf/server directory |
To use the backup export utility
| 1. | Open a command prompt window. |
| 2. | Navigate to <TDV_install_dir>/bin. |
| 3. | Run backup_export: |
./backup_export
-server <host_name> [-port <port_number>] [-encrypt]
-pkgfile <file_name>
-user <user_name> -password <password> [-domain <domain>]
-encryptionPassword <encryptionPassword>
[ -sso ] [ -sspi ] [ -spn <spn> ] [ -krb5Conf <krb5Conf> ]
[-pkgname <name>] [-description <text>]
[-optfile <file_name>] [-optfilePassword <optpassword>]
[-newOptfilePassword <new optpassword>]
[-excludeJars]
[-includeStatistics]
[-genopt <filename>] [-optfilePassword <optpassword>]
[-verbose]
The backup_export parameters are described in the following table.
|
Backup Export Parameters |
Optional/ Required |
Comments |
|||||||||
|
-server <host_name> |
Required |
Target TDV server to which the utility is to connect. |
|||||||||
|
-port <port_number> |
Optional |
Specifies the Web Services base port (HTTP) used to communicate with the TDV Server. The default value is 9400. |
|||||||||
|
-encrypt |
Optional |
Encrypts communication between the command line and TDV using SSL sent over the dedicated HTTPS port. The HTTPS port is 9402 |
|||||||||
|
-pkgfile <file_name> |
Required |
Specifies the path and file name of the backup archive file (CAR). The file path must be accessible to the command-line client. TDV passes data to the command-line client, and then the client writes that CAR file to the specified location. |
|||||||||
|
-encryptionPassword |
Required |
The password used to encrypt /decrypt sensitive data in your car file, for example, data source password, etc. |
|||||||||
|
-user <user_name> |
Required |
User name of the TDV system administrator. |
|||||||||
|
-password <password> |
Required |
Password of the administrative user who is performing the export. Note: When using an optfile, if the password contains a double quote character, it is necessary to escape the character with a double-quote. |
|||||||||
|
-domain <domain> |
Optional |
User domain. The default value is composite. |
|||||||||
|
-sso |
Optional |
Enables SSO authentication. Must be used with the -spn option. There is no need to input user_name or password. |
|||||||||
|
-sspi |
Optional |
For Windows environments configured with sspi, you can use this parameter after -sso and -spn. |
|||||||||
|
-spn <spn> |
Optional |
Use this parameter after specifying -sso, to indicate what the service principal name is. Use one of the following formats depending on the protocol you are using:
|
|||||||||
|
-krb5Conf <krb5Conf> |
Optional |
For environments configured with multiple Kerberos authentication files, you can use this parameter after -sso and -spn to specify which authentication file to use. <krb5Conf> must specify the full path and filename to use. If this parameter is not specified, the default Kerberos system file is used. |
|||||||||
|
-pkgname <name> |
Optional |
Names an attribute in the contents.xml within the exported backup file. |
|||||||||
|
-description <text> |
Optional |
Description of the exported archive file set as an attribute of the contents.xml file within the exported CAR. This description is displayed prior to a Studio-based import. |
|||||||||
|
-optfile <file_name> |
Optional |
Specifies a file to pass options without using the command line. The options file is useful for hiding password information. For example: backup_export -server localhost -user test -password <password> -pkgfile sample.car is the same as: backup_export -optfile sample.opt -optfilepassword password where sample.opt contains: -server localhost -user test -password <password> -pkgfile sample.car Notes:
|
|||||||||
|
-optfilePassword |
Required if optfile is used. |
Password required to access the option file. |
|||||||||
|
-newOptfilePassword |
Optional |
Use this option to change the optfile password and re-encrypt the password strings in the option file. |
|||||||||
|
-excludeJars |
Optional |
Suppresses export of custom Java procedure data source JAR files. |
|||||||||
|
-includeStatistics |
Optional |
Includes any known cardinality statistics about data source table boundaries, column boundaries, and configurations when statistics gathering is enabled. |
|||||||||
|
-genopt |
Optional |
By giving this option and an opt file name, the parameters will be stored in the opt file with the password encrypted. While doing an export or import operation the password saved will not be shown as a clear text. The file created can later be used in the -optfile option of this backup_export command. Note: An optfilePassword is required for the generated optfile. TDV versions prior to 8.4 do not have this optfile password feature. |
|||||||||
|
-verbose |
Optional |
Generates output describing the export in the command-line window. |