DEFINE DOMAIN (Define a new policy domain)

Use this command to define a new policy domain. A policy domain contains policy sets, management classes, and copy groups. A client is assigned to one policy domain. The ACTIVE policy set in the policy domain determines the rules for clients that are assigned to the domain. The rules control the archive, backup, and space management services that are provided for the clients.

You must activate a policy set in the domain before clients assigned to the policy domain can back up, archive, or migrate files.

Privilege class

To issue this command, you must have system privilege.

Syntax

Read syntax diagramSkip visual syntax diagram DEFine DOmain domain_name DESCription=descriptionBACKRETention=30BACKRETention=daysARCHRETention=365ARCHRETention=daysACTIVEDESTination=,active-data_pool_name

Parameters

domain_name (Required)
Specifies the name of the policy domain to be defined. The maximum length of this name is 30 characters.
DESCription
Specifies a description of the policy domain. 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.
BACKRETention
Specifies the number of days (from the date the backup versions became inactive) to retain backup versions of files that are no longer on the client file system. This parameter is optional. You can specify an integer from 0 to 9999. The default value is 30. 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 default value is 365. 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
This optional parameter specifies the names of active-data pools that store active versions of backup data for nodes that are assigned to the domain. You can specify up to 10 active-data pools for a domain, which is separated by commas. Spaces are not permitted between the names.

Before the IBM Spectrum Protect server writes data to an active-data pool, it verifies that the node owning 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 verifies that the node meets the criteria during backup operations by IBM Spectrum Protect backup-archive clients or by application clients by using the IBM Spectrum Protect API. The verification is also performed when active-data is being copied by using the COPY ACTIVEDATA command.

Example: Define a policy domain

Define a policy domain with a name of PROG1 and the description, Programming Group Domain. Specify that archive copies are retained for 90 days when management classes or archive copy groups are deleted and the default management class does not contain an archive copy group. Also, specify that backup versions are retained for 60 days when management classes or copy groups are deleted and the default management class does not contain a backup copy group.
define domain prog1 
description="Programming Group Domain" 
backretention=60 archretention=90

Related commands

Table 1. Commands related to DEFINE DOMAIN
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
COPY DOMAIN Creates a copy of a policy domain.
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.
UPDATE DOMAIN Changes the attributes of a policy domain.