Professional Documents
Culture Documents
4 Administration Guide
SC32-1773-02
Note: Before using this information and the product it supports, read the information in Notices on page 70.
Fourth Edition (January 2007) This edition applies to version 5, release 4, of IBM Tivoli Storage Manager for HSM for Windows and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright International Business Machines Corporation 2005, 2007. All rights reserved. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
ii
Table of Contents
1 INTRODUCTION ...................................................................................................6 1.1 1.2 1.3 2 About This Book..........................................................................................6 Who Should Read This Book .....................................................................6 Contacting IBM Software Support .............................................................6
COMPONENTS .....................................................................................................4 3.1 3.2 3.3 The Migration Program ...............................................................................4 File System Filter Driver and Recall Application ......................................5 Administration GUI......................................................................................6
INSTALLATION ....................................................................................................7 4.1 Installation on a clustered environment....................................................7 4.1.1 Cluster scenario.......................................................................................7 4.1.2 Installation Steps for a Clustered Configuration...................................9 4.1.3 Limitations..............................................................................................10
5 6 7
REGISTERING THE HSM CLIENT .....................................................................10 BACKUP BEFORE MIGRATION ........................................................................18 DEFINING MIGRATION JOBS ...........................................................................22 7.1 7.2 7.3 New Files....................................................................................................26 New Directories .........................................................................................33 Examples....................................................................................................39
8.2 From the command line ............................................................................42 8.2.1 Using input from other applications ....................................................43
iii
8.3 9
Scheduled ..................................................................................................43
ADDITIONAL ADMINISTRATIVE FUNCTIONS .................................................47 9.1 9.2 Using File Groups .....................................................................................47 Calculate Space Saving ............................................................................50
9.3 Search and Retrieve ..................................................................................51 9.3.1 Search Migrated Files............................................................................51 9.3.2 Retrieve Migrated Files..........................................................................54 9.4 Quota ..........................................................................................................56 9.4.1 Define Quotas ........................................................................................57 9.4.2 View Quotas ...........................................................................................60 9.5 10 Regional Settings ......................................................................................61 TOOLS .............................................................................................................61 dsminfo.exe ...............................................................................................62 dsmfileinfo.exe ..........................................................................................63 dsmfind.exe ...............................................................................................63
LOG FILES AND LOG LEVELS ......................................................................64 Log file settings.........................................................................................65 Administrative Logs..................................................................................67
11.1 11.2 12
ADVANCED PARAMETER SETTINGS ...........................................................68 Max Connections.......................................................................................68 Hsmservice Connection Timeout.............................................................68 Hsmservice Timeout .................................................................................69 File Attribute Filter.....................................................................................69 Directory Attribute Filter ...........................................................................69 Listfiles.......................................................................................................70
13.1
iv
14
GLOSSARY......................................................................................................72
vi
If you are not sure what type of software maintenance contract you need, call 1-800-IBMSERV (1-800-426-7378) in the United States. From other countries, go to the contacts page of the IBM Software Support Handbook on the Web at http://techsupport.services.ibm.com/guides/contacts.html and click the name of your geographic region for phone numbers of people who provide support for your location.
Migration jobs can be organized according to different types of files such as office documents, images, and text files. This organization provides a more logical view on data than pure HSM.
The HSM Client comes with a comprehensive Graphical User Interface (GUI), which is used to define migration jobs. On each file server where the HSM Client is installed, local NTFS file systems can be browsed, and parts of the directory structure can be excluded or included in a migration job. For each selection, filters can be applied to include or exclude files based on the file type (extension), and various criteria related to the age of a file (creation, modification, last access). Each migration job is stored in an XML structured file (job file). The actual migration can be scheduled using any standard scheduler, or it can be started manually from a command line. In addition, the HSM Client administrator can initiate immediate execution of a migration job directly from the administration GUI. It is highly recommended to have a valid backup before migrating any file. When a security descriptor is changed on a migrated file on the file server, the next migration job on that file will recall and re-migrate the file, so that the security of the file is stored correctly on the Tivoli Storage Manager Server. The HSM Client utilizes an Installable File System (IFS) filter driver and uses Windows Reparse Points and Sparse Files to leave stubs of migrated files on the local disks. The Reparse Points generated by the HSM Client have a worldwide unique ID, which has been provided and registered by Microsoft. The HSM Client supports NTFS file systems under Windows 2003. Windows NT and FAT partitions are not supported. With regard to the Tivoli Storage Manager server, the HSM Client acts as a Tivoli Storage Manager Client exploiting the Tivoli Storage Manager Clients archiving API. Note: Before you migrate files with the HSM Client you should do a backup of the original files using the Tivoli backup Client. As the HSM Client works independently of the backup Client the only interaction point are stub files. These are backed up as-is and restored as stubs. Before recalling files please ensure, that sufficient space is left on the volume. The correct behavior of Tivoli Storage Manager (in the case of an NTFS volume that is completely full) cannot be ensured. The hostname of the HSM fileserver must not be changed. Otherwise retrieving or recalling data will be impossible. The HSM Client by default only migrates files larger than 4kBytes and larger than the NTFS cluster size of the volume. To increase this size, change the value of following registry keys from default (dec) 4096 (bytes) to a higher value in kilobytes:
HKLM\SOFTWARE\IBM\ADSM\CurrentVersion\HsmClient \dsmclc\FileSizeMinimum for dsmclc.exe and HKLM\SOFTWARE\IBM\ADSM\CurrentVersion\HsmClient \dsmgui\FileSizeMinimum for dsmgui.exe Jobs with actions "delete" or "keep" ignore the registry key FileSizeMinimum as well as the volume cluster size and the hard coded limit of 4k. The result is that jobs with actions "delete" or "keep" archive files independently from the file size. However, the administrator can specify file size limits in archiving jobs.
3 Components
The HSM Client consists of the following components: The Migration Program The File System Filter Driver The Recall Application The Administration GUI
When files are migrated to an existing file space, each file is checked to see if it already exists. If it exists and the content of the two versions is different, the new version is appended to the file space. If the file exists and has not been changed, it is simply replaced (again) by a stub pointing to the original entry in the Tivoli Storage Manager file space. When only file attributes or times (creation time, last modification time) have changed, no new version of the file is appended; however, the attributes or file times are updated in Tivoli Storage Manager for the current (latest) version of a file. However, when security attributes have changed, files are recalled first and then stored again with the same version number. The old entry is deleted in Tivoli Storage Manager. The administrator should be aware that files are recalled and that they use temporary disk
space. Attributes and file times are stored in the Tivoli Storage Manager database and they can be modified. File security is part of the binary data blob, and it cannot be updated.
The migration programs can be started either automatically by a scheduler or manually from the command line. In addition, the migration program can be used as a command line tool to list file entries in a file space, and to retrieve files from a file space. For retrieve operations, the latest version of a file is always accessed. Due to Tivoli Storage Manager convention, the complete pathname of the file(s) to be archived cannot exceed 1024 characters. Due to Windows Explorer limitations, dsmgui.exe pathnames can handle a maximum of 254 characters only. . For pathnames that exceed 254 characters, dsmclc.exe must be used. The name of the migration program is: dsmclc.exe
The name of the File System Filter Driver is: hsmdriver.sys The name of the Recall Application is: hsmservice.exe
File Space Creation: Change log settings Define and view quota Regional settings
4 Installation
For installation instructions, see the Release Notes file (relnote_hsmwin540.html) located on the IBM Tivoli Storage Manager for HSM for Windows 5.4 Quick Start CD. This file is also available online at the Tivoli Information Center Web site: http://publib.boulder.ibm.com/infocenter/tivihelp/v1r1/index.jsp
Before detailing the additional steps required for installation in a clustered environment we will review what happens with Tivoli Storage Manager for HSM for Windows in a Windows cluster after a failover if the additional steps are not taken. Example (names refer to the diagram above): Files are migrated from volume Y: by Node1 Node1 fails Cluster Group 0 fails-over to Node2 Recall of migrated files from Y: fails on Node2 Retrieve of migrated files from Y: fails on Node2
File Migration During migration Tivoli Storage Manager for HSM for Windows stores the complete UNC pathname of a file in the Tivoli Storage Manager database as well as in the reparse point left as the stub on the file server disk. This pathname includes the hostname of the node (in the above example Node1). Recall operation after failover During a recall operation (from Node2 which is now the controlling node) the hsmservice looks for the pathname found in the reparse data and verifies if it is a local path. This is important as the driver that actually restores the file can only work on local NTFS disks. As this pathname contains the name of Node1 as hostname, the recall operation fails.
Retrieve operation The retrieve operation fails because it constructs pathnames with Node2 while the files stored in Tivoli Storage Manager contain Node1 as hostname. Solution In order to address the NodeName issues mentioned above a function has been implemented in Tivoli Storage Manager for HSM for Windows to map the node names and volumes in a cluster to the generic cluster name and its volumes. This mapping is done automatically for any cluster resource volume of any cluster group, which can fail-over (and which will be used with HSM for Windows). When hsmservice is started the first time, following registry key with entries of the mapped volumes is generated:
HKLM\SOFTWARE\IBM\ADSM\CurrentVersion\HsmClient\Cluster\<hostname>\Volumes
For the configuration shown in the sample above the following registry entries are made on both nodes:
Name Y: Z: Type REG_SZ REG_SZ Data \\CLUSTER\Y$\ \\CLUSTER\Z$\
Tivoli Storage Manager for HSM for Windows will check the Windows Registry under the above key and replace the node name for each volume defined by the clustername. This applies to all operations involving the following: Reparse data Path names in Tivoli Storage Manager Search and retrieve operations
CAUTION: These settings define the HOST and DRIVENAMES on which data is stored. These settings are STORED in the REPARSEPOINTS that are NEEDED to recall files. Changing this mapping AFTER a file has been migrated WILL MAKE A USER RECALL IMPOSSIBLE.
Steps 1 and 2 are performed as for the non-Clustered Environment, but on each Node in the Cluster.
For registering HSM Client on a Cluster please see Chapter 5, Registering the HSM Client
4.1.3 Limitations
In a fail-over situation migration jobs defined on Node1 may no longer be executable from Node2. In the Scenario described earlier the job files are stored on the local disk C: of Node1, which is not accessible when this Node fails. This limitation could be avoided by storing the job files on the volume Y: of Cluster Group Group 0 in an active-standby configuration (The directory job files to be searched by Tivoli Storage Manager for HSM for Windows may be redefined using the registry key HKLM\SOFTWARE\IBM\ADSM\CurrentVersion\hsmClient\JobFileDir). In a fail-over situation, the job files must be applied to the new node name. Otherwise the source files cannot be found on the second node, when executing the job. In an active-active configuration this approach is not feasible, as Node2 is running its own migration jobs. However, job files may be stored on a shared directory accessible from both cluster nodes. Currently only Microsoft cluster environments (MSCS) are supported.
Once the Tivoli Storage Manager administrator has set up your node you can start the administration GUI. The first time that you start the program, the Configuration Wizard will guide you through the required configuration steps to connect to the Tivoli Storage Manager server.
10
Click Next
11
Enter the IP address or hostname of the Tivoli Storage Manager server Enter the port number of the Tivoli Storage Manager server Note: Each HSM Client can only connect to one Tivoli Storage Manager server. This server might be different from the one used by the Backup-Archive Client.
Select the password option you want to use to connect to the Tivoli Storage Manager server. The recommended option is Password Generate. With this option, Tivoli Storage Manager automatically handles the password. As a result, there is no need to maintain a password or deal with password expiration. If you select the Password Prompt option, you must specify a password to be used by the HSM Client to logon to the Tivoli Storage Manager server. This password is stored and encrypted by the HSM Client and is used automatically for each logon to the Tivoli Storage Manager server. In addition, in Password Prompt mode, a password is not needed to perform functions such as running migration jobs or searching a file space.
12
Enter the name under which your client node has been registered on the Tivoli Storage Manager server.
13
Enter a password. Enter the initial password that has been assigned to your node by the Tivoli Storage Manager administrator
Enter the name of the file space that will be used as the default, to store migrated files from your client node on the Tivoli Storage Manager server. The file space will be generated automatically.
14
By default, the Backup Migratable Files option is checked. This sets the default to Backup before Migrate when creating a new migration job. If this option is unchecked, the default, when creating a migration job is not to backup before migrate. Of course the setting can be changed for each job individually.
15
If you have installed HSM Client in a clustered environment, at this point an additional information window comes up to remind you to grant proxy authority to the node you are registering:
Click Next If HSM is not running on a cluster node, you come directly to this dialog:
16
The HSM Client should connect successfully to the Tivoli Storage Manager server and you are now ready to define and run migration jobs.
17
Notes: The Tivoli Storage Manager administrator defines the policy domain to which your client node belongs. A policy domain contains policy sets and management classes that control how Tivoli Storage Manager manages the files that you migrate. The HSM Client uses its own dsm.opt file, located in the HSM Client installation directory, to store logon parameters (Tivoli Storage Manager server, node name, password mode), and does not use the dsm.opt file that is used by the Tivoli Storage Manager Backup-Archive Client. For further information about options in the Backup-Archive Client dsm.opt file, please refer to the Backup-Archive Client documentation. After specifying a new dsm.opt file or changing values in the dsm.opt file, an hsmservice restart is necessary to apply the changes. However, changing dsm.opt may lead to the situation, that stubs can not be retrieved or recalled anymore. Password and names of file spaces are also stored and managed separately from the Backup-Archive Client. They are stored and managed with the Windows registry entries of the HSM Client. However, if you choose password generate, the Tivoli Storage Manager Client API will use the registry entry of the Backup-Archive Client to store the automatically generated password. To keep the logon parameters of the HSM Client separate from those of the Backup-Archive Client, it is recommended to register under a node name different from the one used by the Backup-Archive Client.
18
This setting is used as the default selection in the job definition panel:
19
Existing migration job files from older HSM Client versions (legacy job file) can still be parsed without the backup-before-migrate attribute set. If a legacy job is run, no backup is done as the user expects the old behavior. If a legacy job is edited, the default (backup=true) applies and the user is asked to modify the backup option for that job. The value selected by the user in the New Job panel is stored in the TSM HSM job file. When a TSM HSM migration job is run, the job file information is read. For each element of the source-files section in the job file (referred to as the sourceselector) the file system is scanned, and a list of file names and stub names is created and stored in the source-selectors. If a job is marked for backup, each source-selector is processed one by one. Only files with content on disk (resident files) will be backed up.Thus, the list of files in a sourceselector is filtered and all files with the reparse point file attribute set are filtered out. The list of source files is written to a temporary file in the systems temporary directory. After a (non-empty) list of files has been successfully written to the backup list file, dsmc.exe is run as an external process, with the file list as input. File migration begins when dsmc.exe completes successfully,. If dsmc.exe returns an error, the TSM HSM command line tool ( dsmclc.exe) terminates. The GUI (dsmgui.exe) will display an error message prompts the user to whether to proceed with file migration:
20
Note: - Be aware that files backed up by TSM HSM can be indirectly removed from the Tivoli Storage Manager server backup file spaces. The possibility of such an event occurring is dependent upon the actual backup policies in use when stub files are backed up. Stub files are backed up when a full backup is run or an incremental backup is run and the Tivoli Storage Manager server has determined that the stub has changed (for example, security attributes for the stub have changed).
21
22
The new job is displayed in the Migration Jobs window and can be renamed to a user chosen name.
23
Fill in the name of the file space in which you want to store migrated files. You may use an already exiting files space or a new file space. To create a new file space select Tools->Create New File Space
24
From this tab you can define files and directories to be migrated.
25
26
Repeat the actions described above for all files to be migrated. Press OK
27
The Replace the file with a shortcut to the file space option (default) performs a migration. The Keep the original file and Delete the file options perform archiving tasks.
28
Press New Include to specify time-related conditions for the files to be migrated.
29
The following figure shows how to specify that only files that were created previous to 90 days are to be included in the migration job.
30
31
Repeat the actions described above for new Include Conditions. After you have specified all of the conditions, press OK.
Note: If the first filter is an include condition, the origin set is empty. If the first filter is an exclude condition, the origin set includes all files in the folder.
32
On the Source Files tab of the New Job window, press New Directory and Browse.
33
Click Include subdirectories when you want to include files from subdirectories. Select the migration mode.
The Replace the file with a shortcut option (default) performs a migration. The Keep the original file and Delete the file options perform archiving tasks.
34
On this tab you can specify conditions under which files are migrated by pressing either New Include or New exclude.
Select the desired condition. This example shows how to specify that files of a defined file group are included in the migration job.
35
After you have selected the condition Include Files based on Group, the following window is displayed:
You can specify whether you want to select an existing file group from a list or specify file extensions for files to be migrated. If you select a file group from the list and press Edit group, the extensions that belong to this file group are displayed. The extensions shown are the ones specified under Tools -> File groups (see section 9.1, Using File Groups).
36
Note: Even if you can edit the list of extensions to match your needs, this should not be done here because it affects the file group definition made under Tools -> File groups. If you press New file group you can define a new file group and the extensions belonging to this type. Note: The creation of a new file group is global. For example, the new type is included in the list of types under Tools -> File groups.
If you select Specify file extensions as shown below, you can either define file extension for the files to be included or you can choose the desired extensions directly from a defined file group.
Press, Pick from file group > and select the desired group. The extensions belonging to this group are displayed.
37
Note: File group definitions have global scope and can be used in all jobs. If you change definitions in the context of defining a job this will affect the file group definition made under Tools -> File groups.
You can also select the condition Include all files in a Subdirectory and browse for the subdirectories that are to be included in the migration job.
You can exclude files in directories by selecting New Exclude on the Advanced Conditions tab.
38
Specifying the files to be excluded is done either by specifying name and path of the files or by browsing as described above.
7.3 Examples The following examples illustrate the use of the file selection criteria and, in particular, how Advanced Include and Exclude Conditions are combined. If you want to migrate all files located in a specific directory, you do not have to define any Advanced Condition. Selecting the directory automatically includes all files located on this directory.
If you only want to migrate files of a specific group, you can define this as an Advanced Include Condition. Only the files matching the condition are selected for migration.
39
If you only want to migrate files of a specific group that were modified before a specific date, add an Advanced Exclude Condition for all files modified after this date. Only the files matching both conditions file extension .doc, .xls, .ppt and modified before the specified date - are selected for migration.
40
If you only want to migrate files that have not been modified for a specific period of time, you would specify an Exclude Condition based on age instead of time.
If you only want to migrate files that are larger than a defined minimum size (for example 10,000 bytes), you would specify an Exclude Condition based on file size.
41
42
After executing the command, dsmclc.exe returns a code to give a status of the processed operations. Valid return code values are: 0 - All operations completed successfully 4 - All operations completed successfully, but some files were not processed. There were no global errors or warnings. 8 - The operation completed with at least one warning or one error message. (Note: In this implementation, this is measured based on logging severity error/severe.) No error exception was received at end of operations. 12 - The operation completed with an error exception.
8.3 Scheduled
In order to start migration jobs automatically, you must configure all jobs in a standard scheduler program on the machine to run dsmclc.exe. The following example shows how to configure the Windows Scheduler to start a job weekly (each Monday at 1:00 AM). The example refers to Windows 2000.
From the Start menu select: Settings -> Control Panel -> Scheduled Tasks - > Add Scheduled Task.
43
Press Next, then press Browse to browse for the Migration Program. After you have selected the program, press Open.
Specify the time interval for the task to be performed and press Next.
44
Enter user name and password, and then confirm the password. Press Next.
45
Click the Open advanced properties for this task... box to display the properties and press Finish.
46
Fill in the settings as required. The Run parameter is: <dsmclc.exe> <jobfile_name> Note: When you have selected the program by browsing you have to manually add the name of the job file in the Run parameter (sample.osj in the above example). The job file parameter can be given as an absolute path, or relative to dsmclc.exe. Press OK. If you now select: Settings -> Control Panel -> Scheduled Tasks from the Start menu, you can view the newly specified task. To change your settings, select the task and edit is as desired.
47
To view existing file groups or to define new ones, select Tools->File Groups .
Enter the name of the file group you want to define. Enter the file extensions you want to be included in this file group.
48
Press OK.
49
The newly defined file group can now be seen in the list:
Press OK.
To delete or to edit a defined file group, select the type and press the corresponding button.
50
The disk usage of the selected job before and after migration is displayed and the saved disk space is calculated. All sizes are shown in kilobytes.
51
Select the file space in which you want to search for files. Specify at least one search criteria. If you do not specify any search criteria, you will receive a warning, and all of the files stored in the file space will be shown. Click Search
Blank fields in the Search Criteria Section will be treated as wildcards and match any string in the in the archive. You can search migrated files by Volume, Path or Filename. Volume is not, but Path and Filename are case-sensitive. All of these fields allow you to use an asterisk or question mark as wildcard characters. The question mark matches a single character; the asterisk matches zero or more characters.
52
The search result list shows the migrated files that match the search criteria. If several versions of a migrated file exist, this is shown in the Version(s) column.
53
To retrieve one file from the Tivoli Storage Manager server, perform a search as explained in section 9.3.1 Search Migrated Files and select one entry in the result list. Click on Retrieve to display the Retrieve Options window.
You can change the full path and filename to which a single file is retrieved. If more than one version of a file is found in the archive, you can select which version you want to retrieve. The date shown in the Version list is the last modification time. Proceed with Retrieve.
54
Search the repository Select the file to be retrieved Click on Retrieve Enter the new target directory
Or
To retrieve a selection from the repository, perform a search as explained in 9.3.1 and select entries in the result list. Click on Retrieve to display the Retrieve Options window. By default, files will be retrieved to their original location. Optionally, a directory can be specified to which files shall be retrieved. If you check the Preserve Pathnames checkbox the directory tree will be retrieved below the given directory. Otherwise all files will be retrieved to the specified directory.
55
Search the repository Select the files to retrieve Click on Retrieve Specify whether the files should be retrieved to the original location or to a new directory and if pathnames should be preserved. Click on Retrieve
9.4 Quota
The Administration GUI provides the possibility to define and view recall-quotas. (quotas) With quotas the number of possible recalls during a timeframe can be restricted system wide (Default Quota) or for particular Windows (local or domain) users and groups. When a quota is exceeded, a subsequent recall request is rejected and the hsm-driver (ithsmdrv.sys) returns the code STATUS_FILE_IS_OFFLINE. The actual behavior of the calling application depends on the response of this application to this return code. Quotas only affect the (user)recall with hsmservice. Quotas do not have any influence on retrieving files with the administration GUI. - Default quota defines the general number of possible recalls in a time unit and affects all users and groups, for which no user or group specific quota has been defined. - Group quotas define the allowed number of recalls in a time unit for user groups. If a user is a member of two or more groups and has no defined user quota, the group with the least restrictive quota will be applied for this user. - User quotas define the allowed number of recalls in a time unit for an individual user. If a user quota is defined, only this quota is applied for the user. Default and group quota do not have any influence in this case. Group and user quotas can be defined for local users and groups as well as for Active Directory (Domain) users and groups (domain local groups). Quotas currently cannot be defined for domain global groups. Quotas can be updated at any time using the GUI. The update is effective immediately. A restart of hsmservice is not required. The quota configuration is stored in ..\<hsmclient_installdir>\config\quota.cfg. After changing quotas, a backup of quota.cfg is saved in ..\<hsmclient_installdir>\config\backup\quota.cfg
56
Now you can change the Default Quota, User Quota, or Group Quota: 9.4.1.1 Default Quota After clicking the Default Quota 'Change' button, you can choose between Unlimited Recalls, No Recalls or Configure Quota. For unlimited or no recall, just choose the corresponding entry and click OK
If you choose Configure Quota, you can select the number of files to be recalled within a time span. In the screenshot, the quota is set to 1 file per day. Instead of Day(s), you can also choose hours, minutes or seconds.
57
9.4.1.2 User Quota Choosing User Quota opens the following dialog. In the Look in combo-box you can choose whether you want to assign quotas to local or domain users. You can filter users by entering a name or a part of a name and pressing Filter. If you have assigned a quota to a user, you can delete the quota, by selecting the user and clicking Delete.
58
9.4.1.3 Group Quotas Choosing Group Quota brings you to following dialog. In the Look in combo-box you can choose whether you want to assign quotas to local or domain local groups. For clarity you can filter groups by entering a name or a part of a name and pressing Filter. If you have assigned a quota to a group, you can delete the quota, by selecting the group and clicking Delete.
59
60
In this window you can see all users with assigned quota. In the second column you can see the type of the assigned quota and in the third column the quota is shown. For clarity, you can filter users by entering a name or a part of a name and pressing Filter.
To apply the changes, the Administration GUI must be restarted. Regional settings are available for 14 languages (English, Simplified Chinese, Traditional Chinese, Czech, German, Spanish, French, Hungarian, Italian, Japanese, Korean, Polish, Brazilian Portuguese and Russian).
10 Tools
The Tivoli Storage Manager for HSM for Windows package contains three tools for analysis purposes. After installation, you can find these tools in your installation directory: dsminfo.exe dsmfileinfo.exe dsmfind.exe
61
10.1 dsminfo.exe
dsminfo.exe lists various settings of your installation such as the version of libraries, actual log level settings, the operating system version, and disk information. When you load dsminfo.exe from the command line without a parameter, you will see all of the available options, as shown below.
Command Line HSM Info Interface - Version 5, Release 4, Level 0.0 Copyright by IBM Corporation and other(s) 2005, 2007. All Rights Reserved Options: help print this message all print all save save output to check_installation.txt (any further run of the program will delete this file) errors print only messages containing installation errors installdir print the installation dir files check if all required files are present stamps shows version information of IBM Tivoli HSM binaries clclog print dsmclc log level set guilog print dsmgui log level set servicelog print hsmservice log level set tivoli check version of Tivoli backup client and of its APIs ip print local machine IP addresses win print windows version and fix pack disk print hard disk(s) info user print current user version print HSM client version driver print HSM file system driver version Print information about HSM client installation Usage: dsminfo [OPTION]... A log file called dsminfo.log will be created Example: dsminfo servicelog
62
10.2 dsmfileinfo.exe
The dsmfileinfo.exe program lists attributes of migrated and non-migrated files. When you load dsmfileinfo.exe from the command line without a parameter, you will see all of the available options, as shown below.
Command Line HSM File Information Interface - Version 5, Release 4, Level 0.0 Copyright by IBM Corporation and other(s) 2005, 2007. All Rights Reserved Usage: dsmfileinfo [-r] <filename> Options: -a - show all (-m -q -r -s -t) -t - show file times, size and attributes (default) -r - show reparse data (stubs only) -m - calculate MD5 key (files only) -q - query backend version(s) (stubs only) dsmfileinfo provides file information.
10.3 dsmfind.exe
The dsmfind.exe program lists files that are eligible by a job file or that correspond to a pattern. When you load dsmfind.exe from the command line without a parameter, you will see all of the available options, as shown below.
Command Line HSM File Find Interface - Version 5, Release 4, Level 0.0 (c) Copyright by IBM Corporation and other(s) 2005, 2007. All Rights Reserved Usage: dsmfind <jobfile|pattern> Options: -r - recurse (pattern only) -s - stubs only (pattern only) dsmfind lists files
63
These parameters define how the log file is handled by each component: LogFilePercent Defines which percentage of a log file shall be kept when LogFileSize is reached. The rest is truncated from the oldest log data. The default value for LogFilePercent is 66. Example: The default for LogFilePercent is 66. This means, that the oldest 34 percent of log-messages are deleted, when LogFileSize is reached. LogFileSize Defines the maximum size of a log file in kilobytes. When this limit is reached, the oldest data is deleted corresponding to LogFilePercent. The default value for LogFileSize is 10 MB. LogLevel Defines, which type of messages are written to the log file: Logging Level: Message Type: Log File Prefix ----------------------------------------------------------------------------------------0x00000001 Error E: 0x00000002 Severe S: 0x00000010 Warning W: 0x00000100 Information I: 0x00001000 Trace T: 0x00010000 Debug D: 0x00100000 Dump X: 0x00200000 Flush F: 0x00400000 Driver K: 0x01000000 Event C:
64
0x10000000
Library
L:
The default level is 0x10000113 (S, E, W, I, L). The log file can be written in ASCII or Unicode. The registry key LogFileUcs2 defines if the log file is written in ASCII or in Unicode. By default the value is set to 0 (ASCII). For Unicode, change the value to 1
To change the log file settings, change the corresponding registry entry.
65
The log file settings for administration GUI can also be changed directly from the GUI:
Press OK.
Note: These settings affect the log level of the Administration GUI only. Logging is very important for problem analysis. If problems occur, in most cases Log Files with a high log level (0x11711113, or simply 0xFFFFFFFF) need to be provided to the IBM support team. Error, Warning and Information Logging Messages are turned on by default and should never be switched off.
66
Trace messages are important to reconstruct the program flow. Debug messages are used to understand several situations in more detail. Library messages are error messages issued by external libraries. Under Log File Directories, the path to the log-files and to the listing-files can be changed.
These parameters define how the log file is handled by each component: AdminLogFilePercent Defines which percentage of a log file is kept when LogFileSize is reached. The rest is truncated from the oldest log data. The default value for LogFilePercent is 66. Example: The default for LogFilePercent is 66. This means that the oldest 34 percent of log-messages are deleted, when LogFileSize is reached. AdminLogFileSize Defines the maximum size of a log file in kilobytes. When this limit is reached, the oldest data is deleted corresponding to LogFilePercent. The default value for LogFileSize is 10 MB. The log file can be written in ASCII or Unicode (UCS-2). The registry key AdminLogFileUcs2 defines whether the log file is written in ASCII or in Unicode. By default, the value is set to 0 (ASCII). For Unicode, change the value to 1. The administrative log shows only errors and warnings. The log level of the administrative log cannot be changed.
67
The default value is 4. The maximum value is 64. Note: Change this parameter only on technical advice from IBM. After the value has been changed the hsmservice must be restarted.
The default value is 600 seconds. Note: If a file has been recalled from a tape, the connection is reset. This ensures that the tape is not locked after the recall. After the value has been changed the hsmservice must be restarted.
68
The default value is 60 seconds. If you migrate or recall very large files, use a slow tape device, or if the network is slow, it may be necessary to increase this value.
69
12.6 Listfiles
Every migrate, retrieve, delete or recall operation generates an entry in a file in the listings directory. A migrate, retrieve or delete listing shows date, time, filename, version and result of the transaction for all of the files processed in the executed job. A recall listing shows date, time, filename, version, result and the user who initiated the recall of a file. The directory where listings are saved can be changed in HKLM\SOFTWARE\IBM\ADSM\CurrentVersion\HsmClient\ListingsDir or by changing the path in the Administration GUI (see section 11.1 Log file settings). Listfiles can be written in ASCII or Unicode. The registry key ListFileUcs2 defines if the listfile is written in ASCII or in Unicode. By default, the value is set to 0 (ASCII). For Unicode, change the value to 1. The location in the registry is: HKLM\SOFTWARE\IBM\ADSM\CurrentVersion\HsmClient\<programname>\ListFileUcs2
13 Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
70
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions; therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information that has been exchanged, should contact: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.
71
13.1 Trademarks
The following terms are trademarks of the International Business Machines Corporation in the United States, other countries, or both: IBM Tivoli TotalStorage Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others.
14 Glossary
Archiving
HSM Client
Quotas
The process of storing files in a Tivoli Storage Manager File Space and either keeping the original file or deleting the original file dsmfind.exe lists files that are eligible by a job file or that correspond to a pattern dsmfileinfo.exe lists attributes of migrated and non migrated files dsminfo.exe lists various settings of your installation A Windows 2000 or Windows 2003 file server with an NTFS file system, on which the HSM Client may run. Synonym for Tivoli Storage Manager for HSM for Windows. The term Client is used as Tivoli Storage Manager for HSM for Windows acts as a Tivoli Storage Manager Client A file containing a migration job The process of storing files in a Tivoli Storage Manager File Space transparent to users of these files. Execution of a migration job. A set of rules defining criteria for the selection of files for migration. A computer running the HSM Client The name under which the HSM Client registers with a Tivoli Storage Manager server The Administration GUI provides the
72
Recall
Reparse point
Retrieve
Sparse file
Stub
possibility to define and view recall-quotas The process of accessing migrated files from a Tivoli Storage Manager File Space transparent to the user. The files are recalled to their original location in the local file system. A feature of NTFS redirecting IO requests to a file system filter driver loaded into the Windows kernel space. The administrative function to retrieve files from a Tivoli Storage Manager file space to a local file system. Migrated files can be retrieved to the original location in the file system or to a new location. When several versions of a file have been migrated each of the versions can be retrieved. A file that allocates disk space only for regions that do not contain blocks of zero data. The sparse files generated by the HSM Client consume one cluster of disk space. A short cut on the Windows file system generated by the HSM Client for a migrated file to allow transparent user access. The sparse file representation of a migrated file, with a reparse point attached.
End of Document
73