Deploy Backup Templates
NOTES:
- 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.
- Regular expressions are only supported in Maintenance Plans.
To deploy a LiteSpeed Backup Template with Deploy Wizard
- Select the Backup Manager pane (CTRL+1).
- In the Backup Templates tab,
beside Backup Templates on the toolbar, select the Deploy option and double-click the template file you want to deploy.
-
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
Use the Validate by wildcard/regex option to check whether servers match the given criteria set in Backup Template.
NOTE: You can select individual databases only if the backup template is saved with the Custom Database Selection at Deployment option.
NOTE: Servers which don't match the given criteria set in Backup Template are marked in red.
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.
Use the TLog Backup Location column to enter the Transaction Log backup folder for the given instance.
Use the Diff Backup Location column to enter the Differential backup folder for the given instance.
Use the Exclude Databases column to exclude individual databases from the backup.
NOTE: "Select all" check box is added in the Backup Template Deployment Wizard when excluding databases under the Backup Option. While deploying a backup template, on the Backup Options step there is an option to exclude databases in the drop-down menu. Since the user can have large numbers of databases, “Select all” check box is added as an option to select all databases either to exclude all databases or deselect only the smaller number which is not needed. By default, the option is deselected.Use the TSM Settings column to customize TSM settings for the backup.
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:
- Default to template—To change the current cell back to the template default.
- Default all to template—To change all cells back to the template default.
- 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:
Deployment Type LiteSpeed will deploy the template as a SQL Agent job or a maintenance plan.
Owner - Optionally, enter the owner of the SQL job (or Maintenance Plan) that will deploy the template. If the name you enter does not exist as a SQL user then the job will fail. If this field is left blank the job will run with the creator of the template or "running" user as the owner.
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.
To deploy a LiteSpeed Backup Template with powershell script
1) Install powershell snapin:
Use "Log Reader PowerShell Snap-In" help part to get help how to install powershell snapin. Take to account the following changes for deploy backup template snapin registration:
'LiteSpeed.PSSnapIn.register.ps1' instead of 'LogReader.SqlServer.register.ps1'
'LSInstallationDirectory' instead of 'LRInstallationDirectory'
'Add-PSSnapin LiteSpeed.PSSnapIn' instead of 'add-pssnapin LogReader.SqlServer'
ps1xml file is missed for LiteSpeed.PSSnapIn
2) Use following commands:
Command:
Get-LSBackupTemplate
SYNTAX
Get-LSBackupTemplate [-ServerInstance] <string> [-Database] <string> [[-Credential] <pscredential>] [[-TemplateName] <string>] [-TemplateID <string>] [<CommonParameters>]
Get-LSBackupTemplate [-Path] <string> [<CommonParameters>]
Example 1
Get backup template stored locally
$template = Get-LSBackupTemplate -Path "C:\Templates\template.xml"
Example 2
Get list of templates stored at LiteSpeedCentral repository on the local server (using Windows authentication):
Get-LSBackupTemplate . LiteSpeedCentral
Example 3
Get list of templates stored at LiteSpeedCentral repository on the local server (using SQL Server authentication):
$cred = Get-Credential
Get-LSBackupTemplate -Database "LiteSpeedCentral" $cred
Example 4
Get backup template "Template1" stored at LiteSpeedCentral repository on the local server (using Windows authentication):
$template = Get-LSBackupTemplate -Database "LiteSpeedCentral" -TemplateName "Template1"
Command:
Get-LSCloudSettings
SYNTAX
Get-LSCloudSettings [-CloudVendor]
{AmazonS3 | S3Compatible | AzureBlob | GoogleStorage}
[-AccessKey] <string> [-SecretKey] <string> [-BucketName] <string> [-RegionName <string>] [-Endpoint <string>] [-AcceptAllCertificates] [-StorageClass <string>] [-UseSsl] [-UseGovCloud] [-GSProject <string>] [-ProxyHost <string>] [-ProxyPort <int>] [-ProxyLogin <string>] [-ProxyPassword <string>] [<CommonParameters>]
Example
Get cloud settings for deployment
$cloud = Get-LSCloudSettings AmazonS3 ACCESSKEY11111 SECRETKEY11111111111111 Bucket1 -UseSsl
Command:
Get-LSTSMSettings
SYNTAX
Get-LSTSMSettings [-ClientNode <string>] [-ClientOwnerPassword <string>] [-ConfigurationFile <string>] [-ManagementClass <string>] [-UsePasswordAccessGenerate] [-Archive] [-DeviceTimeoutMinutes <int>] [<CommonParameters>]
Example
Get default TSM settings for deployment
$tsm = Get-LSTSMSettings -ConfigurationFile %TSMDEFAULTPATH% -UsePasswordAccessGenerate
Command:
Deploy-LSBackupTemplate
SYNTAX
Deploy-LSBackupTemplate [-BackupTemplate] <LSBackupTemplate> [-ServerInstance] <string> [[-Credential] <pscredential>] [-BackupPath <string>] [-TLogBackupPath <string>] [-DiffBackupPath <string>] [-Databases <string[]>] [-ExcludeDatabases <string[]>] [-DeployAsMaintenancePlan] [-RenameAndDisableExistingObjects] [-Owner <string>] [-NotificationOperator <string>] [-CloudSettings <LSCloudSettings>] [-TSMSettings <LSTSMSettings>] [<CommonParameters>]
Example 1
Deploy backup template as SQL Server job for Northwind database
$template = Get-LSBackupTemplate -Path "C:\Templates\template.xml"
$template | Deploy-LSBackupTemplate -ServerInstance . -BackupPath "C:\backups" -Databases Northwind
Example 2
Deploy backup template as Maintenance Plan
$template = Get-LSBackupTemplate . LiteSpeedCentral -TemplateName "Template1"
$template | Deploy-LSBackupTemplate -ServerInstance . -BackupPath "C:\backups" -DeployAsMaintenancePlan
Command:
Undeploy-LSBackupTemplate
SYNTAX
Undeploy-LSBackupTemplate [-BackupTemplate] <LSBackupTemplate> [-ServerInstance] <string> [[-Credential] <pscredential>] [<CommonParameters>]
Example
Undeploy backup template on the local server (using Windows authentication):
$template = Get-LSBackupTemplate -Path "C:\Templates\template.xml"
Undeploy-LSBackupTemplate $template .