dsmclc retrieve

Edit online

The dsmclc.exe command with the retrieve parameter retrieves migrated files from the file space of an IBM® Storage Protect server. Primary data stream (PDS) data and Windows™ alternate data stream (ADS) data is retrieved.

Syntax


1  DSMCLC.exe RETRIEVE  -g filespace  search_pattern ? connection_options?  -d
2.1! no
2.1 yes ? -f?  -s
2.1! yes
2.1 no ? target_dir?  -l loglevel

Options

-g filespace
Specify a file space on IBM Storage Protect storage. The file space name is case sensitive.
search_pattern
Specify a pattern for migrated objects. All migrated objects that match the pattern are included in the operation. There are several parts to a search pattern. Some parts are required; some parts are optional. Separate the parts with a blank space. Search pattern elements are case-sensitive. If there is no hardware mapping, you can use wildcard characters asterisk (*) and question mark (?).
volume_pattern
Specify a pattern that matches volume names. The volume pattern is required. If the volume pattern contains blank spaces, enclose the pattern with quotation marks.

If there is a hardware mapping for the volume, you must specify the file-server host name and drive letter without wildcard characters.

directory_pattern
Specify a pattern that matches directory names. The directory pattern is required. If the directory pattern contains blank spaces, enclose the pattern with quotation marks.
file_pattern
Specify a pattern that matches file names. The file pattern is optional. If the volume pattern contains blank spaces, enclose the pattern with quotation marks.
-version number
Specify a file version.

The version parameter is optional. If you do not specify a version, only the most recent version is retrieved.

connection_options

If the operation involves a remote file server, you must specify an IBM Storage Protect connection.

You can specify a connection by specifying the two parts of a connection pair or by specifying a shortcut.

Specify the two parts of a connection
Use the h and u parameters:
–h TSM_host_name
Specify the IBM Storage Protect server part of a connection pair. The value of TSM_host_name is not case-sensitive. Specify TSM_host_name with the value of the TCPSERVERADDRESS option and the value of the TCPPORT option, separated with a colon. For example: 127.0.0.1:1500
–u node_name
Specify the IBM Storage Protect node part of a connection pair. Use the same value that you used to define the IBM Storage Protect server connection. If the connection to the IBM Storage Protect server was configured with the asnodename option, specify the value of the asnodename option. If the connection was configured without the asnodename option, specify the value of the nodename option. The value of node_name is not case-sensitive.
Specify a connection shortcut
Instead of specifying the host name and node name parts of a connection, you can specify a connection shortcut. Use the c parameter to specify a connection shortcut:
–c shortcut
The shortcut value is one or two characters and is generated by the HSM for Windows client. Connection shortcuts include these examples:
  • l (local)
  • r1 (remote connection 1)
  • r2 (remote connection 2)
Tip: Run dsmclc help to display connection shortcuts.
-d no|yes
Specify whether Windows alternate data stream (ADS) data is retrieved when the file is retrieved. The default is the value that you set in the initial configuration wizard. A yes value means that ADS data is retrieved when the file is retrieved. ADS data can be retrieved only if ADS data was migrated. A no value means that ADS data is not retrieved. If you use the option but do not specify yes or no, a yes value is assumed.
-f
Force writing the retrieved file if a copy exists on the local volume.

If the stub file on the file system contains Windows alternate data stream (ADS) data, you must use the f option to retrieve the file. It is possible that the ADS data that is in the stub file is more recent than the ADS data that was migrated.

-s yes|no
Specify whether file security attributes (ACL) are migrated when the file is migrated. The default is the value that you set in the initial configuration wizard. A yes value means that the ACL is migrated when the file is migrated. A no value means that the ACL is not migrated. If you use the option but do not specify yes or no, a yes value is assumed.
target_dir
Specify a directory for the retrieved file. If you do not specify this option, the file is retrieved to the original path.
-L loglevel

Specify the type of information that is to be recorded in logs and trace files. You can specify one or more values with no commas or blank space separators. Severe and error messages are always recorded. The default combination is severe, error, warning, information, and library (SEWIL). The following values are valid:

  • C (event)
  • D (debug)
  • E (error)
  • F (flush)
  • I (information)
  • K (driver)
  • L (library)
  • S (severe)
  • T (trace)
  • U (user)
  • W (warning)
  • X (dump)

Examples

Task
Retrieve the migrated .xls files in the c:\big projects\2009\ directory to a new path: c:\projects\spreadsheets\. The migrated copies are in file space def-hsm01.

Command: dsmclc retrieve -g def-hsm01 c: "\big projects\2009" *.xls c:\projects\spreadsheets.

Spaces separate the three parts of the search_pattern: c: "\big projects\2009" *.xls. Because the directory_pattern (\big projects\2009) contains a blank space, it is enclosed in quotation marks.

Task
Display help for the dsmclc.exe command.

Command: dsmclc help

Task
Change the information that is recorded in log and trace files to the default.

Command: dsmclc -l