LiteSpeed™ for SQL Server® 8.1 User Guide Copyright © 2015 Dell Inc. ALL RIGHTS RESERVED. This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose other than the purchaser’s personal use without the written permission of Dell Inc. The information in this document is provided in connection with Dell products. No license, express or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Dell products. EXCEPT AS SET FORTH IN THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, DELL ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL DELL BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF DELL HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Dell makes no representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the right to make changes to specifications and product descriptions at any time without notice. Dell does not make any commitment to update the information contained in this document. If you have any questions regarding your potential use of this material, contact: Dell Inc. Attn: LEGAL Dept 5 Polaris Way Aliso Viejo, CA 92656 Refer to our Web site (software.dell.com) for regional and international office information. Patents LiteSpeed is protected by U.S. Patent # 8,260,750. Additional patents pending. Trademarks Dell, the Dell logo, and LiteSpeed are trademarks of Dell Inc.and/or its affiliates. Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Dell disclaims any proprietary interest in the marks and names of others. Legend CAUTION: A CAUTION indicates potential damage to hardware or loss of data if instructions are not followed. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. IMPORTANT, NOTE, TIP, MOBILE, VIDEO: An information icon indicates supporting information. LiteSpeed for SQL Server 8.1 User Guide July 17, 2015 Contents Copyright 2 About Backing Up/Restoring with LiteSpeed 11 About LiteSpeed 11 About Backing Up/Restoring Databases 11 LiteSpeed User Interface 13 Application Menu 13 Home Ribbon 14 View Ribbon 14 Backup Manager Server Tools Ribbon 16 Database Tools Ribbon 16 Job Manager Ribbon 17 Log Reader Ribbon 17 Log Shipping Server Tools Ribbon 18 Object Level Recovery Ribbon 19 Navigation Pane 20 Central Pane 21 Background Tasks Pane 22 Properties Pane 22 Toolbar 22 Configure LiteSpeed for First Use 24 Register Central Repositories Select a Central Repository 24 24 Register and Group Server Instances SQL Server Instances Existing instance registration Centralized instance management Register Server Instances Create Server Groups Assign Server Instances to Server Groups About Categorizing Server Instances Change Server Instance Grouping Methods Create Categories Assign Server Instances and Databases to Categories 24 24 25 25 25 27 28 28 28 28 29 Configure LiteSpeed Defaults Processor Affinity 29 30 Configure LiteSpeed Options LiteSpeed General Options Backup Manager Options Log Shipping Options Job Manager Options Log Reader Options 31 31 32 33 33 34 LiteSpeed for SQL Server 8.1 User Guide 3 Object Level Recovery options 35 Configure Replication and Retention Options for Repositories Push Statistics to Central Repository Purge Repository Data 35 35 36 Amazon S3 Cloud 40 About Amazon S3 Cloud 40 Using the Amazon S3 Cloud Setting up Your Amazon S3 Cloud Account Registering Your Amazon S3 Cloud Account with LiteSpeed Running LiteSpeed Backups to the Amazon S3 Cloud Running LiteSpeed Restores from the Amazon S3 Cloud 40 40 41 41 41 Amazon S3 Cloud Account Settings 42 Back Up Databases 43 Test Optimal Backup Settings Backup Analyzer Wizard Scheduling Backup Analyzer Backup Analyzer Tab 43 43 45 45 Create and Deploy Backup Templates Create Backup Templates Deploy Backup Templates 46 46 52 Back Up Databases 53 About partial backups and restores Partial backups Restore partial backups 62 62 62 Back Up Multiple Databases LiteSpeed's Logic for Backing Up Multiple Databases Use Wildcard and Regular Expressions in LiteSpeed Multi-Database Backup 63 63 64 67 Fast Compression Quick Start Backup Files and Folders Full Backup Conditions Backup Escalation Backup Verification Cleanup Backup Jobs 67 68 68 69 70 70 71 71 Compression Methods Compression Levels Adaptive Compression 71 71 72 Encryption Methods 73 Double Click Restore Executables Double Click Restore Naming Conventions Create Double Click Restore Executables 73 73 74 Network Resilience 75 SmartCleanup 75 LiteSpeed Variables Accepted Variables 76 76 LiteSpeed for SQL Server 8.1 User Guide 4 Examples 77 Automate Maintenance Tasks 79 About Automating Maintenance Tasks Legacy and SSIS Maintenance Plans Native SQL Server and LiteSpeed Maintenance Plans 79 79 79 About Creating Maintenance Plans 80 Back Up Databases Using Maintenance Plans 82 Clean Up Maintenance Plans 88 Copy Maintenance Plans 88 Automate Similar Backup Tasks on Multiple Instances 90 Restore Databases 92 Restore Databases Using the Restore Wizard 92 Restore Double Click Restore Executables 99 Manually Restore a Master Database 99 Restore Objects 102 Restore Objects in the LiteSpeed UI Console Review the Backup File Contents Restore Tables and Schemas 102 103 105 Object Level Restores from TSM Backups 105 Execute SELECT Statements 106 Supported SELECT Statements Examples 107 108 View Activity and History 109 View Backup Manager Activity and History 109 View Maintenance Plans Activity and History 111 Use Command-Line Interface 113 About Using the Command-Line Interface 113 LiteSpeed Command-Line Arguments Syntax Arguments TSM-Specific Arguments Examples Returns 113 114 115 126 127 128 Fast Compression Command-Line Arguments Syntax Arguments Examples Returns 129 129 130 137 137 SmartCleanup Command-Line Arguments Syntax Arguments Example Returns 137 138 138 141 141 Script Maintenance Plans Tasks 141 LiteSpeed for SQL Server 8.1 User Guide 5 Syntax Arguments Examples 142 146 155 Recast LiteSpeed Backups Syntax Arguments Examples Returns 156 156 157 162 162 Convert LiteSpeed Backups to SQL Server Backups Syntax Arguments Examples Returns 163 163 163 165 165 Restore Objects with the Command-Line Interface Syntax Arguments Examples Returns 165 166 167 170 171 LicenseInfoCmd Utility Syntax Examples 171 171 171 Use Extended Stored Procedures 172 About Using Extended Stored Procedures Create Backups Verify Backups View Information about Backups Clean Up Old Backups Restore Backups and Files Recover Objects from Backups Encrypt Passwords TSM-Specific Tasks Check Progress and Memory LiteSpeed Information 172 172 173 173 173 173 173 174 174 174 174 xp_backup_database Syntax Arguments Examples Returns 174 174 177 189 192 xp_backup_log Syntax Arguments Example Returns 192 193 194 204 204 xp_delete_tsmfile Syntax Arguments Returns 204 204 204 205 xp_encrypt_backup_key 206 LiteSpeed for SQL Server 8.1 User Guide 6 Syntax Results 206 206 xp_encrypt_restore_key Syntax Results 206 206 206 xp_extractor Syntax Arguments Examples Returns 206 206 207 211 211 xp_memory_size Syntax Results 211 211 212 xp_objectrecovery Syntax Arguments Examples Returns 212 213 214 218 220 xp_objectrecovery_createscript Syntax Arguments Examples Returns 220 221 221 224 226 xp_objectrecovery_executeselect Syntax Arguments Examples Returns 226 227 228 232 233 xp_objectrecovery_viewcontents Syntax Arguments Examples Returns 233 233 234 236 237 xp_restore_attachedfilesonly Syntax Arguments Examples Returns 237 238 238 244 244 xp_restore_automated Syntax Arguments Examples Returns 244 245 245 252 254 xp_restore_checkpassword Syntax Arguments 254 254 254 xp_restore_checksumonly Syntax 255 255 xp_restore_database 255 LiteSpeed for SQL Server 8.1 User Guide 7 . 1 User Guide 8 .Syntax Arguments Examples Returns 256 258 268 270 xp_restore_filelistonly Syntax Arguments Results Returns 270 271 271 273 273 xp_restore_headeronly Syntax Arguments Examples Results Returns 273 274 274 278 279 281 xp_restore_log Syntax Arguments Examples Returns 281 282 283 290 290 xp_restore_setinfo Syntax Arguments Example Results Returns 291 291 291 294 294 294 xp_restore_verifyonly Syntax Arguments Example Returns 294 295 296 300 300 xp_slsCreateDCR Syntax Agruments Example Returns 301 301 301 301 302 xp_slsFastCompression Syntax Arguments Examples Returns 302 303 304 315 316 xp_slsreadprogress Syntax Examples 316 316 316 xp_slsSmartCleanup Syntax Arguments Examples Returns 317 317 317 322 322 LiteSpeed for SQL Server 8. 1 User Guide 9 .xp_slssqlmaint Syntax Examples 323 323 323 xp_sqllitespeed_licenseinfo Syntax Arguments Examples Result Set 323 324 324 324 324 xp_sqllitespeed_version 325 xp_view_tsmcontents Syntax Arguments Example Result Set Returns 325 325 325 328 328 330 xp_view_tsmmc Syntax Arguments Result Set Returns 330 330 330 331 331 Troubleshoot LiteSpeed 333 Review Known Issues 333 Troubleshoot LiteSpeed Activity Local repository is not populated 4.x jobs not displayed Dell storage appliance not working with LiteSpeed 333 333 333 334 Troubleshoot Maintenance Plans Leverage SSIS and LiteSpeed advanced options Install Backward Compatibility components Analyze log information Upgrade LiteSpeed Maintenance Plans 334 334 334 334 335 Troubleshoot Performance-Related Issues 335 Troubleshoot Previous Versions of LiteSpeed 336 Configure Logging in LiteSpeed Installer Logging Backup/Restore Logging Instance-Wide LiteSpeed Logging Log File Naming and Location LiteSpeed UI Console Activity Logging Reporting and Logging in Maintenance Plans 336 336 337 337 338 338 339 Create Support Bundles 339 Review Additional Resources 341 LiteSpeed Community 341 Video Tutorials 341 Useful Web Resources 341 LiteSpeed for SQL Server 8. 1 User Guide 10 .About Dell 343 Contact Dell 343 Technical Support Resources 343 Third Party Contributions 344 Index 345 LiteSpeed for SQL Server 8. LiteSpeed supports the following options for backups: l encrypt (See Encryption Methods on page 73 for more information. high-performance compression and encryption technology helps reduce storage costs and protect data. To. See Multi-Database Backup on page 67 for more information. generate backup scripts. Backup Templates Automate backing up databases on multiple server instances by deploying a LiteSpeed Backup Template.. striping..1 User Guide 11 . run backups immediately or schedule SQL Agent jobs. Backup Analyzer Evaluate different backup options. You can create native SQL Server or LiteSpeed backups. Be sure to select Use LiteSpeed to leverage many LiteSpeed advanced features. Multi-Database Backup Wizard Back up several databases with the same options... such as CleanUp and Rebuild Indexes LiteSpeed for SQL Server 8. See Back Up Databases on page 53 for more information. to determine which settings have the best compression and duration values.1 About Backing Up/Restoring with LiteSpeed About LiteSpeed LiteSpeed™ for SQL Server®. About Backing Up/Restoring Databases LiteSpeed has the following key features: Use this feature. Maintenance Plans provide flexible backup options as well as additional database maintenance options. This option lets you define backup options individually for each database. LiteSpeed's low-impact.) l compress (See Compression Methods on page 71 for more information. such as compression level. See Create Backup Templates on page 46 for more information. is a fast and flexible backup and recovery solution that allows database administrators to easily maintain complete control over the backup and recovery process.) l mirror l stripe l attach files l log activity l and more. or LiteSpeed.. See Test Optimal Backup Settings on page 43 for more information.. and backup destinations. while maintaining a high level of recoverability. Backup Wizard Back up individual databases. Maintenance Plans Automate backing up databases. including processes that fail or succeed. See Fast Compression on page 67 for more information. query.Use this feature. See Compression Methods on page 71 for more information.. Use the LiteSpeed UI Console to view activity and history for your backups. If backing up to unique filenames. extended stored procedures and the command-line interface.. tasks.1 User Guide 12 . preview and restore specific objects directly from the native SQL Server or LiteSpeed backup files.. See About Automating Maintenance Tasks on page 79 for more information. Fast Compression Reduce backup size and decrease backup times from hours to minutes by including differential backups in the nightly backup routine. LiteSpeed for SQL Server 8. Adaptive Compression can optimize backups either for speed or for small size. a list of all of the jobs for a server instance or database. See Network Resilience on page 75 for more information. Automated Restore Automate restoring the most recent database backups. See View Backup Manager Activity and History on page 109 for more information. See Restore Databases Using the Restore Wizard on page 92 for more information. See Restore Objects on page 102 for more information. Network Resilience Control network resilience options. You can back up and restore with LiteSpeed using wizards in the LiteSpeed UI Console. See Restore Databases Using the Restore Wizard on page 92 for more information. To. Object Level Recovery List. Adaptive Compression Let LiteSpeed select optimal compression based on server performance at the time of backup. Restore Wizard Restore databases and attached files immediately or schedule a restore job. Double Click Restore Restore Double Click Restore executable files on a server instance that does not have LiteSpeed installed. See the Configure Log Shipping guide for more information. LiteSpeed's read and write resilience can handle various failures on both network and attached storage devices. Log Shipping Automate backing up and restoring database transaction logs on one or more standby databases. the amount of disk space you save. See Double Click Restore Executables on page 73 for more information.. you only need to specify a folder where LiteSpeed will look for candidates for restore. You can add repository.LiteSpeed User Interface Use the LiteSpeed user interface (called the LiteSpeed UI Console) to create backups. Deploy Run the Remote Deploy Configuration wizard. The File ribbon defaults to the Help selection. Use the Application menu to access the following features: Feature Description Repository Registration Display and edit repository registration. Help Display the LiteSpeedSupport information. view activity and history for your backups. and About information. test connection. Cloud Accounts Display and edit registered cloud account settings. design Maintenance Plans. delete connection. import. edit connection.1 User Guide 13 . edit. and export cloud accounts. schedule SQL Agent jobs and monitor tasks progress. import. recover database objects. You can add. restore databases. License Display and edit the LiteSpeed license key information. Options Display and edit the following LiteSpeed options: General. Backup LiteSpeed for SQL Server 8. Application Menu The Application menu displays often used LiteSpeed features and replaces the previous File menu. delete. Support Bundle. LiteSpeed Community. Displays the LiteSpeed Help. and export repositories. Use this wizard to deploy the LiteSpeed Engine and edit LiteSpeed the configuration to remote servers. Backup Templates Run the Create New Backup Template Wizard. Job Manager. Log Shipping. and attached files. Log Reader. You can also create new maintenance plan. edit. Maintenance Plans. Log Shipping Run the Create LiteSpeed Log Shipping Plan Wizard. and Object Level Recovery. Refresh Refreshes the selected items. Read Transaction Log Run the Read Log Wizard and displays the Log Reader Ribbon. files and file groups. deploy or remove existing backup templates. You can also delete. Automated Restore Run the Restore Wizard with Automated Restore as the default selection. Exit Exit the LiteSpeed product. LiteSpeed for SQL Server 8. Restore Run the Restore Wizard. and upgrade LiteSpeed maintenance plans. You can also restores databases.Feature Description Manager . Backup Run the Backup Wizard. transaction logs. Use the Home ribbon to access the following features: Feature Description SQL Server Registration Register new SQL Servers and groups. edit or manage existing ones. import maintenance plan.(See Backup Manager Options).1 User Guide 14 . Multi-Database Backup Run the Backup Wizard for several databases. You can also create new. Home Ribbon The Home ribbon displays often used features. Display Jobs Run the Job Manager and displays the Job Manager Ribbon. View Ribbon The View ribbon displays often used view features. Maintenance Plans Create a new maintenance plan by default. paste maintenance plan. You can also view detailed information about your backup and restore processes. and rebuilding indexes to run on a specific day and time. Local View list of local instances in the navigation pane. NOTE: Object Level Recovery is only available with the Enterprise license. You can view recent transactions. Several other items are available. NOTE: The local repository instance icon (and central) are displayed in the View ribbon when a central repository is selected. The central server instance icon is displayed in the navigation pane. Log Shipping Automate backing up a database (the publisher) and restoring its transaction logs on one or more standby databases (the subscribers). the full database log. The local server instance icon is displayed in the navigation pane. both the local and central icons are not visible in the View ribbon. Log Reader Restore data in transaction log files by rolling back any operation and reconstructing transactions.1 User Guide 15 . Central View list of central instances in the navigation pane. NOTE: The central repository instance icon (and local) are displayed in the View ribbon when a central repository is selected. Automate routine database maintenance tasks. Maintenance Plans Create a new maintenance plan by default. The process runs automatically throughout the day at the interval you specify. which creates synchronized databases. Job Manager Schedule. Object Level Recovery Read native SQL Server or LiteSpeed backups to view tables. Background Tasks Display running background tasks. Categories View the list of servers grouped by category. and a list of all of the jobs for a server instance or database. When a central repository is not used.Use the View Ribbon to access the following features: Feature Description Backup Manager Manage LiteSpeed and native SQL Server backups and restores with a variety of advanced tools. monitor. and views. updating statistics. Alphabetically View instances in the navigation pane by an alphabetic sort. the amount of disk space you save. Category Select the server category grouping based on location or role. and edit categories. query backup data and restore tables. Server Group View the list of servers grouped by instances. both the local and central icons are not visible in the View ribbon. and all transactions in the backup file. such as backing up databases. assign categories. You can also generate DDL scripts for one or more databases objects. Custom View instances in the navigation pane by a defined custom sort. When a central repository is not used. including statistics on processes that fail or succeed. schemas. and manage SQL Agent jobs and Windows tasks. LiteSpeed for SQL Server 8. Refresh Refreshes the selected item. and remove templates. Maintenance Plans Create a new maintenance plan by default. deploy. edit. such as backing up databases. Properties Displays the general properties of the current server. You can also create new. LiteSpeed for SQL Server 8. Restore Run the Restore Wizard with database as the default selection. Automate routine database maintenance tasks. updating statistics.1 User Guide 16 . LiteSpeed Defaults Displays the LiteSpeed backup default options. Makes visible the Job Manager ribbon. Log Shipping View the LiteSpeed Log Shipping information in the navigation pane. Display Jobs View the Job Manager and list of jobs in various states. Multi-Database Backup Run the Backup Wizard for several databases. transaction logs. Several other items are available. You can also restore files and file groups. Automated Restore Run the Restore Wizard with Automated Restore as the default selection. Use the Backup Manager Server Tools ribbon to access the following features: Feature Description Backup Run the Backup Wizard. Database Tools Ribbon The Database Tools ribbon is displayed when you select Backup Manager from the View Ribbon. Backup Templates Runs the Create New Backup Template Wizard. and rebuilding indexes to run on a specific day and time.Backup Manager Server Tools Ribbon The Backup Manager Server Tools ribbon is displayed when you select a SQL Server from the Navigation Pane. Read Transaction Log Run the Read Log Wizard and LiteSpeed displays the Log Reader Ribbon. and attached files. Week Display jobs for a particular week. and attached files. Restore Run the Restore Wizard. Month Display jobs for a particular month. files and file groups. Multi-Database Backup Run the Backup Wizard for several databases. Refresh Refreshes the Job Manager items. Log Reader Ribbon The Log Reader ribbon is displayed when you select Log Reader from the View Ribbon. Windows Tasks Select a server in the Windows Tasks pane Day Display jobs for a particular day. transaction. Refresh Refresh the database items. Job Manager Ribbon The Job Manager ribbon is displayed when you select Job Manager from the View Ribbon. Display Jobs Display jobs and tasks according to their schedules and execution history. Read Transaction Log Display a listing of recent SQL Server transactions. Properties Display general LiteSpeed properties. Work Week Display jobs for a particular work week. Automated Restore Run the Restore Wizard with Automated Restore as the default selection.1 User Guide 17 . LiteSpeed for SQL Server 8. Use the Job Manager ribbon to access the following features: Feature Description SQL Server Jobs Select a server in the SQL Server Jobs pane.Use the Database Tools ribbon to access the following features: Feature Description Backup Run the Backup Wizard. You can also restores databases. Backup Analyzer Display analyzer graph of backup jobs. logins. You can also restore files and file groups. Table History Wizard Run the Table History Wizard to view changes made to specific tables. Log Shipping Server Tools Ribbon The Log Shipping Server Tools ribbon is displayed when you select Maintenance Plans from the View Ribbon. XML. objects. Restore Run the Restore Wizard with database as the default selection. Grouping Group the log entries by column headers. Stop checking End checking log changes. Multi-Database Backup Run the Backup Wizard for several databases. Export to CSV Export table to a CSV file. Other export options include: HTML. and applications. Undo / Redo Wizard Run the Undo / Redo Wizard to generate a T-SQL script. and attached files. Start checking Begin checking log changes. Log Shipping View the LiteSpeed Log Shipping information in the LiteSpeed for SQL Server 8. Automated Restore Run the Restore Wizard with Automated Restore as the default selection. and DB. that reverses changes previously made or reapplies current changes. When selected the Grouping option remains highlighted in the log reader ribbon. users. Refresh Refreshes the Log Reader items. operations. Backup Run the Backup Wizard. transaction logs.Use the Log Reader ribbon to access the following features: Feature Description Read Log Run the Read Log Wizard to generate a job transaction log. When selected the Filter option remains highlighted in the log reader ribbon. Use the Log Shipping Server Tools ribbon to access the following features: Feature Description New Plan Run the Create Log Shipping Plan Wizard. hosts. Filter Filter the log entries by general. Recover Table Wizard Run the Recover Table Wizard to recover dropped tables.1 User Guide 18 . Print Preview Displays a preview of currently selected log. Find Search and locate log entries. query backup data and restore tables. Recover Schema Recover a database schema. Stored Procedures. Defaults. such as backing up databases. Views. Extended Procedures. You can also generate DDL scripts for one or more databases objects. Functions. Recover Table Run the Recover Table Wizard. Automate routine database maintenance tasks. updating statistics. Several other items are available. Refresh Refreshes the selected item. and remove templates. Types. Makes visible the Job Manager ribbon. Read Transaction Log Run the Read Log Wizard and LiteSpeed displays the Log Reader Ribbon. Select Scripted Select a scripted object. Partition Functions. LiteSpeed Defaults Displays the LiteSpeed backup default options. Rules. Find Search for a specified database object. Users. Partition Schemes. Roles. Maintenance Plans Create a new maintenance plan by default.1 User Guide 19 . Triggers. Views (indexed). and rebuilding indexes to run on a specific day and time. schemas. and Xml Schema Collection. Display Jobs View the Job Manager and list of jobs in various states. Optional filters include: All. Backup Templates Runs the Create New Backup Template Wizard. edit. LiteSpeed for SQL Server 8. Object Level Recovery Ribbon The Object Level Recoveryribbon is displayed when you select Object Level Recovery from the View Ribbon. Tables. Use the Object Level Recovery ribbon to access the following features: Feature Description Object Level Recovery Wizard Read native SQL Server or LiteSpeed backups to view tables. and views. Properties Displays the general properties of the current server. deploy. Filters Apply filters to the database object search. You can also create new. NOTE: Object Level Recovery is only available with the Enterprise license.Feature Description navigation pane. The top of the navigation pane displays a tree of servers for Backup Manager.1 User Guide 20 . the amount of disk space you save. and Maintenance Plans. When local servers are selected in the View ribbon. the top of the navigation pane and the central pane update with the relevant information. Log Shipping. Use the Navigation pane to access the following features: Keyboard shortcut Feature Description Backup Manager Manage LiteSpeed and native SQL Server backups and restores with a variety of advanced tools. including statistics on processes that fail or succeed. the the navigation pane. Once you select a feature. the local instance icon is displayed in the navigation pane. and a list of all of the jobs for a server instance or database. It displays key tasks and options for the other features. CTRL+1 LiteSpeed for SQL Server 8.Navigation Pane The navigation pane has two parts: a list of LiteSpeed features at the bottom and feature-specific information at the top. Tip: Click central instance icon is displayed in to change the features that appear as button selectable in the navigation pane. When central servers are selected in the View ribbon. You can also view detailed information about your backup and restore processes. updating statistics. CTRL+5 Log Reader Restore data in transaction log files by rolling back any operation and reconstructing transactions. Automate routine database maintenance tasks.Keyboard shortcut Feature Description Log Shipping Automate backing up a database (the publisher) and restoring its transaction logs on one or more standby databases (the subscribers). monitor. Log Shipping. LiteSpeed does not display the home page for Backup Manager. and all transactions in the backup file. The process runs automatically throughout the day at the interval you specify. schemas. LiteSpeed for SQL Server 8. Each feature has a unique home page and set of tabs. see View Backup Manager Activity and History. CTRL+2 Object Level Recovery Read native SQL Server or LiteSpeed backups to view tables. query backup data and restore tables. Maintenance Plans Create a new maintenance plan by default. and Maintenance Plans. and manage SQL Agent jobs and Windows tasks. CTRL+4 Job Manager Schedule. such as backing up databases. NOTE: If you selected a central repository. You can view recent transactions. Several other items are available.1 User Guide 21 . For a description of the Backup Manager tabs and central pane options. which creates synchronized databases. CTRL+6 Central Pane The central pane displays information based upon your selection in the navigation pane. and views. the full database log. You can also generate DDL scripts for one or more databases objects. CTRL+3 NOTE: Object Level Recovery is only available with the Enterprise license. and rebuilding indexes to run on a specific day and time. To view the pane. select View | Background Tasks. Refresh selected item. Properties Pane The Properties pane lists properties about the item selected in the navigation pane. Home. including Start Backup Wizard. click the Application Button and select Options and then Display properties in dockable window on the General tab.Background Tasks Pane The Background Tasks pane displays processes that you selected to run in the background while you use the LiteSpeed UI Console. To view the properties pane. You can dock the pane by clicking or cancel a process by clicking . and Customize Quick Access Toolbar: LiteSpeed for SQL Server 8. NOTE: Canceling a background task does not mean that SQL Server is done rolling back the process. Toolbar The toolbar has the following parts: Toolbar Part Description Navigation Includes buttons to navigate within the LiteSpeed UI Console.1 User Guide 22 . Back. and Help: Quick Access Tool Bar Includes buttons to navigate within the LiteSpeed UI Console. Forward. You can dock the pane by clicking . including Minimize the Ribbon. right-click and deselect it.1 User Guide 23 . LiteSpeed for SQL Server 8.Tip: To hide a toolbar. 2. Select a Central Repository The LiteSpeed UI Console displays the activity statistics in the Backup Manager Overview tab for the selected central repository.3 Configure LiteSpeed for First Use Register Central Repositories When you create or upgrade a central repository. or import registrations from a CSV file. To select a central repository » Select Tools | Options and select the repository on the General tab. 3. Tips: l l Select add repository. LiteSpeed for SQL Server 8. Tip: You can also click beside the Central Repository field in the status bar of the LiteSpeed UI Console and select the repository from the list. To register a repository 1. your native SQL Server tool (for example. or Password fields in the grid to change their value. Click Test connection. You can register them one at a time. Authentication. and export by clicking the corresponding button in the Edit Repository Registration dialog. delete connection. Imports can be done from . but you can only view activity for one at a time. Management Studio) or a previous version of LiteSpeed. Login. Register and Group Server Instances SQL Server Instances You must register server instances before you can manage them in the LiteSpeed UI Console. You can click the Display name. Click beside the Central Repository field in the bottom of the LiteSpeed UI Console and select Select Repository. import. You can register multiple central repositories in the LiteSpeed UI Console. LiteSpeed central repository.csv files and from LiteSpeed 4.x. edit connection.1 User Guide 24 . you must register it in the LiteSpeed UI Console before you can view its activity statistics. test connection. Click Add repository and complete the Register New Repository dialog. If the timestamp matched. You can change from Windows Authentication to SQL Authentication. they are handled accordingly. If the timestamps do not match. Login credentials are not persisted in the central. LiteSpeed checks a timestamp against the central (which is automatically updated each time a change is made to a registration). The actual password.1 User Guide 25 . review the following information on existing instance registration and centralized instance management. This helps you know when the central data has changed. or change the account used for SQL Authentication without affecting the central repository. Changes to the central. When importing or refreshing. You can also register server instances that do not have LiteSpeed installed on them and perform native backups and restores through the LiteSpeed UI Console. Groups are created automatically as needed when importing. l l The import shows all instances in the import file (like is done for manual imports from the central) and automatically deselects instances that are already registered in the console. The only thing stored centrally is the type of authentication (Windows or SQL). if the central repository view is selected. l Preserves grouping in the export file. any instances that are added. If there are duplicate names. if SQL Authentication is used. In the central repository view. including their proper grouping. LiteSpeed automatically refreshes the view from the central repository. any local login information is persisted while the central repository cache is saved locally. is stored locally. Register Server Instances You must register server instances before you can manage them in the LiteSpeed UI Console. or sorted. Grouping information is used in the export file to put the instances where they need to be. The Backup Manager View tab is used to switch between local and central repository views (if a central is used). When LiteSpeed starts. NOTE: You need to register all SQL Server instances involved in log shipping in the LiteSpeed UI Console to retrieve log shipping data for them. LiteSpeed for SQL Server 8. all instances are read from the central. the local central registration cache is loaded.Before registering instances. In the central view. Centralized instance management LiteSpeed has the following capabilities for centralized instance management: l l l l l l l l l l Shares a common set of instance registrations and maintain grouping across all consoles. You can then import while preserving login information. automatically get persisted into the central. Existing instance registration LiteSpeed has the following capabilities for existing instance registration: l Keeps everything in sync if you are not using a central repository. Passwords are still stored locally for the user. removed. trigger a version change. The central does not store passwords for SQL Server Authentication. You need to manually edit the CSV file to remove the connection information before you import instances from this file. <port_number>. a separate line for a server. You can also see information for each instance including license.321 NOTE: If you export server instances to a CSV file. Click Add server to add an individual server or Import to import server instances from a CSV file or the LiteSpeed central repository.SQL Server. display overview tab. l Password—May be blank. Complete the fields as necessary. Select either Windows authentication or SQL Server authentication (enter the user name and password). ServerName—Computer name or IP address following by port number: <IP_address>. <port_number>. it will contain SQL logins and obfuscated passwords. LiteSpeed for SQL Server 8.spb9884.Password W2K3-14. You can also edit credential information for each instance including display name. NOTE: Microsoft recommends using Windows authentication when possible because it is more secure than SQL Server authentication. Next lines contain server parameters. password.3w663k3E spb9884_sql_auth. test connection. l LoginName—User name in the following format: 'Domain\Username'. l Authentication—Windows or SQL Server. 4. NOTE: You can import instances from a central repository. 1. Select Home | SQL Server Registration | Manage. click OK and continue with step 4. Select the central repository to import server instances from. authentication.Authentication.1 User Guide 26 .Windows. Additional Connection Parameters Enter additional connection string parameters. login.Scenario There are several server instances configured to report to a central repository and you need to register some of them in your LiteSpeed UI Console. To register server instances TIP: From the Edit SQL Server Registration window you can add server. Scenario: Click Import and then From Central Repository. import and export. review the list of servers.W2K3-14.DOMAIN\Username. optionally deselecting those you do not want to be registered in your LiteSpeed UI Console. server name. (If you selected to import servers from a CSV file) Review the following for additional information: The first line of a valid CSV file contains the following column headers: l l DisplayName—Specify how you want to display servers in the navigation pane tree. 3. license type.). separated by semicolons (. Example: DisplayName. and parent group. edit connection. 2.ServerName.LoginName. Review the following for additional information: SQL Server Connect using Specify server name or IP address using the following format: <IP_address>.sa. You can omit the LoginName and Password parameters to complete them later in the LiteSpeed UI Console. and license expire date. if the central repository is configured and selected for use. Login. select View | Sort Instances | Custom. select View | Group Instances By. (Optional) In the Server tree. create the parent group first. or Password fields in the grid to change their value. You can also group server instances by categories. AlwaysOn and others to the SQL server connection string. Tips: l l You can click the Display name. Create Server Groups To create server groups 1. click and drag server instances to move them between groups. Tips: l l l To create multi-level groups. 2. Clear the Allow import of this instance. Authentication. 2.1 User Guide 27 . This will let you stay on the registration dialog and continue editing or registering new server instances. Scenario There are several server instances configured to report to a central repository and you want a new colleague to manage some of them in their LiteSpeed UI Console. Select the Backup Manager pane (CTRL+1). LiteSpeed allows all of the instances to be imported into other clients when you select to import from a central repository. To exclude a server instance from import 1. you can see registered SQL Server Instance nodes sorted alphabetically. To switch between server groups and categories. Advanced>>Display Name Enter the name to display in the navigation pane tree.. Click Display Overview Tab to see the Overview tab of the LiteSpeed UI Console window for the selected instance. When you create the subgroup. Select one of the following options: Create a top-level server group Right-click SQL Servers at the top of the navigation tree and select New SQL Server Group.Tip: Use this selection as needed to include custom parameters such as encryption. unless you specifically exclude instances. Tip: In the Server tree. 3. To edit or delete a server group. Right-click a server in the Server tree in the navigation pane and select Edit | SQL Server Registration.. To use a custom sort order. right-click the group and select the appropriate option. By default. Group the Backup Manager tree by server group (View | Group Instances By | Server Groups). the parent group will already be there for you to select. Define which server instances are eligible for import. Create a subgroup of an existing server group Right-click the group in the navigation pane tree and select New SQL Server Group. LiteSpeed for SQL Server 8. but still see overview information of the various instances. 5. checkbox and click OK. NOTE: You can use categories. Change Server Instance Grouping Methods You can group server instances in the navigation pane tree based on their category or server group. but server groups only organize server instances. Databases and server instances can be assigned to more than one category. See Select a Central Repository on page 24 for more information. Select the Backup Manager pane (CTRL+1). a database does not have to be assigned to the same categories as its parent server instance. Categories can only be two levels deep. About Categorizing Server Instances Use categories to organize server instances and databases based upon your business needs. See Change Server Instance Grouping Methods on page 28 for more information.Assign Server Instances to Server Groups You can assign server instances to server groups when you first register them. Select Subgroup of and select the parent group from the list. if the central repository is configured and selected for use. such as function. or by modifying their properties afterwards. Click Advanced. location. but they offer different features. a server instance can only be assigned to one server group.1 User Guide 28 . Categories are similar to server groups. but not both. with top-level categories (Role or Location). NOTE: You can group server instances in the navigation pane tree based on their category or server group. To assign a server instance to a server group 1. If you select Categories. select a category to view in the Category field in the toolbar. 3. See Select a Central Repository on page 24 for more information. You can assign server instances and databases to as many or as few categories as necessary. Create Categories You can create as many categories as you need to organize your server instances and databases. 2. Right-click the server instance and select Edit SQL Server Registration. 4. NOTE: You can use categories. division. To change the server instance grouping method » Select View | Group Instances By. but they offer different features: l l Categories can organize both server instances and databases. and subcategories (Development/Testing or Asia/Europe). and then select Server Group or Categories. In the previous example. if the central repository is configured and selected for use. or criticality. a database could be categorized as both North America and Development. if you have Location and Role categories. Categories are similar to server groups. LiteSpeed for SQL Server 8. In addition. For example. the server instance could only be assigned to a role or location group. Unlike categories. move. the default encryption level is 128-bit AES. LiteSpeed for SQL Server 8.1 User Guide 29 .bak. if the central repository is configured and selected for use. LiteSpeed will use the pre-defined default values automatically. encryption is not used. 2. Select a subcategory to assign the server instance or database to. See Select a Central Repository on page 24 for more information. select Categories | Edit. The default file name format is %D_%DATETIME%. NOTE: You can only select one subcategory per category. Click Add Category to add a top-level category. Review the following additional information about the LiteSpeed defaults: Encryption level By default. 2. command-line interface or when using the extended stored procedures. Select an option to change its value. You can rename. Configure LiteSpeed Defaults LiteSpeed defaults specify the default values for various LiteSpeed backup parameters. Select Category | Edit Categories. See Encryption Methods on page 73 for more information. Right-click the server instance or database and select Assign Categories. LiteSpeed uses the default SQL Server backup directory. such as compression level. See LiteSpeed Variables on page 76 for more information. processor affinity. right-click the server instance and select LiteSpeed Defaults…. If you select to encrypt a backup using the LiteSpeed UI Console wizards. if the central repository is configured and selected for use. To create categories 1. To set the LiteSpeed defaults 1. Assign Server Instances and Databases to Categories Server instances and their databases can be assigned to the same or different categories and subcategories. In the server tree. max transfer size. buffer count and some other. You should only modify advanced options after careful planning and testing. To assign a server instance or database to a category 1. 2. unless you supply a different value. NOTE: You can use categories. File name Location and name of a LiteSpeed backup file. You do not need to specify these parameters each time you run a backup from the LiteSpeed UI Console. NOTE: LiteSpeed defaults typically result in the best performance. See Select a Central Repository on page 24 for more information.NOTE: You can use categories. Tip: To edit categories. but you can assign server instances and databases to multiple categories. or select the top-level category and click Add Subcategory. Select the Backup Manager pane (CTRL+1). and delete categories. 3. The remaining values of 1 through 8 specify compression with increasingly aggressive computation. The default is n-1 threads. Processor Affinity You can specify which processors LiteSpeed can use for the backup/restore process. access the advanced options. Priority Select the priority of the backup over other transactions or processes running on the same server. See Adaptive Compression on page 72 for more information. try limiting the number of threads. See About Using the Command-Line Interface on page 113 for more information. The argument accepts an integer value between 1 and 100. Path to TSM opt file See the Integration with TSM Guide for more information. Number of threads Determines the number of threads used for the backup. Buffer count Specifies the number of SQL Server buffers available for a LiteSpeed operation. affinity setting. LiteSpeed for SQL Server 8. Throttle Specifies the maximum CPU usage allowed. Click to select which processors LiteSpeed can use. Processor affinity Specifies the affinity mask for the process. By default. The default value is set by SQL Server. Processor affinity designates specific processors to run LiteSpeed.1 User Guide 30 . The mask is a 64-bit integer value. and SQL Server responsiveness. Valid values are 0 through 8. TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. If you decide to use an affinity value other than default. click Reset Original Values. Compression level Specifies the compression level for the backup. 2 is the default value. Where multiple SQL Server instances exist on one machine. The default is 0.NOTE: Fast Compression handles the naming of files automatically. You may also want to consider using Adaptive Compression to maintain backup performance. compression level. encryption settings. See Compression Methods on page 71 for more information. This is the percentage of the total amount of CPU usage (across all enabled processors) available. which allows LiteSpeed to use all available system processors. where n is the number of processors.304 bytes (4 MB). In wizards. The default value is 100. while not allowing LiteSpeed to run on the remaining processors. Or you can use the affinity parameter with the LiteSpeed extended stored procedures or command-line utilities. you need to change the defaults for each instance individually. Tip: To reset to the application default values. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. it is recommended that you limit the threading as well. The default is Normal. They can be the same or different from the processor affinity for SQL Server. Init backup set LiteSpeed will appends the backup to an existing backup file set or tape. but the exact value depends on several factors including: processors available. See Backup Files and Folders on page 68 for more information. IO device speed.194. You will achieve the best results by specifying multiple threads. The default is 1048576 (1 MB). Max transfer size Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. See Processor Affinity on page 30 for more information. 0 bypasses the compression routines. it is 0 and will utilize all CPUs. and sixth bits to 1 and all other bits to 0. NOTE: 32-bit Windows is internally limited to a 32-bit mask. 3. Review the following for additional information: Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 3 11 1 and 2 7 111 1.. You may also want to consider using Adaptive Compression to maintain backup performance. For example.. Review the following for additional information: Use this option. you need to select processors 2. and 6 for use with LiteSpeed. 3. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. third. To.. The rightmost bit represents the first processor. it is recommended that you limit the threading as well. 3. Cleared LiteSpeed for SQL Server 8. Default Select central repository Select a central repository to view statistics in the LiteSpeed UI Console. See Adaptive Compression on page 72 for more information. Cleared Show confirmation message View confirmation message when exiting the LiteSpeed UI Console or wizards. There is a General options page to select basic settings. 4. Click the Application Button and select Options (Keyboard: ALT+F+O). try limiting the number of threads. which is decimal 38 or hexadecimal 0x26. and 6 205 11001101 1. Configure LiteSpeed Options LiteSpeed General Options Use the options pages to customize settings in LiteSpeed. The result is binary 100110. To set General options 1. Set the second. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process. 7. 2. 2 and 3 38 100110 2. See Register Central Repositories on page 24 for more information. Not Selected Display properties in dockable window View properties about the item selected in the navigation pane in a dockable window.. If a value begins with "0x" it is interpreted as hexadecimal.1 User Guide 31 . and a separate options page for each main feature in LiteSpeed. Number the bits from the right to left. If you decide to use an affinity value other than default.This argument accepts decimal values and hexadecimal values. You must register the repository before you can select it. Select the Proxy Settings link and enter the following. l Address .Proxy server address.. Default View content timeout Enter the connection timeout for when you view the backup file content. l Port ..Click to enable proxy use. Review the following for additional information: Use this option. Errors only Show database status View if a database has been backed up recently using LiteSpeed Cleared The instance tree view displays databases icons of the following colors: l l l GREEN—If the latest database backup was successfully created within the number of days specified for GREEN. Refresh the Overview and LiteSpeed Activity screens a configurable amount in increments from 1 to 30 minutes.Proxy server port (default is 80). Not selected Specify proxy settings if needed to set up cloud storage connection. Selected Ask for confirmation when Display a confirmation message before you are able to edit making changes to the Central central repository instances.. Click the Application Button and select Options (Keyboard: ALT+F+O). RED—If the latest database backup was NOT successfully created within the number of days specified for YELLOW. Select the Backup Manager tab. Backup Manager Options To set Backup Manager options 1. View Selected Ask to import instances when switching from Local to Central View.1 User Guide 32 . Selected Automatic refresh Overview every. No retries Show TimeLine on LiteSpeed Activity tab View database backups in a timeline at the server and database level. LiteSpeed for SQL Server 8..Use this option. Specify proxy settings for the LiteSpeed console.. Default Log the LiteSpeed UI Console activity Select a logging level to define what events to log for the console.. Display a confirmation message about importing registered SQL Server instances when switching from the Local to Central View. 2. 30 seconds TSM device retry time Select the amount of time to wait for the device to become available. To.. To. NOTE: Database status can only be displayed for LiteSpeed backups and if the local repository is configured. or not to retry. Not selected l Use proxy .. YELLOW—If the latest database backup was successfully created within the number of days specified for YELLOW and NOT in the number of days specified for GREEN. .. Cleared Task List Page On Demand—Display history only after clicking Show History. To. The details panel displays tips if there is something wrong with the log shipping plan.Use this option.. Default Scheduler Page Set the following options.. Default l Username .Proxy server password credential. To.... Selected Show recurring executions as one item Simplify the display by showing jobs that run multiple times as one job. Under each row of a job Show history Display job history on the Job List tab in a separate pane at the bottom of the window. (Selected.. To. 2. Log Shipping Options To set Log Shipping options 1. — Show server time Display the local time and the time difference between the desktop and the server at the top of the Calendar tab for each server. history displays automatically when you select a LiteSpeed for SQL Server 8. Default Read subscriber information View subscriber information on the Monitoring tab.Proxy server user credential. Select the Log Shipping tab. Click the Application Button and select Options.. Click the Application Button and select Options (Keyboard: ALT+F+O).. Selected Display detailed status information on the Monitoring tab Show the details panel on the Monitoring tab. l Password .1 User Guide 33 . plan status is only loaded when you doubleclick a plan.. Select the Job Manager tab... 2.. Job Manager Options To set Job Manager options 1. Cleared If this option is off. — Show steps Display each job step on the Job List tab in an expanding row in the list or in a separate pane at the bottom of the window. Review the following for additional information: Use this option. View current statuses of all log shipping plans when connecting to the server instance and when refreshing the Log shipping plans tab at the instance level. Selected Set the following options.) If cleared. Review the following for additional information: Use this option. Selected Load log shipping plan statuses. Default Check log file changes every Check the log file for changes every so many seconds.. Review the following for additional information: Use this option. 2. To. Select this option to enable the use of the full-backup file. Select the Log Reader tab. A mask is a pattern used to group jobs or tasks with similar names and display the appropriate icon for them. Select the Application Button and select Options (Keyboard: ALT+F+O). 3. LiteSpeed for SQL Server 8. Masks are stored locally. NOTE: You need to turn off transactions to undo or redo inmemory objects.1 User Guide 34 .. Not Selected Maximum BLOB size Set the maximum Binary Large Object (Blob) Data size. the Log Reader might need to refer to the full-backup file for the database to reconstruct old log records. 3 Maximum appointments Specify the maximum number of appointments that can display on the Calendar tab. To.. If the number of appointments exceeds this value. Log Reader Options To set the Log Reader options 1. Default job.Use this option to turn on or off transactions for undo/redo scripts. Selected Reconstruct DDL commands Select this option to display both DML and DDL commands Selected Export all details of the log Export all details of the log file. Selected 10 seconds Show uncommitted transactions List all the transactions that are not committed.Use this option..When reading an online or offline log. 25 Tip: Click Advanced | Known Applications to add new or change existing masks and icons.... Enclose Undo/Redo scripts in a transaction . Advanced Click Advanced to set the following options.. — Maximum number of threads Specify the maximum number of total concurrent threads to use on target instances to run the jobs. appointments may display incorrectly. l l Request full database backup file if needed . 8000 bytes Reconstruction Select one or both of the following: Selected TIP: Select this option to get a full report. LiteSpeed for SQL Server 8. Read approximately .. The second option only replicates job status. Click the Application Button and select Options (Keyboard: ALT+F+O).. Object Level Recovery operations may work much faster in this case.. Object Level Recovery options To set Object Level Recovery options 1. Default Generate script for tables include Instructs LiteSpeed to script or recover one or more of the following: All are selected l Constraints except foreign keys l Triggers l Foreign Keys l Statistics l Indexes Bypass tail log processing In scenarios when you do not require any transaction log backups and the tail log. NOTE: The minimum number of records to read is 100. 2. Default Select whether to read the entire log file or only a set number of records in the log file. To.000. maintenance plans and log shipping information.1 User Guide 35 . Select the Object Level Recovery tab.. The first option replicates the LiteSpeed activity.. Not selected Use table. Not selected Configure Replication and Retention Options for Repositories Push Statistics to Central Repository There are two options for replicating statistics to the central repository..Use this option. you can include constraints and index name prefixes in the script by selecting this option and entering the prefix value into the field. constraint and index name suffix For tables. The options are: 100000 l l Read entire log file . Review the following for additional information: Use this option. constraint and index name prefix For tables.Select this option to read the entire log file. you can select to bypass tail log processing.Select this option to set the number of records to read.. Search Depth To. you can include constraints and index name suffixes in the script by selecting this option and entering the suffix value into the field. Not selected Use table.. To replicate database and LiteSpeed activity information » On the local repository server. do one of the following: l l Execute dbo.If you did not select to populate the central repository automatically or via a scheduled job during Instance Configuration.exe file from the command line or using the extended stored procedures.exe -GatherJobStats. From the command line. LiteSpeed_DeleteActivity This stored procedure removes LiteSpeed activity and information about LiteSpeed backups based on the date and time specified.. See LiteSpeed_DeleteActivity on page 36 for more information. it removes log shipping history.exe. l SLSSQLMaint utility. l LiteSpeedCentral. maintenance plans and log shipping information » On the local repository server. LiteSpeed for SQL Server 8.[LiteSpeed_ImportNativeHistory] procedure to import the native backup history first into the local repository. DST status. You must use the [LiteSpeedLocal]. NOTE: You must run the LiteSpeed_DeleteActivity procedure against the database that has the LiteSpeed procedures installed and can be the one of the following: l LiteSpeedLocal.xp_replicate_job_statistics against the master database. Purge Repository Data You can remove historical data using any of the following: l Clean Up History task.xp_replicate_activity_statistics against the master database. and information about deleted databases. l Custom database—You can use the LiteSpeed Instance Configuration wizard (Start | All Programs | Dell | LiteSpeed for SQL Server | Instance Configuration) to choose where to store the repository data. NOTE: The xp_replicate_activity_statistics command is designed for sync changes between the local and central repositories. C:\Program Files\Dell\LiteSpeed\SQL Server\Engine) and run ActivityManager.1 User Guide 36 . do one of the following: l l Execute dbo. To replicate job. change the directory until you are in the directory containing the LiteSpeed command-line utilities (Usually. See Script Maintenance Plans Tasks on page 141 for more information. if appropriate parameters are specified. C:\Program Files\Dell\LiteSpeed\SQL Server\Engine) and run ActivityManager. From the command line. LiteSpeed does not contain information about the native backup history because it is a SQL Server native tool. you can manually force a replication at any time by calling the ActivityManager. Additionally. jobs and maintenance plans history. l LiteSpeed_DeleteActivity stored procedure. See About Creating Maintenance Plans on page 80 for more information. change the directory until you are in the directory containing the LiteSpeed command-line utilities (Usually. @delUnitType = 'time' )} .1 User Guide 37 . @delUnitType Specifies a unit of measurement of time for @delUnit. @purgeDeleted = 0 | 1 ] [. This argument accepts one of the following values: l 0—false l 1—true @delUnit Deletes the rows older than the age specified.Syntax USE {LiteSpeedLocal|LiteSpeedCentral|<custom_database_name>} EXEС LiteSpeed_DeleteActivity { @deleteDate = 'date_time' | ( @delUnit = n.LitespeedDatabase in the following LiteSpeed for SQL Server 8. This argument accepts one of the following values: @purgeDeleted l MINUTES l HOURS l DAYS l WEEKS l MONTHS l YEARS Deletes information about deleted databases from dbo. @delLogshipping = 0 | 1 ] [. @delStatus = 0 | 1] Arguments This stored procedure accepts the following arguments: Argument Description @deleteDate Deletes data older than the date and time specified. The argument accepts the following format: YYYYMMDD HH:MM:SS where @delLocal @delCentral l YYYY—4-digit year l MM—2-digit month l DD—2-digit day of the month l HH—2-digit hour using the local 24-hour clock l MM—2-digit minute l SS—2-digit second Deletes old data from the LitespeedActivity and LitespeedBackupFile tables in the Local repository or in the custom database (if the Local repository tables were created in the custom database). @delCentral = 0 | 1)} [. {@delLocal = 0 | 1 | @delCentral = 0 | 1 |( @delLocal = 0 | 1 . This argument accepts one of the following values: l 0—false l 1—true Deletes old data from the LitespeedActivity and LitespeedBackupFile tables in the Central repository or in the custom database (if the Central repository tables were created in the custom database). Argument Description databases: l Local repository or custom database, if @delLocal was supplied l Central repository or custom database, if @delCentral was supplied l Both, if both @delLocal and @delCentral were supplied This argument accepts one of the following values: l 0—false l 1—true @delLogshipping Deletes old log shipping history entries from dbo.LogShippingHistory in the following databases: l Local repository or custom database, if @delLocal was supplied l Central repository or custom database, if @delCentral was supplied l Both, if both @delLocal and @delCentral were supplied This argument accepts one of the following values: @delStatus l 0—false l 1—true Deletes old data from dbo.DbMaintStatus, dbo.DTSStatus, dbo.JobStatus in the following databases: l Local repository or custom database, if @delLocal was supplied l Central repository or custom database, if @delCentral was supplied l Both, if both @delLocal and @delCentral were supplied This argument accepts one of the following values: l 0—false l 1—true Examples 1. Delete the following data older than 08/21/2009 from the Local and Central repositories: l LiteSpeed activity l Information about deleted databases exec LiteSpeedLocal.dbo.LiteSpeed_DeleteActivity @delLocal=1 , @delCentral=1 , @purgeDeleted = 1 , @deleteDate = '20090821 00:00:00' 2. Delete the following data older than 6 months in the Local repository: l LiteSpeed activity l Log shipping history l Data from dbo.DbMaintStatus, dbo.DTSStatus, dbo.JobStatus USE LiteSpeedLocal EXEC LiteSpeed_DeleteActivity @delLocal=1, @delLogshipping = 1, LiteSpeed for SQL Server 8.1 User Guide 38 @delStatus = 1 , @delUnit = 6, @delUnitType = 'MONTHS' LiteSpeed for SQL Server 8.1 User Guide 39 4 Amazon S3 Cloud About Amazon S3 Cloud LiteSpeed supports backup directly to and from the Amazon S3 (Simple Storage Service) Cloud service. Amazon S3 provides a fully redundant data storage infrastructure for storing and retrieving any amount of data, at any time, from anywhere on the Web. Information about the Amazon S3 Cloud is available on: http://docs.aws.amazon.com/AmazonS3/latest/dev/Introduction.html. NOTE: Cloud backup/restore is only available with the Enterprise license. Using the Amazon S3 Cloud You can get started using the Amazon S3 Cloud with LiteSpeed by first setting up your Amazon S3 Cloud account and then registering your Cloud account with LiteSpeed. Note: LiteSpeed contains all the necessary software and components necessary for using the Amazon S3 Cloud and running LiteSpeed backups and restores. Setting up Your Amazon S3 Cloud Account The first step in using the Amazon S3 Cloud with LiteSpeed is to create your own Cloud account. Note: Amazon changes their Cloud account Web UI on a regular basis. Therefore the actual icons, tabs, and selection buttons might be different than what is indicated in the procedures below. To create your Amazon S3 Cloud account 1. Setup your Amazon account by registering on: http://aws.amazon.com. 2. Click the IAM icon on the Cloud administration console to create a Cloud user. 3. The User Access Key IDs and Secret Access Keys are automatically generated. 4. Write down and save the Access Key IDs and Secret Access Keys. You will use these values later in the LiteSpeed Cloud account registration. 5. Select the Permissions tab in the Cloud admin console and assign user Administrator Access permissions. 6. Use the Cloud admin console to create a Bucket Name and Region. This is the location where your backup files will be stored. 7. Write down and save the Bucket Name and Region. You will use these values later in the LiteSpeed Cloud account registration. 8. Use the following procedure to register your Amazon S3 Cloud account with LiteSpeed. LiteSpeed for SQL Server 8.1 User Guide 40 Registering Your Amazon S3 Cloud Account with LiteSpeed After setting up your Amazon S3 Cloud account, then register your Cloud account with LiteSpeed before attempting LiteSpeed backups and restores. To register your Amazon S3 Cloud account with LiteSpeed 1. Use the LiteSpeed Application Menu and select Cloud Accounts. 2. Select the Add icon. The Add cloud account window opens. 3. Enter the Access key and Secret key saved in Step 4 from the "To create your Amazon S3 Cloud account" procedure above. 4. Enter the Region and Bucket names saved in Step 7 from the same procedure above. 5. Click OK to save your entries. Your Amazon S3 Cloud account has now been registered with LiteSpeed. 6. Use one of the following procedures and run the LiteSpeed Backup or Restore Wizard to save backups to the Amazon S3 Cloud or restore files from the same. Running LiteSpeed Backups to the Amazon S3 Cloud After first setting up your Amazon S3 Cloud account, and registering your Cloud account with LiteSpeed, you now can run backups to the Amazon S3 Cloud using the LiteSpeed Backup Wizard. TIP: There are three ways to back up to the Amazon S3 Cloud: Backup Wizard, Maintenance Plans, or Backup Templates. CAUTION: The Amazon S3 Cloud only runs backup to new files. Appending to an existing file is not supported by the Amazon S3 Cloud. Existing backups can only be overwritten. The option "Overwrite existing object" is available in the Backup Wizard and MP (Back Up Database task). The option is turned off by default. To run LiteSpeed backups to the Amazon S3 Cloud 1. Run the LiteSpeed Backup wizard and make your appropriate selections. 2. Select Cloud from the destination list and complete the Backup Destination page. 3. Select the Amazon S3 Cloud account that you created from the Accounts list. 4. Conclude making the Backup wizard selections and finish by executing the backup. 5. TIP: You can review the LiteSpeed Cloud backup scripts at the last wizard step before executing the Cloud backup. You can also view an example Cloud backup database script here (scroll to the bottom of the page). Running LiteSpeed Restores from the Amazon S3 Cloud After first setting up your Amazon S3 Cloud account, registering your Cloud account with LiteSpeed, and running backups to the Amazon S3 Cloud, you now can run restores from the Amazon S3 Cloud using the LiteSpeed Restore Wizard. LiteSpeed for SQL Server 8.1 User Guide 41 To run LiteSpeed restores from the Amazon S3 Cloud 1. Run the LiteSpeed Restore Wizard and make your appropriate selections. 2. Select Cloud from the Backup Source page and select the Database from which to restore. 3. Conclude making the Restore wizard selections and finish by executing the restore. 4. TIP: You can review the LiteSpeed Cloud restore script at the last wizard step before executing the Cloud restore. You can also view an example Cloud restore database script here (scroll to the bottom of the page). Amazon S3 Cloud Account Settings You can setup the Amazon S3 Cloud account and proxy settings in the Backup, Restore, and Template Wizard. Cloud account Select the Cloud account from the drop-down list. Select the following items to edit the registered cloud account settings. l l Proxy Settings Add - Click to add Cloud vendor, display name, access key, secret key, region, and bucket. Select: use SSL, use server side encryption, use reduced redundancy storage, and GovCloud (US) Region. Edit - Click to edit Display name, Access key, Secret key, Region, and Bucket. Select: use SSL, use server side encryption, use reduced redundancy storage, and GovCloud (US) Region. l Delete - Click to delete the Cloud account from the console. l Import - Click to import a saved Cloud account in XML format. l Export - Click to export and save a Cloud account in XML format. Select the following items to edit the Cloud account proxy settings. l l l Use LiteSpeed Server proxy settings - Click to use the server proxy setting. This is the default selection. You can also edit the proxy settings from this item. Use LiteSpeed Console proxy settings - Click to use the console proxy setting. You can also edit the proxy settings from this item. Specify custom proxy settings - Click to add your own custom proxy address, port, username and password. LiteSpeed for SQL Server 8.1 User Guide 42 5 Back Up Databases Test Optimal Backup Settings Higher compression levels result in smaller backup files, but they also may consume additional CPU. If the server does not have sufficient CPU, then the backup may take longer to complete. The Backup Analyzer evaluates different settings, such as compression level, striping, and backup destinations, to help you determine optimal backup settings. NOTE: When running the Backup Analyzer, follow these guidelines for the best results: Minimum: 1 GB sample size. Recommendation: 10 GB sample size. The combination of compression levels, encryption options, and backup locations should be considered. For example, if you sample 4 GB of data with 10 different tests, LiteSpeed will take the same amount of time as it takes to back up 40 GB. On very large databases, you can speed up the analysis by reducing the number of backup combinations or by reducing the amount of sample data. Backup Analyzer Wizard The Backup Analyzer wizard guides you through selecting the backup parameters to test. The wizard tests all of the different combinations of your selected parameters by backing up a portion of the database. It does not interfere with existing backup schedules or sets. To run the Backup Analyzer wizard 1. Select the Backup Manager pane (CTRL+1). 2. Right-click the database and select Backup Analyzer Wizard. Tips: l l l To test striped backups, click Add to add several destinations and select the Test backup striping to selected backup locations checkbox on the Backup Location page. If you add more than two destinations, select both checkboxes to test all destination combinations. If you select a large number of backup parameters, you may want to schedule the tests to run at a specified time within the LiteSpeed Analyzer job. 3. Click Next. 4. On the Backup Location screen, select Backup to (Disk, Cloud, or TSM Backup) and Backup locations. Add or remove backups from the locations. Additionally select striping options. 5. Click Next. 6. On the Data Sample screen, enter the amount of data to sample in megabytes or the percentage of data to test. 7. Click Next. LiteSpeed for SQL Server 8.1 User Guide 43 the process is intentionally aborted. Priority Select the priority of the backup over other transactions or processes running on the same server. You may also want to consider using Adaptive Compression to maintain backup performance. This generates the VDI error messages in the LiteSpeed log files and the SQL Server error log.8. Review the following additional information about the advanced options: Throttle Enter the maximum percentage of CPU that LiteSpeed can use for the process. Complete the wizard. 9. Click Next. 12. 10. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. Wait period before each retry attempt (in seconds)—The default period to wait before retry is 15 seconds The maximum allowed setting is 300 seconds. See Processor Affinity on page 30 for more information. On the Execute Script screen. try limiting the number of threads. the list of databases to test is displayed. The default is n-1 threads. 11. The maximum allowed setting is 1000 retries. l l Number of times to retry any given read/write attempt—The default is 4 retries. The Backup Analyzer Wizard test scrip runs and displays the test results summary. Number of threads Enter the number of threads used for the backup. The default is 1048576. The default is 0. You should only modify advanced options after careful planning and testing. NOTE: LiteSpeed defaults typically result in the best performance. NOTE: After the required number of bytes is received for analysis. Max transfer size Enter the maximum backup file size in bytes. Processor affinity Click to select which processors LiteSpeed can use. Click Next. select the compression levels to test. where n is the number of CPU cores. The default is set by SQL Server. See Configure LiteSpeed Defaults on page 29 for more information. You can also specify additional backup advanced options. See Network Resilience on page 75 for more information. Tips: l l Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. If you decide to use an affinity value other than default. Any combination of compression levels from 0 to 8 are available.1 User Guide 44 . See Adaptive Compression on page 72 for more information. The default is Normal. You can enable and disable and control the number of times to retry and the amount of time to wait before retrying. Buffer count Enter the number of SQL Server buffers available for a LiteSpeed operation. .194. it waits and retries the operation. The default is 100. it is recommended that you limit the threading as well. Please ignore them.304 bytes (4 MB). LiteSpeed for SQL Server 8. Network Resilience If LiteSpeed fails to write disk backups or reads from disk. On the Compression Level screen. which allows LiteSpeed to use all available system processors. Click to remove all Backup Analyzer tests for the database.Click to run the Backup Analyzer Wizard and begin a new test.Click to print the grid. test number. and grid. disable or even delete the job. l Show Analyzer Jobs . You can view previous tests by changing the Existing test field. Encryption Indicates enabled encryption for the database backup. The Backup Analyzer toolbar is used to select the following items: l Existing test . Estimated Duration The approximate time allotted to run the database backup. LiteSpeed indicates the corresponding test in the bar graph with a yellow border around it. Column Description Test Number The number assigned by the Backup Analyzer. Compression (MB) The amount of disk space you can save with this compression ratio. LiteSpeed for SQL Server 8. Level The test level run on the database backup.DATABASENAME" is created.Use the Grid horizontal scroll bar to view other table columns.Click to view all Backup Analyzer jobs. size. The Backup Analyzer tab presents the test results in a graph and grid format: l l Graph—Displays the backup duration and compression amount for each test in a bar graph so you can easily compare the results between size and duration. l New Test .Scheduling Backup Analyzer You can schedule analyzing from within the Backup Analyzer Wizard.View the existing test or use the drop down to select other tests. Review the following for additional information: TIP: .Click to export the grid to Microsoft Excel. An SQL Server job with the name "LiteSpeed Analyzer SERVERNAME. You can change schedule. View the list of Backup Analyzer jobs directly from the Backup Analyzer tab by clicking "Show Analyzer Jobs. Estimated Backup Size (MB) The approximate size of the backed up database. Compression (%) Data compression ratio. Read Speed (MB/Sec) Maximum read speed. start/stop. and duration are displayed. Throughput (MB/Sec) Actual speed of processing data (compression and encryption). graph. If you hover the mouse over the bar graph. To view the script." Right-click on the job. Grid—Displays the details of each test in columnar format. If you select a test in the grid. Database Size (MB) The amount of disk space the database occupies. select the "View in Job Manager" option and open the job properties from the Job Manager module.1 User Guide 45 . You can then go to the job step details. l l . l Purge All . LiteSpeed indicates its recommendation with the number indicated first in the Test Number column and a yellow box around the test bar graph. . Backup Analyzer Tab The Backup Analyzer tab consists of the toolbar. To create a Backup Template 1.Column Description Backup Speed (MB/Sec) Virtual write speed of the backup. with or without transaction log backups. so it is easy to see if an instance needs to be updated. It shows how quickly the compressed data stream is written to the destination disk. Remove a column by dragging its column header into the list. LiteSpeed versions the templates and the deployments. You do not have to manage backup jobs for each database or manage maintenance plans for one server at a time. Compare this value to Throughput and Read Speed to determine if you are experiencing a write-bound issue. To move a column. move. Instead. and define the LiteSpeed compression and encryption options to use for the backup. group. To add or remove columns. 2. Stripes Number of stripes associated with the backup. If your company's policy changes. Backup Templates can also be easily removed from an instance if they are no longer required. Tips: For panes that have grids. click column headers while holding the SHIFT key. drag the column header to the new location.1 User Guide 46 . When you deploy a template to a server instance. you can quickly edit the template to comply with the new standards and re-deploy. Write Speed (MB/Sec) Actual write speed. Select the Backup Manager pane (CTRL+1). create and deploy a backup template. If you do not use the central repository. click New on the toolbar. making re-deployment very easy. Create and Deploy Backup Templates Create Backup Templates A LiteSpeed backup template contains a set of backup parameters that describe the types of databases and the types of backups you want to perform. To sort records against multiple columns. For example. you can sort. NOTE: This feature is only supported for disk and cloud LiteSpeed backups. Using a backup template you define Full backup or Fast Compression backup schemes for your environment. and remove the columns: l l l l To sort and group the records. right-click a column header and select the appropriate options. Backup Templates can be easily updated and changes deployed to all instances. Using LiteSpeed backup templates in your backup routine can help you manage multiple SQL Server instances. Destination Backup destination directory location. In the Backup Templates tab. Threads Number of threads associated with the backup. Add a column by dragging it from the list into the column headers. You can double-click a row for more information about the test. LiteSpeed tracks the instances where each template is deployed. right-click a column header and select Column Chooser. this creates a backup job or a maintenance plan that uses the parameters you specified in the template. to sort by type and then by name. click LiteSpeed for SQL Server 8. click the Type column header and then SHIFT+click the Name column header. If you specify a backup destination in a template. Wildcards are supported by both Maintenance Plans and Jobs. See Backup Files and Folders on page 68 for more information. You can select whether to back up databases participating in AlwaysOn Availability Groups. 3. When you redeploy this template. See Fast Compression on page 67 for more information. See Back Up SQL Server 2012 AlwaysOn Availability Groups on page 64 for more information. Each Backup Template remembers if you override these settings to make future redeployments easier. you can see if a database was included in the previous deployment and change the database selection as needed. Backup file name as well as the backup folder can include the %SERVER% variable. Fast Compression—Full and Differential and optionally transaction log backups. Select Databases Select databases you want to back up. Review the following additional information about the backup type and destination: Backup Type Select what backups will occur after you deploy this template on a server instance. NOTE: Fast Compression handles the naming of files automatically. that may be particularly useful when backing up many instances to the same network share. NOTEs: l l l Backup Destination You can select the Custom Database Selection at Deployment option to specify individual databases for each instance at the deployment time. l l Full—Full backups and optionally transaction log backups. See Deploy Backup Templates on page 52 for more information. Diff or Log) l %z—Timestamp You can specify custom backup name and description using both the LiteSpeed variables and text. then you are limited to deploying as a Maintenance Plan. The backup LiteSpeed for SQL Server 8.1 User Guide 47 . you can override backup destinations for each instance at deployment time. Decide whether you want to save a default backup destination name in the template or specify it at the deployment time. See Use Wildcard and Regular Expressions in LiteSpeed on page 64 for more information. Fast Compression automatically decides when to issue a Full or Differential backup based on the amount of database changes and some other conditions. You can either supply the backup destination at deployment time or save the default backup destination in the template. See LiteSpeed Variables on page 76 for more information.Backup Templates on the toolbar. If you use the Regular Expression option. The default backup name and description use the following information: l %D—Database name l %T—Backup type (Full. Unload the tape after backup Select to unload the tape after the backup is finished running.1 User Guide 48 .lsm file is created in the temp directory and attached to the backup file after the backup is completed. we need to add an option (that defaults to Append as it is now) to allow for an Overwrite option (there is no need for the unique option we provide in the Backup Wizard). which makes the object level recovery process much faster. when a Full backup template is created. TIP: You can select the option to overwrite existing media when a full backup template is created. NOTE: A Double Click Restore can only be created for a disk file. The default is enabled. Set Backup options. See Double Click Restore Executables on page 73 for more information. Verify backup when finished Select to run a backup verification after the backup has finished running. Optimize the Object Level Recovery speed Select to create an index of objects in the backup file.lsm file. the backup is executed despite encountering an invalid backup checksum. NOTE: Before you can recover objects or execute a SELECT statement. The expiration can be set to expire after a selected amount of days or on a particular day. Create a Double Click Restore executable Select to create an executable backup file or a Double Click Restore Loader that allows you to restore a backup on a server instance that does not have LiteSpeed installed.destinations include disk and cloud. 4. We have a few customers who would like to be able to create and deploy backup templates but require the previous backup be overwritten. Additionally. If you select this option. During the backup process the . The index is an . See Amazon S3 Cloud Account Settings on page 42 for more information. This option is only available for LiteSpeed backups. LiteSpeed uses the index in the backup file to read the backup file. Fast Compression Type Select whether you prefer to create a unique file for each backup or you prefer to manage a single file for each backup set (a backup set is composed of one full database backup plus all associated differential LiteSpeed for SQL Server 8. Perform checksum before writing to media Select to verify checksums when a backup is created. You can additionally select Cloud Accounts and Proxy Settings. Review the following if you selected the Fast Compression backup type. you can control the response to an error. Continue on error Select this option to continue running the backup even if an invalid checksum is encountered. NOTE: This option is for tape backups only. Copy Only Backup Select this option to enable copy-only backups. Select the sub option to rewind if you choose to have the tape rewound before unloading it. In order to do this. If you select the Continue on error option. you must read the backup file to create an index of restorable objects. Review the following for additional information: Backup expires Select to set the transaction log expiration. backups): l l Separate backup files—(Default) Creates a unique file for each backup in the backup set. This option provides the convenience of having to move less data to tape or across the network when copying individual backup files. Using this option means that up to two physical files may be needed to restore the database (full backup plus the associated differential for the day in question). Self-contained backup sets—Provides the convenience of only having to manage a single file per backup set. Only one file needs to be saved to or pulled from tape or copied from the backup location to a secondary location. If backing up more than one database, a file for each database will be created. The Self-Contained Backup Sets option automatically verifies the Full backup exists. The Separate Backup Files option performs the same validation by default. Fast Compression Backup Options You can set the following thresholds to define when to issue a full backup: l l Force a full backup every - The amount of time elapsed since the last full backup. The default is 14 days. Data change threshold - The amount of database changes since the last full backup. The default is 35%. Fast Compression measures the amount of data change by either querying SQL Server or by comparing the size of the last differential to the last full backup. The default option is to query actual data pages. It provides the most accurate way to determine the amount of data change. If the query fails for any reason, Fast Compression will automatically run a size comparison to the last Differential backup. For example, set this parameter to 20%, and should the database change by 20% or more, Fast Compression will automatically run a Full backup. The larger the threshold, the larger the differential backups can grow before Fast Compression triggers the next Full backup. Regardless of how much underlying database data has changed, when exceeding the maximum interval (in days) between full backups, Fast Compression will force a full backup. NOTES: l l l Before a differential Fast Compression backup is available, the last full backup must have been created in the Fast Compression backup or alternate backup folder. When backing up the master database as part of a Fast Compression maintenance plan or job, Fast Compression always executes a full backup. The copy-only full backups cannot serve as a base for differential backups. Select the File extension checkbox to enter or change the backup file name extension. The default is set to bkp. NOTE: You can select the backup file extension for Fast Compression and make the new default, bak, for new items. For an existing item that does not have an extension defined, bkp is displayed when the item is edited (maintenance plans and templates). Backup Escalation This option causes LiteSpeed to issue a full backup, if one of the LiteSpeed for SQL Server 8.1 User Guide 49 following problems is discovered in the current backup set: l l The full backup is missing. A differential backup is missing from the backup set (excludes backups automatically removed after the specified retention period). l LSN verification fails in the backup set. l 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. Verification Make sure the backup files in the backup set have integrity. This provides an added level of insurance the backup files can be restored. Verification failures appear in the LiteSpeed UI Console and, optionally, as job failure notifications. A verification failure after a differential backup will trigger the backup escalation process, if selected. The Verification options include: l Do not verify backup (default). l Verify last backup. l Verify both the last full and latest differential backup. l Verify the last full and all associated differential backups. The Cleanup options include: l Clean up full/differential backups older than 28 (default) days. l Clean up transaction logs older than 7 (default) days. l Clean up transaction log backup not scheduled. Option disabled. l Do not delete if archive bit is set. 5. Set Compression and Encryption options. Note that you can specify both the compression level and Adaptive Compression option. LiteSpeed will select and use Adaptive Compression if it is supported by the target server LiteSpeed version. Otherwise, the specified compression level will be used. Adaptive Compression LiteSpeed automatically selects the optimal compression based on throughput and CPU usage and optimize backups either for size or for speed (default). NOTE: Adaptive Compression is only available with LiteSpeed 6.5 or later; Enterprise license. Compression level Select 0 for no compression or 1-8 (default 2) to compress the file. See Compression Methods on page 71 for more information. NOTE: Higher compression levels result in smaller backup files, but they also take longer to complete. For assistance determining the best compression options, use the Backup Analyzer. See Test Optimal Backup Settings on page 43 for more information. Encrypt backup Select this checkbox to encrypt the backup. Then, select the encryption level and enter the encryption password. See Encryption Methods on page 73 for more information. LiteSpeed for SQL Server 8.1 User Guide 50 Review the following additional information about the advanced options: Throttle Enter the maximum percentage of CPU that LiteSpeed can use for the process. The default is 100. Priority Select the priority of the backup over other transactions or processes running on the same server. The default is Normal. Buffer count Enter the number of SQL Server buffers available for a LiteSpeed operation. The default is set by SQL Server. Max transfer size Enter the maximum backup file size in bytes. . The possible values are multiples of 65536 bytes (64 KB) ranging up to 4,194,304 bytes (4 MB). The default is 1048576. Processor affinity Click to select which processors LiteSpeed can use. The default is 0, which allows LiteSpeed to use all available system processors. See Processor Affinity on page 30 for more information. Number of threads Enter the number of threads used for the backup. The default is n-1 threads, where n is the number of CPU cores. Network Resilience If LiteSpeed fails to write disk backups or reads from disk, it waits and retries the operation. You can enable and disable and control the number of times to retry and the amount of time to wait before retrying. l l Number of times to retry any given read/write attempt—The default is 4 retries. The maximum allowed setting is 1000 retries. Wait period before each retry attempt (in seconds)—The default period to wait before retry is 15 seconds The maximum allowed setting is 300 seconds. See Network Resilience on page 75 for more information. Tips: l l 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. See Adaptive Compression on page 72 for more information. NOTE: LiteSpeed defaults typically result in the best performance. You should only modify advanced options after careful planning and testing. See Configure LiteSpeed Defaults on page 29 for more information. 6. Configure notification options. You can select an existing notification profile or specify operators at deployment. TIP: Variables defined in the maintenance plan can be used to format the Subject Line. There is also help information inside the task that lists the available Subject Line variables. NOTE: The SQL Server Agent must be configured to send email using Database Mail. Review the following for additional information: l http://msdn.microsoft.com/en-us/library/ms189635.aspx l http://technet.microsoft.com/en-us/sqlserver/dd939167.aspx 7. Specify backup cleanup options. See SmartCleanup on page 75 for more information. LiteSpeed for SQL Server 8.1 User Guide 51 NOTE: The "Do not delete if Archive bit is set" option is available for full and fast compression backups in the Backup Template when it is deployed as a maintenance plan. If a backup template is created for a full backup with the option "Do not delete if Archive bit is set" selected, and the backup template is deployed as a job, the option is passed to the job's script to run the xp_ slsSmartCleanup procedure. When the backup template is deployed as a maintenance plan, the option is omitted because the “Remove files older than” option (not the SmartCleanup option) for full backup is run in the maintenance plan. 8. Complete the wizard. Backup Templates are saved in the central repository (if one is used) and available for editing and deployment on the Backup Templates tab in the Backup Manager pane (CTRL+1). If the central repository is not configured, LiteSpeed will save each template as file. In the Backup Templates tab, you can create, edit, clone, import, export and deploy templates, view the template contents, deployment details and modification history. NOTES: l l The Backup Templates tab is only available, if the central repository is configured and selected for use. To edit, deploy or remove a template when the central repository is not used, click beside Backup Templates on the toolbar and select the appropriate option. The template deployment history is not exported when you export a template. Deploy Backup Templates NOTES: l l l l A LiteSpeed backup template can only be deployed on a server that has LiteSpeed installed. If the target server LiteSpeed version does not support Adaptive Compression, the created jobs and maintenance plans will instead use the specified compression level. Backup Templates can only be deployed as jobs on SQL Server 2000, because SSIS maintenance plans are not supported in this version of SQL Server. Regular expressions are only supported in Maintenance Plans. To deploy a LiteSpeed Backup Template 1. Select the Backup Manager pane (CTRL+1). 2. In the Backup Templates tab, click Deploy on the toolbar. If you saved the template to file and the central repository is not selected for use, click beside Backup Templates on the toolbar, select the Deploy option and double-click the template file you want to deploy. 3. Complete the wizard. Review the following for additional information: Select Instances Use the Show selected instances only option to see server instances and databases where the selected template was deployed. NOTE: You can select individual databases only if the backup template is saved with the Custom Database Selection at Deployment option. Backup Options Enter backup destinations for individual instances or for several instances at a time or use the default backup destination you specified in the template. You can change the scheduled time manually or you can right-click a cell in the Scheduled Time column and select one of the following options: l Default to template—To change the current cell back to the template default. l Default all to template—To change all cells back to the template default. LiteSpeed for SQL Server 8.1 User Guide 52 l l Stagger by n minutes—To stagger all scheduled times by n minutes, starting at the template time and adding n minutes for an instance. Spread over n hour(s)—To spread the scheduled times evenly over an n hour range, starting with the template time. NOTE: You can only change the time for the instance. Each Backup Template remembers if you override these settings to make future redeployments easier. For example, if you specify a different scheduled time for an instance, it will retain the job/plan start time for the next deployments and will not change if you edit this setting in the template. Notifications If you enabled notification in the template, review the Notification page and complete the fields as necessary. You can use the notification profiles only if they are already configured within a SQL Server instance. TIP: Variables defined in the maintenance plan can be used to format the Subject Line. There is also help information inside the task that lists the available Subject Line variables. NOTE: The SQL Server Agent must be configured to send email using Database Mail. Review the following for additional information: l http://msdn.microsoft.com/en-us/library/ms189635.aspx l http://technet.microsoft.com/en-us/sqlserver/dd939167.aspx For each of the selected instances, the Deployment wizard will create either a SQL Agent job or a maintenance plan. Maintenance Plans names and subplans jobs names are prefixed with the template name. SQL Agent job names have the following format: LiteSpeed Backup Template <template_name> (version n). Tip: To remove a deployed template, run the Deployment wizard, select the Remove deployed template option on the Select Template page and complete the wizard. Back Up Databases The Backup Manager wizard guides you through the process of backing up a single database or multiple databases. For single database backups you can perform file, filegroup, or transaction log backups, and you can also mirror, stripe, compress, encrypt, and add attachments to the backup file. For multiple database backups you can create both the native SQL Server and LiteSpeed backups, mirror, compress and encrypt backups, run all backups immediately or schedule via a SQL Server job. Tip: Database backups created with LiteSpeed Version 8.x cannot be restored using older versions of LiteSpeed. NOTES: l Running individual database backups or multi-database backups both use the same Backup wizard. When backing up multiple databases at the same time See Multi-Database Backup on page 67 for more information. Alternately, you can create a maintenance plan. See About Creating Maintenance Plans on page 80 for more information. l l If you select Fast Compression Backup, the wizard creates a Fast Compression job and does not create backup files immediately. When using this wizard to back up databases participating in AlwaysOn availability groups, LiteSpeed does not check whether the replica is preferred for backups. You can automate backing up of preferred replicas using the LiteSpeed Backup Templates feature. See Create Backup Templates on page 46 for more information. LiteSpeed for SQL Server 8.1 User Guide 53 l l l Fast Compression is not supported on secondary replicas in AlwaysOn Availability Groups. Backups must be performed on the primary because differential backups are not supported on secondaries. Performing full, file and filegroup backups on secondary replicas in an AlwaysOn Availability Group will always produce copy-only backups. Please refer to the SQL Server 2012 product documentation for information about supported backup types. For information about full file backups, see http://msdn.microsoft.com/enus/library/ms189860.aspx. Scenario You need to perform nightly disk backups for a 500 GB database that changes 10% daily. To back up multiple databases 1. In the Navigation pane, select a database to backup and click the Multi-Database Backup button. Alternately you can right-click a database and select Multi-Database Backup from the menu. 2. Select the databases for backup. See LiteSpeed's Logic for Backing Up Multiple Databases on page 63 for more information. 3. Complete the wizard. See To back up databases using the Backup wizard on page 54 for more information on backup options. In case you select to schedule the backups to run at the specified times, the wizard creates a job with 'Multiple Databases' appended to the job name. To back up databases using the Backup wizard 1. Select the Backup Manager pane (CTRL+1). 2. In the Navigation pane, select a database to backup and click the Backup button. Alternately you can right-click a database and select Backup from the menu. 3. On the Select Backup Type page, review the following: Recovery model Indicates the model used for this recovery. The default is set to full and cannot be changed on this page. Backup type Select one of the following backup types: l l Fast Compression backup. Using this option you can schedule Full and Differential and optionally Transaction log backups. Fast Compression automatically decides when to issue a Full or Differential backup based on the amount of database changes and some other conditions. See Fast Compression on page 67 for more information. Regular backup (Full, Differential or Transaction Log). Scenario: Select the Fast Compression backup type. Backup component Select one of the following backup components: Note: This field is only available for databases with a full recovery model and for a regular (not fast compression) backup. l l Database - Select to backup the database. Files and filegroups - Select to backup specific files and filegroups. When selected, the Specify Filegroups and Files window is displayed. In the window you can select the entire database, or any combination of filegroups or individual files to backup. LiteSpeed for SQL Server 8.1 User Guide 54 Use LiteSpeed Select to create a LiteSpeed backup. If you clear this checkbox, LiteSpeed creates a native backup script. Note: The LiteSpeed version number is displayed. Tip: You can specify custom backup names and descriptions using variables. See LiteSpeed Variables on page 76 for more information. 4. On the Backup Destination page, review the following: CAUTION: The Amazon S3 Cloud only runs backup to new files. Appending to an existing file is not supported by the Amazon S3 Cloud. Existing backups can only be overwritten. The option "Overwrite existing object" is available in the Backup Wizard and MP (Back Up Database task). The option is turned off by default. Scenario: Select Disk and enter the existing or new location for Fast Compression backups: Backup to Select one of the following options: l Disk l Cloud l TSM Backup l TSM Archive l Tape Add Click to add multiple backup destinations. The Select Backup Destination window is displayed. From here you can enter file names or backup devices. Remove Click to remove backup destinations. Contents Click to view the contents of the backup destination including general properties of file content and backup sets properties. Overwrite Select one of the following options: TIP: This option is only available for regular backups (and not fast compression backups). l Append to media. l Overwrite existing media. l Add Mirror Create unique media—This option will generate a unique file name for a backup. Click to copy the entire backup file to multiple locations. TIP: This option is only available with the Overwrite existing media option above. You can create multiple mirrors by clicking this button more than once. a. After clicking the button once, the Mirror 1 tab is displayed. b. Click the Add button to display the Select mirror destination window. c. Enter the mirror destination. Choices are file name and backup device. l For file names, click the ellipsis button to display backup locations. You can browse the network, add files, delete LiteSpeed for SQL Server 8.1 User Guide 55 files, and rename files. l For backup device, click the New Device button. The New Backup Device window is displayed. Enter device name and the physical location choices of file or tape drive. Notes: l l l Mirroring is not the same as striping, which divides the backup file and stores the pieces at different destinations. LiteSpeed automatically stripes the backup files if you include more than one backup destination. You can mirror backups regardless of what SQL Server version you use, but you cannot mirror TSM or tape backups. If you selected Cloud, review the following for additional information: Cloud account Select the Cloud account from the drop-down list. Select the following items to edit the registered cloud account settings. l l Proxy Settings Add - Click to add Cloud vendor, display name, access key, secret key, region, and bucket. Select: use SSL, use server side encryption, use reduced redundancy storage, and GovCloud (US) Region. Edit - Click to edit Display name, Access key, Secret key, Region, and Bucket. Select: use SSL, use server side encryption, use reduced redundancy storage, and GovCloud (US) Region. l Delete - Click to delete the Cloud account from the console. l Import - Click to import a saved Cloud account in XML format. l Export - Click to export and save a Cloud account in XML format. Select the following items to edit the Cloud account proxy settings. l l l Use LiteSpeed Server proxy settings - Click to use the server proxy setting. This is the default selection. You can also edit the proxy settings from this item. Use LiteSpeed Console proxy settings - Click to use the console proxy setting. You can also edit the proxy settings from this item. Specify custom proxy settings - Click to add your own custom proxy address, port, username and password. If you selected TSM Backup or TSM Archive, review the following for additional information: Client node Enter the node name for the TSM session. This field is not case-sensitive. Client owner password Enter the access password for the specified node. Configuration file Select the configuration file. (Usually, dsm.opt.) NOTE: This file contains session options such as the TSM server's TCP address. If you select the Use PASSWORDACCESS GENERATE from TSM configuration file checkbox and your options file is configured to support this option, you do not need to specify the client node and client owner password. Management class Select the management class (policy) to associate with the backup object being created. LiteSpeed will use the default management class, LiteSpeed for SQL Server 8.1 User Guide 56 if this option is not selected. TSM Filespaces (Fast Compression backups) Click TSM Filespaces and select the existing or enter new file space name(s). This step is optional, if you do not specify the file space name, Fast Compression will automatically create one. NOTE: Fast Compression handles the naming of files automatically. See Backup Files and Folders on page 68 for more information. TSM Object (Regular backups) Click Select TSM Object. Enter the filespace and the high-level and low-level names and click Query TSM to pick the object name from the list of available TSM objects. From the Available TSM Objects list, double-click the objects you would like to select. NOTE: If you leave the High level and Low level fields blank, LiteSpeed will query all TSM server levels. Querying all levels may take longer to complete. For a new object, you can manually enter the full three-part name. Check for existing objects with same name (Regular backups) Select this option to check for objects with the same name. LiteSpeed aborts the backup if it finds one. 5. If you selected the Fast Compression backup type, review the following: Fast Compression Type Select whether you prefer to create a unique file for each backup or you prefer to manage a single file for each backup set (a backup set is composed of one full database backup plus all associated differential backups): l l Separate backup files—(Default) Creates a unique file for each backup in the backup set. This option provides the convenience of having to move less data to tape or across the network when copying individual backup files. Using this option means that up to two physical files may be needed to restore the database (full backup plus the associated differential for the day in question). Self-contained backup sets—Provides the convenience of only having to manage a single file per backup set. Only one file needs to be saved to or pulled from tape or copied from the backup location to a secondary location. If backing up more than one database, a file for each database will be created. The Self-Contained Backup Sets option automatically verifies the Full backup exists. The Separate Backup Files option performs the same validation by default. 6. On the Options page, review the following: Options You can set the following thresholds to define when to issue a full backup: l l Force a full backup every - The amount of time elapsed since the last full backup. The default is 14 days. Data change threshold - The amount of database changes since the last full backup. The default is 35%. Fast Compression measures the amount of data change by either querying SQL Server or by comparing the size of the last differential to the last full backup. The default option is to query actual data pages. It LiteSpeed for SQL Server 8.1 User Guide 57 provides the most accurate way to determine the amount of data change. If the query fails for any reason, Fast Compression will automatically run a size comparison to the last Differential backup. For example, set this parameter to 20%, and should the database change by 20% or more, Fast Compression will automatically run a Full backup. The larger the threshold, the larger the differential backups can grow before Fast Compression triggers the next Full backup. Regardless of how much underlying database data has changed, when exceeding the maximum interval (in days) between full backups, Fast Compression will force a full backup. NOTES: l l l Before a differential Fast Compression backup is available, the last full backup must have been created in the Fast Compression backup or alternate backup folder. When backing up the master database as part of a Fast Compression maintenance plan or job, Fast Compression always executes a full backup. The copy-only full backups cannot serve as a base for differential backups. Select the File extension checkbox to enter or change the backup file name extension. The default is set to bkp. NOTE: You can select the backup file extension for Fast Compression and make the new default, bak, for new items. For an existing item that does not have an extension defined, bkp is displayed when the item is edited (maintenance plans and templates). Select the Enable backup escalation checkbox to maintain high recoverability. This option is enabled by default. This option causes LiteSpeed to issue a full backup, if one of the following problems is discovered in the current backup set: l l The full backup is missing. A differential backup is missing from the backup set (excludes backups automatically removed after the specified retention period). l LSN verification fails in the backup set. l 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. Select the Optimize Object Level Recovery speed checkbox to enable speed. The default is enabled. Select the Perform checksum before writing to media checkbox to verify backup data checksum before writing the backup data to the media. Select the Continue on error checkbox to continue running the backup even if an invalid checksum is encountered. Select the Extension for backup files checkbox to enter or change the backup file name extension. The default is set to bak. LiteSpeed for SQL Server 8.1 User Guide 58 NOTE: You can select the backup file extension for Fast Compression and make the new default, bak, for new items. For an existing item that does not have an extension defined, bkp is displayed when the item is edited (maintenance plans and templates). Backup expires Select to set the transaction log expiration. The expiration can be set to expire after a selected amount of days or on a particular day. Verify backup when finished Select to run a backup verification after the backup has finished running. Optimize the Object Level Recovery speed Select to create an index of objects in the backup file. This option is only available for LiteSpeed backups. The default is enabled. NOTE: Before you can recover objects or execute a SELECT statement, you must read the backup file to create an index of restorable objects. The index is an .lsm file. During the backup process the .lsm file is created in the temp directory and attached to the backup file after the backup is completed. If you select this option, LiteSpeed uses the index in the backup file to read the backup file, which makes the object level recovery process much faster. Create a Double Click Restore executable Select to create an executable backup file or a Double Click Restore Loader that allows you to restore a backup on a server instance that does not have LiteSpeed installed. See Double Click Restore Executables on page 73 for more information. NOTE: A Double Click Restore can only be created for a disk file. Unload the tape after backup Select to unload the tape after the backup is finished running. Select the sub option to rewind if you choose to have the tape rewound before unloading it. NOTE: This option is for tape backups only. Perform checksum before writing to media Select to verify checksums when a backup is created. Continue on error Select this option to continue running the backup even if an invalid checksum is encountered. Copy Only Backup Select this option to enable copy-only backups. Additionally, you can control the response to an error. If you select the Continue on error option, the backup is executed despite encountering an invalid backup checksum. Note: Some options are only available with certain backup types. 7. On the Compression page, review the following: Adaptive Compression LiteSpeed automatically selects the optimal compression based on throughput and CPU usage and optimize backups either for size or for speed (default). NOTE: Adaptive Compression is only available with LiteSpeed 6.5 or later; Enterprise license. Compression level Select 0 for no compression or 1-8 (default 2) to compress the file. See Compression Methods on page 71 for more information. LiteSpeed for SQL Server 8.1 User Guide 59 try limiting the number of threads. it is recommended that you limit the threading as well. 8. The default is 1048576. The default is 100. select the encryption level and enter the encryption password. See Network Resilience on page 75 for more information. See Configure LiteSpeed Defaults on page 29 for more information. Processor affinity Click to select which processors LiteSpeed can use. l l Number of times to retry any given read/write attempt—The default is 4 retries.194. Network Resilience If LiteSpeed fails to write disk backups or reads from disk.NOTE: Higher compression levels result in smaller backup files. See Test Optimal Backup Settings on page 43 for more information. Encrypt backup Select this checkbox to encrypt the backup. where n is the number of CPU cores. Priority Select the priority of the backup over other transactions or processes running on the same server. Review the following additional information about the advanced options: Throttle Enter the maximum percentage of CPU that LiteSpeed can use for the process.304 bytes (4 MB). it waits and retries the operation.1 User Guide 60 . See Encryption Methods on page 73 for more information. You may also want to consider using Adaptive Compression to maintain backup performance. If you decide to use an affinity value other than default. The maximum allowed setting is 1000 retries. See Adaptive Compression on page 72 for more information. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. . The default is 0. Number of threads Enter the number of threads used for the backup. use the Backup Analyzer. You should only modify advanced options after careful planning and testing. but they also take longer to complete. Then. The default is set by SQL Server. LiteSpeed appends the files to the data section of the backup file. Max transfer size Enter the maximum backup file size in bytes. This feature lets you bundle items with the backup file that may be necessary to restore it. NOTE: LiteSpeed defaults typically result in the best performance. You can enable and disable and control the number of times to retry and the amount of time to wait before retrying. On the Attached Files page. which allows LiteSpeed to use all available system processors. Wait period before each retry attempt (in seconds)—The default period to wait before retry is 15 seconds The maximum allowed setting is 300 seconds. The default is Normal. and consequently the attached files are encrypted and compressed with the backup if those options are selected. Tips: l l Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. select Attach files and directories to store selected files with the backup. See Processor Affinity on page 30 for more information. Buffer count Enter the number of SQL Server buffers available for a LiteSpeed operation. The default is n-1 threads. For assistance determining the best compression options. LiteSpeed for SQL Server 8. you can configure the Fast Compression job to send notifications when any type of failure occurs. duration. but you may need them to restore it. schedule type. If you selected Fast Compression the backup schedule has options to configure backups to run as a SQL Agent job at a scheduled time.aspx 11. Select one of the following: l l l Do not use notification . The options are: daily at. daily frequency. specify scheduling for the transaction log backup job execution.com/en-us/library/ms189635.Some examples of when to use this feature include the following: l l l Extended stored procedures packaged in DLLs may exist outside of the database. On the T-Log Schedule page.1 User Guide 61 . TIP: Variables defined in the maintenance plan can be used to format the Subject Line..microsoft. you can back up the database along with the current version of the application. you can attach schema diagrams. weekly. select Restore Attached Files and Directories on the Attach Files page of the Restore wizard. like a missing Full or Differential backup. optionally.. a validation issue. Click the ellipsis button on the far right to create new or edit existing operators. On the Verification/Cleanup page. LiteSpeed for SQL Server 8. 12. If you are going to upgrade a database application. 9. An operator can be selected and configured to receive notifications. The failure might be due to a failed backup. occurs.com/en-us/sqlserver/dd939167.microsoft. The Verification options include: l Do not verify backup (default). Tip: To restore attached files only using the Restore Wizard. Click the ellipsis button on the far right to create new or edit existing operators. A verification failure after a differential backup will trigger the backup escalation process. if you selected the Fast Compression backup type. as job failure notifications. Verification failures appear in the LiteSpeed UI Console and. occurs. specify the verification and cleanup options after each backup. On the Backup Schedule page.Notify for all successes and failures. instructions. custom. and description. 10. if selected. you can restore both the database and the related application files. Run in background.All failure notifications (including operator selections) are disabled. select Run immediately. and other documentation. When sending a backup file offsite to another person (such as an auditor or consultant). Select Schedule transaction log and fill out the new job schedule screen. Notify every time .Notify for failure only. or Schedule. If anything goes wrong during the upgrade. schedule type. Entries include schedule name. There is also help information inside the task that lists the available Subject Line variables. To retrieve the attachment. or a failed Verify operation. This provides an added level of insurance the backup files can be restored. On the Notification page. If you select custom. See xp_restore_attachedfilesonly on page 237 for more information. l Verify last backup. These external DLLs can be attached to the backup file. NOTE: The SQL Server Agent must be configured to send email using Database Mail. and description. and do not run full backup on specified days of the week. daily frequency. Failure only .aspx l http://technet. Review the following for additional information: l http://msdn. duration and description. occurs. daily frequency. An operator can be selected and configured to receive notifications. username and password lists. right-click a database in the server tree and select Restore | Attached Files. Make sure the backup files in the backup set have integrity. schedule type. Selecting Schedule launches a page where you can fill out the schedule name. You can also use xp_restore_attachedfilesonly. you can add schedule name. an LSN verification issue. duration. l Verify both the last full and latest differential backup. create the fast compression backup job script. l Clean up transaction logs older than 7 (default) days. If you scheduled the backup. Refer to xp_backup_ database for partial backup example syntax. Restores begin with primary files. and other specified read-only files. and then secondary filegroups. all read and write files. l Clean up transaction log backup not scheduled. Restore partial backups with fast compression LiteSpeed can restore partially backed up databases that have been run with fast compression enabled. Refer to xp_restore_ database for restore partial backups example syntax. Partial database backups contain only data from some filegroups in a database. Partial backups are different from full backups in that full backups contains all the data in a specific database or set of filegroups or files. Scenario: Specify when full/differential backups are eligible for cleanup. and enough available transaction log information for recovering that data.1 User Guide 62 . Partial backups LiteSpeed can backup partial databases. Piecemeal restores with fast compression are run using the CLI with fast compression restore commands. Partial backup data includes that from primary filegroups. Option disabled. you can view the progress in the Background Tasks pane (View | Background Tasks). 14. LiteSpeed for SQL Server 8. The Cleanup options include: l Clean up full/differential backups older than 28 (default) days. l Do not delete if archive bit is set. Note: If you selected to run the backup in the background. 13. l Verify the last full and all associated differential backups. Partial backups are run using the CLI with backup commands. On the Fast Compression Job page. Piecemeal restores are run using the CLI with restore commands. according to your company's retention policy. Complete the wizard. About partial backups and restores LiteSpeed supports partial backups and restores for filegroups. Refer to xp_slsFastCompression for restore partial backups with fast compression example syntax. Piecemeal database restore sequences can restore databases in stages at the filegroup level. Restore partial backups LiteSpeed can restore partially backed up databases. read and write filegroups. This restore is similar to restore partial backups except that it performs a restore where the partial backup was run with the Fast Compression technology enabled. you can view and edit it from the LiteSpeed Jobs tab for the database. See SmartCleanup on page 75 for more information. unless they are excluded by an Exclude option. See Exclude Databases on page 63 for more information. NOTE: LiteSpeed wizards may have different Exclude/Include options for selecting databases. you selected to back up databases. l Deleted l Log Shipping l Read Only NOTE: Mirror databases are automatically excluded. Instead. You can exclude the following databases: l l Offline Selected—LiteSpeed will backup all existing and new databases. If there are conflicting conditions (for example. NOTE: New user databases will also be backed up as part of the "All databases" or "User databases" groups or if they match the specified pattern. Include Databases You can specify databases: l Manually l Using one of the following built-in groups: l l All databases l System databases l User databases Using wildcard or regular expressions.1 User Guide 63 . except those you selected manually and those excluded by a different Exclude option. matching the 'DirectD*' pattern and skip read-only databases. See Use Wildcard and Regular Expressions in LiteSpeed on page 64 for more information. Exclude Databases Using these options you can further define databases you want to back up. while the name of a read-only database matches the pattern). You cannot mix selection methods. the Exclude condition wins over Include. you can schedule several subplans or jobs using different selection methods. LiteSpeed for SQL Server 8.Back Up Multiple Databases LiteSpeed's Logic for Backing Up Multiple Databases LiteSpeed provides you with many flexible options for selecting databases to include in a backup job or in a backup task of a maintenance plan. Using wildcard and regular expressions is particularly helpful when there are databases with similar names on the same instance or on multiple instances. In Maintenance Plans if you select the Differential backup type. provided the jobs or maintenance plans are configured on every server instance that hosts an availability replica.0 and later of LiteSpeed provide enhanced support for databases participating in AlwaysOn availability groups. regardless of AlwaysOn configuration. as well as perform backups on individual replicas. all secondary replicas in an AlwaysOn Availability Group are automatically excluded. unless the primary replica is the only replica online. or create a maintenance plan on one instance and then simply copy it to other instances. the following options define which replicas are eligible for backup: l l l l Back up preferred—This is the default option. LiteSpeed lets you enter multiple patterns. "litespeed*" will include all databases that start with "litespeed" or "LiteSpeed". file and filegroup backups on secondary replicas in an AlwaysOn Availability Group will always produce copy-only backups. In Maintenance Plans and in the Multi-Database Backup Wizard. you can click Validate selected or Validate all to display a list of databases names that match any of the specified patterns. For example.Back Up SQL Server 2012 AlwaysOn Availability Groups Versions 7. Please refer to the SQL Server 2012 product documentation for information about supported backup types. backups for all secondary replicas will fail because transaction log backups with Copy Only are not supported on secondaries. Wildcard Expressions You can use wildcard characters '?' and '*' to select databases you want to back up. Backups must be performed on the primary because differential backups are not supported on secondaries. LiteSpeed will follow the logic defined for the availability group by the database administrator and back up databases accordingly. Performing full.1 User Guide 64 . Tips: l l To back up databases with similar names on multiple instances. You can include availability databases in a maintenance plan or a backup job. When selecting databases for your maintenance plan. In maintenance plans and backup templates. In the Multi-Database Backup Wizard they are not excluded and differential backup for secondary replicas will fail. Back up none—AlwaysOn databases are ignored during backup. create and deploy a backup template. NOTES: l l l l Fast Compression is not supported on secondary replicas in AlwaysOn Availability Groups. Only back up the primary—The primary is backed up each time. Use Wildcard and Regular Expressions in LiteSpeed You can configure LiteSpeed to only back up databases that match the specified pattern. Back up all (primary and secondaries)— All primaries and secondaries are backed up each time. LiteSpeed for SQL Server 8. The default AlwaysOn configuration is to back up a secondary replica only. regardless of AlwaysOn configuration. if you select the Transaction log backup type and turn on the Copy Only option. can. use ([Aa][Bb][Cc]) instead of (?i:abc).1 User Guide 65 . Begins with "LiteSpeed".Regular Expressions Using regular expressions can provide you with more flexibility when selecting databases. To ignore case. except for the following: ^ . Text: 9pm @ RockCafe Expression: \W Matches: @ \d Any digit. 8285[0-4][0-9] 5. LiteSpeed for SQL Server 8. Begins with "LiteSpeed" followed by digits. catch \W Any non-word character.z). Text: no cat can catch a crow Expression: \w+$ Matches: crow (normal characters) Characters match themselves. Ends with "_PUBLISHER". _PUBLISHER$ 3. digits. ^(?!DellSoftwareCMSS)(Dell|LiteSpeed) NOTES: l l Regular expressions are only supported in Maintenance Plans. Contains any number within the range 828500 to 828549.Z and a . Review the following for additional information: Construct Description ^ The character following this construct is at the beginning of the document or new line. ^LiteSpeed\d+ 4. Begins with "LiteSpeed" or "Dell". For example. Text: no cat can catch a crow Expression: ca\w+ Matches: cat. when that character is not an escaped character. ^LiteSpeed 2. * + ? { [ ( | ) \ $ \ The character immediately following it. and underscores. except "DellSoftwareCMSS". Text: no cat can catch a crow Expression: ^\w+ Matches: no $ The character followed by this construct is at the end of the string. the following expressions will include a database if its name: 1. LiteSpeed does not support regular expressions with the IgnoreCase option. Expression: \* Matches: * \w Any word character (A . Text: no cat can catch a crow Expression: c\S+ Matches: cat. [0-9a-fA-F] matches a single hexadecimal digit. Text: no cat can catch a crow Expression: c\w\w\s Matches: "cat " and "can "(both matches include the space) \S Any non-whitespace character. can. aaaha. crow [] Any character within the brackets.Construct Description Text: APR-2012 Expression: \d\d\d\d Matches: 2012 \D Any non-digit. Expression: b[a-z]ttle Matches: battle. gooogle. {n} The exact number of matches for the preceding character. Expression: a*ha Matches: ha. catch. without case sensitivity.1 User Guide 66 . ? Zero or one matches of the preceding character. and dug * Zero or more matches of the preceding character.g Matches: dog. it is equivalent to a period character. Any single character. Text: APR-2012 Expression: \D\D\D Matches: APR \s Any whitespace character. [^ ] Any character that is not in the specified set of characters. Expression: colou?r Matches: color and colour + One or more matches of the preceding character. bottle NOTE: The . etc. or if it is escaped with a backslash. aha. etc. When preceded with the escape character (\).character is considered a literal character if it used as the first or last character within the brackets. dig. Expression: goo+gle Matches: google. Expression: d[^u]g Matches: dog and dig but not dug . Expression: p[ai]ck Matches: pick. aaha. pack [-] Any character within the specified range. Expression: d. Text: he had to go too far Expression: o{2} Matches: oo in "too" LiteSpeed for SQL Server 8. Expression: mo{2.aspx Multi-Database Backup Multi-Database Backup launches the Backup wizard which allows you to configure backup options for several databases at once. Alternately you can select the Multi-Database Backupbutton at the top.1 User Guide 67 . Expression: ^(?=. Expression: ^(?!test). LiteSpeed generates uniquely named backup files to avoid collision.. Expression: theat(er|re)(?# using this example a second time) Matches: theater and theatre (?= ) A zero-width positive lookahead assertion. See To back up databases using the Backup wizard on page 54 for more information on backup options.Construct Description {n. Select databases for backup. Fast Compression Fast Compression allows you to maximize space savings and reduce backup time considerably over nightly full backup routines by intelligently backing up only database changes rather than the entire database. 3.microsoft.microsoft.3}n Matches: moon and mooon. Fast Compression automatically chooses to create a full or differential backup based on user-defined full backup LiteSpeed for SQL Server 8.aspx l msdn. Expression: theat(er|re) Matches: theater and theatre (?# ) A comment within a regular expression. Complete the wizard. but not mon or moooon () Matches subexpression. Right-click the server instance and select Multi-Database Backup. For each database.com/en-us/library/az24scfc. See LiteSpeed's Logic for Backing Up Multiple Databases on page 63 for more information. the wizard creates a job with 'Multiple Databases' appended to the job name. In case you select to schedule the backups to run at the specified times. 2.. see l msdn. | Matches any of the alternate expressions. The comment ends after the first closing parenthesis.. To back up multiple databases 1.m} The preceding character must match at least "n" times but no more than "m" times.{32}$)(\d+) Matches: numbers at the beginning of any line which is exactly 32 characters long (?! ) A zero-width negative lookahead assertion.com/en-us/magazine/cc163473. NOTE: Fast Compression is now available for multi-database backup in the UI.+ Matches: any line that does not begin with "test" For more information about regular expressions. Create a maintenance plan with the Fast Compression Backup task.s#] where: l f# is full backup index l d# is diff backup index (if used) l s# is stripe index (if used) l m# is mirror index (if used) NOTE: All indexes start at zero.d#][. users will see a significant reduction in backup storage and backup time. Fast Compression backups have the following format: l Disk backup: database_name.f#[. Backup Files and Folders Fast Compression handles the naming of files automatically. create and deploy a LiteSpeed backup template. By only backing up database changes. See Back Up Databases Using Maintenance Plans on page 82 for more information. LiteSpeed for SQL Server 8.m#]. Fast Compression selects the differential backup after first full. Enterprise license. Days Native backup LiteSpeed full backup Fast Compression backup 1 100 GB 20 GB 20 GB (Full) 2 100 GB 20 GB 1 GB (Diff) 3 100 GB 20 GB 2 GB (Diff) 4 100 GB 20 GB 3 GB (Diff) 5 100 GB 20 GB 4 GB (Diff) 6 100 GB 20 GB 5 GB (Diff) 7 100 GB 20 GB 6 GB (Diff) Total: 700 GB 140 GB 41 GB Quick Start To start do one of the following: l l Run the Backup wizard and select the Fast Compression backup type. See Back Up Databases on page 53 for more information.litespeed. See Create Backup Templates on page 46 for more information. if the amount of changes is less than 35%.bkp l TSM backup: file_space_name\database_name\litespeed.d#][. Tip: To create Fast Compression jobs or tasks on several instances. By default.1 or later. l Fast Compression is only available with LiteSpeed 5. NOTES: l Fast Compression is not available for Tape and TSM Archive. The following table shows how much disk space can be saved for nightly Fast Compression backups for a 100 GB database that changes 5% daily and uses a 35% data change threshold.s#][.1 User Guide 68 .intervals and the percentage of the database that has changed.f#[. Also. The default is 14 days. If the query fails for any reason. set this parameter to 20%. If backing up more than one database. The Separate Backup Files option performs the same validation by default. The larger the threshold. If striping.Disk Backup Folders Since the database name is incorporated into the backup name. Fast Compression will automatically run a Full backup. Regardless of how much underlying database data has changed. The default is 35%. The default option is to query actual data pages. Only one file needs to be saved to or pulled from tape or copied from the backup location to a secondary location. It is recommended that you create a new folder to use for Fast Compression backups. It provides the most accurate way to determine the amount of data change. Using this option means that up to two physical files may be needed to restore the database (full backup plus the associated differential for the day in question). Fast Compression escalates to a full backup (if the escalate option is selected) or continues with a differential backup. but a valid. the larger the differential backups can grow before Fast Compression triggers the next Full backup. Fast Compression performs some validations to see if a full backup already exists: l l l If the last full backup was not performed by Fast Compression. If the last full backup was not performed by Fast Compression and that full backup is either missing or has an LSN verification issue. you can select several directories.1 User Guide 69 . the last full backup must have been created in the Fast Compression backup or alternate backup folder. Data change threshold . Self-contained backup sets—Provides the convenience of only having to manage a single file per backup set. LiteSpeed for SQL Server 8. when exceeding the maximum interval (in days) between full backups. Full Backup Conditions You can set the following thresholds to define when to issue a full backup: l l Force a full backup every . Fast Compression measures the amount of data change by either querying SQL Server or by comparing the size of the last differential to the last full backup.The amount of time elapsed since the last full backup. Fast Compression will force a full backup. If the last Full backup was performed by Fast Compression and is either missing or has an LSN verification issue.The amount of database changes since the last full backup. This option provides the convenience of having to move less data to tape or across the network when copying individual backup files. you can safely select the same directory for all databases on an instance. then Fast Compression uses it and begins the process with a differential backup. and should the database change by 20% or more. If you decide to back up to a folder that already has database backups. you can add directories to mirror the entire backup file to multiple locations. preventing the need to run an initial full backup on the database. Disk Backup Files Select whether you prefer to create a unique file for each backup or you prefer to manage a single file for each backup set (a backup set is composed of one full database backup plus all associated differential backups): l l Separate backup files—(Default) Creates a unique file for each backup in the backup set. For example. The Self-Contained Backup Sets option automatically verifies the Full backup exists. NOTES: l Before a differential Fast Compression backup is available. a file for each database will be created. full backup exists in the designated Fast Compression folder. Fast Compression will automatically run a size comparison to the last Differential backup. Fast Compression starts off by executing a full backup. This will continue until Fast Compression runs on a day that is not excluded. NOTE: You can select the backup file extension for Fast Compression and make the new default. you should not experience these types of issues as they are normally caused by accidental deletion of files or disk corruption. if one of the following problems is discovered in the current backup set: l l The full backup is missing. A differential backup is missing from the backup set (excludes backups automatically removed after the specified retention period). you would not normally be able to restore the database. assuming no full backup exists that can be used as described above. but you will not be able to recover the database using these backups unless the correct full backup is located. The default is set to bkp. you will have to correct the problem manually. for new items. both of which occur very infrequently. If you select to exclude specific days of the week from Full backups and Fast Compression is set to execute the first time on an excluded day. Fast Compression always executes a full backup. If you uncheck this option and Fast Compression discovers an issue. This setting provides insurance against unanticipated errors. a differential backup may be executed successfully. For example. Full backup escalation is selected by default to maintain high recoverability level in the situations where recoverability may be limited (missing differential in set) or not available at all (missing full backup). as job failure notifications. See xp_ slsFastCompression on page 302 for more information. Verification failures appear in the LiteSpeed UI Console and. NOTE: If a problem is detected and a full backup is created through escalation. if selected. If the physical file for the last full backup cannot be found.1 User Guide 70 . Fast Compression automatically runs a full backup to put the database in a restorable state. Backup Verification Make sure the backup files in the backup set have integrity. For an existing item that does not have an extension defined. if a backup file is missing from the backup set (someone accidentally deleted it). l Verify last backup. This provides an added level of insurance the backup files can be restored. To correct for this potential issue with backups. The Verification options include: l Do not verify backup (default). Additionally. LiteSpeed for SQL Server 8. you can prevent full backups from occurring on specified days of the week. an error will be returned. or there is some other type of issue like a Log Sequence Number (LSN) validation error or file corruption. l LSN verification fails in the backup set. A verification failure after a differential backup will trigger the backup escalation process. Errors are still noted in the LiteSpeed UI Console and alerts will still be sent via the job. Select the File extension checkbox to enter or change the backup file name extension.l l When backing up the master database as part of a Fast Compression maintenance plan or job. Under normal operating conditions. The copy-only full backups cannot serve as a base for differential backups. Fast Compression will not execute a full backup. l Verify operation fails on full or differential backup. Correction may require forcing a full backup using the @ForceFull parameter. bak. Backup Escalation This option causes LiteSpeed to issue a full backup. bkp is displayed when the item is edited (maintenance plans and templates). optionally. See Adaptive Compression on page 72 for more information. If you use the Separate Backup Files option in Fast Compression.bak backup file. Compression Methods You can specify a compression level manually. or you can use Adaptive Compression to let LiteSpeed automatically select the optimal compression level. if a user performs a backup of AdventureWorks and Pubs into the same mybackups. This is important because the cleanup will never remove a full backup that is needed by a differential backup that is not being deleted. you can optionally schedule transaction log backups for the database. Compression Levels LiteSpeed offers the following compression levels that allow you to specify compression from least compression to most compression. Select this option to remove full and differential backup files and transaction log backups that are older than the specified time period. l Verify the last full and all associated differential backups. l Do not delete if archive bit is set. Compression Level Description 1 Medium Compression—for servers where minimal CPU utilization is preferred at the expense LiteSpeed for SQL Server 8. The backup retention will never delete: l l The backup files. For example. See SmartCleanup on page 75 for more information.1 User Guide 71 . Using the Backup wizard. if there are mixed backups in the same backup file. The cleanup routine is backup set aware. Option disabled. NOTE: Fast Compression does not raise errors if it detects a missing backup from a backup set that was removed via the cleanup process. Transaction log backups are scheduled as a separate job from Fast Compression. you have the added flexibility of being able to remove differential backups from the active backup set that are no longer needed.l Verify both the last full and latest differential backup. l Clean up transaction log backup not scheduled. Cleanup Cleanup provides a convenient way to remove old backups from disk without disrupting Fast Compression. if there are associated differential or t-log backups in the backup set that are not eligible for cleanup. l Clean up transaction logs older than 7 (default) days. The full backup. with a corresponding CPU trade-off. The Cleanup options include: l Clean up full/differential backups older than 28 (default) days. Backup Jobs Completing the wizard will create the Fast Compression backup job. Adaptive Compression With Adaptive Compression you do not have to run the Backup Analyzer wizard to determine the best compression level for a database. while maximizing use of available CPU. the higher compression levels will look for longer patterns to compress. You can select to optimize backups either for size or for speed: l l Optimize for speed—Backups complete in the least amount of time possible. Optimize for size—Backups are completed with higher compression while managing overall backup time to ensure backups do not take a long time to complete (when compared to optimizing for speed). See Test Optimal Backup Settings on page 43 for more information.0 and are now automatically mapped to the new compression level 8. When choosing a compression level. Additionally. LiteSpeed does not automatically export the encryption key. This is the default setting. restoring and shipping transaction logs of the databases encrypted with transparent data encryption (TDE). If the server workload changes during the backup (change in CPU or Disk IO). Adaptive Compression automatically switches compression to maintain optimal performance. the LiteSpeed backup will not compress very well. Since the database is encrypted with TDE. the higher the compression ratio the higher the CPU utilization and potentially more compression. 7. Typically. some databases will get varying results as the level increases. Generally. 3. since using a higher level of compression will only cause CPU to increase without any real benefit on the backup file size. Available CPU is leveraged to reduce backup size. See Encryption Methods on page 73 for more information. 8 Extreme Compression—a new highly optimized extreme compression algorithm for databases where compressed size is very important with only a slight increase in CPU utilization over previous levels. That is. as well as perform more passes on the data. the various algorithms will yield different results. 5. If you want to compress the backup. NOTE:Levels 9. because there is no way to recover the data without the key. The higher levels do not guarantee better compression ratios as the nature of the data dictates the final result. 4. the higher levels require more time for the backup. If needed. if a higher level gets significantly better compression. In this mode. but not at the expense of increased backup time. it may actually perform faster than a lower level. 10 and 11 were deprecated in version 6. 2 Medium-High Compression—a new highly optimized low CPU algorithm for environments where low CPU utilization is preferred but with improved compression over level 1. LiteSpeed allows the backup to complete more slowly if the reduction in speed results in a LiteSpeed for SQL Server 8. you should choose compression level 1 to minimize CPU. 6 High Compression—for databases where balanced compressed backup size and CPU utilization is important. To further protect the backup. If you choose compression level 0. Review the following for additional information: l l Its important to back up the database encryption key. LiteSpeed will dynamically change the compression level during a backup in order to optimize for speed or size.1 User Guide 72 . LiteSpeed will not attempt to compress the backup. you can include the encrypted key file in the backup. NOTE: LiteSpeed supports backing up. Depending on your environment.Compression Level Description of some compression. test various options to determine the best option for your environment. See Back Up Databases on page 53 for more information. you can use LiteSpeed Encryption with TDE databases to add a secondary layer or protection to the backup. Therefore. NOTE: If running Windows 2000 to utilize the higher levels of encryption. then the backup file name will have the . NOTE: Adaptive Compression is only available with LiteSpeed 6. and the others will remain unchanged.exe.1 User Guide 73 . In many cases. Encryption Methods Encryption is a mechanism for protecting data. LiteSpeed offers the option of encrypting in the following formats: l 40-bit RC2 l 56-bit RC2 l 112-bit RC2 l 128-bit RC2 l 168-bit 3DES l 128-bit RC4 l 128-bit AES l 192-bit AES l 256-bit AES Higher levels of encryption require slightly more CPU.exe extension and LiteSpeed will create X. but generally the impact of 256-bit AES encryption on a backup running on a modern server is very low at less than 0. A Double Click Restore is an executable that has an . An executable file allows you to restore a backup on a server instance that does not have LiteSpeed installed.exe extension.smaller backup file. a backup cannot be restored or recovered without the original encryption key. We recommend for best security of a backup that 256-bit AES be used when encryption is needed. or by inserting the loader directly into the header of a suitable LiteSpeed backup file. If the backup file size is less than 4 GB. This mode is designed for databases where a smaller backup is desired but managing how long the backup takes to complete is important as well. If the backup file is larger than 4 GB. the empty Double Click Restore loader that restores the backup when double-clicked. Double Click Restore Naming Conventions Double Click Restore conversion may modify the extension of the backup file. take care not to lose the encryption key. LiteSpeed disk backups can be directly converted to Double Click Restore executables. which applies to it a specially designed algorithm. For LiteSpeed backups.5 or later. effectively obfuscating its content by making it different from the original.exe extension and performs a database restore when double-clicked. then the backup file name will not have the .exe). Caution: When encrypting data. the first file will be the executable (. Enterprise license. the Windows 2000 High Encryption Pack must be installed.5% CPU utilization. If you convert a striped backup file. Double Click Restore Executables LiteSpeed executables can be created for Native SQL Server and LiteSpeed disk backups. file name conversion depends on the backup file size. LiteSpeed for SQL Server 8. A Double Click Restore executable is created by either writing a loader program designed to restore backup files. Repeat for all other files.For native SQL Server backups. LiteSpeed will create the empty Double Click Restore loader that has the .. you may need to re-enter the encryption password.exe X* X X* (No name changes) LiteSpeed (>4GB) Native SQL Server * —X. You can locate it in the same directory as the converted X. Run exec xp_slsCreateDCR @FileName='<path>' where <path> is the path to the backup. Define which backup files are needed for the restore and convert them to the Double Click Restore executables. LiteSpeed for SQL Server 8. Supply --doubleclick 1 when creating a backup using command-line interface. Create Double Click Restore Executables To create a new Double Click Restore executable. 2.exe X. NOTE: If you deselected and selected appended backups to restore. you need to copy both the converted backup file and the empty Double Click Restore loader. Do one of the following: l l Right-click a backup in the Backup Browser tab or in the Backup History tab and select Convert to Double Click Restore backup. do one of the following: l l l Select the Create a Double Click Restore executable.exe (No name changes) X X. Supply @doubleclick = 1 when creating a backup using procedures.exe X* X X* (No name changes) X.exe extension and restores the backup when double-clicked. Log on to the server.1 User Guide 74 . Copy the Double Click Restore executable(s) you created to the server that does not have LiteSpeed.exe is created as empty Double Click Restore loader. Scenario You need to restore particular compressed and encrypted LiteSpeed backups on a server that does not have LiteSpeed To restore LiteSpeed backups on a server that does not have LiteSpeed 1. 3. option when creating backups in the LiteSpeed UI Console.exe X. Backup Type Name Before Conversion Name After Conversion LiteSpeed (<4GB) X. See LiteSpeed Command-Line Arguments on page 113 for more information. NOTE: If a backup file is more than 4 GB. double-click the first Double Click Restore Executable file to restore and complete the LiteSpeed Double Click Restore dialog. See xp_backup_database on page 174 for more information.. If LiteSpeed fails to write a backup during a backup operation or fails to read a backup during a restore operation. l File/FileGroup backups l File/FileGroup differential backups l Partial backups l Partial differential backups l Files that have the filesystem archive bit set (if that option is selected) NOTE: Fast Compression does not raise errors if it detects a missing backup from a backup set that was removed via the cleanup process. the backup or restore operation continues without interruption. it will wait and retry the failed operation. It removes full and differential backup files and optionally transaction log backups based on a user-defined period.Network Resilience LiteSpeed's read and write resilience can handle various failures on both network and attached storage devices. 2. SmartCleanup is backup set aware and will never remove a full backup that is needed by a differential backup that is not being deleted. See LiteSpeed Command-Line Arguments on page 113 for more information. LiteSpeed for SQL Server 8.1 User Guide 75 . For example. You can control the number of times to retry and the amount of time to wait before retrying. To configure retry options from the command line » Use -X or --IOFlags parameter. Select one or both network resilience options to change the default values. See About Using Extended Stored Procedures on page 172 for more information. Complete the wizard. if there are mixed backups in the same backup file. The full backup. these operations would fail immediately on the first read or write problem encountered. Access advanced options. if a user performs a backup of AdventureWorks and Pubs into the same mybackups. if there are associated differential or t-log backups in the backup set that are not eligible for cleanup. If successful on a subsequent attempt. Without network resilience.bak backup file. The backup retention will never delete: l l The backup files. SmartCleanup SmartCleanup provides a convenient way to remove old LiteSpeed backups. in which case it will allow deletions. 3. To configure retry options in wizards 1. LiteSpeed will ignore copyonly backups except on secondary replicas in AlwaysOn Availability groups. To configure retry options in procedures » Use @IOFLAG parameter. See xp_slsSmartCleanup on page 317 for more information.The diagram below shows how the LiteSpeed components communicate to SQL Server to check if backups are eligible for cleanup and delete them each time SmartCleanup runs. log) Note: Not supported for Fast Compression. LiteSpeed Variables LiteSpeed automatically substitutes variables anywhere you need to specify a backup file name. diff. Open or create the Fast Compression Database task in a maintenance plan. LiteSpeed for SQL Server 8. from the command-line and when using extended stored procedures. See Create Backup Templates on page 46 for more information. Accepted Variables LiteSpeed accepts the following variables: Variable Description %DATABASENAME% or %D Database name %TYPE% or %T Backup type (full. Run the Backup wizard and select the Fast Compression backup type. See About Creating Maintenance Plans on page 80 for more information. Run slsSmartCleanup. To configure SmartCleanup in Wizards l l l Open existing or create a new backup template. or description in the LiteSpeed UI Console.exe with the appropriate arguments from the command-line. comment. To run SmartCleanup manually. do one of the following: l l Use the xp_slsSmartCleanup extended stored procedure. See SmartCleanup Command-Line Arguments on page 137 for more information.1 User Guide 76 . See Back Up Databases on page 53 for more information. ALL variables are supported for both files and folders. @init= 1 . last two digits (00-99) %Y Year %Z Time zone name or abbreviation Examples 1. the number of seconds elapsed since 00:00:00 January 1. @filename='C:\MSSQL\Backup\%D.xp_backup_database @database='MyDB' .dbo. @desc = '%T Backup of %D' LiteSpeed for SQL Server 8. UCT Date and time variables %DATE% Date %TIME% Time (hhmm) %DATETIME% Date and time %a Abbreviated weekday name %A Full weekday name %b Abbreviated month name %B Full month name %d Day of the month (01-31) %H Hour in 24h format (00-23) %I Hour in 12h format (01-12) %j Day of the year (001-366) %m Month as a decimal number %M Minute (00-59) %p AM or PM designation %S Second (00-59) %U Week number with the first Sunday as the first day of week one (0053) %w Weekday as a decimal number with Sunday as 0 (0-6) %W Week number with the first Monday as the first day of week one (0053) %y Year.Variable Description %SERVER% Server name %INSTANCE% Server instance name %DEFAULTDIR% Default backup directory %z Timestamp. @backupname = '%D_%w' . Specify backup destination: \\Storage\Backup\%SERVER%\%DATABASENAME%_%TYPE%_%DATETIME%.1 User Guide 77 . Back up the Northwind database with the specified backup set name and description. 1970. EXEC master.bak 2.BAK' . sqllitespeed.3.1 User Guide 78 .bak from the commandline interface.bak" -W REPLACE LiteSpeed for SQL Server 8.exe -R Database -D Northwind -F "C:\temp\%D. Restore the Northwind database from the backup device c:\temp\Northwind. such as backing up databases. 2. SQL Server 2000 and LiteSpeed 4. Otherwise. Right-click a maintenance plan and select Convert to LiteSpeed. To take advantage of Integration Services (SSIS) in maintenance plans. Select Maintenance Plans in the Navigation pane (CTRL+4). updating statistics. Legacy and SSIS Maintenance Plans In SQL Server 2000. l SQL Server 2005 SSIS components version is lower than 9. including the high-performance compression technology LiteSpeed uses to create backups. In SQL Server 2005 or later.1 User Guide 79 .6 Automate Maintenance Tasks About Automating Maintenance Tasks Maintenance plans help you automate routine database maintenance tasks.3042 (Service Pack 2). LiteSpeed maintenance plans have the extended task set and a larger number of advanced options. maintenance plans create SSIS packages that run as agent jobs. Integration Services may be a part of the Client Tools or a part of SQL Server. Integration Services must be installed on any server instance where you want to create maintenance plans. You need to have LiteSpeed installed on every server instance where you want to create LiteSpeed maintenance plans. To convert a maintenance plan 1. LiteSpeed for SQL Server 8. NOTES: l l Express edition of SQL Server does not support maintenance plans. LiteSpeed also creates a legacy maintenance plan when: l SSIS components are not installed on server. you can also convert previous LiteSpeed maintenance plans to the latest version. Using this option. These jobs contain a commandline call to the function you want to execute.x maintenance plans are considered legacy plans. maintenance plans create multiple agent jobs as output.00. Native SQL Server and LiteSpeed Maintenance Plans You can manage both native SQL Server and LiteSpeed maintenance plans in the LiteSpeed UI Console. and rebuilding indexes to run on a specific day and time. only native SQL Server functionality is available. This ensures that your databases are stable and perform at optimal levels. Convert to LiteSpeed You can convert native SQL Server maintenance plans to LiteSpeed maintenance plans. Drag tasks to the Design pane to add them to the subplan.About Creating Maintenance Plans Use the Design pane to create a workflow of database maintenance tasks. See Back Up Databases Using Maintenance Plans on page 82 for more information. Any tasks in the subplan must use the same list of databases. or can be dependent on another task's completion before they can begin execution. You cannot have both a Fast Compression Backup task and Back Up Database task added to the same subplan. If you select a different database in a task.1 or later. 2.1 User Guide 80 . Job LiteSpeed for SQL Server 8. Fast Compression Backup Perform full or differential backups using the Fast Compression technology. Reorganize Index Execute Execute an existing SQL Server Agent job. Enterprise license. NOTE: Fast Compression is only available with LiteSpeed 5. Tip: If you need to create several similar plans. To add a duplicate task. create a new subplan and add the task. or transaction log backups.. See Back Up Databases Using Maintenance Plans on page 82 for more information. Double-click a task to specify its properties. To create a maintenance plan 1. Right-click a server instance and select Create New Maintenance Plan in the Maintenance Plan pane. Select Maintenance Plans in the Navigation pane (CTRL+4). 3. See Copy Maintenance Plans on page 88 for more information. You can back up databases on multiple servers by adding a separate backup task to the maintenance plan for each server. with or without encryption. Back Up Database Perform full.. you can simply copy existing plans or subplans and then make the necessary edits. differential. LiteSpeed prompts you to apply the database change to the entire subplan. Check Database Integrity Validate the following: l Disk space allocation l Page and structural integrity for tables and indexed views l Catalog consistency l Contents of indexed views l Service Broker data Defragment and compact existing indexes to improve performance. Tip: For legacy maintenance plans only: l l l You cannot have more than one task of the same type in a subplan. Task Add this task to. You can add additional subplans in a maintenance plan to group related tasks or to schedule tasks to execute at different times. Tasks can execute independent of another task's status. com/en-us/sqlserver/dd939167. Statistics 4. Notify Operator l Any information for deleted databases l Log shipping history l Status history (Job.microsoft. Clean Up Maintenance Plans See Clean Up Maintenance Plans on page 88 for more information. Remove obsolete backup files and reports created by a maintenance plan.Task Add this task to.aspx l http://technet. right-click the constraint line and select Edit. where the Local repository resides. TIP: Variables defined in the maintenance plan can be used to format the Subject Line. and can execute those tasks concurrently or based on the outcome of the previous task. You can use the notification profiles only if they are already configured within a SQL Server instance. Update column and index statistics. Maint Plans) Send an email notification to one or more existing operators.. NOTE: The SQL Server Agent must be configured to send email using Database Mail.microsoft. To use edit the constraint or use an expression to evaluate precedence. Review the following for additional information: Rebuild l http://msdn.. Remove historical data from the msdb database and LiteSpeed Local and Central repositories for the following: Clean Up History l Back up and restore history l SQL Server Agent jobs l Maintenance plans l LiteSpeed activity NOTE: LiteSpeed activity is removed from the Central repository.aspx Drop and recreate an index to improve performance. only if it is located on the same server.1 User Guide 81 . Tips: l l You can add multiple constraints for a single task. (SSIS Plans only) Right-click a task to execute first and select Add Constraint to draw a line to the dependent task. DTS. There is also help information inside the task that lists the available Subject Line variables.com/en-us/library/ms189635. Execute TSQL Update NOTE: SSIS maintenance plans support only the Transact-SQL command type. Index Reduce the size of data and log files in a database that grow beyond a specified size. LiteSpeed for SQL Server 8. Shrink Database Execute statements or batches on one or more databases. and repeat steps 2. except "DellSoftwareCMSS". you can add only one connection for remote logging and you must use Windows Authentication. Note that the plan owner is only responsible for creating and editing plans. Execute T-SQL 5. you can select it from the Connection dropdown list in any task. succeeds. 3 and 4 for additional subplans you want to add. Notify Operator 10. or completes. right-click the plan in the Maintenance Plan pane and select an option. 7. The account that executes packages is the SQL Agent service account (or a proxy account). Click to enter or select a schedule for executing the current subplan. Reporting and Logging Notifications Click to set the reporting and logging options. See About Automating Maintenance Tasks on page 79 for more information. Rebuild Index 4. "Dell" and "LiteSpeed". select it and click on the toolbar in the maintenance plan designer. or delete a maintenance plan. Fast Compression Backup or Back Up Database 8. l To define any connections you want to use for tasks in a maintenance plan. double-click the subplan in the Design pane. You can also define a connection at the task level that applies to other tasks and subplans. native or LiteSpeed). Tips: l l To manually execute. Legacy plan tasks are executed in the following sequence: 1. Once you add a connection. Reorganize Index 7. Shrink Database 5. LiteSpeed for SQL Server 8. For more information. (Optional) Set reporting options. Back Up Databases Using Maintenance Plans NOTE: Backup options may vary depending on the LiteSpeed and SQL Server version and plan type (legacy or SSIS. Clean Up History 2.1 User Guide 82 .NOTE: Constraints are not available for legacy plans. Scenario You need to create a maintenance plan to only back up databases which names start with "C". Click 6. For legacy plans. See Reporting and Logging in Maintenance Plans on page 339 for more information. click . l To disable a subplan. please refer to the "Privilege and Grant Requirements" section of the LiteSpeed Installation Guide. open the plan in the Designpane and select the owner from the dropdown list in the upper-right corner of the pane. Check Database Integrity 3. Update Statistics 6. To change the plan owner. Click to notify an operator of job (subplan) status when a job fails. Clean Up Maintenance Plans 9. edit. l To remove a subplan. Select: use SSL.Click to edit Display name.Click to use the server LiteSpeed for SQL Server 8. Back up database across one or more files This option creates one backup file for all selected databases. Select the following items to edit the Cloud account proxy settings. See LiteSpeed Variables on page 76 for more information. l Import . Access key. secret key. provide multiple backup destinations. LiteSpeed file format The default backup file format uses the following information: l %D—Database name l %T—Backup type (Full. l Delete . Drag the Back Up Database task or the Fast Compression Backup task to the Design pane. Secret key. If you need to create striped backups. If you want LiteSpeed to remember a custom file format and use it for new backup tasks on this instance. If you selected Cloud. Scenario: Select the Databases matching regular expression option. if you want to create separate disk backups for databases. Double-click the task and review the following for additional information: Databases Click to select databases you want to include in and exclude from the maintenance plan. See Use Wildcard and Regular Expressions in LiteSpeed on page 64 for more information. 2.Click to delete the Cloud account from the console. and GovCloud (US) Region. enter the following in the Mask field: ^(?!QuestSoftwareCMSS) (C|Dell|LiteSpeed) and click Add. use server side encryption.Click to add Cloud vendor. and bucket. Diff or Log) l %Y-%m-%d-%H%M%S—Date and time l %EXT%—File extension You can specify a custom backup file format using both the LiteSpeed variables and text.1 User Guide 83 .To configure database backups 1. and GovCloud (US) Region. use server side encryption.Click to export and save a Cloud account in XML format. region. use reduced redundancy storage. l Use LiteSpeed Server proxy settings . Select the following items to edit the registered cloud account settings. NOTE: Fast Compression handles the naming of files automatically.See LiteSpeed's Logic for Backing Up Multiple Databases on page 63 for more information. display name. Create backup file for every database Select this option. modify the format in the LiteSpeed file format field as needed and click Set to Instance. and Bucket. Select: use SSL. See Backup Files and Folders on page 68 for more information. Region.Click to import a saved Cloud account in XML format. use reduced redundancy storage. access key. l l Proxy Settings Add . review the following for additional information: Cloud account Select the Cloud account from the drop-down list. l Export . Edit . This field is not case-sensitive. dsm.) NOTE: This file contains session options such as the TSM server's TCP address. use the Clean Up task. l l Use LiteSpeed Console proxy settings . LiteSpeed will use the default management class. You can also edit the proxy settings from this item.Click to use the console proxy setting. (Usually. the high-level name and the format of the low-level name. review the following for additional information: Client node Enter the node name for the TSM session. Set native Backup compression Select one of the following options: l Use the default server setting l Compress backup l Do not compress backup LiteSpeed for SQL Server 8. If you selected the Backup Database task. If the option Stripe on TSM object and the number of stripes are selected. Tip: To remove obsolete files from different locations. TSM Objects (Regular backups) Click TSM Objects and specify the filespace. you do not need to specify the client node and client owner password. Management class Select the management class (policy) to associate with the backup object being created. TSM Filespaces (Fast Compression backups) This step is optional. Client owner password Enter the access password for the specified node. if this option is not selected.proxy setting. the mask %@ is added by default to the end of the defined file format. You can click TSM Filespaces to select the existing or enter new file space name(s). NOTE: Fast Compression handles the naming of files automatically. the mask %@ can be added by the user to any place of file format. port. 3.1 User Guide 84 .Click to add your own custom proxy address. This is the default selection. review the following: Remove files older than This option only removes files that match the specified extension from the specified destination folder. You can also edit the proxy settings from this item. If you select the Use PASSWORDACCESS GENERATE from TSM configuration file checkbox and your options file is configured to support this option. Specify custom proxy settings . See Clean Up Maintenance Plans on page 88 for more information. Verify backup when finished Select this option to verify that LiteSpeed successfully wrote all backup files and can read them.opt. Configuration file Select the configuration file. If you selected TSM Backup or TSM Archive. See Backup Files and Folders on page 68 for more information. username and password. If the option Stripe on TSM object and the number of stripes are selected. Select the Options page. the larger the differential backups can grow before Fast Compression triggers the next Full backup. It provides the most accurate way to determine the amount of data change. The default is 14 days. Backup Escalation This option causes LiteSpeed to issue a full backup. The larger the threshold. Data change threshold . A differential backup is missing from the backup set (excludes backups automatically removed after the specified retention period). For example. The default is 35%. review the following: Fast Compression Backup Options You can set the following thresholds to define when to issue a full backup: l l Force a full backup every . Select the File extension checkbox to enter or change the backup file name extension. For an existing item that does not have an extension defined.The amount of time elapsed since the last full backup.If you selected the Fast Compression Backup task. Verification and Cleanup Make sure the backup files in the backup set have integrity. LiteSpeed for SQL Server 8. l LSN verification fails in the backup set. Fast Compression will automatically run a size comparison to the last Differential backup. bak. NOTES: l l l Before a differential Fast Compression backup is available. Fast Compression will force a full backup. for new items. when exceeding the maximum interval (in days) between full backups. This provides an added level of insurance the backup files can be restored. NOTE: You can select the backup file extension for Fast Compression and make the new default. The default option is to query actual data pages. NOTE: If a problem is detected and a full backup is created through escalation. Fast Compression measures the amount of data change by either querying SQL Server or by comparing the size of the last differential to the last full backup. l Verify operation fails on full or differential backup. Regardless of how much underlying database data has changed. The copy-only full backups cannot serve as a base for differential backups.1 User Guide 85 . If the query fails for any reason.The amount of database changes since the last full backup. When backing up the master database as part of a Fast Compression maintenance plan or job. The default is set to bkp. set this parameter to 20%. bkp is displayed when the item is edited (maintenance plans and templates). the last full backup must have been created in the Fast Compression backup or alternate backup folder. and should the database change by 20% or more. Fast Compression always executes a full backup. if one of the following problems is discovered in the current backup set: l l The full backup is missing. an error will be returned. Fast Compression will automatically run a Full backup. Review the following additional information about the encryption and compression options: Adaptive Compression LiteSpeed automatically selects the optimal compression based on throughput and CPU usage and optimize backups either for size or for speed (default). Enterprise license. See Compression Methods on page 71 for more information. The Cleanup options include: l Clean up full/differential backups older than 28 (default) days. Option disabled.aspx 4. l Verify both the last full and latest differential backup. use the Backup Analyzer. l Do not delete if archive bit is set. See Test Optimal Backup Settings on page 43 for more information.5 or later. See Encryption Methods on page 73 for more information. l Clean up transaction logs older than 7 (default) days.1 User Guide 86 .aspx http://technet. Notification Send an email notification to one or more existing operators.microsoft. Select the LiteSpeed page. For assistance determining the best compression options. There is also help information inside the task that lists the available Subject Line variables.com/enus/sqlserver/dd939167. NOTE: The SQL Server Agent must be configured to send email using Database Mail. TIP: Variables defined in the maintenance plan can be used to format the Subject Line. l Clean up transaction log backup not scheduled. if selected. but they also take longer to complete. A verification failure after a differential backup will trigger the backup escalation process. select the encryption level and enter the encryption password. Review the following for additional information: l l http://msdn. you can configure cleanup of transaction log backups in the Fast Compression Backup task. The Verification options include: l Do not verify backup (default). Encrypt backup Select this checkbox to encrypt the backup. optionally. You can use the notification profiles only if they are already configured within a SQL Server instance. NOTE: Adaptive Compression is only available with LiteSpeed 6. l Verify the last full and all associated differential backups. See SmartCleanup on page 75 for more information.microsoft.Verification failures appear in the LiteSpeed UI Console and. LiteSpeed for SQL Server 8. Compression level Select 0 for no compression or 1-8 (default 2) to compress the file. l Verify last backup. Specify the cleanup options. NOTE: Higher compression levels result in smaller backup files. as job failure notifications.com/en-us/library/ms189635. NOTE: While transaction log backups can be automated within a separate Back Up Database task. Then. The maximum allowed setting is 1000 retries. The default is 1048576. Optimize the Object Level Recovery speed Select to create an index of objects in the backup file. it is recommended that you limit the threading as well. The default is n-1 threads. where n is the number of CPU cores. Tips: l l Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. which allows LiteSpeed to use all available system processors. You may also want to consider using Adaptive Compression to maintain backup performance. This option is only available for LiteSpeed backups.lsm file. See Processor Affinity on page 30 for more information. During the backup process the . The default is 100.194.Review the following additional information about the advanced options: Throttle Enter the maximum percentage of CPU that LiteSpeed can use for the process. Number of threads Enter the number of threads used for the backup. Verify backup when finished Select to run a backup verification after the backup has finished running. Network Resilience If LiteSpeed fails to write disk backups or reads from disk. NOTE: Before you can recover objects or execute a SELECT statement. try limiting the number of threads. Wait period before each retry attempt (in seconds)—The default period to wait before retry is 15 seconds The maximum allowed setting is 300 seconds.1 User Guide 87 . You should only modify advanced options after careful planning and testing. Review the following additional information about the verification and recovery options: Backup expires Select to set the transaction log expiration. The default is set by SQL Server.304 bytes (4 MB). See Adaptive Compression on page 72 for more information. Processor affinity Click to select which processors LiteSpeed can use. . LiteSpeed for SQL Server 8. If you decide to use an affinity value other than default. Max transfer size Enter the maximum backup file size in bytes. The default is 0. The index is an . The expiration can be set to expire after a selected amount of days or on a particular day. Priority Select the priority of the backup over other transactions or processes running on the same server. The default is Normal. you must read the backup file to create an index of restorable objects. See Configure LiteSpeed Defaults on page 29 for more information. it waits and retries the operation. l l Number of times to retry any given read/write attempt—The default is 4 retries. You can enable and disable and control the number of times to retry and the amount of time to wait before retrying. See Network Resilience on page 75 for more information. Buffer count Enter the number of SQL Server buffers available for a LiteSpeed operation. NOTE: LiteSpeed defaults typically result in the best performance.lsm file is created in the temp directory and attached to the backup file after the backup is completed. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. The default is enabled. Additionally. which makes the object level recovery process much faster. Copy Maintenance Plans To set up similar plans. See Double Click Restore Executables on page 73 for more information.If you select this option. NOTE: A Double Click Restore can only be created for a disk file. you can control the response to an error. LiteSpeed for SQL Server 8.1 User Guide 88 . you do not necessarily have to start from scratch. If you select the Continue on error option. Continue on error Select this option to continue running the backup even if an invalid checksum is encountered. Clean Up Maintenance Plans Use this task to remove obsolete backup files and maintenance plan reports. Copy Only Backup Select this option to enable copy-only backups. LiteSpeed uses the index in the backup file to read the backup file. Create a plan and copy it to any server instances where you want the plan to run. Select the sub option to rewind if you choose to have the tape rewound before unloading it. Create a Double Click Restore executable Select to create an executable backup file or a Double Click Restore Loader that allows you to restore a backup on a server instance that does not have LiteSpeed installed. File extension Enter the extension of the files you want to remove. Delete specific file Select this option to delete a specific file. Unload the tape after backup Select to unload the tape after the backup is finished running. NOTE: This option is for tape backups only. Drag the Clean Up Maintenance Plans task to the Design pane. 2. Double-click the task and review the following for additional information: Delete files of the following types Select the type of files to clean up: l Backup files (disk and cloud) l Maintenance plan text reports l Any files File location Select the location of the files you want to delete. Perform checksum before writing to media Select to verify checksums when a backup is created. the backup is executed despite encountering an invalid backup checksum. To clean up maintenance plan data 1. Include all subfolders Select this option to include all subfolders when searching for files to remove. Search folder and delete files based on extension Select this option to remove any files with a specific file extension. right-click a maintenance plan you want to copy and select Copy Maintenance Plan. select a maintenance plan you want to export and click the Export Plan button on the toolbar. 4. To export a sublan. 3. . To copy a maintenance plan 1. you cannot have more than one Backup task in a subplan.mps file that relates to the subplan you want to import. if the source and target servers have: l Different SQL Server versions—You may need to review and edit the selected databases list. multiple Backup Database and Fast Compression (SmartDiff) Backup tasks are not copied due to the difference between the SSIS and legacy plans. right-click the SQL Server instance from where you want to import the plan and select Tasks|Import Maintenance Plan.mpp file that relates to the maintenance plan you want to import. To import a plan. Also. NOTE: The file extension is .LiteSpeed versions on the source and the target are different. in the Design pane select a subplan you want to export and click The file extension is . Different LiteSpeed versions and different SQL Server versions—See Back Up Databases Using Maintenance Plans on page 82 for more information. NOTE: 2. 2. Right-click the instance where you want to paste the plan and select Paste Maintenance Plan.LiteSpeed versions and database lists are different. To export or import a maintenance plan 1. To copy a subplan 1. when copying a subplan between SQL Server 2005 (or higher) and SQL Server 2000. . 3. . Select the . Select a subplan and click on the Design pane toolbar to add a new subplan.NOTE: Copying and importing plans and subplans between servers may require additional manual steps.1 User Guide 89 . but database lists are the same.mpp. To import a subplan. You may want to create a new subplan and add a backup task to this subplan. LiteSpeed for SQL Server 8. .mps. Click 4. In the Server tree. 2. 2. Select the . This step is optional. To export a plan. select a subplan and click to copy. Open a new or existing maintenance plan in the Design pane. (Optional) Click on the Design pane toolbar to add a new subplan. . l l Different LiteSpeed versions—Some options may be lost if they are not supported by the previous LiteSpeed version. For legacy plans. In the Design pane. 5. Select a subplan and click to paste. open a new or existing maintenance plan in the Design pane. To export or import a subplan 1.LiteSpeed version is the same but the database list is different (warning indicates that some databases do not exist). See Back Up Databases Using Maintenance Plans on page 82 for more information. 3. Select Maintenance Plans in the Navigation pane (CTRL+4). 4. You are going to create a maintenance plan on one SQL Server instance and then simply copy it to the other server instances.Automate Similar Backup Tasks on Multiple Instances Scenario You need to schedule full. NOTE: This scenario describes how to back up all user databases. c. 5. Specify when the full backups are eligible for cleanup according to your company’s retention policy. Click on the tool bar. 7. 3. Click Ok to save the task. The task you just created will serve as a base for differential and tlog backups.1 User Guide 90 . then Ok. Save the plan. To automate backups on server instances 1. click 6. Double-click every subplan in the plan. you can configure maintenance plans to back up system databases and databases matching wildcard or regular expressions. Click and select User databases (excluding master. Enter the name and description. 2. For example. differential and t-log database backups on several servers and automate backup cleanup according to your company’s retention policy. Drag and drop the Back Up Database task in the middle of the Design pane and double-click it. Specify when the differential and t-log backups are eligible for cleanup according to your company’s retention policy. Configure the copied subplan tasks to create the differential and t-log backups instead of full backups. Select the Full backup type. l Full backups occurring every week l Differential backups occurring every day l T-log backups occurring every 20 minutes When you are done editing the subplan properties. Click to set schedule properties. b. select Enabled and click Ok. 9. Similarly. b. 8. Select each of the two new subplans and click . a. To create a subplan. click Copy Plan. a. to paste. Select the Create backup file for every database option and specify the Destination folder and file extension for the backups. msdb). In the Server tree. right-click an instance and select Create New Maintenance Plan. Select the Options tab and select the Remove files older than option. Each subplan should have its own reoccurring schedule. model. Create two new subplans. LiteSpeed for SQL Server 8. LiteSpeed for SQL Server 8. For all instances where you want to paste the plan.10.1 User Guide 91 . right-click the instance and select Paste Maintenance Plan. see http://msdn.7 Restore Databases Restore Databases Using the Restore Wizard The Restore wizard guides you through the process of restoring a database (full or differential).aspx. data files. click one of the following. files and filegroups. NOTES: l l For information about performing file restores.1 User Guide 92 . Tip: Database backups created with LiteSpeed Version 8. 2.microsoft. transaction log. LiteSpeed for SQL Server 8. and finish. scheduled restore. and transaction log restore types use the restore wizard pages listed in the steps below: restore destination. backup source. For a description of restoring file and filegroup backups in SQL Server. Copy the backup files needed for restore to another server and run the Restore wizard. select a database to restore and click the Restore or Automated Restore button. TIP: The attached files type uses the restore wizard pages listed in the steps below: restore destination. To run the Restore wizard 1. recovery options. see http://support. Scenario You need to restore a LiteSpeed disk backup to a new database on another SQL Server. execute script. In the Navigation pane. backup source. l Transaction Log—Restore transaction log only. TIP: The database (full or differential). Select the Backup Manager pane (CTRL+1). review the automated restore information below.x cannot be restored using older versions of LiteSpeed. backup content. l Attached Files—Restore attached files only. or filegroups. backup content. Alternately you can right-click a database and select Restore or Automated Restore from the menu. attached files. data files. l Files and Filegroups—Restore files and filegroups only. files. and finish.com/kb/281122. l Database (full or differential)—Restore database only.com/enus/library/ms190710. If you clicked Restore.microsoft. scheduled restore. execute script. If you clicked Automated Restore. Click to add Cloud vendor. For example: %SOURCESERVER%_%DATABASENAME%. When running restores from multiple servers. No user connections can exist when performing a database restore. review the following for additional information: Cloud account Select the Cloud account from the drop-down list. restore options. backup files. Access key. 3. you can select the View current activity link to view the database connection activity table. You can still select another database to restore here using the drop down selector instead of using the database originally selected.Click to export and save a Cloud account in XML format. the variable %SOURCESERVER% adds the source server name (server+instance) to the target database name when running multiple automated restores. and Tape.1 User Guide 93 . use reduced redundancy storage. TSM Archive. If you select this option. l Use LiteSpeed Server proxy settings . and finish.l Automated Restore—Restore the most recent full backup and optionally differential and transaction log backups. the options are Disk.Click to delete the Cloud account from the console. Select the following items to edit the registered cloud account settings. use server side encryption. l l l l l Proxy Settings Add . use reduced redundancy storage. 4. database integrity database files. select Database to restore from a specific database's backup history. the Restore wizard creates an Automated Restore job. A database cannot be restored unless the restore process has exclusive access to the database. Scenario: Select Device and then Disk and specify the backup files you copied. Select the following items to edit the Cloud account proxy settings. Export . the database you are restoring is displayed. and GovCloud (US) Region. Cloud. and bucket. Region. Backup files can be restored immediately or restored in the background. we recommend that you use the %DATABASENAME% variable to automatically generate an original database name for database(s) going to be restored. Review information on the Restore Destination page. display name. If you select Database. Edit . scheduled restore. On the Backup Source page. Import . backup source.When running restores for multiple databases. If you selected Cloud. execute script. TIP: The automated restore type uses the restore wizard pages listed in the steps below: restore destination. Select: use SSL. use server side encryption. secret key. different databases with the same server name can be overwritten. and Bucket. Select the Kill all current connections before restore checkbox to obtain exclusive access to the selected database. and GovCloud (US) Region. This is the default selection. notification.Click to edit Display name. Scenario: Select the server instance to restore the backup to and enter a new database name. CAUTION: Multi-Database Restores . TSM Backup. or select Device to manually select files to restore. If you select Device. Additionally. To prevent this. Delete .Click to import a saved Cloud account in XML format. region. access key.Click to use the server proxy setting. Secret key. You LiteSpeed for SQL Server 8. Select: use SSL. If you select the Use PASSWORDACCESS GENERATE from TSM configuration file checkbox and your options file is configured to support this option. dsm. If you selected TSM Backup or TSM Archive. l l Use LiteSpeed Console proxy settings . port.) NOTE: This file contains session options such as the TSM server's TCP address. Latest backup search method Select one of the following options: l l Folder scan—LiteSpeed will search the specified folder for the most recent database backups.g. Select User databases and all subordinate user databases are automatically selected. If you selected Automated Restore. For AlwaysOn availability groups. To specify a secondary SQL Server. double-click the objects you would like to select.can also edit the proxy settings from this item. Querying all levels may take longer to complete. SQL-PROD\AG2) in the Source list (Server column). Individually select and deselect databases using the checkbox next to it. SQL-PROD\AG1. Specific backup file name—You can use this option to automate restore operations if the same file gets overwritten during the backup or if new backups are always appended to the same file. You can configure LiteSpeed to search subfolders and filter backups using the specified file extensions. Configuration file Select the configuration file. Restore from Select SQL Server and databases to specify the source from where to search the backups for automated restore. Client owner password Enter the access password for the specified node. username and password. TIP: Use the drop-down treeview to add multiple sources from the System and User parent nodes.Click to add your own custom proxy address. Specify custom proxy settings . review the following for additional information: Client node Enter the node name for the TSM session. NOTES: LiteSpeed for SQL Server 8. You can also edit the proxy settings from this item. This field is not case-sensitive. NOTE: If you leave the High level and Low level fields blank. From the Available TSM Objects list.opt. (Usually. LiteSpeed will query all TSM server levels. Enter the filespace and the high-level and low-level names and click Query TSM to pick the object name from the list of available TSM objects. review the following for additional information. use the semicolumn as a separator between SQL Servers (e.1 User Guide 94 . TSM Object Click Select TSM Object. you do not need to specify the client node and client owner password.Click to use the console proxy setting. you may need to specify both SQL Server (primary and secondary) to allow LiteSpeed to search backups among all replicas. Use locks instead of using an internal database snapshot. Select one of the following options: l l l l Full—The most recent full database backup. 5. This option is selected by default. Do not include informational messages in notification report (NO_INFOMSGS). This option is selected by default. Specify backup types to use for the restore. If you selected Automated Restore. Remove Select and remove the backup file location from the list. Full. Add Add the backup file location to restore to the list by selecting and using the Backup File Location wizard. This option is selected by default. You can enter several backup extensions per path.1 User Guide 95 . If you selected Automated Restore. on the Restore Options page. 6. you can specify multiple locations/filenames. differential and transaction logs—The most recent full database backup and any existing differential and/or transaction log backups created after the most recent full backup. Do not perform intensive checks of nonclustered indexes for user tables. Separate them with commas or semicolons. Drop databases after restore Use this option if you no longer need the restored database. Check database integrity after restore (DBCC_CHECKDB) Use this option to run a CHECKDB on the restored database and report the results to the repository for review. This option contains two additional options to select. XML indexes and spatial indexes (EXTENDED_LOGICAL_CHECKS). One or both options can be selected. For example. on the Database Integrity. Select a combination of the following database integrity options: l l l l l l Check physical structure only (PHYSICAL_ONLY).l l Backup type If restoring a striped backup. on the Backup Files page. Check the database for column values that are not valid or out-of-range (DATA_PURITY). LiteSpeed for SQL Server 8. if you are only restoring the latest backup for testing purposes.This option is selected by default. Include copy only backups—Select the Include copy only backups checkbox to add copy only backups in the restore. Full and differential—The most recent full database backup and any existing differential backups based on this full. Perform logical consistency checks on indexed views. specify options for automated restore. If you selected Automated Restore. select the backup file locations to search. Restore from Select the restore from location (disk or cloud) using the drop down menu. 7. define the options to check database integrity after restore. Review the following additional information about the Backup Content page. The table includes backup name. Yellow triangle indicates warning that full backup was not successful. Click the ellipsis to launch a window containing a list of backups to restore.The database is dropped after failing the restore or database integrity check. l Red text indicates there was a problem with the backup.1 User Guide 96 . IntelliRestore Select to have LiteSpeed automatically select the backups needed to restore the database successfully. Green down partial arrow indicates successful differential backup. Include databases that are part of a replication plan Use this option to include databases that are part of a replication plan. l On failure any of restore or check databases integrity operations . size. l Check mark indicates a selected backup. b. NOTE: Automated Restore requires that you use the same password for all encrypted backups. First backup to recover a. destination. expiration. Verify backups Select to verify the backup file integrity before completing the wizard. and copy only. 8. Password Provide a password for encrypted backups. Skip this page for Automated Restore.On success restore and check database integrity operations The database is dropped after a successful restore or database integrity check. database. server. user. Select database backup Select the database that you want to restore. l l l Green down arrow indicates successful full backup. finish date. LiteSpeed for SQL Server 8. Select server instance Select the server that contains the backup you want to restore. encrypted. Scroll down the list and select a backup. begin date. Expanding the plus might show however that a differential backup was successful. l Overwrite the existing database Use this option if you want to overwrite the existing database with the restored database. The backup to recover table is populated with a list of backups. position. See the partial table below. type. Skip this page for Automated Restore. you can restore a user database into an NTFS compressed folder or restore a tlog to a read-only database in a compressed folder. When selected. it is recommended that you use locations generated by LiteSpeed. LiteSpeed will create it as NTFS compressed. The default is not selected. LiteSpeed for SQL Server 8. Undo committed transactions and save the undo actions in a standby file (RECOVER WITH STANDBY). On the Recovery Options page. This option is available only for tapes. You can only use this feature on Windows NTFS file systems. The default is not selected. l Select to leave the database in read-only mode. The default is selected. Eject tapes (if any) after restoring each backup Select this option if you would like to eject any tapes after restoring each backup. If restoring database (full or differential). Specify a compressed folder for the data files by editing the Restore As paths. the default listed standby file can be used. Preserve the replication settings Select to preserve the replication settings for the restored database. The default is not selected. If a folder does not exist. select the database recovery state following the restore. NOTES: l l l When using an NTFS-compressed folder for a database. including secondary data files locations. Restore as compressed.1 User Guide 97 . Recovery state The options are as follows: Select to leave the database in an operational state (RESTORE WITH RECOVERY). the following links can be selected (not available for Automated Restore): l l Keep original database locationn—Click to display in the table below the original database locations. Use SQL Server instance default locations—Click to display in the table below the SQL Server instance default locations. it can only be restored as read-only. l 10. Restrict access to the restored database Select to restrict access to the database after it is restored. The default is not selected. Review the following additional information about the Data Files page: Prompt before restoring each backup Select this option if you would like to receive a prompt notification before restoring each backup. Restore the database files as Although you can manually enter DATA and LOG locations.9. read-only database Using this option. Overwrite the existing database Select to have the current database overwritten with the restored database. The default is not selected. The default is not selected. NTFS compression of read-only databases is not supported in SQL Server 2000. The default is not selected. l Select to leave the database in a non-operational state and allow restoration of additional transaction logs (RESTORE WITH NORECOVERY). Or select the ellipsis button to browse and select another standby file. 13. The default is selected.l Select new location—Click to launch the Database Files Destination window and select a new database output file location. l l Processor affinity Logging level Folders for log files—To enter a new location for all LOG files. If it succeeds. Custom locations for data and log files—To use DATA and LOG directories of the database which backup you are restoring. You can enable and disable and control the number of times to retry and the amount of time to wait before retrying. The maximum allowed setting is 1000 retries. Verbose—LiteSpeed writes a log file for the backup or restore operation. If the source and target locations do not match or if they are set to other than the default. The default is 0. l l Number of times to retry any given read/write attempt—The default is 4 retries. You can specify the notification of failure options that are sent after each restore. schedule type. Click the ellipsis button to browse and select other folders for log files. Click to select which processors LiteSpeed can use. Select one of the following: LiteSpeed for SQL Server 8. Run in background. and description. Select one of the following options: l l l Network resilience Folder for data files—To enter a new location for all DATA files. 12. Wait period before each retry attempt (in seconds)—The default period to wait before retry is 15 seconds The maximum allowed setting is 300 seconds. If LiteSpeed fails to write disk backups or reads from disk. Review the following information about the Notification page. Click the ellipsis button to browse and select other folders for data files. Run immediately.1 User Guide 98 . Log file is removed on success—LiteSpeed only saves log files if the backup or restore operation fails. 11. LiteSpeed you can select one of the following options in Automated Restore: l l Use SQL Server instance default locations—To use DATA and LOG directories of the existing database you are restoring the backup to. add. select the Restore Attached Files and Directories on the Attached Files page. None—LiteSpeed does not write a log file for the backup or restore operation. See Network Resilience on page 75 for more information. LiteSpeed does not save the log. delete. duration. which allows LiteSpeed to use all available system processors. or Schedule (Custom Schedule for Automated Restore. Select Weekly on (for Automated Restore only). occurs. it waits and retries the operation. Review the following information about the Schedule Restore page. The default is not selected. Selecting Schedule launches a page for adding the schedule name. If you added an attachment to the backup file. Verbose. daily frequency. weekly. and rename files. You can browse the network. Use this argument to list all backup files except the executable being run: l The filename of the backup if there is a Double Click Restore loader created for this backup l The filenames of any other stripes that were not converted to an executable NOTE: The syntax is exactly the same as that for sqllitespeed. Notify every time—Notify for all successes and failures. command-line interface or procedures. There is also help information inside the task that lists the available Subject Line variables.exe is the name of the Double Click Restore executable. Click the ellipsis button on the far right to create new or edit existing operators. do one of the following: l l Double-click the Double Click Restore executable and complete the LiteSpeed Double Click Restore dialog.l l l Do not use notification—All failure notifications (including operator selections) are disabled. You can supply multiple instances of this argument. Click the ellipsis button on the far right to create new or edit existing operators. Review the following for additional information: l http://msdn. Complete the wizard.com/en-us/sqlserver/dd939167.com/en-us/library/ms189635. TIP: Variables defined in the maintenance plan can be used to format the Subject Line. l The root of C:\—On a server that does not have LiteSpeed installed.aspx 14. An operator can be selected and configured to receive notifications. Run the command line. Failure only—Notify for failure only.1 User Guide 99 .exe -R database -F backup_file -W replace where backup. Manually Restore a Master Database To restore the master database from a LiteSpeed backup.microsoft. Restore Double Click Restore Executables To restore a Double Click Restore executable. NOTE: If logging is enabled during a restore. change the directory until you are in the directory containing the Double Click Restore executable and run the following: backup. the log file is written to: l The default output directory—See Configure Logging in LiteSpeed on page 336 for more information. start the server instance in single-user mode and execute the LiteSpeed restore statement. backup_file specifies the path to the file containing backup data. l Restore as any other backup using the Restore Wizard. See LiteSpeed Command-Line Arguments on page 113 for more information. An operator can be selected and configured to receive notifications. NOTE: The SQL Server Agent must be configured to send email using Database Mail.aspx l http://technet.exe. LiteSpeed for SQL Server 8.microsoft. Execute the LiteSpeed restore statement to restore a full database backup of master.exe –R"Database" -D"master" F"c:\backup\master. Usually: C:\Program Files\Microsoft SQL Server\MSSQL\Binn 2. You cannot restore master database backups which were made on SQL Server version 7.opt" 5.exe –R"Database" -D"master" F"c:\backup\master. change the directory until you are in the directory containing sqlservr.1 User Guide 100 .bak" –W"REPLACE" -S "<server name>" -T Restore a master to the named instance sqllitespeed. Restart SQL Server and LiteSpeed.exe -c –m"LiteSpeed" –s"<instance name>" NOTE: You must switch to the appropriate directory (for the instance of Microsoft SQL Server you want to start) in the command window before starting sqlservr. Using another command prompt.exe –R"Database" -D"master" F"c:\backup\master. stop the following services and retry them: l Alerter l Cluster l Computer Browser LiteSpeed for SQL Server 8.bak" -Kpassword –W"REPLACE" -S "<server name>\<instance name>" –T -W"MOVE 'master' TO 'C:\Program Files\Microsoft SQL Server\MSSQL.exe.exe.exe.0 or earlier. From a command prompt. Example Script Restore a master database to the default instance sqllitespeed. Run the following to start the server instance in single-user mode: sqlservr.mdf'" -W"MOVE 'master_log' TO 'C:\Program Files\Microsoft SQL Server\MSSQL.bak" -Kpassword –W"REPLACE" -S "<server name>\<instance name>" –T Restore with replace sqllitespeed. 3.bak" –W"REPLACE" -S "<server name>\<instance name>" –T Restore with encryption sqllitespeed. SQLLiteSpeed.exe -c –m"LiteSpeed" For named instance: sqlservr.ldf'" Restore using the Tivoli Storage Manager sqllitespeed. If the process hangs.To manually restore a master database 1. run as administrator.exe –R"Database" -D"master" – W"REPLACE -i"filespace\highlevel\lowlevel" c"nodename" -k"password" -j"c:\program files\Tivoli\TSM\baclient\dsm.exe -R"Database" -D"master" -F "<path to backup file\backup file name>" -W"REPLACE" -S "<server name>\<instance name>" –T NOTE: The master database can only be restored from a backup created on an instance of SQL Server 2000 and newer. change the directory until you are in the directory containing SQLLiteSpeed. Usually: C:\Program Files\Dell\LiteSpeed\SQL Server\Engine 4.exe –R"Database" -D"master" F"c:\backup\master.1\MSSQL\Data\master.1\MSSQL\Data\master_Log. SQL Server 2012: http://technet. LiteSpeed for SQL Server 8.microsoft.l Event Log l License Logging l Logical Disk Manager l Messenger l Net Logon l NTLM Security Support Provider l Plug and Play l Remote Procedure Call (RPC) Locator l Remote Procedure Call (RPC) l Server l Print Spooler l TCP/IP NetBIOS Helper l Windows Time l Workstation NOTE: To restore the master database from a native full backup.microsoft.1 User Guide 101 .com. For example. refer to msdn.com/en-us/library/ms190679(v=sql.aspx.110). l Restore objects from the backup files. and when running the Object Level Recovery Wizard and the Recover Table Wizard. the Optimize Object Level Recovery speed option on the Backup wizard Options page is selected by default to create the index during the backup. you can select to bypass tail log processing. Object Level Recovery does not support SQL Server 2008 Transparent Data Encryption (TDE).In scenarios when you do not require any transaction log backups and the tail log. Objects are recovered as they existed at the time they were backed up. You can enable and disable the use of direct mode from the the Recover Table Wizard. You can also restore objects in the command-line or using extended stored procedures. To prevent this. l Query backups. you must read the backup file to create an index of restorable objects. You can: l View backup contents and preview table data.lsm file is created in the temp directory and attached to the backup file after the backup is completed. Object Level Recovery operations may work much faster in this case. you can enable direct mode which significantly improves deployment and configuration of your applications. Direct mode . NOTES: l l l l l l l You cannot restore objects from Clouds. During the backup process the . often with little response in the LiteSpeed UI Console. You cannot recover data to a random point in time. See Execute SELECT Statements on page 106 for more information.8 Restore Objects LiteSpeed helps you restore specific objects from a native or LiteSpeed backup file. You cannot restore objects directly from TSM files or tape backups.1 User Guide 102 . LiteSpeed may take a long time to read the backup file for large databases. The index is an . See Object Level Restores from TSM Backups on page 105 for more information. Tail log processing . LiteSpeed for SQL Server 8. You can enable and disable bypass tail log processing from the toolbar. NOTE: Object Level Recovery is only available with the Enterprise license.In scenarios where you want the application to work with SQL Server directly using a TCP/IP connection without involving the SQL Server client. See the following for more information: l Restore Objects with the Command-Line Interface l Recover Objects from Backups using the extended stored procedures Restore Objects in the LiteSpeed UI Console Before you can recover objects or execute a SELECT statement.lsm file. You can also click Remove or Content to remove the file or view file contents. click Next. delete. 7. select Database to restore from a specific database's backup history. On the Backup Content page. Review the Backup File Contents After you read the backup file. On the Welcome page click Next. On the Select Backup Files page. Object Level Recovery operations may work faster.1 User Guide 103 . 4. Select the Object Level Recovery pane (CTRL+3). its contents appear in the Overview tab. and rename folders. 5. Select Object Level Recovery Wizard. 9. locate and select the backup file to read. The Backukp File Location window is displayed. view the script that will run to retrieve the backup content. 2. NOTE: LiteSpeed must be installed on the server instance you select on the Specify Recover Destination page. On the Specify Backup Source. 10. add. click Add. 6. 8.Select to bypass tail log processing.To read the backup files 1. the file path and file name are displayed. Click OK. Selecting Content displays a window showing file general properties and file backup sets properties. On the Preview Script page. On the Specify Recovery Destination page. select a backup to recover and click Next. Bypass tail log processing . TIP: Only disk backups are supported for OLR. 3. On the Backup File Location window. Complete the wizard. You can browse the network. select the server instance. If you selected Disk. or select Disk to manually select files to restore. Click Next. Once selected. LiteSpeed for SQL Server 8. right-click a column header and select the appropriate options. Table Data Preview The table data preview displays the contents of the table. click the Type column header and then SHIFT+click the Name column header.The Overview tab has the following panes: 1. right-click the table in the objects grid and select Preview Data. 2. group. print. To sort records against multiple columns. Tips: For panes that have grids. Objects Grid The grid displays all of the restorable objects in backup file. To preview a table's data. A table that you preview and script has a small chart and scroll icon beside it. copy. and scripted objects have a small scroll icon beside them in the objects grid. You can filter the objects that appear in the list by selecting the appropriate options in the toolbar.1 User Guide 104 . click the Select Scripted button in the Object Level Recovery ribbon menu. indexes. 3. You can script more than one object. but you cannot edit or execute it in the script preview pane. you can sort. move. and search the script in LiteSpeed. and the previewed table has a small chart icon beside it in the objects grid. click column headers while holding the SHIFT key. NOTE: You can save. to sort by type and then by name. LiteSpeed for SQL Server 8. For tables. You can only preview the data of one table at a time. To script an object. and triggers in the script by selecting the appropriate options on the Object Level Recovery tab in Options. and remove the columns: l l To sort and group the records. Script Preview The script preview displays the DDL script. For example. To view all of the scripts in the script preview. you can also include constraints. right-click it in the objects grid and select Generate DDL Script. Restore objects from the converted or native backup files using the Object Level Recovery tool. This tool is fully backward compatible. (Usually. NOTE: You can specify the default temp directory using the TempPath parameter in the [LiteSpeed] section of the LiteSpeedSettings. Review the following for additional information: Database Temporary directory LiteSpeed will not overwrite an existing table. C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\LiteSpeedSettings. right-click a column header and select Column Chooser. you must use a different table name. This option stores the object at the directory but does not restore it. using the extractor tool. Extract a TSM backup to disk as a native uncompressed backup. NOTE: To be able to extract TSM backups you need the Extractor tool delivered with LiteSpeed 5. See Recast LiteSpeed Backups on page 156 for more information. To move a column. This option associates the restored object with the filegroup. Filegroup Select the filegroup.2 or higher. 2. 2.ini file. Select a table in the objects grid and click Recover Table. Enter the path or click to navigate to it. Add a column by dragging it from the list into the column headers. Do one of the following: l l Convert a TSM backup to LiteSpeed disk backup. Tips: l CTRL-click objects in the grid to select multiple objects for recovery. To restore tables 1. drag the column header to the new location. See Convert LiteSpeed Backups to SQL Server Backups on page 163 for more information. LiteSpeed for SQL Server 8.1 User Guide 105 .l l To add or remove columns. Restore Tables and Schemas Restoring a table in the LiteSpeed UI Console restores the table's schema and data. l To restore the table schema only. To work around this issue 1. If you select the same server instance and database as the original table. Complete the wizard. because TSM does not allow for randomly accessing the data. select a table in the objects grid and click Recover Schema.ini. This option restores the table and is generally used when the default directory does not have enough free disk space.) Ship directory Enter the path or click to navigate to it. Remove a column by dragging its column header into the list. Object Level Restores from TSM Backups You cannot do object level restores directly from a TSM backup. and rename folders. NOTE: LiteSpeed must be installed on the server instance you select on the Specify Recover Destination page. On the Specify Recovery Destination page.1 User Guide 106 . and when running the Object Level Recovery Wizard and the Recover Table Wizard. select Database to restore from a specific database's backup history. click Next. NOTES: l l l l l l l You cannot restore objects from Clouds. Click OK.lsm file is created in the temp directory and attached to the backup file after the backup is completed. On the Specify Backup Source. You cannot recover data to a random point in time. select a backup to recover and click Next.In scenarios when you do not require any transaction log backups and the tail log. click Add. LiteSpeed for SQL Server 8.Select to bypass tail log processing. Once selected. LiteSpeed may take a long time to read the backup file for large databases.Execute SELECT Statements Before you can recover objects or execute a SELECT statement. or select Disk to manually select files to restore. 7. To read the backup files 1. See Object Level Restores from TSM Backups on page 105 for more information. To prevent this. the file path and file name are displayed.lsm file. you can select to bypass tail log processing. select the server instance. The Backukp File Location window is displayed. If you selected Disk. Objects are recovered as they existed at the time they were backed up. you must read the backup file to create an index of restorable objects. the Optimize Object Level Recovery speed option on the Backup wizard Options page is selected by default to create the index during the backup. TIP: Only disk backups are supported for OLR. On the Select Backup Files page. 2. add. You can enable and disable bypass tail log processing from the toolbar. Select Object Level Recovery Wizard. Select the Object Level Recovery pane (CTRL+3). You cannot restore objects directly from TSM files or tape backups. you can enable direct mode which significantly improves deployment and configuration of your applications. On the Welcome page click Next. 4. Object Level Recovery operations may work much faster in this case. Object Level Recovery does not support SQL Server 2008 Transparent Data Encryption (TDE). Direct mode . You can enable and disable the use of direct mode from the the Recover Table Wizard. delete. Tail log processing .In scenarios where you want the application to work with SQL Server directly using a TCP/IP connection without involving the SQL Server client. You can browse the network. Bypass tail log processing . You can also click Remove or Content to remove the file or view file contents. On the Backup Content page. During the backup process the . 6. Object Level Recovery operations may work faster. 8. locate and select the backup file to read. The index is an . 3. On the Backup File Location window. 5. often with little response in the LiteSpeed UI Console. Selecting Content displays a window showing file general properties and file backup sets properties. 3. Click Execute.. NOTE: Be sure to use fully qualified names when you write a select statement. 2. Enter the statement. view the script that will run to retrieve the backup content. In addition. Supported SELECT Statements LiteSpeed only supports a small subset of the possible T-SQL SELECT statements. To execute a SELECT statement 1... it does not support computed columns and OUTER JOIN. 10. <table_source> | <select_source> JOIN <table_source> ON <search_condition> | <select_source> INNER JOIN <table_source> ON <search_condition> <table_source> ::= table | table alias | table AS alias <search_condition> ::= { [ NOT ] <predicate> | ( <search_condition> ) } [ { AND | OR } [ NOT ] { <predicate> | ( <search_condition> ) } ][.n] <predicate> ::= <expression> { = | > | < | >= | <= | <> | !< | != | !> } <expression> | expression [ NOT ] LIKE string_constant [ ESCAPE 'escape_char' ] | expression [ NOT ] BETWEEN expression AND expression | expression [ NOT ] IN (expression [. Click Next.1 User Guide 107 ... Complete the wizard. <select_item> <select_item> ::= column | column_wild | column alias | alias = column <select_source> ::= <table_source> | <select_source> .9. Select the Script Execution tab. On the Preview Script page..n]) | expression IS [ NOT ] NULL <expression> ::= constant | column <offset_fetch> ::= { OFFSET { integer_constant | offset_row_count_expression } { ROW | ROWS } [ FETCH { FIRST | NEXT } {integer_constant | fetch_row_count_expression } { ROW | ROWS } ONLY ] } LiteSpeed for SQL Server 8. LiteSpeed supports the following syntax to execute SELECT statements against a backup file: SELECT [ TOP <expression> ] <select_list> FROM <select_source> [ WHERE <search_condition> ] [ <offset_fetch> ] <select_list> ::= <select_item> | <select_list> . Examples SELECT * FROM LiteSpeedActivity OFFSET 0 ROWS FETCH NEXT 10 ROWS ONLY SELECT TOP 10 * FROM LiteSpeedActivity WHERE DatabaseID = 6 LiteSpeed for SQL Server 8.1 User Guide 108 . Databases Server instance Lists all of the server instance's databases with their state. restore. including activity type and status. Depending on what tree level and tab you select. subcategory. last 4 hours. server group. check database. server instance. You can right click on any instance and select: view in timeline. properties. and LiteSpeed jobs. the amount of disk space you save. duration. restore. verify. or select dates from a calendar. backup analyzer. and backup destination. Source—Select the type of backups to display. multi-database backup. You can view the backup activity and history by selecting the Backup Manager Server Tools Ribbon. such as all. warning. and activity.1 User Guide 109 . LiteSpeed or native SQL Server backups. display backup/restore jobs. recovery model. Windows domain or SQL Server account that was used to initiate the backup or restore operation. success. last hour. Tab Name Available Level Overview All Description Displays information about the backup volume savings. Information about a category. you can view statistics on processes that fail or succeed. Select as a group: backup. and check database. last 48 hours. and failed jobs. verify. failure. last week. You can view information about different dates by changing the Period field or select the dates from a calendar. Report type—Select the type of activity to display. last 72 hours. You can right click on any instance and select backup. and additional information. a list of all of the jobs for a server instance or database. and re-execute backup. and in progress. or all of your server instances by selecting the appropriate level in the tree. assign categories (available in some cases). last 2 weeks. compression ratio. DTS packages. last 8 hours. Status—View total instance status including all. and more. restore. last 24 hours. You can change the parameters in the following fields: l l l l Period—Select the time span. LiteSpeed Activity All Displays all activity for the selected parameters. automated restore. Tips: LiteSpeed for SQL Server 8. database. refresh. device. Individually select: backup. backup throughput (uncompressed backup size to backup duration ratio). successful jobs. and last month.9 View Activity and History View Backup Manager Activity and History The LiteSpeed UI Console provides information about your backup processes in the Backup Manager tabs. maintenance plans. The options are all. view details. including native SQL LiteSpeed for SQL Server 8. Note that the Re-execute Backup. Right-click anywhere in the timeline to navigate to a date. view content. backup template. and convert to native backup. You can select different job types in the Jobs filter field. Backup Browser Server instance Displays backup directories and current backup files. the tab also displays a timeline of activity. You can restore the backup file or begin object level recovery from the files listed in the tab. The template deployment history is not exported when you export a template. convert to double click restore backup. view the template contents. backup history. change the time scale. Backup Templates All Displays the LiteSpeed Backup templates stored in the central repository.. To view information about the native SQL Server backups and restores in the LiteSpeed UI Console. deploy or remove a template when the central repository is not used. If you selected a database or server instance in the navigation pane. The timeline displays backups and restores from the past and those scheduled to occur in the future. clone. NOTES: l l Backup History Database The Backup Templates tab is only available.. You can hover over an item for additional information about it. authentication method. click beside Backup Templates on the toolbar and select the appropriate option. LiteSpeed version. deployment details and modification history. if the central repository is configured and selected for use. you can create. LiteSpeed Jobs Server instance and Database Lists all scheduled jobs. and number of databases.. and is enabled only for backups that were executed by using t-sql. You can also add directories. and backup analyzer information is provided in the following table. right-click the activity and select Re-execute Backup. You can edit the script if needed and run it immediately as a SQL Agent job or run it in the background. See Create Backup Templates on page 46 for more information. edit.. enable jobs.Tab Name Available Level Description l l To re-execute any successful or failed (and fast compression) backup. delete directories. run the Instance Configuration wizard from the start menu and configure the local repository to be updated via a SQL Server job. Right click a job to select the options: change schedule. delete. Lists all backups with their date and destination. To edit. menu item is only visible for LiteSpeed backups. import. If the LiteSpeed backup was executed using the command-line then the menu is disabled. SQL Server version. Tab Name Available Level Description List Server group Lists the instances in the server group with their display name. In the Backup Templates tab. disable jobs.1 User Guide 110 . export and deploy templates. stop. or set a default directory. Further list. After expending a directory and making a backup visible. and view in job manager. you can right click on the backup and select restore. or rotate the name of the databases. start. To add or remove columns. Backup Analyzer Database Analyzes different settings. click column headers while holding the SHIFT key.1 User Guide 111 . click the Type column header and then SHIFT+click the Name column header. and remove the columns: l l l l l To sort and group the records. Maintenance Plans Lists all maintenance plans for the server instance. You can view information about different dates by changing the Period field or clicking select the dates from a calendar. to NOTE: To view execution history of every task in a subplan. owner. you can sort. Select a group. Tips: For panes that have grids. successful jobs. You can view information about different dates by changing the Period field or select the dates from a calendar. drag the column header to the new location. creation date. For example. right-click a column header and select Column Chooser. You can group server instances in the navigation pane tree based on their category or server group. group. See Test Optimal Backup Settings on page 43 for more information. After you refine the report criteria. the tab has a timeline that displays the activity for the selected parameters by their date. and failed jobs. View Maintenance Plans Activity and History You can view information about the current state of existing maintenance plans and their execution history (CTRL+4). To sort records against multiple columns. striping. to determine which settings have the best compression and duration values. and backup destinations. At a maintenance plan level—Displays maintenance plan latest status. Design Create and edit maintenance plans. you can print the results or export them to Excel. move. such as compression level.Available Level Tab Name Description Server backups performed through LiteSpeed. Add a column by dragging it from the list into the column headers. and last run date. to sort by type and then by name. See Change Server Instance Grouping Methods on page 28 for more information. instance. or maintenance plan in the tree view to display the following tabs: Tab Overview Description l l At a group and instance level—Displays information about the backup volume savings. To move a column. Remove a column by dragging its column header into the list. right-click a column header and select the appropriate options. configure extended logging. Categories are similar to server groups. In addition. name. History Displays execution history of the maintenance plans for the server instance. See Reporting and Logging in Maintenance Plans on page 339 for more information. but they offer different features. The list also includes backups that have been replaced. LiteSpeed for SQL Server 8. LiteSpeed for SQL Server 8.NOTE: If you receive a message that the server does not exist or access is denied. make sure the instance is registered and connected.1 User Guide 112 . NOTES: l l l You must run commands on the server instance on which you want to perform activity. See SmartCleanup Command-Line Arguments on page 137 for more information. See Restore Objects with the Command-Line Interface on page 165 for more information.1 User Guide 113 . You must run the utility on the LiteSpeed for SQL Server 8. See Fast Compression Command-Line Arguments on page 129 for more information. SQLLiteSpeed Perform backup/restore tasks.exe) allows you to conduct LiteSpeed backups and restores directly from your operating system command-line. See Convert LiteSpeed Backups to SQL Server Backups on page 163 for more information. Review the Syntax sections to see which arguments are mandatory. See LicenseInfoCmd Utility on page 171 for more information. Review the Arguments sections for more information about the arguments and accepted values. See Recast LiteSpeed Backups on page 156 for more information.. Mutually exclusive arguments are separated by a vertical bar. SLSSmartCleanup Delete old backups. SLSFastCompression Back up a database using Fast Compression technology. Extractor Convert LiteSpeed backups to the native SQL Server backups.. which are optional. See Script Maintenance Plans Tasks on page 141 for more information. If you want to. Round brackets are used to group arguments. and which are mutually exclusive. Use.10 Use Command-Line Interface About Using the Command-Line Interface LiteSpeed allows you to perform various tasks directly from the command-line interface (CLI).. 2.. LicenseInfoCmd View currently installed license or to register a new key. OLR Restore database objects. See LiteSpeed Command-Line Arguments on page 113 for more information. SLSSQLMaint Perform various database maintenance tasks. Optional arguments are enclosed in square brackets. Run a LiteSpeed utility with appropriate arguments. To perform tasks using the CLI 1.exe or sqllitespeedx32. LiteSpeed Command-Line Arguments The LiteSpeed command-line utility (sqllitespeed. SLSRecast Change backup options for the existing LiteSpeed backups. Change the directory until you are in the directory containing the LiteSpeed command-line utility (Usually. C:\Program Files\Dell\LiteSpeed\SQL Server\Engine). .server that you are backing up or restoring.. Syntax sqllitespeed..1 User Guide 114 .exe ( -? | <options> ) Connection Options: -S <server_name\instance_name> (-U <login_id> -P <password> ) | -T Backup Options: -B <option> [--nowrite] [-D <database_name>] [-f <file_name>] [-g <filegroup_name>] -F <backup_device_name> [-n <backup_set_name>] [-d <backup_description>] [-Y <comment> ] [-E <mirror_path>] [-I] [-N <file_number>] [-W <options>] [--AdaptiveCompression (Speed|Size) | -C <compression_level> ] [-e <encryption_level> (-K <password>|--JobP <key>)] [-y <date_time> | -r <number_of_days>] [-s ] [--doubleclick] [--OLRMap [--TempDirectory <path>]] [--attachedfile <path_or_file>] [-X <options>] [-h 1..100] [-o <buffer_count>] [-x < maximum_transfer_size>] [-t <number_of_threads>] [-p (-1|0|1|2)] [--LSECompatible ] [-L (0|1|2) [--Trace logpath = "path"]] [--Verify] Restore Options: -R <restore_option> -F <backup_device_name> -D <destination_database_name> [-N <file_number>] [-f <file_name>] [-g <filegroup_name>] [--Read_Write_Filegroups] [-K <password>| --JobP <key>] [-W STATS = <number>] [-W PASSWORD = "<media_password>"] [-A <affinity_mask>] [-h 1.100] [-o <buffer_count>] [-x <maximum_transfer_size>] [-X <options>] [--RestoreAsReadOnly [--RestoreAsCompressed ]] [--attachedfile <path_or_file>] [-L (0|1|2) [--Trace logpath = "path"]] LiteSpeed for SQL Server 8. You may need to use sqllitespeedx32.exe if you have a 32-bit SQL Server on a 64-bit operating system. This argument accepts one of LiteSpeed for SQL Server 8... they must be preceded by double dashes '--'.1 User Guide 115 . You can tell Adaptive Compression to optimize backups either for size or for speed.Automated Restore Options: -R Automated [-D <destination_database_name> [--DataFilePath <path> ] [--LogFilePath <path> ] ] -F <backup_filename> | (--BackupPath <path> --BackupExtension <extensions> --CheckSubfolders (0|1) ) [--BackupType <option> ] --SourceServer <server_name> --SourceDatabase <database_name> [-K <password> | --JobP <key>] [-W "STATS = <number>"] [-W "PASSWORD = '<my_password>'"] [--WithReplace (0|1)] [-A <affinity_mask>] [-h 1. See Compression Methods on page 71 for more information. -Argument --Argument Description (none) --AdaptiveCompression Automatically selects the optimal compression level based on CPU usage or Disk IO. Verbose multi-letter arguments are not case-sensitive.100] [-o <buffer_count>] [-x <maximum_transfer_size>] [-X <options>] [--RestoreAsReadOnly [--RestoreAsCompressed ]] [-L (0|1|2) [--Trace logpath = "path"]] [--DryRun (0|1)] [--DropDatabaseOnFailure (0|1)] [--DropDatabaseOnSuccess (0|1)] TSM Connection Options: -j <TSM_configuration_file> -i < TSM_object> [-c <TSM_client_node> ] [-k <TSM_client_owner_password>] [-l <TSM_filespace>] [-q <TSM_query>] [-a delete] [-z <TSM_management_class>] [--tsmpointtime yyyy-mm-dd hh:mm:ss] [--tsmarchive] Tape Arguments: [-m (0|1|2|3)] [-w] [-u] Arguments NOTES: l l Single-letter arguments are case-sensitive. and they can be preceded by a figure dash '-' or '/'. If it is a directory. When used within the context of a restore operation. 3. See Adaptive Compression on page 72 for more information. Review the following for additional information: Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 3 11 1 and 2 7 111 1. The filepath can be either a single file or a directory. and 6 205 11001101 1. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process.-Argument --Argument Description the following values: -A --Affinity l Size l Speed Processor affinity designates specific processors to run LiteSpeed. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. 2 and 3 38 100110 2. The result is binary 100110. 3. while not allowing LiteSpeed to run on the remaining processors. and Double Click Restore as well. try limiting the number of threads. If you decide to use an affinity value other than default. third. 4. NOTE: 32-bit Windows is internally limited to a 32-bit mask. You may also want to consider using Adaptive Compression to maintain backup performance. 7. and sixth bits to 1 and all other bits to 0. 3. it is recommended that you limit the threading as well. If a value begins with "0x" it is interpreted as hexadecimal. This form will take the syntax of <file_ LiteSpeed for SQL Server 8. then LiteSpeed recursively includes all files and subdirectories. Number the bits from the right to left. All attached files are encrypted and compressed. For example. This argument accepts decimal values and hexadecimal values. (none) --AttachedFile Specifies filepaths to include in both backup and restore operations. and 6 for use with LiteSpeed. TSM. which is decimal 38 or hexadecimal 0x26. You can supply multiple instances of this argument. the path parameter can be expanded to include a new destination. Set the second.1 User Guide 116 . This feature works for disk. The rightmost bit represents the first processor. tape. you need to select processors 2. with all pertinent backup parameters supported. separated with commas. For TSM backups and TSM archives. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. -d --BackupDescription Specifies a description to store with the backup. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low> This argument accepts variables. No value or asterisk (*) specifies any file extension. c: to c:\testadSattsm is allowed). -n --BackupName Specifies the name of the backup set. This argument accepts variables.g. This argument accepts one of the following values: l Database—Back up database l Log—Back up transaction log (none) --BackupExtension When looking for database backups. LiteSpeed will only consider backup files that have the extensions you specify. c:\testad to testadr would restore all files in directory c:\testad to c:\testadr. just the files that were attached to that backup. This argument accepts network destinations. -F --BackupFile The name of the LiteSpeed backup device file to be extracted. See LiteSpeed Variables on page 76 for more information. It does not restore the database. You can supply multiple instances of this argument. restoring. extracting or reading from files with multiple appended backups. -N --BackupIndex Specifies the particular backup to use when recasting. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. The value of this parameter is a list of extensions. This argument only restores the attached files. NOTES: l l The original entire directory path need not be supplied (e.1 User Guide 117 . LiteSpeed for SQL Server 8.-Argument --Argument Description path> to <new_file_path>. See LiteSpeed Variables on page 76 for more information. The new filepath can be used to specify a new location but cannot rename a file. Examples: UNC Path: \\servername\share\path\filename Local path: c:\filedirectory\filename For TSM backups and TSM archives. -B --Backup Backup operation. See Test Optimal Backup Settings on page 43 for more information. You should only modify advanced options after careful planning and testing. LiteSpeed will only use backups located in the specified folder. LiteSpeed will look for backups in the specified folder and in its subfolders. Each instance of this parameter must be followed by -BackupExtension and --CheckSubfolders arguments. diff—LiteSpeed will restore the most recent full database backup and any existing differential backups based on this full. Specifies the number of SQL Server buffers available for a LiteSpeed operation. LiteSpeed will not error out and will select and use Adaptive Compression. 0 bypasses the compression routines. -C --CompressionLevel Specifies the compression level for the backup. See LiteSpeed Variables on page 76 for more information. (none) --BackupPath Specifies the directory where to search for the backup files. The default value is set by SQL Server. 2 is the default value. This argument accepts variables. See LiteSpeed Variables on page 76 for more information. This argument accepts one of the following values: l l -Y --Comment 0—False. (none) --CheckSubfolders Specifies whether to use subfolders to look for database backups. 1—True. When choosing a compression level. Appends a user comment to the backup. Valid values are 0 through 8.-Argument --Argument Description This argument accepts variables. tlog—LiteSpeed will restore the most recent full database backup and any existing differential and/or transaction log backups created after the most recent full backup. NOTE: If both the compression level and Adaptive Compression option are passed in. LiteSpeed for SQL Server 8. The remaining values of 1 through 8 specify compression with increasingly aggressive computation. Use the Backup Analyzer to test the performance of different compression levels. NOTE: LiteSpeed defaults typically result in the best performance. (none) --BackupType Specifies backup types to use for the restore.1 User Guide 118 . You can supply multiple instances of this argument. This argument accepts one of the following values: l l l -o --BufferCount full—LiteSpeed will only restore the most recent full database backup. it is best to try various options using your equipment and data to determine the best option for your environment. This option contains two additional options to select. Works in conjunction with the Key (K) parameter. One or both options can be selected.The database is dropped after failing the restore or database integrity check.On failure any of restore or check databases integrity operations . This argument accepts one of the following values: l 0—False (default) l 1—True Drops database on success only. This argument accepts one of the following values: l 0—False (default) l 1—True (none) --EncBackupKey Encrypts the specified key.The database is dropped after a successful restore or database integrity check.The database is dropped after failing the restore or database integrity check. If a backup is a native SQL Server backup or it is larger than 4 GB. This argument accepts one of the following values: l l 1—Converts a LiteSpeed backup to a Double Click Restore executable. it creates a Double Click Restore loader in the same location.On success restore and check database integrity operations . The encrypted key is suitable for use with -jobp in a backup operation. if you are only restoring the latest backup for testing purposes.-Argument --Argument Description -D --Database Name of database to be backed up or restored.1 User Guide 119 . (none) --DoubleClick Creates a Double Click Restore executable. (none) --DataFilePath Specifies a location for data files. This argument accepts one of the following values: l 0—40-bit RC2 l 1—56 bit RC2 LiteSpeed for SQL Server 8. if the size of the backup is less than 4GB. One or both options can be selected.On failure any of restore or check databases integrity operations . if you are only restoring the latest backup for testing purposes. 2—Creates a Double Click Restore loader in the same location. This option contains two additional options to select. For example. (none) (none) --DropDatabaseOnFailure --DropDatabaseOnSuccess Drops the restored database only if the restore fails. See Double Click Restore Executables on page 73 for more information. For example. (none) --EncRestoreKey Encrypts the specified key.On success restore and check database integrity operations The database is dropped after a successful restore or database integrity check. -e --EncryptionLevel Specifies encryption level. Use this option if you no longer need the restored database. Use this option if you no longer need the restored database. The encrypted key is suitable for use with -jobp in a restore operation. The default is 4 retries. -g --FileGroup Specifies a database filegroup to include in the backup or restore. the restore will fail. You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. LiteSpeed will not overwrite this file until expiration datetime is passed. If you use the wrong encryption key. then the program will not encrypt the backup. (none) --JobP Specifies an encrypted key. NOTE: Automated Restore requires that you use the same password for all encrypted backups. the maximum allowed setting is 300. -K --Key Value used to generate the encryption key for the encryption algorithm. NOTE: This functionality is only available for disk operations. If you do not supply encryption key. This argument accepts one of the following formats: l yyyy-mm-dd l yyyy-mm-dd hh:mm:ss -f --File Specifies a logical database file used for file or filegroup backups.1 User Guide 120 . DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. You can supply multiple instances of this argument. LiteSpeed for SQL Server 8.-Argument -y --Argument --Expiration Description l 2—112 bit RC2 l 3—128 bit RC2 l 4—168 bit 3DES l 5—128 bit RC4 l 6—128 bit AES l 7—192 bit AES l 8—256 bit AES Specifies the date and time when the backup expires. 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. See Network Resilience on page 75 for more information. Files in a filegroup backup can be restored individually or as a group. (Similar to -K). The default is 15 seconds. -X --IOFlags Specifies if LiteSpeed should wait and retry the read or write operation on failure. You can supply multiple instances of this argument. the maximum allowed setting is 1000. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. -E --Mirror Mirrors the backup file (copies the backup to multiple locations). performance may be degraded. This argument accepts one of the following values: l 0—False (default) l 1—True -x --MaxTransferSize Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. it is not written to disk.-Argument --Argument Description Caution: When encrypting data. To log to a different directory run this utility with the following argument: --trace logpath = "path".1 User Guide 121 . striping model. The parameter can be used whenever a new backup file is created and should only be set when backups are needed for crosscompatibility between the products. This argument accepts variables. The parameter is ignored when appending to a backup file created without the switch. take care not to lose the encryption key. This switch will force modifications to internal settings such as the thread count. (none) --LSECompatible Produces a backup that is compatible for use with LiteSpeed Engine for SQL Server. all mirrored backups must match the primary in the number of stripes in each mirror. -Z --NoWrite The argument is similar to backup log xxx to disk = 'NUL'. 2 or any even value—Logging on. This argument accepts one of the following values: l l l 0—Logging off. When the backup is completed. See LiteSpeed Variables on page 76 for more information. -L --LogLevel Creates a log file. The MSDB LiteSpeed for SQL Server 8. NOTES: l You need to supply a filename (-F). Log file is removed on success. (none) --LogFilePath Specifies a location for log files. 1 or any odd value—Logging on. The default is 1048576 (1 MB).194. See Configure Logging in LiteSpeed on page 336 for more information. In some cases. Example of key: 'Mypassword' NOTE: Automated Restore requires that you use the same password for all encrypted backups. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. If you back up the primary to a set of striped files.304 bytes (4 MB). and encryption levels. a backup cannot be restored or recovered without the original encryption key. -R --Restore Restore operation. Required if the connection type is not a trusted connection. which includes the primary filegroup and any read-write secondary filegroups. l VerifyOnly—Verify backup. Automated—Restore the most recent full backup and optionally differential and transaction log backups. l Database—Restore database backup. this will create the TSM object and version the backup based on the retention policy. -P --Password Specifies the user password. l CheckSumOnly—Checksum a backup file.This argument accepts one of the following values: l AttachedFilesOnly —Restore attached files without restoring the database. LiteSpeed for SQL Server 8. -r --RetainDays Specifies a number of days to retain the backup. This argument accepts one of the following values: l 0—False (default) l 1—True -I --Overwrite Re-initializes (overwrites and replaces) the target backup files.1 User Guide 122 . l (none) --OLRMap If compression or encryption parameters are specified. but the file will not get created and no IO is performed. This argument accepts one of the following values: l -1—Below Normal l 0—Normal (Default) l 1—AboveNormal l 2—High (none) --Read_Write_Filegroups Specifies a partial backup. l CheckPassword—Check password/key. LiteSpeed will not overwrite this file for this number of days. -p --Priority Specifies the priority of the LiteSpeed process compared to other processes running on the same server. then the data will get compressed or encrypted before being thrown away.-Argument --Argument Description history tables are updated with the filename specified. For TSM backups. Generates a map file during a backup for Object Level Recovery. l Log—Restore log backup. l HeaderOnly—Provide backup details. l FileListOnly—Provide database file details. Passwords are case-sensitive. l l AttachedFileNamesOnly—List names of all attached files. (none) --SourceServer Backups created on this instance of SQL Server are the source for restore.-Argument --Argument Description (none) --RestoreAsCompressed Works in conjunction with --RestoreAsReadOnly. you can restore a user database into an NTFS compressed folder or restore a tlog to a read-only database in a compressed folder. This argument accepts one of the following values: l server_name l server_name\instance_name If no server is specified. it can only be restored as read-only.1 User Guide 123 . This argument only applies to tape backups. l 0—False (default) l 1—True (none) --SourceDatabase Backups of this database are the source for restore. and then compresses it. This argument accepts one of the following values: (none) --RestoreAsReadOnly l 0—False (default) l 1—True Instructs the restore operation to leave the database in read-only mode. NTFS compression of read-only databases is not supported in SQL Server 2000. -m --TapeFormat Initializes the media on the device. NOTES: l l l -S --Server When using an NTFS-compressed folder for a database. This argument accepts one of the following values: l 0—False (default) l 1—True Using this option. This argument accepts one of the following values: l 0—Do not format (default) l 1—Write new header l 2—Long erase / write new header l 3—Low level controller format / write new header LiteSpeed for SQL Server 8. -s --Skip Skips normal retention checks and overwrites the backup that has not expired. Specifies the instance of Microsoft SQL Server to connect to. the LiteSpeed command-line utility will connect to the default instance of SQL Server on the local computer. -? --ShowHelp Displays the syntax summary of the LiteSpeed commandline utility. creates a folder if it does not exist. You can only use this feature on Windows NTFS file systems. it is recommended that you limit the threading as well. This is the percentage of the total amount of CPU usage (across all enabled processors) available. but the exact value depends on several factors including: processors available. (none) --Verify Performs a restore verification on the backup file just created (if backup was successful). LiteSpeed for SQL Server 8. 2. IO device speed. NOTE: You can specify the default temp directory using the TempPath parameter in the [LiteSpeed] section of the LiteSpeedSettings. not all are available to all drive types) lays down a LiteSpeed tape header that will identify this tape as containing LiteSpeed backups. where n is the number of processors. Use this argument when the default Windows temp directory does not have enough free disk space for the restore process. (Usually. The default is n-1 threads. C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\LiteSpeedSettings. The argument accepts an integer value between 1 and 100. Login IDs are case-sensitive. This argument accepts one of the following values: l 0—Leave the tape unwound (default) l 1—Rewind the tape after writing/reading Applies to tape backups and restores. affinity setting.-Argument --Argument Description NOTE: Any successful format operation (values 1. You may also want to consider using Adaptive Compression to maintain backup performance. Required if the connection type is not a trusted connection. -U --UserId Specifies user login ID. compression level. -h --Throttle Specifies the maximum CPU usage allowed. try limiting the number of threads.) -t --Threads Determines the number of threads used for the backup.ini file. The default value is 100. encryption settings. See Adaptive Compression on page 72 for more information. You will achieve the best results by specifying multiple threads. and SQL Server responsiveness. If you decide to use an affinity value other than default.ini. Using @init=1 (or -I in the command line) will not lay down a tape header.1 User Guide 124 . -w -u --TapeRewind --TapeUnload Applies only to backing up and restoring tape. TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. This argument accepts one of the following values: l l (none) --TempDirectory 0—Keep tape loaded (default) 1—Unload and eject tape from the drive after operation Specifies a temporary directory for use with Object Level Recovery. and 3. MOVE—Specifies that the given logical_file_name should be moved to operating_system_file_name. the database is ready for use. in bytes. 4096. STATS—Displays a message each time a percentage of the activity completes. NO_TRUNCATE—Allows backing up the log in situations where the database is damaged. RESTRICTED_USER—When used in conjunction with recovery (another with param and the default) leaving a usable database. After the recovery process.-Argument --Argument Description -T --WindowsAuth Uses a trusted connection (to the server) instead of requiring a password. CONTINUE_AFTER_ERROR—Causes the backup be executed despite encountering an invalid backup checksum. If you do not want to check the checksums during a restore. or sysadmin roles. Use this option so that all individual log backups since the last full backup do not need to be applied. RECOVERY—Instructs the restore operation to roll back any uncommitted transactions. -W --With Specifies strings that will be passed directly to SQL Server. it is automatically checked. NORECOVERY—Instructs the restore operation to not roll back any uncommitted transactions. COPY_ONLY—Specifies the copy-only backup. LiteSpeed for SQL Server 8. REPLACE—Instructs LiteSpeed to create the specified database and its related files even if another database already exists with the same name. dbcreator. 2048. The existing database is deleted. NOTE: When you restore a backup containing checksum. You can supply multiple instances of this argument.1 User Guide 125 . Some of the accepted parameters are the following: l l l l l l l l l l l l l DIFFERENTIAL—Specifies that the database or file backup should consist only of the portions of the database or file changed since the last full backup. supply 'NO_CHECKSUM' . this restricts access for the restored database to members of the db_ owner. Supported values are: 512. BLOCKSIZE—Specifies the physical block size. KEEP_REPLICATION—Instructs the restore operation to keep the replication settings when restoring a published database to a server other than that on which it was created (used when setting up replication with log shipping). CHECKSUM—Causes checksums to be verified when a LiteSpeed backup is created. A differential backup is usually smaller than a full backup. The default is 10%. 1024. It can be the LiteSpeed for SQL Server 8.1 User Guide 126 . Not required. Some operations may require an administrative user with client owner authority to be specified in order to open a TSM session. See Syntax and Examples for more information. -j --TSMConfigFile Specifies the TSM configuration file.-Argument --Argument Description 8192. --TSMDSMI_Dir DSMI_DIR path if needed. Not required. The correct username and password may be obtained from the TSM administrator. This argument accepts one of the following values: l 0—False (default) l 1—True -c --TSMClientNode Specifies the TSM server LiteSpeed connects to during backups and restores. --TSMArchive Specifies to store the backup as a TSM archive. The existing database is deleted. 32768. if specified in the options file or if backing up with the Passwordaccess Generate option. if specified in the options file or if backing up with the Passwordaccess Generate option. and 65536 (Default). 16384. -Argument (none) --Argument Description --TSMAdminName Specifies the TSM administrative user name that has client authority for the TSM node. l (none) --WithReplace PASSWORD—Specifies the password for the backup set. This argument accepts one of the following values: l 0—False (default) l 1—True TSM-Specific Arguments TSM arguments work in conjunction with the LiteSpeed arguments. --TSMDSMI_Log DSMI_LOG path. -i --TSMFile Defines the TSM filespace. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l tsm_filespace is the logical space on the TSM server that contains a group of files. -k --TSMClientOwnerPwd Specifies the TSM client owner user password. Instructs LiteSpeed to create the specified database and its related files even if another database already exists with the same name. --TSMDeviceTimeoutMinutes Specifies how long to wait for a TSM device. high level and low level. --TSMAdminPwd Specifies the plain text password of the administrative user which is used to log in to the TSM server and start the TSM session. 1.1 User Guide 127 . It can be the drive label name or UNC name. the logical space on the TSM server. You can use the -I commandline argument or @init to back up to a non-unique location. LiteSpeed uses the default management class. (none) --TSMPointInTime Specifies the date for restore/to filter results. l l tsm_high_level specifies the directory path in which the file belongs. Write a database backup where each failure can be retried once after a 30 second wait: sqllitespeed.exe -B Database -D Northwind -F "C:\temp\Northwind. If not specified. The format is yyyy-mm-dd hh:mm:ss. then the most recent of the times must be chosen. tsm_low_level specifies actual name of the file.exe -B Database -T -D Northwind -F "C:\temp\Northwind. Backup the Northwind database.exe -B database -D foo -F c:\test. Create a differential backup of the Northwind database: sqllitespeed.bak" 2. --TSMLogname Log name. log errors (if any) to a specified directory: sqllitespeed. it is recommended that LiteSpeed users follow this practice with a specific file space reserved for LiteSpeed backups.-Argument --Argument Description drive label name or UNC name. You can supply multiple instances of this argument.bak" -L1 --trace logpath="C:\backup_logs" 3.200" k"password" -j"c:\program files\Tivoli\TSM\baclient\dsm.bkp -X disk_retry_count=1 -X disk_retry_wait=30 4. Back up to TSM with the Passwordaccess Generate option: sqllitespeed.bak: sqllitespeed. -z --TSMMgmtClass Specifies the TSM management class.0. LiteSpeed will choose the most recent archived backup. Backup the Northwind database using a trusted connection to the backup device c:\temp\Northwind.exe -Bdatabase -DNorthwind -L1 -i"fsMH\nw\%D" j"C:\TSM\baclient\dsm_pg.opt" -WDIFFERENTIAL -I - LiteSpeed for SQL Server 8. NOTE: IBM recommends that an application client should select a unique file space. NOTE: You may only store one item the location specified by this argument. If it is not passed. NOTE: If the backup was a striped backup and the pointin-times of the various striped files are different (rare but can be different a second or so). It is not possible to append an object to this location.opt" -I -z"SPS_MGTD" -S"MyServer\Inst2" -U"sa" -P"***" 5.exe -Bdatabase -DNorthwind -i"fsMH\nw\%D-%T" -c"10. Examples 1. -l --TSMFileSpace Specifies the TSM file space. Restore the most recent striped backup.txt' to 'C:\CProg.exe -R Automated -D "NEWDB" --DataFilePath "D:\DATA" --LogFilePath "D:\DATA" --BackupPath "D:\temp" --BackupExtension "stripe1" --CheckSubfolders 0 --BackupPath "E:\temp" --BackupExtension "stripe2" --CheckSubfolders 0 -SourceServer "LITESPEED\SQL2005" --SourceDatabase "FOX" --BackupType "full" -S "LITESPEED\SQL2005" -T 12.bak" -N 1 --attachedfile "'C:\temp\CProg—29-Sep-2009 19-22-51233.exe -R Automated -D LiteSpeedLocal_TestRestore --DataFilePath "D:\DATA" --LogFilePath "D:\DATA" --DropDatabase 3 --BackupPath "D:\temp" -BackupExtension "" --CheckSubfolders 0 --SourceServer LITESPEED\SQL2005 -SourceDatabase LiteSpeedLocal --BackupType full -K ****** --WithReplace 1 -DropDatabaseOnFailure 1 --DropDatabaseOnSuccess 1 -S"LITESPEED\SQL2005" -T 9.exe -R Database -D Northwind -F "C:\temp\%D.opt" -i"fsMH\nw\Northwind" -TSMPointInTime "2011-04-12 16:57:22" -N1 -DNorthwind -WREPLACE -A0 -L1 -S"w2k322" -U"sa" -P"***" 7. Restore the most recent full backup and related differential and transaction log backups following this full to a new database.n"Northwind Diff Backup" -d"Differential Backup of Northwind on 4/12/2011 1:50:58 PM" 6.bkp" --CheckSubfolders 1 --SourceServer LITESPEED\SQL2005 --SourceDatabase "LiteSpeedLocal" --BackupType "diff" --DryRun "1" -S "LITESPEED\SQL2005" -T 13. sqllitespeed.1 User Guide 128 .bak" 8.exe -R Automated --DataFilePath "D:\DATA" --LogFilePath "D:\DATA" -BackupPath "D:\temp" --BackupExtension "" --CheckSubfolders 1 -D LiteSpeedLocal_Copy --SourceServer LITESPEED\SQL2005 --SourceDatabase LiteSpeedLocal --BackupType tlog -K ****** -S"LITESPEED\SQL2005" -T 10. View candidates for Automated Restore. sqllitespeed. Restore the most recent Fast Compression backups. Restore the Northwind database from the backup device c:\temp\Northwind.exe -RDatabase -j"C:\TSM\baclient\dsm. Restore the most recent full and drop database: sqllitespeed.exe -R Automated --BackupPath d:\temp\TEST --BackupExtension "bak.exe --EncRestoreKey -K "RF^t%7MF" Returns 0 (success) or 1 (failure) LiteSpeed for SQL Server 8.bak using variables: sqllitespeed.exe -R Automated -D "LiteSpeedLocal_AutomatedRestore" -BackupPath "D:\temp\FC\" --BackupExtension "" --CheckSubfolders 0 -K "*******" --SourceServer "LITESPEED\SQL2005" --SourceDatabase "LiteSpeedLocal" --BackupType "diff" --JobP "5jzOEztgLxQ=" --WithReplace 1 -S "LITESPEED\SQL2005" -U "sa" -P "******" 11. Encrypt a password for the restore operations. sqllitespeed.exe -R attachedfilesonly -F "C:\Program Files\Microsoft SQL Server\MSSQL. Restore the Northwind database: sqllitespeed. sqlLiteSpeed. Restore attached files only: sqllitespeed. sqllitespeed.txt'" -S "spb9771" -T 14.1\MSSQL\Backup\CapacityManagerRepository_Full_200903012353_ 20091006124204. .exe) allows you to conduct full and differential backups directly from your operating system command-line.)] [--SDSearchAlternateBackupDirectory <path>] [--SDMirrorDirectory <path>.Full|All).] [--SDAppendDifferential] FastCompression verify option: [--SDVerify (Full|Last|Last.1 User Guide 129 ...] Accepted LiteSpeed arguments: [-t <number_of_threads>] [-I] [-X <options>] [-N <file_number>] [-A <affinity_mask> ] [-L (0|1|2)] [-W <with_arguments>] [-n < backup_name>] [-d <backup_description>] [-p <priority_level> ] [--AdaptiveCompression (Speed|Size) | -C < compression_level> ] [-e <encryption_level> (-K <encryption_key>| --JobP <encrypted_key>)] [-Y <comment> ] [--attachedfile <path_or_file>] [-h 1.exe ( -? | --ShowHelp | --SDShowSyntax | <FastCompression_backup_options> <options> | <FastCompression_verify_option> <options> | <FastCompression_backup_options> <FastCompression_verify_option> <options> ) FastCompression backup options: --SDBackupDirectory <path> [--SDForceFull |--SDForceDifferential ] --SDExtentsChgRatioRequireFull <value> |--SDDiffToFullRatioRequireFull <value> [--SDCheckForFullBackup] [--SDFullBackupEscalation] [--SDElapsedDaysRequireFull <n>] [--SDSpecificDaysForbidFull (<day>..100] [-o <buffer_count>] [-x <maximum_transfer_size>] Connection options: -D <database_name> -S <server_name> (-U <username> -P <password>) |-T TSM connection options: [ -j <TSM_configuration_file> [-c <TSM_client_node> ] [-k <TSM_client_owner_password>] [--TSMDeviceTimeoutMinutes <minutes>] [-l <TSM_filespace>] LiteSpeed for SQL Server 8... Syntax slsFastCompression...Fast Compression Command-Line Arguments The LiteSpeed command-line utility (SLSFastCompression... This argument accepts one of the following formats: l ".4" l "40%" --SDForceDifferential Forces differential backup. --SDExtentsChgRatioRequireFull Specifies the minimum amount of database changes required for the full backup.4" l "40%" --SDElapsedDaysRequireFull Specifies the minimum number of days since last full backup required to perform full backup. --SDCheckForFullBackup Checks if the expected full backup exists when backing up to separate files and returns a failure message if it is not found. and they can be preceded by a figure dash '-' or '/'. --SDForceFull Forces full backup. the decision to perform a new full or a differential backup will depend on other conditions specified. --SDFullBackupEscalation This option causes LiteSpeed to LiteSpeed for SQL Server 8. Argument Description --SDAppendDifferential Appends data to an existing full backup file. The default value is 14. When exceeding the specified ratio LiteSpeed performs a full backup. it performs a full backup. --SDBackupDirectory Specifies a directory for the backup file. This argument accepts one of the following formats: l ". --SDDiffToFullRatioRequireFull Specifies the last differential backup size to last full backup size ratio.1 User Guide 130 .[-z <TSM_management_class>] ] Arguments NOTES: l l Single-letter arguments are case-sensitive. Verbose multi-letter arguments are not case-sensitive. If the full backup file does exist. they must be preceded by double dashes '--'. If the full backup file does not exist. 1 User Guide 131 . Wednesday. --SDShowSyntax Displays the slsFastCompression syntax. --SDSpecificDaysForbidFull Specifies days of the week when a full backup is never performed. This LiteSpeed for SQL Server 8. and Sunday Performs a restore verification on the backup file just created (if backup was successful). NOTE: If a problem is detected and a full backup is created through escalation. su"—on Monday. Verify operation fails on full or differential backup. This argument accepts one of the following formats: l 3—on Tuesday l "tu"—on Tuesday l l --SDVerify "5-7"—from Thursday to Saturday "m. if one of the following problems is discovered in the current backup set: l l l l The full backup is missing. --SDSearchAlternateBackup Specifies the directory where to search for the backup file. an error will be returned. LSN verification fails in the backup set. A differential backup is missing from the backup set (excludes backups automatically removed after the specified retention period).Argument Description issue a full backup. w. This argument accepts one of the following values: l 0—False (default) l 1—True --SDMirrorDirectory Specifies a directory for a mirror backup. You can supply multiple instances of this argument. For example. third.Argument Description argument accepts one of the following values: l l l l Full—Verifies the last full backup Last—Verifies last backup performed (can be either a full or differential) Full. you need to select processors 2. and sixth bits to 1 and all other bits to 0. Set the second. This argument accepts decimal values and hexadecimal values. The rightmost bit represents the first processor. See Compression Methods on page 71 for more information. --Argument -Argument Description -AdaptiveCompression (none) Automatically selects the optimal compression level based on CPU usage or Disk IO.Last—Verifies the last full backup and last differential is available All—Verifies last full backup and all differentials since Accepted LiteSpeed Arguments The following parameters work in conjunction with the Fast Compression parameters. 3. If a value begins with "0x" it is interpreted as hexadecimal.1 User Guide 132 . See Syntax and Examples for more information. which is decimal 38 or hexadecimal 0x26. You can tell Adaptive Compression to optimize backups either for size or for speed. This argument accepts one of the following values: --Affinity -A l Size l Speed Processor affinity designates specific processors to run LiteSpeed. Review the following for additional information: Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 LiteSpeed for SQL Server 8. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process. Number the bits from the right to left. while not allowing LiteSpeed to run on the remaining processors. NOTE: 32-bit Windows is internally limited to a 32-bit mask. and 6 for use with LiteSpeed. The result is binary 100110. 2 and 3 38 100110 2. See Test Optimal Backup Settings on page 43 for more information. If you decide to use an affinity value other than default. it is recommended that you limit the threading as well. See Adaptive Compression on page 72 for more information. The remaining values of 1 through 8 specify compression with increasingly aggressive computation. 7. it is best to try various options using your equipment and data to determine the best option for your environment. This argument accepts variables. This argument accepts variables. 3. --BackupDescription -d Specifies a description to store with the backup. See LiteSpeed Variables on page 76 for more information. This argument accepts variables. When choosing a compression level. Works in conjunction with the Key (K) parameter. You may also want to consider using Adaptive Compression to maintain backup performance. --CompressionLevel -C Specifies the compression level for the backup. --BackupName -n Specifies the name of the backup set. try limiting the number of threads. LiteSpeed will not error out and will select and use Adaptive Compression. This argument accepts one of the following values: LiteSpeed for SQL Server 8. NOTE: If both the compression level and Adaptive Compression option are passed in. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. 4. See LiteSpeed Variables on page 76 for more information. You can supply multiple instances of this argument. NOTE: LiteSpeed defaults typically result in the best performance.. --BufferCount -o Specifies the number of SQL Server buffers available for a LiteSpeed operation. --AttachedFile (none) Specifies a file or directory (and all nested files and directories) to attach with this backup operation. See Configure LiteSpeed Defaults on page 29 for more information. Valid values are 0 through 8. --EncryptionLevel -e Specifies encryption level. Use the Backup Analyzer to test the performance of different compression levels.1 User Guide 133 . 3. --Comment -Y Appends a user comment to the backup. You should only modify advanced options after careful planning and testing. --Database -D Name of database to be backed up or restored. 0 bypasses the compression routines. and 6 205 11001101 1. 2 is the default value. See LiteSpeed Variables on page 76 for more information.--Argument -Argument Description Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 3 11 1 and 2 7 111 1. The default value is set by SQL Server. You can supply multiple instances of this argument. This argument accepts one of the following values: l 0—Logging off. Caution: When encrypting data. You can supply multiple instances of this argument. Example of key: 'Mypassword' --LogLevel -L Creates a log file. --FileGroup -g Specifies a database filegroup to include in the backup or restore. l 1 or any odd value—Logging on. then the program will not encrypt the backup. --Ioflag -X Specifies if LiteSpeed should wait and retry the read or write operation on failure. --Key -K Value used to generate the encryption key for the encryption algorithm. You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. If you do not supply encryption key.--Argument --Expiration -Argument -y Description l 0—40-bit RC2 l 1—56 bit RC2 l 2—112 bit RC2 l 3—128 bit RC2 l 4—168 bit 3DES l 5—128 bit RC4 l 6—128 bit AES l 7—192 bit AES l 8—256 bit AES Specifies the date and time when the backup expires. The default is 15 seconds. Files in a filegroup backup can be restored individually or as a group. 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. The default is 4 retries. This argument accepts one of the following formats: l yyyy-mm-dd l yyyy-mm-dd hh:mm:ss --File -f Specifies a logical database file used for file or filegroup backups. NOTE: This functionality is only available for disk operations. Log file is removed on LiteSpeed for SQL Server 8. a backup cannot be restored or recovered without the original encryption key. the maximum allowed setting is 1000. the restore will fail. DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. LiteSpeed will not overwrite this file until expiration datetime is passed. take care not to lose the encryption key. the maximum allowed setting is 300. If you use the wrong encryption key.1 User Guide 134 . Passwords are case-sensitive.304 bytes (4 MB). compression level. but the exact value depends on several factors including: processors available. Required if the connection type is not a trusted connection. The argument accepts LiteSpeed for SQL Server 8. l 2 or any even value—Logging on. LiteSpeed will not overwrite this file for this number of days. This argument accepts one of the following values: l -1—Below Normal l 0—Normal (Default) l 1—AboveNormal l 2—High --Read_Write_ Filegroups (none) Specifies a partial backup. The default is n1 threads.--Argument -Argument Description success. the LiteSpeed command-line utility will connect to the default instance of SQL Server on the local computer. --MaxTransferSize -x Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. --Priority -p Specifies the priority of the LiteSpeed process compared to other processes running on the same server. --ShowHelp -? Displays the syntax summary of the LiteSpeed command-line utility.1 User Guide 135 . --Threads -t Determines the number of threads used for the backup.194. This argument accepts one of the following values: l 0—False (default) l 1—True --Password -P Specifies the user password. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. --Server -S Specifies the instance of Microsoft SQL Server to connect to. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. --Throttle -h Specifies the maximum CPU usage allowed. and SQL Server responsiveness. IO device speed. See Configure Logging in LiteSpeed on page 336 for more information. To log to a different directory run this utility with the following argument: -trace logpath = "path". --RetainDays -r Specifies a number of days to retain the backup. encryption settings. where n is the number of processors. You will achieve the best results by specifying multiple threads. which includes the primary filegroup and any read-write secondary filegroups. This argument accepts one of the following values: l server_name l server_name\instance_name If no server is specified. affinity setting. The default is 1048576 (1 MB). --OLRMap (none) Generates a map file during a backup for Object Level Recovery. This is the percentage of the total amount of CPU usage (across all enabled processors) available. If you do not want to check the checksums during a restore. --Verify (none) Performs a restore verification on the backup file just created (if backup was successful). the logical space on the TSM server. --UserId -U Specifies user login ID. Some of the accepted parameters are the following: l l l CHECKSUM—Causes checksums to be verified when a LiteSpeed backup is created. -j --TSMConfigFile Specifies the TSM configuration file. -l --TSMFileSpace Specifies the TSM file space. It can be the drive label name or UNC name. if specified in the options file or if backing up with the Passwordaccess Generate option. Required if the connection type is not a trusted connection. You can supply multiple instances of this argument. it is automatically checked. -Argument --Argument Description -c --TSMClientNode Specifies the TSM server LiteSpeed connects to during backups and restores. (none) --TSMdsmi_log DSMI_LOG path. NOTE: When you restore a backup containing checksum. it is recommended that you limit the threading as well. The default value is 100. -k --TSMClientOwnerPwd Specifies the TSM client owner user password. Login IDs are case-sensitive. CONTINUE_AFTER_ERROR—Causes the backup be executed despite encountering an invalid backup checksum. The default is 10%. Not required.1 User Guide 136 . LiteSpeed for SQL Server 8.--Argument -Argument Description an integer value between 1 and 100. Accepted TSM Command-Line Arguments The following arguments work in conjunction with the Fast Compression arguments and accepted LiteSpeed arguments. See Adaptive Compression on page 72 for more information. STATS—Displays a message each time a percentage of the activity completes. try limiting the number of threads. Not required. If you decide to use an affinity value other than default. (none) --TSMDeviceTimeoutMinutes Specifies how long to wait for a TSM device. See Syntax and Examples for more information. (none) --TSMdsmi-dir DSMI_DIR path if needed. TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. if specified in the options file or if backing up with the Passwordaccess Generate option. --With -W Specifies strings that will be passed directly to SQL Server in the backup/restore SQL. supply 'NO_CHECKSUM' . You may also want to consider using Adaptive Compression to maintain backup performance. 1\MSSQL\Backup" --SDForceFull -D Northwind -S SPB9771 4. SLSFastCompression. SLSFastCompression. -z --TSMMgmtClass Specifies the TSM management class. LiteSpeed for SQL Server 8.exe) allows you to find and remove old full. Back up the Northwind database. Full backup escalation option is on.1\MSSQL\Backup" --SDExtentsChgRatioRequireFull ".bak" --CloudVendor "AmazonS3" -AWSBucketName "california" --AWSAccessKey "*****" --AWSSecretKey "*****" -AWSRegionName "us-west-1" --UseSSL -S"servername" –T Returns 0 (success) or 1 (failure) SmartCleanup Command-Line Arguments The slsSmartCleanup command-line utility (slsSmartCleanUp. Perform full backup only if the amount of database changes since the last full backup is more than 40%.1\MSSQL\Backup" --SDMirrorDirectory "D:\SQLServerBackups" -SDElapsedDaysRequireFull 10 --SDFullBackupEscalation -S SPB9771 -D Northwind 3. They will fail if the access info is not encrypted. Force full backup.exe --SDBackupDirectory "C:\Program Files\Microsoft SQL Server\MSSQL.exe --SDBackupDirectory "C:\Program Files\Microsoft SQL Server\MSSQL. Perform full backup only if more than 10 days have passed since last full backup.-Argument --Argument Description NOTE: IBM recommends that an application client should select a unique file space. Back up to TSM using the Passwordaccess Generate option specified in the option file.4" -D Northwind -S SPB9771 2. hgRatioRequireFull ". TIP: Command line fast compression backups only work with the encrypted access information. SLSFastCompression. it is recommended that LiteSpeed users follow this practice with a specific file space reserved for LiteSpeed backups. Perform full backup only if the amount of database changes since the last full backup is more than 40%. (none) --TSMLogname Log name.exe -D LiteSpeedLocal -C 2 --SDExtentsChgRatioRequireFull ". Back up to Amazon S3 cloud. Back up the Northwind database.exe --SDBackupDirectory "C:\Program Files\Microsoft SQL Server\MSSQL. Examples 1.4" --TSMFileSpace "FC" --TSMConfigFile "C:\Program Files\Tivoli\TSM\baclient\dsm_pg.4" -D model -F"test/test.opt" --TSMMgmtClass "STANDARD" -tsmdevicetimeoutminutes 2 --SDFullBackupEscalation --SDElapsedDaysRequireFull 14 -S"W2K5_TSM" -U"sa" -P"***" 4. If not specified.1 User Guide 137 . SLSFastCompression. LiteSpeed uses the default management class. differential and transaction log backups based on a user-defined period (either the file age or the date). Back up the Northwind database to multiple locations. if there are associated differential or t-log backups in the backup set that are not eligible for cleanup. if a user performs a backup of AdventureWorks and Pubs into the same mybackups. For example.exe ( -? | --ShowHelp | --ShowSyntax | <options> ) Connection options: --Database <database_name> --Server <server_name> --WindowsAuth | (--UserName <username> --Password <password>) Cleanup options: --BackupRetainDays <number> | --BackupExpiration <date> --LogRetainDays <number> | --LogExpiration <date> [--CopyOnlyBackups <option>] TSM connection options: [--TSMConfigFile <path>] [--TSMClientNode <node>] [--TSMClientOwnerPwd <password>] [--TSMdsmi_dir <path>] [--TSMdsmi_log <path>] [--TSMLogName <name>] [--TSMAdminName <name>] [--TSMAdminPwd <password>] Other options: [--DryRun] [--LogLevel (0|1|2) [--trace logpath = "path"]] Arguments NOTES: l l Single-letter arguments are case-sensitive. and they can be preceded by a figure dash '-' or '/'. if there are mixed backups in the same backup file.The backup retention will never delete: l l The backup files. Verbose multi-letter arguments are not case-sensitive.1 User Guide 138 . they must be preceded by double dashes '--'. When enabled dependent files are not deleted. -b --BackupRetainDays Specifies the number of days (N).bak backup file. -c --BackupExpiration Specifies the date using one of the following formats: YYYY-MM-DD LiteSpeed for SQL Server 8. -Argument --Argument Description -a --KeepArchiveFiles Turns on monitoring and refuses to delete files that have the archive filesystem bit set. l File/FileGroup backups l File/FileGroup differential backups l Partial backups l Partial differential backups l Files that have the filesystem archive bit set (if that option is selected) Syntax slsSmartCleanup. The full backup. The full or differential backup must be at least N days old before it is eligible for cleanup. SmartCleanup does not remove any backups. Name of database to be backed up or restored.-Argument --Argument Description YYYY-MM-DD HH:MM:SS where l YYYY—4-digit year l MM—2-digit month l DD—2-digit day of the month l HH—2-digit hour using the local 24-hour clock l MM—2-digit minute l SS—2-digit second To be eligible for cleanup. This is the default behavior when the parameter is not specified. -d --DryRun Displays backups that are to be removed (delete candidates) or kept according to the specified conditions and SmartCleanup logic. Copy-only transaction log backups will not mark other transaction log or full backups as having a dependent. AllowDeletes—Copy-only backups are removed according to the specified retention options. This argument accepts one of the following values: l l l Default—LiteSpeed will ignore copy-only backups except on secondary replicas in AlwaysOn Availability groups. if this parameter is specified.1 User Guide 139 . in which case it will allow deletions. NOTES: l l l -D --Database Transaction log backups are not considered dependent on copy-only full or copy-only tlog backups. The values are not case-sensitive. Ignore—Copy-only backups are never deleted. the full or differential backup must be older than this date. -C --CopyOnlyBackups Controls how LiteSpeed handles copy-only backups. Only backups of this database are eligible for cleanup. -k --LogExpiration Specifies the date of one of the following formats: YYYY-MM-DD YYYY-MM-DD HH:MM:SS where l YYYY—4-digit year l MM—2-digit month l DD—2-digit day of the month l HH—2-digit hour using the local 24-hour clock l MM—2-digit minute l SS—2-digit second LiteSpeed for SQL Server 8. (none) --TSMAdminName Specifies the TSM administrative user name that has client authority for the TSM node. (none) -TSMClientOwnerPwd Specifies the TSM client owner user password. This argument accepts one of the following values: l l l 0—Logging off. This argument accepts one of the following values: l server_name l server_name\instance_name If no server is specified. -U --UserName Specifies user login ID.1 User Guide 140 . (none) --TSMAdminPwd Specifies the plain text password of the administrative user which is used to log in to the TSM server and start the TSM session. the LiteSpeed command-line utility will connect to the default instance of SQL Server on the local computer. LiteSpeed for SQL Server 8. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. -l --LogRetainDays Specifies the number of days (N). -P --Password Specifies the user password. 2 or any even value—Logging on. (none) --TSMLogName Log name. -j --TSMConfigFile Specifies the TSM configuration file. -S --Server Specifies the instance of Microsoft SQL Server to connect to. if specified in the options file or if backing up with the Passwordaccess Generate option. Not required. Passwords are case-sensitive. The correct username and password may be obtained from the TSM administrator. if specified in the options file or if backing up with the Passwordaccess Generate option. Login IDs are case-sensitive. the t-log backup must be older than this date. Required if the connection type is not a trusted connection. Log file is removed on success.-Argument --Argument Description To be eligible for cleanup. Not required. (none) --TSMdsmi_dir DSMI_DIR path if needed. See Configure Logging in LiteSpeed on page 336 for more information. The t-log backup must be at least N days old before it is eligible for cleanup. 1 or any odd value—Logging on. -L --LogLevel Creates a log file. To log to a different directory run this utility with the following argument: -trace logpath = "path". (none) --TSMClientNode Specifies the TSM server LiteSpeed connects to during backups and restores. Required if the connection type is not a trusted connection. (none) --TSMdsmi_log DSMI_LOG path. Some operations may require an administrative user with client owner authority to be specified in order to open a TSM session. opt" --TSMClientNode w2k3_TSM2 --TSMClientOwnerPwd ***** --LogRetainDays 2 --WindowsAuth 4. (none) --ShowSyntax Displays the utility syntax.exe --Database test2 --BackupExpiration "2012-11-15" --Server LITESPEED\SQL2005 --WindowsAuth 3.-Argument --Argument Description -T --WindowsAuth Specifies Windows authentication. NOTE: You can generate scripts by opening tasks in the LiteSpeed UI Console and clicking View T-SQL. Delete Amazon S3 cloud backup.SQL2008\MSSQL\Binn).opt" --BackupExpiration 2012-06-15 -LogExpiration 2012-06-15 --WindowsAuth 5. SLSsmartcleanup.exe -D model --BackupExpiration "2014-03-02 00:00:00" -CloudVendor "AmazonS3" --AWSBucketName "california" --AWSAccessKey "***** " -AWSSecretKey "******" --AWSRegionName "us-west-1" --UseSSL -S"servername" Returns 0 (success) or 1 (failure) Script Maintenance Plans Tasks You can perform various database maintenance tasks from the command line. delete log backups older than 2 days. Delete disk full and differential backups created before 11/15/2012: SLSSmartCleanup. (Usually. C:\Program Files\Microsoft SQL Server\MSSQL10. change the directory until you are in the directory containing slssqlmaint. differential and log TSM backups created before 06/15/2012. Example 1. Delete full.exe. allow deletions of the copy-only backups: SLSSmartCleanup. -? --ShowHelp Displays the syntax summary of the LiteSpeed command-line utility. To use the SLSSQLMaint utility. Delete tsm log backups older than 2 days: SLSSmartCleanup.exe --Database test_tsm --TSMConfigFile "C:\Program Files\Tivoli\TSM\baclient\dsm. Uses a trusted connection (to the server) instead of requiring a password. using the PASSWORDAccess generate option to connect to the TSM Server: SLSSmartCleanup. LiteSpeed for SQL Server 8. See About Creating Maintenance Plans on page 80 for more information. TIP: The parameter “-CSecretKey” must be generated by the Maintenance plan wizard and cut\paste into the command line script.1 User Guide 141 .exe --Database test2 --BackupRetainDays 28 --LogRetainDays 2 -CopyOnlyBackups AllowDeletes --Server LITESPEED\SQL2005 -U sa -P ******* 2. Delete disk full and differential backups older than 28 days.exe --Database test_tsm --TSMConfigFile "C:\Program Files\Tivoli\TSM\baclient\dsm_gp. 1 User Guide 142 .Syntax slssqlmaint.exe -? | (<connection_options> <task_options>) Connection options: -S <server_name\instance_name> -T | (-U <login_ID> -P <password>) Backup Database task options (Disk): -D <names_group_or_patterns> -BkUpMedia DISK -BkUpDB|-BkUpLog ( (<path_and_filename> -BkFileName [-NOINIT] ) | ( (-UseDefDir|<path>) [-CrBkSubDir] -Default <file_format> ) ) [-BkExt <extension>] [-Differential] [-FileGroups <filegroups>] [-Expiration <date_time> | -Retaindays <number_of_days> ] [-DelBkUps <number>(HOURS|DAYS|WEEKS|MONTHS|YEARS)] [-VrfyBackup] [-With "COPY_ONLY"] [-AdaptiveCompression (speed|size) | -CompressionLevel <value> ] [-Logging (0|1|2)] [-Comment <comment>] [-Threads <number>] [-Throttle <value>] [-BufferCount <number>] [-MaxTransferSize <size>] [-Priority (0|1|2)] [-Affinity <mask>] [-X [DISK_RETRY_COUNT <value>] [DISK_RETRY_WAIT <value>]] [-CryptLevel <value> (-jobp <encrypted_key> | -BackupKey <encryption_password>) ] [-DblClick (1|2)] [-OPTOLR|-NOOPTOLR] [-Reliability (1|2|3)] [-Mirror <path>] [-Attached <file_or_directory>] [-Exclude [Offline] [LogShippng] [ReadOnly] [Selected] [Deleted] [<wildcard_or_regex_pattern>] [IgnoreReplica [Primary] [Secondary]] Backup Database task options (TSM or TSM Archive): -D <names_group_or_patterns> -BkUpMedia (TSM|TSMARCHIVE) (-BkUpDB|-BkUpLog) -BkFileName [-CrBkSubDir] LiteSpeed for SQL Server 8. 1 User Guide 143 .-Default <file_format> [-Differential] [-FileGroups <filegroups>] [-TSMClientNode <client_node>] [-TSMClientOwnerPWD <password>] -TSMConfigFile <path> -TSMObjectPath <TSM_path> [-TSMManagementClass <name>] [-TSMDeviceTimeoutMinutes <timeout_period>] [-VrfyBackup] [-With "COPY_ONLY"] [-AdaptiveCompression (speed|size) | -CompressionLevel <value> ] [-Logging (0|1|2)] [-Comment <comment>] [-Threads <number>] [-Throttle <value>] [-BufferCount <number>] [-MaxTransferSize <size>] [-Priority (0|1|2)] [-Affinity <mask>] [-CryptLevel <value> (-jobp <encrypted_key> | -BackupKey <encryption_password>) ] [-Reliability (1|2|3)] [-Attached <file_or_directory>] [-Exclude [Offline] [LogShippng] [ReadOnly] [Selected] [Deleted] [<wildcard_or_regex_pattern>] [IgnoreReplica [Primary] [Secondary]] Backup Database task options (Tape): -D <names_group_or_patterns> -BkUpMedia TAPE (-BkUpDB|-BkUpLog) <path> -BkFileName [-NOINIT] [-Differential] [-FileGroups <filegroups>] [-Expiration <date_time> | -Retaindays <number_of_days> ] [-VrfyBackup] [-With "COPY_ONLY"] [-AdaptiveCompression (speed|size) | -CompressionLevel <value> ] [-Logging (0|1|2)] [-Comment <comment>] [-Threads <number>] [-Throttle <value>] [-BufferCount <number>] [-MaxTransferSize <size>] [-Priority (0|1|2)] [-Affinity <mask>] [-CryptLevel <value> (-jobp <encrypted_key> | -BackupKey <encryption_password>) ] [-Reliability (1|2|3)] [-Attached <file_or_directory>] [-Exclude [Offline] [LogShippng] [ReadOnly] LiteSpeed for SQL Server 8. [Selected] [Deleted] [<wildcard_or_regex_pattern>] [IgnoreReplica [Primary] [Secondary]] Fast Compression task options (Disk): -D <names_group_or_patterns> -BkUpMedia DISK -BkUpDB <path> -BkFileName [-CrBkSubDir] [-NOINIT] -SmartDiff <number>DAYS (-DataDelta <value> | -SizeDelta <value>) [-ExcludeDays <values>] -SingleFile (0|1) [-RequireFull [-AltBkpDir <path>]] [-BackupEsc] [-VerifyOpt (Last|FullDiff|All)] [-NotifyOpt (Failure|Every)] [-NotifyAgent <name>] [-FullDiffRtn 28 ] [-LogRtn 28] [-AdaptiveCompression (speed|size) | -CompressionLevel <value> ] [-Logging (0|1|2)] [-Comment <comment>] [-Threads <number>] [-Throttle <value>] [-BufferCount <number>] [-MaxTransferSize <size>] [-Priority (0|1|2)] [-Affinity <mask>] [-X [DISK_RETRY_COUNT <value>] [DISK_RETRY_WAIT <value>]] [-CryptLevel <value> (-jobp <encrypted_key> | -BackupKey <encryption_password>) ] [-OPTOLR|-NOOPTOLR] [-Reliability (1|2|3)] [-Mirror <path>] [-Attached <file_or_directory>] [-Exclude [Offline] [LogShippng] [ReadOnly] [Selected] [Deleted] [<wildcard_or_regex_pattern>] [IgnoreReplica [Primary] [Secondary]] Fast Compression task options (TSM): -D <names_group_or_patterns> -BkUpMedia DISK -BkUpDB <path> -BkFileName [-CrBkSubDir] -Default <file_format> [-TSMClientNode <client_node>] [-TSMClientOwnerPWD <password>] -TSMConfigFile <path> LiteSpeed for SQL Server 8.1 User Guide 144 . 1 User Guide 145 .[-TSMObjectPath <filespace_name>] [-TSMManagementClass <name>] [-TSMDeviceTimeoutMinutes <timeout>] -SmartDiff <number>DAYS (-DataDelta <value> | -SizeDelta <value>) [-ExcludeDays <values>] -SingleFile (0|1) [-RequireFull [-AltBkpDir <path>]] [-BackupEsc] [-VerifyOpt (Last|FullDiff|All)] [-NotifyOpt (Failure|Every)] [-NotifyAgent <name>] [-FullDiffRtn 28 ] [-LogRtn 28] [-AdaptiveCompression (speed|size) | -CompressionLevel <value> ] [-Logging (0|1|2)] [-Comment <comment>] [-Threads <number>] [-Throttle <value>] [-BufferCount <number>] [-MaxTransferSize <size>] [-Priority (0|1|2)] [-Affinity <mask>] [-CryptLevel <value> (-jobp <encrypted_key> | -BackupKey <encryption_password>) ] [-Reliability (1|2|3)] [-Attached <file_or_directory>] [-Exclude [Offline] [LogShippng] [ReadOnly] [Selected] [Deleted] [<wildcard_or_regex_pattern>] [IgnoreReplica [Primary] [Secondary]] Cleanup History task options: -CleanHis <number>(HOURS|DAYS|WEEKS|MONTHS|YEARS) [BKUP] [JBS] [MAINTPLN] [Activity] [CentralActivity] [PurgeInfo] [Logshipping] [Status] [ShrinkLog] Cleanup Maintenance Plans task options: -MAINTDEL -DelDeviceType DISK -DELTYPE (FileBkup|FileRpt|FileAny) [-DELUSEAGE -DELUNIT <number> -DELUNITTYPE (MINUTES|HOURS|DAYS|WEEKS|MONTHS|YEARS)] (-DELFOLDER <directory> -DELEXTENSION <extension> [-DELSUBFOLDERS] [-DelEmptyFolder]) |(-DELFILE -DELFILEPATH <path_and_filename>) LiteSpeed for SQL Server 8. g. This form will take the syntax of <file_path> to <new_file_path>. It does not restore the database. NOTES: l l The original entire directory path need not be supplied (e.Legacy Task options: (-PlanID <plan_ID>|-PlanName <plan_name>) [<backup_task_options>] [-CkDB|-CkDBNoIdx] [-ReorgIDX] [<cleanup_maint_plans_task_options>] [<clean_up_history_task_options>] [-OpNotify <names> -OpMessage <message> -OpSubject <subject> -OpImportance (0|1|2)] [-RebldIdx <1-100> ] [-RmUnusedSpace <max_size> <free_space_to_remain> [NoTrunc]] [-UpdOptiStats <number> -UpdStatsTarget (Columns|Index|All) -UpdStatsScan (FullScan|Rows|Percent)] [-Rpt <path>. The filepath can be either a single file or a directory.html [-DelHtmlRpt <number><time_unit>]] [-To <operator_name>] [-Writehistory] [-LogEngine (0|1|2)] Arguments -Argument Description -AdaptiveCompression <value> Automatically selects the optimal compression level based on CPU usage or Disk IO. the path parameter can be expanded to include a new destination. and Double Click Restore as well. All attached files are encrypted and compressed. The mask is a 64-bit integer value.txt [-DelTxtRpt <number><time_unit>]] [-HtmlRpt <path>. -Attached <file_or_ directory> Specifies filepaths to include in both backup and restore operations. This argument only restores the attached files. When used within the context of a restore operation. then LiteSpeed recursively includes all files and subdirectories. You can supply multiple instances of this argument. By default. c: to c:\testadSattsm is allowed).1 User Guide 146 . with all pertinent backup parameters supported. See Compression Methods on page 71 for more information. just the files that were attached to that backup. If it is a directory. tape. -AltBkpDir <path> Specifies the directory where to search for the backup file. TSM. This argument accepts one of the following values: -AFFINITY <mask> l Size l Speed Specifies the affinity mask for the process. See Processor Affinity on page 30 for more information. The new filepath can be used to specify a new location but cannot rename a file. c:\testad to testadr would restore all files in directory c:\testad to LiteSpeed for SQL Server 8. it is 0 and will utilize all CPUs. This feature works for disk. You can tell Adaptive Compression to optimize backups either for size or for speed. This argument accepts one or more of the following: l l <number><time_unit>—Removes historical data older than specified time period. then the program will not encrypt the backup.1 User Guide 147 . a backup cannot be restored or recovered without the original encryption key. -BackupKey <encryption_ password> Value used to generate the encryption key for the encryption algorithm. -BackupEsc This option causes LiteSpeed to issue a full backup. If you use the wrong encryption key. LiteSpeed for SQL Server 8. l Verify operation fails on full or differential backup. Caution: When encrypting data. The default value is set by SQL Server. A differential backup is missing from the backup set (excludes backups automatically removed after the specified retention period).-Argument Description c:\testadr. -BkFileName Specifies that each path specified includes the filename. if one of the following problems is discovered in the current backup set: l l The full backup is missing. -BkUpDB Specifies the database backup type. If you do not supply encryption key. Example of key: 'Mypassword' -BkExt <extension> Specifies the extension of the backup files. This argument accepts one of the following values: l DISK l TAPE l TSM l TSMArchive -BUFFERCOUNT Specifies the number of SQL Server buffers available for a LiteSpeed operation. -BkUpMedia <value> Specifies the backup destination. -CkDBNoIdx Checks the allocation and structural integrity of tables. -BkUpLog Specifies the tlog backup type. an error will be returned. take care not to lose the encryption key. -CleanHis <values> Enables the Cleanup History task. l LSN verification fails in the backup set. You can use one of the following time units: l HOURS l DAYS l WEEKS l MONTHS l YEARS BKUP—Deletes back up and restore history. -CkDB Checks the allocation and structural integrity of tables and indexes. the restore will fail. NOTE: If a problem is detected and a full backup is created through escalation. you can specify wildcard or regular expression patterns using one of the following formats: l Mask:"<wildcard_expression>" LiteSpeed for SQL Server 8. LiteSpeed will not error out and will select and use Adaptive Compression. l CentralActivity—Deletes LiteSpeed activity from the Central Repository. DTS. l LogShipping—Deletes log shipping history. This argument accepts variables. When choosing a compression level. Maint Plans). See Test Optimal Backup Settings on page 43 for more information.-Argument -COMMENT <comment> Description l JBS—Deletes SQL Server Agent jobs history.1 User Guide 148 . it is best to try various options using your equipment and data to determine the best option for your environment. 2 is the default value. Valid values are 0 through 8. 0 bypasses the compression routines. l PurgeInfo—Deletes any information for deleted databases. l ShrinkLog—Shrinks the repository databases log files. See LiteSpeed Variables on page 76 for more information. Appends a user comment to the backup. l Status—Deletes status history (Job. The remaining values of 1 through 8 specify compression with increasingly aggressive computation. l MAINTPLN—Deletes Maintenance plans history. This argument accepts one of the following values: -D <names_group_or_ patterns> l 0—40-bit RC2 l 1—56 bit RC2 l 2—112 bit RC2 l 3—128 bit RC2 l 4—168 bit 3DES l 5—128 bit RC4 l 6—128 bit AES l 7—192 bit AES l 8—256 bit AES Specifies the database names or the following built-in database groups to include in the backup: l "ALL DATABASES" l "ALL SYSTEM DATABASES" l "ALL USER DATABASES" Alternately. -COMPRESSIONLEVEL <value> Specifies the compression level for the backup. -CrBkSubDir Creates a subdirectory for each database. NOTE: If both the compression level and Adaptive Compression option are passed in. Use the Backup Analyzer to test the performance of different compression levels. -CRYPTLEVEL <value> Specifies the encryption level. l Activity—Deletes LiteSpeed activity from the Local Repository. See Double Click Restore Executables on page 73 for more information. usually %D_%T_%Y-%m-%d-%H%M%S. -DelHtmlRpt <number><time_unit> Deletes . Accepted values are 1-99.html reports older than the given time period. Diff or Log) l %Y-%m-%d-%H%M%S—Date and time l %EXT%—File extension See LiteSpeed Variables on page 76 for more information. 2—Creates a Double Click Restore loader in the same location. If a backup is a native SQL Server backup or it is larger than 4 GB. the default value is 35. -DelFilePath <filename> Specifies the location and name of the files.1 User Guide 149 . -DelBkUps <number><time_unit> Deletes old backups based on the time period specified in the format: <number><time_unit>. -DblClick Creates a Double Click Restore executable. Currently DISK is the only supported device type. -DataDelta <value> Specifies the minimum amount of database changes required for the full backup. -DelFolder <path> Deletes a specific folder. if the size of the backup is less than 4GB. where: l %D—Database name l %T—Backup type (Full. -DelFile Deletes a specific file. This argument accepts one of the following values: l l 1—Converts a LiteSpeed backup to a Double Click Restore executable. where the time unit is one of the following: l HOURS l DAYS l WEEKS l MONTHS l YEARS -DelDeviceType DISK Specifies the device type. -DelEmptyFolder Deletes empty folders. -Default <format> Specifies the default file format.-Argument Description l Regex:"<regular_expression>" See Use Wildcard and Regular Expressions in LiteSpeed on page 64 for more information. -DelExtension <extension> Specifies the extension of the files eligible for deletion.%EXT%. it creates a Double Click Restore loader in the same location. This argument accepts one of the following time units: l HOURS l DAYS l WEEKS l MONTHS LiteSpeed for SQL Server 8. This argument accepts one of the following values: l FileBkupbackup—Backup files l FileRptreport—Maintenance plan text reports l FileAny—Any file -DelUnit Deletes files based on the file age. -DIFFERENTIAL Specifies that the database or file backup should consist only of the portions of the database or file changed since the last full backup. This argument accepts one of the following time units: -DelType <value> l HOURS l DAYS l WEEKS l MONTHS l YEARS Deletes file by type. A differential backup is usually smaller than a full backup.1 User Guide 150 . -DelTxtRpt <number><time_unit> Deletes . Primary LiteSpeed for SQL Server 8. unless they are excluded by the Primary and Secondary options. -Exclude <values> Excludes databases. Use this option so that all individual log backups since the last full backup do not need to be applied. -DelUnitType <value> Specifies the unit type for file age.-Argument Description l YEARS -DelSubFolders Deletes the first-level subfolders. l LogShippng l ReadOnly l Offline l Deleted l Mask:"<wildcard_expression>" l Regex:"<regular_expression>" l l IgnoreReplica—This option will ignore the preferred replica setting and will back up all replicas. This argument accepts one or more of the following: l Selected—This option will exclude databases supplied with the -D argument. This argument accepts one of the following values: l MINUTES l HOURS l DAYS l WEEKS l MONTHS l YEARS -DelUseAge Specifies the file age.txt reports older than the given time period. See Reporting and Logging in Maintenance Plans on page 339 for more information. -MAINTDEL Enables the Cleanup Maintenance Plans task. l 1 or any odd value—Logging on. -LogEngine <value> Controls the debug logging options for a plan. l 1 or any odd value—Logging on. This argument accepts one of the following values: l 0—Logging off.1 User Guide 151 . -LOGGING <value> Controls the logging options for backups. LiteSpeed for SQL Server 8. -HtmlRpt <report_ filename>. -JobP <encrypted_key> Specifies an encrypted key. This argument accepts one or more of the following: l Mn l Tu l Wd l Th l Fr l St l Sn Specifies the date and time when the backup expires. See Configure Logging in LiteSpeed on page 336 for more information.HTML Writes an HTML report. You can supply multiple instances of this argument. Files in a filegroup backup can be restored individually or as a group. l 2 or any even value—Logging on. Log file is removed on success. Log file is removed on success. LiteSpeed will not overwrite this file until expiration datetime is passed. The t-log backup must be at least N days old before it is eligible for cleanup. -LogRtn <number_of_days> Specifies the number of days (N). 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. The full or differential backup must be at least N days old before it is eligible for cleanup.-Argument Description l -ExcludeDays <values> -Expiration <date_time> -FileGroups <filegroup_ names> Secondary Specifies days of the week when a full backup is never performed. l 2 or any even value—Logging on. This argument accepts one of the following formats: l yyyy-mm-dd l yyyy-mm-dd hh:mm:ss Specifies a database filegroup to include in the backup or restore. -FullDiffRtn <number_of_ days> Specifies the number of days (N). This argument accepts one of the following values: l 0—Logging off. This argument accepts one of the following values: l 0—Low l 1—Normal l 2—High -OpMessage <message> Specifies the message for the Notify Operator task. -P <password> Specifies the user password. Required if the connection type is not a trusted connection.-Argument Description -MAXTRANSFERSIZE <size> Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. -NOINIT Does not overwrite the existing backup files. -OpProfile <profile> Specifies operators profile. all mirrored backups must match the primary in the number of stripes in each mirror. This argument accepts one of the following values: l 1—Causes checksums to be verified when a LiteSpeed backup is created. Passwords are case-sensitive.1 User Guide 152 . -NOOPTOLR Does not generate a map file during a backup for Object Level Recovery. -Reliability <value> Specifies whether LiteSpeed should perform checksums before writing to media and whether it should continue on error.subject -OPTOLR Generates a map file during a backup for Object Level Recovery. -PlanName <name> Specifies the maintenance plan name. -OpSubject <subject> Specifies the message subject for the Notify Operator task. LiteSpeed for SQL Server 8.304 bytes (4 MB). -NotifyOpt <value> Specifies the notification options after backup. LiteSpeed does not continue on error. creates the specified amount of free space on each data page (1-100).194. -PRIORITY <value> Specifies the priority of the LiteSpeed process compared to other processes running on the same server. -NotifyAgent <operator> Specifies the operator. This argument accepts one of the following values: l -1—Below Normal l 0—Normal (Default) l 1—AboveNormal l 2—High -RebldIdx <%_free_space> Drops and recreates indexes to improve performance. This argument accepts one of the following values: -OpImportance <value> l Every—Notify every time l Failure—Notify on failure only Specifies whether the message is of low. -PlanID <plan_id> Specifies GUID identifying the maintenance plan in 36 character hex format. -OpNotify <names> Specifies the operator names for the Notify Operator task. high or normal importance. -NO_OUTPUT Does not display the output. The default is 1048576 (1 MB). If you back up the primary to a set of striped files. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. -Mirror <path> Mirrors the backup file (copies the backup to multiple locations). the decision to perform a new full or a differential backup will depend on other conditions specified. LiteSpeed for SQL Server 8. it becomes eligible for shrinking. IO device speed.TXT report. l 1—Appends data to an existing full backup file. The default is n-1 threads. the default value is 35. checksums are not verified. The argument accepts an integer value between 1 and 100. If the full backup file does not exist. compression level. This argument accepts one of the following values: l server_name l server_name\instance_name If no server is specified. but the exact value depends on several factors including: processors available. -ReorgIDX Defragments and compacts existing indexes to improve performance. The percentage of free space to remain after shrinking. This is the percentage of the total amount of CPU usage (across all enabled processors) available. The default is 10.1 User Guide 153 . -Retaindays <number_of_ days> Specifies a number of days to retain the backup. Accepted values are 1-99. -SingleFile <value> This argument accepts one of the following values: l 0—Specifies self-contained backup set. encryption settings. when the database grows beyond this amount . See Fast Compression on page 67 for more information. where n is the number of processors. When exceeding the specified ratio LiteSpeed performs a full backup. If the full backup file does exist.-Argument Description l l 2—Causes the backup be executed on error. The default value is 100.txt Writes a . and SQL Server responsiveness. in MB. -RequireFull Checks if the expected full backup exists when backing up to separate files and returns a failure message if it is not found. -S <server_name> Specifies the instance of Microsoft SQL Server to connect to. -SmartDiff <number>DAYS Specifies the minimum number of days since last full backup required to perform full backup. The default value is 14. -T Uses a trusted connection (to the server) instead of requiring a password. -Rpt <report_ filename>. LiteSpeed will not overwrite this file for this number of days. -THREADS <number_of_ threads> Determines the number of threads used for the backup. -RmUnusedSpace <max_ size> <free_space_to_ remain> Reduces the size of data and log files in a database that grow beyond a specified size. You will achieve the best results by specifying multiple threads. NoTrunc—(Optional) Returns freed space to operating system. 3—Causes the backup be executed despite encountering an invalid backup checksum. -SizeDelta <value> Specifies the last differential backup size to last full backup size ratio. This arguments accepts the following values: l l l Database size. affinity setting. -THROTTLE <value> Specifies the maximum CPU usage allowed. it performs a full backup. the LiteSpeed command-line utility will connect to the default instance of SQL Server on the local computer. The default is 50. -U <username> Specifies user login ID. You may also want to consider using Adaptive Compression to maintain backup performance. Login IDs are case-sensitive. try limiting the number of threads. it is recommended that you limit the threading as well. Not required. -TSMObjectPath <path> Specifies path to the TSM backup. The default is 50 percent. Performs a restore verification on the backup file just created (if backup was successful). Required if the connection type is not a trusted connection. This argument accepts one of the following values: l -VrfyBackup Last—Verifies last backup performed (can be either a full or differential). -UpdStatsScan <value> Specifies how to measure the amount of database to sample. -VerifyOpt <value> Performs a restore verification on the backup file just created (if backup was successful). If not specified. -TSMClientNode <node_ name> Specifies the TSM server LiteSpeed connects to during backups and restores. LiteSpeed uses the default management class. This argument accepts one of the following values: -UpdStatsTarget <value> l Rows l Percent l FullScan Updates index and/or column statistics. l FullDiff—Verifies the last full backup and last differential is available. -TSMConfigFile <path> Specifies the TSM configuration file. The number following this argument is the amount of database to sample (in rows or percent). if specified in the options file or if backing up with the Passwordaccess Generate option. if specified in the options file or if backing up with the Passwordaccess Generate option. If you decide to use an affinity value other than default. it only specifies the filespace.-Argument Description TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. -To <names> Specifies operator's name. -TSMManagementClass <class> Specifies the TSM management class. -UpdOptiStats <number> Enables the Update Statistics task. See Adaptive Compression on page 72 for more information.1 User Guide 154 . TSMDeviceTimeoutMinutes <timeout> Specifies how long to wait for a TSM device. LiteSpeed for SQL Server 8. For Fast Compression backups. Not required. -TSMClientOwnerPWD <password> Specifies the TSM client owner user password. This argument accepts one of the following values: l Columns l Index l All -UseDefDir Instructs LiteSpeed to use the default backup directory. l All—Verifies last full backup and all differentials since. exe -S LITESPEED\SQL2005 -U sa -P ****** -CleanHis 3MONTHS BKUP Activity ShrinkLog 5. Delete backup files older than 14 days from the d:\temp folder and its subfolders.1 User Guide 155 . slssqlmaint. See Network Resilience on page 75 for more information. -X <option> <option_value> <option> <option_value> Specifies if LiteSpeed should wait and retry the read or write operation on failure. shrink LiteSpeed Local repository.sysdbmaintplan_history. perform full Fast Compression backups if the amount of database changes since the last full backup is 40% or more. DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. except those starting with "temp".exe -S LITESPEED\SQL2005 -U sa -P ****** -D "ALL USER DATABASES" BkUpMedia DISK -BkUpDB -UseDefDir -AdaptiveCompression speed -Default "%D_%z. slssqlmaint. The default is 4 retries. slssqlmaint. the maximum allowed setting is 1000. slssqlmaint. slssqlmaint.exe -S LITESPEED\SQL2005 -U sa -P ****** -D "LiteSpeedLocal" "LiteSpeedCentral" -BkUpMedia DISK -BkUpDB "C:\temp" -BkFileName AdaptiveCompression speed -SmartDiff 14DAYS -DataDelta 40 -SingleFile 0 RequireFull -BackupEsc -Exclude Offline LogShippng ReadOnly 3.%EXT%" -CkDB -ReorgIDX -MAINTDEL -DelDeviceType DISK DELTYPE FileBkup -DELUSEAGE -DELUNIT "3" -DELUNITTYPE "DAYS" -DELSUBFOLDERS DELEXTENSION "bak" -DELFOLDER "c:\temp" -CleanHis 90DAYS MAINTPLN Activity PurgeInfo ShrinkLog -RebldIdx 100 -RmUnusedSpace 50 10 -UpdOptiStats 50 UpdStatsTarget All -UpdStatsScan FullScan -WriteHistory -LogEngine 0 6. LiteSpeed for SQL Server 8. Perform full backups of all user databases. -WriteHistory Writes history to msdb. Script a legacy plan. For LiteSpeedLocal and LiteSpeedCentral databases. You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. the maximum allowed setting is 300.exe -S LITESPEED\SQL2005 -U sa -P ****** -PlanID "00638AA2-C4934F90-9C3B-275B55091D60" -BkUpMedia DISK -BkUpDB -UseDefDir -CrBkSubDir -BkExt "bak" -NOOPTOLR -Logging 2 -AdaptiveCompression speed -Default "%D_%T_%Y%d%m%H%M%S. NOTE: This functionality is only available for disk operations. if the files have "bkp" extension. Perform an Amazon S3 cloud backup. Examples 1.dbo.exe -S LITESPEED\SQL2005 -U sa -P ****** -MAINTDEL -DelDeviceType DISK -DELTYPE FileBkup -DELUSEAGE -DELUNIT "14" -DELUNITTYPE "DAYS" DELSUBFOLDERS -DELEXTENSION "bkp" -DELFOLDER "d:\temp" 4.-Argument Description -With "COPY_ONLY" Specifies the copy-only backup. The default is 15 seconds.bak" -CryptLevel 8 -BackupKey ****** -Exclude Offline LogShippng ReadOnly Mask:"temp*" 2. Remove backup and restore history older than 3 months from the LiteSpeed Local repository. ..... retention and other settings..3} [-w|--TapeRewind ] [-u|--TapeUnload ] TSM Options: [-c|--TSMClientNode <node_name> ] [-k|--TSMClientOwnerPwd <password> ] [-j|--TSMConfigFile <path> ] [-z|--TSMMgmtClass <class> ] [ --TSMPointInTime] [ --TSMDeviceTimeoutMinutes <number> ] [ --TSMarchive ] [ --TSMdsmi_dir <path> ] [ --TSMdsmi_log <path> ] [ --TSMLogname <name> ] LiteSpeed for SQL Server 8...TIP: When using variables in a command line script.exe) allows you to convert one LiteSpeed backup into another LiteSpeed backup through the command line. append several backups to one file.exe ( -? | <source_options> <target_options> <other_options> ) Source Options: -E|--SrcBackupFiles <path> [-N|--SrcBackupIndex <file_number> ] [-P|--SrcKey <password> ] Target Options: -F|--TgtBackupFiles <path> [-K|--TgtKey <password> ] [-I|--Overwrite ] [(-C|--CompressionLevel 0.8 ] [-y|--Expiration <time> ] [-r|--RetainDays <number> ] [-J|--DoubleClick] [(-M|--OLRMap) [--TempDirectory <path>] ] Other Options: [ -A|--Affinity <affinity_mask> ] [ -p|--Priority -1. convert TSM objects to disk backups to restore on another machine. l Correct example: -Default "%%T-%%m-%%H-%%M-%%S" l Incorrect example: -Default "%T-%m-%H-%M-%S" slssqlmaint. compression..100 ] Tape Options: [-m|--TapeFormat 0.exe -D "master" -BkUpMedia CLOUD -BkUpDB -BkFileName -Logging 0 CompressionLevel 2 -Default "%%T-%%m-%%H-%%M-%%S" -OPTOLR -CSType "AmazonS3" CSAccessKey "******" -CSSecretKeyPlain "*********" -CSContainer "california" CSAccessPoint "us-west-1" -CSObject "test\" -Exclude Deleted Offline LogShippng -T -S servername Recast LiteSpeed Backups The SLSRecast utility (slsrecast. Syntax SLSRecast. optionally changing encryption. See Examples on page 162 for more information. Also.8 )|--AdaptiveCompression (Speed|Size)] [-e|--EncryptionLevel 0. using this utility you can create disk stripe files. use double %% or else they will not be parsed correctly.2 ] [ -h|--Throttle 1.1 User Guide 156 .. The remaining values of 1 through 8 specify compression with increasingly aggressive computation. 16384. Valid values are 0 through 8.Arguments NOTES: l l Single-letter arguments are case-sensitive. -C --CompressionLevel Specifies the compression level for the backup. 2 is the default value. See Test Optimal Backup Settings on page 43 for more information. and 65536 (Default). Works in conjunction with LiteSpeed for SQL Server 8. NOTE: If both the compression level and Adaptive Compression option are passed in. -Argument --Argument Description (none) --AdaptiveCompression Automatically selects the optimal compression level based on CPU usage or Disk IO. LiteSpeed will not error out and will select and use Adaptive Compression. If a backup is a native SQL Server backup or it is larger than 4 GB. This argument accepts one of the following values: l Size l Speed -O --BaseSize The smallest chunk of memory LiteSpeed attempts to write to disk at any given time. 2048. 2—Creates a Double Click Restore loader in the same location. -J --DoubleClick Creates a Double Click Restore executable. they must be preceded by double dashes '--'. See Compression Methods on page 71 for more information. You can tell Adaptive Compression to optimize backups either for size or for speed. 0 bypasses the compression routines. 1024. Use the Backup Analyzer to test the performance of different compression levels. See Double Click Restore Executables on page 73 for more information. -e --EncryptionLevel Specifies encryption level. 4096. if the size of the backup is less than 4GB. it creates a Double Click Restore loader in the same location. Verbose multi-letter arguments are not case-sensitive.1 User Guide 157 . it is best to try various options using your equipment and data to determine the best option for your environment. and they can be preceded by a figure dash '-' or '/'. This argument accepts one of the following values: l l 1—Converts a LiteSpeed backup to a Double Click Restore executable. in bytes. 8192. Supported values are: 512. 32768. -b --BlockSize Specifies the physical block size. When choosing a compression level. 1 or any odd value—Logging on. This argument accepts one of the following values: l l l 0—Logging off. To log to a different directory run this utility with the following argument: --trace logpath = "path". This argument accepts one of the following formats: l yyyy-mm-dd l yyyy-mm-dd hh:mm:ss Specifies if LiteSpeed should wait and retry the read or write operation on failure. The default is 4 retries. the maximum allowed setting is 300. This argument accepts one of the following values: -y -X --Expiration --IOFlags l 0—40-bit RC2 l 1—56 bit RC2 l 2—112 bit RC2 l 3—128 bit RC2 l 4—168 bit 3DES l 5—128 bit RC4 l 6—128 bit AES l 7—192 bit AES l 8—256 bit AES Specifies the date and time when the backup expires. The default is 15 seconds. See Network Resilience on page 75 for more information. 2 or any even value—Logging on. See Configure Logging in LiteSpeed on page 336 for more LiteSpeed for SQL Server 8. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. NOTE: This functionality is only available for disk operations. DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. -L --LogLevel Creates a log file.1 User Guide 158 . You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure.-Argument --Argument Description the Key (K) parameter. LiteSpeed will not overwrite this file until expiration datetime is passed. Log file is removed on success. the maximum allowed setting is 1000. For TSM backups. restoring. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. This argument accepts one of the following values: l 0—False (default) l 1—True -I --Overwrite Re-initializes (overwrites and replaces) the target backup files. This argument accepts one of the following values: l 0—Do not format (default) LiteSpeed for SQL Server 8. Converting multiple files to a single file is accomplished by running the commands more than once (Example 3). -M --OLRMap Generates a map file during a backup for Object Level Recovery. this will create the TSM object and version the backup based on the retention policy. -P --SrcKey Password/key used to decrypt backup. This argument accepts one of the following values: l -1—Below Normal l 0—Normal (Default) l 1—AboveNormal l 2—High -r --RetainDays Specifies a number of days to retain the backup. This argument only applies to tape backups. -p --Priority Specifies the priority of the LiteSpeed process compared to other processes running on the same server. -? --ShowHelp Displays the syntax summary of the LiteSpeed command-line utility. Tip: Multiple -E parameters are used for stripe files (Example 2). For TSM backups and TSM archives. -m --TapeFormat Initializes the media on the device. -N --SrcBackupIndex Specifies the particular backup to use when recasting. extracting or reading from files with multiple appended backups.-Argument --Argument Description information. -E --SrcBackupFiles Location and name of the source backup/restore file device(s). You can also specify a UNC path. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low> See Examples on page 162 for more information.1 User Guide 159 . LiteSpeed will not overwrite this file for this number of days. Passwords are case-sensitive. This argument accepts one of the following values: l 0—Leave the tape unwound (default) l 1—Rewind the tape after writing/reading Applies to tape backups and restores.-Argument --Argument Description l 1—Write new header l 2—Long erase / write new header l 3—Low level controller format / write new header NOTE: Any successful format operation (values 1.) -F --TgtBackupFiles Location and name of the target backup/restore file device(s).ini file. Use this argument when the default Windows temp directory does not have enough free disk space for the restore process.ini. C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\LiteSpeedSettings.1 User Guide 160 . The argument accepts an integer value between 1 and 100. You can supply multiple instances of this argument. not all are available to all drive types) lays down a LiteSpeed tape header that will identify this tape as containing LiteSpeed backups. 2. The default value is 100. and 3. -h --Throttle Specifies the maximum CPU usage allowed. -K --TgtKey Password/key used to encrypt new backup. Examples: UNC Path: \\servername\share\path\filename Local path: c:\filedirectory\filename NOTE: You cannot use the same location for the source and target files if you want to recast files with the same names. (Usually. LiteSpeed for SQL Server 8. This is the percentage of the total amount of CPU usage (across all enabled processors) available. NOTE: You can specify the default temp directory using the TempPath parameter in the [LiteSpeed] section of the LiteSpeedSettings. Using @init=1 (or -I in the command line) will not lay down a tape header. This argument accepts one of the following values: l l (none) --TempDirectory 0—Keep tape loaded (default) 1—Unload and eject tape from the drive after operation Specifies a temporary directory for use with Object Level Recovery. -w -u --TapeRewind --TapeUnload Applies only to backing up and restoring tape. -j --TSMConfigFile Specifies the TSM configuration file. Some operations may require an administrative user with client owner authority to be specified in order to open a TSM session. Not required. tsm_high_level .-Argument --Argument Description TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. See Adaptive Compression on page 72 for more information.is the logical space on the TSM server that contains a group of files. if specified in the options file or if backing up with the Passwordaccess Generate option. -c --TSMClientNode -k --TSMClientOwnerPwd Specifies the TSM client owner user password. -i --TSMFile Defines the TSM filespace. (none) --TSMDeviceTimeoutMinutes Maximum wait time to acquire TSM device.1 User Guide 161 . If you decide to use an affinity value other than default. tsm_low_level . try limiting the number of threads. The correct username and password may be obtained from the TSM administrator. high level and low level. NOTE: You may only store one item at the location specified by this argument. (none) --TSMAdminPwd Specifies the plain text password of the administrative user which is used to log in to the TSM server and start the TSM session. It can be the drive label name or UNC name.specifies the directory path in which the file belongs. (none) --TSMdsmi_dir DSMI_DIR path if needed. LiteSpeed for SQL Server 8. (none) --TSMdsmi_log DSMI_LOG path. (none) --TSMOptions Specifies the options that are used during the TSM session. if specified in the options file or if backing up with the Passwordaccess Generate option. Not required. You can use the I command-line argument or @init to back up to a non-unique location. (none) --TSMAdminName Specifies the TSM administrative user name that has client authority for the TSM node. This argument accepts one of the following values: Specifies the TSM server LiteSpeed connects to during backups and restores. it is recommended that you limit the threading as well. (none) --TSMarchive Specifies to store the backup as a TSM archive. You may also want to consider using Adaptive Compression to maintain backup performance.specifies the actual name of the file. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l l l tsm_filespace . It is not possible to append an object to this location. -z --TSMMgmtClass Specifies the TSM management class.bkp 2. (none) --TSMPointInTime Specifies the date for restore/to filter results.bkp new.opt -E tsmbkp:fs\highlevel\lowlevel -F new1.bkp Returns 0 (success) or 1 (failure) LiteSpeed for SQL Server 8.bkp -F new. Convert a backup to a Double Click Restore file: Slsrecast.bkp -F new. Convert a full.exe -j tsmconfig.exe -E old. Stripe a TSM backup to 3 disk files: Slsrecast.exe Slsrecast. LiteSpeed uses the default management class.bkp -F new. If not specified. Encrypt a backup: Slsrecast.bkp 3.exe -E -E -E -E full.bkp new3. Change compression. Recompress a backup at the highest compression level for archival: Slsrecast.exe -E old.bkp -e 6 -K password 7.bkp -C 8 6. then the most recent of the times must be chosen.bkp diff.exe -E full.bkp new2.bkp 3. If it is not passed.bkp new.exe Slsrecast.opt -E tsmbkp:fs\highlevel\lowlevel --TSMPointInTime "2012-10-19 10:45:10"-F new -J 8.bkp -C 5 -M 5. Examples 1. The format is yyyy-mm-dd hh:mm:ss.bkp tlog. Convert a 4-striped backup to a single file: Slsrecast. remove the encryption. Convert a TSM backup to a disk backup and convert to a Double Click Restore executable: Slsrecast.bkp --DoubleClick 1 -F new 2.bkp 4.exe Slsrecast.exe -E 1.bkp 4. and 2 t-log backups to a single appended file: Slsrecast.bkp new.-Argument --Argument Description (none) --TSMLogname Log name.bkp -F -F -F -F new.exe -E 1.exe -j tsmconfig. 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).bkp tlog.1 User Guide 162 .bkp -P password -F new. add an OLRMap file: Slsrecast. diff. LiteSpeed will choose the most recent archived backup. run the command line and change the directory until you are in the LiteSpeed installation directory (Usually. --E --MTFFile Specify the location and name of the Microsoft Tape Format (MSTF) base file. The extracted files containing the native SQL Server backup will have the following format: base_file_namex. The extractor utility will create one backup device file for each thread used in a LiteSpeed backup.Convert LiteSpeed Backups to SQL Server Backups The extraction utility (extractor. Syntax extractor. The utility must be run on the server where the backup files are located. In case there are no additional files. To use the utility.exe ( -? | ( [-F <sqllitespeed_backup_file>] [-E <base_file_name>] [-N <file_number>] [-K <encryption_key>] [-L (0|1|2)] [-c <tsm_client_node>] [-k <tsm_owner_password>] [-j <tsm_config_file>] [--TSMPointInTime <date_time>] [-I] ) ) Arguments NOTES: l l Single-letter arguments are case-sensitive. -c --TSMClientNode Specifies the TSM server LiteSpeed connects to during backups and restores. NOTES: LiteSpeed for SQL Server 8. they must be preceded by double dashes '--'.1 User Guide 163 . Verbose multi-letter arguments are not case-sensitive. Where: l l base_file_name is the specified Microsoft Tape Format base file.exe) allows you to create MTF compliant SQL Server backup files from LiteSpeed backup files through the command-line. and they can be preceded by a figure dash '-' or '/'. if specified in the options file or if backing up with the Passwordaccess Generate option. the base file will not have an x appended to its name. -Argument --Argument Description -? --ShowHelp Displays the syntax summary of the LiteSpeed command-line utility. C:\Program Files\Dell\LiteSpeed\SQL Server). The devices created by the extractor utility can be restored on any SQL Server using the native RESTORE DATABASE or RESTORE LOG commands. x is a number or letter that represents the sequence of the files. Not required. 2 or any even value—Logging on. -K --Key Value used to generate the encryption key for the encryption algorithm. then the program LiteSpeed for SQL Server 8. You cannot tell the extraction utility to extract a different number of native SQL Server files.exe will create. For TSM backups and TSM archives. -j --TSMConfigFile Specifies the TSM configuration file. You only need to specify this parameter once. However. run it without this parameter. The extraction utility will create all the necessary files automatically. -L --LogLevel Creates a log file. The name of the LiteSpeed backup device file to be extracted. NOTE: If the backup was a striped backup and the point-intimes of the various striped files are different (rare but can be different a second or so). -I --Overwrite Re-initializes (overwrites and replaces) the target native backup files. To log to a different directory run this utility with the following argument: -trace logpath = "path". this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low> You can supply multiple instances of this argument. See Configure Logging in LiteSpeed on page 336 for more information. See example 4 for more information. Not required. The format is yyyy-mm-dd hh:mm:ss.-Argument --Argument Description l l l l -F --BackupFile You can specify a network destination for this parameter. -k --TSMClientOwnerPwd Specifies the TSM client owner user password. (none) --TSMPointInTime Specifies the date for restore/to filter results. then the most recent of the times must be chosen. This argument accepts one of the following values: l l l 0—Logging off. If you do not supply encryption key.1 User Guide 164 . if specified in the options file or if backing up with the Passwordaccess Generate option. the extracted files will be created in the current directory. If a full path is not specified. 1 or any odd value—Logging on. If it is not passed. 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. This argument accepts network destinations. LiteSpeed will choose the most recent archived backup. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. Log file is removed on success. To see how many files extractor. The example below has 3 destination files: extractor. See how many destination files the extractor utility is going to create for the LiteSpeed backup: extractor.opt" -F tsmbkp:fsMH\nw\test -E "C:\temp\TestNative. restoring. If you use the wrong encryption key.200" -k"password" -j"C:\Program Files\Tivoli\TSM\baclient\dsm. a. Caution: When encrypting data.bak" -N 1 3.1 User Guide 165 .exe -F "C:\temp\Northwind.bak 5.bak" -F "C:\temp\LS4.0. LiteSpeed for SQL Server 8.bak" -F "C:\temp\LS2.bak" NOTE: The number of extracted files does not have to match the number of files in a LiteSpeed backup. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. Specify one filename for each destination file.bak" -E "C:\temp\Native.bak" -F "C:\temp\LS3.bak" b.exe -F "C:\temp\LS1. Extract a LiteSpeed backup to different locations. Extract a TSM backup to native SQL Server backup: extractor. a backup cannot be restored or recovered without the original encryption key.exe -F"c:\Backup\Northwind. Example of key: 'Mypassword' -N --BackupIndex Specifies the particular backup to use when recasting. Extract only the first backup in a backup set: extractor. Extract a striped LiteSpeed backup: extractor.bak" \\my_server\my_share\NW3.exe -F"c:\Backup\Northwind.-Argument --Argument Description will not encrypt the backup.bak" Returns 0 (success) or 1 (failure) Restore Objects with the Command-Line Interface Object Level Recovery utility (olr. Examples 1. the restore will fail.bak" -E \\my_server\my_share\Native. extracting or reading from files with multiple appended backups. Extract a LiteSpeed backup to a Network Share: extractor.bak 2.bak" –E "c:\Data\NW1.exe -F "C:\temp\Northwind.exe -c"10. 4. See Arguments on page 163 for more information about the -E parameter.1. take care not to lose the encryption key.bak" "e:\Data\NW2. 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.bak" -E "C:\temp\NorthwindNative.exe) allows you to restore objects from the command-line interface (CLI). Syntax olr.1 User Guide 166 .exe ( -? | <list_backup_contents> | <view_or_restore_tables> | <restore_other_ objects> | <execute_select_script>) Connection Options: -U <username> -P <password> Backup Files: -F <full_backup_filename> [-N <file_number>] [-K <encryption_key>] ] [-D <diff_backup_filename> [-N <file_number>] [-K <encryption_key>] ] [-g <log_backup_filename> [ ( [-N <file_number>] [-K <encryption_key>] ) | (-h <striped_log_backup_filename> [-N <file_number>] [-K <encryption_key>] ) ] ] [-L (Create|Keep|Delete)] Script Options: [ -G <ON_filegroup_name> ] [ -I <TEXTIMAGE_ON_filegroup_name> ] [ -i <table_objects> ] [ -p <prefix> ] [ -s <suffix> ] List Contents: -V [-Y <object_type>] <backup_files> View or Recover Tables: -O <table_name> -E <destination_server_name> [ (-S <database_name> [-T <table_name>] [-W <temp_directory>] [-X <ship_directory>] ) | -J <output_filename> ] [<script_options>] <backup_files> <connection_options> Recover Objects Other than Tables: ( -C [ <object_name> ] -Y ( object_type | 'Database' ) | -Z <objects_filename> ) [ -Q <script_filename> ] [<script_options>] <backup_files> [-y ] [-W <temp_directory>] -E <destination_server_name> <connection_options> Execute Select Script: -B (-H <script_text> | -Q <script_file_name>) [-y ] -E <destination_server_name> [ (-S <database_name> [-T <table_name>] [-W <temp_directory>] LiteSpeed for SQL Server 8. These files may become very large depending on the table size and will require permissions to write to a temporary directory.1 User Guide 167 . This will set the number of row inserts for each batched transaction. -F <full_backup_ filename> Location and name of the backup file device containing the object to recover. Object Level Recovery will write a BCP format file and an accompanying binary data file to the local file system. -b 1 Object Level Recovery can restore tables using two different internal techniques to handle the record inserts. An alternate insertion method can be specified to use Sql Server’s Sql Native Client capabilities. This method inserts row-data directly into the destination database bypassing any storage on the local file-system. You can supply multiple instances of this argument. Regardless of the insertion method used. l Either use -J or -T (with -S and -W) but not both. -O. See Supported SELECT Statements on page 107 for more LiteSpeed for SQL Server 8. -G <filegroup_ name> Destination ON filegroup name. To enable this method.) | -J <output_filename> ] <backup_files> <connection_options> NOTES: l Arguments are case sensitive and can only be preceded with "-". The first and default method uses BCP files and a TSQL BULK INSERT statement. -V and -Z parameters are mutually exclusive. -C. -C <object_name> Specifies the name of the object to recover. use the parameter @backend='SQLNativeClient' (or -b 1 from the command line). l Either use -H or -Q but not both. -E <destination_ server_name> Name of the destination server. Arguments Argument Description -? Displays the syntax summary of the LiteSpeed command-line utility. To make this the default method set the value “BackEnd=SQLNativeClient” in the Object Level Recovery section of the LiteSpeed configuration file. You can supply multiple instances of this argument. Used for differential backups instead of full backup files. l -B. -H <script_text> SELECT Script literal text. the batch size can be globally managed by setting the value “BulkImportBatchSize=<N>”. -B Indicates Execute SELECT mode of operation. -D <diff_backup_ filename> Name of backup file to restore. The default TEMP location can be set by using the @TempDirectory parameter or by setting a permanent temp location in the LiteSpeed configuration file. -g <log_filename> Specifies location and name of the log backup file. Examples: UNC Path: \\servername\share\path\filename Local path: c:\filedirectory\filename NOTE: There can be multiple files but they must be listed in the order in which they were backed up. Used to restore a BLOB (binary large object). l Create—Reads backup and creates a new mapfile. Example of key: 'Mypassword' -L <option> Specifies handling for OLR LSM mapfile(s). -S <destination_ database_name> Specifies the destination database. -s <suffix> Adds a suffix to the names of the table's objects you selected to script or recover. -h <striped_ logfilename> Specifies the striped log file name. the restore will fail.csv) that is generated instead restoring into a database. l Constraints—But not foreign keys l ForeignKeys l Indexes l Statistics l Triggers l All—All of the above The value is a list of options. Required if the connection type is not a trusted connection. restoring. a backup cannot be restored or recovered without the original encryption key. l Keep—Does not delete mapfile(s) when complete. If you use the wrong encryption key. this file contains the select statement(s). Caution: When encrypting data. This is an ad hoc solution for users want to see the restored data in Excel. -P <password> Specifies the user password. -O <object_name> Specifies the name of the object to recover. -K <encryption_ key> Value used to generate the encryption key for the encryption algorithm. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. -J <filename> Name of comma separated file (. -T <destination_ Specifies the name of the destination table. extracting or reading from files with multiple appended backups. -Q <script_file_ name> The file name that the script is output into. -I <filegroup_name> Destination TEXTIMAGE_ON filegroup name. See Supported SELECT Statements on page 107 for more information.1 User Guide 168 . It will ignore attached LSM. -i <table_objects> Instructs LiteSpeed to script or recover one or more of the following: NOTE: The striped files for a given log backup must be specified before the next log backup set is specified. If you do not supply encryption key. then the program will not encrypt the backup. -p <prefix> Adds a prefix to the names of the table's objects you selected to script or recover. l Delete—Always deletes mapfile(s) when complete. Passwords are case-sensitive. take care not to lose the encryption key. separated with commas. LiteSpeed will not overwrite an existing LiteSpeed for SQL Server 8. Table name must be preceded by database owner.Argument Description information. NOTE: Currently only tables. -N <file_number> Specifies the particular backup to use when recasting. You can only use this argument for text data. When used with execute-select. Required if the connection type is not a trusted connection. you must use a different table name. which are prefixed with "object_type. The format of this file is LiteSpeed for SQL Server 8. (Usually. -y Instructs LiteSpeed to skip all transaction log backups and tail log processing. LiteSpeed will attempt to insert (append) all selected records into existing table. but the name of the owning table. When one of these values is used with -C or xp_objectrecovery_createscript.ini. Login IDs are case-sensitive. All pseudo-table object types will be listed even though they might not exist for the associated table. ". -V View contents. -Z <filename> Identifies a file that contains a list of objects. -Y <object_type> Specifies the type of object.1 User Guide 169 . This may improve read and recovery times. @ObjectName (-C) is not the name of the object. NOTE: You can specify the default temp directory using the TempPath parameter in the [LiteSpeed] section of the LiteSpeedSettings. C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\LiteSpeedSettings. 3 l TableConstraintClustered 2 l Database l TableConstraints 2 l Default l TableForeignKeys 2 l ExtendedProcedure l TableIndexClustered 2 l Function l TableIndexes 2 l PartitionFunction l TableStatistics2 l PartitionScheme l TableTriggers 2 l Role 1 l Trigger l Rule l Type l StoredProcedure l User 1 l SystemTable l View l Table l XmlSchemaCollection NOTES: 1 These values cannot be used to create scripts. If you select the same server instance and database as the original table. They are only used to generate SQL scripts to alter the table. NOTE: For Execute-Select operations. If you omit this parameter the object type defaults to table.Argument Description table_name> table.ini file. This argument accepts one of the following values: l All 1. so you should use this argument to recover schema objects other than tables.) -X <ship_directory> Ship directory for packaging files for subsequent restore. and they will be ignored when used with -V or xp_objectrecovery_viewcontents. -U <username> Specifies user login ID. 2 These values are pseudo-object types and are not real schema objects. -W <temp_ directory> Specifies a temporary directory for use with Object Level Recovery. Use this argument when the default Windows temp directory does not have enough free disk space for the restore process. 3 This value lists all object types. Recover the contents of the LiteSpeedActivity table to the LITESPEED\SQL2005 server.LiteSpeedActivity -E LITESPEED\SQL2005 -S TEST -Tdbo.exe -F "C:\temp\FOX_full. Tip: You can use -V and -Y arguments to create the objects list.exe -F "C:\temp\LITESPEED_full. foreignkeys" -s "_restored" 11.Employees -i "constraints. Execute select script and save results in a database: olr.exe -F "C:\temp\LITESPEED_full.bak" -B -H "select top (100)* from dbo. foreignKeys" -E LITESPEED\SQL2005 -S NHR -T dbo.Employees later: olr.csv" 9. Examples 1.exe -F "C:\temp\FOX_full.bak" -Y "All" 2.bak" -K****** -g"C:\temp\FOX_tlog1. List all objects in the LiteSpeedLocal database in the LITESPEED_full.LiteSpeedActivity Wd:\products 5. LiteSpeedActivity table using custom temp directory: olr.exe -F "C:\temp\LITESPEED_full.bak" -N 1 -O dbo.bak" -K****** -Odbo.bak backup file: olr.Argument Description "ObjectType.1 User Guide 170 .csv file: olr.exe -F "C:\temp\LITESPEED_full. Preview a table.Employees -i "constraints.exe -F "C:\temp\LITESPEED_full.LitespeedActivity -i "constraints. Recover dbo.ObjectName" per line. TEST database.bak" -B -Q "C:\temp\New Folder\select_ script.bak" -N2 -D "c:\temp\LITESPEED_diff.bak" -K****** -g"C:\temp\FOX_tlog1.bak" -N2 -D "c:\temp\LITESPEED_diff.bak" -K****** -Odbo. Recover the contents of the LiteSpeedActivity table to the LITESPEED\SQL2005 server.exe -F "C:\temp\LITESPEED_full.FOX_view -Y View LiteSpeed for SQL Server 8.bak" -N 1 -C dbo.bak" h"C:\temp\FOX_tlog2.LiteSpeedActivity117 4.bak" -K****** -N3 -C dbo. Query the backup and save results in a .bak" -h"C:\temp\FOX_tlog3.exe -F "C:\temp\LITESPEED_full. LiteSpeedActivity117 table: olr.sql" -E LITESPEED\SQL2005 -SQResults -T DBID6 8. do not use tail log: olr. Generate a script for an object other than a table: olr.bak" -B -H "select * from dbo.LitespeedActivity -y -E LITESPEED\SQL2005 3.exe -V -F "C:\temp\LITESPEED_full. TEST database.bak" -N3 -O dbo. Query the backup: olr.LiteSpeedActivity" -E LITESPEED\SQL2005 7.Employees 6.Employees from a striped backup: olr.Employees -X c:\temp\scripts 10.bak" h"C:\temp\FOX_tlog2. foreignKeys" -E LITESPEED\SQL2005 -S HR -Tdbo. Create scripts in the "c:\temp\scripts" folder to recover dbo.LiteSpeedActivity -E LITESPEED\SQL2005 -S TEST -Tdbo.bak" -h"C:\temp\FOX_tlog3.bak" -N3 -O dbo.exe -F "C:\temp\FOX_full.LiteSpeedActivity where PercentCompleted < 100" -E LITESPEED\SQL2005 -J "C:\LS_Activity. Generate a script to restore the table schema only: olr. exe -r NOTE: LicenseInfoCmd needs to be run from an elevated command prompt on Windows Vista/2008/7 to be able to store the license key.exe -l C20TM3Q3K2HD74UDLBMHC6KYV6HZ3MQFNXZFB-123-45678-34 -m "Trial Version" -s 4. Remove the currently installed license LicenseInfoCmd. View information about the accepted parameters: LicenseInfoCmd.sql Returns 0 (success) or 1 (failure) LicenseInfoCmd Utility The LicenseInfoCmd utility allows you to license LiteSpeed from the command line. Create a 'Create Database' script: olr. LiteSpeed for SQL Server 8.exe -l C20TM3Q3K2HD74UDLBMHC6KYV6HZ3MQFNXZFB-123-45678-34 -m "Trial Version" 3.exe -F "C:\temp\FOX_full.bak" -K****** -N3 -C -Y Database -Q d:\temp\create_ database_FOX.exe -F "C:\temp\FOX_full. C:\Program Files\Dell\LiteSpeed\SQL Server). Create a script file for objects listed in the objects. Syntax LicenseInfoCmd.bak" -K****** -N3 -Z "c:\temp\objects.exe (-? | -r | ([-s] -l <license_key> -m <site_message>) ) Examples 1.12. run the command line and change the directory until you are in the LiteSpeed installation directory (Usually.txt file: olr. NOTE: This utility will only register a local copy of LiteSpeed.txt" -Q d:\temp\create_view. Register the supplied license key LicenseInfoCmd. View information about the supplied license key LicenseInfoCmd.1 User Guide 171 .exe -? 2. To use the utility.sql 13. 11 Use Extended Stored Procedures About Using Extended Stored Procedures You can use extended stored procedures to perform LiteSpeed activities without using the LiteSpeed UI Console. such as Dell's Toad for SQL Server.. or filegroup) xp_backup_database Back up a transaction log xp_backup_log Back up using Fast Compression xp_slsFastCompression Backup databases and perform other maintenance tasks xp_slssqlmaint Convert a backup to a Double Click Restore xp_slsCreateDCR LiteSpeed for SQL Server 8. Review the Arguments sections for more information about the arguments and accepted values. database name. Review the following for additional information: l l Path type parameters are the MAX_PATH for any filesystem being employed. you are only limited by OS.1 User Guide 172 . When you install LiteSpeed. Round brackets are used to group arguments. etc. file. Review the Syntax sections to see which arguments are mandatory. Extended stored procedures are executed against the master database. differential. which are optional. are passed into SQL Server and have the same requirements. l TSM has a limit on object names. l Other than that.. NOTES: l l l l l You can only run LiteSpeed commands on SQL Servers on which the LiteSpeed stored procedures have been registered. Use. These extended stored procedures contain a series of commands that you can execute in SQL Query Analyzer or other SQL scripting tool. Backup name.. and which are mutually exclusive. Back up a database (full.. the installer registers the LiteSpeed extended stored procedures with every instance of SQL Server selected at installation. LiteSpeed arguments are flexible and usually do not have any hard coded length limits. Create Backups If you want to. Optional arguments are enclosed in square brackets. Mutually exclusive arguments are separated by a vertical bar. Restore a database xp_restore_database Restore transaction logs xp_restore_log Automate restore operations xp_restore_automated Restore only files attached to a backup xp_restore_attachedfilesonly Recover Objects from Backups If you want to.. Use. Restore tables from backups xp_objectrecovery List restorable objects in a backup xp_objectrecovery_viewcontents Create DDL scripts to recover objects xp_objectrecovery_createscript Execute a SELECT statement against the backup (can be used for row-level restores) xp_objectrecovery_executeselect LiteSpeed for SQL Server 8.. Use.. Delete old backups xp_slsSmartCleanup Restore Backups and Files If you want to.... Use. Verify the backup without restoring it xp_restore_verifyonly Validate that a file has not been corrupted xp_restore_checksumonly View Information about Backups If you want to.... Use....1 User Guide 173 .. Use..Verify Backups If you want to....... List header information for all LiteSpeed backups on a xp_restore_headeronly backup device View information about a stripe set xp_restore_setinfo List the logical file names in a backup xp_restore_filelistonly Check a password against a backup xp_restore_checkpassword Clean Up Old Backups If you want to. . Manage licensing information xp_sqllitespeed_licenseinfo View LiteSpeed components version xp_sqllitespeed_version xp_backup_database Performs full..1 User Guide 174 . Use.... Check a password against a backup xp_restore_checkpassword Encrypt a password for backup xp_encrypt_backup_key Encrypt a password for restore xp_encrypt_restore_key TSM-Specific Tasks If you want to.xp_backup_database @database = 'database_name' (. file... Check the progress of an activity xp_slsreadprogress Check available memory xp_memory_size LiteSpeed Information If you want to. @backupname = 'backupset_name'] LiteSpeed for SQL Server 8.Encrypt Passwords If you want to. Delete an object from a specified TSM location xp_delete_tsmfile Retrieve TSM-specific information xp_view_tsmcontents See available TSM management classes xp_view_tsmmc Check Progress and Memory If you want to.dbo.. or partial filegroup backups.......n] [. Use. differential. Use. See LiteSpeed Variables on page 76 for more information.... Use. @desc = 'backup_description'] [. Syntax NOTE: You can replace argument values with variables.. xp_backup_database (Disk or TSM) EXEC master. @filename = 'backup_file_name') [.. @nowrite = 0 | 1 ] [. n] [.( @encryptionkey = 'encryption_key'| @jobp = 'encrypted_key' ) ] [..100] [... @verify = 0 | 1 ] [.1 User Guide 175 .. @ioflag = 'DISK_RETRY_WAIT=n'] [. @priority = -1 | 0 | 1 | 2 ] [.. @tsmobject = 'TSM_object'] [... @tsmclientnode = 'TSM_client_node'] [. @file = 'logical_file_name'] [..[.. @init = 0 | 1 ] [. @olrmap = 0 | 1 ] [. @filegroup = 'logical_filegroup_name'] [. @throttle = 1.. ( @retaindays = 0. @affinity = 0. @maxtransfersize = 'maximum_transfer_size'] [. @compressionlevel = 'compression_level'] [.. @returndetails = 0 |1 ] LiteSpeed for SQL Server 8.99999 | @expiration = 'date' ) ] [.2147483648] [. @mirror = 'mirror_backup_file_name'] [. @doubleclick = 0 | 1 ] [... @cryptlevel = 'encryption_level'] [. @tsmconfigfile = 'TSM_configuration_file'] [.n] [. @tsmmanagementclass = 'TSM_management_class'] [...n] [. @ioflag = 'DISK_RETRY_COUNT=n'] [. @tsmclientownerpwd = 'TSM_client_owner_password'] [.32] [. @logging = 0 | 1 | 2 ] [. @with = 'additional_with_parameters'] [.. @LSECompatible = 1] [. @threads = 1. @attachedfile = 'pathname'] [. @tsmarchive = 0 |1 ] [.n] [. @comment = 'comment'] [. @read_write_filegroups = 0 | 1 ] [. @adaptivecompression = 'speed' | 'size' ] [. @buffercount = 'buffer_count'] [. FGBackups_PROD. @ProxyPassword = N'****'] [.1 User Guide 176 .. @file = 'logical_file_name'] [. @unload = 0 | 1 ] [.2147483648] [..xp_backup_database @database = N'FGBackups_PROD'. ( @retaindays = 0. @rewind = 0 | 1 ] [. LiteSpeed for SQL Server 8. @AWSBucketName = N'aabucket77'] [.. @logging = 0 | 1 | 2 ] [.99999 | @expiration = 'date' ) ] [. @format = 0. @ProxyLogin = N'DOMAIN\test-xyz-MYtester'] [.xp_backup_database (Tape) EXEC master.dbo. @affinity = 0..dbo xp_backup_database @Database = N'AA_3' [. @ProxyPort = 8080] [.bak'] [. @desc = 'backup_description'] [. @threads = 1. @AWSAccessKey = N'ZRWAOPTRURWQ'] [. @compressionlevel = 'compression_level'] [. @filename = 'tape_device_name' [.. @filegroup = 'logical_filegroup_name'] [. @AWSUseReducedRedundancy = 1] xp_backup_database (partial backup) NOTE: The following example shows the syntax for performing partial backups using the “read_write_ filegroups” parameter. @comment = 'comment'] [.sitelocal'] [.n] [..3] [.. @maxtransfersize = 'maximum_transfer_size'] [. FG1.xp_backup_database @database = 'database_name' .. @priority = -1 | 0 | 1 | 2 ] [... @backupname = N'FGBackups_PROD . @ProxyHost = N'proxy. EXEC master. @UseSSL = 1] [..n] [. @verify = 0 | 1 ] [. FG2. @backupname = 'backupset_name'] [. @AWSUseServerSideEncryption = 1] [. contains the following filegroups: Primary.32] [. and FG2). and FG3). @AWSRegionName = N'us-west-2'] [. @attachedfile = 'pathname'] [..100] [. @returndetails = 0 |1 ] xp_backup_database (Cloud) EXEC master.n] [. @buffercount = 'buffer_count'] [.. The database used in the example below. @AWSSecretKey = N'P99YGZGiaKoRU1zHSOW'] [. @CloudVendor = N'AmazonS3'] [.Full Database Backup'. Tip: The following example takes a partial backup of the primary and secondary read write file groups (Primary. @throttle = 1. @adaptivecompression = 'speed' | 'size' ] [. @FileName = N'folder2\AA3Backup.dbo. FG1. @with = 'additional_with_parameters'] [. @encryptionkey = 'encryption_key'] [.. Set the second. 3. <xp_arguments> @adaptivecompression Automatically selects the optimal compression level based on CPU usage or Disk IO.bkp'. If you decide to use an affinity value other than default.<procedure_name> show_help To convert the script for use with the command-line utilities.dbo.<procedure_name> show_cmd. 7.1 User Guide 177 .dbo. You can tell Adaptive Compression to optimize backups either for size or for speed. 2 and 3 38 100110 2. Review the following for additional information: Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 3 11 1 and 2 7 111 1. and sixth bits to 1 and all other bits to 0. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process. See Compression Methods on page 71 for more information. which is decimal 38 or hexadecimal 0x26. If a value begins with "0x" it is interpreted as hexadecimal. 3. 3.@desc = N'Full Backup of FGBackups_PROD on %Y-%m-%d %I:%M:%S %p'. it is recommended that you limit the threading as well. and 6 for use with LiteSpeed. LiteSpeed for SQL Server 8. The rightmost bit represents the first processor. @compressionlevel = 2. 4. See Adaptive Compression on page 72 for more information. execute the following: exec master. You may also want to consider using Adaptive Compression to maintain backup performance. third. @filename = N'I:\FGBackups_FULL. Number the bits from the right to left. The result is binary 100110. try limiting the number of threads. while not allowing LiteSpeed to run on the remaining processors. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. For example. NOTE: 32-bit Windows is internally limited to a 32-bit mask. This argument accepts decimal values and hexadecimal values. @with = N'STATS = 10' Arguments Tips: l l To see the list of accepted arguments and data types for arguments. @init = 1. and 6 205 11001101 1. @read_write_filegroups = 1. execute the following: exec master. This argument accepts one of the following values: l Size l Speed @affinity Processor affinity designates specific processors to run LiteSpeed. you need to select processors 2. The new filepath can be used to specify a new location but cannot rename a file. When used within the context of a restore operation. The number of parts can be up to 5 if there is enough memory available during the upload.000. you may inadvertently go over the 10. TSM. This form will take the syntax of <file_path> to <new_file_path>. This argument only restores the attached files. @AWSAccessKeyEnc The @AWSAccessKeyEnc argument specifies the name of the encrypted unique Amazon Web Service alphanumeric access key that identifies each user.g. The LiteSpeed default for Part Size is calculated as a database size divided into 9.000 limit. The filepath can be either a single file or a directory. and Double Click Restore as well. then LiteSpeed recursively includes all files and subdirectories. @AWSBucketName The @AWSBucketName argument specifies the name of the container for AWS objects. This feature works for disk. l c:\testad to testadr would restore all files in directory c:\testad to c:\testadr. Bucket names must be at least 3 and no more than 63 characters long. c: to c:\testadSattsm is allowed). @AWSMaxParts Is the number of parts that are simultaneously uploaded to Amazon S3. The LiteSpeed default is 3 parts. just the files that were attached to that backup. If you override this parameter. you may impact memory usage.000 parts per file. l Minimum and maximum values for Part Size are defined by Amazon S3: 5MB and 5120MB (5GB) relatively. with all pertinent backup parameters supported. NOTES: l The original entire directory path need not be supplied (e. The minimum Part Size = 25MB. @AWSAccessKey The @AWSAccessKey argument specifies the name of the unique Amazon Web Service alphanumeric access key that identifies each user.@attachedfile Specifies filepaths to include in both backup and restore operations. tape. If it is a directory. l The maximum object size is 5TB. LiteSpeed for SQL Server 8. It does not restore the database. All attached files are encrypted and compressed. the path parameter can be expanded to include a new destination. @AWSPartSize The size of each part that is uploaded to Amazon S3 (in MB).1 User Guide 178 . If you override this parameter. NOTES: l Amazon S3 has a maximum allowable 10. You can supply multiple instances of this argument. apsoutheast-2. ap-northeast-1. This argument accepts one of the following values: l 0—Do not use government cloud l 1—Use government cloud @AWSUseReducedRedundancy The @AWSUseReducedRedundancy argument specifies the use of reduced redundancy storage in Amazon S3. Example values are but not limited to: us-east-1. and sa-east-1. This argument accepts one of the following values: l 0—Do not use Server Side Encryption l 1—Use Server Side Encryption @backupname Specifies the name of the backup set.1 User Guide 179 . @buffercount Specifies the number of SQL Server buffers available for a LiteSpeed operation. The default value is set by SQL Server. @AWSSecretKey The @AWSSecretKey argument specifies the name of the Amazon Web Service secret key that is assigned when you initially get an AWS account. us-west-1. us-west-2. ap-southeast-1. @AWSSecretKeyEnc The @AWSSecretKeyEnc argument specifies the name of the encrypted Amazon Web Service secret key that is assigned when you initially get an AWS account. LiteSpeed for SQL Server 8. eu-west-1. See LiteSpeed Variables on page 76 for more information. @AWSUseGovCloud The @AWSUseGovCloud argument enables a special restricted region for the US Government use in Amazon S3. @AWSRegionName The @AWSRegionName argument specifies the name of the Amazon Web Service region to use for a bucket.TIP: Dell recommends using LiteSpeed defaults. This argument accepts variables. This argument accepts one of the following values: l 0—Do not use reduced redundancy storage l 1—Use reduced redundancy storage @AWSUseServerSideEncryption The @AWSUseServerSideEncryption argument enables the encryption of data stored at rest in Amazon S3. @comment Appends a user comment to the backup. LiteSpeed will not error out and will select and use Adaptive Compression. Use the Backup Analyzer to test the performance of different compression levels. 2 is the default value.1 User Guide 180 .@CloudVendor The @CloudVendor argument specifies the name of the company offering the Cloud service. @cryptlevel Works in conjunction with the @encryptionkey parameter. but they require more CPU and take longer. This argument accepts variables. See Test Optimal Backup Settings on page 43 for more information. When choosing a compression level. See LiteSpeed Variables on page 76 for more information. @compressionlevel Specifies the compression level for the backup. This argument accepts one of the following values: l 0—40-bit RC2 l 1—56 bit RC2 l 2—112 bit RC2 l 3—128 bit RC2 l 4—168 bit 3DES l 5—128 bit RC4 l 6—128 bit AES l 7—192 bit AES l 8—256 bit AES @database Name of database to be backed up or restored. See Test Optimal Backup Settings on page 43 for more information on analyzing the best backup settings for your environment. 0 bypasses the compression routines. The remaining values of 1 through 8 specify compression with increasingly aggressive computation. Valid values are 0 through 8. The default cloud vendor is AmazonS3. NOTE: If both the compression level and Adaptive Compression option are passed in. This parameter specifies a database: l to be backed up (xp_backup_database and xp_slsSmartDiff) l containing the transaction log to be backed up (xp_backup_log) LiteSpeed for SQL Server 8. Higher levels improve security. it is best to try various options using your equipment and data to determine the best option for your environment. Specify the encryption level. This argument accepts variables. Example of key: 'Mypassword' @expiration Specifies the date and time when the backup expires. Files in a filegroup backup can be restored individually or as a group. See Double Click Restore Executables on page 73 for more information. @encryptionkey Value used to generate the encryption key for the encryption algorithm. Caution: When encrypting data. the restore will fail. a backup cannot be restored or recovered without the original encryption key. LiteSpeed will not overwrite this file until expiration datetime is passed. then the program will not encrypt the backup. 2—Creates a Double Click Restore loader in the same location. If you use the wrong encryption key. If a backup is a native SQL Server backup or it is larger than 4 GB.l to be restored (xp_restore_database and xp_restore_log) l on which you wish to check the progress of an activity (xp_slsReadProgress) l for which you want to delete old backups (xp_slsSmartCleanup) If supplied as a variable (@database). LiteSpeed for SQL Server 8. @filegroup Specifies a database filegroup to include in the backup or restore. @desc Specifies a description to store with the backup. it creates a Double Click Restore loader in the same location. this name can be specified either as a string constant (@database = database name) or as a variable of character string data type.1 User Guide 181 . You can supply multiple instances of this argument. You can supply multiple instances of this argument. See LiteSpeed Variables on page 76 for more information. take care not to lose the encryption key. This argument accepts one of the following formats: l yyyy-mm-dd l yyyy-mm-dd hh:mm:ss @file Specifies a logical database file used for file or filegroup backups. except for the ntext or text data types. 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. if the size of the backup is less than 4GB. This argument accepts one of the following values: l l 1—Converts a LiteSpeed backup to a Double Click Restore executable. @doubleclick Creates a Double Click Restore executable. If you do not supply encryption key. it wipes out all the backups by writing at the tape's beginning. @ioflag Specifies if LiteSpeed should wait and retry the read or write operation on failure. LiteSpeed for SQL Server 8. DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. NOTE: 0 is the default value if you do not provide this parameter.@filename The name of the LiteSpeed backup device file to be extracted. @format Initializes the media on the device. See also @format. For TSM backups. this will create the TSM object and version the backup based on the retention policy. and 3. 1—Re-initializes (overwrites and replaces) the target backup files.1 User Guide 182 . this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. the maximum allowed setting is 300. This argument accepts variables. For TSM backups and TSM archives. This argument accepts one of the following values: l 0—Do not format (default) l 1—Write new header l 2—Long erase / write new header l 3—Low level controller format / write new header NOTE: Any successful format operation (values 1. 1—If the tape was previously formatted by LiteSpeed. This argument accepts network destinations. See LiteSpeed Variables on page 76 for more information. it results in an error if the file object already exists. For TSM backups. NOTE: This functionality is only available for disk operations. This argument only applies to tape backups. Tape backups l l 0—Appends the backup to tape. not all are available to all drive types) lays down a LiteSpeed tape header that will identify this tape as containing LiteSpeed backups. @init Disk or TSM backups l l 0—Appends the backup to an existing backup file set. the maximum allowed setting is 1000. You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. Using @init=1 (or -I in the command line) will not lay down a tape header. 2. The default is 15 seconds. The default is 4 retries. dbo. The parameter can be used whenever a new backup file is created and should only be set when backups are needed for cross-compatibility between the products.304 bytes (4 MB). This argument accepts one of the following values: l 0—Logging off. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. This switch will force modifications to internal settings such as the thread count. l 1 or any odd value—Logging on. and encryption levels. The parameter is ignored when appending to a backup file created without the switch. See Configure Logging in LiteSpeed for information about LiteSpeed logging. Log file is removed on success. @logging Writes a log file for the operation.1 User Guide 183 . The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs.194. In some cases. See LiteSpeed Variables on page 76 for more information. This argument accepts one of the following values: l 0—False (default) l 1—True @maxtransfersize Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. @ioflag='DISK_RETRY_COUNT=1' . to specify a database backup where each failure can be retried once after a 30-second wait: EXEC master. LiteSpeed for SQL Server 8. If you back up the primary to a set of striped files.bkp' . @mirror Mirrors the backup file (copies the backup to multiple locations).xp_backup_database @filename='c:\test. You can use xp_encrypt_backup_key to convert the password (encryption_key) for use with @jobp. The default is 1048576 (1 MB). To log to a different directory add @Trace='logpath=path'. l 2 or any even value—Logging on. performance may be degraded. This argument accepts variables. @database='test' . (Similar to @EncryptionKey). The original password (or encrypted key generated by xp_encrypt_restore_key) must be used to restore a backup. @ioflag='DISK_RETRY_WAIT=30' See Network Resilience on page 75 for more information. all mirrored backups must match the primary in the number of stripes in each mirror. @jobp Specifies an encrypted key. @LSECompatible Produces a backup that is compatible for use with LiteSpeed Engine for SQL Server.For example. striping model. Backup only system databases. If compression or encryption parameters are specified. This argument accepts one of the following values: l All .1 User Guide 184 . NOTE: LiteSpeed for SQL Server 8. user.Backup only user databases. or selected databases. l System .@MultiDatabaseType Produces a backup that includes several types of databases. l Selected . but the file will not get created and no IO is performed. it is not written to disk (similar to the native the SQL Native Backup commands: backup database xxx to disk = 'NUL' or backup log xxx to disk = 'NUL' command). This argument accepts one of the following values: l 0—False (default) l 1—True The MSDB history tables are updated with the file name specified. This argument accepts one of the following values: l 0—False (default) l 1—True @priority Specifies the priority of the LiteSpeed process compared to other processes running on the same server. @nowrite When the backup is completed. This argument accepts one of the following values: l -1—Below Normal l 0—Normal (Default) l 1—AboveNormal l 2—High @ProxyHost The @ProxyHost argument is optional and specifies the name of the Amazon Web Service host machine that is running the proxy server. system.Backup specifically selected databases. then the data will get compressed or encrypted before being thrown away. @olrmap Generates a map file during a backup for Object Level Recovery. l User . Types can include: all.Backup all system and user databases. @ProxyPort The @ProxyPort argument is optional and contains the port number of the proxy server. then the LiteSpeed core engine connects directly to the Amazon servers. @retaindays Specifies a number of days to retain the backup. NOTE: l If the @ProxyPort argument is not defined. @read_write_filegroups Specifies a partial backup. LiteSpeed for SQL Server 8. @ProxyPasswordEnc The @ProxyPasswordEnc argument is optional and specifies the encrypted proxy server password credential. then the LiteSpeed core engine connects directly to the Amazon servers. then the LiteSpeed core engine connects directly to the Amazon servers. If the proxy parameters are not detected. @read_write_filegroups includes only the primary filegroup. then the LiteSpeed core engine checks the local . then the LiteSpeed core engine checks the local . then the LiteSpeed core engine checks the local . which includes all the read/write files in a database: the primary filegroup.ini files for the proxy parameters. The TCP/IP port values can be 1-65535.ini files for the proxy parameters. @ProxyPassword The @ProxyPassword argument is optional and specifies the proxy server password credential.l If the @ProxyHost argument is not defined. NOTE: l If the @ProxyPassword argument is not defined. NOTE: l If not defined. If the proxy parameters are not detected.1 User Guide 185 . and any specified read-only files or filegroups. NOTE: l If the @ProxyPasswordEnc argument is not defined. any read/write secondary filegroups. @ProxyLogin The @ProxyLogin argument is optional and specifies the proxy server login credential. If the proxy parameters are not detected.ini files for the proxy parameters. LiteSpeed will not overwrite this file for this number of days. then the LiteSpeed core engine checks the local .ini files for the proxy parameters.ini files for the proxy parameters. If the database is read-only. If the proxy parameters are not detected. then the LiteSpeed core engine connects directly to the Amazon servers. then the LiteSpeed core engine checks the local . If the proxy parameters are not detected. then the LiteSpeed core engine connects directly to the Amazon servers. This argument accepts one of the following values: l 0—Leave the tape unwound (default) l 1—Rewind the tape after writing/reading @skip Skips normal retention checks and overwrites the backup that has not expired. l 0—False (default) l 1—True The result set contains the following details: Column Name Data Type Description Database nvarchar (128) Database name. AdaptiveCompression nvarchar (max) Adaptive Compression option used for compressing the backup: 'speed' or 'size'. OverlappedBuffers tinyint The number of buffers that any single VDI thread can use at a time.194. ElapsedSeconds numeric (18.@returndetails Generates a single-row result set. BufferCount smallint The number of SQL Server buffers available for a LiteSpeed operation. LiteSpeed for SQL Server 8. MaxTransferSize int Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. Operation nvarchar (30) Operation type: Backup or Restore. BackupSize bigint Size of the backup (in bytes). Tip: In Toad. 3) Processor time used by the LiteSpeed operation. Threads tinyint The number of threads used for a LiteSpeed backup. if backed up with Adaptive Compression. CompressionLevel tinyint Compression level used for compressing the backup. CPUSeconds numeric (18. 3) Duration of the operation. The compression level can be NULL. NativeSize bigint Backup size (in bytes) without LiteSpeed compression.1 User Guide 186 . BaseSize int The smallest chunk of memory LiteSpeed attempts to write to disk at any given time.304 bytes (4 MB). StripeCount smallint Number of backup files in the stripe set. @rewind Applies only to backing up and restoring tape. you can use Group Execute to produce a single result set for several server instances. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. The default is 1048576 (1 MB) . IO device speed. if specified in the options file or if backing up with the Passwordaccess Generate option. where n is the number of processors. and SQL Server responsiveness. You may also want to consider using Adaptive Compression to maintain backup performance. If not specified. You will achieve the best results by specifying multiple threads.1 User Guide 187 . Not required. but the exact value depends on several factors including: processors available. The argument accepts an integer value between 1 and 100. LiteSpeed uses the default management class. try limiting the number of threads. @tsmobject Defines the TSM filespace. @tsmmanagementclass Specifies the TSM management class. encryption settings. See Adaptive Compression on page 72 for more information. if specified in the options file or if backing up with the Passwordaccess Generate option. @throttle Specifies the maximum CPU usage allowed. The default is n-1 threads. Not required. @tsmconfigfile Specifies the TSM configuration file. TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. If you decide to use an affinity value other than default. @tsmclientownerpwd Specifies the TSM client owner user password. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level LiteSpeed for SQL Server 8. This is the percentage of the total amount of CPU usage (across all enabled processors) available. This argument accepts one of the following values: l 0—False (default) l 1—True @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. affinity setting.l 0—False (default) l 1—True @threads Determines the number of threads used for the backup. high level and low level. The default value is 100. it is recommended that you limit the threading as well. @tsmarchive Specifies to store the backup as a TSM archive. compression level. The supported formats are: l @with='PARAMETER' l @with='PARAMETER=''accepted_value''' NOTES: l l Extended stored procedure arguments are limited to 255 characters. If you need more than 255 characters. You can use the -I command-line argument or @init to back up to a nonunique location.where: l tsm_filespace is the logical space on the TSM server that contains a group of files. It is not possible to append an object to this location. @with Each @with argument should be a syntactically complete and correct statement. See xp_ restore_verifyonly on page 294 for more information. l tsm_high_level specifies the directory path in which the file belongs.1 User Guide 188 . This argument accepts one of the following values: l 0—Keep tape loaded (default) l 1—Unload and eject tape from the drive after operation @UseSSL The @UseSSL argument specifies that the connection uses SSL security. This argument accepts one of the following values: l 0—Do not use SSL l 1—Use SSL (default) @verify Performs a restore verification on the backup file just created (if backup was successful). l tsm_low_level specifies actual name of the file. This argument accepts one of the following values: l 0—False (default) l 1—True @verify is similar to an xp_restore_verifyonly call following xp_backup_database (or log). use multiple @with arguments. then the caller does not need to determine what file names were chosen. Please refer to the SQL Server Transact-SQL backup and restore documentation for the syntax and usage. But if you use variables in the file names. Do not supply the @with parameter if no additional features are required. @unload Applies to tape backups and restores. This extended stored procedure accepts the following @with parameters: LiteSpeed for SQL Server 8. It can be the drive label name or UNC name. NOTE: You may only store one item the location specified by this argument. BAK' .BAK' . BLOCKSIZE Specifies the physical block size.BAK' .dbo. 8192. @init=1 . @threads = 3 LiteSpeed for SQL Server 8. LiteSpeed backs up enough of the transaction log to produce a consistent database when the database is restored.BAK' . @filename='C:\MSSQL\Backup\MyDB_Backup. 1024. supply 'NO_CHECKSUM' . A differential backup is usually smaller than a full backup. PASSWORD Specifies the password for the backup set. @filename='C:\MSSQL\Backup\MyDB_Backup.dbo. @filename = 'C:\MSSQL\Backup\MyDB_Backup.xp_backup_database @database='MyDB' .Parameter Description DIFFERENTIAL Specifies that the database or file backup should consist only of the portions of the database or file changed since the last full backup. @encryptionkey='Password' Back Up Database with Multiple Threads EXEC master. NOTE: During a full database or differential backup.dbo.xp_backup_database @database='MyDB' . Use this option so that all individual log backups since the last full backup do not need to be applied. in bytes. It defaults to 10%. 32768. Examples Back Up Database with Init EXEC master. @with = 'DIFFERENTIAL' Back Up Database with Encryption EXEC master. STATS Specifies the percentage at which SQL Server returns backup progress. @init= 1 Create Differential Backup EXEC master.xp_backup_database @database='MyDB' . NOTE: When you restore a backup containing checksum. 16384.1 User Guide 189 . 4096. CHECKSUM Causes checksums to be verified when a LiteSpeed backup is created. Supported values are: 512. it is automatically checked. COPY_ONLY Specifies the copy-only backup. @filename = 'C:\MSSQL\Backup\MyDB_Backup.xp_backup_database @database='MyDB' . If you do not want to check the checksums during a restore. 2048.dbo. and 65536 (Default). CONTINUE_ AFTER_ ERROR Causes the backup be executed despite encountering an invalid backup checksum. @filegroup = 'PRIMARY' .dbo.xp_backup_database @database='MyDB' .Multiple Backup Devices (Striped Backup) EXEC master. @filename='\\.dbo. and a specified read-only file) EXEC master. @init = 1 Create Filegroup Backup EXEC master.xp_backup_database @database = 'MyDB' .dbo.1\MSSQL\Backup\MyDB.Partial Backup' .bak' Back Up Database to Tape EXEC master.xp_backup_database @database = 'MyDB' . @desc = 'Daily tape backup' . @compressionlevel = 1 .bak' . @init = 1 .1\MSSQL\Backup\MyDB_ 200909111234_differential. @backupname = 'MyDB . @filename = 'C:\Program Files\Microsoft SQL Server\MSSQL. @filename = 'C:\Program Files\Microsoft SQL Server\MSSQL. @filename= 'D:\MSSQL\Backup\MyDB_Backup2. all read/write secondary filegroups. @file = 'file1' .BAK' . @filename= 'C:\MSSQL\Backup\MyDB_Backup. @filegroup = 'SEC' . @format = 0 LiteSpeed for SQL Server 8.BAK' .BAK' . @filename = 'E:\MSSQL\Backup\MyDB_Backup3. @file = 'file3_RO' . @filegroup = 'PRIMARY' . @read_write_filegroups = 1 .BAK' .dbo.dbo. @with = N'DIFFERENTIAL' Create Partial Backup (includes the primary filegroup. @filename = 'C:\MSSQL\Backup\MyDB_Backup1.1 User Guide 190 .xp_backup_database @database='MyDB' . @init= 1 Create Differential Filegroup Backup exec master.xp_backup_database @database='MyDB' .\TAPE0' . @filegroup = 'THRD' . @filegroup = 'SEC' .Differential Filegroup Backup' . @backupname = 'MyDB . @init = 1.xp_backup_database @MultiDatabaseType = N'selected'. @tsmclientownerpwd= 'test16' . @backupname = N'%DATABASENAME% . @tsmobject= 'SLS_Mar\MyDB\(16)Thursday_14:14' .dbo. @backupname = N'%DATABASENAME% .bak'. @desc = N'Full Backup of %DATABASENAME% on 5/31/2013 6:32:44 AM'.xp_backup_database @database= 'MyDB' .Create TSM Archive EXEC master. @desc = N'Full Backup of %DATABASENAME% on 5/31/2013 6:32:44 AM'. @desc = N'Full Backup of %DATABASENAME% on 5/31/2013 6:32:44 AM'. @with = N'STATS = 10' GO Backup selected databases exec master. @tsmclientnode = 'ClusterGroup' . @init=1 Backup all databases exec master.xp_backup_database @MultiDatabaseType = N'all'. @compressionlevel = 5. @tsmconfigfile= 'C:\Program Files\Tivoli\tsm\baclient\dsm.dbo. @filename = N'D:\Backups\mdb-%D_%T_%z.xp_backup_database @MultiDatabaseType = N'user'. @compressionlevel = 5.opt' . @filename = N'D:\Backups\mdb-%D_%T_%z. @with = N'STATS = 10' GO LiteSpeed for SQL Server 8. @comment = 'multi'.bak'. @with = N'STATS = 10' GO Backup user databases exec master.bak'. @init = 1.Full Database Backup'. @backupname = N'%DATABASENAME% . @init = 1. @comment = 'multi'.dbo.dbo.Full Database Backup'. @tsmarchive=1 . @compressionlevel = 5.Full Database Backup'. @Database = N'db1'. @filename = N'D:\Backups\mdb-%D_%T_%z. @comment = 'multi'. @desc='test' . @Database = N'db2'.1 User Guide 191 . us-west-2.bak' . run the following: declare @rc int declare @rmsg varchar(999) exec master. @resultcode=@rc output select @rc. us-west-1. @ProxyHost = N'proxy. @ProxyPassword = N'****' . ap-northeast-1. xp_backup_log Backs up a transaction log. Instead.my key . @rmsg NOTE: For tape backups. sa-east-1 (This is an optional parameter. @AWSRegionName = N'us-west-2' -. ap-southeast-2. This number is used in the restore when multiple backups are sent to the same tape. and you have to back up with SQL Server to use them.<procedure_name> <arguments>. @ProxyLogin = N'DOMAIN\tst-xyz-MYtester' .) .my key . You cannot use xp_backup_log to back up databases with a simple recovery model. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation..dbo. run the following: declare @rmsg varchar(999) exec master. Regions for selected @AWSBucketName are used. LiteSpeed for SQL Server 8. @AWSBucketName = N'aabucket1' . @CloudVendor = N'AmazonS3' .<procedure_name> <arguments>. apsoutheast-1. NOTE: xp_backup_log does not accept the @with NO_LOG | TRUNCATE_ONLY parameters.us-east-1. @AWSSecretKey = N'P99YGUGrcKhQM1yJSDP' -. @FileName = N'folder2\AA3Backup. LiteSpeed returns the size and dataset number of the backup file. To capture the output message. @resultmsg=@rmsg output. @AWSUseReducedRedundancy = 1 Returns 0 (success) or non-zero (failure).xp_backup_database @Database = N'AA_3' . @AWSUseServerSideEncryption = 1 .sitelocal' . @AWSAccessKey = N'AUIWJOEIEBMQ' -. use xp_backup_database. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. @UseSSL = 1 . eu-west-1.1 User Guide 192 .Backup database to Cloud exec master.. @ProxyPort = 8080 . 32] [. @buffercount = 'buffer_count'] [. @init = 0 | 1 ] [..n] [.. @maxtransfersize = 'maximum_transfer_size'] [. @tsmarchive = 0 |1 ] [.100] [.. @tsmclientnode = 'TSM_client_node'] [. @file = 'logical_file_name'] [.Syntax Back Up Log (Disk or TSM) EXEC master. ( @retaindays = 0..n] [.1 User Guide 193 . @tsmclientownerpwd = 'TSM_client_owner_password'] [...99999 | @expiration = 'date' ) ] [.. @filegroup = 'logical_filegroup_name'] [. @adaptivecompression = 'size' | 'speed' ] [. @LSECompatible = 1] [. @mirror = 'mirror_backup_file_name'] [.xp_backup_log @database = 'database_name' (.n] [.. @with = 'additional_with_parameters'] [. @attachedfile = 'pathname'] [. @ioflag = 'DISK_RETRY_WAIT=n'] [. ( @encryptionkey = 'encryption_key' | @jobp = 'encrypted_key' ) ] [.. @comment = 'comment'] [... @returndetails = 0 | 1 ] LiteSpeed for SQL Server 8. @tsmobject = 'TSM_object'] [... @backupname = 'backupset_name'] [. @doubleclick = 0 | 1 ] [. @nowrite = 0 | 1 ] [. @desc = 'backup_description'] [.. @cryptlevel = 'encryption_level'] [..n] [. @tsmmanagementclass = 'TSM_management_class'] [. @filename = 'backup_file_name') [. @verify = 0 | 1 ] [.. @threads = 1. @logging = 0 | 1 | 2 ] [. @priority = -1 | 0 | 1 | 2 ] [.. @ioflag = 'DISK_RETRY_COUNT=n'] [.dbo. @throttle = 1..n] [. @tsmconfigfile = 'TSM_configuration_file'] [. @compressionlevel = 'compression_level'] [.2147483648] [. @affinity = 0.. @backupname = 'backupset_name'] [.. @threads = 1. See Compression Methods on page 71 for more information....dbo... @with = 'additional_with_parameters'] [. @desc = 'backup_description'] [. while not allowing LiteSpeed to run on the remaining processors. @comment = 'comment'] [.. @attachedfile = 'pathname'] [... @affinity = 0.. @priority = -1 | 0 | 1 | 2 ] [.<procedure_name> show_cmd.Back Up Log (Tape) EXEC master.1 User Guide 194 .dbo..3] [.99999 | @expiration = 'date' ) ] [. <xp_arguments> @adaptivecompression Automatically selects the optimal compression level based on CPU usage or Disk IO. @logging = 0 | 1 | 2 ] [. @rewind = 0 | 1 ] [.xp_backup_log @database = 'database_name' .100] [.n] [. @unload = 0 | 1 ] [.dbo. @compressionlevel = 'compression_level'] [. @adaptivecompression = 'size' | 'speed' ] [.<procedure_name> show_help To convert the script for use with the command-line utilities. ( @retaindays = 0. LiteSpeed for SQL Server 8. execute the following: exec master. @verify = 0 | 1 ] [. @file = 'logical_file_name'] [. @maxtransfersize = 'maximum_transfer_size'] [.n] [. @filegroup = 'logical_filegroup_name'] [.. @returndetails = 0 | 1 ] Arguments Tips: l l To see the list of accepted arguments and data types for arguments. @format = 0.. This argument accepts one of the following values: l Size l Speed @affinity Processor affinity designates specific processors to run LiteSpeed. You can tell Adaptive Compression to optimize backups either for size or for speed. execute the following: exec master.2147483648] [.32] [. @buffercount = 'buffer_count'] [.n] [. @throttle = 1. @filename = 'tape_device_name' [. @encryptionkey = 'encryption_key'] [.. It does not restore the database.This argument accepts decimal values and hexadecimal values. LiteSpeed for SQL Server 8. This feature works for disk. 2 and 3 38 100110 2. If you decide to use an affinity value other than default.g. it is recommended that you limit the threading as well. You may also want to consider using Adaptive Compression to maintain backup performance. See Adaptive Compression on page 72 for more information. If it is a directory. @attachedfile Specifies filepaths to include in both backup and restore operations. You can supply multiple instances of this argument. third. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance.1 User Guide 195 . 3. Set the second. All attached files are encrypted and compressed. l c:\testad to testadr would restore all files in directory c:\testad to c:\testadr. The minimum Part Size = 25MB. For example. try limiting the number of threads. The LiteSpeed default for Part Size is calculated as a database size divided into 9. If you override this parameter. which is decimal 38 or hexadecimal 0x26. the path parameter can be expanded to include a new destination. The rightmost bit represents the first processor. 4. If a value begins with "0x" it is interpreted as hexadecimal. you need to select processors 2. and 6 for use with LiteSpeed. The number of parts can be up to 5 if there is enough memory available during the upload. NOTES: l The original entire directory path need not be supplied (e. and Double Click Restore as well.000. The result is binary 100110. The filepath can be either a single file or a directory. The LiteSpeed default is 3 parts. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process. @AWSPartSize The size of each part that is uploaded to Amazon S3 (in MB). When used within the context of a restore operation. This form will take the syntax of <file_path> to <new_file_path>. TSM. @AWSMaxParts Is the number of parts that are simultaneously uploaded to Amazon S3. just the files that were attached to that backup. and 6 205 11001101 1. Review the following for additional information: Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 3 11 1 and 2 7 111 1. tape. 3. 3. Number the bits from the right to left. with all pertinent backup parameters supported. 7. and sixth bits to 1 and all other bits to 0. then LiteSpeed recursively includes all files and subdirectories. This argument only restores the attached files. c: to c:\testadSattsm is allowed). you may impact memory usage. NOTE: 32-bit Windows is internally limited to a 32-bit mask. The new filepath can be used to specify a new location but cannot rename a file. NOTES: l Amazon S3 has a maximum allowable 10,000 parts per file. If you override this parameter, you may inadvertently go over the 10,000 limit. l Minimum and maximum values for Part Size are defined by Amazon S3: 5MB and 5120MB (5GB) relatively. l The maximum object size is 5TB. TIP: Dell recommends using LiteSpeed defaults. @backupname Specifies the name of the backup set. This argument accepts variables. See LiteSpeed Variables on page 76 for more information. @buffercount Specifies the number of SQL Server buffers available for a LiteSpeed operation. The default value is set by SQL Server. @comment Appends a user comment to the backup. This argument accepts variables. See LiteSpeed Variables on page 76 for more information. @compressionlevel 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. 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. See Test Optimal Backup Settings on page 43 for more information. 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. @cryptlevel Works in conjunction with the @encryptionkey parameter. Specify the encryption level. Higher levels improve security, but they require more CPU and take longer. See Test Optimal Backup Settings on page 43 for more information on analyzing the best backup settings for your environment. This argument accepts one of the following values: l 0—40-bit RC2 l 1—56 bit RC2 l 2—112 bit RC2 l 3—128 bit RC2 l 4—168 bit 3DES LiteSpeed for SQL Server 8.1 User Guide 196 l 5—128 bit RC4 l 6—128 bit AES l 7—192 bit AES l 8—256 bit AES @database Name of database to be backed up or restored. This parameter specifies a database: l to be backed up (xp_backup_database and xp_slsSmartDiff) l containing the transaction log to be backed up (xp_backup_log) l to be restored (xp_restore_database and xp_restore_log) l on which you wish to check the progress of an activity (xp_slsReadProgress) l for which you want to delete old backups (xp_slsSmartCleanup) If supplied as a variable (@database), this name can be specified either as a string constant (@database = database name) or as a variable of character string data type, except for the ntext or text data types. @desc Specifies a description to store with the backup. This argument accepts variables. See LiteSpeed Variables on page 76 for more information. @doubleclick Creates a Double Click Restore executable. This argument accepts one of the following values: l l 1—Converts a LiteSpeed backup to a Double Click Restore executable, if the size of the backup is less than 4GB. If a backup is a native SQL Server backup or it is larger than 4 GB, it creates a Double Click Restore loader in the same location. 2—Creates a Double Click Restore loader in the same location. See Double Click Restore Executables on page 73 for more information. @encryptionkey 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' @expiration 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: l yyyy-mm-dd l yyyy-mm-dd hh:mm:ss LiteSpeed for SQL Server 8.1 User Guide 197 @file Specifies a logical database file used for file or filegroup backups. You can supply multiple instances of this argument. @filegroup 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. @filename 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: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. This argument accepts variables. See LiteSpeed Variables on page 76 for more information. @format Initializes the media on the device. This argument only applies to tape backups. This argument accepts one of the following values: l 0—Do not format (default) l 1—Write new header l 2—Long erase / write new header l 3—Low level controller format / write new header NOTE: Any successful format operation (values 1, 2, and 3; not all are available to all drive types) lays down a LiteSpeed tape header that will identify this tape as containing LiteSpeed backups. Using @init=1 (or -I in the command line) will not lay down a tape header. @init Disk or TSM backups l l 0—Appends the backup to an existing backup file set. For TSM backups, it results in an error if the file object already exists. 1—Re-initializes (overwrites and replaces) the target backup files. For TSM backups, this will create the TSM object and version the backup based on the retention policy. Tape backups l l 0—Appends the backup to tape. 1—If the tape was previously formatted by LiteSpeed, it wipes out all the backups by writing at the tape's beginning. See also @format. LiteSpeed for SQL Server 8.1 User Guide 198 NOTE: 0 is the default value if you do not provide this parameter. @ioflag Specifies if LiteSpeed should wait and retry the read or write operation on failure. You can define retry options using the following parameters: l l 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 operations. For example, to specify a database backup where each failure can be retried once after a 30-second wait: EXEC master.dbo.xp_backup_database @filename='c:\test.bkp' , @database='test' , @ioflag='DISK_RETRY_COUNT=1' , @ioflag='DISK_RETRY_WAIT=30' See Network Resilience on page 75 for more information. @jobp Specifies an encrypted key. (Similar to @EncryptionKey). You can use xp_encrypt_backup_key to convert the password (encryption_key) for use with @jobp. The original password (or encrypted key generated by xp_encrypt_restore_key) must be used to restore a backup. @logging Writes a log file for the operation. This argument accepts one of the following values: l 0—Logging off. l 1 or any odd value—Logging on. Log file is removed on success. l 2 or any even value—Logging on. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. To log to a different directory add @Trace='logpath=path'. See Configure Logging in LiteSpeed for information about LiteSpeed logging. @LSECompatible Produces a backup that is compatible for use with LiteSpeed Engine for SQL Server. The parameter can be used whenever a new backup file is created and should only be set when backups are needed for cross-compatibility between the products. This switch will force modifications to internal settings such as the thread count, striping model, and encryption levels. In some cases, performance may be degraded. The parameter is ignored when appending to a backup file created without the switch. This argument accepts one of the following values: l 0—False (default) l 1—True LiteSpeed for SQL Server 8.1 User Guide 199 @maxtransfersize 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). @mirror Mirrors the backup file (copies the backup to multiple locations). If you back up the primary to a set of striped files, all mirrored backups must match the primary in the number of stripes in each mirror. This argument accepts variables. See LiteSpeed Variables on page 76 for more information. @nowrite When the backup is completed, it is not written to disk (similar to the native the SQL Native Backup commands: backup database xxx to disk = 'NUL' or backup log xxx to disk = 'NUL' command). This argument accepts one of the following values: l 0—False (default) l 1—True The MSDB history tables are updated with the file name specified, but the file will not get created and no IO is performed. If compression or encryption parameters are specified, then the data will get compressed or encrypted before being thrown away. @priority Specifies the priority of the LiteSpeed process compared to other processes running on the same server. This argument accepts one of the following values: l -1—Below Normal l 0—Normal (Default) l 1—AboveNormal l 2—High @retaindays Specifies a number of days to retain the backup. LiteSpeed will not overwrite this file for this number of days. @returndetails Generates a single-row result set. l 0—False (default) l 1—True The result set contains the following details: Column Name Data Type Description Database nvarchar Database name. LiteSpeed for SQL Server 8.1 User Guide 200 Column Name Data Type Description (128) Operation nvarchar (30) Operation type: Backup or Restore. Threads tinyint The number of threads used for a LiteSpeed backup. CompressionLevel tinyint Compression level used for compressing the backup. The compression level can be NULL, if backed up with Adaptive Compression. AdaptiveCompression nvarchar (max) Adaptive Compression option used for compressing the backup: 'speed' or 'size'. MaxTransferSize int 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) . BaseSize int The smallest chunk of memory LiteSpeed attempts to write to disk at any given time. BufferCount smallint The number of SQL Server buffers available for a LiteSpeed operation. StripeCount smallint Number of backup files in the stripe set. OverlappedBuffers tinyint The number of buffers that any single VDI thread can use at a time. CPUSeconds numeric (18, 3) Processor time used by the LiteSpeed operation. ElapsedSeconds numeric (18, 3) Duration of the operation. NativeSize bigint Backup size (in bytes) without LiteSpeed compression. BackupSize bigint Size of the backup (in bytes). Tip: In Toad, you can use Group Execute to produce a single result set for several server instances. @rewind Applies only to backing up and restoring tape. This argument accepts one of the following values: l 0—Leave the tape unwound (default) l 1—Rewind the tape after writing/reading @skip Skips normal retention checks and overwrites the backup that has not expired. l 0—False (default) l 1—True @threads 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. LiteSpeed for SQL Server 8.1 User Guide 201 This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l tsm_filespace is the logical space on the TSM server that contains a group of files. LiteSpeed uses the default management class. @tsmarchive Specifies to store the backup as a TSM archive. It is not possible to append an object to this location. @tsmmanagementclass Specifies the TSM management class. TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. Not required. If you decide to use an affinity value other than default. if specified in the options file or if backing up with the Passwordaccess Generate option. it is recommended that you limit the threading as well. if specified in the options file or if backing up with the Passwordaccess Generate option. l tsm_high_level specifies the directory path in which the file belongs. The default value is 100. You can use the -I command-line argument or @init to back up to a nonunique location. l tsm_low_level specifies actual name of the file. try limiting the number of threads. @tsmobject Defines the TSM filespace.@throttle Specifies the maximum CPU usage allowed. LiteSpeed for SQL Server 8. It can be the drive label name or UNC name. You may also want to consider using Adaptive Compression to maintain backup performance. This argument accepts one of the following values: l 0—False (default) l 1—True @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. @tsmconfigfile Specifies the TSM configuration file. high level and low level. This is the percentage of the total amount of CPU usage (across all enabled processors) available. Not required. @tsmclientownerpwd Specifies the TSM client owner user password. If not specified. The argument accepts an integer value between 1 and 100. See Adaptive Compression on page 72 for more information. NOTE: You may only store one item the location specified by this argument.1 User Guide 202 . This argument accepts one of the following values: l 0—False (default) l 1—True @verify is similar to an xp_restore_verifyonly call following xp_backup_database (or log). @with Each @with argument should be a syntactically complete and correct statement. 1024. in bytes.1 User Guide 203 . But if you use variables in the file names.@unload Applies to tape backups and restores. 16384. Do not supply the @with parameter if no additional features are required. 2048. Supported values are: 512. 8192. CHECKSUM Causes checksums to be verified when a LiteSpeed backup is created. PASSWORD Specifies the password for the backup set. LiteSpeed for SQL Server 8. and 65536 (Default). Please refer to the SQL Server Transact-SQL backup and restore documentation for the syntax and usage. See xp_ restore_verifyonly on page 294 for more information. This extended stored procedure accepts the following @with parameters: Parameter Description NO_ TRUNCATE Allows backing up the log in situations where the database is damaged. BLOCKSIZE Specifies the physical block size. supply 'NO_CHECKSUM' . COPY_ONLY Specifies the copy-only backup. 4096. The supported formats are: l @with='PARAMETER' l @with='PARAMETER=''accepted_value''' NOTES: l l Extended stored procedure arguments are limited to 255 characters. CONTINUE_ AFTER_ ERROR Causes the backup be executed despite encountering an invalid backup checksum. it is automatically checked. use multiple @with arguments. 32768. then the caller does not need to determine what file names were chosen. If you do not want to check the checksums during a restore. If you need more than 255 characters. This argument accepts one of the following values: l 0—Keep tape loaded (default) l 1—Unload and eject tape from the drive after operation @verify Performs a restore verification on the backup file just created (if backup was successful). NOTE: When you restore a backup containing checksum. This number is used in the restore when multiple backups are sent to the same tape. @rmsg NOTE: For tape backups.xp_delete_tsmfile @tsmclientnode = 'TSM_client_node' . run the following: declare @rc int declare @rmsg varchar(999) exec master.Example EXEC master. execute the following: exec master. @tsmconfigfile = 'TSM_configuration_file' [. execute the following: exec master. LiteSpeed returns the size and dataset number of the backup file.dbo. @resultmsg=@rmsg output.. @filename='C:\MSSQL\Backup\MyDB_Backup. @tsmobject = 'TSM_object' ..dbo. @tsmclientownerpwd = 'TSM_client_owner_password' .dbo. To capture the output message. run the following: declare @rmsg varchar(999) exec master. Syntax EXEC master.<procedure_name> show_help To convert the script for use with the command-line utilities. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. @resultcode=@rc output select @rc.BAK' .<procedure_name> <arguments>.<procedure_name> <arguments>.1 User Guide 204 . @init = 1 Returns 0 (success) or non-zero (failure). Return codes represent the native error number returned from SQL Server for any errors encountered during the operation. xp_delete_tsmfile Deletes an object from a specified TSM location.dbo.<procedure_name> show_cmd.xp_backup_log @database = 'MyDB' . @tsmpointintime = 'date_time' ] Arguments Tips: l l To see the list of accepted arguments and data types for arguments. <xp_arguments> LiteSpeed for SQL Server 8. @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. 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). To capture the output message. It is not possible to append an object to this location. Not required. l tsm_high_level specifies the directory path in which the file belongs. @tsmclientownerpwd Specifies the TSM client owner user password. The format is yyyy-mm-dd hh:mm:ss. If it is not passed. @tsmpointintime Specifies the date for restore/to filter results. @resultmsg=@rmsg output select @rmsg LiteSpeed for SQL Server 8. Not required.1 User Guide 205 .. @tsmconfigfile Specifies the TSM configuration file. @tsmobject Defines the TSM filespace. You can use the -I command-line argument or @init to back up to a nonunique location. then the most recent of the times must be chosen. if specified in the options file or if backing up with the Passwordaccess Generate option. if specified in the options file or if backing up with the Passwordaccess Generate option. high level and low level. Returns 0 (success) or non-zero (failure). run the following: declare @rmsg varchar(999) exec master. It can be the drive label name or UNC name. NOTE: You may only store one item the location specified by this argument. l tsm_low_level specifies actual name of the file. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l tsm_filespace is the logical space on the TSM server that contains a group of files. LiteSpeed will choose the most recent archived backup.<procedure_name> <arguments>. that is suitable for the xp_restore_database and xp_ restore_log procedures as an encrypted key.xp_encrypt_restore_key @key ='Mypassword' Results The Results tab displays the encrypted key. Syntax EXEC master. that is suitable for xp_backup_database and xp_ backup_log procedures as an encrypted key. xp_extractor Converts LiteSpeed backups to native SQL Server backups. xp_encrypt_restore_key The procedure encrypts a password into a value for @jobp.. @rmsg xp_encrypt_backup_key The procedure encrypts a password into a value for @jobp.To capture the output message and the result code.1 User Guide 206 . LiteSpeed for SQL Server 8.<procedure_name> <arguments>. See LiteSpeed Variables on page 76 for more information.dbo.dbo. Syntax EXEC master. @resultmsg=@rmsg output. @resultcode=@rc output select @rc. Syntax NOTE: You can replace argument values with variables. run the following: declare @rc int declare @rmsg varchar(999) exec master.xp_encrypt_backup_key @key ='Mypassword' Results The Results tab displays the encrypted key. Review the following for additional information: Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 3 11 1 and 2 7 111 1. and sixth bits to 1 and all other bits to 0.dbo. third. and 6 for use with LiteSpeed. <xp_arguments> @affinity Processor affinity designates specific processors to run LiteSpeed. 3. For example. 4. NOTE: 32-bit Windows is internally limited to a 32-bit mask. 3. @FileNumber = 1. Set the second. this argument accepts the following formats: LiteSpeed for SQL Server 8.xp_extractor @FileName = N'C:\Backups\backup. execute the following: exec master. you need to select processors 2. For TSM backups and TSM archives. @Init = 1. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process. Number the bits from the right to left.bkp'. This argument accepts network destinations. 7. @backupfile The name of the LiteSpeed backup device file to be extracted.xp_extractor exec master. 3. If a value begins with "0x" it is interpreted as hexadecimal. execute the following: exec master.bkp.<procedure_name> show_cmd. and 6 205 11001101 1.bak' Arguments Tips: l l To see the list of accepted arguments and data types for arguments. 2 and 3 38 100110 2. The result is binary 100110.1 User Guide 207 .. If you decide to use an affinity value other than default. it is recommended that you limit the threading as well. This argument accepts decimal values and hexadecimal values. @MTFFile = N'C:\Backups\backup. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance.<procedure_name> show_help To convert the script for use with the command-line utilities. try limiting the number of threads. You may also want to consider using Adaptive Compression to maintain backup performance. while not allowing LiteSpeed to run on the remaining processors. See Adaptive Compression on page 72 for more information. The rightmost bit represents the first processor. which is decimal 38 or hexadecimal 0x26.dbo. @maxtransfersize Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. @basesize The smallest chunk of memory LiteSpeed attempts to write to disk at any given time. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. The default is 4 retries. a backup cannot be restored or recovered without the original encryption key. CAUTION: When encrypting data. the maximum allowed setting is 1000. See Configure Logging in LiteSpeed for information about LiteSpeed logging. If you do not supply encryption key. restoring. Log file is removed on success.l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low> You can supply multiple instances of this argument. extracting or reading from files with multiple appended backups.1 User Guide 208 . l 1 or any odd value—Logging on. take care not to lose the encryption key. To log to a different directory add @Trace='logpath=path'. The default is 15 seconds. the restore will fail. The default is 1048576 (1 MB). If you use the wrong encryption key.194. This argument accepts one of the following values: l 0—Logging off. @backupindex Specifies the particular backup to use when recasting. You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure.304 bytes (4 MB). LiteSpeed for SQL Server 8. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. l 2 or any even value—Logging on. Key example: 'Mypassword' @loglevel Writes a log file for the operation. @ioflag Specifies if LiteSpeed should wait and retry the read or write operation on failure. the maximum allowed setting is 300. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. NOTE: This functionality is only available for disk operations. then the program will not encrypt the backup. @key Value used to generate the encryption key for the encryption algorithm. This is the percentage of the total amount of CPU usage (across all enabled processors) available. The argument accepts an integer value between 1 and 100. x is a number or letter that represents the sequence of the files. the base file will not have an x appended to its name. If a full path is not specified. The extractor utility will create one backup device file for each thread used in a LiteSpeed backup. In case there are no additional files. @overwrite Re-initializes (overwrites and replaces) the target native backup files. However. Where: l l base_file_name is the specified Microsoft Tape Format base file. This argument accepts one of the following values: l -1—Below Normal l 0—Normal (Default) l 1—AboveNormal l 2—High @showhelp Displays the syntax summary of the LiteSpeed command-line utility. The default value is 100.@mtffile Specify the location and name of the Microsoft Tape Format (MSTF) base file.exe will create. the extracted files will be created in the current directory. @throttle Specifies the maximum CPU usage allowed. @priority Specifies the priority of the LiteSpeed process compared to other processes running on the same server. See example 4 for more information. LiteSpeed for SQL Server 8. @trace Used by LiteSpeed to activate trace logging. The extraction utility will create all the necessary files automatically. NOTES: l l l l You can specify a network destination for this parameter. run it without this parameter.1 User Guide 209 . To see how many files extractor. You only need to specify this parameter once. You cannot tell the extraction utility to extract a different number of native SQL Server files. 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. The extracted files containing the native SQL Server backup will have the following format: base_file_namex. The format is yyyy-mm-dd hh:mm:ss. The number of virtual log files can grow based on the auto growth settings for the log file and how often the active transactions are written to disk. Too many virtual log files can cause transaction log backups to slow down and can also slow down database recovery. 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). If it is not passed. @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. @tsmpointintime Specifies the date for restore/to filter results. Not required. if specified in the options file or if backing up with the Passwordaccess Generate option. if specified in the options file or if backing up with the Passwordaccess Generate option.1 User Guide 210 . @vlf Virtual log files are the unit of truncation for the transaction log. then the most recent of the times must be chosen. LiteSpeed will choose the most recent archived backup. @tsmconfigfile Specifies the TSM configuration file. Passwords are case-sensitive. LiteSpeed for SQL Server 8. @vlfmaxsize The maximum size of virtual log files. @tsmclientownerpwd Specifies the TSM client owner user password. This argument accepts one of the following values: l 0—False (default) l 1—True @tsmfile Specifies the TSM file. @tsmuserpwd The TSM username password. @tsmdevicetimeoutminutes Specifies how long to wait for a TSM device. Not required.@tsmarchive Specifies to store the backup as a TSM archive. @tsmusername The TSM username ID. Syntax EXEC master. @Init = 1.<xp_extractor> <arguments>. @Init = 1.. @resultmsg=@rmsg output. @rmsg Convert LiteSpeed Backups to SQL Server Backups xp_memory_size Extended stored procedure to return the contiguous memory availability of the system within the SQL Server process space. run the following: declare @rc int declare @rmsg varchar(999) exec master. @FileName = N'C:\Backups\backupStripe3. @EncryptionKey = N'password'.bkp.<xp_extractor> <arguments>. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation. @resultcode=@rc output select @rc. @MTFFile = N'C:\Backups\backup.xp_extractor @FileName = N'C:\Backups\backup.1 User Guide 211 .dbo.2.. @MTFFile = N'C:\Backups\backup.bkp'.xp_extractor @FileName = N'C:\Backups\backupStripe1.1. @FileNumber = 1.bkp'. To capture the output message. @FileName = N'C:\Backups\backupStripe2.bak'.xp_memory_size LiteSpeed for SQL Server 8. run the following: declare @rmsg varchar(999) exec master.bkp'.. @MTFFile = N'C:\Backups\backup.bak' Striped backups exec master.Examples Encrypted backup conversion exec master.bkp'. This is the space to be utilized for the transfer buffer for backup and restore operations. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code..bak' Returns 0 (success) or non-zero (failure). Allows you to restore the table later or on a different location. Restore table to a . See Object Level Restores from TSM Backups on page 105 for more information. You cannot restore objects directly from TSM files or tape backups.In scenarios when you do not require any transaction log backups and the tail log. Restore table to a ship directory . you can use @destinationtable to rename the new table and restore it to the database. However. LiteSpeed may take a long time to read the backup file for large databases. LiteSpeed for SQL Server 8.Results Column Name Data Type Description ContiguousSize Int Available contiguous memory in the SQL Server process space in bytes. Objects are recovered as they existed at the time they were backed up. xp_objectrecovery Restores a table from backup files. To prevent this. You cannot recover data to a random point in time. the Optimize Object Level Recovery speed option on the Backup wizard Options page is selected by default to create the index during the backup.csv file . If a table with the same name already exists in the destination database. Object Level Recovery operations may work much faster in this case. you can enable direct mode which significantly improves deployment and configuration of your applications.csv file format. LiteSpeed will not overwrite it. NOTES: l l l l l l l You cannot restore objects from Clouds. There are several ways to restore a table: l l l Restore table to a database .Allows you to open the file with Excel or any other spreadsheet application recognizing . Tail log processing . and when running the Object Level Recovery Wizard and the Recover Table Wizard.1 User Guide 212 .Allows you to directly restore the table. you can select to bypass tail log processing. often with little response in the LiteSpeed UI Console. You can enable and disable bypass tail log processing from the toolbar. You can enable and disable the use of direct mode from the the Recover Table Wizard. Object Level Recovery does not support SQL Server 2008 Transparent Data Encryption (TDE).In scenarios where you want the application to work with SQL Server directly using a TCP/IP connection without involving the SQL Server client. Direct mode . . @diffencryptionkey = 'diff_encrypt_key'] [. @tempdirectory = 'recovery_temp_dir'] [. @logfilenumber = n ] ) [. @includetableobjects = 'options'] LiteSpeed for SQL Server 8. @destinationserver = 'dest_server_name'] [. @logfilename = 'log_file_name' [.dbo. @LSM = 'option' ] . @difffilename = 'diff_file_name'] [.n]] [. @difffilenumber = n] [. @stripedlogfilename = 'striped_log_file_name'] [. @disablelogprocessing = 0 | 1 ] Restore table to a database EXEC master.n] [. @stripedlogfilename = 'striped_log_file_name'] [.n]] [. @encryptionkey = 'encryption_key'] [( .1 User Guide 213 . @difffilenumber = n] [... @objectname = 'object_name' [... @tempdirectory = 'recovery_temp_dir'] [. @textimageonfilegroup = 'blob_filegroup_name'] [. @filenumber = n] [... @destinationtable = 'dest_table_name'] [. @logencryptionkey= 'log_encryption_key'] [.xp_objectrecovery @filename = 'backup_file_name' [..... @disablelogprocessing = 0 | 1 ] [.Syntax Preview table data EXEC master... @destinationdatabase = 'database_name' [..n] [. @prefixtableobjects = N'prefix'] [. @logfilename = 'log_file_name' [. @difffilename = 'diff_file_name'] [. @objectname = 'object_name' .. @logencryptionkey= 'log_encryption_key'] [.n] [.. @encryptionkey = 'encryption_key'] [( ...dbo. @logfilenumber = n ] ) [.n] [. @suffixtableobjects = N'suffix'] [... @onfilegroup = 'table_filegroup_name'] [..... @filenumber = n] [. @destinationserver = 'dest_server_name'] [. @diffencryptionkey = 'diff_encrypt_key'] [. @LSM = 'option' ] .xp_objectrecovery @filename = 'backup_file_name' [.n] [.n] [. . @LSM = 'option' ] .dbo.Restore table to a ship directory EXEC master.csv file EXEC master.. execute the following: exec master.<procedure_name> show_help To convert the script for use with the command-line utilities. @filenumber = n] [.. LiteSpeed for SQL Server 8. @difffilename = 'diff_file_name'] [. @suffixtableobjects = N'suffix'] [. @stripedlogfilename = 'striped_log_file_name'] [. @logencryptionkey = 'log_encryption_key'] [..n] [.xp_objectrecovery @filename = 'backup_file_name' [. @logfilename = 'log_file_name' [. @stripedlogfilename = 'striped_log_file_name'] [......n]] [. @destinationtable = 'dest_table_name'] [.. @objectname = 'object_name' . @difffilenumber = n] [. @diffencryptionkey = 'diff_encrypt_key'] [.n] [. @logfilenumber = n ] ) [. @encryptionkey = 'encryption_key'] [( .xp_objectrecovery @filename = 'backup_file_name' [. @includetableobjects = 'options'] Arguments Tips: l l To see the list of accepted arguments and data types for arguments...n] [.n] [.. @diffencryptionkey = 'diff_encrypt_key'] [.n] [. @destinationfilename = 'csv_file_name' [.dbo. @onfilegroup = 'table_filegroup_name'] [.<procedure_name> show_cmd. @disablelogprocessing = 0 | 1 ] [.n] [. @encryptionkey = 'encryption_key'] [( . @logfilenumber = n ] ) [. @textimageonfilegroup = 'blob_filegroup_name'] [.n]] [. @difffilename = 'diff_file_name'] [. @logfilename = 'log_file_name' [....1 User Guide 214 ... @prefixtableobjects = N'prefix'] [.. @objectname = 'object_name' .. @disablelogprocessing = 0 | 1 ] [... @includetableobjects = 'options'] Restore table to a . <xp_arguments> @backend Object Level Recovery can restore tables using two different internal techniques to handle the record inserts..dbo. execute the following: exec master.. @shipdirectory = 'recovery_ship_dir' [. @logencryptionkey = 'log_encryption_key'] [.dbo. @difffilenumber = n] [. @filenumber = n] [. @LSM = 'option' ] . LiteSpeed will not overwrite an existing table. @destinationserver Name of the destination server. To make this the default method set the value “BackEnd=SQLNativeClient” in the Object Level Recovery section of the LiteSpeed configuration file. @diffencryptionkey Value used to generate the encryption key for the encryption algorithm. This is an ad hoc solution for users want to see the restored data in Excel. LiteSpeed will attempt to insert (append) all selected records into existing table.csv) that is generated instead restoring into a database. You can only use this argument for text data. LiteSpeed for SQL Server 8. take care not to lose the encryption key. This will set the number of row inserts for each batched transaction. If you select the same server instance and database as the original table. If you do not supply encryption key. The default TEMP location can be set by using the @TempDirectory parameter or by setting a permanent temp location in the LiteSpeed configuration file. To enable this method. Used for differential backups instead of full backup files. An alternate insertion method can be specified to use Sql Server’s Sql Native Client capabilities. Caution: When encrypting data. @difffilename Name of backup file to restore. Example of key: 'Mypassword' Equivalent to @encryptionkey. you must use a different table name.1 User Guide 215 . a backup cannot be restored or recovered without the original encryption key. Object Level Recovery will write a BCP format file and an accompanying binary data file to the local file system. but used for differential backups instead of full backup files. @destinationfilename Name of comma separated file (. Regardless of the insertion method used. the restore will fail.The first and default method uses BCP files and a TSQL BULK INSERT statement. These files may become very large depending on the table size and will require permissions to write to a temporary directory. use the parameter @backend='SQLNativeClient' (or -b 1 from the command line). @destinationtable Specifies the name of the destination table. NOTE: For Execute-Select operations. then the program will not encrypt the backup. This method inserts row-data directly into the destination database bypassing any storage on the local file-system. @destinationdatabase Specifies the destination database. the batch size can be globally managed by setting the value “BulkImportBatchSize=<N>”. If you use the wrong encryption key. You can supply multiple instances of this argument. If you do not supply encryption key. LiteSpeed for SQL Server 8. @encryptionkey Value used to generate the encryption key for the encryption algorithm. take care not to lose the encryption key. Example of key: 'Mypassword' @filename The name of the LiteSpeed backup device file to be extracted. a backup cannot be restored or recovered without the original encryption key. Caution: When encrypting data. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. restoring. Equivalent to @filenumber. @disablelogprocessing Instructs LiteSpeed to skip all transaction log backups and tail log processing. This argument accepts network destinations.1 User Guide 216 . extracting or reading from files with multiple appended backups.@difffilenumber Identifies the backup file within the backup set. but used for differential backups instead of full backup files. This may improve read and recovery times. @includetableobjects Instructs LiteSpeed to script or recover one or more of the following: l Constraints—But not foreign keys l ForeignKeys l Indexes l Statistics l Triggers l All—All of the above The value is a list of options. For TSM backups and TSM archives. @filenumber Specifies the particular backup to use when recasting. separated with commas. the restore will fail. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. This argument accepts one of the following values: l l 0—False (Default). 1—True. If you use the wrong encryption key. then the program will not encrypt the backup. LiteSpeed will entirely ignore any transaction log backups specified and will not process the tail log. the restore will fail.bcp LiteSpeed for SQL Server 8. a backup cannot be restored or recovered without the original encryption key. Use this argument when you want to restore the object later or at a different physical location.sql l <object_name>. then the program will not encrypt the backup. @prefixtableobjects Adds a prefix to the names of the table's objects you selected to script or recover. @onfilegroup Filegroup with the object to restore. @LSM Specifies handling for OLR LSM mapfile(s). You can supply multiple instances of this argument. @objectname Specifies the name of the object to recover. Equivalent to @filenumber. Caution: When encrypting data.sql l BULK INSERT <object_name>. This argument creates the following files in the ship directory: l CREATE <object_name>. If you do not supply encryption key. @logfilename Specifies location and name of the log backup file. but used for log backups. l Keep—Does not delete mapfile(s) when complete.fmt l <object_name>. but used for transaction log backups. Example of key: 'Mypassword' Equivalent to @encryptionkey. It will ignore attached LSM. take care not to lose the encryption key. @logfilenumber Identifies the log backup file within the backup set. If you use the wrong encryption key.@logencryptionkey Value used to generate the encryption key for the encryption algorithm.1 User Guide 217 . @shipdirectory Name of the ship directory. l Delete—Always deletes mapfile(s) when complete. See Syntax on page 213 for more information. l Create—Reads backup and creates a new mapfile. xp_objectrecovery @filename='C:\MSSQL\Backup\MyDB_Backup. You will need to slightly modify the BULK INSERT file because of the .ini file.dbo. Use this argument when the default Windows temp directory does not have enough free disk space for the restore process.fmt and . Examples Preview a table from a full backup file EXEC master. @FileNumber = 1. @stripedlogfilename Specifies the striped log file name. @tempdirectory Specifies a temporary directory for use with Object Level Recovery.xp_objectrecovery @filename = 'C:\MSSQL\Backup\MyDB_Backup. @filenumber = 1. . @filenumber = 1. @ObjectName = N'dbo.BAK' .Customers' .bak'. @objectname = 'dbo. (Usually. @suffixtableobjects Adds a suffix to the names of the table's objects you selected to script or recover. NOTE: The striped files for a given log backup must be specified before the next log backup set is specified.[Roles]'.To restore the object. @DestinationTable = N'[dbo]. Tip: You can zip the files and send them to someone else.BAK'.bcp file path names.1 User Guide 218 .dbo.) @textimageonfilegroup Destination TEXTIMAGE_ON filegroup name.ini. @destinationdatabase = 'tempdb' Restore multiple tables and tables' constraints and indexes exec xp_objectrecovery @FileName = N'C:\temp\HiServ_full. NOTE: You can specify the default temp directory using the TempPath parameter in the [LiteSpeed] section of the LiteSpeedSettings. LiteSpeed for SQL Server 8. @objectname='dbo. run the CREATE file first. Used to restore a BLOB (binary large object). and then run the BULK INSERT file. C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\LiteSpeedSettings. @DestinationDatabase = N'HiServ'.Customers' Restore a table from a full backup file into a database EXEC master.Roles'. Projects'. @ObjectName = N'dbo. @logencryptionkey = 'key' .bak'. @filename='C:\TestSCriptBackups\' .dbo.BAK' .bak'.xp_objectrecovery @filename = 'C:\MSSQL\Backup\MyDB_Backup. @encryptionkey = 'key' . @FileNumber = 1. @DestinationTable = N'[dbo].bak'. @DestinationServer = N'w2k3-22\LITESPEED'. exec xp_objectrecovery @FileName = N'C:\temp\HiServ_full.xp_objectrecovery @filename='C:\TestSCriptBackups\full_Mon' . filegroup and temp directory parameters EXEC master. constraints. @filenumber=1 . exec xp_objectrecovery @FileName = N'C:\temp\HiServ_full. @destinationserver = 'MyMachine\SQL2000' . constraints.bak'. @ObjectName = N'dbo. @DestinationTable = N'[dbo]. @stripedlogfilename='C:\TestSCriptBackups\Log_Mon_0900_3' .[Customers]'. exec xp_objectrecovery @FileName = N'C:\temp\HiServ_full. @DestinationServer = N'w2k3-22\LITESPEED'. @FileNumber = 1.Customers'. @onfilegroup = 'Secondary' . @logfilenumber=1 LiteSpeed for SQL Server 8. @ObjectName = N'dbo. @ObjectName = N'dbo. constraints. @DestinationServer = N'w2k3-22\LITESPEED'. @FileNumber = 1. @IncludeTableObjects = N'indexes. @stripedlogfilename='C:\TestSCriptBackups\Log_Mon_0900_2' . server.Restored_Customers' . @IncludeTableObjects = N'indexes. exec xp_objectrecovery @FileName = N'C:\temp\HiServ_full. @FileNumber = 1. @objectname = 'dbo. @destinationdatabase = 'tempdb' . @DestinationDatabase = N'HiServ'.1 User Guide 219 .Employees'. @DestinationServer = N'w2k3-22\LITESPEED'. @logfilename='C:\TestSCriptBackups\Log_Mon_0900_1' . @DestinationTable = N'[dbo].[Positions]'.dbo. @IncludeTableObjects = N'indexes.Customers' . constraints. constraints. @DestinationDatabase = N'HiServ'. @DestinationDatabase = N'HiServ'.[Employees]'.Positions'. @IncludeTableObjects = N'indexes.@DestinationServer = N'w2k3-22\LITESPEED'. @IncludeTableObjects = N'indexes.[Projects]'. @destinationtable = 'dbo. @textimageonfilegroup = 'Secondary' Restore a table from a striped backup EXEC master. @DestinationDatabase = N'HiServ'. @tempdirectory = 'D:\temp' . foreignKeys' foreignKeys' foreignKeys' foreignKeys' foreignKeys' Restore a table from a full backup file to a database using table. @DestinationTable = N'[dbo]. dbo. To capture the output message.<procedure_name> <arguments>.csv' Returns 0 (success) or non-zero (failure)..BAK' . @rmsg xp_objectrecovery_createscript Creates DDL scripts. @resultmsg=@rmsg output. @objectname = 'dbo..dbo. @destinationtable='dbo.csv file EXEC master. @destinationdatabase='OLRRegressionTest' . NOTE: When using scripts.xp_objectrecovery @filename = 'C:\MSSQL\Backup\MyDB_Backup. run the following: declare @rmsg varchar(999) exec master. @destinationfilename = 'C:\temp\Customers. @resultcode=@rc output select @rc.See Object Level Restores from TSM Backups on page 105 for more information. You can use this extended stored procedure to restore objects other than tables by generating the DDL scripts and then running the scripts in your native SQL Server tool (such as Management Studio).xp_objectrecovery @filename = 'C:\MSSQL\Backup\MyDB_Backup..<procedure_name> <arguments>. LiteSpeed for SQL Server 8.Customers' . Return codes represent the native error number returned from SQL Server for any errors encountered during the operation. @objectname='dbo.BAK' . single column result set so other products can programmatically acquire the script without having to parse the message results. the message output results are rendered in a multi row.1 User Guide 220 .employees_recovered' . @shipdirectory = 'C:\temp\ship' Restore a table from a full backup file to a . @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. @objectname = 'dbo. run the following: declare @rc int declare @rmsg varchar(999) exec master.employees' Restore a table from a full backup file to a ship directory EXEC master.Customers' . The script then remains in the message output and result set locations. You can supply multiple instances of this argument.. @textimageonfilegroup = 'blob_filegroup_name'] [. @difffilenumber Identifies the backup file within the backup set.. @objectfilename = 'object_file_name' . @stripedlogfilename = 'striped_log_file_name'] [. @prefixtableobjects = N'prefix'] [.. but used for differential backups instead of full backup files. @type = 'object_type'] [.<procedure_name> show_cmd. @objectname = 'object_name' .n] [. Caution: When encrypting data. @logencryptionkey = 'log_encryption_key'] [. @disablelogprocessing = 0 | 1 ] [. @includetableobjects = 'options'] [. @difffilenumber = n] [. then the program will not encrypt the backup. If you use the wrong encryption key.dbo... @suffixtableobjects = N'suffix'] Arguments Tips: l l To see the list of accepted arguments and data types for arguments.xp_objectrecovery_createscript (@filename = 'backup_file_name') [. @diffencryptionkey = 'diff_encrypt_key'] [... but used for differential backups instead of full backup files.dbo. If you do not supply encryption key.. Used for differential backups instead of full backup files.n] [. Equivalent to @filenumber..Syntax EXEC master. the restore will fail. a backup cannot be restored or recovered without the original encryption key.dbo. @difffilename Name of backup file to restore..1 User Guide 221 . <xp_arguments> @diffencryptionkey Value used to generate the encryption key for the encryption algorithm. LiteSpeed for SQL Server 8. @filenumber = n] [. @scriptfilename = 'script_file_name' [.n] [. @onfilegroup = 'table_filegroup_name'] [. Example of key: 'Mypassword' Equivalent to @encryptionkey. @logfilename = 'log_file_name' [. @logfilenumber = n ] ) [. execute the following: exec master... execute the following: exec master. take care not to lose the encryption key. @LSM = 'option' ] .n]] [.<procedure_name> show_help To convert the script for use with the command-line utilities. @encryptionkey = 'encryption_key'] [( . @difffilename = 'diff_file_name'] [. separated with commas. then the program will not encrypt the backup. extracting or reading from files with multiple appended backups.@disablelogprocessing Instructs LiteSpeed to skip all transaction log backups and tail log processing. @filenumber Specifies the particular backup to use when recasting. LiteSpeed will entirely ignore any transaction log backups specified and will not process the tail log. the restore will fail. For TSM backups and TSM archives. restoring. Example of key: 'Mypassword' @filename The name of the LiteSpeed backup device file to be extracted. If you use the wrong encryption key. @logencryptionkey Value used to generate the encryption key for the encryption algorithm.1 User Guide 222 . If you do not supply encryption key. This may improve read and recovery times. @includetableobjects Instructs LiteSpeed to script or recover one or more of the following: l Constraints—But not foreign keys l ForeignKeys l Indexes l Statistics l Triggers l All—All of the above The value is a list of options. If you do not supply encryption key. take care not to lose the encryption key. If you use the wrong encryption key. @encryptionkey Value used to generate the encryption key for the encryption algorithm. This argument accepts one of the following values: l l 0—False (Default). LiteSpeed for SQL Server 8. the restore will fail. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. Caution: When encrypting data. 1—True. This argument accepts network destinations. then the program will not encrypt the backup. a backup cannot be restored or recovered without the original encryption key. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. See Syntax on page 221 for more information. @stripedlogfilename Specifies the striped log file name. @LSM Specifies handling for OLR LSM mapfile(s). LiteSpeed for SQL Server 8. The format of this file is "ObjectType. @prefixtableobjects Adds a prefix to the names of the table's objects you selected to script or recover. @logfilename Specifies location and name of the log backup file. NOTE: The striped files for a given log backup must be specified before the next log backup set is specified. @logfilenumber Identifies the log backup file within the backup set. but used for transaction log backups. l Keep—Does not delete mapfile(s) when complete. @onfilegroup Filegroup with the object to restore. but used for log backups. a backup cannot be restored or recovered without the original encryption key. l Create—Reads backup and creates a new mapfile. @objectname Specifies the name of the object to recover. l Delete—Always deletes mapfile(s) when complete.Caution: When encrypting data. @objectfilename Identifies a file that contains a list of objects. You can create the list using xp_objectrecovery_viewcontents. You can supply multiple instances of this argument. Equivalent to @filenumber. @scriptfilename Name of the script file to save the generated SQL scripts. Example of key: 'Mypassword' Equivalent to @encryptionkey.ObjectName" per line. It will ignore attached LSM. take care not to lose the encryption key. See xp_objectrecovery_viewcontents on page 233 for more information.1 User Guide 223 . @ObjectName (-C) is not the name of the object. @textimageonfilegroup Destination TEXTIMAGE_ON filegroup name. @type = 'Database' . This argument accepts one of the following values: l All 1.sql' LiteSpeed for SQL Server 8. so you should use this argument to recover schema objects other than tables. They are only used to generate SQL scripts to alter the table. Used to restore a BLOB (binary large object). All pseudo-table object types will be listed even though they might not exist for the associated table. which are prefixed with "object_type.BAK' . but the name of the owning table.1 User Guide 224 . @scriptfilename = 'C:\sql\CREATE_DATABASE.xp_objectrecovery_createscript @filename = 'C:\MSSQL\Backup\MyDB_Backup. and they will be ignored when used with -V or xp_objectrecovery_ viewcontents. ". If you omit this parameter the object type defaults to table.dbo. Examples Generate SQL script to create a database EXEC master. @type Specifies the type of object. 3 l TableConstraintClustered 2 l Database l TableConstraints 2 l Default l TableForeignKeys 2 l ExtendedProcedure l TableIndexClustered 2 l Function l TableIndexes 2 l PartitionFunction l TableStatistics2 l PartitionScheme l TableTriggers 2 l Role 1 l Trigger l Rule l Type l StoredProcedure l User 1 l SystemTable l View l Table l XmlSchemaCollection NOTES: 1 These values cannot be used to create scripts. 3 This value lists all object types. 2 These values are pseudo-object types and are not real schema objects.@suffixtableobjects Adds a suffix to the names of the table's objects you selected to script or recover. When one of these values is used with -C or xp_objectrecovery_createscript. xp_objectrecovery_createscript @filename = 'C:\MSSQL\Backup\MyDB_Backup.dbo.[Order Details] TableIndexClustered. constraints.Customers TableConstraints. @objectfilename = 'C:\temp\MyDB_All. @scriptfilename = 'C:\sql\CREATE_Customers. @includetableobjects='indexes. @type = 'TableConstraintClustered' Generate SQL scripts to create a view EXEC master. @objectname = 'dbo.Orders Table.xp_objectrecovery_createscript @filename='C:\MSSQL\Backup\MyDB_Backup.xp_objectrecovery_createscript @filename = 'C:\MSSQL\Backup\MyDB_Backup.dbo.dbo.1 User Guide 225 .dbo.BAK' .dbo.sql' Generate SQL scripts to restore a table.xp_objectrecovery_createscript @filename = 'C:\MSSQL\Backup\MyDB_Backup.dbo.Generate SQL scripts to create a table EXEC master.dbo.BAK' .Products TableConstraints.Products TableIndexClustered.xp_objectrecovery_createscript @filename = 'C:\MSSQL\Backup\MyDB_Backup. @objectname='tbl' .Orders TableConstraintClustered. @type='table' .dbo.dbo.txt looks like the following: Table.dbo.[Order Details] LiteSpeed for SQL Server 8.[Order Details] TableConstraintClustered. @scriptfilename = 'C:\sql\CREATE_VIEW_Invoices.Customers' .dbo.dbo. constraints and foreign keys EXEC master.Customers Table.dbo. @objectname = 'dbo.sql' . @scriptfilename = 'C:\sql\ALTER_Customers. @scriptfilename = 'C:\sql\CREATE_VIEW_Invoices.Customers TableIndexClustered.dbo.BAK' .Customers' . @prefixtableobjects='test_' .dbo.Products TableConstraintClustered. foreignkeys' Generate SQL scripts to alter a table EXEC master.Customers TableConstraintClustered.sql' .dbo.txt' .BAK' .dbo.BAK' . @objectname = 'dbo.dbo.sql' Where the MyDB_ALL.Orders TableIndexClustered.Invoices' . including table's indexes.dbo.[Order Details] Table. @type = 'View' Generate SQL scripts for objects listed in an object file EXEC master. <procedure_name> <arguments>.[Ten Most Expensive Products] Returns 0 (success) or non-zero (failure).dbo.dbo.TableConstraints.dbo.[Order Details] TableForeignKeys. run the following: declare @rc int declare @rmsg varchar(999) exec master. @resultmsg=@rmsg output. The SELECT results can be a table in a database.Products TableForeignKeys. or a . which you can use for row-level restores.Orders TableConstraints.[Current Product List] StoredProcedure.Orders TableTriggers. ship directory. run the following: declare @rmsg varchar(999) exec master. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation.Customers TableTriggers.Products TableIndexes. @resultcode=@rc output select @rc.dbo.Customers TableForeignKeys.Orders TableForeignKeys.dbo.csv file.dbo. @rmsg xp_objectrecovery_executeselect Execute SELECT statement queries against the backup files.dbo. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code.dbo.1 User Guide 226 .dbo.<procedure_name> <arguments>.dbo.Customers TableIndexes.dbo.Products View.dbo.dbo.dbo.Orders TableIndexes. LiteSpeed for SQL Server 8.dbo...[Order Details] TableTriggers.[Sales by Year] StoredProcedure.dbo.Products TableTriggers. To capture the output message.CustOrdersDetail StoredProcedure.dbo.dbo.[Order Details] TableIndexes. @destinationtable = 'dest_table_name' [.n]] [. @filenumber = n] [. @encryptionkey = 'encryption_key'] [( .. @scripttext = 'script_text' | .1 User Guide 227 . @destinationserver = 'dest_server_name'] [...n] [. @diffencryptionkey= 'diff_encrypt_key'] [. @scriptfilename = 'script_file_name'} [. @logfilenumber = n ] ) [.... @difffilename = 'diff_file_name'] [.. @stripedlogfilename = 'striped_log_file_name'] [. @destinationserver = 'dest_server_name'] [.. @logfilename = 'log_file_name' [....dbo. @textimageonfilegroup = 'blob_filegroup_name'] [. @diffencryptionkey= 'diff_encrypt_key'] [. @difffilenumber = n] [.n] [. @logencryptionkey = 'log_encryption_key'] [.. @tempdirectory = 'recovery_temp_dir'] [. @LSM = 'option' ] {.. @difffilenumber = n] [.Syntax View the SELECT query results EXEC master.dbo. @tempdirectory = 'recovery_temp_dir'] [. @scripttext = 'script_text' | . @stripedlogfilename = 'striped_log_file_name'] [......xp_objectrecovery_executeselect (@filename = 'backup_file_name') [. @disablelogprocessing = 0 | 1 ] LiteSpeed for SQL Server 8.n] [. @prefixtableobjects = N'prefix'] [..n] [. @destinationdatabase = 'database_name' [..n] [. @suffixtableobjects = N'suffix'] . @filenumber = n] [. @LSM = 'option' ] {...n] [. @scriptfilename = 'script_file_name'} . @onfilegroup = 'table_filegroup_name'] [..xp_objectrecovery_executeselect (@filename = 'backup_file_name') [. @logfilenumber = n ] ) [.n]] [. @encryptionkey = 'encryption_key'] [( . @difffilename = 'diff_file_name'] [.. @logencryptionkey = 'log_encryption_key'] [. @logfilename = 'log_file_name' [. @disablelogprocessing = 0 | 1 ] Restore the SELECT query results into a database EXEC master. @scriptfilename = 'script_file_name'} .. @difffilename = 'diff_file_name'] [. @difffilenumber = n] [..n] [. @disablelogprocessing = 0 | 1 ] Recover the SELECT query results into a . @suffixtableobjects = N'suffix'] . @difffilenumber = n] [. @diffencryptionkey= 'diff_encrypt_key'] [. @stripedlogfilename = 'striped_log_file_name'] [..1 User Guide 228 .n]] [.xp_objectrecovery_executeselect (@filename = 'backup_file_name') [.... <xp_arguments> @backend Object Level Recovery can restore tables using two different internal techniques to handle the record inserts... @logencryptionkey = 'log_encryption_key'] [.<procedure_name> show_cmd. @logfilenumber = n ] ) [. @onfilegroup = 'table_filegroup_name'] [. execute the following: exec master. @disablelogprocessing = 0 | 1 ] Arguments Tips: l l To see the list of accepted arguments and data types for arguments. @textimageonfilegroup = 'blob_filegroup_name'] [.Recover the SELECT query results into a ship directory EXEC master. execute the following: exec master.n] [.<procedure_name> show_help To convert the script for use with the command-line utilities.. @scripttext = 'script_text' | . @difffilename = 'diff_file_name'] [. @logencryptionkey = 'log_encryption_key'] [. LiteSpeed for SQL Server 8..n] [.n]] [. @filenumber = n] [.. @stripedlogfilename = 'striped_log_file_name'] [.n] [.. @encryptionkey = 'encryption_key'] [( . @scripttext = 'script_text' | .csv file EXEC master.dbo.. @encryptionkey = 'encryption_key'] [( . @destinationtable = 'dest_table_name' [.. @logfilename = 'log_file_name' [..dbo.. @diffencryptionkey = 'diff_encrypt_key'] [...dbo. @filenumber = n] [.dbo.. @logfilename = 'log_file_name' [.. @scriptfilename = 'script_file_name'} . @shipdirectory = 'recovery_ship_dir' [... @prefixtableobjects = N'prefix'] [..n] [. @destinationfilename = 'csv_file_name' [.. @logfilenumber = n ] ) [. @LSM = 'option' ] {.xp_objectrecovery_executeselect (@filename = 'backup_file_name') [. @LSM = 'option' ] {.n] [. These files may become very large depending on the table size and will require permissions to write to a temporary directory. take care not to lose the encryption key. This method inserts row-data directly into the destination database bypassing any storage on the local file-system. You can only use this argument for text data. LiteSpeed for SQL Server 8. NOTE: For Execute-Select operations. @destinationfilename Name of comma separated file (. This is an ad hoc solution for users want to see the restored data in Excel. you must use a different table name. If you do not supply encryption key. If you select the same server instance and database as the original table. LiteSpeed will not overwrite an existing table. Object Level Recovery will write a BCP format file and an accompanying binary data file to the local file system. @destinationtable Specifies the name of the destination table.The first and default method uses BCP files and a TSQL BULK INSERT statement. To make this the default method set the value “BackEnd=SQLNativeClient” in the Object Level Recovery section of the LiteSpeed configuration file. then the program will not encrypt the backup. This will set the number of row inserts for each batched transaction. LiteSpeed will attempt to insert (append) all selected records into existing table. Caution: When encrypting data. the batch size can be globally managed by setting the value “BulkImportBatchSize=<N>”. You can supply multiple instances of this argument. Example of key: 'Mypassword' Equivalent to @encryptionkey. but used for differential backups instead of full backup files. a backup cannot be restored or recovered without the original encryption key.1 User Guide 229 . The default TEMP location can be set by using the @TempDirectory parameter or by setting a permanent temp location in the LiteSpeed configuration file. @destinationdatabase Specifies the destination database.csv) that is generated instead restoring into a database. Regardless of the insertion method used. If you use the wrong encryption key. @diffencryptionkey Value used to generate the encryption key for the encryption algorithm. To enable this method. Used for differential backups instead of full backup files. the restore will fail. @difffilename Name of backup file to restore. @destinationserver Name of the destination server. An alternate insertion method can be specified to use Sql Server’s Sql Native Client capabilities. use the parameter @backend='SQLNativeClient' (or -b 1 from the command line). restoring. You can supply multiple instances of this argument. Equivalent to @filenumber. Example of key: 'Mypassword' @filename The name of the LiteSpeed backup device file to be extracted. @filenumber Specifies the particular backup to use when recasting. If you use the wrong encryption key. Caution: When encrypting data. If you use the wrong encryption key. take care not to lose the encryption key. Example of key: 'Mypassword' Equivalent to @encryptionkey. 1—True. Caution: When encrypting data. extracting or reading from files with multiple appended backups. a backup cannot be restored or recovered without the original encryption key. If you do not supply encryption key. @logencryptionkey Value used to generate the encryption key for the encryption algorithm. then the program will not encrypt the backup. a backup cannot be restored or recovered without the original encryption key. @encryptionkey Value used to generate the encryption key for the encryption algorithm. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. This argument accepts network destinations. This argument accepts one of the following values: l l 0—False (Default).1 User Guide 230 .@difffilenumber Identifies the backup file within the backup set. If you do not supply encryption key. @disablelogprocessing Instructs LiteSpeed to skip all transaction log backups and tail log processing. then the program will not encrypt the backup. @logfilename Specifies location and name of the log backup file. the restore will fail. the restore will fail. LiteSpeed will entirely ignore any transaction log backups specified and will not process the tail log. but used for differential backups instead of full backup files. but used for transaction log backups. take care not to lose the encryption key. For TSM backups and TSM archives. LiteSpeed for SQL Server 8. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. This may improve read and recovery times. The SELECT statement is imbedded in a single-quoted string literal. It will ignore attached LSM. run the CREATE file first. You can also use SET QUOTED_IDENTIFIER OFF to allow double quotes. @scripttext = "SELECT * FROM dbo.BAK' . l Delete—Always deletes mapfile(s) when complete.bcp file path names.Customers WHERE City='London'" .sql l <object_name>. and then run the BULK INSERT file.sql l BULK INSERT <object_name>.CustomersInLondon' .Customers WHERE City=''London''' The single quoted string literal 'London' is double single-quoted.1 User Guide 231 . @onfilegroup Filegroup with the object to restore. @logfilenumber Identifies the log backup file within the backup set. @scriptfilename Name of the SELECT script file to be executed. LiteSpeed for SQL Server 8. @destinationtable = 'dbo. l Keep—Does not delete mapfile(s) when complete. @destinationdatabase = 'MyDB' @shipdirectory Name of the ship directory. For example: SET QUOTED_IDENTIFIER OFF EXEC xp_objectrecovery_executeselect @filename = 'C:\MSSQL\Backup\MyDB_Backup. Equivalent to @filenumber. and all single-quoted string literals in the SELECT statement need to be double singlequoted. For example: @scripttext = 'SELECT * FROM dbo. This argument creates the following files in the ship directory: l CREATE <object_name>. but used for log backups.See Syntax on page 227 for more information. Tip: You can zip the files and send them to someone else.fmt and . You will need to slightly modify the BULK INSERT file because of the . @scripttext The text of the SELECT script to be executed.fmt l <object_name>. l Create—Reads backup and creates a new mapfile.bcp To restore the object. @LSM Specifies handling for OLR LSM mapfile(s). Use this argument when you want to restore the object later or at a different physical location. BAK' .CustomersInLondon' . C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\LiteSpeedSettings. @destinationtable = 'dbo.sql' .bak' .ini. @destinationdatabase = 'MyDB' Restore the SELECT query results into a database using script file EXEC master. @scripttext = 'select top (4)* from dbo. @destinationtable = 'dbo.dbo.Customers WHERE City=''London''' .) @textimageonfilegroup Destination TEXTIMAGE_ON filegroup name. NOTE: The striped files for a given log backup must be specified before the next log backup set is specified. Examples View the SELECT query results xp_objectrecovery_executeselect @filename = 'D:\temp\LiteSpeedLocal. @scriptfilename = 'C:\temp\SelectCustomerFromLondon. @tempdirectory Specifies a temporary directory for use with Object Level Recovery. @scripttext = 'SELECT * FROM dbo. @tempdirectory = 'D:\temp' . Used to restore a BLOB (binary large object). (Usually.CustomersInLondon' . Use this argument when the default Windows temp directory does not have enough free disk space for the restore process.BAK' . NOTE: You can specify the default temp directory using the TempPath parameter in the [LiteSpeed] section of the LiteSpeedSettings. @textimageonfilegroup = 'Secondary' LiteSpeed for SQL Server 8.xp_objectrecovery_executeselect @filename = 'C:\MSSQL\Backup\MyDB_Backup. @onfilegroup = 'Secondary' .dbo. @destinationserver = 'MyMachine\SQL2000' .LiteSpeedActivity' Restore the SELECT query results into a database using inline script EXEC master.ini file.1 User Guide 232 .xp_objectrecovery_executeselect @filename = 'C:\MSSQL\Backup\MyDB_Backup. @destinationdatabase = 'MyDB' .@stripedlogfilename Specifies the striped log file name. . @encryptionkey = 'encryption_key'] [( .CustomersInLondon' . Syntax EXEC master.. @filenumber = n] [.sql' .dbo. @resultmsg=@rmsg output...n] [.n] [. @scriptfilename = 'C:\temp\SelectCustomerFromLondon.<procedure_name> <arguments>.. @difffilenumber = n] [.sql' .dbo..<procedure_name> <arguments>. @logfilenumber = n ] ) [.BAK' .BAK' .csv file EXEC master. @diffencryptionkey = 'diff_encrypt_key'] [. run the following: declare @rc int declare @rmsg varchar(999) exec master. @type = 'object_type'] [.n]] [. @rmsg xp_objectrecovery_viewcontents Lists the objects within the backup file. @resultcode=@rc output select @rc. @logfilename = 'log_file_name' [. @shipdirectory = 'C:\temp\London' Restore the SELECT query results into a .csv' Returns 0 (success) or non-zero (failure).xp_objectrecovery_executeselect @filename = 'C:\MSSQL\Backup\MyDB_Backup.. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation. @disablelogprocessing = 0 | 1 ] [. @destinationtable = 'dbo..xp_objectrecovery_executeselect @filename = 'C:\MSSQL\Backup\MyDB_Backup. @logencryptionkey = 'log_encryption_key'] [. @difffilename = 'diff_file_name'] [.xp_objectrecovery_viewcontents (@filename = 'backup_file_name') [. @destinationfilename = 'C:\temp\LondonCustomer. @LSM = 'option' ] LiteSpeed for SQL Server 8. @scriptfilename = 'C:\temp\SelectCustomerFromLondon. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code.Restore the SELECT query results into ship directory EXEC master...1 User Guide 233 . @stripedlogfilename = 'striped_log_file_name'] [.... To capture the output message..n] [.dbo. run the following: declare @rmsg varchar(999) exec master. @difffilenumber Identifies the backup file within the backup set. a backup cannot be restored or recovered without the original encryption key. but used for differential backups instead of full backup files. the restore will fail. LiteSpeed will entirely ignore any transaction log backups specified and will not process the tail log.1 User Guide 234 .Arguments Tips: l l To see the list of accepted arguments and data types for arguments.dbo.<procedure_name> show_help To convert the script for use with the command-line utilities. <xp_arguments> @diffencryptionkey Value used to generate the encryption key for the encryption algorithm. the restore will fail. This may improve read and recovery times. Caution: When encrypting data. You can supply multiple instances of this argument.<procedure_name> show_cmd.dbo. 1—True. take care not to lose the encryption key. @difffilename Name of backup file to restore. take care not to lose the encryption key. a backup cannot be restored or recovered without the original encryption key. Example of key: 'Mypassword' Equivalent to @encryptionkey. this argument accepts the following formats: LiteSpeed for SQL Server 8. execute the following: exec master. Example of key: 'Mypassword' @filename The name of the LiteSpeed backup device file to be extracted. execute the following: exec master. This argument accepts one of the following values: l l 0—False (Default). then the program will not encrypt the backup. This argument accepts network destinations. If you do not supply encryption key. @disablelogprocessing Instructs LiteSpeed to skip all transaction log backups and tail log processing. If you use the wrong encryption key. Used for differential backups instead of full backup files. Caution: When encrypting data. If you do not supply encryption key. For TSM backups and TSM archives. but used for differential backups instead of full backup files. then the program will not encrypt the backup. Equivalent to @filenumber. @encryptionkey Value used to generate the encryption key for the encryption algorithm. If you use the wrong encryption key. @filenumber Specifies the particular backup to use when recasting. @logfilenumber Identifies the log backup file within the backup set. @type Specifies the type of object. extracting or reading from files with multiple appended backups. This argument accepts one of the following values: l All 1. then the program will not encrypt the backup. l Delete—Always deletes mapfile(s) when complete. a backup cannot be restored or recovered without the original encryption key. You can supply multiple instances of this argument. l Keep—Does not delete mapfile(s) when complete. Caution: When encrypting data. Example of key: 'Mypassword' Equivalent to @encryptionkey.l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. the restore will fail. but used for transaction log backups. take care not to lose the encryption key. @stripedlogfilename Specifies the striped log file name. 3 l TableConstraintClustered 2 l Database l TableConstraints 2 l Default l TableForeignKeys 2 LiteSpeed for SQL Server 8. If you do not supply encryption key. restoring. If you omit this parameter the object type defaults to table. l Create—Reads backup and creates a new mapfile. NOTE: The striped files for a given log backup must be specified before the next log backup set is specified. @logencryptionkey Value used to generate the encryption key for the encryption algorithm. but used for log backups. See Syntax on page 233 for more information. It will ignore attached LSM. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. so you should use this argument to recover schema objects other than tables. @logfilename Specifies location and name of the log backup file.1 User Guide 235 . Equivalent to @filenumber. If you use the wrong encryption key. @LSM Specifies handling for OLR LSM mapfile(s). BAK' . @filenumber=1 . 2 These values are pseudo-object types and are not real schema objects.xp_objectrecovery_viewcontents @filename='C:\MSSQL\Backup\MyDB_Backup. @filenumber=2 .dbo. They are only used to generate SQL scripts to alter the table. and they will be ignored when used with -V or xp_objectrecovery_ viewcontents. Examples List table objects for backup set #1 on a full backup file EXEC master. @difffilename='C:\MSSQL\Backup\MyDB_Diff.BAK' . ". 3 This value lists all object types. @difffilenumber=3 . All pseudo-table object types will be listed even though they might not exist for the associated table.xp_objectrecovery_viewcontents @filename='C:\MSSQL\Backup\MyDB_Backup.BAK' List all objects for backup set #1 on an encrypted SLS full backup file EXEC master. @type='View' LiteSpeed for SQL Server 8. @encryptionkey='Password' .xp_objectrecovery_viewcontents @filename='C:\MSSQL\Backup\MyDB_Backup.dbo. @type='All' List view objects for backup set #2 on a full backup file + backup set #3 on a diff backup file EXEC master.dbo.1 User Guide 236 . When one of these values is used with -C or xp_objectrecovery_createscript. which are prefixed with "object_type. but the name of the owning table.l ExtendedProcedure l TableIndexClustered 2 l Function l TableIndexes 2 l PartitionFunction l TableStatistics2 l PartitionScheme l TableTriggers 2 l Role 1 l Trigger l Rule l Type l StoredProcedure l User 1 l SystemTable l View l Table l XmlSchemaCollection NOTES: 1 These values cannot be used to create scripts. @ObjectName (-C) is not the name of the object.BAK' . @logencryptionkey='Ysbgdd06' . @rmsg xp_restore_attachedfilesonly Restores attached files included within LiteSpeed backup sets. @type = 'All' .bkp' .bkp' ..1 User Guide 237 . @logfilenumber = 1 List encrypted contents of a striped backup EXEC master. @resultmsg=@rmsg output.List all database objects using the full database backup and several t-log backups EXEC master.dbo. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation. @logfilename = 'C:\backups\testdecimal_log_1_1. run the following: declare @rmsg varchar(999) exec master.bkp' . @filenumber = 1 . @logencryptionkey='Ysbgdd07' .xp_objectrecovery_viewcontents @filename = 'C:\backups\testdecimal_full_1. @encryptionkey='Ysbgdd05' . @stripedlogfilename = 'C:\backups\testdecimal_log_1_2. @stripedlogfilename = 'C:\backups\testdecimal_log_2_2. run the following: declare @rc int declare @rmsg varchar(999) exec master. LiteSpeed for SQL Server 8. @logfilenumber = 1 ..<procedure_name> <arguments>.bkp' . @type = 'All' . @logfilename = N'C:\temp\8_20101007183923_20101007184235. @logfilename = N'C:\temp\8_20101007183923_20101007184136.bkp' . NOTE: You can direct restored files to be recreated in an alternate location from their original location. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code.bak' . but only restores the specified files. @logfilenumber = 1 .dbo. @resultcode=@rc output select @rc. @filename = 'C:\backups\testdecimal_full_2. @logfilename = 'C:\backups\testdecimal_log_2_1. This procedure performs no database restore operation.bak' .xp_objectrecovery_viewcontents @filename = N'C:\temp\8_20101007183923. @logfilenumber = 1 Returns 0 (success) or non-zero (failure).bkp' .bak' .<procedure_name> <arguments>. @filenumber = 1 . To capture the output message. .1 User Guide 238 . @throttle = 1.. @tsmarchive = 0 | 1] xp_restore_attachedfilesonly (Tape) EXEC master. you need to select processors 2. third. @filenumber = n] [. @encryptionkey = 'encryption_key'] [. @tsmpointintime = 'date_time' ] [.dbo. @logging = 0 | 1 | 2 ] [.. @unload = 0 | 1 ] [. This argument accepts decimal values and hexadecimal values.100] Arguments xp_restore_attachedfilesonly accepts the following arguments: @affinity Processor affinity designates specific processors to run LiteSpeed. @throttle = 1. which is decimal 38 or hexadecimal 0x26.. @attachedfile = 'pathname [ to new_pathname ]']) [... The result is binary 100110. @affinity = 0.. @logging = 0 | 1 | 2 ] [. Review the following for additional information: LiteSpeed for SQL Server 8. and sixth bits to 1 and all other bits to 0.xp_restore_attachedfilesonly ( @filename = 'backup_file_name') [..Syntax xp_restore_attachedfilesonly (Disk or TSM) EXEC master. while not allowing LiteSpeed to run on the remaining processors. @attachedfile = 'pathname [ to new_pathname ]']) [..2147483648] [..n] (. 3.. @tsmobject = 'TSM_object'] [. and 6 for use with LiteSpeed. @rewind = 0 | 1 ] [. For example. @filenumber = n] [. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process. Number the bits from the right to left.n] (.. The rightmost bit represents the first processor. @tsmconfigfile = 'TSM_configuration_file'] [..n] [. @tsmclientownerpwd = 'TSM_client_owner_password'] [. @tsmclientnode = 'TSM_client_node'] [. Set the second. If a value begins with "0x" it is interpreted as hexadecimal.2147483648] [. @affinity = 0. NOTE: 32-bit Windows is internally limited to a 32-bit mask.n] [. @encryptionkey = 'encryption_key'] [.xp_restore_attachedfilesonly ( @filename = 'backup_file_name') [.100] [.dbo. with all pertinent backup parameters supported. @AWSAccessKeyEnc The @AWSAccessKeyEnc argument specifies the name of the encrypted unique Amazon Web Service alphanumeric access key that identifies each user. Example values are but not limited to: us-east-1. 3. and sa-east-1. You may also want to consider using Adaptive Compression to maintain backup performance. apsoutheast-2. This feature works for disk. LiteSpeed for SQL Server 8.Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 3 11 1 and 2 7 111 1. ap-southeast-1. then LiteSpeed recursively includes all files and subdirectories. 2 and 3 38 100110 2. If it is a directory. us-west-2. the path parameter can be expanded to include a new destination. See Adaptive Compression on page 72 for more information. This form will take the syntax of <file_path> to <new_file_path>. Bucket names must be at least 3 and no more than 63 characters long. tape. All attached files are encrypted and compressed. just the files that were attached to that backup. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. @attachedfile Specifies filepaths to include in both backup and restore operations. try limiting the number of threads. You can supply multiple instances of this argument. The filepath can be either a single file or a directory. This argument only restores the attached files. ap-northeast-1. us-west-1. The new filepath can be used to specify a new location but cannot rename a file. TSM. @AWSRegionName The @AWSRegionName argument specifies the name of the Amazon Web Service region to use for a bucket. it is recommended that you limit the threading as well. It does not restore the database. l c:\testad to testadr would restore all files in directory c:\testad to c:\testadr. and 6 205 11001101 1. @AWSBucketName The @AWSBucketName argument specifies the name of the container for AWS objects. 4. @AWSAccessKey The @AWSAccessKey argument specifies the name of the unique Amazon Web Service alphanumeric access key that identifies each user.g.1 User Guide 239 . 3. and Double Click Restore as well. NOTES: l The original entire directory path need not be supplied (e. 7. If you decide to use an affinity value other than default. c: to c:\testadSattsm is allowed). When used within the context of a restore operation. eu-west-1. This argument accepts one of the following values: l 0—Do not use Server Side Encryption l 1—Use Server Side Encryption @CloudVendor The @CloudVendor argument specifies the name of the company offering the Cloud service. The default cloud vendor is AmazonS3. This argument accepts one of the following values: l 0—Do not use reduced redundancy storage l 1—Use reduced redundancy storage @AWSUseServerSideEncryption The @AWSUseServerSideEncryption argument enables the encryption of data stored at rest in Amazon S3. Example of key: 'Mypassword' @filename The name of the LiteSpeed backup device file to be extracted. take care not to lose the encryption key. @AWSUseGovCloud The @AWSUseGovCloud argument enables a special restricted region for the US Government use in Amazon S3. @encryptionkey Value used to generate the encryption key for the encryption algorithm. @AWSSecretKeyEnc The @AWSSecretKeyEnc argument specifies the name of the encrypted Amazon Web Service secret key that is assigned when you initially get an AWS account. then the program will not encrypt the backup. If you do not supply encryption key. Caution: When encrypting data. this argument accepts the following formats: LiteSpeed for SQL Server 8. This argument accepts one of the following values: l 0—Do not use government cloud l 1—Use government cloud @AWSUseReducedRedundancy The @AWSUseReducedRedundancy argument specifies the use of reduced redundancy storage in Amazon S3. This argument accepts network destinations. For TSM backups and TSM archives. the restore will fail. If you use the wrong encryption key.@AWSSecretKey The @AWSSecretKey argument specifies the name of the Amazon Web Service secret key that is assigned when you initially get an AWS account.1 User Guide 240 . a backup cannot be restored or recovered without the original encryption key. Tape restores: Identifies the backup set to be restored. See Configure Logging in LiteSpeed for information about LiteSpeed logging. If the proxy parameters are not detected. @ProxyHost The @ProxyHost argument is optional and specifies the name of the Amazon Web Service host machine that is running the proxy server. l 1 or any odd value—Logging on. a file number of 1 indicates the first backup set on the backup medium. l 2 or any even value—Logging on. If the proxy parameters are not detected. NOTE: l If the @ProxyHost argument is not defined.1 User Guide 241 .ini files for the proxy parameters. For example. To log to a different directory add @Trace='logpath=path'. @logging Writes a log file for the operation. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs.ini files for the proxy parameters. then the LiteSpeed core engine connects directly to the Amazon servers. @ProxyLogin The @ProxyLogin argument is optional and specifies the proxy server login credential. then the LiteSpeed core engine checks the local . @filenumber Disk restores: Specifies the particular backup to use when recasting. and a file number of 2 indicates the second backup set.l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. NOTE: LiteSpeed for SQL Server 8. extracting or reading from files with multiple appended backups. Log file is removed on success. NOTE: l If not defined. @ProxyPassword The @ProxyPassword argument is optional and specifies the proxy server password credential. This argument accepts one of the following values: l 0—Logging off. restoring. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. then the LiteSpeed core engine connects directly to the Amazon servers. then the LiteSpeed core engine checks the local . If you decide to use an affinity value other than default. then the LiteSpeed core engine checks the local . it is recommended that you limit the threading as well. if specified in the options file or if backing up with the Passwordaccess Generate option. then the LiteSpeed core engine connects directly to the Amazon servers.ini files for the proxy parameters. The argument accepts an integer value between 1 and 100. TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. This argument accepts one of the following values: l 0—Leave the tape unwound (default) l 1—Rewind the tape after writing/reading @throttle Specifies the maximum CPU usage allowed. This argument accepts one of the following values: l 0—False (default) l 1—True @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. try limiting the number of threads. If the proxy parameters are not detected.1 User Guide 242 .ini files for the proxy parameters. If the proxy parameters are not detected. You may also want to consider using Adaptive Compression to maintain backup performance. @tsmarchive Specifies to store the backup as a TSM archive. If the proxy parameters are not detected. then the LiteSpeed core engine checks the local . NOTE: l If the @ProxyPasswordEnc argument is not defined. @ProxyPort The @ProxyPort argument is optional and contains the port number of the proxy server. @ProxyPasswordEnc The @ProxyPasswordEnc argument is optional and specifies the encrypted proxy server password credential. NOTE: l If the @ProxyPort argument is not defined. @rewind Applies only to backing up and restoring tape. LiteSpeed for SQL Server 8. then the LiteSpeed core engine checks the local . then the LiteSpeed core engine connects directly to the Amazon servers. then the LiteSpeed core engine connects directly to the Amazon servers. The default value is 100. Not required. This is the percentage of the total amount of CPU usage (across all enabled processors) available.ini files for the proxy parameters. See Adaptive Compression on page 72 for more information.l If the @ProxyPassword argument is not defined. The TCP/IP port values can be 1-65535. @tsmclientownerpwd Specifies the TSM client owner user password. @tsmobject Defines the TSM filespace. NOTE: You may only store one item the location specified by this argument. @tsmpointintime Specifies the date for restore/to filter results. LiteSpeed will choose the most recent archived backup. The format is yyyy-mm-dd hh:mm:ss.1 User Guide 243 . @unload Applies to tape backups and restores. Not required. It is not possible to append an object to this location. If it is not passed. @tsmconfigfile Specifies the TSM configuration file. You can use the -I command-line argument or @init to back up to a nonunique location. 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). This argument accepts one of the following values: l 0—Keep tape loaded (default) l 1—Unload and eject tape from the drive after operation @UseSSL The @UseSSL argument specifies that the connection uses SSL security. high level and low level. It can be the drive label name or UNC name. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l tsm_filespace is the logical space on the TSM server that contains a group of files. l tsm_high_level specifies the directory path in which the file belongs. then the most recent of the times must be chosen. if specified in the options file or if backing up with the Passwordaccess Generate option. This argument accepts one of the following values: l 0—Do not use SSL l 1—Use SSL (default) LiteSpeed for SQL Server 8. l tsm_low_level specifies actual name of the file. dbo.BAK' @attachedfile = 'C:\DATA\Images' 2. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. You can use this extended stored procedure to automate restore operations even if backup files have unique names. @attachedfile = N'''C:\Program Files\Tivoli\TSM\baclient\dsm_pg. No user connections can exist when performing a database restore.opt'' to ''C:\Program Files\Tivoli\TSM\baclient\dsm_pg. run the following: declare @rc int declare @rmsg varchar(999) exec master. @logging = 0. To capture the output message.xp_restore_attachedfilesonly @tsmconfigfile = N'C:\Program Files\Tivoli\TSM\baclient\dsm.Examples 1. Restore a complete directory: EXEC master. @resultmsg=@rmsg output..<procedure_name> <arguments>. @resultcode=@rc output select @rc.xp_restore_attachedfilesonly @filename= 'C:\MSSQL\Backup\MyDB_Backup. run the following: declare @rmsg varchar(999) exec master.dbo.pdf' 3. @tsmpointintime = '2012-05-04 00:54:32'.xp_restore_attachedfilesonly @filename= 'C:\MSSQL\Backup\MyDB_Backup. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation.<procedure_name> <arguments>.BAK' @attachedfile = 'C:\DATA\Images to c:\DATA\Old_Images' @attachedfile = 'C:\DATA\Docs\Invoice.opt''' Returns 0 (success) or non-zero (failure). NOTE: A database cannot be restored unless the restore process has exclusive access to the database.pdf to C:\DATA\Docs\Old_Invoice. Restore a file attached to a tsm backup: EXEC master. @filenumber = 1.. @rmsg xp_restore_automated Restores the most recent full disk and cloud backup created with LiteSpeed and optionally differential and transaction log backups.1 User Guide 244 . Restore a directory and file to an alternate location: EXEC master. LiteSpeed for SQL Server 8.dbo. @tsmobject = N'C\Reports\attachedfiles'.opt'. @affinity = 0. . @with = 'additional_with_parameters'] [. If a value begins with "0x" it is interpreted as hexadecimal. @backupextension = 'extensions' . @throttle = 1. @datafilepath = 'path'] [. @ioflag = 'DISK_RETRY_WAIT=n'] [. third. Set the second. @backuptype = N'option'.dbo. @sourceserver = 'server_name' . [.xp_restore_automated [@database = 'database_name' [.dbo. @logfilepath = 'path'] ] ..n] . <xp_arguments> @affinity Processor affinity designates specific processors to run LiteSpeed. @restoreascompressed = 0 | 1] [. @maxtransfersize = 'maximum_transfer_size'] [. 3. Number the bits from the right to left. The rightmost bit represents the first processor.. you need to select processors 2.1 User Guide 245 . Review the following for additional information: Decimal Value 0 Binary Bit Mask Allow LiteSpeed Threads on Processors 0 All (default) LiteSpeed for SQL Server 8. @dryrun = 0 | 1] [. @dropdatabaseonfailure = 0 | 1 ] [.. which is decimal 38 or hexadecimal 0x26.dbo. @affinity = 0. NOTE: 32-bit Windows is internally limited to a 32-bit mask. and sixth bits to 1 and all other bits to 0. @ioflag = 'DISK_RETRY_COUNT=n'] [. This argument accepts decimal values and hexadecimal values.. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process.2147483648] [. and 6 for use with LiteSpeed. @restoreasreadonly = 0 | 1] [.Syntax EXEC master.. execute the following: exec master.<procedure_name> show_cmd. @logging = 0 | 1 | 2 ] [. @buffercount = 'buffer_count'] [.100] [. ( @filename = 'backup_filename' | ( @backuppath = 'path' . @dropdatabaseonsuccess = 0 | 1 ] Arguments Tips: l l To see the list of accepted arguments and data types for arguments. @checksubfolders = 0 | 1 ) ) [. @withreplace = 0 | 1 ] [. ( @encryptionkey = 'encryption_key' | @jobp = 'encrypted_key' ) ] [.<procedure_name> show_help To convert the script for use with the command-line utilities. execute the following: exec master... while not allowing LiteSpeed to run on the remaining processors. @sourcedatabase = 'database_name' . For example.n] [. The result is binary 100110. 4. 2 and 3 38 100110 2. This argument accepts one of the following values: l l l full—LiteSpeed will only restore the most recent full database backup. 3. tlog—LiteSpeed will restore the most recent full database backup and any existing differential and/or transaction log backups created after the most recent full backup. See Adaptive Compression on page 72 for more information. try limiting the number of threads. @checkdbdatapurity Checks data purity validations on every column value in all rows of the table or tables in the database. This argument accepts one of the following values: l 0—False. @backuptype Specifies backup types to use for the restore. separated with commas. @buffercount Specifies the number of SQL Server buffers available for a LiteSpeed operation. LiteSpeed will not confirm integrity of the database after restore. If you decide to use an affinity value other than default. The default value is set by SQL Server. l 1—True. LiteSpeed will confirm integrity of the database after restore.Decimal Value Binary Bit Mask 1 Allow LiteSpeed Threads on Processors 1 1 3 11 1 and 2 7 111 1. This argument accepts one of the following values: LiteSpeed for SQL Server 8. and 6 205 11001101 1. @backupextension When looking for database backups. No value or asterisk (*) specifies any file extension. The value of this parameter is a list of extensions. 7. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. it is recommended that you limit the threading as well. 3.1 User Guide 246 . diff—LiteSpeed will restore the most recent full database backup and any existing differential backups based on this full. You may also want to consider using Adaptive Compression to maintain backup performance. @checkdb Checks database integrity after restore. LiteSpeed will only consider backup files that have the extensions you specify. @backuppath Specifies the directory where to search for the backup files. This argument accepts one of the following values: l 0—False. LiteSpeed will confirm logical consistency after restore. LiteSpeed will not confirm physical structure of the database. LiteSpeed will not confirm integrity of the database column values after restore. @checkdbnoindex Checks the database but does not check the index. @checksubfolders Specifies whether to use subfolders to look for database backups. This argument accepts one of the following values: l 0—False. This argument accepts one of the following values: l 0—False. LiteSpeed will confirm physical structure of the database. l 1—True. LiteSpeed will not include informational messages in notification report after restore. after restore. This includes a shortterm exclusive (X) lock on the database. LiteSpeed will confirm integrity of the database column values after restore. @checkdbtablelocks Causes check database to obtain locks instead of using an internal database snapshot. l 1—True. LiteSpeed will check the database but not check the index. LiteSpeed will not use locks instead of using an internal database snapshot after restore. l 1—True. l 1—True. LiteSpeed will check the database and check the index. and spatial indexes after restore. @checkdbphysicalonly Checks physical structure of the database only. This argument accepts one of the following values: l 0—False. LiteSpeed will include informational messages in notification report after restore. l 1—True. LiteSpeed for SQL Server 8. @checkdbextendedlogical Checks logical consistency on an indexed view. LiteSpeed will not confirm logical consistency after restore.l 0—False. LiteSpeed will only use backups located in the specified folder. XML indexes. This argument accepts one of the following values: l 0—False. This argument accepts one of the following values: l 0—False. LiteSpeed will look for backups in the specified folder and in its subfolders. l 1—True.1 User Guide 247 . LiteSpeed will use locks instead of using an internal database snapshot after restore. @checkdbnoinfomessages Causes check database to suppress all informational messages. l 1—True. For example.The database is dropped after failing the restore or database integrity check. This argument accepts one of the following values: l 0—False (default) l 1—True LiteSpeed for SQL Server 8. Use this option if you no longer need the restored database.On failure any of restore or check databases integrity operations . Include copy only backups.On success restore and check database integrity operations . One or both options can be selected. @database Name of database to be backed up or restored. This parameter specifies a database: l to be backed up (xp_backup_database and xp_slsSmartDiff) l containing the transaction log to be backed up (xp_backup_log) l to be restored (xp_restore_database and xp_restore_log) l on which you wish to check the progress of an activity (xp_slsReadProgress) l for which you want to delete old backups (xp_slsSmartCleanup) If supplied as a variable (@database). l 1—True.On failure any of restore or check databases integrity operations . This option contains two additional options to select. One or both options can be selected. This option contains two additional options to select.The database is dropped after a successful restore or database integrity check.On success restore and check database integrity operations . this name can be specified either as a string constant (@database = database name) or as a variable of character string data type. @dropdatabaseonfailure Drops the restored database only if the restore fails. For example.The database is dropped after failing the restore or database integrity check. except for the ntext or text data types. if you are only restoring the latest backup for testing purposes.@dontusecopyonly Specifies whether copy only backups are included during automated restores.1 User Guide 248 .The database is dropped after a successful restore or database integrity check. @datafilepath Specifies a location for data files. if you are only restoring the latest backup for testing purposes. Use this option if you no longer need the restored database. Do not include copy only backups. This argument accepts one of the following values: l 0—False. This argument accepts one of the following values: l 0—False (default) l 1—True @dropdatabaseonsuccess Drops database on success only. You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. @jobp Specifies an encrypted key. the maximum allowed setting is 1000. Example of key: 'Mypassword' NOTE: Automated Restore requires that you use the same password for all encrypted backups. The default is 15 seconds.dbo. If you use the wrong encryption key. the maximum allowed setting is 300. @ioflag='DISK_RETRY_COUNT=1' .1 User Guide 249 . to specify a database backup where each failure can be retried once after a 30-second wait: EXEC master. The default is 4 retries.@dryrun Shows backups that are candidates for restore at this time. Caution: When encrypting data. This argument accepts one of the following values: l 0—False (default) l 1—True @encryptionkey Value used to generate the encryption key for the encryption algorithm. For example. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. LiteSpeed for SQL Server 8.xp_backup_database @filename='c:\test. If you do not supply encryption key. NOTE: This functionality is only available for disk operations. (Similar to @EncryptionKey). This argument accepts network destinations. then the program will not encrypt the backup. take care not to lose the encryption key. @database='test' . @ioflag='DISK_RETRY_WAIT=30' See Network Resilience on page 75 for more information. DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. a backup cannot be restored or recovered without the original encryption key. the restore will fail. For TSM backups and TSM archives. @ioflag Specifies if LiteSpeed should wait and retry the read or write operation on failure. @filename The name of the LiteSpeed backup device file to be extracted. but does not restore them.bkp' . @logfilepath Specifies a location for log files. @maxtransfersize Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. The default is 1048576 (1 MB). l 2 or any even value—Logging on. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. NOTE: Automated Restore requires that you use the same password for all encrypted backups. See Configure Logging in LiteSpeed for information about LiteSpeed logging. @sourcedatabase Backups of this database are the source for restore.304 bytes (4 MB). and then compresses it. This argument accepts one of the following values: l 0—Logging off. you can restore a user database into an NTFS compressed folder or restore a tlog to a readonly database in a compressed folder.194. l 1 or any odd value—Logging on.1 User Guide 250 . @restoreascompressed Works in conjunction with @restoreasreadonly. Log file is removed on success. creates a folder if it does not exist. @logging Writes a log file for the operation. l You can only use this feature on Windows NTFS file systems. it can only be restored as read-only.You can use xp_encrypt_backup_key to convert the password (encryption_key) for use with @jobp. NOTES: l When using an NTFS-compressed folder for a database. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. l NTFS compression of read-only databases is not supported in SQL Server 2000. To log to a different directory add @Trace='logpath=path'. The original password (or encrypted key generated by xp_encrypt_restore_key) must be used to restore a backup. This argument accepts one of the following values: l 0—False (default) l 1—True @restoreasreadonly Instructs the restore operation to leave the database in read-only mode. This argument accepts one of the following values: l 0—False (default) l 1—True Using this option. LiteSpeed for SQL Server 8. The existing database is deleted.@sourceserver Backups created on this instance of SQL Server are the source for restore.1 User Guide 251 . Do not supply the @with parameter if no additional features are required. The argument accepts an integer value between 1 and 100. PASSWORD Specifies the password for the backup set. it is recommended that you limit the threading as well. This argument accepts one of the following values: l 0—False (default) l 1—True LiteSpeed for SQL Server 8. use multiple @with arguments. Please refer to the SQL Server Transact-SQL backup and restore documentation for the syntax and usage. @with Each @with argument should be a syntactically complete and correct statement. This is the percentage of the total amount of CPU usage (across all enabled processors) available. If you need more than 255 characters. @withreplace Instructs LiteSpeed to create the specified database and its related files even if another database already exists with the same name. This extended stored procedure accepts the following @with parameters: Parameter Description STATS Displays a message each time a percentage of the activity completes. The default value is 100. try limiting the number of threads. The default is 10%. @throttle Specifies the maximum CPU usage allowed. The supported formats are: l @with='PARAMETER' l @with='PARAMETER=''accepted_value''' NOTES: l l Extended stored procedure arguments are limited to 255 characters. TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. You may also want to consider using Adaptive Compression to maintain backup performance. See Adaptive Compression on page 72 for more information. If you decide to use an affinity value other than default. dbo.bkp' . @logfilepath = 'D:\DATA' .dbo. @logfilepath = 'D:\DATA' . @backupextension = '' . @datafilepath = 'D:\DATA' . @sourceserver = N'LITESPEED\SQL2005' . @sourcedatabase = N'LiteSpeedLocal' . @backupextension = 'bak. @backupextension = '' .xp_restore_automated @database='NEWDB' .Examples Restore the Most Recent Full Database Backup to a New Database EXEC master. @dropdatabaseonsuccess = 1 . @backuppath = N'D:\temp' . @backuppath = N'D:\temp\FC\' . @datafilepath = 'D:\DATA' . @sourceserver = N'LITESPEED\SQL2005' . @jobp = N'5jzOEztgLxQ=' .1 User Guide 252 .dbo. @sourcedatabase = N'FOX' . @withreplace = 1 Restore the Most Recent Fast Compression Backups exec master. @sourcedatabase = N'FOX' . @checksubfolders = 0 .xp_restore_automated @database='TESTDB' . @checksubfolders = 1 . @checksubfolders = 1 . @sourceserver = N'LITESPEED\SQL2005' . @backuptype = N'diff' .xp_restore_automated @database = N'LiteSpeedLocal_AutomatedRestore' . @backuptype = N'full' Restore the Most Recent Full and Drop Database EXEC master. @backuptype = N'full' . @dropdatabaseonfailure = 1 . @backuppath = N'D:\temp' . @withreplace = 1 LiteSpeed for SQL Server 8. 1 User Guide 253 . @checksubfolders = 0. LiteSpeed for SQL Server 8. @backuppath = N'test'. @logfilepath = 'D:\DATA' .dbo.xp_restore_automated @database = N'model' . @checksubfolders = 0 . @AWSBucketName = N'california'. @backuptype = N'tlog'. @backupextension = N''. @sourceserver = N'SPB8595'. @backuptype = N'full' Restore with Database Integrity Enabled exec master. @backuptype = N'diff'. @sourceserver = N'LITESPEED\SQL2005' . @checkdb = 1. @with = N'STATS = 10' View Candidates for Automated Restore EXEC master. @withreplace = 1.xp_restore_automated @database='NEWDB' . @sourcedatabase = N'CM_1_Testing'. @backupextension = N''.dbo. @checkdbnoindex = 1. @sourceserver = N'LITESPEED\SQL2005' . @datafilepath = 'D:\DATA' . @backuppath = N'D:\temp' .xp_restore_automated @backuppath = N'D:\temp' .dbo. @sourcedatabase = N'FOX' . @backuppath = N'C:\backup'.dbo. @logging = 0. @encryptionkey = N'******' . @sourceserver = N 'servername'. @backuppath = N'E:\temp' .xp_restore_automated @database = N'CM_1_Testing_1' . @checksubfolders = 0. @backupextension = 'stripe1' . @backuptype = N'tlog' . @checkdbphysicalonly = 1.Restore the Most Recent Striped Backup EXEC master. @checksubfolders = 0 . @checksubfolders = 1 . @affinity = 0. @sourcedatabase = N'FOX' . @AWSAccessKey = N'********'. @dryrun = 1 Restore from Amazon S3 cloud exec master. @CloudVendor = N'AmazonS3'. @backupextension = 'stripe2' . @backupextension = '' . @sourcedatabase = N'model'. Syntax EXEC master. @checkdbphysicalonly = 1.. @affinity = 0. For TSM backups and TSM archives.<procedure_name> <arguments>.xp_restore_checkpassword @filename = 'filename' [. @resultmsg=@rmsg output. @resultcode=@rc output select @rc.1 User Guide 254 . @DontUseReplication = 1.<procedure_name> <arguments>. @filenumber = n] [. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. @checkdbnoinfomessages = 1. This argument accepts network destinations. run the following: declare @rc int declare @rmsg varchar(999) exec master. @encryptionkey = 'Mypassword'] Arguments The procedure accepts the following arguments: @filename The name of the LiteSpeed backup device file to be extracted. this argument accepts the following formats: LiteSpeed for SQL Server 8. @with = N'STATS = 10' Returns 0 (success) or non-zero (failure). @rmsg xp_restore_checkpassword This extended stored procedure checks a provided password or key against a single backup set within a single file.dbo.. @progressname = N'f94ee3d8-f6ac-47e0-80cd-a6326a532dd9'. @UseSSL = 1. @checkdb = 1. run the following: declare @rmsg varchar(999) exec master. @logging = 0. To capture the output message. @checkdbnoindex = 1. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation.@AWSSecretKey = N'*********'. @encryptionkey Value used to generate the encryption key for the encryption algorithm. If you use the wrong encryption key. In addition. take care not to lose the encryption key.1 User Guide 255 . then the program will not encrypt the backup. Caution: When encrypting data. This feature does not validate that the backup set is valid.l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. If @FileNumber is not specified. No user connections can exist when performing a database restore. you must apply a transaction log using xp_restore_log. NOTE: A database cannot be restored unless the restore process has exclusive access to the database. restoring. or from a full database backup operation using xp_ backup_database. a backup cannot be restored or recovered without the original encryption key. Syntax EXEC master. file differential backups can be restored after a full file restore using LiteSpeed. the procedure checks if the backup set is encrypted or not. When restoring files or filegroups. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name.xp_restore_checksumonly @filename = 'backup_file_name' xp_restore_database Restores LiteSpeed full and partial backups created with LiteSpeed.dbo. extracting or reading from files with multiple appended backups. @filenumber Specifies the particular backup to use when recasting. It can be used to validate that a file has not been corrupted since a previous point in time. the restore will fail. Example of key: 'Mypassword' If @EncryptionKey is not provided (or is an empty string). the backup set defaults to 1. but provides you with a check sum value to validate your files with. xp_restore_checksumonly This procedure generates a checksum of an entire backup file. If you do not supply encryption key. LiteSpeed for SQL Server 8. Files and filegroups may also be restored either from a file or filegroup LiteSpeed backup operation. ..n] [. @with = 'additional_with_parameters'] [.. ( @encryptionkey = 'encryption_key' | @jobp = 'encrypted_key' ) ] [.dbo. @ioflag = 'DISK_RETRY_COUNT=n'] [. @filenumber = n] [. @tsmclientnode = 'TSM_client_node'] [.xp_restore_database @database = 'database_name' (. @throttle = 1. @buffercount = 'buffer_count'] [. @filenumber = n] [..2147483648] [.Syntax xp_restore_database (disk or TSM) EXEC master..1 User Guide 256 ..n] [.. @logging = 0 | 1 | 2 ] [.. @unload = 0 | 1 ] [... @tsmarchive = 0 | 1 ] [.n] [.n] [..n] [. @attachedfile = 'pathname'] [.. @maxtransfersize = 'maximum_transfer_size'] [.. @tsmconfigfile = 'TSM_configuration_file'] [.. @restoreasreadonly = 0 | 1 ] [.. @file = 'logical_file_name'] [. @returndetails = 0 | 1] [... @maxtransfersize = 'maximum_transfer_size'] [. @filegroup = 'logical_filegroup_name'] [.n] [.n] [. @file = 'logical_file_name'] [... @tsmclientownerpwd = 'TSM_client_owner_password'] [....2147483648] [. @ioflag = 'DISK_RETRY_WAIT=n'] [.n] [.100] [. @restoreasreadonly = 0 | 1 ] [.100] [.... @logging = 0 | 1 | 2 ] [. @filename = 'backup_file_name') [..n] [... @tsmpointintime = 'date_time'] [.. @returndetails = 0 | 1] LiteSpeed for SQL Server 8. @encryptionkey = 'encryption_key'] [. @filename = 'backup_file_name') [. @restoreasreadonly = 0 | 1] [. @attachedfile = 'pathname'] [. @buffercount = 'buffer_count'] [. @affinity = 0. @rewind = 0 | 1 ] [. @filegroup = 'logical_filegroup_name'] [.xp_restore_database @database = 'database_name' (. @throttle = 1... @restoreascompressed = 0 | 1] xp_restore_database (tape) EXEC master.. @with = 'additional_with_parameters'] [.n] [.dbo. @affinity = 0. @tsmobject = 'TSM_object'] [. bak'.filegroup online) Tip: To restore the read only filegroup FG3 and bring it online after the partial restore above has completed.xp_restore_database @database = 'Prod_test' . @With = N'MOVE ''AA_5'' TO ''F:\Databases. @FileName = N'AA_5_1. is offline after the restore is complete. @Database = N'AA_5_restored88' [.dbo. @filename = 'I:\SQLbackups\FGBackups_PROD. The database used in the example below.f0.bkp'. @filename = N'I:\FGBackups_FULL_keep. @ProxyHost = N'proxy.ldf''. @ProxyPort = 8080] [. @with = N'REPLACE' xp_restore_database (restore partial backup .bkp' .mdf''. and FG3). @read_write_filegroups = 1. @AWSRegionName = N'us-west-2'] [. contains the following filegroups: Primary.SQL2005\QQ_3_restored88. REPLACE'] [.bak'] [.xp_restore_database @database = 'Prod_test'.xp_restore_database @database = 'Prod_test' .dbo. @with = N'REPLACE' LiteSpeed for SQL Server 8. FG3. EXEC master. @ProxyPassword = N'bW8z4NM'] xp_restore_database (restore partial backup . @read_write_filegroups = 1.sitelocal'] [.1 User Guide 257 . FG2.xp_restore_database (cloud) EXEC master. a full backup containing the filegroup must be used for the restore as indicated in the following example. @ProxyLogin = N'DOMAIN\temp-xyz-MYtester'] [.dbo. MOVE ''AA_ 3_log'' TO ''F:\Databases. FG1. @with = N'REPLACE' xp_restore_database (restore fast compression partial backup . @AWSAccessKey = N'AQRTJBTRPKPRG6QJTWMQ'] [.offline) NOTE: The read only file group.filegroup offline) NOTE: The following example shows the syntax for performing partial restores using the “read_write_ filegroups” parameter. @filegroup = 'FG3' .SQL2005\AA_5_restored88_log.xp_restore_database @CloudVendor = N'AmazonS3' .litespeed. @AWSBucketName = N'aabucket1'] [. EXEC master. @filename = N'I:\FGBackups_FULL. @FileNumber = 1] [.dbo. EXEC master. @AWSSecretKey = N'P99YGUGrzqKaQM1yJUYP'] [. FGBackups_PROD. Tip: The read only filegroup FG3 is offline after the restore is complete as indicated in the following example. dbo.xp_restore_database @database = 'Prod_test' .<procedure_name> show_cmd.xp_restore_database @database = 'FGBackups_PROD' . <xp_arguments> LiteSpeed for SQL Server 8. @filename = N'I:\FGBackups_FULL.online) Tip: To restore the read only file group. a full backup containing the file group must be used for the restore.dbo. execute the following: exec master. execute the following: exec master.bkp'. @filename = N'I:\FGBackups_FULL_diff.xp_restore_database @database = 'FGBackups_PROD' . @read_write_filegroups = 1.bak'. EXEC. EXEC master. @read_write_filegroups = 1. @with = N'REPLACE' xp_restore_database (restore partial differential backup) NOTE: The read only file group FG3 is offline after the restore is complete. Step 1 . It is a two-step process to restore a LiteSpeed partial full backup followed by a restore of a LiteSpeed partial differential backup.master.dbo. @with = N'REPLACE'. and bring it online after the partial restore above has completed. Both steps are needed in order to restore a partial differential backup and bring the database online.dbo. @filegroup = 'FG3' . @WITH = 'PARTIAL' . @with = N'REPLACE' Arguments Tips: l l To see the list of accepted arguments and data types for arguments. @filename = N'I:\FGBackups_FULL.bkp'.master.bak'. @with = N'NORECOVERY' Step 2 -restore the LiteSpeed partial differential backup EXEC master.xp_restore_database (restore fast compression partial backup .dbo.<procedure_name> show_help To convert the script for use with the command-line utilities.1 User Guide 258 . a full backup containing the filegroup must be used for the restore. @filegroup = 'FG3' . FG3.restore the LiteSpeed partial full backup EXEC.dbo. Tip: To restore the read only file group FG3 and bring it online after the partial restore above is completed.xp_restore_database @database = 'FGBackups_PROD' . @filename = N'I:\FGBackups_FULL_keep. and Double Click Restore as well. See Adaptive Compression on page 72 for more information. When used within the context of a restore operation.g. it is recommended that you limit the threading as well. NOTES: l The original entire directory path need not be supplied (e. @attachedfile Specifies filepaths to include in both backup and restore operations. 3. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. All attached files are encrypted and compressed. This feature works for disk. This form will take the syntax of <file_path> to <new_file_path>. If it is a directory. third. try limiting the number of threads. and 6 205 11001101 1. You may also want to consider using Adaptive Compression to maintain backup performance. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process. just the files that were attached to that backup. TSM. 3. @AWSAccessKey The @AWSAccessKey argument specifies the name of the unique Amazon Web Service alphanumeric access key that identifies each user.@affinity Processor affinity designates specific processors to run LiteSpeed. If a value begins with "0x" it is interpreted as hexadecimal. c: to c:\testadSattsm is allowed). 7. you need to select processors 2. then LiteSpeed recursively includes all files and subdirectories. the path parameter can be expanded to include a new destination. which is decimal 38 or hexadecimal 0x26. This argument only restores the attached files. The result is binary 100110. with all pertinent backup parameters supported. 3. Review the following for additional information: Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 3 11 1 and 2 7 111 1. For example. NOTE: 32-bit Windows is internally limited to a 32-bit mask. The new filepath can be used to specify a new location but cannot rename a file. l c:\testad to testadr would restore all files in directory c:\testad to c:\testadr.1 User Guide 259 . This argument accepts decimal values and hexadecimal values. tape. and 6 for use with LiteSpeed. and sixth bits to 1 and all other bits to 0. LiteSpeed for SQL Server 8. It does not restore the database. You can supply multiple instances of this argument. If you decide to use an affinity value other than default. Number the bits from the right to left. The filepath can be either a single file or a directory. The rightmost bit represents the first processor. 2 and 3 38 100110 2. while not allowing LiteSpeed to run on the remaining processors. 4. Set the second. This argument accepts one of the following values: l 0—Do not use government cloud l 1—Use government cloud @AWSUseReducedRedundancy The @AWSUseReducedRedundancy argument specifies the use of reduced redundancy storage in Amazon S3. @AWSUseGovCloud The @AWSUseGovCloud argument enables a special restricted region for the US Government use in Amazon S3. eu-west-1. us-west-1.1 User Guide 260 . @AWSRegionName The @AWSRegionName argument specifies the name of the Amazon Web Service region to use for a bucket. @AWSSecretKeyEnc The @AWSSecretKeyEnc argument specifies the name of the encrypted Amazon Web Service secret key that is assigned when you initially get an AWS account. apsoutheast-2. @AWSSecretKey The @AWSSecretKey argument specifies the name of the Amazon Web Service secret key that is assigned when you initially get an AWS account. This argument accepts one of the following values: l 0—Do not use reduced redundancy storage l 1—Use reduced redundancy storage @AWSUseServerSideEncryption The @AWSUseServerSideEncryption argument enables the encryption of data stored at rest in Amazon S3. ap-northeast-1. This argument accepts one of the following values: l 0—Do not use Server Side Encryption l 1—Use Server Side Encryption LiteSpeed for SQL Server 8.@AWSAccessKeyEnc The @AWSAccessKeyEnc argument specifies the name of the encrypted unique Amazon Web Service alphanumeric access key that identifies each user. Bucket names must be at least 3 and no more than 63 characters long. and sa-east-1. ap-southeast-1. us-west-2. Example values are but not limited to: us-east-1. @AWSBucketName The @AWSBucketName argument specifies the name of the container for AWS objects. the restore will fail. this name can be specified either as a string constant (@database = database name) or as a variable of character string data type. The default value is set by SQL Server. @database Name of database to be backed up or restored. this argument accepts the following formats: LiteSpeed for SQL Server 8. a backup cannot be restored or recovered without the original encryption key. This parameter specifies a database: l to be backed up (xp_backup_database and xp_slsSmartDiff) l containing the transaction log to be backed up (xp_backup_log) l to be restored (xp_restore_database and xp_restore_log) l on which you wish to check the progress of an activity (xp_slsReadProgress) l for which you want to delete old backups (xp_slsSmartCleanup) If supplied as a variable (@database).1 User Guide 261 . If you do not supply encryption key. @filegroup Specifies a database filegroup to include in the backup or restore. 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. Caution: When encrypting data. If you use the wrong encryption key. @encryptionkey Value used to generate the encryption key for the encryption algorithm. except for the ntext or text data types. Example of key: 'Mypassword' @file Specifies a logical database file used for file or filegroup backups. then the program will not encrypt the backup. @CloudVendor The @CloudVendor argument specifies the name of the company offering the Cloud service. The default cloud vendor is AmazonS3.@buffercount Specifies the number of SQL Server buffers available for a LiteSpeed operation. Files in a filegroup backup can be restored individually or as a group. You can supply multiple instances of this argument. This argument accepts network destinations. @filename The name of the LiteSpeed backup device file to be extracted. For TSM backups and TSM archives. You can supply multiple instances of this argument. take care not to lose the encryption key. For example.xp_backup_database @filename='c:\test. Tape restores: Identifies the backup set to be restored. LiteSpeed for SQL Server 8. DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. to specify a database backup where each failure can be retried once after a 30-second wait: EXEC master. @ioflag='DISK_RETRY_COUNT=1' . restoring. extracting or reading from files with multiple appended backups. NOTE: This functionality is only available for disk operations.1 User Guide 262 . the maximum allowed setting is 300. (Similar to @EncryptionKey). The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. the maximum allowed setting is 1000. @jobp Specifies an encrypted key. @ioflag Specifies if LiteSpeed should wait and retry the read or write operation on failure.dbo. a file number of 1 indicates the first backup set on the backup medium. The original password (or encrypted key generated by xp_encrypt_restore_key) must be used to restore a backup. To log to a different directory add @Trace='logpath=path'. l 2 or any even value—Logging on. @filenumber Disk restores: Specifies the particular backup to use when recasting. @logging Writes a log file for the operation. @database='test' . You can use xp_encrypt_backup_key to convert the password (encryption_key) for use with @jobp. Log file is removed on success. You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. l 1 or any odd value—Logging on.bkp' . and a file number of 2 indicates the second backup set. The default is 15 seconds. See Configure Logging in LiteSpeed for information about LiteSpeed logging.l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. The default is 4 retries. For example. This argument accepts one of the following values: l 0—Logging off. @ioflag='DISK_RETRY_WAIT=30' See Network Resilience on page 75 for more information. then the LiteSpeed core engine checks the local .194.ini files for the proxy parameters. then the LiteSpeed core engine checks the local . @ProxyPassword The @ProxyPassword argument is optional and specifies the proxy server password credential. then the LiteSpeed core engine checks the local .1 User Guide 263 . LiteSpeed for SQL Server 8.ini files for the proxy parameters. NOTE: l If the @ProxyHost argument is not defined. then the LiteSpeed core engine connects directly to the Amazon servers.ini files for the proxy parameters. @ProxyHost The @ProxyHost argument is optional and specifies the name of the Amazon Web Service host machine that is running the proxy server. then the LiteSpeed core engine connects directly to the Amazon servers. @ProxyPort The @ProxyPort argument is optional and contains the port number of the proxy server. NOTE: l If the @ProxyPassword argument is not defined. If the proxy parameters are not detected. The default is 1048576 (1 MB). then the LiteSpeed core engine connects directly to the Amazon servers. @ProxyLogin The @ProxyLogin argument is optional and specifies the proxy server login credential. then the LiteSpeed core engine checks the local . If the proxy parameters are not detected. If the proxy parameters are not detected. then the LiteSpeed core engine connects directly to the Amazon servers. The TCP/IP port values can be 1-65535. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. then the LiteSpeed core engine connects directly to the Amazon servers.ini files for the proxy parameters.@maxtransfersize Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed.ini files for the proxy parameters. NOTE: l If the @ProxyPasswordEnc argument is not defined. NOTE: l If the @ProxyPort argument is not defined. then the LiteSpeed core engine checks the local . @ProxyPasswordEnc The @ProxyPasswordEnc argument is optional and specifies the encrypted proxy server password credential. If the proxy parameters are not detected. If the proxy parameters are not detected.304 bytes (4 MB). NOTE: l If not defined. which includes all the read/write files in a database: the primary filegroup. Threads tinyint The number of threads used for a LiteSpeed backup. The possible values are multiples of 65536 bytes (64 LiteSpeed for SQL Server 8. l You can only use this feature on Windows NTFS file systems. and then compresses it. If the database is read-only. l 0—False (default) l 1—True The result set contains the following details: Column Name Data Type Description Database nvarchar (128) Database name. you can restore a user database into an NTFS compressed folder or restore a tlog to a readonly database in a compressed folder. it can only be restored as read-only. The compression level can be NULL. CompressionLevel tinyint Compression level used for compressing the backup. creates a folder if it does not exist. This argument accepts one of the following values: l 0—False (default) l 1—True Using this option. @returndetails Generates a single-row result set. MaxTransferSize int Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. Operation nvarchar (30) Operation type: Backup or Restore.1 User Guide 264 . AdaptiveCompression nvarchar (max) Adaptive Compression option used for compressing the backup: 'speed' or 'size'. any read/write secondary filegroups. This argument accepts one of the following values: l 0—False (default) l 1—True @restoreasreadonly Instructs the restore operation to leave the database in read-only mode. NOTES: l When using an NTFS-compressed folder for a database. l NTFS compression of read-only databases is not supported in SQL Server 2000. @read_write_filegroups includes only the primary filegroup. @restoreascompressed Works in conjunction with @restoreasreadonly.@read_write_filegroup Specifies a partial backup. and any specified read-only files or filegroups. if backed up with Adaptive Compression. try limiting the number of threads. it is recommended that you limit the threading as well. 3) Duration of the operation. If you decide to use an affinity value other than default. StripeCount smallint Number of backup files in the stripe set. TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. The default value is 100. CPUSeconds numeric (18. OverlappedBuffers tinyint The number of buffers that any single VDI thread can use at a time. This is the percentage of the total amount of CPU usage (across all enabled processors) available.304 bytes (4 MB). BackupSize bigint Size of the backup (in bytes). 3) Processor time used by the LiteSpeed operation. This argument accepts one of the following values: l 0—Leave the tape unwound (default) l 1—Rewind the tape after writing/reading @throttle Specifies the maximum CPU usage allowed.194. BaseSize int The smallest chunk of memory LiteSpeed attempts to write to disk at any given time. BufferCount smallint The number of SQL Server buffers available for a LiteSpeed operation.Column Name Data Type Description KB) ranging up to 4. This argument accepts one of the following values: l 0—False (default) l 1—True @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. Tip: In Toad. you can use Group Execute to produce a single result set for several server instances. Not required. @tsmarchive Specifies to store the backup as a TSM archive. You may also want to consider using Adaptive Compression to maintain backup performance. if specified in the options file or if backing up with the Passwordaccess Generate option. ElapsedSeconds numeric (18. LiteSpeed for SQL Server 8. The argument accepts an integer value between 1 and 100. @rewind Applies only to backing up and restoring tape. The default is 1048576 (1 MB) . NativeSize bigint Backup size (in bytes) without LiteSpeed compression.1 User Guide 265 . See Adaptive Compression on page 72 for more information. The format is yyyy-mm-dd hh:mm:ss. @tsmconfigfile Specifies the TSM configuration file. It can be the drive label name or UNC name. high level and low level. @tsmobject Defines the TSM filespace. Not required. if specified in the options file or if backing up with the Passwordaccess Generate option. This argument accepts one of the following values: l 0—Keep tape loaded (default) l 1—Unload and eject tape from the drive after operation @UseSSL The @UseSSL argument specifies that the connection uses SSL security.1 User Guide 266 . NOTE: You may only store one item the location specified by this argument. @unload Applies to tape backups and restores. It is not possible to append an object to this location. This argument accepts one of the following values: l 0—Do not use SSL l 1—Use SSL (default) @with Each @with argument should be a syntactically complete and correct statement. @tsmpointintime Specifies the date for restore/to filter results. l tsm_high_level specifies the directory path in which the file belongs. LiteSpeed will choose the most recent archived backup. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l tsm_filespace is the logical space on the TSM server that contains a group of files. 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). If it is not passed. then the most recent of the times must be chosen. LiteSpeed for SQL Server 8. You can use the -I command-line argument or @init to back up to a nonunique location. Please refer to the SQL Server Transact-SQL backup and restore documentation for the syntax and usage. l tsm_low_level specifies actual name of the file.@tsmclientownerpwd Specifies the TSM client owner user password. the logical_file_name is restored to its original location. This extended stored procedure accepts the following @with parameters: Parameter Description KEEP_ REPLICATION Instructs the restore operation to keep the replication settings when restoring a published database to a server other than that on which it was created (used when setting up replication with log shipping).LDF''' NOTE: Use xp_restore_filelistonly to obtain a list of the logical files from the backup set.dbo. After the recovery process. NORECOVERY Instructs the restore operation to not roll back any uncommitted transactions. By default. Filegroups that are not restored are marked as offline and are not accessible. The result is a subset of the database.1 User Guide 267 . RECOVERY Instructs the restore operation to roll back any uncommitted transactions. The granularity of the partial restore operation is the database filegroup. @with = 'MOVE ''MyDB_Data2'' TO ''C:\MSSQL\Data\MyDB_data2. along with the files that you specify and their corresponding filegroups. MOVE MOVE = ''logical_file_name'' TO ''operating_system_file_name'' Specifies that the given logical_file_name should be moved to operating_system_file_name. You cannot specify this parameter with NORECOVERY. The primary file and filegroup are always restored.The supported formats are: l @with='PARAMETER' l @with='PARAMETER=''accepted_value''' NOTES: l l Extended stored procedure arguments are limited to 255 characters. @filename = 'C:\MSSQL\Backup\MyDB_Backup. Example: EXEC master. This is useful in either of these situations: l l PARTIAL a restore script is being run and the log is always being applied. RECOVERY. @with = 'MOVE ''MyDB_Data'' TO ''C:\MSSQL\Data\MyDB_data. See xp_restore_filelistonly on page 270 for more information. a sequence of file restores is used and the database is not intended to be usable between two of the restore operations. RECOVERY is the default.MDF''' . When used with a file or filegroup restore operation.NDF''' . @with = 'MOVE ''MyDB_Log'' TO ''C:\MSSQL\Data\MyDB_log. If NORECOVERY. NOTE: When specifying the NORECOVERY option. NORECOVERY forces the database to remain in the restoring state after the restore operation. or STANDBY is not specified. Each logical file in the database can be specified in different MOVE statements. If subsequent LiteSpeed restore operations (xp_restore_log or xp_restore_database from LiteSpeed for SQL Server 8. Either the NORECOVERY or STANDBY option must be specified if another transaction log has to be applied. or when multiple xp_restore_database or xp_restore_log statements are needed (for example. the MOVE parameter may be needed to relocate the database files and to avoid collisions with existing files. If you use xp_restore_database to copy a database to the same or different server. the database is ready for use. use multiple @with arguments. Do not supply the @with parameter if no additional features are required. the database is not usable in this intermediate. Specifies a partial restore operation. SQL Server requires that the WITH NORECOVERY option is used on all but the final xp_restore_ log statement when restoring a database backup and multiple transaction logs using LiteSpeed. non-recovered state. a full database backup followed by a differential database backup). If you need more than 255 characters.BAK' .xp_restore_database @database = 'MyDB' . The size required for the undo file depends on the volume of undo actions resulting from uncommitted transactions. RECOVERY is the default. LiteSpeed creates it. or sysadmin roles. @filename= 'C:\MSSQL\Backup\MyDB_Backup. it is automatically checked. REPLACE Instructs LiteSpeed to create the specified database and its related files even if another database already exists with the same name. dbcreator. Examples Standard Database Restore EXEC master. this restricts access for the restored database to members of the db_owner. RECOVERY. LiteSpeed will overwrite an existing file which cannot be verified as belonging to the database being restored. NOTE: If free disk space is exhausted on the drive containing the specified undo file name. LiteSpeed defaults to RECOVERY. or STANDBY. When restoring backup sets from an earlier version of SQL Server.dbo. This upgrade is performed automatically when WITH RECOVERY is specified. If the specified undo file name does not exist. LiteSpeed will refuse to overwrite pre-existing files. NORECOVERY or STANDBY should be specified instead. If you do not specify NORECOVERY. Normally. PASSWORD Specifies the password for the backup set. If you do not want to check the checksums during a restore.xp_restore_database @database = 'MyDB' . or STANDBY is not specified. supply 'NO_CHECKSUM' . STANDBY allows a database to be brought up for read-only access between transaction log restores and can be used with either warm standby server situations or special recovery situations in which it is useful to inspect the database between log restores. When the this option is not specified. RECOVERY.1 User Guide 268 . The default is 10%. If NORECOVERY.Parameter Description differential) are planned. STANDBY STANDBY = ''undo_file_name'' Specifies the undo file name so the recovery effects can be undone. NOTE: When you restore a backup containing checksum. and the database name is different from the database name recorded in the LiteSpeed backup set. the LiteSpeed restore operation stops.BAK' LiteSpeed for SQL Server 8. The existing database is deleted. CHECKSUM Causes checksums to be verified when a LiteSpeed backup is created. RESTRICTED_ USER When used in conjunction with recovery (another with param and the default) leaving a usable database. a database upgrade may be required. LiteSpeed performs a check to ensure that the database is not restored to the current server if: l l the database named in the xp_restore_database statement already exists on the current server. The same undo file can be used for consecutive LiteSpeed restores of the same database. If the file does exist. LiteSpeed overwrites it. STATS Displays a message each time a percentage of the activity completes. dbo.1 User Guide 269 . @file = 'file2' Restore a Filegroup and a File exec master. @with = 'MOVE ''MyDB_Data'' TO ''C:\MSSQL\Data\MyDB_Data.BAK' .dbo.\TAPE0' .xp_restore_database @database = 'MyDB' .dbo.LDF''' Restore Database from Tape EXEC master. @filename = 'C:\MSSQL\Backup\MyDB_Backup.xp_restore_database @database = 'MyDB' .xp_restore_database @database= 'Prod' . @filegroup = 'PRIMARY' .xp_restore_database @database='MyDB' .dbo.xp_restore_database @database='MyDB' . @rewind = 1 .dbo. @filename='C:\MSSQL\Backup\MyDB_Backup. @filename='\\. @tsmclientnode = 'ClusterGroup' LiteSpeed for SQL Server 8.BAK' .bak' . @file = 'file1' .bak' Restore Database with Move EXEC master.dbo.MDF''' . @unload = 0 Restore a TSM archive EXEC master.dbo. @filename = 'C:\Program Files\Microsoft SQL Server\MSSQL. @filenumber = 2 .xp_restore_database @database='MyDB' . @with='NORECOVERY' Restore an Encrypted Backup EXEC master.BAK' . @encryptionkey='Password' Restore Files exec master. @filenumber = 1 .1\MSSQL\Backup\MyDB_ 200909111303_file. @with = 'MOVE ''MyDB_log'' TO ''C:\MSSQL\Data\MyDB_Log.1\MSSQL\Backup\MyDB_ 200909111243_filegroup.xp_restore_database @database = 'MyDB' .Restore Database with NoRecovery EXEC master. @filename='C:\MSSQL\Backup\MyDB_Backup. @filename = 'C:\Program Files\Microsoft SQL Server\MSSQL. @file = 'file1' . . @With = N'MOVE ''AA_3'' TO ''E:\Databases. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation. @AWSSecretKey = N'P99YGUGrzqKaQM1yJUYP' -. REPLACE' . @Database = N'AA_3_restored33' .. .ldf''.. @ProxyPassword = N'bW8z4NM' Returns 0 (success) or non-zero (failure).SQL2005\AA_3_restored11. LiteSpeed for SQL Server 8. eu-west-1. @FileName = N'AA_3_1. .dbo. ap-southeast-2. us-west-1. @resultmsg=@rmsg output.sitelocal' . sa-east-1 .my key . @tsmclientownerpwd= 'test16' @tsmobject= 'SLS_Mar\Prod\(16)Thursday_14:14' @tsmconfigfile= 'C:\Program Files\Tivoli\tsm\baclient\dsm. @resultcode=@rc output select @rc. @AWSBucketName = N'aabucket1' . @resultmsg=@rmsg output select @rmsg To capture the output message and the result code.us-east-1. @FileNumber = 1 . ap-northeast-1.opt' @tsmpointintime='2006-03-16 14:49:35' @tsmarchive=1 Restore Database from Amazon S3 Cloud EXEC master.mdf''. @ProxyHost = N'proxy.SQL2005\AA_3_restored11_log. run the following: declare @rmsg varchar(999) exec master. run the following: declare @rc int declare @rmsg varchar(999) exec master. @rmsg xp_restore_filelistonly Returns a result set with a list of the database and log files contained in a LiteSpeed backup set. @ProxyPort = 8080 .. @AWSRegionName = N'us-west-2' -. To capture the output message.bak' .<procedure_name> <arguments>.xp_restore_database @CloudVendor = N'AmazonS3' .<procedure_name> <arguments>.my key . us-west-2. . @AWSAccessKey = N'AQRTJBTRPKPRG6QJTWMQ' -. @ProxyLogin = N'DOMAIN\temp-xyz-MYtester' . MOVE ''AA_ 3_log'' TO ''E:\Databases. apsoutheast-1.1 User Guide 270 . @AWSAccessKey = N'***********'. execute the following: exec master. @filenumber = n] xp_restore_filelistonly (Amazon S3 cloud) exec master.1 User Guide 271 . @AWSSecretKey = N'****************'. @UseSSL = 1 Arguments Tips: l l To see the list of accepted arguments and data types for arguments.dbo. execute the following: exec master.xp_restore_filelistonly ( @filename = 'backup_file_name') [. @filenumber = 1. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument.xp_restore_filelistonly @filename = 'tape_device_name' [. For TSM backups and TSM archives. @tsmclientownerpwd = 'TSM_client_owner_password'] [. @AWSBucketName = N'california'.xp_restore_filelistonly @filename = N'test/test/test. LiteSpeed for SQL Server 8.dbo.dbo. @tsmclientnode = 'TSM_client_node'] [. @tsmobject = 'TSM_object'] [.<procedure_name> show_help To convert the script for use with the command-line utilities...dbo.. <xp_arguments> @filename The name of the LiteSpeed backup device file to be extracted.bkp'.dbo.Syntax xp_restore_filelistonly (Disk or TSM) EXEC master.n] [. @filenumber = n] [. This argument accepts network destinations.<procedure_name> show_cmd. @CloudVendor = N'AmazonS3'. @tsmpointintime = 'date_time' ] xp_restore_filelistonly (Tape) EXEC master. @tsmconfigfile = 'TSM_configuration_file'] [. For example. then the most recent of the times must be chosen. You can use the -I command-line argument or @init to back up to a nonunique location. l tsm_low_level specifies actual name of the file. @tsmpointintime Specifies the date for restore/to filter results. The format is yyyy-mm-dd hh:mm:ss. high level and low level. @tsmconfigfile Specifies the TSM configuration file.1 User Guide 272 . if specified in the options file or if backing up with the Passwordaccess Generate option. a file number of 1 indicates the first backup set on the backup medium. LiteSpeed for SQL Server 8. LiteSpeed will choose the most recent archived backup. 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). You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. Not required. restoring. extracting or reading from files with multiple appended backups. and a file number of 2 indicates the second backup set. It is not possible to append an object to this location. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l tsm_filespace is the logical space on the TSM server that contains a group of files. @tsmobject Defines the TSM filespace. Tape restores: Identifies the backup set to be restored. @tsmclientownerpwd Specifies the TSM client owner user password. It can be the drive label name or UNC name. l tsm_high_level specifies the directory path in which the file belongs.@filenumber Disk restores: Specifies the particular backup to use when recasting. Not required. @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. NOTE: You may only store one item the location specified by this argument. If it is not passed. if specified in the options file or if backing up with the Passwordaccess Generate option. FileId nvarchar(4000) Identifier of the device files. run the following: declare @rc int declare @rmsg varchar(999) exec master.Results Column Name Data Type Description for backup sets LogicalName nvarchar(4000) Logical name of the SQL Server data or log device. @resultcode=@rc output select @rc.. MaxSize nvarchar(4000) Value returned from SQL Server. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. BackupSizeInBytes nvarchar(4000) Size (in bytes) of the backup for the device file. Returns 0 (success) or non-zero (failure). run the following: declare @rmsg varchar(999) exec master. Tip: To retrieve information from TSM backups. FileGroupId nvarchar(4000) Identifier of the filegroup the device files belong to. To capture the output message. @resultmsg=@rmsg output. also use xp_view_tsmcontents. PhysicalName nvarchar(4000) Full path of the SQL Server data or log device. Size nvarchar(4000) Size (in bytes) of the device file.<procedure_name> <arguments>. The header information is sent as a row by the server for each backup on a given backup device in a table. LiteSpeed for SQL Server 8..1 User Guide 273 . Type nvarchar(4000) Device Types: l D—Data device l L—Transaction Log Device FileGroupName nvarchar(4000) Name of the filegroup the device files belong to. @rmsg xp_restore_headeronly Retrieves the backup header information for all LiteSpeed backups.<procedure_name> <arguments>. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation. @attachedfiles = 0 | 1 | 2 | 3 ] [. @tsmconfigfile = 'TSM_configuration_file' [. @headerdetails = 'option'] [. @AWSBucketName = N'aabucket7'] [. @filenumber = n] [. @attachedfiles = 0 | 1 | 2 | 3 ] xp_restore_headeronly (TSM) EXEC master.dbo.n] [.<procedure_name> show_help LiteSpeed for SQL Server 8. @AWSRegionName = N'us-west-2'] [.dbo..Syntax xp_restore_headeronly (Disk) EXEC master.xp_restore_headeronly @filename = 'tape_device_name' [. @tsmclientnode = 'clientnode_name'] [.dbo. @ProxyHost = N'proxy.dbo. @tsmclientownerpwd = '****'] [.bak' [. @ProxyPassword = N'***'] Arguments Tips: l To see the list of accepted arguments and data types for arguments. @tsmarchive = 0 | 1 ] [.1 User Guide 274 . @attachedfiles = 0 | 1 | 2 | 3 ] xp_restore_headeronly (Tape) EXEC master. @ProxyPort = 8080] [. execute the following: exec master.. @filenumber = n] [. @FileName = N'AA_3_1.xp_restore_headeronly [@filename = 'backup_file_name'] [.sitelocal'] [.. @tsmpointintime = 'date_time'] [. @headerdetails = 'option'] [.xp_restore_headeronly @CloudVendor = N'AmazonS3' . @headerdetails = 'option'] xp_restore_headeronly (Amazon S3 cloud) EXEC master.dbo. @AWSSecretKey = P91YGUGurKaQM1qJSDP'] [.xp_restore_headeronly @tsmobject = 'TSM_object' . @AWSAccessKey = N'AZIZJBKLRTQJENGQ'] [. @ProxyLogin = N'DOMAIN\xyz-tst-MYTester'] [. @AWSSecretKeyEnc The @AWSSecretKeyEnc argument specifies the name of the encrypted Amazon Web Service secret key that is assigned when you initially get an AWS account. @AWSBucketName The @AWSBucketName argument specifies the name of the container for AWS objects.1 User Guide 275 . apsoutheast-2. Example values are but not limited to: us-east-1. @AWSUseGovCloud The @AWSUseGovCloud argument enables a special restricted region for the US Government use in Amazon S3. This argument accepts one of the following values: l 0—Backup header information only l 1—Attached files only l 2—Backup header information and a list of attached files l 3—Attached directories and individual files outside of those directories @AWSAccessKey The @AWSAccessKey argument specifies the name of the unique Amazon Web Service alphanumeric access key that identifies each user. ap-southeast-1. @AWSRegionName The @AWSRegionName argument specifies the name of the Amazon Web Service region to use for a bucket. @AWSAccessKeyEnc The @AWSAccessKeyEnc argument specifies the name of the encrypted unique Amazon Web Service alphanumeric access key that identifies each user.<procedure_name> show_cmd. us-west-1.l To convert the script for use with the command-line utilities. and sa-east-1. This argument accepts one of the following values: l 0—Do not use government cloud l 1—Use government cloud LiteSpeed for SQL Server 8. <xp_arguments> @attachedfiles Lists files attached to a backup. us-west-2. execute the following: exec master. eu-west-1. ap-northeast-1. Bucket names must be at least 3 and no more than 63 characters long. @AWSSecretKey The @AWSSecretKey argument specifies the name of the Amazon Web Service secret key that is assigned when you initially get an AWS account.dbo. The default cloud vendor is AmazonS3. LiteSpeed for SQL Server 8. extracting or reading from files with multiple appended backups. This argument accepts one of the following values: l 0—Do not use reduced redundancy storage l 1—Use reduced redundancy storage @AWSUseServerSideEncryption The @AWSUseServerSideEncryption argument enables the encryption of data stored at rest in Amazon S3. @filename The name of the LiteSpeed backup device file to be extracted. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. and a file number of 2 indicates the second backup set. This argument accepts one of the following values: l 0—Do not use Server Side Encryption l 1—Use Server Side Encryption @CloudVendor The @CloudVendor argument specifies the name of the company offering the Cloud service.1 User Guide 276 . this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. a file number of 1 indicates the first backup set on the backup medium. For TSM backups and TSM archives. l attachedfiles—Lists files attached to a backup. l attachedfileparams—Lists attached directories and individual files outside of those directories. For example. @headerdetails This argument accepts one of the following values: l backup—Retrieves the backup header information. @filenumber Disk restores: Specifies the particular backup to use when recasting. This argument accepts network destinations. restoring.@AWSUseReducedRedundancy The @AWSUseReducedRedundancy argument specifies the use of reduced redundancy storage in Amazon S3. l all—Retrieves all the backup header information. Tape restores: Identifies the backup set to be restored. then the LiteSpeed core engine checks the local .@ProxyHost The @ProxyHost argument is optional and specifies the name of the Amazon Web Service host machine that is running the proxy server. then the LiteSpeed core engine checks the local . If the proxy parameters are not detected.ini files for the proxy parameters. The TCP/IP port values can be 1-65535. If the proxy parameters are not detected.ini files for the proxy parameters. If the proxy parameters are not detected. then the LiteSpeed core engine checks the local . @ProxyPasswordEnc The @ProxyPasswordEnc argument is optional and specifies the encrypted proxy server password credential. then the LiteSpeed core engine connects directly to the Amazon servers. then the LiteSpeed core engine connects directly to the Amazon servers. @ProxyPort The @ProxyPort argument is optional and contains the port number of the proxy server. This argument accepts one of the following values: l 0—False (default) l 1—True LiteSpeed for SQL Server 8. @ProxyPassword The @ProxyPassword argument is optional and specifies the proxy server password credential. NOTE: l If the @ProxyPasswordEnc argument is not defined. then the LiteSpeed core engine connects directly to the Amazon servers. NOTE: l If the @ProxyPort argument is not defined. then the LiteSpeed core engine connects directly to the Amazon servers. NOTE: l If the @ProxyPassword argument is not defined. NOTE: l If not defined.1 User Guide 277 . then the LiteSpeed core engine checks the local . then the LiteSpeed core engine checks the local . If the proxy parameters are not detected.ini files for the proxy parameters. If the proxy parameters are not detected. NOTE: l If the @ProxyHost argument is not defined. @ProxyLogin The @ProxyLogin argument is optional and specifies the proxy server login credential. @tsmarchive Specifies to store the backup as a TSM archive.ini files for the proxy parameters.ini files for the proxy parameters. then the LiteSpeed core engine connects directly to the Amazon servers. 1 User Guide 278 . @tsmclientownerpwd Specifies the TSM client owner user password. @tsmobject Defines the TSM filespace. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l tsm_filespace is the logical space on the TSM server that contains a group of files. @UseSSL The @UseSSL argument specifies that the connection uses SSL security. If it is not passed. then the most recent of the times must be chosen. It can be the drive label name or UNC name.dbo. Display backup set information and attached files: exec master. l tsm_low_level specifies actual name of the file. It is not possible to append an object to this location. @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. high level and low level. @tsmpointintime Specifies the date for restore/to filter results. You can use the -I command-line argument or @init to back up to a nonunique location. Not required. 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). if specified in the options file or if backing up with the Passwordaccess Generate option. The format is yyyy-mm-dd hh:mm:ss. This argument accepts one of the following values: l 0—Do not use SSL l 1—Use SSL (default) Examples 1. l tsm_high_level specifies the directory path in which the file belongs. if specified in the options file or if backing up with the Passwordaccess Generate option.xp_restore_headeronly @filename = N'C:\Program Files\Microsoft SQL LiteSpeed for SQL Server 8. Not required.@tsmconfigfile Specifies the TSM configuration file. NOTE: You may only store one item the location specified by this argument. LiteSpeed will choose the most recent archived backup. @FileName = N'AA_3_1. @ProxyPort = 8080 .my key . Region for selected @AWSBucketName will be used. @AWSSecretKey = P91YGUGurKaQM1qJSDP' -. us-west-2. @AWSBucketName = N'aabucket7' .bak' .177'. @attachedfiles = 2 2. @AWSRegionName = N'us-west-2' -.my key . LiteSpeed for SQL Server 8. @ProxyHost = N'proxy. BackupDescription nvarchar(128) Backup set description. BackupType nvarchar(128) Backup type: l 1—Database l 2—Transaction Log l 4—File l 5—Differential Database l 6—Differential File l 7—Partial l 8—Partial Differential ExpirationDate Datetime Expiration date for the backup set. ap-northeast-1. @tsmobject = N'test\test\model' . Guid Uniqueidentifier Backup Guid.xp_restore_headeronly @tsmclientnode = N'10. @tsmconfigfile = N'D:\dsm. @AWSAccessKey = N'AZIZJBKLRTQJENGQ' -.26. @tsmclientownerpwd = N'Quest2013'. Compressed Tinyint 0—No compression.opt' . ap-southeast-2.) .bak' . Restore headers from an AmazonS3 Cloud backup: exec master. @attachedfiles = 1 3.1\MSSQL\Backup\FASTCOMP_full2. BackupFormat nvarchar(128) Reserved field. @ProxyPassword = N'***' Results xp_restore_headeronly displays the following information: Column Name Data Type Description FileNumber Int Number of the Backup within the LiteSpeed backup device. List files attached to a tsm backup: exec master.1.sitelocal' .1 User Guide 279 . sa-east-1 (this is an optional parameter. uniquely identifies LiteSpeed backup sets. Returns 1.us-east-1.Server\MSSQL. ap-southeast-1. BackupName nvarchar(128) Backup set name.dbo. us-west-1.xp_restore_headeronly @CloudVendor = N'AmazonS3' . @ProxyLogin = N'DOMAIN\xyz-tst-MYTester' . eu-west-1.dbo. BackupFinishDate datetime Date and time that the backup operation finished. NULL for file backups. CompatibilityLevel Tinyint Compatibility level setting of the database from which the backup was created. Encryption Int Indicates if backup is encrypted l 0—not encrypted LiteSpeed for SQL Server 8. BindingID Uniqueidentifier Binding ID for the database. CheckpointLSN numeric (25.0) Log sequence number of the most recent full database backup. BackupSize numeric (20. BackupStartDate datetime Date and time that the backup operation began. For SQL Server. SoftwareVersionMinor Int Minor version number of the server that created the backup set. this number is 4608 (or hexadecimal 0x1200). RecoveryForkID Uniqueidentifier ID for the current recovery fork for this backup. DatabaseVersion int Version of the database from which the backup was created.Column Name Data Type Description 1—Compressed Position Smallint Position of the backup set in the volume (for use with the FILE = option). SoftwareVersionMajor Int Major version number of the server that created the backup set. ServerName nvarchar(128) Name of the server that wrote the backup set. NULL for file backups.0) Log sequence number of the first transaction in the backup set. SoftwareVendorId Int Software vendor identification number. LastLSN numeric (25. DifferentialBaseLSN numeric (25.0) Log sequence number of the most recent checkpoint at the time the backup was created. SoftwareVersionBuild Int Build number of the server that created the backup set. CodePage Smallint Server code page or character set used by the server.0) Size of the backup.1 User Guide 280 .0) Log sequence number of the last transaction in the backup set. MachineName nvarchar(128) Name of the server that wrote the backup set. in bytes. This column is valid for database backups only. DatabaseName nvarchar(128) Name of the database that was backed up. FirstLSN numeric (25. SortOrder Smallint Server sort order. DeviceType Tinyint Virtual Device > 7—Logical 107—Physical UserName nvarchar(128) Username that performed the backup operation. Provided for backward compatibility. DatabaseCreationDate datetime Date and time the database was created. NOTES: l l A database cannot be restored unless the restore process has exclusive access to the database.1 User Guide 281 . run the following: declare @rmsg varchar(999) exec master.<procedure_name> <arguments>.. @rmsg xp_restore_log Restores LiteSpeed transaction log backups taken using the xp_backup_log command. or from a full database backup operation using xp_backup_log.Column Name Data Type Description l IsCopyOnly nvarchar(128) 1—encrypted Indicates if the backup is a copy-only backup. Files and filegroups may also be restored either from a file or filegroup LiteSpeed backup operation. @resultcode=@rc output select @rc. run the following: declare @rc int declare @rmsg varchar(999) exec master. Returns 0 (success) or non-zero (failure). @resultmsg=@rmsg output.. When restoring files or filegroups. you must apply a transaction log using xp_ restore_log. file differential backups can be restored after a full file restore using LiteSpeed. LiteSpeed for SQL Server 8. In addition. No user connections can exist when performing a database restore. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation. You cannot restore filegroups to a point in time.<procedure_name> <arguments>. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. To capture the output message. @CloudVendor = N'AmazonS3'. @encryptionkey = 'encryption_key'] [. @AWSAccessKey = N'*******'. @filename = 'tape_device_name' [. @with = 'additional_with_parameters'] [.100] [.. @filenumber = n] [. @affinity = 0. @logging = 0 | 1 | 2 ] [. @returndetails = 0 | 1 ] xp_restore_log (Amazon S3 cloud) exec master.. @buffercount = 'buffer_count'] [.xp_restore_log @database = 'database_name' . @buffercount = 'buffer_count'] [. @with = N'RECOVERY'... @tsmclientnode = 'TSM_client_node'] [. @rewind = 0 | 1 ] [.. @logging = 0 | 1 | 2 ] [.dbo. @filename = N'test\tlogl. @attachedfile = 'pathname'] [. @maxtransfersize = 'maximum_transfer_size'] [.n] [. ( @encryptionkey = 'encryption_key' | @jobp = 'encrypted_key' )] [. @tsmpointintime = 'date_time' ] [..dbo.. @filenumber = 1.xp_restore_log @database = N'model' . LiteSpeed for SQL Server 8.2147483648] [.... @affinity = 0.. @returndetails = 0 | 1 ] [.n] [.. @unload = 0 | 1 ] [. @restoreascompressed = 0 | 1] xp_restore_log (Tape) EXEC master. @filenumber = n] [.n] [. @maxtransfersize = 'maximum_transfer_size'] [.Syntax xp_restore_log (Disk or TSM) EXEC master. @throttle = 1. @ioflag = 'DISK_RETRY_COUNT=n'] [. @tsmconfigfile = 'TSM_configuration_file'] [.dbo.. @with = 'additional_with_parameters'] [..100] [. @ioflag = 'DISK_RETRY_WAIT=n'] [. @AWSSecretKey = N'**********'. @filename = 'backup_file_name') [.1 User Guide 282 . @AWSBucketName = N'california'.n] [. @attachedfile = 'pathname'] [.xp_restore_log @database = 'database_name' (.. @tsmclientownerpwd = 'TSM_client_owner_password'] [.bak'.2147483648] [. @tsmobject = 'TSM_object'] [. @throttle = 1. @restoreasreadonly = 0 | 1] [. @UseSSL = 1.. @with = N'STATS = 10'..n] [. execute the following: exec master. This argument only restores the attached files. @logging = 0 Arguments Tips: l l To see the list of accepted arguments and data types for arguments.<procedure_name> show_help To convert the script for use with the command-line utilities. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. You can supply multiple instances of this argument. 7. See Adaptive Compression on page 72 for more information. then LiteSpeed recursively includes all files and subdirectories. Number the bits from the right to left. execute the following: exec master. This form will take the syntax of <file_path> to <new_file_path>.@affinity = 0. <xp_arguments> @affinity Processor affinity designates specific processors to run LiteSpeed. The result is binary 100110. tape. All attached files are encrypted and compressed. while not allowing LiteSpeed to run on the remaining processors. It does not restore the database. If it is a directory. LiteSpeed for SQL Server 8.dbo. The rightmost bit represents the first processor. For example. 3. NOTE: 32-bit Windows is internally limited to a 32-bit mask. This feature works for disk. 3. with all pertinent backup parameters supported. just the files that were attached to that backup. you need to select processors 2.dbo. If a value begins with "0x" it is interpreted as hexadecimal. it is recommended that you limit the threading as well. and sixth bits to 1 and all other bits to 0. and 6 for use with LiteSpeed. If you decide to use an affinity value other than default. try limiting the number of threads. The filepath can be either a single file or a directory. TSM. The new filepath can be used to specify a new location but cannot rename a file.1 User Guide 283 . When used within the context of a restore operation. and 6 205 11001101 1. @attachedfile Specifies filepaths to include in both backup and restore operations.<procedure_name> show_cmd. and Double Click Restore as well. which is decimal 38 or hexadecimal 0x26. 2 and 3 38 100110 2. Set the second. Review the following for additional information: Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 3 11 1 and 2 7 111 1. You may also want to consider using Adaptive Compression to maintain backup performance. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process. third. 4. This argument accepts decimal values and hexadecimal values. 3. the path parameter can be expanded to include a new destination. a backup cannot be restored or recovered without the original encryption key.g. the restore will fail. except for the ntext or text data types. For TSM backups and TSM archives. then the program will not encrypt the backup. LiteSpeed for SQL Server 8. extracting or reading from files with multiple appended backups. If you use the wrong encryption key. Caution: When encrypting data. @buffercount Specifies the number of SQL Server buffers available for a LiteSpeed operation. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. This argument accepts network destinations.NOTES: l The original entire directory path need not be supplied (e. @filenumber Disk restores: Specifies the particular backup to use when recasting. The default value is set by SQL Server. restoring. c: to c:\testadSattsm is allowed). @database Name of database to be backed up or restored. If you do not supply encryption key. l c:\testad to testadr would restore all files in directory c:\testad to c:\testadr. Example of key: 'Mypassword' @filename The name of the LiteSpeed backup device file to be extracted. @encryptionkey Value used to generate the encryption key for the encryption algorithm.1 User Guide 284 . This parameter specifies a database: l to be backed up (xp_backup_database and xp_slsSmartDiff) l containing the transaction log to be backed up (xp_backup_log) l to be restored (xp_restore_database and xp_restore_log) l on which you wish to check the progress of an activity (xp_slsReadProgress) l for which you want to delete old backups (xp_slsSmartCleanup) If supplied as a variable (@database). this name can be specified either as a string constant (@database = database name) or as a variable of character string data type. take care not to lose the encryption key. This argument accepts one of the following values: LiteSpeed for SQL Server 8.304 bytes (4 MB). To log to a different directory add @Trace='logpath=path'. You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. and a file number of 2 indicates the second backup set. l 1 or any odd value—Logging on. The original password (or encrypted key generated by xp_encrypt_restore_key) must be used to restore a backup. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. @ioflag Specifies if LiteSpeed should wait and retry the read or write operation on failure. DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. Log file is removed on success. The default is 15 seconds. You can use xp_encrypt_backup_key to convert the password (encryption_key) for use with @jobp.bkp' . (Similar to @EncryptionKey). @priority Specifies the priority of the LiteSpeed process compared to other processes running on the same server. @jobp Specifies an encrypted key.194.xp_backup_database @filename='c:\test. NOTE: This functionality is only available for disk operations. This argument accepts one of the following values: l 0—Logging off. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. to specify a database backup where each failure can be retried once after a 30-second wait: EXEC master. l 2 or any even value—Logging on. The default is 4 retries. a file number of 1 indicates the first backup set on the backup medium. See Configure Logging in LiteSpeed for information about LiteSpeed logging. @ioflag='DISK_RETRY_WAIT=30' See Network Resilience on page 75 for more information. @database='test' . For example. the maximum allowed setting is 300. For example.1 User Guide 285 . @logging Writes a log file for the operation. The default is 1048576 (1 MB).Tape restores: Identifies the backup set to be restored. @maxtransfersize Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed.dbo. the maximum allowed setting is 1000. @ioflag='DISK_RETRY_COUNT=1' . This argument accepts one of the following values: l 0—False (default) l 1—True @restoreasreadonly Instructs the restore operation to leave the database in read-only mode.l -1—Below Normal l 0—Normal (Default) l 1—AboveNormal l 2—High @restoreascompressed Works in conjunction with @restoreasreadonly. it can only be restored as read-only. The possible values are multiples of 65536 bytes (64 LiteSpeed for SQL Server 8. l NTFS compression of read-only databases is not supported in SQL Server 2000. The compression level can be NULL. if backed up with Adaptive Compression. MaxTransferSize int Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed.1 User Guide 286 . CompressionLevel tinyint Compression level used for compressing the backup. NOTES: l When using an NTFS-compressed folder for a database. This argument accepts one of the following values: l 0—False (default) l 1—True Using this option. you can restore a user database into an NTFS compressed folder or restore a tlog to a readonly database in a compressed folder. Operation nvarchar (30) Operation type: Backup or Restore. creates a folder if it does not exist. l You can only use this feature on Windows NTFS file systems. and then compresses it. l 0—False (default) l 1—True The result set contains the following details: Column Name Data Type Description Database nvarchar (128) Database name. @returndetails Generates a single-row result set. AdaptiveCompression nvarchar (max) Adaptive Compression option used for compressing the backup: 'speed' or 'size'. Threads tinyint The number of threads used for a LiteSpeed backup. 304 bytes (4 MB). See Adaptive Compression on page 72 for more information. Not required. it is recommended that you limit the threading as well. StripeCount smallint Number of backup files in the stripe set. BackupSize bigint Size of the backup (in bytes). 3) Duration of the operation. LiteSpeed for SQL Server 8. ElapsedSeconds numeric (18. @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. Not required. The argument accepts an integer value between 1 and 100. You may also want to consider using Adaptive Compression to maintain backup performance.194. The default value is 100. If you decide to use an affinity value other than default. TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. BufferCount smallint The number of SQL Server buffers available for a LiteSpeed operation.1 User Guide 287 . you can use Group Execute to produce a single result set for several server instances. This argument accepts one of the following values: l 0—Leave the tape unwound (default) l 1—Rewind the tape after writing/reading @throttle Specifies the maximum CPU usage allowed. @tsmclientownerpwd Specifies the TSM client owner user password. @tsmconfigfile Specifies the TSM configuration file. try limiting the number of threads. if specified in the options file or if backing up with the Passwordaccess Generate option. CPUSeconds numeric (18. Tip: In Toad. OverlappedBuffers tinyint The number of buffers that any single VDI thread can use at a time. if specified in the options file or if backing up with the Passwordaccess Generate option. BaseSize int The smallest chunk of memory LiteSpeed attempts to write to disk at any given time. @rewind Applies only to backing up and restoring tape. This is the percentage of the total amount of CPU usage (across all enabled processors) available.Column Name Data Type Description KB) ranging up to 4. NativeSize bigint Backup size (in bytes) without LiteSpeed compression. The default is 1048576 (1 MB) . 3) Processor time used by the LiteSpeed operation. high level and low level. If not specified. @unload Applies to tape backups and restores. @tsmobject Defines the TSM filespace. The format is yyyy-mm-dd hh:mm:ss.@tsmmanagementclass Specifies the TSM management class. @tsmpointintime Specifies the date for restore/to filter results. LiteSpeed uses the default management class. This extended stored procedure accepts the following @with parameters: LiteSpeed for SQL Server 8. This argument accepts one of the following values: l 0—Keep tape loaded (default) l 1—Unload and eject tape from the drive after operation @with Each @with argument should be a syntactically complete and correct statement. If it is not passed. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l tsm_filespace is the logical space on the TSM server that contains a group of files. 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). use multiple @with arguments. NOTE: You may only store one item the location specified by this argument. l tsm_low_level specifies actual name of the file. It can be the drive label name or UNC name. Please refer to the SQL Server Transact-SQL backup and restore documentation for the syntax and usage. It is not possible to append an object to this location. then the most recent of the times must be chosen. Do not supply the @with parameter if no additional features are required. You can use the -I command-line argument or @init to back up to a nonunique location. l tsm_high_level specifies the directory path in which the file belongs.1 User Guide 288 . If you need more than 255 characters. LiteSpeed will choose the most recent archived backup. The supported formats are: l @with='PARAMETER' l @with='PARAMETER=''accepted_value''' NOTES: l l Extended stored procedure arguments are limited to 255 characters. The size required for the undo file depends on the volume of undo actions resulting from uncommitted transactions. SQL Server requires that the WITH NORECOVERY option is used on all but the final xp_ restore_log statement when restoring a database backup and multiple transaction logs using LiteSpeed. RECOVERY. STANDBY STANDBY = ''undo_file_name'' Specifies the undo file name so the recovery effects can be undone. the database is not usable in this intermediate. LiteSpeed for SQL Server 8. or sysadmin roles.Parameter Description NORECOVERY Instructs the restore operation to not roll back any uncommitted transactions. This upgrade is performed automatically when WITH RECOVERY is specified. RECOVERY is the default. If the file does exist. LiteSpeed overwrites it. LiteSpeed defaults to RECOVERY. or when multiple xp_restore_database or xp_restore_log statements are needed (for example. NORECOVERY or STANDBY should be specified instead. a sequence of file restores is used and the database is not intended to be usable between two of the restore operations. If NORECOVERY. LiteSpeed creates it. dbcreator. Either the NORECOVERY or STANDBY option must be specified if another transaction log has to be applied. non-recovered state. NORECOVERY forces the database to remain in the restoring state after the restore operation. After the recovery process. or STANDBY is not specified. If subsequent LiteSpeed restore operations (xp_restore_log or xp_restore_database from differential) are planned. If you do not specify NORECOVERY. STOPAT STOPAT = date_time | @date_time_var Specifies that the database be restored to the state it was in as of the specified date and time. smalldatetime. When used with a file or filegroup restore operation. RECOVERY. If NORECOVERY. or STANDBY. or datetime data type. char. RECOVERY. NOTE: When specifying the NORECOVERY option. If a variable is used for STOPAT. The same undo file can be used for consecutive LiteSpeed restores of the same database. NOTE: If free disk space is exhausted on the drive containing the specified undo file name. RECOVERY is the default. the variable must be varchar. If the specified undo file name does not exist. the LiteSpeed restore operation stops. or STANDBY is not specified. This is useful in either of these situations: l l RECOVERY a restore script is being run and the log is always being applied. a database upgrade may be required.1 User Guide 289 . this restricts access for the restored database to members of the db_ owner. Only transaction log records written before the specified date and time are applied to the database. STANDBY allows a database to be brought up for read-only access between transaction log restores and can be used with either warm standby server situations or special recovery situations in which it is useful to inspect the database between log restores. RESTRICTED_USER When used in conjunction with recovery (another with param and the default) leaving a usable database. Instructs the restore operation to roll back any uncommitted transactions. the database is ready for use. a full database backup followed by a differential database backup). When restoring backup sets from an earlier version of SQL Server. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation. run the following: declare @rmsg varchar(999) exec master.<procedure_name> <arguments>. STOPBEFOREMARK STOPBEFOREMARK = ''mark_name'' [ AFTER Datetime ] Specifies recovery to the specified mark but does not include the transaction that contains the mark. If AFTER Datetime is specified.xp_restore_log @database='MyDB' . Restore Log to Log Mark: EXEC master. @filename = 'C:\MSSQL\Backup\MyDB_Backup. including the transaction that contains the mark. recovery stops at the first mark having the specified name exactly at or after Datetime. run the following: declare @rc int declare @rmsg varchar(999) exec master. CHECKSUM Causes checksums to be verified when a LiteSpeed backup is created. To capture the output message. If AFTER Datetime is omitted.. If you do not want to check the checksums during a restore.1 User Guide 290 . STOPATMARK STOPATMARK = ''mark_name'' [ AFTER Datetime ] Specifies recovery to the specified mark.BAK' .BAK' . the database is left in an unrecovered state. recovery stops at the first mark with the specified name. Examples 1. @with = 'STOPBEFOREMARK= ''LogMark''' 2.dbo. just as if xp_restore_log had been run with NORECOVERY.. @resultmsg=@rmsg output. recovery stops at the first mark with the specified name. recovery stops at the first mark having the specified name exactly at or after Datetime. it is automatically checked.<procedure_name> <arguments>.Parameter Description NOTE: If you specify a STOPAT time that is beyond the end of the xp_restore_log operation. @filename = 'C:\MSSQL\Backup\MyDB_Backup. If AFTER Datetime is specified. supply 'NO_CHECKSUM' . @with ='RECOVERY' . PASSWORD Specifies the password for the backup set. Restore Log to Point in Time: EXEC master.000''' Returns 0 (success) or non-zero (failure). @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. NOTE: When you restore a backup containing checksum. @resultcode=@rc LiteSpeed for SQL Server 8. @with = 'RECOVERY' . @with = 'STOPAT = ''2003-03-19 11:10:57.dbo.xp_restore_log @database='MyDB' . If AFTER Datetime is omitted. LiteSpeed for SQL Server 8. @AWSAccessKeyEnc = 'accesskeyenc'. @tsmarchive = 0 | 1 ] [. Syntax xp_restore_setinfo (Disk or Tape) EXEC master.xp_restore_setinfo @tsmobject = 'TSM_object' . Bucket names must be at least 3 and no more than 63 characters long.xp_restore_setinfo @filename = 'file name' @CloudVendor = 'AmazonS3'. @AWSSercretKeyEnc = 'secretkeyenc' Arguments @AWSAccessKey The @AWSAccessKey argument specifies the name of the unique Amazon Web Service alphanumeric access key that identifies each user.dbo. @AWSBucketName = 'bucket name'.dbo.1 User Guide 291 .xp_restore_setinfo @filename = 'file_name' [. @tsmconfigfile = 'TSM_configuration_file' [. @tsmpointintime = 'date_time'] xp_restore_setinfo (Cloud) EXEC master. @rmsg xp_restore_setinfo Returns information about the stripe set to which the backup file belongs. @AWSAccessKeyEnc The @AWSAccessKeyEnc argument specifies the name of the encrypted unique Amazon Web Service alphanumeric access key that identifies each user. @tsmclientownerpwd = '****'] [. @filenumber = n] xp_restore_setinfo (TSM) EXEC master.output select @rc.dbo. @tsmclientnode = 'clientnode_name'] [. @AWSBucketName The @AWSBucketName argument specifies the name of the container for AWS objects. NOTE: l If the @ProxyHost argument is not defined. us-west-1. @filename The name of the LiteSpeed backup device file to be extracted. ap-southeast-1. @ProxyHost The @ProxyHost argument is optional and specifies the name of the Amazon Web Service host machine that is running the proxy server. then the LiteSpeed core engine checks the local . If the proxy parameters are not detected. @AWSSecretKey The @AWSSecretKey argument specifies the name of the Amazon Web Service secret key that is assigned when you initially get an AWS account. @AWSSecretKeyEnc The @AWSSecretKeyEnc argument specifies the name of the encrypted Amazon Web Service secret key that is assigned when you initially get an AWS account.ini files for the proxy parameters. extracting or reading from files with multiple appended backups. @ProxyLogin The @ProxyLogin argument is optional and specifies the proxy server login credential. then the LiteSpeed core engine connects directly to the Amazon servers. ap-northeast-1. NOTE: LiteSpeed for SQL Server 8. and sa-east-1.1 User Guide 292 . For TSM backups and TSM archives. The default cloud vendor is AmazonS3. restoring. us-west-2. apsoutheast-2.@AWSRegionName The @AWSRegionName argument specifies the name of the Amazon Web Service region to use for a bucket. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. @CloudVendor The @CloudVendor argument specifies the name of the company offering the Cloud service. eu-west-1. This argument accepts network destinations. @filenumber Specifies the particular backup to use when recasting. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. Example values are but not limited to: us-east-1. ini files for the proxy parameters. @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. If the proxy parameters are not detected. Not required. then the LiteSpeed core engine connects directly to the Amazon servers. NOTE: l If the @ProxyPassword argument is not defined. then the LiteSpeed core engine checks the local . Not required. NOTE: l If the @ProxyPort argument is not defined. then the LiteSpeed core engine checks the local . NOTE: l If the @ProxyPasswordEnc argument is not defined.1 User Guide 293 . @ProxyPort The @ProxyPort argument is optional and contains the port number of the proxy server. @tsmclientownerpwd Specifies the TSM client owner user password. then the LiteSpeed core engine checks the local .ini files for the proxy parameters.l If not defined. @ProxyPassword The @ProxyPassword argument is optional and specifies the proxy server password credential. LiteSpeed for SQL Server 8. then the LiteSpeed core engine connects directly to the Amazon servers.ini files for the proxy parameters. The TCP/IP port values can be 1-65535. If the proxy parameters are not detected. then the LiteSpeed core engine connects directly to the Amazon servers.ini files for the proxy parameters. This argument accepts one of the following values: l 0—False (default) l 1—True @tsmconfigfile Specifies the TSM configuration file. If the proxy parameters are not detected. if specified in the options file or if backing up with the Passwordaccess Generate option. If the proxy parameters are not detected. if specified in the options file or if backing up with the Passwordaccess Generate option. then the LiteSpeed core engine checks the local . @tsmarchive Specifies to store the backup as a TSM archive. @ProxyPasswordEnc The @ProxyPasswordEnc argument is optional and specifies the encrypted proxy server password credential. then the LiteSpeed core engine connects directly to the Amazon servers. LiteSpeed returns the message from SQL Server: "The backup set is valid. Returns 0 (success) or non-zero (failure). 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). If it is not passed." LiteSpeed for SQL Server 8. 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 nonunique location. LiteSpeed will choose the most recent archived backup. It checks to see that the backup set is complete and that all volumes are readable. StripeGUID Uniqueidentifier Unique identifier of LiteSpeed stripe set. The format is yyyy-mm-dd hh:mm:ss.xp_restore_setinfo @filename = 'C:\SQLServerBackups\CD3. but does not restore the backup. Example EXEC master.dbo. If the backup is valid.@tsmobject Defines the TSM filespace. then the most recent of the times must be chosen. NOTE: You may only store one item the location specified by this argument. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l tsm_filespace is the logical space on the TSM server that contains a group of files. StripeCount Int Number of backup files in the stripe set. high level and low level. @tsmpointintime Specifies the date for restore/to filter results. StripeNumber Int Backup file number within the stripe set. xp_restore_verifyonly Verifies the backup. It can be the drive label name or UNC name.1 User Guide 294 .bak' Results Column Name Data Type Description FormatVersion Int Actual version of LiteSpeed binary format used to create the backup. l tsm_low_level specifies actual name of the file. l tsm_high_level specifies the directory path in which the file belongs. @CloudVendor = N'AmazonS3'. @affinity = 0..dbo.n] [.2147483648] [.100] [. @tsmpointintime = 'date_time'] [. @affinity = 0. @buffercount = 'buffer_count'] [. @ioflag = 'DISK_RETRY_COUNT=n'] [. @affinity = 0. @tsmarchive = 1 | 0 ] [. @maxtransfersize = 'maximum_transfer_size'] [. @AWSAccessKey = N'************'. @returndetails = 0 | 1] xp_restore_verifyonly (Amazon S3 cloud) exec master. @logging = 0 LiteSpeed for SQL Server 8. @throttle = 1. @tsmclientnode = 'TSM_client_node'] [. @with = N'STATS = 10'. @encryptionkey = 'encryption_key'| @jobp = 'encrypted_key' ) ] [.2147483648] [.. @filenumber = 1. @filenumber = n] [. @returndetails = 0 | 1] xp_restore_verifyonly (Tape) EXEC master. @tsmobject = 'TSM_object'] [. @filenumber = n] [. @UseSSL = 1. @throttle = 1. @tsmclientownerpwd = 'TSM_client_owner_password'] [. @maxtransfersize = 'maximum_transfer_size'] [.100] [. @AWSBucketName = N'california'. @ioflag = 'DISK_RETRY_WAIT=n'] [.1 User Guide 295 .bak'. @encryptionkey = 'encryption_key' ] [.xp_restore_verifyonly @filename = N'test\tlogl.dbo.Syntax xp_restore_verifyonly (Disk or TSM) EXEC master. @logging = 0 | 1 | 2 ] [.xp_restore_verifyonly @filename = 'backup_file_name' [.. @logging = 0 | 1 | 2 ] [. @AWSSecretKey = N'**********'.. @unload = 0 | 1 ] [. @tsmconfigfile = 'TSM_configuration_file'] [. @buffercount = 'buffer_count'] [..xp_restore_verifyonly @filename = 'tape_device_name' [.dbo.. @with = N'RECOVERY'.. 3.Arguments Tips: l l To see the list of accepted arguments and data types for arguments. and 6 205 11001101 1. a backup cannot be restored or recovered without the original encryption key. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process. take care not to lose the encryption key. You may also want to consider using Adaptive Compression to maintain backup performance. 7. and sixth bits to 1 and all other bits to 0. Review the following for additional information: Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 3 11 1 and 2 7 111 1. the restore will fail. while not allowing LiteSpeed to run on the remaining processors.1 User Guide 296 . 2 and 3 38 100110 2. NOTE: 32-bit Windows is internally limited to a 32-bit mask. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. If you use the wrong encryption key. @buffercount Specifies the number of SQL Server buffers available for a LiteSpeed operation. and 6 for use with LiteSpeed. Number the bits from the right to left. <xp_arguments> @affinity Processor affinity designates specific processors to run LiteSpeed.dbo. try limiting the number of threads. you need to select processors 2. 3. third. execute the following: exec master. Example of key: 'Mypassword' LiteSpeed for SQL Server 8. Set the second. @encryptionkey Value used to generate the encryption key for the encryption algorithm. execute the following: exec master. which is decimal 38 or hexadecimal 0x26. 3. See Adaptive Compression on page 72 for more information. If you decide to use an affinity value other than default. If a value begins with "0x" it is interpreted as hexadecimal. The rightmost bit represents the first processor. Caution: When encrypting data. If you do not supply encryption key. For example. This argument accepts decimal values and hexadecimal values. then the program will not encrypt the backup. it is recommended that you limit the threading as well.<procedure_name> show_cmd.dbo. The result is binary 100110. The default value is set by SQL Server.<procedure_name> show_help To convert the script for use with the command-line utilities. 4. and a file number of 2 indicates the second backup set. to specify a database backup where each failure can be retried once after a 30-second wait: EXEC master.dbo. For example. (Similar to @EncryptionKey). @database='test' . For example. @jobp Specifies an encrypted key. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name. the maximum allowed setting is 300. @ioflag='DISK_RETRY_COUNT=1' . the maximum allowed setting is 1000. LiteSpeed for SQL Server 8. extracting or reading from files with multiple appended backups. The original password (or encrypted key generated by xp_encrypt_restore_key) must be used to restore a backup. You can use xp_encrypt_backup_key to convert the password (encryption_key) for use with @jobp. DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. This argument accepts network destinations. The default is 15 seconds.xp_backup_database @filename='c:\test.1 User Guide 297 . You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. For TSM backups and TSM archives. NOTE: This functionality is only available for disk operations. @ioflag Specifies if LiteSpeed should wait and retry the read or write operation on failure. Tape restores: Identifies the backup set to be restored.@filename The name of the LiteSpeed backup device file to be extracted. a file number of 1 indicates the first backup set on the backup medium.bkp' . @ioflag='DISK_RETRY_WAIT=30' See Network Resilience on page 75 for more information. this argument accepts the following formats: l tsmbkp:<filespace>\<high>\<low> l tsmarc:<filespace>\<high>\<low You can supply multiple instances of this argument. The default is 4 retries. restoring. @filenumber Disk restores: Specifies the particular backup to use when recasting. l 1 or any odd value—Logging on.1 User Guide 298 . CPUSeconds numeric (18. LiteSpeed for SQL Server 8. Threads tinyint The number of threads used for a LiteSpeed backup. 3) Duration of the operation. @maxtransfersize Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. The compression level can be NULL. OverlappedBuffers tinyint The number of buffers that any single VDI thread can use at a time. To log to a different directory add @Trace='logpath=path'. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4.304 bytes (4 MB). l 0—False (default) l 1—True The result set contains the following details: Column Name Data Type Description Database nvarchar (128) Database name. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. MaxTransferSize int Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. AdaptiveCompression nvarchar (max) Adaptive Compression option used for compressing the backup: 'speed' or 'size'. The default is 1048576 (1 MB) .194.194. if backed up with Adaptive Compression. l 2 or any even value—Logging on. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. This argument accepts one of the following values: l 0—Logging off. 3) Processor time used by the LiteSpeed operation. BufferCount smallint The number of SQL Server buffers available for a LiteSpeed operation. @returndetails Generates a single-row result set. Operation nvarchar (30) Operation type: Backup or Restore.@logging Writes a log file for the operation. Log file is removed on success. CompressionLevel tinyint Compression level used for compressing the backup. ElapsedSeconds numeric (18. The default is 1048576 (1 MB). BaseSize int The smallest chunk of memory LiteSpeed attempts to write to disk at any given time. See Configure Logging in LiteSpeed for information about LiteSpeed logging.304 bytes (4 MB). StripeCount smallint Number of backup files in the stripe set. Tip: In Toad. The argument accepts an integer value between 1 and 100. @throttle Specifies the maximum CPU usage allowed. You may also want to consider using Adaptive Compression to maintain backup performance. Not required. you can use Group Execute to produce a single result set for several server instances. it is recommended that you limit the threading as well. high level and low level. @tsmobject Defines the TSM filespace.Column Name Data Type Description NativeSize bigint Backup size (in bytes) without LiteSpeed compression. try limiting the number of threads. It can be the drive label name or UNC name. @tsmarchive Specifies to store the backup as a TSM archive.1 User Guide 299 . @tsmclientownerpwd Specifies the TSM client owner user password. If you decide to use an affinity value other than default. if specified in the options file or if backing up with the Passwordaccess Generate option. This argument accepts the following format: tsm_filespace\tsm_high_level\tsm_low_level where: l tsm_filespace is the logical space on the TSM server that contains a group of files. This is the percentage of the total amount of CPU usage (across all enabled processors) available. l tsm_high_level specifies the directory path in which the file belongs. See Adaptive Compression on page 72 for more information. LiteSpeed for SQL Server 8. This argument accepts one of the following values: l 0—False (default) l 1—True @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. @tsmconfigfile Specifies the TSM configuration file. TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. The default value is 100. l tsm_low_level specifies actual name of the file. Not required. if specified in the options file or if backing up with the Passwordaccess Generate option. BackupSize bigint Size of the backup (in bytes). dbo. Please refer to the SQL Server Transact-SQL backup and restore documentation for the syntax and usage.1 User Guide 300 . it is automatically checked. then the most recent of the times must be chosen. PASSWORD Specifies the password for the backup set. Do not supply the @with parameter if no additional features are required. The format is yyyy-mm-dd hh:mm:ss. @tsmpointintime Specifies the date for restore/to filter results. You can use the -I command-line argument or @init to back up to a nonunique location. It is not possible to append an object to this location. This extended stored procedure accepts the following @with parameters: Parameter Description CHECKSUM Causes checksums to be verified when a LiteSpeed backup is created. If you do not want to check the checksums during a restore. Example EXEC master. use multiple @with arguments. NOTE: When you restore a backup containing checksum. 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). @unload Applies to tape backups and restores.NOTE: You may only store one item the location specified by this argument. supply 'NO_CHECKSUM' . LiteSpeed for SQL Server 8.xp_restore_verifyonly @filename='C:\MSSQL\Backup\MyDB_Backup.BAK' Returns 0 (success) or non-zero (failure). LiteSpeed will choose the most recent archived backup. Return codes represent the native error number returned from SQL Server for any errors encountered during the operation. This argument accepts one of the following values: l 0—Keep tape loaded (default) l 1—Unload and eject tape from the drive after operation @with Each @with argument should be a syntactically complete and correct statement. If it is not passed. The supported formats are: l @with='PARAMETER' l @with='PARAMETER=''accepted_value''' NOTES: l l Extended stored procedure arguments are limited to 255 characters. If you need more than 255 characters. <procedure_name> <arguments>. See Double Click Restore Executables on page 73 for more information. @resultcode=@rc output select @rc.To capture the output message. 2—Creates a Double Click Restore loader in the same location.<procedure_name> <arguments>. @doubleclick Creates a Double Click Restore executable. NOTE: A Double Click Restore can only be created for a disk file. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. If a backup is a native SQL Server backup or it is larger than 4 GB. run the following: declare @rmsg varchar(999) exec master.bak' LiteSpeed for SQL Server 8. @rmsg xp_slsCreateDCR This stored procedure converts a Native or LiteSpeed backup file to a Double Click Restore backup. It also performs a rename on the file if applicable. it creates a Double Click Restore loader in the same location. Example exec xp_slscreatedcr @FileName = N'I:\test\test. if the size of the backup is less than 4GB.. @resultmsg=@rmsg output. @doubleclick = 1 | 2 ] Agruments @filename Specifies the path to the backup. a selfexecuting and self-extracting backup that can be restored on a server instance that does not have LiteSpeed installed. See Double Click Restore Executables on page 73 for more information. This argument accepts one of the following values: l l 1—Converts a LiteSpeed backup to a Double Click Restore executable. run the following: declare @rc int declare @rmsg varchar(999) exec master. Syntax exec xp_slsCreateDCR @FileName='<path>' [..1 User Guide 301 . run the following: declare @rc int declare @rmsg varchar(999) exec master. partial. LiteSpeed for SQL Server 8. @rmsg xp_slsFastCompression xp_slsFastCompression (previously known as xp_slsSmartDiff) performs a full. run the following: declare @rmsg varchar(999) exec master. or differential database backup using Fast Compression technology.. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code.<procedure_name> <arguments>. To capture the output message.1 User Guide 302 .. @resultmsg=@rmsg output. @resultcode=@rc output select @rc.<procedure_name> <arguments>. See Fast Compression on page 67 for more information.Returns 0 (success) or non-zero (failure). @BackupDirectory = 'backup_directory' { @ForceFull = 0 | 1 | @ForceDifferential = 0 | 1 | ( @ExtentsChgRatioRequireFull = '1%'.... @retaindays = 0. @ElapsedDaysRequireFull = 1. FG1. @throttle = 1. @tsmclientownerpwd = 'TSM_client_owner_password'] [...100] [. @AppendDifferential = 0 | 1 ] [. @comment = 'comment'] [. @encryptionkey = 'encryption_key'] [. @adaptivecompression = 'size' | 'speed' ] [.n] [...32] [. @desc = 'backup_description'] [.. LiteSpeed for SQL Server 8... @FullBackupEscalation = 0 | 1 ] [...2147483647 ] [.. @backupname = 'backupset_name'] [. @tsmconfigfile = 'TSM_configuration_file'] [.. @logging = 0 | 1 | 2 ] [..'100%') [.n] [.n] [. @tsmdevicetimeoutminutes = n] [. FGBackups_PROD. The database used in the example below... @with = 'additional_with_parameters'] [. @ioflag = 'DISK_RETRY_WAIT=n'] [.n] ([. @filegroup = 'logical_filegroup_name'] [....'7' ] [. @maxtransfersize = 'maximum_transfer_size'] [. @ioflag = 'DISK_RETRY_COUNT=n'] [. and FG3). @SpecificDaysForbidFull = '1'.n])} [.. @tsmmanagementclass = 'TSM_management_class'] [. @SearchAlternateBackup = 'backup_directory' ] [. @with = 'option_name'] xp_slsFastCompression (restore partial backup with fast compression) NOTE: The following example shows the syntax for performing partial restores using the “read_write_ filegroups” parameter.. @affinity = 0. @cryptlevel = 'encryption_level'] [. @tsmdsmi_log = 'path'] [.Full' | 'All'] [..dbo. @file = 'logical_file_name'] [..xp_slsFastCompression @database = 'database_name' .n] [.n] [. @tsmdsmi_dir = 'path'] [.. @tsmclientnode = 'TSM_client_node'] [. @compressionlevel = 'compression_level'] [. FG2.'100%' | @DiffToFullRatioRequireFull = '1%'. @Verify = 'Last' | 'Full' | 'Last. @threads = 1. @CheckForFullBackup = 0 | 1 ] [. @MirrorDirectory = 'mirror_directory'] [. @priority = -1 | 0 | 1 | 2 ] [. @expiration = 'date_time'] [.. @tsmlogname = 'log_name'] [.Syntax EXEC master.. @tsmfilespace = 'TSM_file_space'] [. contains the following filegroups: Primary. @attachedfile = 'pathname'] [.. @buffercount = 'buffer_count'] [.2147483647] [..1 User Guide 303 . You may also want to consider using Adaptive Compression to maintain backup performance.dbo. it is recommended that you limit the threading as well. 7. @read_write_filegroups = 1 Arguments Tips: l l To see the list of accepted arguments and data types for arguments. and 8 Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. The rightmost bit represents the first processor. 4.<procedure_name> show_help To convert the script for use with the command-line utilities. execute the following: exec master. @BackupDirectory = 'I:\SQLbackups' . 3. and 6 205 11001101 1. NOTE: 32-bit Windows is internally limited to a 32-bit mask. third. @ExtentsChgRatioRequireFull = '.dbo.Tip: This example takes a partial backup of the primary and secondary read write filegroups (Primary. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process. execute the following: exec master. If you decide to use an affinity value other than default. try limiting the number of threads. and sixth bits to 1 and all other bits to 0. @AppendDifferential Appends data to an existing full backup file. and FG2).1 User Guide 304 . If a value begins with "0x" it is interpreted as hexadecimal. Set the second. and 6 for use with LiteSpeed.<procedure_name> show_cmd. Review the following for additional information: Decimal Value Binary Bit Mask Allow LiteSpeed Threads on Processors 0 0 All (default) 1 1 1 3 11 1 and 2 7 111 1. EXEC master. 3. @ForceFull = 1. you need to select processors 2.4'.dbo. while not allowing LiteSpeed to run on the remaining processors. Number the bits from the right to left. FG1. The result is binary 100110. 2 and 3 38 100110 2. <xp_arguments> @affinity Processor affinity designates specific processors to run LiteSpeed. This argument accepts decimal values and hexadecimal values. which is decimal 38 or hexadecimal 0x26. For example.This argument accepts one of the following values: l 0—False (default) l 1—True LiteSpeed for SQL Server 8. 3.xp_slsFastCompression @database = N'FGBackups_PROD' . See Adaptive Compression on page 72 for more information. @AWSBucketName The @AWSBucketName argument specifies the name of the container for AWS objects. us-west-1. The number of parts can be up to 5 if there is enough memory available during the upload. NOTES: l Amazon S3 has a maximum allowable 10. eu-west-1. Example values are but not limited to: us-east-1.000 limit. @AWSAccessKeyEnc The @AWSAccessKeyEnc argument specifies the name of the encrypted unique Amazon Web Service alphanumeric access key that identifies each user. you may inadvertently go over the 10. @AWSRegionName The @AWSRegionName argument specifies the name of the Amazon Web Service region to use for a bucket. If you override this parameter. us-west-2.@attachedfile l 0—False (default) l 1—True @AWSAccessKey The @AWSAccessKey argument specifies the name of the unique Amazon Web Service alphanumeric access key that identifies each user. The minimum Part Size = 25MB. and sa-east-1. l Minimum and maximum values for Part Size are defined by Amazon S3: 5MB and 5120MB (5GB) relatively. @AWSPartSize The size of each part that is uploaded to Amazon S3 (in MB). apsoutheast-2. ap-southeast-1.000. The LiteSpeed default is 3 parts.000 parts per file. @AWSSecretKey The @AWSSecretKey argument specifies the name of the Amazon Web Service secret key that is assigned when you initially get an AWS account. ap-northeast-1. LiteSpeed for SQL Server 8.1 User Guide 305 . l The maximum object size is 5TB. @AWSMaxParts Is the number of parts that are simultaneously uploaded to Amazon S3. Bucket names must be at least 3 and no more than 63 characters long. If you override this parameter. you may impact memory usage. TIP: Dell recommends using LiteSpeed defaults. The LiteSpeed default for Part Size is calculated as a database size divided into 9. This argument accepts one of the following values: l 0—Do not use reduced redundancy storage l 1—Use reduced redundancy storage @AWSUseServerSideEncryption The @AWSUseServerSideEncryption argument enables the encryption of data stored at rest in Amazon S3. @buffercount Specifies the number of SQL Server buffers available for a LiteSpeed operation. This argument accepts variables. If the full backup file does exist. If the full backup file does not exist. it performs a full backup. @backupname Specifies the name of the backup set. Accepts the following values: l 0—False (default) l 1—True LiteSpeed for SQL Server 8. This argument accepts one of the following values: l 0—Do not use Server Side Encryption l 1—Use Server Side Encryption @BackupDirectory Specifies a directory for the backup file.1 User Guide 306 . This argument accepts one of the following values: l 0—Do not use government cloud l 1—Use government cloud @AWSUseReducedRedundancy The @AWSUseReducedRedundancy argument specifies the use of reduced redundancy storage in Amazon S3. @CheckForFullBackup Checks if the expected full backup exists when backing up to separate files and returns a failure message if it is not found. @AWSUseGovCloud The @AWSUseGovCloud argument enables a special restricted region for the US Government use in Amazon S3. See LiteSpeed Variables on page 76 for more information. The default value is set by SQL Server.@AWSSecretKeyEnc The @AWSSecretKeyEnc argument specifies the name of the encrypted Amazon Web Service secret key that is assigned when you initially get an AWS account. the decision to perform a new full or a differential backup will depend on other conditions specified. See LiteSpeed Variables on page 76 for more information. The default cloud vendor is AmazonS3.@CloudVendor The @CloudVendor argument specifies the name of the company offering the Cloud service. it is best to try various options using your equipment and data to determine the best option for your environment. @comment Appends a user comment to the backup. See Test Optimal Backup Settings on page 43 for more information. 0 bypasses the compression routines. @compressionlevel Specifies the compression level for the backup. Valid values are 0 through 8. This argument accepts one of the following values: l 0—40-bit RC2 l 1—56 bit RC2 l 2—112 bit RC2 l 3—128 bit RC2 l 4—168 bit 3DES l 5—128 bit RC4 l 6—128 bit AES l 7—192 bit AES l 8—256 bit AES @database Name of database to be backed up or restored. When choosing a compression level. NOTE: If both the compression level and Adaptive Compression option are passed in. The remaining values of 1 through 8 specify compression with increasingly aggressive computation.1 User Guide 307 . See Test Optimal Backup Settings on page 43 for more information on analyzing the best backup settings for your environment. 2 is the default value. This parameter specifies a database: l to be backed up (xp_backup_database and xp_slsSmartDiff) l containing the transaction log to be backed up (xp_backup_log) LiteSpeed for SQL Server 8. Specify the encryption level. Use the Backup Analyzer to test the performance of different compression levels. This argument accepts variables. but they require more CPU and take longer. LiteSpeed will not error out and will select and use Adaptive Compression. Higher levels improve security. @cryptlevel Works in conjunction with the @encryptionkey parameter. 4' l '40%' @ElapsedDaysRequireFull Specifies the minimum number of days since last full backup required to perform full backup.1 User Guide 308 . this name can be specified either as a string constant (@database = database name) or as a variable of character string data type. Caution: When encrypting data. then the program will not encrypt the backup. The default value is 14. @DiffToFullRatioRequireFull Specifies the last differential backup size to last full backup size ratio. @desc Specifies a description to store with the backup.l to be restored (xp_restore_database and xp_restore_log) l on which you wish to check the progress of an activity (xp_slsReadProgress) l for which you want to delete old backups (xp_slsSmartCleanup) If supplied as a variable (@database). If you do not supply encryption key. the restore will fail. LiteSpeed will not overwrite this file until expiration datetime is passed. When exceeding the specified ratio LiteSpeed performs a full backup. This argument accepts one of the following formats: l '. This argument accepts variables. If you use the wrong encryption key. except for the ntext or text data types. This argument accepts one of the following formats: l yyyy-mm-dd l yyyy-mm-dd hh:mm:ss LiteSpeed for SQL Server 8. See LiteSpeed Variables on page 76 for more information. @encryptionkey Value used to generate the encryption key for the encryption algorithm. take care not to lose the encryption key. Example of key: 'Mypassword' @ExtentsChgRatioRequireFull Specifies the minimum amount of database changes required for the full backup.4' l '40%' @expiration Specifies the date and time when the backup expires. a backup cannot be restored or recovered without the original encryption key. This argument accepts one of the following formats: l '. This argument accepts one of the following values: l 0—False (default) l 1—True @FullBackupEscalation This option causes LiteSpeed to issue a full backup. You can supply multiple instances of this argument. Files in a filegroup backup can be restored individually or as a group.1 User Guide 309 . A differential backup is missing from the backup set (excludes backups automatically removed after the specified retention period).the default for new items. @ForceDifferential Forces differential backup. 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. This argument accepts one of the following values: l 0—False (default) l 1—True LiteSpeed for SQL Server 8. an error will be returned.for an existing item that does not have an extension defined @file Specifies a logical database file used for file or filegroup backups.@FastCompressionExtension Specifies the fast compression file extension. l bkp . l LSN verification fails in the backup set. if one of the following problems is discovered in the current backup set: l l The full backup is missing. NOTE: If a problem is detected and a full backup is created through escalation. It accepts the following values: l 0—False (default) l 1—True @ForceFull Forces full backup. This argument accepts one of the following formats: l bak . @filegroup Specifies a database filegroup to include in the backup or restore. l Verify operation fails on full or differential backup. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4. Types can include: all. l System . The default is 15 seconds. @logging Writes a log file for the operation. For example. @ioflag='DISK_RETRY_COUNT=1' . DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying.1 User Guide 310 .Backup specifically selected databases.194. user. system. l Selected .304 bytes (4 MB). the maximum allowed setting is 1000. @maxtransfersize Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. The default output directory is C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. LiteSpeed for SQL Server 8.Backup only system databases.Backup only user databases. or selected databases. l 2 or any even value—Logging on.@ioflag Specifies if LiteSpeed should wait and retry the read or write operation on failure. You can define retry options using the following parameters: l l DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. Log file is removed on success. NOTE: This functionality is only available for disk operations. l 1 or any odd value—Logging on. @database='test' . The default is 1048576 (1 MB). You can supply multiple instances of this argument. the maximum allowed setting is 300. @MirrorDirectory Specifies a directory for a mirror backup.xp_backup_database @filename='c:\test. @MultiDatabaseType Produces a backup that includes several types of databases.bkp' . This argument accepts one of the following values: l All . l User . This argument accepts one of the following values: l 0—Logging off. to specify a database backup where each failure can be retried once after a 30-second wait: EXEC master. The default is 4 retries. @ioflag='DISK_RETRY_WAIT=30' See Network Resilience on page 75 for more information. See Configure Logging in LiteSpeed for information about LiteSpeed logging. To log to a different directory add @Trace='logpath=path'.dbo.Backup all system and user databases. ini files for the proxy parameters.@olrmap Generates a map file during a backup for Object Level Recovery. then the LiteSpeed core engine connects directly to the Amazon servers. then the LiteSpeed core engine connects directly to the Amazon servers.ini files for the proxy parameters. NOTE: LiteSpeed for SQL Server 8. @ProxyPassword The @ProxyPassword argument is optional and specifies the proxy server password credential. If the proxy parameters are not detected. This argument accepts one of the following values: l 0—False (default) l 1—True @priority Specifies the priority of the LiteSpeed process compared to other processes running on the same server. This argument accepts one of the following values: l -1—Below Normal l 0—Normal (Default) l 1—AboveNormal l 2—High @ProxyHost The @ProxyHost argument is optional and specifies the name of the Amazon Web Service host machine that is running the proxy server. @ProxyLogin The @ProxyLogin argument is optional and specifies the proxy server login credential.1 User Guide 311 . @ProxyPasswordEnc The @ProxyPasswordEnc argument is optional and specifies the encrypted proxy server password credential. then the LiteSpeed core engine checks the local .ini files for the proxy parameters. NOTE: l If not defined. then the LiteSpeed core engine checks the local . NOTE: l If the @ProxyHost argument is not defined. then the LiteSpeed core engine connects directly to the Amazon servers. If the proxy parameters are not detected. then the LiteSpeed core engine checks the local . If the proxy parameters are not detected. NOTE: l If the @ProxyPassword argument is not defined. The argument accepts an integer value between 1 and 100. w. but the exact value depends on several factors including: processors available. @SearchAlternateBackupDirectory Specifies the directory where to search for the backup file. any read/write secondary filegroups. @read_write_filegroups includes only the primary filegroup. then the LiteSpeed core engine connects directly to the Amazon servers. NOTE: l If the @ProxyPort argument is not defined. @read_write_filegroups Specifies a partial backup. then the LiteSpeed core engine checks the local . The TCP/IP port values can be 1-65535. Wednesday. which includes all the read/write files in a database: the primary filegroup. compression level. IO device speed. @ProxyPort The @ProxyPort argument is optional and contains the port number of the proxy server. LiteSpeed will not overwrite this file for this number of days. and SQL Server responsiveness. @SpecificDaysForbidFull Specifies days of the week when a full backup is never performed. This is the percentage of the total amount of CPU usage (across all enabled processors) available.ini files for the proxy parameters. If the proxy parameters are not detected. su'—on Monday. @retaindays Specifies a number of days to retain the backup. The default value is 100. You will achieve the best results by specifying multiple threads. where n is the number of processors.l If the @ProxyPasswordEnc argument is not defined. affinity setting. @throttle Specifies the maximum CPU usage allowed. then the LiteSpeed core engine connects directly to the Amazon servers. and Sunday @threads Determines the number of threads used for the backup. then the LiteSpeed core engine checks the local . If the proxy parameters are not detected.1 User Guide 312 . and any specified read-only files or filegroups. If the database is read-only. LiteSpeed for SQL Server 8. It accepts the following formats: l 3—on Tuesday l 'tu'—on Tuesday l '5-7'—from Thursday to Saturday l 'm. The default is n-1 threads. encryption settings.ini files for the proxy parameters. Passwords are case-sensitive. @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. NOTE: IBM recommends that an application client should select a unique file space. Not required. LiteSpeed for SQL Server 8. @tsmdsmi_dir DSMI_DIR path if needed.1 User Guide 313 . it is recommended that LiteSpeed users follow this practice with a specific file space reserved for LiteSpeed backups. @tsmclientownerpwd Specifies the TSM client owner user password. @tsmmanagementclass Specifies the TSM management class. @tsmconfigfile Specifies the TSM configuration file. LiteSpeed uses the default management class. @tsmdsmi_log DSMI_LOG path. if specified in the options file or if backing up with the Passwordaccess Generate option. try limiting the number of threads. @tsmpassword The TSM username password. If you decide to use an affinity value other than default. It can be the drive label name or UNC name. @tsmdevicetimeoutminutes Specifies how long to wait for a TSM device. @tsmlogname Log name. If not specified. You can supply multiple instances of this argument. it is recommended that you limit the threading as well. See Adaptive Compression on page 72 for more information. if specified in the options file or if backing up with the Passwordaccess Generate option. Not required.TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance. the logical space on the TSM server. @tsmfilespace Specifies the TSM file space. You may also want to consider using Adaptive Compression to maintain backup performance. use multiple @with arguments.@tsmusername The TSM username ID. LiteSpeed for SQL Server 8. supply 'NO_CHECKSUM' . Please refer to the SQL Server Transact-SQL backup and restore documentation for the syntax and usage.Last—Verifies the last full backup and last differential is available l All—Verifies last full backup and all differentials since @with Each @with argument should be a syntactically complete and correct statement. @UseSSL The @UseSSL argument specifies that the connection uses SSL security. NOTE: When you restore a backup containing checksum. This extended stored procedure accepts the following @with parameters: Parameter Description CHECKSUM Causes checksums to be verified when a LiteSpeed backup is created. This argument accepts one of the following values: l 0—Do not use SSL l 1—Use SSL (default) @Verify Performs a restore verification on the backup file just created (if backup was successful). If you do not want to check the checksums during a restore. CONTINUE_ AFTER_ ERROR Causes the backup be executed despite encountering an invalid backup checksum. The supported formats are: l @with='PARAMETER' l @with='PARAMETER=''accepted_value''' NOTES: l l Extended stored procedure arguments are limited to 255 characters.1 User Guide 314 . If you need more than 255 characters. This argument accepts one of the following values: l Full—Verifies the last full backup l Last—Verifies last backup performed (can be either a full or differential) l Full. Do not supply the @with parameter if no additional features are required. it is automatically checked. @tsmdevicetimeoutminutes = 2. @AdaptiveCompression = 'Speed'.4' 2.1\MSSQL\Backup' .dbo.xp_slsFastCompression @database = 'Northwind' . @FullBackupEscalation = 1 5. @tsmclientnode = N'w2k3_TSM'. Backup to TSM. Back up the Northwind database. @ElapsedDaysRequireFull = 10 3. @ElapsedDaysRequireFull = 14.1\MSSQL\Backup' . @FastCompressionExtension = ‘bkp’ LiteSpeed for SQL Server 8. EXEC master.xp_slsFastCompression @database = 'Northwind' .xp_slsFastCompression @database = N'userdb3'. @backupname = N'userdb3 . @BackupDirectory = 'C:\Program Files\Microsoft SQL Server\MSSQL. @ExtentsChgRatioRequireFull = N'40%'. EXEC master. @CheckForFullBackup = 1.xp_slsFastCompression @database = 'Northwind' .dbo. exec master. @MirrorDirectory = 'D:\SQLServerBackups' . @comment = N''. @tsmmanagementclass = N'STANDARD'. @BackupDirectory = 'C:\Program Files\Microsoft SQL Server\MSSQL.xp_slsFastCompression @database = N'A1'. @AppendDifferential = 0.Fast Compression Backup'. Force full backup. Back up the Northwind database. @backupname = N'A1 . @ExtentsChgRatioRequireFull = N'35%'. @compressionlevel = 2. Backup showing FastCompressionExtension argument using existing item bkp file extension. Back up the Northwind database to multiple locations. @desc = N'Fast Compression Backup of userdb3'. @FullBackupEscalation = 1.opt'. @tsmfilespace = N'FC'. @BackupDirectory = 'C:\Program Files\Microsoft SQL Server\MSSQL.dbo.dbo. Perform full backup only if the amount of database changes since the last full backup is more than 40%.dbo.Fast Compression Backup'. @desc = N'Fast Compression Backup of A1'. @BackupDirectory = N'D:\Backups'.Examples 1. @ExtentsChgRatioRequireFull = '. Perform full backup only if more than 10 days have passed since last full backup. EXEC master. @ForceFull = 1 4. exec master. @tsmclientownerpwd = N'***'.1 User Guide 315 .1\MSSQL\Backup' . Perform full backup only if the amount of database changes since the last full backup is more than 40%. @tsmconfigfile = N'C:\Program Files\Tivoli\TSM\baclient\dsm. @Percent = @Result output if @Result = 100 begin print 'Done' end LiteSpeed for SQL Server 8..<procedure_name> <arguments>.dbo. @resultmsg=@rmsg output. @resultcode=@rc output select @rc. Syntax EXEC master.1 User Guide 316 . To capture the output message.<procedure_name> <arguments>.xp_slsreadprogress @database = 'database_name' Examples 1.. for example: (1 row(s) affected) 96 percent completed 2. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. run the following: declare @rc int declare @rmsg varchar(999) exec master. Query the progress of an activity based on the result returned (in this case print 'DONE' when the progress is 100 percent): Declare @Result int exec xp_slsreadprogress @database='Northwind'. run the following: declare @rmsg varchar(999) exec master.Returns 0 (success) or non-zero (failure). Read the progress of the current activity at a specified database: exec xp_slsreadprogress @database='Northwind' This command returns the percentage complete. @rmsg xp_slsreadprogress Reads the progress of the current activity on a specified database and returns an integer (0-100) indicating the percentage completed of the current activity on the specified database. @TSMClientOwnerPwd = 'TSM_client_owner_password'] [. @CopyOnlyBackups = 'option'] [.. execute the following: exec master. if there are mixed backups in the same backup file.. @TSMDSMI_LOG = 'path'] [.. execute the following: exec master.bak backup file.dbo.1 User Guide 317 .. For example. @TSMLogName = 'log_name'] Arguments Tips: l l To see the list of accepted arguments and data types for arguments. (@LogRetainDays = 1. @TSMDSMI_DIR = 'path'] [. The backup retention will never delete: l l The backup files. (@BackupRetainDays = 1.dbo. The full backup.xp_slsSmartCleanup @database = 'database_name' .365 | @LogExpiration = 'date_time') [. @TSMPassword = 'TSM_username_password'] [. @DryRun = 0 | 1 ] [. l File/FileGroup backups l File/FileGroup differential backups l Partial backups l Partial differential backups l Files that have the filesystem archive bit set (if that option is selected) Syntax exec master.<procedure_name> show_help To convert the script for use with the command-line utilities. @TSMConfigFile = 'TSM_configuration_file'] [. if a user performs a backup of AdventureWorks and Pubs into the same mybackups. @TSMUserName = 'TSM_username_ID'] [.dbo. @TSMClientNode = 'TSM_client_node'] [. <xp_arguments> @AWSAccessKey The @AWSAccessKey argument specifies the name of the unique Amazon Web Service alphanumeric access key that identifies each user.xp_slsSmartCleanup Removes full and differential backup files and transaction log backups based on a user-defined period (either the file age or the date).<procedure_name> show_cmd.365 | @BackupExpiration = 'date_time') . @KeepArchiveFiles = 0 | 1 ] [. LiteSpeed for SQL Server 8. if there are associated differential or t-log backups in the backup set that are not eligible for cleanup. @AWSSecretKey The @AWSSecretKey argument specifies the name of the Amazon Web Service secret key that is assigned when you initially get an AWS account. ap-southeast-1. @AWSRegionName The @AWSRegionName argument specifies the name of the Amazon Web Service region to use for a bucket. Bucket names must be at least 3 and no more than 63 characters long.1 User Guide 318 . LiteSpeed for SQL Server 8. ap-northeast-1. us-west-1. Example values are but not limited to: us-east-1. @AWSSecretKeyEnc The @AWSSecretKeyEnc argument specifies the name of the encrypted Amazon Web Service secret key that is assigned when you initially get an AWS account. and sa-east-1.@AWSAccessKeyEnc The @AWSAccessKeyEnc argument specifies the name of the encrypted unique Amazon Web Service alphanumeric access key that identifies each user. This argument accepts one of the following values: l 0—Do not use government cloud l 1—Use government cloud @BackupExpiration Specifies the date using one of the following formats: YYYY-MM-DD YYYY-MM-DD HH:MM:SS where l YYYY—4-digit year l MM—2-digit month l DD—2-digit day of the month l HH—2-digit hour using the local 24-hour clock l MM—2-digit minute l SS—2-digit second To be eligible for cleanup. eu-west-1. us-west-2. @AWSUseGovCloud The @AWSUseGovCloud argument enables a special restricted region for the US Government use in Amazon S3. @AWSBucketName The @AWSBucketName argument specifies the name of the container for AWS objects. the full or differential backup must be older than this date. apsoutheast-2. 1 User Guide 319 . NOTES: l l l Transaction log backups are not considered dependent on copy-only full or copy-only tlog backups. This is the default behavior when the parameter is not specified. except for the ntext or text data types. The default cloud vendor is AmazonS3. LiteSpeed for SQL Server 8. @database Name of database to be backed up or restored. SmartCleanup does not remove any backups. @KeepArchiveFiles Turns on monitoring and refuses to delete files that have the archive filesystem bit set. @DryRun Displays backups that are to be removed (delete candidates) or kept according to the specified conditions and SmartCleanup logic. l AllowDeletes—Copy-only backups are removed according to the specified retention options. This parameter specifies a database: l to be backed up (xp_backup_database and xp_slsSmartDiff) l containing the transaction log to be backed up (xp_backup_log) l to be restored (xp_restore_database and xp_restore_log) l on which you wish to check the progress of an activity (xp_slsReadProgress) l for which you want to delete old backups (xp_slsSmartCleanup) If supplied as a variable (@database). in which case it will allow deletions. this name can be specified either as a string constant (@database = database name) or as a variable of character string data type. This argument accepts one of the following values: l Default—LiteSpeed will ignore copy-only backups except on secondary replicas in AlwaysOn Availability groups. @CopyOnlyBackups Controls how LiteSpeed handles copy-only backups. if this parameter is specified. When enabled dependent files are not deleted. The full or differential backup must be at least N days old before it is eligible for cleanup. @CloudVendor The @CloudVendor argument specifies the name of the company offering the Cloud service.@BackupRetainDays Specifies the number of days (N). Copy-only transaction log backups will not mark other transaction log or full backups as having a dependent. The values are not case-sensitive. l Ignore—Copy-only backups are never deleted. If the proxy parameters are not detected. @LogRetainDays Specifies the number of days (N). the t-log backup must be older than this date.ini files for the proxy parameters. If the proxy parameters are not detected. NOTE: l If not defined. @ProxyLogin The @ProxyLogin argument is optional and specifies the proxy server login credential. then the LiteSpeed core engine connects directly to the Amazon servers. @ProxyPasswordEnc The @ProxyPasswordEnc argument is optional and specifies the encrypted proxy server password credential. LiteSpeed for SQL Server 8.@LogExpiration Specifies the date of one of the following formats: YYYY-MM-DD YYYY-MM-DD HH:MM:SS where l YYYY—4-digit year l MM—2-digit month l DD—2-digit day of the month l HH—2-digit hour using the local 24-hour clock l MM—2-digit minute l SS—2-digit second To be eligible for cleanup. then the LiteSpeed core engine checks the local . then the LiteSpeed core engine checks the local . then the LiteSpeed core engine connects directly to the Amazon servers.ini files for the proxy parameters. If the proxy parameters are not detected. The t-log backup must be at least N days old before it is eligible for cleanup. then the LiteSpeed core engine connects directly to the Amazon servers. then the LiteSpeed core engine checks the local .ini files for the proxy parameters.1 User Guide 320 . @ProxyPassword The @ProxyPassword argument is optional and specifies the proxy server password credential. @ProxyHost The @ProxyHost argument is optional and specifies the name of the Amazon Web Service host machine that is running the proxy server. NOTE: l If the @ProxyHost argument is not defined. NOTE: l If the @ProxyPassword argument is not defined. @tsmclientownerpwd Specifies the TSM client owner user password. The TCP/IP port values can be 1-65535. Passwords are case-sensitive.ini files for the proxy parameters.ini files for the proxy parameters. @tsmlogname Log name. LiteSpeed for SQL Server 8. if specified in the options file or if backing up with the Passwordaccess Generate option. then the LiteSpeed core engine checks the local . Not required. @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. NOTE: l If the @ProxyPort argument is not defined. If the proxy parameters are not detected. then the LiteSpeed core engine checks the local . if specified in the options file or if backing up with the Passwordaccess Generate option. @tsmpassword The TSM username password. @tsmusername The TSM username ID. @tsmdsmi_log DSMI_LOG path.NOTE: l If the @ProxyPasswordEnc argument is not defined.1 User Guide 321 . @tsmconfigfile Specifies the TSM configuration file. Not required. then the LiteSpeed core engine connects directly to the Amazon servers. @ProxyPort The @ProxyPort argument is optional and contains the port number of the proxy server. If the proxy parameters are not detected. @tsmdsmi_dir DSMI_DIR path if needed. then the LiteSpeed core engine connects directly to the Amazon servers. dbo. allow deletions of the copy-only backups: exec master. Delete tsm log backups older than 2 days: exec master. @LogRetainDays = 2 . Delete disk full and differential backups older than 28 days.@UseSSL The @UseSSL argument specifies that the connection uses SSL security. @resultmsg=@rmsg output select @rmsg LiteSpeed for SQL Server 8. This argument accepts one of the following values: l 0—Do not use SSL l 1—Use SSL (default) Examples 1.xp_slsSmartCleanup @database = @dbname . @CopyOnlyBackups = 'AllowDeletes' 2. @BackupExpiration = '2012-11-15' 3. Delete disk full and differential backups created before 11/15/2012: exec master.dbo. delete log backups older than 2 days. differential and transaction log TSM backups created before 06/15/2012. To capture the output message.xp_slsSmartCleanup @database = 'test2' . @LogRetainDays = 2 4.1 User Guide 322 .opt' .dbo.. Delete full. @tsmconfigfile = N'C:\Program Files\Tivoli\TSM\baclient\dsm. run the following: declare @rmsg varchar(999) exec master. @BackupExpiration = '2012-06-15' .<procedure_name> <arguments>.xp_slsSmartCleanup @database = N'test_tsm' .xp_slsSmartCleanup @database = 'test2' . @tsmconfigfile = N'C:\Program Files\Tivoli\TSM\baclient\dsm_gp. @LogRetainDays = 1 . @tsmclientownerpwd = N'*****' . @LogExpiration = '2012-06-15' 5.xp_slsSmartCleanup @database = N'test_tsm' .dbo. @tsmclientnode = N'w2k3_TSM2' . Keep archived files older than 2 days: exec master. @KeepArchiveFiles = 1 Returns 0 (success) or non-zero (failure).dbo. @BackupRetainDays = 2 .opt' . using the PASSWORDAccess generate option to connect to the TSM Server: exec master. @BackupRetainDays = 28 . Without the arguments. NOTE: You can generate scripts by opening tasks in the LiteSpeed UI Console and clicking View T-SQL. LiteSpeed for SQL Server 8..dbo.<procedure_name> <arguments>. @rmsg xp_slssqlmaint This extended stored procedure executes the slssqlmaint. It accepts a string that contains the command-line arguments to be passed directly to slssqlmaint. run the following: declare @rc int declare @rmsg varchar(999) exec master.%EXT%" -Exclude Offline LogShippng ReadOnly ' Clean up maintenance plans exec master.dbo. See About Creating Maintenance Plans on page 80 for more information. this extended stored procedure returns a result set showing the currently installed LiteSpeed license. @resultcode=@rc output select @rc.1 User Guide 323 .xp_slssqlmaint N'-D Regex:"LiteSpeed" Regex:"Dell" -BkUpMedia DISK DelBkUps 3DAYS -BkUpDB "C:\temp" -CrBkSubDir -BkExt "bak" -Logging 1 -Reliability 1 CompressionLevel 1 -Default "%D_%T_%z.exe.exe utility. Examples Back up database exec master. @resultmsg=@rmsg output.xp_slssqlmaint '-MAINTDEL -DELTYPE FileBkup -DELSUBFOLDERS DelEmptyFolder -DELFOLDER "C:\temp\" -DELEXTENSION "bak" -DELUNIT "3" -DELUNITTYPE "WEEKS" -DELUSEAGE -NO_OUTPUT ' xp_sqllitespeed_licenseinfo Using xp_sqllitespeed_licenseinfo you can register a new LiteSpeed license key or remove licensing information (unlicense LiteSpeed). Syntax EXEC master.dbo.To capture the output message and the result code.xp_slssqlmaint '<task_options> ' See Script Maintenance Plans Tasks on page 141 for more information about the task options and the syntax for scripting maintenance plan tasks. xp_sqllitespeed_licenseinfo @licensekey = 'C20TM3Q3K2HD74UDLBMHC6KYV6HZ3MQFNXZFB-123-45678-34' .Syntax EXEC master. except it comes with support LiteSpeed for SQL Server 8.dbo. License Type nvarchar (128) One of the following: l Trial—a dated trial license key that expires on a specific date l Permanent—a permanent license key l Term—similar to trial keys. Examples 1.dbo.1 User Guide 324 .xp_sqllitespeed_licenseinfo @remove= 1 Result Set Column Name Data Type Description Product Name nvarchar (128) LiteSpeed for SQL Server.xp_sqllitespeed_licenseinfo [ @licensekey = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-111-22222-YY' . Remove license key: EXEC master. @sitemessage = 'Trial Version' 2. @store = 1] | @remove = 1] Arguments @licensekey Passes license key value. @sitemessage = 'Trial Version' . @sitemessage Passes license site message. @remove = 1 Removes the currently stored license.dbo.dbo. License Site Message nvarchar (128) Site message. @sitemessage = 'Site_Message' [. License Key nvarchar (128) Key license value. @store=1 3. @store = 1 Overwrites any currently stored licenses with the valid license supplied.xp_sqllitespeed_licenseinfo @licensekey = 'C20TM3Q3K2HD74UDLBMHC6KYV6HZ3MQFNXZFB-123-45678-34' . View information about the supplied license key: EXEC master. Register a license key: EXEC master. xp_sqllitespeed_version xp_view_tsmcontents Retrieves TSM specific information and backup header information for the given LiteSpeed backup. About Using Extended Stored Procedures xp_sqllitespeed_version This extended stored procedure returns the name and version of the installed LiteSpeed components. @tsmexpdatelower='date_time'] [.xp_view_tsmcontents @tsmclientnode = 'TSM_client_node' . Syntax EXEC master. @tsmhighlevel ='TSM_high_level'] [. The default value is 15. if the expiration date is fixed and not based on the install date. execute the following: exec master. @tsminsdateupper='date_time'] [. Trial Length int Number of trial days. Site License bit Whether the key is a Site license key that is used company-wide. @tsmexpdateupper='date_time'] [. @tsmfilespace = 'TSM_filespace' . NOTE: Some types of trials may have 0. @tsmarchive= 0 | 1 ] [. @tsmpointintime = 'date_time'] Arguments Tips: l To see the list of accepted arguments and data types for arguments.Column Name Data Type Description Edition nvarchar (128) Enterprise or Standard. @tsmbrieflist = 1 | 0 ] [. Expire Date datetime Date value (Trial and Term only).<procedure_name> show_help LiteSpeed for SQL Server 8.dbo.1 User Guide 325 .dbo. @tsmsortbypit = 0 | 1 ] [. @tsminsdatelower='date_time'] [. LiteSpeed will fail any backup of databases larger than the limit. If there is a gigabyte limit set in the license (any value larger than 0). @tsmconfigfile = 'TSM_configuration_file' [. 0 indicates unlimited database size. @tsmlowlevel = 'TSM_low_level'] [.dbo. @tsmclientownerpwd = 'TSM_client_owner_password' . Gigabyte Limit int Database size limit in GB. @tsmsortbylowlevel = 0 | 1 ] [. @desc='description'] [. exec master. dbo. execute the following: exec master.1 User Guide 326 .l To convert the script for use with the command-line utilities. This argument accepts one of the following values: l 0—False (default) l 1—True @tsmbrieflist Returns a brief list.<procedure_name> show_cmd. @tsmconfigfile Specifies the TSM configuration file. The format is yyyymm-dd hh:mm:ss. @tsmexpdatelower For TSM archives. The format is yyyy-mm-dd hh:mm:ss. @tsmarchive Specifies to store the backup as a TSM archive. @tsmclientownerpwd Specifies the TSM client owner user password. @tsmexpdateupper For TSM archives. @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. if specified in the options file or if backing up with the Passwordaccess Generate option. NOTE: @desc is only supported if @TSMBriefList=0. it specifies the oldest expiration date and time of where to start the list. it specifies the most recent expiration date and time of where to stop the list. if specified in the options file or if backing up with the Passwordaccess Generate option. <xp_arguments> @desc Specifies a description to filter the returned results to those that match the pattern. Not required. This argument accepts one of the following values: l 0—False l 1—True (default) NOTE: It is not needed for archives as they are only returned as a brief list. LiteSpeed for SQL Server 8. Not required. @tsmlowlevel Specifies the TSM low-level name.g. it specifies the most recent insertion date and time of where to stop the list. it specifies the oldest insertion date and time of where to start the list. If you do not specify this parameter. You do not necessarily have to have both the @tsmhighlevel and @tsmlowlevel parameters in one query. MyLowLevelName*. @tsmhighlevel Specifies the TSM high-level name. If you do not specify this parameter. The format is yyyy-mm-dd hh:mm:ss. @tsmsortbylowlevel Sorts the results by the low level name.g. You do not necessarily have to have both the @tsmhighlevel and @tsmlowlevel parameters in one query.@tsmfilespace Specifies the space on the TSM server that contains a group of files. MyLowLevelName*. @tsminsdatelower For TSM archives. MyHighLevelName*). This argument accepts one of the following values: l 0—False (default) l 1—True @tsmsortbypit Sorts the results by the point-in-time date. MyHighLevelName*). @tsminsdateupper For TSM archives. It accepts one of the following: l 0—False (default) l 1—True LiteSpeed for SQL Server 8. The format is yyyymm-dd hh:mm:ss. LiteSpeed will retrieve all low levels from the TSM server. NOTES: l l This parameter supports wild cards (e. NOTES: l l This parameter supports wild cards (e. LiteSpeed will retrieve all high levels from the TSM server. It can be the drive label name or UNC name.1 User Guide 327 . BackupType Nvarchar(128) Backup type: ExpirationDate Datetime l 1—Database l 2—Transaction Log l 4—File l 5—Differential Database l 6—Differential File l 7—Partial l 8—Partial Differential (For archives only) The expiration date and time that TSM LiteSpeed for SQL Server 8.1 User Guide 328 . Management Class Nvarchar(128) TSM Management Class. @tsmclientownerpwd= 'test16' . 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). Guid Uniqueidentifier Backup GUID. @tsmexpdatelower='2007-02-14 09:00:00' .opt' . @tsmconfigfile= 'C:\Program Files\Tivoli\tsm\baclient\dsm. Example exec master. BackupName Nvarchar(128) Backup set name.@tsmpointintime Specifies the date for restore/to filter results. @tsminsdateupper='2006-03-16 18:00:00' . LiteSpeed will choose the most recent archived backup. @tsminsdatelower='2006-03-15 13:00:00' . TsmPointInTime Nvarchar(128) The TSM retention point-in-time date for restore. uniquely identifies LiteSpeed backup sets. BackupFormat Nvarchar(128) Reserved field.xp_view_tsmcontents @tsmclientnode = 'ClusterGroup' . then the most recent of the times must be chosen.dbo. @tsmarchive=1 . @tsmexpdateupper='2007-03-17 18:00:00' Result Set xp_view_tsmcontents displays the following information: Column Name Data Type Description File Space Nvarchar(128) TSM File Space. BackupDescription Nvarchar(128) (For archives only) The description (if any) that the user passed in on the @desc parameter on the original backup. FileNumber Int Number of the Backup within the LiteSpeed Backup device. The format is yyyy-mm-dd hh:mm:ss. High Level Nvarchar(128) TSM High Level. Low Level Nvarchar(128) TSM Low Level. If it is not passed. @tsmfilespace= 'SLS_Mar' . Returns 1. This column is valid for database backups only. NULL for file backups.Column Name Data Type Description assigned the archived object based on the management class policy of the management class assigned to the archived object. SoftwareVersionBuild Int Build number of the server that created the backup set. MachineName Nvarchar(128) Name of the server that wrote the backup set. SoftwareVendorId Int Software vendor identification number.0) Log sequence number of the most recent checkpoint at the time the backup was created. BackupFinishDate Datetime Date and time that the backup operation finished. BackupStartDate Datetime Date and time that the backup operation began.1 User Guide 329 . SortOrder Smallint Server sort order. NULL for file backups. CompatibilityLevel Tinyint Compatibility level setting of the database from which the backup was created. BackupSize Numeric (20. DatabaseName Nvarchar(128) Name of the database that was backed up.0) Size of the backup. BindingId Uniqueidentifier Binding ID for the database. ServerName Nvarchar(128) Name of the server that wrote the backup set.0) Log sequence number of the last transaction in the backup set. 1 = Compressed Position Smallint Position of the backup set in the volume (for use with the FILE = option). CodePage Smallint Server code page or character set used by the server. SoftwareVersionMinor Int Minor version number of the server that created the backup set. this number is 4608 (or hexadecimal 0x1200).0) Log sequence number of the most recent full database backup. For SQL Server. FirstLsn Numeric (25. in bytes. RecoveryForkId Uniqueidentifier ID for the current recovery fork for this backup. LastLsn Numeric (25. DifferentialBaseLsn Numeric (25. Provided for backward compatibility.0) Log sequence number of the first transaction in the backup set. Compressed Tinyint 0 = No compression. DatabaseVersion Int Version of the database from which the backup was created. CheckpointLsn Numeric (25. Encryption Int Indicates if backup is encrypted: IsCopyOnly Bit l 0—not encrypted l 1—encrypted Indicates if the backup is copy-only: l 1—A copy-only backup LiteSpeed for SQL Server 8. DeviceType Tinyint Virtual Device > 7 = Logical 107 = Physical UserName Nvarchar(128) Username that performed the backup operation. DatabaseCreationDate Datetime Date and time the database was created. SoftwareVersionMajor Int Major version number of the server that created the backup set. if specified in the options file or if backing up with the Passwordaccess Generate option. Returns 0 (success) or non-zero (failure)..<procedure_name> <arguments>. To capture the output message.<procedure_name> <arguments>. Not required.dbo. run the following: declare @rc int declare @rmsg varchar(999) exec master. @rmsg xp_view_tsmmc Displays available TSM management classes with detailed information. LiteSpeed for SQL Server 8. If you specify a management class. if specified in the options file or if backing up with the Passwordaccess Generate option. @tsmclientownerpwd Specifies the TSM client owner user password. the information returns only to the specified management class. Not required. run the following: declare @rmsg varchar(999) exec master. @resultcode=@rc output select @rc. @tsmmanagementclass = 'TSM_management_class'] Arguments @tsmclientnode Specifies the TSM server LiteSpeed connects to during backups and restores. @tsmclientownerpwd = 'TSM_client_owner_password' .. @resultmsg=@rmsg output select @rmsg To capture the output message and the result code.xp_view_tsmmc @tsmclientnode = 'TSM_client_node' . @tsmconfigfile = 'TSM_configuration_file' [. Syntax EXEC master. @tsmconfigfile Specifies the TSM configuration file. @resultmsg=@rmsg output.Column Name Data Type Description Note: A copy-only backup does not impact the overall backup and restore procedures for the database.1 User Guide 330 . Result Set Column Name Data Type Name Nvarchar (128) Management class name. such as tape. LiteSpeed for SQL Server 8. The destination can be either a storage pool of disk devices or a storage pool of devices that support removable media. For example: If this parameter is set to 10 days when a file is inactivated during an incremental backup. the oldest version is deleted from server storage. This parameter is ignored as long as the file or directory remains on your drive. The most recent version is the active version. If not specified. LiteSpeed uses the default management class. The destination can be either a storage pool of disk devices or a storage pool of devices that support removable media. then extra versions are kept until the number of backup versions exceeds the versions data exists or versions data deleted parameter settings. such as tape. and active versions are never erased. If you select a management class that permits more than one backup version. Returns 0 (success) or non-zero (failure). If Nolimit is specified. Backup copy group destination Nvarchar (128) Names the destination where backups are stored. the oldest extra version is deleted immediately.1 User Guide 331 . Archive copy group destination Nvarchar (128) Names the destination where archives are stored. All other versions are called inactive versions. the next time you run an incremental backup. the most recent version is called the active version. Retain extra versions Nvarchar (128) Specifies how many days all but the most recent backup version is retained. Description Versions Nvarchar data exists (128) Specifies the maximum number of different backup versions retained. and you run a backup that creates a sixth version. Versions data deleted Nvarchar (128) Specifies the maximum number of different backup versions retained for files and directories that you erased from your drive. the last version is retained indefinitely. the active backup version is changed to inactive and the oldest versions are erased that exceed the number specified by this parameter. If Nolimit is specified. If you erase the file or directory.@tsmmanagementclass Specifies the TSM management class. Backup copy group name Nvarchar (128) The name of the backup copy group. In this case. This parameter goes into effect during the next incremental backup after a file is deleted from the client machine. the file will be expired in 10 days. Archive copy group name Nvarchar (128) The name of the backup copy group. Any subsequent updates to this parameter will not affect files that are already inactive. Retain only versions Nvarchar (128) Specifies the number of days the last remaining inactive version of a file or directory is retained. If the maximum number of versions permitted is five. run the following: declare @rmsg varchar(999) exec master. @resultcode=@rc output select @rc.<procedure_name> <arguments>.To capture the output message. @rmsg LiteSpeed for SQL Server 8.. run the following: declare @rc int declare @rmsg varchar(999) exec master.1 User Guide 332 . @resultmsg=@rmsg output select @rmsg To capture the output message and the result code. @resultmsg=@rmsg output..<procedure_name> <arguments>. Review the names of the instances on the SQL Instances step.12 Troubleshoot LiteSpeed Review Known Issues Refer to the Release Notes for the current list of issues known to exist in this version of LiteSpeed. 3. To view 4. To update @@SERVERNAME value » Run the following: exec sp_dropserver 'old_name' exec sp_addserver 'new_name'. Troubleshoot LiteSpeed Activity Local repository is not populated If the computer name is changed. the Local Repository database is not being populated and you cannot view LiteSpeed activity. the local repository settings are not found.database_name LiteSpeed for SQL Server 8. You need to update @@SERVERNAME for all instances on that computer and re-run the Instance Configuration wizard.x jobs not displayed The timeline does not automatically show 4. you can manually rename the jobs and they will appear in the timeline. 'local' To run Instance Configuration 1.1 User Guide 333 . However. Select Start | All Programs | Dell | LiteSpeed for SQL Server | Instance Configuration. 4.x backup/restore jobs. As a result. because LiteSpeed refers to the old computer name.x jobs l Rename backup jobs to: LiteSpeed Backup SERVER_NAME. Complete the wizard. 2.database_name l Rename restore jobs to: LiteSpeed Restore SERVER_NAME. See Reporting and Logging in Maintenance Plans on page 339 for more information. DR4100. Install Backward Compatibility components If you receive one of the following error messages. l {*user} means all user databases. and DR6000 storage appliances.exe failed." . Dell storage appliance not working with LiteSpeed LiteSpeed has been tested and is certified to work with Dell DR4000. Confirm the access rights of the SQLserver\agent startup account to the DR resource..Be sure to use upper case for SERVER_NAME. NOTE: For all scenarios. l {*} means all databases l It is possible to use combinations. "The SQLDMO 'Application' object failed to initialize.litespeedlocal}{*system} means all system databases plus specified.1 User Guide 334 . In rare cases the DR storage appliance may not work with LiteSpeed.". see http://support. LiteSpeed for SQL Server 8.litespeedlocal} l {*system} means all system databases. you probably need the Backward Compatibility components installed: l l "Executed as user: . Troubleshoot Maintenance Plans Leverage SSIS and LiteSpeed advanced options Some tasks and advanced options can be unavailable if you do not select Use LiteSpeed when configuring tasks. The step failed.run the maintenance plan task script in SSMS 2008. the best is to upgrade all of your servers to the latest LiteSpeed version. For more information.pubs. 2.. To check the DR storage appliance 1. Additionally. [SQLSTATE 42000] (Error 22029).doubleclick a plan in the History page to view the event message. Use a semicolon as a separator. sqlmaint. For example: {northwind. {master}{*user} means all user databases plus master. See About Automating Maintenance Tasks for more information. Confirm network connectivity between the SQL server and the DR storage appliance.microsoft.com/kb/955626. you need to add a comment to maintenance plans to provide information about the databases involved in the plan: l l Comment should begin with /** and end with **/ Specify the databases inside {}. Analyze log information Enable advanced logging and review log files for errors or work with Dell support to identify and resolve plan problems. For example: {northwind.pubs. LiteSpeed for SQL Server 8.1 User Guide 335 . 2. Troubleshoot Performance-Related Issues LiteSpeed uses Virtual Device Interface (VDI) to generate its backups.Upgrade. 5. If upgrading LiteSpeed 4. See the LiteSpeed Installation Guide for more information about the upgrade scenario.x or later.x. but the underlying cause of memory fragmentation should be addressed for long-term resolution.exe utility to the default LiteSpeed installation directory on the machine where you have both the LiteSpeed UI Console and SQL Server Integration Services installed. Select Maintenance Plans in the Navigation pane (CTRL+4). COM/OLE Automation objects.x SSIS maintenance plans backups. To upgrade a maintenance plan 1.0 1. To upgrade plans in LiteSpeed 6. click Connect. Repeat steps 3 and 4 for all servers where you have LiteSpeed SSIS plans. 2. LiteSpeed allows you to read SSMS plug-in maintenance plans and upgrade them to SSIS LiteSpeed maintenance plans. This operates in a single contiguous region of addresses within the SQL Server process space known as MemToLeave memory area.Upgrade.MaintenancePlan. To upgrade plans in LiteSpeed 5. the SSMS plug-in maintenance plans need to be manually upgraded.1 or later » Right-click an instance in the Maintenance Plan pane and select Upgrade LiteSpeed Maintenance plans. you can use a separate Clean up maintenance plans task. Double-click the utility. Rebooting SQL Server will free the memory. Enter server connection details.MaintenancePlan. such as extended procedures. Contact Dell Support to obtain the Dell. Right-click a maintenance plan and select Convert to LiteSpeed.2 and 6. SQL Server In-Place Upgrade SSIS LiteSpeed plans must be manually upgraded to use the appropriate library. Select maintenance plans you want to upgrade and click Upgrade. 3.Upgrade LiteSpeed Maintenance Plans LiteSpeed for SQL Server Upgrade If upgrading LiteSpeed 5. SQL Server's MemToLeave area becoming fragmented so that there is insufficient contiguous space to allocate the buffers required for the backups.exe utility. To remove old backup files for these plans. the Maintenance Plans should remain intact and no additional steps are required. Save the Dell. It is set aside at startup and is left unallocated by SQL Server for the use by components in the SQL Server process space. Memory allocations by SQL Server larger than 8 KB are also made from the MemToLeave area. then you need to upgrade the plan after upgrading SQL Server to a higher version. If you have at least one LiteSpeed task in a SSIS plan. and linked server queries. 4. otherwise they will fail after SQL Server upgrade. NOTE: The Remove files older than option in the Backup Database task does not remove LiteSpeed 4. software. See the Configure Log Shipping guide for more information. Run the xp_memory_size extended stored procedure. right-click an instance and select Properties. Installer Logging Installer log files are created in the default output directory.Factors that can drain this memory area: l Number of databases on each server l Number of Servers on physical machine l Number of concurrent users l Amount of data l Number of data/log files l Running 3rd party software To check the available contiguous memory. Troubleshoot Previous Versions of LiteSpeed If you experience issues with the previous versions of LiteSpeed and they are not discussed in the documentation set delivered with your LiteSpeed version.com to access support documentation and search the extensive Knowledgebase for published solutions and case data. this creates a 'RemoteDeploy'-prefixed log file on the machine where you run the remote deploy from and 'SLSInstall'-prefixed log files on all target servers. please visit https://support. When you use the Remote Deploy Configuration wizard to deploy LiteSpeed on SQL Server instances. do one of the following: l l In the Server tree. LiteSpeed for SQL Server 8. Configure Logging in LiteSpeed Logging is available for the following areas in LiteSpeed: l Core Engine l Installation and Remote Deploy l Maintenance Plans l Log Shipping l Object Level Recovery l LiteSpeed UI Console Activity NOTE: Log shipping plans activity is also logged and displayed in the History tab of the Log Shipping pane (CTRL+2). See xp_memory_size on page 211 for more information. Note that for most cases the best is to upgrade all of your servers to the latest LiteSpeed version. See Log File Naming and Location on page 338 for more information.1 User Guide 336 .dell. LiteSpeed for SQL Server 8. Select this parameter if you experience program exceptions resulting in a process abort. access options or advanced options and set the logging level. To log all backup/restore activity on the server. Supply the -L(--LogLevel) parameter from the command line. 2. See LiteSpeed Command-Line Arguments on page 113 for more information. l Fast Compression—To log Fast Compression jobs and Fast Compression backups. but not Maintenance Plans backup tasks. Complete the dialog. select Support and then LiteSpeed Logging. Delete log file on success A log file is only saved if an error has occurred during execution. Flush output to log file after every write (slower) LiteSpeed will perform a disk flush after each record. To enable/disable advanced logging 1. see Instance-Wide LiteSpeed Logging. Otherwise. Supply the @logging parameter if using the extended stored procedures. See Log File Naming and Location on page 338 for more information. Right-click an instance in the server tree. Use this option in the case of a long running application. Log Ship—To log backup/copy/restore Log Shipping jobs. or when an error happens near the end of execution. Review the following for additional information: Option Description Log file path This parameter specifies a path to a default output directory into which the log files are written. Object Level Recovery (OLR)—To log read operations and object-level recovery. 3. l SmartCleanup—To log SmartCleanup activity. do one of the following: l l l In wizards. To enable backup/restore logging. Log rollover size This will limit the size of the log file. but not transaction log backups and restores. See xp_backup_database on page 174 for more information. including log shipping and Fast Compression backups. Select one or more of the following options: l l l Core Engine—To log all backup/restore activity on the server. Clear one or more checkboxes to disable advanced logging for those options. set the rollover size value to zero.1 User Guide 337 .Backup/Restore Logging Using the following instructions you can enable logging for a particular backup or restore activity. so that only the last records that fit within the specified size will be kept. See Reporting and Logging in Maintenance Plans on page 339 for more information about logging options in Maintenance Plans. Instance-Wide LiteSpeed Logging LiteSpeed's advanced tracing facility allows for even more granular control over the major LiteSpeed features at the server level. when the log file becomes overly large. 1 User Guide 338 . Log File Naming and Location By default. Log files will have one of the following formats: l Source YYYY-MM-DD hh-mm-ss PPPP.) To change the default output directory 1.txt Where source components are the following: l SLS (Backup or restore operations) l OLR l LogShip l FastComp l SCleanup Other components of the log file name are as follows: l YYYY—4-digit year l MM—2-digit month l DD— 2-digit day of the month l hh— 2-digit hour using the local 24-hour clock l mm—2-digit minute l ss— 2-digit second l xxx—3-digit millisecond l PPPP—4-digit process id l TTTT— 4-digit thread id When you use the Remote Deploy Configuration wizard to deploy LiteSpeed on SQL Server instances.NOTES: l l Enabling Core Engine advanced logging will not override the logging level specified in wizards and procedures. Be sure to disable advanced logging after it is no longer needed. This location is specified by the logpath value in the LiteSpeedSettings. Enter a new location in the Log file path field.Log l Source YYYY-MM-DD hh-mm-ss PPPP TTTT. log files are written to C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\Logs. 2. Right-click an instance in the server tree.ini file.Log l SLSInstaller . (Usually.YYYYMMDD hh-mm-ss-xxx. select Support and then LiteSpeed Logging. this creates a 'RemoteDeploy'-prefixed log file on the machine where you run the remote deploy from and 'SLSInstall'-prefixed log files on all target servers. LiteSpeed for SQL Server 8.ini. LiteSpeed UI Console Activity Logging The LiteSpeed UI Console activity is logged in the Windows Application event log. C:\Documents and Settings\All Users\Application Data\Dell\LiteSpeed\SQL Server\LiteSpeedSettings. A report contains information about each task within one subplan: task name. Review the following for information about logging in Maintenance Plans: Option Description Log extended information Logs plan details in msdb. This additional information is task-specific and is displayed in the Extended Log Information pane of the History tab. including the Reporting task l one file containing -Gather command-line command to collect statistics l one file containing -CollectStats command-line command for the process that starts collecting statistics to repositories (only created for SSIS plans) LiteSpeed's debug logging is not supported for the native SQL Server tasks. Select Tools | Options.To set the LiteSpeed UI Console logging level 1.See Configure Logging in LiteSpeed on page 336 for more information about the default output directory. select logging level. results. 2.sysmaintplan_logdetail for both LiteSpeed and native SQL Server SSIS maintenance plans.dbo. click to configure reports about execution of the entire maintenance plan and set the reporting and logging options. Log to remote Server Writes the plan history to the remote server. duration. Dell Support may ask you to enable debug logging in maintenance plans to help troubleshoot product issues. LiteSpeed for SQL Server 8.zip file in the default output directory. system configuration. Reporting and Logging in Maintenance Plans With your maintenance plan open in the Design tab. and settings and can help troubleshoot problems. On the General tab.1 User Guide 339 . To create a LiteSpeed UI Console support bundle » Select Application button | Help | Support Bundle. you can create a support bundle and send it to customer support. then that task is handled by the native SQL Server components. For the native SQL Server plans. Debug Logging Logs LiteSpeed maintenance plan utility activity. If the Use LiteSpeed option is cleared for a task. Create Support Bundles If you have not found an answer to your question. Each archive has: l one or more files for all LiteSpeed tasks in a subplan. Make sure LiteSpeed is installed on the server where you have a problem with maintenance plans. The support bundle contains information about your database. this information also becomes a part of the native reporting and may increase the size of the stored maintenance plan history. the Maintenance Plan engine saves the archived <plan_name>_ <subplan_name>[<GUID>]. To hide or display the pane. for all tasks. When a subplan is executed. select Tools | Options | Maintenance Plans. 1 User Guide 340 .To create a server support bundle 1. 2. LiteSpeed for SQL Server 8. Right-click a server in the tree and select Support | Support Bundle. Send the support bundle to Dell customer support or click Clipboard to save the generated content to file. com LiteSpeed for SQL Server 8. find helpful resources.dell.microsoft.sswug. Useful Web Resources Share and find information about Dell products and SQL Server related technologies at: Dell Data Protection Community http://en.com/techcenter/data-protection/. Use this site to: l Share your knowledge l Participate in forums l Learn about new features and enhancements in Dell products l Download the latest product releases l Find expert tips and tricks l Communicate with product teams l Participate in beta programs Video Tutorials If you want to learn more about using LiteSpeed for SQL Server.community.com Microsoft Developer Network (MSDN) http://msdn.13 Review Additional Resources LiteSpeed Community Get the latest product information. Join the LiteSpeed community at: http://en. At the Dell Data Protection TechCenter you can find video tutorials. check out: http://en. and join a discussion with the LiteSpeed Dell team and other community members.toadworld.community.dell.aspx Microsoft SQL Server World Wide Users Group http://www.microsoft.com/en-us/sqlserver TechNet Site http://technet.com/techcenter/data-protection/ ToadWorld http://www.com Professional Association for SQL Server http://www.sqlpass.dell.microsoft.com/platforms/sql-server/default.org Microsoft SQL Server Developer Center http://msdn.com/techcenter/data-protection/. user tips and usage examples.org Microsoft Product Support http://support.community.1 User Guide 341 .microsoft. boulder.jsp LiteSpeed for SQL Server 8.microsoft.1 User Guide 342 .ibm.com/sql IBM Tivoli Storage Manager Information Center http://publib.com/infocenter/tsminfo/v6r3/index.Microsoft SQL Server Web Site http://www. and manage Service Requests (cases) l View Knowledge Base articles l Obtain product notifications l Download software. l View how-to videos l Engage in community discussions l Chat with a support engineer LiteSpeed for SQL Server 8. To access the Support Portal.1 User Guide 343 . In addition. Contact Dell Technical Support: Online Support Product Questions and Sales: (800) 306 .com.dell.About Dell Dell listens to customers and delivers worldwide innovative technology.software.com/support/. business solutions and services they trust and value. go to Trial Downloads. 365 days a year. The site enables you to: l Create.9329 Email:
[email protected]. the portal provides direct access to product support engineers through an online Service Request system. update.dell.com Technical Support Resources Technical support is available to customers who have purchased Dell software with a valid maintenance contract and to customers who have trial versions. go to http://software. The Support Portal provides self-help tools you can use to solve problems quickly and independently. For more information. visit www. For trial software. 24 hours a day. NET (DXperience) 13.452 SharpZipLib License Task Scheduler Managed Wrapper 2.85.1.aspx.0 license Active Directory Common Dialogs .0 Ms-PL AWS SDK for .8 The MIT License (MIT) zlib 1.0 This component is governed by the Apache 2.3.2.2. CMarkup Developer 11.NET 2.17 LibTomCrypt 1.0 license.2.0 (Apache) Wizard .2 This component is governed by the Apache License 2.5 QuickLZ Commercial License 1.4 New BSD License (BSD) WinForms Group Controls 1.NET Library 2. Source code for components marked with an asterisk (*) is available at http://opensource.2.10 Developer Express .65 Public Domain QuickLZ 1.4.dell.14.2 MIT TimeSpan Helper Library 2.NET 2.Net (DXperience) 12.2 CMarkup Developer 1.17 license LZMA 4.4. Component License or Acknowledgement ActiPro Syntax Editor (for Windows Forms) 4.com.0 SharpZipLib 0.0.dell.1 User Guide 344 .0 license Developer Express .6 license LibTomCrypt 1.5.0.Third Party Contributions This product contains some third party components (listed below). Copies of their licenses may be found at http://software.5 License LiteSpeed for SQL Server 8.com/legal/license-agreements.0 ActiPro Syntax Editor (for Windows Forms) 4.5 zlib 1. 1 User Guide 345 . export 52 .lsm 102 import from file 52 A job notifications 51 activitymanager.Index backup speed 45 % % variables 76 backup statistics 109 Backup Templates 46 .exe 35 Adaptive Compression 71 advanced logging 337 AlwaysOn Availability Groups 64 AlwaysOn databases 64 Amazon S3 Cloud 40 Application Menu 13 argument data type 172 attachments add to backup file 60 list files and directories 275 restore from backup file 98 Automated Restore 92 command-line arguments 113 xp arguments 244 availability groups 64 select databases 47 view history 52 backup throughput 109 backup wizard 53 backups 11 attach files 60 cleanup 75 convert to SQL Server 163 create 53 differential 53 Fast Compression 67 file and filegroup 53 full 53 multi-database 67 primary replicas 64 re-execute 109 read (OLR) 102 B recast 156 back up databases (Maint Plans) 82 restore objects (OLR) 102 background processes 22 secondary repricas 64 Backup Analyzer 43 t-log 53 backup cleanup See Smart Cleanup template 46 backup escalation 70 test optimal settings 43 backup files See backups verify integrity 96 backup history 109 view activity 109 Backup Manager Server Tools Ribbon 16 wizard 53 LiteSpeed for SQL Server 8. generate (OLR) 102 default log output directory 337 defaults 29 deploy backup templates 52 Double Click Restore 73 restore 99 Maintenance Plans 141 Object Level Recovery 165 E recast backups 156 encryption 73 Smart Cleanup 137 exe backup files See Double Click Restore compressed database 97 export backup templates 52 compressed folder 97 extended stored procedures 172 compression 71 extract to different locations 164 convert extract to the SQL Server backup 163 backups to executables 74 extraction utility 163 LiteSpeed backups 156 extractor.1 User Guide 346 .exe 163 Maintenance Plans 79 F Copyright 2 Fast Compression 67 custom database selection 47 backup escalation 70 D command-line arguments 129 Database Tools Ribbon 16 job notification 61 databases xp arguments 302 back up 53 categorize 28 H Home Ribbon 14 compress 97 group 28 I restore 92 import backup templates 52 databases (Maint Plans) 79 back up 82 IntelliRestore 96 IO failure See Network Resilience LiteSpeed for SQL Server 8.check integrity 80 C clean up backups 80 categories 28 clean up history 80 assign 29 execute jobs 80 create 28 execute T-SQL 80 edit 29 rebuild index 80 group by in LiteSpeed Console 28 reorganize indexes 80 central pane 21 shrink 80 central repository 24 clone backup templates 52 command line (LiteSpeed) 113 extract backups 163 Fast Compression 67 general commands 113 licensing 171 DCR See Double Click Restore DDL. prerequisites 79 J upgrade 335 Job Manager Ribbon 17 view activity and history 111 K MemToLeave 335 known issues 333 mirror backup files 55 L monitor history backup 109 LicenseInfoCmd.exe 171 Maintenance Plans 111 LiteSpeed Console 13 LiteSpeed defaults 29 multi-database backup 67 LiteSpeed logging 337 N LiteSpeed utilities 113 navigation pane 20 extractor 163 Network Resilience 75 licenseinfocmd 171 notifications olr 165 Backup Templates 51 slsfastcompression 129 Fast Compression job 61 slsrecast 156 Maintenance Plans 80 slssmartcleanup 137 Restore job 93 slssqlmaint 141 NTFS compressed database 97 sqllitespeed 113 NTFS compressed folder 97 LiteSpeed variables 76 O LiteSpeed_DeleteActivity 36 location and name of extracted files 163 Log Reader options 34 Log Reader Ribbon 17 Log Shipping Server Tools Ribbon 18 logging 336 Object Level Recovery 102 command-line arguments 165 read backup files 102 restore from TSM 105 restore tables 102 SELECT statements 106 wizard 102 M xp arguments 212 Maintenance Plans 79 Object Level Recovery Ribbon 19 back up database 82 OLR See Object Level Recovery clean up maintenance data 88 olr.exe 165 command-line arguments 141 options (Job Manager) 33 copy plans and subplans 88 options (LiteSpeed) 31 create 80 Backup Manager 32 debug logging 339 Log Shipping 33 logging 339 OLR 35 owner 82 options (Log Reader) 34 LiteSpeed for SQL Server 8.1 User Guide 347 . 1 User Guide 348 .exe 113 support bundle 339 resilience See Network Resilience T restore 92 tables.owner of a maintenance plan 82 restore partial diff backup 258 P S preferred replica 64 schemas.exe 141 Smart Cleanup 75 command-line arguments 137 purge 36 xp arguments 317 register 24 select 24 reset LiteSpeed defaults 29 sqllitespeed.exe 129 slsrecast. restore (OLR) 102 primary replicas 64 secondary replicas 64 processor affinity 30 SELECT statements 107 properties 22 execute 106 server groups R assign servers to 28 re-execute failed backups 109 create 27 read-only compressed database 97 group by in LiteSpeed Console 28 read backups (OLR) 102 recast LiteSpeed backups 156 server instances 25 assign to server group 28 recover objects 102 categorize 28 regex 64 group in LiteSpeed Console 28 regexp 64 register server instances 26 regular expressions 64 remove deployed templates 53 reports 109 repositories maintenance 36 set affinity mask 30 slsfastcompression.exe 156 slssmartcleanup.exe 137 slssqlmaint. recover 102 automated 92 TDE 72 databases 92 template 46 objects 102 threads 29 to NTFS compressed folder 97 throttle 29 wizard 92 timeline 109 Restore job notification 93 restore as location 97 NTFS-compressed 97 restore partial backup 257 toolbars 13 troubleshoot TSMSee also logging tutorials 341 U update central repository 35 user interface 13 LiteSpeed for SQL Server 8. utilities See LiteSpeed utilities xp_sqllitespeed_licenseinfo 323 V xp_sqllitespeed_version 325 variables 76 video tutorials 341 xp_view_tsmcontents 325 xp_view_tsmmc 330 view activity 109 View Ribbon 14 W wildcard expressions 64 X xp_backup_database 174 xp_backup_log 192 xp_delete_tsmfile 204 xp_encrypt_backup_key 206 xp_encrypt_restore_key 206 xp_extractor 206 xp_memory_size 211 xp_objectrecovery 212 xp_objectrecovery_createscript 220 xp_objectrecovery_executeselect 226 xp_objectrecovery_viewcontents 233 xp_replicate_activity_statistics 35 xp_replicate_job_statistics 35 xp_restore_attachedfilesonly 237 xp_restore_automated 244 xp_restore_checkpassword 254 xp_restore_checksumonly 255 xp_restore_database 255 xp_restore_filelistonly 270 xp_restore_headeronly 273 xp_restore_log 281 xp_restore_setinfo 291 xp_restore_verifyonly 294 xp_slsCreateDCR 301 xp_slsFastCompression 302 xp_slsReadProgress 316 xp_slsSmartCleanup 317 xp_slssqlmaint 323 LiteSpeed for SQL Server 8.1 User Guide 349 . Documents Similar To LiteSpeed for SQL Server - User GuideSkip carouselcarousel previouscarousel next70_765_ProvisioningSQLDatabasesPeers SQL Server 2012Ftmle In001 en pBCDBINFDBATable of Contents[100% PASS]Braindump2go Free 70-462 Dumps PDF 41-50SmarTeam Design Express for CATIA Installation GuideHow to Install SQL Server 2005.docxDBA Iq Faq-praveenContingency plan TemplateDatabase Mirroring in SQL Server 2005Keep data available without affecting user response timeBC660_EN_46D_Col22_FV_171005_2002Q22778_ebc_labs_rev_a2Display Advertisement by Country Using ASP and MS-SQL DatabasePSDM Exercise for TrainingBackup and Restore InformixMOM2005_ConceptsGuideOperation Guide of the CME in Standalone Mode (INTERNAL)Access 2007 Level 1PCEW61ManualSQLServer_2008CompareEnterpriseStandardkhurram-khosoController 83 - New FeaturesProject Doc04 SQL Recovery1. Introduction.pptxFormationABSTRACTAmmas ResumeMore From balamurali_aSkip carouselcarousel previouscarousel nextNormalization NotesQuestion Bank 2014 - 15 (Info. Prac).pdfWindowsITPro_2011101207561308complied.pdf0411 ST EGuide DRPlanningFINAL v2Release Management With Continuous Delivery a Case Study12 OS Security Workshop2014 Null Sebastian Solbach Virtual Rac PraesentationSecuring a Production LAMP Server - Aaron CorsoIIS6AdminC12VedicReport11-30-201711-05-02PMServer 2012 R2 and Windows_server_baseline ComplianceRelManagePlan.pdfDell - Microsoft OS Support MatrixVCommander Cloud Automation Planning Guideb Ba Guide Win v712 (June 2015)GSD ECM-EDMS_Project_Management Plan_Rev 2 2 (4)dotnet-performance-testing-and-optimization.pdf1624047963xi-ip_final_study_material_2014-15REDIM Installation Guide 5.5.2.1Perf Tun Srv 2016Kvpy 2012 - Sx _class 12SSL, TLS, Ciphers Oh MyConfiguringWindowsServer2016andNanoServerFailoverClusters(3288 CD WS)KVPY_iisc_2014_qp_sb_sxlarsplatzdasch-sqlserveralwaysonforsharepointhadrsqlkonf2017en-170216222044BCDR - Concepts Overview Guidechapter_9_coordination_compounds.pdfKarkidaka Dietchapter_14_biomolecules.pdfFooter MenuBack To TopAboutAbout ScribdPressOur blogJoin our team!Contact UsJoin todayInvite FriendsGiftsLegalTermsPrivacyCopyrightSupportHelp / FAQAccessibilityPurchase helpAdChoicesPublishersSocial MediaCopyright © 2018 Scribd Inc. .Browse Books.Site Directory.Site Language: English中文EspañolالعربيةPortuguês日本語DeutschFrançaisTurkceРусский языкTiếng việtJęzyk polskiBahasa indonesiaSign up to vote on this titleUsefulNot usefulYou're Reading a Free PreviewDownloadClose DialogAre you sure?This action might not be possible to undo. Are you sure you want to continue?CANCELOK