LiteSpeed for SQL Server 8.9.8 - Configure Log Shipping Guide

Automatically selects the optimal compression level based on CPU usage or Disk IO. For more information, see Compression Methods.

You can tell Adaptive Compression to optimize backups either for size or for speed. This argument accepts one of the following values:

• Size
• Speed

Specifies the affinity mask for the process. The mask is a 64-bit integer value. By default, it is 0 and will utilize all CPUs.

For more information, see Processor Affinity.

Specifies filepaths to include in both backup and restore operations. The filepath can be either a single file or a directory. If it is a directory, then LiteSpeed recursively includes all files and subdirectories. All attached files are encrypted and compressed, with all pertinent backup parameters supported. This feature works for disk, tape, TSM, and Double Click Restore as well. You can supply multiple instances of this argument.

When used within the context of a restore operation, the path parameter can be expanded to include a new destination. This form will take the syntax of <file_path> to <new_file_path>. The new filepath can be used to specify a new location but cannot rename a file.

This argument only restores the attached files. It does not restore the database, just the files that were attached to that backup.

NOTES:

• The original entire directory path need not be supplied (e.g. c: to c:\testadSattsm is allowed).

• c:\testad to testadr would restore all files in directory c:\testad to c:\testadr.

This option causes LiteSpeed to issue a full backup, if one of the following problems is discovered in the current backup set:

• The full backup is missing.
• A differential backup is missing from the backup set (excludes backups automatically removed after the specified retention period).
• LSN verification fails in the backup set.
• Verify operation fails on full or differential backup.

NOTE: If a problem is detected and a full backup is created through escalation, an error will be returned.

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'

Specifies the database backup type.

Specifies the backup destination. This argument accepts one of the following values:

• DISK
• TAPE
• TSM
• TSMArchive

Specifies the number of SQL Server buffers available for a LiteSpeed operation. The default value is set by SQL Server.

Checks the allocation and structural integrity of tables and indexes.

Enables the Cleanup History task. This argument accepts one or more of the following:

• <number><time_unit>—Removes historical data older than specified time period. You can use one of the following time units:
  • HOURS
  • DAYS
  • WEEKS
  • MONTHS
  • YEARS
• BKUP—Deletes back up and restore history.
• JBS—Deletes SQL Server Agent jobs history.
• MAINTPLN—Deletes Maintenance plans history.
• Activity—Deletes LiteSpeed activity from the Local Repository.
• CentralActivity—Deletes LiteSpeed activity from the Central Repository.
• PurgeInfo—Deletes any information for deleted databases.
• LogShipping—Deletes log shipping history.
• Status—Deletes status history (Job, DTS, Maint Plans).
• ShrinkLog—Shrinks the repository databases log files.

Appends a user comment to the backup.

This argument accepts variables. For more information, see LiteSpeed Variables.

Specifies the compression level for the backup. Valid values are 0 through 8. 0 bypasses the compression routines. The remaining values of 1 through 8 specify compression with increasingly aggressive computation. 2 is the default value for disk backups and 7 is the default value for cloud backups.

When choosing a compression level, it is best to try various options using your equipment and data to determine the best option for your environment. Use the Backup Analyzer to test the performance of different compression levels. For more information, see Test Optimal Backup Settings.

NOTE: If both the compression level and Adaptive Compression option are passed in, LiteSpeed will not error out and will select and use Adaptive Compression.

Creates a subdirectory for each database.

Specifies the encryption level. This argument accepts one of the following values:

• 0—40-bit RC2

• 1—56 bit RC2

• 2—112 bit RC2

• 3—128 bit RC2

• 4—168 bit 3DES

• 5—128 bit RC4

• 6—128 bit AES

• 7—192 bit AES

• 8—256 bit AES

• 9—MS_AES_128

• 10—MS_AES_192

• 11—MS_AES_256

Specifies the database names or the following built-in database groups to include in the backup:

• "ALL DATABASES"
• "ALL SYSTEM DATABASES"
• "ALL USER DATABASES"

