IBM Tivoli Storage Manager, Version 7.1

UPDATE DOMAIN (Update a policy domain)

Use this command to change a policy domain.

Privilege class

To issue this command, you must have system privilege, unrestricted policy privilege, or restricted policy privilege for the specified policy domain.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-UPDate DOmain--domain_name----------------------------------->

>--+-----------------------------+------------------------------>
   '-DESCription--=--description-'   

>--+------------------------+--+------------------------+------->
   '-BACKRETention--=--days-'  '-ARCHRETention--=--days-'   

>--+-----------------------------------------------------+-----><
   |                       .-,-------------------------. |   
   |                       V                           | |   
   '-ACTIVEDESTination--=------active-data_pool_name---+-'   

Parameters

domain_name (Required)
Specifies the name of the policy domain.
DESCription
Describes the policy domain by using a text string. This parameter is optional. The maximum length of the description is 255 characters. Enclose the description in quotation marks if it contains any blank characters. To remove a previously defined description, specify a null string ("").
BACKRETention
Specifies the number of days (from the date the backup versions became inactive) to retain backup versions that are no longer on the client file system. This parameter is optional. You can specify an integer from 0 to 9999. The server uses the backup retention value to manage inactive versions of files when any of the following conditions occur:
  • A file is rebound to a new management class, but the new management class and the default management class do not contain a backup copy group.
  • The management class to which a file is bound, no longer exists. The default management class does not contain a backup copy group.
  • The backup copy group is deleted from the management class to which a file is bound. The default management class does not contain a backup copy group.
ARCHRETention
Specifies the number of days (from the date of archive) to retain archive copies. This parameter is optional. You can specify an integer from 0 to 30000. The server uses the archive retention value to manage archive copies of files when either of the following conditions occur:
  • The management class to which a file is bound, no longer exists. The default management class does not contain an archive copy group.
  • The archive copy group is deleted from the management class to which a file is bound. The default management class does not contain an archive copy group.
ACTIVEDESTination
Specifies the names of active-data pools that store active versions of backup data for nodes that are assigned to the domain. This parameter is optional. Spaces between the names of the active-data pools are not permitted. You cannot specify more than 10 active-data pools for a domain.

Before the Tivoli® Storage Manager server writes data to an active-data pool, it verifies that the node that owns the data is assigned to a domain that has the active-data pool that is listed in the ACTIVEDESTINATION list. If the server verifies that the node meets this criteria, the data is stored in the active-data pool. If the node does not meet the criteria, then the data is not stored in the active-data pool. If the simultaneous-write function is used to write data to an active-data pool, the server completes the verification during backup operations by Tivoli Storage Manager backup-archive clients or by application clients by using the Tivoli Storage Manager API. The verification is also done when active-data is being copied by using the COPY ACTIVEDATA command.

Example: Update the backup retention period for a policy domain

For the EMPLOYEE_RECORDS policy domain, set the backup retention to 45 days and the archive retention to 75 days.
update domain employee_records 
backretention=45 archretention=75

Related commands

Table 1. Commands related to UPDATE DOMAIN
Command Description
COPY DOMAIN Creates a copy of a policy domain.
DEFINE DOMAIN Defines a policy domain that clients can be assigned to.
DEFINE POLICYSET Defines a policy set within the specified policy domain.
DELETE DOMAIN Deletes a policy domain along with any policy objects in the policy domain.
QUERY DOMAIN Displays information about policy domains.


Feedback