Tivoli Storage Manager for Windows: Administrator's Reference

GENERATE BACKUPSET (Generate a Backup Set of a Client's Data)

Use this command to generate a backup set for a backup-archive client node. A backup set is a collection of a client's active backed up data, stored and managed as a single object, on specific media, in server storage. While the server allows you to create a backup set for any TSM client node, a backup set can only be used by a backup-archive client.

Note:
|You cannot generate a backup set for a NAS node. |

The server creates copies of active versions of a client's backed up objects that are within the one or more file spaces specified with this command, and consolidates them onto sequential media. Currently, the backup object types supported for backup sets include directories and files only.

The backup-archive client node can restore their backup set from the server as well as from the media to which the backup set was written.

This command generates a background process that can be cancelled with the CANCEL PROCESS command. If the background process created by this command is cancelled, the media may not contain a complete backup set. You can use the QUERY PROCESS command to display information about the background process that is created by this command.

Privilege Class

To issue this command, you must have system privilege or policy privilege for the domain to which the client node is assigned.

Syntax

>>-GENerate BACKUPSET--node_name--backup_set_name_prefix-------->
 
   .-*-------------------.
>--+---------------------+--DEVclass--=--device_class_name------>
   |.-,---------------.  |
   |V                 |  |
   '--file_space_name-+--'
 
   .-SCRatch--=--Yes-----.
>--+---------------------+--+---------------------------+------->
   '-SCRatch--=--+-Yes-+-'  |          .-,------------. |
                 '-No--'    |          V              | |
                            '-VOLumes=---volume_names-+-'
 
   .-RETention--=--365---------.
>--+---------------------------+-------------------------------->
   '-RETention--=--+-days----+-'
                   '-NOLimit-'
 
                                    .-Wait--=--No------.
>--+-----------------------------+--+------------------+-------->
   '-DESCription--=--description-'  '-Wait--=--+-No--+-'
                                               '-Yes-'
 
   .-NAMEType--=--SERVER------.
>--+--------------------------+--------------------------------->
   '-NAMEType--=--+-SERVER--+-'
                  +-UNIcode-+
                  '-FSID----'
 
   .-CODEType--=--BOTH-----------.
>--+-----------------------------+-----------------------------><
   '-CODEType--=--+-UNIcode----+-'
                  +-NONUNIcode-+
                  '-BOTH-------'
 
 

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 client node names.

backup_set_name_prefix (Required)
Specifies the name of the backup set for the client node. 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. The backup set name is then identified to TSM 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.

file_space_name
Specifies the names of one or more file spaces that contain the data to be included in the backup set. This parameter is optional. The file space name you specify can contain wildcard characters. You can specify more than one file space by separating the names with commas and no intervening spaces. If you do not specify a file space, data from all the client node's backed- up and active file spaces is included in the backup set.

For a server that has clients with support for Unicode-enabled file spaces, you can enter either a file space name or file space ID (FSID). If you enter a file space name, you may need to have the server convert the file space name that you enter. For example, you may need to have the server convert the name you enter from the server's code page to Unicode. See the NAMETYPE parameter for details. If you do not specify a file space name, or specify only a single wildcard character for the name, you can use the CODETYPE parameter to limit the operation to Unicode file spaces or to non-Unicode file spaces.

DEVclass (Required)
Specifies the name of the device class for the volumes to which the backup set is written. The maximum length of the name is 30 characters.
Note:
|You cannot specify a device class with a device type of NAS. |

SCRatch
Specifies whether to use scratch volumes for the backup set. If you include a list of volumes using the VOLUMES parameter, the server uses scratch volumes only if the data cannot be contained in the volumes you specify. The default is SCRATCH=YES. The values are:

YES
Specifies to use scratch volumes for the backup set.

NO
Specifies not to use scratch volumes for the backup set.

VOLumes
Specifies the names of one or more volumes that will contain the backup set. This parameter is optional. You can specify more than one volume by separating each volume with a comma, with no intervening spaces.

If you do not specify this parameter, scratch volumes are used for the backup set.

RETention
Specifies the number of days to retain the backup set 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, the server 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. This parameter is optional. The maximum length of the description is 255 characters.

Wait
Specifies whether to wait for the server to complete processing this command in the foreground. This parameter is optional. The default is No. The values are:

Yes
|Specifies the command processes in the foreground. Messages |created are not displayed until the command completes processing. You |cannot specify WAIT=YES from the server console.

No
Specifies that the command processes in the background. Use the QUERY PROCESS command to monitor the background processing of this command.

NAMEType
Specify how you want the server to interpret the file space names that you enter. This parameter is useful when the server has clients with support for Unicode-enabled file spaces. A backup-archive client with support for Unicode-enabled file spaces is currently available only for Windows NT and Windows 2000 operating systems.

Use this parameter only when you enter a partly or fully qualified file space name. The default value is SERVER. Possible values are:

SERVER
The server uses the server's code page to interpret the file space names.

UNIcode
The server converts the file space name entered from the server code page to the UTF-8 code page. The success of the conversion depends on the actual characters in the name and the server's code page. Conversion can fail if the string includes characters that are not available in the server code page, or if the server has a problem accessing system conversion routines.

FSID
The server interprets the file space names as their file space IDs (FSIDs).

CODEType
Specify what type of file spaces are to be included in the operation. The default is BOTH, meaning that file spaces are included regardless of code page type. Use this parameter only when you enter a single wildcard character for the file space name or when you do not specify any file space names. Possible values are:

UNIcode
Include only file spaces that are in Unicode.

NONUNIcode
Include only file spaces that are not in Unicode.

BOTH
Include file spaces regardless of code page type.

Examples

Task

Generate a backup set of a file space called /srvr that belongs to client node JANE. Name the backup set PERS_DATA and retain it for 75 days. Specify that volumes VOL1 and VOL2 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:
generate backupset jane pers_data /srvr devclass=agadm 
retention=75 volumes=vol1,vol2 

Task

Generate a backup set of the Unicode-enabled file space, \\joe\c$, that belongs to client node JOE. Name the backup set JOES_DATA . Specify that volume VOL1 contain the data for the backup set. The volume is to be read by a device that is assigned to the AGADM device class. Have the server convert the \\joe\c$ file space name from the server code page to the UTF-8 code page.

Command:
generate backupset joe joes_data \\joe\c$ devclass=agadm
volumes=vol1 nametype=unicode 

Related Commands

Table 140. Commands Related to GENERATE BACKUPSET

Command Description
DEFINE BACKUPSET Defines a previously generated backup set to a server.
DELETE BACKUPSET Deletes a backup set.
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 ]