QUERY CONTAINER (Query a container)

Use this command to display information about one or more containers.

Privilege class

Any administrator can issue this command.

Syntax

Parameters

container_name

Specifies the name of the container. Specify one of the following values:

*: Specifies that an asterisk (*) represents a wildcard character. Use wildcard characters such as an asterisk to match any characters. Alternatively, you can use a question mark (?) or a percent sign (%) to match exactly one character. If you specify an asterisk, all container names are displayed. This value is the default.
container_name: Specifies the name of the container. The maximum length of the file name is 1024.

STGpool

Specifies the name of the directory-container storage pool. This parameter is optional. The maximum length of the storage pool name is 30.

Format

Specifies the level of detail of the query results. This parameter is optional. Specify one of the following values:

Standard: Specifies that a summary of the information is displayed. This value is the default.
Detailed: Specifies that detailed information is displayed.

STate

Specifies the state of the container that is queried. This parameter is optional. Specify one of the following values:

AVAilable: Specifies that only containers that are available are displayed.
UNAvailable: Specifies that only containers that are not available are displayed. For example, a container might be unavailable if the header is corrupted or if the container cannot be opened.
ANY: Specifies that containers in any state are displayed. This value is the default.
REAdonly: Specifies that only containers in a read-only state are displayed. Data in the container can be read but data cannot be written to the container.
PENding: Specifies that only containers in a pending state are displayed.

TYPe

Specifies the type of container that is queried. This parameter is optional. Specify one of the following values:

NONdedup: Displays containers that contain data that is not deduplicated. This type of data includes metadata, encrypted data, and data that is too small for data deduplication.
DEDup: Displays containers that contain deduplicated data.
CLOud: Displays containers that are stored in a cloud storage pool.
ANY: Displays any type of container. This value is the default.

Example: Display information about a container

See Field descriptions for field descriptions.

query container /Containers/09/0000000000000943.ncf

Container                             Storage       Container     State
                                      Pool Name     Type                 
------------------------------------  ------------- ------------  ---------
/Containers/09/0000000000000943.ncf   STGPOOL1      Non Dedup     Available

Example: Display information about a container

See Field descriptions for field descriptions.

query container C:\abc\00\0000000000000005.ncf

Container                         Storage      Container   State
                                  Pool Name    Type                 
------------------------------    -----------  ----------  ---------
C:\abc\00\0000000000000005.ncf    STGPOOL1     Non Dedup   Available

Example: Display detailed information about a container

Display detailed information about containers that contain deduplicated data in storage pool STGPOOL1:

query container stgpool=STGPOOL1 type=dedup format=detail

                            Container: /abc/00/0000000000000001.dcf
                    Storage Pool Name: STGPOOL1
                       Container Type: Dedup
                                State: Available
                    Maximum size (MB): 40,960
                      Free Space (MB): 39,700 
            Approx. Date Last Written: 11/10/2014 15:17:09
              Approx. Date Last Audit:
                           Cloud Type:
                            Cloud URL:
               Cloud Object Size (MB):
                  Space Utilized (MB):
                    Data Extent Count:

Example: Display detailed information about a container

Display detailed information about containers that contain deduplicated data in storage pool STGPOOL1:

query container stgpool=STGPOOL1 type=dedup format=detail

                            Container: C:\abc\00\0000000000000001.dcf
                    Storage Pool Name: STGPOOL1
                       Container Type: Dedup
                                State: Available
                    Maximum size (MB): 40,960
                      Free Space (MB): 39,700
            Approx. Date Last Written: 11/10/2014 15:17:09
              Approx. Date Last Audit:
                           Cloud Type:
                            Cloud URL:
               Cloud Object Size (MB):
                  Space Utilized (MB):
                    Data Extent Count:

Example: Display detailed information about containers that are stored in a cloud storage pool

Display detailed information about containers that are stored in the cloud storage pool CLOUDPOOL:

QUERY CONTAINER stgpool=CLOUDPOOL format=detail

                            Container: mybucket/07d-469a496567b7eb1193800242ac120002-L/000000000000007d.dcf
                    Storage Pool Name: CLOUDPOOL
                       Container Type: Cloud
                                State:
                       Free Space(MB):
                     Maximum Size(MB):
            Approx. Date Last Written: 06/02/21   17:39:52
              Approx. Date Last Audit:
                           Cloud Type: S3
                            Cloud URL: https://icos-accesser1.storage.tucson.ibm.com
               Cloud Object Size (MB): 13
                  Space Utilized (MB): 13

Field descriptions

Container

The name of the container.

Storage Pool Name

The name of the storage pool.

Container Type

The type of container.

State

The state of the data in the container. The field can contain one of the following values:

Available: The container is available for use.
Unavailable: The container cannot be opened or validated.
Tip: Issue the AUDIT CONTAINER command to validate the contents of the container.
Read only: The container can be read but data cannot be written to the container.
Pending: The container is pending deletion. When the value that is specified for the REUSEDELAY parameter expires on the DEFINE STGPOOL or UPDATE STGPOOL command, the container is deleted.

In general, this field does not apply to containers that are stored in cloud-container storage pools. However, if a container in a cloud-container storage pool is moved by using the MOVE CONTAINER command with the DEFRAG=YES setting, the container is in pending state until it is deleted.

Maximum Size (MB)

The maximum size of the container, in megabytes.

This field does not apply to containers that are stored in cloud storage pools.

Free Space (MB)

The total amount of free space that is available in the container, in megabytes.

This field does not apply to containers that are stored in cloud storage pools.

Approx. Date Last Written

The approximate date and time that data was written to the container.

Approx. Date Last Audit

The approximate date and time that data was audited in the container.

Cloud Type

If the container is stored in a cloud storage pool, the type of cloud platform.

Cloud URL

If the container is stored in a cloud storage pool, the URL for accessing the on-premises private cloud or off-premises public cloud.

Cloud Object Size (MB)

The size of the cloud object, in megabytes, if the container is represented by a single object in the cloud-container storage pool.

Space Utilized (MB)

If the container is stored in a cloud storage pool, the amount of space that is used by the container in the on-premises private cloud or off-premises public cloud.

Data Extent Count

If the container is stored in a cloud-container storage pool, the number of data extents that are managed by the on-premises private cloud or off-premises public cloud for the container.

Table 1. Commands related to QUERY CONTAINER
Command	Description
AUDIT CONTAINER	Audit a directory-container storage pool.
MOVE CONTAINER	Moves the contents of a storage pool container to another container.
QUERY DAMAGED	Displays information about damaged files.