UPDATE STGPOOL (Update a directory-container storage pool)

Use this command to update a directory-container storage pool.

Privilege class

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

Syntax

Read syntax diagramSkip visual syntax diagram UPDate STGpool pool_name DESCription=descriptionACCess=READWriteACCess=READWriteREADOnlyUNAVailableMAXSIze=NOLimitMAXSIze=maximum_file_sizeNOLimitMAXWriters=NOLimitMAXWriters=maximum_writersNOLimitNEXTstgpool=pool_namePROTECTstgpool=target_stgpoolPROTECTLOCalstgpools=,local_target_stgpoolREUsedelay=1REUsedelay=daysENCRypt=YesNoCOMPRession=YesCOMPRession=YesNo

Parameters

pool_name (Required)
Specifies the storage pool to update. This parameter is required. The maximum length of the name is 30 characters.
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 any blank characters. To remove an existing description, specify a null string ("").
ACCess
Specifies how client nodes and server processes access files in 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. This is the default.
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.
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. 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. 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, update 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.

Linux operating systemsWindows operating systemsIf 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 that can run concurrently on the storage pool. Specify a maximum number of I/O threads to control 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 one of 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.
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.
  • Linux operating systemsWindows operating systemsDo 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 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 to update. Separate multiple names with commas and no intervening spaces. The maximum length of each name is 30 characters. This parameter is optional.
To add or remove container-copy storage pools, specify the container-copy storage pool names to include. For example, if the existing container-copy storage pool includes COPY1 and you want to add COPY2, specify PROTECTLOCALSTGPOOLS=COPY1,COPY2. To remove all existing container-copy storage pools that are associated with the primary storage pool, specify a null string (""). For example, COPYSTGPOOLS="".
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. When the value that is specified for the parameter expires, the deduplicated extents are deleted from the directory-container storage pool. The default is 1. Specify one of the following values:
days
Specify an integer in the range 0 - 9999.
1
Specifies that deduplicated extents are deleted from a directory-container storage pool after one day.
Tip: 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.
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.

Example: Update a storage pool to specify a maximum number of data sessions

Update a storage pool that is named STGPOOL1 and specify a maximum of 10 data sessions.
update stgpool stgpool1 maxwriters=10

Example: Update a storage pool to specify the maximum size

Update a storage pool that is named STGPOOL2. The storage pool specifies the maximum file size that the server can store in the storage pool as 100 megabytes.
update stgpool stgpool2 maxsize=100M

Example: Update the description of a storage pool

Update a storage pool that is named STGPOOL3. Remove the existing description from the storage pool.
update stgpool stgpool3 description=""
Table 3. Commands related to UPDATE STGPOOL
Command Description
DEFINE STGPOOL Defines a storage pool as a named collection of server storage media.
DEFINE STGPOOLDIRECTORY Defines a storage pool directory to a directory-container or cloud-container storage pool.
PROTECT STGPOOL Protects a directory-container storage pool.
QUERY CONTAINER Displays information about a container.
QUERY STGPOOL Displays information about storage pools.
REPAIR STGPOOL Repairs a directory-container storage pool.
Linux operating systemsWindows operating systemsAIX operating systemsUPDATE STGPOOLDIRECTORY Changes the attributes of a storage pool directory.