Retrieves the backup header information for all LiteSpeed backups on a particular LiteSpeed backup device. The header information is sent as a row by the server for each backup on a given backup device in a table.
Tip: To retrieve information from TSM backups, also use xp_view_tsmcontents.
This topic covers:
EXEC master.dbo.xp_restore_headeronly
[@filename = 'backup_file_name'] [,...n]
[, @filenumber = n]
[, @headerdetails = 'option']
[, @attachedfiles = 0 | 1 | 2 | 3 ]
EXEC master.dbo.xp_restore_headeronly
@filename = 'tape_device_name'
[, @filenumber = n]
[, @headerdetails = 'option']
[, @attachedfiles = 0 | 1 | 2 | 3 ]
EXEC master.dbo.xp_restore_headeronly
@tsmobject = 'TSM_object'
, @tsmconfigfile = 'TSM_configuration_file'
[, @tsmclientnode = 'clientnode_name']
[, @tsmclientownerpwd = '****']
[, @tsmarchive = 0 | 1 ]
[, @tsmpointintime = 'date_time']
[, @attachedfiles = 0 | 1 | 2 | 3 ]
[, @headerdetails = 'option']
EXEC master.dbo.xp_restore_headeronly
@CloudVendor = N'AmazonS3'
, @FileName = N'AA_3_1.bak'
[, @CloudBucketName = N'aabucket7']
[, @CloudAccessKey = N'***']
[, @CloudSecretKey = ***']
[, @CloudRegionName = N'us-west-2']
[, @ProxyHost = N'proxy.sitelocal']
[, @ProxyPort = 8080]
[, @ProxyLogin = N'DOMAIN\xyz-tst-MYTester']
[, @ProxyPassword = N'***']
EXEC master.dbo.xp_restore_headeronly
@filename = N'test\test.bak',
@CloudVendor = N'AzureBlob',
@CloudAccessKeyEnc = N'*******',
@CloudSecretKeyEnc = N'******',
@CloudBucketName = N'test',
@UseSSL = 1,
@logging = 0
exec xp_restore_headeronly
@FileName = N'path\to\backup'
, @FileNumber = 1
, @CloudVendor = N'GoogleStorage'
, @CloudBucketName = N'bucketname'
, @CloudAccessKey = N'***' -- my key'
, @CloudSecretKey = N'***' -- my key'
exec xp_restore_headeronly
@FileName = N'path\to\backup'
, @FileNumber = 1
, @CloudVendor = N'S3Compatible'
, @CloudEndpoint = N'storageserver:port'
, @CloudBucketName = N'bucketname'
, @CloudAccessKey = N'***' -- my key'
, @CloudSecretKey = N'***' -- my key'
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>
Lists files attached to a backup. This argument accepts one of the following values:
The @AWSUseReducedRedundancy argument specifies the use of reduced redundancy storage in Amazon S3. This argument accepts one of the following values:
|
Note: This @AWSUseReducedRedundancy argument is replaced with the @CloudStorageClass = 'rrs' argument. |
The @AWSUseServerSideEncryption argument enables the encryption of data stored at rest in Amazon S3. This argument accepts one of the following values:
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.
Type: Varchar
The @CloudAccessKeyEnc argument specifies the name of the encrypted unique Cloud Web Service alphanumeric access key that identifies each user.
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,
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:
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'.
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.
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.
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".
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".
Type: Boolean
The @CloudAcceptAllCertificates argument instructs LiteSpeed accept self-signed certificates for S3 Compatible Storage. This argument accepts one of the following values:
Note: Delete backups is not supported in Maintenance Plans with this option.
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.
Type: Integer
Disk restores:
Specifies the particular backup to use when recasting, restoring, extracting or reading from files with multiple appended backups.
Tape restores:
Identifies the backup set to be restored. For example, a file number of 1 indicates the first backup set on the backup medium, and a file number of 2 indicates the second backup set.
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.
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.
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. |
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. |
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. |
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. |
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. |
Specifies to store the backup as a TSM archive. This argument accepts one of the following values:
Specifies the TSM configuration file.
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.
Specifies the TSM client owner user password. Not required, if specified in the options file or if backing up with the Passwordaccess Generate option.
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.
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.
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
The @UseSSL argument specifies that the connection uses SSL security. This argument accepts one of the following values:
Disable output information for the procedure
Display backup set information and attached files:
exec master.dbo.xp_restore_headeronly
@filename = N'C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Backup\FASTCOMP_full2.bak'
, @attachedfiles = 2
List files attached to a tsm backup:
exec master.dbo.xp_restore_headeronly
@tsmclientnode = N'10.1.26.177',
@tsmclientownerpwd = N'Quest2013',
@tsmconfigfile = N'D:\dsm.opt'
, @tsmobject = N'test\test\model'
, @attachedfiles = 1
Restore headers from an AmazonS3 Cloud backup:
exec master.dbo.xp_restore_headeronly
@CloudVendor = N'AmazonS3'
, @FileName = N'AA_3_1.bak'
, @CloudBucketName = N'aabucket7'
, @CloudAccessKey = N'***' -- my key
, @CloudSecretKey = ***' -- my key
, @CloudRegionName = N'us-west-2' -- us-east-1, us-west-2, us-west-1, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1
(this is an optional parameter. Region for selected @CloudBucketName will be used.)
, @ProxyHost = N'proxy.sitelocal'
, @ProxyPort = 8080
, @ProxyLogin = N'DOMAIN\xyz-tst-MYTester'
, @ProxyPassword = N'***'
xp_restore_headeronly displays the following information:
|
Column Name |
Data Type |
Description |
|---|---|---|
|
FileNumber |
Int |
Number of the Backup within the LiteSpeed backup device. |
|
BackupFormat |
nvarchar(128) |
Reserved field. Returns 1. |
|
Guid |
Uniqueidentifier |
Backup Guid, uniquely identifies LiteSpeed backup sets. |
|
BackupName |
nvarchar(128) |
Backup set name. |
|
BackupDescription |
nvarchar(128) |
Backup set description. |
|
BackupType |
nvarchar(128) |
Backup type:
Shouldn't there be a 3? |
|
ExpirationDate |
Datetime |
Expiration date for the backup set. |
|
Compressed |
Tinyint |
0—No compression. |
|
Position |
Smallint |
Position of the backup set in the volume (for use with the FILE = option). |
|
DeviceType |
Tinyint |
Virtual Device |
|
UserName |
nvarchar(128) |
Username that performed the backup operation. |
|
ServerName |
nvarchar(128) |
Name of the server that wrote the backup set. |
|
DatabaseName |
nvarchar(128) |
Name of the database that was backed up. |
|
DatabaseVersion |
int |
Version of the database from which the backup was created. |
|
DatabaseCreationDate |
datetime |
Date and time the database was created. |
|
BackupSize |
numeric (20,0) |
Size of the backup, in bytes. |
|
FirstLSN |
numeric (25,0) |
Log sequence number of the first transaction in the backup set. NULL for file backups. |
|
LastLSN |
numeric (25,0) |
Log sequence number of the last transaction in the backup set. NULL for file backups. |
|
CheckpointLSN |
numeric (25,0) |
Log sequence number of the most recent checkpoint at the time the backup was created. |
|
DifferentialBaseLSN |
numeric (25,0) |
Log sequence number of the most recent full database backup. |
|
BackupStartDate |
datetime |
Date and time that the backup operation began. |
|
BackupFinishDate |
datetime |
Date and time that the backup operation finished. |
|
SortOrder |
Smallint |
Server sort order. This column is valid for database backups only. Provided for backward compatibility. |
|
CodePage |
Smallint |
Server code page or character set used by the server. |
|
CompatibilityLevel |
Tinyint |
Compatibility level setting of the database from which the backup was created. |
|
SoftwareVendorId |
Int |
Software vendor identification number. For SQL Server, this number is 4608 (or hexadecimal 0x1200). |
|
SoftwareVersionMajor |
Int |
Major version number of the server that created the backup set. |
|
SoftwareVersionMinor |
Int |
Minor version number of the server that created the backup set. |
|
SoftwareVersionBuild |
Int |
Build number of the server that created the backup set. |
|
MachineName |
nvarchar(128) |
Name of the server that wrote the backup set. |
|
BindingID |
Uniqueidentifier |
Binding ID for the database. |
|
RecoveryForkID |
Uniqueidentifier |
ID for the current recovery fork for this backup. |
|
Encryption |
Int |
Indicates if backup is encrypted
|
| IsCopyOnly | nvarchar(128) |
Indicates if the backup is a copy-only backup. |
0 (success) or non-zero (failure).
To capture the output message, run the following:
declare @rmsg varchar(999)
exec master..<procedure_name> <arguments>, @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..<procedure_name> <arguments>, @resultmsg=@rmsg output, @resultcode=@rc output
select @rc, @rmsg
© ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center
