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.

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 for 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 with the CLOUDTYPE=AZURE parameter setting, you cannot later change the storage pool type by using the UPDATE STGPOOL command.

GOOGle

Specifies that the connection uses a Google Cloud Storage cloud computing system. If you define a storage pool with the CLOUDTYPE=GOOGLE parameter setting, 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 with the CLOUDTYPE=S3 parameter setting, 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 associated protocol.

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 associated protocol.

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. 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 operation begins.

Tip: For IBM Cloud Object Storage users: To optimize performance, use multiple Accessers. To use more than one IBM Cloud Object Storage Accesser, list the Accesser IP addresses. Separate the IP addresses by a vertical bar (|), without spaces and enclosed by double 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 required.

This parameter is required if you specify the CLOUDTYPE parameter.

IDentity

Specifies the user ID for the cloud provider. The IDENTITY parameter is required for all supported cloud computing systems except Azure and Google. If you specified CLOUDTYPE=AZURE or CLOUDTYPE=GOOGLE, 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

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. If you specified CLOUDTYPE=GOOGLE, do not specify the PASSWORD parameter. This parameter is required for other cloud types. The maximum length of the password is 256 characters. The IDENTITY and PASSWORD parameters are not validated until the first backup operation 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

KEYLocation

Specifies the name of the file that contains the Google Cloud Storage service account key in JavaScript Object Notation (JSON) format. This parameter is required and is valid only if you specify CLOUDTYPE=GOOGLE.

Tip: To help ensure that you can restore the database and recover your storage environment after a disaster, save the key file and the path to the key file in a separate and secure location. Avoid moving the key file because the file might be required later to reestablish the connection between IBM Spectrum® Protect and the cloud object storage.

If the key changes, you must update the connection so that the server can load the new content. To update the key on the server with the key location, issue the UPDATE CONNECTION command and the key will reload.

The maximum length of the key location is 256 characters. You can specify a value that is similar to the following example: /home/tsminst1/spectrumprotectdev-de4bbf31824b.json

BUCKETName

Specifies the name of an AWS S3 or Google Cloud Storage bucket, or an IBM Cloud Object Storage vault to use with this storage pool, instead of using the default bucket name or vault name. This parameter is required and is valid only if you specify CLOUDTYPE=S3 or CLOUDTYPE=GOOGLE.

If a bucket or vault exists with the name that you specify, that bucket or vault is tested to ensure that the proper permissions are set.

Follow the naming restrictions for your cloud provider when you specify this parameter. Ensure that the credentials for this storage pool include permission to read, write, list, and delete objects in this bucket or vault.

If the bucket or vault does not exist, the parameter verifies only that a bucket or vault with that name does not exist. If the command output indicates that the bucket or vault does not exist, work with your cloud service provider to create a bucket or vault with an appropriate name and settings. Permissions are required for reading, writing, listing, and deleting objects.

If you cannot change or view the permissions, and data is not yet written to this bucket, use the UPDATE STGPOOL command. In that command, specify the BUCKETNAME parameter to select a bucket or vault in a storage pool that has the required permission.

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 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. By setting this parameter to a higher value, the references to files in the cloud-container storage pool are still valid when you restore the database to an earlier level.

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

CLOUDSTORAGEClass

Specifies the type of Amazon Simple Storage Service (Amazon S3) or Google Cloud Storage storage class that you are configuring for the storage pool. This parameter is valid only if you specify CLOUDTYPE=S3 or CLOUDTYPE=GOOGLE. This parameter is optional. You can specify the following values, based on your cloud provider:

Default

Specifies that 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 Standard storage class.

AUTOmaticvendortiering

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

NEARLINE

Specifies that data that is uploaded to Google Cloud Storage is sent to the Nearline storage class.