DEFINE STGPOOL (Define a directory-container storage pool)

Privilege class

To issue this command, you must have system privilege.

Parameters

pool_name (Required)

Specifies the storage pool to define. This parameter is required. The maximum length of the name is 30 characters.

STGType=DIrectory (Required)

Specifies the type of storage that you want to define for a storage pool. This parameter specifies that a directory-container type of storage pool is assigned to the storage pool. You must define a storage pool directory for this type of storage pool by using the DEFINE STGPOOLDIRECTORY command.

Requirements:

• Ensure that enough space is available on the file system for the directory-container storage pool.
• You must store the directory-container storage pool and the Db2® database on separate mount points on the file system. The directory-container storage pool might grow to occupy all the space on the directory it is stored on.
• You must use a file system other than the file system where the IBM Spectrum® Protect server is located.

POoltype=PRimary

Specifies that you want the storage pool to be used as a primary storage pool. This parameter is optional.

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.

ACCess

Specifies how client nodes and server processes can 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.

MAXSIze

Specifies the maximum size for a physical file that the server can store in the storage pool. 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 storage pool.

maximum_file_size

Limits the maximum physical file size. Specify an integer in the range 1 - 999999, followed by a scale factor. For example, MAXSIZE=5G specifies that the maximum file size for this storage pool is 5 GB. You can use one of the following scale factors:

Table 1. Scale factor for the maximum file size

Scale factor	Meaning
K	kilobyte
M	megabyte
G	gigabyte
T	terabyte

Tip: If you do not specify a unit of measurement for the maximum file size, the value is specified in bytes.

When the physical size of the storage pool exceeds the MAXSIZE parameter, the following table shows where files are typically stored.

Table 2. The location of a file according to the file size and the pool that is specified

Pool that is specified	Result
No pool is specified as the next storage pool in the hierarchy.	The server does not store the file.
A pool is specified as the next storage pool in the hierarchy.	The server stores the file in the storage pool that you specified.

Tip: If you also specify the NEXTstgpool parameter, define one storage pool in your hierarchy to have no limit on the maximum file size by specifying the MAXSIze=NOLimit parameter. When you have at least one pool with no size limit, you ensure that no matter what its size, the server can store the file.

For multiple files that are sent during data deduplication processing, the server considers the size of the data deduplication process to be the file size. If the total size of all files in the process is larger than the maximum size limit, the server does not store the files in the storage pool.

If the file size from an object client node exceeds the MAXSIZE parameter, file backup will fail.

MAXWriters

Specifies the maximum number of I/O threads for the following processes:

• The number of I/O threads that can run concurrently on the directory-container storage pool.
• The number of I/O threads that are written simultaneously to the directory-container storage pool.

This parameter is optional. As a best practice, use the default value of NOLIMIT. You can specify the following values:

NOLimit

Specifies that no maximum number of I/O threads are written to the storage pool.

maximum_writers

Limits the maximum number of I/O threads that you can use. Specify an integer in the range 1 - 99999.

Tip: The IBM Spectrum Protect server manages the number of I/O threads automatically based on the resources that are available and the server load.

NEXTstgpool

Specifies the name of a random-access or primary sequential storage pool to which files are stored when the directory-container storage pool is full. This parameter is optional.

Restrictions:

• To ensure that you do not create a chain of storage pools that leads to an endless loop, specify at least one storage pool in the hierarchy with no value.
• If you specify a sequential-access pool as the next storage pool, the pool must be in either NATIVE or NONBLOCK data format.
• Do not specify a directory-container or cloud-container storage pool.
• Do not use this parameter to specify a storage pool for data migration.
• Do not use this parameter to store data from object client nodes. If the directory-container storage pool becomes full while writing object client data, the object client backup will fail.

PROTECTstgpool

Specifies the name of the directory-container storage pool on the target replication server where the data is backed up when you use the PROTECT STGPOOL command for this storage pool. This parameter is optional.

PROTECTLOCalstgpools

Specifies the name of the container-copy storage pool on a local device where the data is backed up. This container-copy storage pool will be a local target storage pool when you use the PROTECT STGPOOL command. You can specify a maximum of two container-copy storage pool names. Separate multiple names with commas and no intervening spaces. The maximum length of each name is 30 characters. This parameter is optional.

REUsedelay

Specifies the number of days that must elapse before all deduplicated extents are removed from a directory-container storage pool. This parameter controls the duration that deduplicated extents are associated with a directory-container storage pool after they are no longer referenced. When the value that is specified for the parameter expires, the deduplicated extents are deleted from the directory-container storage pool. Specify an integer in the range 0 - 9999. The default value for directory-container storage pools is 1, which means that deduplicated extents that are no longer referenced are deleted from a directory-container storage pool after 1 day.

Set this parameter to a value greater than the number that is specified as your database backup period to ensure that data extents are still valid when you restore the database to another level.

ENCRypt

Specifies whether the server encrypts client data before the server 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 is the default value.

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.