DEFINE STGPOOL (Define a cloud-container storage pool)

Use this command to define a container storage pool in a cloud environment. This type of storage pool is used for data deduplication. Cloud-container storage pools are not supported on Linux® on System z®.

Tip: To help optimize backup and archive performance, set up one or more local storage directories to temporarily hold data that IBM Spectrum Protect is transferring to the cloud. After you use the DEFINE STGPOOL command to define a cloud-container storage pool, use the DEFINE STGPOOLDIRECTORY command to assign local storage directories to the cloud-container storage pool.

Privilege class

To issue this command, you must have system privilege.

Syntax

Read syntax diagramSkip visual syntax diagram DEFine STGpool pool_name STGType = CLoud CONNection = connection_name POoltype=PRimaryPOoltype=PRimaryDESCription=descriptionACCess=READWriteACCess=READWriteREADOnlyUNAVailableMAXWriters=NOLimitMAXWriters=NOLimitmaximum_writersREUsedelay=1REUsedelay=daysENCRypt=YesENCRypt=YesNoCOMPRession=YesCOMPRession=YesNoCLOUDSTORAGEClass=DefaultCLOUDSTORAGEClass=DefaultAUTOmaticvendortieringNEARLINECOLDLINEARchiveGLACIER_IRCLOUDReadcache=OFfCLOUDReadcache=OFfONONPreferingestENABLECLOUDDATALock=NoENABLECLOUDDATALock=YesNoCLOUDDATALOCKDURation=0CLOUDDATALOCKDURation=days

Parameters

pool_name (Required)
Specifies the cloud-container storage pool to define. This parameter is required. The maximum length of the name is 30 characters.
STGType=CLoud (Required)
Specifies the type of storage that you want to define for a cloud-container storage pool. To ensure that the storage pool can be used in a cloud environment, you must specify STGTYPE=CLOUD.
CONNection (Required)
Specifies the name of the defined connection that contains details such as the cloud URL and cloud type. This parameter is required.
POoltype=PRimary
Specifies that you want to define a primary storage pool. This parameter is optional.
DESCription
Specifies a description of the cloud-container storage pool. This parameter is optional. The maximum length of the description is 255 characters. Enclose the description in quotation marks if it contains blank characters.
ACCess
Specifies how client nodes and server processes access the cloud-container storage pool. This parameter is optional. The default value is READWRITE. You can specify one of the following values:
READWrite
Specifies that client nodes and server processes can read and write to the cloud-container storage pool. This value is the default.
READOnly
Specifies that client nodes and server processes can only read from the cloud-container storage pool.
UNAVailable
Specifies that client nodes and server processes cannot access the cloud-container storage pool.
MAXWriters
Specifies the maximum number of writing sessions that can run concurrently on the cloud-container storage pool. By limiting the number of writing sessions, you can help to ensure that write operations do not negatively impact other system resources and system performance. This parameter is optional. The default value is NOLIMIT. You can specify one of the following values:
NOLimit
Specifies that no limit exists for the number of writers that you can use. This value is the default.
maximum_writers
Limits the maximum number of writers that you can use. Specify an integer in the range 1 - 99999.
REUsedelay
Specifies the number of days that the server retains deduplicated extents that are no longer referenced by the cloud-container storage pool. After the specified time elapses, the deduplicated extents are deleted from the server. Deduplicated extents are required to ensure that files can be recovered from the server database from the point in time of a database restore operation. This parameter is optional. The default value is 1.
days
Specifies the number of days after which deduplicated extents are deleted from the server. You can specify an integer in the range 1 - 9999.
Tips:
  • If you used the SET DRMDBBACKUPEXPIREDAYS command to specify the expiration period for a database backup series, set the REUSEDELAY parameter to a value that exceeds the expiration period. In this way, you can help to ensure that references to files in the storage pool will be valid if you restore the server database from a backup.
  • If you did not use the SET DRMDBBACKUPEXPIREDAYS command to specify an expiration period, set the REUSEDELAY parameter to a value that is equal to or greater than the number of days that you retain database backups. For example, if you retain database backups for 7 days, you can set the value to 7.
ENCRypt
Specifies whether the server encrypts client data before it writes it to the storage pool. You can specify the following values:
Yes
Specifies that client data is encrypted by the server by using 256-bit Advanced Encryption Standard (AES) data encryption.
No
Specifies that client data is not encrypted by the server.