Alternately, you can specify wildcard or regular expression patterns using one of the following formats:

• Mask:"<wildcard_expression>"
• Regex:"<regular_expression>"

For more information, see Use Wildcard and Regular Expressions in LiteSpeed.

Specifies the minimum amount of database changes required for the full backup.

Accepted values are 1-99, the default value is 35.

Creates a Double Click Restore executable. This argument accepts one of the following values:

• 1—Creates one Double-Click Restore executable file. Note the following warning: The executable may be greater than 4GB for large databases. Windows Server is unable to run executable files larger than 4GB. However, the file will be convertible/restorable by LiteSpeed file.
• 2—Creates a Double Click Restore loader in the same location. (Default)

For more information, see Double Click Restore Executables.

Specifies the default file format, usually %D_%T_%Y-%m-%d-%H%M%S.%EXT%, where:

• %D—Database name
• %T—Backup type (Full, Diff or Log)
• %Y-%m-%d-%H%M%S—Date and time
• %EXT%—File extension

For more information, see LiteSpeed Variables.

Deletes old backups based on the time period specified in the format: <number><time_unit>, where the time unit is one of the following:

• HOURS
• DAYS
• WEEKS
• MONTHS
• YEARS

Deletes .html reports older than the given time period. This argument accepts one of the following time units:

• HOURS
• DAYS
• WEEKS
• MONTHS
• YEARS

Deletes .txt reports older than the given time period. This argument accepts one of the following time units:

• HOURS
• DAYS
• WEEKS
• MONTHS
• YEARS

Deletes file by type. This argument accepts one of the following values:

• FileBkupbackup—Backup files
• FileRptreport—Maintenance plan text reports
• FileAny—Any file

Specifies the unit type for file age. This argument accepts one of the following values:

• MINUTES

• HOURS
• DAYS
• WEEKS
• MONTHS
• YEARS

Excludes databases. This argument accepts one or more of the following:

• Selected—This option will exclude databases supplied with the -D argument.
• LogShippng

• ReadOnly

• Offline
• Deleted
• Mask:"<wildcard_expression>"
• Regex:"<regular_expression>"
• IgnoreReplica—This option will ignore the preferred replica setting and will back up all replicas, unless they are excluded by the Primary and Secondary options.
• Primary
• Secondary

• Mn
• Tu
• Wd
• Th
• Fr
• St
• Sn

Specifies the date and time when the backup expires. LiteSpeed will not overwrite this file until expiration datetime is passed. This argument accepts one of the following formats:

• yyyy-mm-dd
• yyyy-mm-dd hh:mm:ss

Specifies a database filegroup to include in the backup or restore. You can supply multiple instances of this argument.

A filegroup backup is a single backup of all files in the filegroup and is equivalent to explicitly listing all files in the filegroup when creating the backup. Files in a filegroup backup can be restored individually or as a group.

Specifies the number of units (N). The full or differential backup must be at least N units old before it is eligible for cleanup.

See BackupRetainUnits for unit types details

Note: Old argument BackupRetainDays is still supported for compatibility reasons.

Controls the debug logging options for a plan. This argument accepts one of the following values:

• 0—Logging off.

• 1 or any odd value—Logging on. Log file is removed on success.

• 2 or any even value—Logging on.

For more information, see Reporting and Logging in Maintenance Plans.

Controls the logging options for backups. This argument accepts one of the following values:

• 0—Logging off.

• 1 or any odd value—Logging on. Log file is removed on success.

• 2 or any even value—Logging on.

For more information, see Configure Logging in LiteSpeed.

Specifies the number of units (N). The t-log backup must be at least N units old before it is eligible for cleanup.

See also LogRetainUnits for unit types details

Note: Old argument @LogRetainDays is still supported for compatibility reasons.

Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4,194,304 bytes (4 MB). The default is 1048576 (1 MB).

Specifies the notification options after backup. This argument accepts one of the following values:

• Every—Notify every time
• Failure—Notify on failure only

