UPDATE STGRULE (Update a storage rule for generating data deduplication statistics)

Use this command to update a storage rule for generating data deduplication statistics.

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 STGRULE rule_name DELAY=delayMAXPRocess=numberSTARTTime=timeACTIVE=NoYesNODEList=,node_namenode_group_nameNAMEType=SERVERUNIcodeFSIDFSList=,filespace_name,fsidCODEType=UNIcodeNONUNIcodeBOTHDESCription=description

Parameters

rule_name (Required)
Specifies the name of the storage rule. The name must be unique, and the maximum length is 30 characters.
DELAY
Specifies the number of days to wait before the statistics are generated. You can specify an integer in the range 0 - 9999.
MAXProcess
Specifies the maximum number of parallel processes to collect statistics for each storage pool that is specified. This parameter is optional. You can enter a value in the range 1 - 99. For example, if you have 4 storage pools and you specify a value of 8, 32 processes are started.
STARTTime
Specifies the time for the beginning of the window in which the storage rule is first processed. This parameter is optional. The storage rule runs daily within 5 minutes following the specified time.
You can specify one of the following values:
Value Description Example
HH:MM:SS A specific time. 23:30:08
NOW The current time. NOW
NOW+HH:MM or +HH:MM The current time plus the specified number of hours and minutes. NOW+02:00 or +02:00
NOW-HH:MM or -HH:MM The current time minus the specified number of hours and minutes. NOW-02:00 or -02:00
ACTIVE
Specifies whether storage rule processing occurs. This parameter is optional. The following values are possible:
No
Specifies that the storage rule is inactive. The storage rule is not processed at the scheduled time.
Yes
Specifies that the storage rule is active. The storage rule is processed at the scheduled time.
NODEList
Specifies the name of the client node or defined group of client nodes for which data deduplication statistics are collected. You can also specify a combination of client node names and client-node group names. To specify multiple client node names or client-node group names, separate the names with commas with no intervening spaces. You can use wildcard characters with client node names but not with client-node group names. The specified value can have a maximum of 1024 characters. If you enter an asterisk (*), information is shown for all client nodes. This parameter is optional.
NAMEType
Specifies how you want the server to interpret the file space names that you enter. Use this parameter when IBM Spectrum® Protect clients have file spaces that are in Unicode format, and are on Windows, NetWare, or Macintosh OS X operating systems. This parameter is optional.
This parameter is required if you specify a node name and a file space name or FSID.
Restriction: When you specify this parameter, the file space name cannot contain an asterisk.

You can specify one of the following values:

SERVER
The server uses the server's code page to interpret the file space names.
UNIcode
The server converts the file space name that is entered from the server code page to the UTF-8 code page. The success of the conversion depends on the characters in the name and the server's code page.
Tip: Conversion can fail if the string includes characters that are not available in the server code page, or if the server cannot access system conversion routines.
FSID
The server interprets the file space names as their FSIDs.
FSList
Specifies the names of one or more file spaces for which data deduplication statistics are collected. This parameter is optional. You can use wildcard characters to specify this name. The specified value can have a maximum of 1024 characters. You can specify one of the following values:
*
Specify an asterisk (*) to show information for all file spaces or IDs.
filespace_name
Specifies the name of the file space. You can specify more than one file space by separating the names with commas and no intervening spaces.
FSID
Specifies the name of a file space identifier. This parameter is valid for clients with file spaces that are in Unicode format. Specify more than one file space by separating the names with commas and no intervening spaces.
For clients with file spaces that are in Unicode format, you can enter either a file space name or an FSID. If you enter a file space name, the server might have to convert the file space name that you enter. For example, the server might have to convert the name that you enter from the server's code page to Unicode.
Restrictions: The following restrictions apply to file space names and FSIDs:
  • You must specify a node name if you specify a file space name.
  • Do not specify both file space names and FSIDs on the same command.
CODEType
Specifies what type of file spaces to include in the record. Use this parameter only when you enter an asterisk to display information about all file spaces. This parameter is optional. Specify one of the following values:
UNIcode
Include file spaces that are in Unicode format.
NONUNIcode
Include file spaces that are not in Unicode format.
BOTH
Include file spaces regardless of code page type.
DESCription
Specifies a description of the storage rule. This parameter is optional.

Update a rule to generate data deduplication statistics

Update a storage rule that is named MYSTAT1 to generate data deduplication statistics. Limit the scope to the node that is named NODE1:
update stgrule mystat1 nodelist=node1

Related commands

Table 1. Commands related to UPDATE STGRULE
Command Description
DEFINE STGRULE (data deduplication statistics) Defines a storage rule for generating data deduplication statistics.
DELETE STGRULE Deletes storage rules.
QUERY STGRULE Displays storage rule information.