QUERY RETRULE (Query a retention rule)

Use this command to display information about one or more retention rules.

Privilege class

Any administrator can issue this command.

Syntax

Parameters

retrule_name

Specifies the name of the retention rule to query. This parameter is optional. If you specify a retention rule, only that retention rule is considered during query processing. If you do not specify a rule, all retention rules are displayed.

Format

Specifies how the information is displayed. This parameter is optional. The default value is STANDARD. You can specify one of the following values:

Standard: Specifies that partial information is displayed.
Detailed: Specifies that complete information is displayed. For example, you can see when the next retention set creation job will run.

Example: Display detailed information about a retention rule

Display detailed information about a retention rule that is named WEEKLY. See Field descriptions for field descriptions.

query retrule weekly format=detailed


           Retention Rule Name: WEEKLY
              Retention Period: 2,000
             Number of Clients: 2
                   Description:
       Retention Rule Contents: FILEMAN TAPEMAN
               Start Date/Time: 05/07/2018 08:44:35
Next Scheduled Start Date/Time: 07/02/2018 08:44:35
                Schedule Style: Classic
      Retention Rule Frequency: Weekly
                   Day of Week: Any
                         Month:
                  Day of Month:
                 Week of Month:
                       Active?: Yes
Last Update by (administrator): ADMIN1A
         Last Update Date/Time: 05/07/2018 08:44:35

Field descriptions

Retention Rule Name: The name of the retention rule.
Retention Period: The length of time, in days, for which any retention set that is created by the retention rule is retained by the server. If no retention period was specified, the value NOLIMIT is displayed.
Number of Clients: The number of clients that are included in the retention rule. If wildcards are used in the node and/or filespace specifications, this value reflects the number of clients that match those specifications when the query runs.
Description: A description of the retention rule.
Retention Rule Contents: The clients that are included in retention sets created by this retention rule. If wildcards are specified for the nodes or file spaces, these wildcard values are displayed in the query output.
Start Date/Time: The starting date and time of the range from when the retention rule runs.
Next Scheduled Start Date/Time: The starting date and time when the next retention rule is scheduled.
If the ACTIVE parameter is set to Yes, this date corresponds to the date is when the next retention set is created by this retention rule. If the ACTIVE parameter is set to No, this field is blank.
Schedule Style: Specifies whether classic or enhanced schedule rules are used.
Retention Rule Frequency: The frequency with which a retention rule is created. If the SCHEDSTYLE=ENHANCED setting is specified, this field is blank.
Day of Week: The day of the week that the scheduled retention rule runs.
Month: The month of the year that the scheduled retention rule runs. If the SCHEDSTYLE=CLASSIC setting is specified, this field is blank.
Week of Month: The week of the month that the scheduled retention rule runs. If the SCHEDSTYLE=CLASSIC setting is specified, this field is blank.
Active: Indication of whether the retention rule is active or inactive.
Last Update by (administrator): The administrator ID that defined or most recently updated the retention rule.
Last Update Date/Time: The date and time that an administrator defined or most recently updated the retention rule.

Related commands

Table 1. Commands related to QUERY RETRULE
Command	Description
DEFINE RETRULE	Defines a retention rule.
UPDATE RETRULE	Changes the attributes of a retention rule.
DELETE RETRULE	Deletes a retention rule.
RENAME RETRULE	Renames a retention rule.