LiteSpeed for SQL Server 8.9.8 - Security and Compliance Guide

xp_view_tsmcontents

Retrieves TSM specific information and backup header information for the given LiteSpeed backup.

This topic covers:

• Syntax

• Arguments

• Example

• Result Set

Syntax

EXEC master.dbo.xp_view_tsmcontents
@tsmclientnode = 'TSM_client_node'
, @tsmclientownerpwd = 'TSM_client_owner_password'
, @tsmfilespace = 'TSM_filespace'
, @tsmconfigfile = 'TSM_configuration_file'
[, @tsmhighlevel ='TSM_high_level']
[, @tsmlowlevel = 'TSM_low_level']
[, @tsmarchive= 0 | 1 ]
[, @desc='description']
[, @tsminsdatelower='date_time']
[, @tsminsdateupper='date_time']
[, @tsmexpdatelower='date_time']
[, @tsmexpdateupper='date_time']
[, @tsmbrieflist = 1 | 0 ]
[, @tsmsortbypit = 0 | 1 ]
[, @tsmsortbylowlevel = 0 | 1 ]
[, @tsmpointintime = 'date_time']

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>

@desc

Specifies a description to filter the returned results to those that match the pattern.

NOTE: @desc is only supported if @TSMBriefList=0.

@tsmarchive

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

• 0—False (default)
• 1—True

@tsmbrieflist

Returns a brief list. This argument accepts one of the following values:

• 0—False
• 1—True (default)

NOTE: It is not needed for archives as they are only returned as a brief list. Backups had to continue to support the full xml dump because of backwards compatibility - i.e. I never knew if some customers might be relying on the full list, but archives are a new feature and especially for archives it makes even less since to open up EVERY archived object to read in the full xml which can take even more hours.

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

@tsmconfigfile

Specifies the TSM configuration file.

You can use the %TSMDEFAULTPATH% variable to make LiteSpeed detect the default TSM configuration file path automatically (by getting from LiteSpeed defaults as a priority or the registry - HKEY_LOCAL_MACHINE\SOFTWARE\IBM\ADSM\CurrentVersion\BackupClient)

@tsmexpdatelower

For TSM archives, it specifies the oldest expiration date and time of where to start the list. (as in TSM's client api doc for expdatelowerbound) The format is yyyy-mm-dd hh:mm:ss.

@tsmexpdateupper

For TSM archives, it specifies the most recent expiration date and time of where to stop the list. (as in TSM's client api doc for expdateupperbound) The format is yyyy-mm-dd hh:mm:ss.

@tsmfilespace

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

See also @tsmobject.

@tsmhighlevel

Specifies the TSM high-level name. If you do not specify this parameter, LiteSpeed will retrieve all high levels from the TSM server.

NOTES:

• This parameter supports wild cards (e.g. MyLowLevelName*, MyHighLevelName*).
• You do not necessarily have to have both the @tsmhighlevel and @tsmlowlevel parameters in one query.

@tsminsdatelower

For TSM archives, it specifies the oldest insertion date and time of where to start the list. (as in TSM's client api doc for insdatelowerbound) The format is yyyy-mm-dd hh:mm:ss.

@tsminsdateupper

For TSM archives, it specifies the most recent insertion date and time of where to stop the list. (as in TSM's client api doc for insdateupperbound) The format is yyyy-mm-dd hh:mm:ss.

@tsmlowlevel

Specifies the TSM low-level name. If you do not specify this parameter, LiteSpeed will retrieve all low levels from the TSM server.

NOTES:

• This parameter supports wild cards (e.g. MyLowLevelName*, MyHighLevelName*).
• You do not necessarily have to have both the @tsmhighlevel and @tsmlowlevel parameters in one query.

@tsmsortbylowlevel

Sorts the results by the low level name. This argument accepts one of the following values:

• 0—False (default)
• 1—True

@tsmsortbypit

Sorts the results by the point-in-time date. It accepts one of the following:

• 0—False (default)
• 1—True

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

Example

exec master.dbo.xp_view_tsmcontents
@tsmclientnode = 'ClusterGroup'
, @tsmclientownerpwd= 'test16'
, @tsmfilespace= 'SLS_Mar'
, @tsmconfigfile= 'C:\Program Files\Tivoli\tsm\baclient\dsm.opt'
, @tsmarchive=1
, @tsminsdatelower='2006-03-15 13:00:00'
, @tsminsdateupper='2006-03-16 18:00:00'
, @tsmexpdatelower='2007-02-14 09:00:00'
, @tsmexpdateupper='2007-03-17 18:00:00'

Result Set

xp_view_tsmcontents displays the following information:

Returns

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

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

Related Topic

About Using Extended Stored Procedures