Chat now with support
Chat with Support

NOTICE! We are upgrading our support telephone services, implementing Genesys, starting the week of May 19, 2025

LiteSpeed for SQL Server 8.9.8 - Security and Compliance Guide

xp_backup_parameters

Enter parameters to connect to Cloud storage. Use in conjunction with xp_backup_database.

This topic covers:

Syntax

Enter parameters to connect to Cloud storage:

declare @mirrorId1 as nvarchar(100)
exec master.dbo.xp_backup_parameters
@FileName = @mirrorId1 OUTPUT,
@CloudVendor = N'AmazonS3',
@CloudBucketName = N'bucketname',
@CloudAccessKeyEnc = N'***',
@CloudSecretKeyEnc = N'***',
@CloudRegionName = N'us-east-1',
@UseSSL = 1

declare @mirrorId1 as nvarchar(100)
exec master.dbo.xp_backup_parameters
@FileName = @mirrorId1 OUTPUT,
@CloudVendor = N'AzureBlob',
@CloudBucketName = N'bucketname',
@CloudAccessKeyEnc = N'***',
@CloudSecretKeyEnc = N'***',
@CloudRegionName = N'us-east-1',
@UseSSL = 1

declare @mirrorId1 as nvarchar(100)
exec master.dbo.xp_backup_parameters
@FileName = @mirrorId1 OUTPUT,
@CloudVendor = N'GoogleStorage',
@CloudBucketName = N'bucketname',
@CloudAccessKeyEnc = N'***',
@CloudSecretKeyEnc = N'***',
@CloudStorageClass = N'multi_regional',
@CloudRegionName = N'asia',
@UseSSL = 1

declare @mirrorId1 as nvarchar(100)
exec master.dbo.xp_backup_parameters
@FileName = @mirrorId1 OUTPUT,
@CloudVendor = N'S3Compatible',
@CloudBucketName = N'bucketname',
@CloudAccessKeyEnc = N'***',
@CloudSecretKeyEnc = N'***',
@AzureBlobType = N'Block',
@UseSSL = 1

Run a backup:

declare @mirrorPath1 nvarchar(1024)
set @mirrorPath1 = @mirrorId1 + N':' + N''
exec master.dbo.xp_backup_database
@database = N'TestDatabase',
@backupname = N'TestDatabase - Full Database Backup',
@desc = N'Full Backup of TestDatabase on %Y-%m-%d %I:%M:%S %p',
@compressionlevel = 2,
@filename = N'c:\backup\TestDatabase_Full_1503360019.bak',
@init = 1,
@mirror = @mirrorPath1,
@OLRMAP = 1 ,
@with = N'STATS = 10'

Arguments

Tips:

  • To see the list of accepted arguments and data types for arguments, execute the following:
    exec master.dbo.<procedure_name> show_help

  • To convert the script for use with the command-line utilities, execute the following:
    exec master.dbo.<procedure_name> show_cmd, <xp_arguments>

@AzureBlobType

Type: Varchar

The @AzureBlobType argument specifies the types of blobs that can be stored in the Microsoft Azure cloud storage. This argument accepts one of the following values: "Block", "Page".

note: The LiteSpeed auto striping logic used in the @CloudAutoStriping and @CloudAutoStripingThreshold parameters can override the Azure blob limit for LiteSpeed backups.

@CloudAccessKey

Type: Varchar

The @CloudAccessKey argument specifies the name of the unique Cloud Web Service alphanumeric access key that identifies each user. The selections include Amazon Access Key, Azure Account Name, Google e-mail styled account, S3 Compatible Storage Access Key.

@CloudAccessKeyEnc

Type: Varchar

The @CloudAccessKeyEnc argument specifies the name of the encrypted unique Cloud Web Service alphanumeric access key that identifies each user.

@CloudAutoStriping

This parameter enables automatic file striping for LiteSpeed cloud backups.

@CloudAutoStripingThreshold

This parameter contains the stripe size in GBs. LiteSpeed logic uses the database size to make a decision about the number of stripes needed for LiteSpeed cloud backups. For example, if you have a database with a size of 200GB and set @CloudAutoStripingThreshold = 50, then LiteSpeed uses 200/50 = 4 stripes.

@CloudBucketName

Type: Varchar

The @CloudBucketName argument specifies the name of the container for cloud objects. Bucket names must be at least 3 and no more than 63 characters long. The selections are Amazon Bucket Name, Azure Container Name, Google Bucket Name, Google Bucket Name requirements are described at https://cloud.google.com/storage/docs/naming, S3 Compatible Storage Bucket Name,

@CloudGovRegion

The @CloudGovRegion argument enables a special restricted region for the US Government use in Amazon S3 and Azure Clouds. This argument accepts one of the following values:

  • 0—Do not use government cloud (default)
  • 1—Use government cloud

@CloudParallelUpload

The @CloudParallelUpload argument, parallel parts transfers, is used to create fast uploads to the Azure Cloud or Amazon S3. The default number of parallel uploads:

  • Amazon S3 = 3
  • Azure Blob = 20

@CloudPartSize

The @CloudPartSize argument determines the size of each part that is uploaded to the cloud. The default part size:

  • Amazon S3 = 25MB
  • Azure Blob = 4MB

