GENERATE DEDUPSTATS (Generate data deduplication statistics)

Privilege class

To issue this command, you must have system privilege, unrestricted storage privilege, or restricted storage privilege for the storage pool.

Parameters

pool_name (Required)

Specifies the name of the storage pool that is reported in the data deduplication statistics. You can specify up to 30 characters for the storage pool name. If you specify more than 30 characters, the command fails.

Restriction: You can specify only directory-container storage pools or cloud storage pools.

node_name or node_group_name (Required)

Specifies the name of the client node or defined group of client nodes that is reported in the data deduplication statistics. 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.

filespace_name or FSID

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

MAXPRocess

Specifies the maximum number of parallel processes to generate statistics for a container in a directory-container or cloud-container storage pool. This parameter is optional. Enter a value in the range 1 - 99. The default value is 4.

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.

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.

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.

Wait

Specifies whether the data deduplication statistics are generated in the foreground or background. This parameter is optional. You can specify one of the following values:

No

Specifies that the operation is completed in the background. You can continue with other tasks while the command is processing. Messages that are related to the background process are displayed in the activity log file or the server console, depending on where the messages are logged. This is the default value.

Yes

Specifies that the operation is completed in the foreground. It might take a long time to complete the operation. The operation must end before you can continue with other tasks. Messages are displayed in the activity log file or the server console, or both, depending on where the messages are logged.

Restriction: You cannot specify the WAIT=YES parameter from the server console.

DESCription

Specifies a description of the generated statistics. This parameter is optional.

Related commands

Table 1. Commands related to GENERATE DEDUPSTATS

Command	Description
DELETE DEDUPSTATS	Deletes data deduplication statistics.
QUERY DEDUPSTATS	Displays data deduplication statistics.