Administrator's Reference


DEFINE COPYGROUP (Define a Copy Group)

Use this command to define a new backup or archive copy group within a specific management class, policy set, and policy domain. The server uses the backup and archive copy groups to control how clients back up and archive files, and to manage the backed-up and archived files. To allow clients to use the new copy group, you must activate the policy set that contains the new copy group.

You can define one backup and one archive copy group for each management class. To ensure that client nodes can back up files, include a backup copy group in the default management class for a policy set.

Note:The DEFINE COPYGROUP command fails if you specify a copy storage pool as a destination.

The DEFINE COPYGROUP command has two forms, one for defining a backup copy group and one for defining an archive copy group. The syntax and parameters for each form are defined separately.

DEFINE COPYGROUP -- Backup

Use this command to define a new backup copy group within a specific management class, policy set, and policy domain.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, or restricted policy privilege for the policy domain to which the copy group belongs.

Syntax

>>-DEFine COpygroup--domain_name--policy_set_name--class_name--->
 
      .-STANDARD--.   .-Type--=--Backup--.
>-----+-----------+---+------------------+---------------------->
      '-STANDARD--'   '-Type--=--Backup--'
 
                                  .-FREQuency--=--0-----.
>-----DESTination--=--pool_name---+---------------------+------->
                                  '-FREQuency--=--days--'
 
      .-VERExists--=--2-----------.
>-----+---------------------------+----------------------------->
      '-VERExists--=--+-number--+-'
                      '-NOLimit-'
 
      .-VERDeleted--=--1-----------.
>-----+----------------------------+---------------------------->
      '-VERDeleted--=--+-number--+-'
                       '-NOLimit-'
 
      .-RETExtra--=--30----------.
>-----+--------------------------+------------------------------>
      '-RETExtra--=--+-days----+-'
                     '-NOLimit-'
 
      .-RETOnly--=--60----------.   .-MODE--=--MODified-----.
>-----+-------------------------+---+-----------------------+--->
      '-RETOnly--=--+-days----+-'   '-MODE--=--+-MODified-+-'
                    '-NOLimit-'                '-ABSolute-'
 
      .-SERialization--=--SHRSTatic------.
>-----+----------------------------------+---------------------><
      '-SERialization--=--+-SHRSTatic--+-'
                          +-STatic-----+
                          +-SHRDYnamic-+
                          '-DYnamic----'
 

Parameters

domain_name (Required)
Specifies the policy domain for which you are defining the copy group.

policy_set_name (Required)
Specifies the policy set for which you are defining the copy group.

You cannot define a copy group for a management class that belongs to the ACTIVE policy set.

class_name (Required)
Specifies the management class for which you are defining the copy group.

STANDARD
Specifies the name of the copy group, which must be STANDARD. This parameter is optional. The default value is STANDARD.

Type=Backup
Specifies that you want to define a backup copy group. The default parameter is BACKUP. This parameter is optional.

DESTination (Required)
Specifies the primary storage pool where the server initially stores backup data. You cannot specify a copy storage pool as the destination.

FREQuency
Specifies how frequently TSM can back up a file. This parameter is optional. TSM backs up a file only when the specified number of days has elapsed since the last backup. The FREQUENCY value is used only during a full incremental backup operation. This value is ignored during selective backup or partial incremental backup. You can specify an integer from 0 to 9999. The default value is 0, meaning that TSM can back up a file regardless of when the file was last backed up.

VERExists
Specifies the maximum number of backup versions to retain for files that are currently on the client file system. This parameter is optional. The default value is 2.

If a backup operation causes the limit to be exceeded, the server expires the oldest backup version that exists in server storage. Possible values are:

number
Specifies the number of backup versions to retain for files that are currently on the client file system. You can specify an integer from 1 to 9999.

NOLimit
Specifies that you want the server to retain all backup versions.

The number of backup versions to retain is controlled by this parameter until versions exceed the retention time specified by the RETEXTRA parameter.

VERDeleted
Specifies the maximum number of backup versions to retain for files that have been deleted from the client file system after being backed up using TSM. This parameter is optional. The default value is 1.

If a user deletes a file from the client file system, the next backup causes the server to expire the oldest versions of the file in excess of this number. The expiration date for the remaining versions is determined by the retention time specified by the RETEXTRA or RETONLY parameter. Possible values are:

number
Specifies the number of backup versions to retain for files that are deleted from the client file system after being backed up. You can specify an integer from 0 to 9999.

NOLimit
Specifies that you want the server to retain all backup versions for files that are deleted from the client file system after being backed up.