notes:

  • Minimum part size for Azure Blob = 4MB

  • Minimum part size for Amazon S3 = 5MB

TIP: Quest Software recommends using LiteSpeed defaults.

@CloudRegionName

Type: Varchar

The @CloudRegionName argument specifies the name of the Cloud Web Service region to use for a bucket. Example values are but not limited to: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, sa-east-1, N'Germany' and N'China'.

@CloudSecretKey

Type: Varchar

The @CloudSecretKey argument specifies the name of the Cloud Web Service secret key that is assigned when you initially get a Cloud account.

@CloudSecretKeyEnc

Type: Varchar

The @CloudSecretKeyEnc argument specifies the name of the encrypted Cloud Web Service secret key that is assigned when you initially get a Cloud account.

@CloudStorageClass

Type: Varchar

The @CloudStorageClass argument specifies a range of storage classes established for different use cases including:

For Amazon S3:

  • Standard: Standard storage - for general-purpose storage of frequently accessed data.
  • Standard-IA: Standard Infrequent Access - for long-lived, but less frequently accessed data.

  • RRS: Reduced Redundancy Storage - for non-critical data considering lower level of redundancy rather than Standard storage.

Important: : In versions less than 8.5 you should use --AWSStorageClass. The @AWSStorageClass argument is no longer valid in subsequent LiteSpeed versions after 8.5.

For Google Storage:

  • Multi_regional - for frequently accessed data around the world as per serving website content, streaming videos, or gaming and mobile applications.
  • Regional - for frequently accessed data in the same region as your Google Cloud DataProc or the Google Compute Engine instances that use it, as per data analytics.
  • Nearline - for infrequently accessed data (data you expect to access no more than once per month).
  • Coldline - for infrequently accessed data (data you expect to access no more than once per year).

@CloudVendor

Type: Varchar

The @CloudVendor argument specifies the name of the cloud service provider. The argument accepts one of the following values: "AmazonS3", "AzureBlob", "GoogleStorage" or "S3Compatible".

@CloudEndpoint

Type: Varchar

The @CloudEndpoint argument specifies the endpoint for S3 Compatible Storage and custom endpoint for Amazon S3 service (in case of VPC). Format: servername:port .Example values: "servername", "servername:port", "ip:port", "10.0.0.200:9021".

@CloudAcceptAllCertificates

Type: Boolean

The @CloudAcceptAllCertificates argument instructs LiteSpeed accept self-signed certificates for S3 Compatible Storage. This argument accepts one of the following values:

  • 0—Accept verified certificates only (default)
  • 1—Accept self-signed certificates

Note: Delete backups is not supported in Maintenance Plans with this option.

@CloudSessionToken

Type: Varchar

Amazon Web Services specific argument.

The @CloudSessionToken argument specifies the session token required for temporary security credentials (see Amazon Web Services SDK documentation for details).

@filename

Specifies a backup location (e.g. C:\backups\AdventureWorks.bak). This argument accepts network destinations. You can supply multiple instances of this argument to use stripe backups.

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

@GSProject

DEPRECATED LiteSpeed 8.8: Was used to store for the Google Cloud Storage project ID; the project ID is now obtained from login. This parameter is retained for compatibility with old backup/restore scripts.

@ProxyHost

Type: Varchar

The @ProxyHost argument is optional and specifies the name of the proxy host name that is running the proxy server.

note: If the @ProxyHost argument is not defined, then the LiteSpeed core engine checks the local .ini files for the proxy parameters. If the proxy parameters are not detected, then the LiteSpeed core engine connects directly to the proxy servers.

@ProxyLogin

Type: Varchar

The @ProxyLogin argument is optional and specifies the proxy server login credential.

note: If not defined, then the LiteSpeed core engine checks the local .ini files for the proxy parameters. If the proxy parameters are not detected, then the LiteSpeed core engine connects directly to the proxy servers.

@ProxyPassword

Type: Varchar

The @ProxyPassword argument is optional and specifies the proxy server password credential.

note: If the @ProxyPassword argument is not defined, then the LiteSpeed core engine checks the local .ini files for the proxy parameters. If the proxy parameters are not detected, then the LiteSpeed core engine connects directly to the proxy servers.

@ProxyPasswordEnc

Type: Varchar

The @ProxyPasswordEnc argument is optional and specifies the encrypted proxy server password credential.

note: If the @ProxyPasswordEnc argument is not defined, then the LiteSpeed core engine checks the local .ini files for the proxy parameters. If the proxy parameters are not detected, then the LiteSpeed core engine connects directly to the proxy servers.

@ProxyPort

The @ProxyPort argument is optional and contains the port number of the proxy server. The TCP/IP port values can be 1-65535.

note: If the @ProxyPort argument is not defined, then the LiteSpeed core engine checks the local .ini files for the proxy parameters. If the proxy parameters are not detected, then the LiteSpeed core engine connects directly to the proxy servers.

@UseSSL

The @UseSSL argument specifies that the connection uses SSL security. This argument accepts one of the following values:

  • 0—Do not use SSL
  • 1—Use SSL (default)

 

Related Topic

About Using Extended Stored Procedures

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating