DEFINE OBJECTDOMAIN (Define a policy domain for object clients)

Edit online

Use this command to define a policy domain for object clients. An object policy domain contains policy sets, management classes, and copy groups. The rules that are defined by the policy domain control the backup services that are provided to clients. Each object client is assigned to one policy domain.

You can specify the storage pool to be used for the policy domain as a container storage pool. If the object client is IBM Storage Protect Plus, you can specify a container storage pool, a cold-data-cache storage pool, or both.

When you define the object policy domain, you can choose whether to specify a storage pool. If you choose not to, the object policy domain is created, but a copy group is not specified and you must define the copy group for the policy domain manually. To define the copy group for the policy domain manually, you issue the DEFINE COPYGROUP command.

To delete an object policy domain and the associated policy sets, management classes, and copy groups, issue the DELETE DOMAIN command.

Privilege class

To issue this command, you must have system privilege.

Syntax

Read syntax diagramSkip visual syntax diagram DEFine OBJECTDomain domain_name STANDARDPool=pool_nameCOLDPool=pool_name1
Notes:
  • 1 This parameter applies only to IBM Storage Protect Plus.

Parameters

domain_name (Required)
Specifies the name of the policy domain to be defined. The maximum length of this name is 30 characters.
STANDARDPool
Specifies the storage pool that will be used as the destination for requests from the object client. The data is sent to the IBM Storage Protect server from the Amazon Simple Storage Service (S3) Standard storage class by using the S3 protocol. You must specify an existing storage pool. The name of the storage pool must be unique, and the maximum length is 30 characters. This parameter is optional.
Restriction: If you do not specify the STANDARDPOOL parameter, the object domain cannot receive requests from the S3 Standard storage class.
COLDPool
This parameter applies only to IBM Storage Protect Plus. Specifies the storage pool that will be used as the destination for requests from the object client. The data is sent to the IBM Storage Protect server from an Amazon S3 Glacier Flexible Retrieval (formerly Amazon S3 Glacier) storage class by using the S3 protocol. You must specify an existing storage pool. The name of the storage pool must be unique, and the maximum length is 30 characters. This parameter is optional.
Restriction: If you do not specify the COLDPOOL parameter, the object domain cannot receive requests from the Amazon S3 Glacier Flexible Retrieval (formerly Amazon S3 Glacier) storage class.

Example for IBM Storage Protect Plus: Define an object client policy domain with only a cold-data-cache storage pool permitted for the object client

Define an object client policy domain with the name COLD1. Specify a cold-data-cache storage pool with the name COLDCACHEPOOL1.
define objectdomain cold1 coldpool=coldcachepool1

Example: Define an object client policy domain with a container storage pool

Define an object client policy domain with the name OBJECTDOMAIN1. Specify a cloud-container storage pool.
define objectdomain objectdomain1 standardpool=cloudcontainerpool25

Related commands

Table 1. Command related to DEFINE OBJECTDOMAIN
Command Description
DELETE DOMAIN Deletes a policy domain along with any policy objects in the policy domain.
UPDATE OBJECTDOMAIN Changes the attributes of a policy domain that is associated with an object client.