UPDATE STGPOOL (Update a cloud-container storage pool)
Use this command to update a container storage pool in a cloud environment. Cloud storage pools are not supported on Linux® on System z®.
The preferred way to define and configure a cloud-container storage pool is to use the Operations Center. For instructions and tips for the Operations Center and the command-line interface, see Configuring a cloud-container storage pool for data storage.
Privilege class
To issue this command, you must have system privilege, unrestricted storage privilege, or restricted storage privilege.
Syntax
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 quotation marks if it contains blank characters. To remove an existing description, specify a null string ("").
- CLOUDType
- Specifies the type of cloud environment where you are configuring a storage pool. This parameter is optional. Specify one of the following values:
- CLOUDUrl
- Specifies the URL of the cloud environment where you are configuring the storage pool. 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 begins.
- 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
- 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 optional. 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. You can specify one of the following values:
- OFfpremise
- ONpremise
- BUCKETName
- Specifies the name for an Amazon Web Services (AWS) bucket or IBM Cloud Object
Storage vault to use with this
storage pool. AWS buckets and IBM Cloud Object
Storage vaults are used in the same manner as containers in a cloud-container
storage pool. This parameter is optional, and is valid only if this storage pool has a cloud type of
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 ensure
that the credentials for this storage pool have permission to read, write, list, and delete objects
in this bucket or vault.Restriction: You cannot change the bucket or vault if any cloud containers exist in this storage pool.
- 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 read only from the storage pool.
- UNAVailable
- Specifies that client nodes and server processes cannot access the storage pool. As a result, backups and restore 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. Backups and restores fail for this storage pool, but any attempts to delete objects and containers from this storage pool finish successfully.
- MAXWriters
- Specifies the maximum number of writing sessions that can run concurrently on the storage pool.
Specify a maximum number of writing sessions to control the performance of the cloud storage pool
from negatively impacting other system resources. This parameter is optional. 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 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 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.
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 Amazon S3 storage is not affected.
Example 1: Update a cloud storage pool to specify a maximum number of data sessions
Update a cloud storage pool that is named STGPOOL1 and specify a maximum of 10 data sessions.update stgpool stgpool1 maxwriters=10
Example 2: Update the description of a cloud-container storage pool
Update a cloud-container storage pool that is named STGPOOL2. Remove the existing description from the storage pool.update stgpool stgpool2 cloudurl=http://123.234.123.234:5000/v2.0
identity=admin:admin password=protect8991 description=""