dsmattr
The dsmattr command sets or changes the recall mode for one or more migrated files. The recall mode determines how the space management client recalls a migrated file when you access it.
You cannot set a recall mode for a resident or a premigrated file. The recall mode that you set for a migrated file remains associated with that file only while the file remains migrated.
If you do not specify any parameters, the command displays the current recall mode, stub size, preview size, file name, and whether the readstartsrecall option is set.
Syntax
Parameters
- options
- –ERRORLOGName=file_path
- Specifies the path and file name of the error log file to be used by this command. Output from only this command is logged to the specified file. Other commands and daemons write output to the error log file specified by the errorlogname option in options file dsm.sys or dsm.opt, or as specified by the DSM_LOG environment variable. If any part of the path you specify does not exist, the space management client creates it.
- –Help
- Displays syntax and options for the command. Do not specify other options when you specify the help option.
- –PREViewsize=n
- Specifies the preview size of the stub file. Valid values are 0 - 1,073,741,824, and must not be greater than the stub size.
When the attributes are set and the preview size is defined, a recall operation begins only when an application reads the stub file beyond the preview section of the stub file. If an operation reads only the preview section of the stub file, the file is not recalled.
- –REAdstartsrecall=No|Yes
- Specifies whether a recall operation starts when an application reads the stub file.
This option applies only if streaming recall mode is set.
If the previewsize option is set for the stub file, a recall operation starts only when an application reads beyond the preview section of the stub file.
The default value is No.
Regardless of the value of the readstartsrecall option, the file is recalled when either of the following conditions are true:- The recall daemon determines that the stub file does not contain all of the data that is required by a read operation.
- An operation modifies the file.
- –RECAllmode=value
- Sets a recall mode for one or more migrated files. If you do not
specify the RECAllmode option, the space management client displays the
current recall mode for the files that you specify. You can specify
the following values:
- Normal
- Recalls the migrated file to its originating file system.Normal is the default. If the file is not modified, it becomes a premigrated file. If the file is modified, it becomes a resident file.
- Partialrecall
- Specifies that the file is recalled by using partial file recall, regardless of its size. Valid only on GPFS™ file systems.
- Streaming
- Specifies that you want to enable an asynchronous recall of migrated files. The recalled portion of the file can be accessed while the file is recalled. This parameter is valid for read-only operations on the file.
Value Description Normal Recalls the migrated file to its originating file system. Normalis the default. If the file is not modified, it becomes a premigrated file. If the file is modified, it becomes a resident file. Partialrecall IBM® Storage Scale systems only) Specifies that the file is recalled by using partial file recall, regardless of its size. Streaming Specify an asynchronous recall of migrated files. The recalled portion of the file can be accessed before the complete file is recalled. This parameter is valid for read-only operations on the file. - –RECUrsive
- Sets or displays the recall mode for migrated files in the directory and subdirectories that you specify.
- filespec
- Note: This parameter is required only when you set a new recall mode. If you do not use the RECAllmode option, and you do not specify a path and a file name, the current recall mode displays for all files in the current directory.
The path and file name of the file for which you want to set a new recall mode, or display the current recall mode. You can specify a single file, a group of files, or a directory. If you specify a directory, the space management client sets or displays that recall mode for each migrated file in the directory.
You can use wildcard characters to specify a group of files with similar names. You can issue more than one file specification in a command. If you enter several file specifications, separate each specification with one or more blank spaces.
- –FIlelist=file_path
- Specifies the path of a file that contains a list of files to be processed by this command.
The entries in the list file must adhere to the following rules:
- Each entry is a fully qualified path to a file or a relative path to a file.
- No entry is a directory object.
- Each entry is on a separate line.
The following rules apply to a file list for the space management client. These rules differ from the rules for backup-archive client file lists.- An entry can contain unprintable characters, but cannot contain a carriage return.
- Wildcard characters are allowed.
- A file path that contains blank spaces must be enclosed in quotation marks.
- An entry that begins with a quotation mark and ends with a quotation mark is tolerated. The space management client assumes that the quotation marks are not needed and omits them when the space management client processes the entry. If beginning and ending quotation marks are required to identify the file, add double quotation marks before the beginning and after the end of the entry.
The following example shows a list of files within a list file:/home/dir/file1 "/fs1/dir2/file3" "/fs2/my files/file4" ../tivoli/'file1' "'fs3'/dir3/'file.txt'" fs4/dir/a"file".txt '/fs4/dir/file.txt' /fs5/dir/file*with?wildcards.txtIf the list file name that you specify with the filelist option does not exist, the command fails.
Examples
| Task | Command |
|---|---|
| Change the recall mode to partial file recall for all migrated files in the /home/user2 directory and all of its subdirectories. | dsmattr -recall=partialrecall -Recursive
/home/user2 |
| Enable an asynchronous recall of migrated files in the /home/user2/ directory. | dsmattr -recall=streaming /home/user2/ |
| On the /myfs file system, stub files are 32,768 bytes. For the migrated files that are listed in files.lst, set the preview size to 4,096 bytes. If an application reads more than the preview section of any of these stub files, start the recall process. (Streaming recall mode is a requirement to start the recall after an application reads the preview section). | dsmattr -preview=4096 -readstartsrecall=yes
-recall=streaming -filelist=/myfs/files.lst |
| Display the recall attributes that are assigned to all files in the current directory. | dsmattr |
| Display all files in the file list that is named /tmp/filelist. | dsmattr -filelist=/tmp/filelist |