DEFINE SUBRULE (Define an exception to a tiering storage rule)

Privilege class

To issue this command, you must have system privilege.

Parameters

parent_rule_name (Required)

Specifies the name of the parent storage rule.

subrule_name (Required)

Specifies the name of the subrule. The name must be unique, and the maximum length is 30 characters.

node_name (Required)

Specifies the nodes to which the subrule applies. You can specify a single node name or a comma-delimited list of node names.

ACTiontype (Required)

Specifies the subrule type. You must specify one of the following values:

TIERBYAge

Specifies that data is tiered after an age threshold is met.

TIERBYSTate

Specifies that only inactive data is tiered after an age threshold is met.

NOTiering

Specifies that data is not tiered.

TARGETSTGpool

Specifies the name of the target storage pool. This parameter is optional. By default, the target storage pool is inherited from the parent storage rule.

If you specify this parameter for cloud storage, you must specify a cloud-container storage pool that uses the Microsoft Azure or Google Cloud Storage cloud computing system, or the Simple Storage Service (S3) protocol. If you specify this parameter for tape storage, you must specify a storage pool that is defined for a physical or virtual tape library.

TIERDelay

Specifies the interval, in days, after which data is tiered. You can specify an integer in the range 0 - 9999. This parameter is optional. If ACTIONTYPE=TIERBYAGE is specified, the default value is 30. If ACTIONTYPE=TIERBYSTATE is specified, the default value is 1. If ACTIONTYPE=NOTIERING is specified, you cannot specify a tier delay.

MAXPRocess

Specifies the maximum number of parallel processes for the subrule. This parameter is optional. You can enter a value in the range 1 - 99. The default value is 4.

Tip: To optimize the process of tiering data to tape, ensure that the sum of all MAXPROCESS values for a rule and its subrules is less than or equal to the number of tape drives.

FIlespace

Specifies one or more virtual machines, which are registered to the IBM Spectrum® Protect server as file spaces. This parameter applies only to virtual machines and is optional. You can use wildcard characters. The specified value can have a maximum of 1024 characters. You can specify one of the following values:

*

Specify an asterisk (*) to specify all file spaces or IDs. This is the default.

filespace_name

Specifies the name of the file space.

fsid

Specifies the name of a file space identifier (FSID). This parameter is valid for clients with file spaces that are in Unicode format. Do not specify both file space names and FSIDs on the same command.

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.

When you specify nodes and file spaces, the following rules apply:

• You can specify a single node and a single file space, which corresponds to an existing virtual machine.
• You can specify a single node and all file spaces by using an asterisk (*) as a wildcard to represent all file spaces, or by entering no value to include all file spaces.
• You can specify a comma-delimited list of nodes and no file space to include all file spaces.
• You can specify a single node and a file space name with one or more asterisks in the file space name. The asterisks can be placed in any part of the name.
• If you use wildcard characters in a file space name, you cannot specify wildcard patterns that might result in overlapping node and file space pairs. Each wildcard pattern can specify one or more node and file space pairs, but the pairs in one pattern cannot overlap the pairs in another pattern. For example, you cannot specify node NODE1 and file space ABC* in one subrule, and specify node NODE1 and file space A* in the same subrule or in a different subrule.

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. This is the default.

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.

Restriction: 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.

CODEType

Specifies the type of file spaces to include in the subrule. The default value is BOTH, which specifies that file spaces are included regardless of code page type. Use this parameter only when you enter an asterisk to display information about all file spaces. This parameter is optional. You can 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.

Related commands