QUERY STGRULE (Display storage rule information)

Use this command to display information about storage rules that are defined for storage pools.

Privilege class

Any administrator can issue this command.

Syntax


                  .-*---------.  .-Format--=--Standard-----.   
>>-Query STGRULE--+-----------+--+-------------------------+---->
                  '-rule_name-'  '-Format--=--+-Standard-+-'   
                                              '-Detailed-'     

   .-ACTiontype--=--ANY---------------.   
>--+----------------------------------+------------------------->
   '-ACTiontype--=--+-ANY-----------+-'   
                    +-AUDit---------+     
                    +-GENdedupstats-+     
                    +-REClaim-------+     
                    +-TIERBYAge-----+     
                    +-TIERBYState---+     
                    '-NOTiering-----'     

   .-ACTIVE--=--ANY-----.   
>--+--------------------+--------------------------------------><
   '-ACTIVE--=--+-ANY-+-'   
                +-Yes-+     
                '-No--'

Parameters

rule_name

Specifies the name of one or more storage rules. This parameter is optional. You can use wildcard characters to specify this name. If you do not specify a value for this parameter, all storage rules are displayed. The maximum length of the name is 30 characters.

Format

Specifies how the information is displayed. This parameter is optional. The default value is STANDARD. The following values are possible:

Standard: Specifies that partial information is displayed.
Detailed: Specifies that complete information is displayed.

ACTiontype

Specifies the storage action that is completed by the storage rules. The following values are possible:

ANY: All types of storage rules are displayed.
AUDit: Storage rules for audit operations are displayed.
GENdedupstats: Storage rules for data deduplication statistics are displayed.
REClaim: Storage rules for reclaiming cloud-container storage pools are displayed.
TIERBYAge: Storage rules for tiering based on age are displayed. If a storage tiering rule is based on age, all data that meets the age requirement is tiered.
TIERBYState: Storage rules for tiering based on state are displayed. If a storage tiering rule is based on state, only inactive data that meets the age requirement is tiered.
NOTiering: Storage rules that prevent data tiering are displayed.

ACTIVE

Specifies whether active or inactive storage rules are displayed. This parameter is optional. The default is ANY. The following values are possible:

ANY: Specifies that all storage rules are displayed.
Yes: Specifies that only active storage rules are displayed.
No: Specifies that only inactive storage rules are displayed.

Example: List all storage rules for all storage pools

Tip: In the output examples, some fields are blank because the item does not apply in the specified environment.

Query all storage rules for all storage pools. See Field descriptions for field descriptions.

query stgrule

Storage           Target Storage   Action     Active        Source Storage
Rule              Pool             Type                     Pools
Name                                                    
---------         ---------        ------     ---------     ------------------------
STGACTION1        CLOUD            TierByAge  Yes           DIRPOOL1

Example: Display detailed information about a storage rule for tiering

Query detailed information about a storage rule for tiering. See Field descriptions for field descriptions.

query stgrule format=detailed

   Storage Rule Name: COSRULE
 Target Storage Pool: COSPOOL
         Action Type: NoTiering
              Active: Yes
        Storage Type: Cloud
   Maximum Processes: 8
          Start Time: 14:20:15
     Delay (in days): 
            Duration:
         Description:
          Audit Type:
         Audit Level:
           Node Name:
     Filespace names:
           Name Type:
           Code Type:
      Percent Unused:
  Last Exe Date/Time:
Source Storage Pools: CONPOOL

Example: Display detailed information about a storage rule for auditing storage pools

Query detailed information about a storage rule for auditing storage pools. See Field descriptions for field descriptions.

query stgrule format=detailed

          Storage Rule Name: AUDIT
        Target Storage Pool: CTR
                Action Type: Audit
                     Active: Yes
               Storage Type: 
          Maximum Processes: 4
                 Start Time: 11:42:36
            Delay (in days): 7
                   Duration:
                Description:
                 Audit Type: Extent
                Audit Level: 5
                  Node Name:
            Filespace names:
                  Name Type:
                  Code Type:
             Percent Unused:
         Last Exe Date/Time: 01/19/2018 11:43:31
       Source Storage Pools:

Example: Display detailed information about a storage rule for generating data deduplication statistics

Query detailed information about a storage rule for generating data deduplication statistics. See Field descriptions for field descriptions.

query stgrule format=detailed

       Storage Rule Name: GEN1
     Target Storage Pool: DIRPOOL
             Action Type: GenDedupStats
                  Active: Yes
            Storage Type:
       Maximum Processes: 8
              Start Time: 12:06:46
         Delay (in days): 1
                Duration:
             Description:
              Audit Type:
             Audit Level:
               Node Name: *
         Filespace names: *
               Name Type: SERVER
               Code Type: BOTH
      Last Exe Date/Time: 01/18/2018 12:07:10
    Source Storage Pools:

Example: Display detailed information about a storage rule for reclaiming space in cloud-container storage pools

Query detailed information about a storage rule for reclaiming space in cloud-container storage pools. See Field descriptions for field descriptions.

query stgrule format=detailed

       Storage Rule Name: RECLAIM
     Target Storage Pool: CLOUD1
             Action Type: Reclaim
                  Active: Yes
            Storage Type:
       Maximum Processes: 8
              Start Time: 9:04:16
         Delay (in days): 
                Duration: 120
             Description:
              Audit Type:
             Audit Level:
               Node Name: *
         Filespace names: *
               Name Type: 
               Code Type: 
          Percent Unused: 50
      Last Exe Date/Time: 01/30/2018 12:07:10
    Source Storage Pools:

Field descriptions

Storage Rule Name: The name of the storage rule.
Target Storage Pool: The name of the target storage pool.
Action Type: The type of storage rule.
Active: Indication of whether the storage rule is active or inactive.
Storage Type: The storage type of the target storage pool. For cloud tiering storage rules, a value of Cloud is displayed.
Maximum Processes: The maximum number of parallel processes per storage pool.
Tip: For tiering storage rules, this value specifies the maximum number of processes for the source storage pool. For audit storage rules, you cannot set a maximum process value. The server automatically sets and adjusts the number of maximum processes during audit operations.
Start Time: The starting time of the window when the storage rule runs.
Delay (in days): The number of days to wait before the storage rule operation occurs. For audit storage rules, the number represents the interval, in days, between audit operations. For tiering storage rules, the number represents the minimum number of days that an object must remain in a source storage pool before it is moved to a target storage pool.
Duration: The number of minutes that the storage rule processes the data when all associated processes are completed. No value indicates that processing continues until complete.
Description: A description of the storage rule.
Audit Type: The type of audit operation.
Audit Level: The level of audit operation.
Filespace names: The names of one or more affected file spaces.
Name Type: Indication of how the server interprets file space names.
Code Type: Indicates the type of file spaces that are included.
Percent Unused: Specifies the percentage of unused space in reclamation storage rules.
Last Exe Date/Time: Specifies the last date and time when the storage rule was run.
Source Storage Pools: The name of the source storage pool or pools.

Related commands

Table 1. Commands related to QUERY STGRULE
Command	Description
DEFINE STGRULE (auditing)	Defines a storage rule for auditing storage pools.
DEFINE STGRULE (data deduplication statistics)	Defines a storage rule for generating data deduplication statistics.
DEFINE STGRULE (reclaiming)	Defines a storage rule for reclaiming cloud-container storage pools.
DEFINE STGRULE (tiering)	Defines a storage rule for tiering.
DELETE STGRULE	Deletes storage rules.
UPDATE STGRULE (auditing)	Updates a storage rule for auditing storage pools.
UPDATE STGRULE (data deduplication statistics)	Updates a storage rule for generating data deduplication statistics.
UPDATE STGRULE (reclaiming)	Updates a storage rule for reclaiming cloud-container storage pools.
UPDATE STGRULE (tiering)	Updates a tiering storage rule.