Specifies whether the message is of low, high or normal importance. This argument accepts one of the following values:

• 0—Low
• 1—Normal
• 2—High

Generates a map file during a backup for Object Level Recovery.

Specifies the user password. Passwords are case-sensitive. Required if the connection type is not a trusted connection.

Specifies the priority of the LiteSpeed process compared to other processes running on the same server. This argument accepts one of the following values:

• 0—Normal (Default)

• 1—AboveNormal

• 2—High

Specifies whether LiteSpeed should perform checksums before writing to media and whether it should continue on error. This argument accepts one of the following values:

• 1—Causes checksums to be verified when a LiteSpeed backup is created, LiteSpeed does not continue on error.
• 2—Causes the backup be executed on error, checksums are not verified.
• 3—Causes the backup be executed despite encountering an invalid backup checksum.

Checks if the expected full backup exists when backing up to separate files and returns a failure message if it is not found. If the full backup file does not exist, it performs a full backup. If the full backup file does exist, the decision to perform a new full or a differential backup will depend on other conditions specified.

Specifies a number of days to retain the backup. LiteSpeed will not overwrite this file for this number of days. 

Reduces the size of data and log files in a database that grow beyond a specified size. This arguments accepts the following values:

• Database size, in MB, when the database grows beyond this amount , it becomes eligible for shrinking. The default is 50.
• The percentage of free space to remain after shrinking. The default is 10.

• NoTrunc—(Optional) Returns freed space to operating system.

Specifies the instance of Microsoft SQL Server to connect to. This argument accepts one of the following values:

• server_name
• server_name\instance_name

If no server is specified, the LiteSpeed command-line utility will connect to the default instance of SQL Server on the local computer.

This argument accepts one of the following values:

• 0—Specifies self-contained backup set.
• 1—Appends data to an existing full backup file.

For more information, see Fast Compression.

Specifies the last differential backup size to last full backup size ratio. When exceeding the specified ratio LiteSpeed performs a full backup.

Accepted values are 1-99, the default value is 35.

Specifies the minimum number of days since last full backup required to perform full backup. The default value is 14.

Determines the number of threads used for the backup. You will achieve the best results by specifying multiple threads, but the exact value depends on several factors including: processors available, affinity setting, compression level, encryption settings, IO device speed, and SQL Server responsiveness. The default is n-1 threads, where n is the number of processors.

Specifies the maximum CPU usage allowed. The argument accepts an integer value between 1 and 100. The default value is 100. This is the percentage of the total amount of CPU usage (across all enabled processors) available.

TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance, try limiting the number of threads. If you decide to use an affinity value other than default, it is recommended that you limit the threading as well. You may also want to consider using Adaptive Compression to maintain backup performance. For more information, see Adaptive Compression.

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.

Specifies the TSM client owner user password. Not required, if specified in the options file or if backing up with the Passwordaccess Generate option.

Specifies the TSM configuration file.

Specifies how long to wait for a TSM device.

Specifies the TSM management class. If not specified, LiteSpeed uses the default management class.

Specifies user login ID. Required if the connection type is not a trusted connection.

Login IDs are case-sensitive.

Specifies how to measure the amount of database to sample. This argument accepts one of the following values:

• Rows
• Percent
• FullScan

Updates index and/or column statistics. This argument accepts one of the following values:

• Columns
• Index
• All

Performs a restore verification on the backup file just created (if backup was successful). This argument accepts one of the following values:

• Last—Verifies last backup performed (can be either a full or differential).
• FullDiff—Verifies the last full backup and last differential is available.
• All—Verifies last full backup and all differentials since.

Performs a restore verification on the backup file just created (if backup was successful).

Specifies if LiteSpeed should wait and retry the read or write operation on failure. You can define retry options using the following parameters:

• DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. The default is 4 retries, the maximum allowed setting is 1000.
• DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. The default is 15 seconds, the maximum allowed setting is 300.

NOTE: This functionality is only available for disk and cloud operations.

For more information, see Network Resilience.