dsmrecall

The dsmrecall command selectively recalls migrated files or parts of migrated files to the local file system. Space management must be active.

Note: On large file systems, selective recall can take a long time.

If the file resides in a file system whose server stanza is different from the stanza of the last processed file, a new session is started for each recalled file. This process can happen as a result of links from one file system to another.

To display a list of all migrated files, use the dsmmigquery command. To display information about a list of migrated files from a particular file system or directory, use the dsmls command.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-DSMRECALL--+---------+--------------------------------------->
              '-options-'   

       .----------.                                         
       V          |                                         
>----+---filespec-+-----------------------------------+--------><
     '- –FILEList--=--list_file--+------------------+-'     
                                 '-file_system_name-'       

Parameters

options
Detail
Display the size, path, and file name for each file that you recall.
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 Tivoli® Storage Manager for Space Management client creates it.
Help
Displays syntax and options for the command. Do not specify other options when you specify the help option.
OFFset=n
Specify the offset from the beginning of the file of the required data range for partial recall (in bytes, kilobytes, megabytes, or gigabytes). Multipliers (k, m, g, K, M, or G) can be used. The range of acceptable values is 0 - 2147483647. There is no default value. This option is valid on AIX®GPFS™ and Linux x86_64 GPFS file systems only.
Remember: Use this option only with the size option and when a file system is specified. The recursive, detail, and filelist options are not valid with the offset option.

Examples are: -offset=10 (bytes), -offset=23k (kilobytes), -off=5M (megabytes), -off=2G (gigabytes).

PREView
Generate list files that are optimized for tape recalls but do not recall the files. You must also specify filelist and a file system. The preview option is not valid when filelist specifies a collection file.
Logname=file_path
Specifies the path and file name of the log file to be used by this command. The kinds of events that are logged to the file are specified with the hsmlogeventflags option. Error events are not logged to the file.
Recursive
Recall files that match the file specification in a directory and its subdirectories. If you do not use this option, files are recalled only for those directories that you specify.
RESident
When files are recalled, change the state to resident. If you do not use the resident option, the recalled files are in the premigrated state.
Remember: During the next reconciliation of the file system, files in resident state are marked for expiration on the Tivoli Storage Manager server.
SIZE=n
Specify the size of the required data range for partial recall (in bytes, kilobytes, megabytes, or gigabytes). Multipliers (k, m, g, K, M, or G) can be used. The range of acceptable values is 0 - 4294967295. There is no default value. This option is valid on AIXGPFS and Linux x86_64 GPFS file systems only.
Remember: Use this option only with the offset and the filespec options. The recursive, detail, and filelist options are not valid with the size option.

Examples are: -size=10 (bytes), -size=23k (kilobytes), -size=5M (megabytes), -size=2G (gigabytes).

SErver=server_name

Specify the target server for the task. This option is valid only in a multiple-server environment. If the file system is managed by multiple servers and you do not specify server, the task is attempted with the default migration server.

If a file is coupled with a server, the value of server must be that coupled server. If you specify another Tivoli Storage Manager server, the task fails with a warning message.

filespec
Specify the path and file name of the files to recall. This parameter is required. You can use wildcard characters to specify a group of files or all files in a directory, or more than one file specification in one command. When you use wildcard characters in a file specification, the Tivoli Storage Manager for Space Management client recalls all files that match the specification. If a file matches the specification but it is not migrated, an error message displays. If you enter more than one file specification, separate each specification with at least one blank space.
-FILEList=list_file
Process the files that are listed in list_file.
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 Tivoli Storage Manager for Space Management client ignores any entry that does not adhere to these rules.
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.txt

If the list file name that you specify with the filelist option does not exist, the command fails.

You can specify a collection file generated by dsmrecall or a list file generated by another application. You can specify only one list file or collection file, and you can specify the filelist option only once in each command.

If you also specify the preview option:
You must also specify file_system_name. The Tivoli Storage Manager for Space Management client generates tape-optimized list files and a collection file. No files are recalled.
If you do not specify the preview option:
The Tivoli Storage Manager for Space Management client recalls files.
If you also specify file_system_name:
The Tivoli Storage Manager for Space Management client performs a tape-optimized recall.
If the list file is a collection file that was generated by dsmrecall:
Recall starts. The list files referenced by the collection are processed in the order defined in the collection file. You must specify the collection file generated by dsmrecall; you cannot specify a tape list file or disk list file.
If the list file was not generated by dsmrecall:
The Tivoli Storage Manager for Space Management client first reorders the list to optimize recalls from tape. Then the Tivoli Storage Manager for Space Management client recalls the files.
If you do not specify file_system_name:
The Tivoli Storage Manager for Space Management client recalls the files in the list file. The Tivoli Storage Manager for Space Management client does not reorder the list to optimize recalls from tape.
file_system_name
Specify a file system. You must also specify the filelist option. The Tivoli Storage Manager for Space Management client optimizes the processing of files stored on tape.

Examples

Task Command
Recall a single file named /migfs1/test/tf04 and display detailed information. dsmrecall -Detail /migfs1/test/tf04
Recall all migrated files in a directory named /mfs4/user1 and all migrated files in its subdirectories. dsmrecall -Recursive /mfs4/user1/*
Recall all files in the FILElist named /tmp/filelist. Results are logged in the log file /tmp/recalllog. dsmrecall -Logname=/tmp/recalllog -filelist=/tmp/filelist

Recall the specified portion of a file named /mfs1/file10 in partial recall mode.

dsmrecall -offset=10M -size=500M /mfs1/file10