Convert LiteSpeed Backups to SQL Server Backups
The extraction utility (extractor.exe) allows you to create MTF compliant SQL Server backup files from LiteSpeed backup files through the command-line. The devices created by the extractor utility can be restored on any SQL Server using the native RESTORE DATABASE or RESTORE LOG commands. The utility must be run on the server where the backup files are located.
This topic covers:
To use the utility, run the command line and change the directory until you are in the LiteSpeed installation directory (Usually, C:\Program Files\Quest Software\LiteSpeed\SQL Server).
Syntax
extractor.exe ( -? | ( [-F <sqllitespeed_backup_file>]
[-E <base_file_name>]
[-N <file_number>]
[-K <encryption_key>]
[-L (0|1|2)]
[-c <tsm_client_node>]
[-i <tsm_filespace>]
[-k <tsm_owner_password>]
[-j <tsm_config_file>]
[--TSMPointInTime <date_time>]
[-I] ) )
Arguments
NOTES:
- Single-letter arguments are case-sensitive, and they can be preceded by a figure dash '-' or '/'.
- Verbose multi-letter arguments are not case-sensitive, they must be preceded by double dashes '--'.
|
-? |
--ShowHelp |
Displays the syntax summary of the LiteSpeed command-line utility. |
| -c |
--TSMClientNode |
Specifies the TSM server LiteSpeed connects to during backups and restores. Not required, if specified in the options file or if backing up with the Passwordaccess Generate option. |
|
-E |
--MTFFile |
Specify the location and name of the Microsoft Tape Format (MSTF) base file.
The extractor utility will create one backup device file for each thread used in a LiteSpeed backup.
The extracted files containing the native SQL Server backup will have the following format: base_file_namex.
Where:
-
base_file_name is the specified Microsoft Tape Format base file.
-
x is a number or letter that represents the sequence of the files. In case there are no additional files, the base file will not have an x appended to its name.
NOTES:
- You can specify a network destination for this parameter.
- You only need to specify this parameter once. The extraction utility will create all the necessary files automatically.
- You cannot tell the extraction utility to extract a different number of native SQL Server files. However, you can specify different destinations for the extracted files by supplying a file name with the -E parameter for each of the native SQL Server files. To see how many files extractor.exe will create, run it without this parameter. See example 4 for more information.
- If a full path is not specified, the extracted files will be created in the current directory.
|
|
-F |
--BackupFile |
The name of the LiteSpeed backup device file to be extracted. This argument accepts network destinations.
For TSM backups and TSM archives, this argument accepts the following formats:
- tsmbkp:<filespace>\<high>\<low>
- tsmarc:<filespace>\<high>\<low>
You can supply multiple instances of this argument. |
|
-I |
--Overwrite |
Re-initializes (overwrites and replaces) the target native backup files.
- 0 (appends the backup to an existing backup file)
- 1 (overwrite the existing target backup file)
|
| -j |
--TSMConfigFile |
Specifies the TSM configuration file. |
| -k |
--TSMClientOwnerPwd |
Specifies the TSM client owner user password. Not required, if specified in the options file or if backing up with the Passwordaccess Generate option. |
| -i |
--TSMFile |
Defines the TSM filespace, high level and low level. This argument accepts the following format:
tsm_filespace\tsm_high_level\tsm_low_level
where:
-
tsm_filespace is the logical space on the TSM server that contains a group of files. It can be the drive label name or UNC name.
-
tsm_high_level specifies the directory path in which the file belongs.
-
tsm_low_level specifies actual name of the file.
NOTE: You may only store one item the location specified by this argument. It is not possible to append an object to this location. You can use the -I command-line argument or @init to back up to a non-unique location. |
| (none) |
--TSMPointInTime |
Specifies the date for restore/to filter results. If it is not passed, LiteSpeed will choose the most recent archived backup. The format is yyyy-mm-dd hh:mm:ss.
NOTE: If the backup was a striped backup and the point-in-times of the various striped files are different (rare but can be different a second or so), then the most recent of the times must be chosen. |
|
-L |
--LogLevel |
Creates a log file. This argument accepts one of the following values:
The default output directory is C:\Documents and Settings\All Users\Application Data\Quest Software\LiteSpeed\SQL Server\Logs (or C:\ProgramData\Quest Software\LiteSpeed\SQL Server\Logs) (or C:\ProgramData\Quest Software\LiteSpeed\SQL Server\Logs). To log to a different directory run this utility with the following argument: --trace logpath = "path".
For more information, see Configure Logging in LiteSpeed. |
|
-K |
--Key |
Value used to generate the encryption key for the encryption algorithm. If you do not supply encryption key, then the program will not encrypt the backup. If you use the wrong encryption key, the restore will fail.
Caution: When encrypting data, take care not to lose the encryption key; a backup cannot be restored or recovered without the original encryption key.
Example of key: 'Mypassword' |
|
-N |
--BackupIndex |
Specifies the particular backup to use when recasting, restoring, extracting or reading from files with multiple appended backups. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. |
Examples
-
Extract a LiteSpeed backup to a Network Share:
extractor.exe -F "C:\temp\Northwind.bak" -E \\my_server\my_share\Native.bak
-
Extract only the first backup in a backup set:
extractor.exe -F "C:\temp\Northwind.bak" -E "C:\temp\NorthwindNative.bak" -N 1
-
Extract a striped LiteSpeed backup:
extractor.exe -F "C:\temp\LS1.bak" -F "C:\temp\LS2.bak" -F "C:\temp\LS3.bak" -F "C:\temp\LS4.bak" -E "C:\temp\Native.bak"
NOTE: The number of extracted files does not have to match the number of files in a LiteSpeed backup. For more information, see Arguments. about the -E parameter.
- Extract a LiteSpeed backup to different locations.
-
See how many destination files the extractor utility is going to create for the LiteSpeed backup:
extractor.exe -F"c:\Backup\Northwind.bak"
-
Specify one filename for each destination file. The number of file names you specify with the -E parameter must match the number of files the extractor utility has returned for the LiteSpeed backup. The example below has 3 destination files:
extractor.exe -F"c:\Backup\Northwind.bak" –E "c:\Data\NW1.bak" "e:\Data\NW2.bak" \\my_server\my_share\NW3.bak
-
Extract a TSM backup to native SQL Server backup:
extractor.exe -c"10.0.1.200" -k"password" -j"C:\Program Files\Tivoli\TSM\baclient\dsm.opt" -F tsmbkp:fsMH\nw\test -E "C:\temp\TestNative.bak"
Returns
0 (success) or 1 (failure)
Related Topic
About Using the Command-Line Interface
xp_extractor