RETExtra
Specifies the number of days to retain a backup version after that version becomes inactive. A version of a file becomes inactive when the client stores a more recent backup version, or when the client deletes the file from the workstation and then runs a full incremental backup. The server deletes inactive versions based on retention time even if the number of inactive versions does not exceed the number allowed by the VEREXISTS or VERDELETED parameters. This parameter is optional. The default value is 30 days. Possible values are:

days
Specifies the number of days to retain inactive backup versions. You can specify an integer from 0 to 9999.

NOLimit
Specifies that you want to retain inactive backup versions indefinitely.

If you specify NOLIMIT, the server deletes inactive backup versions based on the VEREXISTS parameter (when the file still exists on the client file system) or the VERDELETED parameter (when the file no longer exists on the client file system).

RETOnly
Specifies the number of days to retain the last backup version of a file that has been deleted from the client file system. This parameter is optional. The default value is 60. Possible values are:

days
Specifies the number of days to retain the last remaining inactive version of a file. You can specify an integer from 0 to 9999.

NOLimit
Specifies that you want to keep the last remaining inactive version of a file indefinitely.

If you specify NOLIMIT, the server retains the last remaining backup version forever, unless a user or administrator deletes the file from server storage.

MODE
Specifies whether TSM backs up a file only if the file has changed since the last backup, or whenever a client requests a backup. This parameter is optional. The default value is MODIFIED. Possible values are:

MODified
Specifies that TSM backs up the file only if it has changed since the last backup. TSM considers a file changed if any of the following is true:
  • The date last modified is different
  • The file size is different
  • The file owner is different
  • The file permissions are different

ABSolute
Specifies that TSM backs up the file regardless of whether it has been modified.

The MODE value is used only for full incremental backup. This value is ignored during partial incremental backup or selective backup.

SERialization
Specifies how TSM handles files or directories when they are modified during backup processing. This parameter is optional. The default value is SHRSTATIC. Possible values are:

SHRSTatic
Specifies that TSM backs up a file or directory only if it is not being modified during backup. TSM attempts to perform a backup as many as four times, depending on the value specified for the CHANGINGRETRIES client option. If the file or directory is modified during each backup attempt, TSM does not back it up.

STatic
Specifies that TSM backs up a file or directory only if it is not being modified during backup. TSM attempts to perform the backup only once.

Platforms that do not support the STATIC option default to SHRSTATIC.

SHRDYnamic
Specifies that if the file or directory is being modified during a backup attempt, TSM backs up the file or directory during the last attempt even though the file or directory is being modified. TSM attempts to perform a backup as many as four times, depending on the value specified for the CHANGINGRETRIES client option.

DYnamic
Specifies that TSM backs up a file or directory on the first attempt, regardless of whether the file or directory is being modified during backup processing.

Attention: Be careful about using the SHRDYNAMIC and DYNAMIC values. These values allow TSM to back up a file or directory while modifications are occurring. As a result, the backup version might be a fuzzy backup. A fuzzy backup does not accurately reflect what is currently in the file or directory because it contains some, but not all, modifications. If a file that contains a fuzzy backup is restored, the file may or may not be usable, depending on the application that uses the file. If a fuzzy backup is not acceptable, be sure to use a serialization value that allows TSM to create a backup version only if the file or directory is not being modified (SHRSTATIC or STATIC).

Examples

Task

Create a backup copy group named STANDARD for management class ACTIVEFILES in policy set VACATION in the EMPLOYEE_RECORDS policy domain. Set the backup destination to BACKUPPOOL. Set the minimum interval between backups to three days, regardless of whether the files have been modified. Retain up to five backup versions of a file while the file exists on the client file system.

Command:
define copygroup employee_records vacation activefiles standard type=backup destination=backuppool frequency=3 verexists=5 mode=absolute

DEFINE COPYGROUP -- Archive

Use this command to define a new archive copy group within a specific management class, policy set, and policy domain.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, or restricted policy privilege for the policy domain to which the copy group belongs.

Syntax

>>-DEFine COpygroup--domain_name--policy_set_name--class_name--->
 
      .-STANDARD--.
>-----+-----------+---Type--=--Archive-------------------------->
      '-STANDARD--'
 
                                   .-FREQuency--=--Cmd--.
>-----DESTination--=--pool_name----+--------------------+------->
                                   '-FREQuency--=--Cmd--'
 
      .-RETVer--=--365---------.   .-MODE--=--ABSolute--.