This parameter is optional. The default is YES.

Attention: Unencrypted data does not have data privacy and integrity protections against unauthorized users who gain access to the data.

Changing the ENCRYPT parameter value affects only data that is written to the storage pool after the value is changed. For example, if the ENCRYPT parameter value is NO, and you change the value to YES, the existing data in the storage pool remains in an unencrypted state. Only new data that is written to the storage pool is encrypted.

COMPRession
Specifies whether data is compressed in the storage pool. This parameter is optional. You can specify one of the following values:
No
Specifies that data is not compressed in the storage pool.
Yes
Specifies that data is compressed in the storage pool. This value is the default.
CLOUDSTORAGEClass
Specifies the type of Amazon Web Services (AWS) with Simple Storage Service (S3) or Google Cloud Storage storage class for the storage pool. This parameter is optional. You can specify the following values, based on your cloud provider:
Default
Specifies that the data that is uploaded to Amazon S3 storage is sent to the S3 Standard storage class. Data that is uploaded to Google Cloud Storage is sent to the Google Cloud Storage Standard storage class.
AUTOmaticvendortiering
Specifies that the data that is uploaded to Amazon S3 storage is sent to the S3 Intelligent-Tiering storage class.
NEARLINE
Specifies that the data that is uploaded to Google Cloud Storage is sent to the Nearline storage class.
COLDLINE
Specifies that the data that is uploaded to Google Cloud Storage is sent to the Coldline storage class. This storage class exists for a specific time interval and is intended only for data that is not frequently read. For more information, see the Google Cloud Storage documentation.
ARchive
Specifies that the data that is uploaded to Google Cloud Storage is sent to the Archive storage class. This storage class exists for extended time periods and is intended only for data that is rarely accessed. You can run reclamation operations against storage pools with the Archive storage class, but you might incur additional storage fees. You must also ensure that data retention policies are set so that the data remains in the storage pool for at least one year. Using this cloud storage class with cloud reclamation or brief data retention periods might result in additional charges from Google. You must understand the data life cycle before using this storage class. For more information, see the Google Cloud Storage documentation.
GLACIER_IR
Specifies that the data that is uploaded to Amazon S3 storage is sent to the S3 Glacier Instant Retrieval storage class.
CLOUDReadcache
Specifies whether a cloud-container storage pool has an enabled or disabled read cache. This parameter is optional. You can specify the following values:
OFf
Specifies that the read cache is disabled. This value is the default.
ON
Specifies that the read cache is enabled.
ONPreferingest
Specifies that the read cache is enabled. If ingested data has an out-of-space issue for a storage pool directory, the read cache data is removed from that directory and read caching pauses for 60 seconds.
ENABLECLOUDDATALock
Specifies whether the data in the storage pool which is stored in the cloud gets locked. This parameter is optional. You can specify one of the following values:
No
Specifies that the data is not lock enabled in the storage pool. This value is the default.
Yes
Specifies that the data is lock enabled in the storage pool.
CLOUDDATALOCKDURation

Specifies the number of days for which the server retains cloud-container storage pool data. After the specified time elapses, the data might get deleted from the storage pool. This parameter is optional. The default value is 0.

days
Specifies the number of days after which deduplicated extents are deleted from the server. You can specify an integer in the range 0 - 36525.

Example 1: Define a cloud-container primary storage pool

Define a cloud-container primary storage pool that is named STGPOOL1.
define stgpool stgpool1 stgtype=cloud connection=serverone pooltype=primary

Example 2: Define a cloud-container storage pool with 99 writing sessions

Define a cloud-container storage pool that is named STGPOOL5 with 99 writing sessions.
define stgpool stgpool5 stgtype=cloud connection=serverone maxwr=99

Example 3: Define a cloud-container storage pool in which deduplicated extents are deleted after two days

Define a cloud-container storage pool that is named STGPOOL1 and deduplicated extents are deleted after two days.
define stgpool stgpool1 stgtype=cloud connection=serverone reusedelay=2
Table 1. Commands related to DEFINE STGPOOL
Command Description
DEFINE CONNECTION Defines a connection to back up the server database to a cloud provider.
UPDATE STGPOOL (cloud-container) Update a cloud-container storage pool.