LiteSpeed for SQL Server 8.9.5 - Security and Compliance Guide

xp_restore_setinfo

Returns information about the stripe set to which the backup file belongs.

This topic covers:

• Syntax

• Arguments

• Example

• Results

• Returns

Syntax

xp_restore_setinfo (Disk or Tape)

EXEC master.dbo.xp_restore_setinfo
@filename = 'file_name'
[, @filenumber = n]

xp_restore_setinfo (TSM)

EXEC master.dbo.xp_restore_setinfo
@tsmobject = 'TSM_object'
, @tsmconfigfile = 'TSM_configuration_file'
[, @tsmclientnode = 'clientnode_name']
[, @tsmclientownerpwd = '****']
[, @tsmarchive = 0 | 1 ]
[, @tsmpointintime = 'date_time'] 

xp_restore_setinfo (Amazon S3)

EXEC master.dbo.xp_restore_setinfo

@filename = 'file name'

@CloudVendor = 'AmazonS3',

@CloudBucketName = 'bucket name',

@CloudAccessKeyEnc = 'accesskeyenc',

@CloudSercretKeyEnc = 'secretkeyenc'

xp_restore_setinfo (Microsoft Azure)

EXEC master.dbo.xp_restore_setinfo

@filename = N'tst\test.bak',

@CloudVendor = N'AzureBlob',

@CloudBucketName = N'test',

@CloudAccessKeyEnc = N'******',

@CloudSecretKeyEnc = N'********'

xp_restore_setinfo (Google Storage)

EXEC master.dbo.xp_restore_setinfo

@filename = N'tst\test.bak',

@CloudVendor = N'GoogleStorage',

@CloudBucketName = N'test',

@CloudAccessKeyEnc = N'******',

@CloudSecretKeyEnc = N'********'

xp_restore_setinfo (S3 Compatible Storage)

EXEC master.dbo.xp_restore_setinfo

@filename = N'tst\test.bak',

@CloudVendor = N'S3Compatible',

@CloudEndpoint = N'storageserver:port',

@CloudBucketName = N'test',

@CloudAccessKeyEnc = N'******',

@CloudSecretKeyEnc = N'********'

Arguments

@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.

@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,

@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.

@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.

@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.

@filenumber

Specifies the particular backup to use when recasting, restoring, extracting or reading from files with multiple appended backups. A backup file can contain multiple backups. Each time you append a new backup, a sequential number is assigned to this backup within the backup file. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name.

@logging

Writes a log file for the operation. This argument accepts one of the following values:

• 0—Logging off.

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

• 2 or any even value—Logging on.

The default output directory is C:\Documents and Settings\All Users\Application Data\Quest Software\LiteSpeed\SQL Server\Logs (or C:\ProgramData\Quest Software\LiteSpeed\SQL Server\Logs) (or C:\ProgramData\Quest Software\LiteSpeed\SQL Server\Logs). To log to a different directory add @Trace='logpath=path'.

See Configure Logging in LiteSpeed for information about LiteSpeed logging.

@ProxyHost

Type: Varchar

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

@ProxyLogin

Type: Varchar

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

@ProxyPassword

Type: Varchar

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

@ProxyPasswordEnc

Type: Varchar

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

@ProxyPort

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

@tsmarchive

Specifies to store the backup as a TSM archive. This argument accepts one of the following values:

• 0—False (default)
• 1—True

@tsmconfigfile

Specifies the TSM configuration file.

@tsmclientnode

Specifies the TSM server LiteSpeed connects to during backups and restores. Not required, if specified in the options file or if backing up with the Passwordaccess Generate option.

@tsmclientownerpwd

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

@tsmobject

Defines the TSM filespace, high level and low level. This argument accepts the following format:

tsm_filespace\tsm_high_level\tsm_low_level

where:

• tsm_filespace is the logical space on the TSM server that contains a group of files. It can be the drive label name or UNC name.

• tsm_high_level specifies the directory path in which the file belongs.

• tsm_low_level specifies actual name of the file.

NOTE: You may only store one item the location specified by this argument. 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 non-unique location.

@tsmpointintime

Specifies the date for restore/to filter results. If it is not passed, LiteSpeed will choose the most recent archived backup. The format is yyyy-mm-dd hh:mm:ss.

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), then the most recent of the times must be chosen.

@unload

Type: Integer

Applies to tape backups and restores. This argument accepts one of the following values:

• 0—Keep tape loaded (default)

• 1—Unload and eject tape from the drive after operation

@NoOutput

Disable output information for the procedure

1. 0 - Output information enabled (default).
2. 1 - Output information disabled

Example

EXEC master.dbo.xp_restore_setinfo
@filename = 'C:\SQLServerBackups\CD3.bak'

Results

Returns

0 (success) or non-zero (failure). Message indicating success or failure of the operation.

Related Topic

About Using Extended Stored Procedures