Instance Configuration
In the LiteSpeed Instance Configuration wizard you will select the SQL Server instances that will use LiteSpeed and install extended stored procedures that LiteSpeed needs to run on the instances. You must install the extended stored procedures to take full advantage of LiteSpeed functionality on the selected instances.
In addition, you can configure activity logging using this wizard. Activity logging works by installing a local repository on a server instance to record its activity, and then installing a central repository to consolidate information from the local repositories. Quest Software recommends that you configure activity logging to benefit fully from LiteSpeed's features.
To configure server instances on the local computer
-
Start the Instance Configuration wizard from Start | All Programs | Quest Software | LiteSpeed for SQL Server | LiteSpeed Instance Configuration. In the installation scenario, the LiteSpeed Instance Configuration wizard is launched automatically.
-
On the SQL Instances page, select the SQL Server instances on which you want to install the extended LiteSpeed stored procedures. The default behavior is to install the procedures onto all instances. Also, when you re-run the wizard to modify existing options, be sure to select Install.
Tip: If you do not want to install the procedures on an instance, click the action and change it to Ignore. When you select Uninstall next to an instance, the wizard removes the LiteSpeed extended stored procedures from the instance.
Verify the connection details for each server. To change login details, select Windows or SQL Server authentication.
-
On the Activity Logging page, select whether you want to configure a central and a local repository, or only a local repository.
LiteSpeed creates a local repository database to collect backup activity information. This database can be a dedicated database or an existing database of your choice. You can create the central repository once and point to it in subsequent installs.
If you decide to create and configure only local repositories during installation, you may define a central repository later using the LiteSpeed UI Console to enable consolidated logging.
-
Complete the wizard.
Use the following information to help guide you through instance configuration:
Page Description
Service Account Specify login information for the LiteSpeed Activity Manager service. This service runs on each server and merges statistics from the LiteSpeed local repositories to the central repository database. Typically the account is a Windows domain account. It must have permissions to update the central repository database using Windows authentication (for a cluster configuration, the Windows account must have permissions on all nodes). For more information, see Privilege and Grant Requirements.
NOTE:
- You should select Local system when the central repository is on the same server as the local repository. If the central repository is on another server, the Activity Service will not be able to use Windows authentication to access it. You will need to provide SQL Server login and password on the Central Repository screen.
SQL Servers Select the SQL Server instances on which to install LiteSpeed.
The State column indicates the state of SQL Server instances. To check the state of selected instances click Check Instance State. To update the state, right click on the instance and click Update State.
For all selected instances not in the running state, on clicking Next LiteSpeed will issue a warning as installation on a stopped instance will result in failure.
Installation Directory
Select the installation directory for each SQL Server that LiteSpeed will be installed on.
LiteSpeed will validate the install path for each server before proceeding further.
Install Path State More information The specified path is invalid. This warning may mean any of the following:
- Cannot check folder state.
- Not enough free disk space is available.
- The disk type is not valid for installation.
- The specified path is too long.
- The specified path is not available.
- Disk does not exist.
- Folder does not exist.
Local Repository LiteSpeed uses the login details you specify to connect to the server instance, create the database, and add objects to it. This account must have the appropriate permissions.
Native Backup Activity Select whether you want to update the local repository with information about native SQL Server backup activity and view it in the LiteSpeed UI Console. Click Schedule to modify the default schedule.
Central Repository Point to the server instance and database.
Create and upgrade a Central Repository database. LiteSpeed creates the database if it does not already exist. It checks the version and upgrades if necessary.
Repository Update Indicate when you want the central repository to be updated with backup and job statistics. You can have LiteSpeed update the central repository:
- Automatically after any LiteSpeed activity, such as after every backup/restore operation (best for real time statistics).
- Via a scheduled SQL Server job (best for minimal network traffic).
- Manually.
NOTE: Quest Software recommends that you select Automatically after any LiteSpeed activity for both selections.
Repository Cleanup Select to set repository maintenance, including when to delete old data from repositories, and how much of that data to delete. Old data can be deleted from the local repository, central repository, or both. The repositories are individually selected to remove activity older than a user-selectable number of days, weeks, months, or years. Additionally, Edit Schedule launches a screen where schedule information can be changed.
Tip: Further repository cleanup can be accomplished by using the Purge Repository Data procedure.
Proxy settings Select Use proxy settings for cloud connections. When selected, you can add the proxy address and port. Optionally, you can select to use authentication and then enter username and password.
License I you select Register later, the installed LiteSpeed version will operate as a trial on all instances, until you register it or the trial period expires.
Summary Displays a summary of instance configuration selections.
Upgrade Repositories
LiteSpeed automatically upgrades LiteSpeed repositories during local and remote install.
If you have a LiteSpeed central repository that needs to communicate with a repository for a previous version of LiteSpeed, do one of the following:
- Upgrade the statistic agent that transfers information between them on the outdated server instance. To do this, run the Remote Deploy Configuration wizard and select Statistics Agent Only on the Installer Path page. For more information, see Install LiteSpeed on Remote Server Instances.
- Upgrade both the server where the LiteSpeedLocal and LiteSpeedCentral to the same version of LiteSpeed.
- Rename the LiteSpeedLocal and LiteSpeedCentral databases and recreate them by running the Instance Configuration wizard.
Remote Install
You can install LiteSpeed on multiple remote server instances using the Remote Deploy Configuration wizard.
NOTES:
- Before you run the Remote Deploy Configuration wizard, you must run Complete installation on the machine from which you wish to run the remote deploy.
- Make sure you have a Windows domain user account with Administrator rights for the server instances you want to install LiteSpeed on. The machines must be part of the same domain.
To create and deploy installation files
-
Click the Application Button and select Remote Deploy...
-
On the Remote Deploy Task page, select one of the following tasks:
- Generate Remote Deploy configuration file—To create the installation files and optionally deploy them. If you select the Complete or Core Components Only installation and deploy the files, this will also configure remote server instances.
- Edit existing Remote Deploy configuration files—To edit configuration files generated by the Generate Remote Deploy configuration file task. Use to deploy to many servers that all use the same parameters without having to input all the information every time.
- Deploy existing Remote Deploy configuration files—To deploy the installation and configuration files generated by the Generate Remote Deploy configuration file task.
- Configure LiteSpeed using existing Remote Deploy configuration files—To configure remote server instances. You can use this task to complete installation after you deployed LiteSpeed using a deployment tool such as SCCM or LANDesk.
- Validate existing Remote Deploy configuration files—To see if the configuration files are valid for installation and review installation options and expected actions.
NOTE: To deploy or validate existing Remote Deploy configuration files, you only need to select the main configuration file (usually, LiteSpeedRemoteDeploy_Configuration.xml). The wizard will automatically validate all remaining server-specific configuration files.
-
If you selected the Generate Remote Deploy configuration file task, review the following for additional information:
-
Select one of the following installation types:
- Complete—Installs LiteSpeed for SQL Server, LiteSpeed UI Console, and statistics agent (if you configured LiteSpeed to collect statistics).
- Core Components Only—Installs LiteSpeed for SQL Server and statistics agent (if you configured LiteSpeed to collect statistics), but not the LiteSpeed UI Console
- Client Only—Installs the LiteSpeed UI Console only.
- Statistic Agent Only—Installs/updates the service that transfers information between local and central repositories.
- If the current user account has Windows administrative rights but does not have access to the server instances, select Use a different account for installation to specify an additional account.
-
Select the SQL Server instances on which to install LiteSpeed. Start by clicking the Refresh button to see all the machines found on the network. Select servers in the Servers drop-down list, confirm selection and click Add. If you prefer to add servers manually, enter server names separated by commas in the Servers field and click Add. Alternately, you can import servers from a text file (one server name or IP address per line).
Use the following information to help guide you through instance configuration:
Page Description
Service Account Specify login information for the LiteSpeed Activity Manager service. This service runs on each server and merges statistics from the LiteSpeed local repositories to the central repository database. Typically the account is a Windows domain account. It must have permissions to update the central repository database using Windows authentication (for a cluster configuration, the Windows account must have permissions on all nodes). For more information, see Privilege and Grant Requirements.
NOTE:
- You should select Local system when the central repository is on the same server as the local repository. If the central repository is on another server, the Activity Service will not be able to use Windows authentication to access it. You will need to provide SQL Server login and password on the Central Repository screen.
SQL Servers Select the SQL Server instances on which to install LiteSpeed.
The State column indicates the state of SQL Server instances. To check the state of selected instances click Check Instance State. To update the state, right click on the instance and click Update State.
For all selected instances not in the running state, on clicking Next LiteSpeed will issue a warning as installation on a stopped instance will result in failure.
Installation Directory
Select the installation directory for each SQL Server that LiteSpeed will be installed on.
LiteSpeed will validate the install path for each server before proceeding further.
Install Path State More information The specified path is invalid. This warning may mean any of the following:
- Cannot check folder state.
- Not enough free disk space is available.
- The disk type is not valid for installation.
- The specified path is too long.
- The specified path is not available.
- Disk does not exist.
- Folder does not exist.
Local Repository LiteSpeed uses the login details you specify to connect to the server instance, create the database, and add objects to it. This account must have the appropriate permissions.
Native Backup Activity Select whether you want to update the local repository with information about native SQL Server backup activity and view it in the LiteSpeed UI Console. Click Schedule to modify the default schedule.
Central Repository Point to the server instance and database.
Create and upgrade a Central Repository database. LiteSpeed creates the database if it does not already exist. It checks the version and upgrades if necessary.
Repository Update Indicate when you want the central repository to be updated with backup and job statistics. You can have LiteSpeed update the central repository:
- Automatically after any LiteSpeed activity, such as after every backup/restore operation (best for real time statistics).
- Via a scheduled SQL Server job (best for minimal network traffic).
- Manually.
NOTE: Quest Software recommends that you select Automatically after any LiteSpeed activity for both selections.
Repository Cleanup Select to set repository maintenance, including when to delete old data from repositories, and how much of that data to delete. Old data can be deleted from the local repository, central repository, or both. The repositories are individually selected to remove activity older than a user-selectable number of days, weeks, months, or years. Additionally, Edit Schedule launches a screen where schedule information can be changed.
Tip: Further repository cleanup can be accomplished by using the Purge Repository Data procedure.
Proxy settings Select Use proxy settings for cloud connections. When selected, you can add the proxy address and port. Optionally, you can select to use authentication and then enter username and password.
License I you select Register later, the installed LiteSpeed version will operate as a trial on all instances, until you register it or the trial period expires.
Summary Displays a summary of instance configuration selections.
- On the License page, if you select Register later, the installed LiteSpeed version will operate as a trial on all instances, until you register it or the trial period expires.
-
-
On the Deploy LiteSpeed page, select whether you want to deploy the files immediately or run the wizard later and select the appropriate option.
TIP: On the Deploy Status tab you can check for errors during deployment. If errors are found you are given the opportunity on this tab to select to save the list of failed servers to a configuration file.
Caution: The Remote Configuration wizard does not prevent you from deploying the files if they are not valid.
NOTE: The Simultaneous installs field determines how many servers to install simultaneously. For example, if you select to install LiteSpeed on 50 servers and specify 10 simultaneous installs, then the wizard would install LiteSpeed on 10 servers at a time until it has installed all 50 servers.
- Complete the wizard.
Silent Installation
LiteSpeed may also be installed locally from the command line or remotely using the LANDesk, SCCM or WMI deployment tools.
NOTE: The silent installation procedure requires the user running the installer be logged into the Windows machine with Local Administrator level access.
The silent install requires the following:
- LiteSpeed installer.
- Server-specific .xml file containing information about the machine onto which LiteSpeedis being installed. You can generate it using the RemoteDeploy.exe utility, supplied with LiteSpeed. For more information, see Install LiteSpeed on Remote Server Instances..
Command-Line Parameters
NOTE: All paths in the msiexec string should be passed as fully qualified paths, including the drive letter.
| Parameter | Description |
|---|---|
| /i | This is an installation. |
| /l*v | Invokes logging (The *v invokes verbose logging.) The path of the log file is indicated by, "C:\logfile.txt"). |
| /qn | Suppresses the graphic user interface. |
| SILENTPHASE=0 | Runs Instance Configuration silently. |
| SILENTINSTALLXML |
Indicates the fully qualified path to the .xml file for Instance Configuration. Must be local to the system. NOTE: Version 6.5 of LiteSpeed introduced the new improved XML file format. Although the configuration files created by a LiteSpeed version prior to 6.5 can be manually used with the current LiteSpeed installer, it is recommended, that you generate the new files. For more information, see Install LiteSpeed on Remote Server Instances. |
| LICENSEKEY | Passes the license key. |
| SITEMSG | Passes site message. Required only when upgrading from a LiteSpeed 8.5 or earlier installation. |
| LICENSETYPE |
Indicates the license type:
|
| ENGINEONLY=1 | Installs LiteSpeed for SQL Server without the LiteSpeed UI Console. |
| CLIENTONLY=1 | Installs only the LiteSpeed UI Console. |
| INSTALLDIR="D:\Program Files\Quest Software" | Provides an alternate install destination to the default C:\Program Files. |
Examples
To run a silent install
msiexec /i "c:\Litespeed.msi" SILENTINSTALLXML="C:\LiteSpeedRemoteDeploy_Server.xml" SILENTPHASE=0 /qn
To register LiteSpeed on all* instances during install
msiexec /i "c:\LiteSpeed.msi" LICENSEKEY="C20TM3Q3K2HD74UDLBMHC6KYV6HZ3MQFNXZFB-123-45678-34" SITEMSG="Trial Version" LICENSETYPE="LICENSE" SILENTINSTALLXML="c:\LiteSpeedRemoteDeploy_Server.xml" SILENTPHASE=0 /qn
*—all instances that were specified in the .XML file.
SITEMSG="Trial Version" - The Site Message is applicable only when upgrading from a LiteSpeed 8.5 or earlier installation.
To run an install with logging enabled
msiexec /i "c:\LiteSpeed.msi" /l*v "c:\logfile.txt" SILENTINSTALLXML="c:\LiteSpeedRemoteDeploy_Server.xml" SILENTPHASE=0 /qn
To run install, but not Instance Configuration
msiexec /i "c:\Litespeed.msi" SILENTPHASE=0 /qn
To uninstall LiteSpeed
msiexec /uninstall "c:\Litespeed.msi"