UPDATE SUBRULE (Update a subrule for replicating data)

Use this command to define an exception to a storage rule for replicating data. The exception applies only to the node and filespace pairs that are specified by the subrule.

Privilege class

To issue this command, you must have system privilege.

Syntax

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.

FIlespace

Specifies the name of the filespace or the filespace identifier (FSID) to replace the file space or FSID that was previously defined in the subrule. Use this parameter only when a single node is defined in the subrule.

*: Specify an asterisk (*) to specify 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 filespace 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 filespace name or an FSID. If you enter a filespace name, the server might have to convert the filespace 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.

Restriction: When you issue the UPDATE SUBRULE command with FILESPACE parameter, you cannot specify the NODE, ADDNODE, or ADDFILESPACE parameters in the same command because these four parameters are mutually exclusive. Instead, you must issue a separate UPDATE SUBRULE command for each parameter that you plan to update.

NODE

Specifies nodes or node groups to replace the existing nodes defined in the subrule. This parameter is optional.

You can add a node or node group only if a wildcard character (*) or a single file space was specified for the FILESPACE parameter in the subrule that is being updated.

node_name or node_group_name: Specifies the client nodes or client-node groups to which the subrule applies. You can specify a single node name or a comma-delimited list of node names. 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 cannot use wildcard characters, such as asterisks (*), to specify client node names or client-node group names.

Restriction: When you issue the UPDATE SUBRULE command with the NODE parameter, you cannot specify the FILESPACE, ADDNODE, or ADDFILESPACE parameters in the same command because these four parameters are mutually exclusive. Instead, you must issue a separate UPDATE SUBRULE command for each parameter that you want to update.

ADDNode

Specifies the name of a node or a node group to add to the subrule. This parameter is optional.

When you specify a node or a node group, ensure that either a wildcard (*) value or a single file space was defined in the subrule, which is being updated.

node_name or node_group_name: Specifies the client node or client-node group to which the subrule applies. You can either specify a single node name, a client-node group, or both. You cannot use wildcard characters, such as asterisks (*), to specify client node names or client-node group names.

Restriction: When you issue the UPDATE SUBRULE command with the ADDNODE parameter, you cannot specify the FILESPACE, NODE, or ADDFILESPACE parameters in the same command because these four parameters are mutually exclusive. Instead, you must issue a separate UPDATE SUBRULE command for each parameter that you want to update.

ADDFilespace

Specifies the name of the file space or the filespace identifier (FSID) to add to the file space or FSID that was previously in the subrule. This parameter is optional.

filespace_name: Specifies the name of the file space.
FSID: Specifies the name of a filespace identifier (FSID). This parameter is valid for clients with file spaces that are in Unicode format. Do not specify both filespace names and FSIDs on the same command.; For clients with file spaces that are in Unicode format, you can enter either a filespace name or an FSID. If you enter a filespace name, the server might have to convert the filespace 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.

Restriction: When you issue the UPDATE SUBRULE command with the ADDFILESPACE parameter, you cannot specify the FILESPACE, NODE, or ADDNODE parameters in the same command because these four parameters are mutually exclusive. Instead, you must issue a separate UPDATE SUBRULE command for each parameter that you want to update.

REMNode

Specifies the name of a node or a node group to remove from the subrule. This parameter is optional.

Restriction: The REMNODE parameter value cannot be specified for the UPDATE SUBRULE command if only a single node or a single node group is defined in the subrule. In this case, you must delete the subrule to remove the node.

REMFilespace

Specifies the name of a file space to remove from the subrule. You cannot remove multiple file spaces by using a single UPDATE SUBRULE command. This parameter is optional.

Restriction: REMFILESPACE parameter value cannot be specified for the UPDATE SUBRULE command if only a single file space is defined in the subrule. In this case, you must delete the subrule to remove the node.

DATAtype

Specifies the type of data to replace with the existing data types that are defined in the subrule. This parameter is optional. Separate multiple data types with commas with no intervening spaces. You cannot use wildcard characters. You can specify one or more of the following values:

ALl: The subrule includes all backup, archive, and space-managed data in a file space according to the rule that is assigned to the data type. This is the default value.
BACKUP: The subrule includes active, inactive, and retained backup data in a file space.
ARCHive: The subrule includes only archive data in a file space.
SPACEManaged: The subrule includes only space-managed data in a file space.

NAMEType

Specifies how you want the server to interpret the filespace 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 required only if you specify a node name and a filespace name or FSID.

Restriction: When you specify this parameter, the filespace 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 filespace names. This is the default value.
UNIcode: The server converts the filespace 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 filespace 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 specify all file spaces. This parameter is optional. You can specify one of the following values:

NONUNIcode: Include file spaces that are not in Unicode format.
UNIcode: Include file spaces that are in Unicode format.
BOTH: Include file spaces regardless of code page type.

Update a subrule to exclude records

The storage rule PERFORMANCEREVIEWS is used to replicate records of employee performance reviews from a client node to a server. The RETIREES subrule was defined to ensure that retiree records, which are stored on the NODE1 node, remain on NODE1 and are excluded from replication operations. Update the subrule to ensure that records on both NODE1 and NODE2 are excluded from the PERFORMANCEREVIEWS storage rule.

update subrule performancereviews retirees addnode=node2 actiontype=noreplicating

Related commands

Table 1. Commands related to UPDATE SUBRULE
Command	Description
DEFINE SUBRULE (replicating)	Defines an exception to a replicating storage rule.
DELETE SUBRULE	Deletes subrules.
UPDATE STGRULE (replicating)	Updates a storage rule for replicating data.
QUERY SUBRULE	Displays information about subrules.