Note!
Before using this information and the product it supports, read the general information in "Notices".
Edition notice
This edition applies to Version 5.5 of the IBM Tivoli Storage Manager (5608-HSM), IBM Tivoli Storage Manager
Extended Edition (5806-ISX), Tivoli Storage Manager HSM for Windows (5608-HSM), and to any subsequent
releases until otherwise indicated in new editions or technical newsletters.
Changes since the previous edition are marked with a vertical bar (|) in the left margin. Ensure that you are using
the correct edition for the level of the product.
© 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.
Contents
Tables . . . . . . . . . . . . . . . v
About this book . . . . . . . . . . . vii
Who should read this book . . . . . . . . . vii
Publications . . . . . . . . . . . . . . vii
Support information . . . . . . . . . . . vii
Getting technical training . . . . . . . . viii
Searching knowledge bases . . . . . . . . viii
Contacting IBM Software Support . . . . . . ix
Conventions used in this manual . . . . . . xi
Accessibility features . . . . . . . . . . xi
What’s new for V5.5.0 HSM for Windows client . . xii
Chapter 1. HSM for Windows client
overview . . . . . . . . . . . . . . 1
Prerequisites and considerations . . . . . . . . 2
Migration overview . . . . . . . . . . . . 3
Stub file overview . . . . . . . . . . . . 4
Reconciliation overview . . . . . . . . . . 4
Client commands and GUI overview . . . . . . 5
Chapter 2. Installing the HSM for
Windows client . . . . . . . . . . . . 7
Considerations for a clustered environment
installation . . . . . . . . . . . . . . . 7
Clustered configuration installation steps . . . . 9
Installing in user mode . . . . . . . . . . . 9
Installing in network mode . . . . . . . . . 10
Registering the HSM for Windows client . . . . 10
Chapter 3. Using the HSM for Windows
client GUI . . . . . . . . . . . . . 11
Running the HSM for Windows client Configuration
Wizard . . . . . . . . . . . . . . . . 12
File groups overview . . . . . . . . . . . 17
Creating a new file group . . . . . . . . 17
Edit a file group . . . . . . . . . . . . 18
File recall quotas . . . . . . . . . . . . 18
Viewing file recall quotas . . . . . . . . . 19
Defining file recall quotas . . . . . . . . 19
Creating a new file space . . . . . . . . . . 21
Regional settings . . . . . . . . . . . . 22
Chapter 4. Migration jobs . . . . . . . 23
Backing up files before migrating them . . . . . 23
Creating migration jobs . . . . . . . . . . 24
Examples of including and excluding files . . . . 32
Calculate a migration job’s space savings . . . . 37
Executing migration jobs . . . . . . . . . . 38
Running migration jobs from the HSM for
Windows client GUI . . . . . . . . . . 38
Running migration jobs with other applications’
output . . . . . . . . . . . . . . . 38
Scheduling a migration job . . . . . . . . 38
Chapter 5. Retrieving migrated or
archived files . . . . . . . . . . . . 43
Chapter 6. Configuring reconciliation 47
Changing volume mount paths . . . . . . . . 49
Chapter 7. Using commands . . . . . 51
dsmclc.exe . . . . . . . . . . . . . . . 51
dsmfileinfo.exe . . . . . . . . . . . . . 52
dsmfind.exe . . . . . . . . . . . . . . 53
dsmhsmclc.exe . . . . . . . . . . . . . 53
dsminfo.exe . . . . . . . . . . . . . . 55
dsmReconConverter.exe . . . . . . . . . . 56
Chapter 8. Backup-archive client
integration overview . . . . . . . . . 59
HSM for Windows client backup integration with
the backup-archive client . . . . . . . . . . 60
Impacts of changing file encryption . . . . . 61
Restoring HSM files with the backup-archive client 62
Chapter 9. HSM advanced parameters
and file location settings . . . . . . . 65
File location preferences . . . . . . . . . . 65
Recall service settings . . . . . . . . . . . 66
Recall quota entries deletion interval . . . . . . 67
Tracing preferences . . . . . . . . . . . . 67
Chapter 10. Problem determination . . 71
Troubleshooting steps and information . . . . . 71
Antivirus considerations . . . . . . . . . . 72
Appendix. HSM for Windows messages
reference . . . . . . . . . . . . . . 73
Notices . . . . . . . . . . . . . . 99
Trademarks . . . . . . . . . . . . . . 100
Glossary . . . . . . . . . . . . . 103
Index . . . . . . . . . . . . . . . 105
© Copyright IBM Corp. 2005, 2007 iii
||
||
| | | |
| |
| |
| | | | | | | | | |
| |
| |
Tables
1. Summary of version 5.5.0 HSM for Windows
client changes . . . . . . . . . . . xiii
2. Node Registry Entries . . . . . . . . . 8
3. HSM for Windows client GUI functions 11
4. Example base file set . . . . . . . . . 33
5. Summary of include and exclude examples 33
6. Target set for include condition example 1 33
7. Target set for exclude condition example 2 34
8. Target set for exclude condition example 3 34
9. Target set for include conditions example 4 35
10. Target set for exclude conditions example 5 35
11. Incorrect target set for include and exclude
conditions in example 6a . . . . . . . . 35
12. Correct target set for include and exclude
conditions in example 6b . . . . . . . . 36
13. Example target set for example 7 redundant
exclude condition . . . . . . . . . . 36
14. Reconcile settings window field descriptions 49
15. HSM for Windows client command shell
commands . . . . . . . . . . . . . 51
16. dsmclc.exe command prompt options . . . . 51
17. dsmclc.exe return codes . . . . . . . . 52
18. Command line options for dsmfileinfo.exe 52
19. Command line options for dsmfileinfo.exe 53
20. dsmcsmclc command variable descriptions 54
21. dsmhsmclc.exe command examples . . . . 54
22. Command line options for dsminfo.exe 55
23. dsmReconConverter command variable
descriptions . . . . . . . . . . . . 56
24. Backup-archive HSM for Windows option
names . . . . . . . . . . . . . . 59
25. Advanced parameters descriptions . . . . . 65
26. Tracing preferences window field definitions 68
© Copyright IBM Corp. 2005, 2007 v
||| | |
| | | |
| | | | | |
| |
About this book
This book provides information to help you perform the following tasks:
v Installing the HSM for Windows client
v Registering the HSM for Windows client with a Tivoli Storage Manager server
v Configuring the HSM for Windows client
v Defining migration jobs
v Configuring reconciliation
v Executing and scheduling migration jobs
v Performing additional administration functions such as search and retrieve
migrated and archived files
v Using tools for problem analysis
v Setting log levels for problem analysis
Who should read this book
This book is mainly intended for persons who are responsible for installing, setting
up, and administering the HSM for Windows client.
Publications
Tivoli Storage Manager publications and other related publications are available
online.
You can search all the Tivoli Storage Manager publications in the Information
Center: http://publib.boulder.ibm.com/infocenter/tivihelp/v1r1/index.jsp
You can download PDF versions of publications from the IBM® Publications
Center:
http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi
You can also order some related publications from this Web site. The Web site
provides information for ordering publications from countries other than the
United States. In the United States, you can order publications by calling
800-879-2755.
Support information
You can find support information for IBM products from a number of different
sources:
v “Getting technical training” on page viii
v “Searching knowledge bases” on page viii
v “Contacting IBM Software Support” on page ix
© Copyright IBM Corp. 2005, 2007 vii
Getting technical training
Information about Tivoli® technical training courses is available online.
http://www.ibm.com/software/tivoli/education/
Searching knowledge bases
If you have a problem with Tivoli Storage Manager, there is a variety of
knowledge bases you can search.
You can begin with the Information Center, from which you can search all the
Tivoli Storage Manager publications: http://publib.boulder.ibm.com/infocenter/tivihelp/v1r1/index.jsp
Searching the Internet
If you cannot find an answer to your question in the information center, search the
Internet for the latest, most complete information that might help you resolve your
problem.
To search multiple Internet resources, go to the support web site for Tivoli Storage
Manager: http://www.ibm.com/software/sysmgmt/products/support/IBMTivoliStorageManager.html. From this section, you can search a variety of
resources including:
v IBM technotes
v IBM downloads
v IBM Redbooks™
If you still cannot find the solution to your problem, you can search forums and
newsgroups on the Internet for the latest information that might help you resolve
your problem.
Using IBM Support Assistant
The IBM Support Assistant is a free, stand-alone application that you can install on
any workstation. You can then enhance the application by installing
product-specific plug-in modules for the IBM products you use.
The IBM Support Assistant helps you gather support information when you need
to open a problem management record (PMR), which you can then use to track the
problem. The product-specific plug-in modules provide you with the following
resources:
v Support links
v Education links
v Ability to submit problem management reports
For more information, see the IBM Support Assistant Web site at
http://www.ibm.com/software/support/isa/
viii IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Finding product fixes
A product fix might be available to resolve your problem. You can determine what
fixes are available by checking the product support Web site.
1. Go to the IBM Software Support Web site: http://www.ibm.com/software/tivoli/products/storage-mgr/product-links.html
2. Click the Support Pages link for your Tivoli Storage Manager product.
3. Click Fixes for a list of fixes for your product.
4. Click the name of a fix to read the description and optionally download the fix.
Getting E-mail notification of product fixes
You can sign up to receive weekly E-mail notifications about fixes and other news
about IBM products.
1. From the support page for any IBM product, click My support in the
upper-right corner of the page.
2. If you have already registered, skip to the next step. If you have not registered,
click register in the upper-right corner of the support page to establish your
user ID and password.
3. Sign in to My support.
4. On the My support page, click Edit profiles in the left navigation pane, and
scroll to Select Mail Preferences. Select a product family and check the
appropriate boxes for the type of information you want.
5. Click Submit.
6. For E-mail notification for other products, repeat steps 4 and 5.
Contacting IBM Software Support
Before you contact IBM Software Support, you must have an active IBM software
maintenance contract, and you must be authorized to submit problems to IBM. The
type of software maintenance contract that you need depends on the type of
product you have.
v For IBM distributed software products (including, but not limited to, Tivoli,
Lotus®, and Rational® products, as well as DB2® and WebSphere® products that
run on Windows® or UNIX® operating systems), enroll in Passport Advantage®
in one of the following ways:
Online
Go to the Passport Advantage Web page (http://www.ibm.com/software/sw-lotus/services/cwepassport.nsf/wdocs/passporthome) and
click How to Enroll
By phone
For the phone number to call in your country, go to the IBM Contacts
Web page (http://techsupport.services.ibm.com/guides/contacts.html)
and click the name of your geographic region.v For IBM eServer™ software products (including, but not limited to, DB2 and
WebSphere products that run in zSeries®, pSeries®, and iSeries™ environments),
you can purchase a software maintenance agreement by working directly with
an IBM sales representative or an IBM Business Partner. For more information
about support for eServer software products, go to the IBM Technical Support
Advantage Web page: http://www.ibm.com/servers/eserver/techsupport.html.
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. For a list of telephone
About this book ix
numbers of people who provide support for your location, go to the IBM Contacts
Web page, http://techsupport.services.ibm.com/guides/contacts.html, and click
the name of your geographic region.
Perform these actions to contact IBM Software Support:
1. Determine the business impact of your problem.
2. Describe your problem and gather background information.
3. Submit your problem to IBM Software Support.
Determine the business impact
When you report a problem to IBM, you are asked to supply a severity level.
Therefore, you need to understand and assess the business impact of the problem
you are reporting.
Severity 1 Critical business impact: You are unable to use the program,
resulting in a critical impact on operations. This condition
requires an immediate solution.
Severity 2 Significant business impact: The program is usable but is
severely limited.
Severity 3 Some business impact: The program is usable with less
significant features (not critical to operations) unavailable.
Severity 4 Minimal business impact: The problem causes little impact on
operations, or a reasonable circumvention to the problem has
been implemented.
Describe your problem and gather background information
When explaining a problem to IBM, be as specific as possible. Include all relevant
background information so that IBM Software Support specialists can help you
solve the problem efficiently.
To save time, know the answers to these questions:
v What software versions were you running when the problem occurred?
v Do you have logs, traces, and messages that are related to the problem
symptoms? IBM Software Support is likely to ask for this information.
v Can the problem be re-created? If so, what steps led to the failure?
v Have any changes been made to the system? For example, hardware, operating
system, networking software, and so on.
v Are you currently using a workaround for this problem? If so, be prepared to
explain it when you report the problem.
Submit your problem to IBM Software Support
You can submit your problem to IBM Software Support online or by phone.
Online
Go to the ″Submit and track problems″ page on the IBM Software Support
site http://www.ibm.com/software/support/probsub.html . Enter your
information into the appropriate problem submission tool.
By phone
For the phone number to call in your country, go to the contacts page of
the IBM Software Support Handbook on the Web and click the name of
your geographic region.
x IBM Tivoli Storage Manager HSM for Windows: Administration Guide
If the problem you submit is for a software defect or for missing or inaccurate
documentation, IBM Software Support creates an Authorized Program Analysis
Report (APAR). The APAR describes the problem in detail. Whenever possible,
IBM Software Support provides a workaround for you to implement until the
APAR is resolved and a fix is delivered. IBM publishes resolved APARs on the
IBM product support Web pages daily, so that other users who experience the
same problem can benefit from the same resolutions.
Conventions used in this manual
This manual uses the following typographical conventions:
Example Description
autoexec.ncf
hsmgui.exe
A series of lowercase letters with an extension indicates program file
names.
DSMI_DIR A series of uppercase letters indicates return codes and other variables
or values.
dsmQuerySessInfo Boldface type indicates a command that you type on a command line,
the name of a function call, the name of a structure, a field within a
structure, or a parameter.
dateformat Italic type indicates an option, the value of an option, a new term, a
placeholder for information you provide, or for special emphasis in the
text.
maxcmdretries Monospace type indicates fragments of a program or information as it
might appear on a display screen, such a command example.
plus sign (+) A plus sign between two keys indicates that you press both keys at the
same time.
Accessibility features
Accessibility features help a user who has a physical disability, such as restricted
mobility or limited vision, to use software products successfully. The major
accessibility features of Tivoli Storage Manager are described in this topic.
v Server and client command-line interfaces provide comprehensive control of
Tivoli Storage Manager using a keyboard.
v The Windows client-graphical interface can be navigated and operated using a
keyboard.
v The Web backup-archive client interface is HTML 4.0 compliant, and accessibility
is limited only by the choice of Internet browser.
v All user documentation is provided in HTML and PDF format. Descriptive text
is provided for all documentation images.
v The Tivoli Storage Manager for Windows Console follows Microsoft®
conventions for all keyboard navigation and access. Drag and Drop support is
handled using the Microsoft Windows Accessibility option known as
MouseKeys. For more information about MouseKeys and other Windows
accessibility options, please refer to the Windows Online Help (keyword:
MouseKeys).
About this book xi
What’s new for V5.5.0 HSM for Windows client
Before installing and using version 5.5.0 of the HSM for Windows client, fully
review this list of changes. Some changes require you to plan how you first use
V5.5.0 of the HSM for Windows client so you don’t encounter an out-of-space
condition.
xii IBM Tivoli Storage Manager HSM for Windows: Administration Guide
|
||||
Table 1 provides a summary of the 5.5.0 enhancements.
Table 1. Summary of version 5.5.0 HSM for Windows client changes
Area Description
Stub file integrity
and
backup-client archive
integration
Enhanced integration with the backup-archive client ensures there
is a current copy of the file content in a Tivoli Storage Manager
server backup for each backed up stub file. With this enhancement
you are always able to recreate the complete file from the backup,
even if the IBM TSM HSM Recall Service is not is running. Before
V5.5.0, a backup or archive of a migrated file backed up the stub
independently from previous backups and thus the backup-archive
client could not restore the complete file. Now a stub is only
backed up if a current copy of the resident file exists in the backup.
The stub is still backed up as such, but the copy of the resident file
and the stub are bound together on the Tivoli Storage Manager
server.
The following considerations can help you plan your use of V5.5.0
features:
v The object containing the file content is not expired from the
server as long as there is still a stub object that references it.
v If the complete file has not been backed up before, a migrated
file is recalled to the local file system and then sent to the
backup storage pool. You can configure the HSM for Windows
client to backup all files before migration so the recall of a
migrated file that is not backed up does not occur.
v The backup-archive client only archives the contents of a
migrated file and never the stub file. The same is true for
selective backup. The migrated files are recalled during archive
or selective backup operation. Only incremental backups backs
up stub files as such.
v In order to avoid an out-of-space condition caused by the recall
of non-backed up files, see Chapter 8, “Backup-archive client
integration overview,” on page 59.
v To use the full integration of V5.5 of the HSM for Windows
client backup-archive client you cannot use a version prior to
V5.5 for either the backup-archive client or the Tivoli Storage
Manager server.
v To control the space usage of the file system, the backup-archive
client has a new backup option Skip migrated files
(SKIPMIGRATED), (see “HSM for Windows client backup
integration with the backup-archive client” on page 60).
Additional integration affects the backup-archive client restore
function. One option determines whether the backup-archive client
restores just the stub or the resident file. Another option determines
whether the backup-archive client checks the integrity of the stub
(see “Restoring HSM files with the backup-archive client” on page
62):
v Restore as migrated file (RESTOREMIGSTATE)
v Restore resident if not accessible
(RESTORECHECKSTUBACCESS)
About this book xiii
|
||
||
||||
||||||||||||
||
||
|||||
|||||
|||
||||
||||
||||||
|
||
Table 1. Summary of version 5.5.0 HSM for Windows client changes (continued)
Area Description
reconciliation
and
orphan stubs
Prior to V5.5.0, if a migrated file was deleted locally or was
modified and migrated again, obsolete copies remained on the
Tivoli Storage Manager server. With V5.5.0, reconciliation deletes
these obsolete files from the server.
As well, if a stub file in the file system has no corresponding object
in the HSM archive (an orphan), the HSM for Windows client
generates a message in the hsmmonitor-admin.log and writes the
name of the file in the hsmmonitor-orphan.log. The volume is
processed, but no files are deleted. You then check the log for any
orphans and restore them from the backup.
You configure and run reconciliation using the new dsmhsmclc.exe
command or the HSM for Windows client graphical user interface
(GUI). Prior to reconciling any system, see “Reconciliation
overview” on page 4 to ensure you have the information you need.
For example, you might need to run the new command,
dsmReconConverter.exe, to convert the old stub files to the new
reconciliation format (see “dsmReconConverter.exe” on page 56).
Configuration tools The following settings are configurable in the HSM for Windows
client:
v Log settings for all applications
v Trace file and listings file settings
v File recall settings
v Reconciliation settings
Performance enhancements
Migrating files The following list describes some scalability and file system scan
improvements:
v Memory handling uses far less RAM to build candidate lists.
v File scanning, backup before migration (if used), and file
migration occur in parallel to speed up migration.
The following list describes some improved migration processing:
v Splitting of file reading processes allows parallel buffer read and
writes.
v Detailed status information is displayed during migration.
Retrieving files v The HSM console sorts file retrieval by tape order so the Tivoli
Storage Manager server retrieval time is reduced.
v The HSM console eliminated a re-query step to the Tivoli Storage
Manager server by storing a key for each file.
v Files can now be retrieved when the IBM TSM HSM Recall
Service is not running. A Tivoli Storage Manager HSM
administrator can use the dsmclc command or the HSM for
Windows client GUI.
Recalling files Restart is no longer required to make Tivoli Storage Manager
service configuration changes, such as changing the number of
recall threads.
Filter driver
enhancements
Improved memory usage of the HSM file system filter driver
allows a quicker file recall and reduces uses of Windows
non-paged pool memory.
xiv IBM Tivoli Storage Manager HSM for Windows: Administration Guide
|
||
|||
||||
||||||
|||||||
|||
|
|
|
|
|
|||
|
||
|
||
|
|||
||
||||
||||
|||||
Table 1. Summary of version 5.5.0 HSM for Windows client changes (continued)
Area Description
Messages In V5.5.0 of the HSM for Windows client, there are additional
messages written by the driver to the trace files to help with
support of the product. These messages are only written to the
trace file, not to the administrative log, and need to be set in the
Tracing Preferences window of the HSM for Windows client GUI
(see “Tracing preferences” on page 67).
About this book xv
|
||
||||||||
Chapter 1. HSM for Windows client overview
IBM Tivoli Storage Manager for HSM for Windows client provides Hierarchical
Storage Management (HSM) for Windows NTFS file systems.
HSM is a data storage system that automatically moves data between high-cost
and low-cost storage media. HSM exist because high-speed storage devices, such
as hard disk drives, are more expensive per byte stored than slower devices, such
as optical discs and magnetic tape drives. While it would be ideal to have all data
available on high-speed devices all the time, this is prohibitively expensive for
many organizations. Instead, you can use HSM to store the bulk of your
enterprise’s data on slower devices, and then copy data to faster disk drives only
when needed.
In effect, HSM turns the fast disk drives into caches for the slower mass storage
devices. The HSM for Windows client monitors the way files are used and lets you
automate policies as to which files can safely be moved (migrated) to slower
devices and which files should stay on the hard disks.
The HSM for Windows client manages the migration of individual files, files from
parts of NTFS file systems, or complete NTFS file systems to remote storage in
IBM Tivoli Storage Manager. The migration of files is transparent to Windows
users and applications. Windows users see migrated files the same as any file that
is physically stored on the file system. Migrated files can be accessed the same as
any other file and opened and updated by the Windows application corresponding
to the file extension.
In addition to the migration and recall of files and the reconciliation of file
systems, the HSM for Windows client provides additional functions beyond the
scope of traditional HSM:
v An administrator can define migration jobs for each volume, including or
excluding files based on the file type (extension) and various criteria related to
the age of a file (creation, modification, last access). The files eligible for each
migration job can be stored in separate file spaces in Tivoli Storage Manager
storage.
v An administrator can define recall quotas to limit the number of file recalls
during a specified time period. Quotas can be a system wide default quota or
particular user and group quotas.
v The HSM for Windows client can also be used for archiving purposes. In this
case, files are purely archived in Tivoli Storage Manager and the original files
are either kept on disk or deleted.
v Search and retrieve options are available to the administrator for migrated and
archived files. Selected files or complete file spaces can be retrieved either to
their original location in the file system or to a different location in the file
system.
v When migrated files are recalled and changed by a user, several versions of a
migrated file are kept in Tivoli Storage Manager storage until the file system
was reconciled. A user recall always accesses the latest version of a file.
However, an administrator can retrieve any available version of a file.
The following are some advantages of these facilities beyond those of the classical
HSM approach:
© Copyright IBM Corp. 2005, 2007 1
|
v The scope of individual migration jobs can be limited with regard to the number
of files and data volume.
v Individual jobs can be executed at different times.
v Migration jobs can be organized according to the logical structure of a volume
(including different parts of the directory structure) and thus potentially reflect
the structure of an organization or user groups, etc.
v 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 for Windows client comes with a comprehensive graphical user interface
(HSM for Windows client GUI), which you use to define and run migration jobs,
reconciliation, searches and file retrieval, and to define general settings. You can
also use several executables from a Windows command prompt (see Chapter 7,
“Using commands,” on page 51).
On each file server where an HSM for Windows 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 for Windows client administrator can initiate immediate
execution of a migration job directly from the HSM for Windows client GUI. It is
highly recommended to have a valid backup before migrating any file. This can be
ensured by selecting the ″backup before migrate″ option when you define a
migration job in the HSM for Windows client GUI. When a security descriptor is
changed on a migrated file on the file server, the next migration job on that file
will recall and remigrate the file, so that the security of the file is stored correctly
on the Tivoli Storage Manager Server.
The HSM for Windows 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 for Windows client
have a worldwide unique ID, which has been provided and registered by
Microsoft. The HSM for Windows client supports local NTFS file systems under
Windows 2003. Windows® FAT partitions are not supported. With regard to the
Tivoli Storage Manager server, the HSM for Windows client acts as a Tivoli Storage
Manager client exploiting the Tivoli Storage Manager Client’s archiving API.
Prerequisites and considerations
Before installing and using the HSM for Windows client review these prerequisites
and considerations.
v The IBM Tivoli Storage Manager Backup-Archive Client must be installed on the
file server before you can use the HSM for Windows client. To use the V5.5 HSM
for Windows client integration with the backup-archive client, you must also use
V5.5 of the backup-archive client. IBM Tivoli Storage Manager is a separate
client-server licensed program that provides storage management services.
v The HSM for Windows client requires complete implementation of the NTFS V5
file system. In particular reparse points and sparse files must be fully supported.
Specifically the HSM for Windows client runs on a 32 bit Windows 2003 Server
or Enterprise Server (original version, SP1, R2, or SP2).
2 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
v The machine on which the HSM for Windows client is installed must have at
least: a Pentium® processor, 512 MB of memory, and 50 MB of available disk
space.
v An incremental backup of migrated files usually does not recall the data in the
file but backs up the stub (the sparse file representation of a migrated file with a
reparse point attached).
v A restore with the backup-archive client transparently either restores the stub or
the resident file, depending on the configuration and the content of the HSM
archive.
v Before you migrate files with the HSM for Windows client you should back up
the original files using the backup-archive client or by selecting the Backup
Migratable Files check box during configuration (see “Running the HSM for
Windows client Configuration Wizard” on page 12).
v Before you recall files ensure that sufficient space is available on the volume. If
an NTFS volume that is completely full, the behavior of Tivoli Storage Manager
is undetermined.
v The hostname of the HSM file server must not be changed. Otherwise retrieving
or recalling data will be impossible.
v The HSM for Windows client by default only migrates files larger than 4 kb 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
kilobyte value: HKLM\SOFTWARE\IBM\ADSM\CurrentVersion\HsmClient\dsmclc\FileSizeMinimum for dsmclc.exe and HKLM\SOFTWARE\IBM\ADSM\CurrentVersion\HsmClient\dsmgui\FileSizeMinimum for dsmgui.exe
v Jobs that have been defined with actions of Delete or Keep supersede the
registry key FileSizeMinimum as well as the volume cluster size and the hard
coded limit of 4 kb. The result is that jobs with actions Delete or Keep archive
files independently from the file size. However, your administrator can specify
file size limits in archiving jobs.
Migration overview
Migration is the core process you perform with the HSM for Windows client.
Although you can migrate files at any time from a command line, most migrations
occur from scheduled migration jobs. Migration jobs are defined thru the HSM for
Windows GUI.
When the HSM for Windows client migrates a file, that file is moved from the
client to another, usually less expensive, form of storage on the Tivoli Storage
Manager server. A placeholder stub of the file is left on the client to enable recall of
the migrated file if a user needs that file. This recall happens automatically and
transparently via the stub. You can also use the HSM for Windows client to archive
files when defining a migration job. Migration jobs are policies that define a set of
files to be migrated. When the Delete or Keep options are selected when defining
a migration job, archiving is performed instead of migration.
Some policy parameters for defining migration jobs are:
v Include/exclude by directory
v Include/exclude by file size
v Include/exclude by file type extensions
v Creation, modification, or last access date
v Absolute or relative dates
v Combination of rules
Chapter 1. HSM for Windows client overview 3
||||
Note: You can use the migration program from a Windows command prompt to
list and retrieve files in a file space (see “dsmclc.exe” on page 51).
Stub file overview
A stub is created for and replaces each migrated file. On the local system, a stub
file looks and act like a regular file. When you or a Windows application accesses a
migrated file stub, the Windows operating system transparently directs a file access
request to the HSM for Windows client file system filter driver. This driver
retrieves the full file from the repository to which it was migrated.
Note:
v The file system filter driver and the recall application must be installed on
all servers on which files are migrated. When files are migrated from a
server where these components are not installed, or the recall application
is not active, each attempt to access a migrated file results in an error.
v When user action restores a file but the user does not change the file, that
file is ″re-stubbed″ during the next automated migration process.
v When user action restores a file and modifies the file, that new version of
the file is stored in archive system. Subsequent recall restores the most
recent version.
v As well, an administrator can use more advanced retrieve functions to
obtain previous versions of a file. An administrator can also obtain a file
whose stub was deleted if the file was not deleted by reconciliation in the
meantime.
The HSM for Windows client file system filter driver (ithsmdrv.sys) is an
Installable File System (IFS) filter driver. When a user or application accesses a
migrated file stub, the file system filter driver and the IBM TSM HSM Recall
Service (hsmservice.exe) running in the Windows user space perform the following
steps:
1. The file system filter driver connects to the recall application running in the
Windows user space and requests to recall the file.
2. The IBM TSM HSM Recall Service reads the file data and restores the file
content.
3. The file system filter driver returns control to the Windows operating system
and the I/O request is completed.
Reconciliation overview
Reconciliation is the process of synchronizing a file system, which you have
configured for reconciliation, with the Tivoli Storage Manager server you contact
for space management services. After running reconciliation, exactly one migrated
object exists on the Tivoli Storage Manager server for each migrated file.
By removing old and obsolete objects from the Tivoli Storage Manager server
storage, reconciliation helps you to reduce your storage and license expenses. It
also checks whether there are migrated files without a copy on the Tivoli Storage
Manager server in the file system.
The HSM for Windows client performs reconciliation automatically at intervals
specified with the reconcileinterval option you define using the using the HSM for
Windows client GUI or with command line tool dsmhsmclc.exe. An administrative
user can also start reconciliation manually at any time.
4 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
|
||||
||||
||||
Use the HSM for Windows client GUI to configure reconciliation (see Chapter 6,
“Configuring reconciliation,” on page 47 for more information).
Note: When upgrading from a HSM for Windows client before V5.4, use the
dsmReconConverter program to convert your stub files into a format that
the reconciliation tasks can process (see “dsmReconConverter.exe” on page
56).
Client commands and GUI overview
Once you install and register the HSM for Windows client you use the HSM for
Windows client GUI or run commands from a Windows command prompt to use
the client’s features.
For information and usage details on each of the commands, see Chapter 7, “Using
commands,” on page 51. The HSM for Windows client GUI is used in many
examples throughout the book, such as configuring, migrating, and reconciling.
Chapter 1. HSM for Windows client overview 5
||
||||
Chapter 2. Installing the HSM for Windows client
You can install the HSM for Windows client in user mode or network mode. In
user mode you step through a series of installation windows to collect necessary
information and manage the installation. A network installation only copies the
product to a network drive for a shared installation.
Note:
v To install the HSM for Windows client you need administrative rights.
v If you are installing the HSM for Windows client in a clustered
environment, make sure you read “Considerations for a clustered
environment installation.”
v For the most up-to-date installation instructions and last minute addenda,
see the release notes file (relnote_hsmwin550.html) located on the IBM
Tivoli Storage Manager for HSM for Windows 5.5 Quick Start CD. This
file is also available online at the Tivoli Information Center Web site:
http://publib.boulder.ibm.com/infocenter/tivihelp/v1r1.
v The HSM for Windows client uses the directory of the previously installed
backup-archive client as the default installation directory.
v You must reboot to complete the installation. Do not configure the HSM
for Windows client until after the reboot.
v Once you install the HSM for Windows client refer to “Running the HSM
for Windows client Configuration Wizard” on page 12 for information on
using the Configuration Wizard.
Considerations for a clustered environment installation
If you are installing the HSM for Windows client in a clustered environment, read
these considerations and scenario before installation. Currently only Microsoft
cluster environments (MSCS) are supported.
Tivoli Storage Manager for HSM for Windows may be installed in a Microsoft
cluster in both active-standby and active-active configurations. The HSM for
Windows client cluster installation is transparent. However, some additional
installation steps are required in order to set up and operate the system in a
clustered environment. The section that follows explains the necessary steps for
installation in a clustered environment together with several issues of which the
system administrator must be aware.
Clustered Scenario
The following example installation is based on a cluster setup with two nodes
(Node1 and Node2) and two cluster groups (Cluster Group 0 and Cluster Group
1). The description can be extended to any more complex cluster setup. It refers to
an active-standby configuration as well as to an active-active configuration of the
cluster. Where differences exist with regard to this configuration they are stated
explicitly.
Before detailing the additional steps required for installation in a clustered
environment you need to understand what happens with HSM for Windows client
in a Windows cluster after a failover if the additional steps are not taken.
© Copyright IBM Corp. 2005, 2007 7
1. Files are migrated from volume Y: by Node1
2. Node1 fails
3. Cluster Group 0 fails-over to Node2
4. Recall of migrated files from Y: fails on Node2
5. Retrieve of migrated files from Y: fails on Node2
File migration
During migration the HSM for Windows client 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.
Recall operation after failover
During a recall operation, from Node2 which is now the controlling node, the IBM
TSM HSM Recall Service (hsmservice.exe) 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. Because this pathname
contains the name of Node1 as hostname, the recall operation fails.
Retrieve operation
The retrieve operation also fails because it constructs pathnames with ″Node2″
while the files stored in Tivoli Storage Manager contain ″Node1″ as the hostname.
Solution
In order to address these node name issues, HSM for Windows client maps 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 failover and which are with the HSM for Windows client. The
mapping is done automatically during the first startup of the HSM for Windows
client.
For the described configuration the following registry entries are made on both
nodes:
Table 2. Node Registry Entries
Name Type Data
Y: REG_SZ \\CLUSTER\Y$\
Z: REG_SZ \\CLUSTER\Z$\
HSM for Windows client checks this mapping and replaces the node name for each
volume defined by the cluster name. This applies to all operations involving the
following:
v Reparse data
v Path names in Tivoli Storage Manager
v Search and retrieve operations
8 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Attention: These settings define the HOST and DRIVE NAMES on which data is
stored. These settings are STORED in the REPARSE POINTS that are NEEDED to
recall files. Changing this mapping AFTER a file has been migrated MAKES USER
RECALL IMPOSSIBLE.
In a failover situation, migration jobs defined on Node1 may no longer be
executable from Node2. In the example described if the job files are stored on the
local disk C: of Node1, they will not be accessible when this node fails. This
limitation can be avoided by storing the job files on volume Y: of Cluster Group 0
in an active-standby configuration. The job files directory to be searched by Tivoli
Storage Manager for HSM for Windows may be redefined using the HSM for
Windows client GUI (select Tools → Preferences → Path Configuration, see “File
location preferences” on page 65). In a failover 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.
Clustered configuration installation steps
After reviewing the considerations for clustering, use these steps to install the
HSM for Windows client in a clustered environment.
The basic steps required to ensure proper operation in a clustered environment are
as follows:
Note:
v You follow these same steps with a non-clustered environment, but you
perform these steps on each node in the cluster.
v Register the HSM for Windows client for the cluster (see “Registering the
HSM for Windows client” on page 10).1. Install the Tivoli Storage Manager Backup-Archive Client on all nodes.
2. Install the HSM for Windows client on all nodes using either the user or
network mode (see “Installing in user mode” and “Installing in network mode”
on page 10)
Installing in user mode
You can install the HSM for Windows client in user mode by clicking on the setup
icon or running the setup command from a command line.
Note:
v The Repair option reinstalls missing or damaged files, shortcuts, or
registry entries.
v The Remove option removes the product from the machine. However, the
HSM for Windows client installation directory including the jobs, listings,
and logs folders remain on the machine.
v After installation or deinstallation, you must reboot the system to load the
file system filter driver.
v After adding new hard disks or volumes to a server already running the
HSM for Windows client, the recall service (hsmservice.exe) running as a
Windows service (IBM TSM HSM Recall Service) must be restarted.
Chapter 2. Installing the HSM for Windows client 9
Use the following steps to install the HSM for Windows client in user mode:
1. Insert the product CD into a CD drive.
2. Open Windows Explorer.
3. Change to the <cd-drive>:\ location, where <cd-drive> is the drive letter of the
reader where you placed the installation CD.
4. Double-click the setup.exe file.
Note: In 3 you could choose to open a command prompt on the CD drive and
issue the setup command.
Installing in network mode
You can install the HSM for Windows client in network mode to share the
installation.
Use the following steps to install the HSM for Windows client in network mode:
1. Insert the product CD into a CD drive.
2. Open a command window.
3. Change to the <cd-drive>:\ location where <cd-drive> is the drive letter of the
cd reader.
4. Type msiexec /a ″IBM Tivoli Storage Manager HSM for Windows client.msi″
and press Enter.
5. Step through the user interface dialogs by typing the necessary information.
The file IBM Tivoli Storage Manager HSM for Windows client.msi is copied to
the assigned network drive.
6. To install the product, right-click this .msi file, select Install, and step through
the setup windows.
Registering the HSM for Windows client
Before the HSM for Windows client can connect to a Tivoli Storage Manager server
it must be registered as a Tivoli Storage manager client node at the server, by your
Tivoli Storage Manager administrator.
Provide the following information to your Tivoli Storage Manager administrator:
v The node name (the node name that you will specify in the HSM for Windows
client Configuration Wizard).
v The initial password that you want to use, if a password is required.
v Contact information, such as your name, user ID, and telephone number.
v If you have installed the HSM for Windows client on a clustered environment,
you additionally need to provide the global Tivoli Storage Manager node name
for the cluster. The global Tivoli Storage Manager node name is identical to the
cluster name by definition and cannot be chosen. For this global node, the Tivoli
Storage Manager administrator must grant proxy authority to each node of the
cluster.
Once the Tivoli Storage Manager administrator has set up your node you can start
the HSM for Windows client GUI (hsmgui.exe). The first time that you start the
program, the Configuration Wizard guides you through the required configuration
steps to connect to the Tivoli Storage Manager server.
10 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Chapter 3. Using the HSM for Windows client GUI
The HSM for Windows client GUI (dsmgui.exe) is a visual, menu-based
environment where you: migrate files; setup and run migration jobs; setup and
start reconciliation; search and retrieve files; create file groups, file spaces, and
quotas; and define regional and log settings. You can also run these same tasks
using commands in a Windows command prompt.
You must start the HSM for Windows client GUI with administrative rights on the
file server on which it is administered. Each file server on which the HSM for
Windows client is installed must be administered locally.
Table 3 describes some key functions of the HSM for Windows client GUI:
Table 3. HSM for Windows client GUI functions
Function Description
Define and run
migration jobs
You can create new migration jobs or edit existing jobs. For each
migration job, you must specify the name of a file space in Tivoli
Storage Manager. The drives, directories, and files are displayed in a
Windows Explorer-like window. From this window, you use filtering
criteria to select which files to migrate from complete drives,
directories, subdirectories, or you can select individual files. For more
information see Chapter 4, “Migration jobs,” on page 23. You can
select a defined migration job and click Execute Job Immediately to
start the migration process. For more information see “Running
migration jobs from the HSM for Windows client GUI” on page 38.
Search for
migrated or
archived files
Use the search function to find any migrated or archived file in
existing Tivoli Storage Manager file spaces under several search
criteria. As a result of the search process, all entries of the file space
matching the search criteria are listed. For more information see
Chapter 5, “Retrieving migrated or archived files,” on page 43.
Retrieve searched
files
You can retrieve the complete or partial set of files from a search
operation. You can specify the (locally mounted) volume and a
destination directory for the retrieved files (the default is to retrieve to
the original file location). In addition, older versions of files can be
retrieved to the original or a new location. For more information see
Chapter 5, “Retrieving migrated or archived files,” on page 43.
Configure and run
reconciliation
You can define and start reconciliation that synchronizes your local
file systems by deleting obsolete copies of files from the Tivoli Storage
Manager server. For more information see “Reconciliation overview”
on page 4 and Chapter 6, “Configuring reconciliation,” on page 47.
Create file groups You can create file groups by extension or directories to facilitate
creating migration jobs. For more information see “Creating a new file
group” on page 17.
Create file spaces You can create new file spaces on the Tivoli Storage Manager server
directly from the HSM for Windows client GUI. For more information
see “Creating a new file space” on page 21.
Change log
settings
You can change the settings and directories of the log files for HSM
client applications. For more information see “Tracing preferences” on
page 67.
© Copyright IBM Corp. 2005, 2007 11
||
Table 3. HSM for Windows client GUI functions (continued)
Function Description
Define and view
quotas
You can define and view quota settings from the HSM for Windows
client GUI. Quotas define how many files can be restored in a defined
time frame. For more information see “Viewing file recall quotas” on
page 19 and “Defining file recall quotas” on page 19.
Change regional
settings
You can change the regional settings such as your language, time,
date and number format of the HSM for Windows client GUI. For
more information see “Regional settings” on page 22.
Running the HSM for Windows client Configuration Wizard
When running the HSM for Windows client GUI for the first time, the
Configuration Wizard guides you through necessary configuration steps. You can
also run the Configuration Wizard any time from the Tools menu.
If you have not registered your node with your Tivoli Storage Manager
administrator, read “Registering the HSM for Windows client” on page 10 to be
able to connect to the Tivoli Storage Manager server.
Before configuring HSM for Windows client, read these considerations:
v A policy domain contains policy sets the management classes that control how
Tivoli Storage Manager manages the files that you migrate. The HSM for
Windows client uses the default management class.
v The HSM for Windows client stores its parameters (Tivoli Storage Manager
server, node name, password mode) in the dsm.opt file located in the HSM for
Windows client installation directory. It does not use the dsm.opt file that is
used by the Tivoli Storage Manager Backup-Archive Client. For further
information about the options in the backup-archive client dsm.opt file, refer to
the IBM Tivoli Storage Manager for Windows Backup-Archive Clients
Installation and User’s Guide. Attention: We recommend you only use the HSM for Windows client GUI to
change HSM for Windows client options. Editing the HSM for Windows
client dsm.opt file could lead to you being unable to access to your data.
v 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 for Windows client. However, if you select the
Password Generate option in the Configuration Wizard, the Tivoli Storage
Manager API uses the registry entry of the backup-archive client to store the
automatically generated password. If you want to keep the logon parameters of
the HSM for Windows client separate from those of the backup-archive client,
register the HSM for Windows client under a node name different from the one
used by the backup-archive client.
Run the HSM for Windows client GUI by issuing the dsmgui.exe command in the
HSM for Windows client installation directory:
1. In the Option File Task window, select which task you want to perform and
selected Next.
12 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
2. In the TPC/IP Parameters window, enter the server address and port for the
Tivoli Storage Manager server and select Next. Each HSM for Windows client
can connect to only one Tivoli Storage Manager server. This server might be
different from the one used by the backup-archive client.
3. In the TSM password access window, select the password access option and
select Next. 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 for Windows client to logon to the Tivoli Storage Manager server.
This password is stored and encrypted by the HSM for Windows 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.
Figure 1. Configuration: Option File Task window
Figure 2. Configuration: TCP/IP Parameters window
Chapter 3. Using the HSM for Windows client GUI 13
4. In the TSM authentication window, enter the name under which your client
node has been registered on the Tivoli Storage Manager server and select
Next.
5. In the Set or Change Password window, enter the initial password that has
been assigned to your node by the Tivoli Storage Manager administrator and
select Next.
6. In the Initial File Space Registration window, 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. If you want to create a file space later, select the Skip file space
creation check box (see “Creating a new file space” on page 21). Select Next.
Figure 3. Configuration: TSM password access window
Figure 4. Configuration: TSM authentication window
14 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
7. In the Additional Migration Options window, decide if files should be backed
up before a migration job is run (see “Backing up files before migrating them”
on page 23 for more information). 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 back up before migration. The setting can be
changed for each job individually. Select the Next button.
8. If you are running in a clustered environment, an information window
displays, reminding you to issue a command on the Tivoli Storage Manager
server similar to:
grant proxynode target=<clustername> agent=<nodename>
Note: Where <clustername> is the name of the cluster and <nodename> is the
node name you defined in the 4 on page 14.Write down the proxy node relationship command and have your Tivoli
Storage Manager administrator issue the command. Select Next.
9. If the HSM for Windows client is not running on a cluster node, you come
directly to this dialog, you will see the Completing the TSM HSM
Configuration Wizard window. If all options are correct, click Finish. If you
need to make corrections click the Back button.
Figure 5. Configuration: Initial File Space Registration window
Figure 6. Configuration: Additional Migration Options
Chapter 3. Using the HSM for Windows client GUI 15
10. Acknowledge the successful saving of the configuration to the options file by
clicking on the OK button in the Completing the TSM HSM Configuration
Wizard.
When the HSM for Windows client connects successfully to the Tivoli Storage
Manager server you can define and run migration jobs.
Figure 7. Configuration: Completing the TSM HSM Configuration Wizard window
Figure 8. Configuration: Completing the TSM HSM Configuration Wizard window
16 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
File groups overview
To facilitate the grouping of files for migration, you can create and edit file groups.
You define file groups by file extension types.
You can associate any number of file types to one file group. For example, you
could have a group called ″Image Files″ consisting of these file extensions: bmp,
jpg, eps, and gif. You can define another file group called ″Office Files″ consisting
of the following file extensions: doc, xls, and ppt.
Note:
v A file group can be used in the definition of migration jobs.
v Every file group is global and any changes to the group will change its
definition anywhere that group is used or selected.
v You can define a file group, on-the-fly, within other tasks, such as when
defining a migration job.
Creating a new file group
Use these steps to create a new group using the HSM for Windows client GUI.
Note: The creation of a new file group is global. The new file type you create here
will be included in the lists of types under Tools → File Groups.
1. Select Tools → File Groups.
2. Click theNew file group button.
3. Enter the name of the file group you want to define.
4. Enter the file extensions you want to be included in this file group, separated
by spaces as shown in Figure 10.
5. Click the OK button.
Figure 9. File Group: New file group window
Figure 10. File Group: Executables window
Chapter 3. Using the HSM for Windows client GUI 17
See “Edit a file group” for steps on editing existing groups.
Edit a file group
Use these steps to edit an existing file group using the HSM for Windows client
GUI.
Note: Any changes you make to a file group affect that file group globally,
wherever it is used or selected.
1. Select Tools → File Group.
2. Select the file group you want to edit and select the Edit button.
3. Edit the file extensions you want to be included in this file group.
See “Creating a new file group” on page 17 for steps on creating groups.
File recall quotas
You can create file recall quotas to limit the number of possible file recalls for a
specific time period. You can use a system-wide (Default Quota) quota or create
quotas for particular Windows (local or domain) users and groups.
When a file recall quota is exceeded, a subsequent file recall request is rejected,
and the HSM for Windows client returns the code STATUS_FILE_IS_OFFLINE. The
actual behavior of the calling application depends on the response of the calling
application to this return code.
Note:
v Because some backup and archive operations recall files, too low of a file
recall quota might not allow you to back up or archive all files.
v 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.
v Quotas can be updated at any time using the HSM GUI. The update is
effective immediately without restarting the HSM for Windows client.
v Quotas only affect the recall of migrated files from users accessing stub
files. Quotas do not have any influence on retrieving files with the HSM
for Windows client GUI.
v The default quota defines the general number of possible file recalls in a
time period for group and users for which no specific quota has been
defined.
Figure 11. File Group: Executables window (edit)
18 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
v 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.
v 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.
v 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.
Viewing file recall quotas
Use the HSM for Windows client GUI to view define quotas.
1. Select Tools → Quotas → View Quotas to display the Users and defined quotas
window.
2. Use the Look in control to choose whether you want to view quotas for local
or domain users. You can also filter the view by entering a name or a part of a
name and pressing the Filter button.
3. You can now scroll thru the list and view quotas. The second column displays
the type of quota, and the third column displays the quota.
Defining file recall quotas
Use the HSM for Windows client GUI to define the default, user, and group
quotas.
1. Select Tools → Quotas → Define Quotas to display the Recall Quotas window.
2. To change the default quota using the System Default Quota window, select the
Change button that is to the right of Default Quota.
Figure 12. Recall Quotas window
Chapter 3. Using the HSM for Windows client GUI 19
a. If you want to define this quota as Unlimited Recalls or No Recalls, select
one of those options in the Predefined quotas list and then select the OK
button.
b. If you want to define a time span for this quota, select the Configure quota
option in the Predefined quotas list, enter a numeric value in the Number
of files that can be recalled box, select values for the Timespan for this
quota values, and select the OK button. Figure 13 sets a default quota of
one file per day. You can also choose hours, minutes, and seconds.3. To change a user quota click the Change button that is to the right of User
Quota (see Figure 12 on page 19).
a. In the User Quotas window, use the Look in control to 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 the Filter button.
b. Select the user for whom you want to define a user quota and click the
Change button. After selecting a user, you can also delete their defined
quota by clicking the Delete button.
Figure 13. System Default Quota window
Figure 14. User Quotas window
20 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
c. Follow the substeps in step 2 on page 19 to define the quota for the selected
user.4. To define a group quota, click the Change button that is to the right of Group
Quotas (see Figure 12 on page 19).
a. In the Group Quota window, use the Look in control to choose whether
you want to assign quotas to local or domain groups. You can filter groups
by entering a name or a part of a name and pressing the Filter button.
b. Select the group which you want to define a user quota and click the
Change button. After selecting a group, you can also delete their defined
quota by clicking the Delete button.
c. Follow the sub-steps in step 2 on page 19 to define the quota for the
selected group.
Creating a new file space
You can create new file spaces on the Tivoli Storage Manager server directly from
the HSM for Windows GUI.
Use the steps in this task to create a new file space:
1. To create a new file space select Tools → Create New File Space.
2. Enter a name for the new file space.
3. Select the OK button.
Figure 15. Group Quotas window
Chapter 3. Using the HSM for Windows client GUI 21
Regional settings
Use the Regional Settings window to set your language, time format, date format,
number format, and define if you want log, listing, and trace files in Unicode.
Note: You must restart the HSM for Windows client GUI for any of the settings in
Figure 16 changes to take effect.
1. Select Tools → Preferences and then select the Regional Settings tab.
2. Make changes as needed and select the OK button.
Figure 16. Preferences windows for regional and Unicode settings
22 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Chapter 4. Migration jobs
Before creating a migration job review these considerations to enhance your
planning. You need to have an overall migration plan, such as pre-migration,
quotas, file spaces involved , file sets to migrate, a migration schedule, etc.
v When files are migrated to an existing file space, each file is checked to see if it
already exists in Tivoli Storage Manager file space. If it exists and the content of
the two versions is different, the new version is migrated to the file space. If the
file exists but has not been changed, it is simply replaced (again) by a stub
pointing to the original entry in the Tivoli Storage Manager file space.
v When only file attributes or times (creation time or last modification time) have
changed, the file is not re-appended to the file space. Instead, 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, the files are recalled
and then stored again in Tivoli Storage Manager file space with the same version
number. The old entry is deleted in Tivoli Storage Manager. Because files are
recalled, you must have enough temporary disk space. Attributes and file times
are stored in the Tivoli Storage Manager database, and they can be updated by
the HSM for Windows client. In contrast to this, the file security is part of the
binary data blob, and it cannot be updated or modified by the HSM for
Windows client. Instead the file must be uploaded a second time to reflect such
changes.
v Due to the Tivoli Storage Manager API low-level qualifier length definition, a
HSM for Windows client file name cannot exceed 256 bytes. The path length (the
API high-level qualifier) cannot exceed 1024 bytes. A path and file name
includes the file server name, the volume, and the directory portion of the full
UNC name, for example \\FILESERVER\E:\directory\filename.ext. The
Unicode representation of a character can occupy several bytes, so the maximum
number of characters that a file name might contain can vary.
v Due to Windows Explorer limitations, when using the HSM for Windows client
GUI, path names can be a maximum of 254 characters only. For path names that
exceed 254 characters, you must use dsmclc.exe from a Windows command
prompt.
v When deciding what files to include in a migration job, consider both the
frequency of use of the files and their retrieval times (the time to retrieve it from
the storage repository). Although most file retrieval is transparent to users,
network bandwidth, storage repository speed, and file size all determine the file
retrieval speed.
Backing up files before migrating them
Before running an HSM for Windows client migration operation, files should be
backed up for disaster recovery. The backup-before-migrate feature allows files to
be backed up automatically before they are migrated. However, a hierarchical
storage management application such as the HSM for Windows client does not
replace the practice of routinely backing up files and its backup-before-migrate
feature is not a substitute for regularly backing up your files.
When you ran the Configuration Wizard for the HSM for Windows client, the
Additional Migration Options window allowed you to define a global setting to
back up files before a migration job (step 7 on page 15 in “Running the HSM for
© Copyright IBM Corp. 2005, 2007 23
Windows client Configuration Wizard” on page 12). Regardless of what you
selected for that global setting, you can select the pre-migration backup option
when defining each migration job (see Figure 19 on page 25).
If a migration job is marked for backup before migration, a list of resident source
files is written to a temporary file. After a (non-empty) list of files has been
successfully written to the backup list file, those files are backed up by the
dsmc.exe backup-archive client program. Only files that have been backed up
successfully are migrated. The other files will be skipped
If in the past you selected to not backup files before migrating them you may want
to review the following section: and “HSM for Windows client backup integration
with the backup-archive client” on page 60.
Note: The path name length limits differ for migrated files and for files backed up
before migration. When backing up files before migration, the file name
cannot exceed 256 bytes, and the path length plus the file name cannot
exceed 8440 bytes. Refer to the Tivoli Storage Manger for Windows
Backup-Archive Clients Installation and User’s Guide for detailed information on
these length limits.
Creating migration jobs
Use the HSM for Windows client GUI to define migration jobs. The core function
of migration jobs, and why you have more than one, is to select different file sets
to migrate by selecting different include and exclude conditions such as file age,
size, subdirectory, and groups on files or directories.
Note:
v Due to the Tivoli Storage Manager API low-level qualifier length
definition, an HSM for Windows client file name cannot exceed 256 bytes.
The path length (the API high-level qualifier) cannot exceed 1024 bytes. A
path and file name includes the file server name, the volume, and the
directory portion of the full UNC name, for example \\FILESERVER\E:\directory\filename.ext. The Unicode representation of a character can
occupy several bytes, so the maximum number of characters that a file
name might contain can vary.
v Due to Windows Explorer limitations, when using the HSM for Windows
client GUI, path names can be a maximum of 254 characters only. For
path names that exceed 254 characters, you must use dsmclc.exe from a
Windows command prompt.
To complete the following steps to define a migration job, run the HSM for
Windows client GUI.
1. Select Job → New Job or right-click in the window’s white space and select
New Job.
24 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
2. Name the new job icon to a name of your choice.
3. Double-click the new job icon to display the New Job window.
4. In the New Job window’s General tab, use the File Space menu to select the
name of the file space in which you want to store migrated files. If you need
to create a new file space, see “Creating a new file space” on page 21.
Figure 17. New Job menu selection
Figure 18. New migration job: rename window
Figure 19. New migration job: General tab
Chapter 4. Migration jobs 25
5. Decide if you want to Specify whether files converted by this job should be
backed up before migration.
Note: Existing migration job files from pre-5.4 versions of HSM for Windows
client versions can still be processed without the backup-before-migrate
attribute set. If you plan to run a legacy migration job, edit the job file
in the HSM for Windows client before running it so you can select to
back up files before migration.
6. Select the Source Files tab so you can begin to select files to migrate by files or
by directories.
7. To add a new directory, skip to step 8 on page 29. For each file you want add,
follow these substeps:
a. Select the Source Files tab’s New File button.
b. Select the Browse button. In the Browse for File window, select the drive
you want and select OK.
c. Use the file selection window that displays to drill down to the file you
want and select the OK button.
Figure 20. New migration job: Source Files tab
26 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
d. Select a migration action. The default Replace the file with a shortcut to
the file space option performs a migration and creates a stub file. The
Keep the original file archives the file, but keeps the original file as is on
the local system, while Delete the file archives the file and then deletes it
from the local system.
Note: Don’t run reconciliation on the file spaces used for this job, if you
select Delete the file.
e. Select the Source File window’s Advanced Conditions tab and select the
New Include button. The following steps use the Include Conditions
windows as examples, but you could also chose the New Exclude button,
which follows the same convention. And you can combine include and
exclude conditions.
Figure 21. New migration job: Source Files General tab (Browse for File, Select Drive)
Figure 22. New migration job: File General tab Action (migration) window
Chapter 4. Migration jobs 27
Note: The files that are selected for migration through a combination of
include and exclude conditions are based not only on the include
and exclude condition type and parameters you select, but are also
determined by the order of the include and exclude statements. We
recommend before you continue to create a migration job, you
review “Examples of including and excluding files” on page 32 for
detailed examples of combining include and exclude conditions.
f. From the Include Condition window’s top drop-down menu choose the
type of condition you want for the selected file(s), define the settings for
the condition specific settings and select OK. Use Figure 24 through
Figure 26 on page 29 as examples to continue to define your include and
exclude conditions.
Figure 23. New migration job: Source File Advanced Conditions tab
Figure 24. New migration job window to include files based on file size
28 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
g. Continue to define include and exclude conditions for the selected file(s)
and select OK when complete. 8. To add new directories from the New Job window’s Source Files tab, select the
New Directory and then Browse buttons. Select the directory you want to add
and select the OK button to add it. Continue to add as many directories as
you need, then follow these substeps to define the details of the migration job:
Note: The migration action and include and exclude conditions you apply to
a subdirectory-based migration job applies to the individual files in the
selected subdirectories.
a. Select a migration action. The default Replace the file with a shortcut to
the file space option performs a migration and creates a stub file. The
Keep the original file archives the file, but keeps the original file as is on
the local system, while Delete the file archives the file and then deletes it
from the local system.
Note: Don’t run reconciliation on the file spaces used for this job, if you
select Delete the file.
Figure 25. New migration job window to include files by time
Figure 26. New migration job window to include files based on age
Chapter 4. Migration jobs 29
b. Select the Include Subdirectories check box if you want to include all files
in the selected directory’s subdirectories.
c. Select the Advanced Conditions tab and then, the type of include condition
you want to define. Use Figure 28 through Figure 33 on page 32 to
understand the conditions in each of the include or exclude types.
Figure 27. New migration job: Source Directory General tab
Figure 28. New migration job: Advanced Conditions window Include Condition options
30 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Note: See “Creating a new file group” on page 17 and “Edit a file group”
on page 18 for steps on creating and editing groups.
Figure 29. New migration job window to include files by subdirectory
Figure 30. New migration job window to include files by group (by directory)
Figure 31. New migration job window to include files based on file size (by directory)
Chapter 4. Migration jobs 31
9. Once you define a migration job you can view estimated space gains without
actually running the job. See “Calculate a migration job’s space savings” on
page 37 for more information.
10. Run the migration job by using one of the methods described in “Executing
migration jobs” on page 38.
Examples of including and excluding files
By reviewing a base set of example files and different include and exclude
conditions, you can understand how the HSM Windows client determines which
files to include and which to exclude.
Attention: The following examples are to help you get started with building your
own include and exclude conditions. Before relying on a set of these conditions,
make sure you test them thoroughly.
Table 4 on page 33 lists the base file set used in these include and exclude
examples. A base file set includes all files in the selected disk, folders, and, if
selected, all subfolders. The content of the base set never changes. Include and
exclude conditions you define create a subset of the base files that are valid for the
Figure 32. New migration job window to include directories by time (by directory)
Figure 33. New migration job window to include directories based on age (by directory)
32 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
selected operation. This valid subset of files is called the ″target set″. If there is no
advanced condition imposed on the base set, the HSM for Windows client uses a
default of ″include all″, and thus the base set and the target set are identical.
Table 4. Example base file set
File name File size
test.log 1.5 GB
test.html 50 K
test.bmp 250 MB
test.pdf 2.7 GB
test2.pdf 11 GB
test.dwg 100 GB
Table 5 summarizes the include and exclude examples. The examples are not
cumulative, in that each is a stand-alone example to show you various ways to
create the subset of files you need for your file system.
Table 5. Summary of include and exclude examples
Table Include / exclude condition
Table 6 include all files < 300 MB
Table 7 on page 34 exclude all files < 300 MB
Table 8 on page 34 exclude all files < 30 GB
Table 9 on page 35 include all files < 300 MB
include all files with extension = pdf
Table 10 on page 35 exclude all files < 300 MB
exclude all files with extension = pdf
Table 11 on page 35 exclude all files < 3 GB
include all files with extension = pdf
Table 12 on page 36 include all files with extension = pdf
exclude all files < 2 GB
Table 13 on page 36 include all files with extension = html
exclude all files with extension = log
Example 1: one include condition
This example is an include condition that creates a target set of all files that match
the include condition. The files that do not match the include condition are
excluded. Table 6 shows the target set that results from the following include
condition:
include all files < 300 MB
Table 6. Target set for include condition example 1
Base file set Target file set
File name File size File name File size
test.log 1.5 GB
test.html 50 K test.html 50 K
test.bmp 250 MB test.bmp 250 MB
test.pdf 2.7 GB
Chapter 4. Migration jobs 33
Table 6. Target set for include condition example 1 (continued)
Base file set Target file set
File name File size File name File size
test2.pdf 11 GB
test.dwg 8 GB
Example 2: one exclude condition
This example shows an exclude condition. The first exclude condition includes all
files into the target set which are not excluded by the condition. Table 7 shows the
target set that results from the following exclude condition:
exclude all files < 300 MB
Table 7. Target set for exclude condition example 2
Base file set Target file set
File name File size File name File size
test.log 1.5 GB test.log 1.5 GB
test.html 50 K
test.bmp 250 MB
test.pdf 2.7 GB test.pdf 2.7 GB
test2.pdf 11 GB test2.pdf 11 GB
test.dwg 8 GB test.dwg 8 GB
Example 3: one exclude condition
In this example, Table 8 shows that no file is in the target set from the following
exclude condition:
exclude all files < 30 GB
Table 8. Target set for exclude condition example 3
Base file set Target file set
File name File size File name File size
test.log 1.5 GB
test.html 50 K
test.bmp 250 MB
test.pdf 2.7 GB
test2.pdf 11 GB
test.dwg 8 GB
Example 4: two include conditions
In this example, two include conditions create a target set that includes all files
that match either include condition. Files that do not match either include
condition are excluded from the target set. Table 9 on page 35 shows the target set
that results from the following include conditions:
include all files < 300 MB
include all files with extension = pdf
34 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Table 9. Target set for include conditions example 4
Base file set Target file set
File name File size File name File size
test.log 1.5 GB
test.html 50 K test.html 50 K
test.bmp 250 MB test.bmp 250 MB
test.pdf 2.7 GB test.pdf 2.7 GB
test2.pdf 11 GB test2.pdf 11 GB
test.dwg 8 GB
Example 5: two exclude conditions
In this example, two exclude conditions combine to exclude any files that matches
either exclude condition. Files that do not match either exclude condition make up
the files that are included into the target set. Table 10 shows the target set that
results from the following exclude conditions:
exclude all files < 300 MB
exclude all files with extension = pdf
Table 10. Target set for exclude conditions example 5
Base file set
Target file set after first
exclude condition Final target file set
File name File size File name File size File name File size
test.log 1.5 GB test.log 1.5 GB test.log 1.5 GB
test.html 50 K
test.bmp 250 MB
test.pdf 2.7 GB test.pdf 2.7 GB
test2.pdf 11 GB test2.pdf 11 GB
test.dwg 8 GB test.dwg 8 GB test.dwg 8 GB
Example 6a: incorrect mixed include and exclude conditions
This example is an incorrect example to show how mixed conditions are evaluated
from the top down. Assume you want a target set of only .pdf files that are larger
than 3 GB. Table 11 shows the target set that results from the following include and
exclude conditions are not part of the original goal.
exclude all files < 3 GB
include all files with extension = pdf
Table 11. Incorrect target set for include and exclude conditions in example 6a
Base file set Final target file set
File name File size File name File size
test.log 1.5 GB
test.html 50 K
test.bmp 250 MB
test.pdf 2.7 GB test.pdf 2.7 GB
test2.pdf 11 GB test2.pdf 11 GB
Chapter 4. Migration jobs 35
Table 11. Incorrect target set for include and exclude conditions in example 6a (continued)
Base file set Final target file set
File name File size File name File size
test.dwg 8 GB test.dwg 8 GB
Example 6b: correct mixed include and exclude conditions
The next example is the correct example of obtaining the same goal of a target set
of all .pdf files that are greater than 3 GB. With the include condition as the first
condition, the top-down ordering creates the target set in Table 12.
include all files with extension = pdf
exclude all files < 3 GB
Attention: Remember that any include condition uses all of the base target set
regardless of the include or exclude conditions that precede it.
Table 12. Correct target set for include and exclude conditions in example 6b
Base file set Final target file set
File name File size File name File size
test.log 1.5 GB
test.html 50 K
test.bmp 250 MB
test.pdf 2.7 GB
test2.pdf 11 GB test2.pdf 11 GB
test.dwg 8 GB
Example 7: redundant exclude condition
This example illustrates how an exclude condition may be redundant. Table 13
shows the target set that results from the following include and exclude conditions.
include all files with extension = html
exclude all files with extension = log
Table 13. Example target set for example 7 redundant exclude condition
Base file set
Target file set after first
include condition Final target file set
File name File size File name File size File name File size
test.log 1.5 GB
test.html 50 K test.html 50 K test.html 50 K
test.bmp 250 MB
test.pdf 2.7 GB
test2.pdf 11 GB
test.dwg 8 GB
36 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Calculate a migration job’s space savings
Before finalizing a migration job, you can calculate the amount of space that will
be saved by a migration without having to run the migration job.
To calculate a migration job’s space savings perform the following:
Right-click on the migration job you want to calculate and select Calculate Space
Saving. Alternatively, select the job and select Job → Calculate Space Saving. You
see three sets of information in both files count and kilobytes:
v Current Disk Usage
v Disk Usage after Migration
v Free Disk space Gain
Figure 34. Estimate Disk Space Gain window
Chapter 4. Migration jobs 37
Executing migration jobs
Most migrations jobs are run from a standard scheduler. However, there are a few
other methods for running migration jobs.
You can run migrations jobs any of the following ways:
v From the HSM for Windows client
v From the Windows command prompt using the dsmclc command
v From a scheduled task
Running migration jobs from the HSM for Windows client GUI
After defining migration jobs, you can run them at any time from the HSM for
Windows client GUI.
Run migration jobs from the HSM for Windows client GUI by right-clicking on a
migration job and selecting Execute Job Immediately.
Note: You can also migrate files and schedule migrations jobs using the
dsmclc.exe. See “dsmclc.exe” on page 51 for more information.
Running migration jobs with other applications’ output
As an alternative to creating a migration job from the HSM GUI, you can process
output generated by other applications such as the IBM Tivoli TotalStorage®
Productivity Center for Data (formerly IBM Tivoli Storage Resource Manager).
To use output from another application, load dsmclc.exe with the migratelist option
and specify the name of the file generated by the application as joblist parameter.
The joblist text file must contain the complete path names of all files to be
migrated. Each path name must be written on one line of the file, and each line
must be separated by CRLF.
Scheduling a migration job
In order to start migration jobs automatically, you must configure those 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).
1. From Windows Start menu, select Settings → Control Panel → Scheduled Tasks
→ Add Scheduled Tasks to open the Scheduled Task Wizard window. Select the
Next button.
38 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
2. Select the Browse button to browse and select the migration program
(dsmclc.exe). Then select the Open button.
3. Specify an alternative name and time interval for the job to be run and select
the Next button.
4. Specify the time settings you wand and select the Next button.
Figure 35. Scheduled Task Wizard opening window
Figure 36. Scheduled Task Wizard perform task window
Chapter 4. Migration jobs 39
5. Enter a user name, password, and confirmation password and select the Next
button.
6. Check the Open advanced properties for this task box to open that properties
definition window.
Figure 37. Scheduled Task Wizard day schedule window
Figure 38. Scheduled Task Wizard password window
40 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
7. Fill in your settings as needed and select the OK button when finished. The
Run parameter is: <dsmclc.exe><jobfile_name>
Note: When you select the program by browsing, you still have to manually
add the name of the job file in the Run parameter: sample.osj in
Figure 40.
Figure 39. Scheduled Task Wizard finish window
Figure 40. Scheduled Task Wizard dsmclc window
Chapter 4. Migration jobs 41
Chapter 5. Retrieving migrated or archived files
When using the HSM for Windows client GUI to search for and retrieve files that
have been migrated or archived, first obtain a list files based on your criteria. From
this list, select the files that you want to retrieve, and then define specific retrieval
options, such a specific version to retrieve or to be prompted before overwriting
files.
Follow these steps to search for and retrieve migrated or archived files:
1. Select Migrate Retrieve → Search & Retrieve.
2. Select the File Space in which you want to search for files.
3. Specify your search criteria and click Search. If you do not specify at least one
search criterion, you receive a warning, and all of the files stored in the file
space are shown. The Path and Filename fields are case sensitive, but the
Volume field is not case sensitive. You can use wildcards in any field: an
asterisk matches zero or more characters, and a question mark matches a single
character.
4. After the list of matching files is displayed in the Search Results window, click
Select All to retrieve all files or select individual files and then click Retrieve.
If you select just one file to retrieve, you can select a specific version to retrieve
(see step 5 on page 44). If you select more than one file, you cannot select
specific versions, but can select the directory into which they are saved (see
step 6 on page 45). In the Search Results window, you can also click Search
again to obtain a different set of files to retrieve.
Figure 41. Search in File Space window
© Copyright IBM Corp. 2005, 2007 43
After clicking Retrieve in the Search Results window with only one file
selected, the Retrieve options window displays.
5. Use the Version menu to select the version of the file that you want to retrieve.
Also select one of the following three options in the Overwrite section: Keep
existing file(s), stubs will be overwritten, Prompt before overwriting existing
file(s), stubs will be overwritten, Overwrite existing files. When you have
Figure 42. Search Results window
44 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
made your selections, click Retrieve to retrieve the selected file.
After clicking Retrieve in the Search Results window with more than one file
selected, the Retrieve options window displays.
6. Select to either save the files to their original location or select a directory into
which you want to save the selected files. Also select one of the following three
options in the Overwrite section: Keep existing file(s), stubs will be
overwritten, Prompt before overwriting existing file(s), stubs will be
overwritten, Overwrite existing files. When you have made your selections,
click Retrieve to retrieve the selected files.
Figure 43. Search in File Space window
Figure 44. Search in File Space window
Chapter 5. Retrieving migrated or archived files 45
Chapter 6. Configuring reconciliation
Reconciling synchronizes your file system with the Tivoli Storage Manager server
by logging orphan stubs and by deleting obsolete copies of files. You use the HSM
for Windows client GUI to both configure and start reconciliation. You can start
reconciliation at any time and can define reconciliation to run automatically in
defined intervals.
The two main advantages of reconciliation are to reduce costs and to maintain
integrity of your file systems. Reconciliation can reduce your costs by removing
unnecessary or obsolete migrated objects from the Tivoli Storage Manager server
storage. With fewer files, you need less storage and fewer licenses because the
HSM for Windows client is volume-licensed based on the amount of terabytes used
on the Tivoli Storage Manager server for migrated data.
The HSM for Windows client helps you maintain the integrity of your file systems
by finding orphan stubs. Those orphans are recorded in the hsmmonitor-orphan.log. When you check that log file, you decide if you want to delete the
orphan stub or if you want to restore the stub from a backup.
Note:
v Reconciliation should not be used with files paces or volumes with
migration jobs that have the action Keep the original file or Delete the
file (see “Creating migration jobs” on page 24).
v Reconciliation is not supported for configurations, where clustered
volumes are nested into other volumes.
v Because reconciliation deletes objects on the server, it is strongly
recommended to back up all migrated files before starting reconciliation.
v Reconciliation only works with stub files that have been created by IBM
TSM HSM for Windows V5.4 or higher.
v Reconciliation can also be configured from the Windows command
prompt using the dsmhsmclc.exe command (see “dsmhsmclc.exe” on
page 53).
v To improve reconciliation performance and avoid having to use the
backup-archive client to restore files, use separate file spaces for each local
file system and do not rename volumes. Before configuring a file space for
reconciliation, understand the following multiple conditions and
consequences:
– The HSM for Windows reconciliation process needs to find all migrated
objects for one file system on the Tivoli Storage Manager server.
– If files from one file system are migrated to several file spaces, the
reconciliation process queries all these file spaces.
– If files from several local file systems are migrated to the same file
space, then the server eventually (depending on the names of the files)
returns not only the files from the file system, which is currently
reconciled, but also other files to the HSM client.
– Using the current name of the volume and the name of the currently
nested volumes, the reconciliation process sorts out the files which do
not belong to the file system that is being reconciled.
© Copyright IBM Corp. 2005, 2007 47
|
|
|||||
||||||
||||
|
|||
||
||
||
|||
|||||
||
||
||||
|||
– If the following conditions are met, then the reconciliation process
might erroneously assume that the file has been deleted locally and
thus also deletes it from the Tivoli Storage Manager server:
- If the name of a volume has been changed after files were migrated
from it
- If the same file space was used for migration of multiple file systems
- If this file space is configured for reconciliation of a file system– If this situation occurs, you can use the backup-archive client to
restore the complete file space using the backup-archive client (see
“HSM for Windows client backup integration with the backup-archive
client” on page 60). But again, it is recommended to avoid this
situation by not renaming volumes after files have been migrated from
them.v If you restore a file-system image backup and plan to run reconciliation,
you must restore the files that have been migrated after the image
backup. Otherwise, migrated files, which have been created after the
image backup, expire from the HSM archive storage on the Tivoli Storage
Manager server. Also if reconciliation runs after the image backup and
deletion of migrated files, the restored stubs from the image are not
readable and must be restored from the file backup.
To configure reconciliation, select Tools → Reconciliation. Figure 45 displays an
example Reconciliation settings window and Table 14 on page 49 describes each of
its fields.
Figure 45. HSM for Windows client Reconcile settings window
48 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
|
|||
|||
||
|
|
||||||
|||||||
||||
Table 14. Reconcile settings window field descriptions
Field Description
Mount path Specifies the volume drive letter or volume mount
point for nested volumes of the volume to be
configured for reconciliation
Status Specifies the status of the current reconcile
configuration for the selected mount path and whether
a reconciliation process is running or not running.
Click the Refresh button to get the current status.
Unconfigure and Configure This button displays Unconfigure if the selected mount
path is configured. You can select it to unconfigure
reconciliation on the mount path. If the button displays
Configure, select it to configure the selected mount
path for reconciliation.
Next reconcile Displays the date and time of the next reconciliation.
The default is the current date and time.
Reconcile interval (hours) Specifies the period in hours between the automated
reconciliation process runs. An interval of 0 hours,
deactivates any automated reconciliation process on
this mount path.
Reconcile now If selected, specifies that reconciliation runs after you
click the OK or Apply button. Selecting this option,
always results in an extra run of the reconciliation
process. After this extra reconciliation process, the next
regular reconciliation will start at the configured Next
reconcile time and date. Setting Reconcile interval
(hours) to 0 does not deactivate the functionality of the
Reconcile now check box.
All available file spaces
Selected file spaces only
Select one of these options to configure the next
reconciliation process to run on all file spaces (those
displayed in the Available box) or on just the file
spaces that you highlight and move from the Available
box to the Selected box.
Maximum number of parallel
reconcile threads
Specifies the integer value to limit the number of
reconcile processes.
Refresh Refreshes the information in the window.
Cleanup Select this button when a volume configured for
reconciliation is deleted and the volume is no longer
available as a mount path. In this case, the Cleanup
button is enabled and allows you to remove the old
configuration.
Changing volume mount paths
Although you can change volume mount paths after files are migrated, it is
strongly recommended that you do not because this change might affect
reconciliation. There are some methods to mitigate issues, such as lost data, if you
must change volume mount paths.
As an administrator, you can change the path of a volume. For example, you can
change the volume letter from e: to f: or you can change the mount path from
e:\nested to f:\nested. This modification does not recall files nor does it affect the
accessibility of migrated files. The stubs can still be recalled after such a rename.
However, the following example shows how it can affect reconciliation.
Chapter 6. Configuring reconciliation 49
||
||
||||
|||||
||||||
|||
|||||
|||||||||
|||||||
||||
||
|||||||
||
||||
|||||
If you have a volume e:, a nested volume e:\nested, and a file e:\nested\file,
when the file is migrated, it can be found on the Tivoli Storage Manager server
under the name \\mynode\e$\nested\file. If you move the nested volume from
e:\nested to f:\nested, and you, or another user, then runs a reconciliation on e:,
the process cannot determine that there was a nested volume e:\nested. Thus, the
process assumes that \\mynode\e$\nested\file is a file that has been deleted. As
a consequence, reconciliation removes the object \\mynode\e$\nested\file from
the Tivoli Storage Manager server.
In order to avoid such a situation, you can migrate the files of each volume to a
separate file space on the Tivoli Storage Manager server. Reconciliation can then be
limited to this file space, only. In this case, the Tivoli Storage Manager server
query, which is performed at the beginning of the reconciliation for a volume, does
not return any objects from other volumes and consequently does not delete any
objects from other volumes.
Note:
v This is only necessary, if the drive letter or volume mount path is
changed. If the configuration is unchanged, reconciliation correctly
identifies the volume for each object on the Tivoli Storage Manager server
and thus does not delete any data in error.
v You can manage which file spaces are used during reconciliation with the
FILESPacelist option of dsmhsmclc command or by using the Reconcile
settings window of the HSM for Windows client GUI.
If reconciliation has already deleted objects in such a case, you then have to restore
the files from the backup. Because the HSM for Windows client is integrated with
the backup-archive client, you are able to restore the complete data, even if the file
content has been deleted from the HSM archive. See “Restoring HSM files with the
backup-archive client” on page 62 for more information.
50 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
||||||||
||||||
|
||||
|||
|||||
Chapter 7. Using commands
The HSM for Windows client has several commands you can run from a Windows
command prompt. With these commands you can: view settings such as log levels,
OS and library versions, file attributes, files eligible for migration; configure and
run reconciliation; and convert stub data for the reconciliation task.
Table 15 summarizes the HSM commands.
Table 15. HSM for Windows client command shell commands
Command Description
dsmclc.exe Use this command to run a migration job from the Windows
command prompt. You can also list files and file spaces.
dsminfo.exe Use this command to list various settings of your installation
such as the version of libraries, actual log level settings, the
operating system version, and disk information.
dsmfileinfo.exe Use this command to list attributes of migrated and
non-migrated files.
dsmfind.exe Use this command to list files that are eligible by a job file or
that correspond to a pattern.
dsmhsmclc.exe Use this command to configure reconciliation.
dsmReconConverter.exe Use this command once to convert pre V5.4 stubs and server
objects to the V5.5.0 format for enhanced reconciliation.
dsmclc.exe
Normally you run migration jobs through a scheduler program; however, you can
run a migration job from the Windows command prompt using the dsmclc.exe
command. You can also list files and file spaces.
Note: Entries for file spaces and search patterns are case sensitive.
The following is the general usage of the dsmclc command:
dsmclc [migrate] [-l loglevel] <jobfile>
Table 16 describes the command line options for the dsmclc.exe command line
migration program.
Table 16. dsmclc.exe command prompt options
To: dsmclc command elements
List migrated files d:\Office
Documents\*.doc in the file space
″officespace″.
list -g officespace D: ″\Office Documents\″ *.doc
Migrate the files in the job list file
″joblist″. This file is a text file that
contains the absolute path names
of the files, which are to be
migrated. The file can be created
by a third party application.
migratelist -g <filespace> -x <action> [-l loglevel]
<joblist>
© Copyright IBM Corp. 2005, 2007 51
|
|
Table 16. dsmclc.exe command prompt options (continued)
To: dsmclc command elements
Retrieve files from a specific file
space
retrieve -g <filespace> [-f][-l loglevel] <search patterns>
List file spaces listfilespaces [*|filespace] [-l loglevel]
Delete files from a file space delete -g <filespace> [-l loglevel] <search patterns>
Create a file space createfilespace -g <filespace> [-l loglevel]
Replace migrated files with stub
files
Use the <replace> action
Delete archived files Use the <delete> action
Keep archived files Use the <keep> action
Use <search patterns> Specify at least 3 blank separated search parts. For
each part, * and ? may be used to match files.
Match a volume Use <volume-pattern>
Match a directory Use <directory-pattern>
Match a filename Use [file-pattern]
Use the force option to (overwrite
files)
-f
Use the loglevel option (default:
SEWIL)
-l
After executing the command, use Table 17 to understand the status of the
processed operations.
Table 17. dsmclc.exe return codes
Code Description
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. 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.
dsmfileinfo.exe
Run the dsmfileinfo.exe program from a command shell to view file attributes.
The following command is a usage example:
dsmfileinfo [-r] <filename>
Table 18 shows the options for the dsmfileinfo.exe program.
Table 18. Command line options for dsmfileinfo.exe
Option Description
-a Shows all
-i Show file object id; or -ic to create file object id
52 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Table 18. Command line options for dsmfileinfo.exe (continued)
Option Description
-m Calculate MD5 key (files only)
-q Query backend version(s) (stubs only)
-r Show reparse data (stubs only)
-s Show file security
-t Show file times, size, and attributes (default)
dsmfind.exe
Run the dsmfind.exe program from a command shell to show files that fit a job file
or that correspond to a pattern.
Usage:
dsmfind <jobfile|pattern>
You can display the help for this command if you issue the dsmfind command
without any command line options.
Table 19 shows the options for the dsmfind.exe command.
Table 19. Command line options for dsmfileinfo.exe
Option Description
-r recurse (pattern only)
-s stubs only (pattern only)
dsmhsmclc.exe
Issue the dsmhsmclc.exe command from a Windows command prompt to define
reconcile settings, start reconciliation, unconfigure reconciliation, set log levels, and
show file system settings.
The dsmhsmclc.exe command has several options, and you can use combinations
of the different options in one command. For example, a command for configuring
one volume for immediate reconciliation, using all file spaces, and an interval of
1000 hours would be similar to:
dsmhsmclc e:\ -RECONCILEINT 1000
The command for configuring the next reconciliation to start at midnight on the
31st of November 2007 using file spaces filespaceA and filespaceC, with an interval
of one year (8760 hours) would be similar to:
dsmhsmclc e:\ -NEXTREConcile 2007-11-31-00-00 -FILESPacelist
filespaceA,filespaceC -RECONCILEINT 8760
If you do use an option, you should usually specify a value for the option. For
example, the following command specifies a reconcilenow option value of yes:
dsmhsmclc e:\ -reconcilenow yes
If you don’t specify a value for an option, then either the value remains unchanged
or the default is used. For the following to examples, assume volume e:\ and f:\
are not yet configured for reconciliation. The following command:
Chapter 7. Using commands 53
|
|||
||||
|
|||
||
||
|
|||
dsmhsmclc e:\
configures the volume and applies the defaults for all options (nextreconcile,
filespacelist, reconcilenow, reconcileinterval). The following command:
dsmhsmclc f:\ -reconcileinterval 1000
configures the volume and applies all defaults, except for reconcileinterval, which is
set to 1000. Then, if you issue the following command:
dsmhsmclc e:\ -reconcileinterval 8000
the only change is to reconcileinterval, making it 8000. The other options for e:\ will
remain unchanged.
Restriction:
You can only use a variety of options with the dsmhsmclc command
with a <vol_mount_path> as parameter. If you use the command with
one of the following options: maxreconcileproc, query, or unconfigure;
you can only use that one option.
Table 20 describes the variable parameters used in the command examples that are
not predefined.
Table 20. dsmcsmclc command variable descriptions
Variable name used in
the command examples Description
<file_space> The name of a file space.
<date_time> Date and time in the format: ″YYYY-MM-DD-HH-MM″, where
″YYYY″ = year; ″MM″ = month; ″DD″ = year; ″HH″ = hour;
″MM″ = minutes.
<log_level> The single character for denoting the log level, the default is
SEWIL. The possible values are: C (event), D (debug), E (error), F
(flush), I (info), K (driver), L (library), T (trace), U (user), W
(warning), X (dump). See Table 26 on page 68 for a description of
the values.
<vol_mount_path> Any root directory such as ″C:\″, ″D:\″, or the path of a mount
point (″E:\MountedVolumes\Volume″).
Table 21 displays example usage for the dsmhsmclc command.
Table 21. dsmhsmclc.exe command examples
dsmhsmclc parameter usage examples
dsmhsmclc <vol_mount_path> -NEXTREConcile <date_time>
Specifies when the next regular reconcile will occur on the specified file system. The
default is the current date and time.
dsmhsmclc <vol_mount_path> -RECONCILEINTerval <number_hours>
Specifies the number of hours between reconciliation runs. The default is 720 hours. The
range of acceptable values is 0 to 876000. If this option is set to 0, automatic reconciliation
is deactivated.
dsmhsmclc <vol_mount_path> -RECONCILENOW (yes|no)
If yes, specifies the reconciliation starts immediately. The default is no.
54 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
|
||
|
||
|
||
|
||||
||
||
|||
||
||||
||||||
|||||
||
|
|
||
|
|||
|
|
Table 21. dsmhsmclc.exe command examples (continued)
dsmhsmclc parameter usage examples
dsmhsmclc <vol_mount_path> -FILESPacelist (ALL|<file_space>[,<file_space>[...]])
A comma-separated list of file spaces to reconcile. You can improve the reconcile
performance and scalability by restricting the query to the files spaces that contain
migrated files of the volume you are configuring. The default is ″ALL″, which means that
all are available file spaces are used.
dsmhsmclc <vol_mount_path> -L <log_level>
The logging level for reconciliation.
dsmhsmclc -MAXRECONCILEPROC <max_number_of_process> [-L <log_level>]
Sets the global MAXRECONCILEPROC option to the specified value. This option specifies
the number of file systems that can be reconciled in parallel. If this number is exceeded,
any pending reconciliation tasks are delayed until the running reconcile tasks finishes. The
default is 3. The range of values is 1 to 16.
dsmhsmclc -Query [<vol_mount_path>[,<vol_mount_path>[...]]] [-L <log_level>]
Without a parameter, this command returns the settings of all configured file systems to
the command line. With a comma separated list of files systems as the parameter, only
those file systems’ information is shown.
dsmhsmclc -UNCONFigure <vol_mount_path> [-L <log_level>]
Unconfigures reconciliation on a volume.
dsmhsmclc [-Help|-?] [-L <log_level>]
Displays the help text for the dsmhsmclc command.
dsminfo.exe
Run the dsminfo.exe program from a command shell to view HSM for Windows
client settings.
When you run this command the log file dsminfo.log is created.
The following is an example command that shows the defined quotas:
dsminfo quota
Table 22 shows the options for the dsminfo.exe program.
Table 22. Command line options for dsminfo.exe
Option Description
all Performs every task in this table
allquota Displays quotas of all users on the given server
clclog Displays the dsmclc command’s log level
disk Displays hard disk(s) information
domain Displays domain information.
domgroups Lists the domain local groups
domusergr Lists the domain local users and the groups of each user
domusers Lists the domain local users
driver Displays HSM for Windows file system driver version
Chapter 7. Using commands 55
|
|
|
||||
|
|
|
||||
|
|||
|
|
|
||
|
Table 22. Command line options for dsminfo.exe (continued)
Option Description
errors Displays only messages containing installation errors
files Checks if all required files are present
filter Displays the attribute file filter and minimum file size
guilog Displays the dsmgui command’s log level
help Displays the help for the options for this command
infolog Displays dsminfo command’s log level
installdir Displays the installation directory
ip Displays local machine IP addresses
locausers Lists the computer local groups
locusergrl Lists the computer local users, list the groups of each user.
locusers Lists the computer local users
quota Displays only defined quotas
save Saves the output to check_installation.txt (any further run of the
command will delete this file)
servicelog Displays the hsmservice command’s log level
stamps Displays version information of IBM Tivoli HSM binaries
tivoli Displays the versions of Tivoli Storage Manager backup archive client and
API
user Displays the current user name
version Displays the HSM for Windows client version
win Displays the Windows version and fix pack
dsmReconConverter.exe
The dsmReconConverter command converts pre-V5.4 stubs to a format compatible
with reconciliation. The command also checks all stub files and their Tivoli Storage
Manager server objects for inconsistencies and tries to resolve them.
Note: For information on reconciliation see “Reconciliation overview” on page 4.
Table 23 describes the variable parameters used in the command examples that are
not predefined.
Table 23. dsmReconConverter command variable descriptions
Variable name used in
the command examples Description
<file_space> The name of a file space.
<log_level> The single character for denoting the log level, the default is
SEWIL. The possible values are: C (event), D (debug), E (error), F
(flush), I (info), K (driver), L (library), T (trace), U (user), W
(warning), X (dump). See Table 26 on page 68 for a description of
the values.
<vol_mount_path> Any root directory such as ″C:\″, ″D:\″, or the path of a mount
point (″E:\MountedVolumes\Volume″).
The following example command converts all files in <vol_mount_path> and all
56 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
|
|||
|
||
||
|||
||
||||||
|||||
corresponding objects on the Tivoli Storage Manager server in either all file spaces
(ALL) or the selected <file space>, to the needed reconciliation format. After the tool
runs successfully on the volume, that volume is ready for reconciliation.
dsmReconConverter <vol_mount_path> -FILESPacelist (ALL|<file_space>
[,<file_space>[...]]) [-L <log_level>]
The following command shows the help text for this command:
dsmReconConverter [-Help|-?] [-L <log_level>]
The following two examples show a simple command and show a more complex
command that can be used for nested environments:
dsmReconConverter F: -filesp ALL
dsmReconConverter G:\myNestedVolume -filesp test2,test3,test4
Chapter 7. Using commands 57
|||
||
|
|
||
||
|
Chapter 8. Backup-archive client integration overview
With V5.5.0, three backup-archive client options control the HSM for Windows
client data. The Skip migrated files option regulates backup and archive
operations on stubs. The two restore options, Restore as migrated file, and Restore
resident if not accessible, define how stubs are restored.
Full integration between HSM for Windows client and the backup-archive client
requires version 5.5 of the Tivoli Storage Manager server and of the backup-archive
client. If you do not use V5.5 for both these products, the backup-archive client
might not always be able to maintain a copy of the resident and the migrated file,
and thus, you might not be able to restore the full file from a backup.
Use the backup-archive client HSM for Windows preferences tab to set the HSM
for Windows client options. You access that tab by running the backup-archive
client GUI (dsm.exe), selecting Edit → Preferences, and then selecting the HSM for
Windows tab. The HSM for Windows tab in the backup-archive preference editor
only displays, if HSM for Windows client is installed. You can also edit the
dsm.opt backup-archive client options file and set these values to yes or no. Do not
edit the HSM client dsm.opt file, which is separate from the backup-archive
dsm.opt file. A yes value is equivalent to not selecting a check box and a no option
is equivalent to clearing the check box.
Table 24 relates the name of the check box in the HSM for Windows tab with the
short option name used in the backup-archive client dsm.opt file.
Table 24. Backup-archive HSM for Windows option names
HSM for Windows preferences
tab check box name Short option name (dsm.opt) Default
Skip migrated files SKIPMIGRATED Unchecked (no)
Restore as migrated file RESTOREMIGSTATE Checked (yes)
Restore resident if not
accessible
RESTORECHECKSTUBACCESS Checked (yes)
The integration between the HSM for Windows client and the backup-archive
client ensures the backup-archive client, independent from HSM for Windows
client, always maintains a copy of the complete file in the backup pool, whether
this file is migrated or not. In other words, for migrated files there are two
identical versions of the file on the Tivoli Storage Manager server: one is in the
HSM archive, created by the HSM client; and one is the backup copy in the backup
pool, created by the backup archive client. Because of this, when restoring files, the
backup-archive client can always recreate the complete file from the backup only,
even in the case of an HSM for Windows client issue (for example, when the copy
in the HSM archive has been erroneously deleted). But this is only true when the
stubs have been backed up with the V5.5.0 of the backup-archive client.
To understand the Skip migrated files option and the HSM for Windows client
integration with the backup-archive client’s backup function, see “HSM for
Windows client backup integration with the backup-archive client” on page 60.
© Copyright IBM Corp. 2005, 2007 59
|
|
||||
|||||
|||||||||
||
||
||||
|||
|||
||||
|
|||||||||||
|||
To understand the Restore as migrated file, and Restore resident if not accessible
options and the HSM for Windows client integration with the backup-archive
client’s restore function, see “Restoring HSM files with the backup-archive client”
on page 62.
HSM for Windows client backup integration with the backup-archive
client
Use the Skip migrated files (SKIPMIGRATED) option of the backup-archive client
to manage whether HSM for Windows migrated files are processed by the
backup-archive client or not.
Tip:
v See Chapter 8, “Backup-archive client integration overview,” on page 59 for
instructions on setting this option in the backup-archive client or the
backup-archive client’s dsm.opt file.
v See “Impacts of changing file encryption” on page 61 to understand the
recall impacts when you change encryption on resident or stub files.
v
If the backup-archive client Skip migrated files check box is not checked or the
value is set to no in the backup-archive client dsm.opt file, all files are processed
during a backup independent of the migration state.
In this case, the backup-archive client ensures that whenever a stub is backed up
there is a copy of the complete file in the backup. If a file has not been backed up
before migration, the migrated file is recalled during an operation before the
backup. On the next run of a migration job, the file will be remigrated and the
subsequent back up will then back up the stub itself. The backup is created on the
Tivoli Storage Manager server and the copy of the resident file is linked with the
copy of the stub in the backup pool. This means that the copy of the resident file
does not expire until the stub copy expires. The backup-archive client knows about
both the file in the backup and the copy of the stub. Thus, both the resident or the
migrated files can always be recreated using the backup-archive client.
Interaction between HSM for Windows client and the backup-archive client is
handled through a plug-in, which is installed by the HSM for Windows client in
the plug-in directory of the backup-archive client. If a file needs to be recalled, but
the HSM for Windows client is not able to do so (for example, because the IBM
TSM HSM Recall Service is not running or the file is an orphan), the
backup-archive client will fail to back up the file with an I/O error.
If the option is checked (yes), the backup-archive client does not process any HSM
for Windows client stubs. Thus, no file is recalled, and the stubs are not backed up.
Stubs not being backed up might lead to an out-of-space condition when you
restore files, because they (even migrated ones) are always restored to a resident
state.
You need to explicitly manage the Skip migrated files option before the first
backup after installing the 5.5.0 version of the backup-archive client so that you do
not create an out-of-space condition. If you have many files that have not been
backed up before migration, and Skip migrated files is unchecked, all of those
files are recalled at the next backup. This might create massive recalls during the
60 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
||||
||
|
|||
|
|||
||
|
|||
||||||||||
||||||
|||||
|||||
first backup. The number of files recalled will be increased if you have many files
that were migrated and backed up with an earlier version, or if you renamed stubs
or directories containing stubs.
During any backup, you can keep migrated files from being backed up by selecting
the backup-archive client option Skip migrated files. But you will probably want
to take advantage of the backup-archive client integration and not leave the Skip
migrated files permanently checked.
You can take advantage of this feature and avoid an out-of-space condition from
the recall of files that were not yet backed up by:
v Running your first regular backup with the Skip migrated files checked.
v Running backups on selected directories with the Skip migrated files option
unchecked. You select which directories to manage on a case-by-case basis based
on your available space and how many migrated files have not previously
backed up in a specific directory. Thus, you manage, for each directory, the
number of files that are recalled.
v Remigrate the recalled files to free up space.
v After you do this for each directory, leave the Skip migrated files option
unchecked (no) for regular backup jobs.
The following backup-archive client dsmc command runs a backup that skips
migrated files:
dsmc inc N:\file.txt –skipmigrated=yes
The following list contains additional considerations:
v The backup-archive client only archives the contents of a migrated file and never
the stub. The same is true for selective backup. So, for the archive and selective
backup, the stubs are always recalled during the operation.
v For planning, keep in mind that as discussed in this section your first backup
after the installation of V5.5.0 and archive and selective backups can take more
time than you are used to because the migrated files are first recalled before they
are backed up.
v Subfile backup, in conjunction with HSM for Windows, is not supported.
v Your Tivoli Storage Manager server administrator can set some client options
that are available on the Tivoli Storage Manager server. Any client option that is
set by the server overrides the client defined option value.
v Stub files are not backed up during an incremental by-date backup. You must
run an incremental backup in order to back up the stub files.
Impacts of changing file encryption
You need to take special care when applying encryption to or removing encryption
from resident files or stub files. When you change the encryption of a file, the
backup and resident file content is no longer the same. When the encryption of a
file has changed, the backup-archive client treats this as content change. If this
applies to a migrated file, a recall is triggered at the next incremental backup.
Thus, if you change the encryption status of many stubs, a massive recall might be
triggered at the next incremental backup, which might cause an out-of-space
condition. To avoid this situation, set the encryption status of files before backing
up the resident files.
If you need to change the encryption status of many stub files, follow these steps:
Chapter 8. Backup-archive client integration overview 61
|||
||||
||
|
|||||
|
||
||
|
|
|||
||||
|
|||
||
|
|||||
||||
|
1. Change the encryption status of the appropriate files in one directory of a file
system.
2. Run an incremental backup of the changed files in the directory. Stub files with
a modified encryption status are recalled.
3. Migrate the changed files.
4. Optionally, backup the files.
5. Repeat steps 1 through 4 for each directory in the file system that contains files
with a changed encryption status.
Restoring HSM files with the backup-archive client
Use the Restore as migrated file (RESTOREMIGSTATE) and Restore resident if
not accessible (RESTORECHECKSTUBACCESS) backup-archive client options to
manage how stub files are restored from Tivoli Storage Manager storage.
Tip:
v See Chapter 8, “Backup-archive client integration overview,” on page 59 for
instructions on setting these options in the backup-archive client or the
backup-archive client’s dsm.opt file.
v If the HSM for Windows client is not installed, or if the IBM TSM HSM
Recall Service is not running, default security attributes are applied to
restored files.
You can use the Restore resident if not accessible option to verify the readability
of a stub file before restoring the corresponding migrated file as a stub. If the stub
file is not readable, the file will be restored completely (in the resident state) and
not as a stub. If you do not select this check box (no), the backup-archive client
does not check whether the migration copy is available in the HSM migration
storage pool. The backup-archive client restores the migrated file as a stub file
without this verification.
Restore as migrated file controls whether the stub is recreated at all, or whether
the resident file is always restored. When the Restore resident if not accessible
option is unchecked (no), it disables the readability check in the HSM pool. If you
do not check the Restore resident if not accessible check box (no) and do check
Restore as migrated file check box (yes), then the stub will be always restored.
This also means that the backup-archive client does not need to request the data of
the resident file from the Tivoli Storage Manager server. Thus during a restore, less
data is transferred from the server to the client, and less temporary space is
needed.
Note:
v The Restore resident if not accessible option is only evaluated in
combination when the Restore as migrated file check box is checked (yes).
v In addition to these options, the following conditions must also be met for
a file to only be restored as stub:
– The file was migrated on the last backup
– The HSM for Windows client is installed
– The restored object is the active version
– The original file system and the target file system are of the same type
(NTFS)
– The file system, high level name, and low level name are identical
(source and destination)
62 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
||
||
|
|
||
||
|||
|
|||
|||
|||||||
|||||||||
|
||
||
|
|
|
||
||
The following examples use the backup-archive client dsmc rest command. The
Restore as migrated file check box sets the RESTOREMIGSTATE option and the
Restore resident if not accessible check box sets the
RESTORECHECKSTUBACCESS option.
v The default behavior is to restore a stub file as a stub, if it is accessible in HSM
archive, otherwise as a resident file:
dsmc rest N:\file.txt –restoremigstate=yes –restorecheckstubaccess=yes
v Restore a stub file as a stub without checking its accessibility in HSM archive:
dsmc rest N:\file.txt –restoremigstate=yes –restorecheckstubaccess=no
v Restore stub file as a resident file:
dsmc rest N:\file.txt –restoremigstate=no
v Restore a stub to different position that causes a resident restore:
dsmc rest N:\file.txt N:\file2.txt –restoremigstate=yes
restorecheckstubaccess=no
Use the following summary of the advantages and one disadvantage of these
backup-archive client restore options (restoremigstate=yes and
restorecheckstubaccess=no) to help you decide how to use them:
v Advantages:
– Less temporary space needed during restore
– Less network traffic
– Faster restorev Disadvantage:
– The combination of checking Restore as migrated file and not checking
Restore resident if not accessible is the most space efficient and fastest way
to restore stubs. However there might be orphan stubs after such a restore. If
you run reconciliation after such a restore, the process detects these orphans,
which you can restore individually as resident files.
Depending on your settings, when HSM for Windows migrated files are restored,
resident and migrated files are sent from the Tivoli Storage Manager server to the
client. These objects are stored in a subdirectory under the temporary directory,
\~tsmtemp\, in the volume root. At the end of a restore, this subdirectory is
deleted, and \~tsmtemp\ is deleted if there is no other subdirectory from another
restore. If a backup-archive client restore process is stopped in an unusual way (for
example by pressing Ctrl+C or by restarting your system), this subdirectory, and
any files in it, are not deleted. In this case you must manually delete them.
Chapter 8. Backup-archive client integration overview 63
||||
||
|
|
|
|
|
|
||
|||
|
|
|
|
|
|||||
||||||||
Chapter 9. HSM advanced parameters and file location
settings
Although most parameters’ default settings are appropriate, you can customize
some settings.
Note: See “Tracing preferences” on page 67 for information on setting log and
trace file settings.
Table 25 displays the advanced parameters. For all parameters except the Timeout
parameter, the Parameter name and description column shows you the parameter
name and Windows registry path from the end of this common path:
HKLM\SOFTWARE\IBM\ADSM\CurrentVersion\HsmClient\. The Timeout
parameter’s full path is listed in the Parameter Name column.
Table 25. Advanced parameters descriptions
Parameter name and description Default Notes
HKLM\SYSTEM\CurrentControlSet\Services\ithsmdrv\Parameters\Timeout
Defines the number of seconds after which
the File System Filter Driver returns an
error, when a requested file has not been
received in this period by the recalling
application.
60 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.
dsmclc\FileAttributesFilter and dsmgui\FileAttributesFilter
Configures the registry to prevent files with
certain attributes from migration. The
dsmclc registry path is for dsmclc.exe, and
dsmgui is for dsmgui.exe.
6 -
hidden
and
system
Change this parameter only on
technical advice from IBM.
dsmclc\DirectoryAttribuesFilter and dsmgui\DirectoryAttribuesFilter
Configures folders with certain attributes
that are generally not entered for selecting
files for migration. The dsmclc registry path
is for dsmclc.exe, and dsmgui is for
dsmgui.exe.
6 -
hidden
and
system
Change this parameter only on
technical advice from IBM.
File location preferences
Use the HSM for Windows client GUI Preferences window’s Path Configuration
tab to define the location of the HSM for Windows client configuration file,
migration job files, and temporary files.
Access the Preferences Path Configuration tab by selecting HSM for Windows
client GUI. Select Tools → Preferences → Path Configuration.
Figure 46 on page 66 contains three fields where you select the path of the three
different file types: configuration, migration, and temporary. Click Browse to select
an existing directory.
© Copyright IBM Corp. 2005, 2007 65
|
|||
||
||||
Recall service settings
Use the HSM for Windows client GUI to define the recall service settings (IBM
TSM HSM Recall Service).
Access the Recall Service tab of the Preferences window by selecting Tools →
Preferences → Recall Service.
Only change the value in the Thread(s) box on advice from IBM. This value
determines the number of concurrent connections you can have for the recall
service. The default is 4 and the maximum is 64.
Use the Second(s) box to define the number of seconds after which the recall
service closes the connection to the Tivoli Storage Manager server. The default is
600.
Note: If a file is recalled from a tape, the connection is reset to ensure the tape is
not locked after the recall.
Figure 46. Trace Preferences->Path Configuration window
Figure 47. Preferences windows Recall Service tab
66 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
|
|||
Recall quota entries deletion interval
Use the HSM for Windows client GUI to define the interval that the program uses
to delete recall quota entries. These entries are created to track quota allocations.
Access the Recall Service tab of the Preferences window by selecting Tools →
Preferences → Recall Quota.
Use the Minute(s) box to define the number of minutes for the interval the recall
service uses to delete expired quota entries. Changing this value to a smaller
interval than the default of sixty minutes may give you some hard disk space gain
but at a higher CPU performance. Increasing the value has the contrary effect.
Tracing preferences
HSM for Windows client processing, from both the GUI and the commands,
creates several log files, trace files, and listings files. You use the HSM for
Windows client GUI to define the level of information recorded in these files, their
location, and their maximum size.
In normal production, these preferences settings should be set to the defaults. The
default level records warnings and errors and does not record trace-level messages.
You should increase the logging level only when you need to perform advanced
diagnostics. The Severe and Error logging levels are active by default and cannot
be deactivated.
When you change log levels in the hsmservice and dsmgui tabs (see Figure 49 on
page 68), you do not need to restart either of those programs for those settings to
become active. However other changes, such as file location, require a restart for
which you will see a message box telling you to restart the client (the HSM for
Windows client GUI) or the IBM TSM HSM Recall Service (hsmservice.exe), or the
IBM TSM HSM Monitor Service (hsmmonitor.exe).
There are three types of settings you define for the logs: their recording level, their
size, the log file location. To access these settings from the HSM for Windows client
GUI, select Tools → Trace Preferences. Figure 49 on page 68 contains the trace
levels and size settings you can select for each executable file or plug-in in the
HSM for Windows client program. The example Figure 49 on page 68 is for the
dsmgui.exe executable file, but most other tabs (for example, dsminfo, dsmhsmclc,
and dsmclc) are identical. The Path Configuration tab is different from these other
Figure 48. Preferences windows Recall Service tab
Chapter 9. HSM advanced parameters and file location settings 67
|
||||
|||||
||||||
|||||||
tabs (see Figure 50 on page 69). Table 26 describes each setting.
Table 26. Tracing preferences window field definitions
Field Description
Trace Levels section
Severe Records HSM Windows messages that are categorized as severe.
Error Records HSM Windows messages that are categorized as errors.
Warning If checked, records HSM Windows messages that are categorized
as warnings.
Info If checked, records HSM Windows messages that are categorized
as information only.
Trace If checked, turns on the tracing of program events and should be
used for advanced diagnostics or for problem analysis.
Debug If checked, records special debugging information and codes
should be used for advanced diagnostics or for problem analysis.
Library If checked, records specific library information and should be used
for advanced diagnostics or for problem analysis.
Dump If checked, records additional information on issues and should be
used for advanced diagnostics or for problem analysis.
Events If checked, records diagnostic information such as function entries
and exits, and so on.
Flush If checked, records each message to disk before processing
continues instead of buffering them. This records all messages
one-by-one but may impact system performance, so it should be
used for advanced diagnostics.
Default Returns the settings in the Trace Levels section of this window to
their default values.
Figure 49. Tracing Preferences window
68 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
|
|||
||
||
||
||
||
||
|||
|||
|||
|||
|||
|||
|||
|||||
|||
Table 26. Tracing preferences window field definitions (continued)
Field Description
Full Returns all available logging and tracing levels.
Trace File Size section
Maximum file size Sets a size limit in megabytes for the selected trace file. The
default is 10.
File wrapping at Defines the percentage of the log file that is kept when the
Maximum file size value is reached. The default is 66.
Log File Size section
Maximum file size Sets a size limit in megabytes for the selected log file. The default
is 10.
File wrapping at Defines the percentage of the log file that is kept when the
Maximum file size value is reached. The default is 66.
Figure 50 contains three text boxes where you select the path of the three different
files: trace, log and listing. Click Browse to select an existing directory.
Figure 50. Trace Preferences->Path Configuration window
Chapter 9. HSM advanced parameters and file location settings 69
|
|||
|
||
||
||
|||
|||
||
|||
||||
|||
Chapter 10. Problem determination
You can troubleshoot some common issues, such those caused by antivirus
software.
Troubleshooting steps and information
You can follow some general guidelines on troubleshooting and preparing
information for IBM support.
Retry the action
1. Shut down the any running HSM service: IBM TSM HSM Recall Service and
IBM TSM HSM Monitor Service.
2. Save off and delete the log files.
3. Restart the IBM TSM HSM Recall Service (hsmservice.exe) and see if the service
is running. Set the log levels to the highest level. See “Tracing preferences” on
page 67.
4. Retry the action, if you still have an issue, retry the action using another
method, for example:
v Use the HSM for Windows client GUI instead of the command line or vice
versa.
v Check permissions by creating a file in the directory of the stub file you are
trying to retrieve.
v From an application, such as MS Word, open and save the file in question.
Data and files to collect for IBM support
Note:
1. If you did not follow steps 1 through 3 in prior section, follow those steps.
2. Select one or two files and use them to recreate the problem.
3. Write down each step, pipe screen output into text files, capture screens shots,
etc.
4. Zip up logs files into logs.zip.
5. Use the IBM Support Assistant plug-in for the HSM for Windows client to
gather and send the base information needed by the IBM support team.
Descriptive information to send to IBM support
v Program versions and environment
– The entire HSM for Windows client version
– Tivoli Storage Manager versions (server, backup-archive, API)
– Windows version
– Disk layout: cluster, shares, local disks, iSCSII, SAN, NAS
– Types of files involved: MS Office, big, small, where from
– Your ownership and permissionsv Status of the HSM for Windows client installation
– New / upgraded / or running for ’xx’ months
– Are you migrating new files
© Copyright IBM Corp. 2005, 2007 71
– Have you added new users
– Have you increased volumes or the number of files involved
– Did you change a configuration setting recently
– Have file permissions changedv What you want to accomplish
v Steps and events you used to create the problem
v The logs.zip file you collected
v Related screen shots or system messages
Antivirus considerations
Although in-depth testing occurs with each HSM for Windows client release in
regards to industry leading antivirus programs, there are a few considerations you
need to periodically review.
Note:
v Be sure a virus scan runs on files before they are migrated.
v Updates of virus signatures and antivirus scan engines could lead to
different behavior with the HSM for Windows client. During any
troubleshooting, always ask the question ″What changed?″ and take
special consideration of antivirus updates.
v Use antivirus software that supports sparse or offline files. Be sure it has a
setting that allows it to skip offline or sparse files to avoid unnecessary
recall of migrated files.
v The HSM for Windows client has been successfully tested for
compatibility with the following programs with the specified settings:
– McAfee VirusScan Enterprise 7.0 and 8.0
– Symantec AntiVirus 8.0 and 9.0 Corporate Edition with the following
setting:
- Under Scan Advanced Options → Storage migration options, check
Skip offline and sparse files.– Symantec AntiVirus 10.0 Corporate Edition with the following two
settings:
- Under Scan Advanced Options → Storage migration options, check
Skip offline files.
- Under Autoprotect Advanced Options → Scan files when, uncheck
Opened for backup....
72 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Appendix. HSM for Windows messages reference
ANS27024E Failure creating TSM file space ’ file space name<dynamic info>error text.
Explanation The TSM file space could be not created.
System action The desired operation can not be executed.
User action Check if the archive already exists, and check server permissions.
ANS27025E Failure deleting TSM file space ’<dynamic info>file space name<dynamic
info>error text.
Explanation The TSM file space could be not deleted.
System action The desired operation can not be executed.
User action Check if the archive exists, and check server permissions.
ANS27026E The file space ’<dynamic info>file space name ’ does not exist.
Explanation The file space does not exist on the server.
System action The operation can not be performed due to a missing file space.
User action Specify an existing file space for the desired operation.
ANS27027E Failure querying if file space ’<dynamic info>file space name ’
exists:<dynamic info>error text.
Explanation Querying the Tivoli Storage Manager server for a file space failed.
System action The desired operation can not be performed.
User action Check server permissions.
ANS27028E Failure parsing configuration file ’<dynamic info>config file name ’<dynamic
info>error text.
Explanation The global XML configuration file could not be parsed correctly and may
contain corrupted data.
System action The desired operation can not be performed.
User action Correct the global XML configuration file with an editor or reinstall the
product.
ANS27029E The configuration file ’<dynamic info>file name ’ could not be found.
Explanation The global XML job configuration file could not be found.
System action The desired operation can not be performed.
User action Restore the global XML configuration file or reinstall the product.
ANS27030E Failure parsing job file ’<dynamic info>job file name<dynamic info>error
text.
Explanation The job file could not be parsed correctly and may contain corrupted data.
System action The desired migration operation can not be performed.
User action Restore the job file from backup, or delete the corrupted file and recreate
the job from scratch.
© Copyright IBM Corp. 2005, 2007 73
ANS27031E The job file ’<dynamic info>job file name ’ could not be found.
Explanation A migration XML job file could not be found.
System action The migration job can not be executed.
User action Specify an existing job file or create the missing job file.
ANS27032E Failure parsing TSM option file ’<dynamic info>opt file name<dynamic
info>error text.
Explanation The TSM option file could not be parsed correctly.
System action The desired operation can not be performed as necessary TSM
configuration data is missing.
User action Correct the option file or create a new option file in the installation
directory using the wizard.
ANS27033E The configuration file ’<dynamic info>config file name ’ could not be found.
Explanation The TSM option file %1 could not be found.
System action The desired operation can not be performed as necessary TSM
configuration data is missing.
User action Create a new option file in the installation directory using the wizard or
copy an existing option file in the installation directory.
ANS27034E The connection to server<dynamic info>server name , could not be closed
correctly:<dynamic info>error text.
Explanation The application could not close the TCP/IP connection to the Tivoli
Storage Manager server correctly.
System action The system will release the connection after a timeout.
User action No user response necessary. However, you may restart your server and the
application.
ANS27035E The connection to Tivoli Storage Manager server<dynamic info>server name
, port<dynamic info>port number , could not be established:<dynamic
info>error text.
Explanation The application could not connect to the configured Tivoli Storage
Manager server.
System action The server operation is not performed.
User action Check if the repository server is reachable and well configured, and check
your connection data in the TSM option file.
ANS27036E Failure deleting Tivoli Storage Manager server entries for file ’<dynamic
info>file name<dynamic info>error text.
Explanation A repository file entry could not be deleted on server.
System action An error log entry is written and the system continues with next file
entries.
User action Check the Tivoli Storage Manager server permissions and sanity. Retry
server entry file deletion.
74 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
ANS27037E Failure querying the Tivoli Storage Manager server for file entries with
pattern<dynamic info>search pattern :<dynamic info>error text.
Explanation Querying the server for the requested files failed.
System action The Tivoli Storage Manager server entry deletion operation is not
performed.
User action Check Tivoli Storage Manager server permissions and sanity. Retry the
deletion operation.
ANS27038E Failure opening file deletion transaction:<dynamic info>error text.
Explanation The application could not establish the transaction context for entry
deletion on the Tivoli Storage Manager server.
System action The file entry or the file entries are not deleted on the Tivoli Storage
Manager server.
User action Check Tivoli Storage Manager server permissions and sanity. Retry the
deletion operation.
ANS27039E Failure closing file deletion transaction:<dynamic info>error text.
Explanation The application could not close the transaction context for entry deletion
on the Tivoli Storage Manager server.
System action None. The operation continues with the next action.
User action Check Tivoli Storage Manager server permissions and sanity. Retry the
deletion operation.
ANS27040E An error occurred during file analysis:<dynamic info>error text.
Explanation The absolute file path could not be obtained.
System action The program terminates.
User action Check file permissions and security settings.
ANS27041E An error occurred during file analysis<dynamic info>error text.
Explanation File attributes could not be obtained.
System action The program terminates.
User action Check file permissions and security settings.
ANS27042E An error occurred during file analysis:<dynamic info>error text.
Explanation The backend query for the file failed.
System action The program terminates.
User action Check server accessibility and permissions.
ANS27043E An error occurred during file analysis:<dynamic info>error text.
Explanation File MD5 key could not be calculated.
System action The program terminates.
User action Check file permissions and security settings.
ANS27044E An error occurred during file analysis:<dynamic info>error text.
Appendix. HSM for Windows messages reference 75
Explanation File reparse data could not be read.
System action The program terminates.
User action Check file permissions and security settings.
ANS27045E An error occurred during file analysis:<dynamic info>error text.
Explanation File security could not be obtained or evaluated.
System action The program terminates.
User action Check file permissions and security settings.
ANS27046E A program initialization problem occurred:<dynamic info>error text.
Explanation Registry values, file or directories where missing and could not have been
created.
System action The program terminates.
User action Check registry values and installation directory permissions, or reinstall
the product.
ANS27047E A program initialization problem occurred:<dynamic info>error text.
Explanation Logging could not be started.
System action The program terminates.
User action Check logging directory and log file locking, permissions and security.
ANS27048E A program initialization problem occurred:<dynamic info>error text.
Explanation Memory objects could not be created by the program.
System action The program terminates.
User action Check the memory state of the computer running the program.
ANS27049E Failure querying with pattern<dynamic info>search pattern :<dynamic
info>error text.
Explanation Multiple entries for the same file and version have been found. This error
indicates inconsistent file entries in the file space.
System action The operation is aborted.
User action Run the reconciliation tool. Rerun the operation.
ANS27050E Failure querying Tivoli Storage Manager server for file entries with
pattern<dynamic info>search pattern :<dynamic info>error text.
Explanation Querying the Tivoli Storage Manager server for the requested files failed.
System action The Tivoli Storage Manager server entry listing operation is not performed.
User action Check Tivoli Storage Manager server permissions and sanity. Retry the list
operation.
ANS27051E An error occurred during a file rename operation with pattern<dynamic
info>search pattern :<dynamic info>error text.
Explanation Server file entry rename operation failed.
76 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
System action The Tivoli Storage Manager server entry rename operation is not
performed.
User action Check server configuration and permissions.
ANS27052E Failure querying Tivoli Storage Manager server for file entries with
pattern<dynamic info>search pattern :<dynamic info>error text.
Explanation Querying the Tivoli Storage Manager server for the requested files failed.
System action The Tivoli Storage Manager server entry rename operation is not
performed.
User action Check Tivoli Storage Manager server permissions and sanity. Retry the
rename operation.
ANS27053E Failure opening file rename transaction:<dynamic info>error text.
Explanation The application could not open the transaction context for an entry rename
operation on the Tivoli Storage Manager server.
System action The file entry or the file entries are not renamed on the Tivoli Storage
Manager server.
User action Check Tivoli Storage Manager server permissions and sanity. Retry the
rename operation.
ANS27054E Failure closing file rename transaction:<dynamic info>error text.
Explanation The application could not close the transaction context for an entry rename
operation on the Tivoli Storage Manager server.
System action None. The operation continues with the next action.
User action Check Tivoli Storage Manager server permissions and sanity. Retry the
rename operation.
ANS27055E Failure restoring file ’<dynamic info>file name<dynamic info>error text.
Explanation Multiple entries for the same file and version have been found. This error
indicates inconsistent file entries in the file space.
System action The operation is aborted.
User action Run the reconciliation tool. Rerun the operation.
ANS27056E Failure querying Tivoli Storage Manager server for file entries with
pattern<dynamic info>search pattern :<dynamic info>error text.
Explanation Querying the Tivoli Storage Manager server for the requested files failed.
System action The Tivoli Storage Manager server entry retrieve operation is not
performed.
User action Check Tivoli Storage Manager server permissions and sanity. Retry the
retrieve operation.
ANS27057E Failure resetting connection to Tivoli Storage Manager server ’<dynamic
info>server name<dynamic info>error text.
Explanation After a file has been retrieved or recalled from a tape library the Tivoli
Storage Manager server connection needs to be reset to release the tape.
System action None. The application continues with the next operation.
Appendix. HSM for Windows messages reference 77
User action Check server TCP/IP connection and the tape library.
ANS27058E Failure retrieving file(s) ’<dynamic info>file name or pattern ’ from Tivoli
Storage Manager server ’<dynamic info>server name<dynamic info>error
text.
Explanation Requested file(s) could not be retrieved from the Tivoli Storage Manager
server.
System action The retrieve operation is aborted.
User action Check server address, configuration and permissions, check file space and
disk space on file system.
ANS27059E Failure deleting file ’<dynamic info>file name ’ from the file
system:<dynamic info>error text.
Explanation The file has been stored on the Tivoli Storage Manager server. Removing
the file from the file system failed.
System action The file is kept as is. File attributes and file times are recovered.
User action Check file and volume permissions. Rerun the file migration.
ANS27060E Failure preparing file entry ’<dynamic info>file name ’ for migration to
Tivoli Storage Manager server ’<dynamic info>server name<dynamic
info>error text.
Explanation Tivoli Storage Manager server file entry information could not be
completely computed.
System action The file is not migrated to the Tivoli Storage Manager server.
User action Restart the file migration.
ANS27061E Failure loading file(s) on the Tivoli Storage Manager server ’<dynamic
info>server name<dynamic info>error text.
Explanation During the file migration a global error occurred.
System action The file migration will be aborted.
User action Check server address, configuration and permissions, check file space.
ANS27062E Failure turning file ’<dynamic info>file name ’ into a stub file:<dynamic
info>error text.
Explanation The file has been stored on the Tivoli Storage Manager server. Turning the
file into stub file failed.
System action The file is kept as is. File attributes and file times are recovered.
User action Check if your files have extended attributes which is not allowed. Rerun
the file migration.
ANS27063E Failure sending file data of ’<dynamic info>file name ’ to Tivoli Storage
Manager server ’<dynamic info>server name<dynamic info>error text.
Explanation Some file content could not be send to the Tivoli Storage Manager server
file space.
System action The file content transaction is canceled. The file is not stored on the server.
User action Check the Tivoli Storage Manager server for data space. Retry the file
migration.
78 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
ANS27064E Failure opening file migration transaction:<dynamic info>error text.
Explanation The application could not open the transaction context for a file migration
to the Tivoli Storage Manager server.
System action The file entry or the file entries are not migrated on the Tivoli Storage
Manager server.
User action Check Tivoli Storage Manager server permissions and sanity. Retry the file
migration.
ANS27065E Failure closing file migration transaction:<dynamic info>error text.
Explanation The application could not close the transaction context for a file migration
to the Tivoli Storage Manager server.
System action None. The operation continues with the next action.
User action Check Tivoli Storage Manager server permissions and sanity. Retry the file
migration.
ANS27066E Failure removing protection from file ’<dynamic info>file name<dynamic
info>error text.
Explanation To migrate a file the file protection (read-only flag) must be removed.
System action The file is not migrated. Attributes are restored.
User action Check file permissions and user permissions.
ANS27067E Failure validating migrated file ’<dynamic info>file name<dynamic info>error
text.
Explanation A file has been migrated to the Tivoli Storage Manager server but could
not be queried on that server.
System action The file is not turned into a stub files. Files attributes are restored on the
file system.
User action Retry file migration.
ANS27068E The file ’<dynamic info>file name ’ specified as parameter was not found.
Explanation The file specified as parameter could not be found.
System action The program terminates.
User action Specify a path to an existing file.
ANS27069E The program ’<dynamic info>program name ’ was used in an incorrect way.
Explanation The specified parameter syntax is not correct.
System action The program terminates.
User action Type the program name for usage information or refer to the
documentation.
ANS27090E An error occurred during file analysis:<dynamic info>error text.
Explanation The file object id could not be obtained or set.
System action The program terminates.
User action Check file permissions and security settings.
Appendix. HSM for Windows messages reference 79
ANS27353E An unexpected error occurred when terminating the program.
Explanation An unexpected error occurred after stopping logging.
System action The application continues.
User action Contact IBM Software Support for help and indicate the message text
information.
ANS27354E ’ALL’ cannot be used as file space name.
Explanation The HSM reserved key word ’ALL’ was used as file space name.
System action The application aborts.
User action Check the specified file space list.
ANS27355E Unable to copy <dynamic info>.
Explanation The application cannot copy extension dll to<dynamic info>.
System action The application aborts.
User action Check the log file for error details.
ANS27356E Unable to copy <dynamic info>.
Explanation The application cannot copy resource type dll to<dynamic info>.
System action The application aborts.
User action Check the log file for error details.
ANS27357E Unable to register the resource type dlls. The cluster state cannot be
determined.
Explanation The installation cannot determine the cluster state.
System action The application aborts.
User action Make sure that the node belongs to a cluster.
ANS27358E Unable to get windows directory of the node.
Explanation The application cannot get windows directory of the node.
System action The application aborts.
User action Check the log file for error details.
ANS27359E Could not initialize backend libraries.
Explanation Backend library initialization failed.
System action Extension dialog can’t be opened.
User action Please verify that the backend libraries are installed and configured.
ANS27360E Could not initialize backend libraries or missing configuration file
(dsm.opt).
Explanation Backend library initialization failed or configuration file (dsm.opt) is
missing.
System action The application aborts.
80 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
User action Verify whether the backend libraries are installed and configuration file
(dsm.opt) is configured.
ANS27361E Can’t save configuration. Mount path no longer exists:<dynamic info>mount
path.
Explanation Extension dialog tried to save a configuration for a mount path that
meanwhile has disappeared.
System action The configuration is not saved, but stays in registry, if it was already saved
before. The dialog displays another mount path.
User action Select the Cleanup button to interactively remove mount paths from the
registry.
ANS27362E Can’t save configuration of mount path:<dynamic info>other mount path.
The volume is already configured through mount path:<dynamic info>other
mount path.
Explanation Extension dialog tried to configure a volume with a mount path which is
already configured through another mount path.
System action The configuration is not saved. The mount path stays configured through
the other mount path.
User action To change the configuration, select the other mount path and apply
changes there.
ANS27363E The specified volume could not be unconfigured.
Explanation Deleting the configuration of the specified volume from registry failed
unexpectedly.
System action The configuration of the specified volume may be corrupted.
User action Try to delete the configuration again. If deleting the configuration fails
again, contact IBM Software Support.
ANS27364E Cannot unconfigure while reconcile is running on volume.
Explanation You tried to unconfigure a volume while reconcile is running on that
volume.
System action Volume stays configured.
User action Wait until the reconciliation of this volume is done. Then the volume can
be unconfigured.
ANS27365E Unable to perform COM registration of resource type extension dll. .
Explanation The application cannot perform COM registration of resource type
extension dll.
System action The application aborts.
User action Make sure that the resource type extension dll exists under the<dynamic
info>and check the log file for error details.
ANS27366E Unable to perform COM unregistration of resource type extension dll. .
Explanation The application cannot perform COM unregistration of resource type
extension dll.
System action The application aborts.
Appendix. HSM for Windows messages reference 81
User action Make sure that the resource type extension dll exists under the
%%WINDIR%%\\Cluster and check the log file for error details.
ANS27367E Unable to unregister resource type dll, because there is still reconcile
configuration on the cluster.
Explanation Unable to unregister resource type dll, because there is still reconcile
configuration on the cluster.
System action The application aborts.
User action Delete all of reconcile configurations on the cluster and try the operation
again.
ANS27368E Please create at least 1 file space before using the extension panel.
Explanation To configure volumes for reconciliation at least one file space is required.
System action Extension dialog is not displayed.
User action Create a file space. Then open the extension panel.
ANS27369E Failure creating file needed for reconciliation ( <dynamic info>expected size
KB): <dynamic info>file name.
Explanation Reconcile hashtable file could not be created. The file is needed to store
information during reconciliation.
System action Reconcile is aborted for this volume.
User action Make sure there is enough free space on the volume to create the file. Add
some extra space as the file size is only an estimate and might need
additional space.
ANS27370E Failure running the application: <dynamic info>error message. .
Explanation An application error occurred.
System action The application aborts.
User action Check the log file for error details.
ANS27371E Cannot define the current node resource.
Explanation Definition of the Microsoft cluster node failed.
System action The application aborts.
User action Check the log file for error details.
ANS27372E Cannot define owner of the resource ’<dynamic info>resource name’.
Explanation Define owner of Microsoft cluster resource failed.
System action The application aborts.
User action Check the log file for error details.
ANS27373E Failure deleting Tivoli Storage Manager server object. load time: ’ <dynamic
info>load time’, filespace: ’ <dynamic info>filespace’, Tivoli Storage Manager
server object id (hi/lo):<dynamic info>.
Explanation An error occurred while reconciliation tried to delete a server object.
System action Delete operation is skipped and reconciliation proceeds.
82 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
User action Check if Tivoli Storage Manager server is accurately configured and
available.
ANS27374E An unexpected error occurred when terminating the program.
Explanation An unexpected error occurred when deleting instance.
System action The application continues.
User action Check the log file and contact IBM Software Support for help.
ANS27375E Cannot delete resource ’ <dynamic info>resource name’.
Explanation Delete Microsoft cluster resource failed.
System action The application aborts.
User action Make sure that the resource belongs to the local host. Check the log file for
error details.
ANS27376E The file space names in the list were not unique.
Explanation There were two file spaces with the same name.
System action The application aborts.
User action Check the specified file space list.
ANS27377E Unable to enumerate the registered resource types on the node.
Explanation Unexpected error occurred when enumerating the registered resource types
on the node.
System action The application aborts.
User action Check the log file for error details.
ANS27378E Failure validating registry key: ’ <dynamic info>registry key’ Error:
’<dynamic info>error’.
Explanation A registry key used for reconcile configuration contains invalid data.
System action Operation aborts.
User action Contact IBM Software Support.
ANS27379E Failure while saving configuration for mount path:<dynamic info>mount
path.
Explanation An error occurred while saving configuration to registry.
System action System will reload saved configuration and apply a general validation
check. Settings might differ from previous input.
User action Check all settings of currently displayed mount path. If validation fails,
contact IBM Software Support.
ANS27380E Unable to set loaded dll free.
Explanation The application cannot set loaded dll free.
System action The application aborts.
User action Check the log file for error details.
Appendix. HSM for Windows messages reference 83
ANS27381E Unable to unload the resource type extension dll.
Explanation The application cannot unload the resource type extension dll.
System action The application aborts.
User action Make sure that the resource type extension dll exists under the<dynamic
info>and check the log file for error details.
ANS27382E Unable to get version number of ’ <dynamic info>dll name’. .
Explanation The application cannot get version number of dll.
System action The application aborts.
User action Make sure that dll exists and has not been modified.
ANS27383E Getting file spaces failed.
Explanation The program was not able to get the list of file spaces.
System action The conversion program aborts.
User action Please check the connection to the database server.
ANS27384E Cannot get name of the resource ’<dynamic info>resource ID’.
Explanation Get name of Microsoft cluster resource failed.
System action The application aborts.
User action Check the log file for error details.
ANS27385E Unable to get state of resource type dlls.
Explanation Unable to get state of resource type dlls.
System action The application aborts.
User action Make sure that the resource type dlls (HSMResTypDLL.dll and
HSMResTypDLLEx.dll) were registered and copied into the right directory
and check the log file for error details.
ANS27386E Unable to get state of registration of resource type dlls.
Explanation The application cannot get the state of registration of resource type dlls.
System action The application aborts.
User action Check the log file for error details.
ANS27387E The hsmmonitor service has stopped due to an error. Error is written to
Windows event log.
Explanation The hsmmonitor service has been stopped with an error.
System action Error is written to Windows event log. Scheduled reconcile tasks will not
execute.
User action Restart the hsmmonitor service as soon as possible to assure that reconcile
tasks will be processed.
ANS27388E The hsmmonitor service has stopped.
Explanation The hsmmonitor service has been stopped.
84 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
System action Scheduled reconcile tasks will not execute.
User action Restart the hsmmonitor service as soon as possible to assure that reconcile
tasks are processed.
ANS27389E The hsmmonitor service has stopped with a warning. Warning is written to
Windows event log.
Explanation The hsmmonitor service has been stopped with a warning.
System action Warning is written to Windows event log. Scheduled reconcile tasks will
not execute.
User action Restart the hsmmonitor service as soon as possible to assure that reconcile
tasks will be processed.
ANS27390E <dynamic info>service name. is not yet running. Reconcile tasks will be
delayed until it is running.
Explanation The service is needed for reconcile tasks to execute.
System action Scheduled reconcile tasks will be delayed until the service is running.
User action If the service does not start automatically, start it manually. Otherwise
simply wait until it has started.
ANS27391E The HSM recall service is not running.
Explanation If the HSM recall service is not running, stub file attributes cannot be read.
System action Reconciliation canceled because of the missing HSM recall service.
User action Start the HSM recall service and rerun reconciliation.
ANS27392E Found an inconsistent file: ’ <dynamic info>orphan file name’.
Explanation Found a file without an external object ID or unequal object IDs.
System action The process ignores this inconsistency and continues.
User action This problem can be solved by remigrating the file.
ANS27393E Initialization of extension utility failed: <dynamic info>error message.
Explanation Failure when initializing an extension utility.
System action The application or reconcile dialog aborts.
User action Make sure application is running under an administrator account. Check
the log file for error details.
ANS27394E Installation of resource type dlls failed.
Explanation The application cannot install resource type dlls.
System action The application aborts.
User action Check the log file for error details.
ANS27395E Versions of deleted files must be between <dynamic info>minimum versions
of deleted files. and <dynamic info>maximum versions of deleted files.
Explanation The specified value for versions of deleted files was not valid.
System action Show the correct range for version of deleted files. The application aborts.
Appendix. HSM for Windows messages reference 85
User action Check the validity of the specified parameter value.
ANS27396E Versions of existing files must be between <dynamic info>minimum
versions of existing files. and <dynamic info>maximum versions of existing
files.
Explanation The specified value for versions of existing files was not valid.
System action Show the correct range for version of existing files. The application aborts.
User action Check the validity of the specified parameter value.
ANS27397E The Next Reconcile Time was not valid.
Explanation The specified next reconcile time was not valid.
System action Show the correct format of next reconcile time. The application aborts.
User action Check the validity of the specified parameter value.
ANS27398E The Reconcile Interval must be between <dynamic info>minimum of
reconcile interval. and <dynamic info>maximum of reconcile interval ( both
inclusive ) .
Explanation The specified reconcile interval was not valid.
System action Show the correct range of reconcile interval. The application aborts.
User action Check the validity of the specified parameter value.
ANS27399E Please give ’ <dynamic info>yes’ or ’<dynamic info>no’ to the
RECONCILENOW-option.
Explanation The specified value for option RECONCILENOW was not valid.
System action Show the correct value for option RECONCILENOW. The application
aborts.
User action Check the validity of the specified parameter value.
ANS27400E License expired.
Explanation License expired.
System action Extension dialog can’t open.
User action Check license.
ANS27401E License expired.
Explanation License expired.
System action The application aborts.
User action Check license.
ANS27402E License Registration failed.
Explanation License Registration failed.
System action Extension dialog can’t open.
User action Check license.
86 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
ANS27403E License Registration failed.
Explanation License Registration failed.
System action The application aborts.
User action Check license.
ANS27404E Unable to load required dll ’ <dynamic info>dll name’.
Explanation The application cannot load required dll.
System action The application aborts.
User action Check the log file for error details.
ANS27405E Unable to load resource type extension dll.
Explanation The application cannot load the resource type extension dll.
System action The application aborts.
User action Make sure that the resource type extension dll exists under the<dynamic
info>.
ANS27406E Invalid Max Reconcile Process Number. It must be a number between
<dynamic info>minimum number of max reconcile process. and <dynamic
info>maximum number of max reconcile process (both inclusive).
Explanation Value of max reconcile process out of range.
System action Show correct range of max reconcile process. The application aborts.
User action Check the input value of max reconcile process.
ANS27407E A file space was not in search list (file: ’ <dynamic info>orphan file name.
file space: ’<dynamic info>file space name’).
Explanation The file space name of this stub file was not in search list for processing.
System action Less objects are processed by the operation - processing continues.
User action Include this file space to search list for a complete processing.
ANS27408E Reconcile aborted due to a removed volume in: ’ <dynamic info>volume
mount point’.
Explanation The hsmmonitor service was stopped and aborted the running
reconciliation.
System action Reconciliation of the volume has not entirely completed.
User action During reconciliation do not remove any volumes. Doing so can create
data loss.
ANS27409E The resource type dlls are missing.
Explanation The installation might not be completely. The resource type dlls are
missing.
System action The application aborts.
User action Make sure that the resource type dlls (HSMResTypDLL.dll and
HSMResTypDLLEx.dll) were registered and copied into the right directory
and check the log file for error details.
Appendix. HSM for Windows messages reference 87
ANS27410E Mount path no longer exists: ’ <dynamic info>mount path’.
Explanation A mount path disappeared configuring the mount path.
System action The configuration of the mount path stays in registry, if it was already
saved before. The dialog displays another mount path.
User action Select the Cleanup button to interactively remove mount paths from the
registry.
ANS27411E Not enough memory.
Explanation The application cannot allocate enough memory.
System action The application aborts.
User action Make sure that enough memory is available and check the log file for error
details.
ANS27412E The local host is not the owner of the reconcile configuration resource
<dynamic info>resource name.
Explanation The application accessed a resource, which is does belong to the local host.
System action Access denied. Operation on the resource aborts.
User action Make sure that the resource belongs to the local host. Check the log file for
error details.
ANS27413E No access to a file or a directory: ’ <dynamic info>file name’.
Explanation The process has no access to a file or a directory.
System action Without access to all files, the operation cannot complete.
User action Please check the access permissions of the file or the directory.
ANS27414E No available file space.
Explanation No available files space.
System action The application aborts.
User action You need to create at least one file space.
ANS27415E Cannot take resource ’ <dynamic info>resource name’ offline.
Explanation Taking the Microsoft cluster resource offline failed.
System action The application aborts.
User action Make sure that the resource belongs to the local host. Check the log file for
error details.
ANS27416E Found an object of a pre TSM HSM 5.4.0 client: ’ <dynamic info>file name’.
Explanation Pre TSM HSM 5.4.0 server objects are not processed by reconciliation.
System action Reconciliation does not remove obsolete pre TSM HSM 5.4.0 server objects.
User action Use the tool ’dsmReconConverter.exe’ to upgrade these objects.
ANS27417E Cannot bring resource ’<dynamic info>resource name’ online.
Explanation Bringing the Microsoft cluster resource online failed.
88 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
System action The application aborts.
User action Make sure that the resource belongs to the local host. Check the log file for
error details.
ANS27418E Unable to open a enumeration handle.
Explanation The application cannot open a handle to enumeration registered resource
types.
System action The application aborts.
User action Check the log file for error details.
ANS27419E Unable to load required function ’ <dynamic info>function name’ from
’<dynamic info>dll name’.
Explanation The application cannot load the required function from dll.
System action The application aborts.
User action Make sure that the dll exists and has not been modified.
ANS27420E Cannot open handle to ’ <dynamic info>resource name’.
Explanation Opening the handle to Microsoft cluster resource failed.
System action The application aborts.
User action Make sure that the resource belongs to the local host. Check the log file for
error details.
ANS27421E No data on the TSM Server found for file: ’ <dynamic info>orphan file
name’ (file space: ’ <dynamic info>file space name’).
Explanation The process found an orphan file (no data on the TSM Server).
System action The operation cannot be completed if any orphan stub file has been found.
User action Please replace the orphan stub file with the last backup to solve the
problem.
ANS27422E The specified Next Reconcile Time is not valid. It must be at least one
interval (of the reading volume configuration setting ( <dynamic info>actual
interval of reading volume configuration. minute(s) )) after the current
time.
Explanation The specified Next Reconcile time is in the past.
System action The application aborts.
User action Enter a new Next Reconcile Time. It must be at least one interval (of the
reading volume configuration setting (default 60s)) after the current time.
ANS27423E Failed to read command line arguments.
Explanation Cannot allocate enough memory to save command line arguments.
System action The application aborts.
User action Please reserve enough memory for the application.
ANS27424E Reading Number of Max Reconcile Process failed. .
Explanation Reading max reconcile process number from registry failed.
Appendix. HSM for Windows messages reference 89
System action No max reconcile process read from registry. The application aborts.
User action Check access permission of registry.
ANS27425E Reading volume configuration from registry failed.
Explanation Reading volume configuration from registry failed.
System action The application aborts.
User action Check the log file for error details.
ANS27426E Reconcile aborted due to shutdown of hsmmonitor service. Volume:
’<dynamic info>reconcile volume’.
Explanation The hsmmonitor service was stopped and aborted the running
reconciliation.
System action Reconciliation of the volume has not entirely completed.
User action Reconciliation of this volume will be executed again when hsmmonitor
service starts. No need to schedule an additional reconciliation.
ANS27427E Conversion aborts because of running reconciliation jobs.
Explanation One or more reconciliation jobs are currently running.
System action Conversion process aborts.
User action Wait until reconciliation jobs are finished before restating conversion.
ANS27428E Unable to register the resource type extension dll.
Explanation The application cannot register the resource type extension dll.
System action The application aborts.
User action Make sure that the resource type extension dll exists under the<dynamic
info>and check the log file for error details.
ANS27429E Unable to register the resource type dll.
Explanation The application cannot register the resource type dll.
System action The application aborts.
User action Make sure that the resource type dll exists under the<dynamic info>and
check the log file for error details.
ANS27430E Unexpected error. Saved configuration disappeared, mount path: ’<dynamic
info>mount path’.
Explanation The extension dialog cannot find a configuration after saving it. This is
probably due to a manual registry manipulation.
System action The mount path is not configured.
User action Try to save the configuration again. If it fails again, check the log file for
details or contact IBM Software Support.
ANS27431E Saving volume configuration failed.
Explanation Saving volume configuration failed.
90 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
System action No volume configuration will be saved into registry. The application
aborts.
User action Check access permission of registry and check the log file for details.
ANS27432E Could not restore the object ID of a file: ’ <dynamic info>orphan file name’.
Explanation Restore of an external file object ID failed.
System action The process ignores this problem and continues.
User action Please check the access permissions of this file.
ANS27433E Setting Max Reconcile Process Number failed.
Explanation Setting max reconcile process number failed.
System action No max reconcile process number will be written in registry. The
application aborts.
User action Check access permission of registry.
ANS27434E Cannot set the value of NumberOfServerObjects of the resource ’ resource
name’.
Explanation Setting the NumberOfServerObjects parameter of the Microsoft cluster
resource failed.
System action The application aborts.
User action Make sure that the resource belongs to the local host. Check the log file for
error details.
ANS27435E Cannot set value of ReconcileNow of the resource ’ <dynamic info>resource
name’.
Explanation Setting the ReconcileNow parameter of Microsoft cluster resource failed.
System action The application aborts.
User action Make sure that the resource belongs to the local host. Check the log file for
error details.
ANS27436E Cannot set the value of a parameter of the resource ’<dynamic info>resource
name’.
Explanation Setting the parameter of Microsoft cluster resource failed.
System action The application aborts.
User action Make sure that the resource belongs to the local host. Check the log file for
error details.
ANS27437E Cannot set value of ReconcileRunning of the resource ’<dynamic
info>resource name’.
Explanation Setting the ReconcileRunning parameter of the Microsoft cluster resource
failed.
System action The application aborts.
User action Make sure that the resource belongs to the local host. Check the log file for
error details.
Appendix. HSM for Windows messages reference 91
ANS27438E A program initialization problem occurred.
Explanation Cannot start cluster features.
System action The application aborts.
User action Check the log file and contact IBM Software Support for help.
ANS27439E A program initialization problem occurred.
Explanation Cannot start conversion.
System action The application aborts.
User action Check the log file and contact IBM Software Support for help.
ANS27440E A program initialization problem occurred.
Explanation Cannot start domain controller.
System action The application aborts.
User action Check the log file and contact IBM Software Support for help.
ANS27441E A program initialization problem occurred.
Explanation Cannot start storage.
System action The application aborts.
User action Check the log file and contact IBM Software Support for help.
ANS27442E An unexpected error occurred when terminating the program.
Explanation An unexpected error occurred when stopping cluster features.
System action The application continues.
User action Check the log file and contact IBM Software Support for help.
ANS27443E An unexpected error occurred when terminating the program.
Explanation An unexpected error occurred when stopping conversion.
System action The application continues.
User action Check the log file and contact IBM Software Support for help.
ANS27444E An unexpected error occurred when terminating the program.
Explanation An unexpected error occurred when stopping domain controller.
System action The application continues.
User action Check the log file and contact IBM Software Support for help.
ANS27445E An unexpected error occurred when terminating the program.
Explanation An unexpected error occurred when stopping driver.
System action The application continues.
User action Check the log file and contact IBM Software Support for help.
ANS27446E An unexpected error occurred when terminating the program.
Explanation An unexpected error occurred when stopping logging.
92 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
System action The application continues.
User action Check the log file and contact IBM Software Support for help.
ANS27447E An unexpected error occurred when terminating the program.
Explanation An unexpected error occurred when stopping storage.
System action The application continues.
User action Check the log file and contact IBM Software Support for help.
ANS27448E Syntax error or wrong parameter. Please check the usage.
Explanation Syntax error or wrong parameter.
System action Show command usage. The application aborts.
User action Check the usage.
ANS27449E The following specified file space(s) are not available : <dynamic
info>unavailable file space(s).
Explanation There are unavailable file space(s) in the specified file space list.
System action The application aborts.
User action Check the specified file space list.
ANS27450E An unexpected error occurred: <dynamic info>unexpected error. .
Explanation An unexpected error occurred (MFC exception).
System action Operation or program aborts.
User action Check the log file and contact IBM Software Support for help.
ANS27451E An unknown unexpected error occurred.
Explanation An unknown unexpected error occurred (unknown exception).
System action Operation or program aborts.
User action Check the log file and contact IBM Software Support for help.
ANS27452E Uninstallation of resource type dlls failed.
Explanation The application cannot uninstall resource type dlls.
System action The application aborts.
User action Check the log file for error details.
ANS27453E Unknown file space(s) in list of selected file spaces: <dynamic info>file
space.
Explanation A mount path configured by another mount path has unknown file spaces
in list of selected file spaces.
System action Unknown file spaces are in list together with known ones.
User action Select mount path that configures this mount path and change the setting.
ANS27454E Unknown file space not added to selection: <dynamic info>file space.
Explanation A file space previously set in configuration now does not exist.
Appendix. HSM for Windows messages reference 93
System action File space is removed from list of selected file spaces in volume reconcile
configuration.
User action The change can be accepted by selecting the ’Apply’ or ’OK’ button. To
avoid this message, a file space should be removed from all configurations
before it is deleted.
ANS27455E Unable to unregister the resource type extension dll.
Explanation The application cannot unregister the resource type extension dll.
System action The application aborts.
User action Make sure that the resource type extension dll exists under the
%%WINDIR%%\\Cluster and check the log file for error details.
ANS27456E Unable to unregister the resource type dll.
Explanation The application cannot unregister the resource type dll.
System action The application aborts.
User action Make sure that the resource type dll exists under the<dynamic info>and
check the log file for error details.
ANS27457E Found unresolved objects.
Explanation Unresolved objects are found during file system scan.
System action The operation cannot complete if any unresolved objects are detected.
User action Please solve all problems with unresolved files and restart the process.
ANS27458E Conversion failed of a pre TSM HSM 5.4.0 client object: ’<dynamic info>file
name’.
Explanation An error occurred during conversion of a pre TSM HSM 5.4.0 client object.
System action Conversion stops if any upgrade failed.
User action Check the log file and contact IBM Software Support for help.
ANS27459E Failure getting volume for UNC path: ’ <dynamic info>UNC path’ Error
description: <dynamic info>error message.
Explanation The volume of an UNC path could not be determined.
System action Reconciliation aborts.
User action Make sure network connection is activated and properly configured.
ANS27460E Failure analyzing Backup-Archive client trace file for backup failures: Trace
file: ’ <dynamic info>TSM Backup-Archive client trace file name’.
Explanation The Backup-Archive client trace file cannot be exploited to analyze backup
failures.
System action No backup will be performed before file migration.
User action Check the log file for a more detailed reason description.
ANS27461E Failure running TSM Backup-Archive client executable: <dynamic
info>originator error string.
Explanation The Backup-Archive client executable could not be run.
94 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
System action No backup will be performed before file migration.
User action Check the log files for more detailed information.
ANS27462E The TSM Backup-Archive client must not be configured to prompt
interactively for a password. Option file: ’%1’.
Explanation Migration job files with the backup before migration option cannot be
processed correctly.
System action No backup will be performed before file migration.
User action Configure the Backup-Archive client to maintain the password
automatically (PASSWORDACCESS=GENERATE).
ANS27463E No password access mode found in the TSM Backup-Archive client’s
option file. Option file: ’ <dynamic info>option file path’.
Explanation For migration job files with the backup before migrate option, the
Backup-Archive client need be configured with password access generate.
System action No backup will be performed before file migration.
User action Configure the Backup-Archive client to maintain the password
automatically (PASSWORDACCESS=GENERATE).
ANS27464E The currently installed TSM Backup-Archive client API version
Backup-Archive client version string. is not supported with TSM HSM
client version <dynamic info> HSM client version string. You need to install
at least Backup-Archive client version <dynamic info>required HSM client
version string.
Explanation The Backup-Archive client API version is too old to run the TSM HSM
client.
System action The currently installed Backup-Archive client API will not be used by the
TSM HSM client.
User action Install a newer Backup-Archive client version.
ANS27465E Failure configuring target=’ <dynamic info>configuration target string’,
key=’ <dynamic info>configuration key’, value=’<dynamic info>configuration
value’: <dynamic info>error string.
Explanation The desired configuration changes could not be applied.
System action The configuration has not been changed.
User action Check if the specified target and the configuration key are valid and if the
value is in range for the key.
ANS27466E The listing file ’ <dynamic info>listing file name’ already exists.
Explanation TSM HSM applications need to open a new listing file during startup. The
listing file name is created based on the current time.
System action The TSM HSM application terminates.
User action Wait a moment and restart the desired operation.
ANS27467E Failure running migration for job file ’ <dynamic info>migration job file
name’: <dynamic info>originator message.
Explanation The migration job did not run properly.
Appendix. HSM for Windows messages reference 95
System action The job was not run or canceled.
User action Check the reason for the failed migration and correct the problem.
ANS27468E Failure opening listing file ’ <dynamic info>listing file name’.
Explanation TSM HSM applications need to open a new listing file during startup. The
listing file name is created based on the current time.
System action The TSM HSM application terminates.
User action Make sure that the listing file directory is accessible and permissions are
sufficient to write the listing file.
ANS27469E The log file ’ <dynamic info>log file name’ could not be opened.
Explanation TSM HSM applications need to open their log files during startup.
System action The TSM HSM application terminates.
User action Make sure that the log file is not locked by another application, and that
no other reason, like missing access rights, prevents the TSM HSM
application from opening the log file.
ANS27470E Failure retrieving content of stub file ’ <dynamic info>stub file path’ from
Tivoli Storage Manager server ’ <dynamic info> Tivoli Storage Manager
server name’, file space ’ <dynamic info> Tivoli Storage Manager server file
space’: <dynamic info>error string.
Explanation The stub file could not be restored from the Tivoli Storage Manager server.
System action The recall for the stub file will be canceled and the recalling user
application will be released from waiting.
User action Check the log files for more detailed information. Check why the stub file
could not be restored from Tivoli Storage Manager server.
ANS27481E The multithreaded TSM Backup-Archive client API could not be initialized:
<dynamic_info>.
Explanation The Backup-Archive client API reports an error during initialization. The
TSM functionality cannot be used.
System action The TSM interface library will be unloaded.
User action Check the error message of the Backup-Archive client and solve the
reported issue. Retry the desired operation.
ANS27482E Failure analyzing Backup-Archive client audit trace file for backup failures:
Audit trace file: <dynamic info>.
Explanation The Backup-Archive client audit trace file cannot be exploited for backup
result analysis.
System action No backup will be performed before file migration, the migration will not
be run without backup.
User action Check log file for a more detailed reason description.
ANS27483E Failure while loading configuration values for the TSM Backup-Archive
client: <dynamic info>.
Explanation The TSM HSM for Windows backup-archive client configuration is not
valid.
96 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
System action The backup operation cannot be run.
User action Check error text and log file for a more detailed reason description. Correct
the configuration or reinstall the product and retry the desired operation.
ANS27485E NTFS change journal has been truncated for volume: <dynamic info>.
Explanation The NTFS change journal size was too small for all file system changes.
System action Process has been aborted to avoid a possible data loss because of the
truncated NTFS change journal.
User action Please increase the size of the NTFS change journal.
Appendix. HSM for Windows messages reference 97
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.
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, Japan
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 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.
© Copyright IBM Corp. 2005, 2007 99
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 which has been exchanged, should contact:
IBM Corporation
2Z4A/101
11400 Burnet Road
Austin, TX 78758
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 information 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.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
Trademarks
IBM, the IBM logo, and the following terms are trademarks of the International
Business Machines Corporation in the United States, other countries, or both:
400
AIX
I5/OS
OS/390
OS/400
Tivoli
Intel®, Intel Inside® (logos), MMX, and Pentium are trademarks of Intel
Corporation in the United States, other countries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
Java™ and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in
the United States, other countries, or both.
100 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Linux® is a trademark of Linus Torvalds in the United States, other countries, or
both.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Other company, product, or service names may be trademarks or service marks of
others.
Notices 101
Glossary
Term definitions in this glossary pertain to the HSM for Windows client.
If you do not find a term you are looking for, you can refer to the IBM Software
Glossary on the Web at this address: http://www.ibm.com/ibm/terminology/.
This glossary might include terms and definitions from:
v The American National Standard Dictionary for Information Systems, ANSI
X3.172-1990, copyright (ANSI). Copies can be purchased from the American
National Standards Institute, 11 West 42nd Street, New York, New York 10036.
v The Information Technology Vocabulary, developed by Subcommittee 1, Joint
Technical Committee 1, of the International Organization for Standardization and
the International Electrotechnical Commission (ISO/IEC JTC2/SC1).
A
Archiving
This is the process of storing files in a Tivoli Storage Manager File Space
and either keeping the original file or deleting the original file.
D
dsmfind.exe
This program lists files that are eligible by a job file or that correspond to a
pattern.
dsmfileinfo.exe
This program lists attributes of migrated and non migrated files.
dsminfo.exe
This program lists various settings of your installation.
F
File server
This is the Windows 2003 file server with an NTFS file system, on which
the HSM Client may run.
H
HSM client for Windows
This is a 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.
J
Job file
This is an XML file containing a migration job.
M
Migration
This is the process of storing files in a Tivoli Storage Manager File Space
transparent to users of these files. Execution of a migration job.
Migration job
This is an XML file containing the configuration/setting of a migration job.
© Copyright IBM Corp. 2005, 2007 103
N
Node This is a computer running the HSM Client.
Node name
This is the name under which the HSM Client registers with a Tivoli
Storage Manager server.
Q
Quotas
A view or recall limitation for users set through the HSM GUI.
R
Recall This is the process of accessing migrated files from a Tivoli Storage
Manager File Space transparent to the user. The content of the files is
written back (recalled) to their original location in the local file system.
Reconciliation
Reconciliation synchronizes the local file system with the Tivoli Storage
Manager server HSM archive pool and removes old and obsolete objects
from the Tivoli Storage Manager server.
Reparse point
This is a feature of NTFS redirecting IO requests to a file system filter
driver loaded into the Windows kernel space.
Retrieve
This is an 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.
S
Sparse file
This file 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.
Stub This is a shortcut on the Windows file system generated by the HSM
Client for a migrated file to allow transparent user access. In other words,
a stub is the sparse file representation of a migrated file, with a reparse
point attached.
104 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Index
Aaccessibility features xi
antivirusstub file and recall 72
troubleshooting 72
Bbackup 3
backup-archive clientbackup integration 60
backup integration with HSM 59
dsm.exe command 59
restore integration 62
Ccalculate migration savings 37
closing idle server connections 66
clustered environmentinstallation considerations 7
steps 9
commandsdsm.exe (backup-archive client) 59
dsmfileinfo.exe 52
summary 51
dsmfind.exe 53
summary 51
dsmhsmclc.exe 53
summary 51
dsminfo.exeoverview 55
summary 51
dsmReconConverter.exe 56
summary 51
configuration filesetting location of 65
configuringusing GUI 12
Connections parameter 65
ConnectionTimeout parameter 65
creatingfile space 21
customer support, contacting ix
Ddate format setting 22
default quotadefining 19
DirectoryAttribuesFilter parameter 65
drive letterschanging 49
dsm.exe 59
dsmclc.exeoverview 51
dsmfileinfo.exe 51
overview 52
dsmfind.exeoverview 53
summary 51
dsmhsmclc.exeoptions
maxreconcileproc 53
nextreconcile 53
reconcileinterval 53
reconcilenow 53
overview 53
summary 51
dsmhsmclc.exe optionfilespacelist 53
unconfigure 53
dsminfo.exe 51
overview 55
dsmReconConverter.exeoverview 56
Eeducation
see Tivoli technical training viii
encryptionrecommendation about changing 61
exampleexclude conditions 32
include conditions 32
exclude conditionsexamples 32
migrating 24
Ffile group
creating 17
editing 18
overview 17
file locations 65
file quotadefining 18, 19
file sizes 3
file spacecreating 21
file spaces listing command 51
fileslisting command 51
FileSizeMinimum 3
filespacelistdsmhsmclc option 53
fixes, obtaining ix
Ggroup quota
defining 19
group, file 17
GUIconfiguring 12
© Copyright IBM Corp. 2005, 2007 105
Hhostname
renaming 3
HSM for Windows client GUIoverview 11
hsmservice.exe 9
IIBM Software Support
submitting a problem x
IBM Support Assistant viii, 71
IBM TSM HSM Recall Service 9, 60, 66
IBM TSM Recall Servicerestoring default security attributes 62
idle connectionsclosing 66
include conditionsexamples 32
migration jobs 24
installationnetwork mode 10
installing 9
clustered environment 7
network mode 7
user mode 7, 9
Internet, search for problem resolution viii
Internet, searching for problem resolution ix
Jjobs
running migration 38
Kknowledge bases, searching viii
Llanguage setting 22
listing files 51
listings filessettings 67
log filesettings 67
Mmaximum connections parameter 65
maxreconcileprocdsmhsmclc.exe option 53
messages 73
migratingconsiderations 23
defining jobs 24
dsmclc.exe 38
exclude conditions 24
include conditions 24
overview 3, 23
retrieve file 43
run jobs from HSM for Windows client GUI 38
running jobs 38
scheduling job 38
migrating (continued)search for file 43
with other input 38
migrationdsmclc.exe 38
running from command shell 51
space savings 37
migration job filessetting location of 65
mount pathschanging 49
msi 10
msiexec 10
Nnetwork mode installation 10
nextreconciledsmhsmclc.exe option 53
no recalls quota 19
number format setting 22
Ooptions
filespacelist 53
maxreconcileproc 53
nextreconcile 53
reconcileinterval 53
reconcilenow 53
restore as migrated fileoverview 62
restore resident if not accessibleoverview 62
restorecheckstubaccess 59
restoremigstate 59
skipmigrated 59, 60
unconfigure 53
out-of-space conditionavoiding 61
Pparameters
advanced 65
pre-migration backup 3
prerequisites 2
problem determinationdescribing problem for IBM Software Support x
determining business impact for IBM Software Support x
submitting a problem to IBM Software x
publicationsdownload vii
order vii
search vii
Qquotas
defining 18, 19
viewing 19
106 IBM Tivoli Storage Manager HSM for Windows: Administration Guide
Rrecall quota
interval to delete tracking entries 67
viewing 19
recall servicesettings 66
reconcileintervaldsmhsmclc.exe option 53
option 4
reconcilenowdsmhsmclc.exe option 53
reconciliationoverview 4
reconcilingrunning 47
settings 47
regional settings 22
registering HSM for Windows client 10
renaminghostname 3
restore as migrated file 59
option 62
restore as migrated file option 62
how to set 59
restore resident if not accessiblehow to set 59
option 62
restore resident if not accessible option 62
how to set 59
restorecheckstubaccess 62
restorecheckstubaccess optionsetting 59
restoremigstate 62
restoremigstate optionsetting 59
restoring filesbackup-archive client 62
restorecheckstubaccess option 62
restoremigstate option 62
retrievearchived file 43
migrated file 43
return codes 73
runningmigration jobs 38
Ssecurity attributes
restoring default 62
skip migrated files 59
option 60
skip migrated files optionhow to set 59
skipmigratedoption 60
skipmigrated optionsetting 59
Software Supportcontacting ix
describing problem for IBM Software Support x
determining business impact for IBM Software Support x
stub filebackup archive integration xiii
integrity xiii
stub filesoverview 4
support information vii
Symantec Antivirus 72
Ttemporary files
setting location of 65
threadsrecall service 66
time zone setting 22
Timeout parameter 65
Tivoli technical training viii
trace filessettings 67
training, Tivoli technical viii
troubleshootingantivirus 72
steps 71
Uunconfigure
dsmhsmclc option 53
Unicode setting 22
unlimited recall quota 19
user mode installation 9
user quotadefining 19
Vvolume
changing drive letters 49
Wwhat’s new for V5.5.0 xiii
Index 107