Tivoli Header

Administrator's Reference

DEFINE BACKUPSET (Define a Backup Set)

Use this command to define a client backup set that was previously generated on one server and make it available to the server running this command. The client node has the option of restoring the backup set from the server running this command rather than the one on which the backup set was generated.

Any backup set generated on one server can be defined to another server as long as the servers share a common device type. The level of the server to which the backup set is being defined must be equal to or greater than the level of the server that generated the backup set.

You can also use the DEFINE BACKUPSET command to redefine a backup set that was deleted on a server.

Privilege Class

If the REQSYSAUTHOUTFILE server option is set to YES (the default), the administrator must have system privilege. If the REQSYSAUTHOUTFILE server option is set to NO, the administrator must have system privilege or policy privilege for the domain to which the client node is assigned.

Syntax

>>-DEFine BACKUPSET--node_name--backup_set_name----------------->
 
                                            .-,------------.
                                            V              |
>--DEVclass--=--device_class_name--VOLumes=---volume_names-+---->
 
   .-RETention--=--365---------.
>--+---------------------------+-------------------------------->
   '-RETention--=--+-days----+-'
                   '-NOLimit-'
 
>--+-----------------------------+-----------------------------><
   '-DESCription--=--description-'
 
 

Parameters

node_name (Required)
Specifies the name of the client node whose data is contained in the backup set. You cannot use wildcard characters to specify a name nor can you specify a list of node names, separated by commas.

backup_set_name (Required)
Specifies the name of the backup set to define to this server. The maximum length of the name is 30 characters.

When you select a name, TSM adds a suffix to construct your backup set name. For example, if you name your backup set mybackupset, TSM adds a unique number such as 3099 to the name. Your backup set name is then identified as mybackupset.3099. To later display information about this backup set, you can include a wildcard with the name, such as mybackupset* or you can specify the fully qualified name, such as mybackupset.3099.

DEVclass (Required)
Specifies the device class name for the volumes from which the backup set is read.
Note:
The device type associated with the device class you specify must match the device class with which the backup set was originally generated.

VOLumes (Required)
Specifies the names of the volumes used to store the backup set. You can specify multiple volumes by separating the names with commas and no intervening spaces. The volumes you specify must be available to the server that is defining the backup set.

RETention
Specifies the number of days that the backup set is retained on the server. You can specify an integer from 0 to 9999. The default is 365 days. The values are:

days
Specifies the number of days to retain the backup set on the server.

NOLimit
Specifies that the backup set should be retained on the server indefinitely.

If you specify NOLIMIT, TSM retains the volumes containing the backup set forever, unless a user or administrator deletes the volumes from server storage.

DESCription
Specifies the description to associate with the backup set that belongs to the client node. This parameter is optional. The maximum length of the description is 255 characters.

Examples

Task

Define the PERS_DATA backup set that belongs to client node JANE to the server running this command. Retain the backup set on the server for 50 days. Specify that volumes VOL001 and VOL002 contain the data for the backup set. The volumes are to be read by a device that is assigned to the AGADM device class.

Command:
define backupset jane pers_data devclass=agadm 
volumes=vol1,vol2 retention=50

Related Commands

Table 36. Commands Related to DEFINE BACKUPSET

Command Description
DELETE BACKUPSET Deletes a backup set.
GENERATE BACKUPSET Generates a backup set of a client's data.
QUERY BACKUPSET Displays backup sets.
QUERY BACKUPSETCONTENTS Displays contents contained in backup sets.
UPDATE BACKUPSET Updates a retention value associated with a backup set.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]