Chat now with support
Chat with Support

LiteSpeed for SQL Server 8.9.5 - Installation Guide

xp_view_tsmmc

Displays available TSM management classes with detailed information. If you specify a management class, the information returns only to the specified management class.

This topic covers:

Syntax

EXEC master.dbo.xp_view_tsmmc
@tsmclientnode = 'TSM_client_node'
, @tsmclientownerpwd = 'TSM_client_owner_password'
, @tsmconfigfile = 'TSM_configuration_file'
[, @tsmmanagementclass = 'TSM_management_class']

Arguments

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

@tsmmanagementclass

Specifies the TSM management class. If not specified, LiteSpeed uses the default management class.

Result Set

Column Name

Data Type

Description

Name

Nvarchar(128)

Management class name.

Backup copy group name

Nvarchar(128)

The name of the backup copy group.

Backup copy group destination

Nvarchar(128)

Names the destination where backups are stored. The destination can be either a storage pool of disk devices or a storage pool of devices that support removable media, such as tape.

Versions data exists 

Nvarchar(128)

Specifies the maximum number of different backup versions retained. If you select a management class that permits more than one backup version, the most recent version is called the active version. All other versions are called inactive versions. If the maximum number of versions permitted is five, and you run a backup that creates a sixth version, the oldest version is deleted from server storage. 

Versions data deleted 

Nvarchar(128)

Specifies the maximum number of different backup versions retained for files and directories that you erased from your drive. This parameter is ignored as long as the file or directory remains on your drive. If you erase the file or directory, the next time you run an incremental backup, the active backup version is changed to inactive and the oldest versions are erased that exceed the number specified by this parameter. 

Retain extra versions

Nvarchar(128)

Specifies how many days all but the most recent backup version is retained. The most recent version is the active version, and active versions are never erased. If Nolimit is specified, then extra versions are kept until the number of backup versions exceeds the versions data exists or versions data deleted parameter settings. In this case, the oldest extra version is deleted immediately.

Retain only versions

Nvarchar(128)

Specifies the number of days the last remaining inactive version of a file or directory is retained. If Nolimit is specified, the last version is retained indefinitely. This parameter goes into effect during the next incremental backup after a file is deleted from the client machine. Any subsequent updates to this parameter will not affect files that are already inactive. For example: If this parameter is set to 10 days when a file is inactivated during an incremental backup, the file will be expired in 10 days.

Archive copy group name

Nvarchar(128)

The name of the backup copy group.

Archive copy group destination

Nvarchar(128)

Names the destination where archives are stored. The destination can be either a storage pool of disk devices or a storage pool of devices that support removable media, such as tape.

Returns

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

 

Related Topic

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating