UPDATE STGPOOL (Update a cloud-container storage pool)

Privilege class

To issue this command, you must have system privilege, unrestricted storage privilege, or restricted storage privilege.

Parameters

pool_name (Required)

Specifies the storage pool to update. This parameter is required.

DESCription

Specifies a description of the storage pool. This parameter is optional. The maximum length of the description is 255 characters. Enclose the description in double quotation marks if it contains blank characters. To remove an existing description, specify a null string ("").

CLOUDType

Specifies the type of cloud environment for the storage pool. This parameter is optional. Specify one of the following values:

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.

IBMCLoudswift

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

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.

Restriction: If you used the DEFINE STGPOOL command to define a storage pool with the CLOUDTYPE=S3, CLOUDTYPE=AZURE, or CLOUDTYPE=GOOGLE parameter setting, you cannot change to a different cloud type by using the UPDATE STGPOOL command. Additionally, you cannot change the following cloud types by using the UPDATE STGPOOL command:

• A non-S3 storage pool to S3
• A non-Azure storage pool to Azure
• A non-Google storage pool to Google

CLOUDUrl

Specifies the URL of the cloud environment. Based on your cloud provider, you can use a 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.

To obtain the value of the CLOUDURL parameter, follow the instructions for obtaining configuration information for cloud service providers, as described in Configuring a cloud-container storage pool for data storage .

Tip: To help 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, enclosed in 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.

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 your cloud provider. If you specified CLOUDTYPE=GOOGLE, do not specify the PASSWORD 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 optional. 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 storage.This parameter is optional. 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 valid only if you specified the CLOUDTYPE=GOOGLE parameter setting. You can specify a value that is similar to the following example: /home/tsminst1/spectrumprotectdev-de4bbf31824b.json

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.

BUCKETName

Specifies the name of an Amazon Web Services (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 optional and is valid only if this storage pool has a cloud type of S3 or Google.

Restriction: You cannot change the bucket or vault if any cloud containers exist in this storage pool.

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.

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.

ACCess

Specifies how client nodes and server processes access the storage pool. This parameter is optional. You can specify one of the following values:

READWrite

Specifies that client nodes and server processes can read and write to the storage pool.

READOnly

Specifies that client nodes and server processes can only read from the storage pool.

UNAVailable

Specifies that client nodes and server processes cannot access the storage pool. As a result, backup and restore operations fail for this storage pool. You can use this value to specify that the cloud service provider is temporarily unavailable.

DESTroyed

Specifies that client nodes and server processes cannot access the storage pool because the cloud service provider is permanently unavailable. Backup and restore operations fail for this storage pool, but attempts to delete objects and containers from this storage pool can finish successfully.

MAXWriters

Specifies the maximum number of writing sessions that can run concurrently on the 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. 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 storage pool. This parameter controls the duration that deduplicated extents are associated with a cloud storage pool. When the value that is specified for the parameter expires, the deduplicated extents are deleted from the cloud storage pool. This parameter is optional. You can specify one of the following values:

1

Specifies that deduplicated extents are deleted from a cloud storage pool after one day.

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, you can ensure that when you restore the database to an earlier level, the references to files in the storage pool are still valid.

ENCRypt

Specifies whether the server encrypts client data before it writes the data 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 premises, 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 AWS S3 or Google Cloud Storage storage class that you are configuring for the storage pool. This parameter is valid if you specify CLOUDTYPE=S3, using an AWS S3 solution. The parameter is ignored for other, non-AWS S3 types.

This parameter is also valid if you specify 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.

Tip:

If you update the CLOUDSTORAGECLASS parameter value (by issuing the UPDATE STGPOOL command), the updated value applies only to data that is yet to be uploaded. The storage class of data that is already uploaded to Google Cloud Storage or Amazon S3 storage is not affected.

CLOUDReadcache

Specifies whether a cloud-container storage pool has an enabled or disabled read cache. This parameter is optional and valid only for non-Swift cloud types. 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.