AIX operating systemsLinux operating systemsOracle Solaris operating systemsWindows operating systems

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 storage pools are not supported on Linux on Power Systems™ and Linux on System z®.

Privilege class

To issue this command, you must have system privilege.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-DEFine STGPOOL--pool_name--STGType--=--CLoud----------------->

   .-POoltype--=--PRimary-.                                    
>--+----------------------+--+-----------------------------+---->
   '-POoltype--=--PRimary-'  '-DESCription--=--description-'   

   .-CLOUDType--=--SWift---------.   
>--+-----------------------------+------------------------------>
   '-CLOUDType--=--+-SWift-----+-'   
                   +-SOftlayer-+     
                   '-V1Swift---'     

>--+------------------------+--IDentity--=--cloud_identity------>
   '-CLOUDUrl--=--cloud_url-'                                

>--PAssword--=--password---------------------------------------->

   .-CLOUDLocation--=--OFfpremise-----.   
>--+----------------------------------+------------------------->
   '-CLOUDLocation--=--+-OFfpremise-+-'   
                       '-ONpremise--'     

   .-ACCess--=--READWrite-------.   
>--+----------------------------+------------------------------->
   '-ACCess--=--+-READWrite---+-'   
                +-READOnly----+     
                '-UNAVailable-'     

   .-MAXWriters--=--NOLimit-------------.   
>--+------------------------------------+----------------------->
   '-MAXWriters--=--+-NOLimit---------+-'   
                    '-maximum_writers-'     

   .-REUsedelay--=--1----.  .-ENCRypt--=--Yes---------.   
>--+---------------------+--+-------------------------+--------><
   '-REUsedelay--=--days-'  |                     (1) |   
                            '-ENCRypt--=--+-Yes-+-----'   
                                          '-No--'         

Notes:
  1. The default value of the ENCRYPT parameter is conditional. The server encrypts data by default if the CLOUDLOCATION parameter is set to OFFPREMISE. If the CLOUDLOCATION parameter is set to ONPREMISE, the default is No.

Parameters

pool_name (Required)
Specifies the cloud 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 storage pool. This parameter specifies that only a storage pool in a cloud environment can be assigned to the 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 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 where you are configuring the storage pool. You can specify one of the following values:
SOftlayer
Specifies that the storage pool uses a SoftLayer 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 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 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 where you are configuring the storage pool. The maximum length of the web address is 255 characters.
This parameter is required if you specify the following CLOUDTYPE values:
  • SOftlayer
  • SWift
  • V1Swift
IDentity(Required)
Specifies the user ID for the cloud that is specified in the CLoud parameter. This parameter is required. The maximum length of the user ID is 255 characters.
PAssword(Required)
Specifies the password for the cloud that is specified in the CLoud parameter. This parameter is required. The maximum length of the password is 255 characters.
CLOUDLocation(Required)
Specifies the physical location of the cloud that is specified in the CLOUD parameter. This parameter is required. You can specify one of the following values:
  • OFfpremise
  • ONpremise
ACCess
Specifies how client nodes and server processes access the cloud 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 storage pool. This value is the default.
READOnly
Specifies that client nodes and server processes can read only from the cloud storage pool.
UNAVailable
Specifies that client nodes and server processes cannot access the cloud storage pool.
MAXWriters
Specifies the maximum number of writing sessions that can run concurrently on the cloud 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. The default value is NOLimit. You can specify one of the following values:
NOLimit
Specifies that there is no maximum size limit for physical files that are stored in the cloud storage pool. 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. The default is 1. You can specify one of the following values:
1
Specifies that deduplicated extents are deleted from a cloud storage pool after one day. This value is the default.
days
You can specify an integer 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 cloud 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.
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 premise, the server does not encrypt data by default.

Example 1: Define an OpenStack Swift cloud storage pool

Define an OpenStack Swift cloud storage pool that is named STGPOOL1.
define stgpool stgpool1 stgtype=cloud 
cloudtype=swift cloudurl=http://123.456.789:5000/v2.0
identity=admin:admin password=password description="OpenStack Swift cloud"

Example 2: Define a cloud primary storage pool

Define a cloud primary storage pool that is named STGPOOL1.
define stgpool stgpool1 stgtype=cloud 
cloudtype=swift cloudurl=http://123.456.789:5000/v2.0
identity=admin:admin password=password pooltype=primary

Example 3: Define a cloud storage pool with read only access

Define a cloud storage pool that is named STGPOOL1 with read only access.
define stgpool stgpool1 stgtype=cloud 
cloudtype=swift cloudurl=http://123.456.789:5000/v2.0
identity=admin:admin password=password access=readonly

Example 4: Define a cloud storage pool with 99 writing sessions

Define a cloud storage pool that is named STGPOOL1 with 99 writing sessions.
define stgpool stgpool1 stgtype=cloud 
cloudtype=swift cloudurl=http://123.456.789:5000/v2.0
identity=admin:admin password=password maxwr=99

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

Define a cloud storage pool that is named STGPOOL1 and deduplicated extents are deleted after two days.
define stgpool stgpool1 stgtype=cloud 
cloudtype=swift cloudurl=http://123.456.789:5000/v2.0
identity=admin:admin password=password reusedelay=2