>-----+------------------------+---+--------------------+------->
      '-RETVer--=--+-days----+-'   '-MODE--=--ABSolute--'
                   '-NOLimit-'
 
      .-SERialization--=--SHRSTatic------.
>-----+----------------------------------+---------------------><
      '-SERialization--=--+-SHRSTatic--+-'
                          +-STatic-----+
                          +-SHRDYnamic-+
                          '-DYnamic----'
 

Parameters

domain_name (Required)
Specifies the name of the policy domain for which you are defining the copy group.

policy_set_name (Required)
Specifies the name of the policy set for which you are defining the copy group.

You cannot define a copy group for a management class that belongs to the ACTIVE policy set.

class_name (Required)
Specifies the name of the management class for which you are defining the copy group.

STANDARD
Specifies the name of the copy group, which must be STANDARD. This parameter is optional. The default value is STANDARD.

Type=Archive (Required)
Specifies that you want to define an archive copy group.

DESTination (Required)
Specifies the primary storage pool where the server initially stores the archive copy. You cannot specify a copy storage pool as the destination.

FREQuency=Cmd
Specifies the copy frequency, which must be CMD. This parameter is optional. The default value is CMD.

RETVer
Specifies the number of days to keep an archive copy. This parameter is optional. The default value is 365. Possible values are:

days
Specifies the number of days to keep an archive copy. You can specify an integer from 0 to 9999.

NOLimit
Specifies that you want to keep an archive copy indefinitely.

If you specify NOLIMIT, the server retains archive copies forever, unless a user or administrator deletes the file from server storage.

The value of the RETVER parameter can affect the management class to which the server binds an archived directory. If the client does not use the ARCHMC option, the server binds directories that are archived to the default management class. If the default management class has no archive copy group, the server binds directories that are archived to the management class with the shortest retention period.

MODE=ABSolute
Specifies that a file is always archived when the client requests it. The MODE must be ABSOLUTE. This parameter is optional. The default value is ABSOLUTE.

SERialization
Specifies how TSM handles files that are modified during archive. This parameter is optional. The default value is SHRSTATIC. Possible values are:

SHRSTatic
Specifies that TSM archives a file only if it is not being modified. TSM attempts to perform an archive operation as many as four times, depending on the value specified for the CHANGINGRETRIES client option. If the file is modified during the archive attempt, TSM does not archive the file.

STatic
Specifies that TSM archives a file only if it is not being modified. TSM attempts to perform the archive operation only once.

Platforms that do not support the STATIC option default to SHRSTATIC.

SHRDYnamic
Specifies that if the file is being modified during an archive attempt, TSM archives the file during its last attempt even though the file is being modified. TSM attempts to archive the file as many as four times, depending on the value specified for the CHANGINGRETRIES client option.

DYnamic
Specifies that TSM archives a file on the first attempt, regardless of whether the file is being modified during archive processing.

Attention: Be careful about using the SHRDYNAMIC and DYNAMIC values. These values allow TSM to archive a file while modifications are occurring. As a result, the archive copy might be a fuzzy backup. A fuzzy backup does not accurately reflect what is currently in the file because it contains some, but not all, modifications. If a file that contains a fuzzy backup is retrieved, the file may or may not be usable, depending on the application that uses the file. If a fuzzy backup is not acceptable, be sure to use a serialization value that allows TSM to create an archive copy only if the file is not being modified (SHRSTATIC or STATIC).

Examples

Task

Create an archive copy group named STANDARD for management class MCLASS1 in policy set SUMMER in the PROG1 policy domain. Set the archive destination to ARCHIVEPOOL, where the archive copy is kept for 730 days.

Command:
define copygroup prog1 summer mclass1 standard type=archive destination=archivepool retver=730

Related Commands


Table 45. Commands Related to DEFINE COPYGROUP

Command Description
ASSIGN DEFMGMTCLASS Assigns an existing management class as the default for a specified policy set.
COPY MGMTCLASS Creates a copy of a management class.
DEFINE MGMTCLASS Defines a management class.
DEFINE STGPOOL Defines a storage pool as a named collection of server storage media.
DELETE COPYGROUP Deletes a backup or archive copy group from a policy domain and policy set.
DELETE MGMTCLASS Deletes a management class and its copy groups from a policy domain and policy set.
EXPIRE INVENTORY Manually starts inventory expiration processing.
QUERY COPYGROUP Displays the attributes of an existing copy group.
QUERY MGMTCLASS Displays information about management classes.
UPDATE COPYGROUP Changes one or more attributes of a copy group.


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