DEFINE STGPOOL (Define a cloud-container storage pool)

Privilege class

To issue this command, you must have system privilege.

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.

Tip: To optimize performance, set up one or more local storage directories to temporarily hold data that is moving to the cloud. After you define a cloud-container storage pool, use the DEFINE STGPOOLDIRECTORY command to assign local directories to the cloud-container storage pool.

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.

CLOUDType

Specifies the type of cloud environment where you are configuring the storage pool.

You can specify one of the following values:

AZure

Specifies that the storage pool uses a Microsoft Azure cloud computing system. If you define a storage pool as using Azure with this parameter, you cannot later change the storage pool type by using the UPDATE STGPOOL command.

S3

Specifies that the storage pool uses a cloud computing system with the Simple Storage Service (S3) protocol, such as IBM® Cloud Object Storage or Amazon Web Services (AWS) S3. If you define a storage pool as using S3 with this parameter, you cannot later change the storage pool type by using the UPDATE STGPOOL command.

IBMCLoudswift

Specifies that the storage pool uses an IBM Cloud cloud computing system with an OpenStack Swift cloud computing system.

SWift

Specifies that the storage pool uses an OpenStack Swift cloud computing system. This value also specifies that the storage pool uses Version 2 of the protocol for authentication to the cloud. The URL of the cloud usually contains the version number of the protocol that it is using.

V1Swift

Specifies that the storage pool uses an OpenStack Swift cloud computing system. This value also specifies that the storage pool uses Version 1 of the protocol for authentication to the cloud. The URL of the cloud usually contains the version number of the protocol that it is using.

This parameter is optional. If you do not specify the parameter, the default value, SWIFT, is used.

CLOUDUrl

Specifies the URL of the cloud environment where you are configuring the storage pool. Based on your cloud provider, you can use a blob service endpoint, region endpoint URL, an Accesser® IP address, a public authentication endpoint, or a similar value for this parameter. Be sure to include the protocol, such as https:// or http://, at the beginning of the URL. The maximum length of the web address is 870 characters. The CLOUDURL parameter is not validated until the first backup begins.

Tip: To optimize performance, use multiple Accessers. To use more than one IBM Cloud Object Storage Accesser, list the Accesser IP addresses separated by a vertical bar (|), with no spaces, surrounded by quotation marks, as in the following example:

cloudurl="accesser_ur1|accesser_url2|accesser_url3"

If you are using the IBM Cloud S3 solution, only one Accesser is needed.

This parameter is required if you specify the CLOUDTYPE parameter.

• AZure
• S3 (Simple Storage Service)
• IBMCLoudswift
• SWift
• V1Swift

IDentity

Specifies the user ID for the cloud that is specified in the STGTYPE=CLOUD parameter. This parameter is required for all supported cloud computing systems except Azure. If you specified CLOUDTYPE=AZURE, do not specify the IDENTITY parameter. Based on your cloud provider, you can use an access key ID, a user name, a tenant name and user name, or a similar value for this parameter. The maximum length of the user ID is 255 characters.

PAssword (Required)

Specifies the password for the cloud that is specified in the STGTYPE=CLOUD parameter. Based on your cloud provider, you can use a shared access signature (SAS) token, secret access key, an API key, a password, or a similar value for this parameter. This parameter is required. The maximum length of the password is 256 characters. The IDENTITY and PASSWORD parameters are not validated until the first backup begins.

CLOUDLocation

Specifies the physical location of the cloud that is specified in the CLOUD parameter. This parameter is optional. The default value is OFFPREMISE. You can specify one of the following values:

• OFfpremise
• ONpremise

BUCKETName

Specifies the name for an AWS S3 bucket or a IBM Cloud Object Storage vault to use with this storage pool, instead of using the default bucket name or vault name. This parameter is optional, and is valid only if you specify CLOUDTYPE=S3. If the name that you specify does not exist, the server creates a bucket or vault with the specified name before using the bucket or vault. Follow the naming restrictions for your cloud provider when specifying this parameter. Review the permissions for the bucket or vault and make sure that the credentials for this storage pool have permission to read, write, list, and delete objects in this bucket or vault. If you do not have the ability to change or view the permissions, and you have not already written data to this storage pool, use the UPDATE STGPOOL command with the BUCKETNAME parameter to use a different bucket or vault.

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 read only 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. Specify a maximum number of writing sessions to control the performance of the cloud-container storage pool from negatively impacting other system resources. This parameter is optional. The default value is NOLIMIT. You can specify one of the following values:

NOLimit

Specifies that no maximum size 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 must elapse after all deduplicated extents are removed from a cloud-container storage pool. This parameter controls the duration that deduplicated extents are associated with a cloud-container storage pool. When the value that is specified for the parameter expires, the deduplicated extents are deleted from the cloud-container storage pool. The default is 1. You can specify one of the following values:

1

Specifies that deduplicated extents are deleted from a cloud-container storage pool after one day. This value is the default.

days

You can specify an integer in the range 0 - 9999.

Tip: Set this parameter to a value that is greater than the number specified for the SET DRMDBBACKUPEXPIREDAYS command. If you set this parameter to a higher value, you can ensure that when you restore the database to an earlier level, the references to files in the cloud-container storage pool are still valid.

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 depends on the physical location of the cloud, which is specified by the CLOUDLOCATION parameter. If the cloud is off premise, the server encrypts data by default. If the cloud is on premises, the server does not encrypt data by default.

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 is the default.

CLOUDSTORAGEClass

Specifies the type of Amazon Simple Storage Service (Amazon S3) storage class that you are configuring for the storage pool. This parameter is valid only if you specify CLOUDTYPE=S3. This parameter is optional. You can specify the following values:

Default

Specifies that data that is uploaded to Amazon S3 storage is sent to the S3 Standard storage class.

AUTOmaticvendortiering

Specifies that data that is uploaded to Amazon S3 storage is sent to the S3 Intelligent-Tiering storage class.