Tivoli Storage Manager

for Windows
Administrators Reference
Version 5.5
SC32-0127-01

Tivoli Storage Manager

for Windows
Administrators Reference
Version 5.5
SC32-0127-01

Note!
Before using this information and the product it supports, read the general information in the Notices appendix.
Edition notice
This edition applies to Version 5.5 of the IBM Tivoli Storage Manager for Windows (program numbers 5608-HSM,
5608-ISM, 5608-ISX, 5608-SAN, 5608-ARM) 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 1993, 2007. All rights reserved.
US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.

Contents
About this publication . . . . . . . . xi
Who should read this guide . . . . . . . . . xi
Publications . . . . . . . . . . . . . . xi
Tivoli Storage Manager publications . . . . . xi
Related hardware publications . . . . . . . xiii
Support information . . . . . . . . . . . xiv
Getting technical training . . . . . . . . xiv
Searching knowledge bases . . . . . . . . xiv
Contacting IBM Software Support . . . . . . xv
Conventions used in this guide . . . . . . . xvii
Accessibility features . . . . . . . . . . . xvii
Technical changes for Version 5.5. . . xix
Chapter 1. Administering the server
from the command line . . . . . . . . 1
Issuing commands from the administrative client . . 1
Starting and stopping the administrative client . . 2
Monitoring server activities from the
administrative client . . . . . . . . . . . 2
Monitoring removable-media mounts from the
administrative client . . . . . . . . . . . 3
Processing commands one at a time from the
administrative client . . . . . . . . . . . 3
Processing a series of commands from the
administrative client . . . . . . . . . . . 3
Formatting output from commands . . . . . . 4
Saving command output to a specified location . . 4
Administrative client options . . . . . . . . 5
Issuing commands from the Administration Center . 7
Issuing commands from the server console . . . . 7
Entering administrative commands . . . . . . . 7
Reading syntax diagrams . . . . . . . . . 7
Entering long commands . . . . . . . . . 11
Naming Tivoli Storage Manager objects . . . . 12
Using wildcard characters to specify object
names . . . . . . . . . . . . . . . 12
Specifying descriptions in keyword parameters 14
Controlling command processing . . . . . . . 14
Server command processing . . . . . . . . 14
Cancelling commands . . . . . . . . . . 15
Performing tasks concurrently on multiple servers 15
Routing commands to a single server . . . . . 16
Routing commands to multiple servers . . . . 16
Routing commands to a server group . . . . . 16
Routing commands to server groups . . . . . 17
Routing commands to two servers and a server
group . . . . . . . . . . . . . . . 17
Routing commands inside scripts . . . . . . 17
Privilege classes for commands . . . . . . . . 18
Commands requiring system privilege . . . . 18
Commands requiring policy privilege . . . . 20
Commands requiring storage privilege . . . . 21
Commands requiring operator privilege . . . . 22
Commands requiring analyst privilege . . . . 23
Commands any administrator can issue . . . . 23
Chapter 2. Administrative commands 25
ACCEPT commands . . . . . . . . . . . 26
ACCEPT DATE (Accepts the current system date) 27
ACTIVATE commands . . . . . . . . . . . 29
ACTIVATE POLICYSET (Activate a new policy
set) . . . . . . . . . . . . . . . . 30
ASSIGN commands . . . . . . . . . . . 32
ASSIGN DEFMGMTCLASS (Assign a default
management class) . . . . . . . . . . . 33
AUDIT commands . . . . . . . . . . . . 35
AUDIT LIBRARY (Audit volume inventories in
an automated library) . . . . . . . . . . 36
AUDIT LICENSES (Audit server storage usage) 38
AUDIT VOLUME (Verify database information
for a storage pool volume) . . . . . . . . 39
BACKUP commands . . . . . . . . . . . 45
BACKUP DB (Back up the database) . . . . . 46
BACKUP DEVCONFIG (Create backup copies of
device configuration information) . . . . . . 49
BACKUP NODE (Back up a NAS node) . . . . 51
BACKUP STGPOOL (Back up primary storage
pool to copy storage pool) . . . . . . . . 55
BACKUP VOLHISTORY (Save sequential volume
history information) . . . . . . . . . . 59
BEGIN commands . . . . . . . . . . . . 61
BEGIN EVENTLOGGING (Begin logging events) 62
CANCEL commands . . . . . . . . . . . 64
CANCEL EXPIRATION (Cancel an expiration
process) . . . . . . . . . . . . . . 65
CANCEL EXPORT (Deletes a suspended export
operation) . . . . . . . . . . . . . . 66
CANCEL PROCESS (Cancel an administrative
process) . . . . . . . . . . . . . . 67
CANCEL REQUEST (Cancel one or more mount
requests) . . . . . . . . . . . . . . 69
CANCEL RESTORE (Cancel a restartable restore
session) . . . . . . . . . . . . . . . 70
CANCEL SESSION (Cancel one or more client
sessions) . . . . . . . . . . . . . . 71
CHECKIN commands . . . . . . . . . . . 72
CHECKIN LIBVOLUME (Check a storage
volume into a library) . . . . . . . . . . 73
CHECKOUT commands . . . . . . . . . . 81
CHECKOUT LIBVOLUME (Check a storage
volume out of a library) . . . . . . . . . 82
CLEAN commands . . . . . . . . . . . . 88
CLEAN DRIVE (Clean a drive) . . . . . . . 89
COMMIT (Control committing of commands in a
macro) . . . . . . . . . . . . . . . . 91
CONVERT commands . . . . . . . . . . . 93
CONVERT ARCHIVE (Allow clients to query
archive files by description) . . . . . . . . 94
COPY commands . . . . . . . . . . . . 96

Copyright IBM Corp. 1993, 2007 iii
||
|
||
COPY ACTIVEDATA (Copy active backup data
from a primary storage pool to an active-data
pool) . . . . . . . . . . . . . . . 97
COPY CLOPTSET (Copy a client option set) . . 101
COPY DOMAIN (Copy a policy domain) . . . 102
COPY MGMTCLASS (Copy a management
class) . . . . . . . . . . . . . . . 104
COPY POLICYSET (Copy a policy set) . . . . 106
COPY PROFILE (Copy a profile) . . . . . . 108
COPY SCHEDULE (Copy a client or an
administrative command schedule) . . . . . 110
COPY SCRIPT (Copy a Tivoli Storage Manager
script) . . . . . . . . . . . . . . . 114
COPY SERVERGROUP (Copy a server group) 115
DEFINE commands . . . . . . . . . . . 116
DEFINE ASSOCIATION (Associate client nodes
with a schedule) . . . . . . . . . . . 118
DEFINE BACKUPSET (Define a backup set) . . 120
DEFINE CLIENTACTION (Define a one-time
client action) . . . . . . . . . . . . 125
DEFINE CLIENTOPT (Define an option to an
option set) . . . . . . . . . . . . . 130
DEFINE CLOPTSET (Define a client option set
name) . . . . . . . . . . . . . . . 134
DEFINE COLLOCGROUP (Define a collocation
group) . . . . . . . . . . . . . . . 135
DEFINE COLLOCMEMBER (Define collocation
group member) . . . . . . . . . . . . 137
DEFINE COPYGROUP (Define a copy group) 139
DEFINE DATAMOVER (Define a data mover) 149
DEFINE DBBACKUPTRIGGER (Define the
database backup trigger) . . . . . . . . 152
DEFINE DBCOPY (Define a volume copy of a
database volume) . . . . . . . . . . . 154
DEFINE DBVOLUME (Define a database
volume) . . . . . . . . . . . . . . 156
DEFINE DEVCLASS (Define a device class) . . 158
DEFINE DOMAIN (Define a new policy
domain) . . . . . . . . . . . . . . 229
DEFINE DRIVE (Define a drive to a library) . . 232
DEFINE EVENTSERVER (Define a server as the
event server) . . . . . . . . . . . . 237
DEFINE GRPMEMBER (Add a server to a
server group) . . . . . . . . . . . . 238
DEFINE LIBRARY (Define a library) . . . . . 240
DEFINE LOGCOPY (Define a volume copy of a
recovery log volume) . . . . . . . . . . 250
DEFINE LOGVOLUME (Define a recovery log
volume) . . . . . . . . . . . . . . 252
DEFINE MACHINE (Define machine
information) . . . . . . . . . . . . . 254
DEFINE MACHNODEASSOCIATION
(Associate a node with a machine) . . . . . 256
DEFINE MGMTCLASS (Define a management
class) . . . . . . . . . . . . . . . 258
DEFINE NODEGROUP (Define a node group) 261
DEFINE NODEGROUPMEMBER (Define node
group member) . . . . . . . . . . . . 262
DEFINE PATH (Define a path) . . . . . . 263
DEFINE POLICYSET (Define a policy set) . . . 271
DEFINE PROFASSOCIATION (Define a profile
association) . . . . . . . . . . . . . 273
DEFINE PROFILE (Define a profile) . . . . . 279
DEFINE RECMEDMACHASSOCIATION
(Associate recovery media with a machine) . . 281
DEFINE RECOVERYMEDIA (Define recovery
media) . . . . . . . . . . . . . . 283
DEFINE SCHEDULE (Define a client or an
administrative command schedule) . . . . . 285
DEFINE SCRIPT (Define a Tivoli Storage
Manager script) . . . . . . . . . . . 307
DEFINE SERVER (Define a server for
server-to-server communications) . . . . . . 310
DEFINE SERVERGROUP (Define a server
group) . . . . . . . . . . . . . . . 315
DEFINE SPACETRIGGER (Define the space
trigger) . . . . . . . . . . . . . . 316
DEFINE STGPOOL (Define a storage pool) . . 321
DEFINE SUBSCRIPTION (Define a profile
subscription) . . . . . . . . . . . . 359
DEFINE VIRTUALFSMAPPING (Define a
virtual file space mapping) . . . . . . . . 361
DEFINE VOLUME (Define a volume in a
storage pool) . . . . . . . . . . . . 363
DELETE commands . . . . . . . . . . . 369
DELETE ASSOCIATION (Delete the node
association to a schedule) . . . . . . . . 371
DELETE BACKUPSET (Delete a backup set) . . 373
DELETE CLIENTOPT (Delete an option in an
option set) . . . . . . . . . . . . . 378
DELETE CLOPTSET (Delete a client option set) 379
DELETE COLLOCGROUP (Delete a collocation
group) . . . . . . . . . . . . . . . 380
DELETE COLLOCMEMBER (Delete collocation
group member) . . . . . . . . . . . . 382
DELETE COPYGROUP (Delete a copy group) 384
DELETE DATAMOVER (Delete a data mover) 386
DELETE DBBACKUPTRIGGER (Delete the
database backup trigger) . . . . . . . . 387
DELETE DBVOLUME (Delete a database
volume) . . . . . . . . . . . . . . 388
DELETE DEVCLASS (Delete a device class) . . 389
DELETE DOMAIN (Delete a policy domain) 390
DELETE DRIVE (Delete a drive from a library) 391
DELETE EVENT (Delete event records) . . . . 392
DELETE EVENTSERVER (Deletes the definition
of the event server) . . . . . . . . . . 394
DELETE FILESPACE (Delete client node data
from the server) . . . . . . . . . . . 395
DELETE GRPMEMBER (Delete a server from a
server group) . . . . . . . . . . . . 399
DELETE KEYRING (Delete password
information in the certificate key database) . . 400
DELETE LIBRARY (Delete a library) . . . . . 401
DELETE LOGVOLUME (Delete a recovery log
volume) . . . . . . . . . . . . . . 402
DELETE MACHINE (Delete machine
information) . . . . . . . . . . . . . 403
DELETE MACHNODEASSOCIATION (Delete
association between a machine and a node) . . 404

iv IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE MGMTCLASS (Delete a management
class) . . . . . . . . . . . . . . . 405
DELETE NODEGROUP (Delete a node group) 407
DELETE NODEGROUPMEMBER (Delete node
group member) . . . . . . . . . . . . 408
DELETE PATH (Delete a path) . . . . . . 409
DELETE POLICYSET (Delete a policy set) . . . 411
DELETE PROFASSOCIATION (Delete a profile
association) . . . . . . . . . . . . . 412
DELETE PROFILE (Delete a profile) . . . . . 415
DELETE RECMEDMACHASSOCIATION
(Delete recovery media and machine
association) . . . . . . . . . . . . . 417
DELETE RECOVERYMEDIA (Delete recovery
media) . . . . . . . . . . . . . . 418
DELETE SCHEDULE (Delete a client or an
administrative command schedule) . . . . . 419
DELETE SCRIPT (Delete command lines from a
script or delete the entire script) . . . . . . 422
DELETE SERVER (Delete a server definition) 423
DELETE SERVERGROUP (Delete a server
group) . . . . . . . . . . . . . . . 424
DELETE SPACETRIGGER (Delete the database
or recovery log space triggers) . . . . . . . 425
DELETE STGPOOL (Delete a storage pool) . . 427
DELETE SUBSCRIBER (Delete subscriptions
from a configuration manager database) . . . 429
DELETE SUBSCRIPTION (Delete a profile
subscription) . . . . . . . . . . . . 430
DELETE VIRTUALFSMAPPING (Delete a
virtual file space mapping) . . . . . . . . 431
DELETE VOLHISTORY (Delete sequential
volume history information) . . . . . . . 432
DELETE VOLUME (Delete a storage pool
volume) . . . . . . . . . . . . . . 437
DISABLE commands . . . . . . . . . . . 440
DISABLE EVENTS (Disable events for event
logging) . . . . . . . . . . . . . . 441
DISABLE SESSIONS (Temporarily prevent client
node access to the server) . . . . . . . . 445
DISMOUNT command . . . . . . . . . . 447
DISMOUNT VOLUME (Dismount a volume by
volume name) . . . . . . . . . . . . 448
DISPLAY commands . . . . . . . . . . . 449
DISPLAY OBJNAME (Display a full object
name) . . . . . . . . . . . . . . . 450
ENABLE commands . . . . . . . . . . . 451
ENABLE EVENTS (Enable server or client
events for logging) . . . . . . . . . . 452
ENABLE SESSIONS (Resume user activity on
the server) . . . . . . . . . . . . . 455
END commands . . . . . . . . . . . . 457
END EVENTLOGGING (Stop logging events) 458
ESTIMATE DBREORGSTATS (Estimates amount of
recoverable space) . . . . . . . . . . . . 460
EXPIRE commands . . . . . . . . . . . 462
EXPIRE INVENTORY (Manually start inventory
expiration processing) . . . . . . . . . 463
EXPORT commands . . . . . . . . . . . 466
EXPORT ADMIN (Export administrator
information) . . . . . . . . . . . . . 467
EXPORT NODE (Export client node
information) . . . . . . . . . . . . . 473
EXPORT POLICY (Export policy information) 491
EXPORT SERVER (Export server information) 497
EXTEND commands . . . . . . . . . . . 512
EXTEND DB (Increase the assigned capacity of
the database) . . . . . . . . . . . . 513
EXTEND LOG (Increase the assigned capacity
of the recovery log) . . . . . . . . . . 515
GENERATE commands . . . . . . . . . . 517
GENERATE BACKUPSET (Generate a backup
set of a clients data) . . . . . . . . . . 518
GENERATE BACKUPSETTOC (Generate a table
of contents for a backup set) . . . . . . . 526
GRANT commands . . . . . . . . . . . 529
GRANT AUTHORITY (Add administrator
authority) . . . . . . . . . . . . . 530
GRANT PROXYNODE (Grant proxy authority
to a client node) . . . . . . . . . . . 534
HALT (Shut down the server) . . . . . . . . 536
HELP (Get help on commands and error messages) 538
IMPORT commands . . . . . . . . . . . 541
IMPORT ADMIN (Import administrator
information) . . . . . . . . . . . . . 542
IMPORT NODE (Import client node
information) . . . . . . . . . . . . . 545
IMPORT POLICY (Import policy information) 551
IMPORT SERVER (Import server information) 554
INSERT commands . . . . . . . . . . . 559
INSERT MACHINE (Insert machine
characteristics information or recovery
instructions) . . . . . . . . . . . . . 560
ISSUE MESSAGE (Issue a message from a server
script) . . . . . . . . . . . . . . . . 562
LABEL commands . . . . . . . . . . . . 564
LABEL LIBVOLUME (Label a library volume) 565
LOCK commands . . . . . . . . . . . . 571
LOCK ADMIN (Lock out an administrator) . . 572
LOCK NODE (Lock out a client node) . . . . 573
LOCK PROFILE (Lock a profile) . . . . . . 574
MACRO (Invoke a macro) . . . . . . . . . 576
MIGRATE STGPOOL (Migrate storage pool to next
storage pool) . . . . . . . . . . . . . 578
MOVE commands . . . . . . . . . . . . 581
MOVE DATA (Move files on a storage pool
volume) . . . . . . . . . . . . . . 582
MOVE DRMEDIA (Move disaster recovery
media offsite and back onsite) . . . . . . . 586
MOVE GRPMEMBER (Move a server group
member) . . . . . . . . . . . . . . 600
MOVE MEDIA (Move sequential access storage
pool media) . . . . . . . . . . . . . 601
MOVE NODEDATA (Move data by node in a
sequential access storage pool) . . . . . . 609
NOTIFY commands . . . . . . . . . . . 618
NOTIFY SUBSCRIBERS (Notify managed
servers to update profiles) . . . . . . . . 619
PARALLEL (Control running of multiple
commands in a script) . . . . . . . . . . 620
PING command . . . . . . . . . . . . 622

Contents v
|
||
PING SERVER (Test the connection between
servers) . . . . . . . . . . . . . . 623
PREPARE (Create a recovery plan file) . . . . . 624
QUERY commands . . . . . . . . . . . 629
QUERY ACTLOG (Query the activity log) . . . 631
QUERY ADMIN (Display administrator
information) . . . . . . . . . . . . . 637
QUERY ASSOCIATION (Query client node
associations with a schedule) . . . . . . . 641
QUERY AUDITOCCUPANCY (Query client
node storage utilization) . . . . . . . . . 643
QUERY BACKUPSET (Query a backup set) . . 646
QUERY BACKUPSETCONTENTS (Query
contents of a backup set) . . . . . . . . 651
QUERY CLOPTSET (Query a client option set) 654
QUERY COLLOCGROUP (Query a collocation
group) . . . . . . . . . . . . . . . 656
QUERY CONTENT (Query the contents of a
storage pool volume) . . . . . . . . . . 658
QUERY COPYGROUP (Query copy groups) . . 665
QUERY DATAMOVER (Display data mover
definitions) . . . . . . . . . . . . . 670
QUERY DB (Display information on the
database) . . . . . . . . . . . . . . 673
QUERY DBBACKUPTRIGGER (Query the
database backup trigger) . . . . . . . . 677
QUERY DBVOLUME (Display information on
one or more database volumes) . . . . . . 679
QUERY DEVCLASS (Display information on
one or more device classes) . . . . . . . . 682
QUERY DIRSPACE (Query storage utilization of
FILE directories) . . . . . . . . . . . 686
QUERY DOMAIN (Query a policy domain) . . 687
QUERY DRIVE (Query information about a
drive) . . . . . . . . . . . . . . . 691
QUERY DRMEDIA (Query disaster recovery
media) . . . . . . . . . . . . . . 695
QUERY DRMSTATUS (Query disaster recovery
manager system parameters) . . . . . . . 703
QUERY ENABLED (Query enabled events) . . 706
QUERY EVENT (Query scheduled and
completed events) . . . . . . . . . . . 708
QUERY EVENTRULES (Query rules for server
or client events) . . . . . . . . . . . 720
QUERY EVENTSERVER (Query the event
server) . . . . . . . . . . . . . . . 723
QUERY EXPORT (Query for active or
suspended export operations) . . . . . . . 724
QUERY FILESPACE (Query one or more file
spaces) . . . . . . . . . . . . . . 730
QUERY LIBRARY (Query a library) . . . . . 736
QUERY LIBVOLUME (Query a library volume) 739
QUERY LICENSE (Display license information) 742
QUERY LOG (Display information on the
recovery log) . . . . . . . . . . . . 743
QUERY LOGVOLUME (Display information on
one or more log volumes) . . . . . . . . 746
QUERY MACHINE (Query machine
information) . . . . . . . . . . . . . 749
QUERY MEDIA (Query sequential access
storage pool media) . . . . . . . . . . 753
QUERY MGMTCLASS (Query a management
class) . . . . . . . . . . . . . . . 760
QUERY MOUNT (Display information on
mounted sequential access volumes) . . . . . 763
QUERY NASBACKUP (Query NAS backup
images) . . . . . . . . . . . . . . 765
QUERY NODE (Query nodes) . . . . . . . 768
QUERY NODEDATA (Query client data in
volumes) . . . . . . . . . . . . . . 775
QUERY NODEGROUP (Query a node group) 778
QUERY OCCUPANCY (Query client file spaces
in storage pools) . . . . . . . . . . . 780
QUERY OPTION (Query server options) . . . 784
QUERY PATH (Display a path definition) . . . 786
QUERY POLICYSET (Query a policy set) . . . 790
QUERY PROCESS (Query one or more server
processes) . . . . . . . . . . . . . 793
QUERY PROFILE (Query a profile) . . . . . 795
QUERY PROXYNODE (Query proxy authority
for a client node) . . . . . . . . . . . 799
QUERY RECOVERYMEDIA (Query recovery
media) . . . . . . . . . . . . . . 800
QUERY REQUEST (Query one or more pending
mount requests) . . . . . . . . . . . 803
QUERY RESTORE (Query restartable restore
sessions) . . . . . . . . . . . . . . 804
QUERY RPFCONTENT (Query recovery plan
file contents stored on a target server) . . . . 807
QUERY RPFILE (Query recovery plan file
information stored on a target server) . . . . 809
QUERY SAN (Query the devices on the SAN) 812
QUERY SCHEDULE (Query schedules) . . . . 815
QUERY SCRIPT (Query Tivoli Storage Manager
scripts) . . . . . . . . . . . . . . 823
QUERY SERVER (Query a server) . . . . . 827
QUERY SERVERGROUP (Query a server group) 831
QUERY SESSION (Query client sessions) . . . 833
QUERY SHREDSTATUS (Query shredding
status ) . . . . . . . . . . . . . . 836
QUERY SPACETRIGGER (Query the space
triggers) . . . . . . . . . . . . . . 838
QUERY SQLSESSION (Display SQL session
value) . . . . . . . . . . . . . . . 841
QUERY STATUS (Query system parameters) 843
QUERY STGPOOL (Query storage pools) . . . 849
QUERY SUBSCRIBER (Display subscriber
information) . . . . . . . . . . . . . 858
QUERY SUBSCRIPTION (Display subscription
information) . . . . . . . . . . . . . 860
QUERY SYSTEM (Query the system
configuration and capacity) . . . . . . . . 862
QUERY TAPEALERTMSG (Display status of
SET TAPEALERTMSG command) . . . . . 864
QUERY TOC (Display table of contents for a
backup image) . . . . . . . . . . . . 865
QUERY VIRTUALFSMAPPING (Query a virtual
file space mapping) . . . . . . . . . . 868
QUERY VOLHISTORY (Display sequential
volume history information) . . . . . . . 870
QUERY VOLUME (Query storage pool
volumes) . . . . . . . . . . . . . . 878

vi IBM Tivoli Storage Manager for Windows: Administrators Reference
|
||
QUIT (End the interactive mode of the
administrative client) . . . . . . . . . . . 885
RECLAIM commands . . . . . . . . . . 886
RECLAIM STGPOOL (Reclaim sequential-access
storage pool) . . . . . . . . . . . . 887
RECONCILE commands . . . . . . . . . . 890
RECONCILE VOLUMES (Reconcile differences
in the virtual volume definitions) . . . . . . 891
REDUCE commands . . . . . . . . . . . 894
REDUCE DB (Decrease the assigned capacity of
the database) . . . . . . . . . . . . 895
REDUCE LOG (Decrease the assigned capacity
of the recovery log) . . . . . . . . . . 896
REGISTER commands . . . . . . . . . . 898
REGISTER ADMIN (Register an administrator) 899
REGISTER LICENSE (Register a new license) 901
REGISTER NODE (Register a node) . . . . . 903
REMOVE commands . . . . . . . . . . . 913
REMOVE ADMIN (Delete an administrator) . . 914
REMOVE NODE (Delete a node or an
associated machine node) . . . . . . . . 915
RENAME commands . . . . . . . . . . . 917
RENAME ADMIN (Rename an administrator) 918
RENAME FILESPACE (Rename a client file
space on the server) . . . . . . . . . . 919
RENAME NODE (Rename a node) . . . . . 922
RENAME SCRIPT (Rename a Tivoli Storage
Manager script) . . . . . . . . . . . 923
RENAME SERVERGROUP (Rename a server
group) . . . . . . . . . . . . . . . 924
RENAME STGPOOL (Change the name of a
storage pool) . . . . . . . . . . . . 925
REPLY (Allow a request to continue processing) 926
RESET commands . . . . . . . . . . . . 927
RESET BUFPOOL (Reset the database buffer
pool statistics) . . . . . . . . . . . . 928
RESET DBMAXUTILIZATION (Reset the
utilization statistic for the database) . . . . . 929
RESET LOGCONSUMPTION (Reset the
cumulative log consumption statistic) . . . . 930
RESET LOGMAXUTILIZATION (Reset the
utilization statistic for the log) . . . . . . . 931
RESET PASSEXP (Reset password expiration) 932
RESTART EXPORT (Restarts a suspended export
operation) . . . . . . . . . . . . . . 934
RESTORE commands . . . . . . . . . . . 936
RESTORE NODE (Restore a NAS node) . . . 937
RESTORE STGPOOL (Restore storage pool data
from a copy pool or an active-data pool) . . . 941
RESTORE VOLUME (Restore primary volume
data from a copy pool or an active-data pool) . 945
REVOKE commands . . . . . . . . . . . 950
REVOKE AUTHORITY (Remove administrator
authority) . . . . . . . . . . . . . 951
REVOKE PROXYNODE (Revoke proxy
authority for a client node) . . . . . . . . 955
ROLLBACK (Rollback uncommitted changes in a
macro) . . . . . . . . . . . . . . . . 956
RUN (Run a Tivoli Storage Manager script) . . . 957
SELECT (Perform an SQL query of the IBM Tivoli
Storage Manager Database) . . . . . . . . . 960
Effect of the SELECT command on server
performance . . . . . . . . . . . . . 968
Requirement for database space for the SELECT
command . . . . . . . . . . . . . 969
SQL parameters available . . . . . . . . 970
SERIAL (Control running of multiple commands in
a script) . . . . . . . . . . . . . . . 971
SET commands . . . . . . . . . . . . . 972
SET ACCOUNTING (Set accounting records on
or off) . . . . . . . . . . . . . . . 974
SET ACTLOGRETENTION (Set the retention
period or the size of the activity log) . . . . 975
SET ARCHIVERETENTIONPROTECTION
(Activate data retention protection) . . . . . 977
SET AUTHENTICATION (Set password
authentication) . . . . . . . . . . . . 979
SET CLIENTACTDURATION (Set the duration
period for the client action) . . . . . . . . 980
SET CONFIGMANAGER (Specify a
configuration manager) . . . . . . . . . 981
SET CONFIGREFRESH (Set managed server
configuration refresh) . . . . . . . . . . 983
SET CONTEXTMESSAGING (Set message
context reporting on or off) . . . . . . . . 985
SET CROSSDEFINE (Specifies whether to
cross-define servers) . . . . . . . . . . 986
SET DRMCHECKLABEL (Specify label
checking) . . . . . . . . . . . . . . 987
SET DRMCMDFILENAME (Specify the name of
a file to contain commands) . . . . . . . 988
SET DRMCOPYSTGPOOL (Specify the copy
storage pools to be managed by DRM) . . . . 989
SET DRMCOURIERNAME (Specify the courier
name) . . . . . . . . . . . . . . . 990
SET DRMDBBACKUPEXPIREDAYS (Criteria for
DB backup series expiration) . . . . . . . 991
SET DRMFILEPROCESS (Specify file
processing) . . . . . . . . . . . . . 993
SET DRMINSTRPREFIX (Specify the prefix for
recovery instructions file names) . . . . . . 994
SET DRMNOTMOUNTABLENAME (Specify the
not mountable location name) . . . . . . . 996
SET DRMPLANPREFIX (Specify a prefix for
recovery plan file names) . . . . . . . . 997
SET DRMPLANVPOSTFIX (Specify replacement
volume names) . . . . . . . . . . . . 999
SET DRMPRIMSTGPOOL (Specify the primary
storage pools to be managed by DRM) . . . 1001
SET DRMRPFEXPIREDAYS (Set criteria for
recovery plan file expiration) . . . . . . . 1002
SET DRMVAULTNAME (Specify the vault
name) . . . . . . . . . . . . . . 1004
SET EVENTRETENTION (Set the retention
period for event records) . . . . . . . . 1005
SET INVALIDPWLIMIT (Set the number of
invalid logon attempts) . . . . . . . . . 1007
SET LICENSEAUDITPERIOD (Set license audit
period) . . . . . . . . . . . . . . 1008
SET LOGMODE (Set mode for saving recovery
log records) . . . . . . . . . . . . 1009

Contents vii
|
||
SET MAXCMDRETRIES (Set the maximum
number of command retries) . . . . . . . 1011
SET MAXSCHEDSESSIONS (Set maximum
scheduled sessions) . . . . . . . . . . 1012
SET MINPWLENGTH (Set minimum password
length) . . . . . . . . . . . . . . 1013
SET PASSEXP (Set password expiration date) 1014
SET QUERYSCHEDPERIOD (Set query period
for polling client nodes) . . . . . . . . 1016
SET RANDOMIZE (Set randomization of
scheduled start times) . . . . . . . . . 1017
SET REGISTRATION (Set open or closed
registration) . . . . . . . . . . . . 1019
SET RETRYPERIOD (Set time between retry
attempts) . . . . . . . . . . . . . 1021
SET SCHEDMODES (Select a central
scheduling mode) . . . . . . . . . . 1022
SET SERVERHLADDRESS (Set the high-level
address of a server) . . . . . . . . . . 1024
SET SERVERLLADDRESS (Set the low-level
address of a server) . . . . . . . . . . 1025
SET SERVERNAME (Specify the server name) 1026
SET SERVERPASSWORD (Set password for
server) . . . . . . . . . . . . . . 1028
SET SQLDATETIMEFORMAT (Set the format
for date, time, and time stamp for SQL data) . 1029
SET SQLDISPLAYMODE (Set the display of
SQL data types) . . . . . . . . . . . 1031
SET SQLMATHMODE (Set the mode for SQL
arithmetic) . . . . . . . . . . . . . 1032
SET SUBFILE (Set subfile backup for client
nodes) . . . . . . . . . . . . . . 1033
SET SUMMARYRETENTION (Set days to keep
data in activity summary table) . . . . . . 1034
SET TAPEALERTMSG (Set tape alert messages
on or off) . . . . . . . . . . . . . 1035
SET TOCLOADRETENTION (Set load
retention period for table of contents) . . . . 1036
SETOPT (Set a server option for dynamic update) 1037
SHRED commands . . . . . . . . . . . 1039
SHRED DATA (Shred data) . . . . . . . 1040
SUSPEND EXPORT (Suspends a currently
running export operation) . . . . . . . . . 1042
UNDO commands . . . . . . . . . . . 1044
UNDO ARCHCONVERSION (Reverse archive
conversion for the node) . . . . . . . . 1045
UNLOCK commands . . . . . . . . . . 1046
UNLOCK ADMIN (Unlock an administrator) 1047
UNLOCK NODE (Unlock a client node) . . . 1048
UNLOCK PROFILE (Unlock a profile) . . . . 1049
UPDATE commands . . . . . . . . . . 1050
UPDATE ADMIN (Update an administrator) 1051
UPDATE ARCHIVE (Manage archive usage
and performance) . . . . . . . . . . 1053
UPDATE BACKUPSET (Update a retention
value assigned to a backup set) . . . . . . 1055
UPDATE CLIENTOPT (Update a client option
sequence number) . . . . . . . . . . 1060
UPDATE CLOPTSET (Update a client option
set description) . . . . . . . . . . . 1061
UPDATE COLLOCGROUP (Update a
collocation group) . . . . . . . . . . 1062
UPDATE COPYGROUP (Update a copy group) 1064
UPDATE DATAMOVER (Update a data
mover) . . . . . . . . . . . . . . 1072
UPDATE DBBACKUPTRIGGER (Update the
database backup trigger) . . . . . . . . 1074
UPDATE DEVCLASS (Update the attributes of
a device class) . . . . . . . . . . . . 1076
UPDATE DOMAIN (Update a policy domain) 1139
UPDATE DRIVE (Update a drive) . . . . . 1141
UPDATE LIBRARY (Update a library) . . . . 1145
UPDATE LIBVOLUME (Change the status of a
storage volume) . . . . . . . . . . . 1151
UPDATE MACHINE (Update machine
information) . . . . . . . . . . . . 1153
UPDATE MGMTCLASS (Update a
management class) . . . . . . . . . . 1155
UPDATE NODE (Update node attributes) . . 1158
UPDATE NODEGROUP (Update a node
group) . . . . . . . . . . . . . . 1166
UPDATE PATH (Change a path) . . . . . 1167
UPDATE POLICYSET (Update a policy set
description) . . . . . . . . . . . . 1173
UPDATE PROFILE (Update a profile
description) . . . . . . . . . . . . 1175
UPDATE RECOVERYMEDIA (Update recovery
media) . . . . . . . . . . . . . . 1176
UPDATE SCHEDULE (Update a schedule) 1178
UPDATE SCRIPT (Update a Tivoli Storage
Manager script) . . . . . . . . . . . 1199
UPDATE SERVER (Update a server defined for
server-to-server communications) . . . . . 1201
UPDATE SERVERGROUP (Update a server
group description) . . . . . . . . . . 1205
UPDATE SPACETRIGGER (Update the space
triggers) . . . . . . . . . . . . . . 1206
UPDATE STGPOOL (Update a storage pool) 1210
UPDATE VIRTUALFSMAPPING (Update a
virtual file space mapping) . . . . . . . 1244
UPDATE VOLHISTORY (Update sequential
volume history information) . . . . . . . 1246
UPDATE VOLUME (Change a storage pool
volume) . . . . . . . . . . . . . . 1248
VALIDATE commands . . . . . . . . . . 1253
VALIDATE LANFREE (Validate LAN-Free
paths) . . . . . . . . . . . . . . 1254
VALIDATE POLICYSET (Verify a policy set) 1256
VARY (Bring a random access volume online or
offline) . . . . . . . . . . . . . . . 1258
Chapter 3. Server options . . . . . 1261
Modifying server options . . . . . . . . . 1261
Types of server options . . . . . . . . . . 1261
Communication options . . . . . . . . 1262
Server storage options . . . . . . . . . 1262
Client-server options . . . . . . . . . 1263
Date, number, time, and language options . . 1263
Database and recovery log options . . . . . 1264
Data transfer options . . . . . . . . . 1264
Message options . . . . . . . . . . . 1264

viii IBM Tivoli Storage Manager for Windows: Administrators Reference
|
||
Event logging options . . . . . . . . . 1265
Security options and licensing options . . . . 1265
Miscellaneous options . . . . . . . . . 1266
3494SHARED . . . . . . . . . . . . . 1267
ACSACCESSID . . . . . . . . . . . . 1268
ACSLOCKDRIVE . . . . . . . . . . . 1269
ACSQUICKINIT . . . . . . . . . . . . 1270
ACSTIMEOUTX . . . . . . . . . . . . 1271
ADMINONCLIENTPORT . . . . . . . . . 1272
ADREGISTER . . . . . . . . . . . . . 1273
ADSETDC . . . . . . . . . . . . . . 1274
ADSMGROUPNAME . . . . . . . . . . 1275
ADUNREGISTER . . . . . . . . . . . 1276
ALIASHALT . . . . . . . . . . . . . 1277
ASSISTVCRRECOVERY . . . . . . . . . 1278
AUDITSTORAGE . . . . . . . . . . . 1279
BUFPOOLSIZE . . . . . . . . . . . . 1280
COMMMETHOD . . . . . . . . . . . 1281
COMMTIMEOUT . . . . . . . . . . . 1282
DATEFORMAT . . . . . . . . . . . . 1283
DBPAGESHADOW . . . . . . . . . . . 1284
DBPAGESHADOWFILE . . . . . . . . . 1285
DEVCONFIG . . . . . . . . . . . . . 1286
DISABLESCHEDS . . . . . . . . . . . 1287
DISPLAYLFINFO . . . . . . . . . . . . 1288
DNSLOOKUP . . . . . . . . . . . . . 1289
DRIVEACQUIRERETRY . . . . . . . . . 1290
EVENTSERVER . . . . . . . . . . . . 1291
EXPINTERVAL . . . . . . . . . . . . 1292
EXPQUIET . . . . . . . . . . . . . . 1293
FILEEXIT . . . . . . . . . . . . . . 1294
FILETEXTEXIT . . . . . . . . . . . . 1295
IDLETIMEOUT . . . . . . . . . . . . 1296
LANGUAGE . . . . . . . . . . . . . 1297
LOGPOOLSIZE . . . . . . . . . . . . 1298
LOGWARNFULLPERCENT . . . . . . . . 1299
MAXSESSIONS . . . . . . . . . . . . 1300
MESSAGEFORMAT . . . . . . . . . . . 1301
MIRRORREAD . . . . . . . . . . . . 1302
MIRRORWRITE . . . . . . . . . . . . 1303
MOVEBATCHSIZE . . . . . . . . . . . 1304
MOVESIZETHRESH . . . . . . . . . . 1305
MSGINTERVAL . . . . . . . . . . . . 1306
MSGSTACKTRACE . . . . . . . . . . . 1307
NAMEDPIPENAME . . . . . . . . . . 1308
NDMPCONTROLPORT . . . . . . . . . 1309
NDMPPORTRANGE . . . . . . . . . . 1310
NOPREEMPT . . . . . . . . . . . . . 1311
NORETRIEVEDATE . . . . . . . . . . . 1312
NPAUDITFAILURE . . . . . . . . . . . 1313
NPAUDITSUCCESS . . . . . . . . . . . 1314
NPBUFFERSIZE . . . . . . . . . . . . 1315
NUMBERFORMAT . . . . . . . . . . . 1316
QUERYAUTH . . . . . . . . . . . . . 1317
REPORTRETRIEVE . . . . . . . . . . . 1318
REQSYSAUTHOUTFILE . . . . . . . . . 1319
RESOURCETIMEOUT . . . . . . . . . . 1320
RESTOREINTERVAL . . . . . . . . . . 1321
RETENTIONEXTENSION . . . . . . . . . 1322
SANDISCOVERY . . . . . . . . . . . . 1323
SANREFRESHTIME . . . . . . . . . . . 1324
SEARCHMPQUEUE . . . . . . . . . . . 1325
SECUREPIPES . . . . . . . . . . . . . 1326
SELFTUNEBUFPOOLSIZE . . . . . . . . 1327
SHMPORT . . . . . . . . . . . . . . 1328
SHREDDING . . . . . . . . . . . . . 1329
SNMPHEARTBEATINTERVAL . . . . . . . 1330
SNMPMESSAGECATEGORY . . . . . . . . 1331
SNMPSUBAGENT . . . . . . . . . . . 1332
SNMPSUBAGENTHOST . . . . . . . . . 1333
SNMPSUBAGENTPORT . . . . . . . . . 1334
SSLTCPADMINPORT . . . . . . . . . . 1335
SSLTCPPORT . . . . . . . . . . . . . 1336
TCPADMINPORT . . . . . . . . . . . 1337
TCPNODELAY . . . . . . . . . . . . 1338
TCPPORT . . . . . . . . . . . . . . 1339
TCPWINDOWSIZE . . . . . . . . . . . 1340
TECBEGINEVENTLOGGING . . . . . . . 1341
TECHOST . . . . . . . . . . . . . . 1342
TECPORT . . . . . . . . . . . . . . 1343
TECUTF8EVENT . . . . . . . . . . . . 1344
THROUGHPUTDATATHRESHOLD . . . . . 1345
THROUGHPUTTIMETHRESHOLD . . . . . 1346
TIMEFORMAT . . . . . . . . . . . . 1347
TXNGROUPMAX . . . . . . . . . . . 1348
UNIQUETDPTECEVENTS . . . . . . . . 1349
UNIQUETECEVENTS . . . . . . . . . . 1350
USEREXIT . . . . . . . . . . . . . . 1351
VERBCHECK . . . . . . . . . . . . . 1352
VOLUMEHISTORY . . . . . . . . . . . 1353
Chapter 4. IBM Tivoli Storage
Manager Utilities . . . . . . . . . 1355
Miscellaneous utilities . . . . . . . . . . 1355
Database recovery utilities . . . . . . . . . 1355
Database salvage utilities . . . . . . . . . 1356
DSMMAXSG (Increasing the block size for
writing data) . . . . . . . . . . . . . 1357
DSMSERV (Start the server) . . . . . . . . 1358
DSMSERV AUDITDB (Verify database
information) . . . . . . . . . . . . . 1360
DSMSERV DISPLAY DBBACKUPVOLUME
(Display database backup volume information) . . 1363
DSMSERV DISPLAY DBVOLUMES (Display
database volume information) . . . . . . . 1365
DSMSERV DISPLAY LOGVOLUMES (Display
recovery log volume information) . . . . . . 1367
DSMSERV DUMPDB (Dump the database) . . . 1369
DSMSERV EXTEND LOG (Emergency log
extension) . . . . . . . . . . . . . . 1372
DSMSERV FORMAT (Format the database and
log) . . . . . . . . . . . . . . . . 1373
DSMSERV LOADDB (Reload the database) . . . 1376
DSMSERV LOADFORMAT (Format the database
and log for load) . . . . . . . . . . . . 1379
DSMSERV RESTORE DB (Restore the database) 1382
Restoring a database to its most current state 1384
Restoring a single database volume to its most
current state . . . . . . . . . . . . 1385
Restoring a database to a point-in-time
volume history file available . . . . . . . 1387

Contents ix
||
Restoring a database to a point-in-time
volume history file unavailable . . . . . . 1389
DSMSERV UNLOADDB (Unload the database) 1391
Appendix A. Return codes for use in
IBM Tivoli Storage Manager scripts . 1395
Appendix B. Notices . . . . . . . . 1397
Trademarks . . . . . . . . . . . . . 1399
Glossary . . . . . . . . . . . . . 1401
Index . . . . . . . . . . . . . . 1421

x IBM Tivoli Storage Manager for Windows: Administrators Reference
About this publication
IBM

Tivoli

Storage Manager is a client/server program that provides storage

management solutions to customers in a multi-vendor computer environment. IBM
Tivoli Storage Manager provides an automated, centrally scheduled,
policy-managed backup, archive, and space-management facility for file servers
and workstations.
Who should read this guide
This reference is intended for anyone who is registered as an administrator. A
single administrator can manage Tivoli Storage Manager, or several people can
share administrative responsibilities.
You should be familiar with the operating system on which the server resides and
the communication protocols required for the client/server environment. You also
need to understand the storage management practices of your organization, such
as how you are currently backing up workstation files and how you are using
storage devices.
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.
Tivoli Storage Manager publications

Tivoli Storage Manager server publications
Publication Title Order Number
IBM Tivoli Storage Manager Messages SC32-0140
IBM Tivoli Storage Manager Performance Tuning Guide SC32-0141
IBM Tivoli Storage Manager Problem Determination Guide SC32-0142
IBM Tivoli Storage Manager for AIX Installation Guide GC23-5969
IBM Tivoli Storage Manager for AIX Administrators Guide SC32-0117
IBM Tivoli Storage Manager for AIX Administrators Reference SC32-0123
IBM Tivoli Storage Manager for HP-UX Installation Guide GC23-5970

Copyright IBM Corp. 1993, 2007 xi
Tivoli Storage Manager server publications
Publication Title Order Number
IBM Tivoli Storage Manager for HP-UX Administrators Guide SC32-0118
IBM Tivoli Storage Manager for HP-UX Administrators Reference SC32-0124
IBM Tivoli Storage Manager for Linux Installation Guide GC23-5971
IBM Tivoli Storage Manager for Linux Administrators Guide SC32-0119
IBM Tivoli Storage Manager for Linux Administrators Reference SC32-0125
IBM Tivoli Storage Manager for Sun Solaris Installation Guide GC23-5972
IBM Tivoli Storage Manager for Sun Solaris Administrators Guide SC32-0120
IBM Tivoli Storage Manager for Sun Solaris Administrators Reference SC32-0126
IBM Tivoli Storage Manager for Windows Installation Guide GC23-5973
IBM Tivoli Storage Manager for Windows Administrators Guide SC32-0121
IBM Tivoli Storage Manager for Windows Administrators Reference SC32-0127
IBM Tivoli Storage Manager for z/OS Installation Guide GC23-5974
IBM Tivoli Storage Manager for z/OS Administrators Guide SC32-0122
IBM Tivoli Storage Manager for z/OS Administrators Reference SC32-0128
IBM Tivoli Storage Manager for System Backup and Recovery Installation
and Users Guide
SC32-6543


Tivoli Storage Manager storage agent publications
Publication Title Order Number
IBM Tivoli Storage Manager for SAN for AIX Storage Agent Users
Guide
SC32-0129
IBM Tivoli Storage Manager for SAN for HP-UX Storage Agent Users
Guide
SC32-0130
IBM Tivoli Storage Manager for SAN for Linux Storage Agent Users
Guide
SC32-0131
IBM Tivoli Storage Manager for SAN for Sun Solaris Storage Agent
Users Guide
SC32-0132
IBM Tivoli Storage Manager for SAN for Windows Storage Agent Users
Guide
SC32-0133


Tivoli Storage Manager client publications
Publication Title Order Number
IBM Tivoli Storage Manager for Macintosh: Backup-Archive Clients
Installation and Users Guide
SC32-0143
IBM Tivoli Storage Manager for NetWare: Backup-Archive Clients
Installation and Users Guide
SC32-0144
IBM Tivoli Storage Manager for UNIX and Linux: Backup-Archive
Clients Installation and Users Guide
SC32-0145
IBM Tivoli Storage Manager for Windows: Backup-Archive Clients
Installation and Users Guide
SC32-0146
IBM Tivoli Storage Manager for Space Management for UNIX and Linux:
Users Guide
SC32-0148
IBM Tivoli Storage Manager for HSM for Windows Administration Guide SC32-1773

xii IBM Tivoli Storage Manager for Windows: Administrators Reference
Tivoli Storage Manager client publications
Publication Title Order Number
IBM Tivoli Storage Manager Using the Application Program Interface SC32-0147


Tivoli Storage Manager Data Protection publications
Publication Title
Order
Number
IBM Tivoli Storage Manager for Advanced Copy Services: Data Protection for
Snapshot Devices for SAP Installation and Users Guide for Oracle
SC33-8207
IBM Tivoli Storage Manager for Advanced Copy Services: Data Protection for
Snapshot Devices for DB2 Installation and Users Guide
SC33-8330
IBM Tivoli Storage Manager for Advanced Copy Services: Data Protection for
WebSphere Application Server Installation and Users Guide
SC32-9075
IBM Tivoli Storage Manager for Databases: Data Protection for Informix
Installation and Users Guide
SH26-4095
IBM Tivoli Storage Manager for Databases: Data Protection for Microsoft SQL
Server Installation and Users Guide
SC32-9059
IBM Tivoli Storage Manager for Databases: Data Protection for Oracle for UNIX
and Linux Installation and Users Guide
SC32-9064
IBM Tivoli Storage Manager for Databases: Data Protection for Oracle for
Windows Installation and Users Guide
SC32-9065
IBM Tivoli Storage Manager for Enterprise Resource Planning: Data Protection for
SAP Installation and Users Guide for DB2
SC33-6341
IBM Tivoli Storage Manager for Enterprise Resource Planning: Data Protection for
SAP Installation and Users Guide for Oracle
SC33-6340
IBM Tivoli Storage Manager for Hardware: Data Protection for Enterprise Storage
Server

for DB2 UDB Installation and Users Guide

SC32-9060
IBM Tivoli Storage Manager for Hardware: Data Protection for Snapshot Devices
for Oracle Installation and Users Guide
GC32-1772
IBM Tivoli Storage Manager for Mail: Data Protection for Lotus Domino for
UNIX, Linux, and OS/400

Installation and Users Guide

SC32-9056
IBM Tivoli Storage Manager for Mail: Data Protection for Lotus Domino for
Windows Installation and Users Guide
SC32-9057
IBM Tivoli Storage Manager for Mail: Data Protection for Microsoft Exchange
Server Installation and Users Guide
SC32-9058

Related hardware publications
Put your short description here; used for first paragraph and abstract.

Title Order Number
IBM Magstar 3494 Tape Library Introduction and Planning Guide GA32-0279
IBM Magstar MP 3570 Tape Subsystem Operators Guide GA32-0345
IBM TotalStorage Enterprise Tape System 3590 Operator Guide GA32-0330
IBM Magstar 3494 Tape Library Dataserver Operator Guide GA32-0280
IBM TotalStorage Enterprise Tape System 3592 Operator Guide GA32-0465



About this publication xiii
Support information
You can find support information for IBM products from a number of different
sources:
v Getting technical training
v Searching knowledge bases
v Contacting IBM Software Support on page xv
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/

xiv IBM Tivoli Storage Manager for Windows: Administrators Reference
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 publication xv
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.

xvi IBM Tivoli Storage Manager for Windows: Administrators Reference
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 guide
v Command to be entered on the Windows command line:
> dsmadmc
v Command to be entered on the command line of an administrative client:
query devclass
In the usage and descriptions for administrative commands, the term characters
corresponds to the number of bytes available to store an item. For languages in
which it takes a single byte to represent a displayable character, the character to
byte ratio is 1 to 1. However, for DBCS and other multi-byte languages, the
reference to characters refers only to the number of bytes available for the item and
may represent fewer actual characters.
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 publication xvii
xviii IBM Tivoli Storage Manager for Windows: Administrators Reference
Technical changes for Version 5.5
The following changes have been made to the product for this edition:
New method for calculating migration thresholds for storage pools associated
with sequential-access disk (FILE) devices
In previous releases of Tivoli Storage Manager, migration thresholds for
storage pools associated with sequential-access disk (FILE) devices were
based on the percentage of volumes utilized. In this release, migration
thresholds are based on a percentage of the storage pools total data
capacity. Migration thresholds for other types of sequential-access storage
pools are still based on the percentage of volumes utilized.
For example, a sequential-access disk storage pool with a total capacity of
100 TB and a high migration threshold of 70% will be migrated when the
pool contains 70 TB of data. This method of calculating migration
thresholds provides a potentially more efficient use of large,
sequential-access disk storage pools. The server continues to migrate files
by volume; after each volume is migrated, the server checks to determine
if the low migration threshold has been reached.
When you start the version 5.5 server, the percentage of data in a
FILE-type storage pool that can be migrated is immediately recalculated
using the new metric. If you are upgrading from a previous version of
Tivoli Storage Manager, you will discover that more data must be stored
before migration starts. Be sure to adjust your migration thresholds so that
you do not run out of space for routine storage operations such as client
backups.
See the following changed commands:
v DEFINE STGPOOLPrimary Sequential Access
v UPDATE STGPOOLPrimary Sequential Access
Concurrent access to volumes in storage pools with a device type of FILE
In previous versions of Tivoli Storage Manager, a client session or server
process had to wait for a FILE volume if the volume was in use by another
session or process. In this version, the Tivoli Storage Manager server
allows concurrent read access and write access to the volume.
Concurrent access improves restore performance by allowing two or more
clients to access the same volume at the same time. Multiple client sessions
(archive, retrieve, backup, and restore) or server processes (for example,
storage pool backup) can read the volume concurrently. In addition, one
client session can write to the volume while it is being read.
The following server processes are allowed shared read access to FILE
volumes:
v BACKUP DB
v BACKUP STGPOOL
v COPY ACTIVEDATA
v EXPORT/IMPORT NODE
v EXPORT/IMPORT SERVER
v GENERATE BACKUPSET
v RESTORE STGPOOL

Copyright IBM Corp. 1993, 2007 xix
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
v RESTORE VOLUME
The following server processes are not allowed shared read access to FILE
volumes:
v AUDIT VOLUME
v DELETE VOLUME
v MIGRATION
v MOVE DATA
v MOVE NODEDATA
v RECLAMATION
A FILE volume can appear as the current volume for more than one
session and as the target of concurrent read and write operations. There are
no command changes associated with this feature.
Restartable server-to-server export
You can now suspend and later restart an export operation if it is a
server-to-server export that is designated with a FILEDATA value other
than NONE. If an export operation was suspended because of errors or
because the SUSPEND EXPORT command was issued, you can restart the
export at the point where it was suspended. To find those export
operations that can be restarted, issue the QUERY EXPORT command.
You can also specify the TODATE/TOTIME parameter when issuing an
EXPORT NODE or EXPORT SERVER command. The following commands
were added to support restartable exports:
v CANCEL EXPORT
v QUERY EXPORT
v RESTART EXPORT
v SUSPEND EXPORT
IBM and HP LTO-4 Drive Support and Encryption
Tivoli Storage Manager now supports IBM and HP LTO-4 tape drives. New
recording formats are available for the LTO device class. Tape device
encryption is also supported. Encryption provides security for data on
individual tapes and protects sensitive information that might be
transported off-site. When enabled, Tivoli Storage Manager handles
encrypting and decrypting data on tapes, according to specifications set
when defining the LTO device class. To enable drive encryption with IBM
LTO-4, you must have the IBM RMSS Ultrium device driver installed. SCSI
drives do not support IBM LTO-4 encryption.
For details about encryption, see the Administrators Guide.
See the following changed commands:
v DEFINE DEVCLASSLTO
v QUERY DEVCLASS
v QUERY VOLUME
v UPDATE DEVCLASSLTO
New support for Plasmon and IBM UDO2 optical disk drives and media
Tivoli Storage Manager now supports Plasmon and IBM UDO2 optical disk
drives and media. A new recording format is available for the OPTICAL
device type. You cannot mix UDO1 and UDO2 drives in a single library.
See the following changed commands:
v DEFINE DEVCLASSOptical and WORM types
v UPDATE DEVCLASSOptical and WORM types

xx IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Support for long file names
Tivoli Storage Manager now supports up to 8704 bytes in length for fully
qualified file names (a file name and file path combined). This support is
available for backup and restore functions, and is dependent on whether or
not the client also supports the byte length. Fully qualified file names
might be truncated in message or query output. To display the full name,
use the DISPLAY OBJNAME command.
See the following new command:
v DISPLAY OBJNAME
See the Administrators Guide for more information.
TCP/IP Version 6
Tivoli Storage Manager is now able to use TCP/IP Version 6 (IPv6) as its
communications protocol. IPv6 is interoperable with TCP/IP Version 4. You
can specify either IPv4 or both IPv4 and IPv6 in the COMMMETHOD
option when you start the server, storage agent, client, or API application.
The same port numbers are used by the server, storage agent, client, or API
application for both IPv4 and IPv6.
IPv6 address formats are acceptable for all functions that support IPv6.
However, if you use IPv6 addresses for functions that do not support IPv6,
communications will fail. The following functions do not support IPv6:
v NDMP: backing up and restoring storage pools, copying and moving
data (continue to use IPv4)
v ACLS (continue to use IPv4)
v SNMP (continue to use IPv4)
v Centera device support (continue to use IPv4)
v Shared Memory Protocol (continue to use IPv4)
v Windows Microsoft Management Console functions (continue to use
IPv4)
v Tivoli Enterprise Console

(TEC) support
v Administration Center (continue to use IPv4)
See the following changed server option:
v COMMMETHOD on page 1281
Client and Server authentication using Secure Socket Layer (SSL)
Tivoli Storage Manager now supports the use of Secure Socket Layer (SSL)
for authentication of passwords between the server and clients.
See the following new command: DELETE KEYRING
See the following new server options:
v SSLTCPPORT on page 1336
v SSLTCPADMINPORT on page 1335

Technical changes for Version 5.5 xxi
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
xxii IBM Tivoli Storage Manager for Windows: Administrators Reference
Chapter 1. Administering the server from the command line
Tivoli Storage Manager provides several different command line interfaces. The
interface you choose depends on the tasks that you want to perform and
accessibility.
Tivoli Storage Manager provides three command line interfaces:
v Administrative command-line client
v Server console
v Administration Center command line
The administrative command-line client is a program that runs on a file server,
workstation, or mainframe. It is installed as part of the Tivoli Storage Manager
server installation process. With the administrative client, you can issue any and all
server commands.
Compared to the administrative client, the capabilities of the server console are
somewhat limited. For example, you cannot issue certain commands from the
server console, and you cannot specify that certain commands process before other
commands can be issued. (This procedure can be useful if, for example, you want
to run two commands in quick succession.) Furthermore, because the server
console is a DOS window on the machine on which the server is installed, you
must be physically located at the server machine to use the console. The
administrative client, on the other hand, can be accessed remotely from a different
location. You cannot route commands to other servers from the server console.
The Administration Center is a Web-based, task-oriented interface for centrally
configuring and managing Tivoli Storage Manager servers. The Administration
Center provides a command line interface that you can use if necessary. For
example, you might want to use the command line interface to perform Tivoli
Storage Manager functions that are limited or not supported in the Administration
Center. Using the command line in the Administration Center, you can issue any
and all server commands.
Issuing commands from the administrative client
The administrative command-line client is a program that runs on a file server,
workstation, or mainframe.
Ensure that your administrative client and your server are running in compatible
languages. See LANGUAGE on page 1297 for language and locale options. If
your client and server are using different languages, the messages that Tivoli
Storage Manager generates might not be understandable.
Administrative client options on page 5
In all administrative client modes, you can use options to modify
administrative client session responses.
Saving command output to a specified location on page 4
The most common use for redirecting output is to save the output from query
commands to a specified file or program. You can then browse the contents of
the file or, in some cases, print the contents.


Copyright IBM Corp. 1993, 2007 1
Starting and stopping the administrative client
Use the DSMADMC command to start an administrative client session.
The Tivoli Storage Manager server must be running before an administrative client
can connect. For instructions about starting the server, see the Installation Guide.
To start an administrative client session in command-line mode, enter this
command on your workstation:
dsmadmc -id=admin -password=admin -dataonly=yes
Note:
1. If you do not want to be prompted for a user ID and password, enter the
DSMADMC command using the -ID and -PASSWORD options as shown.
2. The -DATAONLY option specifies whether product version information
and output headers display with the output. The default is NO.
v NO specifies that the product version information and output column
headers display.
v YES suppresses the product version information and output column
headers.
Stop an administrative command-line client session by entering the following
command on your workstation:
quit
Administrative client options on page 5
In all administrative client modes, you can use options to modify
administrative client session responses.
Monitoring server activities from the administrative client
To monitor Tivoli Storage Manager activities, such as server migration and client
logons, run the administrative client in console mode. You cannot enter any
administrative commands in console mode.
To start an administrative client session in console mode, enter:
dsmadmc -consolemode
You are prompted for a password if authentication is turned on for the server. If
you do not want to be prompted for your user ID and password, enter the
DSMADMC command with the -ID and -PASSWORD options.
To end an administrative client session in console mode, see Table 1.
Table 1. Keyboard break sequences
Environment Break Sequence
UNIX-based and Linux

clients Ctrl+C
Windows Ctrl+C, Ctrl+Break
TSO ATTN



2 IBM Tivoli Storage Manager for Windows: Administrators Reference
Monitoring removable-media mounts from the administrative
client
To monitor the mounting and dismounting of removable media, run the
administrative client in mount mode. When the client is running in mount mode,
you cannot enter any administrative commands.
To start an administrative client session in mount mode, enter:
dsmadmc -mountmode
You are prompted for a password if authentication is turned on for the server. If
you do not want to be prompted for your user ID and password, enter the
DSMADMC command with the -ID and -PASSWORD options.
To end an administrative client session in mount mode, see Table 1 on page 2.
Processing commands one at a time from the administrative
client
Use batch mode to enter a single administrative command. Your administrative
client session automatically ends when the command has processed.
To start an administrative client session in batch mode, enter:
dsmadmc server_command
If you do not want to be prompted for your user ID and password, you can enter
the DSMADMC command with the -ID and -PASSWORD options.
In batch mode, you must enter the complete command on one line. If a command
does not fit on one line, enter the command by using a macro or a script. If you
specify a parameter with a string of text using batch mode, enclose the text in
single quotation marks ( ) in the macro. Do not use double quotes for commands
in batch mode, because your operating system might not parse the quotes correctly.
You can bypass this batch mode double quote restriction for Windows clients by
using the backslash (\) escape character. For example, on the OBJECTS parameter
of the DEFINE CLIENTACTION command, you could enter the string with the \
character preceding the double quotes in the command.
dsmadmc -id=admin -password=admin define clientaction test_node domain=test_dom
action=restore objects=\"C:\program files\test\*\"
Processing a series of commands from the administrative
client
Use the interactive mode to process a series of administrative commands.
To start an administrative client session in interactive mode, a server session must
be available. To ensure the availability of server sessions for both administrative
and client node sessions, the interactive mode of the administrative client is
disconnected if one or more of the following conditions is true:
v The server was stopped using the HALT command.
v Commands were not issued from the administrative client session for the length
of time specified with the IDLETIMEOUT server option.
v The administrative client session was canceled with the CANCEL SESSION
command.

Chapter 1. Administering the server from the command line 3
|
You can use continuation characters when using interactive mode. For more
information, see Entering long commands on page 11.
To start an administrative session in interactive mode, enter:
dsmadmc
Do not enter a server command with the DSMADMC command. Doing so will
start the administrative client in batch, not interactive, mode. For example, do not
enter:
dsmadmc server_command
You can automatically restart your administrative client session by entering
another command each time the tsm: servername > prompt appears.
Formatting output from commands
Tivoli Storage Manager formats the output processed from commands according to
your screen or window width.
If the width of your screen or window is not wide enough to display the output
horizontally, Tivoli Storage Manager arranges and displays the information
vertically.
You can format the output of QUERY commands using the DISPLAYMODE and
OUTFILE administrative client options.
Saving command output to a specified location
The most common use for redirecting output is to save the output from query
commands to a specified file or program. You can then browse the contents of the
file or, in some cases, print the contents.
Some platforms support redirection of output using special characters like >, >>,
and |. You can save the output from a command by entering redirection characters
at the end of the command. Redirection characters direct the output of a command
to a file or program you specify instead of to your screen. To redirect output, leave
a blank between the redirection character and the file or program name See the
examples below.
Note: When redirecting output, follow the naming conventions of the operating
system running your administrative client.

If you want to: Enter this:
Redirect the output of a
QUERY DOMAIN command to
a new file in batch or
interactive mode
dsmadmc -id=xxx -pa=xxx query domain acctg dominfo.acc
A single greater-than sign (>) indicates that Tivoli Storage Manager redirects the
output to a new file or writes over an existing file.
Append the output of a
QUERY DOMAIN command to
the end of an existing file in
batch or interactive mode
dsmadmc -id=xxx -pa=xxx query domain acctg >> dominfo.acc
Double greater-than signs (>>) indicates that Tivoli Storage Manager appends the
output to the end of an existing file.
Redirect all output from an
administrative client session in
console mode to a program
called filter.exe
dsmadmc -console -id=admin -password=xxx | filter.exe
The program can be set up to monitor the output for individual messages as they
occur and take appropriate action, such as sending mail to another user.


4 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
You can also redirect all output to a specified file by specifying the -OUTFILE
option with a destination file name. For example, enter:
dsmadmc -id=sullivan -password=secret -consolemode -outfile=save.out
Administrative client options
In all administrative client modes, you can use options to modify administrative
client session responses.
DSMADMC

DSMADMC

admin_client_option

server_command

Here is an example of a task and how to use the administrative client options: You
can enter the DSMADMC command with your user ID and password by using the
-ID and -PASSWORD options, respectively if you do not want to be prompted for
that information. To have Tivoli Storage Manager redirect all output to a file,
specify the -OUTFILE option with a destination file name. For example, to issue
the QUERY NODE command in batch mode with the output redirected to the
SAVE.OUT file, enter:
dsmadmc -id=sullivan -password=secret -outfile=save.out query node
Options
Administrative client options can be specified with the DSMADMC command and
are valid from an administrative client session only. You can type an option in
uppercase letters, lowercase letters, or any combination. Uppercase letters denote
the shortest acceptable abbreviation. If an option appears entirely in uppercase
letters, you cannot abbreviate it.
-ALWAYSPrompt
Specifies that a command prompt is displayed if the input is from the
keyboard or if it is redirected (for example, from a file). If this option is not
specified and the input is redirected, the command prompt is not written.
If the input is redirected, only the command output is displayed. If this option
is specified, the command prompt and the command output are displayed.
-CHECKAliashalt
Allows the administrative client to recognize an alias for the HALT command
as set in the ALIASHALT server option. See ALIASHALT on page 1277 for
details.
-COMMAdelimited
Specifies that any tabular output from a server query is to be formatted as
comma-separated strings rather than in readable format. This option is
intended to be used primarily when redirecting the output of an SQL query
(SELECT command). The comma-separated value format is a standard data
format, which can be processed by many common programs, including
spreadsheets, data bases, and report generators.
-CONsolemode
Specifies that Tivoli Storage Manager runs in console mode. All server console

Chapter 1. Administering the server from the command line 5
|
output is echoed to your screen, excluding items such as responses to query
commands issued from the console, trace output, or any system messages that
might appear on the console.
-DISPLaymode=LISt or TABle
Allows you to force the QUERY output to tabular or list format regardless of
the command line window column width.
If you are using the -DISPLAYMODE option and you want the output to go to
a file, do not specify the -OUTFILE option. Use redirection to write to the file.
-ID=userid
Specifies the administrators user ID.
-Itemcommit
Specifies that Tivoli Storage Manager commits commands inside a script or a
macro as each command is processed.
-MOUNTmode
Specifies that Tivoli Storage Manager runs in mount mode. All server
removable-media mount messages are echoed to your screen.
-NEWLINEAFTERPrompt
Specifies that a newline character is written immediately after the command
prompt and commands entered from the keyboard appear immediately below
the prompt. If this option is not specified, commands entered from the
keyboard appear immediately to the right of the prompt.
-NOConfirm
Specifies that you do not want Tivoli Storage Manager to request confirmation
before processing commands that affect the availability of the server or data
managed by the server.
-OUTfile
Specifies that output from a server query is formatted one line per query. This
option is available in batch mode only.
-OUTfile=filename
Specifies that output from a server query is redirected to a specified file. In
batch mode, output is redirected to a file you specify and the format of the
output matches the format of the output on your screen.
In interactive, console, or mount mode sessions, output displays on your
screen.
-PAssword=password
Specifies the administrators password.
-Quiet
Specifies that Tivoli Storage Manager does not display standard output
messages to your screen. However, when you use this option, certain error
messages still appear.
-TABdelimited
Specifies that any tabular output from a server query is to be formatted as
tab-separated strings rather than in readable format. This option is intended to
be used primarily when redirecting the output of an SQL query (SELECT
command). The tab-separated value format is a standard data format, which
can be processed by many common programs, including spreadsheets,
databases, and report generators.
-TCPPort
Specifies a TCP/IP port address for a Tivoli Storage Manager server.

6 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
-TCPServeraddress
Specifies a TCP/IP server address for a Tivoli Storage Manager server.
Besides the options listed here, you can also specify any option that is in the client
options file. Each option must be preceded with a hyphen and delimited with a
space.
Issuing commands from the Administration Center
A command-line interface is available from all of the main server tables in the
Administration Center. To access the command line, select a server, click Select
Action, and select Use Command Line.
Issuing commands from the server console
Tivoli Storage Manager provides a user ID named SERVER_CONSOLE that allows
you to issue commands and administer the server from the server console after
Tivoli Storage Manager is installed. At installation, SERVER_CONSOLE is
automatically registered as an administrator and is given system authority.
If you have system privilege, you can revoke or grant new privileges to the
SERVER_CONSOLE user ID. However, you cannot:
v Register or update the SERVER_CONSOLE user ID
v Lock or unlock the SERVER_CONSOLE user ID
v Rename the SERVER_CONSOLE user ID
v Remove SERVER_CONSOLE user ID
v Route commands from the SERVER_CONSOLE user ID
Note: Not all Tivoli Storage Manager commands are supported by the server
console. You cannot specify the WAIT parameter from the server console.
Entering administrative commands
Commands consist of command names and usually parameters and variables.
Syntax diagrams depict the rules to follow when entering commands.
Reading syntax diagrams
To read a syntax diagram for entering a command, follow the path of the line.
Read from left to right and from top to bottom.
v The symbol indicates the beginning of a syntax diagram.
v The symbol at the end of a line indicates that the syntax diagram continues
onto the next line.
v The symbol at the beginning of a line indicates that a syntax diagram
continues from the previous line.
v The symbol indicates the end of a syntax diagram.
Command names
The command name can consist of a single action word, such as HALT, or it can
consist of an action word and an object for the action, such as DEFINE DOMAIN.
You can enter the command in any column of the input line.

Chapter 1. Administering the server from the command line 7
Enter the entire command name or the abbreviation that is specified in the syntax
diagram for the command. Uppercase letters denote the shortest acceptable
abbreviation. If a command appears entirely in uppercase letters, you cannot
abbreviate it. You can enter the command in uppercase letters, lowercase letters, or
any combination. In this example, you can enter CMDNA, CMDNAM, or
CMDNAME in any combination of uppercase and lowercase letters.
CMDNAme

Note: Command names in descriptive text are always capitalized.
Required parameters
When a parameter is on the same line as the command name, the parameter is
required. When two or more parameter values are in a stack and one of them is on
the line, you must specify one value.
In this example, you must enter PARMNAME=A, PARMNAME=B, or
PARMNAME=C. Do not include any blanks immediately before or after the equal
sign (=).
PARMName = A
B

C


Optional parameters
When a parameter is below the line, the parameter is optional. In this example,
you can enter PARMNAME=A or nothing at all. Do not include any blanks
immediately before or after the equal sign (=).

PARMName

=

A


When two or more parameter values are in a stack below the line, all of them are
optional. In this example, you can enter PARMNAME=A, PARMNAME=B,
PARMNAME=C, or nothing at all. Do not include any blanks immediately before
or after the equal sign (=).

PARMNAme

=

A

B

C


Defaults
Defaults are above the line. The system uses the default unless you override it. You
can override the default by entering an option from the stack below the line.
In this example, PARMNAME=A is the default. You can also enter
PARMNAME=A, PARMNAME=B, or PARMNAME=C. Do not include any blanks
before or after the equal sign (=).

8 IBM Tivoli Storage Manager for Windows: Administrators Reference

PARMNAme = A
PARMName

=

A

B

C

Variables
Highlighted lowercase items (like this) denote variables. In these examples,
var_name represents variables::
CMDNAme var_name

PARMname

=

var_name


Special characters
You must code these symbols exactly as they appear in the syntax diagram.
* Asterisk
: Colon
, Comma
= Equal Sign
- Hyphen
( ) Parentheses
. Period
Repeating values
An arrow returning to the left means that the item can be repeated. A character
within the arrow means that you must separate repeated items with that character.

,
file_name

Repeatable choices
A stack of values followed by an arrow returning to the left means that you can
select more than one value or, when permitted, repeat a single item. In this
example, you can choose more than one value, with each name delimited with a
comma. Do not include any blanks before or after the equal sign (=).

,
PARMNAme

=

value1

value2

value3

Chapter 1. Administering the server from the command line 9
Footnotes
Footnotes are enclosed in parentheses.

,
(1)

file_name

Notes:
1 You can specify up to five file names.
Entering parameters
The order in which you enter parameters can be important. The example below
shows a portion of the command for defining a copy storage pool:
DEFine STGpool pool_name device_class_name POoltype = COpy

DESCription

=

description
REClaim = 100
REClaim

=

percent

The first two parameters in this command (pool_name and device_class_name are
required parameters. pool_name and device_class_name are also positional. That is,
they must be entered in the order shown, immediately after the command name.
The POOLTYPE parameter is a required keyword parameter. DESCRIPTION and
RECLAIM, are optional keyword parameters. Keyword parameters are identified
by an equal sign that specifies a specific value or a variable. Keyword parameters
must follow any positional parameters in a command.
The following command entries, in which the keyword parameters are ordered
differently, are both acceptable:
define stgpool mycopypool mydeviceclass pooltype=copy description=engineering
reclaim=50
define stgpool mycopypool mydeviceclass description=engineering pooltype=copy
reclaim=50
The following example, in which one of the positional parameters follows a
keyword parameter, is not acceptable:
define stgpool mycopypool pooltype=copy mydeviceclass description=engineering
reclaim=50
Syntax fragments
Some diagrams, because of their length, must display parts of the syntax with
fragments. The fragment name appears between vertical bars in the diagram.
The expanded fragment appears in the diagram after all other parameters or at the
bottom of the diagram. A heading with the fragment name identifies the expanded
fragment. Commands appearing directly on the line are required.
In this example, the fragment is named Fragment.

10 IBM Tivoli Storage Manager for Windows: Administrators Reference
Fragment

Fragment:
A
B

C


Entering long commands
Continuation characters are useful when you want to process a command that is
longer than your screen or window width. You can use continuation characters in
the interactive mode of the administrative client.
Without continuation characters you can enter up to 256 characters. With
continuation characters you can enter up to 1500 characters.
Note: In the MACRO command, the maximums apply after any substitution
variables have been applied.
With continuation characters, you can do the following:
v Enter a dash at the end of the line you want to continue.
For example:
register admin pease mypasswd -
contact="david, ext1234"
v Continue a list of values by entering a dash or a back slash, with no preceding
blank spaces, after the last comma of the list that you enter on the first line.
Then, enter the remaining items in the list on the next line with no preceding
blank spaces. For example:
stgpools=stg1,stg2,stg3,-
stg4,stg5,stg6
v Continue a string of values enclosed in quotation marks by entering the first
part of the string enclosed in quotation marks, followed by a dash or a back
slash at the end of the line. Then, enter the remainder of the string on the next
line enclosed in the same type of quotation marks.
For example:
contact="david pease, bldg. 100, room 2b, san jose,"-
"ext. 1234, alternate contact-norm pass,ext 2345"
Tivoli Storage Manager concatenates the two strings with no intervening blanks.
You must use only this method to continue a quoted string of values across more
than one line.


Chapter 1. Administering the server from the command line 11
Naming Tivoli Storage Manager objects
Tivoli Storage Manager restricts the number and type of characters that you can
use to name objects.
The following characters are available for defining object names.

Character Description
AZ Any letter, A through Z
09 Any number, 0 through 9
_ Underscore
. Period
- Hyphen
+ Plus
& Ampersand

The following table shows the maximum length of characters permitted for naming
objects.

Type of Name Maximum Length
Administrators, client option sets, client nodes,
passwords, server groups, server, names, virtual file
space names
64
Restartable export identifiers 64
High-level and low-level TCP/IP (IPv4 or IPv6)
addresses
64
Device classes, drives, libraries, management classes,
policy domains, profiles, schedules scripts, backup
sets, storage pools
30

When you use DEFINE commands to define database, recovery log, and storage
pool volumes, the naming convention for the volume name is dependent on the
type of sequential access media or random access media you are using. Refer to
the specific VOLUME command for details.
Using wildcard characters to specify object names
In some commands, such as the query commands, you can use wildcard characters
to create a pattern-matching expression that specifies more than one object. Using
wildcard characters makes it easier to tailor a command to your needs.
The wildcard characters you use depend on the operating system from which you
issue commands. For example, you can use wildcard characters such as an asterisk
(*) to match any (0 or more) characters, or you can use a question mark (?) or a
percent sign (%) to match exactly one character.
Table 2 on page 13 provides references to wildcard characters for some operating
systems. Use wildcard characters appropriate for your system.

12 IBM Tivoli Storage Manager for Windows: Administrators Reference
||
|
|
|
Table 2. Wildcard characters by operating system
Operating system Match any Match exactly one
AIX

, HP-UX, Linux, OS/2

, Sun
Solaris, Windows
* ?
TSO * %

For example, if you want to query all the management classes whose names begin
with DEV in all the policy sets in DOMAIN1, and your system uses an asterisk as
the match-any character, you can enter:
query mgmtclass domain1 * dev*
If your system uses a question mark as the match-exactly-one character, and you
want to query the management classes in POLICYSET1 in DOMAIN1, you can
enter:
query mgmtclass domain1 policyset1 mc?
Tivoli Storage Manager displays information about management classes with
names MC.
Table 3 shows additional examples of using wildcard characters to match any
characters.
Table 3. Match-any character
Pattern Matches Does not match
ab* ab, abb, abxxx a, b, aa, bb
ab*rs abrs, abtrs, abrsrs ars, aabrs, abrss
ab*ef*rs abefrs, abefghrs abefr, abers

Table 4 shows additional examples of using wildcard characters to match exactly
one character. The question mark (?) can be replaced by a percent sign (%) if your
platform uses that character instead of (?).
Table 4. Match-exactly-one character
Pattern Matches Does not match
ab? abc ab, abab, abzzzz
ab?rs abfrs abrs, abllrs
ab?ef?rs abdefjrs abefrs, abdefrs, abefjrs
ab??rs abcdrs, abzzrs abrs, abjrs, abkkkrs



Chapter 1. Administering the server from the command line 13
||
|||
|
|
||
|||
|
Specifying descriptions in keyword parameters
If a description (a string of text) for a parameter begins with a single or double
quote, or contains any embedded blanks or equal signs, you must surround the
value with either single () or double () quotation marks.
The opening and closing quotation marks must be the same type of quotation
marks. For example, if the opening quotation is a single quotation mark, the
closing quotation mark must also be a single quotation mark.
For example, to register a new client node named Louie, with a password of secret,
and with his title included as contact information, enter:
register node louie secret contact="manager of dept. 61f"
The following table presents ways of entering a description for the CONTACT
parameter. The value can contain quotation marks, embedded blanks, or equal
signs.

For this description Enter this
manager contact=manager
managers contact=managers or contact=managers
manager contact=manager or contact=manager
managers report contact=managers report or contact=managers
report
managers report contact=managers report
manager=dept. 61f contact=manager=dept. 61f
manager reports to dept. 61f contact=manager reports to dept. 61f or
contact=manager reports to dept. 61f

Controlling command processing
You can run some Tivoli Storage Manager commands sequentially or concurrently
with other commands. You can also route commands from one server to other
servers for processing.
Server command processing
Tivoli Storage Manager processes administrator commands either in the foreground
or in the background. Commands that process in the foreground must complete
before you can issue another command. When commands are processing in the
background, you can issue additional commands at any time.
Most Tivoli Storage Manager commands process in the foreground. For some
commands that normally process in the background (for example, BACKUP DB),
you can specify the WAIT parameter (WAIT=YES) with the command so that the
command processes in the foreground. You might want to process a command in
the foreground rather than in the background for any of the following reasons:
v To quickly determine whether a command completed successfully. When you
issue a command that processes in the foreground, Tivoli Storage Manager sends
a confirmation message indicating that the command completed successfully. If
you process the command in the background, you need to open operational
reporting or query the activity log to determine whether the command
completed successfully.

14 IBM Tivoli Storage Manager for Windows: Administrators Reference
v To monitor server activities (for example, messages) on the administrative client
as a command is being processed. This might be preferable to searching a long
activity log after the command has completed.
v To be able to start another process immediately after a command has
completed. For example, you might specify WAIT=YES for a command that
takes a short time to process so that, when the processing completes, you can
immediately start processing another command .
v To serialize commands in an administrative script when it is important that one
command completes before another begins.
Check the individual command description to determine whether a command has
a WAIT parameter.
You can cancel commands that are processed in the foreground from the server
console or from another administrative client session.
Each background process is assigned a process number. Use the QUERY PROCESS
command to obtain the status and process number of a background process.
Note:
v If you are defining a schedule with a command that specifies WAIT=NO
(the default), and you issue QUERY EVENT to determine the status of
your scheduled operation, failed operations will report an event status of
COMPLETED with a return of OK. In order for the QUERY EVENT
output to reflect the failed status, the WAIT parameter must be set to YES.
This will run the scheduled operation in the foreground and inform you
of the status when it completes.
v You cannot process commands in the foreground from the server console.
Cancelling commands
Use the CANCEL PROCESS command to cancel commands that generate
background processes.
Use the QUERY PROCESS command to obtain the status and process number of a
background process. If a background process is active when you cancel it, the
server stops the process. Any changes that are uncommitted are rolled back.
However, changes that are committed are not rolled back.
Note: When you issue a QUERY command from the administrative client, multiple
screens of output might be generated. If this occurs and additional output is
not needed, you can cancel the display of output to the client workstation.
Doing so does not end the processing of the command.
Performing tasks concurrently on multiple servers
Command routing allows you to route commands to one or more servers for
processing and then collect the output from these servers.
To route commands to other servers, you must have the same administrator ID
and password as well as the required administrative authority on each server to
which the command is being routed. You cannot route commands to other servers
from the server console.

Chapter 1. Administering the server from the command line 15
After the command has completed processing on all servers, the output displays,
in its entirety, for each server. For example, the output from SERVER_A displays in
its entirety, followed by the output from SERVER_B. The output includes summary
messages for each individual server and identifies which server processed the
output. Return codes indicate whether commands processed on the servers
successfully. These return codes include one of three severities: 0, ERROR, or
WARNING.
Each server that is identified as the target of a routed command must first be
defined using the DEFINE SERVER command. The command is automatically
routed to all servers specified as members of a server group or to individual
servers specified with the command. For details about setting up and managing
multiple servers for command routing, see the Administrators Guide.
The following examples describe how to route the QUERY STGPOOL command to
one server, multiple servers, a server group, multiple server groups, or a
combination of servers and server groups. Each server or server group in a list
must be separated with a comma, without spaces.
Routing commands to a single server
To route the QUERY STGPOOL command to a server named ASTRO, enter:
astro: query stgpool
The colon after the server name indicates the end of the routing information. This
is also called the server prefix. Another way to indicate the end of routing
information is to use parentheses around the server name, for example:
(astro) query stgpool
Routing commands to multiple servers
To route the QUERY STGPOOL command to multiple servers named HD_QTR,
MIDAS, SATURN, enter:
hd_qtr,midas,saturn: query stgpool
If the first server has not been defined to Tivoli Storage Manager, the command is
routed to the next defined server in the list of servers.
You can also enter the command this way:
(hd_qtr,midas,saturn) query stgpool
Routing commands to a server group
In this example, the server group ADMIN has servers named SECURITY,
PAYROLL, PERSONNEL defined as group members. The command is routed to
each of these servers.
To route the QUERY STGPOOL command to the server group named ADMIN,
enter:
admin: query stgpool
You can also enter the command this way:
(admin) query stgpool


16 IBM Tivoli Storage Manager for Windows: Administrators Reference
Routing commands to server groups
In this example, the server group ADMIN2 has servers SERVER_A, SERVER_B,
and SERVER_C defined as group members, and server group ADMIN3 has servers
ASTRO, GUMBY, and CRUSTY defined as group members. The command is
routed to servers SERVER_A, SERVER_B, SERVER_C, ASTRO, GUMBY, and
CRUSTY.
To route the QUERY STGPOOL command to two server groups that are named
ADMIN2 and ADMIN3, enter:
admin2,admin3: query stgpool
You can also enter the command this way:
(admin2,admin3) query stgpool
Routing commands to two servers and a server group
In this example, the server group DEV_GROUP has servers SALES, MARKETING,
and STAFF defined as group members. The command is routed to servers SALES,
MARKETING, STAFF, MERCURY, and JUPITER.
To route the QUERY STGPOOL command to a server group named DEV_GROUP
and to the servers named MERCURY and JUPITER, enter:
dev_group,mercury,jupiter: query stgpool
You can also enter the command this way:
(dev_group,mercury,jupiter) query stgpool
Routing commands inside scripts
When routing commands inside scripts, you must enclose the server or server
group in parentheses and omit the colon. Otherwise, the command will not be
routed when the RUN command is issued, and will only be run on the server
where the RUN command is issued.
For example, to route the QUERY STGPOOL command inside a script:
1. Define a script called QU_STG to route it to the DEV_GROUP server group.
define script qu_stg "(dev_group) query stgpool"
2. Run the QU_STG script:
run qu_stg
In this example, the server group DEV_GROUP has servers SALES, MARKETING,
and STAFF defined as group members. The QUERY STGPOOL command is routed
to these servers.

Chapter 1. Administering the server from the command line 17
Privilege classes for commands
The authority granted to an administrator through the privilege class determines
which administrative commands that the administrator can issue.
There are five administrator privilege classes in Tivoli Storage Manager:
v System
v Policy
v Storage
v Operator
v Analyst
After an administrator has been registered via the REGISTER ADMIN command,
the administrator can issue a limited set of commands, including all query
commands. When you install Tivoli Storage Manager, the server console is defined
as a system administrator named SERVER_CONSOLE and is granted system
privilege.
The following sections describe each type of administrator privilege and the
commands that can be issued by an administrator who has been granted the
corresponding authority.
Commands requiring system privilege
An administrator with system privilege has the highest level of authority in Tivoli
Storage Manager. With system privilege, an administrator can issue any
administrative command and has authority to manage all policy domains and all
storage pools.
Table 5 on page 19 lists the commands that administrators with system privilege
can issue. In some cases administrators with lower levels of authority, for example,
unrestricted storage privilege, can also issue these commands. In addition, the
REQSYSAUTHOUTFILE server option can be used to specify that certain
commands require system privilege if they cause Tivoli Storage Manager to write
to an external file. For more information about this server option see
REQSYSAUTHOUTFILE on page 1319.

18 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 5. System privilege commands
Command Name Command Name
v AUDIT LICENSES
v ACCEPT DATE
v BEGIN EVENTLOGGING
v CANCEL EXPIRATION
v CANCEL PROCESS
v CANCEL REQUEST
v CANCEL RESTORE
v CLEAN DRIVE
v CONVERT ARCHIVE
v COPY ACTIVEDATA
v COPY DOMAIN
v COPY POLICYSET
v COPY PROFILE
v COPY SCHEDULE (See note.)
v COPY SCRIPT
v COPY SERVERGROUP
v DEFINE BACKUPSET
v DEFINE CLIENTACTION
v DEFINE CLIENTOPT
v DEFINE CLOPTSET
v DEFINE COLLOCGROUP
v DEFINE COLLOCMEMBER
v DEFINE DEVCLASS
v DEFINE DOMAIN
v DEFINE DRIVE
v DEFINE EVENTSERVER
v DEFINE GRPMEMBER
v DEFINE LIBRARY
v DEFINE MACHINE
v DEFINE MACHNODEASSOCIATION
v DEFINE NODEGROUP
v DEFINE NODEGROUPMEMBER
v DEFINE PATH
v DEFINE PROFASSOCIATION
v DEFINE PROFILE
v DEFINE RECMEDMACHASSOCIATION
v DEFINE RECOVERYMEDIA
v DEFINE SCHEDULE (See note.)
v DEFINE SCRIPT
v DEFINE SERVER
v DEFINE SERVERGROUP
v DEFINE SPACETRIGGER
v DEFINE STGPOOL
v DEFINE SUBSCRIPTION
v DEFINE VIRTUALFSMAPPING
v DEFINE VOLUME
v DELETE BACKUPSET
v DELETE DBBACKUPTRIGGER
v DELETE CLIENTOPT
v DELETE CLOPTSET
v DEFINE COLLOCGROUP
v DEFINE COLLOCMEMBER
v DELETE DOMAIN
v DELETE DRIVE
v DELETE EVENTSERVER
v DELETE GRPMEMBER
v DELETE LIBRARY
v DELETE MACHINE
v DELETE MACHNODEASSOCIATION
v DELETE NODEGROUP
v DELETE NODEGROUPMEMBER
v DELETE PROFILE
v DELETE RECMEDMACHASSOCIATION
v DELETE RECOVERYMEDIA
v DELETE SCHEDULE (See note.)
v DELETE SCRIPT
v DELETE SERVER
v DELETE SERVERGROUP
v DELETE SPACETRIGGER
v DELETE STGPOOL
v DELETE SUBSCRIBER
v DELETE SUBSCRIPTION
v DELETE VIRTUALFSMAPPING
v DISABLE EVENTS
v ENABLE EVENTS
v END EVENTLOGGING
v ESTIMATE DBREORGSTATS
v EXPIRE INVENTORY
v EXPORT ADMIN
v EXPORT NODE
v EXPORT POLICY
v EXPORT SERVER
v GENERATE BACKUPSET
v GRANT AUTHORITY
v GRANT PROXYNODE
v IMPORT ADMIN
v IMPORT NODE
v IMPORT POLICY
v IMPORT SERVER
v INSERT MACHINE
v LABEL LIBVOLUME
v LOCK ADMIN
v LOCK PROFILE
v MIGRATE STGPOOL
v MOVE DRMEDIA
v MOVE MEDIA
v MOVE GRPMEMBER
v NOTIFY SUBSCRIBERS
v PING SERVER
v PREPARE
v QUERY BACKUPSETCONTENTS
v QUERY MEDIA
v QUERY RPFCONTENT
v QUERY TOC
v RECLAIM STGPOOL
v RECONCILE VOLUMES
v REGISTER ADMIN
v REGISTER LICENSE
v REMOVE ADMIN
v RENAME ADMIN
v RENAME SCRIPT
v RENAME SERVERGROUP
v RENAME STGPOOL
v RESET PASSEXP
v RESTORE NODE
v REVOKE AUTHORITY

Chapter 1. Administering the server from the command line 19
Table 5. System privilege commands (continued)
Command Name Command Name
v REVOKE PROXYNODE
v RUN
v SET ACCOUNTING
v SET ACTLOGRETENTION
v SET ARCHIVERETENTIONPROTECTION
v SET AUTHENTICATION
v SET CLIENTACTDURATION
v SET CONFIGMANAGER
v SET CONFIGREFRESH
v SET CONTEXTMESSAGING
v SET CROSSDEFINE
v SET DRMCHECKLABEL
v SET DRMCMDFILENAME
v SET DRMCOPYSTGPOOL
v SET DRMCOURIERNAME
v SET DRMDBBACKUPEXPIREDAYS
v SET DRMFILEPROCESS
v SET DRMINSTRPREFIX
v SET DRMNOTMOUNTABLENAME
v SET DRMPLANPREFIX
v SET DRMPLANVPOSTFIX
v SET DRMPRIMSTGPOOL
v SET DRMRPFEXPIREDAYS
v SET DRMVAULTNAME
v SET EVENTRETENTION
v SET INVALIDPWLIMIT
v SET LICENSEAUDITPERIOD
v SET LOGMODE
v SET MAXCMDRETRIES
v SET MAXSCHEDSESSIONS
v SET MINPWLENGTH
v SET PASSEXP
v SET QUERYSCHEDPERIOD
v SET RANDOMIZE
v SET REGISTRATION
v SET RETRYPERIOD
v SET SCHEDMODES
v SET SERVERHLADDRESS
v SET SERVERLLADDRESS
v SET SERVERNAME
v SET SERVERPASSWORD
v SET SUBFILE
v SET TOCLOADRETENTION
v SETOPT
v UNLOCK ADMIN
v UNLOCK PROFILE
v UPDATE ADMIN
v UPDATE BACKUPSET
v UPDATE CLIENTOPT
v UPDATE CLOPTSET
v UPDATE COLLOCGROUP
v UPDATE DEVCLASS
v UPDATE DRIVE
v UPDATE LIBRARY
v UPDATE LIBVOLUME
v UPDATE MACHINE
v UPDATE NODEGROUP
v UPDATE PATH
v UPDATE PROFILE
v UPDATE RECOVERYMEDIA
v UPDATE SCHEDULE (See note.)
v UPDATE SCRIPT
v UPDATE SERVER
v UPDATE SERVERGROUP
v UPDATE SPACETRIGGER
v UPDATE VIRTUALFSMAPPING
v UPDATE VOLHISTORY
v VALIDATE LANFREE
Note: This command is restricted by the authority granted to an administrator. System
privilege is required only for administrative command schedules. System or policy privilege
is required for client operation schedules.

Commands requiring policy privilege
An administrator with policy privilege can issue commands that relate to policy
management objects such as policy domains, policy sets, management classes, copy
groups, and schedules. The policy privilege can be unrestricted, or can be restricted
to specific policy domains.
Unrestricted policy privilege permits you to issue all of the administrator
commands that require policy privilege. You can issue commands that affect all
existing policy domains as well as any policy domains that are defined in the
future. An unrestricted policy administrator cannot define, delete, or copy policy
domains.
Restricted policy privilege permits you to issue administrator commands that affect
one or more policy domains for which you have been explicitly granted authority.

20 IBM Tivoli Storage Manager for Windows: Administrators Reference
For example, the DELETE MGMTCLASS command requires you to have policy
privilege for the policy domain to which the management class belongs.
Table 6 lists the commands that an administrator with policy privilege can issue.
Table 6. Policy privilege commands
Command Name Command Name
v ACTIVATE POLICYSET
v ASSIGN DEFMGMTCLASS
v CLEAN DRIVE
v CONVERT ARCHIVE
v BACKUP NODE
v COPY MGMTCLASS
v COPY POLICYSET
v COPY SCHEDULE (See note 2.)
v DEFINE ASSOCIATION
v DEFINE BACKUPSET
v DEFINE COPYGROUP
v DEFINE CLIENTACTION
v DEFINE CLIENTOPT
v DEFINE MGMTCLASS
v DEFINE NODEGROUP
v DEFINE NODEGROUPMEMBER
v DEFINE POLICYSET
v DEFINE SCHEDULE
v DELETE ASSOCIATION
v DELETE BACKUPSET
v DELETE COPYGROUP
v DELETE EVENT (See note 1.)
v DELETE FILESPACE
v DELETE MGMTCLASS
v DELETE NODEGROUP
v DELETE NODEGROUPMEMBER
v DELETE POLICYSET
v DELETE PATH
v DELETE PROFASSOCIATION
v DELETE SCHEDULE (See note 2.)
v GENERATE BACKUPSET
v LOCK NODE
v QUERY BACKUPSETCONTENTS
v REGISTER NODE
v REMOVE NODE
v RENAME FILESPACE
v RENAME NODE
v SET SUMMARYRETENTION
v RESTORE NODE
v QUERY TOC
v UNDO ARCHCONVERSION (See note 1.)
v UNLOCK NODE
v UPDATE ARCHIVE (See note 1.)
v UPDATE BACKUPSET
v UPDATE COPYGROUP
v UPDATE DOMAIN
v UPDATE MGMTCLASS
v UPDATE NODE
v UPDATE NODEGROUP
v UPDATE POLICYSET
v UPDATE SCHEDULE (See note 2.)
v VALIDATE POLICYSET
Notes:
1. This command can be restricted by policy domain. An administrator with unrestricted
policy privilege or restricted policy privilege for a specified policy domain can issue this
command.
2. This command is restricted by the authority granted to an administrator. System
privilege is required only for administrative command schedules. System or policy
privilege is required for client operation schedules.

Commands requiring storage privilege
An administrator with storage privilege can issue commands that allocate and
control storage resources for the server. The storage privilege can be unrestricted,
or can be restricted to specific storage pools.
Unrestricted storage privilege permits you to issue all of the administrator
commands that require storage privilege. You can issue commands that affect all
existing storage pools as well as any storage pools that are defined in the future.
You can also issue commands that affect the database and the recovery log. An
unrestricted storage administrator cannot define or delete storage pools.
Restricted storage privilege permits you to issue administrator commands that only
affect a storage pool for which you have been granted authority. For example, the
DELETE VOLUME command only affects a storage pool volume that is defined to
a specific storage pool.

Chapter 1. Administering the server from the command line 21
Table 7 lists the commands an administrator with storage privilege can issue.
Table 7. Storage privilege commands
Command Name Command Name
v AUDIT LIBRARY
v AUDIT VOLUME (See note.)
v BACKUP DB
v BACKUP DEVCONFIG
v BACKUP STGPOOL
v BACKUP VOLHISTORY
v CHECKIN LIBVOLUME
v CHECKOUT LIBVOLUME
v COPY ACTIVEDATA (See note.)
v DEFINE COLLOCGROUP
v DEFINE COLLOCMEMBER
v DEFINE DATAMOVER
v DEFINE DBBACKUPTRIGGER
v DEFINE DBCOPY
v DEFINE DBVOLUME
v DEFINE DEVCLASS
v DEFINE DRIVE
v DEFINE LIBRARY
v DEFINE LOGCOPY
v DEFINE LOGVOLUME
v DEFINE PATH
v DEFINE VIRTUALFSMAPPING
v DEFINE VOLUME (See note.)
v DEFINE SPACETRIGGER
v DELETE COLLOCGROUP
v DELETE COLLOCMEMBER
v DELETE DATAMOVER
v DELETE DBBACKUPTRIGGER
v DELETE DBVOLUME
v DELETE DEVCLASS
v DELETE DRIVE
v DELETE LIBRARY
v DELETE LOGVOLUME
v DELETE PATH
v DELETE SPACETRIGGER
v DELETE VIRTUALFSMAPPING
v DELETE VOLHISTORY
v DELETE VOLUME (See note.)
v EXTEND DB
v EXTEND LOG
v GRANT PROXYNODE
v LABEL LIBVOLUME
v MIGRATE STGPOOL
v MOVE DATA (See note.)
v MOVE MEDIA
v QUERY TAPEALERTMSG
v RECLAIM STGPOOL
v REDUCE DB
v REDUCE LOG
v RESTORE STGPOOL
v RESTORE VOLUME
v REVOKE PROXYNODE
v SET LOGMODE
v SET TAPEALERTMSG
v UPDATE COLLOCGROUP
v UPDATE DATAMOVER
v UPDATE DBBACKUPTRIGGER
v UPDATE DEVCLASS
v UPDATE DRIVE
v UPDATE LIBRARY
v UPDATE PATH
v UPDATE SPACETRIGGER
v UPDATE STGPOOL (See note.)
v UPDATE VIRTUALFSMAPPING
Note: This command can be restricted by storage pool. An administrator with unrestricted
storage privilege or restricted storage privilege for a specified storage pool can issue this
command.

Commands requiring operator privilege
An administrator with operator privilege can issue commands that control the
immediate operation of the server and the availability of storage media.
Table 8 lists the commands an administrator with operator privilege can issue.
Table 8. Operator privilege commands
Command Name Command Name
v CANCEL SESSION
v DISABLE SESSIONS
v DISMOUNT VOLUME
v ENABLE SESSIONS
v HALT
v MOVE DRMEDIA
v MOVE MEDIA
v QUERY MEDIA
v REPLY
v UPDATE VOLUME
v VARY

22 IBM Tivoli Storage Manager for Windows: Administrators Reference
Commands requiring analyst privilege
An administrator with analyst privilege can issue commands that reset the
counters that track server statistics.
Table 9 lists the commands an administrator with analyst privilege can issue.
Table 9. Analyst privilege commands
Command Name Command Name
v RESET BUFPOOL
v RESET DBMAXUTILIZATION
v RESET LOGCONSUMPTION
v RESET LOGMAXUTILIZATION

Commands any administrator can issue
A limited number of commands can be used by any administrator, even if that
administrator has not been granted any specific administrator privileges.

Chapter 1. Administering the server from the command line 23
Table 10 lists the commands any registered administrator can issue.
Table 10. Commands issued by all administrators
Command Name Command Name
v COMMIT
v HELP
v ISSUE MESSAGE
v MACRO
v PARALLEL
v QUERY ACTLOG
v QUERY ADMIN
v QUERY ASSOCIATION
v QUERY AUDITOCCUPANCY
v QUERY BACKUPSET
v QUERY CLOPTSET
v QUERY COLLOCGROUP
v QUERY CONTENT
v QUERY COPYGROUP
v QUERY DATAMOVER
v QUERY DB
v QUERY DBBACKUPTRIGGER
v QUERY DBVOLUME
v QUERY DEVCLASS
v QUERY DIRSPACE
v QUERY DOMAIN
v QUERY DRIVE
v QUERY DRMEDIA
v QUERY DRMSTATUS
v QUERY ENABLED
v QUERY EVENT
v QUERY EVENTRULES
v QUERY EVENTSERVER
v QUERY FILESPACE
v QUERY LIBRARY
v QUERY LIBVOLUME
v QUERY LICENSE
v QUERY LOG
v QUERY LOGVOLUME
v QUERY MACHINE
v QUERY MGMTCLASS
v QUERY MOUNT
v QUERY NASBACKUP
v QUERY NODE
v QUERY NODEDATA
v QUERY NODEGROUP
v QUERY OCCUPANCY
v QUERY OPTION
v QUERY PATH
v QUERY POLICYSET
v QUERY PROCESS
v QUERY PROFILE
v QUERY PROXYNODE
v QUERY RECOVERYMEDIA
v QUERY REQUEST
v QUERY RESTORE
v QUERY RPFILE
v QUERY SCHEDULE
v QUERY SCRIPT
v QUERY SERVER
v QUERY SERVERGROUP
v QUERY SESSION
v QUERY SPACETRIGGER
v QUERY SQLSESSION
v QUERY STATUS
v QUERY STGPOOL
v QUERY SUBSCRIBER
v QUERY SUBSCRIPTION
v QUERY SYSTEM
v QUERY VIRTUALFSMAPPING
v QUERY VOLHISTORY
v QUERY VOLUME
v QUIT
v ROLLBACK
v SERIAL
v SELECT
v SET SQLDATETIMEFORMAT
v SET SQLDISPLAYMODE
v SET SQLMATHMODE


24 IBM Tivoli Storage Manager for Windows: Administrators Reference
Chapter 2. Administrative commands
Administrative commands are available to manage and configure the server.
Information for each command includes:
v A description of the tasks a command performs
v The administrator privilege class required to use the command
v A syntax diagram that identifies the required and optional parameters for the
command
v Descriptions of each parameter of the command
v Examples of using the command
v A list of related commands

Copyright IBM Corp. 1993, 2007 25
ACCEPT commands
Use the ACCEPT command to establish the current date for Tivoli Storage
Manager.
v ACCEPT DATE (Accepts the current system date) on page 27
ACCEPT commands

26 IBM Tivoli Storage Manager for Windows: Administrators Reference
ACCEPT DATE (Accepts the current system date)
Use this command to allow the server to begin normal processing, when the server
does not start normal processing because of a discrepancy between the server date
and the current date on the system.
When the server does not start normal processing because of a discrepancy
between the server date and the current date, this command forces the server to
accept the current date and time as valid. If the system time is valid and the server
has not been run for an extended time, this command should be run to allow the
server to begin normal processing.
Attention: If the system date is invalid or the server was created or run
previously with an invalid system date and this command is issued, any server
processing or command that uses dates can have unexpected results. File
expiration can be affected, for example. When the server is started with the correct
date, files backed up with future dates will not be considered for expiration until
that future date is reached. Files backed up with dates that have passed will expire
faster. When the server processing encounters a future date, an error message is
issued. See the Administrators Guide for more details.
If the server detects an invalid date or time, server sessions become disabled (as if
the DISABLE SESSIONS command had been issued). Expiration, migration,
reclamation, and volume history deletion operations are not able to continue
processing.
Use the ENABLE SESSIONS ALL command after you issue the ACCEPT DATE
command to re-enable sessions to start.
Privilege class
To issue this command, you must have system privilege.
Syntax
ACCept Date

Parameters
None.
Examples
Task
Allow the server to accept the current date as the valid date.
Command
accept date
ACCEPT DATE
Chapter 2. Administrative commands 27
Related commands
Table 11. Command related to ACCEPT DATE
Command Description
ENABLE SESSIONS Resumes server activity following the
DISABLE command or the ACCEPT DATE
command.

ACCEPT DATE

28 IBM Tivoli Storage Manager for Windows: Administrators Reference
ACTIVATE commands
Use the ACTIVATE command to make a resource ready to perform its function for
Tivoli Storage Manager.
v ACTIVATE POLICYSET (Activate a new policy set) on page 30
ACTIVATE command
Chapter 2. Administrative commands 29
ACTIVATE POLICYSET (Activate a new policy set)
Use this command to copy the contents of a policy set to the ACTIVE policy set for
the domain. The server uses the rules in the ACTIVE policy set to manage client
operations in the domain. You can define multiple policy sets for a policy domain,
but only one policy set can be active. The current ACTIVE policy set is replaced by
the one you specify when you issue this command. You can modify the ACTIVE
policy set only by activating another policy set.
Before activating a policy set, check that the policy set is complete and valid by
using the VALIDATE POLICYSET command.
The ACTIVATE POLICYSET command fails if any of the following conditions exist:
v A copy group specifies a copy storage pool as a destination.
v A management class specifies a copy storage pool as the destination for
space-managed files.
v The policy set has no default management class.
v A TOCDESTINATION parameter is specified, and the storage pool is either a
copy pool or has a data format other than NATIVE or NONBLOCK.
The ACTIVE policy set and the last activated policy set are not necessarily
identical. You can modify the original policy set that you activated without
affecting the ACTIVE policy set.
If the server has data retention protection enabled, the following conditions must
exist:
v All management classes in the policy set to be activated must contain an archive
copy group.
v If a management class exists in the active policy set, a management class with
the same name must exist in the policy set to be activated.
v If an archive copy group exists in the active policy set, the corresponding copy
group in the policy set to be activated must have a RETVER value at least as
large as the corresponding values in the active copy group.
Note: Retention protection only applies to archive objects.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the policy
set belongs.
Syntax
ACTivate POlicyset domain_name policy_set_name

Parameters
domain_name (Required)
Specifies the policy domain for which you want to activate a policy set.
policy_set_name (Required)
Specifies the policy set to activate.
ACTIVATE POLICYSET

30 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task
Activate the VACATION policy set in the EMPLOYEE_RECORDS policy domain.
Command
activate policyset employee_records vacation
Related commands
Table 12. Commands related to ACTIVATE POLICYSET
Command Description
COPY POLICYSET Creates a copy of a policy set.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
DELETE POLICYSET Deletes a policy set, including its
management classes and copy groups, from a
policy domain.
QUERY DOMAIN Displays information about policy domains.
QUERY POLICYSET Displays information about policy sets.
UPDATE POLICYSET Changes the description of a policy set.
VALIDATE POLICYSET Verifies and reports on conditions the
administrator must consider before activating
the policy set.

ACTIVATE POLICYSET
Chapter 2. Administrative commands 31
ASSIGN commands
Use the ASSIGN command to specify management class name to use as the default
for a particular policy set for Tivoli Storage Manager.
v ASSIGN DEFMGMTCLASS (Assign a default management class) on page 33
ASSIGN command

32 IBM Tivoli Storage Manager for Windows: Administrators Reference
ASSIGN DEFMGMTCLASS (Assign a default management
class)
Use this command to specify a management class as the default management class
for a policy set. You must assign a default management class for a policy set before
you can activate that policy set.
To ensure that clients can always back up and archive files, choose a default
management class that contains both an archive copy group and a backup copy
group.
The server uses the default management class to manage client files when a
management class is not otherwise assigned or appropriate. For example, the
server uses the default management class when a user does not specify a
management class in the include-exclude list. See the Administrators Guide for
details.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the policy
set belongs.
Syntax
ASsign DEFMGmtclass domain_name policy_set_name class_name

Parameters
domain_name (Required)
Specifies the policy domain to which the management class belongs.
policy_set_name (Required)
Specifies the policy set for which you want to assign a default management
class. You cannot assign a default management class to the ACTIVE policy set.
class_name (Required)
Specifies the management class that is to be the default management class for
the policy set.
Examples
Task
Assign DEFAULT1 as the default management class for policy set SUMMER in the
PROG1 policy domain.
Command
assign defmgmtclass prog1 summer default1
Related commands
Table 13. Commands related to ASSIGN DEFMGMTCLASS
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
ASSIGN DEFMGMTCLASS
Chapter 2. Administrative commands 33
Table 13. Commands related to ASSIGN DEFMGMTCLASS (continued)
Command Description
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DEFINE MGMTCLASS Defines a management class.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
DELETE MGMTCLASS Deletes a management class and its copy
groups from a policy domain and policy set.
QUERY COPYGROUP Displays the attributes of a copy group.
QUERY MGMTCLASS Displays information about management
classes.
QUERY POLICYSET Displays information about policy sets.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.
UPDATE MGMTCLASS Changes the attributes of a management
class.
VALIDATE POLICYSET Verifies and reports on conditions the
administrator must consider before activating
the policy set.

ASSIGN DEFMGMTCLASS

34 IBM Tivoli Storage Manager for Windows: Administrators Reference
AUDIT commands
Use the AUDIT commands to review or examine the adequacy of the database
information and the storage pool volume.
The following is a list of AUDIT commands for Tivoli Storage Manager:
v AUDIT LIBRARY (Audit volume inventories in an automated library) on page
36
v AUDIT LICENSES (Audit server storage usage) on page 38
v AUDIT VOLUME (Verify database information for a storage pool volume) on
page 39
AUDIT command
Chapter 2. Administrative commands 35
AUDIT LIBRARY (Audit volume inventories in an automated
library)
Use this command to audit and synchronize volume inventories in an automated
library.
When the AUDIT LIBRARY command is issued on a library client, the client
synchronizes its inventory with the inventory on the library manager. If the library
client detects inconsistencies, it corrects them by changing the ownership of the
volume on the library manager.
When the AUDIT LIBRARY command is issued on a server where the library is
SCSI, 349X or ACSLS (LIBTYPE=SCSI, LIBTYPE=349X, or LIBTYPE=ACSLS), the
server synchronizes its inventory with the inventory of the library device. If the
server detects inconsistencies, it deletes missing volumes from its inventory.
v In SCSI libraries, the server also updates the locations of volumes in its
inventory that have been moved since the last audit.
v In 349X libraries, the server also ensures that scratch volumes are in the scratch
category and that private volumes are in the private category.
When the AUDIT LIBRARY command is issued on a server that is a library
manager for the library (SHARED=YES), the server updates ownership of its
volumes if it detects inconsistencies.
Regardless the type of server or type of library, issuing the AUDIT LIBRARY
command does not automatically add new volumes to a library. To add new
volumes, you must use the CHECKIN LIBVOLUME command. Note also that
volumes in use by a z/OS

server using LAN-free data movement are not

included in audits.
Attention: The following precautions apply to SCSI, 349X, and ACSLS libraries
only (LIBTYPE=SCSI, LIBTYPE=349X, and LIBTYPE=ACSLS):
v Running the AUDIT LIBRARY command prevents any other library activity
until the audit completes. For example, Tivoli Storage Manager will not process
restore or retrieve requests that involve the library when the AUDIT LIBRARY
command is running.
v If other activity is occurring in the library, do not issue the AUDIT LIBRARY
command. Issuing the AUDIT LIBRARY command when a library is active can
produce unpredictable results (for example, a hang condition) if a process
currently accessing the library attempts to acquire a new tape mount.
This command creates a background process that you can cancel with the
CANCEL PROCESS command. To display information about background
processes, use the QUERY PROCESS command.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
AUDIT LIBRARY

36 IBM Tivoli Storage Manager for Windows: Administrators Reference
Syntax

AUDIT LIBRary

library_name
CHECKLabel = Yes
CHECKLabel

=

Yes

Barcode

Parameters
library_name (Required)
Specifies the name of the library to audit.
CHECKLabel
Specifies how the storage volume label is checked during the audit. This
parameter applies to SCSI libraries only. The parameter is ignored for other
library types. The default is YES. Possible values are:
Yes
Specifies that Tivoli Storage Manager checks each volume label to verify
the identity of the volume.
Barcode
Specifies that Tivoli Storage Manager uses the barcode reader to read the
storage label. Using the barcode decreases the audit processing time. This
parameter applies only to SCSI libraries.
Note: If the scanner cannot read the barcode label or the barcode label is
missing, Tivoli Storage Manager loads that tape in a drive to read
the label.
Examples
Task
Audit the EZLIFE automated library.
Command
audit library ezlife
Related commands
Table 14. Commands related to AUDIT LIBRARY
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE LIBRARY Defines an automated or manual library.
DELETE LIBRARY Deletes a library.
DISMOUNT VOLUME Dismounts a sequential, removable volume
by the volume name.
QUERY LIBRARY Displays information about one or more
libraries.
QUERY LIBVOLUME Displays information about a library volume.
QUERY PROCESS Displays information about background
processes.
UPDATE LIBRARY Changes the attributes of a library.

AUDIT LIBRARY
Chapter 2. Administrative commands 37
AUDIT LICENSES (Audit server storage usage)
Use this command to audit the server storage used by client nodes and to audit
the server licenses. The audit determines whether the current configuration is in
compliance with the license terms.
An audit creates a background process you can cancel with the CANCEL
PROCESS command. If you halt and restart the server, an audit is run
automatically as specified by the SET LICENSEAUDITPERIOD. To view audit
results, use the QUERY LICENSE command.
Attention: The audit of server storage can take a lot of CPU time. You can use
the AUDITSTORAGE server option to specify that storage is not to be audited.
Privilege class
To issue this command, you must have system privilege.
Syntax
AUDit LICenses

Parameters
None.
Examples
Task
Issue the AUDIT LICENSES command.
Command
audit licenses
Related commands
Table 15. Commands related to AUDIT LICENSES
Command Description
CANCEL PROCESS Cancels a background server process.
QUERY AUDITOCCUPANCY Displays the server storage utilization for a
client node.
QUERY LICENSE Displays information about licenses and
audits.
QUERY PROCESS Displays information about background
processes.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
REGISTER LICENSE Registers a new license with the IBM Tivoli
Storage Manager server.
SET LICENSEAUDITPERIOD Specifies the number of days between
automatic license audits.

AUDIT LICENSES

38 IBM Tivoli Storage Manager for Windows: Administrators Reference
AUDIT VOLUME (Verify database information for a storage
pool volume)
Use this command to check for inconsistencies between database information and a
storage pool volume. You can only audit volumes that belong to storage pools with
DATAFORMAT=NATIVE and DATAFORMAT=NONBLOCK. During the audit, the
server sends processing information to the activity log and the server console.
You cannot audit a volume if it is being deleted from a primary or copy storage
pool.
While an audit process is active, clients cannot restore data from the specified
volume or store new data to that volume.
If the server detects a file with errors, handling of the file will depend on the type
of storage pool to which the volume belongs, whether the FIX option is specified
on this command, and whether the file is also stored on a volume assigned to
other pools.
If Tivoli Storage Manager does not detect errors for a file that was marked as
damaged, the state of the file is reset so that it can be used.
The Tivoli Storage Manager server will not delete archive files that are on deletion
hold. If archive retention protection is enabled, the Tivoli Storage Manager server
will not delete archive files whose retention period has not expired.
To display information about the contents of a storage pool volume, use the
QUERY CONTENT command.
To audit multiple volumes, you can use the FROMDATE and TODATE parameters.
Use the STGPOOL parameter to audit all volumes in a storage pool. When you use
the parameters FROMDATE, TODATE, or both, the server limits the audit to only
the sequential media volumes that meet the date criteria, and automatically
includes all online disk volumes in storage. To limit the number of volumes that
may include disk volumes, use the FROMDATE, TODATE, and STGPOOL
parameters.
If you are running a server with archive retention protection enabled, and you
have data stored in storage pools which are defined with the parameter
RECLAMATIONTYPE=SNAPLOCK, the Last Access Date on the NetApp
SnapLock Filer for a volume should be equal to the End Reclaim Period date that
you see when you issue a QUERY VOLUME F=D command on that volume.
During AUDIT VOLUME processing, these dates are compared. If they do not
match and the AUDIT VOLUME command is being run with the FIX=NO
parameter, a message will be issued to you indicating that the command should be
run with the FIX=YES parameter to resolve the inconsistency. If they do not match
and the AUDIT VOLUME command is being run with the FIX=YES parameter, the
inconsistencies will be resolved.
This command creates a background process that can be canceled with the
CANCEL PROCESS command. To display information on background processes,
use the QUERY PROCESS command.
AUDIT VOLUME
Chapter 2. Administrative commands 39
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the storage pool to which the volume is
defined.
Syntax

AUDit Volume

volume_name

A
Fix = No
Fix

=

No

Yes

SKIPPartial = No
SKIPPartial

=

No

Yes
Quiet = No
Quiet

=

No

Yes

A (at least one of these parameters must be specified):

(1)

STGPool

=

poolname
(1)
FROMDate

=

TODAY

FROMDate

=

date

(1)
TODate

=

TODay

TODate

=

date


Notes:
1 You cannot specify a volume name if you specify a storage pool name,
FROMDATE, or TODATE.
Parameters
volume_name
Specifies the name of the storage pool volume you want to audit. This
parameter is required if you do not specify a storage pool. You cannot specify
a volume name together with the FROMDATE and TODATE parameters.
Fix
Specifies how the server resolves inconsistencies between the database
inventory and the specified storage pool volume. This parameter is optional.
The default is NO.
The actions the server performs depend on whether the volume is assigned to
a primary or a copy storage pool.
Primary Storage Pool:
Note: If the AUDIT VOLUME command does not detect an error in a file that
was previously marked as damaged, Tivoli Storage Manager resets the
state of the file so that it can be used. This provides a means for
AUDIT VOLUME

40 IBM Tivoli Storage Manager for Windows: Administrators Reference
resetting the state of damaged files if it is determined that the errors
were caused by a correctable hardware problem such as a dirty tape
head.
Fix=No
Tivoli Storage Manager reports, but does not delete, database records that
refer to files with inconsistencies:
v Tivoli Storage Manager marks the file as damaged in the database. If a
backup copy is stored in a copy storage pool, you can restore the file
using the RESTORE VOLUME or RESTORE STGPOOL command.
v If the file is a cached copy, you must delete references to the file on this
volume by issuing the AUDIT VOLUME command and specifying
FIX=YES. If the physical file is not a cached copy, and a duplicate is
stored in a copy storage pool, it can be restored by using the RESTORE
VOLUME or RESTORE STGPOOL command.
Fix=Yes
The server fixes any inconsistencies as they are detected:
v If the physical file is a cached copy, the server deletes the database
records that refer to the cached file. The primary file is stored on another
volume.
v If the physical file is not a cached copy, and the file is also stored in one
or more copy storage pools, the error will be reported and the physical
file marked as damaged in the database. You can restore the physical file
by using the RESTORE VOLUME or RESTORE STGPOOL command.
v If the physical file is not a cached copy, and the physical file is not
stored in a copy storage pool, each logical file for which inconsistencies
are detected are deleted from the database.
v If archive retention protection is enabled by using the SET
ARCHIVERETENTIONPROTECTION command, a cached copy of data
can be deleted if needed. Data in primary and copy storage pools can
only be marked damaged and never deleted.
Note: Do not use the AUDIT VOLUME command with FIX=YES if a
restore process (RESTORE STGPOOL or RESTORE VOLUME) is
running. The AUDIT VOLUME command could cause the restore to
be incomplete.
Copy Storage Pool:
Fix=No
The server reports the error and marks the physical file copy as damaged in
the database.
Fix=Yes
The server deletes any references to the physical file and any database
records that point to a physical file that does not exist.
SKIPPartial
Specifies whether Tivoli Storage Manager ignores skipped files, which are files
that span multiple storage pool volumes. This parameter is optional. The
default value is NO. When performing an audit operation on a sequential
access media volume, this parameter prevents additional sequential access
media mounts that may be necessary to audit any skipped files. Possible values
are:
No
Tivoli Storage Manager audits files that span multiple volumes.
AUDIT VOLUME
Chapter 2. Administrative commands 41
Unless you specify SKIPPARTIAL=YES, Tivoli Storage Manager attempts to
process each file stored on the volume, including files that span into and
out of other volumes. To audit files that span multiple volumes, the
following conditions must be true:
v For sequential access volumes, the additional sequential access volumes
must have an access mode of read/write or read-only.
v For random access volumes, the additional volumes must be online.
Yes
Tivoli Storage Manager audits only files that are stored on the volume to
be audited. The status of any skipped files is unknown.
Quiet
Specifies whether Tivoli Storage Manager sends detailed informational
messages to the activity log and the server console about irretrievable files on
the volume. This parameter is optional. The default is NO. Possible values are:
No
Specifies that Tivoli Storage Manager sends detailed informational
messages and a summary. Each message contains the node, file space, and
client name for the file.
Yes
Specifies that Tivoli Storage Manager sends only a summary report.
FROMDate
Specifies the beginning date of the range to audit volumes. The default is the
current date. All sequential media volumes meeting the time range criteria that
were written to after this date are audited. The server includes all online disk
volumes in storage. The server starts one audit process for each volume and
runs the process serially. You cannot use this parameter if you have specified a
volume. This parameter is optional. To limit the number of volumes that may
include disk volumes, use the FROMDATE, TODATE, and STGPOOL
parameters.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 10/15/2001
If a date is entered, all candidate
volumes written on that day (starting
at 12:00:01 am) will be evaluated.
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY 7 or 7.
To display information beginning with
volumes written a week ago, you can
specify FROMDATE=TODAY-7 or
FROMDATE= -7.

TODate
Specifies the ending date of the range for volumes to audit. All sequential
media volumes meeting the time range criteria that were written to before this
date are audited. The server includes all online disk volumes in storage . If you
do not specify a value, the server defaults to the current date. You cannot use
this parameter if you have specified a volume. This parameter is optional. To
AUDIT VOLUME

42 IBM Tivoli Storage Manager for Windows: Administrators Reference
limit the number of volumes that may include disk volumes, use the
FROMDATE, TODATE, and STGPOOL parameters.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 10/15/2001
If a date is entered, all candidate
volumes written on that day (ending at
11:59:59 pm) will be evaluated.
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY1 or 1.
To display information created up to
yesterday, you can specify
TODATE=TODAY-1 or simply
TODATE= -1.

STGPool
This parameter specifies that the server only audits the volumes from the
specified storage pool. This parameter is optional. You cannot use this
parameter if you have specified a volume.
Examples
Task
Verify that the database information for storage pool volume PROG2 is consistent
with the data stored on the volume. Tivoli Storage Manager fixes any
inconsistencies.
Command
audit volume prog2 fix=yes
Task
Verify that the database information for all eligible volumes written to from
3/20/2002 to 3/22/2002 is consistent with data stored on the volume.
Command
audit volume fromdate=03/20/2002 todate=03/22/2002
Task
Verify that the database information for all volumes in storage pool STPOOL3 is
consistent with data stored on the volume for today.
Command
audit volume stgpool=STPOOL3
Task
Verify that the database information for all volumes in storage pool STPOOL3 is
consistent with data stored on the volume for the last two days.
Command
audit volume stgpool=STPOOL3 fromdate=-1
AUDIT VOLUME
Chapter 2. Administrative commands 43
Related commands
Table 16. Commands related to AUDIT VOLUME
Command Description
CANCEL PROCESS Cancels a background server process.
QUERY CONTENT Displays information about files in a storage
pool volume.
QUERY PROCESS Displays information about background
processes.
QUERY VOLUME Displays information about storage pool
volumes.
SET ARCHIVERETENTIONPROTECTION Specifies whether data retention protection is
activated.

AUDIT VOLUME

44 IBM Tivoli Storage Manager for Windows: Administrators Reference
BACKUP commands
Use the BACKUP command to create backup copies of Tivoli Storage Manager
information or objects.
The following are the BACKUP commands for Tivoli Storage Manager:
v BACKUP DB (Back up the database) on page 46
v BACKUP DEVCONFIG (Create backup copies of device configuration
information) on page 49
v BACKUP NODE (Back up a NAS node) on page 51
v BACKUP STGPOOL (Back up primary storage pool to copy storage pool) on
page 55
v BACKUP VOLHISTORY (Save sequential volume history information) on page
59
BACKUP commands
Chapter 2. Administrative commands 45
BACKUP DB (Back up the database)
Use this command to back up a Tivoli Storage Manager database to sequential
access volumes.
To determine how much additional storage space a backup will require, use the
QUERY DB command. That command displays the database pages, in megabytes,
that have changed since the last backup.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax

BAckup DB

DEVclass

=

device_class_name
Type = Incremental
Type

=

Incremental

Full

DBSnapshot

,

VOLumenames

=

volume_name

FILE: file_name
Scratch = Yes
Scratch

=

Yes

No

Wait = No
Wait

=

No

Yes

Parameters
DEVclass (Required)
Specifies the name of the sequential access device class to use for the backup.
Note:
1. You cannot use a device class with a device type of NAS or
CENTERA.
2. A restore database operation will fail if the source for the restore is a
FILE library. A FILE library is created if the FILE device class
specifies SHARED=YES.
If all drives for this device class are busy when the backup runs, Tivoli Storage
Manager cancels lower priority operations, such as reclamation, to make a
drive available for the backup.
Type
Specifies the type of backup to run. This parameter is optional. The default is
INCREMENTAL. Possible values are:
Incremental
Specifies that you want to run an incremental backup of the Tivoli Storage
Manager database. The maximum number of incremental backups you can
run between full backups is 32.
BACKUP DB

46 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
Full
Specifies that you want to run a full backup of the Tivoli Storage Manager
database.
DBSnapshot
Specifies that you want to run a full snapshot database backup. The entire
contents of a database are copied and a new snapshot database backup is
created without interrupting the existing full and incremental backup series
for the database.
VOLumenames
Specifies the volumes used to back up the database. This parameter is optional.
However, if you specify SCRATCH=NO, you must specify a list of volumes.
volume_name
Specifies the volumes used to back up the database. Specify multiple
volumes by separating the names with commas and no intervening spaces.
FILE:filename
Specifies the name of a file that contains a list of volumes used to back up
the database. Each volume name must be on a separate line. Blank lines
and comment lines, which begin with an asterisk, are ignored.
For example, to use volumes DB0001, DB0002, and DB0003, create a file
named TAPEVOL.DATA that contains these lines:
DB0001
DB0002
DB0003
You can then specify the volumes for the command as follows:
VOLUMENAMES=FILE:TAPEVOL.DATA
Scratch
Specifies whether scratch volumes can be used for the backup. This parameter
is optional. The default is YES. Possible values are:
Yes
Specifies that scratch volumes can be used.
If you specify SCRATCH=YES and the VOLUMENAMES parameter, Tivoli
Storage Manager will only use scratch volumes if space is unavailable on
the specified volumes.
If you do not include a list of volumes by using the VOLUMENAMES
parameter, you must either specify SCRATCH=YES or use the default.
No
Specifies that scratch volumes cannot be used.
If you specify volumes by using the VOLUMENAMES parameter and
SCRATCH=NO, the backup will fail if there is not enough space available
to store the backup data on the specified volumes.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. The default is NO. Possible values are:
No
Specifies that the server processes this command in the background. You
can continue with other tasks while the command is being processed.
BACKUP DB
Chapter 2. Administrative commands 47
Messages created from the background process are displayed either in the
activity log or the server console, depending on where messages are
logged.
To cancel a background process, use the CANCEL PROCESS command. If
a BACKUP DB background process is canceled, some of the database may
have already been backed up before the cancellation.
Yes
Specifies that the server processes this command in the foreground. Wait
for the command to complete before continuing with other tasks. The
server then displays the output messages to the administrative client when
the command completes.
Note: You cannot specify Wait=Yes from the server console.
Examples
Task
Run an incremental backup of the database using a scratch volume. Assume a
device class of FILE for the backup.
Command
backup db devclass=file type=incremental
Related commands
Table 17. Commands related to BACKUP DB
Command Description
BACKUP DEVCONFIG Backs up IBM Tivoli Storage Manager device
information to a file.
BACKUP VOLHISTORY Records volume history information in
external files.
CANCEL PROCESS Cancels a background server process.
DEFINE DBBACKUPTRIGGER Defines a trigger for automatic IBM Tivoli
Storage Manager database backups.
DELETE VOLHISTORY Removes sequential volume history
information from the volume history file.
QUERY DB Displays allocation information about the
database.
QUERY DBBACKUPTRIGGER Displays information about the database
backup trigger.
QUERY PROCESS Displays information about background
processes.
QUERY VOLHISTORY Displays sequential volume history
information that has been collected by the
server.
SET LOGMODE Sets the mode for saving records in the
recovery log.
UPDATE DBBACKUPTRIGGER Changes one or more attributes of the
database backup trigger.

BACKUP DB

48 IBM Tivoli Storage Manager for Windows: Administrators Reference
BACKUP DEVCONFIG (Create backup copies of device
configuration information)
Use this command to back up information about device configuration for the
server.
This command backs up the following information in one or more files:
v Device class definitions
v Library definitions
v Drive definitions
v Server definitions
v Server name
v Server password
v Volume location information for LIBTYPE=SCSI libraries
To restore the Tivoli Storage Manager database, device configuration information
must be available.
At installation, the server options file includes a DEVCONFIG option that specifies
a device configuration file named devcnfg.out. Tivoli Storage Manager updates this
file whenever a device class, library, or drive is defined, updated, or deleted.
To ensure updates are complete before the server is halted:
v Do not halt the server for a few minutes after issuing the BACKUP
DEVCONFIG command.
v Specify multiple DEVCONFIG options in the server options file.
v Examine the device configuration file to see if the file has been updated.
Privilege class
Any administrator can issue this command unless it includes the FILENAMES
parameter. If the FILENAMES parameter is specified and the
REQSYSAUTHOUTFILE server option is set to YES, the administrator must have
system privilege. If the FILENAMES parameter is specified and the
REQSYSAUTHOUTFILE server option is set to NO, the administrator must have
operator, policy, storage or system privilege.
Syntax
BAckup DEVCONFig

,

Filenames

=

filename


Parameters
Filenames
Specifies the files in which to store device configuration information. You can
specify multiple files by separating the names with commas and no
intervening spaces. This parameter is optional.
If you do not specify a file name, Tivoli Storage Manager stores the
information in all files specified with the DEVCONFIG option in the server
options file.
BACKUP DEVCONFIG
Chapter 2. Administrative commands 49
Examples
Task
Back up device configuration information to a file named DEVICE.
Command
backup devconfig filenames=device
Related commands
Table 18. Commands related to BACKUP DEVCONFIG
Command Description
CHECKIN LIBVOLUME Checks a storage volume into an automated
library.
CHECKOUT LIBVOLUME Checks a storage volume out of an
automated library.
DEFINE DEVCLASS Defines a device class.
DEFINE DRIVE Assigns a drive to a library.
DEFINE LIBRARY Defines an automated or manual library.
DEFINE PATH Defines a path from a source to a destination.
DEFINE SERVER Defines a server for server-to-server
communications.
LABEL LIBVOLUME Labels volumes in manual or automated
libraries.
QUERY LIBVOLUME Displays information about a library volume.
SET SERVERNAME Specifies the name by which the server is
identified.
SET SERVERPASSWORD Specifies the server password.
UPDATE DEVCLASS Changes the attributes of a device class.
UPDATE DRIVE Changes the attributes of a drive.
UPDATE LIBVOLUME Changes the status of a storage volume.
UPDATE PATH Changes the attributes associated with a
path.
UPDATE SERVER Updates information about a server.

BACKUP DEVCONFIG

50 IBM Tivoli Storage Manager for Windows: Administrators Reference
BACKUP NODE (Back up a NAS node)
Use this command to start a backup operation for a network-attached storage
(NAS) node.
Backups that are created for NAS nodes with this BACKUP NODE command are
functionally equivalent to backups that are created by using the BACKUP NAS
command on a Tivoli Storage Manager client. You can restore these backups with
either the servers RESTORE NODE command or the clients RESTORE NAS
command.
Privilege class
To issue this command, you must have system privilege, policy privilege for the
domain to which the node is assigned, or client owner authority over the node.
Syntax
BAckup Node node_name

,

file_system_name

MGmtclass

=

mcname
TOC = Preferred
TOC

=

No

Preferred

Yes
Wait = No
Wait

=

No

Yes

MODE = DIFFerential
MODE

=

FULL

DIFFerential

Parameters
node_name (Required)
Specifies the node for which the backup will be performed. You cannot use
wildcard characters or specify a list of names.
file_system_name
Specifies the name of one or more file systems to back up. You can also specify
names of virtual file spaces that have been defined for the NAS node. The file
system name that you specify cannot contain wildcard characters. You can
specify more than one file system by separating the names with commas and
no intervening spaces.
If you do not specify a file system, all file systems will be backed up. Any
virtual file spaces defined for the NAS node are backed up as part of the file
system image, not separately.
If a file system exists on the NAS device with the same name as the virtual file
space specified, Tivoli Storage Manager automatically renames the existing
virtual file space in the server database, and backs up the NAS file system
which matches the name specified. If the virtual file space has backup data, the
file space definition associated with the virtual file space will also be renamed.
BACKUP NODE
Chapter 2. Administrative commands 51
Note: See the virtual file space name parameter in the DEFINE
VIRTUALFSMAPPING command for more naming considerations.
In determining the file systems to process, the server will not use any
DOMAIN.NAS, INCLUDE.FS.NAS, or EXCLUDE.FS.NAS statements in any
client option file or client option set. If you back up multiple file systems, the
backup of each file system is a separate server process.
MGmtclass
Specifies the name of the management class to which this backup data is
bound. If you do not specify a management class, the backup data is bound to
the default management class of the policy domain to which the node is
assigned. In determining the management class, the server will not use any
INCLUDE.FS.NAS statements in any client option file or client option set. The
destination management class may refer to a Tivoli Storage Manager native
pool, in which case NDMP data is sent into the Tivoli Storage Manager native
hierarchy. Once this occurs, the data stays in the Tivoli Storage Manager
hierarchy. Data flowing to Tivoli Storage Manager native pools goes over the
LAN and data flowing to NAS pools can be directly attached or over a SAN.
TOC
Specifies whether a table of contents (TOC) is saved for each file system
backup. Consider the following in determining whether you want to save a
table of contents.
v If a table of contents is saved, you will be able to use the QUERY TOC
command to determine the contents of a file system backup in conjunction
with the RESTORE NODE command to restore individual files or directory
trees. You will also be able to use the Tivoli Storage Manager Web
backup-archive client to examine the entire file system tree and choose files
and directories to restore. Creation of a table of contents requires that you
define the TOCDESTINATION attribute in the backup copy group for the
management class to which this backup image is bound. Note that a table of
contents creation requires additional processing, network resources, storage
pool space, and possibly a mount point during the backup operation.
v A table of contents for a NAS file system cannot have a directory path
greater than 1024 characters.
v If a table of contents is not saved for a file system backup, you will still be
able to restore individual files or directory trees using the RESTORE NODE
command, provided that you know the fully qualified name of each file or
directory to be restored and the image in which that object was backed up.
This parameter is optional. The default value is Preferred. Possible values
are:
No
Specifies that table of contents information is not saved for file system
backups.
Preferred
Specifies that table of contents information should be saved for file
system backups. However, a backup does not fail just because an error
occurs during creation of the table of contents. This is the default value.
Yes
Specifies that table of contents information must be saved for each file
system backup. A backup fails if an error occurs during creation of the
table of contents.
BACKUP NODE

52 IBM Tivoli Storage Manager for Windows: Administrators Reference
Note: If MODE=DIFFERENTIAL is specified and a table of contents is
requested (TOC=PREFERRED or TOC=YES), but the last full image does
not have a table of contents, a full backup will be performed and a table
of contents will be created for that full backup.
MODE
Specifies whether the file system backups are full or differential. The default is
DIFFERENTIAL.
FULL
Specifies to back up the entire file system.
DIFFerential
Specifies to back up only the files that have changed since the most recent
full backup. If you choose a differential backup, and a full backup is not
found, a full backup is performed.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. The default is NO. Possible values are:
No
Specifies that the server processes this command in the background. Use
the QUERY PROCESS command to monitor the background processing of
this command.
Yes
Specifies that the server processes this command in the foreground. You
wait for the command to complete before continuing with other tasks. The
server then displays the output messages to the administrative client when
the command completes. If you are backing up multiple file systems, all
backup processes must complete before the command is complete.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task 1
Perform a full backup on the /vol/vol10 file system of NAS node NAS1.
Command
backup node nas1 /vol/vol10 mode=full
For Tasks 2 and 3, assume the following virtual file space definitions exist on the
server for the node NAS1.

Virtual file space name File system Path
/mikesdir /vol/vol2 /mikes
/DataDirVol2 /vol/vol2 /project1/data
/TestDirVol1 /vol/vol1 /project1/test

Task 2
Back up the directory /vol/vol2/mikes on the node NAS1 and create a table of
contents for the image.
BACKUP NODE
Chapter 2. Administrative commands 53
Command
backup node nas1 /mikesdir
Task 3
Back up the directories /vol/vol2/project1/data and /vol/vol1/project1/test of
the node NAS1.
Command
backup node nas1 /DataDirVol2,/testdirvol1 mode=full toc=yes
Related commands
Table 19. Commands related to BACKUP NODE
Command Description
BACKUP NAS (Tivoli Storage Manager client
command)
Creates a backup of NAS node data.
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DEFINE VIRTUALFSMAPPING Define a virtual file space mapping.
QUERY NASBACKUP Displays information about NAS backup
images.
QUERY TOC Displays details about the table of contents
for a specified backup image.
QUERY COPYGROUP Displays the attributes of a copy group.
RESTORE NAS (Tivoli Storage Manager
client command)
Restores a backup of NAS node data.
RESTORE NODE Restores a network-attached storage (NAS)
node.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.

BACKUP NODE

54 IBM Tivoli Storage Manager for Windows: Administrators Reference
BACKUP STGPOOL (Back up primary storage pool to copy
storage pool)
Use this command to back up primary storage pool files to a copy storage pool.
In addition to backing up primary storage pools having NATIVE or NONBLOCK
data formats, this command lets you back up primary storage pools that have
NDMP data formats (NETAPPDUMP, CELERRADUMP, or NDMPDUMP). The
copy storage pool to which data is to be backed up must have the same data
format as the primary storage pool. Tivoli Storage Manager supports backend data
movement for NDMP images. For details, see the Administrators Guide. You cannot
back up data from or to storage pools defined with a CENTERA device class.
If a file already exists in the copy storage pool, the file is not backed up unless the
copy of the file in the copy storage pool is marked damaged. However, a new copy
is not created if the file in the primary storage pool is also marked damaged. In a
random-access storage pool, neither cached copies of migrated files nor damaged
primary files are backed up.
If migration for a storage pool starts during a storage pool backup, some files may
be migrated before they are backed up. You may want to back up storage pools
that are higher in the migration hierarchy before backing up storage pools that are
lower. For example, when performing a storage pool backup to copy the contents
of a storage pool offsite, if the process is not done according to the existing storage
pool hierarchy, some files may not be copied to the copy storage pool. This could
become critical for disaster recovery purposes. When performing a storage pool
backup on multiple storage pools, the primary storage pool should be completed
before starting the backup process on the next storage pool.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the copy storage pool in which backup
copies are to be produced.
Syntax
BAckup STGpool primary_pool_name copy_pool_name

MAXPRocess = 1
MAXPRocess

=

number
Preview = No
Preview

=

No

Yes

(1)

VOLumesonly

SHREDTONOshred = No
SHREDTONOshred

=

No

Yes
Wait = No
Wait

=

No

Yes

Notes:
1 Valid only for storage pools associated with a sequential-access device class.
BACKUP STGPOOL
Chapter 2. Administrative commands 55
Parameters
primary_pool (Required)
Specifies the primary storage pool.
copy_pool (Required)
Specifies the copy storage pool.
MAXPRocess
Specifies the maximum number of parallel processes to use for backing up
files. This parameter is optional. Enter a value from 1 to 999. The default is 1.
Using multiple, parallel processes may improve throughput for the backup.
The expectation is that the time needed to perform the storage pool backup
will be decreased by using multiple processes. However, when multiple
processes are running, in some cases one or more of the processes needs to
wait to use a volume that is already in use by a different backup process.
When determining this value, consider the number of logical and physical
drives that can be dedicated to this operation. To access a sequential access
volume, Tivoli Storage Manager uses a mount point and, if the device type is
not FILE, a physical drive. The number of available mount points and drives
depends on other Tivoli Storage Manager and system activity and on the
mount limits of the device classes for the sequential access storage pools that
are involved in the backup.
Each process needs a mount point for copy storage pool volumes, and, if the
device type is not FILE, each process also needs a drive. If you are backing up
a sequential storage pool, each process needs an additional mount point for
primary storage pool volumes and, if the device type is not FILE, an additional
drive. For example, suppose you specify a maximum of 3 processes to back up
a primary sequential storage pool to a copy storage pool of the same device
class. Each process requires 2 mount points and 2 drives. To run all 3
processes, the device class must have a mount limit of at least 6, and at least 6
mount points and 6 drives must be available.
To preview a backup, only one process is used and no mount points or drives
are needed.
Preview
Specifies if you want to preview but not perform the backup. The preview
displays the number of files and bytes to be backed up and a list of the
primary storage pool volumes that you must mount. This parameter is
optional. The default is NO. Possible values are:
No
Specifies that the backup is done.
Yes
Specifies that you want to preview the backup but not do the backup.
VOLumesonly
Specifies that you want to preview the backup only as a list of the volumes
that must be mounted. This choice requires the least processing time. The
VOLUMESONLY option is valid only for storage pools associated with a
sequential-access device class.
SHREDTONOshred
Specifies whether data will be backed up to a copy storage pool from a
primary storage pool that enforces shredding. This parameter is optional. The
default value is NO. Possible values are:
BACKUP STGPOOL

56 IBM Tivoli Storage Manager for Windows: Administrators Reference
No
Specifies that the server will not allow data to be backed up to a copy
storage pool from a primary storage pool that enforces shredding. If the
primary storage pool enforces shredding, the operation will fail.
Yes
Specifies that the server does allow data to be backed up to a copy storage
pool from a primary storage pool that enforces shredding. The data in the
copy storage pool will not be shredded when it is deleted.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is NO. Possible
values are:
No
Specifies that the server processes this command in the background.
You can continue with other tasks while the command is being processed.
Messages created from the background process are displayed either in the
activity log or the server console, depending on where messages are
logged.
To cancel a background process, use the CANCEL PROCESS command. If
you cancel this process, some files may have already been backed up prior
to the cancellation.
Yes
Specifies that the server performs this operation in the foreground. You
must wait for the operation to complete before continuing with other tasks.
The server displays the output messages to the administrative client when
the operation completes.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Back up the primary storage pool named PRIMARY_POOL to the copy storage
pool named COPYSTG.
Command
backup stgpool primary_pool copystg
Related commands
Table 20. Commands related to BACKUP STGPOOL
Command Description
CANCEL PROCESS Cancels a background server process.
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY PROCESS Displays information about background
processes.
QUERY SHREDSTATUS Displays information about data waiting to
be shredded.
BACKUP STGPOOL
Chapter 2. Administrative commands 57
Table 20. Commands related to BACKUP STGPOOL (continued)
Command Description
QUERY STGPOOL Displays information about storage pools.
RESTORE STGPOOL Restores files to a primary storage pool from
copy storage pools.
RESTORE VOLUME Restores files stored on specified volumes in
a primary storage pool from copy storage
pools.
SHRED DATA Manually starts the process of shredding
deleted data.

BACKUP STGPOOL

58 IBM Tivoli Storage Manager for Windows: Administrators Reference
BACKUP VOLHISTORY (Save sequential volume history
information)
Use this command to back up sequential volume history information to one or
more files. You can use volume history information when you reload the database
and audit affected storage pool volumes. If you cannot start the server, you can use
the volume history file to query the database about these volumes.
The volume history includes information about the following types of volumes:
v Database backup volumes
v Database dump volumes
v Export volumes
v Backup set volumes
v Database snapshot volumes
v Database recovery plan file volumes
v Recovery plan file volumes
v Recovery plan file snapshot volumes
v The following sequential access storage pool volumes:
Volumes added to storage pools
Volumes reused through reclamation or MOVE DATA operations
Volumes removed by using the DELETE VOLUME command or during
reclamation of scratch volumes
At installation, the server options file includes a VOLUMEHISTORY option that
specifies a default volume history file named volhist.out . Tivoli Storage Manager
updates volume history files whenever server sequential volume history
information is changed.
In order to ensure updates are complete before the server is halted, we recommend
you:
v Not halt the server for a few minutes after issuing the BACKUP VOLHISTORY
command.
v Specify multiple VOLUMEHISTORY options in the server options file.
v Examine the volume history file to see if the file has been updated.
Privilege class
Any administrator can issue this command unless it includes the FILENAMES
parameter. If the FILENAMES parameter is specified and the
REQSYSAUTHOUTFILE server option is set to YES, the administrator must have
system privilege. If the FILENAMES parameter is specified and the
REQSYSAUTHOUTFILE server option is set to NO, the administrator must have
operator, policy, storage or system privilege.
Syntax
BAckup VOLHistory

,

Filenames

=

file_name


BACKUP VOLHISTORY
Chapter 2. Administrative commands 59
Parameters
Filenames
Specifies the names of one or more files in which to store a backup copy of
volume history information. Separate multiple file names with commas and no
intervening spaces. This parameter is optional.
If you do not specify a file name, Tivoli Storage Manager stores the
information in all files specified with the VOLUMEHISTORY option in the
server options file.
Examples
Task
Back up the volume history information to a file called VOLHIST.
Command
backup volhistory filenames=volhist
Related commands
Table 21. Commands related to BACKUP VOLHISTORY
Command Description
DELETE VOLHISTORY Removes sequential volume history
information from the volume history file.
DELETE VOLUME Deletes a volume from a storage pool.
QUERY VOLHISTORY Displays sequential volume history
information that has been collected by the
server.
UPDATE VOLHISTORY Adds or changes location information for a
volume in the volume history file.

BACKUP VOLHISTORY

60 IBM Tivoli Storage Manager for Windows: Administrators Reference
BEGIN commands
Use the BEGIN command to begin logging events for Tivoli Storage Manager.
v BEGIN EVENTLOGGING (Begin logging events) on page 62
BEGIN commands
Chapter 2. Administrative commands 61
BEGIN EVENTLOGGING (Begin logging events)
Use this command to begin logging events to one or more receivers. A receiver for
which event logging has begun is an active receiver.
When the server is started, event logging automatically begins for the console and
activity log and for any receivers that are started automatically based on entries in
the server options file. You can use this command to begin logging events to
receivers for which event logging is not automatically started at server startup. You
can also use this command after you have disabled event logging to one or more
receivers.
Privilege class
To issue this command, you must have system privilege.
Syntax

BEGin EVentlogging

ALL
,

CONSOLE

ACTLOG

EVENTSERVER

FILE

FILETEXT

NTEVENTLOG

SNMP

TIVOLI

USEREXIT

Parameters
Specify one or more receivers. You can specify multiple receivers by separating
them with commas and no intervening spaces. If you specify ALL, logging begins
for all receivers that are configured. The default is ALL.
ALL
Specifies all receivers that are configured for event logging.
CONSOLE
Specifies the server console as a receiver.
ACTLOG
Specifies the Tivoli Storage Manager activity log as a receiver.
EVENTSERVER
Specifies the event server as a receiver.
FILE
Specifies a user file as a receiver. Each logged event is a record in the file and a
person cannot read each logged event easily.
FILETEXT
Specifies a user file as a receiver. Each logged event is a fixed-size, readable
line.
NTEVENTLOG
Specifies the Windows application log as a receiver.
BEGIN EVENTLOGGING

62 IBM Tivoli Storage Manager for Windows: Administrators Reference
SNMP
Specifies the simple network management protocol (SNMP) as a receiver.
TIVOLI
Specifies the Tivoli Management Environment

(TME

) as a receiver.
USEREXIT
Specifies a user-written routine to which Tivoli Storage Manager writes
information as a receiver.
Examples
Task
Begin logging events to the Tivoli Storage Manager activity log.
Command
begin eventlogging actlog
Related commands
Table 22. Commands related to BEGIN EVENTLOGGING
Command Description
DISABLE EVENTS Disables specific events for receivers.
ENABLE EVENTS Enables specific events for receivers.
END EVENTLOGGING Ends event logging to a specified receiver.
QUERY ENABLED Displays enabled or disabled events for a
specific receiver.
QUERY EVENTRULES Displays information about rules for server
and client events.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

BEGIN EVENTLOGGING
Chapter 2. Administrative commands 63
CANCEL commands
Use the CANCEL commands to end a task before it is completed.
The following is a list of CANCEL commands for Tivoli Storage Manager:
v CANCEL EXPIRATION (Cancel an expiration process) on page 65
v CANCEL PROCESS (Cancel an administrative process) on page 67
v CANCEL REQUEST (Cancel one or more mount requests) on page 69
v CANCEL RESTORE (Cancel a restartable restore session) on page 70
v CANCEL SESSION (Cancel one or more client sessions) on page 71
CANCEL commands

64 IBM Tivoli Storage Manager for Windows: Administrators Reference
CANCEL EXPIRATION (Cancel an expiration process)
Use this command to cancel a process that is running as a result of an inventory
expiration operation.
Privilege class
To issue this command, you must have system privilege.
Syntax
CANcel EXPIration

Examples
Task
Cancel the process that was generated by an inventory expiration operation.
Command
cancel expiration
Related commands
Table 23. Command related to CANCEL EXPIRATION
Command Description
QUERY PROCESS Displays information about background
processes.
EXPIRE INVENTORY Manually starts inventory expiration
processing.

CANCEL EXPIRATION
Chapter 2. Administrative commands 65
CANCEL EXPORT (Deletes a suspended export operation)
Use this command to delete a suspended server-to server export operation. After
issuing the CANCEL EXPORT command, you cannot restart the export operation.
Issue the CANCEL PROCESS command to delete a currently running export
operation.
Privilege class
You must have system privilege to issue this command.
Syntax

*
CANcel EXPort

export_identifier

Parameters
export_identifier
The unique identifier of the suspended export operation that you wish to
delete. You can also enter wildcard characters for the identifier. Issue the
QUERY EXPORT command to list the currently suspended export operations.
Examples
Task
Cancel the suspended server-to-server export operation EXPORTALLACCTNODES.
Command
cancel export exportallacctnodes
Task
Cancel all suspended server-to-server export processes.
Command
cancel export *
Related commands
Table 24. Commands related to CANCEL EXPORT
Command Description
CANCEL PROCESS Cancels a background server process.
EXPORT NODE Copies client node information to external
media.
EXPORT SERVER Copies all or part of the server to external
media.
QUERY EXPORT Displays the export operations that are
currently running or suspended.
RESTART EXPORT Restarts a suspended export operation.
SUSPEND EXPORT Suspends a running export operation.

CANCEL EXPORT

66 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
||
||
||
|
||
|
||
|
||
||
|
|
CANCEL PROCESS (Cancel an administrative process)
Use this command to cancel a background process started by an administrative
command or by a process, such as storage pool migration.
The following commands generate background processes:

v AUDIT LIBRARY
v AUDIT LICENSES
v AUDIT VOLUME
v BACKUP DB
v BACKUP NODE
v BACKUP STGPOOL
v CHECKIN LIBVOLUME
v CHECKOUT LIBVOLUME
v CONVERT ARCHIVE
v DEFINE DBCOPY
v DEFINE LOGCOPY
v DELETE DBVOLUME
v DELETE FILESPACE
v DELETE LOGVOLUME
v DELETE VOLUME
v EXPIRE INVENTORY
v EXPORT ADMIN
v EXPORT NODE
v EXPORT POLICY
v EXPORT SERVER
v EXTEND LOG
v GENERATE BACKUPSET
v IMPORT ADMIN
v IMPORT NODE
v IMPORT POLICY
v IMPORT SERVER
v MIGRATE STGPOOL
v MOVE DATA
v MOVE DRMEDIA
v MOVE MEDIA
v PREPARE
v RECLAIM STGPOOL
v REDUCE DB
v REDUCE LOG
v RESTORE NODE
v RESTORE STGPOOL
v RESTORE VOLUME
v UNDO ARCHCONVERSION
v UPDATE ARCHIVE
v VARY

The following internal server operations generate background processes:
v Inventory expiration
v Migration
v Reclamation
To cancel a process, you must have the process number, which you can obtain by
issuing the QUERY PROCESS command.
Some processes, such as reclamation, will generate mount requests in order to
complete processing. If a process has a pending mount request, the process may
not respond to a CANCEL PROCESS command until the mount request has been
answered or cancelled by using either the REPLY or CANCEL REQUEST
command, or by timing out.
Issue the QUERY REQUEST command to list open requests, or query the activity
log to determine if a given process has a pending mount request.
Note: A mount request indicates that a volume is needed for the current process,
but the volume is not available in the library. It may not be available if the
administrator has issued the MOVE MEDIA or CHECKOUT LIBVOLUME
command, or manually removed the volume from the library.
CANCEL PROCESS
Chapter 2. Administrative commands 67
After you issue a CANCEL PROCESS command for an export operation, the
process cannot be restarted. To stop a server-to-server export operation but allow it
to be restarted at a later time, issue the SUSPEND EXPORT command.
Privilege class
To issue this command, you must have system privilege.
Syntax
CANcel PRocess process_number

Parameters
process_number (Required)
Specifies the number of the background process you want to cancel.
Examples
Task
Cancel background process number 3.
Command
cancel process 3
Related commands
Table 25. Commands related to CANCEL PROCESS
Command Description
CANCEL EXPORT Deletes a suspended export operation
CANCEL REQUEST Cancels pending volume mount requests.
QUERY EXPORT Displays the export operations that are
currently running or suspended.
QUERY PROCESS Displays information about background
processes.
REPLY Allows a request to continue processing.
RESTART EXPORT Restarts a suspended export operation.
SUSPEND EXPORT Suspends a running export operation.

CANCEL PROCESS

68 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
||
||
|
||
||
CANCEL REQUEST (Cancel one or more mount requests)
Use this command to cancel one or more pending media mount requests. To cancel
a mount request, you need to know the request number assigned to the request.
This number is included in the mount request message and can also be shown by
using the QUERY REQUEST command.
Privilege class
To issue this command, you must have system privilege or operator privilege.
Syntax
CANcel REQuest request_number
ALl

PERManent


Parameters
request_number
Specifies the request number of the mount request to cancel.
ALl
Specifies to cancel all pending mount requests.
PERManent
Specifies that you want the server to flag the volumes for which you are
canceling a mount request as unavailable. This parameter is optional.
Examples
Task
Cancel request number 2.
Command
cancel request 2
Related commands
Table 26. Commands related to CANCEL REQUEST
Command Description
QUERY REQUEST Displays information about all pending
mount requests.
UPDATE VOLUME Updates the attributes of storage pool
volumes.

CANCEL REQUEST
Chapter 2. Administrative commands 69
CANCEL RESTORE (Cancel a restartable restore session)
Use this command to cancel a restartable restore session. You can cancel restore
sessions in the active or restartable state. Any outstanding mount requests related
to this session are automatically cancelled.
To display restartable restore sessions, use the QUERY RESTORE command.
Privilege class
To issue this command, you must have system or operator privilege.
Syntax
CANcel RESTore session_number
ALl


Parameters
session_number
Specifies the number for the restartable restore session. An active session is a
positive number, and a restartable session is a negative number.
ALl
Specifies that all the restartable restore sessions are to be cancelled.
Examples
Task 1
Cancel all restore operations.
Command
cancel restore all
Related commands
Table 27. Commands related to CANCEL RESTORE
Command Description
QUERY RESTORE Displays information about restartable restore
sessions.

CANCEL RESTORE

70 IBM Tivoli Storage Manager for Windows: Administrators Reference
CANCEL SESSION (Cancel one or more client sessions)
Use this command to cancel existing administrative or client node sessions, and to
force an administrative or client node session off the server. Any outstanding
mount requests related to this session are automatically cancelled. The client node
must start a new session to resume activities.
If you cancel a session that is in the idle wait (IdleW) state, the client session is
automatically reconnected to the server when it starts to send data again.
If this command interrupts a process, such as backup or archive, the results of any
processing active at the time of interruption are rolled back and not committed to
the database.
Privilege class
To issue this command, you must have system or operator privilege.
Syntax
CANcel SEssion session_number
ALl


Parameters
session_number
Specifies the number of the administrative or client node session that you want
to cancel.
ALl
Specifies that all client node sessions are cancelled. You cannot use this
parameter to cancel administrative client sessions.
Examples
Task
Cancel the client node session with NODEP (session 3).
Command
cancel session 3
Related commands
Table 28. Commands related to CANCEL SESSION
Command Description
DISABLE SESSIONS Prevents new sessions from accessing IBM
Tivoli Storage Manager but permits existing
sessions to continue.
LOCK ADMIN Prevents an administrator from accessing
IBM Tivoli Storage Manager.
LOCK NODE Prevents a client from accessing the server.
QUERY SESSION Displays information about all active
administrator and client sessions with IBM
Tivoli Storage Manager.

CANCEL SESSION
Chapter 2. Administrative commands 71
CHECKIN commands
Use the CHECKIN command to enter a storage volume into Tivoli Storage
Manager control within a library.
v CHECKIN LIBVOLUME (Check a storage volume into a library) on page 73
CHECKIN commands

72 IBM Tivoli Storage Manager for Windows: Administrators Reference
CHECKIN LIBVOLUME (Check a storage volume into a library)
Use this command to add a sequential access storage volume or a cleaning tape to
the server inventory for an automated library. The server cannot use a volume that
physically resides in an automated library until that volume has been checked in.
Note:
1. The CHECKIN LIBVOLUME command processing will not wait for a
drive to become available, even if the drive is only in the IDLE state. If
necessary, you can make a library drive available issuing the
DISMOUNT VOLUME command to dismount the volume. After a
library drive is available, reissue the CHECKIN LIBVOLUME command.
2. You do not define the drives, check in media, or label the volumes in an
external library. The server provides an interface that allows external
media management systems to operate with the server. For more
information, refer to the Administrators Guide.
3. z/OS LAN-free volumes do not need to be checked in. These volumes
are already owned by MVS

. Open system scratch tape mounts are not

supported for LAN-free on z/OS.
4. When checking in WORM tapes other than 3592, you must use
CHECKLABEL=YES or they will be checked in as normal read-write
tapes.
This command creates a background process that you can cancel with the
CANCEL PROCESS command. To display information on background processes,
use the QUERY PROCESS command.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax for SCSI libraries

CHECKIn LIBVolume

library_name
SEARCH = No
volume_name

SEARCH

=

Yes

A

SEARCH

=

Bulk

A

STATus

=

PRIvate

SCRatch

CLEaner
OWNer =
OWNer

=

server_name

CHECKLabel = Yes
CHECKLabel

=

Yes

No

Barcode
SWAP = No
SWAP

=

No

Yes
WAITTime = 60
WAITTime

=

value

CLEanings

=

number


CHECKIN LIBVOLUME
Chapter 2. Administrative commands 73
A (SEARCH=Yes, SEARCH=Bulk):

VOLRange = volume_name1,volume_name2
,

VOLList

=

volume_name

FILE:

file_name


Syntax for 349X libraries

CHECKIn LIBVolume

library_name
SEARCH = No
volume_name

SEARCH

=

Yes

A

STATus

=

PRIvate

SCRatch
OWNer =
OWNer

=

server_name

CHECKLabel = Yes
CHECKLabel

=

Yes

No

DEVType

=

3590

3592
SWAP = No
SWAP

=

No

Yes

WAITTime = 60
WAITTime

=

value

A (SEARCH=Yes):

VOLRange = volume_name1,volume_name2
,

VOLList

=

volume_name

FILE:

file_name


Syntax for ACSLS libraries

CHECKIn LIBVolume

library_name
SEARCH = No
volume_name

SEARCH

=

Yes

A

STATus

=

PRIvate

SCRatch
OWNer =
OWNer

=

server_name

CHECKLabel = Yes
CHECKLabel

=

Yes

No
SWAP = No
SWAP

=

No

Yes
WAITTime = 60
WAITTime

=

value

CHECKIN LIBVOLUME

74 IBM Tivoli Storage Manager for Windows: Administrators Reference
A (SEARCH=Yes):

VOLRange = volume_name1,volume_name2
,

VOLList

=

volume_name

FILE:

file_name


Parameters
library_name (Required)
Specifies the name of the library.
volume_name
Specifies the volume name of the storage volume being checked in. This
parameter is required if SEARCH equals NO. Do not enter this parameter if
the SEARCH parameter equals YES or BULK. If you are checking a volume
into a SCSI library with multiple entry/exit ports, the volume in the lowest
numbered slot will be checked in.
STATus (Required)
Specifies the volume status. Possible values are:
PRIvate
Specifies that the volume is a private volume that is mounted only when it
is requested by name.
SCRatch
Specifies that the volume is a new scratch volume. This volume can be
mounted to satisfy scratch mount requests during either data storage
operations or export operations.
If a volume has an entry in volume history, you cannot check it in as a
scratch volume.
CLEaner
Specifies that the volume is a cleaner cartridge and not a data cartridge.
The CLEANINGS parameter is required for a cleaner cartridge and must
be set to the number of cleaner uses.
CHECKLABEL=YES is not valid for checking in a cleaner cartridge. Use
STATUS=CLEANER to check in a cleaner cartridge separately from a data
cartridge.
OWNer
Specifies which library client owns a private volume in a library that is shared
across a SAN. The volume for which you specify ownership must be a private
volume. You cannot specify ownership for a scratch volume. Furthermore, you
cannot specify an owner when you use SEARCH=YES or SEARCH=BULK.
When you issue the CHECKIN LIBVOLUME command, the Tivoli Storage
Manager server validates the owner. If you did not specify this parameter, then
the server uses the default and delegates volume ownership to the owning
library client, as recorded in the volume history file on the library manager. If
the volume is not owned by any library client, then the server delegates
ownership to the library manager.
SEARCH
Specifies whether the server searches the library to find volumes that were not
checked in. This parameter is optional. The default is NO.
CHECKIN LIBVOLUME
Chapter 2. Administrative commands 75
Possible values are:
No
Specifies that only the named volume is checked into the library.
For SCSI libraries: The server issues a request to have the volume inserted
into a cartridge slot in the library or, if available, into an entry port. The
cartridge slot or entry port is identified by its element address. For 349X
libraries: The volume could already be in the library, or you could put it
into the I/O station when prompted.
Yes
Specifies that the server searches the library for volumes to be checked in.
You can use the VOLRANGE or VOLLIST parameter to limit the search.
When using this parameter, consider the following restrictions:
v If the library is shared between applications, the server could examine a
volume required by another application. For 349X libraries, the server
queries the library manager to determine all volumes that are assigned
to the SCRATCH or PRIVATE category and to the INSERT category.
v For SCSI libraries, do not specify both SEARCH=YES and
CHECKLABEL=NO in the same command.
Bulk
Specifies that the server searches the librarys entry/exit ports for volumes
that can be checked in automatically. This option only applies to SCSI
libraries.
Note:
1. Do not specify both CHECKLABEL=NO and SEARCH=BULK.
2. You can use the VOLRANGE or VOLLIST parameter to limit the
search.
VOLRange
Specifies a range of volume names separated by commas. You can use this
parameter to limit the search for volumes to be checked in when you specify
SEARCH=YES (349X, ACSLS, and SCSI libraries) or SEARCH=BULK (SCSI
libraries only). If there are no volumes in the library that are within the
specified range, the command completes without errors.
Specify only volume names that can be numerically incremented. In addition
to the incremental area, a volume name can include an alphanumeric prefix
and an alphanumeric suffix, for example:

Parameter Description
volrange=bar110,bar130 The 21 volumes are checked in: bar110,
bar111, bar112,...bar129, bar130.
volrange=bar11a,bar13a The 3 volumes are checked in: bar11a,
bar12a, bar13a.
volrange=123400,123410 The 11 volumes are checked in: 123400,
123401, ...123409, 123410.

VOLList
Specifies a list of volumes. You can use this parameter to limit the search for
volumes to be checked in when you specify SEARCH=YES (349X, ACSLS, and
SCSI libraries) or SEARCH=BULK (SCSI libraries only). If there are no volumes
in the library that are in the list, the command completes without errors.
Possible values are:
CHECKIN LIBVOLUME

76 IBM Tivoli Storage Manager for Windows: Administrators Reference
volume_name
Specifies one or more volumes names that are separated by commas and
no intervening spaces. For example: VOLLIST=TAPE01,TAPE02.
FILE: file_name
Specifies the name of a file that contains a list of volumes for the
command. In the file, each volume name must be on a separate line. Blank
lines and comment lines that begin with an asterisk are ignored. For
example, to use volumes TAPE01, TAPE02 and TAPE03, create a file,
TAPEVOL, that contains these lines:
TAPE01
TAPE02
TAPE03
You can specify the volumes for the command as follows:
VOLLIST=FILE:TAPEVOL.
Note: The file name is case-sensitive.
CHECKLabel
Specifies how or whether the server should read sequential media labels of
volumes. This parameter is optional. The default is YES.
Possible values are:
Yes
Specifies that an attempt is made to read the media label during check-in.
Note:
1. For optical volumes (write-once and rewritable), you must
specify YES.
2. For SCSI libraries, do not specify both SEARCH=YES and
CHECKLABEL=NO in the same command.
3. For WORM media other than 3592, you must specify YES.
No
Specifies that the media label is not read during check-in. However,
suppressing label checking can result in future errors (for example, either a
wrong label or an improperly labeled volume can cause an error). For 349X
and ACSLS libraries, specify NO to avoid loading cartridges into a drive to
read the media label. These libraries always return the external label
information on cartridges, and Tivoli Storage Manager uses that
information.
Barcode
Specifies that the server reads the bar code label if the library has a bar
code reader and the volumes have external bar code labels. You can
decrease the check-in time by using the bar code. This parameter applies
only to SCSI libraries.
If the bar code reader cannot read the bar code label, or if the tape does
not have a bar code label, the server mounts the tape and reads the
internal label.
DEVType
Specifies the device type for the volume being checked in. This parameter is
required if none of the drives in this library have defined paths.
3590
Specifies that the device type for the volume being checked in is 3590.
CHECKIN LIBVOLUME
Chapter 2. Administrative commands 77
3592
Specifies that the device type for the volume being checked in is 3592.
SWAP
Specifies whether the server swaps volumes if an empty library slot is not
available. The volume selected for the swap operation (target swap volume) is
ejected from the library and replaced with the volume being checked in. The
server identifies a target swap volume by checking for an available scratch
volume. If none exists, the server identifies the least frequently mounted
volume.
This parameter is optional. The default is NO. This parameter only applies if
there is a volume name specified in the command. Possible values are:
No
Specifies that the server checks in the volume only if an empty slot is
available.
Yes
Specifies that if an empty slot is not available, the server swaps cartridges
to check in the volume.
WAITTime
Specifies the number of minutes that the server will wait for you to reply or
respond to a request. Specify a value in the range 0-9999. If you want to be
prompted by the server, specify a wait time greater than zero. The default
value is 60 minutes. For example, suppose the server prompts you to insert a
tape into the entry/exit port of a library. If you specified a wait time of 60
minutes, the server will issue a request and wait 60 minutes for you to reply.
Suppose, on the other hand, you specify a wait time of 0. If you have already
inserted a tape, a wait time of zero will cause the operation to continue
without prompting. If you have not inserted a tape, a wait time of zero will
cause the operation to fail.
CLEanings
Enter the recommended value for the individual cleaner cartridge (usually
indicated on the cartridge). Cleanings apply only to SCSI libraries. This
parameter is required if STATUS=CLEANER.
If more than one cleaner is checked into the library, only one will be used until
its CLEANINGS value decreases to zero. Another cleaner will then be selected,
and the first cleaner can be checked out and discarded.
Examples
Task
Check in a volume named WPDV00 into the SCSI library named AUTO.
Command
checkin libvolume auto wpdv00 status=scratch
Task
Scan a SCSI library named AUTOLIB1 and, using the bar code reader, look for
cleaner cartridge CLNV. Use SEARCH=YES, but limit the search by using the
VOLLIST parameter.
Command
CHECKIN LIBVOLUME

78 IBM Tivoli Storage Manager for Windows: Administrators Reference
checkin libvolume autolib1 search=yes vollist=cleanv status=cleaner
cleanings=10 checklabel=barcode
Task
Scan a 349X library named ABC, and limit the search to a range of unused
volumes bar110 to bar130 and put them in scratch status.
Command
checkin libvolume abc search=yes volrange=bar110,bar130
status=scratch
Task
Use the barcode reader to scan a SCSI library named MYLIB for VOL1, and put it
in scratch status.
Command
checkin libvolume mylib search=yes vollist=vol1 status=scratch
checklabel=barcode
Related commands
Table 29. Commands related to CHECKIN LIBVOLUME
Command Description
AUDIT LIBRARY Ensures that an
automated library is in
a consistent state.
CANCEL PROCESS Cancels a background
server process.
CHECKOUT LIBVOLUME Checks a storage
volume out of an
automated library.
DEFINE LIBRARY Defines an automated
or manual library.
DEFINE VOLUME Assigns a volume to be
used for storage within
a specified storage pool.
DISMOUNT VOLUME Dismounts a sequential,
removable volume by
the volume name.
LABEL LIBVOLUME Labels volumes in
manual or automated
libraries.
QUERY LIBRARY Displays information
about one or more
libraries.
QUERY LIBVOLUME Displays information
about a library volume.
QUERY PROCESS Displays information
about background
processes.
REPLY Allows a request to
continue processing.
CHECKIN LIBVOLUME
Chapter 2. Administrative commands 79
Table 29. Commands related to CHECKIN LIBVOLUME (continued)
Command Description
UPDATE LIBVOLUME Changes the status of a
storage volume.

CHECKIN LIBVOLUME

80 IBM Tivoli Storage Manager for Windows: Administrators Reference
CHECKOUT commands
Use the CHECKOUT command to remove Tivoli Storage Manager control of a
storage volume located in a library.
v CHECKOUT LIBVOLUME (Check a storage volume out of a library) on page
82
CHECKOUT commands
Chapter 2. Administrative commands 81
CHECKOUT LIBVOLUME (Check a storage volume out of a
library)
Use this command to remove a sequential access storage volume from the server
inventory for an automated library. This command creates a background process
that can be canceled with the CANCEL PROCESS command. To display
information on background processes, use the QUERY PROCESS command.
Note:
1. Check out processing does not wait for a drive to become available, even
if the drive is in the IDLE state. If necessary, you can make a library
drive available by dismounting the volume with the DISMOUNT
VOLUME command. After a drive is available, the CHECKOUT
LIBVOLUME command can be reissued.
2. Before checking out volumes from a 349X library, ensure that the 349x
Cartridge Input and Output facility has enough empty slots for the
volumes to be checked out. The 3494 Library Manager does not inform
an application that the Cartridge Input and Output facility is full. It
accepts requests to eject a cartridge and waits until the Cartridge Input
and Output facility is emptied before returning to the server. Tivoli
Storage Manager may appear to be hung when it is not. You should
check the library and clear any intervention requests.
3. Before checking volumes out of an ACSLS library, ensure that the CAP
priority in ACSLS is greater than zero. If the CAP priority is zero, then
you must specify a value for the CAP parameter on the CHECKOUT
LIBVOLUME command.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax for SCSI library

CHECKOut LIBVolume

library_name

volume_name

A
REMove = Bulk
REMove

=

Yes

No

Bulk

CHECKLabel = Yes
CHECKLabel

=

Yes

No
FORCE = No
FORCE

=

No

Yes

A :

VOLRange = volume_name1,volume_name2
,

VOLList

=

volume_name

FILE:

file_name


CHECKOUT LIBVOLUME

82 IBM Tivoli Storage Manager for Windows: Administrators Reference
Syntax for 349X library

CHECKOut LIBVolume

library_name

volume_name

A
REMove = Bulk
REMove

=

Yes

No

Bulk

A :

VOLRange = volume_name1,volume_name2
,

VOLList

=

volume_name

FILE:

file_name


Syntax for ACSLS library

CHECKOut LIBVolume

library_name

volume_name

A
REMove = Yes
REMove

=

Yes

No

Bulk

CAP

=

x,y,z


A :

VOLRange = volume_name1,volume_name2
,

VOLList

=

volume_name

FILE:

file_name


Parameters
library_name (Required)
Specifies the name of the library.
volume_name
Specifies the volume name.
VOLRange
Specifies two volume names separated by a comma. This parameter is a range
of volumes to be checked out. If there are no volumes in the library that are
within the specified range, the command completes without errors.
Specify only volume names that can be numerically incremented. In addition
to the incremental area, a volume name can include an alphanumeric prefix
and an alphanumeric suffix, for example:
CHECKOUT LIBVOLUME
Chapter 2. Administrative commands 83
|
Parameter Description
volrange=bar110,bar130 The 21 volumes are checked out: bar110,
bar111, bar112,...bar129, bar130.
volrange=bar11a,bar13a The 3 volumes are checked out: bar11a,
bar12a, bar13a.
volrange=123400,123410 The 11 volumes are checked out: 123400,
123401, ...123409, 123410.

VOLList
Specifies a list of volumes to check out. If there are no volumes in the library
that are in the list, the command completes without errors.
Possible values are:
volume_name
Specifies the names of one or more values used for the command.
Example: VOLLIST=TAPE01,TAPE02.
FILE:file_name
Specifies the name of a file that contains a list of volumes for the
command. In the file, each volume name must be on a separate line. Blank
lines and comment lines that begin with an asterisk are ignored. For
example, to use volumes TAPE01, TAPE02 and TAPE03, create a file,
TAPEVOL, that contains these lines:
TAPE01
TAPE02
TAPE03
You can specify the volumes for the command as follows:
VOLLIST=FILE:TAPEVOL.
Note: The file name is case-sensitive.
REMove
Specifies that the server tries to move the volume out of the library and into
the convenience I/O station or entry/exit ports. This parameter is optional.
Possible values, depending on the type of library, are YES, BULK, and NO. The
response of the server to each of those options and the default values are
described in the following sections.
349X libraries: The default is BULK. The following table shows how the server
responds for 349X libraries.
Table 30. How theTivoli Storage Manager Server Responds for 349X Libraries
REMOVE=YES REMOVE=BULK REMOVE=NO
The 3494 Library Manager ejects the
cartridge to the convenience I/O
station.
The 3494 Library Manager ejects the
cartridge to the high-capacity output
facility.
The 3494 Library Manager does not
eject the volume.
The server leaves the cartridge in the
library in the INSERT category for
use by other applications.

SCSI libraries: The default is BULK. The following table shows how the server
responds for a SCSI libraries.
CHECKOUT LIBVOLUME

84 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 31. How theTivoli Storage Manager Server Responds for SCSI Libraries
If a library . . .
And REMOVE=YES,
then...
And REMOVE=BULK,
then...
And REMOVE=NO,
then...
Does not have entry/exit
ports
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server then prompts
you to remove the cartridge
from the slot and to issue a
REPLY command.
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server does not prompt
you to remove the cartridge
and does not require a
REPLY command.
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server does not prompt
you to remove the cartridge
and does not require a
REPLY command.
Has entry/exit ports and an
entry/exit port is available
The server moves the
cartridge to the available
entry/exit port and
specifies the port address in
a message.
The server then prompts
you to remove the cartridge
from the slot and to issue a
REPLY command.
The server moves the
cartridge to the available
entry/exit port and
specifies the port address in
a message.
The server does not prompt
you to remove the cartridge
and does not request a
REPLY command.
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server does not prompt
you to remove the cartridge
and does not require a
REPLY command.
Has entry/exit ports, but no
ports are available
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server then prompts
you to remove the cartridge
from the slot and to issue a
REPLY command.
The server waits for an
entry/exit port to be made
available.
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server does not prompt
you to remove the cartridge
and does not require a
REPLY command.

ACSLS libraries: The default is Yes. The following table shows how the server
responds for ACSLS libraries.
Table 32. How theTivoli Storage Manager Server Responds for ACSLS Libraries
REMOVE=YES or REMOVE=BULK REMOVE=NO
The server ejects the cartridge to the convenience I/O
station, and deletes the volume entry from the server
library inventory.
The server does not eject the cartridge. The server deletes
the volume entry from the server library inventory and
leaves the volume in the library.

CHECKLabel
Specifies how or whether the server reads sequential media labels of volumes.
Note: This parameter does not apply to IBM 349X or ACSLS libraries.
This parameter is optional. The default is YES. Possible values are:
Yes
Specifies that the server attempts to read the media label to verify that the
correct volume is being checked out.
CHECKOUT LIBVOLUME
Chapter 2. Administrative commands 85
No
Specifies that during checkout the media label is not read. This improves
performance because the read process does not occur.
FORCE
Specifies whether the server checks out a volume if an input/output (I/O)
error occurs when reading the label.
Note: This parameter does not apply to IBM 349X or ACSLS libraries.
This parameter is optional. The default is NO. Possible values are:
No
The server does not check out a storage volume if an I/O error occurs
when reading the label.
Yes
The server checks out the storage volume even if an I/O error occurs.
CAP
Specifies which cartridge access port (CAP) to use for ejecting volumes if you
specify REMOVE=YES. This parameter only applies to ACSLS libraries. If a
CAP priority greater than zero does not exist in the library, this parameter is
required. If a CAP priority greater than zero does exist in the library, this
parameter is optional. If you do not specify the parameter, the ACSLS server
will choose any available CAP with a priority greater than zero.
To display valid CAP identifiers (x,y,z), issue the QUERY CAP command with
ALL specified from the Automated Cartridge System System Administrator
(ACSSA) console on the ACSLS server host. The identifiers are as follows:
x The Automated Cartridge System (ACS) ID. This identifier can be a
number between 0126.
y The Library Storage Module (LSM) ID. This identifier can be a number
between 023.
z The CAP ID. This identifier can be a number between 02.
For more information, refer to your StorageTek documentation.
Examples
Task
Check out the volume named EXB004 from the library named FOREST. Read the
label to verify the volume name, but do not move the volume out of the library.
Command
checkout libvolume forest exb004 checklabel=yes remove=no
Related commands
Table 33. Commands related to CHECKOUT LIBVOLUME
Command Description
AUDIT LIBRARY Ensures that an automated library is in a
consistent state.
CANCEL PROCESS Cancels a background server process.
CHECKIN LIBVOLUME Checks a storage volume into an automated
library.
CHECKOUT LIBVOLUME

86 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 33. Commands related to CHECKOUT LIBVOLUME (continued)
Command Description
DEFINE LIBRARY Defines an automated or manual library.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
LABEL LIBVOLUME Labels volumes in manual or automated
libraries.
QUERY LIBRARY Displays information about one or more
libraries.
QUERY LIBVOLUME Displays information about a library volume.
QUERY PROCESS Displays information about background
processes.
REPLY Allows a request to continue processing.
UPDATE LIBVOLUME Changes the status of a storage volume.

CHECKOUT LIBVOLUME
Chapter 2. Administrative commands 87
CLEAN commands
Use the CLEAN DRIVE command to clean a drive in a SCSI library for Tivoli
Storage Manager.
v CLEAN DRIVE (Clean a drive) on page 89
CLEAN commands

88 IBM Tivoli Storage Manager for Windows: Administrators Reference
CLEAN DRIVE (Clean a drive)
Use this command when you want Tivoli Storage Manager to immediately load a
cleaner cartridge into a drive regardless of the cleaning frequency.
Note:
1. There are special considerations if you plan to use this command with a
SCSI library that provides automatic drive cleaning through its device
hardware. See the Administrators Guide for details.
2. You cannot run the CLEAN DRIVE command for a drive whose only
path source is a NAS file server.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
CLEAN DRIVE library_name drive_name

Parameters
library_name (Required)
Specifies the name of the library to which the drive is assigned.
drive_name (Required)
Specifies the name of the drive.
Examples
Task
You have already defined a library named AUTOLIB by using the DEFINE
LIBRARY command, and you have already checked a cleaner cartridge into the
library using the CHECKIN LIBVOL command. Inform the server that
TAPEDRIVE3 in this library requires cleaning.
Command
clean drive autolib tapedrive3
Related commands
Table 34. Commands related to CLEAN DRIVE
Command Description
CHECKIN LIBVOLUME Checks a storage volume into an automated
library.
CHECKOUT LIBVOLUME Checks a storage volume out of an
automated library.
DEFINE DRIVE Assigns a drive to a library.
DEFINE LIBRARY Defines an automated or manual library.
DELETE DRIVE Deletes a drive from a library.
QUERY DRIVE Displays information about drives.
UPDATE DRIVE Changes the attributes of a drive.
CLEAN DRIVE
Chapter 2. Administrative commands 89
CLEAN DRIVE

90 IBM Tivoli Storage Manager for Windows: Administrators Reference
COMMIT (Control committing of commands in a macro)
Use this command to control when a command is committed in a macro and to
update the database when commands complete processing. When issued from the
console mode of the administrative client, this command does not generate a
message.
If an error occurs while processing the commands in a macro, the server stops
processing the macro and rolls back any changes (since the last COMMIT). After a
command is committed, it cannot be rolled back.
Ensure that your administrative client session is not running with the
ITEMCOMMIT option if you want to control command processing. The
ITEMCOMMIT option commits commands inside a script or a macro as each
command is processed.
Privilege class
Any administrator can issue this command.
Syntax
COMMIT

Parameters
None.
Examples
Task
From the interactive mode of the administrative client, register and grant authority
to new administrators using a macro named REG.ADM. Changes are committed
after each administrator is registered and is granted authority.
Macro Contents:
/* REG.ADM-register policy admin & grant authority*/
REGister Admin sara hobby
GRant AUTHority sara CLasses=Policy
COMMIT /* Commits changes */
REGister Admin ken plane
GRant AUTHority ken CLasses=Policy
COMMIT /* Commits changes */
Command
macro reg.adm
Related commands
Table 35. Commands related to COMMIT
Command Description
MACRO Runs a specified macro file.
ROLLBACK Discards any uncommitted changes to the
database since the last COMMIT was
executed.
COMMIT
Chapter 2. Administrative commands 91
COMMIT

92 IBM Tivoli Storage Manager for Windows: Administrators Reference
CONVERT commands
Use this command to improve performance for the archive function when archive
data for a node is organized in packages.
v CONVERT ARCHIVE (Allow clients to query archive files by description) on
page 94
CONVERT commands
Chapter 2. Administrative commands 93
CONVERT ARCHIVE (Allow clients to query archive files by
description)
Use this command to improve performance for the archive function when archive
data for a node is organized in packages. Archive conversion is performed for a
node.
The performance improvements are more noticeable when the node has large
quantities of archived files and directories. This command is designed for nodes
that use the API or command-line interface. The operation is performed
automatically when nodes use the GUI or Web interfaces.
You can also issue the CONVERT ARCHIVE command after UNDO
ARCHCONVERSION has been issued to audit a nodes archive packages or
because the UPDATE ARCHIVE command was issued. See the Administrators
Guide for details.
Privilege class
To issue this command, you must have policy privilege for the policy domain for
the node.
Syntax

CONVert Archive

node_name
Wait = No
Wait

=

No

Yes

Parameters
node_name (Required)
Specifies the name of the node to be converted. This name must not contain
any wildcard characters.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is NO. Possible
values are:
No
Specifies that the server processes this command in the background.
Yes
Specifies that the server processes this command in the foreground
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Perform a background conversion of the client node JAN:
Command
convert archive jan wait=no
CONVERT ARCHIVE

94 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 36. Commands related to CONVERT ARCHIVE
Command Description
UNDO ARCHCONVERSION Reverses archive conversion for the node.
UPDATE ARCHIVE Manages archive usage and performance.

CONVERT ARCHIVE
Chapter 2. Administrative commands 95
COPY commands
Use the COPY commands to create a copy of Tivoli Storage Manager objects.
The following is a list of COPY commands for Tivoli Storage Manager:
v COPY ACTIVEDATA (Copy active backup data from a primary storage pool to
an active-data pool) on page 97
v COPY CLOPTSET (Copy a client option set) on page 101
v COPY DOMAIN (Copy a policy domain) on page 102
v COPY MGMTCLASS (Copy a management class) on page 104
v COPY POLICYSET (Copy a policy set) on page 106
v COPY PROFILE (Copy a profile) on page 108
v COPY SCHEDULE (Copy a client or an administrative command schedule) on
page 110
v COPY SCRIPT (Copy a Tivoli Storage Manager script) on page 114
v COPY SERVERGROUP (Copy a server group) on page 115
COPY commands

96 IBM Tivoli Storage Manager for Windows: Administrators Reference
COPY ACTIVEDATA (Copy active backup data from a primary
storage pool to an active-data pool)
Use this command to copy active versions of backup data from a primary storage
pool to an active-data pool. The primary benefit of active-data pools is fast client
restores. Copy your active data regularly to ensure that the data is protected in
case of a disaster.
If a file already exists in the active-data pool, the file is not copied unless the copy
of the file in the active-data pool is marked damaged. However, a new copy is not
created if the file in the primary storage pool is also marked damaged. In a
random-access storage pool, neither cached copies of migrated files nor damaged
primary files are copied.
If migration for a storage pool starts while active data is being copied, some files
might be migrated before they are copied. For this reason, you should copy active
data from storage pools that are higher in the migration hierarchy before copying
active data from storage pools that are lower. Be sure a copy process is complete
before beginning another.
Note: You can only copy active data from storage pools that have a data format of
NATIVE or NONBLOCK.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the active-data pool from which active
versions of backup data are being copied.
Syntax
COPY ACTIVEdata primary_pool_name active-data_pool_name

MAXProcess = 1
MAXProcess

=

number
Preview = No
Preview

=

No

Yes

(1)

VOLumesonly

Wait = No
Wait

=

No

Yes
SHREDTONOshred = No
SHREDTONOshred

=

No

Yes

Notes:
1 The VOLUMESONLY option applies to sequential-access storage pools only.
Parameters
primary_pool_name (Required)
Specifies the primary storage pool.
active_data_pool_name (Required)
Specifies the active-data pool.
COPY ACTIVEDATA
Chapter 2. Administrative commands 97
MAXProcess
Specifies the maximum number of parallel processes to use for copying files.
This parameter is optional. Enter a value from 1 to 999. The default is 1.
Using multiple, parallel processes may improve throughput for the COPY
ACTIVEDATA command. The expectation is that the time needed to copy
active data will be decreased by using multiple processes. However, when
multiple processes are running, in some cases one or more of the processes
might need to wait to use a volume that is already in use by a different COPY
ACTIVEDATA process.
When determining this value, consider the number of logical and physical
drives that can be dedicated to this operation. To access a sequential-access
volume, Tivoli Storage Manager uses a mount point and, if the device type is
not FILE, a physical drive. The number of available mount points and drives
depends on other Tivoli Storage Manager and system activity and on the
mount limits of the device classes for the sequential-access storage pools that
are involved when copying active data.
Each process needs a mount point for active-data pool volumes, and, if the
device type is not FILE, each process also needs a drive. If you are copying
active data from a sequential-access storage pool, each process needs an
additional mount point for primary storage pool volumes and, if the device
type is not FILE, an additional drive. For example, suppose you specify a
maximum of 3 processes to copy a primary sequential storage pool to an
active-data pool of the same device class. Each process requires two mount
points and two drives. To run all three processes, the device class must have a
mount limit of at least six, and at least six mount points and six drives must be
available.
To use the PREVIEW option, only one process is used, and no mount points or
drives are needed.
Preview
Specifies whether you want to preview but not actually copy any active data.
The preview displays the number of files and bytes to be copied and a list of
the primary storage pool volumes that you must mount. This parameter is
optional. The default is NO. Possible values are:
No
Specifies that active data will be copied.
Yes
Specifies that you want to preview the process but not copy any data.
VOLumesonly
Specifies that you want to preview the process only as a list of the volumes
that must be mounted. This choice requires the least processing time.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is NO. Possible
values are:
No
Specifies that the server processes this command in the background.
You can continue with other tasks while the command is being processed.
Messages created from the background process are displayed either in the
activity log or the server console, depending on where messages are
logged.
COPY ACTIVEDATA

98 IBM Tivoli Storage Manager for Windows: Administrators Reference
To cancel a background process, use the CANCEL PROCESS command. If
you cancel this process, some files may have already been copied prior to
the cancellation.
Yes
Specifies that the server performs this operation in the foreground. You
must wait for the operation to complete before continuing with other tasks.
The server displays the output messages to the administrative client when
the operation completes.
You cannot specify WAIT=YES from the server console.
SHREDTONOshred
Specifies whether data should be copied from a primary storage pool that
enforces shredding to an active-data pool that does not enforce shredding. This
parameter is optional. The default value is NO. Possible values are:
No
Specifies that the server does not allow data to be copied from a primary
storage pool that enforces shredding to an active-data pool that does not
enforce shredding. If the primary storage pool enforces shredding and the
active-data pool does not, the operation will fail.
Yes
Specifies that the server does allow data to be copied from a primary
storage pool that enforces shredding to an active-data pool that does not
enforce shredding. The data in the active-data pool will not be shredded
when it is deleted.
Examples
Task
Copy the active data from a primary storage pool named PRIMARY_POOL to the
active-data pool named ACTIVEPOOL.
Command
copy activedata primary_pool activepool
Related commands
Table 37. Commands related to COPY ACTIVEDATA
Command Description
DEFINE DOMAIN Defines a policy domain that clients can be
assigned to.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
EXPORT NODE Copies client node information to external
media.
EXPORT SERVER Copies all or part of the server to external
media.
IMPORT NODE Restores client node information from
external media.
IMPORT SERVER Restores all or part of the server from
external media.
MOVE NODEDATA Moves data for one or more nodes, or a
single node with selected filespaces.
COPY ACTIVEDATA
Chapter 2. Administrative commands 99
Table 37. Commands related to COPY ACTIVEDATA (continued)
Command Description
QUERY CONTENT Displays information about files in a storage
pool volume.
QUERY DOMAIN Displays information about policy domains.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY NODEDATA Displays information about the location and
size of data for a client node.
QUERY STGPOOL Displays information about storage pools.
RESTORE STGPOOL Restores files to a primary storage pool from
copy storage pools.
RESTORE VOLUME Restores files stored on specified volumes in
a primary storage pool from copy storage
pools.
UPDATE DOMAIN Changes the attributes of a policy domain.
UPDATE STGPOOL Changes the attributes of a storage pool.

COPY ACTIVEDATA

100 IBM Tivoli Storage Manager for Windows: Administrators Reference
COPY CLOPTSET (Copy a client option set)
Use this command to copy a client option set.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the client
node is assigned.
Syntax
COPy CLOptset current_option_set_name new_option_set_name

Parameters
current_option_set_name (Required)
Specifies the name of the client option set to be copied.
new_option_set_name (Required)
Specifies the name of the new client option set. The maximum length of the
name is 64 characters.
Examples
Task
Copy a client option set named ENG to a new client option set named ENG2.
Command
copy cloptset eng eng2
Related commands
Table 38. Commands related to COPY CLOPTSET
Command Description
DEFINE CLIENTOPT Adds a client option to a client option set.
DEFINE CLOPTSET Defines a client option set.
DELETE CLIENTOPT Deletes a client option from a client option
set.
DELETE CLOPTSET Deletes a client option set.
QUERY CLOPTSET Displays information about a client option
set.
UPDATE CLIENTOPT Updates the sequence number of a client
option.
UPDATE CLOPTSET Updates the description of a client option set.

COPY CLOPTSET
Chapter 2. Administrative commands 101
COPY DOMAIN (Copy a policy domain)
Use this command to create a copy of a policy domain.
The server copies the following information to the new domain:
v Policy domain description
v Policy sets in the policy domain (including the ACTIVE policy set, if a policy set
has been activated)
v Management classes in each policy set (including the default management class,
if assigned)
v Copy groups in each management class
Privilege class
To issue this command, you must have system privilege.
Syntax
COPy DOmain current_domain_name new_domain_name

Parameters
current_domain_name (Required)
Specifies the policy domain to copy.
new_domain_name (Required)
Specifies the name of the new policy domain. The maximum length of this
name is 30 characters.
Examples
Task
Copy the policy domain PROG1 to new policy domain PROG2.
Command
copy domain prog1 prog2
Related commands
Table 39. Commands related to COPY DOMAIN
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
COPY MGMTCLASS Creates a copy of a management class.
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DEFINE DOMAIN Defines a policy domain that clients can be
assigned to.
DEFINE MGMTCLASS Defines a management class.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
DELETE COPYGROUP Deletes a backup or archive copy group from
a policy domain and policy set.
COPY DOMAIN

102 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 39. Commands related to COPY DOMAIN (continued)
Command Description
DELETE DOMAIN Deletes a policy domain along with any
policy objects in the policy domain.
DELETE MGMTCLASS Deletes a management class and its copy
groups from a policy domain and policy set.
QUERY COPYGROUP Displays the attributes of a copy group.
QUERY DOMAIN Displays information about policy domains.
QUERY MGMTCLASS Displays information about management
classes.
QUERY POLICYSET Displays information about policy sets.
REGISTER NODE Defines a client to the server and sets options
for that user.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.
UPDATE DOMAIN Changes the attributes of a policy domain.
UPDATE MGMTCLASS Changes the attributes of a management
class.
UPDATE POLICYSET Changes the description of a policy set.
VALIDATE POLICYSET Verifies and reports on conditions the
administrator must consider before activating
the policy set.

COPY DOMAIN
Chapter 2. Administrative commands 103
COPY MGMTCLASS (Copy a management class)
Use this command to create a copy of a management class within the same policy
set.
The server copies the following information to the new management class:
v Management class description
v Copy groups defined to the management class
v Any attributes for managing files for HSM clients
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the new
management class belongs.
Syntax
COPy MGmtclass domain_name policy_set_name
current_class_name new_class_name

Parameters
domain_name (Required)
Specifies the policy domain to which the management class belongs.
policy_set_name (Required)
Specifies the policy set to which the management class belongs.
current_class_name (Required)
Specifies the management class to copy.
new_class_name (Required)
Specifies the name of the new management class. The maximum length of this
name is 30 characters.
Examples
Task
Copy the management class ACTIVEFILES to a new management class,
FILEHISTORY. The management class is in policy set VACATION in the
EMPLOYEE_RECORDS policy domain.
Command
copy mgmtclass employee_records vacation
activefiles filehistory
Related commands
Table 40. Commands related to COPY MGMTCLASS
Command Description
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
COPY MGMTCLASS

104 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 40. Commands related to COPY MGMTCLASS (continued)
Command Description
DELETE MGMTCLASS Deletes a management class and its copy
groups from a policy domain and policy set.
QUERY COPYGROUP Displays the attributes of a copy group.
QUERY MGMTCLASS Displays information about management
classes.
QUERY POLICYSET Displays information about policy sets.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.
UPDATE MGMTCLASS Changes the attributes of a management
class.

COPY MGMTCLASS
Chapter 2. Administrative commands 105
COPY POLICYSET (Copy a policy set)
Use this command to copy a policy set (including the ACTIVE policy set) within
the same policy domain.
The server copies the following information to the new policy set:
v Policy set description
v Management classes in the policy set (including the default management class, if
assigned)
v Copy groups in each management class
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the new
policy set belongs.
Syntax
COPy POlicyset domain_name current_set_name new_set_name

Parameters
domain_name (Required)
Specifies the policy domain to which the policy set belongs.
current_set_name (Required)
Specifies the policy set to copy.
new_set_name (Required)
Specifies the name of the new policy set. The maximum length of this name is
30 characters.
Examples
Task
Copy the policy set VACATION to the new policy set HOLIDAY in the
EMPLOYEE_RECORDS policy domain.
Command
copy policyset employee_records vacation holiday
Related commands
Table 41. Commands related to COPY POLICYSET
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
COPY MGMTCLASS Creates a copy of a management class.
DEFINE MGMTCLASS Defines a management class.
DELETE POLICYSET Deletes a policy set, including its
management classes and copy groups, from a
policy domain.
QUERY POLICYSET Displays information about policy sets.
COPY POLICYSET

106 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 41. Commands related to COPY POLICYSET (continued)
Command Description
UPDATE POLICYSET Changes the description of a policy set.
VALIDATE POLICYSET Verifies and reports on conditions the
administrator must consider before activating
the policy set.

COPY POLICYSET
Chapter 2. Administrative commands 107
COPY PROFILE (Copy a profile)
Use this command on a configuration manager to copy a profile and all its
associated object names to a new profile.
Privilege class
To issue this command, you must have system privilege.
Syntax
COPy PROFIle current_profile_name new_profile_name

Parameters
current_profile_name (Required)
Specifies the profile to copy.
new_profile_name (Required)
Specifies the name of the new profile. The maximum length of the profile
name is 30 characters.
Examples
Task
Copy a profile named VAL to a new profile named VAL2.
Command
copy profile val val2
Related commands
Table 42. Commands related to COPY PROFILE
Command Description
DEFINE PROFASSOCIATION Associates objects with a profile.
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
DEFINE SUBSCRIPTION Subscribes a managed server to a profile.
DELETE PROFASSOCIATION Deletes the association of an object with a
profile.
DELETE PROFILE Deletes a profile from a configuration
manager.
DELETE SUBSCRIBER Deletes obsolete managed server
subscriptions.
DELETE SUBSCRIPTION Deletes a specified profile subscription.
LOCK PROFILE Prevents distribution of a configuration
profile.
NOTIFY SUBSCRIBERS Notifies servers to refresh their configuration
information.
QUERY PROFILE Displays information about configuration
profiles.
QUERY SUBSCRIBER Displays information about subscribers and
their subscriptions to profiles.
COPY PROFILE

108 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 42. Commands related to COPY PROFILE (continued)
Command Description
QUERY SUBSCRIPTION Displays information about profile
subscriptions.
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UNLOCK PROFILE Enables a locked profile to be distributed to
managed servers.
UPDATE PROFILE Changes the description of a profile.

COPY PROFILE
Chapter 2. Administrative commands 109
COPY SCHEDULE (Copy a client or an administrative
command schedule)
Use this command to create a copy of a schedule.
The COPY SCHEDULE command takes two forms, depending on whether the
schedule applies to client operations or administrative commands. The syntax and
parameters for each form are defined separately.
Table 43. Commands related to COPY SCHEDULE
Command Description
DEFINE ASSOCIATION Associates clients with a schedule.
DEFINE SCHEDULE Defines a schedule for a client operation or
an administrative command.
DELETE SCHEDULE Deletes a schedule from the database.
QUERY SCHEDULE Displays information about schedules.
UPDATE SCHEDULE Changes the attributes of a schedule.
COPY SCHEDULE

110 IBM Tivoli Storage Manager for Windows: Administrators Reference
COPY SCHEDULE client
Use the COPY SCHEDULE command to create a copy of a schedule for client
operations. You can copy a schedule within a policy domain or from one policy
domain to another policy domain. Use the DEFINE ASSOCIATION command to
associate the new schedule with the client nodes.
Privilege class
To copy a client schedule, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which you are
copying the schedule.
Syntax
COPy SCHedule current_domain_name current_sched_name new_domain_name

current_sched_name
new_sched_name
REPlace = No
REPlace

=

No

Yes

Parameters
current_domain_name (Required)
Specifies the name of the policy domain that contains the schedule you want to
copy.
current_sched_name (Required)
Specifies the name of the schedule you want to copy.
new_domain_name (Required)
Specifies the name of a policy domain to which you want to copy the new
schedule.
new_sched_name
Specifies the name of the new schedule. You can specify up to 30 characters for
the name.
If you do not specify this name, the name of the original schedule is used.
If the schedule name is already defined in the policy domain, you must specify
REPLACE=YES, or the command fails.
REPlace
Specifies whether to replace a client schedule. The default is NO. The values
are:
No
Specifies that a client schedule is not replaced.
Yes
Specifies that a client schedule is replaced.
Examples
Task
COPY SCHEDULE Client
Chapter 2. Administrative commands 111
Copy the WEEKLY_BACKUP schedule that belongs to policy domain
EMPLOYEE_RECORDS to the PROG1 policy domain and name the new schedule
WEEKLY_BACK2. If there is already a schedule with this name defined in the
PROG1 policy domain, do not replace it.
Command
copy schedule employee_records weekly_backup
prog1 weekly_back2
COPY SCHEDULE Client

112 IBM Tivoli Storage Manager for Windows: Administrators Reference
COPY SCHEDULE administrative command
Use the COPY SCHEDULE command to create a copy of an administrative
command schedule.
Privilege class
To copy an administrative command schedule, you must have system privilege.
Syntax
COPy SCHedule current_sched_name new_sched_name Type = Administrative

REPlace = No
REPlace

=

No

Yes

Parameters
current_schedule_name (Required)
Specifies the name of the schedule you want to copy.
new_schedule_name (Required)
Specifies the name of the new schedule. You can specify up to 30 characters for
the name.
If the schedule name is already defined, you must specify REPLACE=YES, or
the command fails.
Type=Administrative
Specifies that an administrative command schedule is to be copied.
REPlace
Specifies whether to replace an administrative command schedule. The default
is NO. The values are:
No
Specifies that an administrative command schedule is not replaced.
Yes
Specifies that an administrative command schedule is replaced.
Examples
Task
Copy the administrative command schedule, DATA_BACKUP and name the
schedule DATA_ENG. If there is already a schedule with this name, replace it.
Command
copy schedule data_backup data_eng
type=administrative replace=yes
COPY SCHEDULE Administrative Command
Chapter 2. Administrative commands 113
COPY SCRIPT (Copy a Tivoli Storage Manager script)
Use this command to copy a Tivoli Storage Manager script to a new script.
Privilege class
To issue this command, you must have operator, policy, storage, or system
privilege.
Syntax
COPy SCRipt current_script_name new_script_name

Parameters
current_script_name (Required)
Specifies the name of the script you want to copy.
new_script_name (Required)
Specifies the name of the new script. You can specify up to 30 characters for
the name.
Examples
Task
Copy script TESTDEV to a new script and name it ENGDEV.
Command
copy script testdev engdev
Related commands
Table 44. Commands related to COPY SCRIPT
Command Description
DEFINE SCRIPT Defines a script to the IBM Tivoli Storage
Manager server.
DELETE SCRIPT Deletes the script or individual lines from the
script.
QUERY SCRIPT Displays information about scripts.
RENAME SCRIPT Renames a script to a new name.
RUN Runs a script.
UPDATE SCRIPT Changes or adds lines to a script.

COPY SCRIPT

114 IBM Tivoli Storage Manager for Windows: Administrators Reference
COPY SERVERGROUP (Copy a server group)
Use this command to create a copy of a server group.
Privilege class
To issue this command, you must have system privilege.
Syntax
COPy SERVERGRoup current_group_name new_group_name

Parameters
current_group_name (Required)
Specifies the server group to copy.
new_group_name (Required)
Specifies the name of the new server group. The maximum length of this name
is 64 characters.
Examples
Task
Copy the server group GRP_PAYROLL to the new group HQ_PAYROLL.
Command
copy servergroup grp_payroll hq_payroll
Related commands
Table 45. Commands related to COPY SERVERGROUP
Command Description
DEFINE GRPMEMBER Defines a server as a member of a server
group.
DEFINE SERVER Defines a server for server-to-server
communications.
DEFINE SERVERGROUP Defines a new server group.
DELETE GRPMEMBER Deletes a server from a server group.
DELETE SERVER Deletes the definition of a server.
DELETE SERVERGROUP Deletes a server group.
MOVE GRPMEMBER Moves a server group member.
QUERY SERVER Displays information about servers.
QUERY SERVERGROUP Displays information about server groups.
RENAME SERVERGROUP Renames a server group.
UPDATE SERVER Updates information about a server.
UPDATE SERVERGROUP Updates a server group.

COPY SERVERGROUP
Chapter 2. Administrative commands 115
DEFINE commands
Use the DEFINE commands to create Tivoli Storage Manager objects.
The following is a list of DEFINE commands for Tivoli Storage Manager:
v DEFINE ASSOCIATION (Associate client nodes with a schedule) on page 118
v DEFINE BACKUPSET (Define a backup set) on page 120
v DEFINE CLIENTACTION (Define a one-time client action) on page 125
v DEFINE CLIENTOPT (Define an option to an option set) on page 130
v DEFINE CLOPTSET (Define a client option set name) on page 134
v DEFINE COLLOCGROUP (Define a collocation group) on page 135
v DEFINE COLLOCMEMBER (Define collocation group member) on page 137
v DEFINE COPYGROUP (Define a copy group) on page 139
v DEFINE DATAMOVER (Define a data mover) on page 149
v DEFINE DBBACKUPTRIGGER (Define the database backup trigger) on page
152
v DEFINE DBCOPY (Define a volume copy of a database volume) on page 154
v DEFINE DBVOLUME (Define a database volume) on page 156
v DEFINE DEVCLASS (Define a device class) on page 158
v DEFINE DOMAIN (Define a new policy domain) on page 229
v DEFINE DRIVE (Define a drive to a library) on page 232
v DEFINE EVENTSERVER (Define a server as the event server) on page 237
v DEFINE GRPMEMBER (Add a server to a server group) on page 238
v DEFINE LIBRARY (Define a library) on page 240
v DEFINE LOGCOPY (Define a volume copy of a recovery log volume) on page
250
v DEFINE LOGVOLUME (Define a recovery log volume) on page 252
v DEFINE MACHINE (Define machine information) on page 254
v DEFINE MACHNODEASSOCIATION (Associate a node with a machine) on
page 256
v DEFINE MGMTCLASS (Define a management class) on page 258
v DEFINE NODEGROUP (Define a node group) on page 261
v DEFINE NODEGROUPMEMBER (Define node group member) on page 262
v DEFINE PATH (Define a path) on page 263
v DEFINE POLICYSET (Define a policy set) on page 271
v DEFINE PROFASSOCIATION (Define a profile association) on page 273
v DEFINE PROFILE (Define a profile) on page 279
v DEFINE RECMEDMACHASSOCIATION (Associate recovery media with a
machine) on page 281
v DEFINE RECOVERYMEDIA (Define recovery media) on page 283
v DEFINE SCHEDULE (Define a client or an administrative command schedule)
on page 285
v DEFINE SCRIPT (Define a Tivoli Storage Manager script) on page 307
v DEFINE SERVER (Define a server for server-to-server communications) on
page 310
v DEFINE SERVERGROUP (Define a server group) on page 315
v DEFINE SPACETRIGGER (Define the space trigger) on page 316
DEFINE commands

116 IBM Tivoli Storage Manager for Windows: Administrators Reference
v DEFINE STGPOOL (Define a storage pool) on page 321
v DEFINE SUBSCRIPTION (Define a profile subscription) on page 359
v DEFINE VIRTUALFSMAPPING (Define a virtual file space mapping) on page
361
v DEFINE VOLUME (Define a volume in a storage pool) on page 363
DEFINE commands
Chapter 2. Administrative commands 117
DEFINE ASSOCIATION (Associate client nodes with a
schedule)
Use this command to associate one or more clients with a schedule. You must
assign a client node to the policy domain to which a schedule belongs. Client
nodes process operations according to the schedules associated with the nodes.
Note:
1. Tivoli Storage Manager cannot run multiple schedules concurrently for
the same client node.
2. In a macro, the server may stall if some commands (such as REGISTER
NODE and DEFINE ASSOCIATION) are not committed as soon as you
issue them. You could follow each command in a macro with a COMMIT
command. However, a simpler solution is to include the -ITEMCOMMIT
option with the DSMADMC command.
Privilege class
To perform this task, you must have one of the following privilege classes:
v System privilege
v Unrestricted policy privilege
v Restricted policy privilege for the policy domain to which the schedule belongs
Syntax

DEFine ASSOCiation

domain_name

schedule_name

,
node_name

Parameters
domain_name (Required)
Specifies the name of the policy domain to which the schedule belongs.
schedule_name (Required)
Specifies the name of the schedule that you want to associate with one or more
clients.
node_name (Required)
Specifies the name of a client node or a list of client nodes to associate with the
specified schedule. Use commas to separate the items in the list. Do not leave
spaces between the items and commas. You can use a wildcard character to
specify a name. The command will not associate a listed client to the schedule
if:
v The client is already associated with the specified schedule.
v The client is not assigned to the policy domain to which the schedule
belongs.
v The client is a NAS node name. All NAS nodes are ignored.
Examples
Task 1
Associate the client nodes SMITH or JOHN with the WEEKLY_BACKUP schedule.
The associated clients are assigned to the EMPLOYEE_RECORDS policy domain.
DEFINE ASSOCIATION

118 IBM Tivoli Storage Manager for Windows: Administrators Reference
Command
define association employee_records
weekly_backup smith*,john*
Task 2
Associate the client nodes JOE, TOM, and LARRY with the WINTER schedule. The
associated clients are assigned to the EMPLOYEE_RECORDS policy domain;
however, the client JOE is already associated with the WINTER schedule.
Command
define association employee_records
winter joe,tom,larry
Related commands
Table 46. Commands related to DEFINE ASSOCIATION
Command Description
DEFINE SCHEDULE Defines a schedule for a client operation or
an administrative command.
DELETE ASSOCIATION Deletes the association between clients and a
schedule.
DELETE SCHEDULE Deletes a schedule from the database.
QUERY ASSOCIATION Displays the clients associated with one or
more schedules.
REGISTER NODE Defines a client to the server and sets options
for that user.

DEFINE ASSOCIATION
Chapter 2. Administrative commands 119
DEFINE BACKUPSET (Define a backup set)
Use this command to define a client backup set that was previously generated on
one server and make it available to the server running this command. The client
node has the option of restoring the backup set from the server running this
command rather than the one on which the backup set was generated.
Any backup set generated on one server can be defined to another server as long
as the servers share a common device type. The level of the server to which the
backup set is being must be equal to or greater than the level of the server that
generated the backup set.
You can also use the DEFINE BACKUPSET command to redefine a backup set that
was deleted on a server.
Privilege class
If the REQSYSAUTHOUTFILE server option is set to YES (the default), the
administrator must have system privilege. If the REQSYSAUTHOUTFILE server
option is set to NO, the administrator must have system privilege or policy
privilege for the domain to which the client node is assigned.
Syntax

,
DEFine BACKUPSET

node_name

node_group_name

backup_set_name_prefix

DEVclass

=

device_class_name

,
VOLumes

=

volume_names

RETention = 365
RETention

=

days

NOLimit

DESCription

=

description

WHEREDATAType = ALL
,

WHEREDATAType

=

FILE

IMAGE

APPL

TOC

=

PREFERRED

YES

NO

TOCMGmtclass

=

class_name


Parameters
node_name or node_group_name (Required)
Specifies the name of the client nodes or node groups whose data is contained
in the specified backup set volumes. To specify multiple node and node group
DEFINE BACKUPSET

120 IBM Tivoli Storage Manager for Windows: Administrators Reference
names, separate the names with commas and no intervening spaces. Node
names can contain wildcard characters, but node group names cannot. If the
backup set volumes contain backup sets from multiple nodes, every backup set
whose node name matches one of the specified node names will be defined. If
the volumes contain a backup set for a node that is not currently registered,
the DEFINE BACKUPSET command will not define the backup set for that
node.
backup_set_name_prefix (Required)
Specifies the name of the backup set to define to this server. The maximum
length of the name is 30 characters.
When you select a name, Tivoli Storage Manager adds a suffix to construct the
backup set name. For example, if you name your backup set mybackupset,
Tivoli Storage Manager adds a unique number such as 3099 to the name. Your
backup set name is then identified as mybackupset.3099. To later display
information about this backup set, you can include a wildcard with the name,
such as mybackupset* or you can specify the fully qualified name, such as
mybackupset.3099.
If the backup set volumes contain backup sets for multiple nodes, then backup
sets will be defined for each of the nodes using the same backup set name
prefix and suffix.
DEVclass (Required)
Specifies the device class name for the volumes from which the backup set is
read.
Note: The device type associated with the device class you specify must match
the device class with which the backup set was originally generated.
VOLumes (Required)
Specifies the names of the volumes used to store the backup set. You can
specify multiple volumes by separating the names with commas and no
intervening spaces. The volumes you specify must be available to the server
that is defining the backup set.
Note: The volumes you specify must be listed in the order they were created,
or the DEFINE BACKUPSET command will fail.
The server does not verify that every volume specified for a multiple-volume
backup set actually contains part of the backup set. The first volume is always
checked, and in some cases additional volumes are also checked. If these
volumes are correct, the backup set is defined and all of the volumes listed in
the command are protected from being overwritten. If a volume that contains
part of the backup set is not listed in the command, the volume will not be
protected and can potentially be overwritten during normal server operations.
Note: By default, the server attempts to create a table of contents when a
backup set is defined. If an incorrect volume is specified, or if volumes
are not listed in the correct order, the table of contents creation will fail.
If this occurs, check the volume list in the command and consider using
the QUERY BACKUPSETCONTENTS command to verify the contents of
the backup set.
RETention
Specifies the number of days that the backup set is retained on the server. You
can specify an integer from 0 to 30000. The default is 365 days. The values are:
DEFINE BACKUPSET
Chapter 2. Administrative commands 121
|
|
|
|
|
|
|
|
|
|
|
|
|
days
Specifies the number of days to retain the backup set on the server.
NOLimit
Specifies that the backup set should be retained on the server indefinitely.
If you specify NOLIMIT, Tivoli Storage Manager retains the volumes
containing the backup set forever, unless a user or administrator deletes
the volumes from server storage.
DESCription
Specifies the description to associate with the backup set that belongs to the
client node. This parameter is optional. The maximum length of the description
is 255 characters. Enclose the description in quotation marks if it contains any
blank characters.
WHEREDATAType
Specifies the backup sets containing the specified types of data are to be
defined. This parameter is optional. The default is that backup sets for all types
of data (file level, image, and application) are to be defined. To specify
multiple data types, separate the data types with commas and no intervening
spaces. Possible values are:
ALL
Specifies that backup sets for all types of data (file level, image, and
application) are to be defined. This is the default.
FILE
Specifies that a file level backup set is to be defined. File level backup sets
contain files and directories backup up by the backup-archive client.
IMAGE
Specifies that an image backup set is to be defined. Image backup sets
contain images created by the backup-archive client BACKUP IMAGE
command.
APPL
Specifies that an application backup set is to be defined. Application
backup sets contain data backed up to the Tivoli Storage Manager server
by applications using the Tivoli Storage Manager application programming
interface. This parameter applies only if the Tivoli Storage Manager server
was upgraded from Tivoli Storage Manager Express and only for the Tivoli
Storage Manager Express versions of Data Protection for Exchange and
Data Protection for SQL.
TOC
Specifies whether a table of contents (TOC) should be created for the file level
backup set when it is defined. The TOC parameter is ignored when defining
image and application data backup sets because a table of contents is always
created for these backup sets.
Consider the following in determining whether you want to create a table of
contents:
v If a table of contents is created, you can use the Tivoli Storage Manager Web
backup-archive client to examine the entire file system tree and choose files
and directories to restore. Creation of a table of contents requires that you
define the TOCDESTINATION attribute in the backup copy group for the
management class specified by the TOCMGMTCLASS parameter. Note that
a table of contents creation requires additional processing, storage pool
space, and possibly a mount point during the backup set operation.
DEFINE BACKUPSET

122 IBM Tivoli Storage Manager for Windows: Administrators Reference
v If a table of contents is not saved for a backup set, you can still restore
individual files or directory trees using the backup-archive client RESTORE
BACKUPSET command, provided that you know the fully qualified name of
each file or directory to be restored.
This parameter is optional. The default value is Preferred. Possible values are:
No
Specifies that table of contents information is not saved for file level
backup sets.
Preferred
Specifies that table of contents information should be saved for file level
backup sets. However, a backup set does not fail just because an error
occurs during creation of the table of contents.
Yes
Specifies that table of contents information must be saved for each file
level backup set. A backup set fails if an error occurs during creation of the
table of contents.
TOCMGmtclass
Specifies the name of the management class to which the table of contents
should be bound. If you do not specify a management class, the table of
contents is bound to the default management class for the policy domain to
which the node is assigned. In this case, creation of a table of contents requires
that you define the TOCDESTINATION attribute in the backup copy group for
the specified management class.
Examples
Task
Define the PERS_DATA backup set that belongs to client node JANE to the server
running this command. Retain the backup set on the server for 50 days. Specify
that volumes VOL001 and VOL002 contain the data for the backup set. The
volumes are to be read by a device that is assigned to the AGADM device class.
Include a description.
Command
define backupset jane pers_data devclass=agadm
volumes=vol1,vol2 retention=50
description="sector 7 base image"
Related commands
Table 47. Commands related to DEFINE BACKUPSET
Command Description
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DELETE NODEGROUP Deletes a node group.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
GENERATE BACKUPSETTOC Generates a table of contents for a backup
set.
DEFINE BACKUPSET
Chapter 2. Administrative commands 123
Table 47. Commands related to DEFINE BACKUPSET (continued)
Command Description
QUERY BACKUPSET Displays backup sets.
QUERY BACKUPSETCONTENTS Displays contents contained in backup sets.
QUERY NODEGROUP Displays information about node groups.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.
UPDATE NODEGROUP Updates the description of a node group.

DEFINE BACKUPSET

124 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE CLIENTACTION (Define a one-time client action)
Use this command to schedule one or more clients to process a command for a
one-time action.
The server automatically defines a schedule and associates the client node to the
schedule. The server assigns the schedule priority 1, sets the PERUNITS to
onetime, and determines the number of days to keep the schedule active. The
number of days is based on the value set with SET CLIENTACTDURATION
command.
How quickly the client processes this command depends on whether the
scheduling mode for the client is set to server-prompted or client-polling. The
client scheduler must be started on the client workstation in order for the server to
process the schedule.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy for the policy domain to which the schedule belongs.
Syntax

DEFine CLIENTAction

*
,

(1)

node_name

DOmain = *
,

DOmain

=

domain_name
Incremental
ACTion

=

Selective

Archive

REStore

RETrieve

IMAGEBACkup

IMAGEREStore

Command

Macro

OPTions

=

option_string

OBJects

=

object_string

Wait = No
Wait

=

No

Yes

Notes:
1 If you explicitly specify a NAS node name, the command will fail. If you
provide a pattern-matching expression for the node, any NAS nodes that
match the pattern will be ignored.
Parameters
node_name
Specifies the list of client nodes that will process the schedule associated with
the action. You can use a wildcard character to specify a client node or a list of
DEFINE CLIENTACTION
Chapter 2. Administrative commands 125
|
client nodes. Separate the client node names with commas and no intervening
spaces. If you do not specify a value, all client nodes will be scheduled for the
action.
DOmain
Specifies the list of policy domains used to limit the list of client nodes. Only
client nodes that are assigned to one of the specified policy domains will be
scheduled. All clients assigned to a matching domain will be scheduled.
Separate multiple domain names with commas and no intervening spaces. If
you do not specify a value, all policy domains will be included in the list.
ACTion
Specifies the action that occurs when this schedule is processed. Possible
values are:
Incremental
Specifies that the schedule backs up all files that are new or that have
changed since the last incremental backup. Incremental also backs up any
file for which all existing backups may have expired.
Selective
Specifies that the schedule backs up only files that are specified with the
OBJECTS parameter.
Archive
Specifies that the schedule archives files that are specified with the
OBJECTS parameter.
REStore
Specifies that the schedule restores files that are specified with the
OBJECTS parameter.
When you specify ACTION=RESTORE for a scheduled operation, and the
REPLACE option is set to PROMPT, no prompting occurs. If you set the
option to PROMPT, the files are skipped. If you specify a second file
specification, this second file specification acts as the restore destination. If
you need to restore multiple groups of files, schedule one for each file
specification that you need to restore.
RETrieve
Specifies that the schedule retrieves files that are specified with the
OBJECTS parameter.
IMAGEBACkup
Specifies that the schedule backs up logical volumes that are specified with
the OBJECTS parameter.
IMAGEREStore
Specifies that the schedule restores logical volumes that are specified with
the OBJECTS parameter.
Command
Specifies that the schedule processes a client operating system command or
script that is specified with the OBJECTS parameter.
Macro
Specifies that a client processes a macro whose file name is specified with
the OBJECTS parameter.
OPTions
Specifies the client options that you specify to the scheduled command at the
time the schedule is processed. This parameter is optional.
DEFINE CLIENTACTION

126 IBM Tivoli Storage Manager for Windows: Administrators Reference
Only those options that are valid on the scheduled command may be specified
for this parameter. Refer to the appropriate client manual for information about
options that are valid from the command line. All options described there as
valid only on the initial command line will either result in an error or simply
be ignored when the schedule from the server is run. For example, do not
include the following options because they have no effect when the client
processes the scheduled command:
MAXCMDRETRIES
OPTFILE
QUERYSCHEDPERIOD
RETRYPERIOD
SCHEDLOGNAME
SCHEDMODE
SERVERNAME
TCPCLIENTADDRESS
TCPCLIENTPORT
When you define a scheduler service by using the DSMCUTIL command or the
wizard in the backup-archive client GUI, you specify an options file for the
scheduler service to use. You cannot override the options in that options file by
issuing the scheduled command. You must modify the options in your
scheduler service.
If the option string contains multiple options or options with embedded
spaces, surround the entire option string with one pair of single quotes.
Individual options that contain spaces should be enclosed in double quotes. A
leading minus sign is required in front of the option. Errors can occur if the
option string contains spaces that are not quoted correctly.
The following examples show how to specify some client options:
v To specify subdir=yes and domain all-local -systemobject, enter:
options=-subdir=yes -domain="all-local -c: -systemobject"
v To specify domain all-local -c: -d:, enter:
options=-domain="all-local -c: -d:"
Note: For Windows clients running in batch mode: If the use of double
quotes is necessary, use interactive mode (Processing a series of
commands from the administrative client on page 3) or operating
system escape characters. See Processing commands one at a time from
the administrative client on page 3 for additional information.
OBJects
Specifies the objects for which the specified action is performed. Use a single
space between each object. This parameter is required except when
ACTION=INCREMENTAL. If the action is a backup, archive, retrieve, or
restore operation, the objects are file spaces, directories, or logical volumes. See
the Backup-Archive Clients Installation and Users Guide for command syntax
information. If the action is to run a command or macro, the object is the name
of the command or macro to run.
When you specify ACTION=INCREMENTAL without specifying a value for
this parameter, the scheduled command is invoked without specified objects
and attempts to process the objects as defined in the clients option file. To
select all file spaces or directories for an action, explicitly list them in the object
DEFINE CLIENTACTION
Chapter 2. Administrative commands 127
string. Entering only an asterisk in the object string causes the backup to occur
only for the directory where the scheduler was started.
Note:
1. If you specify a second file specification, and it is not a valid
destination, you receive this error:
ANS1082E Invalid destination file specification <filespec> entered.
2. If you specify more than two file specifications, you receive this
error:
ANS1102E Excessive number of command line arguments passed to the
program!
When you specify ACTION=ARCHIVE, INCREMENTAL, or SELECTIVE for
this parameter, you can list a maximum of twenty (20) file specifications.
Enclose the object string in double quotes if it contains blank characters
(spaces), and then surround the double quotes with single quotes. If the object
string contains multiple file names, enclose each file name with its own pair of
double quotes, then surround the entire string with one pair of single quotes.
Errors can occur if file names contain a space that is not quoted correctly. The
following examples show how to specify some file names:
v To specify C:\FILE 2, D:\GIF FILES, and E:\MY TEST FILE, enter:
OBJECTS="C:\FILE 2" "D:\GIF FILES" "E:\MY TEST FILE"
v To specify D:\TEST FILE, enter:
OBJECTS="D:\TEST FILE"
Note: For Windows clients running in batch mode: If the use of double
quotes is necessary, use interactive mode (Processing a series of
commands from the administrative client on page 3) or operating
system escape characters. See Processing commands one at a time from
the administrative client on page 3 for additional information.
Wait
Specifies whether to wait for a scheduled client operation to complete before
processing the next step in a command script or macro. This parameter is
optional. The default is No. Possible values are:
No
Specifies that you do not wait for the scheduled client operation to
complete before processing the next step in the command script or macro.
Yes
Specifies that you wait for the scheduled client operation to complete
before processing the next step in the command script or macro.
You cannot issue the DEFINE CLIENTACTION command with WAIT=YES
from the server console. However, from the server console, you can:
v Specify WAIT=YES with DEFINE CLIENTACTION as the command line
of a DEFINE SCRIPT command.
v Specify WAIT=YES with DEFINE CLIENTACTION as the command line
of a file whose contents will be read into the script that is defined by a
DEFINE SCRIPT command.
Note: If you specify the DEFINE CLIENTACTION command with
WAIT=YES in a macro, the immediate schedules defined by the
command will not roll back if the macro does not complete
successfully.
DEFINE CLIENTACTION

128 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task
Issue an incremental backup command for client node TOM assigned to policy
domain EMPLOYEE_RECORDS. Tivoli Storage Manager defines a schedule and
associates the schedule to client node TOM (assuming that the client scheduler is
running).
Command
define clientaction tom domain=employee_records
action=incremental
Related commands
Table 48. Commands related to DEFINE CLIENTACTION
Command Description
DELETE SCHEDULE Deletes a schedule from the database.
QUERY ASSOCIATION Displays the clients associated with one or
more schedules.
QUERY EVENT Displays information about scheduled and
completed events for selected clients.
QUERY SCHEDULE Displays information about schedules.
SET CLIENTACTDURATION Specifies the duration of a schedule defined
using the DEFINE CLIENTACTION
command.

DEFINE CLIENTACTION
Chapter 2. Administrative commands 129
DEFINE CLIENTOPT (Define an option to an option set)
Use this command to add a client option to an option set.
For details about the options and the values you can specify, refer to
Backup-Archive Clients Installation and Users Guide.
Privilege class
To issue this command, you must have system privilege or unrestricted policy
privilege.
Syntax
DEFine CLIENTOpt option_set_name option_name option_value

Force = No
Force

=

No

Yes

SEQnumber

=

number

Parameters
option_set_name (Required)
Specifies the name of the option set.
option_name (Required)
Specifies a client option to add to the option set. See Table 49 on page 131 for a
list of valid options. See the Backup-Archive Clients Installation and Users Guide
for details on the options.
Note: To add an include or exclude option, specify INCLEXCL as the option
_name. In the option_value, specify any valid include or exclude
statement, as you would in the client options file. For example:
define clientopt option_set_name inclexcl "include c:\proj\text\devel.*"
DEFINE CLIENTOPT

130 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 49. Valid options for option_name
v ARCHSYMLINKASFILE
1
v CASESENSITIVEAWARE
v CHANGINGRETRIES
v COLLOCATEBYFILESPEC
v COMPRESSALWAYS
v COMPRESSION
v DIRMC
v DISABLENQR
v DISKCACHELOCATION
v DOMAIN
v DOMAIN.IMAGE
7
v DOMAIN.NAS
10
v ENABLECLIENTENCRYPTKEY
8
v ENCRYPTIONTYPE
2
v ENCRYPTKEY
v EXCLUDE.FS.NAS
v INCLEXCL (use along with the specific include
or exclude option as the option value)
v INCLUDE.FS.NAS
6
v MANAGEDSERVICES
v MAXCANDPROCS
v MAXCMDRETRIES
v MAXMIGRATORS
v MEMORYEFFICIENTBACKUP
v NFSTIMEOUT
1
v POSTNSCHEDULECMD
9
v POSTSCHEDULECMD
v POSTSNAPSHOTCMD
v PRENSCHEDULECMD
9
v PRESCHEDULECMD
v PRESERVELASTACCESSDATE
v PRESNAPSHOTCMD
5
v QUERYSCHEDPERIOD
v QUIET
v RESETARCHIVEATTRIBUTE
v RESOURCEUTILIZATION
v RETRYPERIOD
v SCHEDMODE
v SCROLLLINES
v SCROLLPROMPT
v SLOWINCREMENTAL
v SNAPSHOTCACHELOCATION
5
v SNAPSHOTCACHESIZE
4
v SNAPSHOTFSIDLERETRIES
5
v SNAPSHOTFSIDLEWAIT
5
v SNAPSHOTPROVIDERFS
3
v SNAPSHOTPROVIDERIMAGE
3
v SNAPSHOTROOT
5
v SUBDIR
v SUBFILEBACKUP
5
v SUBFILECACHEPATH
5
v SUBFILECACHESIZE
5
v TAPEPROMPT
v TXNBYTELIMIT
v VERBOSE
v VMCHOST
5
v VMCPW
5
v VMCUSER
5
v VMLIST
5
v VSSALTSTAGINGDIR

Note:
1. UNIX only
2. UNIX and Linux only
3. UNIX and Windows only
4. Linux only
5. Windows only
6. AIX and Solaris only
7. AIX, HP-UX, and Solaris only
8. API only
9. Not valid on NetWare
10. Only applies to client-initiated NDMP backups
See the Backup-Archive Clients Installation and Users Guide for details on the
options.
option_value (Required)
Specifies the value for the option. If the option includes more than one value,
DEFINE CLIENTOPT
Chapter 2. Administrative commands 131
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
enclose the value in quotation marks. For the values you can specify with the
option refer to Backup-Archive Clients Installation and Users Guide.
Note:
1. The QUIET and VERBOSE options do not have an option value in
the client options file. To specify these values in a server client
option set, specify a value of YES or NO.
2. To add an INCLUDE or EXCLUDE option for a file name that
contains one or more spaces, put single quotes around the file
specification, and double quotes around the entire option. See
Examples for more information.
3. The option_value is limited to 1024 characters.
Force
Specifies whether the server forces the client to use the option set value. The
value is ignored for additive options, such as INCLEXCL and DOMAIN. The
default is NO. This parameter is optional. The values are:
Yes
Specifies that the server forces the client to use the value. (The client
cannot override the value.)
No
Specifies that the server does not force the client to use the value. (The
client can override the value.)
SEQnumber
Specifies a sequence number when an option name is specified more than
once. This parameter is optional.
Examples
Task
Add a client option (MAXCMDRETRIES 5) to a client option set named ENG.
Command
define clientopt eng maxcmdretries 5
Task
Add a client option to the option set ENGBACKUP to exclude the
c:\admin\file.txt from backup services.
Command
define clientopt engbackup inclexcl "exclude c:\admin\file.txt"
Task
Add a client option to the option set WINSPEC to exclude a temporary internet
directory from backup services. When you use the EXCLUDE or INCLUDE option
with file names that contain spaces, put single quotes around the file specification,
then double quotes around the entire option.
Command
define clientopt winspec inclexcl "exclude.dir *:\...\Temporary
Internet Files"
Task
DEFINE CLIENTOPT

132 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
Add client options to the option set WINSPEC to bind all files in directories
C:\Data and C:\Program Files\My Apps to a management class named
PRODCLASS.
Commands
define clientopt winspec inclexcl "include C:\Data\...\* prodclass"
define clientopt winspec inclexcl "include C:\Program
Files\My Apps\...\* prodclass"
Related commands
Table 50. Commands related to DEFINE CLIENTOPT
Command Description
COPY CLOPTSET Copies a client option set.
DEFINE CLOPTSET Defines a client option set.
DELETE CLIENTOPT Deletes a client option from a client option
set.
DELETE CLOPTSET Deletes a client option set.
REGISTER NODE Defines a client to the server and sets options
for that user.
QUERY CLOPTSET Displays information about a client option
set.
UPDATE CLIENTOPT Updates the sequence number of a client
option.
UPDATE CLOPTSET Updates the description of a client option set.
UPDATE NODE Changes the attributes associated with a
client node.

DEFINE CLIENTOPT
Chapter 2. Administrative commands 133
DEFINE CLOPTSET (Define a client option set name)
Use this command to define a name for a set of options you can assign to clients
for archive, backup, restore, and retrieve operations.
To add options to the new set, use the DEFINE CLIENTOPT command.
Privilege class
To issue this command, you must have system privilege or unrestricted policy
privilege.
Syntax
DEFine CLOptset option_set_name
DESCription

=

description


Parameters
option_set_name (Required)
Specifies the name of the client option set. The maximum length of the name is
64 characters.
DESCription
Specifies a description of the client option set. The maximum length of the
description is 255 characters. The description must be enclosed in quotation
marks if it contains any blank characters. This parameter is optional.
Examples
Task
Define a client option set named ENG.
Command
define cloptset eng
Related commands
Table 51. Commands related to DEFINE CLOPTSET
Command Description
COPY CLOPTSET Copies a client option set.
DEFINE CLIENTOPT Adds a client option to a client option set.
DELETE CLIENTOPT Deletes a client option from a client option
set.
DELETE CLOPTSET Deletes a client option set.
QUERY CLOPTSET Displays information about a client option
set.
UPDATE CLIENTOPT Updates the sequence number of a client
option.
UPDATE CLOPTSET Updates the description of a client option set.

DEFINE CLOPTSET

134 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE COLLOCGROUP (Define a collocation group)
Use this command to define a collocation group. A collocation group is a group of
nodes whose data is collocated on a minimal number of sequential access volumes.
Their data is collocated only if the storage pool definition is set to collocate by
group (COLLOCATE=GROUP).
Privilege class
To issue this command, you must have system or unrestricted storage privilege.
Syntax
DEFine COLLOCGroup group_name
DESCription

=

description


Parameters
group_name
Specifies the name of the collocation group name that you want to create. The
maximum length of the name is 30 characters.
DESCription
Specifies a description of the collocation group. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters.
Examples
Task
Define a collocation group named group1.
Command
define collocgroup group1
Related commands
Table 52. Commands related to DEFINE COLLOCGROUP
Command Description
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE COLLOCGROUP Deletes a collocation group.
DELETE COLLOCMEMBER Deletes a client node from a collocation
group.
MOVE NODEDATA Moves data for one or more nodes, or a
single node with selected filespaces.
QUERY COLLOCGROUP Displays information about collocation
groups.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY NODEDATA Displays information about the location and
size of data for a client node.
DEFINE COLLOCGROUP
Chapter 2. Administrative commands 135
Table 52. Commands related to DEFINE COLLOCGROUP (continued)
Command Description
QUERY STGPOOL Displays information about storage pools.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
UPDATE COLLOCGROUP Updates the description of a collocation
group.
UPDATE STGPOOL Changes the attributes of a storage pool.

DEFINE COLLOCGROUP

136 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE COLLOCMEMBER (Define collocation group member)
Use this command to add a client node to a collocation group. A collocation group is
a group of nodes whose data is collocated on a minimal number of sequential
access volumes.
Privilege class
To issue this command you must have system or unrestricted storage privilege.
Syntax

,
DEFine COLLOCMember

group_name

node_name

Parameters
group_name
Specifies the name of the collocation group to which you want to add a client
node.
node_name
Specifies the name of the client node that you want to add to the collocation
group. You can specify one or more names. Separate multiple names with
commas; do not use intervening spaces. You can also use wildcard characters
when specifying multiple names.
Examples
Task
Define two members, node1 and node2, to a collocation group, group1.
Command
define collocmember group1 node1,node2
Related commands
Table 53. Commands related to DEFINE COLLOCMEMBER
Command Description
DEFINE COLLOCGROUP Defines a collocation group.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE COLLOCGROUP Deletes a collocation group.
DELETE COLLOCMEMBER Deletes a client node from a collocation
group.
MOVE NODEDATA Moves data for one or more nodes, or a
single node with selected filespaces.
QUERY COLLOCGROUP Displays information about collocation
groups.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY NODEDATA Displays information about the location and
size of data for a client node.
DEFINE COLLOCMEMBER
Chapter 2. Administrative commands 137
Table 53. Commands related to DEFINE COLLOCMEMBER (continued)
Command Description
QUERY STGPOOL Displays information about storage pools.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
UPDATE COLLOCGROUP Updates the description of a collocation
group.
UPDATE STGPOOL Changes the attributes of a storage pool.

DEFINE COLLOCMEMBER

138 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE COPYGROUP (Define a copy group)
Use this command to define a new backup or archive copy group within a specific
management class, policy set, and policy domain. The server uses the backup and
archive copy groups to control how clients back up and archive files, and to
manage the backed-up and archived files.
To allow clients to use the new copy group, you must activate the policy set that
contains the new copy group.
You can define one backup and one archive copy group for each management
class. To ensure that client nodes can back up files, include a backup copy group in
the default management class for a policy set.
Note: The DEFINE COPYGROUP command fails if you specify a copy storage
pool as a destination.
The DEFINE COPYGROUP command has two forms, one for defining a backup
copy group and one for defining an archive copy group. The syntax and
parameters for each form are defined separately.
Table 54. Commands related to DEFINE COPYGROUP
Command Description
ASSIGN DEFMGMTCLASS Assigns a management class as the default
for a specified policy set.
BACKUP NODE Backs up a network-attached storage (NAS)
node.
COPY MGMTCLASS Creates a copy of a management class.
DEFINE MGMTCLASS Defines a management class.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE COPYGROUP Deletes a backup or archive copy group from
a policy domain and policy set.
DELETE MGMTCLASS Deletes a management class and its copy
groups from a policy domain and policy set.
EXPIRE INVENTORY Manually starts inventory expiration
processing.
QUERY COPYGROUP Displays the attributes of a copy group.
QUERY MGMTCLASS Displays information about management
classes.
SET ARCHIVERETENTIONPROTECTION Specifies whether data retention protection is
activated.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.
DEFINE COPYGROUP
Chapter 2. Administrative commands 139
DEFINE COPYGROUP backup
Use this command to define a new backup copy group within a specific
management class, policy set, and policy domain.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the copy
group belongs.
Syntax

DEFine COpygroup

domain_name

policy_set_name

class_name
STANDARD
STANDARD

Type = Backup
Type

=

Backup

DESTination

=

pool_name
FREQuency = 0
FREQuency

=

days

VERExists = 2
VERExists

=

number

NOLimit
VERDeleted = 1
VERDeleted

=

number

NOLimit

RETExtra = 30
RETExtra

=

days

NOLimit
RETOnly = 60
RETOnly

=

days

NOLimit

MODE = MODified
MODE

=

MODified

ABSolute
SERialization = SHRSTatic
SERialization

=

SHRSTatic

STatic

SHRDYnamic

DYnamic

TOCDestination

=

pool_name


Parameters
domain_name (Required)
Specifies the policy domain for which you are defining the copy group.
policy_set_name (Required)
Specifies the policy set for which you are defining the copy group.
You cannot define a copy group for a management class that belongs to the
ACTIVE policy set.
class_name (Required)
Specifies the management class for which you are defining the copy group.
STANDARD
Specifies the name of the copy group, which must be STANDARD. This
parameter is optional. The default value is STANDARD.
DEFINE COPYGROUP Backup

140 IBM Tivoli Storage Manager for Windows: Administrators Reference
Type=Backup
Specifies that you want to define a backup copy group. The default parameter
is BACKUP. This parameter is optional.
DESTination (Required)
Specifies the primary storage pool where the server initially stores backup
data. You cannot specify a copy storage pool as the destination.
FREQuency
Specifies how frequently Tivoli Storage Manager can back up a file. This
parameter is optional. Tivoli Storage Manager backs up a file only when the
specified number of days has elapsed since the last backup. The FREQUENCY
value is used only during a full incremental backup operation. This value is
ignored during selective backup or partial incremental backup. You can specify
an integer from 0 to 9999. The default value is 0, meaning that Tivoli Storage
Manager can back up a file regardless of when the file was last backed up.
VERExists
Specifies the maximum number of backup versions to retain for files that are
currently on the client file system. This parameter is optional. The default
value is 2.
If an incremental backup operation causes the limit to be exceeded, the server
expires the oldest backup version that exists in server storage. Possible values
are:
number
Specifies the number of backup versions to retain for files that are
currently on the client file system. You can specify an integer from 1 to
9999.
NOLimit
Specifies that you want the server to retain all backup versions.
The number of backup versions to retain is controlled by this parameter until
versions exceed the retention time specified by the RETEXTRA parameter.
VERDeleted
Specifies the maximum number of backup versions to retain for files that have
been deleted from the client file system after being backed up using Tivoli
Storage Manager. This parameter is optional. The default value is 1.
If a user deletes a file from the client file system, the next incremental backup
causes the server to expire the oldest versions of the file in excess of this
number. The expiration date for the remaining versions is determined by the
retention time specified by the RETEXTRA or RETONLY parameter. Possible
values are:
number
Specifies the number of backup versions to retain for files that are deleted
from the client file system after being backed up. You can specify an
integer from 0 to 9999.
NOLimit
Specifies that you want the server to retain all backup versions for files
that are deleted from the client file system after being backed up.
RETExtra
Specifies the number of days to retain a backup version after that version
becomes inactive. A version of a file becomes inactive when the client stores a
more recent backup version, or when the client deletes the file from the
workstation and then runs a full incremental backup. The server deletes
DEFINE COPYGROUP Backup
Chapter 2. Administrative commands 141
inactive versions based on retention time even if the number of inactive
versions does not exceed the number allowed by the VEREXISTS or
VERDELETED parameters. This parameter is optional. The default value is 30
days. Possible values are:
days
Specifies the number of days to retain inactive backup versions. You can
specify an integer from 0 to 9999.
NOLimit
Specifies that you want to retain inactive backup versions indefinitely.
If you specify NOLIMIT, the server deletes inactive backup versions based
on the VEREXISTS parameter (when the file still exists on the client file
system) or the VERDELETED parameter (when the file no longer exists on
the client file system).
RETOnly
Specifies the number of days to retain the last backup version of a file that has
been deleted from the client file system. This parameter is optional. The default
value is 60. Possible values are:
days
Specifies the number of days to retain the last remaining inactive version
of a file. You can specify an integer from 0 to 9999.
NOLimit
Specifies that you want to keep the last remaining inactive version of a file
indefinitely.
If you specify NOLIMIT, the server retains the last remaining backup
version forever, unless a user or administrator deletes the file from server
storage.
MODE
Specifies whether Tivoli Storage Manager backs up a file only if the file has
changed since the last backup, or whenever a client requests a backup. This
parameter is optional. The default value is MODIFIED. Possible values are:
MODified
Specifies that Tivoli Storage Manager backs up the file only if it has
changed since the last backup. Tivoli Storage Manager considers a file
changed if any of the following is true:
v The date last modified is different
v The file size is different
v The file owner is different
v The file permissions are different
ABSolute
Specifies that Tivoli Storage Manager backs up the file regardless of
whether it has been modified.
The MODE value is used only for full incremental backup. This value is
ignored during partial incremental backup or selective backup.
SERialization
Specifies how Tivoli Storage Manager handles files or directories when they are
modified during backup processing. This parameter is optional. The default
value is SHRSTATIC. Possible values are:
DEFINE COPYGROUP Backup

142 IBM Tivoli Storage Manager for Windows: Administrators Reference
SHRSTatic
Specifies that Tivoli Storage Manager backs up a file or directory only if it
is not being modified during backup. Tivoli Storage Manager attempts to
perform a backup as many as four times, depending on the value specified
for the CHANGINGRETRIES client option. If the file or directory is
modified during each backup attempt, Tivoli Storage Manager does not
back it up.
STatic
Specifies that Tivoli Storage Manager backs up a file or directory only if it
is not being modified during backup. Tivoli Storage Manager attempts to
perform the backup only once.
Platforms that do not support the STATIC option default to SHRSTATIC.
SHRDYnamic
Specifies that if the file or directory is being modified during a backup
attempt, Tivoli Storage Manager backs up the file or directory during the
last attempt even though the file or directory is being modified. Tivoli
Storage Manager attempts to perform a backup as many as four times,
depending on the value specified for the CHANGINGRETRIES client
option.
DYnamic
Specifies that Tivoli Storage Manager backs up a file or directory on the
first attempt, regardless of whether the file or directory is being modified
during backup processing.
Attention: Be careful about using the SHRDYNAMIC and DYNAMIC values.
These values allow Tivoli Storage Manager to back up a file or directory while
modifications are occurring. As a result, the backup version might be a fuzzy
backup. A fuzzy backup does not accurately reflect what is currently in the file
or directory because it contains some, but not all, modifications. If a file that
contains a fuzzy backup is restored, the file may or may not be usable,
depending on the application that uses the file. If a fuzzy backup is not
acceptable, be sure to use a serialization value that allows Tivoli Storage
Manager to create a backup version only if the file or directory is not being
modified (SHRSTATIC or STATIC).
TOCDestination
Specifies the primary storage pool in which a table of contents (TOC) will
initially be stored for any NDMP backup or backup set operation for which a
TOC is generated. This parameter is optional. You cannot specify a copy
storage pool as the destination. The storage pool specified for the destination
must have NATIVE or NONBLOCK data format. To avoid mount delays, it is
recommended that the storage pool have a device class of DISK or
DEVTYPE=FILE. TOC generation is an option for NDMP backup operations,
but is not supported for other image-backup operations.
If TOC creation is requested for a backup operation that uses NDMP and the
image is bound to a management class whose backup copy group does not
specify a TOC destination, the outcome will depend on the TOC parameter for
the backup operation.
v If TOC=PREFERRED (the default), the backup proceeds without creation of
a TOC.
v If TOC=YES, the entire backup fails because no TOC can be created.
DEFINE COPYGROUP Backup
Chapter 2. Administrative commands 143
Examples
Task
Create a backup copy group named STANDARD for management class
ACTIVEFILES in policy set VACATION in the EMPLOYEE_RECORDS policy
domain. Set the backup destination to BACKUPPOOL. Set the minimum interval
between backups to three days, regardless of whether the files have been modified.
Retain up to five backup versions of a file while the file exists on the client file
system.
Command
define copygroup employee_records
vacation activefiles standard type=backup
destination=backuppool frequency=3
verexists=5 mode=absolute
DEFINE COPYGROUP Backup

144 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE COPYGROUP archive
Use this command to define a new archive copy group within a specific
management class, policy set, and policy domain.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the copy
group belongs.
Syntax

DEFine COpygroup

domain_name

policy_set_name

class_name
STANDARD
STANDARD

Type

=

Archive

DESTination

=

pool_name
FREQuency = Cmd
FREQuency

=

Cmd

RETVer = 365
RETVer

=

days

NOLimit
RETInit = CREATion
RETInit

=

EVent

RETMin = 365
RETMin

=

days
MODE = ABSolute
MODE

=

ABSolute

SERialization = SHRSTatic
SERialization

=

SHRSTatic

STatic

SHRDYnamic

DYnamic

Parameters
domain_name (Required)
Specifies the name of the policy domain for which you are defining the copy
group.
policy_set_name (Required)
Specifies the name of the policy set for which you are defining the copy group.
You cannot define a copy group for a management class that belongs to the
ACTIVE policy set.
class_name (Required)
Specifies the name of the management class for which you are defining the
copy group.
STANDARD
Specifies the name of the copy group, which must be STANDARD. This
parameter is optional. The default value is STANDARD.
Type=Archive (Required)
Specifies that you want to define an archive copy group.
DEFINE COPYGROUP Archive
Chapter 2. Administrative commands 145
DESTination (Required)
Specifies the primary storage pool where the server initially stores the archive
copy. You cannot specify a copy storage pool as the destination.
FREQuency=Cmd
Specifies the copy frequency, which must be CMD. This parameter is optional.
The default value is CMD.
RETVer
Specifies the number of days to keep an archive copy. This parameter is
optional. The default value is 365. Possible values are:
days
Specifies the number of days to keep an archive copy. You can specify an
integer from 0 to 30000.
Note: If you specify a value of 0 (zero), the default value of 365 is used.
NOLimit
Specifies that you want to keep an archive copy indefinitely.
If you specify NOLIMIT, the server retains archive copies forever, unless a
user or administrator deletes the file from server storage. If you specify
NOLIMIT, you cannot also specify EVENT for the RETINIT parameter.
The value of the RETVER parameter can affect the management class to which
the server binds an archived directory. If the client does not use the ARCHMC
option, the server binds directories that are archived to the default
management class. If the default management class has no archive copy group,
the server binds directories that are archived to the management class with the
shortest retention period.
If the primary storage pool specified in the DESTINATION parameter belongs
to a Centera device class and data protection has been enabled, then the
RETVER value will be sent to Centera for retention management purposes. See
the SET ARCHIVERETENTIONPROTECTION command for a description of
data protection.
The RETVER parameter of the archive copy group of the management class to
which an object is bound determines the retention criterion for each object. See
the SET ARCHIVERETENTIONPROTECTION command for a description of
data protection.
RETInit
Specifies when the retention time specified by the RETVER attribute is
initiated. This parameter is optional. The default value is CREATION. Possible
values are:
CREATion
Specifies that the retention time specified by the RETVER attribute is
initiated at the time an archive copy is stored on the Tivoli Storage
Manager server.
EVent
Specifies that the retention time specified in the RETVER parameter is
initiated at the time a client application notifies the server of a
retention-initiating event for the archive copy. If you specify
RETINIT=EVENT, you cannot also specify RETVER=NOLIMIT.
Note: Placing a deletion hold on an object that was stored with
RETINIT=EVENT for which the event has not been signalled is allowed.
DEFINE COPYGROUP Archive

146 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
If the event is signalled while the deletion hold is in effect, the retention
period will be initiated, but the object will not be deleted while the hold
is in effect.
RETMin
Specifies the minimum number of days to keep an archive copy after it has
been archived. This parameter is optional. The default value is 365. If you
specify RETINIT=CREATION, this parameter is ignored.
MODE=ABSolute
Specifies that a file is always archived when the client requests it. The MODE
must be ABSOLUTE. This parameter is optional. The default value is
ABSOLUTE.
SERialization
Specifies how Tivoli Storage Manager handles files that are modified during
archive. This parameter is optional. The default value is SHRSTATIC. Possible
values are:
SHRSTatic
Specifies that Tivoli Storage Manager archives a file only if it is not being
modified. Tivoli Storage Manager attempts to perform an archive operation
as many as four times, depending on the value specified for the
CHANGINGRETRIES client option. If the file is modified during the
archive attempt, Tivoli Storage Manager does not archive the file.
STatic
Specifies that Tivoli Storage Manager archives a file only if it is not being
modified. Tivoli Storage Manager attempts to perform the archive
operation only once.
Platforms that do not support the STATIC option default to SHRSTATIC.
SHRDYnamic
Specifies that if the file is being modified during an archive attempt, Tivoli
Storage Manager archives the file during its last attempt even though the
file is being modified. Tivoli Storage Manager attempts to archive the file
as many as four times, depending on the value specified for the
CHANGINGRETRIES client option.
DYnamic
Specifies that Tivoli Storage Manager archives a file on the first attempt,
regardless of whether the file is being modified during archive processing.
Attention: Be careful about using the SHRDYNAMIC and DYNAMIC values.
These values allow Tivoli Storage Manager to archive a file while modifications
are occurring. As a result, the archive copy might be a fuzzy backup. A fuzzy
backup does not accurately reflect what is currently in the file because it
contains some, but not all, modifications. If a file that contains a fuzzy backup
is retrieved, the file may or may not be usable, depending on the application
that uses the file. If a fuzzy backup is not acceptable, be sure to use a
serialization value that allows Tivoli Storage Manager to create an archive copy
only if the file is not being modified (SHRSTATIC or STATIC).
Attention: Be cautious when selecting retention values for primary storage
pools which are of type RECLAMATIONTYPE=SNAPLOCK. Volumes in these
types of storage pools cannot be deleted until after their retention dates have
passed.
DEFINE COPYGROUP Archive
Chapter 2. Administrative commands 147
Examples
Task
Create an archive copy group named STANDARD for management class
EVENTMC in policy set SUMMER in the PROG1 policy domain. Set the archive
destination to ARCHIVEPOOL, where the archive copy is kept until the server is
notified of an event to initiate the retention time, after which the archive copy is
kept for 30 days. The archive copy will be kept for a minimum of 90 days after
being stored on the server, regardless of when the server is notified of an event to
initiate the retention time.
Command
define copygroup prog1 summer eventmc standard type=archive
destination=archivepool retinit=event retver=30 retmin=90
DEFINE COPYGROUP Archive

148 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DATAMOVER (Define a data mover)
Use this command to define a data mover. A data mover is a named device that
accepts a request from Tivoli Storage Manager to transfer data and can be used to
perform outboard copy operations.
See the documentation for your device for guidance on specifying the parameters
for this command.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DATAMover data_mover_name Type = NAS HLAddress = address

LLAddress = 10000
LLAddress

=

tcp_port

USERid

=

userid

PASsword

=

password

ONLine = Yes
ONLine

=

Yes

No

DATAFormat

=

NETAPPDump

CELERRADump

NDMPDump

Parameters
data_mover_name (Required)
Specifies the name of the data mover. This name must be the same as a node
name that you previously registered using the REGISTER NODE TYPE=NAS
command. The data that is backed up from this NAS data mover will be
assigned to this node name in the server database. A maximum of 64
characters can be used to specify the name.
Type=NAS (Required)
Specifies that the data mover is a NAS file server.
HLAddress (Required)
Specifies either the numerical IP address or the domain name, which are used
to access the NAS file server.
LLAddress
Specifies the TCP port number to access the NAS device for Network Data
Management Protocol (NDMP) sessions. This parameter is optional. The
default value is 10000.
USERid (Required)
Specifies the user ID for a user that is authorized to initiate an NDMP session
with the NAS file server. For example, enter the administrative ID for a
Network Appliance file server.
PASsword (Required)
Specifies the password for the user ID to log onto the NAS file server.
DEFINE DATAMOVER
Chapter 2. Administrative commands 149
ONLine
Specifies whether the data mover is available for use. This parameter is
optional. The default is YES.
Yes
The default value. Specifies that the data mover is available for use.
No
Specifies that the data mover is not available for use.
Attention: If a library is controlled using a path from a NAS data mover
to the library, and the NAS data mover is offline, the server will not be
able to access the library. If the server is halted and restarted while the
NAS data mover is offline, the library will not be initialized.
Note: When the hardware is being maintained, you can use the UPDATE
DATAMOVER command to set the data mover off-line.
DATAFormat (Required)
Specifies the data format that is used by this data mover.
NETAPPDump
NETAPPDUMP must be used for Network Appliance NAS file servers and
the IBM System Storage

N Series.
CELERRADump
CELERRADUMP must be used for EMC Celerra NAS file servers.
NDMPDump
NDMPDump must be used for NAS file servers other than Network
Appliance or EMC file servers.
Examples
Task
Define a data mover for the NAS node named NAS1. The numerical IP address for
the data mover is 9.67.97.103, at port 10000. The NAS file server is a Network
Appliance device.
Command
define datamover nas1 type=nas hladdress=9.67.97.103 lladdress=10000
userid=root password=admin dataformat=netappdump
Task
Define a data mover for the node named NAS1. The domain name for the data
mover is, NETAPP2.TUCSON.IBM.COM at port 10000.
Command
define datamover nas1 type=nas hladdress=netapp2.tucson.ibm.com
lladdress=10000 userid=root password=admin dataformat=netappdump
Task
Define a data mover for the node named NAS1. The numerical IP address for the
data mover is 9.67.97.103, at port 10000. The NAS file server is neither a Network
Appliance or an EMC file server.
DEFINE DATAMOVER

150 IBM Tivoli Storage Manager for Windows: Administrators Reference
Command
define datamover nas1 type=nas hladdress=9.67.97.103 lladdress=10000
userid=root password=admin dataformat=ndmpdump
Related commands
Table 55. Commands related to DEFINE DATAMOVER
Command Description
DEFINE PATH Defines a path from a source to a destination.
DELETE DATAMOVER Deletes a data mover.
QUERY DATAMOVER Displays data mover definitions.
REGISTER NODE Defines a client to the server and sets options
for that user.
UPDATE DATAMOVER Changes the definition for a data mover.

DEFINE DATAMOVER
Chapter 2. Administrative commands 151
DEFINE DBBACKUPTRIGGER (Define the database backup
trigger)
Use this command to specify when Tivoli Storage Manager backs up the database.
A backup occurs when the specified percentage of the assigned capacity of the
recovery log is reached.
Tivoli Storage Manager uses the database trigger only if the log mode is set to
ROLLFORWARD.
Note: If the backup fails, Tivoli Storage Manager waits 60 seconds and then tries
again. It continues to retry the backup until it is successful.
Privilege class
To perform this task, you must have one of the following privilege classes:
v System privilege
v Unrestricted storage
Syntax
DEFine DBBackuptrigger DEVclass = device_class_name

LOGFullpct = 50
LOGFullpct

=

percent

INCRDEVclass

=

device_class_name

NUMINCremental = 6
NUMINCremental

=

number
MININTerval = 0
MININTerval

=

minutes

MINLOGFREEpct = 0
MINLOGFREEpct

=

percent

Parameters
DEVclass (Required)
Specifies the name of the sequential access device class to use for backups.
LOGFullpct
Specifies a recovery log utilization percentage from 1 to 99. When this value is
exceeded, Tivoli Storage Manager backs up the database. This parameter is
optional. The default is 50.
INCRDEVclass
Specifies the name of the sequential access device class to use for incremental
backups. This parameter is optional. The default is the device class specified
with the DEVCLASS parameter.
NUMINCremental
Specifies the maximum number of incremental backups that can be run before
a full backup is required. The range is from 0 to 32. A value of 0 specifies that
Tivoli Storage Manager runs only full backups. This parameter is optional. The
default is 6.
DEFINE DBBACKUPTRIGGER

152 IBM Tivoli Storage Manager for Windows: Administrators Reference
Each incremental backup, whether run automatically or requested by an
administrator, is added to the count of incremental backups run. Each full
backup, whether run automatically or requested by an administrator, resets the
count for incremental backups to zero.
MININTerval
Specifies the minimum number of minutes that must elapse between a
previous backup and a subsequent automatic backup. The range is from 0 to
9999. This parameter is optional. The default is 0.
Each backup, whether run automatically or requested by an administrator,
resets the time of the last backup. A database snapshot will not reset the time
of the last backup. When the server is started, the time of the last backup is
assumed to have taken place in the past, beyond the longest minimum
interval.
The minimum interval condition, the minimum amount of log space freed
condition, or both conditions must be met in order for an automatic backup to
take place.
MINLOGFREEpct
Specifies a recovery log utilization percentage from 0 to 99. This is the
minimum amount of log space that must be freed by the automatic backup
before it will be performed. This parameter is optional. The default is 0.
The minimum interval condition, the minimum amount of log space freed
condition, or both conditions must be met in order for an automatic backup to
take place.
Examples
Task
Set the database backup trigger to 80 percent. After two incremental backups, do a
full backup. Use the FILE device class. Your database is already backed up every
night. You want no more than two automatic backups per day, unless at least 30
percent of the log space can be freed by a backup.
Command
define dbbackuptrigger devclass=file logfullpct=80 numincremental=2
mininterval=480 minlogfreepct=30
Related commands
Table 56. Commands related to DEFINE DBBACKUPTRIGGER
Command Description
BACKUP DB Backs up the IBM Tivoli Storage Manager
database to sequential access volumes.
DEFINE DEVCLASS Defines a device class.
DELETE DBBACKUPTRIGGER Deletes the database backup trigger.
QUERY DBBACKUPTRIGGER Displays information about the database
backup trigger.
SET LOGMODE Sets the mode for saving records in the
recovery log.
UPDATE DBBACKUPTRIGGER Changes one or more attributes of the
database backup trigger.

DEFINE DBBACKUPTRIGGER
Chapter 2. Administrative commands 153
DEFINE DBCOPY (Define a volume copy of a database
volume)
Use this command to create a copy (mirrored volume) of a database volume.
Mirroring the database increases database availability and provides a safeguard
against media failure. You can have as many as two copies of a database volume.
After each database volume copy is defined, the server attempts to synchronize the
volume copy with the database.
All database volumes reside on random access devices. Volume copies must have
at least the same capacity as the original volume and should be defined on
separate physical devices. Any additional space on the volume copy is not used.
This command generates a background process that you can cancel with the
CANCEL PROCESS command. If a DEFINE DBCOPY process is cancelled, the
volume copy is created. However, synchronization processing is cancelled, leaving
the volume in a stale state. To display information on background processes, use
the QUERY PROCESS command.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DBCopy volume_name copy_volume_name

Wait

=

No

Formatsize

=

megabytes

Wait

=

No

Yes


Parameters
volume_name (Required)
Specifies the name of the database volume to be mirrored.
copy_volume_name (Required)
Specifies the file name of the volume copy. Enter this name as either a fully
qualified path or a name relative to the servers current working directory.
Enclose the name in quotation marks if it contains embedded blanks, equal
signs, or other special characters. For example, if the file name is db2.dsm,
enter the path name as:
"c:\program files\tivoli\tsm\server\db2.dsm"
Formatsize
Specifies the size of the volume that is defined and formatted in one operation.
This parameter is optional. The value is specified in megabytes.
Wait
Specifies whether a volume creation and formatting operation is performed in
the foreground or background. This parameter is optional. The default is NO.
It is ignored unless the FORMATSIZE parameter is also specified.
DEFINE DBCOPY

154 IBM Tivoli Storage Manager for Windows: Administrators Reference
No
Specifies that a volume creation and formatting operation is performed in
the background.
Yes
Specifies that a volume creation and formatting operation is performed in
the foreground.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Format a new data base copy volume of 20MB in the server directory with a name
of db3.dsm and wait for the server to define the volume.
Command
define dbcopy db1.dsm db3.dsm formatsize=20 wait=yes
Task
Create a database volume copy named db2.dsm for the database volume named
db1.dsm.
Command
define dbcopy db1.dsm db2.dsm
Related commands
Table 57. Commands related to DEFINE DBCOPY
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE DBVOLUME Assigns a volume to be used for database
storage.
DELETE DBVOLUME Deletes a volume from the database.
QUERY DBVOLUME Displays information database volumes.
QUERY PROCESS Displays information about background
processes.

DEFINE DBCOPY
Chapter 2. Administrative commands 155
DEFINE DBVOLUME (Define a database volume)
Use this command to define a new database volume. All database volumes reside
on random access devices.
You can have Tivoli Storage Manager create the volume before it is assigned.
Attention: Do not change the size of a database volume after you have defined it
to Tivoli Storage Manager.
When you define a new database volume, you provide additional space to the
database. To permit the database to use this additional space, use the EXTEND DB
command.
A database volume must be at least 5MB. Tivoli Storage Manager uses 1MB of each
database volume for overhead. For example, if you define a 9MB database volume,
8MB are available for storage.
For more information about disk subsystem requirements, see the Administrators
Guide.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DBVolume volume_name
Formatsize

=

megabytes

Wait = No
Wait

=

No

Yes

Parameters
volume_name (Required)
Specifies the file name of the database volume. Enclose the name in quotation
marks if it contains embedded blanks or equal signs.
Enter this name as either a fully qualified path name or a name that is relative
to the servers current working directory. For example, if the file name is
db1.dsm, enter the path name as:
c:\progra~1\tivoli\tsm\server\db1.dsm
Formatsize
Specifies the size of the volume that is defined and formatted in one operation.
This parameter is optional. The value is specified in megabytes.
Wait
Specifies whether a volume creation and formatting operation is performed in
the foreground or background. This parameter is optional. The default is NO.
It is ignored unless the FORMATSIZE parameter is also specified.
DEFINE DBVOLUME

156 IBM Tivoli Storage Manager for Windows: Administrators Reference
No
Specifies that a volume creation and formatting operation is performed in
the background.
Yes
Specifies that a volume creation and formatting operation is performed in
the foreground.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Define a database volume db2.dsm.
Command
define dbvolume db2.dsm
Task
Format a new database volume of 20MB in the server directory with a file name of
db3.dsm and wait for the server to define the database volume.
Command
define dbvolume db3.dsm formatsize=20 wait=yes
Related commands
Table 58. Commands related to DEFINE DBVOLUME
Command Description
DEFINE DBCOPY Creates a volume copy of a database volume.
DELETE DBVOLUME Deletes a volume from the database.
EXTEND DB Extends usable database storage within the
volumes previously allocated for its use.
QUERY DBVOLUME Displays information database volumes.

DEFINE DBVOLUME
Chapter 2. Administrative commands 157
DEFINE DEVCLASS (Define a device class)
Use this command to define a device class for a type of storage device. The server
requires that a device class be defined to allow use of a device.
Note: The DISK device class is defined by IBM Tivoli Storage Manager and cannot
be modified with the DEFINE DEVCLASS command.
The syntax and parameter descriptions are provided according to the device type.
The syntax and parameter information is presented in the following order:
v 3570 (Syntax on page 159)
v 3590 (Syntax on page 162)
v 3592 (Syntax on page 166)
v 4MM (Syntax on page 171)
v 8MM (Syntax on page 175)
v CENTERA (Syntax on page 181)
v DLT (Syntax on page 183)
v DTF (Syntax on page 189)
v ECARTRIDGE (Syntax on page 192)
v FILE (Syntax on page 197)
v GENERICTAPE (Syntax on page 200)
v LTO (Syntax on page 203)
v NAS (Syntax on page 208)
v OPTICAL and WORM Types (Syntax on page 211)
v QIC (Syntax on page 215)
v REMOVABLEFILE (Syntax on page 220)
v SERVER (Syntax on page 223)
v VOLSAFE (Syntax on page 225)
Table 59. Commands related to DEFINE DEVCLASS
Command Description
BACKUP DEVCONFIG Backs up IBM Tivoli Storage Manager device
information to a file.
DEFINE LIBRARY Defines an automated or manual library.
DELETE DEVCLASS Deletes a device class name.
QUERY DEVCLASS Displays information about device classes.
QUERY DIRSPACE Displays information about FILE directories.
UPDATE DEVCLASS Changes the attributes of a device class.
DEFINE DEVCLASS

158 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS 3570
Use the 3570 device class when you are using 3570 tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

3570
FORMAT = DRIVE
FORMAT

=

DRIVE

3570B

3570C

ESTCAPacity

=

size

PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix
MOUNTRetention = 60
MOUNTRetention

=

minutes

MOUNTWait = 60
MOUNTWait

=

minutes
MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the tape drives
that can be used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
DEVType=3570 (Required)
Specifies the 3570 device type is assigned to the device class. The 3570
indicates that IBM 3570 cartridge tape devices are assigned to this device class.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional. The default is DRIVE.
The following table lists the recording formats and estimated capacities for
3570 devices:
DEFINE DEVCLASS 3570
Chapter 2. Administrative commands 159
Table 60. Recording format and default estimated capacity for 3570 tape volumes
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
3570B 5.0GB Uncompressed (basic) format
3570C
See note
10.0GB
Compressed format
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
For more information on the default estimated capacity for 3570 cartridge
tapes, see Table 60.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
DEFINE DEVCLASS 3570

160 IBM Tivoli Storage Manager for Windows: Administrators Reference
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the amount of time, in minutes, to retain an idle sequential access
volume before dismounting it. This parameter is optional. The default value is
60. You can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types, setting this parameter to a low value (for example, two minutes)
enhances device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DEFINE DEVCLASS 3570
Chapter 2. Administrative commands 161
DEFINE DEVCLASS 3590
Use the 3590 device class when you are using 3590 tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

3590
FORMAT = DRIVE
FORMAT

=

DRIVE

3590B

3590C

3590E-B

3590E-C

3590H-B

3590H-C

ESTCAPacity

=

size

PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix
MOUNTRetention = 60
MOUNTRetention

=

minutes

MOUNTWait = 60
MOUNTWait

=

minutes
MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the tape drives
that can be used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
DEVType=3590 (Required)
Specifies the 3590 device type is assigned to the device class. 3590 indicates
that IBM 3590 cartridge tape devices are assigned to this device class.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional. The default value is DRIVE.
If the drives are in a library that includes drives of different tape technology,
do not use the DRIVE value. Use the specific format that the drives use. Refer
to the Administrators Guide for more information.
The following tables list the recording formats, estimated capacities and
recording format options for 3590 devices:
DEFINE DEVCLASS 3590

162 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 61. Recording formats and default estimated capacities for 3590
Format
Estimated
Capacity
Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
3590B 10.0GB Uncompressed (basic) format
3590C
See note
20.0GB
Compressed format
3590E-B 10.0GB Uncompressed (basic) format, similar to the 3590B
format
3590E-C
See note
20.0GB
Compressed format, similar to the 3590C format
3590H-B
30.0GB (J
cartridge
standard length)
60.0GB (K
cartridge
extended length)
Uncompressed (basic) format, similar to the 3590B
format
3590H-C
See note
60.0GB (J
cartridge
standard length)
120.0GB (K
cartridge
extended length)
Compressed format, similar to the 3590C format
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

Table 62. 3590 device recording format selections
Device
Format
3590B 3590C 3590E-B 3590E-C 3590H-B 3590H-C
3590
Ultra SCSI
3590E
3590H
Read/Write
Read/Write
Read
Read
Read/Write
Read/Write
Read
Read


Read/Write
Read


Read/Write
Read



Read/Write



Read/Write

DEFINE DEVCLASS 3590
Chapter 2. Administrative commands 163
ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the amount of time, in minutes, to retain an idle sequential access
volume before dismounting it. This parameter is optional. The default value is
60. You can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types, setting this parameter to a low value (for example, two minutes)
enhances device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
DEFINE DEVCLASS 3590

164 IBM Tivoli Storage Manager for Windows: Administrators Reference
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DEFINE DEVCLASS 3590
Chapter 2. Administrative commands 165
DEFINE DEVCLASS 3592
Use the 3592 device class when you are using 3592 tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

3592
WORM = No
WORM

=

Yes

No
SCALECAPacity = 100
SCALECAPacity

=

100

90

20

FORMAT = DRIVE
FORMAT

=

DRIVE

3592

3592C

3592-2

3592-2C

ESTCAPacity

=

size

PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix
MOUNTRetention = 60
MOUNTRetention

=

minutes

MOUNTWait = 60
MOUNTWait

=

minutes
MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

DRIVEEncryption = ALLOW
DRIVEEncryption

=

ON

ALLOW

OFF

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the tape drives
that can be used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
DEVType=3592 (Required)
Specifies the 3592 device type is assigned to the device class.
DEFINE DEVCLASS 3592

166 IBM Tivoli Storage Manager for Windows: Administrators Reference
WORM
Specifies whether the drives will utilize WORM (write once, read many)
media. The parameter is optional. The default is NO.
Yes
Specifies that the drives will use WORM media.
No
Specifies that the drives will not use WORM media.
Note:
1. To utilize 3592 WORM support in 3584 libraries, you only need to
specify the WORM parameter. The Tivoli Storage Manager server
will distinguish between WORM and non-WORM scratch volumes.
However, to utilize 3592 WORM support in 349X libraries, you also
need to set the WORMSCRATCHCATEGORY on the DEFINE
LIBRARY command. For details, see DEFINE LIBRARY (Define a
library) on page 240.
2. When WORM=YES, the only valid value for the SCALECAPACITY
parameter is 100.
3. Verify with your hardware vendors that your hardware is at the
appropriate level of support.
For more information about WORM media, in general, refer to the
Administrators Guide.
SCALECAPacity
Specifies the percentage of the media capacity that can be used to store data.
This parameter is optional. The default is 100. Possible values are 20, 90, or
100.
Setting the scale capacity percentage to 100 provides maximum storage
capacity. Setting it to 20 provides fastest access time.
Note: The scale capacity value will only take effect when data is first written
to a volume. Any updates to the device class for scale capacity will not
affect volumes that already have data written to them until the volume
is returned to scratch status.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional. The default value is DRIVE.
If the drives are in a library that includes drives of different tape technology,
do not use the DRIVE value. Use the specific format that the drives use. Refer
to the Administrators Guide for more information.
The following table lists the recording formats, estimated capacities and
recording format options for 3592 devices:
DEFINE DEVCLASS 3592
Chapter 2. Administrative commands 167
Table 63. Recording formats and default estimated capacities for 3592
Format
Estimated
Capacity
Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
3592 300GB Uncompressed (basic) format
3592C
See note
900GB
Compressed format
3592-2 500 GB Uncompressed (basic) format
3592-2C 1500 GB Compressed format
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

Note: Mixing 3592 and 3592-2 drives in a SCSI library is not recommended. If
you have to mix drive generations in a SCSI library, use one of the
special configurations described in the Administrators Guide to prevent
or minimize media problems. For optimal performance, upgrade all
drives to 3592-2.
Special configurations are also required for mixing 3592 and 3592-2
drives in 349x and ACSLS libraries. For details, see the Administrators
Guide.
ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
DEFINE DEVCLASS 3592

168 IBM Tivoli Storage Manager for Windows: Administrators Reference
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the amount of time, in minutes, to retain an idle sequential access
volume before dismounting it. This parameter is optional. The default value is
60. You can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types, setting this parameter to a low value (for example, two minutes)
enhances device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DEFINE DEVCLASS 3592
Chapter 2. Administrative commands 169
DRIVEEncryption
Specifies whether drive encryption will be permitted. This parameter is
optional. The default is ALLOW.
ON
Specifies that Tivoli Storage Manager is the key manager for drive
encryption and will permit drive encryption for empty storage pool
volumes only if the application method is enabled. (Other types of
volumesfor example, backup sets, export volumes, and database backup
volumeswill not be encrypted.) If you specify ON and you enable either
the library or system method of encryption, drive encryption will not be
permitted and backup operations will fail.
ALLOW
Specifies that Tivoli Storage Manager does not manage the keys for drive
encryption. However, drive encryption for empty volumes is permitted if
either the library or system method of encryption is enabled.
OFF
Specifies that drive encryption will not be permitted. If you enable either
the library or system method of encryption, backups will fail. If you enable
the application method, Tivoli Storage Manager will disable encryption
and backups will be attempted.
DEFINE DEVCLASS 3592

170 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
DEFINE DEVCLASS 4MM
Use the 4MM device class when you are using 4 mm tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

4MM
FORMAT = DRIVE
FORMAT

=

DRIVE

DDS1

DDS1C

DDS2

DDS2C

DDS3

DDS3C

DDS4

DDS4C

DDS5

DDS5C

ESTCAPacity

=

size

PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix
MOUNTWait = 60
MOUNTWait

=

minutes

MOUNTRetention = 60
MOUNTRetention

=

minutes
MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the 4mm tape
drives used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
DEVType=4MM (Required)
Specifies that the 4MM device type is assigned to the device class. The 4MM
indicates that 4mm tape devices are assigned to this device class.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional. The default value is DRIVE.
DEFINE DEVCLASS 4MM
Chapter 2. Administrative commands 171
If the drives are in a library that includes drives of different tape technology,
do not use the DRIVE value. Use the specific format that the drives use. Refer
to the Administrators Guide for more information.
The following table lists the recording formats and estimated capacities for
4mm devices:
Table 64. Recording formats and default estimated capacities for 4mm tapes
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
DDS1 2.6GB (60-meter)
4.0GB (90-meter)
Uncompressed format, only applies to 60-meter and
90-meter tapes
DDS1C
See note
1.3GB (60-meter)
2.0GB (90-meter)
Compressed format, only applies to 60-meter and
90-meter tapes
DDS2 4.0GB Uncompressed format, only applies to 120-meter
tapes
DDS2C
See note
8.0GB
Compressed format, only applies to 120-meter tapes
DDS3 12.0GB Uncompressed format, only applies to 125-meter
tapes
DDS3C
See note
24.0GB
Compressed format, only applies to 125-meter tapes
DDS4 20.0GB Uncompressed format, only applies to 150-meter
tapes
DDS4C
See note
40.0GB
Compressed format, only applies to 150-meter tapes
DDS5 36GB Uncompressed format, when using DAT 72 media
DDS5C
See note
72GB
Compressed format, when using DAT 72 media
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
DEFINE DEVCLASS 4MM

172 IBM Tivoli Storage Manager for Windows: Administrators Reference
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
For more information on the default estimated capacity for 4mm tapes, see
Table 64 on page 172.
PREFIX
Specifies the high level qualifier of the file name that the server writes into the
sequential access media labels. For each sequential access volume assigned to
this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. The default value is 60. You
can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
DEFINE DEVCLASS 4MM
Chapter 2. Administrative commands 173
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.
DEFINE DEVCLASS 4MM

174 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS 8MM
Use the 8MM device class when you are using 8 mm tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

8MM
WORM = NO
WORM

=

NO

YES
FORMAT = DRIVE
FORMAT

=

DRIVE

8200

8200C

8500

8500C

8900

AIT

AITC

M2

M2C

SAIT

SAITC

VXA2

VXA2C

VXA3

VXA3C

ESTCAPacity

=

size
PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention = 60
MOUNTRetention

=

minutes
MOUNTWait = 60
MOUNTWait

=

minutes

MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the 8mm tape
drives used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
DEFINE DEVCLASS 8MM
Chapter 2. Administrative commands 175
DEVType=8MM (Required)
Specifies that the 8MM device type is assigned to the device class. 8MM
indicates that 8mm tape devices are assigned to this device class.
WORM
Specifies whether the drives will use WORM (write once, read many) media.
The parameter is optional. The default is NO.
Yes
Specifies that the drives will use WORM media.
Note: If you select YES, the only options available for the FORMAT
parameter are:
v DRIVE
v AIT
v AITC
No
Specifies that the drives will not use WORM media.
Refer to the Administrators Guide for more information.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional. The default value is DRIVE.
If the drives are in a library that includes drives of different tape technology,
do not use the DRIVE value. Use the specific format that the drives use. Refer
to the Administrators Guide for more information.
The following table lists the recording formats and estimated capacities for
8mm devices:
Table 65. Recording format and default estimated capacity for 8mm tape
Format
Medium Type Estimated Capacity Description
DRIVE The server selects the highest format that is supported by
the drive on which a volume is mounted.
Attention: Avoid specifying DRIVE when a mixture of
drives is used within the same library. For example, do not
use this option for a library containing some drives that
support recording formats superior to other drives.
8200 2.3GB Uncompressed (standard) format, using standard 112-meter
tape cartridges
8200C
See note
3.5GB
4.6GB
Compressed format, using standard 112-meter tape
cartridges
DEFINE DEVCLASS 8MM

176 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 65. Recording format and default estimated capacity for 8mm tape (continued)
Format
Medium Type Estimated Capacity Description
8500
15m
15m
15m
54m
54m
54m
112m
112m
112m
160m XL
See note
600MB
600MB
600MB
2.35GB
2.35GB
2.35GB
5GB or 10.0GB
5GB or 10.0GB
5GB or 10.0GB
7GB
Drives (Read Write)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
8500C
15m
15m
15m
54m
54m
54m
112m
112m
112m
160m XL
See note
1.2GB
1.2GB
1.2GB
4.7GB
4.7GB
4.7GB
5GB or 10.0GB
5GB or 10.0GB
5GB or 10.0GB
7GB
Drives (Read Write)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
8900
15m
54m
112m
160m XL
22m
125m
170m
See note




2.5 GB

40 GB
Drive (Read Write)
Mammoth 8900 (R)
Mammoth 8900 (R)
Mammoth 8900 (R)
Mammoth 8900 (R)
Mammoth 8900 (RW)
Mammoth 8900 (RW with upgrade)
Mammoth 8900 (RW)
AIT
SDX125C
SDX135C
SDX236C
SDX250C
SDX3100C
SDX3X-150C
SDX4200C
SDX5-400C
See note
25GB
35GB
36GB
50GB
100GB
150GB
200GB
400GB
Drive
AIT, AIT2 and AIT3 drives
AIT, AIT2 and AIT3 drives
AIT2 and AIT3 drives
AIT2 and AIT3 drives
AIT3, AIT4, and AIT5 drives
AIT3-Ex, AIT4, and AIT5 drives
AIT4 and AIT5 drives
AIT5 drive
AITC
SDX125C
SDX135C
SDX236C
SDX250C
SDX3100C
SDX3X-150C
SDX4200C
SDX5-400C
See note
50GB
91GB
72GB
130GB
260GB
390GB
520GB
1040GB
Drive
AIT, AIT2 and AIT3 drives
AIT, AIT2 and AIT3 drives
AIT2 and AIT3 drives
AIT2 and AIT3 drives
AIT3, AIT4, and AIT5 drives
AIT3-Ex, AIT4, and AIT5 drives
AIT4 and AIT5 drives
AIT5 drive
DEFINE DEVCLASS 8MM
Chapter 2. Administrative commands 177
Table 65. Recording format and default estimated capacity for 8mm tape (continued)
Format
Medium Type Estimated Capacity Description
M2
75m
150m
225m
See note
20.0GB
40.0GB
60.0GB
Drive (Read Write)
Mammoth II (RW)
Mammoth II (RW)
Mammoth II (RW)
M2C
75m
150m
225m
See note
50.0GB
100.0GB
150.0GB
Drive (Read Write)
Mammoth II (RW)
Mammoth II (RW)
Mammoth II (RW)
SAIT See note
500GB
Drive (Read Write)
Sony SAIT1500(RW)
SAITC See note
1300GB (1.3TB)
Drive (Read Write)
Sony SAIT1500(RW)
VXA2
V6 (62m)
V10 (124m)
V17 (170m)
See note
20GB
40GB
60GB
Drive (Read Write)
VXA2
VXA2C
V6 (62m)
V10 (124m)
V17 (170m)
See note
40GB
80GB
120GB
Drive (Read Write)
VXA2
VXA3
X6 (62m)
X10 (124m)
X23 (230m)
See note
40GB
86GB
160GB
Drive (Read Write)
VXA3
VXA3C
X6 (62m)
X10 (124m)
X23 (230m)
See note
80GB
172GB
320GB
Drive (Read Write)
VXA3
Note: The actual capacities may vary depending on which cartridges and drives are used.
v For the M2C format, the normal compression ratio is 2.5:1.
v For the AITC and SAITC formats, the normal compression ratio is 2.6:1.

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
Specify this value as an integer followed by K (Kilobytes), M (Megabytes), or
G (Gigabytes).
DEFINE DEVCLASS 8MM

178 IBM Tivoli Storage Manager for Windows: Administrators Reference
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes. The smallest value allowed is
100KB (that is, ESTCAPACITY=100K).
For more information on the default estimated capacity for 8mm tapes, see
Table 65 on page 176.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. The default value is 60. You
can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online.
For EXTERNAL library types (that is, a library managed by an external media
management system), set this parameter to a low value (for example, two
minutes) to enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
DEFINE DEVCLASS 8MM
Chapter 2. Administrative commands 179
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
Examples
Task
Define a device class named 8MMTAPE for an 8mm device in a library named
AUTO. The format is DRIVE, mount limit is 2, mount retention is 10, tape volume
prefix is named ADSMVOL, and the estimated capacity is 6GB.
Command
define devclass 8mmtape devtype=8mm library=auto
format=drive mountlimit=2 mountretention=10
prefix=adsmvol estcapacity=6G
DEFINE DEVCLASS 8MM

180 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS CENTERA
Use the CENTERA device class when you are using EMC Centera storage devices.
The CENTERA device type uses files as volumes to store data sequentially. It is
similar to the FILE device class.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name DEVType = CENTERA

(1)
HLAddress

=

ip_address?PEA_file
MINCAPacity = 100M
MINCAPacity

=

100M

size

MOUNTLimit = 1
MOUNTLimit

=

1

number

Notes:
1 For each Centera device class, you must specify an IP address. However, a
Pool Entry Authorization (PEA) file name and path are optional, and the PEA
file specification must follow the IP address. Use the ? character to separate
the PEA file name and path from the IP address.
Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
DEVType=CENTERA (Required)
Specifies that the Centera device type is assigned to this device class. All
volumes belonging to a storage pool that is defined to this device class are
logical volumes that are a form of sequential access media
HLAddress
Specifies an IP address for the Centera storage device and, optionally, the name
and path of one Pool Entry Authorization (PEA) file. Specify the IP address
using the dotted decimal format (for example, 9.10.111.222). A Centera device
might have multiple IP addresses. However, you only need to specify one of
them as a value for this parameter.
If you append the name and path of a PEA file, ensure that the file is stored in
a directory on the system running the Tivoli Storage Manager server. Separate
the PEA file name and path from the IP address using the ? character, for
example:
HLADDRESS=9.10.111.222?c:\controlFiles\TSM.PEA
Specify only one PEA file name and path for each device class definition. If
you specify two different Centera device classes that point to the same Centera
DEFINE DEVCLASS CENTERA
Chapter 2. Administrative commands 181
storage device and if the device class definitions contain different PEA file
names and paths, the Tivoli Storage Manager server will use the PEA file
specified in the device class HLADDRESS parameter that was first used to
open the Centera storage device.
Note:
1. The Tivoli Storage Manager server does not include a PEA file
during installation. If you do not create a PEA file, the Tivoli Storage
Manager server uses the Centera default profile, which can allow
applications to read, write, delete, purge, and query data on a
Centera storage device. To provide tighter control, create a PEA file
using the command line interface provided by EMC Centera. For
details about Centera authentication and authorization, refer to the
EMC Centera Programmers Guide.
2. You can also specify the PEA file name and path in an environment
variable using the syntax CENTERA_PEA_LOCATION=filePath_
fileName. The PEA file name and path specified using this
environment variable apply to all Centera clusters. If you use this
variable, you do not need to specify the PEA file name and path
using the HLADDRESS parameter.
MINCAPacity
Specifies the minimum size for Centera volumes assigned to a storage pool in
this device class. This value represents the minimum amount of data stored on
a Centera volume before the Tivoli Storage Manager server marks it full.
Centera volumes will continue to accept data until the minimum amount of
data has been stored. The default value is 100M. This parameter is optional.
100M
Specifies that the minimum capacity is 100M (100MB).
size
Specify this value as an integer followed by K (Kilobytes), M (Megabytes),
or G (Gigabytes). The minimum value allowed is 1MB
(MINCAPACITY=1M). The maximum value allowed is 128GB
(MINCAPacity=128G).
MOUNTLimit
Specifies the maximum number of files that can be simultaneously open for
input and output. The default value is 1. This parameter is optional. You can
specify any number from 0 or greater; however, the sum of all mount limit
values for all device classes assigned to the same Centera device should not
exceed the maximum number of sessions allowed by Centera.
DEFINE DEVCLASS CENTERA

182 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS DLT
Use the DLT device class when you are using DLT tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

DLT
WORM = NO
WORM

=

NO

YES
FORMAT = DRIVE
FORMAT

=

DRIVE

DLT1

DLT1C

DLT10

DLT10C

DLT15

DLT15C

DLT20

DLT20C

DLT35

DLT35C

DLT40

DLT40C

DLT2

DLT2C

DLT4

DLT4C

SDLT

SDLTC

SDLT320

SDLT320C

SDLT600

SDLT600C

DLTS4

DLTS4C

ESTCAPacity

=

size
PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention = 60
MOUNTRetention

=

minutes
MOUNTWait = 60
MOUNTWait

=

minutes

MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

DEFINE DEVCLASS DLT
Chapter 2. Administrative commands 183
Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the DLT tape
drives used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
DEVType=DLT (Required)
Specifies that the DLT device type is assigned to the device class. DLT indicates
that DLT tape devices are assigned to this device class.
WORM
Specifies whether the drives will use WORM (write once, read many) media.
The parameter is optional. The default is NO.
Yes
Specifies that the drives will use WORM media.
Note: Support for DLT WORM media is available only for SDLT-600,
Quantum DLT-V4, and Quantum DLT-S4 drives in manual, SCSI,
and ACSLS libraries.
No
Specifies that the drives will not use WORM media.
For more information, refer to the Administrators Guide.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional; the default value is DRIVE.
If the drives are in a library that includes drives of different tape technology,
do not use the DRIVE value. Use the specific format that the drives use. Refer
to the Administrators Guide for more information.
The following table lists the recording formats and estimated capacities for
DLT devices:
Table 66. Recording format and default estimated capacity for DLT
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
DLT1 40.0GB Uncompressed format, using only CompacTape III
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DEFINE DEVCLASS DLT

184 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 66. Recording format and default estimated capacity for DLT (continued)
Format
Estimated
Capacity Description
DLT1C
See note 1 on
page 186.
80.0GB
Compressed format, using only CompacTape III
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT10 10.0GB Uncompressed format, using only CompacTape III
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT10C
See note 1 on
page 186.
20.0GB
Compressed format, using only CompacTape III
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT15 15.0GB Uncompressed format, using only CompacTape IIIxt
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT15C
See note 1 on
page 186.
30.0GB
Compressed format, using only CompacTape IIIxt
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT20 20.0GB Uncompressed format, using only CompacTape IV
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT20C
See note 1 on
page 186.
40.0GB
Compressed format, using only CompacTape IV
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT35 35.0GB Uncompressed format, using only CompacTape IV
cartridges
Valid with DLT7000 and DLT8000 drives
DLT35C
See note 1 on
page 186.
70.0GB
Compressed format, using only CompacTape IV
cartridges
Valid with DLT7000 and DLT8000 drives
DLT40 40.0GB Uncompressed format, using CompacTape IV
cartridges
Valid with a DLT8000 drive
DLT40C
See note 1 on
page 186.
80.0GB
Compressed format, using CompacTape IV cartridges
Valid with a DLT8000 drive
DLT2 80.0GB Uncompressed format, using Quantum DLT tape VS1
media
DEFINE DEVCLASS DLT
Chapter 2. Administrative commands 185
Table 66. Recording format and default estimated capacity for DLT (continued)
Format
Estimated
Capacity Description
DLT2C
See note 1.
160.0GB
Compressed format, using Quantum DLT tape VS1
media
DLT4 160.0GB Uncompressed format, using Quantum DLTtape VS1
cartridges.
Valid with Quantum DLT-V4 drive
DLT4C
See note 1.
320.0GB
Compressed format, using Quantum DLTtape VS1
cartridges.
Valid with Quantum DLT-V4 drive
SDLT
See note 2.
100.0GB Uncompressed format, using Super DLT Tape 1
cartridges
Valid with a Super DLT drive
SDLTC
See note 2.
See note 1.
200.0GB
Compressed format, using Super DLT Tape 1
cartridges
Valid with a Super DLT drive
SDLT320
See note 2.
160.0GB Uncompressed format, using Quantum SDLT I media
Valid with a Super DLT drive
SDLT320C
See note 2.
See note 1.
320.0GB
Compressed format, using Quantum SDLT I media
Valid with a Super DLT drive
SDLT600 300.0GB Uncompressed format, using SuperDLTtape-II media
Valid with a Super DLT drive
SDLT600C
See note 1.
600.0GB
Compressed format, using SuperDLTtape-II media
Valid with a Super DLT drive
DLTS4 800GB Uncompressed format, using Quantum DLT S4
media.
Valid with a DLT-S4 drive
DLTS4C
See note 1.
1.6TB
Compressed format, using Quantum DLT S4 media.
Valid with a DLT-S4 drive
Note:
1. Depending on the effectiveness of compression, the actual capacity may be greater than
the listed value.
2. Tivoli Storage Manager does not support a library that contains both Backward Read
Compatible (BRC) SDLT and Non-Backward Read Compatible (NBRC) SDLT drives.

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
DEFINE DEVCLASS DLT

186 IBM Tivoli Storage Manager for Windows: Administrators Reference
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes. The smallest value allowed is
100KB (that is, ESTCAPACITY=100K).
For more information on estimated capacities, see Table 66 on page 184.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. The default value is 60. You
can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
DEFINE DEVCLASS DLT
Chapter 2. Administrative commands 187
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DEFINE DEVCLASS DLT

188 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS DTF
Use the DTF device class when you are using DTF tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

DTF
FORMAT = DRIVE
FORMAT

=

DRIVE

DTF

DTFC

DTF2

DTF2C

ESTCAPacity

=

size

PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix
MOUNTRetention = 60
MOUNTRetention

=

minutes

MOUNTWait = 60
MOUNTWait

=

minutes
MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the DTF tape
drives used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
DEVType=DTF (Required)
Specifies that the DTF tape devices are assigned to this device class.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional; the default value is DRIVE.
If the drives are in a library that includes drives of different tape technology,
do not use the DRIVE value. Use the specific format that the drives use. Refer
to the Administrators Guide for more information.
The following table lists the recording formats and estimated capacities for
DTF devices:
DEFINE DEVCLASS DTF
Chapter 2. Administrative commands 189
Table 67. Recording format and default estimated capacity for DTF
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
DTF
12.0GB
42.0GB
Using GW-240 tape cassettes
Using GW-730L tape cassettes
DTFC
24.0GB
84.0GB
Using GW-240 tape cassettes
Using GW-730L tape cassettes
DTF2
60.0GB
200.0GB
Using GW2-60GS tape cassettes
Using GW2-200GL tape cassettes
DTF2C
120.0GB
400.0GB
Using GW2-60GS tape cassettes
Using GW2-200GL tape cassettes

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional. You can specify this parameter if the default
estimated capacity for the device class is inaccurate due to compression of
data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
The smallest value allowed is 100KB (that is, ESTCAPACITY=100K).
For more information on estimated capacities, see Table 67.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
DEFINE DEVCLASS DTF

190 IBM Tivoli Storage Manager for Windows: Administrators Reference
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. The default value is 60. You
can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DEFINE DEVCLASS DTF
Chapter 2. Administrative commands 191
DEFINE DEVCLASS ECARTRIDGE
Use the ECARTRIDGE device class when you are using StorageTek drives such as
the StorageTek SD-3, 9490, 9840 or 9940.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

ECARTridge
WORM = NO
WORM

=

NO

YES
FORMAT = DRIVE
FORMAT

=

DRIVE

18T

18TC

36T

36TC

SD3A

SD3AC

SD3B

SD3BC

SD3C

SD3CC

9840

9840-C

9940

9940-C

9940B

9940B-C

M8100

M8100C

T9840C

T9840C-C

T10000A

T10000A-C

ESTCAPacity

=

size
PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention = 60
MOUNTRetention

=

minutes
MOUNTWait = 60
MOUNTWait

=

minutes

MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

DEFINE DEVCLASS ECARTRIDGE

192 IBM Tivoli Storage Manager for Windows: Administrators Reference
Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the ECARTRIDGE
tape drives that can be used by this device class. For information about
defining a library object, see the DEFINE LIBRARY command.
DEVType=ECARTridge (Required)
Specifies that the ECARTRIDGE device type is assigned to the device class.
ECARTRIDGE indicates that a specific type of cartridge tape device
(StorageTek) is assigned to this device class.
WORM
Specifies whether the drives will utilize WORM (write once, read many)
media. The parameter is optional. The default is NO.
Note: If you select YES, the only options available for the FORMAT parameter
are:
v DRIVE
v 9840
v 9840-C
v 10000
v 10000-C
Refer to the Administrators Guide for more information.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional; the default value is DRIVE. If the
drives are in a library that includes drives of different tape technology, do not
use the DRIVE value. Use the specific format that the drives use. Refer to the
Administrators Guide for more information.
Attention: If you specify DRIVE for a device class that has non-compatible
sequential access devices, then you must mount volumes on devices that are
capable of reading or writing the format established when the volume was first
mounted. This can cause delays if the only sequential access device that can
access the volume is already in use.
The following table lists the recording formats and estimated capacities for
ECARTRIDGE devices:
Table 68. Recording formats and default estimated capacities for ECARTRIDGE tapes
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
DEFINE DEVCLASS ECARTRIDGE
Chapter 2. Administrative commands 193
|
|
Table 68. Recording formats and default estimated capacities for ECARTRIDGE
tapes (continued)
Format
Estimated
Capacity Description
18T 360MB 18-track uncompressed (standard) (read-only) format
18TC
See note
1.44GB
18-track extended (read-only), compressed format
36T 720MB 36-track extended (read and write) format
36TC
See note
2.88GB
36-track extended (read and write), compressed
format
SD3A 10GB Uncompressed (standard) format, using a 10GB A
cartridge with 91 meters (298 feet) of tape
SD3AC
See note
40GB
Compressed format, using a 10GB A cartridge with
91 meters (298 feet) of tape
SD3B 25GB Uncompressed (standard) format, using a 25GB B
cartridge with 204 meters (668 feet) of tape
SD3BC
See note
100GB
Compressed format, using a 25GB B cartridge with
204 meters (668 feet) of tape
SD3C 50GB Uncompressed (standard) format, using a 50GB C
cartridge with 392 meters (1286 feet) of tape
SD3CC
See note
200GB
Compressed format, using a 50GB C cartridge with
392 meters (1286 feet) of tape
9840 20GB Uncompressed (standard) format, using a 20GB
cartridge with 270 meters (885 feet) of tape
9840-C
See note
80GB
LZ-1 Enhanced (4:1) compressed format, using a
80GB cartridge with 270 meters (885 feet) of tape
9940 60GB Uncompressed (standard) format, using a 60GB
cartridge.
9940-C
See note
120GB
Compressed format, using a 60GB cartridge.
9940B 200GB Uncompressed (standard) format, using a 200GB
cartridge.
9940B-C
See note
400GB
Compressed format, using a 200GB cartridge.
M8100 10GB Uncompressed (standard) format, using a 10GB
cartridge.
DEFINE DEVCLASS ECARTRIDGE

194 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 68. Recording formats and default estimated capacities for ECARTRIDGE
tapes (continued)
Format
Estimated
Capacity Description
M8100C 10GB Compressed format, using a 10GB cartridge. Because
there is no mechanism to determine the type of
cartridge in an M8100 drive, the server assumes a
10GB estimated uncompressed capacity.
T9840C 40GB Uncompressed (standard) format, using STK media.
T9840C-C 80GB Compressed format, using STK media.
T10000A 500GB Uncompressed (standard) format, using STK media.
T10000A-C 1TB Compressed format, using STK media.
Note: Some formats use a tape drive hardware compression feature. Depending on the
effectiveness of compression, the actual capacity may be double or more than the listed
value.

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
PREFIX
Specifies the high-level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM.
If you have already established a tape label naming convention that supports
your current tape management system, use a tape volume prefix that conforms
to your naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
ADSM.BFS is an example of a tape volume filename using the default prefix
and the added server qualifier.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. The default value is 60. You
can specify a number from 0 to 9999.
DEFINE DEVCLASS ECARTRIDGE
Chapter 2. Administrative commands 195
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DEFINE DEVCLASS ECARTRIDGE

196 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS FILE
Use the FILE device class when you are using files on magnetic disk storage as
volumes that store data sequentially (as on tape).
The FILE device class does not support EXTERNAL libraries. The FILE device class
does not support EXTERNAL or RSM libraries. For information about disk
subsystem requirements for FILE-type disk storage, see the Administrators Guide.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name DEVType = FILE

MOUNTLimit = 20
MOUNTLimit

=

number
MAXCAPacity = 2G
MAXCAPacity

=

size

DIRectory = current_directory_name
,

DIRectory

=

directory_name
SHAREd = No
SHAREd

=

No

Yes

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
DEVType=FILE (Required)
Specifies that the FILE device type is assigned to the device class. FILE
indicates that a file is assigned to this device class. When the server needs to
access a volume that belongs to this device class, it opens a file and reads or
writes file data. A file is a form of sequential access media.
MOUNTLimit
Specifies the maximum number of files that can be simultaneously open for
input/output. This parameter is optional. The default value is 20. You can
specify a number from 1 to 4096. If the device class will be shared with a
storage agent (by specifying the SHARED=YES parameter), drives will be
defined or deleted to match the mount limit value.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
MAXCAPacity
Specifies the maximum size of any data storage files defined to a storage pool
in this device class. The value of the MAXCAPACITY parameter is also used as
the unit of allocation when storage pool space triggers create volumes. The
default value is 2GB (MAXCAPACITY=2G). MAXCAPACITY=5M specifies that
DEFINE DEVCLASS FILE
Chapter 2. Administrative commands 197
the maximum capacity for a volume in this device class is 5 megabytes. This
parameter is optional. The value specified should be less than or equal to the
maximum supported size of a file on the target file system.
2G
Specify that the maximum capacity of the storage files is 2G (2GB).
size
Specify this value as an integer followed by K (Kilobytes), M (Megabytes),
or G (Gigabytes). The minimum value allowed is 100KB
(MAXCAPACITY=100K).
DIRectory
Specifies the directory location or locations of the files used in this device class.
Enclose the entire list of directories within quotation marks, using commas to
separate individual directory names. Special characters (for example, blank
spaces) are permitted within directory names. For example, the directory list
abc def,xyz contains two directories: abc def and xyz.
This parameter is optional. The default is the current working directory of the
server at the time the command is issued. Windows registry information is
used to determine the default directory.
By specifying a directory name or names, you identify the location where the
server places the files that represent storage volumes for this device class. For
NetApp SnapLock support (storage pools with
RECLAMATIONTYPE=SNAPLOCK, which are going to use this device class),
the directory or directories specified with DIRECTORY parameter must point
to the directory or directories on the NetApp SnapLock volumes. For a detailed
description of NetApp SnapLock support, refer to the Administrators Guide.
If the server needs to allocate a scratch volume, it creates a new file in one of
these directories. (The server can choose any of the directories in which to
create new scratch volumes.) For scratch volumes used to store client data, the
file created by the server has a file name extension of .bfs. For scratch volumes
used to store export data, a file name extension of .exp is used. For example, if
you define a device class with a directory of c:\server and the server needs a
scratch volume in this device class to store export data, the file that the server
creates might be named c:\server\00566497.exp.
Storage agents using FILE volumes: You must ensure that storage agents can
access newly created FILE volumes.
Failure of the storage agent to access a
FILE volume can cause operations to be
retried on a LAN-only path or to fail. For
more information, see the description of
the DIRECTORY parameter in DEFINE
PATH (Define a path) on page 263.
DEFINE DEVCLASS FILE

198 IBM Tivoli Storage Manager for Windows: Administrators Reference
Attention: Space trigger functions and storage pool space calculations take
into account the space remaining in each directory. Ideally, you should
associate each directory with a separate file system. If you specify multiple
directories for a device class and the directories reside in the same file system,
the server will calculate space by adding values representing the space
remaining in each directory. These space calculations will be inaccurate. Rather
than choosing a storage pool with sufficient space for an operation, the server
could choose the wrong storage pool and run out of space prematurely. For
space triggers, an inaccurate calculation could result in a failure to expand the
space available in a storage pool. Failure to expand space in a storage pool is
one of the conditions that can cause a trigger to become disabled. If a trigger is
disabled because the space in a storage pool could not be expanded, you can
re-enable the trigger by specifying the following command: update
spacetrigger stg. No further changes are required to the space trigger.
SHAREd
Specifies that this FILE device class will be shared between the server and one
or more storage agents. To prepare for sharing, a library will be automatically
defined along with a number of drives corresponding to the MOUNTLIMIT
parameter value. The drive names are the name of the library plus a number
from 1 to the mount limit number. For example, if the library name is FILE
and the mount limit is set to 4, the drives are named FILE11, FILE12, FILE13,
FILE14.
Note: For information about prerequisites when storage is shared by the server
and storage agent, see http://www.ibm.com/software/sysmgmt/
products/support/IBMTivoliStorageManager.html.
Examples
Task
Define a device class that specifies multiple directories.
Command
define devclass multidir devtype=file
directory=e:\xyz,f:\abc,g:\uvw
Task
Define a device class named PLAINFILES with a FILE device type and a
maximum capacity of 50MB.
Command
define devclass plainfiles devtype=file
maxcapacity=50m
DEFINE DEVCLASS FILE
Chapter 2. Administrative commands 199
DEFINE DEVCLASS GENERICTAPE
Use the GENERICTAPE device class for tape drives supported by operating system
device drivers.
When using this device type, the server does not recognize either the type of
device or the cartridge recording format. Because the server does not recognize the
type of device, if an I/O error occurs, error information is less detailed compared
to error information for a specific device type (for example, 8mm). When defining
devices to the server, do not mix various types of devices within the same device
type.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name
DEVType = GENERICTAPE
ESTCAPacity

=

size

MOUNTRetention = 60
MOUNTRetention

=

minutes
MOUNTWait = 60
MOUNTWait

=

minutes

MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the tape drives
used by this device class. For information about defining a library object, see
the DEFINE LIBRARY command.
DEVType=GENERICTAPE (Required)
Specifies that the GENERICTAPE device type is assigned to the device class.
GENERICTAPE indicates that the volumes for this device class are used in
tape drives supported by the operating systems tape device driver.
The server recognizes that the media can be removed and that additional
media can be inserted, subject to limits set with the MOUNTLIMIT parameter
for the device class and the MAXSCRATCH parameter for the storage pool.
Volumes in a device class with device type GENERICTAPE are sequential
access volumes.
DEFINE DEVCLASS GENERICTAPE

200 IBM Tivoli Storage Manager for Windows: Administrators Reference
ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
Specify a capacity appropriate to the particular tape drive being used.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
MOUNTRetention
Specifies the amount of time, in minutes, to retain an idle sequential access
volume before dismounting it. This parameter is optional. The default value is
60. You can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types, setting this parameter to a low value (for example, two minutes)
enhances device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
DEFINE DEVCLASS GENERICTAPE
Chapter 2. Administrative commands 201
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DEFINE DEVCLASS GENERICTAPE

202 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS LTO
Use the LTO device class when you are using LTO tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

LTO
(1)
WORM

=

NO

WORM

=

NO

YES

FORMAT

=

DRIVE

FORMAT

=

DRIVE

ULTRIUM

ULTRIUMC

ULTRIUM2

ULTRIUM2C

ULTRIUM3

ULTRIUM3C

ULTRIUM4

ULTRIUM4C

ESTCAPacity

=

size
PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention = 60
MOUNTRetention

=

minutes
MOUNTWait = 60
MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

MOUNTLimit

=

DRIVES

number

0
(1) (2)
DRIVEEncryption

=

ALLOW

DRIVEEncryption

=

ON

ALLOW

OFF

Notes:
1 You cannot specify both WORM=YES and DRIVEENCRYPTION=ON.
2 Drive encryption is supported only for IBM and HP Ultrium 4 drives and
media.
Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the LTO tape
DEFINE DEVCLASS LTO
Chapter 2. Administrative commands 203
||
||||||||
|
|
|
drives used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
DEVType=LTO (Required)
Specifies that the linear tape open (LTO) device type is assigned to the device
class.
WORM
Specifies whether the drives will use WORM (write once, read many) media.
The parameter is optional. The default is NO.
Yes
Specifies that the drives will use WORM media.
Note:
1. To use WORM media in a library, all the drives in the library
must be WORM capable.
2. You cannot specify Tivoli Storage Manager as the key manager
for drive encryption of WORM (write once, read many) media.
(Specifying both WORM=YES and DRIVEENCRYPTION=ON is
not supported.)
No
Specifies that the drives will not use WORM media.
For more information, refer to the Administrators Guide.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional; the default value is DRIVE.
If the drives are in a library that includes drives of different tape technology,
do not use the DRIVE value. Use the specific format that the drives use. Refer
to the Administrators Guide for more information.
When migrating all drives from Ultrium to Ultrium 2 devices:
v Delete all existing Ultrium drive definitions and the paths associated with
them.
v Define the new Ultrium 2 drives and paths.
If you are considering mixing different generations of LTO media and drives,
be aware of the following restrictions. For more information about mixing
drives and media, refer to the Administrators Guide.
Table 69. Read - write capabilities for different generations of LTO drives
Drives
Generation 1
media
Generation 2
media
Generation 3
media
Generation 4
media
Generation 1 Read and write n/a n/a n/a
Generation 2 Read and write Read and write n/a n/a
Generation 3
1
Read only Read and write Read and write n/a
Generation 4
2
n/a Read only Read and write Read and write
1
In a library with a Generation 3 drive, all Generation 1 scratch volumes need to be
checked out, and all Generation 1 storage pool volumes need to be updated to read-only.
2
In a library with a Generation 4 drive, all Generation 2 scratch volumes need to be
checked out, and all Generation 2 storage pool volumes need to be updated to read-only.

DEFINE DEVCLASS LTO

204 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|||||
|
|
The following table lists the recording formats and estimated capacities for
LTO devices:
Table 70. Recording format and default estimated capacity for LTO
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
ULTRIUM 100GB Uncompressed format, using Ultrium cartridges
ULTRIUMC See note
200GB
Compressed format, using Ultrium cartridges
ULTRIUM2 200GB Uncompressed (standard) format, using Ultrium 2
cartridges
ULTRIUM2C See note
400GB
Compressed format, using Ultrium 2 cartridges
ULTRIUM3 400GB Uncompressed (standard) format, using Ultrium 3
cartridges
ULTRIUM3C See note
800GB
Compressed format, using Ultrium 3 cartridges
ULTRIUM4 800GB Uncompressed (standard) format, using IBM or HP
Ultrium 4 cartridges
ULTRIUM4C See note
1.6TB
Compressed format, using IBM or HP Ultrium 4
cartridges
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=100G specifies that the estimated capacity for a
volume in this device class is 100 gigabytes.
For more information on estimated capacities, see Table 70.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
DEFINE DEVCLASS LTO
Chapter 2. Administrative commands 205
|||
|
||
|
|
|
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. The default value is 60. You
can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types, you can enhance device sharing between applications by setting
this parameter to a low value (for example, two minutes).
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
DEFINE DEVCLASS LTO

206 IBM Tivoli Storage Manager for Windows: Administrators Reference
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DRIVEEncryption
Specifies whether drive encryption will be permitted. This parameter is
optional. The default is ALLOW.
Note:
1. Drive encryption is supported only for IBM and HP Ultrium 4 drives
and media.
2. You cannot specify Tivoli Storage Manager as the key manager for
drive encryption of WORM (write once, read many) media.
(Specifying both WORM=YES and DRIVEENCRYPTION=ON is not
supported.)
ON
Specifies that Tivoli Storage Manager is the key manager for drive
encryption and will permit drive encryption for empty storage pool
volumes only if the application method is enabled. (Other types of
volumesfor example, backup sets, export volumes, and database backup
volumeswill not be encrypted.) If you specify ON and you enable
another method of encryption, drive encryption will not be permitted and
backup operations will fail.
ALLOW
Specifies that Tivoli Storage Manager does not manage the keys for drive
encryption. However, drive encryption for empty volumes is permitted if
another method of encryption is enabled.
OFF
Specifies that drive encryption will not be permitted. If you enable another
method of encryption, backups will fail. If you enable the application
method, Tivoli Storage Manager will disable encryption and backups will
be attempted.
Examples
Task
Define a device class named LTOTAPE for an LTO drive in a library named
LTOLIB. The format is ULTRIUM, mount limit is 12, mount retention is 5, tape
volume prefix is named SMVOL, and the estimated capacity is 100GB.
Command
define devclass ltotape devtype=lto library=ltolib
format=ultrium mountlimit=12 mountretention=5
prefix=smvol estcapacity=100G
DEFINE DEVCLASS LTO
Chapter 2. Administrative commands 207
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DEFINE DEVCLASS NAS
Use the NAS device class when you are using NDMP (Network Data Management
Protocol) operations to back up network-attached storage (NAS) file servers. The
device class is for drives supported by the NAS file server for backups.
The NAS device class does not support EXTERNAL or RSM libraries.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name DEVType = NAS

LIBRary

=

library_name

MOUNTRetention

=

0
MOUNTWait = 60
MOUNTWait

=

minutes

MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

ESTCAPacity

=

size

PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
DEVType=NAS (Required)
Specifies that the network-attached storage (NAS) device type is assigned to
the device class. The NAS device type is for drives attached to and used by a
NAS file server for backup of NAS file systems.
LIBRary (Required)
Specifies the name of the defined library object that contains the SCSI tape
drives used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
MOUNTRetention=0 (Required)
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. Zero (0) is the only supported value for device classes
with DEVType=NAS.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
DEFINE DEVCLASS NAS

208 IBM Tivoli Storage Manager for Windows: Administrators Reference
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
ESTCAPacity (Required)
Specifies the estimated capacity for the volumes assigned to this device class.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=100G specifies that the estimated capacity for a
volume in this device class is 100 gigabytes.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
DEFINE DEVCLASS NAS
Chapter 2. Administrative commands 209
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
Examples
Task
Define a device class named NASTAPE for a NAS drive in a library named
NASLIB. The mount limit is DRIVES, mount retention is 0, tape volume prefix is
named SMVOL, and the estimated capacity is 200GB.
Command
define devclass nastape devtype=nas library=naslib
mountretention=0 mountlimit=drives
prefix=smvol estcapacity=200G
DEFINE DEVCLASS NAS

210 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS OPTICAL and WORM types
Use the OPTICAL device class when you are using optical devices. Use the WORM
device class when you are using optical devices that have WORM capability.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

OPTical

WORM

WORM12

WORM14
FORMAT = DRIVE
FORMAT

=

DRIVE

650MB

1300MB

2600MB

5200MB

5600MB

6800MB

9100MB

10200MB

12000MB

14800MB

23GB

30GB

60GB

ESTCAPacity

=

size
MOUNTRetention = 60
MOUNTRetention

=

minutes

MOUNTWait = 60
MOUNTWait

=

minutes
MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the optical drives
used by this device class. For information about defining a library object, see
the DEFINE LIBRARY command.
DEVType (Required)
Specifies the device types that are assigned to the device class.
Possible values are:
OPTical
Specifies that the device class uses two-sided 5.25 inch rewritable optical
media.
DEFINE DEVCLASS OPTICAL and WORM types
Chapter 2. Administrative commands 211
|
WORM
Specifies that the device class uses two-sided 5.25 inch write-once
read-many (WORM) optical media.
WORM12
Specifies that the device class uses one-sided 12-inch WORM optical media.
WORM14
Specifies that the device class uses two-sided 14-inch WORM optical
media.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional; the default value is DRIVE. If the
drives are in a library that includes drives of different tape technology, do not
use the DRIVE value. Use the specific format that the drives use. Refer to the
Administrators Guide for more information.
The following table lists the recording formats and estimated capacities for
OPTICAL and WORM devices:
Table 71. Estimated capacities for OPTICAL and WORM drives
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
650MB 650MB Using a 650 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
1300MB 1300MB Using a 1300 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
2600MB 2600MB Using a 2600 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
5200MB 5200MB Using a 5200 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
5600MB 5600MB Using a 5600 MB 12-inch optical drive
Only valid for WORM12 device types
6800MB 6800MB Using a 6800 MB 14-inch optical drive
Only valid for WORM14 device types
9100MB 9100MB Using a 9100 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
10200MB 10200MB Using a 10200 MB 14-inch optical drive
Only valid for WORM14 device types
DEFINE DEVCLASS OPTICAL and WORM types

212 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 71. Estimated capacities for OPTICAL and WORM drives (continued)
Format
Estimated
Capacity Description
12000MB 12000MB Using a 12000 MB 12-inch optical drive
Only valid for WORM12 device types
14800MB 14800MB Using a 14800 MB 14-inch optical drive
Only valid for WORM14 device types
23GB 23GB Using Sony Blue Laser read-write and WORM media
Not valid for WORM12 or WORM14 device types
30GB 30GB Using Plasmon UDO1 read-write and WORM media
Not valid for WORM12 or WORM14 device types
60GB 60GB Using Plasmon or IBM UDO2 read-write and WORM
media
Not valid for WORM12 or WORM14 device types

Note: If you are considering mixing different generations of UDO media and
drives, be aware of the following:
v UDO1 drives can read and write UDO1 media only.
v UDO2 drives can read from, but not write to, UDO1 media.
ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
For more information on estimated capacities, see Table 71 on page 212.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. The default value is 60. You
can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types, setting this parameter to a low value (for example, two minutes)
enhances device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
DEFINE DEVCLASS OPTICAL and WORM types
Chapter 2. Administrative commands 213
|||
|
|
|
|
|
|
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mount limit value
(including online status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.
DEFINE DEVCLASS OPTICAL and WORM types

214 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS QIC
Use the QIC device class when you are using QIC tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

QIC
FORMAT = DRIVE
FORMAT

=

DRIVE

QIC120

QIC150

QIC525

QIC1000

QIC2GB

QIC2GBC

QIC4GB

QIC4GBC

QIC12GB

QIC12GBC

QIC20GB

QIC20GBC

QIC30GB

QIC30GBC

QIC5010

QIC5010C

QIC25GB

QIC25GBC

QIC50GB

QIC50GBC

QIC70GB

QIC70GBC

ESTCAPacity

=

size

PREFIX = ADSM
PREFIX

=

ADSM

tape_volume_prefix
MOUNTRetention = 60
MOUNTRetention

=

minutes

MOUNTWait = 60
MOUNTWait

=

minutes
MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the tape drives
DEFINE DEVCLASS QIC
Chapter 2. Administrative commands 215
that can be used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
DEVType=QIC (Required)
Specifies that the quarter-inch cartridge (QIC) device type is assigned to the
device class.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional; the default value is DRIVE.
If the drives are in a library that includes drives of different tape technology,
do not use the DRIVE value. Use the specific format that the drives use. Refer
to Administrators Guide for information.
The following tables list the recording formats, estimated capacities and
recording format options for QIC devices:
Table 72. Recording format and default estimated capacity for quarter-inch cartridge (QIC)
tape
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that can be
supported by the sequential access drive on which a
volume is mounted.
Avoid specifying the DRIVE value when a mixture of
devices is used within the same library.
For example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
QIC120 26.0MB 172.0MB 120 QIC format, depending on media
Using DC600XTD, DC6150, DC6320, and DC6525
QIC150 31.0MB 207.0MB 150 QIC format, depending on media
Using DC600XTD, DC6150, DC6320, and DC6525
QIC525 65.0MB 427.0MB 525 QIC format, depending on media
Using DC6320 and DC6525
QIC1000 169.0MB 1.1GB 1000 QIC format, depending on media
Using DC9100 and DC9120XL
QIC2GB 2.0GB Uncompressed 2000 QIC format
Using DC9100 and DC9120XL
QIC2GBC
See note
4.0GB
Compressed 2000 QIC format
QIC4GB 4.0GB Uncompressed 4000 QIC format
QIC4GBC
See note
8.0GB
Compressed 4000 QIC format
QIC12GB 12.0GB Uncompressed 12000 QIC format, using 343meter
tape
DEFINE DEVCLASS QIC

216 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 72. Recording format and default estimated capacity for quarter-inch cartridge (QIC)
tape (continued)
Format
Estimated
Capacity Description
QIC12GBC
See note
24.0GB
Compressed 12000 QIC format, using 343meter tape
QIC5010 13.0GB 16.0GB Uncompressed 5010 QIC format, depending on
media
QIC5010C
See note
26.0GB 32.0GB
Compressed 5010 QICformat, depending on media
QIC20GB 20.0GB Uncompressed 20000 QIC format
QIC20GBC
See note
40.0GB
Compressed 20000 QIC format
QIC25GB 25.0GB Uncompressed 25000 QIC format
QIC25GBC
See note
50.0GB
Compressed 25000 QIC format
QIC30GB 30.0GB Uncompressed 30000 QIC format
QIC30GBC
See note
60.0GB
Compressed 30000 QIC format
QIC50GB 50.0GB Uncompressed 50GB QIC format
QIC50GBC
See note
100.0GB
Compressed 50GB QIC format
QIC70GB 70.0GB Uncompressed 70GB QIC format
QIC70GBC
See note
140.0GB
Compressed 70GB QIC format
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

Table 73. QIC tape recording format options
Tape Format QIC-120 QIC-150 QIC-525 QIC-1000
3M DC300XLP
3M DC600A
3M DC600XTD
3M DC6150
3M DC6320
3M DC6525
3M DC9100
3M DC9120XL

Read
Read/Write
Read/Write
Read/Write
Read/Write




Read/Write
Read/Write
Read/Write
Read/Write






Read/Write
Read/Write








Read/Write
Read/Write
DEFINE DEVCLASS QIC
Chapter 2. Administrative commands 217
Table 73. QIC tape recording format options (continued)
Tape Format QIC-120 QIC-150 QIC-525 QIC-1000
Note: The server cannot use 3M DC300XLP and 3M DC600A tapes.

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
For more information on the default estimated capacity for QIC tapes, see
Table 72 on page 216.
PREFIX
Specifies the high level qualifier of the file name that the server writes into the
sequential access media labels. For each sequential access volume assigned to
this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. The default value is 60. You
can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
DEFINE DEVCLASS QIC

218 IBM Tivoli Storage Manager for Windows: Administrators Reference
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DEFINE DEVCLASS QIC
Chapter 2. Administrative commands 219
DEFINE DEVCLASS REMOVABLEFILE
Use the REMOVABLEFILE device class for removable media devices that are
attached as local, removable file systems.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

REMOVABLEfile
MAXCAPacity = space_remaining
MAXCAPacity

=

size

MOUNTRetention = 60
MOUNTRetention

=

minutes
MOUNTWait = 60
MOUNTWait

=

minutes

MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the removable
media drives used by this device class. For information about defining a
library object, see the DEFINE LIBRARY command.
DEVType=REMOVABLEfile (Required)
Specifies that the REMOVABLEFILE device type is assigned to the device class.
REMOVABLEFILE indicates that the volumes for this device class are files on
local, removable media.
Volumes in a device class with device type REMOVABLEFILE are sequential
access volumes.
Use the device manufacturers utilities to format (if necessary) and label the
media. The label on the media must meet the following restrictions:
v The label can have no more than 11 characters.
v The volume label and the name of the file on the volume must match
exactly.
v The MAXCAPACITY parameter value must be specified at less than the
capacity of the media.
Refer to Configuring REMOVABLEFILE Media Devices in the Administrators
Guide for more information.
DEFINE DEVCLASS REMOVABLEFILE

220 IBM Tivoli Storage Manager for Windows: Administrators Reference
MAXCAPacity
Specifies the maximum size of any volumes defined to a storage pool
categorized by this device class. This parameter is optional.
The MAXCAPACITY parameter must be set at less value than the capacity of
the media. For CD-ROM media, the maximum capacity should be no greater
than 650MB.
Because the server opens only one file per physical removable medium, specify
a capacity that enables one file to make full use of your media capacity.
space_remaining
The default maximum capacity is the space remaining on the media after it
is first used.
size
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes).
For example, MAXCAPACITY=5M specifies that the maximum capacity for a
volume in this device class is 5 megabytes. The smallest value allowed is
100KB (that is, MAXCAPACITY=100K).
MOUNTRetention
Specifies the amount of time, in minutes, to retain an idle sequential access
volume before dismounting it. This parameter is optional. The default value is
60. You can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
DEFINE DEVCLASS REMOVABLEFILE
Chapter 2. Administrative commands 221
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DEFINE DEVCLASS REMOVABLEFILE

222 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS SERVER
Use the SERVER device class to use storage volumes or files archived in another
Tivoli Storage Manager server.
If data retention protection is activated using the SET
ARCHIVERETENTIONPROTECTION command, you cannot define a server device
class. See the Administrators Guide for more information.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name DEVType = SERVER

SERVERName

=

server_name
MAXCAPacity = 500M
MAXCAPacity

=

size

MOUNTLimit = 1
MOUNTLimit

=

number
MOUNTRetention = 60
MOUNTRetention

=

minutes

PREFIX = ADSM
PREFIX

=

ADSM

volume_prefix
RETRYPeriod = 10
RETRYPeriod

=

retry_value_(minutes)

RETRYInterval = 30
RETRYInterval

=

retry_value_(seconds)

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
DEVType=SERVER (Required)
Specifies a remote connection that supports virtual volumes.
SERVERName (Required)
Specifies the name of the server. The SERVERNAME parameter must match a
defined server.
MAXCAPacity
Specifies the maximum size for objects created on the target server; the default
for this value is 500M. This parameter is optional.
500M
Specifies that the maximum capacity is 500M (500MB).
size
Specify this value as an integer followed by K (Kilobytes), M (Megabytes),
or G (Gigabytes). The minimum value allowed is 100KB
(MAXCAPACITY=100K).
DEFINE DEVCLASS SERVER
Chapter 2. Administrative commands 223
MOUNTLimit
Specifies the maximum number of simultaneous sessions between the source
server and the target server. Any attempts to access more sessions than
indicated by the mount limit cause the requester to wait. This parameter is
optional. The default value is 1. You can specify a number from 1 to 4096.
The following are possible values:
1 Specifies that only one session between the source server and the target
server is allowed.
number
Specifies the number of simultaneous sessions between the source server
and the target server.
MOUNTRetention
Specifies the number of minutes to retain an idle connection with the target
server before closing the connection. This parameter is optional. The default
value is 60. You can specify a number from 0 to 9999.
PREFIX
Specifies the beginning portion of the high-level archive file name on the target
server. This parameter is optional. The default value is ADSM. The maximum
length of this prefix is 8 characters.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a high level archive file name using the default prefix is
ADSM.volume1.
RETRYPeriod
Specifies the retry period in minutes. The retry period is the interval during
which the server attempts to contact a target server if there is a suspected
communications failure. This parameter is optional. The default value is 10
minutes.
RETRYInterval
Specifies the retry interval in seconds. The retry interval is how often retries
are done within a given time period. This parameter is optional. The default
value is 30 seconds.
DEFINE DEVCLASS SERVER

224 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DEVCLASS VOLSAFE
Use the VOLSAFE device type to work with StorageTek VolSafe brand media and
drives. This technology uses media that cannot be overwritten. Therefore, do not
use these media for short-term backups of client files, the server database, or
export tapes.
Note:
1. NAS-attached libraries are not supported.
2. VolSafe media and read-write media must reside in separate storage
pools.
3. Check in cartridges with CHECKLABEL=YES on the CHECKIN
LIBVOLUME command.
4. Label cartridges with OVERWRITE=NO on the LABEL LIBVOLUME
command. If VolSafe cartridges are labeled more than once, no additional
data can be written to them.
See the Administrators Guide for additional information.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine DEVclass device_class_name LIBRary = library_name

DEVType

=

VOLSAFE
FORMAT = DRIVE
FORMAT

=

DRIVE

9840

9840C

ESTCAPacity

=

size

MOUNTRetention = 60
MOUNTRetention

=

minutes
PREFIX = ADSM
PREFIX

=

ADSM

volume_prefix

MOUNTWait = 60
MOUNTWait

=

minutes
MOUNTLimit = DRIVES
MOUNTLimit

=

DRIVES

number

0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the VolSafe drives
that can be used by this device class. If any drives in a library are
VolSafe-enabled, all drives in the library must be VolSafe-enabled. Consult your
hardware documentation to enable VolSafe on the 9840 drives.
DEFINE DEVCLASS VOLSAFE
Chapter 2. Administrative commands 225
For information about defining a library object, see DEFINE LIBRARY (Define
a library) on page 240.
DEVType=VOLSAFE (Required)
Specifies that the VOLSAFE device type is assigned to the device class. The
label on this type of cartridge can only be overwritten one time, which Tivoli
Storage Manager does when it writes the first block of data. Therefore, it is
important to limit the use of the LABEL LIBVOLUME command to one time
per volume by using the OVERWRITE=NO parameter.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional; the default value is DRIVE.
Attention: If you specify DRIVE for a device class that has non-compatible
sequential access devices, then you must mount volumes on devices that are
capable of reading or writing the format established when the volume was first
mounted. This can cause delays if the only sequential access device that can
access the volume is already in use.
The following table lists the recording formats and estimated capacities for
VolSafe devices:
Table 74. Recording formats and default estimated capacities for volsafe media
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
9840 20GB Uncompressed (standard) format, using a 20GB
cartridge with 270 meters (885 feet) of tape
9840C
See note
80GB
LZ-1 Enhanced (4:1) compressed format, using a
80GB cartridge with 270 meters (885 feet) of tape

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
For more information on the default estimated capacity for cartridge tapes, see
Table 74.
DEFINE DEVCLASS VOLSAFE

226 IBM Tivoli Storage Manager for Windows: Administrators Reference
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. The default value is 60. You
can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
PREFIX
Specifies the beginning portion of the high-level archive file name on the target
server. This parameter is optional. The default value is ADSM. The maximum
length of this prefix is 8 characters.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a high level archive file name using the default prefix is
ADSM.volume1.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
DEFINE DEVCLASS VOLSAFE
Chapter 2. Administrative commands 227
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DEFINE DEVCLASS VOLSAFE

228 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE DOMAIN (Define a new policy domain)
Use this command to define a new policy domain. A policy domain contains policy
sets, management classes, and copy groups. A client is assigned to one policy
domain. The ACTIVE policy set in the policy domain determines the rules for
clients assigned to the domain. The rules control the archive, backup, and space
management services provided for the clients.
You must activate a policy set in the domain before clients assigned to the policy
domain can back up, archive, or migrate files.
Privilege class
To issue this command, you must have system privilege.
Syntax
DEFine DOmain domain_name
DESCription

=

description

BACKRETention = 30
BACKRETention

=

days
ARCHRETention = 365
ARCHRETention

=

days

,

ACTIVEDESTination

=

active-data_pool_name


Parameters
domain_name (Required)
Specifies the name of the policy domain to be defined. The maximum length of
this name is 30 characters.
DESCription
Specifies a description of the policy domain. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters.
BACKRETention
Specifies the number of days (from the date the backup versions became
inactive) to retain backup versions of files that are no longer on the client file
system. This parameter is optional. You can specify an integer from 0 to 9999.
The default value is 30. The server uses the backup retention value to manage
inactive versions of files when any of the following conditions occur:
v A file is rebound to a new management class, but neither the new
management class nor the default management class contains a backup copy
group.
v The management class to which a file is bound no longer exists, and the
default management class does not contain a backup copy group.
v The backup copy group is deleted from the management class to which a
file is bound and the default management class does not contain a backup
copy group.
DEFINE DOMAIN
Chapter 2. Administrative commands 229
ARCHRETention
Specifies the number of days (from the date of archive) to retain archive copies.
This parameter is optional. You can specify an integer from 0 to 30000. The
default value is 365. The server uses the archive retention value to manage
archive copies of files when either of the following conditions occur:
v The management class to which a file is bound no longer exists, and the
default management class does not contain an archive copy group.
v The archive copy group is deleted from the management class to which a
file is bound and the default management class does not contain an archive
copy group.
ACTIVEDESTination
Specifies the names of active-data pools that store active versions of backup
data for nodes assigned to the domain. This parameter is optional. Spaces
between the names of the active-data pools are not permitted. You cannot
specify more than ten active-data pools for a domain.
Before the Tivoli Storage Manager server writes data to an active-data pool, it
verifies that the node owning the data is assigned to a domain that has the
active-data pool listed in the ACTIVEDESTINATION list. If the server verifies
that the node meets this criteria, the data is stored in the active-data pool. If
the node does not meet the criteria, then the data is not stored in the
active-data pool. If the backup is performed with simultaneous write to an
active-data pool, the server performs the verification during backup operations
by Tivoli Storage Manager backup-archive clients or by application clients
using the Tivoli Storage Manager API. The verification is also performed when
active-data is being copied using the COPY ACTIVEDATA command.
Examples
Task
Define a policy domain with a name of PROG1 and the description, Programming
Group Domain. Specify that archive copies are retained for 90 days when
management classes or archive copy groups are deleted and the default
management class does not contain an archive copy group. Also specify that
backup versions are retained for 60 days when management classes or copy groups
are deleted and the default management class does not contain a backup copy
group.
Command
define domain prog1
description="Programming Group Domain"
backretention=60 archretention=90
Related commands
Table 75. Commands related to DEFINE DOMAIN
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
COPY DOMAIN Creates a copy of a policy domain.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
DELETE DOMAIN Deletes a policy domain along with any
policy objects in the policy domain.
QUERY DOMAIN Displays information about policy domains.
DEFINE DOMAIN

230 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 75. Commands related to DEFINE DOMAIN (continued)
Command Description
UPDATE DOMAIN Changes the attributes of a policy domain.

DEFINE DOMAIN
Chapter 2. Administrative commands 231
DEFINE DRIVE (Define a drive to a library)
Use this command to define a drive. Each drive is assigned to a library, and so the
library must be defined before you issue this command.
A path must be defined after you issue the DEFINE DRIVE command in order to
make the drive usable by Tivoli Storage Manager software. For more information,
see DEFINE PATH (Define a path) on page 263.
Note:
1. You can define more than one drive for a given library by issuing the
DEFINE DRIVE command once for each drive. Stand-alone drives
always require a manual library. For additional information, see the
Administrators Guide.
2. Before you issue the DEFINE DRIVE command for a removable media
device like a Jaz, Zip, or CD-ROM drive, you must load the drive with
properly formatted and labeled media. See the information on adding
devices and managing media in the Administrators Guide.
3. The DEFINE PATH command is used to specify the device names of the
drives in the libraries. For more information on paths, see the
Administrators Guide.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax

DEFine DRive

library_name

drive_name
SERial = AUTODetect
SERial

=

AUTODetect

serial_number

ONLine

=

Yes

ONLine

=

Yes

No
(1)
ELEMent

=

AUTODetect

ELEMent

=

AUTODetect

address

(2)

ACSDRVID

=

drive_id
(3) (4)
CLEANFREQuency

=

NONE

CLEANFREQuency

=

NONE

ASNEEDED

gigabytes

Notes:
1 The ELEMENT parameter is valid only for drives in SCSI libraries. This
parameter is not effective when the command is issued from a library client
server (that is, when the library type is SHARED).
2 ACSDRVID is required for drives in ACSLS libraries. This parameter is not
valid for non-ACSLS libraries.
3 The CLEANFREQUENCY parameter is valid only for drives in SCSI libraries.
DEFINE DRIVE

232 IBM Tivoli Storage Manager for Windows: Administrators Reference
4 The CLEANFREQUENCY=ASNEEDED parameter value does not work for
all tape drives. To determine whether a drive supports this function, see the
following Web site: www.ibm.com/software/sysmgmt/products/support/
IBM_TSM_Supported_Devices_for_AIXHPSUNWIN.html. At this Web site,
click the drive to view detailed information. If ASNEEDED is not supported,
you can use the gigabytes value for automatic cleaning.
Parameters
library_name (Required)
Specifies the name of the library to which the drive is assigned. This parameter
is required for all drives, including stand-alone drives. The specified library
must have been previously defined by using the DEFINE LIBRARY command.
drive_name (Required)
Specifies the name that is assigned to the drive. The maximum length of this
name is 30 characters.
SERial
Specifies the serial number for the drive being defined. This parameter is
optional. The default is AUTODETECT.
If SERIAL=AUTODETECT, then the serial number reported by the drive when
you define the path will be used as the serial number.
If SERIAL=serial_number, then the serial number entered will be used to verify
that the path to the drive is correct when you define the path.
Note: Depending on the capabilities of the device, SERIAL=AUTODETECT
may not be supported. In this case, the serial number will be reported as
blank.
ONLine
Specifies whether the drive is available for use. This parameter is optional. The
default is YES.
Yes
Specifies that the drive is available for use.
No
Specifies that the drive is not available for use.
ELEMent
Specifies the element address of the drive within a SCSI library. The server
uses the element address to connect the physical location of the drive to the
SCSI address of the drive. The default is AUTODETECT.
If ELEMENT=AUTODETECT, then the element number will automatically be
detected by Tivoli Storage Manager when the path to the drive is defined.
To find the element address for your library configuration, consult the
manufacturers information.
Additional information on element addresses can be found at the IBM Tivoli
Storage Manager Web site: http://www.ibm.com/software/sysmgmt/
products/support/IBMTivoliStorageManager.html. Follow the links to device
information. Select the appropriate product and platform, then scroll to the
required device. Click on a specific device to see element addresses.
Note:
DEFINE DRIVE
Chapter 2. Administrative commands 233
|
|
|
|
|
|
1. The ELEMENT parameter is valid only for drives in SCSI libraries.
This parameter is not effective when the command is issued from a
library client server (that is, when the library type is SHARED).
2. Depending on the capabilities of the library,
ELEMENT=AUTODETECT may not be supported. In this case you
will have to supply the element address.
ACSDRVID
Specifies the ID of the drive that is being accessed in an ACSLS library. The
drive ID is a set of numbers that indicates the physical location of a drive
within an ACSLS library. This drive ID must be specified as a,l,p,d, where a is
the ACSID, l is the LSM (library storage module), p is the panel number, and d
is the drive ID. The server needs the drive ID to connect the physical location
of the drive to the drives SCSI address. See the StorageTek documentation for
details.
CLEANFREQuency
Specifies how often the server activates drive cleaning. This parameter is
optional. The default is NONE. For the most complete automation of cleaning
for an automated library, you must have a cleaner cartridge checked into the
librarys volume inventory. This parameter is not valid for externally managed
libraries, such as 3494 libraries or StorageTek libraries managed under ACSLS.
For details on using this parameter for automated and manual libraries, see the
Administrators Guide.
Note: There are special considerations if you plan to use server-activated drive
cleaning with a SCSI library that provides automatic drive cleaning
support in its device hardware. See the Administrators Guide for details.
NONE
Specifies that the server does not track cleaning for this drive. This value
can be used for libraries that have their own automatic cleaning.
ASNEEDED
Specifies that the server loads the drive with a checked-in cleaner cartridge
only when a drive reports to the device driver that it needs cleaning.
Note: Tivoli Storage Manager does not control the drives connected to the
NAS file server. If a drive is attached only to a NAS file server (no
connection to a storage agent or server), do not specify ASNEEDED
for the cleaning frequency.
gigabytes
Specifies, in gigabytes, how much data is processed on the drive before the
server loads the drive with a cleaner cartridge. The server resets the
gigabytes-processed counter each time it loads a cleaner cartridge in the
drive.
Consult the drive manufacturers information for cleaning
recommendations. If the information gives recommendations for cleaning
frequency in terms of hours of use, convert to a gigabytes value by doing
the following:
1. Use the bytes-per-second rating for the drive to determine a
gigabytes-per-hour value.
2. Multiply the gigabytes-per-hour value by the recommended hours of
use between cleanings.
3. Use the result as the cleaning frequency value.
DEFINE DRIVE

234 IBM Tivoli Storage Manager for Windows: Administrators Reference
Note: For IBM 3590 and IBM 3570, we recommend that you specify a
gigabyte value for the cleaning frequency to ensure that the drives
receive adequate cleaning. Consult the drive manufacturers
information for cleaning recommendations. Using the cleaning
frequency recommended by IBM will not overclean the drives.
Examples
Note: The following DEFINE DRIVE definitions are followed by their
corresponding DEFINE PATH definitions. The device parameter is no longer
used in the DEFINE DRIVE definition, but is now included in the DEFINE
PATH definition.
Task
Define a drive in a manual library with a library name of LIB01 and a drive name
of DRIVE01.
Command
define drive lib01 drive01
define path server01 drive01 srctype=server desttype=drive
library=lib01 device=mt3.0.0.0
Task
Define a drive in an ACSLS library with a library name of ACSLIB and a drive
name of ACSDRV1.
Command
define drive acslib acsdrv1 acsdrvid=1,2,3,4
define path server01 acsdrv1 srctype=server desttype=drive
library=acslib device=mt3.0.0.0
Task
Define a drive in an automated library with a library name of AUTO8MMLIB and
a drive name of DRIVE01.
Command
define drive auto8mmlib drive01 element=82
define path server01 drive01 srctype=server desttype=drive
library=auto8mmlib device=mt3.0.0.0
Related commands
Table 76. Commands related to DEFINE DRIVE
Command Description
DEFINE LIBRARY Defines an automated or manual library.
DEFINE PATH Defines a path from a source to a destination.
DELETE DRIVE Deletes a drive from a library.
DELETE LIBRARY Deletes a library.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more
libraries.
DEFINE DRIVE
Chapter 2. Administrative commands 235
Table 76. Commands related to DEFINE DRIVE (continued)
Command Description
QUERY PATH Displays information about the path from a
source to a destination.
UPDATE DRIVE Changes the attributes of a drive.
UPDATE PATH Changes the attributes associated with a
path.

DEFINE DRIVE

236 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE EVENTSERVER (Define a server as the event server)
Use this command to identify a server as the event server.
If you define an event server, one Tivoli Storage Manager server can send events to
another Tivoli Storage Manager server that will log those events. See the
Administrators Guide for information about setting up logging events to an event
server.
Privilege class
To issue this command, you must have system privilege.
Syntax
DEFine EVENTSERVer server_name

Parameters
server_name (Required)
Specifies the name of the event server. The server you specify must have
already been defined with the DEFINE SERVER command.
Examples
Task
Designate ASTRO to be the event server.
Command
define eventserver astro
Related commands
Table 77. Commands related to DEFINE EVENTSERVER
Command Description
DEFINE SERVER Defines a server for server-to-server
communications.
DELETE EVENTSERVER Deletes reference to the event server.
DISABLE EVENTS Disables specific events for receivers.
ENABLE EVENTS Enables specific events for receivers.
PING SERVER Test the connections between servers.
QUERY EVENTSERVER Displays the name of the event server.
QUERY SERVER Displays information about servers.

DEFINE EVENTSERVER
Chapter 2. Administrative commands 237
DEFINE GRPMEMBER (Add a server to a server group)
Use this command to add a server as a member of a server group. You can also
add one server group to another server group. A server group lets you route
commands to multiple servers by specifying only the server group name.
Privilege class
To issue this command, you must have system privilege.
Syntax

DEFine GRPMEMber

group_name

,
member_name

Parameters
group_name (Required)
Specifies the name of the server group to which the member will be added.
member_name (Required)
Specifies the names of the servers or groups to be added to the group. To
specify multiple servers and groups, separate the names with commas and no
intervening spaces. The servers or server groups must already be defined to
the server.
Examples
Task 1
Define the server SANJOSE to server group CALIFORNIA.
Command
define grpmember california sanjose
Task 2
Define the server TUCSON and the server group CALIFORNIA to server group
WEST_COMPLEX.
Command
define grpmember west_complex tucson,california
Related commands
Table 78. Commands related to DEFINE GRPMEMBER
Command Description
DEFINE SERVER Defines a server for server-to-server
communications.
DEFINE SERVERGROUP Defines a new server group.
DELETE GRPMEMBER Deletes a server from a server group.
DELETE SERVERGROUP Deletes a server group.
MOVE GRPMEMBER Moves a server group member.
QUERY SERVER Displays information about servers.
DEFINE GRPMEMBER

238 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 78. Commands related to DEFINE GRPMEMBER (continued)
Command Description
RENAME SERVERGROUP Renames a server group.
UPDATE SERVERGROUP Updates a server group.

DEFINE GRPMEMBER
Chapter 2. Administrative commands 239
DEFINE LIBRARY (Define a library)
Use this command to define a library. A library is a collection of one or more
drives, and possibly robotic devices (depending on the library type), which can be
used to access storage volumes.
A library can only be accessed by one source. This can be either an IBM Tivoli
Storage Manager server or a data mover. However, the drives in a library can be
accessed by multiple sources.
This section includes syntax diagrams for a number of different library
configurations:

Configuration Task Syntax Diagram
LAN -- Define a library (MANUAL, SCSI,
349X, EXTERNAL, ACSLS, RSM).
Syntax for a library in a LAN, not used for
NDMP operations
SAN -- Define a library ( SCSI, 349X, FILE,
ACSLS) to a library manager server.
Syntax for a library in a SAN, not used for
NDMP operations on page 242 (SAN --
Define a library to a library manager)
SAN -- Define a library (SHARED) to a
library client server.
Syntax for a library in a SAN, not used for
NDMP operations on page 242 (SAN --
Define a library to a library client)
SAN or LAN -- Define a SCSI library that
will be accessed by a NAS data mover and
directly controlled by Tivoli Storage
Manager.
Syntax for a library in a LAN or a SAN,
used for NDMP operations on page 243
(Define a library controlled directly by Tivoli
Storage Manager)
SAN or LAN -- Define a SCSI library to be
accessed by NAS data mover and controlled
through a NAS file server.
Syntax for a library in a LAN or a SAN,
used for NDMP operations on page 243
(Define a library controlled through a NAS
file server)
SAN -- Define an EXTERNAL library. Syntax for an EXTERNAL library shared
with storage agents on page 243

Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax for a library in a LAN, not used for NDMP operations

DEFine LIBRary

library_name
LIBType = MANUAL
LIBType

=

MANUAL

SCSI

A

349X

B

EXTernal

ACSLS

C

RSM

D

RESETDrives = Yes (1)

RESETDrives

=

Yes

No
AUTOLabel = Yes (2)
AUTOLabel

=

No

Yes

OVERWRITE

DEFINE LIBRARY

240 IBM Tivoli Storage Manager for Windows: Administrators Reference
A (SCSI):
AUTOLabel = No
AUTOLabel

=

No

Yes

OVERWRITE


B (349X):
SCRATCHCATegory = 301
SCRATCHCATegory

=

number
PRIVATECATegory = 300
PRIVATECATegory

=

number

WORMSCRatchcategory

=

number


C (ACSLS):
ACSID = number

D (RSM):
MEDIAType = media_type

Notes:
1 RESETDRIVES defaults to YES only when a library is defined with
SHARED=YES; otherwise, the parameter defaults to NO.
2 AUTOLABEL defaults to YES for all non-SCSI libraries and to NO for SCSI
libraries.
DEFINE LIBRARY
Chapter 2. Administrative commands 241
Syntax for a library in a SAN, not used for NDMP operations

SAN -- define a library to a library manager
DEFine LIBRary library_name LIBType = 349X A
SCSI

B

FILE

ACSLS

C

SHAREd = No
SHAREd

=

Yes

No
RESETDrives = Yes (1)
RESETDrives

=

Yes

No

AUTOLabel = Yes (2)

AUTOLabel

=

No

Yes

OVERWRITE

A (349X):
SCRATCHCATegory = 301
SCRATCHCATegory

=

number
PRIVATECATegory = 300
PRIVATECATegory

=

number

WORMSCRatchcategory

=

number


B (SCSI):
SERial = AUTODetect
SERial

=

AUTODetect

serial_number
AUTOLabel = No
AUTOLabel

=

No

Yes

OVERWRITE


C (ACSLS):
ACSID = number

Notes:
1 RESETDRIVES defaults to Yes only when a library is defined with
SHARED=YES; otherwise, the parameter defaults to No.
2 AUTOLABEL defaults to YES for all non-SCSI libraries and to NO for SCSI
libraries.
DEFINE LIBRARY

242 IBM Tivoli Storage Manager for Windows: Administrators Reference
SAN -- define a library to a library client
DEFine LIBRary library_name
LIBType = SHAREd PRIMarylibmanager = server_name


Syntax for a library in a LAN or a SAN, used for NDMP
operations

Define a library controlled directly by Tivoli Storage Manager
DEFine LIBRary library_name LIBType = SCSI A
ACSLS

349X

SHAREd = No
SHAREd

=

No

Yes
AUTOLabel = Yes (1)
AUTOLabel

=

No

Yes

OVERWRITE

A (SCSI):
AUTOLabel = No
AUTOLabel

=

No

Yes

OVERWRITE
RESETDrives = Yes (2)
RESETDrives

=

Yes

No


Notes:
1 AUTOLABEL defaults to YES for all non-SCSI libraries and to NO for SCSI
libraries.
2 RESETDRIVES defaults to YES only when a library is defined with
SHARED=YES; otherwise, the parameter defaults to No.

SAN -- define a library controlled through a NAS file server
DEFine LIBRary library_name LIBType = SCSI SHAREd = No


Syntax for an EXTERNAL library shared with storage agents
DEFine LIBRary library_name LIBType = EXTernal

DEFINE LIBRARY
Chapter 2. Administrative commands 243
Parameters
library_name (Required)
Specifies the name of the library to be defined. The maximum length of this
name is 30 characters.
LIBType
Specifies the type of library that is being defined. The default is MANUAL.
Possible values are:
MANUAL
Specifies that the library is not automated. When volumes must be
mounted on drives in this type of library, messages are sent to operators.
This type of library is used with stand-alone drives.
FILE
Specifies that a pseudo-library is created for sequential file volumes. When
you issue the DEFINE DEVCLASS command with DEVTYPE=FILE and
SHARED=YES parameters, this occurs automatically. FILE libraries are
necessary only when sharing sequential file volumes between the server
and one or more storage agents. The use of FILE libraries requires library
sharing.
SCSI
Specifies that the library has a SCSI-controlled media changer device. To
mount volumes on drives in this type of library, Tivoli Storage Manager
uses the media changer device.
349X
Specifies that the library is an IBM 3494 Tape Library Dataserver.
For more information about specifying category numbers for scratch,
private, and WORM volumes, see the Administrators Guide.
Note:
1. 3494 libraries support only one unique device type at a time.
2. 3494 libraries are supported on Windows Server 2003.
SHAREd
Specifies that the library is shared with another Tivoli Storage Manager
server over a storage area network (SAN) or a dual SCSI connection to
library drives. This library type is not valid for optical devices.
Note: Specify this library type when defining the library on the library
client.
EXTernal
Specifies that the library is managed by an external media management
system. This library type does not support drive definitions via the
DEFINE DRIVE command. Rather, the external media management system
identifies the appropriate drive for media access operations.
In an IBM Tivoli Storage Manager for Storage Area Networks environment,
this parameter specifies that StorageTek Automated Cartridge System
Library Software (ACSLS) or Library Station software controls the library.
The third-party software such as Gresham EDT-DistribuTAPE allows
multiple servers to share the library. The drives in this library are not
defined to Tivoli Storage Manager. ACSLS identifies the drive for media
operations.
DEFINE LIBRARY

244 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
ACSLS
Specifies that the library is a StorageTek library that is controlled by
StorageTek Automated Cartridge System Library Software (ACSLS).
Note:
1. ACSLS libraries are supported on 32bit versions of Windows
Server 2003.
2. Do not specify a library type of ACSLS for the IBM Tivoli
Storage Manager for Storage Area Networks environment.
Specify EXTERNAL.
RSM
Specifies that the library is integrated with Windows Removable Storage
Management (RSM). This library type allows Tivoli Storage Manager to
share libraries with other applications that use RSM.
When the first RSM library is defined, it contains no media or media type,
but it is a holding library for removable media pools. The corresponding
media pool is named Tivoli Storage Manager\library_name. This library can
be associated with the LTO or GENERICTAPE device types. Do not define
an LTO drive to a library associated with a device class whose device type
is GENERICTAPE.
Use the Removable Storage Manager snap-in to view the contents of the
RSM database and included media pools.
You can create more than one RSM library type if each library_name is
unique.
You can delete RSM libraries, but you cannot update them.
SERial
Specifies the serial number for the library being defined. This parameter is
optional. The default is AUTODETECT.
If SERIAL=AUTODETECT, then when you define the path to the library, the
serial number reported by the library will be used as the serial number.
If SERIAL=serial_number, then the number you have entered will be compared
to the number detected by Tivoli Storage Manager.
Note: Depending on the capabilities of the device, SERIAL=AUTODETECT
may not be supported. In this case, the serial number will be reported as
blank.
ACSID
Specifies the ID of the drive that is being accessed in an ACSLS library. The
drive ID is a set of numbers that indicates the physical location of a drive
within an ACSLS library. This drive ID must be specified as a,l,p,d, where a is
the ACSID, l is the LSM (library storage module), p is the panel number, and d
is the drive ID. The server needs the drive ID to connect the physical location
of the drive to the drives SCSI address. See the StorageTek documentation for
details.
AUTOLabel
Specifies whether the server attempts to automatically label tape volumes. This
parameter is optional. The default for 349X, ACSLS, External and Manual
libraries is Yes. The default for SCSI libraries is No.
To use this option, you need to check in the tapes with
CHECKLABEL=BARCODE on the CHECKIN LIBVOLUME command.
DEFINE LIBRARY
Chapter 2. Administrative commands 245
|
|
No
Specifies that the server does not attempt to label any volumes.
Yes
Specifies that the server only labels unlabeled volumes.
OVERWRITE
Specifies that the server attempts to overwrite an existing label. The server
overwrites existing labels only if both the existing label and the bar code
label are not already defined in any server storage pool or volume history
list.
ACSID
Specifies the number of this StorageTek library assigned by the ACSSA
(Automatic Cartridge System System Administrator). This can be a number
from 0 to 126. Issue QUERY ACS on your system to get the number for your
library ID. This parameter is required and valid only when LIBTYPE=ACSLS.
See your StorageTek documentation for more information.
MEDIAType
Specifies the media type. The Windows Removable Storage Manager snap-in
displays this information under media pools. You must use quotation marks
() around these media types because of embedded spaces. For example,
4mm DDS is a valid media type for tape.
This parameter is required and valid only when LIBTYPE=RSM.
PRIMarylibmanager
Specifies the name of the Tivoli Storage Manager server that is responsible for
controlling access to library resources. You must define this server with the
DEFINE SERVER command before you can use it as a library manager. This
parameter is required and valid only if LIBTYPE=SHARED (that is, when you
define a library in a SAN to a library client server).
PRIVATECATegory
Specifies the category number for private volumes that must be mounted by
name. This parameter is optional. The default value is 300 (becomes X12C on
the IBM 3494 since it uses hexadecimal values). You can specify a number from
1 to 65279. This number must be unique. It cannot be shared with other
applications or defined libraries, and it must be different than the other
category numbers in this library. This parameter is valid only when
LIBTYPE=349X.
SCRATCHCATegory
Specifies the category number to be used for scratch volumes in the library.
This parameter is optional. The default value is 301 (becomes X12D on the
IBM 3494 since it uses hexadecimal values). You can specify a number from 1
to 65279. This number must be unique. It cannot be shared with other
applications or defined libraries, and it must be different than the other
category numbers in this library. This parameter is valid only when
LIBTYPE=349X.
WORMSCRatchcategory
Specifies the category number to be used for WORM scratch volumes in the
library. This parameter is required if you use WORM volumes. You can specify
a number from 1 to 65279. This number must be unique. It cannot be shared
with other applications or defined libraries, and it must be different than the
other category numbers in this library. This parameter is only valid when
LIBTYPE=349X and 3592 WORM volumes are used.
DEFINE LIBRARY

246 IBM Tivoli Storage Manager for Windows: Administrators Reference
Note: If a 349X library does not have the WORMSCRATCHCATEGORY
defined and the WORM parameter is set to YES for the device class, the
mount operation will fail with an error message.
SHAREd
Specifies whether this library is shared with other Tivoli Storage Manager
servers in a storage area network (SAN). This parameter is required when you
define a library to the library manager. This parameter is valid only when you
define a SCSI, 349X, or ACSLS library.
YES
Specifies that this library can be shared with other servers. When you
specify YES, the library manager server mounts volumes as requested by
other servers and tracks drive and volume allocation to other servers.
NO
Specifies that this library cannot be shared with other servers.
SHARED=NO is required if the library is controlled by passing commands
through a NAS file server.
RESETDrives
Specifies whether the server performs a target reset when the server is
restarted or when a library client or storage agent re-connection is established.
This parameter only applies to SCSI, 3494, Manual and ACSLS type libraries.
Yes
Specifies that the target reset is to be performed. Yes is the default for
SCSI, 3494, Manual, and ACSLS libraries defined with SHARED=YES.
No
Specifies that the target reset is not performed. No is the default for SCSI,
3494, Manual, and ACSLS libraries defined with SHARED=NO.
Examples
Task - MANUAL Library
Define a library named MANUALMOUNT with the library type of MANUAL.
Command
define library manualmount libtype=manual
Task - SCSI Library in a LAN
Define a library named SCSILIB with a library type of SCSI and a device name of
lb3.0.0.0.
Commands
define library scsilib libtype=scsi
define path server1 scsilib srctype=server desttype=library
device=lb3.0.0.0
Task - SCSI Library in a SAN
In a storage area network, two Tivoli Storage Manager servers must share a SCSI
library. Define a SCSI library named LTOLIB on a library manager server named
CASTOR. The device name of the library is lb3.0.0.0. Then define the same library
on a library client server named POLLUX.
DEFINE LIBRARY
Chapter 2. Administrative commands 247
Commands
On the library manager, CASTOR:
define library ltolib libtype=scsi shared=yes
define path castor ltolib srctype=server desttype=library
device=lb3.0.0.0
On the library client, POLLUX:
define library ltolib libtype=shared primarylibmanager=castor
Task - ACSLS Library in a SAN
Define a library named ACSLIB with a library type of ACSLS and an ACSID of 1.
Commands
define library acslib libtype=acsls acsid=1 shared=yes
Task - RSM Library
Define a library named RSMLIB with a library type of RSM. The media type for
the library is LTO Ultrium.
Command
define library rsmlib libtype=rsm mediatype="LTO Ultrium"
Task - SCSI Libraries Used for NDMP Operations
A SCSI library named TSMLIB is connected to a Tivoli Storage Manager server.
Define that library so that it will be directly controlled by Tivoli Storage Manager
and used for NDMP operations.
Commands
define library tsmlib libtype=scsi
define path server1 tsmlib srctype=server desttype=library
device=lb3.0.0.0
Task - ACSLS Libraries Used for NDMP Operations
An ACSLS library named STKLIB is connected to a Tivoli Storage Manager server.
Define that library so that it will be directly controlled by Tivoli Storage Manager
and used for NDMP operations.
Commands
define library STKLIB libtype=acsls acsid=4
Task - SCSI library controlled through a NAS Datamover
A SCSI library named NASLIB is connected directly to a NAS file server. Define
that library so that it will be controlled by Tivoli Storage Manager through the
NAS data mover (named NASDM) and used for NDMP operations.
Commands
define library naslib libtype=scsi
define path nasdm naslib srctype=datamover desttype=library
device=mc1
Task - EXTERNAL Library in an IBM Tivoli Storage Manager for Storage Area
Networks configuration
DEFINE LIBRARY

248 IBM Tivoli Storage Manager for Windows: Administrators Reference
For an IBM Tivoli Storage Manager for Storage Area Networks configuration,
define a library named EXTLIB with the library type of EXTERNAL. If using
Gresham Enterprise DistribuTAPE, the external library manager executable is
located in the c:\program files\GES\EDT\bin\elm.exe directory.
Commands
define library extlib libtype=external
define path server1 extlib srctype=server desttype=library
externalmanager="c:\program files\GES\EDT\bin\elm.exe"
Related commands
Table 79. Commands related to DEFINE LIBRARY
Command Description
AUDIT LIBRARY Ensures that an automated library is in a
consistent state.
DEFINE DRIVE Assigns a drive to a library.
DEFINE PATH Defines a path from a source to a destination.
DEFINE SERVER Defines a server for server-to-server
communications.
DELETE DRIVE Deletes a drive from a library.
DELETE PATH Deletes a path from a source to a destination.
DELETE LIBRARY Deletes a library.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more
libraries.
QUERY PATH Displays information about the path from a
source to a destination.
UPDATE DRIVE Changes the attributes of a drive.
UPDATE LIBRARY Changes the attributes of a library.
UPDATE PATH Changes the attributes associated with a
path.

DEFINE LIBRARY
Chapter 2. Administrative commands 249
DEFINE LOGCOPY (Define a volume copy of a recovery log
volume)
Use this command to create a copy (mirrored volume) of a recovery log volume.
Mirroring the recovery log increases the recovery log availability and provides a
safeguard against media failure. You can have as many as two copies of a recovery
log volume. After each recovery log volume copy is defined, the server attempts to
synchronize the volume copy with the recovery log.
All recovery log volumes reside on random access devices. Volume copies must
have at least the same capacity as the original volume and should be defined on
separate physical devices. Any additional space on the volume copy is not used.
This command generates a background process that you can cancel with the
CANCEL PROCESS command. If a DEFINE LOGCOPY process is canceled, the
volume copy is created. However, synchronization processing is canceled leaving
the volume in a stale state. To display information on background processes, use
the QUERY PROCESS command.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine LOGCopy volume_name copy_volume_name

Wait

=

No

Formatsize

=

megabytes

Wait

=

No

Yes


Parameters
volume_name (Required)
Specifies the name of the recovery log to be mirrored.
copy_volume_name (Required)
Specifies the file name of the volume copy. Enter the name as either a fully
qualified path name or a name relative to the servers current working
directory. Enclose the name in quotation marks if it contains embedded blanks,
equal signs, or other special characters. For example, if the file name is
log2.dsm, enter the path name as:
"c:\program files\tivoli\tsm\server\log2.dsm"
Formatsize
Specifies the size of the volume that is defined and formatted in one operation.
This parameter is optional. The value is specified in megabytes.
Wait
Specifies whether a volume creation and formatting operation is performed in
the foreground or background. This parameter is optional. The default is NO.
It is ignored unless the FORMATSIZE parameter is also specified.
DEFINE LOGCOPY

250 IBM Tivoli Storage Manager for Windows: Administrators Reference
No
Specifies that a volume creation and formatting operation is performed in
the background.
Yes
Specifies that a volume creation and formatting operation is performed in
the foreground.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Format a new log copy volume of 20 MB in the server directory with a name of
log3.dsm and wait for the server to define the volume.
Command
define logcopy log1.dsm log3.dsm formatsize=20 wait=yes
Task
Create a recovery log volume copy named log2.dsm for the recovery log volume
named log1.dsm.
Command
define logcopy log1.dsm log2.dsm
Related commands
Table 80. Commands related to DEFINE LOGCOPY
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE LOGVOLUME Defines a disk volume to the recovery log.
DELETE LOGVOLUME Deletes a volume from the recovery log.
QUERY LOGVOLUME Displays information about log volumes.
QUERY PROCESS Displays information about background
processes.

DEFINE LOGCOPY
Chapter 2. Administrative commands 251
DEFINE LOGVOLUME (Define a recovery log volume)
Use this command to define a new recovery log volume. All recovery log volumes
must reside on random access media.
You can have Tivoli Storage Manager create the volume before it is assigned.
Attention: Do not change the size of a recovery log volume after you have
defined it to Tivoli Storage Manager. If you change the size, Tivoli Storage
Manager might not initialize correctly and you might lose data.
A recovery log volume must be at least 9MB. Storage space is used in 4MB blocks
and 1MB is used for overhead purposes. For example, if you define a 9MB
recovery log volume, 8MB are available for storage.
Note: The maximum size of the recovery log is 13GB. Increasing the size of your
recovery log significantly could also significantly increase the time required
to restart the server, back up the database, and restore the database.
For more information about disk subsystem requirements, see the Administrators
Guide.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine LOGVolume volume_name
Formatsize

=

megabytes

Wait = No
Wait

=

No

Yes

Parameters
volume_name (Required)
Enter this name as either a fully qualified path name or a name relative to the
servers current working directory. Enclose the name in quotation marks if it
contains embedded blanks, equal signs, or other special characters. For
example, if the file name is log1.dsm, enter the path name as:
"c:\program files\tivoli\tsm\server\log1.dsm"
Formatsize
Specifies the size of the volume that is defined and formatted in one operation.
This parameter is optional. The value is specified in megabytes.
Wait
Specifies whether a volume creation and formatting operation is performed in
the foreground or background. This parameter is optional. The default is NO.
It is ignored unless the FORMATSIZE parameter is also specified.
DEFINE LOGVOLUME

252 IBM Tivoli Storage Manager for Windows: Administrators Reference
No
Specifies that a volume creation and formatting operation is performed in
the background.
Yes
Specifies that a volume creation and formatting operation is performed in
the foreground.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Define a recovery log volume log2.dsm.
Command
define logvolume log2.dsm
Task
Format a new log volume of 20MB in the server directory with a name of log3.dsm
and wait for the server to define the volume.
Command
define logvolume log3.dsm formatsize=20 wait=yes
Related commands
Table 81. Commands related to DEFINE LOGVOLUME
Command Description
DEFINE LOGCOPY Creates a volume copy of a recovery log
volume.
DEFINE SPACETRIGGER Defines the database or recovery log space
trigger.
DELETE LOGVOLUME Deletes a volume from the recovery log.
EXTEND LOG Extends usable log storage within the
volumes previously allocated for its use.
QUERY LOG Displays allocation information about the
recovery log.
QUERY LOGVOLUME Displays information about log volumes.
UPDATE SPACETRIGGER Changes attributes of the database or
recovery log space trigger.

DEFINE LOGVOLUME
Chapter 2. Administrative commands 253
DEFINE MACHINE (Define machine information)
Use this command to save disaster recovery information for a server or client node
machine. This information will be included in the plan file to help you recover
your machines.
Privilege class
To issue this command, you must have system privilege.
Syntax
DEFine MACHine machine_name
DESCription

=

description

BUilding

=

building

FLoor

=

floor

ROom

=

room

PRIority = 50
PRIority

=

number
ADSMServer = No
ADSMServer

=

No

Yes

Parameters
machine_name (Required)
Specifies the machine name. The name can be up to 64 characters.
DESCription
Specifies a machine description. This parameter is optional. The text can be up
to 255 characters. Enclose the text in quotation marks if it contains any blank
characters.
BUilding
Specifies the building that this machine is in. This parameter is optional. The
text can be up to 16 characters. Enclose the text in quotation marks if it
contains any blank characters.
FLoor
Specifies the floor that this machine is on. This parameter is optional. The text
can be up to 16 characters. Enclose the text in quotation marks if it contains
any blank characters.
ROom
Specifies the room that this machine is in. This parameter is optional. The text
can be up to 16 characters. Enclose the text in quotation marks if it contains
any blank characters.
PRIority
Specifies the restore priority for the machine an integer from 1 to 99. The
highest priority is 1. This parameter is optional. The default is 50.
ADSMServer
Specifies whether the machine is a Tivoli Storage Manager server. Only one
machine can be defined as a Tivoli Storage Manager server. This parameter is
optional. The default is NO. Possible values are:
DEFINE MACHINE

254 IBM Tivoli Storage Manager for Windows: Administrators Reference
No
This machine is not a Tivoli Storage Manager server.
Yes
This machine is a Tivoli Storage Manager server.
Examples
Task
Define a machine named DISTRICT5, and specify a location, a floor, and a room
name. This machine contains critical data and has the highest priority.
Command
define machine district5 building=101 floor=27
room=datafacilities priority=1
Related commands
Table 82. Commands related to DEFINE MACHINE
Command Description
DEFINE MACHNODEASSOCIATION Associates an IBM Tivoli Storage Manager
node with a machine.
DEFINE RECMEDMACHASSOCIATION Associates recovery media with a machine.
DELETE MACHINE Deletes a machine.
INSERT MACHINE Inserts machine characteristics or recovery
instructions into the IBM Tivoli Storage
Manager database.
QUERY MACHINE Displays information about machines.
UPDATE MACHINE Changes the information for a machine.

DEFINE MACHINE
Chapter 2. Administrative commands 255
DEFINE MACHNODEASSOCIATION (Associate a node with a
machine)
Use this command to associate client nodes with a machine. During disaster
recovery, you can use this information to identify the client nodes that resided on
destroyed machines.
The machine must be defined and the nodes registered to Tivoli Storage Manager.
To retrieve the information, issue the QUERY MACHINE command. This
information will be included in the plan file to help you recover the client
machines.
A node remains associated with a machine unless the node, the machine, or the
association itself is deleted.
Privilege class
To issue this command, you must have system privilege.
Syntax

DEFine MACHNODEAssociation

machine_name

,
node_name

Parameters
machine_name (Required)
Specifies the machine name.
node_name (Required)
Specifies the node names. A node can only be associated with one machine. To
specify multiple nodes, separate the names with commas and no intervening
spaces. You can use wildcard characters to specify a name.
Examples
Task
Associate the node named ACCOUNTSPAYABLE with the machine named
DISTRICT5.
Command
define machnodeassociation district5 accountspayable
Related commands
Table 83. Commands related to DEFINE MACHNODEASSOCIATION
Command Description
DEFINE MACHINE Defines a machine for DRM.
DELETE MACHINE Deletes a machine.
DELETE MACHNODEASSOCIATION Deletes association between a machine and
node.
QUERY MACHINE Displays information about machines.
DEFINE MACHNODEASSOCIATION

256 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 83. Commands related to DEFINE MACHNODEASSOCIATION (continued)
Command Description
REGISTER NODE Defines a client to the server and sets options
for that user.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.

DEFINE MACHNODEASSOCIATION
Chapter 2. Administrative commands 257
DEFINE MGMTCLASS (Define a management class)
Use this command to define a new management class in a policy set. To allow
clients to use the new management class, you must activate the policy set that
contains the new class.
You can define one or more management classes for each policy set in a policy
domain. A management class can contain a backup copy group, an archive copy
group, or both. The user of a client node can select any management class in the
active policy set or use the default management class.
Note: The DEFINE MGMTCLASS command fails if a copy storage pool is
specified as the destination for space-managed files.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the
management class belongs.
Syntax
DEFine MGmtclass domain_name policy_set_name class_name

SPACEMGTECHnique = NONE
SPACEMGTECHnique

=

AUTOmatic

SELective

NONE
AUTOMIGNOnuse = 0
AUTOMIGNOnuse

=

days

MIGREQUIRESBkup = Yes
MIGREQUIRESBkup

=

Yes

No
MIGDESTination = SPACEMGPOOL
MIGDESTination

=

pool_name

DESCription

=

description


Parameters
domain_name (Required)
Specifies the policy domain to which the management class belongs.
policy_set_name (Required)
Specifies the policy set to which the management class belongs. You cannot
define a management class to the ACTIVE policy set.
class_name (Required)
Specifies the name of the new management class. The maximum length of this
name is 30 characters. You cannot use either default or grace_period as a class
name.
SPACEMGTECHnique
Specifies whether a file using this management class is eligible for migration.
This parameter is optional. The default is NONE. This parameter is effective
DEFINE MGMTCLASS

258 IBM Tivoli Storage Manager for Windows: Administrators Reference
||||||
only for Tivoli Storage Manager for Space Management clients (also known as
HSM clients), not for backup-archive clients or application clients. Possible
values are:
AUTOmatic
Specifies that the file is eligible for both automatic migration and selective
migration.
SELective
Specifies that the file is eligible for selective migration only.
NONE
Specifies that the file is not eligible for migration.
AUTOMIGNOnuse
Specifies the number of days that must elapse since a file was last accessed
before it is eligible for automatic migration. This parameter is optional. The
default value is 0. If SPACEMGTECHNIQUE is not AUTOMATIC, the server
ignores this attribute. You can specify an integer from 0 to 9999.
This parameter is effective only for HSM clients, not for backup-archive clients
or application clients.
MIGREQUIRESBkup
Specifies whether a backup version of a file must exist before a file can be
migrated. This parameter is optional. The default is YES. This parameter is
effective only for HSM clients, not for backup-archive clients or application
clients. Possible values are:
Yes
Specifies that a backup version must exist.
No
Specifies that a backup version is optional.
MIGDESTination
Specifies the primary storage pool where the server initially stores files
migrated from HSM clients. This parameter is effective only for HSM clients,
not for backup-archive clients or application clients. The default is
SPACEMGPOOL.
The command fails if you specify a copy storage pool as the destination.
DESCription
Specifies a description of the management class. This parameter is optional.
The maximum length of the description is 255 characters. Enclose the
description in quotation marks if it contains any blank characters.
Examples
Task
Define a management class called MCLASS1 for policy set SUMMER in the PROG1
policy domain. For HSM clients, allow both automatic and selective migration, and
store migrated files in the SMPOOL storage pool. Add the description, Technical
Support Mgmt Class.
Command
define mgmtclass prog1 summer mclass1
spacemgtechnique=automatic migdestination=smpool
description="technical support mgmt class"
DEFINE MGMTCLASS
Chapter 2. Administrative commands 259
|
|
|
|
|
Related commands
Table 84. Commands related to DEFINE MGMTCLASS
Command Description
ASSIGN DEFMGMTCLASS Assigns a management class as the default
for a specified policy set.
COPY MGMTCLASS Creates a copy of a management class.
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
DELETE MGMTCLASS Deletes a management class and its copy
groups from a policy domain and policy set.
QUERY COPYGROUP Displays the attributes of a copy group.
QUERY MGMTCLASS Displays information about management
classes.
QUERY POLICYSET Displays information about policy sets.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.
UPDATE MGMTCLASS Changes the attributes of a management
class.

DEFINE MGMTCLASS

260 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE NODEGROUP (Define a node group)
Use this command to define a node group. A node group is a group of client nodes
that are acted upon as if they were a single entity. A node can be a member of one
or more node groups.
Privilege class
To issue this command, you must have system or unrestricted policy privilege.
Syntax
DEFine NODEGroup group_name
DESCription

=

description


Parameters
group_name
Specifies the name of the node group that you want to create. The maximum
length of the name is 30 characters. The specified name may not be the same
as any existing client node name.
DESCription
Specifies a description of the node group. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters.
Examples
Task
Define a node group named group1.
Command
define nodegroup group1
Related commands
Table 85. Commands related to DEFINE NODEGROUP
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
QUERY BACKUPSET Displays backup sets.
QUERY NODEGROUP Displays information about node groups.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.
UPDATE NODEGROUP Updates the description of a node group.

DEFINE NODEGROUP
Chapter 2. Administrative commands 261
DEFINE NODEGROUPMEMBER (Define node group member)
Use this command to add a client node to a node group. A node group is a group of
client nodes that are acted upon as if they were a single entity.
Privilege class
To issue this command you must have system or unrestricted policy privilege.
Syntax

,
DEFine NODEGROUPMember

group_name

node_name

Parameters
group_name
Specifies the name of the node group to which you want to add a client node.
node_name
Specifies the name of the client node that you want to add to the node group.
You can specify one or more names. Separate multiple names with commas; do
not use intervening spaces. You can also use wildcard characters when
specifying multiple names.
Examples
Task
Define two members, node1 and node2, to a node group, group1.
Command
define nodegroupmember group1 node1,node2
Related commands
Table 86. Commands related to DEFINE NODEGROUPMEMBER
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DEFINE NODEGROUP Defines a group of nodes.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
QUERY BACKUPSET Displays backup sets.
QUERY NODEGROUP Displays information about node groups.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.
UPDATE NODEGROUP Updates the description of a node group.

DEFINE NODEGROUPMEMBER

262 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE PATH (Define a path)
Use this command to define a path from a source to a destination. A path provides
access to a destination from a source. You must define the source and destination
before you can define a path. For example, if a path is required between a server
and a drive, you must first issue the DEFINE DRIVE command and then issue the
DEFINE PATH command. A path must be defined after you issue the DEFINE
DRIVE command in order to make the drive usable by IBM Tivoli Storage
Manager software.
Privilege class
To issue this command you must have system privilege or unrestricted storage
privilege.
Syntax

When the destination is a drive
DEFine PATH source_name destination_name
SRCType = DATAMover
SERVer

AUTODetect

=

No

Yes
DESTType = DRive
LIBRary = library_name DEVIce = device_name
FILE

ONLine = Yes
ONLine

=

Yes

No

DIRectory = current_directory_name
,

DIRectory

=

directory_name

DEFINE PATH
Chapter 2. Administrative commands 263
Syntax

When the destination is a library
DEFine PATH source_name destination_name

(1)
SRCType

=

DATAMover

SERVer

AUTODetect

=

No

Yes

DESTType = LIBRary DEVIce = device_name

EXTERNALManager

=

path_name

ONLine = Yes
ONLine

=

Yes

No

Notes:
1 DATAMOVER only applies to NAS devices.

Parameters
source_name (Required)
Specifies the name of source for the path. This parameter is required.
destination_name (Required)
Specifies the name of the destination. This parameter is required. The
destination can be a drive or a library.
Note: To define a path from a NAS data mover to a library, the library must
have LIBTYPE of SCSI, 349x, or ACSLS.
SRCType (Required)
Specifies the type of the source. This parameter is required. Possible values are:
DATAMover
Specifies that a data mover is the source.
SERVer
Specifies that a storage agent is the source.
AUTODetect
Specifies whether the serial number for a drive or library will be automatically
updated in the database at the time that the path is defined. This parameter is
optional. This parameter is only valid for paths defined from the local server to
a drive or a library. Possible values are:
No
Specifies that the serial number will not be automatically updated. The
serial number is still compared with what is already in the database for the
device. The server issues a message if there is a mismatch.
DEFINE PATH

264 IBM Tivoli Storage Manager for Windows: Administrators Reference
Yes
Specifies that the serial number will be automatically updated to reflect the
same serial number that the drive reports to IBM Tivoli Storage Manager.
Note:
1. If you did not set the serial number when you defined the drive
or the library, the server always tries to detect the serial number,
and AUTODETECT defaults to YES. If you have previously
entered a serial number, then AUTODETECT defaults to NO.
2. The use of AUTODETECT=YES in this command means that the
serial number set in the drive or library definition is updated
with the detected serial number.
3. DESTTYPE=DRIVE only: If you set DESTTYPE=DRIVE and
AUTODETECT=YES, then the drive element number in the IBM
Tivoli Storage Manager database will be automatically changed
to reflect the same element number that corresponds to the serial
number of that drive. This is true for drives in a SCSI library. For
more information about the element number, see DEFINE
DRIVE.
4. Depending on the capabilities of the device, the AUTODETECT
parameter may not be supported.
DESTType (Required)
Specifies the type of the destination. This parameter is required. Possible
values are:
DRive
Specifies that a drive is the destination. When the destination is a drive,
you must specify a library name.
LIBRary
Specifies that a library is the destination.
LIBRary
Specifies the name of the library to which the drive is assigned. This parameter
is required if DESTTYPE=DRIVE. The library and its drives must already be
defined to the IBM Tivoli Storage Manager server. If the path is from a NAS
data mover to a library, the library must have LIBTYPE of SCSI, 349x, or
ACSLS.
DEVIce
Specifies the name of the device as known to the source, or FILE if the device
is a logical drive in a FILE library.
The source uses the device name to access the drive or library. See Table 87 for
examples.
Table 87. Examples of device names
Source to destination Example
Server to a drive (not a FILE drive) mt3
Server to a library lb4.1
Storage agent (on a Windows system) to a drive (not a
FILE drive)
mt3
Storage agent to a drive when the drive is a logical
drive in a FILE library
FILE
NAS data mover to a library mc0
DEFINE PATH
Chapter 2. Administrative commands 265
Table 87. Examples of device names (continued)
Source to destination Example
NAS data mover to a drive Network Appliance NAS file server:
rst0l
EMC Celerra NAS file server:
c436t0l1
IBM System Storage N Series: rst0l

Note:
1. For more complete information about device names when the source
is a server, see the Administrators Guide.
2. For information about the device name when the source is a storage
agent, see the Storage Agent Users Guide.
3. For 349X libraries, the alias name is a symbolic name that is
specified in the c:\winnt\ibmatl.conf file. For more information, refer
to the IBM TotalStorage Tape Device Drivers Installation and Users
Guide. The Guides can be downloaded from the FTP site at
ftp://ftp.software.ibm.com/storage/devdrvr/. They are located in
the Doc folder.
4. For information about how to obtain names for devices that are
connected to a NAS file server, consult the product information for
the file server. For example, for a Network Appliance file server,
connect to the file server using telnet and issue the SYSCONFIG
command. Use this command to determine device names for drives:
sysconfig -t
Use this command to determine the device name for a library:
sysconfig -m
EXTERNALManager
Specifies the location of the external library manager where IBM Tivoli Storage
Manager can send media access requests. This parameter is required when the
library name is an external library. Use single quotes around the value of this
parameter. For example, enter: c:\Program Files\bin\elm.exe
ONLine
Specifies whether the path is available for use. This parameter is optional. The
default is YES. Possible values are:
Yes
Specifies that the path is available for use.
No
Specifies that the path is not available for use.
The source and the destination must both be available to use the path. For
example, if the path from a data mover to a drive is online, but either the data
mover or the drive is offline, you cannot use the path.
Attention: If the path to a library is offline, the server will not be able to
access the library. If the server is halted and restarted while the path to the
library is offline, the library will not be initialized. See the Administrators Guide
for additional information.
DEFINE PATH

266 IBM Tivoli Storage Manager for Windows: Administrators Reference
DIRectory
Specifies the directory location or locations where the storage agent reads and
writes the files that represent storage volumes for the FILE device class that is
associated with the FILE library. The DIRECTORY parameter is also used for
devices of type REMOVABLEFILE. For REMOVABLEFILE devices, the
DIRECTORY parameter provides information for the server (not a storage
agent) along with the DRIVE parameter to describe access to the device. This
parameter is optional.
On a storage agent, this parameter is only valid when all of the following
conditions are true:
v The source type is SERVER (meaning a storage agent that has been defined
as a server to this server).
v The source name is the name of a storage agent, not the server.
v The destination is a logical drive that is part of a FILE library created when
the device class was defined.
If you specified multiple directories for the device class associated with the
FILE library, you must specify the same number of directories for each path to
the FILE library. Do not change or move existing directories on the server that
the storage agent is using so that the device class and the path remain
synchronized. Adding directories is permitted. Specifying a mismatched
number of directories can cause a run-time failure. See the example below.
The default value for DIRECTORY is the directory of the server at the time the
command is issued. The Windows registry is used to locate the default value.
Use a naming convention that allows you to associate the directory with a
particular physical drive. This can help ensure that your configuration is valid
for sharing the FILE library between the server and storage agent. If the
storage agent is on a Windows system, use a universal naming convention
(UNC) name. When the storage agent lacks permission to access remote
storage, the storage agent will experience mount failures.
The account associated with the storage agent service must be either an
account within the local administrators group or an account within the
domain administrators group. If the account is in the local administrators
group, the user ID and password must match that of an account with
permissions to access storage as provided by the machine which administers
the remote share. For example, if a SAMBA server is providing access to
remote storage, the user ID and password in the SAMBA configuration must
match that of the local administrator user ID and password associated with the
storage agent service.
define devclass file devtype=file shared=yes mountlimit=1
directory=d:\filedir\dir1
define path sta1 file1 srctype=server desttype=drive
library=file1 device=file
directory=\\192.168.1.10\filedir\dir1
In the example above, the DEFINE DEVCLASS command establishes the
shared file system in the directory accessed by the server as
D:\FILEDIR\DIR1. The storage agent, however, is using UNC name
\\192.168.1.10\FILEDIR\DIR1. This means that the machine with TCP/IP
address 192.168.1.10 is sharing the same directory using FILEDIR as the shared
name. Also, the storage agent service has an account which can access this
storage. It can access it either because it is associated with a local account with
the same user ID and password as 192.168.1.10 or it is associated with a
DEFINE PATH
Chapter 2. Administrative commands 267
domain account which is available on both the storage agent and on
192.168.1.10. If appropriate to the installation, you can replace the 192.168.1.10
with a symbolic name such as:
example.yourcompany.com
Note:
1. Storage agents access FILE volumes by replacing a directory name in
a volume name with a directory name from a directory in the list
provided with the DEFINE PATH command. Directories specified
with this parameter are not validated on the IBM Tivoli Storage
Manager server.
2. IBM Tivoli Storage Manager does not create shares or permissions, or
mount the target file system. You must perform these actions before
starting the storage agent.
The following illustrates the importance of matching device classes and paths
to ensure that storage agents can access newly created FILE volumes.
Suppose you want to use these three directories for a FILE library:
v c:\server
v d:\server
v e:\server
1. You use the following command to set up a FILE library named CLASSA
with one drive named CLASSA1 on SERVER1:
define devclass classa devtype=file
directory="c:\server,d:\server,e:\server"
shared=yes mountlimit=1
2. You want the storage agent STA1 to be able to use the FILE library, so you
define the following path for storage agent STA1:
define path server1 sta1 srctype=server desttype=drive device=file
directory="\\192.168.1.10\c\server,\\192.168.1.10\d\server,
\\192.168.1.10\e\server" library=classa
In this scenario, the storage agent, STA1, will replace the directory name
c:\server with the directory name \\192.168.1.10\c\server to access FILE
volumes that are in the c:\server directory on the server.
3. File volume c:\server\file1.dsm is created by SERVER1. If you later change
the first directory for the device class with the following command:
update devclass classa directory="c:\otherdir,d:\server,e:\server"
SERVER1 will still be able to access file volume c:\server\file1.dsm, but the
storage agent STA1 will not be able to access it because a matching
directory name in the PATH directory list no longer exists. If a directory
name is not available in the directory list associated with the device class,
the storage agent can lose access to a FILE volume in that directory.
Although the volume will still be accessible from the Tivoli Storage
Manager server for reading, failure of the storage agent to access the FILE
volume can cause operations to be retried on a LAN-only path or to fail.
4. If file volume /opt/tivoli1/file1.dsm is created on SERVER1, and if the
following command is issued,
update devclass classa directory="/opt/otherdir,/opt/tivoli2,
/opt/tivoli3"
SERVER1 will still be able to access file volume /opt/tivoli1/file1.dsm, but
the storage agent STA1 will not be able to access it because a matching
DEFINE PATH

268 IBM Tivoli Storage Manager for Windows: Administrators Reference
directory name in the PATH directory list no longer exists. If a directory
name is not available in the directory list associated with the device class,
the storage agent can lose access to a FILE volume in that directory.
Although the volume will still be accessible from the Tivoli Storage
Manager server for reading, failure of the storage agent to access the FILE
volume can cause operations to be retried on a LAN-only path or to fail.
Examples
Task
Define a path from a server to a drive. In this case, the server name is NET1, the
drive name is TAPEDRV6, the library is NETLIB, and the device name is mt4. Set
AUTODETECT to NO.
Command
define path net1 tapedrv6 srctype=server autodetect=no
desttype=drive library=netlib device=mt4
Task
Define a path from the data mover that is a NAS file server to the drive that the
NAS file server will use for backup and restore operations. In this example, the
NAS data mover is NAS1, the drive name is TAPEDRV3, the library is NASLIB,
and the device name for the drive is rst0l.
Command
define path nas1 tapedrv3 srctype=datamover desttype=drive
library=naslib device=rst0l
Task
Define a path from storage agent SA1 to the drive that the storage agent uses for
backup and restore operations. In this example, the library is TSMLIB, the drive is
TAPEDRV4, and the device name for the drive is rmt3.
Command
define path sa1 tapedrv4 srctype=server desttype=drive
library=tsmlib device=/dev/rmt3
Task
Define a path that allows the storage agent to access files on disk storage shared
with the IBM Tivoli Storage Manager server. Drive FILE9 is defined to library
FILE1 on the server. The storage agent SA1 accesses FILE9. The data for FILE9
resides on the server at d:\tsmdata\filedata. On the storage agent, this data is on
directory \\192.168.1.10\filedata.
Command
define path sa1 file9 srctype=server desttype=drive library=file1
device=file directory="\\192.168.1.10\filedata"
DEFINE PATH
Chapter 2. Administrative commands 269
Related commands
Table 88. Commands related to DEFINE PATH
Command Description
DEFINE DATAMOVER Defines a data mover to the IBM Tivoli
Storage Manager server.
DEFINE DRIVE Assigns a drive to a library.
DEFINE LIBRARY Defines an automated or manual library.
DELETE PATH Deletes a path from a source to a destination.
QUERY PATH Displays information about the path from a
source to a destination.
UPDATE DATAMOVER Changes the definition for a data mover.
UPDATE PATH Changes the attributes associated with a
path.

DEFINE PATH

270 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE POLICYSET (Define a policy set)
Use this command to define a policy set in a policy domain. A policy set contains
management classes, which contain copy groups. You can define one or more
policy sets for each policy domain.
To put a policy set into effect, you must activate the policy set by using the
ACTIVATE POLICYSET command. Only one policy set can be active in a policy
domain. The copy groups and management classes within the active policy set
determine the rules by which client nodes perform backup, archive, and space
management operations, and how the client files stored are managed.
Use the VALIDATE POLICYSET command to verify that a policy set is complete
and valid before activating it with the ACTIVATE POLICYSET command.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the policy
set belongs.
Syntax
DEFine POlicyset domain_name policy_set_name

DESCription

=

description


Parameters
domain_name (Required)
Specifies the name of the policy domain to which the policy set belongs.
policy_set_name (Required)
Specifies the name of the policy set. The maximum length of this name is 30
characters. You cannot define a policy set named ACTIVE.
DESCription
Specifies a description for the new policy set. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters.
Examples
Task
Define a policy set called SUMMER for the PROG1 policy domain and include the
description, Programming Group Policies.
Command
define policyset prog1 summer
description="Programming Group Policies"
DEFINE POLICYSET
Chapter 2. Administrative commands 271
Related commands
Table 89. Commands related to DEFINE POLICYSET
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
COPY MGMTCLASS Creates a copy of a management class.
COPY POLICYSET Creates a copy of a policy set.
DEFINE DOMAIN Defines a policy domain that clients can be
assigned to.
DEFINE MGMTCLASS Defines a management class.
DELETE POLICYSET Deletes a policy set, including its
management classes and copy groups, from a
policy domain.
QUERY POLICYSET Displays information about policy sets.
UPDATE POLICYSET Changes the description of a policy set.
VALIDATE POLICYSET Verifies and reports on conditions the
administrator must consider before activating
the policy set.

DEFINE POLICYSET

272 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE PROFASSOCIATION (Define a profile association)
Use this command on a configuration manager to associate one or more objects
with a configuration profile for distribution to subscribing managed servers. After
a managed server subscribes to a profile, the configuration manager sends object
definitions associated with the profile to the managed server where they are stored
in the database. Objects created this way in the database of a managed server
become managed objects. An object can be associated with more than one profile.
You can use this command to define an initial set of profile associations and to add
to existing associations.
You can associate the following types of objects with a profile:
v Administrator registrations and authorities
v Policy domains, which include the domains policy sets, management classes,
copy groups, and client schedules
v Administrative schedules
v Server command scripts
v Client option sets
v Server definitions
v Server group definitions
Note: The configuration manager does not distribute status information for an
object to managed servers. For example, information such as the number of
days since an administrator last accessed the server is not distributed to
managed servers. This type of information is maintained in the databases of
the individual managed servers.
Privilege class
To issue this command, you must have system privilege.
Syntax
DEFine PROFASSOCiation profile_name

ADMins

=

*

,

admin_name

DOmains

=

*

,

domain_name

ADSCHeds

=

*

,

schedule_name

SCRipts

=

*

,

script_name

DEFINE PROFASSOCIATION
Chapter 2. Administrative commands 273

CLOptsets

=

*

,

option_set_name

SERVers

=

*

,

server_name

SERVERGroups

=

*

,

group_name


Parameters
profile_name (Required)
Specifies the name of the configuration profile.
ADMins
Specifies administrators to associate with the profile. You can use wildcard
characters in the names. You can specify more than one name by separating
the names with commas and no intervening spaces. Use the match-all
definition, an asterisk (*) by itself, to specify all administrators that are
registered with the configuration manager. If you specify the match-all
definition and later add more administrators, they are automatically
distributed through the profile.
The configuration manager distributes the administrator name, password,
contact information, and authorities of administrators associated with the
profile. The configuration manager does not distribute the following:
v The administrator named SERVER_CONSOLE, even if you use a match-all
definition
v The locked or unlocked status of an administrator
When the profile already has administrators associated with it, the following
apply:
v If you specify a list of administrators and a list already exists, Tivoli Storage
Manager combines the new list with the existing list.
v If you specify a match-all definition and a list of administrators already
exists, Tivoli Storage Manager replaces the list with the match-all definition.
v If you specify a list of administrators, and a match-all definition had
previously been specified, Tivoli Storage Manager ignores the list. To remove
the match-all definition, issue the DELETE PROFASSOCIATION command
with the ADMINS=* parameter.
DOmains
Specifies policy domains to associate with the profile. You can use wildcard
characters in the names. You can specify more than one name by separating
the names with commas and no intervening spaces. Use the match-all
definition, an asterisk (*) by itself, to specify all domains that are defined on
the configuration manager. If you specify the match-all definition and later add
more domains, they are automatically distributed through the profile.
The configuration manager distributes domain information that includes
definitions of policy domains, policy sets, management classes, copy groups,
and client schedules. The configuration manager does not distribute the
ACTIVE policy set. Administrators on a managed server can activate any
policy set within a managed domain on a managed server.
DEFINE PROFASSOCIATION

274 IBM Tivoli Storage Manager for Windows: Administrators Reference
When the profile already has domains associated with it, the following apply:
v If you specify a list of domains and a list already exists, Tivoli Storage
Manager combines the new list with the existing list.
v If you use a match-all definition and a list of domains already exists, Tivoli
Storage Manager replaces the list with the match-all definition.
v If you specify a list of domains, and a match-all definition had previously
been specified, Tivoli Storage Manager ignores the list. To remove the
match-all definition, issue the DELETE PROFASSOCIATION command with
the DOMAINS=* parameter.
Attention: Client operations such as backup and archive fail if destination
pools do not exist. Therefore, managed servers that subscribe to this profile
must have definitions for any storage pools specified as destinations in the
associated domains. Use the RENAME STGPOOL command to rename existing
storage pools to match the destination names distributed.
ADSCHeds
Specifies administrative schedules to associate with the profile. You can use
wildcard characters in the names. You can specify more than one name by
separating the names with commas and no intervening spaces. Use the
match-all definition, an asterisk (*) by itself, to specify all administrative
schedules that are defined on the configuration manager. If you specify the
match-all definition and later add more administrative schedules, they are
automatically distributed through the profile.
Note: Administrative schedules are not active when they are distributed by a
configuration manager. An administrator on a managed server must
activate any schedule to have it run on that server.
When the profile already has administrative schedules associated with it, the
following apply:
v If you specify a list of administrative schedules and a list already exists,
Tivoli Storage Manager combines the new list with the existing list.
v If you use a match-all definition and a list of administrative schedules
already exists, Tivoli Storage Manager replaces the list with the match-all
definition.
v If you specify a list of administrative schedules, and a match-all definition
had previously been specified, Tivoli Storage Manager ignores the list. To
remove the match-all definition, issue the DELETE PROFASSOCIATION
command with the ADSCHEDS=* parameter.
SCRipts
Specifies server command scripts to associate with the profile. You can use
wildcard characters in the names. You can specify more than one name by
separating the names with commas and no intervening spaces. Use the
match-all definition, an asterisk (*) by itself, to specify all scripts that are
defined on the configuration manager. If you specify the match-all definition
and later add more scripts, they are automatically distributed through the
profile.
When the profile already has scripts associated with it, the following apply:
v If you specify a list of scripts and a list already exists, Tivoli Storage
Manager combines the new list with the existing list.
v If you use a match-all definition and a list of scripts already exists, Tivoli
Storage Manager replaces the list with the match-all definition.
DEFINE PROFASSOCIATION
Chapter 2. Administrative commands 275
v If you specify a list of scripts, and a match-all definition had previously been
specified, Tivoli Storage Manager ignores the list. To remove the match-all
definition, issue the DELETE PROFASSOCIATION command with the
SCRIPTS=* parameter.
CLOptsets
Specifies client option sets to associate with the profile. You can use wildcard
characters in the names. You can specify more than one name by separating
the names with commas and no intervening spaces. Use the match-all
definition, an asterisk (*) by itself, to specify all client option sets that are
defined on the configuration manager. If you specify the match-all definition
and later add more client option sets, they are automatically distributed
through the profile.
When the profile already has client option sets associated with it, the following
apply:
v If you specify a list of client option sets and a list already exists, Tivoli
Storage Manager combines the new list with the existing list.
v If you use a match-all definition and a list of client option sets already exists,
Tivoli Storage Manager replaces the list with the match-all definition.
v If you specify a list of client option sets, and a match-all definition had
previously been specified, Tivoli Storage Manager ignores the list. To remove
the match-all definition, issue the DELETE PROFASSOCIATION command
with the CLOPSETS=* parameter.
SERVers
Specifies server definitions to associate with the profile. The definitions are
distributed to managed servers that subscribe to this profile. You can use
wildcard characters in the names. You can specify more than one name by
separating the names with commas and no intervening spaces. Use the
match-all definition, an asterisk (*) by itself, to specify all servers that are
defined on the configuration manager. If you specify the match-all definition
and later add more servers, they are automatically distributed through the
profile.
The configuration manager distributes the following server attributes:
communication method, IP address, port address, server password, URL, and
the description. Distributed server definitions always have the
ALLOWREPLACE attribute set to YES on the managed server, regardless of
this parameters value on the configuration manager. On the managed server,
you can use the UPDATE SERVER command to set all other attributes.
When the profile already has servers associated with it, the following apply:
v If you specify a list of servers and a list already exists, Tivoli Storage
Manager combines the new list with the existing list.
v If you use a match-all definition and a list of servers already exists, Tivoli
Storage Manager replaces the list with the match-all definition.
v If you specify a list of servers, and a match-all definition had previously
been specified, Tivoli Storage Manager ignores the list. To remove the
match-all definition, issue the DELETE PROFASSOCIATION command with
the SERVERS=* parameter.
Note:
1. A server definition on a managed server is not replaced by a
definition from the configuration manager unless you have allowed
replacement of the definition on the managed server. To allow
DEFINE PROFASSOCIATION

276 IBM Tivoli Storage Manager for Windows: Administrators Reference
replacement, on the managed server update the server definition by
using the UPDATE SERVER command with ALLOWREPLACE=YES.
2. If a configuration manager distributes a server definition to a
managed server, and a server group of the same name exists on the
managed server, the distributed server definition replaces the server
group definition.
SERVERGroups
Specifies server groups to associate with the profile. You can use wildcard
characters in the names. You can specify more than one name by separating
the names with commas and no intervening spaces. Use the match-all
definition, an asterisk (*) by itself, to specify all server groups that are defined
on the configuration manager. If you specify the match-all definition and later
add more server groups, they are automatically distributed through the profile.
Note: A configuration manager does not distribute a server group definition to
a managed server if the managed server has a server defined with the
same name as that of the server group.
When the profile already has server groups associated with it, the following
apply:
v If you specify a list of server groups and a list already exists, Tivoli Storage
Manager combines the new list with the existing list.
v If you use a match-all definition and a list of server groups already exists,
Tivoli Storage Manager replaces the list with the match-all definition.
v If you specify a list of server groups, and a match-all definition had
previously been specified, Tivoli Storage Manager ignores the list. To remove
the match-all definition, issue the DELETE PROFASSOCIATION command
with the SERVERGROUPS=* parameter.
Examples
Task 1
Associate a domain named MARKETING with a profile named DELTA.
Command
define profassociation delta domains=marketing
Task 2
You have already associated a list of domains with a profile named GAMMA. Now
associate all domains defined on the configuration manager with the profile.
Command
define profassociation gamma domains=*
Related commands
Table 90. Commands related to DEFINE PROFASSOCIATION
Command Description
COPY PROFILE Creates a copy of a profile.
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
DELETE PROFASSOCIATION Deletes the association of an object with a
profile.
DEFINE PROFASSOCIATION
Chapter 2. Administrative commands 277
Table 90. Commands related to DEFINE PROFASSOCIATION (continued)
Command Description
DELETE PROFILE Deletes a profile from a configuration
manager.
LOCK PROFILE Prevents distribution of a configuration
profile.
NOTIFY SUBSCRIBERS Notifies servers to refresh their configuration
information.
QUERY PROFILE Displays information about configuration
profiles.
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UNLOCK PROFILE Enables a locked profile to be distributed to
managed servers.
UPDATE PROFILE Changes the description of a profile.

DEFINE PROFASSOCIATION

278 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE PROFILE (Define a profile)
Use this command on a configuration manager to define a profile (a set of
configuration information) that can be distributed to managed servers.
After defining a profile, you can use the DEFINE PROFASSOCIATION command
to specify objects to be distributed to managed servers subscribing to the profile.
Privilege class
To issue this command, you must have system privilege.
Syntax
DEFine PROFIle profile_name
DESCription

=

description


Parameters
profile_name (Required)
Specifies the name of the profile. The maximum length of the name is 30
characters.
DESCription
Specifies a description of the profile. The maximum length of the description is
255 characters. Enclose the description in quotation marks if it contains any
blank characters. This parameter is optional.
Examples
Task
Define a profile named ALPHA with a description of Programming Center.
Command
define profile alpha
description="Programming Center"
Related commands
Table 91. Commands related to DEFINE PROFILE
Command Description
COPY PROFILE Creates a copy of a profile.
DEFINE PROFASSOCIATION Associates objects with a profile.
DEFINE SUBSCRIPTION Subscribes a managed server to a profile.
DELETE PROFASSOCIATION Deletes the association of an object with a
profile.
DELETE PROFILE Deletes a profile from a configuration
manager.
LOCK PROFILE Prevents distribution of a configuration
profile.
QUERY PROFILE Displays information about configuration
profiles.
DEFINE PROFILE
Chapter 2. Administrative commands 279
Table 91. Commands related to DEFINE PROFILE (continued)
Command Description
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UNLOCK PROFILE Enables a locked profile to be distributed to
managed servers.
UPDATE PROFILE Changes the description of a profile.

DEFINE PROFILE

280 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE RECMEDMACHASSOCIATION (Associate recovery
media with a machine)
Use this command to associate recovery media with one or more machines. A
machine is associated with recovery media so that the location of the boot media
and its list of volume names are available to recover the machine. To retrieve the
information, issue the QUERY MACHINE command. This information will be
included in the plan file to help you recover the client machines.
To associate a machine with recovery media, both the machine and media must be
defined to Tivoli Storage Manager. A machine remains associated with the media
until the association, the media, or the machine is deleted.
Privilege class
To issue this command, you must have system privilege.
Syntax

DEFine RECMEDMACHAssociation

media_name

,
machine_name

Parameters
media_name (Required)
Specifies the name of the recovery media with which one or more machines
will be associated.
machine_name (Required)
Specifies the name of the machines to be associated with the recovery media. A
machine can be associated with multiple recovery media. To specify a list of
machines, separate the names with commas and no intervening spaces. You
can use wildcard characters to specify a name.
Examples
Task
Associate machines DISTRICT1 and DISTRICT5 to the DIST5RM recovery media.
Command
define recmedmachassociation dist5rm
district1,district5
Related commands
Table 92. Commands related to DEFINE RECMEDMACHASSOCIATION
Command Description
DEFINE MACHINE Defines a machine for DRM.
DEFINE RECOVERYMEDIA Defines the media required to recover a
machine.
DELETE MACHINE Deletes a machine.
DELETE RECMEDMACHASSOCIATION Deletes association between recovery media
and a machine.
DEFINE RECMEDMACHASSOCIATION
Chapter 2. Administrative commands 281
Table 92. Commands related to DEFINE RECMEDMACHASSOCIATION (continued)
Command Description
DELETE RECOVERYMEDIA Deletes recovery media.
QUERY MACHINE Displays information about machines.
QUERY RECOVERYMEDIA Displays media available for machine
recovery.

DEFINE RECMEDMACHASSOCIATION

282 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE RECOVERYMEDIA (Define recovery media)
Use this command to define the media needed to recover a machine. The same
media can be associated with multiple machines. To display the information, use
the QUERY MACHINE command. This information will be included in the plan
file to help you to recover the client machines.
Privilege class
To issue this command, you must have system privilege.
Syntax
DEFine RECOVERYMedia media_name

,

VOLumenames

=

volume_name

DESCription

=

description

LOcation

=

location

Type = OTher
Type

=

OTher

BOot

PROduct

=

product_name

PRODUCTInfo

=

product_information


Parameters
media_name (Required)
Specifies the name of the recovery media to be defined. The name can be up to
30 characters.
VOLumenames
Specifies the names of volumes that contain the recoverable data (for example,
operating system image copies). This parameter is required if you specify a
media type of BOOT. Specify boot media volume names in the order in which
they are to be inserted into the machine at recovery time. The maximum length
of the volume names list is 255 characters. Enclose the list in quotation marks
if it contains any blank characters.
DESCription
Specifies the description of the recovery media. This parameter is optional. The
maximum length is 255 characters. Enclose the text in quotation marks if it
contains any blank characters.
LOcation
Specifies the location of the recovery media. This parameter is optional. The
maximum length is 255 characters. Enclose the text in quotation marks if it
contains any blank characters.
Type
Specifies the type of recovery media. This parameter is optional. The default is
OTHER.
DEFINE RECOVERYMEDIA
Chapter 2. Administrative commands 283
BOot
Specifies that this is boot media. You must specify volume names if the
type is BOOT.
OTher
Specifies that this is not boot media. For example, a CD-ROM that contains
operating system manuals.
PROduct
Specifies the name of the product that wrote to this media. This parameter is
optional. The maximum length is 16 characters. Enclose the text in quotation
marks if it contains any blank characters.
PRODUCTInfo
Specifies information about the product that wrote to the media. This would be
information that you may need to restore the machine. This parameter is
optional. The maximum length is 255 characters. Enclose the text in quotation
marks if it contains any blank characters.
Examples
Task
Define the recovery media named DIST5RM. Include a description and the
location.
Command
define recoverymedia dist5rm
description="district 5 base system image"
location="district 1 vault"
Related commands
Table 93. Commands related to DEFINE RECOVERYMEDIA
Command Description
DEFINE RECMEDMACHASSOCIATION Associates recovery media with a machine.
DELETE RECOVERYMEDIA Deletes recovery media.
QUERY RECOVERYMEDIA Displays media available for machine
recovery.
UPDATE RECOVERYMEDIA Changes the attributes of recovery media.

DEFINE RECOVERYMEDIA

284 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE SCHEDULE (Define a client or an administrative
command schedule)
Use this command to create a client or administrative command schedule.
The DEFINE SCHEDULE command takes two forms: one if the schedule applies to
client operations, one if the schedule applies to administrative commands. Within
these two forms, you can select either classic or enhanced style schedules. The
syntax and parameters for each form are defined separately.
For each schedule, a startup window is specified. The startup window is the time
period during which the schedule must be initiated. The schedule will not
necessarily complete processing within this window. If the server is not running
when this window starts, but is started before the end of the defined window is
reached, the schedule will run when the server is restarted. Options associated
with each schedule style (classic and enhanced ) determine when the startup
windows should begin.
Table 94. Commands related to DEFINE SCHEDULE
Command Description
COPY SCHEDULE Creates a copy of a schedule.
DEFINE ASSOCIATION Associates clients with a schedule.
DELETE SCHEDULE Deletes a schedule from the database.
QUERY EVENT Displays information about scheduled and
completed events for selected clients.
QUERY SCHEDULE Displays information about schedules.
SET MAXCMDRETRIES Specifies the maximum number of retries
after a failed attempt to execute a scheduled
command.
SET MAXSCHEDSESSIONS Specifies the maximum number of
client/server sessions available for processing
scheduled work.
SET RETRYPERIOD Specifies the time between retry attempts by
the client scheduler.
UPDATE SCHEDULE Changes the attributes of a schedule.
DEFINE SCHEDULE
Chapter 2. Administrative commands 285
DEFINE SCHEDULE client
Use the DEFINE SCHEDULE command to define a client schedule. Tivoli Storage
Manager uses this schedule to perform automatic backup and archive operations
for your client workstation at specified intervals or days. After you define a
schedule, use the DEFINE ASSOCIATION command to associate the client with the
schedule.
You must start the client scheduler on the client workstation for Tivoli Storage
Manager to process the schedule.
Note:
1. Not all clients can run all scheduled operations, even though Tivoli
Storage Manager allows you to define the schedule on the server and
associate it with the client. For example, a Macintosh client cannot run a
schedule when the action is to restore or retrieve files, or run an
executable script. An executable script is also known as a command file,
a batch file, or a script on different client operating systems.
2. Tivoli Storage Manager cannot run multiple schedules concurrently for
the same client node.
Privilege class
To define a client schedule, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the schedule
belongs.
Syntax
Classic client schedule
DEFine SCHedule domain_name schedule_name
Type

=

Client

DESCription

=

description
ACTion = Incremental
ACTion

=

Incremental

Selective

Archive

REStore

RETrieve

IMAGEBACkup

IMAGEREStore

Command

Macro

OPTions

=

option_string

(1)

OBJects

=

object_string

PRIority = 5
PRIority

=

number
STARTDate = current_date
STARTDate

=

date

DEFINE SCHEDULE Client

286 IBM Tivoli Storage Manager for Windows: Administrators Reference

STARTTime = current_time
STARTTime

=

time
DURation = 1
DURation

=

number

DURUnits = Hours
DURUnits

=

Minutes

Hours

Days

INDefinite
SCHEDStyle = Classic
SCHEDStyle

=

Enhanced

PERiod = 1
PERiod

=

number
PERUnits = Days
PERUnits

=

Hours

Days

Weeks

Months

Years

Onetime

DAYofweek = ANY
DAYofweek

=

ANY

WEEKDay

WEEKEnd

SUnday

Monday

TUesday

Wednesday

THursday

Friday

SAturday
EXPiration = Never
EXPiration

=

Never

date

Notes:
1 The OBJECTS parameter is optional when ACTION=INCREMENTAL, but is
required for other actions.
Syntax
Enhanced client schedule
DEFine SCHedule domain_name schedule_name
Type

=

Client

DESCription

=

description
ACTion = Incremental
ACTion

=

Incremental

Selective

Archive

REStore

RETrieve

IMAGEBACkup

IMAGEREStore

Command

Macro

DEFINE SCHEDULE Client

Chapter 2. Administrative commands 287

OPTions

=

option_string

(1)

OBJects

=

object_string

PRIority = 5
PRIority

=

number
STARTDate = current_date
STARTDate

=

date

STARTTime = current_time
STARTTime

=

time
DURation = 1
DURation

=

number

DURUnits = Hours
DURUnits

=

Minutes

Hours

Days

SCHEDStyle

=

Enhanced

MONth = ANY
MONth

=

ANY

JAnuary

February

MARch

APril

May

JUNe

JULy

AUgust

September

October

November

December
DAYOFMonth = ANY
DAYOFMonth

=

ANY

Day

WEEKofmonth = ANY
WEEKofmonth

=

ANY

FIrst

Second

Third

FOurth

Last
DAYofweek = ANY
DAYofweek

=

ANY

WEEKDay

WEEKEnd

SUnday

Monday

TUesday

Wednesday

THursday

Friday

SAturday

EXPiration = Never
EXPiration

=

Never

date

Notes:
1 The OBJECTS parameter is optional when ACTION=INCREMENTAL, but is
required for other actions.
DEFINE SCHEDULE Client

288 IBM Tivoli Storage Manager for Windows: Administrators Reference
Parameters
domain_name (Required)
Specifies the name of the policy domain to which this schedule belongs.
schedule_name (Required)
Specifies the name of the schedule to be defined. You can specify up to 30
characters for the name.
Type=Client
Specifies that a schedule for a client is defined. This parameter is optional.
DESCription
Specifies a description of the schedule. This parameter is optional. You can
specify up to 255 characters for the description. Enclose the description in
quotation marks if it contains any blank characters.
ACTion
Specifies the action that occurs when this schedule is processed. Possible
values are:
Incremental
Specifies that the schedule backs up all files that are new or that have
changed since the last incremental backup. Incremental also backs up any
file for which all existing backups may have expired.
Selective
Specifies that the schedule backs up only files that are specified with the
OBJECTS parameter.
Archive
Specifies that the schedule archives files that are specified with the
OBJECTS parameter.
REStore
Specifies that the schedule restores files that are specified with the
OBJECTS parameter.
When you specify ACTION=RESTORE for a scheduled operation, and the
REPLACE option is set to PROMPT, no prompting occurs. If you set the
option to PROMPT, the files are skipped. If you specify a second file
specification, this second file specification acts as the restore destination. If
you need to restore multiple groups of files, schedule one for each file
specification that you need to restore.
RETrieve
Specifies that the schedule retrieves files that are specified with the
OBJECTS parameter.
IMAGEBACkup
Specifies that the schedule backs up logical volumes that are specified with
the OBJECTS parameter.
IMAGEREStore
Specifies that the schedule restores logical volumes that are specified with
the OBJECTS parameter.
Command
Specifies that the schedule processes a client operating system command or
script that is specified with the OBJECTS parameter.
DEFINE SCHEDULE Client
Chapter 2. Administrative commands 289
Macro
Specifies that a client processes a macro whose file name is specified with
the OBJECTS parameter.
OPTions
Specifies the client options that you specify to the scheduled command at the
time the schedule is processed. This parameter is optional.
Only those options that are valid on the scheduled command may be specified
for this parameter. Refer to the appropriate client manual for information about
options that are valid from the command line. All options described there as
valid only on the initial command line will either result in an error or simply
be ignored when the schedule from the server is run. For example, do not
include the following options because they have no effect when the client
processes the scheduled command:
MAXCMDRETRIES
OPTFILE
QUERYSCHEDPERIOD
RETRYPERIOD
SCHEDLOGNAME
SCHEDMODE
SERVERNAME
TCPCLIENTADDRESS
TCPCLIENTPORT
When you define a scheduler service by using the DSMCUTIL command or the
wizard in the backup-archive client GUI, you specify an options file for the
scheduler service to use. You cannot override the options in that options file by
issuing the scheduled command. You must modify the options in your
scheduler service.
If the option string contains multiple options or options with embedded
spaces, surround the entire option string with one pair of single quotes.
Individual options that contain spaces should be enclosed in double quotes. A
leading minus sign is required in front of the option. Errors can occur if the
option string contains spaces that are not quoted correctly.
The following examples show how to specify some client options:
v To specify subdir=yes and domain all-local -systemobject, enter:
options=-subdir=yes -domain="all-local -c: -systemobject"
v To specify domain all-local -c: -d:, enter:
options=-domain="all-local -c: -d:"
Note: For Windows clients running in batch mode: If the use of double
quotes is necessary, use interactive mode (Processing a series of
commands from the administrative client on page 3) or operating
system escape characters. See Processing commands one at a time from
the administrative client on page 3 for additional information.
OBJects
Specifies the objects for which the specified action is performed. Use a single
space between each object. This parameter is required except when
ACTION=INCREMENTAL. If the action is a backup, archive, retrieve, or
restore operation, the objects are file spaces, directories, or logical volumes. See
DEFINE SCHEDULE Client

290 IBM Tivoli Storage Manager for Windows: Administrators Reference
the Backup-Archive Clients Installation and Users Guide for command syntax
information. If the action is to run a command or macro, the object is the name
of the command or macro to run.
When you specify ACTION=INCREMENTAL without specifying a value for
this parameter, the scheduled command is invoked without specified objects
and attempts to process the objects as defined in the clients option file. To
select all file spaces or directories for an action, explicitly list them in the object
string. Entering only an asterisk in the object string causes the backup to occur
only for the directory where the scheduler was started.
Note:
1. If you specify a second file specification, and it is not a valid
destination, you receive this error:
ANS1082E Invalid destination file specification <filespec> entered.
2. If you specify more than two file specifications, you receive this
error:
ANS1102E Excessive number of command line arguments passed to the
program!
When you specify ACTION=ARCHIVE, INCREMENTAL, or SELECTIVE for
this parameter, you can list a maximum of twenty (20) file specifications.
Enclose the object string in double quotes if it contains blank characters
(spaces), and then surround the double quotes with single quotes. If the object
string contains multiple file names, enclose each file name with its own pair of
double quotes, then surround the entire string with one pair of single quotes.
Errors can occur if file names contain a space that is not quoted correctly. The
following examples show how to specify some file names:
v To specify C:\FILE 2, D:\GIF FILES, and E:\MY TEST FILE, enter:
OBJECTS="C:\FILE 2" "D:\GIF FILES" "E:\MY TEST FILE"
v To specify D:\TEST FILE, enter:
OBJECTS="D:\TEST FILE"
Note: For Windows clients running in batch mode: If the use of double
quotes is necessary, use interactive mode (Processing a series of
commands from the administrative client on page 3) or operating
system escape characters. See Processing commands one at a time from
the administrative client on page 3 for additional information.
PRIority
Specifies the priority value for a schedule. This parameter is optional. You can
specify an integer from 1 to 10, with 1 being the highest priority and 10 being
the lowest. The default is 5.
If two or more schedules have the same window start time, the value you
specify determines when Tivoli Storage Manager processes the schedule. The
schedule with the highest priority starts first. For example, a schedule with
PRIORITY=3 starts before a schedule with PRIORITY=5.
STARTDate
Specifies the date for the beginning of the window in which the schedule is
first processed. This parameter is optional. The default is the current date. Use
this parameter with the STARTTIME parameter to specify when the initial
startup window of the schedule starts.
DEFINE SCHEDULE Client
Chapter 2. Administrative commands 291
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified. The maximum
number of days you can specify
is 9999.
TODAY +3 or +3.

STARTTime
Specifies the time for the beginning of the window in which the schedule is
first processed. This parameter is optional. The default is the current time. This
parameter is used in conjunction with the STARTDATE parameter to specify
when the initial startup window begins.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified
NOW+02:00 or +02:00.
If you issue this command at 5:00 with
STARTTIME=NOW+02:00 or
STARTTIME=+02:00, the beginning of
the startup window is at 7:00.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW-02:00 or 02:00.
If you issue this command at 5:00 with
STARTTIME=NOW02:00 or
STARTTIME=-02:00, the beginning of
the startup window is at 3:00.

DURation
Specifies the number of units that define the length of the startup window of
the scheduled operation. This parameter is optional. This value must be from 1
to 999. The default is 1.
Use this parameter with the DURUNITS parameter to specify the length of the
startup window. For example, if you specify DURATION=20 and
DURUNITS=MINUTES, the schedule must be started within 20 minutes of the
start date and start time. The default length of the startup window is 1 hour.
The duration of the window must be shorter than the period between
windows.
This value is ignored if you specify DURUNITS=INDEFINITE.
DURUnits
Specifies the time units used to determine the duration of the window in
which the schedule can start. This parameter is optional. The default is
HOURS.
Use this parameter with the DURATION parameter to specify how long the
startup window remains open to process the schedule. For example, if
DURATION=20 and DURUNITS=MINUTES, the schedule must be started
within 20 minutes of the start date and start time. The schedule may not
DEFINE SCHEDULE Client

292 IBM Tivoli Storage Manager for Windows: Administrators Reference
necessarily complete processing within this window. If the schedule needs to
be retried for any reason, the retry attempts must begin before the startup
window elapses, or the operation does not restart.
The default value for the length of the startup window is 1 hour. Possible
values are:
Minutes
Specifies that the duration of the window is defined in minutes.
Hours
Specifies that the duration of the window is defined in hours.
Days
Specifies that the duration of the window is defined in days.
INDefinite
Specifies that the startup window of the scheduled operation has an
indefinite duration. The schedule can run any time after the scheduled
start time, until the schedule expires. You cannot specify
DURUNITS=INDEFINITE, unless you specify PERUNITS=ONETIME. The
INDEFINITE value is not allowed with enhanced schedules.
SCHEDStyle
This parameter is optional. SCHEDSTYLE defines either the interval between
times when a schedule should run, or the days on which it should run. The
default is the classic syntax.
Possible values are:
Classic
Parameters allowed for the Classic syntax are: PERIOD, PERUNITS, and
DAYOFWEEK. These parameters are not allowed: MONTH,
DAYOFMONTH, and WEEKOFMONTH.
Enhanced
Parameters allowed for the Enchanced syntax are: MONTH,
DAYOFMONTH, WEEKOFMONTH, and DAYOFWEEK. These parameters
are not allowed: PERIOD and PERUNITS.
PERiod
Specifies the length of time between startup windows for this schedule. This
parameter is optional. This parameter is used only with classic schedules. You
can specify an integer from 1 to 999. The default is 1.
Use this parameter with the PERUNITS parameter to specify the period
between startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is
scheduled every five days after the initial start date and start time. The period
between startup windows must exceed the duration of each window. The
default is 1 day.
This value is ignored if you specify PERUNITS=ONETIME.
PERUnits
Specifies the time units used to determine the period between startup windows
for this schedule. This parameter is optional. This parameter is used only with
classic schedules. The default is DAYS.
Use this parameter with the PERIOD parameter to specify the period between
startup windows. For example, if you specify PERIOD=5 and
DEFINE SCHEDULE Client
Chapter 2. Administrative commands 293
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is
scheduled every 5 days after the initial start date and start time. The default is
1 day. Possible values are:
Hours
Specifies that the time between startup windows is in hours.
Days
Specifies that the time between startup windows is in days.
Weeks
Specifies that the time between startup windows is in weeks.
Months
Specifies that the time between startup windows is in months.
Note: When you specify PERUNITS=MONTHS, the scheduled operation
will be processed each month on the same date. For example, if the
start date for the scheduled operation is 02/04/1998, the schedule
will process on the 4th of every month thereafter. However, if the
date is not valid for the next month, then the scheduled operation
will be processed on the last valid date in the month. Thereafter,
subsequent operations are based on this new date. For example, if
the start date is 03/31/1998, the next months operation will be
scheduled for 04/30/1998. Thereafter, all subsequent operations will
be on the 30th of the month until February. Because February has
only 28 days, the operation will be scheduled for 02/28/1999.
Subsequent operations will be processed on the 28th of the month.
Years
Specifies that the time between startup windows for the schedule is in
years.
Note: When you specify PERUNITS=YEARS, the scheduled operation will
be processed on the same month and date of each year. For example,
if the start date for the scheduled operation is 02/29/2004, the next
years scheduled operation will be 02/28/2005 because February
only has 28 days. Thereafter, subsequent operations will be
scheduled for February 28th.
Onetime
Specifies that the schedule processes once. This value overrides the value
you specified for the PERIOD parameter.
DAYofweek
Specifies the day of the week on which the startup window for the schedule
begins. This parameter is optional. You can specify different options for the
DAYofweek parameter, depending on whether the schedule style has been
defined as Classic or Enhanced:
Classic Schedule
Specifies the day of the week on which the startup window for the
schedule begins. This parameter is optional. You can either specify one
day of the week, or WEEKDAY, WEEKEND, or ANY. If the start date
and start time fall on a day that does not correspond to a day you
specify, the start date and start time will be shifted forward in 24hour
increments until the DAYOFWEEK parameter is satisfied.
DEFINE SCHEDULE Client

294 IBM Tivoli Storage Manager for Windows: Administrators Reference
If you select a value for DAYOFWEEK other than ANY, and depending
on the values for PERIOD and PERUNITS, schedules may not be
processed when you would expect. The default is ANY.
Enhanced Schedule
Specifies the days of the week on which to run the schedule. You can
either specify multiple days separated by commas and no intervening
blanks, or WEEKDAY, WEEKEND, or ANY. If you specify multiple
days, the schedule will run on each of the specified days. If you
specify WEEKDAY or WEEKEND, you must also specify either
WEEKOFMONTH=FIRST or WEEKOFMONTH=LAST, and the
schedule will run just once per month.
The default value is ANY, meaning the schedule will run every day of
the week or on the day or days determined by other enhanced
schedule parameters. DAYOFWEEK must have a value of ANY (either
by default or specified with the command) when used with the
DAYOFMONTH parameter.
Possible values for the DAYofweek parameter are:
ANY
Specifies that the startup window can begin on any day of the week.
WEEKDay
Specifies that the startup window can begin on Monday, Tuesday,
Wednesday, Thursday, or Friday.
WEEKEnd
Specifies that the startup window can begin on Saturday or Sunday.
SUnday
Specifies that the startup window begins on Sunday.
Monday
Specifies that the startup window begins on Monday.
TUesday
Specifies that the startup window begins on Tuesday.
Wednesday
Specifies that the startup window begins on Wednesday.
THursday
Specifies that the startup window begins on Thursday.
Friday
Specifies that the startup window begins on Friday.
SAturday
Specifies that the startup window begins on Saturday.
MONth
Specifies the months of the year during which to run the schedule. This
parameter is used only with enhanced schedules. Specify multiple values by
using commas and no intervening blanks. The default value is ANY. This
means the schedule will run during every month of the year.
DAYOFMonth
Specifies the day of the month to run the schedule. This parameter is used
only with enhanced schedules. You can either specify ANY or a number from
-31 through 31, excluding zero. Negative values are a day from the end of the
month, counting backwards. For example, the last day of the month is -1, the
DEFINE SCHEDULE Client
Chapter 2. Administrative commands 295
next-to-the-last day of the month is -2, and so on. You can specify multiple
values separated by commas and no intervening blanks. If you specify multiple
values, the schedule will run on each of the specified days of the month. If
multiple values resolve to the same day, the schedule will run only once that
day.
The default value is ANY. This means the schedule will run on every day of
the month or on the days determined by other enhanced schedule parameters.
DAYOFMONTH must have a value of ANY (either by default or specified with
the command) when used with the DAYOFWEEK or WEEKOFMONTH
parameters.
WEEKofmonth
Specifies the week of the month in which to run the schedule. This parameter
is used only with enhanced schedules. A week is considered any seven-day
period which does not start on a particular day of the week. You can specify
FIRST, SECOND, THIRD, FOURTH, LAST, or ANY. You can specify multiple
values separated by commas and no intervening blanks. If you specify multiple
values, the schedule will run during each of the specified weeks of the month.
If multiple values resolve to the same week, the schedule will run only once
during that week.
The default value is ANY, meaning the schedule will run during every week of
the month or on the day or days determined by other enhanced schedule
parameters. WEEKOFMONTH must have a value of ANY (either by default or
specified with the command) when used with the DAYOFMONTH parameter.
EXPiration
Specifies the date after which this schedule is no longer used. This parameter
is optional. The default is NEVER. Possible values are:
Never
Specifies that the schedule never expires.
expiration_date
Specifies the date on which this schedule expires, in MM/DD/YYYY
format. If you specify an expiration date, the schedule expires at 23:59:59
on the date you specify.
Examples
Task 1
Define a schedule named MONTHLY_BACKUP that initiates an incremental
backup of all associated nodes. Specify the start date as Tuesday, May 1, 2001. This
date does not match the specified day of the week (Sunday), so the initial startup
window begins on the first Sunday after May 1, 2001 (05/01/2001). The startup
windows for this schedule extend from 01:00 through 03:00. This monthly schedule
initiates backup of c: and d: file spaces for all associated nodes.
Command
define schedule standard monthly_backup
description="Monthly Backup of c: and d: drives"
objects="c:\* d:\*"
startdate=05/01/2001 starttime=01:00
duration=2 durunits=hours period=1
perunits=months dayofweek=sunday
Task 2
DEFINE SCHEDULE Client

296 IBM Tivoli Storage Manager for Windows: Administrators Reference
Define a schedule named WEEKLY_BACKUP that initiates an incremental backup
of all associated nodes. The initial startup window for this schedule extends from
23:00 on Saturday, June 7, 1997 (06/07/1997), to 03:00 on Sunday, June 8, 1997
(06/08/1997). Subsequent windows begin at 23:00, every Saturday. No messages
are returned to the client node when this schedule is executed.
Command
define schedule employee_records weekly_backup
startdate=06/07/1997 starttime=23:00 duration=4
durunits=hours perunits=weeks
dayofweek=saturday options=-quiet
Task 3
Define a schedule that archives specific files quarterly on the last Friday of the
month.
Command
define schedule employee_records quarterly_archive
starttime=20:00 action=archive
object=/home/employee/records/*
duration=1 durunits=hour schedstyle=enhanced
month=mar,jun,sep,dec weekofmonth=last dayofweek=fri
DEFINE SCHEDULE Client
Chapter 2. Administrative commands 297
DEFINE SCHEDULE administrative command
Use the DEFINE SCHEDULE command to create a new schedule for processing an
administrative command.
You can include scripts in an administrative command schedule so the commands
are processed automatically.
Note:
1. You cannot schedule the MACRO command or the QUERY ACTLOG
command.
2. If you are scheduling a command that specifies the WAIT parameter, the
parameter must be set to YES in order for the process to provide a return
code to the session that started it. For more information about the WAIT
parameter, see Server command processing on page 14.
Privilege class
To define an administrative command schedule, you must have system privilege.
Syntax
Classic administrative schedule
DEFine SCHedule schedule_name
Type

=

Administrative

CMD

=

command
ACTIVE = No
ACTIVE

=

Yes

DESCription

=

description

PRIority = 5
PRIority

=

number
STARTDate = current_date
STARTDate

=

date

STARTTime = current_time
STARTTime

=

time
DURation = 1
DURation

=

number

DURUnits = Hours
DURUnits

=

Minutes

Hours

Days

INDefinite
SCHEDStyle = Classic
SCHEDStyle

=

Classic

PERiod = 1
PERiod

=

number
PERUnits = Days
PERUnits

=

Hours

Days

Weeks

Months

Years

Onetime

DEFINE SCHEDULE Administrative Command

298 IBM Tivoli Storage Manager for Windows: Administrators Reference

DAYofweek = ANY
DAYofweek

=

ANY

WEEKDay

WEEKEnd

SUnday

Monday

TUesday

Wednesday

THursday

Friday

SAturday
EXPiration = Never
EXPiration

=

Never

date

Syntax
Enhanced administrative schedule
DEFine SCHedule schedule_name
Type

=

Administrative

CMD

=

Command
ACTIVE = NO
ACTIVE

=

YES

DESCription

=

description

PRIority = 5
PRIority

=

number
STARTDate = current_date
STARTDate

=

date

STARTTime = current_time
STARTTime

=

time
DURation = 1
DURation

=

number

DURUnits = Hours
DURUnits

=

Minutes

Hours

Days

SCHEDStyle

=

Enhanced

MONth = ANY
MONth

=

ANY

JAnuary

February

MARch

APril

May

JUNe

JULy

AUgust

September

October

November

December
DAYOFMonth = ANY
DAYOFMonth

=

ANY

Day

DEFINE SCHEDULE Administrative Command

Chapter 2. Administrative commands 299

WEEKofmonth = ANY
WEEKofmonth

=

ANY

FIrst

Second

Third

FOurth

Last
DAYofweek = ANY
DAYofweek

=

ANY

WEEKDay

WEEKEnd

SUnday

Monday

TUesday

Wednesday

THursday

Friday

SAturday

EXPiration = Never
EXPiration

=

Never

date

Parameters
schedule_name (Required)
Specifies the name of the schedule to be defined. You can specify up to 30
characters for the name.
Type=Administrative
Specifies that a schedule for an administrative command is defined. This
parameter is optional. An administrative command is assumed if the CMD
parameter is specified.
CMD (Required)
Specifies the administrative command to schedule for processing. The
maximum length of the command is 512 characters. Enclose the administrative
command in quotation marks if it contains any blank characters.
Note: You cannot specify redirection characters with this parameter.
ACTIVE
Specifies whether Tivoli Storage Manager processes an administrative
command schedule when the startup window occurs. This parameter is
optional. The default is NO. The administrative command schedule must be set
to the active state with the UPDATE SCHEDULE command so that Tivoli
Storage Manager can process the schedule. Possible values are:
YES
Specifies that Tivoli Storage Manager processes an administrative
command schedule when the startup window begins.
NO
Specifies that Tivoli Storage Manager does not process an administrative
command schedule when the startup window begins.
DESCription
Specifies a description of the schedule. This parameter is optional. You can
specify up to 255 characters for the description. Enclose the description in
quotation marks if it contains any blank characters.
PRIority
Specifies the priority value for a schedule. This parameter is optional. You can
specify an integer from 1 to 10, with 1 being the highest priority and 10 being
the lowest. The default is 5.
DEFINE SCHEDULE Administrative Command

300 IBM Tivoli Storage Manager for Windows: Administrators Reference
If two or more schedules have the same window start time, the value you
specify determines when Tivoli Storage Manager processes the schedule. The
schedule with the highest priority starts first. For example, a schedule with
PRIORITY=3 starts before a schedule with PRIORITY=5.
STARTDate
Specifies the date for the beginning of the window in which the schedule is
first processed. This parameter is optional. The default is the current date. Use
this parameter with the STARTTIME parameter to specify when the initial
startup window of the schedule starts.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified. The maximum
number of days you can specify
is 9999.
TODAY +3 or +3.

STARTTime
Specifies the time for the beginning of the window in which the schedule is
first processed. This parameter is optional. The default is the current time. This
parameter is used in conjunction with the STARTDATE parameter to specify
when the initial startup window begins.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified
NOW+02:00 or +02:00.
If you issue this command at 5:00 with
STARTTIME=NOW+02:00 or
STARTTIME=+02:00, the beginning of
the startup window is at 7:00.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW-02:00 or 02:00.
If you issue this command at 5:00 with
STARTTIME=NOW02:00 or
STARTTIME=-02:00, the beginning of
the startup window is at 3:00.

DURation
Specifies the number of units that define the length of the startup window of
the scheduled operation. This parameter is optional. This value must be from 1
to 999. The default is 1.
Use this parameter with the DURUNITS parameter to specify the length of the
startup window. For example, if you specify DURATION=20 and
DURUNITS=MINUTES, the schedule must be started within 20 minutes of the
start date and start time. The default length of the startup window is 1 hour.
The duration of the window must be shorter than the period between
windows.
DEFINE SCHEDULE Administrative Command
Chapter 2. Administrative commands 301
This value is ignored if you specify DURUNITS=INDEFINITE.
DURUnits
Specifies the time units used to determine the duration of the window in
which the schedule can start. This parameter is optional. The default is
HOURS.
Use this parameter with the DURATION parameter to specify how long the
startup window remains open to process the schedule. For example, if
DURATION=20 and DURUNITS=MINUTES, the schedule must be started
within 20 minutes of the start date and start time. The schedule may not
necessarily complete processing within this window. If the schedule needs to
be retried for any reason, the retry attempts must begin before the startup
window elapses, or the operation does not restart.
The default value for the length of the startup window is 1 hour. Possible
values are:
Minutes
Specifies that the duration of the window is defined in minutes.
Hours
Specifies that the duration of the window is defined in hours.
Days
Specifies that the duration of the window is defined in days.
INDefinite
Specifies that the startup window of the scheduled operation has an
indefinite duration. The schedule can run any time after the scheduled
start time, until the schedule expires. You cannot specify
DURUNITS=INDEFINITE, unless you specify PERUNITS=ONETIME. The
INDEFINITE value is not allowed with enhanced schedules.
SCHEDStyle
This parameter is optional. SCHEDSTYLE defines either the interval between
times when a schedule should run, or the days on which it should run. The
style can be either classic or enhanced. The default is the classic syntax.
For classic schedules, these parameters are allowed: PERIOD, PERUNITS, and
DAYOFWEEK. Not allowed for classic schedules are: MONTH,
DAYOFMONTH, and WEEKOFMONTH.
For enhanced schedules, these parameters are allowed: MONTH,
DAYOFMONTH, WEEKOFMONTH, and DAYOFWEEK. These parameters are
not allowed: PERIOD and PERUNITS.
PERiod
Specifies the length of time between startup windows for this schedule. This
parameter is optional. This parameter is used only with classic schedules. You
can specify an integer from 1 to 999. The default is 1.
Use this parameter with the PERUNITS parameter to specify the period
between startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is
scheduled every five days after the initial start date and start time. The period
between startup windows must exceed the duration of each window. The
default is 1 day.
This value is ignored if you specify PERUNITS=ONETIME.
DEFINE SCHEDULE Administrative Command

302 IBM Tivoli Storage Manager for Windows: Administrators Reference
PERUnits
Specifies the time units used to determine the period between startup windows
for this schedule. This parameter is optional. This parameter is used only with
classic schedules. The default is DAYS.
Use this parameter with the PERIOD parameter to specify the period between
startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is
scheduled every 5 days after the initial start date and start time. The default is
1 day. Possible values are:
Hours
Specifies that the time between startup windows is in hours.
Days
Specifies that the time between startup windows is in days.
Weeks
Specifies that the time between startup windows is in weeks.
Months
Specifies that the time between startup windows is in months.
Note: When you specify PERUNITS=MONTHS, the scheduled operation
will be processed each month on the same date. For example, if the
start date for the scheduled operation is 02/04/1998, the schedule
will process on the 4th of every month thereafter. However, if the
date is not valid for the next month, then the scheduled operation
will be processed on the last valid date in the month. Thereafter,
subsequent operations are based on this new date. For example, if
the start date is 03/31/1998, the next months operation will be
scheduled for 04/30/1998. Thereafter, all subsequent operations will
be on the 30th of the month until February. Because February has
only 28 days, the operation will be scheduled for 02/28/1999.
Subsequent operations will be processed on the 28th of the month.
Years
Specifies that the time between startup windows for the schedule is in
years.
Note: When you specify PERUNITS=YEARS, the scheduled operation will
be processed on the same month and date of each year. For example,
if the start date for the scheduled operation is 02/29/2004, the next
years scheduled operation will be 02/28/2005 because February
only has 28 days. Thereafter, subsequent operations will be
scheduled for February 28th.
Onetime
Specifies that the schedule processes once. This value overrides the value
you specified for the PERIOD parameter.
DAYofweek
Specifies the day of the week on which the startup window for the schedule
begins. This parameter is optional. You can specify different options for the
DAYofweek parameter, depending on whether the schedule style has been
defined as Classic or Enhanced:
Classic Schedule
Specifies the day of the week on which the startup window for the
schedule begins. This parameter is optional. You can either specify one
DEFINE SCHEDULE Administrative Command
Chapter 2. Administrative commands 303
day of the week, or WEEKDAY, WEEKEND, or ANY. If the start date
and start time fall on a day that does not correspond to a day you
specify, the start date and start time will be shifted forward in 24hour
increments until the DAYOFWEEK parameter is satisfied.
If you select a value for DAYOFWEEK other than ANY, and depending
on the values for PERIOD and PERUNITS, schedules may not be
processed when you would expect. The default is ANY.
Enhanced Schedule
Specifies the days of the week on which to run the schedule. You can
either specify multiple days separated by commas and no intervening
blanks, or WEEKDAY, WEEKEND, or ANY. If you specify multiple
days, the schedule will run on each of the specified days. If you
specify WEEKDAY or WEEKEND, you must also specify either
WEEKOFMONTH=FIRST or WEEKOFMONTH=LAST, and the
schedule will run just once per month.
The default value is ANY, meaning the schedule will run every day of
the week or on the day or days determined by other enhanced
schedule parameters. DAYOFWEEK must have a value of ANY (either
by default or specified with the command) when used with the
DAYOFMONTH parameter.
Possible values for the DAYofweek parameter are:
ANY
Specifies that the startup window can begin on any day of the week.
WEEKDay
Specifies that the startup window can begin on Monday, Tuesday,
Wednesday, Thursday, or Friday.
WEEKEnd
Specifies that the startup window can begin on Saturday or Sunday.
SUnday
Specifies that the startup window begins on Sunday.
Monday
Specifies that the startup window begins on Monday.
TUesday
Specifies that the startup window begins on Tuesday.
Wednesday
Specifies that the startup window begins on Wednesday.
THursday
Specifies that the startup window begins on Thursday.
Friday
Specifies that the startup window begins on Friday.
SAturday
Specifies that the startup window begins on Saturday.
MONth
Specifies the months of the year during which to run the schedule. This
parameter is used only with enhanced schedules. Specify multiple values by
using commas and no intervening blanks. The default value is ANY. This
means the schedule will run during every month of the year.
DEFINE SCHEDULE Administrative Command

304 IBM Tivoli Storage Manager for Windows: Administrators Reference
DAYOFMonth
Specifies the day of the month to run the schedule. This parameter is used
only with enhanced schedules. You can either specify ANY or a number from
-31 through 31, excluding zero. Negative values are a day from the end of the
month, counting backwards. For example, the last day of the month is -1, the
next-to-the-last day of the month is -2, etc. You can specify multiple values
separated by commas and no intervening blanks. If you specify multiple
values, the schedule will run on each of the specified days of the month. If
multiple values resolve to the same day, the schedule will run only once that
day.
The default value is ANY This means the schedule will run on every day of
the month or on the days determined by other enhanced schedule parameters.
DAYOFMONTH must have a value of ANY (either by default or specified with
the command) when used with the DAYOFWEEK or WEEKOFMONTH
parameters.
WEEKofmonth
Specifies the week of the month in which to run the schedule. This parameter
is used only with enhanced schedules. A week is considered any seven-day
period which does not start on a particular day of the week. You can specify
FIRST, SECOND, THIRD, FOURTH, LAST, or ANY. You can specify multiple
values separated by commas and no intervening blanks. If you specify multiple
values, the schedule will run during each of the specified weeks of the month.
If multiple values resolve to the same week, the schedule will run only once
during that week.
The default value is ANY, meaning the schedule will run during every week of
the month or on the day or days determined by other enhanced schedule
parameters. WEEKOFMONTH must have a value of ANY (either by default or
specified with the command) when used with the DAYOFMONTH parameter.
EXPiration
Specifies the date after which this schedule is no longer used. This parameter
is optional. The default is NEVER. Possible values are:
Never
Specifies that the schedule never expires.
expiration_date
Specifies the date on which this schedule expires, in MM/DD/YYYY
format. If you specify an expiration date, the schedule expires at 23:59:59
on the date you specify.
Examples
Task 1
Define a schedule named BACKUP_ARCHIVEPOOL that backs up the primary
storage pool ARCHIVEPOOL to the copy storage pool RECOVERYPOOL. The
backup runs at 8 p.m. every two days.
Command
define schedule backup_archivepool type=administrative
cmd="backup stgpool archivepool recoverypool"
active=yes starttime=20:00 period=2
Examples
Task 2
DEFINE SCHEDULE Administrative Command
Chapter 2. Administrative commands 305
Define a schedule named BACKUP_ARCHIVEPOOL that backs up the primary
storage pool ARCHIVEPOOL to the copy storage pool RECOVERYPOOL. Select an
enhanced schedule and run on the first and fifteenth day of the month.
Command
define schedule backup_archivepool type=administrative
cmd="backup stgpool archivepool recoverypool"
schedstyle=enhanced dayofmonth=1,15
DEFINE SCHEDULE Administrative Command

306 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE SCRIPT (Define a Tivoli Storage Manager script)
Use this command to define a Tivoli Storage Manager script or to create a new
Tivoli Storage Manager script using the contents from another script.
The first line for the script may be defined with this command. To add subsequent
lines to the script, use the UPDATE SCRIPT command.
Note:
1. The Administration Center only supports ASCII characters for input. If
you need to enter characters that are not ASCII, issue the DEFINE
SCRIPT and UPDATE SCRIPT commands from the server console.
2. When routing commands inside scripts, enclose the server or server
group in parentheses and omit the colon. Otherwise, if the syntax
includes a colon, the command is not routed when the RUN command is
issued. Instead, the command will only run on the server from which the
RUN command is issued. For more information, see Performing tasks
concurrently on multiple servers on page 15.
Privilege class
To issue this command, you must have operator, policy, storage, or system
privilege.
Syntax

DEFine SCRipt

script_name
Line = 001
command_line

Line

=

number

File

=

file_name

DESCription

=

description


Parameters
script_name (Required)
Specifies the name of the script to be defined. You can specify up to 30
characters for the name.
command_line
Specifies the first command to be processed in a script. You must specify either
this parameter (and, optionally, the LINE parameter) or the FILE parameter.
The command you specify can include substitution variables and can be
continued across multiple lines if you specify a continuation character (-) as the
last character in the command. Substitution variables are specified with a $
character, followed by a number that indicates the value of the parameter
when the script is processed. You can specify up to 1200 characters for the
command line. Enclose the command in quotation marks if it contains blanks.
Conditional logic flow statements can be used. These statements include IF,
EXIT, and GOTO. For more information, see the Administrators Guide. For
return codes used with the IF statement, see Appendix A, Return codes for
use in IBM Tivoli Storage Manager scripts, on page 1395.
DEFINE SCRIPT
Chapter 2. Administrative commands 307
Line
Specifies the line number for the command line. Because commands are
specified in multiple lines, line numbers are used to determine the order
for processing when the script is run. The first line, or line 001 is the
default. This parameter is optional.
File
Specifies the name of the file whose contents will be read into the script to be
defined. The file must reside on the server running this command. If you
specify the FILE parameter, you cannot specify a command line or line
number.
You can create a script by querying another script and specifying the
FORMAT=RAW and OUTPUTFILE parameters. The output from querying the
script is directed to a file you specify with the OUTPUTFILE parameter. To
create the new script, the contents of the script to be defined are read in from
the file you specified with the OUTPUTFILE parameter.
DESCription
Specifies a description for the script. You can specify up to 255 characters for
the description. Enclose the description in quotation marks if it contains blank
characters. This parameter is optional.
Examples
Task 1
Define a script that will display all AIX clients.
Command
define script qaixc "select node_name from nodes where platform_name=AIX"
desc=Display aix clients
Task 2
Define and run a script that will route the QUERY STGPOOL command to a server
group named DEV_GROUP.
1. Define the script:
Command
define script qu_stg "(dev_group) query stgpool"
2. Run the script:
Command
run qu_stg
Task 3
Define a script whose command lines are read in from a file that is named
MY.SCRIPT and name the new script AGADM.
Command
define script agadm file=my.script
DEFINE SCRIPT

308 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
Related commands
Table 95. Commands related to DEFINE SCRIPT
Command Description
COPY SCRIPT Creates a copy of a script.
DELETE SCRIPT Deletes the script or individual lines from the
script.
QUERY SCRIPT Displays information about scripts.
RENAME SCRIPT Renames a script to a new name.
RUN Runs a script.
UPDATE SCRIPT Changes or adds lines to a script.

DEFINE SCRIPT
Chapter 2. Administrative commands 309
DEFINE SERVER (Define a server for server-to-server
communications)
Use this command to define a server.
Use this command to define a server for the following functions:
v Enterprise configuration
v Enterprise event logging
v Command routing
v Virtual volumes
Note: The use of virtual volumes is not supported when the source server and
the target server are the same Tivoli Storage Manager server.
This command also is used to define an IBM Tivoli Storage Manager storage agent
as if it were a server.
Privilege class
To issue this command, you must have system privilege.
Syntax
For Enterprise Configuration, Enterprise Event Logging, Command Routing, and
Storage Agent:
DEFine SERver server_name SERVERPAssword = password
HLAddress = ip_address LLAddress = tcp_port
COMMmethod

=

TCPIP

URL

=

url

DESCription

=

description

(1)
CROSSDEFine

=

No

CROSSDEFine

=

No

Yes
(2)
VALIdateprotocol

=

No

VALIdateprotocol

=

No

All

Notes:
1 The CROSSDEFINE parameter does not apply to storage agent definitions.
2 The VALIDATEPROTOCOL parameter only applies to storage agent
definitions.
DEFINE SERVER

310 IBM Tivoli Storage Manager for Windows: Administrators Reference
Syntax
For Virtual Volumes:
DEFine SERver server_name PAssword = password
HLAddress = ip_address LLAddress = tcp_port
COMMmethod

=

TCPIP

URL

=

url

DELgraceperiod

=

days

NODEName

=

node_name

DESCription

=

description


Parameters
server_name (Required)
Specifies the name of the server. This name must be unique on the server. The
maximum length of this name is 64 characters.
For command routing and server-to-server event logging functions, the server
name you specify here should match the name that was set using the SET
SERVERNAME command at the target server.
PAssword (Required)
Specifies the password used to sign on to the target server for virtual volumes.
If you specify the NODENAME parameter, you must specify the PASSWORD
parameter. If you specify the PASSWORD parameter but not the NODENAME
parameter, the node name defaults to the server name specified with the SET
SERVERNAME command.
SERVERPAssword
Specifies the password of the server you are defining. This password must
match the password set by the SET SERVERPASSWORD command. This
parameter is required for enterprise configuration, command routing, and
server-to-server event logging functions.
Note: Command routing uses the ID and password of the Administrator
issuing the command.
HLAddress (Required)
Specifies the IP address (in dotted decimal format) of the server.
Note: Do not use the loopback address as the value of this parameter. Virtual
volumes are not supported when the source server and the target server
are the same Tivoli Storage Manager server.
LLAddress (Required)
Specifies the low-level address of the server. This address is usually the same
as that in the TCPPORT server option of the target server.
COMMmethod
Specifies the communication method used to connect to the server. This
parameter is optional.
URL
Specifies the URL address of this server. The parameter is optional.
DEFINE SERVER
Chapter 2. Administrative commands 311
DELgraceperiod
Specifies a number of days that an object remains on the target server after it
has been marked for deletion. Possible values are 0-9999. The default is 5. This
parameter is optional.
NODEName
Specifies a node name to be used by the server to connect to the target server.
This parameter is optional. If you specify the NODENAME parameter, you
must also specify the PASSWORD parameter. If you specify the PASSWORD
parameter but not the NODENAME parameter, the node name defaults to the
server name specified with the SET SERVERNAME command.
DESCription
Specifies a description of the server. The parameter is optional. The description
can be up to 255 characters. Enclose the description in quotation marks if it
contains blank characters.
CROSSDEFine
Specifies whether the server running this command will define itself to the
server being specified by this command. This parameter is optional.
Note: This parameter does not apply to storage agent definitions.
If this parameter is included, you must also issue the SET SERVERNAME, SET
SERVERPASSWORD, SET SERVERHLADDRESS, SET CROSSDEFINE, and SET
SERVERLLADDRESS commands. The default is NO.
Possible values are:
No
Cross definition is not to be performed.
Yes
Cross definition is to be performed.
VALIdateprotocol
Specify whether a cyclic redundancy check should be performed to validate
the data sent between the storage agent and Tivoli Storage Manager server.
The parameter is optional. The default is NO. Possible values are:
No
Specifies that data validation not be performed on any data sent between
the storage agent and server.
All
Specifies that data validation be performed on all client file data, client file
metadata, and Tivoli Storage Manager server metadata that is sent between
the storage agent and server. This mode impacts performance as additional
overhead is required to calculate and compare CRC values between the
storage agent and the server.
Examples
Task 1
A target server has a high-level address of 9.116.2.67 and a low-level address of
1570. Define that target server to the source server, name it SERVER2, set the
password to SECRET, and specify that objects remain on the target server for 7
days after they have been marked for deletion.
Command
DEFINE SERVER

312 IBM Tivoli Storage Manager for Windows: Administrators Reference
define server server2 password=secret
hladdress=9.115.3.45 lladdress=1570 delgraceperiod=7
Task 2
Define a server to enable it to receive commands routed from other servers. Name
the server WEST_COMPLEX, set the password to CACTUS, and set the high-level
address to 9.283.299, the low-level address to 1500, and the URL address to
http://west_complex:1580/.
Command
define server west_complex serverpassword=cactus
hladdress=9.283.299 lladdress=1500
url=http://west_complex:1580/
Task 3
Use cross definition to define SERVER_A and SERVER_B.
Command
1. On SERVER_B, specify the server name, password, and high- and
low-level addresses of SERVER_B. Specify that cross defining is
allowed.
set servername server_b
set serverpassword mylife
set serverhladdress 9.115.20.80
set serverlladdress 1860
set crossdefine on
2. On SERVER_A, specify the server name, password, and high- and
low-level addresses of SERVER_A.
set servername server_a
set serverpassword yourlife
set serverhladdress 9.115.20.97
set serverlladdress 1500
3. On SERVER_A, define SERVER_B:
define server server_b hladdress=9.115.20.80 lladdress=1860
serverpassword=mylife crossdefine=yes
Related commands
Table 96. Commands related to DEFINE SERVER
Command Description
DEFINE DEVCLASS Defines a device class.
DELETE DEVCLASS Deletes a device class name.
DELETE FILESPACE Deletes data associated with clients file
spaces.
DELETE SERVER Deletes the definition of a server.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY SERVER Displays information about servers.
RECONCILE VOLUMES Reconciles source server virtual volume
definitions and target server archive objects.
REGISTER NODE Defines a client to the server and sets options
for that user.
DEFINE SERVER
Chapter 2. Administrative commands 313
Table 96. Commands related to DEFINE SERVER (continued)
Command Description
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
SET CROSSDEFINE Specifies whether to cross define servers.
SET SERVERNAME Specifies the name by which the server is
identified.
SET SERVERHLADDRESS Specifies the high-level address of a server.
SET SERVERLLADDRESS Specifies the low-level address of a server.
SET SERVERPASSWORD Specifies the server password.
UPDATE DEVCLASS Changes the attributes of a device class.
UPDATE NODE Changes the attributes associated with a
client node.
UPDATE SERVER Updates information about a server.

DEFINE SERVER

314 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE SERVERGROUP (Define a server group)
Use this command to define a server group. A server group lets you route
commands to multiple servers by specifying only the group name. After defining
the server group, add servers to the group by using the DEFINE GRPMEMBER
command.
Privilege class
To issue this command, you must have system privilege.
Syntax
DEFine SERVERGRoup group_name
DESCription

=

description


Parameters
group_name (Required)
Specifies the name of the server group. The maximum length of the name is 64
characters.
DESCription
Specifies a description of the server group. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters.
Examples
Task
Define a server group named WEST_COMPLEX.
Command
define servergroup west_complex
Related commands
Table 97. Commands related to DEFINE SERVERGROUP
Command Description
COPY SERVERGROUP Creates a copy of a server group.
DEFINE GRPMEMBER Defines a server as a member of a server
group.
DELETE GRPMEMBER Deletes a server from a server group.
DELETE SERVERGROUP Deletes a server group.
MOVE GRPMEMBER Moves a server group member.
QUERY SERVERGROUP Displays information about server groups.
RENAME SERVERGROUP Renames a server group.
UPDATE SERVERGROUP Updates a server group.

DEFINE SERVERGROUP
Chapter 2. Administrative commands 315
DEFINE SPACETRIGGER (Define the space trigger)
Use this command to define settings for triggers that determine when and how
Tivoli Storage Manager prepares additional space when predetermined thresholds
have been exceeded in the database and recovery logs, and in storage pools that
use FILE and DISK device classes. For storage pools with a parameter
RECLAMATIONTYPE=SNAPLOCK, space triggers are not enabled.
Tivoli Storage Manager allocates more space when space utilization reaches a
specified value. After allocating more space, Tivoli Storage Manager takes the
appropriate action to use the space. For the database and recovery log, Tivoli
Storage Manager automatically extends the database or recovery log to make use
of the new space. For storage pools, Tivoli Storage Manager adds the space to the
associated pool. Storage pools using disk storage (either the random-access DISK
device class, or the sequential-access FILE device type) can be specified for use
with space triggers.
Attention: Space trigger functions and storage pool space calculations take into
account the space remaining in each directory. Ideally, you should associate each
directory with a separate file system. If you specify multiple directories for a
device class and the directories reside in the same file system, the server will
calculate space by adding values representing the space remaining in each
directory. These space calculations will be inaccurate. Rather than choosing a
storage pool with sufficient space for an operation, the server could choose the
wrong storage pool and run out of space prematurely. For space triggers, an
inaccurate calculation could result in a failure to expand the space available in a
storage pool. Failure to expand space in a storage pool is one of the conditions that
can cause a trigger to become disabled. If a trigger is disabled because the space in
a storage pool could not be expanded, you can re-enable the trigger by specifying
the following command: update spacetrigger stg. No further changes are
required to the space trigger.
If the database or recovery log volumes are mirrored, Tivoli Storage Manager tries
to create new mirrored copies when the utilization percentage is reached. The
number of mirrored copies will be the same as the maximum number of mirrors
defined for any existing volumes. If sufficient disk space is not available, Tivoli
Storage Manager creates a database or recovery log volume without a mirrored
copy.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax

DEFine SPACETrigger

DB

LOG

STG
Fullpct = 80
Fullpct

=

percent

SPACEexpansion = 20
SPACEexpansion

=

percent

EXPansionprefix

=

prefix

DEFINE SPACETRIGGER

316 IBM Tivoli Storage Manager for Windows: Administrators Reference

MIRRORprefixes

=

prefix

prefix 1, prefix 2

MAXimumsize

=

megabytes

STGPOOL

=

storage_pool_name


Parameters
DB
Specifies a database space trigger.
LOG
Specifies a recovery log space trigger.
STG
Specifies a storage pool space trigger.
Fullpct
For database and recovery log space triggers, this parameter specifies a space
utilization percentage of the database or recovery log. When this value is
reached, Tivoli Storage Manager tries to allocate more space. This parameter is
optional. Specify an integer value from 0 to 99. The default is 80. A value of
zero (0) disables the space trigger.
Note: The database and recovery log utilization percentage may exceed the
FULLPCT space trigger value. The server checks utilization after a
database or recovery log commit. Deleting database volumes and
reducing the database does not activate the trigger. Therefore, the
utilization percentage can exceed the set value before new volumes are
online.
For storage pool space triggers, this parameter specifies the utilization
percentage of the storage pool. When this value is exceeded, the space trigger
creates new volumes. Exceeding the threshold may not cause new volumes to
be created until the next space request is made.
You can determine storage pool utilization by issuing the QUERY STGPOOL
command with FORMAT=DETAILED. The percentage of storage pool
utilization for the storage pool is displayed in the field Space Trigger Util.
The calculation for this percentage does not include potential scratch volumes.
The calculation for the percentage utilization used for migration and
reclamation, however, does include potential scratch volumes.
SPACEexpansion
For database and recovery log space triggers, this parameter specifies, as a
percentage of the current size, the amount by which the database or recovery
log can be increased. Specify an integer from 0 to 200. The default is 20. The
database must be at least 4MB (5MB file with processing space); the recovery
log must be at least 8MB (9MB file with processing space). New database or
recovery log volumes must be multiples of 5MB or 9MB respectively. A value
of zero (0) disables expansion.
For space triggers for sequential-access FILE-type storage pools, this parameter
is used in determining the number of additional volumes that Tivoli Storage
Manager creates in the storage pool. Volumes are created using the
MAXCAPACITY value from the storage pools device class.
DEFINE SPACETRIGGER
Chapter 2. Administrative commands 317
For space triggers for random-access DISK storage pools, the space trigger
creates a single volume using the EXPANSIONPREFIX.
EXPansionprefix
For space triggers for databases, recovery logs, and random-access DISK
storage-pools, this specifies the prefix that Tivoli Storage Manager uses to
create new database, recovery log, or storage pool files.
The prefix can include one or more directory separator characters, for example,
c:\program files\tivoli\tsm\. You can specify up to 200 characters. If you
specify an invalid prefix, automatic expansion can fail.
This parameter is not valid for space triggers for sequential-access FILE storage
pools. For sequential storage pool space triggers, prefixes are obtained from the
directories specified with the associated device class.
This is an optional parameter. The default prefix is the Tivoli Storage Manager
installation path.If Tivoli Storage Manager server is running as a Windows
service, the default prefix is the c:\wnnt\system32 directory.
MIRRORprefixes
Specifies the prefix or prefixes that Tivoli Storage Manager uses to create new
files for database or recovery log copy volumes. A prefix can include one or
more directory separator characters (for example, c:\program
files\tivoli\tsm\). You can specify up to 200 characters. If you specify an
invalid prefix, automatic expansion can fail. Only one or two copy volumes
can be created per database or recovery log space trigger. Therefore, you can
specify only one or two prefixes. If you specify one prefix and two copy
volumes are created, that single prefix will be used for both copy volumes. If
you specify two prefixes, each prefix will be used in creating a single copy
volume.
This is an optional parameter. The default prefix is the value of the
EXPANSIONPREFIX, if specified. If not specified, the default is Tivoli Storage
Manager installation path. If Tivoli Storage Manager server is running as a
Windows service, the default prefix is the c:\wnnt\system32 directory.
MAXimumsize
Specifies the maximum size, in megabytes, of the database or recovery log.
When this size is reached, expansion stops, and Tivoli Storage Manager issues
a message. This parameter is optional. Specify a value from 9 to 13000 (13GB)
for the recovery log, or from 4 to 530000 (530GB) for the database. A value of
zero (0) or omitting this parameter disables checking for maximum size.
Increasing the size of the recovery log significantly can increase the time
required to restart the server, back up the database, and restore the database.
This parameter does not apply to storage pool space triggers.
Note: The database and the recovery log size may exceed the specified
MAXIMUMSIZE value. This value is a threshold for expansion. Tivoli
Storage Manager checks the size and allows expansion if the database or
the recovery log is less than the maximum size. Tivoli Storage Manager
will not automatically expand the database or the recovery log if either
is greater than the maximum size. However, Tivoli Storage Manager
only checks the size that results after expansion to ensure that the
maximum recovery log size is not exceeded.
STGPOOL
Specifies the storage pool associated with this space trigger. This parameter
does not apply to database and recovery log space triggers, and it is optional
for storage pool space triggers. If the STG parameter is specified but STGPOOL
DEFINE SPACETRIGGER

318 IBM Tivoli Storage Manager for Windows: Administrators Reference
is not, one space trigger is created that applies to all random-access DISK and
sequential-access FILE storage pools that do not have a specific space trigger.
This parameter does not apply to storage pools with the parameter
RECLAMATIONTYPE=SNAPLOCK.
Examples
Task
Set the database space trigger to 80 percent. When the database reaches this value,
allocate a volume that is twice the current size. Use space in the j:\adsmserv\
directory.
Command
define spacetrigger db spaceexpansion=100 expansionprefix=j:\adsmserv\
Task
Set the database space trigger to 80 percent. When the database reaches this value,
allocate a volume that is twice the current size. Use space in the j:\adsmserv\
directory. Create copy volumes in separate directories.
Command
define spacetrigger db spaceexpansion=100
expansionprefix=j:\adsmserv\
mirrorprefixes="k:\adsmserv\,l:\adsmserv\"
Task
Setup a storage pool space trigger for increasing the amount of space in a storage
pool by 25 percent when it is filled to 80 percent utilization of existing volumes.
Space will be created in the directories associated with the device class.
Command
define spacetrigger stg spaceexpansion=25 stgpool=file
Task
Setup a space trigger for the WINPOOL1 storage pool to increase the amount of
space in the storage pool by 40 percent when it is filled to 80 percent utilization of
existing volumes.
Command
define spacetrigger stg spaceexpansion=40 stgpool=winpool1
Related commands
Table 98. Commands related to DEFINE SPACETRIGGER
Command Description
DEFINE LOGVOLUME Defines a disk volume to the recovery log.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
DELETE SPACETRIGGER Deletes the database or recovery log space
trigger.
QUERY SPACETRIGGER Displays information about the database or
recovery log space trigger.
DEFINE SPACETRIGGER
Chapter 2. Administrative commands 319
Table 98. Commands related to DEFINE SPACETRIGGER (continued)
Command Description
UPDATE SPACETRIGGER Changes attributes of the database or
recovery log space trigger.

DEFINE SPACETRIGGER

320 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE STGPOOL (Define a storage pool)
Use this command to define a primary storage pool, copy storage pool, or an
active-data pool. A primary storage pool provides a destination for backup files,
archive files, or files migrated from client nodes. A copy storage pool provides a
destination for backup copies of files that are in primary storage pools. An
active-data pool provides a destination for active versions of backup data that are
in primary storage pools.
All volumes in a storage pool belong to the same device class. Random access
storage pools use the DISK device type. After you define a random access storage
pool, you must define volumes for the pool to create storage space.
Sequential access storage pools use device classes that you define for tape devices,
optical devices, files on disk (FILE device type), and storage on another server
(SERVER device type). To create storage space in a sequential access storage pool,
you must allow scratch volumes for the pool when you define or update it, or
define volumes for the pool after you define the pool. You can also do both.
The DEFINE STGPOOL command takes four forms:
v Defining a primary storage pool assigned to random access devices
v Defining a primary storage pool assigned to sequential access devices
v Defining a copy storage pool (always assigned to sequential access devices)
v Defining an active-data pool (always assigned to sequential access devices)
The syntax and parameters for each form are defined separately.
Table 99. Commands related to DEFINE STGPOOL
Command Description
BACKUP DB Backs up the IBM Tivoli Storage Manager
database to sequential access volumes.
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
COPY ACTIVEDATA Copies active backup data.
DEFINE COLLOCGROUP Defines a collocation group.
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
DEFINE DEVCLASS Defines a device class.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
DELETE COLLOCGROUP Deletes a collocation group.
DELETE COLLOCMEMBER Deletes a client node from a collocation
group.
DELETE STGPOOL Deletes a storage pool from server storage.
MOVE DATA Moves data from a specified storage pool
volume to another storage pool volume.
MOVE MEDIA Moves storage pool volumes that are
managed by an automated library.
QUERY COLLOCGROUP Displays information about collocation
groups.
QUERY DEVCLASS Displays information about device classes.
DEFINE STGPOOL
Chapter 2. Administrative commands 321
Table 99. Commands related to DEFINE STGPOOL (continued)
Command Description
QUERY NODEDATA Displays information about the location and
size of data for a client node.
QUERY SHREDSTATUS Displays information about data waiting to
be shredded.
QUERY STGPOOL Displays information about storage pools.
RENAME STGPOOL Renames a storage pool.
RESTORE STGPOOL Restores files to a primary storage pool from
copy storage pools.
RESTORE VOLUME Restores files stored on specified volumes in
a primary storage pool from copy storage
pools.
SET DRMPRIMSTGPOOL Specifies that primary storage pools are
managed by DRM.
SHRED DATA Manually starts the process of shredding
deleted data.
UPDATE COLLOCGROUP Updates the description of a collocation
group.
UPDATE STGPOOL Changes the attributes of a storage pool.
DEFINE STGPOOL

322 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE STGPOOL primary random access
Use this command to define a primary storage pool assigned to random access
devices.
Privilege class
To issue this command, you must have system privilege.
Syntax

DEFine STGpool

pool_name

DISK
POoltype = PRimary
POoltype

=

PRimary

DESCription

=

description
ACCess = READWrite
ACCess

=

READWrite

READOnly

UNAVailable

MAXSIze = NOLimit
MAXSIze

=

maximum_file_size
CRCData = No
CRCData

=

Yes

No

NEXTstgpool

=

pool_name
HIghmig = 90
HIghmig

=

percent

LOwmig = 70
LOwmig

=

percent
CAChe = No
CAChe

=

Yes

No
MIGPRocess = 1
MIGPRocess

=

number

MIGDelay = 0
MIGDelay

=

days
MIGContinue = Yes
MIGContinue

=

Yes

No

,

COPYContinue

=

Yes

COPYSTGpools

=

copy_pool_name

COPYContinue

=

Yes

No

,

ACTIVEDATApools

=

active-data_pool_name

SHRED = 0
(1)

SHRED

=

overwrite_count

DEFINE STGPOOL Primary Random Access
Chapter 2. Administrative commands 323
Notes:
1 This parameter is not available for Centera or SnapLock storage pools.
Parameters
pool_name (Required)
Specifies the name of the storage pool to be defined. The name must be
unique, and the maximum length is 30 characters.
DISK (Required)
Specifies that you want to define a storage pool to the DISK device class (the
DISK device class is predefined during installation).
POoltype=PRimary
Specifies that you want to define a primary storage pool. This parameter is
optional. The default value is PRIMARY.
DESCription
Specifies a description of the storage pool. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters.
ACCess
Specifies how client nodes and server processes (such as migration and
reclamation) can access files in the storage pool. This parameter is optional.
The default value is READWRITE. Possible values are:
READWrite
Specifies that client nodes and server processes can read and write to files
stored on volumes in the storage pool.
READOnly
Specifies that client nodes can only read files from the volumes in the
storage pool.
Server processes can move files within the volumes in the storage pool.
However, no new writes are permitted to volumes in the storage pool from
volumes outside the storage pool.
If this storage pool has been specified as a subordinate storage pool (with
the NEXTSTGPOOL parameter) and is defined as readonly, the storage pool
is skipped when server processes attempt to write files to the storage pool.
UNAVailable
Specifies that client nodes cannot access files stored on volumes in the
storage pool.
Server processes can move files within the volumes in the storage pool and
can also move or copy files from this storage pool to another storage pool.
However, no new writes are permitted to volumes in the storage pool from
volumes outside the storage pool.
If this storage pool has been specified as a subordinate storage pool (with
the NEXTSTGPOOL parameter) and is defined as unavailable, the storage
pool is skipped when server processes attempt to write files to the storage
pool.
MAXSIze
Specifies the maximum size for a physical file that the server can store in the
storage pool. This parameter is optional. The default value is NOLIMIT.
Possible values are:
DEFINE STGPOOL Primary Random Access

324 IBM Tivoli Storage Manager for Windows: Administrators Reference
NOLimit
Specifies that there is no maximum size limit for physical files stored in the
storage pool.
maximum_file_size
Limits the maximum physical file size. Specify an integer from 1 to 999999,
followed by a scale factor. For example, MAXSIZE=5G specifies that the
maximum file size for this storage pool is 5 gigabytes. Scale factors are:

Scale factor Meaning
K kilobyte
M megabyte
G gigabyte
T terabyte

If a file exceeds the maximum size and no pool is specified as the next storage
pool in the hierarchy, the server does not store the file. If a file exceeds the
maximum size and a pool is specified as the next storage pool, the server
stores the file in the next storage pool that can accept the file size. If you
specify the next storage pool parameter, at least one storage pool in your
hierarchy should have no limit on the maximum size of a file. By having no
limit on the size for at least one pool, you ensure that no matter what its size,
the server can store the file.
For logical files that are part of an aggregate, the server considers the size of
the aggregate to be the file size. Therefore, the server does not store logical
files that are smaller than the maximum size limit if the files are part of an
aggregate that is larger than the maximum size limit.
CRCData
Specifies whether a cyclic redundancy check (CRC) validates storage pool data
when audit volume processing occurs on the server. This parameter is optional.
The default value is NO. By setting CRCDATA to YES and scheduling an
AUDIT VOLUME command you can continually ensure the integrity of data
stored in your storage hierarchy. Possible values are:
Yes
Specifies that data is stored containing CRC information, allowing for audit
volume processing to validate storage pool data. This mode impacts
performance because additional overhead is required to calculate and
compare CRC values between the storage pool and the server.
No
Specifies that data is stored without CRC information.
NEXTstgpool
Specifies a primary storage pool to which files are migrated. This parameter is
optional.
If you do not specify a next storage pool, the server cannot migrate files from
this storage pool and cannot store files that exceed the maximum size for this
storage pool in another storage pool.
You cannot create a chain of storage pools that leads to an endless loop
through the NEXTSTGPOOL parameter. At least one storage pool in the
hierarchy must have no value specified for NEXTSTGPOOL.
HIghmig
Specifies that the server starts migration for this storage pool when the amount
DEFINE STGPOOL Primary Random Access
Chapter 2. Administrative commands 325
of data in the pool reaches this percentage of the pools estimated capacity.
This parameter is optional. You can specify an integer from 0 to 100. The
default value is 90.
When the storage pool exceeds the high migration threshold, the server can
start migration of files by node, to the next storage pool, as defined with the
NEXTSTGPOOL parameter. You can specify HIGHMIG=100 to prevent
migration for this storage pool.
LOwmig
Specifies that the server stops migration for this storage pool when the amount
of data in the pool reaches this percentage of the pools estimated capacity.
This parameter is optional. You can specify an integer from 0 to 99. The default
value is 70.
When the storage pool reaches the low migration threshold, the server does
not start migration of another nodes files. Because all file spaces that belong to
a node are migrated together, the occupancy of the storage pool can fall below
the value you specified for this parameter. You can set LOWMIG=0 to permit
migration to empty the storage pool.
CAChe
Specifies whether the migration process leaves a cached copy of a file in this
storage pool after migrating the file to the next storage pool. This parameter is
optional. The default value is NO. Possible values are:
Yes
Specifies that caching is enabled.
No
Specifies that caching is disabled.
Using cache may improve the retrievability of files, but may affect the
performance of other processes. See the Administrators Guide for details.
MIGPRocess
Specifies the number of processes that the server uses for migrating files from
this storage pool. This parameter is optional. You can specify an integer from 1
to 999. The default value is 1.
During migration, the server runs this number of processes in parallel to
provide the potential for improved migration rates.
Note: The number of migration processes is dependent upon the setting of the
MIGPROCESS parameter and the number of nodes or the number of
collocation groups with data in the migrating storage pool. For example,
if the MIGPROCESS parameter is equal to six, but there are only two
nodes with data on the storage pool, migration processing only consists
of two processes, not six.
MIGDelay
Specifies the minimum number of days a file must remain in a storage pool
before it becomes eligible for migration. To calculate a value to compare to the
specified MIGDELAY value, the server counts the number of days that the file
has been in the storage pool and the number of days, if any, since the file was
retrieved by a client. The lesser of the two values is compared to the specified
MIGDELAY value. For example, if all the following conditions are true, a file is
not migrated:
v A file has been in a storage pool for five days.
v The file was accessed by a client within the past three days.
DEFINE STGPOOL Primary Random Access

326 IBM Tivoli Storage Manager for Windows: Administrators Reference
v The value specified for the MIGDELAY parameter is four days.
This parameter is optional. You can specify an integer from 0 to 9999. The
default is 0, which means that you do not want to delay migration.
If you want the server to count the number of days based only on when a file
was stored and not when it was retrieved, use the NORETRIEVEDATE server
option.
MIGContinue
Specifies whether you allow the server to migrate files that do not satisfy the
migration delay time. This parameter is optional. The default is YES.
Because you can require that files remain in the storage pool for a minimum
number of days, the server may migrate all eligible files to the next storage
pool yet not meet the low migration threshold. This parameter allows you to
specify whether the server is allowed to continue the migration process by
migrating files that do not satisfy the migration delay time.
Possible values are:
Yes
Specifies that, when necessary to meet the low migration threshold, the
server continues to migrate files that do not satisfy the migration delay
time.
If you allow more than one migration process for the storage pool, some
files that do not satisfy the migration delay time may be migrated
unnecessarily. As one process migrates files that satisfy the migration delay
time, a second process could begin migrating files that do not satisfy the
migration delay time to meet the low migration threshold. The first process
that is still migrating files that satisfy the migration delay time might have,
by itself, caused the low migration threshold to be met.
No
Specifies that the server stops migration when no eligible files remain to be
migrated, even before reaching the low migration threshold. The server
does not migrate files unless the files satisfy the migration delay time.
COPYSTGpools
Specifies the names of copy storage pools where the server simultaneously
writes data. The COPYSTGPOOLS parameter is optional. Beginning with Tivoli
Storage Manager Version 5.3, you can specify a maximum of three copy pool
names separated by commas. (In versions earlier than Version 5.3, the
maximum number was ten.) Spaces between the names of the copy pools are
not permitted. When specifying a value for the COPYSTGPOOLS parameter,
you can also specify a value for the COPYCONTINUE parameter.
The combined total number of storage pools specified in the COPYSGTPOOLS
and ACTIVEDATAPOOLS parameters cannot exceed three.
The simultaneous write function changed in Tivoli Storage Manager Version
5.3. In Version 5.3 and later, when a data storage operation switches from a
primary storage pool to a next storage pool, the next storage pool inherits the
list of copy storage pools and the COPYCONTINUE value from the primary
storage pool. The primary storage pool is specified by the copy group of the
management class that is bound to the data. For details, refer to information
about simultaneous write in the Administrators Guide.
The server can perform simultaneous write to copy storage pools for the
following operations:
DEFINE STGPOOL Primary Random Access
Chapter 2. Administrative commands 327
v Backup and archive operations by Tivoli Storage Manager backup-archive
clients or application clients using the Tivoli Storage Manager API
v Migration operations by Hierarchical Space Management (HSM) clients
v Import operations that involve copying exported file data from external
media to a primary storage pool associated with a copy storage pool list
Note: Simultaneous write is not supported for the following store operations:
v When the operation is using LAN-free data movement. Simultaneous
write takes precedence over LAN-free operations, causing the
operations to go over the LAN. However, the simultaneous write
configuration is honored.
v NAS backup operations. If the primary storage pool specified in the
DESTINATION or TOCDESTINATION in the copy group of the
management class has copy storage pools defined, the copy storage
pools are ignored and the data is stored into the primary storage pool
only.
Attention: The function provided by the COPYSTGPOOLS parameter is not
intended to replace the BACKUP STGPOOL command. If you use the
COPYSTGPOOLS parameter, continue to use the BACKUP STGPOOL
command to ensure that the copy storage pools are complete copies of the
primary storage pool. There are cases when a copy might not be created. For
more information, see the COPYCONTINUE parameter description.
COPYContinue
Specifies how the server should react to a copy storage pool write failure for
any of the copy storage pools listed in the COPYSTGPOOLS parameter. This
parameter is optional. The default value is YES. When specifying the
COPYCONTINUE parameter, you must also specify the COPYSTGPOOLS
parameter.
This parameter has no effect on active-data pools. If a write error occurs while
writing to an active-data pool, the server will stop writing to the failing
active-data pool for the remainder of the session.
Possible values are:
Yes
If the COPYCONTINUE option is set to YES, the server will stop writing
to the failing copy pools for the remainder of the session, but continue
storing files into the primary pool and any remaining copy pools. The copy
storage pool list is active only for the life of the client session and applies
to all the primary storage pools in a particular storage pool hierarchy.
For additional information about the COPYCONTINUE parameter, refer to
the information about simultaneous write in the Administrators Guide.
No
If the COPYCONTINUE option is set to NO, the server will fail the current
transaction and discontinue the store operation.
ACTIVEDATApools
Specifies the names of active-data pools where the server simultaneously
writes data during a client backup operation. The ACTIVEDATAPOOLS
parameter is optional. Spaces between the names of the active-data pools are
not permitted.
The combined total number of storage pools specified in the COPYSGTPOOLS
and ACTIVEDATAPOOLS parameters can not exceed three.
DEFINE STGPOOL Primary Random Access

328 IBM Tivoli Storage Manager for Windows: Administrators Reference
When a data storage operation switches from a primary storage pool to a next
storage pool, the next storage pool inherits the list of active-data pools from
the destination storage pool specified in the copy group. The primary storage
pool is specified by the copy group of the management class that is bound to
the data. For details, refer to information about simultaneous write in the
Administrators Guide.
The server can perform simultaneous write to active-data pools only during
backup operations by Tivoli Storage Manager backup-archive clients or
application clients using the Tivoli Storage Manager API.
Note:
1. This parameter is available only to primary storage pools that use
NATIVE or NONBLOCK data format. This parameter is not available
for storage pools that use the following data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
2. Simultaneous write to active-data pools is not supported when the
operation is using LAN-free data movement. Simultaneous write
takes precedence over LAN-free operations, causing the operations to
go over the LAN. However, the simultaneous write configuration is
honored.
3. Simultaneous write is not supported when a NAS backup operation
is writing a TOC file. If the primary storage pool specified in the
TOCDESTINATION in the copy group of the management class has
active-data pools defined, the active-data pools are ignored and the
data is stored into the primary storage pool only.
4. You cannot use the simultaneous write function with Centera storage
devices.
5. Data being imported will not be stored in active-data pools. After an
import operation, use the COPY ACTIVEDATA command to store
the imported data in an active-data pool.
Attention: The function provided by the ACTIVEDATAPOOLS parameter is
not intended to replace the COPY ACTIVEDATA command. If you use the
ACTIVEDATAPOOLS parameter, use the COPY ACTIVEDATA command to
ensure that the active-data pools contain all active data of the primary storage
pool.
SHRED
Specifies whether data will be physically overwritten when it is deleted. This
parameter is optional. You can specify an integer from 0 to 10. The default
value is 0.
If you specify a value of 0, the Tivoli Storage Manager server will delete the
data from the database. However, the storage used to contain the data will not
be overwritten, and the data will still exist in storage until that storage is
reused for other data. It might be possible to discover and reconstruct the data
after it has been deleted.
If you specify a value greater than 0, the Tivoli Storage Manager server will
delete the data both logically and physically. The server will overwrite the
storage used to contain the data the specified number of times. This increases
the difficulty of discovering and reconstructing the data after it has been
deleted.
DEFINE STGPOOL Primary Random Access
Chapter 2. Administrative commands 329
To ensure that all copies of the data are shredded, specify a SHRED value
greater than 0 for the storage pool specified in the NEXTSTGPOOL parameter,
and do not specify either the COPYSTGPOOLS or ACTIVEDATAPOOLS.
Specifying relatively high values for the overwrite count will generally
improve the level of security, but could affect performance adversely.
Overwriting of deleted data is performed asynchronously after the delete
operation is complete. Therefore, the space occupied by the deleted data will
remain occupied for some period of time and will not be available as free
space for new data.
A SHRED value greater than zero cannot be used if the value of the CACHE
parameter is YES.
Important: After an export operation has finished identifying files for export,
any changes to the storage pool SHRED value is ignored. An
export operation that is suspended retains the original SHRED
value throughout the operation. You might want to consider
cancelling your export operation if changes to the storage pool
SHRED value jeopardize the operation. You can reissue the export
command after any needed cleanup.
Examples
Task
Define a primary storage pool, POOL1, to use the DISK device class, with caching
enabled. Limit the maximum file size to 5MB. Store any files larger than 5MB in
subordinate storage pools beginning with the PROG2 storage pool. Set the high
migration threshold to 70 percent, and the low migration threshold to 30 percent.
Command
define stgpool pool1 disk
description="main disk storage pool" maxsize=5m
highmig=70 lowmig=30 cache=yes
nextstgpool=prog2
DEFINE STGPOOL Primary Random Access

330 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
DEFINE STGPOOL primary sequential access
Use this command to define a primary storage pool assigned to sequential access
devices.
Privilege class
To issue this command, you must have system privilege.
Syntax

DEFine STGpool

pool_name

device_class_name
POoltype = PRimary
POoltype

=

PRimary

DESCription

=

description
ACCess = READWrite
ACCess

=

READWrite

READOnly

UNAVailable

MAXSIze = NOLimit
(1)

(2)

MAXSIze

=

maximum_file_size
CRCData = No
CRCData

=

Yes

(1)

No

(1)

(2)

NEXTstgpool

=

pool_name
HIghmig = 90
(1)

(2)

HIghmig

=

percent

LOwmig = 70
(1)

(2)

LOwmig

=

percent
REClaim = 60
(1)

(2)

REClaim

=

percent

RECLAIMPRocess = 1
(1)

(2)

RECLAIMPRocess

=

number

(1)

(2)

RECLAIMSTGpool

=

pool_name

RECLAMATIONType = THRESHold
(1)

(2)

(3)

RECLAMATIONType

=

THRESHold

SNAPlock
COLlocate = GRoup
(2)

COLlocate

=

No

GRoup

NODe

FIlespace

(2)
MAXSCRatch

=

number
REUsedelay = 0
(2)

REUsedelay

=

days

(1)

(2)

OVFLOcation

=

location

MIGDelay = 0
(1)

(2)

MIGDelay

=

days
MIGContinue = Yes
(1)

(2)

MIGContinue

=

No

Yes

MIGPRocess = 1
(1)

(2)

MIGPRocess

=

number
DATAFormat = NATive
(2)

(4)

DATAFormat

=

NATive

NONblock

NETAPPDump

CELERRADump

NDMPDump

DEFINE STGPOOL Primary Sequential Access

Chapter 2. Administrative commands 331

,

(1)

(2)

COPYContinue

=

Yes

COPYSTGpools

=

copy_pool_name

(1)

(2)

COPYContinue

=

Yes

No

,

ACTIVEDATApools

=

active-data_pool_name


Notes:
1 This parameter is not available for storage pools that use the data formats
NETAPPDUMP, CELERRADUMP, or NDMPDUMP.
2 This parameter is not available or is ignored for Centera storage pools.
3 The RECLAMATIONTYPE=SNAPLOCK setting is valid only for storage
pools defined to servers that are enabled for System Storage Archive
Manager. The storage pool must be assigned to a FILE device class, and the
directories specified in the device class must be NetApp SnapLock volumes.
4 The values NETAPPDUMP, CELERRADUMP, and NDMPDUMP are not valid
for storage pools defined with a FILE-type device class.
Parameters
pool_name (Required)
Specifies the name of the storage pool to be defined. The name must be
unique, and the maximum length is 30 characters.
device_class_name (Required)
Specifies the name of the device class to which this storage pool is assigned.
You can specify any device class except for the DISK device class.
POoltype=PRimary
Specifies that you want to define a primary storage pool. This parameter is
optional. The default value is PRIMARY.
DESCription
Specifies a description of the storage pool. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters.
ACCess
Specifies how client nodes and server processes (such as migration and
reclamation) can access files in the storage pool. This parameter is optional.
The default value is READWRITE. Possible values are:
READWrite
Specifies that client nodes and server processes can read and write to files
stored on volumes in the storage pool.
READOnly
Specifies that client nodes can only read files from the volumes in the
storage pool.
Server processes can move files within the volumes in the storage pool.
However, no new writes are permitted to volumes in the storage pool from
volumes outside the storage pool.
DEFINE STGPOOL Primary Sequential Access

332 IBM Tivoli Storage Manager for Windows: Administrators Reference
If this storage pool has been specified as a subordinate storage pool (with
the NEXTSTGPOOL parameter) and is defined as readonly, the storage pool
is skipped when server processes attempt to write files to the storage pool.
UNAVailable
Specifies that client nodes cannot access files stored on volumes in the
storage pool.
Server processes can move files within the volumes in the storage pool and
can also move or copy files from this storage pool to another storage pool.
However, no new writes are permitted to volumes in the storage pool from
volumes outside the storage pool.
If this storage pool has been specified as a subordinate storage pool (with
the NEXTSTGPOOL parameter) and is defined as unavailable, the storage
pool is skipped when server processes attempt to write files to the storage
pool.
MAXSIze
Specifies the maximum size for a physical file that the server can store in the
storage pool. This parameter is optional. The default value is NOLIMIT.
Possible values are:
NOLimit
Specifies that there is no maximum size limit for physical files stored in the
storage pool.
maximum_file_size
Limits the maximum physical file size. Specify an integer from 1 to 999999,
followed by a scale factor. For example, MAXSIZE=5G specifies that the
maximum file size for this storage pool is 5 gigabytes. Scale factors are:

Scale factor Meaning
K kilobyte
M megabyte
G gigabyte
T terabyte

If a file exceeds the maximum size and no pool is specified as the next storage
pool in the hierarchy, the server does not store the file. If a file exceeds the
maximum size and a pool is specified as the next storage pool, the server
stores the file in the next storage pool that can accept the file size. If you
specify the next storage pool parameter, at least one storage pool in your
hierarchy should have no limit on the maximum size of a file. By having no
limit on the size for at least one pool, you ensure that no matter what its size,
the server can store the file.
For logical files that are part of an aggregate, the server considers the size of
the aggregate to be the file size. Therefore, the server does not store logical
files that are smaller than the maximum size limit if the files are part of an
aggregate that is larger than the maximum size limit.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
DEFINE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 333
CRCData
Specifies whether a cyclic redundancy check (CRC) validates storage pool data
when audit volume processing occurs on the server. This parameter is only
valid for NATIVE data format storage pools. This parameter is optional. The
default value is NO. By setting CRCDATA to YES and scheduling an AUDIT
VOLUME command you can continually ensure the integrity of data stored in
your storage hierarchy. Possible values are:
Yes
Specifies that data is stored containing CRC information, allowing for audit
volume processing to validate storage pool data. This mode impacts
performance because additional overhead is required to calculate and
compare CRC values between the storage pool and the server.
No
Specifies that data is stored without CRC information.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
NEXTstgpool
Specifies a primary storage pool to which files are migrated. You cannot
migrate data from a sequential access storage pool to a random access storage
pool. This parameter is optional.
If this storage pool does not have a next storage pool, the server cannot
migrate files from this storage pool and cannot store files that exceed the
maximum size for this storage pool in another storage pool.
When there is insufficient space available in the current storage pool, the
NEXTSTGPOOL parameter for sequential access storage pools does not allow
data to be stored into the next pool. In this case the server issues a message
and the transaction fails.
For next storage pools with a device type of FILE, the server performs a
preliminary check to determine whether sufficient space is available. If space is
not available, the server skips to the next storage pool in the hierarchy. If space
is available, the server attempts to store data in that pool. However, it is
possible that the storage operation could fail because, at the time the actual
storage operation is attempted, the space is no longer available.
You cannot create a chain of storage pools that leads to an endless loop
through the NEXTSTGPOOL parameter. At least one storage pool in the
hierarchy must have no value specified for NEXTSTGPOOL.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
HIghmig
Specifies that the server starts migration when storage pool utilization reaches
this percentage. For sequential-access disk (FILE) storage pools, utilization is
the ratio of data in a storage pool to the pools total estimated data capacity,
DEFINE STGPOOL Primary Sequential Access

334 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
including the capacity of all scratch volumes specified for the pool. For storage
pools that use tape or optical media, utilization is the ratio of volumes that
contain data to the total number of volumes in the storage pool. The total
number of volumes includes the maximum number of scratch volumes. This
parameter is optional. You can specify an integer from 0 to 100. The default
value is 90.
When the storage pool exceeds the high migration threshold, the server can
start migration of files by volume to the next storage pool defined for the pool.
You can set the high migration threshold to 100 to prevent migration for the
storage pool.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
LOwmig
Specifies that the server stops migration when storage pool utilization is at or
below this percentage. For sequential-access disk (FILE) storage pools,
utilization is the ratio of data in a storage pool to the pools total estimated
data capacity, including the capacity of all scratch volumes specified for the
pool. For storage pools that use tape or optical media, utilization is the ratio of
volumes that contain data to the total number of volumes in the storage pool.
The total number of volumes includes the maximum number of scratch
volumes. This parameter is optional. You can specify an integer from 0 to 99.
The default value is 70.
When the storage pool reaches the low migration threshold, the server does
not start migration of files from another volume. You can set the low migration
threshold to 0 to permit migration to empty the storage pool.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
REClaim
Specifies when the server reclaims a volume, based on the percentage of
reclaimable space on a volume. Reclamation makes the fragmented space on
volumes usable again by moving any remaining unexpired files from one
volume to another volume, thus making the original volume available for
reuse. This parameter is optional. You can specify an integer from 1 to 100. The
default value is 60, except for storage pools that use WORM devices.
For storage pools that use WORM devices, the default value is 100 to prevent
reclamation from occurring. This is the default because a WORM volume is not
reusable. If necessary, you can lower the value to allow the server to
consolidate data onto fewer volumes. Volumes emptied by reclamation can be
checked out of the library, freeing slots for new volumes.
Specify a value of 50 percent or greater for this parameter so that files stored
on two volumes can be combined onto a single output volume.
DEFINE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 335
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
RECLAIMPRocess
Specifies the number of parallel processes to use for reclaiming the volumes in
this storage pool. This parameter is optional. Enter a value from 1 to 999. The
default value is 1.
When calculating the value for this parameter, consider the number of
sequential storage pools that will be involved with the reclamation and the
number of logical and physical drives that can be dedicated to the operation.
To access a sequential access volume, Tivoli Storage Manager uses a mount
point and, if the device type is not FILE, a physical drive. The number of
available mount points and drives depends on other Tivoli Storage Manager
and system activity and on the mount limits of the device classes for the
sequential access storage pools that are involved in the reclamation.
For example, suppose that you want to reclaim the volumes from two
sequential storage pools simultaneously and that you want to specify four
processes for each of the storage pools. The storage pools have the same device
class. Assuming that the RECLAIMSTGPOOL parameter is not specified or that
the reclaim storage pool has the same device class as the storage pool being
reclaimed, each process requires two mount points and, if the device type is
not FILE, two drives. (One of the drives is for the input volume, and the other
drive is for the output volume.) To run eight reclamation processes
simultaneously, you need a total of at least 16 mount points and 16 drives. The
device class for the storage pools must have a mount limit of at least 16.
If the number of reclamation processes you specify is more than the number of
available mount points or drives, the processes that do not obtain mount
points or drives will wait for mount points or drives to become available. If
mount points or drives do not become available within the MOUNTWAIT
time, the reclamation processes will terminate. For information about
specifying the MOUNTWAIT time, see DEFINE DEVCLASS (Define a device
class) on page 158.
The Tivoli Storage Manager server will start the specified number of
reclamation processes regardless of the number of volumes that are eligible for
reclamation. For example, if you specify ten reclamation processes and only six
volumes are eligible for reclamation, the server will start ten processes and
four of them will complete without processing a volume.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
RECLAIMSTGpool
Specifies another primary storage pool as a target for reclaimed data from this
storage pool. This parameter is optional. When the server reclaims volumes for
the storage pool, the server moves unexpired data from the volumes being
reclaimed to the storage pool named with this parameter.
DEFINE STGPOOL Primary Sequential Access

336 IBM Tivoli Storage Manager for Windows: Administrators Reference
A reclaim storage pool is most useful for a storage pool that has only one drive
in its library. When you specify this parameter, the server moves all data from
reclaimed volumes to the reclaim storage pool regardless of the number of
drives in the library.
To move data from the reclaim storage pool back to the original storage pool,
use the storage pool hierarchy. Specify the original storage pool as the next
storage pool for the reclaim storage pool.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
RECLAMATIONType
Specifies the method by which volumes are reclaimed and managed. This
parameter is optional. The default value is THRESHOLD. Possible values are
the following:
THRESHold
Specifies that volumes belonging to this storage pool are reclaimed based
on the threshold value in the RECLAIM attribute for this storage pool.
SNAPlock
Specifies that FILE volumes belonging to this storage pool will be managed
for retention using NetApp Data ONTAP software and NetApp SnapLock
volumes. This parameter is only valid for storage pools being defined to a
server that has data retention protection enabled and that is assigned to a
FILE device class. Volumes in this storage pool are not reclaimed based on
threshold; the RECLAIM value for the storage pool is ignored.
All volumes in this storage pool are created as FILE volumes. A retention
date, derived from the retention attributes in the archive copy group for
the storage pool, is set in the metadata for the FILE volume using the
SnapLock feature of the NetApp Data ONTAP operating system. Until the
retention date has expired, the FILE volume and any data on it cannot be
deleted from the physical SnapLock volume on which it is stored.
The RECLAMATIONTYPE parameter for all storage pools being defined
must be the same when defined to the same device class name. The
DEFINE command will fail if the RECLAMATIONTYPE parameter
specified is different than what is currently defined for storage pools
already defined to the device class name.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
COLlocate
Specifies whether the server attempts to keep data belonging to a single client
node, group of client nodes, or client file space stored on as few volumes as
possible. This parameter is optional. The default value is GROUP.
Collocation reduces the number of sequential access media mounts for restore,
retrieve, and recall operations. However, collocation increases both the amount
DEFINE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 337
of server time needed to collocate files for storing and the number of volumes
required. For details, see the Administrators Guide.
Possible values are:
No
Specifies that collocation is disabled.
GRoup
Specifies that collocation is enabled at the group level for client nodes. The
server attempts to put data for nodes that belong to the same collocation
group on as few volumes as possible. If the nodes in the collocation group
have multiple file spaces, the server does not attempt to collocate those file
spaces.
If you specify COLLOCATE=GROUP but do not define any collocation
groups or if you specify COLLOCATE=GROUP but do not add nodes to a
collocation group, data is collocated by node. Be sure to consider tape
usage when organizing client nodes into collocation groups. For example,
if a tape-based storage pool consists of data from grouped and ungrouped
nodes and you specify COLLOCATE=GROUP, the server does the
following:
v Collocates by group the data for grouped nodes only. Whenever
possible, the server collocates data belonging to a group of nodes on a
single tape or on as few tapes as possible. Data for a single node can
also be spread across several tapes associated with a group.
v Collocates by node the data for ungrouped nodes. Whenever possible,
the server stores the data for a single node on a single tape. All available
tapes that already have data for the node are used before available space
on any other tape is used.
NODe
Specifies that collocation is enabled at the client node level. The server
attempts to put data for one node on as few volumes as possible. If the
node has multiple file spaces, the server does not attempt to collocate those
file spaces. For backward compatibility, COLLOCATE=YES is still accepted
by the server to specify collocation at the client node level.
If a storage pool contains data for a node that is a member of a collocation
group and you specify COLLOCATE=NODE, the data will be collocated by
node not by group.
FIlespace
Specifies that collocation is enabled at the file space level for client nodes.
The server attempts to put data for one node and file space on as few
volumes as possible. If a node has multiple file spaces, the server attempts
to put data for different file spaces on different volumes.
MAXSCRatch (Required)
Specifies the maximum number of scratch volumes that the server can request
for this storage pool. You can specify an integer from 0 to 100000000. By
allowing the server to request scratch volumes, you avoid having to define
each volume to be used.
The value specified for this parameter is used to estimate the total number of
volumes available in the storage pool and the corresponding estimated
capacity for the storage pool.
DEFINE STGPOOL Primary Sequential Access

338 IBM Tivoli Storage Manager for Windows: Administrators Reference
Scratch volumes are automatically deleted from the storage pool when they
become empty. When scratch volumes with the device type of FILE are
deleted, the space that the volumes occupied is freed by the server and
returned to the file system.
REUsedelay
Specifies the number of days that must elapse after all files are deleted from a
volume before the volume can be rewritten or returned to the scratch pool.
This parameter is optional. You can specify an integer from 0 to 9999. The
default value is 0, which means that a volume can be rewritten or returned to
the scratch pool as soon as all the files are deleted from the volume.
Important: Use this parameter to help ensure that when you restore the
database to an earlier level, database references to files in the
storage pool are still valid. You must set this parameter to a value
greater than the number of days you plan to retain the oldest
database backup. The number of days specified for this parameter
should be the same as the number specified for the SET
DRMDBBACKUPEXPIREDAYS command. For more information,
see the Administrators Guide.
OVFLOcation
Specifies the overflow location for the storage pool. The server assigns this
location name to a volume that is ejected from the library by the command.
This parameter is optional. The location name can be a maximum length of 255
characters. Enclose the location name in quotation marks if the location name
contains any blank characters.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
MIGDelay
Specifies the minimum number of days a file must remain in a storage pool
before it becomes eligible for migration. All files on a volume must be eligible
for migration before the server selects the volume for migration. To calculate a
value to compare to the specified MIGDELAY, the server counts the number of
days that the file has been in the storage pool.
This parameter is optional. You can specify an integer from 0 to 9999. The
default is 0, which means that you do not want to delay migration. If you
want the server to count the number of days based only on when a file was
stored and not when it was retrieved, use the NORETRIEVEDATE server
option.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
MIGContinue
Specifies whether you allow the server to migrate files that do not satisfy the
migration delay time. This parameter is optional. The default is YES.
DEFINE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 339
Because you can require that files remain in the storage pool for a minimum
number of days, the server may migrate all eligible files to the next storage
pool yet not meet the low migration threshold. This parameter allows you to
specify whether the server is allowed to continue the migration process by
migrating files that do not satisfy the migration delay time.
Possible values are:
Yes
Specifies that, when necessary to meet the low migration threshold, the
server continues to migrate files that do not satisfy the migration delay
time.
If you allow more than one migration process for the storage pool, some
files that do not satisfy the migration delay time may be migrated
unnecessarily. As one process migrates files that satisfy the migration delay
time, a second process could begin migrating files that do not satisfy the
migration delay time to meet the low migration threshold. The first process
that is still migrating files that satisfy the migration delay time might have,
by itself, caused the low migration threshold to be met.
No
Specifies that the server stops migration when no eligible files remain to be
migrated, even before reaching the low migration threshold. The server
does not migrate files unless the files satisfy the migration delay time.
MIGPRocess
Specifies the number of parallel processes to use for migrating the files from
the volumes in this storage pool. This parameter is optional. Enter a value
from 1 to 999. The default value is 1.
When calculating the value for this parameter, consider the number of
sequential storage pools that will be involved with the migration, and the
number of logical and physical drives that can be dedicated to the operation.
To access a sequential-access volume, Tivoli Storage Manager uses a mount
point and, if the device type is not FILE, a physical drive. The number of
available mount points and drives depends on other Tivoli Storage Manager
and system activity and on the mount limits of the device classes for the
sequential access storage pools that are involved in the migration.
For example, suppose you want to simultaneously migrate the files from
volumes in two primary sequential storage pools and that you want to specify
three processes for each of the storage pools. The storage pools have the same
device class. Assuming that the storage pool to which files are being migrated
has the same device class as the storage pool from which files are being
migrated, each process requires two mount points and, if the device type is not
FILE, two drives. (One drive is for the input volume, and the other drive is for
the output volume.) To run six migration processes simultaneously, you need a
total of at least 12 mount points and 12 drives. The device class for the storage
pools must have a mount limit of at least 12.
If the number of migration processes you specify is more than the number of
available mount points or drives, the processes that do not obtain mount
points or drives will wait for mount points or drives to become available. If
mount points or drives do not become available within the MOUNTWAIT
time, the migration processes will terminate. For information about specifying
the MOUNTWAIT time, see DEFINE DEVCLASS (Define a device class) on
page 158.
DEFINE STGPOOL Primary Sequential Access

340 IBM Tivoli Storage Manager for Windows: Administrators Reference
The Tivoli Storage Manager server will start the specified number of migration
processes regardless of the number of volumes that are eligible for migration.
For example, if you specify ten migration processes and only six volumes are
eligible for migration, the server will start ten processes and four of them will
complete without processing a volume.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
DATAFormat
Specifies the data format to use to back up files to this storage pool and restore
files from this storage pool. The default format is the NATIVE server format.
Possible values are:
NATive
Specifies the data format is the native IBM Tivoli Storage Manager server
format and includes block headers.
NONblock
Specifies the data format is the native IBM Tivoli Storage Manager server
format and does not include block headers.
Note: The default minimum block size on a volume associated with a FILE
device class is 256 KB, regardless how much data is being written to
the volume. For certain tasks (for example, using
content-management products, using the DIRMC client option to
store directory information, or migrating very small files using the
hierarchical space management (HSM) client), you can minimize
wasted space on storage volumes by specifying the NONBLOCK
data format. In most situations, however, the NATIVE format is
preferred.
NETAPPDump
Specifies the data is in a Network Appliance dump format. This data
format should be specified for file system images that are in a dump
format and that have been backed up from a Network Appliance or an
IBM System Storage N Series file server using NDMP. The server will not
perform migration, reclamation, or AUDIT VOLUME for a storage pool
with DATAFORMAT=NETAPPDUMP. You can use the MOVE DATA
command to move data from one primary storage pool to another, or out
of a volume if the volume needs to be reused.
CELERRADump
Specifies that the data is in an EMC Celerra dump format. This data format
should be specified for file system images that are in a dump format and
that have been backed up from an EMC Celerra file server using NDMP.
The server will not perform migration, reclamation, or AUDIT VOLUME
for a storage pool with DATAFORMAT=CELERRADUMP. You can use the
MOVE DATA command to move data from one primary storage pool to
another, or out of a volume if the volume needs to be reused.
NDMPDump
Specifies that the data is in NAS vendor-specific backup format. Use this
data format for file system images that have been backed up from a NAS
file server other than a Network Appliance or EMC Celerra file server. The
DEFINE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 341
server will not perform migration, reclamation, or AUDIT VOLUME for a
storage pool with DATAFORMAT=NDMPDUMP. You can use the MOVE
DATA command to move data from one primary storage pool to another,
or out of a volume if the volume needs to be reused.
COPYSTGpools
Specifies the names of copy storage pools where the server simultaneously
writes data. The COPYSTGPOOLS parameter is optional. You can specify a
maximum of three copy pool names separated by commas. (In versions earlier
than Version 5 Release 3, the maximum number was ten.) Spaces between the
names of the copy pools are not permitted. When specifying a value for the
COPYSTGPOOLS parameter, you can also specify a value for the
COPYCONTINUE parameter.
The combined total number of storage pools specified in the COPYSGTPOOLS
and ACTIVEDATAPOOLS parameters cannot exceed three.
The simultaneous write function changed in Tivoli Storage Manager Version
5.3. In Version 5.3 and later versions, when a data storage operation switches
from a primary storage pool to a next storage pool, the next storage pool
inherits the list of copy storage pools and the COPYCONTINUE value from
the primary storage pool. The primary storage pool is specified by the copy
group of the management class that is bound to the data. For details, refer to
information about simultaneous write in the Administrators Guide.
The server can perform simultaneous write to copy storage pools for the
following operations:
v Backup and archive operations by Tivoli Storage Manager backup-archive
clients or application clients using the Tivoli Storage Manager API
v Migration operations by Hierarchical Space Management (HSM) clients
v Import operations that involve copying exported file data from external
media to a storage pool defined with a copy storage pool list
Note:
1. This parameter is available only to primary storage pools that use
NATIVE or NONBLOCK data format. This parameter is not available
for storage pools that use the following data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
2. Simultaneous write to copy storage pools is not supported when the
operation is using LAN-free data movement. Simultaneous write
takes precedence over LAN-free operations, causing the operations to
go over the LAN. However, the simultaneous write configuration is
honored.
3. Simultaneous write is not supported for NAS backup operations. If
the primary storage pool specified in the DESTINATION or
TOCDESTINATION in the copy group of the management class has
copy storage pools defined, the copy storage pools are ignored and
the data is stored into the primary storage pool only.
4. You cannot use the simultaneous write function with Centera storage
devices.
DEFINE STGPOOL Primary Sequential Access

342 IBM Tivoli Storage Manager for Windows: Administrators Reference
Attention: The function provided by the COPYSTGPOOLS parameter is not
intended to replace the BACKUP STGPOOL command. If you use the
COPYSTGPOOLS parameter, continue to use the BACKUP STGPOOL
command to ensure that the copy storage pools are complete copies of the
primary storage pool. There are cases when a copy may not be created. For
more information, see the COPYCONTINUE parameter description.
COPYContinue
Specifies how the server should react to a copy storage pool write failure for
any of the copy storage pools listed in the COPYSTGPOOLS parameter. This
parameter is optional. The default value is YES. When specifying the
COPYCONTINUE parameter, you must also specify the COPYSTGPOOLS
parameter.
This parameter has no effect on active-data pools. If a write error occurs while
writing to an active-data pool, the server will stop writing to the failing
active-data pool for the remainder of the session.
Possible values are:
Yes
If the COPYCONTINUE option is set to YES, the server will stop writing
to the failing copy pools for the remainder of the session, but continue
storing files into the primary pool and any remaining copy pools. The copy
storage pool list is active only for the life of the client session and applies
to all the primary storage pools in a particular storage pool hierarchy.
For additional information about the COPYCONTINUE parameter, refer to
the information about simultaneous write in the Administrators Guide.
No
If the COPYCONTINUE option is set to NO, the server will fail the current
transaction and discontinue the store operation.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
ACTIVEDATApools
Specifies the names of active-data pools where the server simultaneously
writes data during a client backup operation. The ACTIVEDATAPOOLS
parameter is optional. Spaces between the names of the active-data pools are
not permitted.
The combined total number of storage pools specified in the COPYSGTPOOLS
and ACTIVEDATAPOOLS parameters can not exceed three.
When a data storage operation switches from a primary storage pool to a next
storage pool, the next storage pool inherits the list of active-data pools from
the destination storage pool specified in the copy group. The primary storage
pool is specified by the copy group of the management class that is bound to
the data. For details, refer to information about simultaneous write in the
Administrators Guide.
The server can perform simultaneous write to active-data pools only during
backup operations by Tivoli Storage Manager backup-archive clients or
application clients using the Tivoli Storage Manager API.
DEFINE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 343
Note:
1. This parameter is available only to primary storage pools that use
NATIVE or NONBLOCK data format. This parameter is not available
for storage pools that use the following data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
2. Simultaneous write to active-data pools is not supported when the
operation is using LAN-free data movement. Simultaneous write
takes precedence over LAN-free operations, causing the operations to
go over the LAN. However, the simultaneous write configuration is
honored.
3. Simultaneous write is not supported when a NAS backup operation
is writing a TOC file. If the primary storage pool specified in the
TOCDESTINATION in the copy group of the management class has
active-data pools defined, the active-data pools are ignored, and the
data is stored into the primary storage pool only.
4. You cannot use the simultaneous write function with Centera storage
devices.
5. Data being imported will not be stored in active-data pools. After an
import operation, use the COPY ACTIVEDATA command to store
the imported data in an active-data pool.
Attention: The function provided by the ACTIVEDATAPOOLS parameter is
not intended to replace the COPY ACTIVEDATA command. If you use the
ACTIVEDATAPOOLS parameter, use the COPY ACTIVEDATA command to
ensure that the active-data pools contain all active data of the primary storage
pool.
Examples
Task
Define a primary storage pool named 8MMPOOL to the 8MMTAPE device class
(with a device type of 8MM) with a maximum file size of 5MB. Store any files
larger than 5MB in subordinate pools, beginning with POOL1. Enable collocation
of files for client nodes. Allow as many as 5 scratch volumes for this storage pool.
Command
define stgpool 8mmpool 8mmtape maxsize=5m
nextstgpool=pool1 collocate=node
maxscratch=5
DEFINE STGPOOL Primary Sequential Access

344 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE STGPOOL copy sequential access
Use this command to define a copy storage pool assigned to sequential access
devices.
Privilege class
To issue this command, you must have system privilege.
Syntax
DEFine STGpool pool_name device_class_name POoltype = COpy

DESCription

=

description
ACCess = READWrite
ACCess

=

READWrite

READOnly

UNAVailable

COLlocate = No
COLlocate

=

No

GRoup

NODe

FIlespace
REClaim = 100
REClaim

=

percent

RECLAIMPRocess = 1
RECLAIMPRocess

=

number
RECLAMATIONType = THRESHold
(1)

RECLAMATIONType

=

THRESHold

SNAPlock

OFFSITERECLAIMLimit = NOLimit
OFFSITERECLAIMLimit

=

number

MAXSCRatch

=

number

REUsedelay = 0
REUsedelay

=

days

OVFLOcation

=

location

DATAFormat = NATive
(2)

DATAFormat

=

NATive

NONblock

NETAPPDump

CELERRADump

NDMPDump
CRCData = No
CRCData

=

Yes

No

Notes:
1 The RECLAMATIONTYPE=SNAPLOCK setting is valid only for storage
pools defined to servers that are enabled for System Storage Archive
Manager. The storage pool must be assigned to a FILE device class, and the
directories specified in the device class must be NetApp SnapLock volumes.
2 The values NETAPPDUMP, CELERRADUMP, and NDMPDUMP are not valid
for storage pools defined with a FILE-type device class.
DEFINE STGPOOL Copy Sequential Access
Chapter 2. Administrative commands 345
Parameters
pool_name (Required)
Specifies the name of the storage pool to be defined. The name must be
unique, and the maximum length is 30 characters.
device_class_name (Required)
Specifies the name of the sequential access device class to which this copy
storage pool is assigned. You can specify any device class except DISK.
POoltype=COpy (Required)
Specifies that you want to define a copy storage pool.
DESCription
Specifies a description of the copy storage pool. This parameter is optional.
The maximum length of the description is 255 characters. Enclose the
description in quotation marks if it contains any blank characters.
ACCess
Specifies how client nodes and server processes (such as reclamation) can
access files in the copy storage pool. This parameter is optional. The default
value is READWRITE. Possible values are:
READWrite
Specifies that files can be read from and written to the volumes in the copy
storage pool.
READOnly
Specifies that client nodes can only read files stored on the volumes in the
copy storage pool.
Server processes can move files within the volumes in the storage pool.
The server can use files in the copy storage pool to restore files to primary
storage pools. However, no new writes are permitted to volumes in the
copy storage pool from volumes outside the storage pool. A storage pool
cannot be backed up to the copy storage pool.
UNAVailable
Specifies that client nodes cannot access files stored on volumes in the
copy storage pool.
Server processes can move files within the volumes in the storage pool.
The server can use files in the copy storage pool to restore files to primary
storage pools. However, no new writes are permitted to volumes in the
copy storage pool from volumes outside the storage pool. A storage pool
cannot be backed up to the copy storage pool.
COLlocate
Specifies whether the server attempts to keep data belonging to a single client
node, group of client nodes, or client file space stored on as few volumes as
possible. This parameter is optional. The default value is NO.
Collocation reduces the number of sequential access media mounts for restore,
retrieve, and recall operations. However, collocation increases both the amount
of server time needed to collocate files for storing and the number of volumes
required. For details, see the Administrators Guide.
Possible values are:
No
Specifies that collocation is disabled.
DEFINE STGPOOL Copy Sequential Access

346 IBM Tivoli Storage Manager for Windows: Administrators Reference
GRoup
Specifies that collocation is enabled at the group level for client nodes. The
server attempts to put data for nodes that belong to the same collocation
group on as few volumes as possible. If the nodes in the collocation group
have multiple file spaces, the server does not attempt to collocate those file
spaces.
If you specify COLLOCATE=GROUP but do not define any collocation
groups or if you specify COLLOCATE=GROUP but do not add nodes to a
collocation group, data is collocated by node. Be sure to consider tape
usage when organizing client nodes into collocation groups. For example,
if a tape-based storage pool consists of data from grouped and ungrouped
nodes and you specify COLLOCATE=GROUP, the server does the
following:
v Collocates by group the data for grouped nodes only. Whenever
possible, the server collocates data belonging to a group of nodes on a
single tape or on as few tapes as possible. Data for a single node can
also be spread across several tapes associated with a group.
v Collocates by node the data for ungrouped nodes. Whenever possible,
the server stores the data for a single node on a single tape. All available
tapes that already have data for the node are used before available space
on any other tape is used.
NODe
Specifies that collocation is enabled at the client node level. The server
attempts to put data for one node on as few volumes as possible. If the
node has multiple file spaces, the server does not attempt to collocate those
file spaces. For backward compatibility, COLLOCATE=YES is still accepted
by the server to specify collocation at the client node level.
If a storage pool contains data for a node that is a member of a collocation
group and you specify COLLOCATE=NODE, the data will be collocated by
node not by group.
FIlespace
Specifies that collocation is enabled at the file space level for client nodes.
The server attempts to put data for one node and file space on as few
volumes as possible. If a node has multiple file spaces, the server attempts
to put data for different file spaces on different volumes.
REClaim
Specifies when the server reclaims a volume, based on the percentage of
reclaimable space on a volume. Reclamation makes the fragmented space on
volumes usable again by moving any remaining unexpired files from one
volume to another volume, thus making the original volume available for
reuse. This parameter is optional. You can specify an integer from 1 to 100. The
default value is 100, which means that reclamation is not performed.
If you change the value from the default, specify a value of 50 percent or
greater so that files stored on two volumes can be combined onto a single
output volume.
When a copy pool volume that is offsite becomes eligible for reclamation, the
reclamation process attempts to obtain the unexpired files on the reclaimable
volume from a primary or copy storage pool that is onsite. The process then
writes these files to an available volume in the original copy storage pool.
Effectively, these files are moved back to the onsite location. However, the files
could be obtained from the offsite volume after a disaster if a database backup
DEFINE STGPOOL Copy Sequential Access
Chapter 2. Administrative commands 347
is used that references the files on the offsite volume. Because of the way
reclamation works with offsite volumes, use it carefully with copy storage
pools.
RECLAIMPRocess
Specifies the number of parallel processes to use for reclaiming the volumes in
this storage pool. This parameter is optional. Enter a value from 1 to 999. The
default value is 1.
When calculating the value for this parameter, consider the number of
sequential storage pools that will be involved with the reclamation and the
number of logical and physical drives that can be dedicated to the operation.
To access a sequential access volume, Tivoli Storage Manager uses a mount
point and, if the device type is not FILE, a physical drive. The number of
available mount points and drives depends on other Tivoli Storage Manager
and system activity and on the mount limits of the device classes for the
sequential access storage pools that are involved in the reclamation.
For example, suppose that you want to reclaim the volumes from two
sequential storage pools simultaneously and that you want to specify four
processes for each of the storage pools. The storage pools have the same device
class. Each process requires two mount points and, if the device type is not
FILE, two drives. (One of the drives is for the input volume, and the other
drive is for the output volume.) To run eight reclamation processes
simultaneously, you need a total of at least 16 mount points and 16 drives. The
device class for the storage pools must have a mount limit of at least 16.
If the number of reclamation processes you specify is more than the number of
available mount points or drives, the processes that do not obtain mount
points or drives will wait for mount points or drives to become available. If
mount points or drives do not become available within the MOUNTWAIT
time, the reclamation processes will terminate. For information about
specifying the MOUNTWAIT time, see DEFINE DEVCLASS (Define a device
class) on page 158.
The Tivoli Storage Manager server will start the specified number of
reclamation processes regardless of the number of volumes that are eligible for
reclamation. For example, if you specify ten reclamation processes and only six
volumes are eligible for reclamation, the server will start ten processes and
four of them will complete without processing a volume.
RECLAMATIONType
Specifies the method by which volumes are reclaimed and managed. This
parameter is optional. The default value is THRESHOLD. Possible values are
the following:
THRESHold
Specifies that volumes belonging to this storage pool are reclaimed based
on the threshold value in the RECLAIM attribute for this storage pool.
SNAPlock
Specifies that FILE volumes belonging to this storage pool will be managed
for retention using NetApp Data ONTAP software and NetApp SnapLock
volumes. This parameter is only valid for storage pools being defined to a
server that has data retention protection enabled and that is assigned to a
FILE device class. Volumes in this storage pool are not reclaimed based on
threshold; the RECLAIM value for the storage pool is ignored.
All volumes in this storage pool are created as FILE volumes. A retention
date, derived from the retention attributes in the archive copy group for
DEFINE STGPOOL Copy Sequential Access

348 IBM Tivoli Storage Manager for Windows: Administrators Reference
the storage pool, is set in the metadata for the FILE volume using the
SnapLock feature of the NetApp Data ONTAP operating system. Until the
retention date has expired, the FILE volume and any data on it cannot be
deleted from the physical SnapLock volume on which it is stored.
The RECLAMATIONTYPE parameter for all storage pools being defined
must be the same when defined to the same device class name. The
DEFINE command will fail if the RECLAMATIONTYPE parameter
specified is different than what is currently defined for storage pools
already defined to the device class name.
OFFSITERECLAIMLimit
Specifies the number of offsite volumes to have their space reclaimed during
reclamation for this storage pool. This parameter is optional. The default value
is NOLIMIT. Possible values are:
NOLimit
Specifies that you want to have the space reclaimed in all of your offsite
volumes.
number
Specifies the number of offsite volumes to have their space reclaimed. You
can specify an integer from 0 to 99999. A value of zero means that none of
the offsite volumes will be reclaimed.
Note: When determining the value for the OFFSITERECLAIMLIMIT,
consider using the statistical information in the message issued at
the end of the offsite volume reclamation operation. Alternatively,
you can use the following Tivoli Storage Manager SQL select
command to obtain the statistical information from the SUMMARY
table for the offsite volume reclamation operation:
select * from summary where activity=OFFSITE RECLAMATION
The statistical information includes the following:
v The number of offsite volumes that were processed
v The number of parallel processes that were used
v The total amount of time required for the processing
The order in which offsite volumes are reclaimed is based on the amount of
unused space in a volume. (Unused space includes both space that has never
been used on the volume and space that has become empty because of file
deletion.) Volumes with the largest amount of unused space are reclaimed first.
For example, suppose a copy storage pool contains three volumes: VOL1,
VOL2, and VOL3. VOL1 has the largest amount of unused space, and VOL3
has the least amount of unused space. Suppose further that the percentage of
unused space in each of the three volumes is greater than the value of the
RECLAIM parameter. If you do not specify a value for the
OFFSITERECLAIMLIMIT parameter, all three volumes will be reclaimed when
the reclamation runs. If you specify a value of 2, only VOL1 and VOL2 will be
reclaimed when the reclamation runs. If you specify a value of 1, only VOL1
will be reclaimed.
MAXSCRatch (Required)
Specifies the maximum number of scratch volumes that the server can request
for this storage pool. You can specify an integer from 0 to 100000000. By
allowing the server to request scratch volumes as needed, you avoid having to
define each volume to be used.
DEFINE STGPOOL Copy Sequential Access
Chapter 2. Administrative commands 349
The value specified for this parameter is used to estimate the total number of
volumes available in the copy storage pool and the corresponding estimated
capacity for the copy storage pool.
Scratch volumes are automatically deleted from the storage pool when they
become empty. However, if the access mode for a scratch volume is OFFSITE,
the volume is not deleted from the copy storage pool until the access mode is
changed. This allows an administrator to query the server for empty, offsite
scratch volumes and return these to the onsite location.
When scratch volumes with the device type of FILE become empty and are
deleted, the space that the volumes occupied is freed by the server and
returned to the file system.
REUsedelay
Specifies the number of days that must elapse after all files are deleted from a
volume before the volume can be rewritten or returned to the scratch pool.
This parameter is optional. You can specify an integer from 0 to 9999. The
default value is 0, which means that a volume can be rewritten or returned to
the scratch pool as soon as all the files are deleted from the volume.
Important: Use this parameter to help ensure that when you restore the
database to an earlier level, database references to files in the copy
storage pool are still valid. You must set this parameter to a value
greater than the number of days you plan to retain the oldest
database backup. The number of days specified for this parameter
should be the same as the number specified for the SET
DRMDBBACKUPEXPIREDAYS command. For more information,
see the Administrators Guide.
OVFLOcation
Specifies the overflow location for the storage pool. The server assigns this
location name to a volume that is ejected from the library by the command.
This parameter is optional. The location name can be a maximum length of 255
characters. Enclose the location name in quotation marks if the location name
contains any blank characters.
DATAFormat
Specifies the data format to use to back up files to this storage pool and restore
files from this storage pool. The default format is the NATIVE server format.
Possible values are:
NATive
Specifies the data format is the native IBM Tivoli Storage Manager server
format and includes block headers.
NONblock
Specifies the data format is the native IBM Tivoli Storage Manager server
format and does not include block headers.
Note: The default minimum block size on a volume associated with a FILE
device class is 256 KB, regardless how much data is being written to
the volume. For certain tasks (for example, using
content-management products, using the DIRMC client option to
store directory information, or migrating very small files using the
hierarchical space management (HSM) client), you can minimize
wasted space on storage volumes by specifying the NONBLOCK
data format. In most situations, however, the NATIVE format is
preferred.
DEFINE STGPOOL Copy Sequential Access

350 IBM Tivoli Storage Manager for Windows: Administrators Reference
NETAPPDump
Specifies that the data is in a Network Appliance dump format. Do not
specify this data format for file system images that are in a dump format
and that have been backed up from a Network Appliance file server using
NDMP. The server will not perform storage pool reclamation or AUDIT
VOLUME for a storage pool with DATAFORMAT=NETAPPDUMP. You
can use the MOVE DATA command to move NDMP-generated data out of
a volume if the volume needs to be re-used.
CELERRADump
Specifies that the data is in an EMC Celerra dump format. Do not specify
this data format for file system images that are in a dump format and that
have been backed up from an EMC Celerra file server using NDMP. The
server will not perform storage pool reclamation or AUDIT VOLUME for a
storage pool with DATAFORMAT=CELERRADUMP. You can use the
MOVE DATA command to move NDMP-generated data out of a volume if
the volume needs to be re-used.
NDMPDump
Specifies that the data is in a NAS vendor-specific backup format. Do not
specify this data format for file system images that are in a backup format
and that have been backed up from a NAS file server other than a
Network Appliance or EMC Celerra file server. The server will not perform
storage pool reclamation or AUDIT VOLUME for a storage pool with
DATAFORMAT=NDMPDUMP. You can use the MOVE DATA command to
move NDMP-generated data out of a volume if the volume needs to be
re-used.
CRCData
Specifies whether a cyclic redundancy check (CRC) validates storage pool data
when audit volume processing occurs on the server. This parameter is only
valid for NATIVE data format storage pools. This parameter is optional. The
default value is NO. By setting CRCDATA to YES and scheduling an AUDIT
VOLUME command you can continually ensure the integrity of data stored in
your storage hierarchy. Possible values are:
Yes
Specifies that data is stored containing CRC information, allowing for audit
volume processing to validate storage pool data. This mode impacts
performance because additional overhead is required to calculate and
compare CRC values between the storage pool and the server.
No
Specifies that data is stored without CRC information.
Examples
Task
Define a copy storage pool, TAPEPOOL2, to the DC480 device class. Allow up to
50 scratch volumes for this pool. Delay the reuse of volumes for 45 days.
Command
define stgpool tapepool2 dc480 pooltype=copy
maxscratch=50 reusedelay=45
DEFINE STGPOOL Copy Sequential Access
Chapter 2. Administrative commands 351
DEFINE STGPOOL active-data sequential access
Use this command to define an active-data pool assigned to sequential-access
devices.
Privilege class
To issue this command, you must have system privilege.
Syntax
DEFine STGpool pool_name device_class_name POoltype = ACTIVEdata

DESCription

=

description
ACCess = READWrite
ACCess

=

READWrite

READOnly

UNAVailable

COLlocate = No
COLlocate

=

No

GRoup

NODe

FIlespace
REClaim = 60
REClaim

=

percent

RECLAIMPRocess = 1
RECLAIMPRocess

=

number
RECLAMATIONType = THRESHold
(1)

RECLAMATIONType

=

THRESHold

SNAPlock

OFFSITERECLAIMLimit = NOLimit
OFFSITERECLAIMLimit

=

number

MAXSCRatch

=

number

REUsedelay = 0
REUsedelay

=

days

OVFLOcation

=

location

DATAFormat = NATive
DATAFormat

=

NATive

NONblock
CRCData = No
CRCData

=

Yes

No

Notes:
1 The RECLAMATIONTYPE=SNAPLOCK setting is valid only for storage
pools defined to servers that are enabled for System Storage Archive
Manager. The storage pool must be assigned to a FILE device class, and the
directories specified in the device class must be NetApp SnapLock volumes.
Parameters
pool_name (Required)
Specifies the name of the storage pool to be defined. The name must be
unique, and the maximum length is 30 characters.
DEFINE STGPOOL Active-data Sequential Access

352 IBM Tivoli Storage Manager for Windows: Administrators Reference
device_class_name (Required)
Specifies the name of the sequential access device class to which this
active-data pool is assigned. You can specify any device class except DISK.
POoltype=ACTIVEdata (Required)
Specifies that you want to define an active-data pool.
DESCription
Specifies a description of the active-data pool. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters.
ACCess
Specifies how client nodes and server processes (such as reclamation) can
access files in the active-data pool. This parameter is optional. The default
value is READWRITE. Possible values are:
READWrite
Specifies that files can be read from and written to the volumes in the
active-data pool.
READOnly
Specifies that client nodes can only read files stored on the volumes in the
active-data pool.
Server processes can move files within the volumes in the storage pool.
The server can use files in the active-data pool to restore files to primary
storage pools. However, no new writes are permitted to volumes in the
active-data pool from volumes outside the storage pool. A storage pool
cannot be copied to the active-data pool.
UNAVailable
Specifies that client nodes cannot access files stored on volumes in the
active-data pool.
Server processes can move files within the volumes in the storage pool.
The server can use files in the active-data pool to restore files to primary
storage pools. However, no new writes are permitted to volumes in the
active-data pool from volumes outside the storage pool. A storage pool
cannot be copied to the active-data pool.
COLlocate
Specifies whether the server attempts to keep data belonging to a single client
node, group of client nodes, or client file space stored on as few volumes as
possible. This parameter is optional. The default value is NO.
Collocation reduces the number of sequential access media mounts for restore,
retrieve, and recall operations. However, collocation increases both the amount
of server time needed to collocate files for storing and the number of volumes
required. For details, see the Administrators Guide.
Possible values are:
No
Specifies that collocation is disabled.
GRoup
Specifies that collocation is enabled at the group level for client nodes. The
server attempts to put data for nodes that belong to the same collocation
group on as few volumes as possible. If the nodes in the collocation group
have multiple file spaces, the server does not attempt to collocate those file
spaces.
DEFINE STGPOOL Active-data Sequential Access
Chapter 2. Administrative commands 353
If you specify COLLOCATE=GROUP but do not define any collocation
groups or if you specify COLLOCATE=GROUP but do not add nodes to a
collocation group, data is collocated by node. Be sure to consider tape
usage when organizing client nodes into collocation groups. For example,
if a tape-based storage pool consists of data from grouped and ungrouped
nodes and you specify COLLOCATE=GROUP, the server does the
following:
v Collocates by group the data for grouped nodes only. Whenever
possible, the server collocates data belonging to a group of nodes on a
single tape or on as few tapes as possible. Data for a single node can
also be spread across several tapes associated with a group.
v Collocates by node the data for ungrouped nodes. Whenever possible,
the server stores the data for a single node on a single tape. All available
tapes that already have data for the node are used before available space
on any other tape is used.
NODe
Specifies that collocation is enabled at the client node level. The server
attempts to put data for one node on as few volumes as possible. If the
node has multiple file spaces, the server does not attempt to collocate those
file spaces. For backward compatibility, COLLOCATE=YES is still accepted
by the server to specify collocation at the client node level.
If a storage pool contains data for a node that is a member of a collocation
group and you specify COLLOCATE=NODE, the data will be collocated by
node not by group.
FIlespace
Specifies that collocation is enabled at the file space level for client nodes.
The server attempts to put data for one node and file space on as few
volumes as possible. If a node has multiple file spaces, the server attempts
to put data for different file spaces on different volumes.
REClaim
Specifies when the server reclaims a volume, based on the percentage of
reclaimable space on a volume. Reclamation makes the fragmented space and
space occupied by inactive backup files on volumes usable again by moving
any remaining unexpired files and active backup files from one volume to
another volume. This makes the original volume available for reuse. This
parameter is optional. You can specify an integer from 1 to 100. The default
value is 60.
If you change the value from the default, specify a value of 50 percent or
greater so that files stored on two volumes can be combined onto a single
output volume.
When an active-data pool volume that is offsite becomes eligible for
reclamation, the reclamation process attempts to obtain the unexpired files on
the reclaimable volume from a primary or active-data pool that is onsite. The
process then writes these files to an available volume in the original active-data
pool. Effectively, these files are moved back to the onsite location. However,
the files could be obtained from the offsite volume after a disaster if a database
backup is used that references the files on the offsite volume. Because of the
way reclamation works with offsite volumes, use it carefully with active-data
pools.
DEFINE STGPOOL Active-data Sequential Access

354 IBM Tivoli Storage Manager for Windows: Administrators Reference
RECLAIMPRocess
Specifies the number of parallel processes to use for reclaiming the volumes in
this storage pool. This parameter is optional. Enter a value from 1 to 999. The
default value is 1.
When calculating the value for this parameter, consider the number of
sequential storage pools that will be involved with the reclamation and the
number of logical and physical drives that can be dedicated to the operation.
To access a sequential access volume, Tivoli Storage Manager uses a mount
point and, if the device type is not FILE, a physical drive. The number of
available mount points and drives depends on other Tivoli Storage Manager
and system activity and on the mount limits of the device classes for the
sequential access storage pools that are involved in the reclamation.
For example, suppose that you want to reclaim the volumes from two
sequential storage pools simultaneously and that you want to specify four
processes for each of the storage pools. The storage pools have the same device
class. Each process requires two mount points and, if the device type is not
FILE, two drives. (One of the drives is for the input volume, and the other
drive is for the output volume.) To run eight reclamation processes
simultaneously, you need a total of at least 16 mount points and 16 drives. The
device class for the storage pools must have a mount limit of at least 16.
If the number of reclamation processes you specify is more than the number of
available mount points or drives, the processes that do not obtain mount
points or drives will wait for mount points or drives to become available. If
mount points or drives do not become available within the MOUNTWAIT
time, the reclamation processes will terminate. For information about
specifying the MOUNTWAIT time, see DEFINE DEVCLASS (Define a device
class) on page 158.
The Tivoli Storage Manager server will start the specified number of
reclamation processes regardless of the number of volumes that are eligible for
reclamation. For example, if you specify ten reclamation processes and only six
volumes are eligible for reclamation, the server will start ten processes and
four of them will complete without processing a volume.
RECLAMATIONType
Specifies the method by which volumes are reclaimed and managed. This
parameter is optional. The default value is THRESHOLD. Possible values are
the following:
THRESHold
Specifies that volumes belonging to this storage pool are reclaimed based
on the threshold value in the RECLAIM attribute for this storage pool.
SNAPlock
Specifies that FILE volumes belonging to this storage pool will be managed
for retention using NetApp Data ONTAP software and NetApp SnapLock
volumes. This parameter is only valid for storage pools being defined to a
server that has data retention protection enabled and that is assigned to a
FILE device class. Volumes in this storage pool are not reclaimed based on
threshold; the RECLAIM value for the storage pool is ignored.
All volumes in this storage pool are created as FILE volumes. A retention
date, derived from the retention attributes in the archive copy group for
the storage pool, is set in the metadata for the FILE volume using the
SnapLock feature of the NetApp Data ONTAP operating system. Until the
retention date has expired, the FILE volume and any data on it cannot be
deleted from the physical SnapLock volume on which it is stored.
DEFINE STGPOOL Active-data Sequential Access
Chapter 2. Administrative commands 355
The RECLAMATIONTYPE parameter for all storage pools being defined
must be the same when defined to the same device class name. The
DEFINE command will fail if the RECLAMATIONTYPE parameter
specified is different than what is currently defined for storage pools
already defined to the device class name.
OFFSITERECLAIMLimit
Specifies the number of offsite volumes to have their space reclaimed during
reclamation for this storage pool. This parameter is optional. The default value
is NOLIMIT. Possible values are:
NOLimit
Specifies that you want to have the space reclaimed in all of your offsite
volumes.
number
Specifies the number of offsite volumes to have their space reclaimed. You
can specify an integer from 0 to 99999. A value of zero means that none of
the offsite volumes will be reclaimed.
Note: When determining the value for the OFFSITERECLAIMLIMIT,
consider using the statistical information in the message issued at
the end of the offsite volume reclamation operation. Alternatively,
you can use the following Tivoli Storage Manager SQL select
command to obtain the statistical information from the SUMMARY
table for the offsite volume reclamation operation:
select * from summary where activity=OFFSITE RECLAMATION
The statistical information includes the following:
v The number of offsite volumes that were processed
v The number of parallel processes that were used
v The total amount of time required for the processing
The order in which offsite volumes are reclaimed is based on the amount of
unused space in a volume. (Unused space includes both space that has never
been used on the volume and space that has become empty because of file
deletion.) Volumes with the largest amount of unused space are reclaimed first.
For example, suppose an active-data pool contains three volumes: VOL1,
VOL2, and VOL3. VOL1 has the largest amount of unused space, and VOL3
has the least amount of unused space. Suppose further that the percentage of
unused space in each of the three volumes is greater than the value of the
RECLAIM parameter. If you do not specify a value for the
OFFSITERECLAIMLIMIT parameter, all three volumes will be reclaimed when
the reclamation runs. If you specify a value of 2, only VOL1 and VOL2 will be
reclaimed when the reclamation runs. If you specify a value of 1, only VOL1
will be reclaimed.
MAXSCRatch (Required)
Specifies the maximum number of scratch volumes that the server can request
for this storage pool. You can specify an integer from 0 to 100000000. By
allowing the server to request scratch volumes as needed, you avoid having to
define each volume to be used.
The value specified for this parameter is used to estimate the total number of
volumes available in the active-data pool and the corresponding estimated
capacity for the active-data pool.
DEFINE STGPOOL Active-data Sequential Access

356 IBM Tivoli Storage Manager for Windows: Administrators Reference
Scratch volumes are automatically deleted from the storage pool when they
become empty. However, if the access mode for a scratch volume is OFFSITE,
the volume is not deleted from the active-data pool until the access mode is
changed. This allows an administrator to query the server for empty, offsite
scratch volumes and return these to the onsite location.
When scratch volumes with the device type of FILE become empty and are
deleted, the space that the volumes occupied is freed by the server and
returned to the file system.
REUsedelay
Specifies the number of days that must elapse after all files are deleted from a
volume before the volume can be rewritten or returned to the scratch pool.
This parameter is optional. You can specify an integer from 0 to 9999. The
default value is 0, which means that a volume can be rewritten or returned to
the scratch pool as soon as all the files are deleted from the volume.
Important: Use this parameter to help ensure that when you restore the
database to an earlier level, database references to files in the
active-data pool are still valid. You must set this parameter to a
value greater than the number of days you plan to retain the oldest
database backup. The number of days specified for this parameter
should be the same as the number specified for the SET
DRMDBBACKUPEXPIREDAYS command. For more information,
see the Administrators Guide.
OVFLOcation
Specifies the overflow location for the storage pool. The server assigns this
location name to a volume that is ejected from the library by the command.
This parameter is optional. The location name can be a maximum length of 255
characters. Enclose the location name in quotation marks if the location name
contains any blank characters.
DATAFormat
Specifies the data format to use to copy files to this storage pool and restore
files from this storage pool. The default format is the NATIVE server format.
Possible values are:
NATive
Specifies the data format is the native IBM Tivoli Storage Manager server
format and includes block headers.
NONblock
Specifies the data format is the native IBM Tivoli Storage Manager server
format and does not include block headers.
Note: The default minimum block size on a volume associated with a FILE
device class is 256 KB, regardless how much data is being written to
the volume. For certain tasks (for example, using
content-management products, using the DIRMC client option to
store directory information, or migrating very small files using the
hierarchical space management (HSM) client), you can minimize
wasted space on storage volumes by specifying the NONBLOCK
data format. In most situations, however, the NATIVE format is
preferred.
CRCData
Specifies whether a cyclic redundancy check (CRC) validates storage pool data
when audit volume processing occurs on the server. This parameter is only
DEFINE STGPOOL Active-data Sequential Access
Chapter 2. Administrative commands 357
valid for NATIVE data format storage pools. This parameter is optional. The
default value is NO. By setting CRCDATA to YES and scheduling an AUDIT
VOLUME command you can continually ensure the integrity of data stored in
your storage hierarchy. Possible values are:
Yes
Specifies that data is stored containing CRC information, allowing for audit
volume processing to validate storage pool data. This mode impacts
performance because additional overhead is required to calculate and
compare CRC values between the storage pool and the server.
No
Specifies that data is stored without CRC information.
Examples
Task
Define an active-data pool, TAPEPOOL2, to the DC480 device class. Allow up to 50
scratch volumes for this pool. Delay the reuse of volumes for 45 days.
Command
define stgpool tapepool3 dc500 pooltype=activedata
maxscratch=50 reusedelay=45
DEFINE STGPOOL Active-data Sequential Access

358 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE SUBSCRIPTION (Define a profile subscription)
Use this command on a managed server to subscribe that managed server to a
profile.
When a server subscribes to its first profile, a subscription is also created to the
default profile (if one exists) of the configuration manager. The server then contacts
the configuration manager periodically for configuration updates.
Note:
1. A server cannot subscribe to profiles from more than one configuration
manager.
2. If a server subscribes to a profile with an associated object that is already
defined on the server, the local definition is replaced by the definition
from the configuration manager. For example, if a server has an
administrative schedule named WEEKLY_ BACKUP, then subscribes to a
profile that also has an administrative schedule named
WEEKLY_BACKUP, the local definition is replaced.
Privilege class
To issue this command, you must have system privilege.
Syntax
DEFine SUBSCRIPtion profile_name
SERVer

=

server_name


Parameters
profile_name (Required)
Specifies the name of the profile to which the server subscribes.
SERVer
Specifies the name of the configuration manager from which the configuration
information is obtained. This parameter is required, if the managed server does
not have at least one subscription. If the managed server has a subscription,
you can omit this parameter and it defaults to the configuration manager for
that subscription.
Examples
Task
Subscribe a profile named BETA that resides on a configuration manager named
TOM.
Command
define subscription beta server=tom
Related commands
Table 100. Commands related to DEFINE SUBSCRIPTION
Command Description
COPY PROFILE Creates a copy of a profile.
DEFINE SUBSCRIPTION
Chapter 2. Administrative commands 359
Table 100. Commands related to DEFINE SUBSCRIPTION (continued)
Command Description
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
DELETE PROFILE Deletes a profile from a configuration
manager.
DELETE SUBSCRIBER Deletes obsolete managed server
subscriptions.
DELETE SUBSCRIPTION Deletes a specified profile subscription.
LOCK PROFILE Prevents distribution of a configuration
profile.
NOTIFY SUBSCRIBERS Notifies servers to refresh their configuration
information.
QUERY PROFILE Displays information about configuration
profiles.
QUERY SUBSCRIBER Displays information about subscribers and
their subscriptions to profiles.
QUERY SUBSCRIPTION Displays information about profile
subscriptions.
SET CONFIGREFRESH Specifies a time interval for managed servers
to contact configuration managers.
UNLOCK PROFILE Enables a locked profile to be distributed to
managed servers.
UPDATE PROFILE Changes the description of a profile.

DEFINE SUBSCRIPTION

360 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE VIRTUALFSMAPPING (Define a virtual file space
mapping)
Use this command to define a virtual file space mapping.
Virtual file space names can be used in the NAS data operations BACKUP NODE
and RESTORE NODE similar to a file system name. Refer to the documentation
about your NAS device for guidance on specifying the parameters for this
command.
Note: The NAS node must have an associated data mover definition because when
the Tivoli Storage Manager server updates a virtual file space mapping, the
server attempts to contact the NAS device to validate the virtual file system
and file system name.
Privilege class
To perform this task, you must have one of the following privilege classes:
v System privilege
v Unrestricted policy privilege
v Restricted policy privilege for the domain to which the NAS node is assigned.
Syntax
DEFine VIRTUALFSmapping node_name virtual_filespace_name

file_system_name

path
NAMEType = SERVER
NAMEType

=

SERVER

HEXadecimal

Parameters
node_name (Required)
Specifies the NAS node on which the file system and path reside. You cannot
use wildcard characters or specify a list of names.
virtual_filespace_name (Required)
Specifies the name which refers to this virtual file space definition. The virtual
file space name is case sensitive and the first character must be a forward slash
/. The length of the name cannot be more than 64 characters, including the
required forward slash. Virtual file space names are restricted to the same
character set as all other objects in the Tivoli Storage Manager server except
that the forward slash / character is also allowed.
The virtual file space name cannot be identical to any file system on the NAS
node. Consider the following when selecting a virtual file space name:
v Use a string for the virtual file space name that is unlikely to be used as a
real file system name on your NAS device in the future. If a file system is
created on the NAS device with the same name as a virtual file system, a
name conflict will occur on the Tivoli Storage Manager server when the new
file space is backed up.
For example: A user follows a naming convention for creating file spaces on
a NAS device with names of the form /vol1, /vol2, /vol3. The user defines
DEFINE VIRTUALFSMAPPING
Chapter 2. Administrative commands 361
a virtual file space to the Tivoli Storage Manager server with the name
/vol9. If the user continues to use the same naming convention, the virtual
file space name is likely to conflict with a real file space name at some point
in the future.
v During backup and restore operations, Tivoli Storage Manager will verify
that a name conflict does not occur prior to starting the operation.
v Because the virtual file space name will appear as a file space in the output
of the QUERY FILESPACE command, and also in the backup and restore
panels of the Tivoli Storage Manager Web client, you should consider
selecting a name that unambiguously identifies this object as a directory
path on the NAS device.
file_system_name (Required)
Specifies the name of the file system in which the path is located. The file
system name must exist on the specified NAS node. The file system name
cannot contain wildcard characters.
path (Required)
Specifies the path from the root of the file system to the directory. The path can
only reference a directory. The maximum length of the path is 1024 characters.
The path name is case sensitive.
NAMEType
Specifies how the server should interpret the path name specified. This
parameter is useful when a path contains characters that are not part of the
code page in which the server is running. The default value is SERVER.
Possible values are:
SERVER
The server uses the server code page to interpret the path name.
HEXadecimal
The server interprets the path that you enter as the hexadecimal
representation of the path. This option should be used when a path
contains characters that cannot be entered. This could occur if the NAS file
system is set to a language different from the one in which the server is
running.
Examples
Task
Define the virtual filespace mapping name /mikeshomedir for the path
/home/mike on the file system /vol/vol1 on the NAS node named NAS1.
Command
define virtualfsmapping nas1 /mikeshomedir /vol/vol1 /home/mike
Related commands
Table 101. Commands related to DEFINE VIRTUALFSMAPPING
Command Description
DELETE VIRTUALFSMAPPING Delete a virtual file space mapping.
QUERY VIRTUALFSMAPPING Query a virtual file space mapping.
UPDATE VIRTUALFSMAPPING Update a virtual file space mapping.

DEFINE VIRTUALFSMAPPING

362 IBM Tivoli Storage Manager for Windows: Administrators Reference
DEFINE VOLUME (Define a volume in a storage pool)
Use this command to assign a random or sequential access volume to a storage
pool.
When defining a random access (DISK) storage pool volume or a sequential access
storage pool volume that is associated with a FILE device class, you can have the
server create the volume before it is assigned or you can use space triggers to
create pre-assigned volumes when predetermined space-utilization thresholds have
been exceeded. (For details about space triggers, see DEFINE SPACETRIGGER
(Define the space trigger) on page 316.) For volumes associated with device
classes other than DISK or device types other than FILE, you can use the DEFINE
VOLUME command to assign an already-created volume to a storage pool.
To create space in sequential access storage pools, you can define volumes or allow
the server to request scratch volumes as needed, as specified by the
MAXSCRATCH parameter for the storage pool. For storage pools associated with
the FILE device class, the server can create private volumes as needed using
storage pool space triggers. For DISK storage pools, the scratch mechanism is not
available. However, you can create space by creating volumes and then defining
them to the server or by having the server create volumes using storage pool space
triggers.
Defining a volume in a storage pool associated with a library does not set its status
to private. To specify a volume as a private volume, you can issue the UPDATE
LIBVOLUME command. It is recommended that you issue the UPDATE
LIBVOLUME command before issuing the DEFINE VOLUME command.
Attention: The size of a storage pool volume cannot be changed once it has been
defined to the Tivoli Storage Manager server. If you change the size of Tivoli
Storage Manager volumes by altering the file sizes of the volumes with operating
system commands or utilities, the server may not initialize correctly and data
could be lost.
You cannot use this command to define volumes in storage pools with the
parameter setting RECLAMATIONTYPE=SNAPLOCK. Volumes in this type of
storage pool are allocated by using the MAXSCRATCH parameter on the storage
pool definition.
You cannot define volumes in a storage pool defined with the CENTERA device
class.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the storage pool to which the volume is
assigned.
Syntax

DEFine Volume

pool_name

volume_name
ACCess = READWrite
ACCess

=

READWrite

READOnly

UNAVailable

(1)

OFfsite

DEFINE VOLUME
Chapter 2. Administrative commands 363

Wait

=

No

Formatsize

=

megabytes

Wait

=

No

Yes

Numberofvolumes = 1
(2)

Numberofvolumes

=

number

(3)

LOcation

=

location

Notes:
1 This value is valid only for volumes assigned to copy storage pools.
2 This parameter is valid only for DISK or FILE volumes.
3 This parameter is valid only for sequential access volumes.
Parameters
pool_name (Required)
Specifies the name of the storage pool to which the volume is assigned.
volume_name (Required)
Specifies the name of the storage pool volume to be defined. If you specify a
number greater than 1 for the NUMBEROFVOLUMES parameter, the volume
name is used as a prefix to generate multiple volume names. The volume
name that you specify depends on the type of device that the storage pool
uses. See Table 102.
Each volume used by a server for any purpose must have a unique name. This
requirement applies to all volumes, whether the volumes are used for storage
pools, or used for operations such as database backup or export. The
requirement also applies to volumes that reside in different libraries but that
are used by the same server.
Note: Volume names cannot contain embedded blanks or equal signs, except
for DISK or FILE volumes.
Table 102. Volume name requirements by device type
Device Type Volume Name Requirements Example
DISK The name of the file to contain the volume data,
with either the fully qualified path name or a path
name relative to the current working directory
If a name contains embedded blanks, equal signs, or
other special characters, enclose the list in quotation
marks.
"c:\program files\tivoli\tsm\server\data3.dsm"
DEFINE VOLUME

364 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 102. Volume name requirements by device type (continued)
Device Type Volume Name Requirements Example
FILE The name of the file to contain the volume data,
with either the fully qualified path name or the path
name relative to a directory identified in the
DIRECTORY parameter for the device class.
If a name contains embedded blanks, equal signs, or
other special characters, enclose the list in quotation
marks.
Place FILE volumes in one of the directories
specified with the DIRECTORY parameter of the
DEFINE DEVCLASS command. Otherwise, storage
agents might not have access to the volumes. For
details, see DEFINE PATH (Define a path) on page
263.
"f:\data storage\fpool01.dsm"
Tape 132 alphanumeric characters
The server converts volume names to uppercase.
DSMT01
OPTICAL or WORM 132 alphanumeric characters
The server converts volume names to uppercase.
DSM_SP001
REMOVABLEFILE 16 alphanumeric characters
The server converts volume names to uppercase.
DSM01

ACCess
Specifies how client nodes and server processes (such as migration) can access
files in the storage pool volume. This parameter is optional. The default value
is READWRITE. Possible values are:
READWrite
Specifies that client nodes and server processes can read from and write to
files stored on the volume.
READOnly
Specifies that client nodes and server processes can only read files stored
on the volume.
UNAVailable
Specifies that neither client nodes nor server processes can access files
stored on the volume.
If you define a random access volume as UNAVAILABLE, you cannot vary
the volume online.
If you define a sequential access volume as UNAVAILABLE, the server
does not attempt to access the volume.
OFfsite
Specifies that the volume is at an offsite location from which it cannot be
mounted. You can specify this value only for volumes in copy storage
pools.
Use this value to help you track volumes at offsite locations. The server
treats volumes designated as offsite differently:
v The server does not generate mount requests for volumes designated
offsite.
v The server reclaims or moves data from offsite volumes by retrieving
files from other storage pools.
DEFINE VOLUME
Chapter 2. Administrative commands 365
v The server does not automatically delete empty, offsite scratch volumes
from a copy storage pool.
LOcation
Specifies the location of the volume. This parameter is optional. It can be
specified only for volumes in sequential access storage pools. The location
information can be a maximum length of 255 characters. Enclose the location in
quotation marks if it contains any blank characters.
Formatsize
Specifies the size of the random access volume or FILE volume that is created
and formatted in one step. The value is specified in megabytes. This parameter
is required if any of the following conditions are true:
v A single FILE or DISK volume is specified, which is to be created and
formatted in one step.
v The value for the NUMBEROFVOLUMES parameter is greater than 1, and
DISK volumes are being created.
v The value of the NUMBEROFVOLUMES parameter is greater than 1, and
the value of the FORMATSIZE parameter is less than or equal to the
MAXCAPACITY parameter of the DEFINE DEVCLASS command.
For a FILE volume, you must specify a value less than or equal to the value of
the MAXCAPACITY parameter of the device class associated with the storage
pool.
You cannot use this parameter for multiple, predefined volumes. Unless
WAIT=YES is specified, the operation is performed as a background process.
Numberofvolumes
Specifies the number of volumes that are created and formatted in one step.
This parameter applies only to storage pools with DISK- or FILE-type device
classes. This parameter is optional. The default is 1. If you specify a value
greater than 1, you must also specify a value for the FORMATSIZE parameter.
Specify a number from 1 to 256.
If the value for the NUMBEROFVOLUMES parameter is greater than 1, the
volume name you specified will have a numeric suffix appended to create each
name (for example, tivolivol001, tivolivol002, and so on). Be sure to chose a
volume name so that a valid file name for the target file system is created
when the suffix is appended.
Note: You must ensure that storage agents can access newly created FILE
volumes. For more information, see DEFINE PATH (Define a path) on
page 263.
Wait
Specifies whether volume creation and formatting operation is performed in
the foreground or background. This parameter is optional. It is ignored unless
you also specify the FORMATSIZE parameter.
No
Specifies that a volume creation and formatting operation is performed in
the background. This is the default when you also specify a format size.
Yes
Specifies that a volume creation and formatting operation is performed in
the foreground.
Note: You cannot specify WAIT=YES from the server console.
DEFINE VOLUME

366 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task
Create a new volume of 100 MB in the disk storage pool named BACKUPPOOL.
The volume name is j:\storage\bf.dsm. Let the volume be created as a background
process.
Command
define volume backuppool j:\storage\bf.dsm formatsize=100
Task
A storage pool named POOL1 is assigned to a tape device class. Define a volume
named TAPE01 to this storage pool, with READWRITE access.
Command
define volume pool1 tape01 access=readwrite
Task
A storage pool named FILEPOOL is assigned to a device class with a device type
of FILE. Define a volume named fp_vol01.dsm to this storage pool.
Command
define volume filepool j:\storage\fp_vol01.dsm
Task
Define ten volumes in a sequential storage pool that uses a FILE device class. The
storage pool is named FILEPOOL. The value of the MAXCAPACITY parameter for
the device class associated with this storage pool is 5 GB. Creation will occur in the
background.
Command
define volume filepool filevol numberofvolumes=10 formatsize=5000
The Tivoli Storage Manager server creates volume names filevol001
through filevol010.
Volumes are created in the directory or directories specified with the
DIRECTORY parameter of the device class associated with storage pool
filepool. If you specified multiple directories for the device class,
individual volumes can be created in any of the directories in the list.
Related commands
Table 103. Commands related to DEFINE VOLUME
Command Description
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE VOLUME Deletes a volume from a storage pool.
QUERY VOLUME Displays information about storage pool
volumes.
UPDATE DEVCLASS Changes the attributes of a device class.
UPDATE LIBVOLUME Changes the status of a storage volume.
DEFINE VOLUME
Chapter 2. Administrative commands 367
Table 103. Commands related to DEFINE VOLUME (continued)
Command Description
UPDATE VOLUME Updates the attributes of storage pool
volumes.

DEFINE VOLUME

368 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE commands
Use the DELETE commands to delete or remove a Tivoli Storage Manager object.
The following is a list of DELETE commands for Tivoli Storage Manager:
v DELETE ASSOCIATION (Delete the node association to a schedule) on page
371
v DELETE BACKUPSET (Delete a backup set) on page 373
v DELETE CLIENTOPT (Delete an option in an option set) on page 378
v DELETE CLOPTSET (Delete a client option set) on page 379
v DELETE COLLOCGROUP (Delete a collocation group) on page 380
v DELETE COLLOCMEMBER (Delete collocation group member) on page 382
v DELETE COPYGROUP (Delete a copy group) on page 384
v DELETE DATAMOVER (Delete a data mover) on page 386
v DELETE DBBACKUPTRIGGER (Delete the database backup trigger) on page
387
v DELETE DBVOLUME (Delete a database volume) on page 388
v DELETE DEVCLASS (Delete a device class) on page 389
v DELETE DOMAIN (Delete a policy domain) on page 390
v DELETE DRIVE (Delete a drive from a library) on page 391
v DELETE EVENT (Delete event records) on page 392
v DELETE EVENTSERVER (Deletes the definition of the event server) on page
394
v DELETE FILESPACE (Delete client node data from the server) on page 395
v DELETE GRPMEMBER (Delete a server from a server group) on page 399
v DELETE KEYRING (Delete password information in the certificate key
database) on page 400
v DELETE LIBRARY (Delete a library) on page 401
v DELETE LOGVOLUME (Delete a recovery log volume) on page 402
v DELETE MACHINE (Delete machine information) on page 403
v DELETE MACHNODEASSOCIATION (Delete association between a machine
and a node) on page 404
v DELETE MGMTCLASS (Delete a management class) on page 405
v DELETE NODEGROUP (Delete a node group) on page 407
v DELETE NODEGROUPMEMBER (Delete node group member) on page 408
v DELETE PATH (Delete a path) on page 409
v DELETE POLICYSET (Delete a policy set) on page 411
v DELETE PROFASSOCIATION (Delete a profile association) on page 412
v DELETE PROFILE (Delete a profile) on page 415
v DELETE RECMEDMACHASSOCIATION (Delete recovery media and machine
association) on page 417
v DELETE RECOVERYMEDIA (Delete recovery media) on page 418
v DELETE SCHEDULE (Delete a client or an administrative command schedule)
on page 419
v DELETE SCRIPT (Delete command lines from a script or delete the entire
script) on page 422
v DELETE SERVER (Delete a server definition) on page 423
DELETE commands
Chapter 2. Administrative commands 369
v DELETE SERVERGROUP (Delete a server group) on page 424
v DELETE SPACETRIGGER (Delete the database or recovery log space triggers)
on page 425
v DELETE STGPOOL (Delete a storage pool) on page 427
v DELETE SUBSCRIBER (Delete subscriptions from a configuration manager
database) on page 429
v DELETE SUBSCRIPTION (Delete a profile subscription) on page 430
v DELETE VIRTUALFSMAPPING (Delete a virtual file space mapping) on page
431
v DELETE VOLHISTORY (Delete sequential volume history information) on
page 432
v DELETE VOLUME (Delete a storage pool volume) on page 437
DELETE commands

370 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE ASSOCIATION (Delete the node association to a
schedule)
Use this command to delete the association of a client node to a client schedule.
Tivoli Storage Manager no longer runs the schedule on the client node.
If you try to disassociate a client from a schedule to which it is not associated, this
command has no effect for that client.
Privilege class
To perform this task, you must have one of the following privilege classes:
v System privilege
v Unrestricted policy privilege
v Restricted policy privilege for the domain to which the schedule belongs
Syntax

DELete ASSOCiation

domain_name

schedule_name

,
node_name

Parameters
domain_name (Required)
Specifies the name of the policy domain to which the schedule belongs.
schedule_name (Required)
Specifies the name of the schedule from which clients are to be disassociated.
node_name (Required)
Specifies the name of the client node that is no longer associated with the
client schedule. You can specify a list of clients which are to be no longer
associated with the specified schedule. Commas, with no intervening spaces,
separate the items in the list. You can also use a wildcard character to specify a
name. All matching clients are disassociated from the specified schedule.
Examples
Task 1
Delete the association of the node JEFF, assigned to the DOMAIN1 policy domain,
to the WEEKLY_BACKUP schedule.
Command
delete association domain1 weekly_backup jeff
Task 2
Delete the association of selected clients, assigned to the DOMAIN1 policy domain,
to the WEEKLY_BACKUP schedule so that this schedule is no longer executed by
these clients. The nodes that are disassociated from the schedule contain ABC or
XYZ in the node name.
Command
delete association domain1 weekly_backup *abc*,*xyz*
DELETE ASSOCIATION
Chapter 2. Administrative commands 371
Related commands
Table 104. Commands related to DELETE ASSOCIATION
Command Description
DEFINE ASSOCIATION Associates clients with a schedule.
QUERY ASSOCIATION Displays the clients associated with one or
more schedules.

DELETE ASSOCIATION

372 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE BACKUPSET (Delete a backup set)
Use this command to manually delete a backup set before its retention period
expires.
When the server creates a backup set, the retention period assigned to the backup
set determines how long the backup set remains in the database. When that date
passes, the server automatically deletes the backup set when expiration processing
runs. However, you can also manually delete the clients backup set from the
server before it is scheduled to expire by using the DELETE BACKUPSET
command.
Note: If the volumes contain multiple backup sets, they are not returned to scratch
status until all the backup sets are expired or are deleted.
Privilege class
If the REQSYSAUTHOUTFILE server option is set to YES (the default), the
administrator must have system privilege. If the REQSYSAUTHOUTFILE server
option is set to NO, the administrator must have system privilege or policy
privilege for the domain to which the client node is assigned.
Syntax

DELete BACKUPSET

,
node_name

node_group_name

,
backup_set_name

BEGINDate

=

date

BEGINTime

=

time

ENDDate

=

date

ENDTime

=

time

WHEREDATAType = ALL
,

WHEREDATAType

=

FILE

IMAGE

APPL

WHERERETention

=

days

NOLimit

WHEREDESCription

=

description

Preview = No
Preview

=

No

Yes

DELETE BACKUPSET
Chapter 2. Administrative commands 373
Parameters
node_name or node_group_name (Required)
Specifies the name of the client nodes or node groups whose data is contained
in the specified backup set volumes. To specify multiple node and node group
names, separate the names with commas and no intervening spaces. Any node
name you specify may contain wildcard characters, but node group names
cannot contain wildcard characters. If backup set volumes contain backup sets
from multiple nodes then every backup set whose node name matches one of
the specified node names will be deleted.
backup_set_name (Required)
Specifies the name of the backup set to delete. The backup set name you
specify can contain wildcard characters. You can specify more than one backup
set name by separating the names with commas and no intervening spaces.
BEGINDate
Specifies the beginning date in which the backup set to delete was created.
This parameter is optional. You can use this parameter with the BEGINTIME
parameter to specify a range for the date and time. If you specify a begin date
without a begin time, the time will be at 12:00 a.m. (midnight) on the date you
specify.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1999
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified.
TODAY +3 or +3.
TODAY-days or
-days
The current date minus days
specified.
TODAY -3 or -3.

BEGINTime
Specifies the beginning time in which the backup set to delete was created.
This parameter is optional. You can use this parameter in conjunction with the
BEGINDATE parameter to specify a range for the date and time. If you specify
a begin time without a begin date, the date will be the current date at the time
you specify.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes specified
NOW+02:00 or +02:00.
NOW-HH:MM or
-HH:MM
The current time minus hours
and minutes specified
NOW-02:00 or 02:00.

ENDDate
Specifies the ending date in which the backup set to delete was created. This
parameter is optional. You can use this parameter in conjunction with the
ENDTIME parameter to specify a range for the date and time. If you specify
an end date without an end time, the time will be at 11:59:59 p.m. on the
specified end date.
DELETE BACKUPSET

374 IBM Tivoli Storage Manager for Windows: Administrators Reference
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1999
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified.
TODAY +3 or +3.
TODAY-days or
-days
The current date minus days
specified.
TODAY -3 or -3.

ENDTime
Specifies the ending time of the range in which the backup set to delete was
created. This parameter is optional. You can use this parameter in conjunction
with the ENDDATE parameter to specify a range for the date and time. If you
specify an end time without an end date, the date will be the current date at
the time you specify.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
end date
NOW+02:00 or +02:00.
NOW-HH:MM or
-HH:MM
The current time minus hours
and minutes on the specified
end date
NOW-02:00 or -02:00.

WHEREDATAType
Specifies the backup sets containing the specified types of data are to be
deleted. This parameter is optional. The default is that backup sets for all types
of data (file level, image, and application) are to be deleted. To specify multiple
data types, separate the data types with commas and no intervening spaces.
Possible values are:
ALL
Specifies that backup sets for all types of data (file level, image, and
application) are to be deleted. This is the default.
FILE
Specifies that a file level backup set is to be deleted. File level backup sets
contain files and directories backup up by the backup-archive client.
IMAGE
Specifies that an image backup set is to be deleted. Image backup sets
contain images created by the backup-archive client BACKUP IMAGE
command.
APPL
Specifies that an application backup set is to be deleted. Application
backup sets contain data backed up to the Tivoli Storage Manager server
by applications using the Tivoli Storage Manager application programming
interface. This parameter applies only if the Tivoli Storage Manager server
DELETE BACKUPSET
Chapter 2. Administrative commands 375
was upgraded from Tivoli Storage Manager Express and only for the Tivoli
Storage Manager Express versions of Data Protection for Exchange and
Data Protection for SQL.
WHERERETention
Specifies the retention value, specified in days, that is associated with the
backup sets to delete. You can specify an integer from 0 to 30000. The values
are:
days
Specifies that backup sets that are retained this number of days are
deleted.
NOLimit
Specifies that the backup sets that are retained indefinitely are deleted.
WHEREDESCription
Specifies the description that is associated with the backup set to delete. The
description you specify can contain a wildcard character. This parameter is
optional. Enclose the description in quotation marks if it contains any blank
characters.
Preview
Specifies whether to preview the list of backup sets to delete, without actually
deleting the backup sets. This parameter is optional. The default value is NO.
The values are:
No
Specifies that the backup sets are deleted.
Yes
Specifies that the server displays the list of backup sets to delete, without
actually deleting the backup sets.
Examples
Task
Delete backup set named PERS_DATA.3099 that belongs to client node JANE. The
backup set was generated on 11/19/1998 at 10:30:05 and the description is
Documentation Shop.
Command
delete backupset pers_data.3099
begindate=11/19/1998 begintime=10:30:05
wheredescription="documentation shop"
Related commands
Table 105. Commands related to DELETE BACKUPSET
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
DELETE BACKUPSET

376 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 105. Commands related to DELETE BACKUPSET (continued)
Command Description
GENERATE BACKUPSETTOC Generates a table of contents for a backup
set.
QUERY BACKUPSET Displays backup sets.
QUERY NODEGROUP Displays information about node groups.
QUERY BACKUPSETCONTENTS Displays contents contained in backup sets.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.
UPDATE NODEGROUP Updates the description of a node group.

DELETE BACKUPSET
Chapter 2. Administrative commands 377
DELETE CLIENTOPT (Delete an option in an option set)
Use this command to delete a client option in an option set.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege.
Syntax
DELete CLIENTOpt option_set_name option_name

SEQnumber

=

number

ALL


Parameters
option_set_name (Required)
Specifies the name of the client option set.
option_name (Required)
Specifies a valid client option.
SEQnumber
Specifies a sequence number when an option name is specified more than
once. This parameter is optional. Valid values are:
n Specifies an integer of 0 or greater.
ALL
Specifies all sequence numbers.
Examples
Task
Delete the date format option in an option set named ENG.
Command
delete clientopt eng dateformat
Related commands
Table 106. Commands related to DELETE CLIENTOPT
Command Description
COPY CLOPTSET Copies a client option set.
DEFINE CLIENTOPT Adds a client option to a client option set.
DEFINE CLOPTSET Defines a client option set.
DELETE CLOPTSET Deletes a client option set.
QUERY CLOPTSET Displays information about a client option
set.
UPDATE CLIENTOPT Updates the sequence number of a client
option.
UPDATE CLOPTSET Updates the description of a client option set.

DELETE CLIENTOPT

378 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE CLOPTSET (Delete a client option set)
Use this command to delete a client option set.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege.
Syntax
DELete CLOptset option_set_name

Parameters
option_set_name (Required)
Specifies the name of the client option set to delete.
Examples
Task
Delete a client option set named ENG.
Command
delete cloptset eng
Related commands
Table 107. Commands related to DELETE CLOPTSET
Command Description
COPY CLOPTSET Copies a client option set.
DEFINE CLIENTOPT Adds a client option to a client option set.
DEFINE CLOPTSET Defines a client option set.
DELETE CLIENTOPT Deletes a client option from a client option
set.
QUERY CLOPTSET Displays information about a client option
set.
UPDATE CLIENTOPT Updates the sequence number of a client
option.
UPDATE CLOPTSET Updates the description of a client option set.

DELETE CLOPTSET
Chapter 2. Administrative commands 379
DELETE COLLOCGROUP (Delete a collocation group)
Use this command to delete a collocation group. You cannot delete a collocation
group if it has any members in it.
You can remove all the members in the collocation group by issuing the DELETE
COLLOCMEMBER command with a wildcard in the node_name parameter.
Privilege class
To issue this command, you must have system or unrestricted storage privilege.
Syntax
DELete COLLOCGroup group_name

Parameters
group_name
Specifies the name of the collocation group that you want to delete.
Examples
Task
Delete a collocation group named group1.
Command
delete collocgroup group1
Related commands
Table 108. Commands related to DELETE COLLOCGROUP
Command Description
DEFINE COLLOCGROUP Defines a collocation group.
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE COLLOCMEMBER Deletes a client node from a collocation
group.
MOVE NODEDATA Moves data for one or more nodes, or a
single node with selected filespaces.
QUERY COLLOCGROUP Displays information about collocation
groups.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY NODEDATA Displays information about the location and
size of data for a client node.
QUERY STGPOOL Displays information about storage pools.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
UPDATE COLLOCGROUP Updates the description of a collocation
group.
DELETE COLLOCGROUP

380 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 108. Commands related to DELETE COLLOCGROUP (continued)
Command Description
UPDATE STGPOOL Changes the attributes of a storage pool.

DELETE COLLOCGROUP
Chapter 2. Administrative commands 381
DELETE COLLOCMEMBER (Delete collocation group member)
Use this command to delete a client node from a collocation group.
Privilege class
To issue this command, you must have system or unrestricted storage privilege.
Syntax

,
DELete COLLOCMember

group_name

node_name

Parameters
group_name
Specifies the name of the collocation group from which you want to delete a
client node.
node_name
Specifies the name of the client node that you want to delete from the
collocation group. You can specify one or more names. When specifying
multiple names, separate the names with commas; do not use intervening
spaces. You can also use wildcard characters to specify multiple nodes.
Examples
Task
Delete two nodes, node1 and node2, from a collocation group, group1.
Command
delete collocmember group1 node1,node2
Related commands
Table 109. Commands related to DELETE COLLOCMEMBER
Command Description
DEFINE COLLOCGROUP Defines a collocation group.
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE COLLOCGROUP Deletes a collocation group.
MOVE NODEDATA Moves data for one or more nodes, or a
single node with selected filespaces.
QUERY COLLOCGROUP Displays information about collocation
groups.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY NODEDATA Displays information about the location and
size of data for a client node.
QUERY STGPOOL Displays information about storage pools.
DELETE COLLOCMEMBER

382 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 109. Commands related to DELETE COLLOCMEMBER (continued)
Command Description
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
UPDATE COLLOCGROUP Updates the description of a collocation
group.
UPDATE STGPOOL Changes the attributes of a storage pool.

DELETE COLLOCMEMBER
Chapter 2. Administrative commands 383
DELETE COPYGROUP (Delete a copy group)
Use this command to delete a backup or archive copy group from a management
class. You cannot delete a copy group in the ACTIVE policy set.
When you activate the changed policy set, any files that are bound to a deleted
copy group are managed by the default management class.
You can delete the predefined STANDARD copy group in the STANDARD policy
domain (STANDARD policy set, STANDARD management class). However, if you
later reinstall the Tivoli Storage Manager server, the process restores all
STANDARD policy objects.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the copy
group belongs.
Syntax

DELete COpygroup

domain_name

policy_set_name

class_name
STANDARD
STANDARD

Type = Backup
Type

=

Backup

Archive

Parameters
domain_name (Required)
Specifies the policy domain to which the copy group belongs.
policy_set_name (Required)
Specifies the policy set to which the copy group belongs.
class_name (Required)
Specifies the management class to which the copy group belongs.
STANDARD
Specifies the copy group, which is always STANDARD. This parameter is
optional. The default value is STANDARD.
Type
Specifies the type of copy group to delete. This parameter is optional. The
default value is BACKUP. Possible values are:
Backup
Specifies that the backup copy group is deleted.
Archive
Specifies that the archive copy group is deleted.
Examples
Task 1
DELETE COPYGROUP

384 IBM Tivoli Storage Manager for Windows: Administrators Reference
Delete the backup copy group from the ACTIVEFILES management class that is in
the VACATION policy set of the EMPLOYEE_RECORDS policy domain.
Command
delete copygroup employee_records
vacation activefiles
Task 2
Delete the archive copy group from the MCLASS1 management class that is in the
SUMMER policy set of the PROG1 policy domain.
Command
delete copygroup prog1 summer mclass1 type=archive
Related commands
Table 110. Commands related to DELETE COPYGROUP
Command Description
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
QUERY COPYGROUP Displays the attributes of a copy group.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.

DELETE COPYGROUP
Chapter 2. Administrative commands 385
DELETE DATAMOVER (Delete a data mover)
Use this command to delete a data mover. You cannot delete the data mover if any
paths are defined for this data mover.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DELete DATAMover data_mover_name

Parameters
data_mover_name (Required)
Specifies the name of the data mover.
Note: This command deletes the data mover even if there is data for the
corresponding NAS node.
Examples
Task
Delete the data mover for the node named NAS1.
Command
delete datamover nas1
Related commands
Table 111. Commands related to DELETE DATAMOVER
Command Description
DEFINE DATAMOVER Defines a data mover to the IBM Tivoli
Storage Manager server.
DEFINE PATH Defines a path from a source to a destination.
DELETE PATH Deletes a path from a source to a destination.
QUERY DATAMOVER Displays data mover definitions.
QUERY PATH Displays information about the path from a
source to a destination.
UPDATE DATAMOVER Changes the definition for a data mover.

DELETE DATAMOVER

386 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE DBBACKUPTRIGGER (Delete the database backup
trigger)
Use this command to delete the definition of the database backup trigger. After
you delete the database backup trigger, issue the SET LOGMODE command to
change the log mode to NORMAL.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DELete DBBackuptrigger

Parameters
None.
Examples
Task
Delete the definition for the database backup trigger.
Command
delete dbbackuptrigger
Related commands
Table 112. Commands related to DELETE DBBACKUPTRIGGER
Command Description
DEFINE DBBACKUPTRIGGER Defines a trigger for automatic IBM Tivoli
Storage Manager database backups.
QUERY DBBACKUPTRIGGER Displays information about the database
backup trigger.
SET LOGMODE Sets the mode for saving records in the
recovery log.
UPDATE DBBACKUPTRIGGER Changes one or more attributes of the
database backup trigger.

DELETE DBBACKUPTRIGGER
Chapter 2. Administrative commands 387
DELETE DBVOLUME (Delete a database volume)
Use this command to delete a database volume or database volume copy. This
command might require that data on the volume be moved to other database
volumes.
Note: You cannot delete the last synchronized volume in a group of mirrored
volumes unless Tivoli Storage Manager can move the information on the
volume to other synchronized volumes.
This command generates a background process that you can cancel with the
CANCEL PROCESS command. If a DELETE DBVOLUME process is canceled,
some of the database data may have already been moved. To display information
on background processes, use the QUERY PROCESS command.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DELete DBVolume volume_name

Parameters
volume_name (Required)
Specifies the name of the database volume.
Examples
Task
Delete the database volume named db2.dsm
Command
delete dbvolume db2.dsm
Related commands
Table 113. Commands related to DELETE DBVOLUME
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE DBCOPY Creates a volume copy of a database volume.
DEFINE DBVOLUME Assigns a volume to be used for database
storage.
QUERY DBVOLUME Displays information database volumes.
QUERY PROCESS Displays information about background
processes.

DELETE DBVOLUME

388 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE DEVCLASS (Delete a device class)
Use this command to delete a device class.
To use this command, you must first delete all storage pools assigned to the
specified device class and, if necessary, cancel any database dump, export, or
import processes that are using the device class.
You cannot delete the device class DISK, which is predefined at installation, but
you can delete any device classes defined by the Tivoli Storage Manager
administrator.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DELete DEVclass device_class_name

Parameters
device_class_name (Required)
Specifies the name of the device class to be deleted.
Examples
Task
Delete the device class named MYTAPE. There are no storage pools assigned to the
device class.
Command
delete devclass mytape
Related commands
Table 114. Commands related to DELETE DEVCLASS
Command Description
DEFINE DEVCLASS Defines a device class.
QUERY DEVCLASS Displays information about device classes.
QUERY DIRSPACE Displays information about FILE directories.
UPDATE DEVCLASS Changes the attributes of a device class.

DELETE DEVCLASS
Chapter 2. Administrative commands 389
DELETE DOMAIN (Delete a policy domain)
Use this command to delete a policy domain. All associated policy sets,
management classes, and copy groups are deleted along with the policy domain.
You cannot delete a policy domain to which client nodes are registered.
You can delete the predefined STANDARD policy domain. However, if you later
reinstall the Tivoli Storage Manager server, the process restores all STANDARD
policy objects.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete DOmain domain_name

Parameters
domain_name (Required)
Specifies the policy domain to delete.
Examples
Task
Delete the EMPLOYEE_RECORDS policy domain.
Command
delete domain employee_records
Related commands
Table 115. Commands related to DELETE DOMAIN
Command Description
COPY DOMAIN Creates a copy of a policy domain.
DEFINE DOMAIN Defines a policy domain that clients can be
assigned to.
QUERY DOMAIN Displays information about policy domains.
UPDATE DOMAIN Changes the attributes of a policy domain.

DELETE DOMAIN

390 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE DRIVE (Delete a drive from a library)
Use this command to delete a drive from a library. A drive that is in use cannot be
deleted.
All paths related to a drive must be deleted before the drive itself can be deleted.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DELete DRive library_name drive_name

Parameters
library_name (Required)
Specifies the name of the library where the drive is located.
drive_name (Required)
Specifies the name of the drive to be deleted.
Examples
Task
Delete DRIVE3 from the library named AUTO.
Command
delete drive auto drive3
Related commands
Table 116. Commands related to DELETE DRIVE
Command Description
DEFINE DRIVE Assigns a drive to a library.
DEFINE LIBRARY Defines an automated or manual library.
DELETE LIBRARY Deletes a library.
DELETE PATH Deletes a path from a source to a destination.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more
libraries.
UPDATE DRIVE Changes the attributes of a drive.

DELETE DRIVE
Chapter 2. Administrative commands 391
DELETE EVENT (Delete event records)
Use this command to delete event records from the database. An event record is
created whenever processing of a scheduled command is started or missed.
This command only deletes the event records that exist at the time the command is
processed. An event record will not be found:
v If the event record has never been created (the event is scheduled for the future)
v If the event has passed and the event record has already been deleted.
Privilege class
To issue this command, you must have system privilege or unrestricted policy
privilege.
Syntax

DELete EVent

date
00:00
time
TYPE = Client
TYPE

=

Client

ADministrative

ALl

Parameters
date (Required)
Specifies the date used to determine which event records to delete. The
maximum number of days you can specify is 9999.
Use this parameter in conjunction with the TIME parameter to specify a date
and time for deleting event records. Any record whose scheduled start occurs
before the specified date and time is deleted. However, records are not deleted
for events whose startup window has not yet passed.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified
TODAY-3 or -3.

time
Specifies the time used to determine which event records to delete. Use this
parameter in conjunction with the DATE parameter to specify a date and time
for deleting event records. Any record whose scheduled start occurs before the
specified date and time is deleted. However, records are not deleted for events
whose startup window has not yet passed. The default is 00:00.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
DELETE EVENT

392 IBM Tivoli Storage Manager for Windows: Administrators Reference
Value Description Example
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified
NOW+03:00 or +03:00
Note: If you issue this command at 9:00
using NOW+03:00 or +03:00, Tivoli
Storage Manager deletes records with a
time of 12:00 or later on the date you
specify.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW-03:00 or 03:00

TYPE
Specifies the type of events to be deleted. This parameter is optional. The
default is CLIENT. Possible values are:
Client
Specifies to delete event records for client schedules.
ADministrative
Specifies to delete event records for administrative command schedules.
ALl
Specifies to delete event records for both client and administrative
command schedules.
Examples
Task
Delete records for events with scheduled start times prior to 08:00 on May 26, 1998
(05/26/1998), and whose startup window has passed. Records for these events are
deleted regardless of whether the retention period for event records, as specified
with the SET EVENTRETENTION command, has passed.
Command
delete event 05/26/1998 08:00
Related commands
Table 117. Commands related to DELETE EVENT
Command Description
QUERY EVENT Displays information about scheduled and
completed events for selected clients.
SET EVENTRETENTION Specifies the number of days to retain
records for scheduled operations.

DELETE EVENT
Chapter 2. Administrative commands 393
DELETE EVENTSERVER (Deletes the definition of the event
server)
Use this command to delete the definition of the event server. You must issue this
command before you issue the DELETE SERVER command. If you specify the
server defined as the event server on the DELETE SERVER command, you will
receive an error message.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete EVENTSERVer

Examples
Task
Delete the definition for the event server ASTRO.
Command
delete eventserver
Related commands
Table 118. Commands related to DELETE EVENTSERVER
Command Description
DEFINE EVENTSERVER Defines a server as an event server.
QUERY EVENTSERVER Displays the name of the event server.

DELETE EVENTSERVER

394 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE FILESPACE (Delete client node data from the server)
Use this command to delete file spaces from the server. Files that belong to the file
space are deleted from primary and copy storage pools.
Tivoli Storage Manager deletes one or more file spaces as a series of batch database
transactions, thus preventing a rollback or commit for an entire file space as a
single action. If the process is canceled or if a system failure occurs, a partial
deletion can occur. A subsequent DELETE FILESPACE command for the same
node or owner can delete the remaining data.
If this command is applied to a WORM (write once, read many) volume, the
volume will return to scratch if it has space remaining in which data can be
written. (Note that data on WORM volumes, including deleted and expired data,
cannot be overwritten. Therefore, data can only be written in space that does not
contain current, deleted, or expired data.) If a WORM volume does not have any
space available in which data can be written, it will remain private. To remove the
volume from the library, you must use the CHECKOUT LIBVOLUME command.
Note:
1. If archive retention protection is enabled, the server will only delete
archive files with expired retention periods. See the SET
ARCHIVERETENTIONPROTECTION command for more information.
2. The server will not delete archive files that are on deletion hold until the
hold is released.
3. Reclamation will not start while the DELETE FILESPACE process is
running.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the client
node is assigned.
Syntax
DELete FIlespace node_name file_space_name

Type = ANY
Type

=

ANY

Backup

ARchive

SPacemanaged

SERver
DAta = ANY
DAta

=

ANY

FIles

(1)

IMages

Wait = No
Wait

=

No

Yes

OWNer

=

owner_name
NAMEType = SERVER
NAMEType

=

SERVER

UNIcode

FSID

DELETE FILESPACE
Chapter 2. Administrative commands 395

CODEType = BOTH
CODEType

=

UNIcode

NONUNIcode

BOTH

Notes:
1 This parameter can only be used when TYPE=ANY or TYPE=BACKUP is
specified.
Parameters
node_name (Required)
Specifies the name of the client node to which the file space belongs.
file_space_name (Required)
Specifies the name of the file space to be deleted. This name is case-sensitive
and must be entered exactly as it is known to the server. To determine how to
enter the name, use the QUERY FILESPACE command. You can use wildcard
characters to specify this name.
For a server that has clients with support for Unicode, you may need to have
the server convert the file space name that you enter. For example, you may
need to have the server convert the name you enter from the servers code
page to Unicode. See the NAMETYPE parameter for details. If you do not
specify a file space name, or specify only a single wildcard character for the
name, you can use the CODETYPE parameter to limit the operation to Unicode
file spaces or to non-Unicode file spaces.
Type
Specifies the type of data to be deleted. This parameter is optional. The default
value is ANY. Possible values are:
ANY
Delete only backed-up versions of files and archived copies of files.
If you specify delete filespace node_name * type=any, all backed-up data
and archived data in all file spaces for that node are deleted. File spaces
are deleted only if they do not contain files that are migrated from an HSM
client.
Backup
Delete backup data for the file space.
ARchive
Delete all archived data on the server for the file space.
SPacemanaged
Delete files migrated from a users local file system (space-managed files
from an HSM client). The OWNER parameter is ignored when you specify
TYPE=SPACEMANAGED.
SERver
Delete all archived files in all file spaces for a node that is registered as
TYPE=SERVER.
DAta
Specifies objects to delete. This parameter is optional. The default value is
ANY. Possible values are:
DELETE FILESPACE

396 IBM Tivoli Storage Manager for Windows: Administrators Reference
ANY
Delete files, directories, and images.
FIles
Delete files and directories.
IMages
Delete image objects. You can only use this parameter if you have specified
TYPE=ANY or TYPE=BACKUP.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default value is No. Possible
values are:
No
Specifies that the server processes this command in the background. You
can continue with other tasks while the command is being processed.
Messages created from the background process are displayed either in the
activity log or the server console, depending on where messages are
logged.
Yes
Specifies that the server processes this command in the foreground. Wait
for the command to complete before continuing with other tasks. The
server displays the output messages to the administrative client when the
command completes.
Note: You cannot specify Wait=Yes from the server console.
OWNer
Restricts the data that is deleted to files belonging to the owner. This
parameter is optional; it is ignored when TYPE=SPACEMANAGED. This
parameter only applies to multiuser client systems such as AIX, Linux and
SunOS.
NAMEType
Specify how you want the server to interpret the file space names that you
enter. This parameter is useful when the server has clients with support for
Unicode. A backup-archive client with support for Unicode is currently
available only for the following operating systems: Windows , Macintosh OS X,
and NetWare operating systems.
Use this parameter only when you enter a partly or fully qualified file space
name. The default value is SERVER. Possible values are:
SERVER
The server uses the servers code page to interpret the file space names.
UNIcode
The server converts the file space names from the server code page to the
UTF-8 code page. The success of the conversion depends on the actual
characters in the name and the servers code page. Conversion can fail if
the string includes characters that are not available in the server code page,
or if the server has a problem accessing system conversion routines.
FSID
The server interprets the file space names as their file space IDs (FSIDs).
CODEType
Specify what type of file spaces are to be included in the operation. The default
DELETE FILESPACE
Chapter 2. Administrative commands 397
|
|
|
is BOTH, meaning that file spaces are included regardless of code page type.
Use this parameter only when you enter a single wildcard character for the file
space name. Possible values are:
UNIcode
Include only file spaces that are in Unicode.
NONUNIcode
Include only file spaces that are not in Unicode.
BOTH
Include file spaces regardless of code page type.
Examples
Task 1
Delete the file space named C_Drive that belongs to the client node HTANG.
Command
delete filespace htang C_Drive
Task 2
Delete all files migrated from client node APOLLO (that is, all space-managed
files).
Command
delete filespace apollo * type=spacemanaged
Related commands
Table 119. Commands related to DELETE FILESPACE
Command Description
CANCEL PROCESS Cancels a background server process.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY FILESPACE Displays information about data in filespaces
that belong to a client.
QUERY OCCUPANCY Displays file space information by storage
pool.
QUERY PROCESS Displays information about background
processes.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
RENAME FILESPACE Renames a client filespace on the server.

DELETE FILESPACE

398 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE GRPMEMBER (Delete a server from a server group)
Use this command to delete a server or server group from a server group.
Privilege class
To issue this command, you must have system privilege.
Syntax

DELete GRPMEMber

group_name

,
member_name

Parameters
group_name (Required)
Specifies the group.
member_name (Required)
Specifies the server or group to delete from the group. To specify multiple
names, separate the names with commas and no intervening spaces.
Examples
Task
Delete member PHOENIX from group WEST_COMPLEX.
Command
delete grpmember west_complex phoenix
Related commands
Table 120. Commands related to DELETE GRPMEMBER
Command Description
DEFINE GRPMEMBER Defines a server as a member of a server
group.
DEFINE SERVERGROUP Defines a new server group.
DELETE SERVER Deletes the definition of a server.
DELETE SERVERGROUP Deletes a server group.
MOVE GRPMEMBER Moves a server group member.
QUERY SERVER Displays information about servers.
QUERY SERVERGROUP Displays information about server groups.
RENAME SERVERGROUP Renames a server group.
UPDATE SERVERGROUP Updates a server group.

DELETE GRPMEMBER
Chapter 2. Administrative commands 399
DELETE KEYRING (Delete password information in the
certificate key database)
Use this command to delete the password information in the Tivoli Storage
Manager database for the certificate key database file (cert.kdb).
This command is needed when the SSLTCPPORT or SSLTCPADMINPORT options
are in use and the cert.kdb file has been lost or is not recoverable. If cert.kdb does
not exist and there is no entry in the database for its password, Tivoli Storage
Manager automatically generates a new self-signed certificate in a replacement
cert.kdb file at server startup . The administrator then distributes the new public
key (that is, the corresponding cert.arm file) to the clients that are using SSL.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete KEYRing

Parameters
None
Examples
Task
The TSM administrator has deleted the current cert.kdb file and wants TSM to
generate a new one at server startup for use by SSL.
Command
delete keyring
Related commands
None
DELETE KEYRING

400 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE LIBRARY (Delete a library)
Use this command to delete an existing library. Before you delete a library, delete
the path and all associated drives.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DELete LIBRary library_name

Parameters
library_name (Required)
Specifies the name of the library to be deleted.
Examples
Task
Delete the manual library named LIBR1.
Command
delete library libr1
Related commands
Table 121. Commands related to DELETE LIBRARY
Command Description
DEFINE DRIVE Assigns a drive to a library.
DEFINE LIBRARY Defines an automated or manual library.
DEFINE PATH Defines a path from a source to a destination.
DELETE DRIVE Deletes a drive from a library.
DELETE PATH Deletes a path from a source to a destination.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more
libraries.
QUERY PATH Displays information about the path from a
source to a destination.
UPDATE DRIVE Changes the attributes of a drive.
UPDATE LIBRARY Changes the attributes of a library.
UPDATE PATH Changes the attributes associated with a
path.

DELETE LIBRARY
Chapter 2. Administrative commands 401
DELETE LOGVOLUME (Delete a recovery log volume)
Use this command to delete a recovery log volume or volume copy. When you
delete the volume from the recovery log, the server moves existing data to
available space on other volumes.
Note: You cannot delete the last synchronized volume in a group of mirrored
volumes unless Tivoli Storage Manager can move the information on the
volume to other synchronized volumes.
This command generates a background process that you can cancel with the
CANCEL PROCESS command. If a DELETE LOGVOLUME background process is
cancelled, some of the data may have already been moved. To display information
on background processes, use the QUERY PROCESS command.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DELete LOGVolume volume_name

Parameters
volume_name (Required)
Specifies the virtual address of the recovery log volume.
Examples
Task
Delete the recovery log volume log2.dsm .
Command
delete logvolume log2.dsm
Related commands
Table 122. Commands related to DELETE LOGVOLUME
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE LOGCOPY Creates a volume copy of a recovery log
volume.
DEFINE LOGVOLUME Defines a disk volume to the recovery log.
QUERY LOGVOLUME Displays information about log volumes.
QUERY PROCESS Displays information about background
processes.

DELETE LOGVOLUME

402 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE MACHINE (Delete machine information)
Use this command to delete machine description information. To replace existing
information, issue this command and then issue an INSERT MACHINE command.
Privilege class
To issue this command, you must have system privilege.
Syntax

DELete MACHine

machine_name
Type = All
Type

=

All

RECOVERYInstructions

CHaracteristics

Parameters
machine_name (Required)
Specifies the name of the machine whose information is to be deleted.
Type
Specifies the type of machine information. This parameter is optional. The
default is ALL. Possible values are:
All
Specifies all information.
RECOVERYInstructions
Specifies the recovery instructions.
CHaracteristics
Specifies the machine characteristics.
Examples
Task
Delete the machine characteristics associated with the DISTRICT5 machine.
Command
delete machine district5 type=characteristics
Related commands
Table 123. Commands related to DELETE MACHINE
Command Description
DEFINE MACHINE Defines a machine for DRM.
INSERT MACHINE Inserts machine characteristics or recovery
instructions into the IBM Tivoli Storage
Manager database.
QUERY MACHINE Displays information about machines.
QUERY RECOVERYMEDIA Displays media available for machine
recovery.
UPDATE MACHINE Changes the information for a machine.

DELETE MACHINE
Chapter 2. Administrative commands 403
DELETE MACHNODEASSOCIATION (Delete association
between a machine and a node)
Use this command to delete the association between a machine and one or more
nodes. This command does not delete the node from Tivoli Storage Manager.
Privilege class
To issue this command, you must have system privilege.
Syntax

DELete MACHNODEAssociation

machine_name

,
node_name

Parameters
machine_name (Required)
Specifies the name of a machine that is associated with one or more nodes.
node_name (Required)
Specifies the name of a node associated with a machine. If you specify a list of
node names, separate the names with commas and no intervening spaces. You
can use wildcard characters to specify a name. If a node is not associated with
the machine, that node is ignored.
Examples
Task
Delete the association between the DISTRICT5 machine and the
ACCOUNTSPAYABLE node.
Command
delete machnodeassociation district5 accountspayable
Related commands
Table 124. Commands related to DELETE MACHNODEASSOCIATION
Command Description
DEFINE MACHNODEASSOCIATION Associates an IBM Tivoli Storage Manager
node with a machine.
QUERY MACHINE Displays information about machines.

DELETE MACHNODEASSOCIATION

404 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE MGMTCLASS (Delete a management class)
Use this command to delete a management class. You cannot delete a management
class in the ACTIVE policy set. All copy groups in the management class are
deleted along with the management class.
You can delete the management class assigned as the default for a policy set, but a
policy set cannot be activated unless it has a default management class.
You can delete the predefined STANDARD management class in the STANDARD
policy domain. However, if you later reinstall the Tivoli Storage Manager server,
the process restores all STANDARD policy objects.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the
management class belongs.
Syntax
DELete MGmtclass domain_name policy_set_name class_name

Parameters
domain_name (Required)
Specifies the policy domain to which the management class belongs.
policy_set_name (Required)
Specifies the policy set to which the management class belongs.
class_name (Required)
Specifies the management class to delete.
Examples
Task
Delete the ACTIVEFILES management class from the VACATION policy set of the
EMPLOYEE_RECORDS policy domain.
Command
delete mgmtclass employee_records
vacation activefiles
Related commands
Table 125. Commands related to DELETE MGMTCLASS
Command Description
ASSIGN DEFMGMTCLASS Assigns a management class as the default
for a specified policy set.
COPY MGMTCLASS Creates a copy of a management class.
DEFINE MGMTCLASS Defines a management class.
QUERY MGMTCLASS Displays information about management
classes.
DELETE MGMTCLASS
Chapter 2. Administrative commands 405
Table 125. Commands related to DELETE MGMTCLASS (continued)
Command Description
UPDATE MGMTCLASS Changes the attributes of a management
class.

DELETE MGMTCLASS

406 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE NODEGROUP (Delete a node group)
Use this command to delete a node group. You cannot delete a node group if it has
any members in it.
Note: You can remove all the members in the node group by issuing the DELETE
NODEGROUPMEMBER command with a wildcard in the node_name
parameter.
Privilege class
To issue this command, you must have system or unrestricted policy privilege.
Syntax
DELete NODEGroup group_name

Parameters
group_name
Specifies the name of the node group that you want to delete.
Examples
Task
Delete a node group named group1.
Command
delete nodegroup group1
Related commands
Table 126. Commands related to DELETE NODEGROUP
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
QUERY BACKUPSET Displays backup sets.
QUERY NODEGROUP Displays information about node groups.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.
UPDATE NODEGROUP Updates the description of a node group.

DELETE NODEGROUP
Chapter 2. Administrative commands 407
DELETE NODEGROUPMEMBER (Delete node group member)
Use this command to delete a client node from a node group.
Privilege class
To issue this command, you must have system or unrestricted policy privilege.
Syntax

,
DELete NODEGROUPMember

group_name

node_name

Parameters
group_name
Specifies the name of the node group from which you want to delete a client
node.
node_name
Specifies the name of the client node that you want to delete from the node
group. You can specify one or more names. When specifying multiple names,
separate the names with commas; do not use intervening spaces. You can also
use wildcard characters to specify multiple nodes.
Examples
Task
Delete two nodes, node1 and node2, from a node group, group1.
Command
delete nodegroupmember group1 node1,node2
Related commands
Table 127. Commands related to DELETE NODEGROUPMEMBER
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUP Deletes a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
QUERY BACKUPSET Displays backup sets.
QUERY NODEGROUP Displays information about node groups.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.
UPDATE NODEGROUP Updates the description of a node group.

DELETE NODEGROUPMEMBER

408 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE PATH (Delete a path)
Use this command to delete a path definition
Privilege class
To issue this command you must have system privilege or unrestricted storage
privilege.
Syntax
DELete PATH source_name destination_name SRCType = DATAMover
SERVer

DESTType = DRive LIBRary = library_name
LIBRary


Parameters
source_name (Required)
Specifies the name of the source of the path to be deleted. This parameter is
required. The name specified must be that of a server or data mover that is
already defined to the server.
destination_name (Required)
Specifies the name of the destination of the path to be deleted. This parameter
is required.
SRCType (Required)
Specifies the source type of the path to be deleted. This parameter is required.
Possible values are:
DATAMover
Specifies that a data mover is the source.
SERVer
Specifies that a storage agent is the source.
DESTType (Required)
Specifies the type of the destination. Possible values are:
DRive LIBRary=library_name
Specifies that a drive is the destination. The DRIVE and LIBRARY
parameters are both required when the destination type is drive.
LIBRary
Specifies that a library is the destination.
Attention: If the path from a data mover to a library is deleted, or the
path from the server to a library is deleted, the server will not be able to
access the library. If the server is halted and restarted while in this state,
the library will not be initialized.
Examples
Task
Delete a path from a NAS data mover NAS1 to the library NASLIB.
DELETE PATH
Chapter 2. Administrative commands 409
Command
delete path nas1 naslib srctype=datamover desttype=library
Related commands
Table 128. Commands related to DELETE PATH
Command Description
DEFINE DATAMOVER Defines a data mover to the IBM Tivoli
Storage Manager server.
DEFINE PATH Defines a path from a source to a destination.
QUERY PATH Displays information about the path from a
source to a destination.
UPDATE PATH Changes the attributes associated with a
path.

DELETE PATH

410 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE POLICYSET (Delete a policy set)
Use this command to delete a policy set. You cannot delete the ACTIVE policy set.
When you delete a policy set, all management classes and copy groups that belong
to the policy set are also deleted.
You can delete the predefined STANDARD policy set. However, if you later
reinstall the Tivoli Storage Manager server, the process restores all STANDARD
policy objects.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the policy
set belongs.
Syntax
DELete POlicyset domain_name policy_set_name

Parameters
domain_name (Required)
Specifies the policy domain to which the policy set belongs.
policy_set_name (Required)
Specifies the policy set to delete.
Examples
Task
Delete the VACATION policy set from the EMPLOYEE_RECORDS policy domain.
Command
delete policyset employee_records vacation
Related commands
Table 129. Commands related to DELETE POLICYSET
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
COPY POLICYSET Creates a copy of a policy set.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
QUERY POLICYSET Displays information about policy sets.
UPDATE POLICYSET Changes the description of a policy set.
VALIDATE POLICYSET Verifies and reports on conditions the
administrator must consider before activating
the policy set.

DELETE POLICYSET
Chapter 2. Administrative commands 411
DELETE PROFASSOCIATION (Delete a profile association)
Use this command on a configuration manager to delete the association of one or
more objects from a profile. If associations are deleted, the objects are no longer
distributed to subscribing managed servers. When managed servers request
updated configuration information, the configuration manager notifies them of the
object deletions.
Attention: A managed server deletes the objects that were deleted from the
profile, unless the objects are associated with another profile to which that server
subscribes.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete PROFASSOCiation profile_name

ADMins

=

*

,

admin_name

DOmains

=

*

,

domain_name

ADSCHeds

=

*

,

schedule_name

SCRipts

=

*

,

script_name

CLOptsets

=

*

,

option_set_name

SERVers

=

*

,

server_name

SERVERGroups

=

*

,

group_name


Parameters
profile_name (Required)
Specifies the profile from which to delete associations.
ADMins
Specifies the administrators whose association with the profile is deleted. You
can specify more than one name by separating the names with commas and no
intervening spaces. Use the match-all character (*) to delete all administrators
from the profile. If you specify a list of administrators and a match-all
definition exists for the profile, the command fails.
DELETE PROFASSOCIATION

412 IBM Tivoli Storage Manager for Windows: Administrators Reference
Administrator definitions are not changed on the configuration manager.
However, they are automatically deleted from all subscribing managed servers
at the next configuration refresh, with the following exceptions:
v An administrator is not deleted if that administrator has an open session on
the server.
v An administrator is not deleted if, as a result, the managed server would
have no administrators with system privilege class.
DOmains
Specifies the domains whose association with the profile is deleted. You can
specify more than one name by separating the names with commas and no
intervening spaces. Use the match-all character (*) to delete all domains from
the profile. If you specify a list of domains and a match-all domain definition
exists for the profile, the command fails.
The domain information is automatically deleted from all subscribing managed
servers. However, a policy domain that has client nodes assigned will not be
deleted. To delete the domain at the managed server, assign those client nodes
to another policy domain.
ADSCHeds
Specifies a list of administrative schedules whose association with the profile is
deleted. You can specify more than one name by separating the names with
commas and no intervening spaces. If you specify a list of administrative
schedules and a match-all administrative schedule definition exists for the
profile, the command fails. Use the match-all character (*) to delete all
administrative schedules from the profile.
The administrative schedules are automatically deleted from all subscribing
managed servers. However, an administrative schedule is not deleted if the
schedule is active on the managed server. To delete an active schedule, make
the schedule inactive.
SCRipts
Specifies the server command scripts whose association with the profile is
deleted. You can specify more than one name by separating the names with
commas and no intervening spaces. Use the match-all character (*) to delete all
scripts from the profile. If you specify a list of scripts and a match-all script
definition exists for the profile, the command fails. The server command scripts
are automatically deleted from all subscribing managed servers.
CLOptsets
Specifies the client option sets whose association with the profile is deleted.
You can specify more than one name by separating the names with commas
and no intervening spaces. Use the match-all character (*) to delete all client
option sets from the profile. If you specify a list of client option sets and a
match-all client option set definition exists for the profile, the command fails.
The client option sets are automatically deleted from all subscribing managed
servers.
SERVers
Specifies the servers whose association with the profile is deleted. You can
specify more than one name by separating the names with commas and no
intervening spaces. You can use the match-all character (*) to delete all servers
from the profile. If you specify a list of servers and a match-all server
definition exists for the profile, the command fails. The server definitions are
automatically deleted from all subscribing managed servers with the following
exceptions:
DELETE PROFASSOCIATION
Chapter 2. Administrative commands 413
v A server definition is not deleted if the managed server has an open
connection to another server.
v A server definition is not deleted if the managed server has a device class of
the device type SERVER that refers to the other server.
v A server definition is not deleted if the server is the event server for the
managed server.
SERVERGroups
Specifies the server groups whose association with the profile is deleted. You
can specify more than one name by separating the names with commas and no
intervening spaces. You can use the match-all character (*) to delete all server
groups from the profile. If you specify a list of server groups and a match-all
group definition exists for the profile, the command fails. The server group
definitions are automatically deleted from all subscribing managed servers.
Examples
Task
Delete all domain associations from a profile named MIKE.
Command
delete profassociation mike domains=*
Related commands
Table 130. Commands related to DELETE PROFASSOCIATION
Command Description
COPY PROFILE Creates a copy of a profile.
DEFINE PROFASSOCIATION Associates objects with a profile.
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
DELETE PROFILE Deletes a profile from a configuration
manager.
LOCK PROFILE Prevents distribution of a configuration
profile.
NOTIFY SUBSCRIBERS Notifies servers to refresh their configuration
information.
QUERY PROFILE Displays information about configuration
profiles.
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UNLOCK PROFILE Enables a locked profile to be distributed to
managed servers.
UPDATE PROFILE Changes the description of a profile.

DELETE PROFASSOCIATION

414 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE PROFILE (Delete a profile)
Use this command on a configuration manager to delete a profile and stop its
distribution to managed servers.
You cannot delete a locked profile. You must first unlock the profile with the
UNLOCK PROFILE command.
Attention: Deleting a profile from a configuration manager does not delete
objects associated with that profile from the managed servers. You can use the
DELETE SUBSCRIPTION command with the DISCARDOBJECTS=YES parameter
on each subscribing managed server to delete subscriptions to the profile and
associated objects. This also prevents the managed servers from requesting further
updates to the profile.
Privilege class
To issue this command, you must have system privilege.
Syntax

DELete PROFIle

profile_name
Force = No
Force

=

No

Yes

Parameters
profile_name (Required)
Specifies the profile to delete.
Force
Specifies whether the profile is deleted if one or more managed servers have
subscriptions to that profile. The default is NO. Possible values are:
No
Specifies that the profile is not deleted if one or more managed servers
have subscriptions to that profile. You can delete the subscriptions on each
managed server using the DELETE SUBSCRIPTION command.
Yes
Specifies that the profile is deleted even if one or more managed servers
have subscriptions to that profile. Each subscribing server continues to
request updates for the deleted profile until the subscription is deleted.
Examples
Task
Delete a profile named BETA, even if one or more managed servers subscribe to it.
Command
delete profile beta force=yes
DELETE PROFILE
Chapter 2. Administrative commands 415
Related commands
Table 131. Commands related to DELETE PROFILE
Command Description
COPY PROFILE Creates a copy of a profile.
DEFINE PROFASSOCIATION Associates objects with a profile.
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
DEFINE SUBSCRIPTION Subscribes a managed server to a profile.
DELETE PROFASSOCIATION Deletes the association of an object with a
profile.
DELETE SUBSCRIPTION Deletes a specified profile subscription.
LOCK PROFILE Prevents distribution of a configuration
profile.
QUERY PROFILE Displays information about configuration
profiles.
QUERY SUBSCRIPTION Displays information about profile
subscriptions.
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UNLOCK PROFILE Enables a locked profile to be distributed to
managed servers.
UPDATE PROFILE Changes the description of a profile.

DELETE PROFILE

416 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE RECMEDMACHASSOCIATION (Delete recovery media
and machine association)
Use this command to remove the association of one or more machines with a
recovery media. This command does not delete the machine from Tivoli Storage
Manager.
Privilege class
To issue this command, you must have system privilege.
Syntax

DELete RECMEDMACHAssociation

media_name

,
machine_name

Parameters
media_name (Required)
Specifies the name of the recovery media that is associated with one or more
machines.
machine_name (Required)
Specifies the name of the machine associated with the recovery media. To
specify a list of machine names, separate the names with commas and no
intervening spaces. You can use wildcard characters to specify a name. If a
machine is not associated with the recovery media, the machine is ignored.
Examples
Task
Delete the association between the DIST5RM recovery media and the DISTRICT1
and DISTRICT5 machines.
Command
delete recmedmachassociation
dist5rm district1,district5
Related commands
Table 132. Commands related to DELETE RECMEDMACHASSOCIATION
Command Description
DEFINE RECMEDMACHASSOCIATION Associates recovery media with a machine.
QUERY MACHINE Displays information about machines.
QUERY RECOVERYMEDIA Displays media available for machine
recovery.

DELETE RECMEDMACHASSOCIATION
Chapter 2. Administrative commands 417
DELETE RECOVERYMEDIA (Delete recovery media)
Use this command to delete a recovery media definition from Tivoli Storage
Manager.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete RECOVERYMedia media_name

Parameters
media_name (Required)
Specifies the name of the recovery media.
Examples
Task
Delete the DIST5RM recovery media.
Command
delete recoverymedia dist5rm
Related commands
Table 133. Commands related to DELETE RECOVERYMEDIA
Command Description
DEFINE RECOVERYMEDIA Defines the media required to recover a
machine.
QUERY RECOVERYMEDIA Displays media available for machine
recovery.
UPDATE RECOVERYMEDIA Changes the attributes of recovery media.

DELETE RECOVERYMEDIA

418 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE SCHEDULE (Delete a client or an administrative
command schedule)
Use this command to delete schedules from the database.
The DELETE SCHEDULE command takes two forms: one if the schedule applies
to client operations, one if the schedule applies to administrative commands. The
syntax and parameters for each form are defined separately.
Table 134. Commands related to DELETE SCHEDULE
Command Description
COPY SCHEDULE Creates a copy of a schedule.
DEFINE SCHEDULE Defines a schedule for a client operation or
an administrative command.
QUERY SCHEDULE Displays information about schedules.
UPDATE SCHEDULE Changes the attributes of a schedule.
DELETE SCHEDULE
Chapter 2. Administrative commands 419
DELETE SCHEDULE client
Use the DELETE SCHEDULE command to delete one or more client schedules
from the database. Any client associations to a schedule are removed when the
schedule is deleted.
Privilege class
To delete a client schedule, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the specified policy domain.
Syntax

DELete SCHedule

domain_name

schedule_name
Type = Client

Parameters
domain_name (Required)
Specifies the name of the policy domain to which the schedule belongs.
schedule_name (Required)
Specifies the name of the schedule to delete. You can use a wildcard character
to specify this name.
Type=Client
Specifies to delete a client schedule. This parameter is optional. The default is
CLIENT.
Examples
Task
Delete the WEEKLY_BACKUP schedule, which belongs to the
EMPLOYEE_RECORDS policy domain.
Command
delete schedule employee_records weekly_backup
DELETE SCHEDULE Client

420 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE SCHEDULE administrative command
Use this command to delete one or more administrative command schedules from
the database.
Privilege class
To delete an administrative command schedule, you must have system authority.
Syntax
DELete SCHedule schedule_name Type = Administrative

Parameters
schedule_name (Required)
Specifies the name of the schedule to delete. You can use a wildcard character
to specify this name.
Type=Administrative (Required)
Specifies to delete an administrative command schedule.
Examples
Task
Delete the administrative command scheduled named DATA_ENG.
Command
delete schedule data_eng type=administrative
DELETE SCHEDULE Administrative Command
Chapter 2. Administrative commands 421
DELETE SCRIPT (Delete command lines from a script or
delete the entire script)
Use this command to delete a single line from a Tivoli Storage Manager script or
to delete the entire Tivoli Storage Manager script.
Privilege class
To issue this command, the administrator must have previously defined the script
or must have system privilege.
Syntax
DELete SCRipt script_name
Line

=

number


Parameters
script_name (Required)
Specifies the name of the script to delete. The script is deleted unless you
specify a line number.
Line
Specifies the line number to delete from the script. If you do not specify a line
number, the entire script is deleted.
Examples
Task
Using the following script named QSAMPLE:
001 /* This is a sample script */
005 QUERY STATUS
010 QUERY PROCESS
Delete line 005 from QSAMPLE.
Command
delete script qsample line=5
Related commands
Table 135. Commands related to DELETE SCRIPT
Command Description
COPY SCRIPT Creates a copy of a script.
DEFINE SCRIPT Defines a script to the IBM Tivoli Storage
Manager server.
QUERY SCRIPT Displays information about scripts.
RENAME SCRIPT Renames a script to a new name.
RUN Runs a script.
UPDATE SCRIPT Changes or adds lines to a script.

DELETE SCRIPT

422 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE SERVER (Delete a server definition)
Use this command to delete a server definition.
This command fails if the server:
v Is defined as the event server.
v Is named in a device class definition whose device type is SERVER.
v Has an open connection to or from another server.
v Is a target server for virtual volumes.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete SERver server_name

Parameters
server_name (Required)
Specifies a server name.
Examples
Task
Delete the definition for a server named SERVER2.
Command
delete server server2
Related commands
Table 136. Commands related to DELETE SERVER
Command Description
DEFINE SERVER Defines a server for server-to-server
communications.
QUERY EVENTSERVER Displays the name of the event server.
QUERY SERVER Displays information about servers.
RECONCILE VOLUMES Reconciles source server virtual volume
definitions and target server archive objects.
UPDATE SERVER Updates information about a server.

DELETE SERVER
Chapter 2. Administrative commands 423
DELETE SERVERGROUP (Delete a server group)
Use this command to delete a server group. If the group you delete is a member of
other server groups, Tivoli Storage Manager also removes the group from the other
groups.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete SERVERGRoup group_name

Parameters
group_name (Required)
Specifies the server group to delete.
Examples
Task
Delete a server group named WEST_COMPLEX.
Command
delete servergroup west_complex
Related commands
Table 137. Commands related to DELETE SERVERGROUP
Command Description
COPY SERVERGROUP Creates a copy of a server group.
DEFINE GRPMEMBER Defines a server as a member of a server
group.
DEFINE SERVERGROUP Defines a new server group.
DELETE GRPMEMBER Deletes a server from a server group.
MOVE GRPMEMBER Moves a server group member.
QUERY SERVERGROUP Displays information about server groups.
RENAME SERVERGROUP Renames a server group.
UPDATE SERVERGROUP Updates a server group.

DELETE SERVERGROUP

424 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE SPACETRIGGER (Delete the database or recovery log
space triggers)
Use this command to delete the definition of the database or recovery log space
trigger.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DELete SPACETrigger DB
LOG

STG

STGPOOL

=

storage_pool_name


Parameters
DB
Specifies the database space trigger.
LOG
Specifies the recovery log space trigger.
STG
Specifies a storage pool space trigger
STGPOOL
Specifies the storage pool trigger to be deleted. This parameter does not apply
to database or recovery log space triggers. If STG is specified without
specifying STGPOOL, the default storage pool space trigger is the deletion
target.
Examples
Task
Delete the definition for the database space trigger.
Command
delete spacetrigger db
Task
Delete the definition for the recovery log space trigger.
Command
delete spacetrigger log
Task
Delete the space trigger definition for the WINPOOL1 storage pool.
Command
delete spacetrigger stg stgpool=winpool1
DELETE SPACETRIGGER
Chapter 2. Administrative commands 425
Related commands
Table 138. Commands related to DELETE SPACETRIGGER
Command Description
DEFINE SPACETRIGGER Defines the database or recovery log space
trigger.
QUERY SPACETRIGGER Displays information about the database or
recovery log space trigger.
UPDATE SPACETRIGGER Changes attributes of the database or
recovery log space trigger.

DELETE SPACETRIGGER

426 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE STGPOOL (Delete a storage pool)
Use this command to delete a storage pool. To delete a storage pool, you must first
delete all volumes assigned to the storage pool.
Attention: Do not delete a storage pool that is specified as a destination for a
management class or copy group in the ACTIVE policy set. Client operations
might fail as a result.
You cannot delete a storage pool that is identified as the next storage pool for
another storage pool. For more information on storage pool hierarchy, see the
NEXTSTGPOOL parameter in the DEFINE STGPOOL command.
Note: This note only applies to environments where the primary storage pool
definition is utilizing the COPYSTGPOOLS list parameter. When deleting a
copy storage pool that has been previously included in a primary storage
pool definition (specifically in the COPYSTGPOOLS list), the copy storage
pool must be removed from the list prior to deletion. Otherwise, the
DELETE STGPOOL command fails until all references to that copy pool
have been removed. For each primary storage pool with a reference to the
copy storage pool to be deleted, remove the reference by entering the
UPDATE STGPOOL command with the COPYSTGPOOLS parameter with
all previous copy storage pools except the copy storage pool to be deleted.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete STGpool pool_name

Parameters
pool_name (Required)
Specifies the storage pool to delete.
Examples
Task
Delete the storage pool named POOLA.
Command
delete stgpool poola
Related commands
Table 139. Commands related to DELETE STGPOOL
Command Description
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
QUERY STGPOOL Displays information about storage pools.
DELETE STGPOOL
Chapter 2. Administrative commands 427
Table 139. Commands related to DELETE STGPOOL (continued)
Command Description
SET DRMCOPYSTGPOOL Specifies that copy storage pools are
managed by DRM.
UPDATE STGPOOL Changes the attributes of a storage pool.

DELETE STGPOOL

428 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE SUBSCRIBER (Delete subscriptions from a
configuration manager database)
Use this command on a configuration manager to delete managed server
subscriptions from the configuration manager database. Use this command when a
managed server no longer exists or cannot notify the configuration manager after
deleting a subscription.
Attention: Use this command only in rare situations in which the configuration
managers database contains an entry for a subscription, but the managed server
does not have such a subscription. For example, use this command if a managed
server no longer exists or cannot notify the configuration manager after deleting a
subscription.
Under normal circumstances, use the DELETE SUBSCRIPTION command to delete
a subscription from the managed server. The managed server notifies the
configuration manager, which then deletes the subscription from its database.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete SUBSCRIBer server_name

Parameters
server_name (Required)
Specifies the name of the managed server with subscription entries to be
deleted.
Examples
Task
Delete all subscription entries for a managed server named DAN.
Command
delete subscriber dan
Related commands
Table 140. Commands related to DELETE SUBSCRIBER
Command Description
DEFINE SUBSCRIPTION Subscribes a managed server to a profile.
DELETE SUBSCRIPTION Deletes a specified profile subscription.
NOTIFY SUBSCRIBERS Notifies servers to refresh their configuration
information.
QUERY SUBSCRIBER Displays information about subscribers and
their subscriptions to profiles.
QUERY SUBSCRIPTION Displays information about profile
subscriptions.

DELETE SUBSCRIBER
Chapter 2. Administrative commands 429
DELETE SUBSCRIPTION (Delete a profile subscription)
Use this command on a managed server to delete a profile subscription. You can
also delete from the managed server all objects associated with the profile.
Privilege class
To issue this command, you must have system privilege.
Syntax

DELete SUBSCRIPtion

profile_name
DISCARDobjects = No
DISCARDobjects

=

No

Yes

Parameters
profile_name (Required)
Specifies the name of the profile for which the subscription is to be deleted.
DISCARDobjects
Specifies whether objects associated with the profile are to be deleted on the
managed server. This parameter is optional. The default is NO.
No
Specifies that the objects are not to be deleted.
Yes
Specifies that the objects are to be deleted, unless they are associated with
another profile for which a subscription is defined.
Examples
Task
Delete a subscription to a profile named ALPHA and its associated objects from a
managed server.
Command
delete subscription alpha discardobjects=yes
Related commands
Table 141. Commands related to DELETE SUBSCRIPTION
Command Description
DEFINE SUBSCRIPTION Subscribes a managed server to a profile.
DELETE SUBSCRIBER Deletes obsolete managed server
subscriptions.
NOTIFY SUBSCRIBERS Notifies servers to refresh their configuration
information.
QUERY SUBSCRIBER Displays information about subscribers and
their subscriptions to profiles.
QUERY SUBSCRIPTION Displays information about profile
subscriptions.

DELETE SUBSCRIPTION

430 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE VIRTUALFSMAPPING (Delete a virtual file space
mapping)
Use this command to delete a virtual file space mapping definition. Virtual file
spaces containing data cannot be deleted unless you use the DELETE FILESPACE
command first.
Privilege class
To perform this task, you must have one of the following privilege classes:
v System privilege
v Unrestricted policy privilege
v Restricted policy privilege for the domain to which the NAS node is assigned
Syntax
DELete VIRTUALFSmapping node_name virtual_filespace_name

Parameters
node_name (Required)
Specifies the NAS node on which the file system and path reside. You cannot
use wildcard characters or specify a list of names.
virtual_filespace_name (Required)
Specifies the name of the virtual file space mapping definition to be deleted.
Wildcard characters are allowed.
Examples
Task
Delete the virtual file space mapping definition /mikeshomedir for the NAS node
named NAS1.
Command
delete virtualfsmapping nas1 /mikeshomedir
Related commands
Table 142. Commands related to DELETE VIRTUALFSMAPPING
Command Description
DEFINE VIRTUALFSMAPPING Define a virtual file space mapping.
QUERY VIRTUALFSMAPPING Query a virtual file space mapping.
UPDATE VIRTUALFSMAPPING Update a virtual file space mapping.

DELETE VIRTUALFSMAPPING
Chapter 2. Administrative commands 431
DELETE VOLHISTORY (Delete sequential volume history
information)
Use this command to delete volume history file records that are no longer needed
(for example, records for obsolete database backup volumes).
When you delete records for volumes that are not in storage pools (for example,
database backup or export volumes), the volumes return to scratch status even if
Tivoli Storage Manager acquired them as private volumes. Scratch volumes of
device type FILE are deleted. When you delete the records for storage pool
volumes, the volumes remain in the Tivoli Storage Manager database. When you
delete records for recovery plan file objects from a source server, the objects on the
target server are marked for deletion.
Note:
1. Volumes for the most recent database backup series are not deleted.
2. Existing volume history files are not automatically updated with this
command.
3. You can use the DEFINE SCHEDULE command to periodically delete
volume history records.
4. Use the DELETE BACKUPSET command to delete specified backup set
volume information in the volume history file. Do not use this DELETE
VOLHISTORY command to delete backup set volume information in the
volume history file.
5. For users of DRM, the database backup expiration should be controlled
with the SET DRMDBBACKUPEXPIREDAYS command instead of this
DELETE VOLHISTORY command. Using the DELETE VOLHISTORY
command removes Tivoli Storage Managers record of the volume. This
can cause volumes to be lost that were managed by the MOVE
DRMEDIA command. The recommended way to manage the automatic
expiration of DRM database backup volumes is by using the SET
DRMDBBACKUPEXPIREDAYS command.
Privilege class
To issue this command, you must have system privilege.
Syntax

DELete VOLHistory

TODate

=

date
TOTime = 23:59:59
TOTime

=

time

DELETE VOLHISTORY

432 IBM Tivoli Storage Manager for Windows: Administrators Reference
Type = All
DBBackup

DEVclass

=

class_name

DBSnapshot

DEVclass

=

class_name

DBDump

DBRpf

EXPort

DELETELatest

=

No

RPFile

DELETELatest

=

No

Yes

DELETELatest

=

No

RPFSnapshot

DELETELatest

=

No

Yes

STGNew

STGReuse

STGDelete


Parameters
TODate (Required)
Specifies the date to use to select sequential volume history information to be
deleted. Tivoli Storage Manager deletes only those records with a date on or
before the date you specify. You can specify the date using one of the values
below:

Value Description Example
MM/DD/YYYY A specific date 01/23/1999
TODAY The current date TODAY
TODAY-days or -days The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY30 or 30.
To delete records that are 30 or more
days old, you can specify TODAY-30
or simply -30.

TOTime
Specifies that you want to delete records created on or before this time on the
specified date. This parameter is optional. The default is the end of the day
(23:59:59). You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the
specified date
12:30:22
NOW The current time on the
specified date
NOW
DELETE VOLHISTORY
Chapter 2. Administrative commands 433
Value Description Example
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
date
NOW+03:00 or +03:00.
If you issue the DELETE
VOLHISTORY command at 9:00 with
TOTIME=NOW+03:00 or
TOTIME=+03:00, Tivoli Storage
Manager deletes records with a time
of 12:00 or earlier on the specified
date.
NOW-HH:MM or
-HH:MM
The current time minus hours
and minutes on the specified
date
NOW-03:30 or -03:30.
If you issue the DELETE
VOLHISTORY command at 9:00 with
TOTIME=NOW-3:30 or
TOTIME=-3:30, Tivoli Storage
Manager deletes records with a time
of 5:30 or earlier on the specified
date.

Type (Required)
Specifies the type of records, which also meet the date and time criteria, to
delete from the volume history file. Possible values are:
All
Specifies to delete all records.
DBBackup
Specifies to delete only records that contain information about volumes
used for database full and incremental backups, that is with volume types
of BACKUPFULL and BACKUPINCR, and that meet the specified date and
time criteria. The latest database full and incremental backup series will
not be deleted.
DEVclass=class_name
Specifies the device class name that was used to create the database
backups. This optional parameter can be used to delete database
backups created using a server-to-server virtual volume device class.
The type of the device class must be SERVER. This parameter can only
be used to delete volume history entries of type BACKUPFULL,
BACKUPINCR, or DBSNAPSHOT.
A full, incremental, or snapshot database backup volume is eligible to
be deleted if all of the following conditions are met:
v The device class used to create the database backup volume matches
the specified device class
v The volume was created on or before the specified date and time
v The volume is not part of the latest full plus incremental database
backup series if the specified volume type is DBBackup, or snapshot
database backup series if the volume type is DBSnapshot
DBSnapshot
Specifies to delete only records that contain information about volumes
used for snapshot database backups, and that meet the specified date and
time criteria. The latest snapshot database backup will not be deleted.
DEVclass=classname
Specifies the device class name that was used to create the database
backups. This optional parameter can be used to delete database
DELETE VOLHISTORY

434 IBM Tivoli Storage Manager for Windows: Administrators Reference
backups created using a server-to-server virtual volume device class.
The type of the device class must be SERVER. This parameter can only
be used to delete volume history entries of type BACKUPFULL,
BACKUPINCR, or DBSNAPSHOT.
A full, incremental, or snapshot database backup volume is eligible to
be deleted if all of the following conditions are met:
v The device class used to create the database backup volume matches
the specified device class
v The volume was created on or before the specified date and time
v The volume is not part of the latest full plus incremental database
backup series if the specified volume type is DBBackup, or snapshot
database backup series if the volume type is DBSnapshot
DBDump
Specifies to delete only online database dump volumes.
DBRpf
Specifies to delete only records that contain information about full and
incremental database backup volumes and recovery plan file volumes.
EXPort
Specifies to delete only records that contain information about export
volumes.
RPFile
Specifies to delete only records that contain information about recovery
plan file objects that are stored on a target server and that meet the
specified date and time criteria.
DELETELatest
Specifies whether the latest recovery plan file is eligible for deletion.
This optional parameter can be used to delete the latest recovery plan
files created using a server-to-server virtual volume device class.
This parameter can only be used to delete volume history entries of
type RPFILE (for instance, those recovery plan files that were created
using the DEVCLASS parameter with the PREPARE command). If this
parameter is not specified, the latest RPFILE entries are not deleted.
No Specifies the latest RPFILE file is not deleted.
Yes Specifies the latest RPFILE file is deleted if it meets the
specified date and time criteria.
RPFSnapshot
Specifies to delete only records that contain information about recovery
plan file objects that were created assuming snapshot database backups,
that are stored on a target server and that meet the specified date and time
criteria. The latest RPFSNAPSHOT file will not be deleted unless it meets
the specified date and time criteria, and the DELETELatest parameter is set
to Yes.
DELETELatest
Specifies whether the latest recovery plan file is eligible for deletion.
This optional parameter can be used to delete the latest recovery plan
files created using a server-to-server virtual volume device class.
This parameter can only be used to delete volume history entries of
type RPFSNAPSHOT(for instance, those recovery plan files that were
DELETE VOLHISTORY
Chapter 2. Administrative commands 435
created using the DEVCLASS parameter with the PREPARE
command). If this parameter is not specified, the latest RPFSNAPSHOT
entries are not deleted.
No Specifies the latest RPFSNAPSHOT file is not deleted.
Yes Specifies the latest RPFSNAPSHOT file is deleted if it meets
the specified date and time criteria.
STGNew
Specifies to delete only records that contain information about new
sequential access storage volumes.
STGReuse
Specifies to delete only records that contain information about reused
sequential storage pool volumes.
STGDelete
Specifies to delete only records that contain information about deleted
sequential storage pool volumes.
Examples
Task
Delete all recovery plan file information created on or before 03/28/1998.
Command
delete volhistory type=rpfile todate=03/28/1998
Related commands
Table 143. Commands related to DELETE VOLHISTORY
Command Description
BACKUP VOLHISTORY Records volume history information in
external files.
DEFINE SCHEDULE Defines a schedule for a client operation or
an administrative command.
DELETE VOLUME Deletes a volume from a storage pool.
EXPIRE INVENTORY Manually starts inventory expiration
processing.
MOVE DRMEDIA Moves DRM media onsite and offsite.
PREPARE Creates a recovery plan file.
QUERY RPFILE Displays information about recovery plan
files.
QUERY VOLHISTORY Displays sequential volume history
information that has been collected by the
server.
SET DRMRPFEXPIREDAYS Set criteria for recovery plan file expiration.
SET DRMDBBACKUPEXPIREDAYS Specifies criteria for database backup series
expiration.

DELETE VOLHISTORY

436 IBM Tivoli Storage Manager for Windows: Administrators Reference
DELETE VOLUME (Delete a storage pool volume)
Use this command to delete a storage pool volume and, optionally, the files stored
in the volume.
If the volume has data, to delete the volume you must do one of the following:
v Before deleting the volume, use the MOVE DATA command to move all files to
another volume.
v Explicitly request to discard all files in the volume when the volume is deleted
(by specifying DISCARDDATA=YES).
If you are deleting several volumes, delete the volumes one at a time. Deleting
more than one volume at a time can adversely affect server performance.
Storage pool volumes cannot be deleted if they are in use. For example, a volume
cannot be deleted if a user is restoring or retrieving a file residing in the volume, if
the server is writing information to the volume, or if a reclamation process is using
the volume.
If this command is applied to a WORM (write once, read many) volume, the
volume will return to scratch if it has space remaining in which data can be
written. (Note that data on WORM volumes, including deleted and expired data,
cannot be overwritten. Therefore, data can only be written in space that does not
contain current, deleted, or expired data.) If a WORM volume does not have any
space available in which data can be written, it will remain private. To remove the
volume from the library, you must use the CHECKOUT LIBVOLUME command.
The DELETE VOLUME command will automatically update the server library
inventory for sequential volumes if the volume will be returned to scratch status
when the volume becomes empty. To determine whether a volume will be returned
to scratch status, issue the QUERY VOLUME command and look at the output. If
the value for the attribute Scratch Volume? is Yes, then the server library
inventory will be automatically updated. If the value is No, you can issue the
UPDATE LIBVOLUME command to specify the status as scratch. It is
recommended that you issue the UPDATE LIBVOLUME command after issuing the
DELETE VOLUME command.
Attempting to use the DELETE VOLUME command to delete WORM FILE
volumes in a storage pool with RECLAMATIONTYPE=SNAPLOCK will fail with
an error message. Deletion of empty WORM FILE volumes is performed only by
the reclamation process.
If you issue the DELETE VOLUME command for a volume in a storage pool that
has a SHRED parameter value greater than 0, the volume will be placed in the
pending state until shredding is run. Shredding is necessary to complete the
deletion, even if the volume is empty.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the storage pool to which the volume is
defined.
DELETE VOLUME
Chapter 2. Administrative commands 437
Syntax

DELete Volume

volume_name
DISCARDdata = No
DISCARDdata

=

No

Yes

Wait = No
Wait

=

No

Yes

Parameters
volume_name (Required)
Specifies the name of the volume to delete.
DISCARDdata
Specifies whether files stored in the volume are deleted. This parameter is
optional. The default value is NO. Possible values are:
No
Specifies that files stored in the volume are not deleted. If the volume
contains any files, the volume is not deleted.
Yes
Specifies that all files stored in the volume are deleted. The server does not
need to mount the volume for this type of deletion.
Note:
1. The Tivoli Storage Manager server will not delete archive files
that are on deletion hold.
2. If archive retention protection is enabled, the Tivoli Storage
Manager server will delete only archive files whose retention
period has expired.
If the volume being deleted is a primary storage pool volume, the server
checks whether any copy storage pool has copies of files that are being
deleted. When files stored in a primary storage pool volume are deleted,
any copies of these files in copy storage pools are also deleted.
When you delete a disk volume in a primary storage pool, the command
also deletes any files that are cached copies (copies of files that have been
migrated to the next storage pool). Deleting cached copies of files does not
delete the files that have already been migrated or backed up to copy
storage pools. Only the cached copies of the files are affected.
Do not use the DELETE VOLUME command with DISCARDDATA=YES if
a restore process (RESTORE STGPOOL or RESTORE VOLUME) is running.
The DELETE VOLUME command could cause the restore to be incomplete.
If you cancel the DELETE VOLUME operation during processing or if a
system failure occurs, some files might remain on the volume. You can
delete the same volume again to have the server delete the remaining files
and then the volume.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter affects processing only when you have also
DELETE VOLUME

438 IBM Tivoli Storage Manager for Windows: Administrators Reference
requested that any data on the volume be discarded. This parameter is
optional. The default value is No. Possible values are:
No
Specifies that the server processes this command in the background. You
can continue with other tasks while the command is being processed. The
server displays messages that are created from the background process
either in the activity log or the server console, depending on where
messages are logged.
Yes
Specifies that the server processes this command in the foreground. You
wait for the command to complete before continuing with other tasks. The
server then displays the output messages to the administrative client when
the command completes.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Delete storage pool volume stgvol.1 from the storage pool FILEPOOL.
Command
delete volume stgvol.1
Related commands
Table 144. Commands related to DELETE VOLUME
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
MOVE DATA Moves data from a specified storage pool
volume to another storage pool volume.
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY CONTENT Displays information about files in a storage
pool volume.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY PROCESS Displays information about background
processes.
QUERY VOLUME Displays information about storage pool
volumes.
UPDATE VOLUME Updates the attributes of storage pool
volumes.

DELETE VOLUME
Chapter 2. Administrative commands 439
DISABLE commands
Use DISABLE commands to prevent some types of operations by the server.
The following is a list of DISABLE commands for Tivoli Storage Manager:
v DISABLE EVENTS (Disable events for event logging) on page 441
v DISABLE SESSIONS (Temporarily prevent client node access to the server) on
page 445
DISABLE commands

440 IBM Tivoli Storage Manager for Windows: Administrators Reference
DISABLE EVENTS (Disable events for event logging)
Use this command to disable the processing of one or more events. If you specify a
receiver that is not supported on any platform, or if you specify an invalid event
or name, Tivoli Storage Manager issues an error message. However, any valid
receivers, events, or names that you specified are still enabled.
Note:
1. Messages in the SEVERE category and message ANR9999D can provide
valuable diagnostic information if there are serious server problems. For
this reason, you should not disable these messages.
2. Certain messages are displayed on the console even if they are disabled.
These include some messages issued during server startup and
shutdown and responses to administrative commands.
3. Server messages from the server on which this command is issued,
cannot be disabled for the activity log.
4. ANR1822I indicates that event logging is being ended for the specified
receiver. When the DISABLE EVENTS command is issued, this message
is logged to the receiver even if it is one of the events that has been
disabled. This is done to confirm that event logging has ended to that
receiver, but subsequent ANR1822I messages are not logged to that
receiver.
Privilege class
To issue this command, you must have system privilege.
Syntax

DISAble EVents

,
receivers

ALL

CONSOLE

ACTLOG

EVENTSERVER

FILE

FILETEXT

NTEVENTLOG

SNMP

TIVOLI

USEREXIT

,
event_name

ALL

INFO

WARNING

ERROR

SEVERE

,

NODEname

=

node_name

,

SERVername

=

server_name


DISABLE EVENTS
Chapter 2. Administrative commands 441
Parameters
receivers (Required)
Specifies the name of the receivers for which to disable events. Specify
multiple receivers by separating them with commas and no intervening spaces.
Possible values are:
ALL
All receivers, except for server events on the activity log receiver
(ACTLOG). Only client events can be disabled for the activity log receiver.
CONSOLE
The standard server console as a receiver.
ACTLOG
The activity log as a receiver. You can disable only client events, not server
events, for the activity log.
EVENTSERVER
The event server as a receiver.
FILE
A user file as a receiver. Each logged event is a record in the file. The
records are not easily readable by people.
FILETEXT
A user file as a receiver. Each logged event is a fixed-size, readable line.
NTEVENTLOG
The Windows application log as a receiver.
SNMP
The simple network management protocol (SNMP) as a receiver.
TIVOLI
The Tivoli Enterprise Console (TEC) as a receiver.
USEREXIT
A user-written program as a receiver. The server writes information to the
program.
events (Required)
Specifies the events to be disabled. You can specify multiple events by
separating them with commas and no intervening spaces. Possible values are:
ALL
All events.
event_name
A four-digit message number preceded by ANR for a server event or ANE
for a client event. Valid ranges are from ANR0001 to ANR9999 and from
ANE4000 to ANE4999. Specify the NODENAMES parameter if client
events are to be disabled for matching nodes. Specify the SERVERNAME
parameter if server events are to be disabled for matching servers.
For the TIVOLI event receiver only, you can specify the following events
names for the IBM Tivoli Storage Manager application clients:

Tivoli Storage Manager Application Client Prefix Range
Data Protection for Microsoft Exchange
Server
ACN 35003649
Data Protection for Lotus Domino

ACD 52005299
DISABLE EVENTS

442 IBM Tivoli Storage Manager for Windows: Administrators Reference
Tivoli Storage Manager Application Client Prefix Range
Data Protection for Oracle ANS 500599
Data Protection for Informix

ANS 600699
Data Protection for Microsoft SQL Server ACO 30003999

Note: Specifying ALL disables these messages. However, the INFO,
WARNING, ERROR, and SEVERE options have no effect on the
messages.
severity categories
If the event list contains a severity category, all events of that severity are
disabled for the specified nodes. The message types are:
INFO
Information messages (type of I).
WARNING
Warning messages (type of W).
ERROR
Error messages (type of E).
SEVERE
Severe error messages (type of S).
NODEname
Specifies the name of one or more node names for which events are to be
disabled. You can use the wildcard character (*) to specify all nodes. You can
specify NODENAME or SERVERNAME. If neither parameter is specified, the
events are disabled for the server running this command.
SERVername
Specifies the name of one or more server names for which events are to be
disabled. You can use the wildcard character (*) to specify all servers other
than the server running this command. You can specify NODENAME or
SERVERNAME. If neither parameter is specified, the events are disabled for
the server running this command.
Examples
Task
Disable all client events in the INFO and WARNING categories for the activity log
and console receivers for all nodes.
Command
disable events actlog,console
info,warning nodename=*
Related commands
Table 145. Commands related to DISABLE EVENTS
Command Description
BEGIN EVENTLOGGING Starts event logging to a specified receiver.
ENABLE EVENTS Enables specific events for receivers.
END EVENTLOGGING Ends event logging to a specified receiver.
DISABLE EVENTS
Chapter 2. Administrative commands 443
Table 145. Commands related to DISABLE EVENTS (continued)
Command Description
QUERY ENABLED Displays enabled or disabled events for a
specific receiver.
QUERY EVENTRULES Displays information about rules for server
and client events.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

DISABLE EVENTS

444 IBM Tivoli Storage Manager for Windows: Administrators Reference
DISABLE SESSIONS (Temporarily prevent client node access
to the server)
Use this command to prevent any new sessions; however, active sessions will
complete. Server processes, such as migration and reclamation, are not affected
when you issue this command.
Privilege class
To issue this command, you must have system privilege or operator privilege.
Syntax

DISAble SESSions
CLIent
CLIent

ALL

SERVer

ADMin

Parameters
Specifies the type of session to be disabled. This parameter is optional. The default
value is CLIent. Possible values are:
CLIent
Disables only backup and archive client sessions.
ALL
Disables all session types.
SERVer
Disables only server-to-server sessions. These are the only types of sessions
that are disabled:
v Server to server event logging
v Enterprise management
v Server registration
v LAN-free: storage agent - server
v Virtual volumes
ADMin
Disables only administrative sessions.
Examples
Task
Temporarily prevent new client node sessions from accessing the server.
Command
disable sessions
Task
Temporarily prevent any new sessions from accessing the server.
DISABLE SESSIONS
Chapter 2. Administrative commands 445
Command
disable sessions all
Related commands
Table 146. Commands related to DISABLE SESSIONS
Command Description
CANCEL SESSION Cancels active sessions with the server.
ENABLE SESSIONS Resumes server activity following the
DISABLE command or the ACCEPT DATE
command.
QUERY SESSION Displays information about all active
administrator and client sessions with IBM
Tivoli Storage Manager.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

DISABLE SESSIONS

446 IBM Tivoli Storage Manager for Windows: Administrators Reference
DISMOUNT command
Use the DISMOUNT command to dismount a volume by the real device address
or by volume name.
The following is the DISMOUNT command for Tivoli Storage Manager:
v DISMOUNT VOLUME (Dismount a volume by volume name) on page 448
DISMOUNT commands
Chapter 2. Administrative commands 447
DISMOUNT VOLUME (Dismount a volume by volume name)
Use this command to dismount an idle volume by volume name. If a drive cannot
dismount the volume, manual intervention is required.
Privilege class
To issue this command, you must have system privilege or operator privilege.
Syntax
DISMount Volume volume_name

Parameters
volume_name (Required)
Specifies the name of the volume to dismount.
Examples
Task
Dismount the volume BTV005.
Command
dismount volume btv005
Related commands
Table 147. Command related to DISMOUNT VOLUME
Command Description
QUERY MOUNT Displays information about mounted
sequential access media.

DISMOUNT VOLUME

448 IBM Tivoli Storage Manager for Windows: Administrators Reference
DISPLAY commands
Use the DISPLAY command to display a fully composed object name.
The following is the DISPLAY command for Tivoli Storage Manager:
v DISPLAY OBJNAME (Display a full object name) on page 450
DISPLAY commands
Chapter 2. Administrative commands 449
DISPLAY OBJNAME (Display a full object name)
Use this command when you want Tivoli Storage Manager to display a full object
name if the name displayed in a message or query output has been abbreviated
due to length. Object names that are very long can be difficult to display and use
through normal operating system facilities. The Tivoli Storage Manager server will
abbreviate long names and assign them a token ID which might be used if the
object path name exceeds 1024 bytes. The token ID is displayed in a string that
includes identifiers for the node, filespace, and object name. The format is:
[TSMOBJ: nID.fsID. nameID]. When specified with the DISPLAY OBJNAME
command, the token ID can be used to show the full object name.
Privilege class
Any administrator can issue this command
Syntax
DISplay OBJname token_ID

Parameters
token_ID (Required)
Specifies the ID reported in the [TSMOBJ:] tag, when an object name is too
long to display.
Examples
Task
Assume the you receive the following message:
ANR9999D file.c(1999) Error handling file [TSMOBJ:1.1.649498] because
of lack of server resources.
Display the full object name for the file referenced in the error message by
specifying the token ID on the DISPLAY OBJNAME command.
Command
display obj 1.1.649498
Related commands
Table 148. Commands related to DISPLAY OBJNAME
Command Description
QUERY CONTENT Displays information about files in a storage
pool volume.

DISPLAY OBJNAME

450 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
||
||
|
|
|
ENABLE commands
Use ENABLE commands to allow some types of operations by the server.
The following is a list of ENABLE commands for Tivoli Storage Manager:
v ENABLE EVENTS (Enable server or client events for logging) on page 452
v ENABLE SESSIONS (Resume user activity on the server) on page 455
ENABLE commands
Chapter 2. Administrative commands 451
ENABLE EVENTS (Enable server or client events for logging)
Use this command to enable the processing of one or more events. If you specify a
receiver that is not supported on any platform, or if you specify an invalid event
or name, Tivoli Storage Manager issues an error message. However, any valid
receivers, events, or names that you specified are still enabled.
Note:
1. Certain events, such as some messages issued during server start-up and
shutdown, automatically go to the console. They do not go to other
receivers even if they are enabled.
2. Administrative commands are returned to the command issuer and are
only logged as numbered events. These numbered events are not logged
to the system console, but are logged to other receivers, including
administrative command-line sessions running in console mode.
Privilege class
To issue this command, you must have system privilege.
Syntax

ENable

EVents

,
ALL

CONSOLE

ACTLOG

EVENTSERVER

FILE

FILETEXT

NTEVENTLOG

SNMP

TIVOLI

USEREXIT

,
event_name

ALL

INFO

WARNING

ERROR

SEVERE

,

NODEname

=

node_name

,

SERVername

=

server_name


Parameters
receivers (Required)
Specifies one or more receivers for which to log enabled events. You can
specify multiple receivers by separating them with commas and no intervening
spaces. Valid values are:
ALL
All receivers.
CONSOLE
The standard server console as a receiver.
ENABLE EVENTS

452 IBM Tivoli Storage Manager for Windows: Administrators Reference
ACTLOG
The server activity log as a receiver.
EVENTSERVER
The event server as a receiver.
FILE
A user file as a receiver. Each logged event is a record in the file. The
records are not easily readable by people.
FILETEXT
A user file as a receiver. Each logged event is a fixed-size, readable line.
NTEVENTLOG
The Windows application log as a receiver.
SNMP
The simple network management protocol (SNMP) as a receiver.
TIVOLI
The Tivoli Enterprise Console (TEC) as a receiver.
USEREXIT
A user-written program as a receiver. The server writes information to the
program.
events (Required)
Specifies the type of events to be enabled. You can specify multiple events by
separating them with commas and no intervening spaces. Possible values are:
ALL
All events.
event_name
A four-digit message number preceded by ANR for a server event or ANE
for a client event. Valid ranges are from ANR0001 to ANR9999 and from
ANE4000 to ANE4999. Specify the NODENAME parameter if client events
are to be enabled for matching nodes. Specify the SERVERNAME
parameter if server events are to be enabled for matching servers.
For the TIVOLI event receiver, you can specify the following additional
ranges for the Tivoli Storage Manager application clients:

Tivoli Storage Manager Application Client Prefix Range
Data Protection for Microsoft Exchange
Server
ACN 35003649
Data Protection for Lotus Domino ACD 52005299
Data Protection for Oracle ANS 500599
Data Protection for Informix ANS 600699
Data Protection for Microsoft SQL Server ACO 30003999

Note:
1. The application client must have enhanced Tivoli Event Console
support enabled in order to route the above messages to the
Tivoli Event Console.
2. Specifying the ALL option enables these messages. However, the
INFO, WARNING, ERROR, and SEVERE options have no effect
on the messages.
ENABLE EVENTS
Chapter 2. Administrative commands 453
3. Because of the number of messages, you should not enable all
messages from a node to be logged to the Tivoli Event Console.
severity categories
If the event list contains a severity category, all events of that severity are
enabled for the specified nodes. The message types are:
INFO
Information messages (type of I) are enabled.
WARNING
Warning messages (type of W) are enabled.
ERROR
Error messages (type of E) are enabled.
SEVERE
Severe error messages (type of S) are enabled.
NODEname
Specifies one or more client nodes for which events are enabled. You can use a
wildcard character to specify all client nodes. You can specify NODENAME or
SERVERNAME. If neither parameter is specified, events are enabled for the
server running this command.
SERVername
Specifies one or more servers for which events are to be enabled. You can use a
wildcard character to specify all servers other than the server from which this
command is issued. You can specify SERVERNAME or NODENAME. If
neither parameter is specified, the events are enabled for the server running
this command.
Examples
Task
Enable all ERROR and SEVERE client events to the USEREXIT receiver for the
node BONZO.
Command
enable events userexit error,severe nodename=bonzo
Related commands
Table 149. Commands related to ENABLE EVENTS
Command Description
BEGIN EVENTLOGGING Starts event logging to a specified receiver.
DISABLE EVENTS Disables specific events for receivers.
END EVENTLOGGING Ends event logging to a specified receiver.
QUERY ENABLED Displays enabled or disabled events for a
specific receiver.
QUERY EVENTRULES Displays information about rules for server
and client events.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

ENABLE EVENTS

454 IBM Tivoli Storage Manager for Windows: Administrators Reference
ENABLE SESSIONS (Resume user activity on the server)
Use this command to allow activity to begin after issuing the DISABLE SESSIONS
command. The processing of this command does not affect system processes, such
as migration and reclamation.
Use the QUERY STATUS command to display the availability of the server.
Privilege class
To issue this command, you must have system privilege or operator privilege.
Syntax

ENable SESSions
CLIent
CLIent

ALL

SERVer

ADMin

Parameters
Specifies the type of session to be enabled. This parameter is optional. The default
value is CLIent. Possible values are:
CLIent
Enables only backup and archive client sessions.
ALL
Enables all session types.
SERVer
Enables only server-to-server sessions.
ADMin
Enables only administrative sessions.
Examples
Task
Resume normal operation, permitting client nodes to access the server.
Command
enable sessions
Task
Resume normal operation, permitting all sessions to access the server.
Command
enable sessions all
ENABLE SESSIONS
Chapter 2. Administrative commands 455
Related commands
Table 150. Commands related to ENABLE SESSIONS
Command Description
ACCEPT DATE Accepts the current date on the server.
CANCEL SESSION Cancels active sessions with the server.
DISABLE SESSIONS Prevents new sessions from accessing IBM
Tivoli Storage Manager but permits existing
sessions to continue.
QUERY SESSION Displays information about all active
administrator and client sessions with IBM
Tivoli Storage Manager.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

ENABLE SESSIONS

456 IBM Tivoli Storage Manager for Windows: Administrators Reference
END commands
Use the END command to stop logging events for Tivoli Storage Manager.
v END EVENTLOGGING (Stop logging events) on page 458
END commands
Chapter 2. Administrative commands 457
END EVENTLOGGING (Stop logging events)
Use this command to stop logging events to an active receiver.
Privilege class
To issue this command, you must have system privilege.
Syntax

ALL
END

EVentlogging

,

CONSOLE

ACTLOG

EVENTSERVER

FILE

FILETEXT

NTEVENTLOG

SNMP

TIVOLI

USEREXIT

Parameters
Specify a type of receiver. You can specify multiple receivers by separating them
with commas and no intervening spaces. This is an optional parameter. The default
is ALL. If you specify ALL or no receiver, logging ends for all receivers.
ALL
Specifies all receivers.
CONSOLE
Specifies the server console as a receiver.
ACTLOG
Specifies the Tivoli Storage Manager activity log as a receiver. Logging can be
stopped only for client events.
EVENTSERVER
Specifies the event server as a receiver.
FILE
Specifies a user file as a receiver. Each logged event is a record in the file and a
person cannot read each logged event easily.
FILETEXT
Specifies a user file as a receiver. Each logged event is a fixed-size, readable
line.
NTEVENTLOG
Specifies the Windows application log as a receiver.
SNMP
Specifies the simple network management protocol (SNMP) as a receiver.
TIVOLI
Specifies the Tivoli Management Environment (TME) as a receiver.
END EVENTLOGGING

458 IBM Tivoli Storage Manager for Windows: Administrators Reference
USEREXIT
Specifies a user-written routine to which Tivoli Storage Manager writes
information as a receiver.
Examples
Task
End logging of events to the user exit.
Command
end eventlogging userexit
Related commands
Table 151. Commands related to END EVENTLOGGING
Command Description
BEGIN EVENTLOGGING Starts event logging to a specified receiver.
DISABLE EVENTS Disables specific events for receivers.
ENABLE EVENTS Enables specific events for receivers.
QUERY ENABLED Displays enabled or disabled events for a
specific receiver.
QUERY EVENTRULES Displays information about rules for server
and client events.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

END EVENTLOGGING
Chapter 2. Administrative commands 459
ESTIMATE DBREORGSTATS (Estimates amount of recoverable space)
Use this command to estimate how much space can be recovered from the server
database by performing a reorganization. A database reorganization is done by
performing a DSMSERV UNLOADDB, DSMSERV LOADFORMAT and DSMSERV
LOADDB. The actual amount of space recovered is estimated to be this value or
greater.
To minimize the impact this command has on other server operations, make sure
the SELFTUNEBUFPOOLSIZE option is set or the BUFFERPOOLSIZE option is
large enough.
After this command completes, a RESET BUFPOOL is performed. This command
resets the database buffer pool statistics.
This command creates a background process that can be canceled with the
CANCEL PROCESS command. To display information on background processes,
use the QUERY PROCESS command.
Attention: This command is a long-running, I/O-intensive operation. It should
not be run during times of heavy server activity or load.
Privilege class
To issue this command, you must have system privilege.
Syntax

ESTimate DBREorgstats
Wait = No
Wait

=

No

Yes

Parameters
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is No. Possible
values are:
No
Specifies that the server processes this command in the background.
You can continue with other tasks while the command is being processed.
Messages created from the background process are displayed either in the
activity log or the server console, depending on where messages are
logged.
To cancel a background process, use the CANCEL PROCESS command.
Yes
Specifies that the server processes this command in the foreground. The
operation must complete before you can continue with other tasks. The
server then displays the output messages to the administrative client when
the operation completes. Messages are also displayed either in the activity
log or the server console, or both, depending on where the messages are
logged.
ESTIMATE DBREORGSTATS

460 IBM Tivoli Storage Manager for Windows: Administrators Reference
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Estimate the amount of recoverable space in the database.
Command
estimate dbreorgstats
Output
ANR1784I A database reorganization would reduce the
database utilization by an estimated 312 MB.
ANR0987I Process 2 for ESTIMATE DBREORG running in
BACKGROUND processed 4151 items with a completion state
of SUCCESS at 14:32:34.
ANR0381I Bufferpool statistics were successfully reset.
Task
Display information about the last completed estimate.
Command
query db format=detailed
Output

Available Space (MB): 8
Assigned Capacity (MB): 4
Maximum Extension (MB): 4
Maximum Reduction (MB): 0
Page Size (bytes): 4,096
Total Usable Pages: 1,024
Used Pages: 94
Pct Util: 9.2
Max. Pct Util: 9.2
Physical Volumes: 3
Buffer Pool Pages: 64
Total Buffer Requests: 4,702
Cache Hit Pct.: 97.68
Cache Wait Pct.: 0.00
Backup in Progress?: No
Type of Backup In Progress:
Incrementals Since Last Full: 0
Changed Since Last Backup (MB): 0.37
Percentage Changed: 100.00
Last Complete Backup Date/Time: 09/15/03 15:51:21
Estimate of Recoverable Space (MB): 321
Last Estimate of Recoverable Space: 09/13/03 06:03:20

Related commands
Table 152. Commands related to ESTIMATE DBREORGSTATS
Command Description
CANCEL PROCESS Cancels a background server process.
QUERY DB Displays allocation information about the
database.
QUERY PROCESS Displays information about background
processes.

ESTIMATE DBREORGSTATS
Chapter 2. Administrative commands 461
EXPIRE commands
Use the EXPIRE command to manually start inventory expiration processing for
Tivoli Storage Manager.
v EXPIRE INVENTORY (Manually start inventory expiration processing) on
page 463
EXPIRE commands

462 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXPIRE INVENTORY (Manually start inventory expiration
processing)
Use this command to manually start inventory expiration processing. The
inventory expiration process removes client backup and archive file copies from
server storage based on policy specified in the backup and archive copy groups of
the management classes to which the files are bound.
When you have the disaster recovery manager function for your Tivoli Storage
Manager server, the inventory expiration process also removes eligible virtual
volumes that are used for the following:
v Database backups of type BACKUPFULL, BACKUPINCR, and DBSNAPSHOT.
The SET DRMDBBACKUPEXPIREDAYS command controls when these volumes
are eligible for expiration.
v Recovery plan files of type RPFILE and RPFSNAPSHOT. The SET
DRMRPFEXPIREDAYS command controls when these volumes are eligible for
expiration.
The inventory expiration process that runs during server initialization does not
remove these virtual volumes.
Only one expiration process is allowed at any time. If an expiration process is
currently running, you cannot start another process.
You can set up automatic expiration processing with the EXPINTERVAL server
option. If you set the EXPINTERVAL to 0, the server does not run expiration
automatically, and you must issue this command to start expiration processing.
This command creates a background process that can be canceled with the
CANCEL PROCESS command. To display information on background processes,
use the QUERY PROCESS command.
If this command is applied to a WORM (write once, read many) volume, the
volume will return to scratch if it has space remaining in which data can be
written. (Note that data on WORM volumes, including deleted and expired data,
cannot be overwritten. Therefore, data can only be written in space that does not
contain current, deleted, or expired data.) If a WORM volume does not have any
space available in which data can be written, it will remain private. To remove the
volume from the library, you must use the CHECKOUT LIBVOLUME command.
Files will not be completely deleted from server storage using client delete
operations, so you should consider running the EXPIRE INVENTORY command.
See the Backup-Archive Clients Installation and Users Guide for more information
about client delete operations.
Privilege class
To issue this command, you must have system privilege.
Syntax

EXPIre Inventory
Quiet = No
Quiet

=

No

Yes
Wait = No
Wait

=

No

Yes

EXPIRE INVENTORY
Chapter 2. Administrative commands 463

SKipdirs = No
SKipdirs

=

No

Yes

DUration

=

minutes

Parameters
Quiet
Specifies whether the server suppresses detailed messages about policy
changes during the expiration processing. This parameter is optional. The
default is NO. Possible values are:
No
Specifies that the server sends detailed informational messages.
Yes
Specifies that the server sends only summary messages. The server issues
messages about policy changes only when files are deleted and either the
default management class or retention grace period for the domain has
been used to expire the files.
You can also specify the EXPQUIET option in the server options file to
automatically determine if expiration processing is performed with
summary messages.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default value is NO.
Possible values are:
No
Specifies that the server processes this command in the background. You
can continue with other tasks while the command is being processed. The
server displays messages that are created from the background process
either in the activity log or the server console, depending on where
messages are logged.
Yes
Specifies that the server processes this command in the foreground. You
wait for the command to complete before continuing with other tasks. The
server then displays the output messages to the administrative client when
the command completes.
Note: You cannot specify WAIT=YES from the server console.
SKipdirs
Specifies whether the server skips directory type objects during the expiration
processing. This parameter is optional. The default is NO. Possible values are:
No
Specifies that the server will expire files and directories based upon the
appropriate policy criteria.
Yes
Specifies that the server will skip directory type backup and archive objects
during expiration processing, even if the directories are eligible for
expiration. By specifying YES, you prevent deletion of directories, and
expiration processing can occur more quickly.
EXPIRE INVENTORY

464 IBM Tivoli Storage Manager for Windows: Administrators Reference
Attention: This option should not be used all the time. If you specify YES
often, the database will grow as the directory objects accumulate, and the
time spent for expiration will increase. You should run SKIPDIRS=NO
periodically to expire the directories and reduce the size of the database.
DUration
Specifies the maximum number of minutes for the expiration process to run.
The process stops when the specified number of minutes pass or when all
eligible expired objects are deleted, whichever comes first. You can specify a
number from 1 to 999999. This parameter is optional.
Examples
Task
Run the expiration process for two hours.
Command
expire inventory duration=120
Task
Run the expiration process on files only.
Command
expire inventory skipdirs=yes
Related commands
Table 153. Commands related to EXPIRE INVENTORY
Command Description
AUDIT LICENSES Checks for compliance with defined licenses.
CANCEL PROCESS Cancels a background server process.
QUERY PROCESS Displays information about background
processes.

EXPIRE INVENTORY
Chapter 2. Administrative commands 465
EXPORT commands
Use the EXPORT commands to copy information from a Tivoli Storage Manager
server to sequential removable media.
The following is a list of EXPORT commands for Tivoli Storage Manager:
v EXPORT ADMIN (Export administrator information) on page 467
v EXPORT NODE (Export client node information) on page 473
v EXPORT POLICY (Export policy information) on page 491
v EXPORT SERVER (Export server information) on page 497
EXPORT commands

466 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXPORT ADMIN (Export administrator information)
Use this command to export administrator and authority definitions from a server.
You can export the information to sequential media for later importing to another
server, or you can export the information directly to another server for immediate
import.
Note:
1. If target and source server levels are not compatible, the operation might
not work. See the Administrators Guide for server compatibility
requirements.
2. Exporting data to a CENTERA device class is not supported. However,
files stored in CENTERA storage pools can be exported.
Tivoli Storage Manager exports administrator information such as:
v Administrator name, password, and contact information
v Administrative privilege classes the administrator has been granted
v Whether the administrator ID is locked from server access
You can use the QUERY ACTLOG command to view the status of the export
operation. You can also view this information from the server console.
This command generates a background process that can be cancelled with the
CANCEL PROCESS command. If you export information to sequential media and
the background process is cancelled, the sequential media holding the exported
data are incomplete and should not be used for importing data. If a
server-to-server export background process is cancelled, a partial import may
result. Evaluate any imported data on the target server to determine if you want to
keep or delete the imported data. Review the import messages for details. To
display information on background processes, use the QUERY PROCESS
command.
The EXPORT ADMIN command takes two forms: export directly to another server
on the network, or export to sequential media. The syntax and parameters for each
form are defined separately.
Table 154. Commands related to EXPORT ADMIN
Command Description
CANCEL PROCESS Cancels a background server process.
EXPORT NODE Copies client node information to external
media.
EXPORT POLICY Copies policy information to external media.
EXPORT SERVER Copies all or part of the server to external
media.
IMPORT ADMIN Restores administrative information from
external media.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY PROCESS Displays information about background
processes.
EXPORT ADMIN
Chapter 2. Administrative commands 467
EXPORT ADMIN to sequential media
You can export administrator and authority definitions from a server to sequential
media for later importing to another server.
Privilege class
To issue this command, you must have system privilege.
Syntax

EXPort Admin

*
,

admin_name
Preview = No
(1)

(2)

Preview

=

No

Yes

(1)

DEVclass

=

device_class_name
Scratch = Yes
(2)

Scratch

=

Yes

No

,

(2)

VOLumenames

=

volume_name

FILE:

file_name

USEDVolumelist

=

file_name
ENCryptionstrength = AES
ENCryptionstrength

=

AES

DES

Notes:
1 If PREVIEW=NO, a device class must be specified.
2 If PREVIEW=NO and SCRATCH=NO, one or more volumes must be
specified.
Parameters
admin_name
Specifies the administrators for which information is to be exported. This
parameter is optional. The default is all administrators.
Separate the items in the list by commas, with no intervening spaces. You can
use wildcard characters to specify names.
Preview
Specifies whether to preview the results of the export operation, without
exporting information. You can use this parameter to preview how many bytes
of data are transferred, allowing you to determine how many volumes will be
required. This parameter is optional. The default value is NO. The values are:
No
Specifies that the administrator information is to be exported. If you
specify this value, you must specify a device class.
EXPORT ADMIN To Sequential Media

468 IBM Tivoli Storage Manager for Windows: Administrators Reference
Yes
Specifies that the operation will be previewed but not performed.
Information is reported to the server console and the activity log. If you
specify this value, you do not need to specify a device class.
DEVclass
Specifies the device class to which the export data is to be written. You cannot
specify the DISK, NAS, or CENTERA device classes. This parameter is required
if PREVIEW=NO.
Note:
1. If all drives for the device class are busy when the export runs,
Tivoli Storage Manager cancels lower priority operations, such as
reclamation, to make a drive available.
2. You can export data to a storage pool on another server by
specifying a device class whose device type is SERVER. You must
issue an IMPORT command from the other server to import the data.
For details about storing data on another server, see the
Administrators Guide.
Scratch
Specifies whether scratch volumes can be used. The default value is YES.
The values are:
Yes
Specifies that scratch volumes can be used for the export. If you also
specify a list of volumes, scratch volumes are used only if there is not
enough space on the volumes specified.
No
Specifies that scratch volumes cannot be used for export. To determine
how many volumes you may need, you can run the command specifying
PREVIEW=YES.
VOLumenames
Specifies the volumes to be used to contain exported data. This parameter
is optional, unless you specify SCRATCH=NO and PREVIEW=NO.
The values are:
volume_name
Specifies the volume name. To specify multiple volumes, separate the
names with commas and no intervening spaces.
FILE:file_name
Specifies the name of a file that contains a list of volumes. In the file,
each volume name must be on a separate line. Blank and comment
lines that begin with an asterisk are ignored.
Use these naming conventions when specifying volumes associated with
the following device types:

For this device Specify
Tape 16 alphanumeric characters.
FILE Any fully qualified file name string. For example,
d:\program files\tivoli\tsm\data1.dsm.
OPTICAL 132 alphanumeric characters.
REMOVABLEFILE 16 alphanumeric characters.
EXPORT ADMIN To Sequential Media
Chapter 2. Administrative commands 469
For this device Specify
SERVER 1250 alphanumeric characters.

USEDVolumelist
Specifies a file where a list of volumes used in the export operation will be
stored. This parameter is optional.
This file can be used as input to the import operation. This file will contain
comment lines with the date and time the export was done, and the
command issued to create the export.
Note: If you specify an existing file, the file will be overwritten.
ENCryptionstrength
Indicates which algorithm to use to encrypt passwords when exporting
administrative and node records. If you are exporting to a server that does
not support AES, you should specify DES. This parameter is optional. The
default value is AES.
Examples
Task 1
From the server, export the information for all defined administrators to tape
volumes TAPE01, TAPE02, and TAPE03. Specify that these tape volumes be read
by a device assigned to the MENU1 device class.
The number and type of objects exported are reported to the system console and in
the activity log.
Command
export admin devclass=menu1
volumenames=tape01,tape02,tape03
Task 2
From the server, export the information for all defined administrators to tape
volumes listed in a file named TAPEVOL.DATA. This file contains these lines:
TAPE01
TAPE02
TAPE03
Specify that these tape volumes be used by a device assigned to the MENU1
device class.
The number and type of objects exported are reported to the system console and in
the activity log.
Command
export admin devclass=menu1 volumenames=file:tapevol.data
EXPORT ADMIN To Sequential Media

470 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXPORT ADMIN directly to another server
Use this command to export administrator and authority definitions directly to
another server on the network. This results in an immediate import on the target
server.
You can issue a QUERY PROCESS command from the target server to monitor the
progress of the import operation.
Privilege class
To issue this command, you must have system privilege.
Syntax

EXPort Admin

*
,

admin_name

TOServer

=

servername

PREVIEWImport = No
PREVIEWImport

=

No

Yes
Replacedefs = No
Replacedefs

=

No

Yes

ENCryptionstrength = AES
ENCryptionstrength

=

AES

DES

Parameters
admin_name
Specifies the administrators for which information is to be exported. This
parameter is optional. The default is all administrators.
Separate the items in the list by commas, with no intervening spaces. You can
use wildcard characters to specify names.
TOServer
Specifies the name of a server to which the export data will be sent directly
over the network for immediate import.
Note: The target server must be defined on the originating server with the
DEFINE SERVER command. The administrator that issues the export
command must be defined with the same administrator name and
password and have system authority on the target server.
When you specify TOSERVER, you cannot specify the DEVCLASS,
VOLUMENAMES, and SCRATCH, USEDVOLUMELIST, and PREVIEW
parameters.
PREVIEWImport
Specifies whether to view how much data will be transferred, without actually
moving any data. This information can be used to determine how much
storage pool space is required on the target server. The default is NO.
Valid values are:
EXPORT ADMIN Directly to Another Server
Chapter 2. Administrative commands 471
Yes
Specifies that you want to preview the results of the import operation on
the target server, without importing the data. Information is reported to the
server console and the activity log.
No
Specifies that you want the data to be imported on the target server
without previewing the results.
Replacedefs
Specifies whether to replace definitions (not file data) on the server. The
default is NO.
Valid values are:
Yes
Specifies that definitions are replaced on the server if definitions having
the same name as those being imported already exist on the target server.
No
Specifies that imported definitions are skipped if their names conflict with
definitions that are already defined on the target server.
ENCryptionstrength
Indicates which algorithm to use to encrypt passwords when exporting
administrative and node records. If you are exporting to a server that does not
support AES, you should specify DES. This parameter is optional. The default
value is AES.
Examples
Task
Export all the administrator definitions to the target server defined as
OTHERSERVER. Preview the import operations on the target server.
Command
export admin * toserver=otherserver previewimport=yes
From the target server, OTHERSERVER, you can view the import
operations by issuing:
query process
EXPORT ADMIN Directly to Another Server

472 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXPORT NODE (Export client node information)
Use this command to export client node definitions or file data to sequential media
or directly to another server for immediate import.
You can export data from a server with retention protection enabled, but it is not
retention protected when imported on another server.
You cannot export nodes of type NAS; export processing excludes these nodes.
Each client node definition includes information such as:
v User ID, password, and contact information.
v Name of the clients assigned policy domain.
v File compression status.
v Whether the user has the authority to delete backed-up or archived files from
server storage.
v Whether the client node ID is locked from server access.
Optionally, you can also export the following:
v File space definitions.
v Backed-up, archived, and space-managed files.
v Access authorization information pertaining to the file spaces exported.
v Archive data that is in deletion hold status may be exported, but the hold status
will not be preserved.
v When the archive data is imported, it will not remain in deletion hold.
The EXPORT NODE command generates a background process that can be
cancelled with the CANCEL PROCESS command. If you export node information
to sequential media and the background process is cancelled, the sequential media
holding the exported data are incomplete and should not be used for importing
data. If a server-to-server export background process is cancelled, a partial import
may result. Evaluate any imported data on the target server to determine if you
want to keep or delete the imported data. Review the import messages for details.
To display information on background processes, issue the QUERY PROCESS
command.
To display information on any running and suspended server-to-server export
operations, issue the QUERY EXPORT command. The QUERY EXPORT command
only displays information for exports that can be suspended. Export operations
that can be suspended, and subsequently restarted, are those server-to-server
exports whose FILEDATA has a value other than NONE. You can issue the QUERY
ACTLOG command to view the status of the export operation.
Note:
1. If target and source server levels are not compatible, the operation might
not work. See the Administrators Guide for server compatibility
requirements.
2. Exporting data to a CENTERA device class is not supported. However,
files stored in CENTERA storage pools can be exported.
Because of unpredictable results, do not run expiration, migration, backup, or
archive when issuing the EXPORT NODE command. See the Administrators Guide
for more information.
EXPORT NODE
Chapter 2. Administrative commands 473
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
For a server that has clients with support for Unicode, you might need to have the
server convert the file space name that you enter, or use one of the following
parameters:
v FSID
v UNIFILESPACE
The EXPORT NODE command takes two forms: export directly to another server
on the network, or export to sequential media. The syntax and parameters for each
form are defined separately.
Table 155. Commands related to EXPORT NODE
Command Description
CANCEL EXPORT Deletes a suspended export operation
CANCEL PROCESS Cancels a background server process.
COPY ACTIVEDATA Copies active backup data.
EXPORT ADMIN Copies administrative information to external
media.
EXPORT POLICY Copies policy information to external media.
EXPORT SERVER Copies all or part of the server to external
media.
IMPORT NODE Restores client node information from
external media.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY EXPORT Displays the export operations that are
currently running or suspended.
QUERY PROCESS Displays information about background
processes.
RESTART EXPORT Restarts a suspended export operation.
SUSPEND EXPORT Suspends a running export operation.
EXPORT NODE

474 IBM Tivoli Storage Manager for Windows: Administrators Reference
||
||
|
||
||
EXPORT NODE to sequential media
You can export node definitions or file data from a server to sequential media for
later importing to another server.
Privilege class
To issue this command, you must have system privilege.
Syntax

EXPort Node

*
,

node_name

,

FILESpace

=

file_space_name

,

FSID

=

file_space_ID

,

UNIFILESpace

=

file_space_name

,

DOmains

=

domain_name
FILEData = None
FILEData

=

ALl

None

ARchive

Backup

BACKUPActive

ALLActive

SPacemanaged

Preview = No
(1)

(2)

Preview

=

No

Yes

(1)

DEVclass

=

device_class_name

Scratch = Yes
(2)

Scratch

=

Yes

No

,

(2)

VOLumenames

=

volume_name

FILE:

file_name

USEDVolumelist

=

file_name

FROMTime

=

00:00:00

FROMDate

=

date

FROMTime

=

time

EXPORT NODE To Sequential Media
Chapter 2. Administrative commands 475

TOTime

=

00:00:00

TODate

=

date

TOTime

=

time

ENCryptionstrength = AES
ENCryptionstrength

=

AES

DES
ALLOWSHREDdable = No
ALLOWSHREDdable

=

No

Yes

Notes:
1 If PREVIEW=NO, a device class must be specified.
2 If PREVIEW=NO and SCRATCH=NO, one or more volumes must be
specified.
Parameters
node_name
Specifies the client node names for which information is to be exported. This
parameter is optional. Separate multiple names with commas and no
intervening spaces. You can use wildcard characters to specify names. For each
node entered, all file spaces in the file space, FSID, and Unicode enabled lists
will be searched.
Note: If you use wildcard characters to specify a pattern for node names, the
server will not report the node names or patterns that do not match any
entries in the database. Check the summary statistics in the activity log
to verify that the server exported all intended nodes.
FILESpace
Specifies the file spaces for which data is to be exported. This parameter is
optional. Separate multiple names with commas and no intervening spaces.
You can use wildcard characters to specify a name.
FSID
Specifies the file spaces by using their file space IDs (FSIDs). The server uses
the FSIDs to find the file spaces to export. To find the FSID for a file space, use
the QUERY FILESPACE command. Separate multiple file space IDs with
commas and no intervening spaces. This parameter is optional.
UNIFILESpace
Specifies the file spaces that are known to the server to be Unicode enabled.
The server converts the names you enter from the server code page to the
UTF-8 code page to find the file spaces to export. The success of the
conversion depends on the actual characters in the name and the servers code
page. Separate multiple names with commas and no intervening spaces. This
parameter is optional.
DOmains
Specifies the policy domains from which nodes should be exported. This
parameter is optional. Separate multiple names with commas and no
intervening spaces. If you specify domains, a node is exported only if it
belongs to one of the specified domains. You can use wildcard characters to
specify a name.
EXPORT NODE To Sequential Media

476 IBM Tivoli Storage Manager for Windows: Administrators Reference
|||||||||
FILEData
Specifies the type of files that should be exported for all nodes being exported
to the server. This parameter is optional. The default value is NONE.
If you are exporting to sequential media: the device class used by the file data
is determined by the device class for the storage pool. If it is the same device
class specified in this command, two drives are needed to export node
information. The mount limit for the device class must be at least 2.
Note: If client nodes registered as TYPE=SERVER are being exported, specify
ALL, ARCHIVE, or ALLACTIVE.
The following descriptions mention active and inactive backup file versions. An
active backup file version is the most recent backup version for a file that still
exists on the client workstation. All other backup file versions are called
inactive copies. The values are:
ALl
The server exports all backup versions of files, all archived files, and all
space-managed files.
None
The server does not export files, only node definitions.
ARchive
The server exports only archived files.
Backup
The server exports only backup versions, whether active or inactive.
BACKUPActive
The server exports only active backup versions.
ALLActive
The server exports all active backup versions of files, all archived files, and
all space-managed files.
SPacemanaged
The server exports only space-managed files.
Preview
Specifies whether to preview the results of the export operation, without
exporting information. You can use this parameter to preview how many bytes
of data would be transferred, allowing you to determine how many volumes
will be required. This parameter is optional. The default value is NO. The
values are:
No
Specifies that the node information is to be exported. If you specify this
value, you must also specify a device class.
Yes
Specifies that the operation will be previewed but not performed.
Information is reported to the server console and the activity log. If you
specify this value, you do not need to specify a device class.
DEVclass
Specifies the device class to which export data is to be written. You cannot
specify the DISK, NAS, or CENTERA device classes. This parameter is required
if PREVIEW=NO.
Note:
EXPORT NODE To Sequential Media
Chapter 2. Administrative commands 477
1. If all drives for the device class are busy when the export runs, IBM
Tivoli Storage Manager cancels lower priority operations, such as
reclamation, to make a drive available.
2. You can export data to a storage pool on another server by
specifying a device class whose device type is SERVER. For details
about storing data on another server, see the Administrators Guide.
Scratch
Specifies whether scratch volumes can be used. The default is SCRATCH=YES.
The values are:
Yes
Specifies that scratch volumes can be used for export. If you also specify a
list of volumes, scratch volumes are used only if there is not enough space
on the volumes specified.
No
Specifies that scratch volumes cannot be used for export. To determine
how many volumes you may need, you can run the command specifying
PREVIEW=YES.
VOLumenames
Specifies the volumes to be used to contain exported data. This parameter is
optional, unless you specify SCRATCH=NO and PREVIEW=NO. If you do not
specify a volume name, scratch volumes are used.
The values are:
volume_name
Specifies the volume name. To specify multiple volumes, separate the
names with commas and no intervening spaces.
FILE:file_name
Specifies the name of a file that contains a list of volumes. In the file, each
volume name must be on a separate line. Blank and comment lines that
begin with an asterisk are ignored.
Use these naming conventions when specifying volumes associated with the
following device types:

For this device Specify
Tape 16 alphanumeric characters.
FILE Any fully qualified file name string. For example,
d:\program files\tivoli\tsm\data1.dsm.
OPTICAL 132 alphanumeric characters.
REMOVABLEFILE 16 alphanumeric characters.
SERVER 1250 alphanumeric characters.

USEDVolumelist
Specifies the file where a list of volumes used in the export operation will be
stored. This parameter is optional.
This file can be used as input to the import operation. This file will contain
comment lines with the date and time the export was done, and the command
issued to create the export.
Note: If you specify an existing file, the file will be overwritten.
EXPORT NODE To Sequential Media

478 IBM Tivoli Storage Manager for Windows: Administrators Reference
FROMDate
Specifies the earliest date for which objects to be exported were stored on the
server. Objects that were stored on the server earlier than the specified date
will not be exported. This parameter only applies to client file data. This
parameter has no effect on other information that may be exported, for
example policy. Tivoli Storage Manager ignores the FROMDATE parameter
when the FILEDATA parameter is set to NONE.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can specify
is 9999.
TODAY 3 or 3.

If this parameter is not specified, Tivoli Storage Manager exports all objects
stored before the TODATE parameter and as qualified by the FILEDATA
parameter. If no TODATE parameter is specified, then all data as qualified by
the FILEDATA parameter is exported.
TODate
Specifies the latest date for objects to be exported from the server. Objects
stored on the server on a date later than the TODATE value are not exported.
TODATE only applies to client file data and does not affect other information
that is being exported, such as policy. Tivoli Storage Manager ignores the
TODATE parameter when the FILEDATA parameter is set to NONE.
Note: If a TODATE parameter is specified without a TOTIME parameter, the
server exports all objects inserted on or before the day specified by the
TODATE parameter.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 10/15/2006
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY 3 or 3.

Note: If you specified the FROMDATE parameter, the value of TODATE must
be later than or equal to the FROMDATE value. If the TODATE and
FROMDATE are equal, then the TOTIME parameter must be later that
the FROMTIME parameter.
FROMTime
Specifies the earliest time for which objects to be exported were stored on the
server. When you specify FROMTIME, you must also use the FROMDATE
parameter. This parameter only applies to client file data. This parameter has
no effect on other information that may be exported, for example policy.
Objects that were stored on the server before the specified time and date will
EXPORT NODE To Sequential Media
Chapter 2. Administrative commands 479
|
|
|
|
|
|
|
|
|
|
|
|||
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
not be exported. Tivoli Storage Manager ignores the FROMTIME parameter
when the FILEDATA parameter is set to NONE.
The default value for this parameter when used with the FROMDATE
parameter is midnight (00:00:00).
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified. The
FROMTIME+ can only be used
with a FROMDATE before
today.
NOW+02:00 or +02:00.
If you issue this command at 5:00 with
FROMTIME=NOW+02:00 or
FROMTIME=+02:00, the export
operation only contains files that were
put on the server after 7:00 on the
FROMDATE that you specify.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW02:00 or 02:00.
If you issue this command at 5:00 with
FROMTIME=NOW02:00 or
FROMTIME=2:00, the export includes
files that were put on the server after
3:00.

TOTime
Specifies the latest time that objects to be exported were stored on the server.
You must specify the TODATE parameter in order to use the TOTIME
parameter. TOTIME only applies to client file data and does not affect other
information that is being exported, such as policy. Tivoli Storage Manager
ignores the TOTIME parameter if the FILEDATA parameter is set to NONE.
The default value for this parameter when used with the TODATE parameter
is midnight minus one second (23:59:59).
Note: The value of TOTIME and TODATE parameters must be later than the
FROMDATE and the FROMTIME value.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW+HH:MM
or+HH:MM
The current time plus hours
and minutes specified.
NOW+02:00 or +02:00.
If you issue this command at 05:00
with FROMTIME=01:00 and
TOTIME=NOW+02:00, the export
includes files that were stored from
01:00 until 07:00.
NOW-HH:MM
or-HH:MM
The current time minus hours
and minutes specified.
NOW-02:00 or -02:00.
If you issue this command at 05:00
with FROMTIME=01:00 and
TOTIME=NOW-02:00, the export
includes files that were stored from
01:00 until 03:00.

EXPORT NODE To Sequential Media

480 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ENCryptionstrength
Indicates which algorithm to use to encrypt passwords when exporting
administrative and node records. This parameter is optional. The default value
is AES. If you are exporting to a server that does not support AES, you should
specify DES. Possible values are:
AES
Specifies the Advanced Encryption Standard (AES).
DES
Specifies the Data Encryption Standard (DES).
ALLOWSHREDdable
Specifies whether data from a storage pool that enforces shredding is exported.
This parameter is optional. The default value is NO. Possible values are:
No
Specifies that the server does not allow data to be exported from a storage
pool that enforces shredding.
Yes
Specifies that the server allows data to be exported from a storage pool
that enforces shredding. The data on the export media will not be
shredded.
Examples
Task 1 From the server, export client node information to tape volumes TAPE01,
TAPE02, and TAPE03. Specify that these tape volumes be used by a device
assigned to the MENU1 device class.
Command
export node devclass=menu1 volumenames=tape01,tape02,tape03
Task 2 From the server, export the client node information to tape volumes listed
in a file named TAPEVOL.DATA. This file contains these lines:
TAPE01
TAPE02
TAPE03
Specify that these tape volumes be read by a device assigned to the
MENU1 device class.
Command
export node devclass=menu1 volumenames=file:tapevol.data
Task 3 From the server, use the FSID to export active backup versions of file data
for client node JOE to tape volume TAPE01. To determine the FSID, first
issue a QUERY FILESPACE command.
Command
1. To determine the FSID, issue a QUERY FILESPACE command.
query filespace joe
Output
Node Name Filespace FSID Platform Filespace Is Capacity Pct
Name Type Filespace (MB) Util
Unicode?
--------- ---------- ---- ------- --------- --------- -------- ----
JOE \\joe\c$ 1 WinNT NTFS Yes 2,502.3 75.2
JOE \\joe\d$ 2 WinNT NTFS Yes 6,173.4 59.6

EXPORT NODE To Sequential Media
Chapter 2. Administrative commands 481
|
2. Export the active backup versions of file data and specify that
the tape volume be used by a device assigned to the MENU1
device class.
export node joe fsid=1,2 filedata=backupactive devclass=menu1
volumenames=tape01
EXPORT NODE To Sequential Media

482 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXPORT NODE directly to another server
Use this command to export client node definitions or file data directly to another
server for immediate import.
Note: You cannot export nodes of type NAS. Export processing will exclude these
nodes.
You can suspend and, subsequently, restart a server-to-server export operation that
has a FILEDATA value other than NONE. The server saves the state and status of
the export operation so that it may be restarted from the point at which the
operation failed or was suspended. The export operation can be restarted at a later
date by issuing the RESTART EXPORT command.
Note: An export operation is suspended when any of the following conditions is
detected:
v A SUSPEND EXPORT command is issued for the running export
operation
v Segment preemption - the file being read for export is deleted by some
other process
v Communication errors on a server-to-server export
v No available mountpoints
v Necessary volumes are unavailable
v I/O Errors encountered
To display information on any running and suspended export operations,
issue the QUERY EXPORT command.
The export operation cannot be restarted if the export operation fails prior to
transmitting the eligible node and file space definitions to the target server. You
must reenter the command to begin a new export operation.
You can issue a QUERY PROCESS command from the target server to monitor the
progress of the import operation. Issue the QUERY EXPORT command to list all
restartable server-to-server export operations.
Privilege class
To issue this command, you must have system privilege.
Syntax

EXPort Node
*
node_name

FILESpace

=

file_space_name

FSID

=

file_space_ID

UNIFILESpace

=

file_space_name

EXPORT NODE Directly to Another Server
Chapter 2. Administrative commands 483
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|

DOmains

=

domain_name
FILEData = None
FILEData

=

ALl

None

ARchive

Backup

BACKUPActive

ALLActive

SPacemanaged

FROMTime

=

00:00:00

FROMDate

=

date

FROMTime

=

time

TOTime

=

00:00:00

TODate

=

date

TOTime

=

time

EXPORTIDentifier

=

export_identifier

TOServer

=

servername

PREVIEWImport = No
PREVIEWImport

=

No

Yes
MERGEfilespaces = No
MERGEfilespaces

=

No

Yes

Replacedefs = No
Replacedefs

=

No

Yes
PROXynodeassoc = No
PROXynodeassoc

=

No

Yes

ENCryptionstrength = AES
ENCryptionstrength

=

AES

DES
ALLOWSHREDdable = No
ALLOWSHREDdable

=

No

Yes

Parameters
node_name
Specifies the client node names for which information is to be exported. This
parameter is optional. Separate multiple names with commas and no
intervening spaces. You can use wildcard characters to specify names. For each
node entered, all file spaces in the file space, FSID, and Unicode enabled lists
will be searched.
Note: If you specify a list of node names or node patterns, the server will not
report the node names or node patterns that do not match any entries in
the database. Check the summary statistics in the activity log to verify
that the server exported all intended nodes.
FILESpace
Specifies the file spaces for which data is to be exported. This parameter is
optional. Separate multiple names with commas and no intervening spaces.
You can use wildcard characters to specify a name.
EXPORT NODE Directly to Another Server

484 IBM Tivoli Storage Manager for Windows: Administrators Reference
|||||||||
|||
FSID
Specifies the file spaces by using their file space IDs (FSIDs). The server uses
the FSIDs to find the file spaces to export. To find the FSID for a file space, use
the QUERY FILESPACE command. Separate multiple file space IDs with
commas and no intervening spaces. This parameter is optional.
UNIFILESpace
Specifies the file spaces that are known to the server to be Unicode enabled.
The server converts the names you enter from the server code page to the
UTF-8 code page to find the file spaces to export. The success of the
conversion depends on the actual characters in the name and the servers code
page. Separate multiple names with commas and no intervening spaces. This
parameter is optional.
DOmains
Specifies the policy domains from which nodes should be exported. This
parameter is optional. Separate multiple names with commas and no
intervening spaces. If you specify domains, Tivoli Storage Manager exports a
node only if it belongs to one of the specified domains. You can use wildcard
characters to specify a name.
FILEData
Specifies the type of files to export for all nodes. This parameter is optional.
The default value is NONE.
If you are exporting to sequential media, the device class used by the file data
is determined by the device class for the storage pool. If it is the same device
class specified in this command, Tivoli Storage Manager requires two drives to
export node information. The mount limit for the device class must be at least
2.
Note: If you export client nodes that are registered as TYPE=SERVER, specify
ALL, ARCHIVE, or ALLACTIVE.
The following descriptions mention active and inactive backup file versions. An
active backup file version is the most recent backup version for a file that still
exists on the client workstation. All other backup file versions are called
inactive copies. The values are:
ALl
The server exports all backup versions of files, all archived files, and all
space-managed files.
None
The server does not export files, only node definitions.
ARchive
The server exports only archived files.
Backup
The server exports only backup versions, whether they are active or
inactive.
BACKUPActive
The server exports only active backup versions.
ALLActive
The server exports all active backup versions of files, all archived files, and
all space-managed files.
SPacemanaged
The server exports only space-managed files.
EXPORT NODE Directly to Another Server
Chapter 2. Administrative commands 485
FROMDate
Specifies the earliest date for which objects to be exported were stored on the
server. Objects that were stored on the server earlier than the specified date
will not be exported. This parameter only applies to client file data. This
parameter has no effect on other information that may be exported, for
example policy. Tivoli Storage Manager ignores the FROMDATE parameter
when the FILEDATA parameter is set to NONE.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can specify
is 9999.
TODAY 3 or 3.

If this parameter is not specified, Tivoli Storage Manager exports all objects
stored before the TODATE parameter and as qualified by the FILEDATA
parameter. If no TODATE parameter is specified, then all data as qualified by
the FILEDATA parameter is exported.
TODate
Specifies the latest date for objects to be exported from the server. Objects
stored on the server on a date later than the TODATE value are not exported.
TODATE only applies to client file data and does not affect other information
that is being exported, such as policy. Tivoli Storage Manager ignores the
TODATE parameter when the FILEDATA parameter is set to NONE.
Note: If a TODATE parameter is specified without a TOTIME parameter, the
server exports all objects inserted on or before the day specified by the
TODATE parameter.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 10/15/2006
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY 3 or 3.

Note: If you specified the FROMDATE parameter, the value of TODATE must
be later than or equal to the FROMDATE value. If the TODATE and
FROMDATE are equal, then the TOTIME parameter must be later that
the FROMTIME parameter.
FROMTime
Specifies the earliest time for which objects to be exported were stored on the
server. When you specify FROMTIME, you must also use the FROMDATE
parameter. This parameter only applies to client file data. This parameter has
no effect on other information that may be exported, for example policy.
Objects that were stored on the server before the specified time and date will
EXPORT NODE Directly to Another Server

486 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|||
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
not be exported. Tivoli Storage Manager ignores the FROMTIME parameter
when the FILEDATA parameter is set to NONE.
The default value for this parameter when used with the FROMDATE
parameter is midnight (00:00:00).
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified. The
FROMTIME+ can only be used
with a FROMDATE before
today.
NOW+02:00 or +02:00.
If you issue this command at 5:00 with
FROMTIME=NOW+02:00 or
FROMTIME=+02:00, the export
operation only contains files that were
put on the server after 7:00 on the
FROMDATE that you specify.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW02:00 or 02:00.
If you issue this command at 5:00 with
FROMTIME=NOW02:00 or
FROMTIME=2:00, the export includes
files that were put on the server after
3:00.

TOTime
Specifies the latest time that objects to be exported were stored on the server.
You must specify the TODATE parameter in order to use the TOTIME
parameter. TOTIME only applies to client file data and does not affect other
information that is being exported, such as policy. Tivoli Storage Manager
ignores the TOTIME parameter if the FILEDATA parameter is set to NONE.
The default value for this parameter when used with the TODATE parameter
is midnight minus one second (23:59:59).
Note: The value of TOTIME and TODATE parameters must be later than the
FROMDATE and the FROMTIME value.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW+HH:MM
or+HH:MM
The current time plus hours
and minutes specified.
NOW+02:00 or +02:00.
If you issue this command at 05:00
with FROMTIME=01:00 and
TOTIME=NOW+02:00, the export
includes files that were stored from
01:00 until 07:00.
NOW-HH:MM
or-HH:MM
The current time minus hours
and minutes specified.
NOW-02:00 or -02:00.
If you issue this command at 05:00
with FROMTIME=01:00 and
TOTIME=NOW-02:00, the export
includes files that were stored from
01:00 until 03:00.

EXPORT NODE Directly to Another Server
Chapter 2. Administrative commands 487
|
|
|
|
|
|
|
|
|
|
|
|
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TOServer
Specifies the name of a server to which the export data will be sent directly
over the network for immediate import.
Note: The target server must be defined on the originating server with the
DEFINE SERVER command. The administrator that issues the export
command must be defined with the same administrator name and
password and have system authority on the target server.
When you specify TOSERVER, you cannot specify the DEVCLASS,
VOLUMENAMES, and SCRATCH, USEDVOLUMELIST, and PREVIEW
parameters.
PREVIEWImport
Specifies whether to view how much data will be transferred, without actually
moving any data. This information can be used to determine how much
storage pool space is required on the target server. The default is NO.
Valid values are:
Yes
Specifies that you want to preview the results of the import operation on
the target server, without importing the data. Information is reported to the
server console and the activity log.
No
Specifies that you want the data to be imported on the target server
without previewing the results.
MERGEfilespaces
Specifies whether Tivoli Storage Manager merges client files into existing file
spaces on the target server (if they exist), or if Tivoli Storage Manager
generates new file space names. The default is NO.
You can only specify this parameter if you have specified the TOSERVER
parameter.
Valid values are:
Yes
Specifies that imported data on the target server is merged with the
existing file space, if a file space with the same name already exists on the
target server.
No
Specifies that Tivoli Storage Manager generates a new file space name for
imported data on the target server if file spaces with the same name
already exist.
Replacedefs
Specifies whether to replace definitions (not file data) on the server. The
default is NO.
Valid values are:
Yes
Specifies that definitions are replaced on the server if definitions having
the same name as those being imported already exist on the target server.
No
Specifies that imported definitions are skipped if their names conflict with
definitions that are already defined on the target server.
EXPORT NODE Directly to Another Server

488 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
PROXynodeassoc
Specifies if proxy node associations are exported. This parameter is optional.
The default value is NO.
ENCryptionstrength
Indicates which algorithm to use to encrypt passwords when exporting
administrative and node records. If you are exporting to a server that does not
support AES, specify DES. This parameter is optional. The default value is
AES. Possible values are:
AES
Specifies the Advanced Encryption Standard (AES).
DES
Specifies the Data Encryption Standard (DES).
ALLOWSHREDdable
Specifies whether data from a storage pool that enforces shredding is exported.
This parameter is optional. The default value is NO. Possible values are:
No
Specifies that the server does not allow data to be exported from a storage
pool that enforces shredding.
Yes
Specifies that the server allows data to be exported from a storage pool
that enforces shredding. The data on the export media will not be
shredded.
Important: After an export operation has finished identifying files for export,
any changes to the storage pool ALLOWSHREDABLE value is
ignored. An export operation that is suspended retains the original
ALLOWSHREDABLE value throughout the operation. You might
want to consider cancelling your export operation if changes to the
storage pool ALLOWSHREDABLE value jeopardize the operation.
You can reissue the export command after any needed cleanup.
EXPORTIDentifier
This optional parameter specifies the name that you select to identify this
export operation. If you do not specify an identifier name, the server generates
one for you. The export identifier name cannot be more than 64 characters,
cannot contain wildcard characters, and is not case sensitive. You can use the
identifier name to reference export operations in the QUERY EXPORT,
SUSPEND EXPORT, RESTART EXPORT, or CANCEL EXPORT commands.
Note: You must specify the TOSERVER parameter if you are specifying the
EXPORTIDENTIFIER parameter.
EXPORTIDENTIFIER is ignored if FILEDATA=NONE.
Examples
Task To export client node information and all client files for NODE1 directly to
SERVERB, issue the following command.
Command
export node node1 filedata=all toserver=serverb
Task To export client node information and all client files for NODE1 directly to
SERVERB between February 1, 2007 and today.
EXPORT NODE Directly to Another Server
Chapter 2. Administrative commands 489
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Command
export node node1 filedata=all toserver=serverb
fromdate=020107 todate=today
Task To export client node information and all client files for NODE1 directly to
SERVERB from 8:00 AM on February 1, 2007 until today at 8:00 AM, issue
the following command.
Command
export node node1 filedata=all toserver=serverb
fromdate=020107 fromtime=08:00:00
todate=today totime=08:00:00
Task To export client node information and all client files for NODE1 directly to
SERVERB for the past three days, issue the following command.
Command
export node node1 filedata=all toserver=serverb
fromdate=today -3
EXPORT NODE Directly to Another Server

490 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXPORT POLICY (Export policy information)
Use this command to export policy information from a Tivoli Storage Manager
server to sequential media or directly to another server for immediate import.
Note:
1. If target and source server levels are not compatible, the operation may
not work. See the Administrators Guide for server compatibility
requirements.
2. Exporting data to a CENTERA device class is not supported. However,
files stored in CENTERA storage pools can be exported.
The server exports policy information, such as:
v Policy domain definitions
v Policy set definitions, including the active policy set
v Management class definitions, including the default management class
v Backup copy group and archive copy group definitions
v Schedule definitions for each policy domain
v Client node associations, if the client node exists on the target server
You can use the QUERY ACTLOG command to view the status of the export
operation. You can also view this information from the server console.
This command generates a background process that can be cancelled with the
CANCEL PROCESS command. If you export policy information to sequential
media and the background process is cancelled, the sequential media holding the
exported data are incomplete and should not be used for importing data. If a
server-to-server export background process is cancelled, a partial import may
result. Evaluate any imported data on the target server to determine if you want to
keep or delete the imported data. Review the import messages for details. To
display information on background processes, use the QUERY PROCESS
command.
The EXPORT POLICY command takes two forms: export directly to another server
on the network, or export to sequential media. The syntax and parameters for each
form are defined separately.
Table 156. Commands related to EXPORT POLICY
Command Description
CANCEL PROCESS Cancels a background server process.
EXPORT ADMIN Copies administrative information to external
media.
EXPORT NODE Copies client node information to external
media.
EXPORT SERVER Copies all or part of the server to external
media.
IMPORT POLICY Restores policy information from external
media.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY PROCESS Displays information about background
processes.
EXPORT POLICY
Chapter 2. Administrative commands 491
EXPORT POLICY to sequential media
Use this command to export policy information from an IBM Tivoli Storage
Manager server to sequential media for later import to another server.
Privilege class
To issue this command, you must have system privilege.
Syntax

EXPort Policy

*
,

domain_name
Preview = No
(1)

(2)

Preview

=

No

Yes

(1)

DEVclass

=

device_class_name
Scratch = Yes
(2)

Scratch

=

Yes

No

,

(2)

VOLumenames

=

volume_name

FILE:

file_name

USEDVolumelist

=

file_name


Notes:
1 If PREVIEW=NO, a device class must be specified.
2 If PREVIEW=NO and SCRATCH=NO, one or more volumes must be
specified.
Parameters
domain_name
Specifies the policy domains for which information is to be exported. This
parameter is optional. The default is all policy domains. Separate multiple
names with commas and no intervening spaces. You can use wildcard
characters to specify names.
Preview
Specifies whether to preview the results of the export operation, without
exporting information. You can use this parameter to preview how many bytes
of data are transferred, allowing you to determine how many volumes will be
required. This parameter is optional. The default value is NO. The values are:
No
Specifies that the policy information is to be exported. If you specify this
value, you must also specify a device class.
Yes
Specifies that the operation will be previewed but not performed.
EXPORT POLICY To Sequential Media

492 IBM Tivoli Storage Manager for Windows: Administrators Reference
Information is reported to the server console and the activity log. If you
specify this value, you do not need to specify a device class.
DEVclass
Specifies the device class to which export data is to be written. This parameter
is required, unless you specified PREVIEW=YES. You cannot specify the DISK,
NAS, or CENTERA device classes.
Note:
1. If all drives for the device class are busy when the export runs,
Tivoli Storage Manager cancels lower priority operations, such as
reclamation, to make a drive available.
2. You can export data to a storage pool on another server by
specifying a device class whose device type is SERVER. For details
about storing data on another server, see the Administrators Guide.
Scratch
Specifies whether scratch volumes can be used. The default is SCRATCH=YES.
The values are:
Yes
Specifies that scratch volumes can be used for the export. If you also
specify a list of volumes, scratch volumes are used only if there is not
enough space on the volumes specified.
No
Specifies that scratch volumes cannot be used for export. To determine
how many volumes you may need, you can run the command specifying
PREVIEW=YES.
VOLumenames
Specifies the volumes to be used to contain exported data. This parameter is
optional, unless SCRATCH=NO and PREVIEW=NO. If you do not specify a
volume name, scratch volumes are used.
The values are:
volume_name
Specifies the volume name. To specify multiple volumes, separate the
names with commas and no intervening spaces.
FILE:file_name
Specifies the name of a file that contains a list of volumes. In the file, each
volume name must be on a separate line. Blank and comment lines that
begin with an asterisk are ignored.
Use these naming conventions when specifying volumes associated with the
following device types:

For this device Specify
Tape 16 alphanumeric characters.
FILE Any fully qualified file name string. For example,
d:\program files\tivoli\tsm\data1.dsm.
OPTICAL 132 alphanumeric characters.
REMOVABLEFILE 16 alphanumeric characters.
SERVER 1250 alphanumeric characters.

EXPORT POLICY To Sequential Media
Chapter 2. Administrative commands 493
USEDVolumelist
Specifies a file where a list of volumes used in the export operation will be
stored. This parameter is optional.
This file can be used as input to the export operation. This file will contain
comment lines with the date and time the export was done, and the command
issued to create the export.
Note: If you specify an existing file, the file will be overwritten.
Examples
Task 1
From the server, export policy information to tape volumes TAPE01, TAPE02, and
TAPE03. Specify that these tape volumes be read by a device assigned to the
MENU1 device class.
Command
export policy devclass=menu1
volumenames=tape01,tape02,tape03
Task 2
From the server, export policy information to tape volumes listed in a file named
TAPEVOL.DATA. This file contains these lines:
TAPE01
TAPE02
TAPE03
Specify that these tape volumes be used by a device assigned to the MENU1
device class.
Command
export policy devclass=menu1 volumenames=file:tapevol.data
EXPORT POLICY To Sequential Media

494 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXPORT POLICY directly to another server
Use this command to export policy information directly to another server on the
network. This results in an immediate import on the target server.
To monitor the progress of the import operation, you can issue a QUERY PROCESS
command from the target server.
Privilege class
To issue this command, you must have system privilege.
Syntax

EXPort Policy

*
,

domain_name

TOServer

=

servername

PREVIEWImport = No
PREVIEWImport

=

No

Yes
Replacedefs = No
Replacedefs

=

No

Yes

Parameters
domain_name
Specifies the policy domains for which information is to be exported. This
parameter is optional. The default is all policy domains. Separate multiple
names with commas and no intervening spaces. You can use wildcard
characters to specify names.
TOServer
Specifies the name of a server to which the export data will be sent directly
over the network for immediate import.
Note: The target server must be defined on the originating server with the
DEFINE SERVER command. The administrator that issues the export
command must be defined with the same administrator name and
password and have system authority on the target server.
When you specify TOSERVER, you cannot specify the DEVCLASS,
VOLUMENAMES, and SCRATCH, USEDVOLUMELIST, and PREVIEW
parameters.
PREVIEWImport
Specifies whether to view how much data will be transferred, without actually
moving any data. This information can be used to determine how much
storage pool space is required on the target server. The default is NO.
Valid values are:
Yes
Specifies that you want to preview the results of the import operation on
the target server, without importing the data. Information is reported to the
server console and the activity log.
EXPORT POLICY Directly to Another Server
Chapter 2. Administrative commands 495
No
Specifies that you want the data to be imported on the target server
without previewing the results.
Replacedefs
Specifies whether to replace definitions (not file data) on the server. The
default is NO.
Valid values are:
Yes
Specifies that definitions are replaced on the server if definitions having
the same name as those being imported already exist on the target server.
No
Specifies that imported definitions are skipped if their names conflict with
definitions that are already defined on the target server.
Examples
Task
To export policy information directly to SERVERB, issue the following command.
Command
export policy replacedefs=yes toserver=othersrv
EXPORT POLICY Directly to Another Server

496 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXPORT SERVER (Export server information)
Use this command to export all or part of the server control information and client
file data (if specified) from the server to sequential media.
When you export server information to sequential media, you can later use the
media to import the information to another server with a compatible device type.
Note:
1. If target and source server levels are not compatible, the operation may
not work. See the Administrators Guide for server compatibility
requirements.
2. Exporting data to a CENTERA device class is not supported. However,
files stored in CENTERA storage pools can be exported.
You also have the option of processing an export operation directly to another
server on the network. This results in an immediate import process without the
need for compatible sequential device types between the two servers.
The EXPORT SERVER command exports server information such as:
v Policy domain definitions.
v Policy set definitions.
v Management class and copy group definitions.
v Schedules defined for each policy domain.
v Administrator definitions.
v Client node definitions.
Optionally, you can export data such as:
v File space definitions.
v Access authorization information pertaining to the file spaces exported.
v Backed-up, archived, and space-managed files.
Note: You cannot export nodes of type NAS. Export processing will exclude these
nodes.
This command generates a background process that can be cancelled with the
CANCEL PROCESS command. If you export server information to sequential
media, and the background process is cancelled, the sequential media holding the
exported data are incomplete and should not be used for importing data. If a
server-to-server export background process is cancelled, a partial import may
result. Evaluate any imported data on the target server to determine if you want to
keep or delete the imported data. Review the import messages for details.
You can issue a QUERY PROCESS command from the target server to monitor the
progress of the import operation. Issue the QUERY EXPORT command to list all
server-to-server export operations (that have a FILEDATA value other than NONE)
that are running or suspended.
You can use the QUERY ACTLOG command to view the actual status information
indicating the size and the success or failure of the export operation.
The EXPORT SERVER command takes two forms: export directly to another server
on the network, or export to sequential media. The syntax and parameters for each
form are defined separately.
EXPORT SERVER
Chapter 2. Administrative commands 497
|
|
|
|
|
|
|
|
|
|
|
Table 157. Commands related to EXPORT SERVER
Command Description
CANCEL EXPORT Deletes a suspended export operation
CANCEL PROCESS Cancels a background server process.
COPY ACTIVEDATA Copies active backup data.
EXPORT ADMIN Copies administrative information to external
media.
EXPORT NODE Copies client node information to external
media.
EXPORT POLICY Copies policy information to external media.
IMPORT SERVER Restores all or part of the server from
external media.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY EXPORT Displays the export operations that are
currently running or suspended.
QUERY PROCESS Displays information about background
processes.
RESTART EXPORT Restarts a suspended export operation.
SUSPEND EXPORT Suspends a running export operation.
EXPORT SERVER

498 IBM Tivoli Storage Manager for Windows: Administrators Reference
||
||
|
||
||
EXPORT SERVER to sequential media
You can export all or part of the server control information and client file data
from a server to sequential media for later importing to another server.
Privilege class
To issue this command, you must have system privilege.
Syntax

EXPort Server
FILEData = None
FILEData

=

ALl

None

ARchive

Backup

BACKUPActive

ALLActive

SPacemanaged

Preview = No
(1)

(2)

Preview

=

No

Yes

(1)

DEVclass

=

device_class_name

Scratch = Yes
(2)

Scratch

=

Yes

No

,

(2)

VOLumenames

=

volume_name

FILE:

file_name

USEDVolumelist

=

file_name

FROMTime

=

00:00:00

FROMDate

=

date

FROMTime

=

time

TOTime

=

00:00:00

TODate

=

date

TOTime

=

time

ENCryptionstrength = AES
ENCryptionstrength

=

AES

DES
ALLOWSHREDdable = No
ALLOWSHREDdable

=

No

Yes

Notes:
1 If PREVIEW=NO, a device class must be specified.
2 If PREVIEW=NO and SCRATCH=NO, one or more volumes must be
specified.
EXPORT SERVER To Sequential Media
Chapter 2. Administrative commands 499
|||||||||
Parameters
FILEData
Specifies the type of files that should be exported for all nodes defined to the
server. This parameter is optional. The default value is NONE.
If you are exporting to sequential media: the device class to access the file data
is determined by the device class for the storage pool. If it is the same device
class specified in this command, two drives are needed to export server
information. The mount limit for the device class must be set to at least 2.
The following descriptions mention active and inactive backup file versions. An
active backup file version is the most recent backup version for a file that still
exists on the client workstation. All other backup file versions are called
inactive copies. The values are:
ALl
Tivoli Storage Manager exports all backup versions of files, all archived
files, and all space-managed files.
None
Tivoli Storage Manager does not export files, only definitions.
ARchive
Tivoli Storage Manager exports only archived files.
Backup
Tivoli Storage Manager exports only backup versions, whether the versions
are active or inactive.
BACKUPActive
Tivoli Storage Manager exports only active backup versions.
ALLActive
Tivoli Storage Manager exports all active backup versions of files, all
archived files, and all space-managed files.
SPacemanaged
Tivoli Storage Manager exports only space-managed files.
Preview
Specifies whether you want to preview the results of the export operation,
without exporting information. You can use this parameter to preview how
many bytes of data are transferred, allowing you to determine how many
volumes will be required. This parameter is optional. The default value is NO.
The values are:
No
Specifies that the server information is to be exported. If you specify this
value, you must also specify a device class.
Yes
Specifies that the operation will be previewed but not performed.
Information is reported to the server console and the activity log. If you
specify this value, you do not need to specify a device class.
DEVclass
Specifies the device class to which export data is to be written. You cannot
specify the DISK, NAS, or CENTERA device classes. This parameter is required
if PREVIEW=NO.
Note:
EXPORT SERVER To Sequential Media

500 IBM Tivoli Storage Manager for Windows: Administrators Reference
1. If all drives for the device class are busy when the export runs,
Tivoli Storage Manager cancels lower priority operations, such as
reclamation, to make a drive available.
2. You can export data to a storage pool on another server by
specifying a device class whose device type is SERVER. For details
about storing data on another server, see Administrators Guide.
Scratch
Specifies whether scratch volumes can be used. The default is YES.
The values are:
Yes
Specifies that scratch volumes can be used for the export. If you also
specify a list of volumes, scratch volumes are used only if there is not
enough space on the volumes specified.
No
Specifies that scratch volumes cannot be used for export. To determine
how many volumes you may need, you can run the command specifying
PREVIEW=YES.
VOLumenames
Specifies the volumes to be used to contain exported data. This parameter is
optional, unless you specify SCRATCH=NO and PREVIEW=YES. If you do not
specify a volume name, scratch volumes are used.
The values are:
volume_name
Specifies the volume name. To specify multiple volumes, separate the
names with commas and no intervening spaces.
FILE:file_name
Specifies the name of a file that contains a list of volumes. In the file, each
volume name must be on a separate line. Blank and comment lines that
begin with an asterisk are ignored.
Use these naming conventions when specifying volumes associated with the
following device types:

For this device Specify
FILE Any fully qualified file name string. For example,
d:\program files\tivoli\tsm\data1.dsm.
Tape 16 alphanumeric characters.
OPTICAL 132 alphanumeric characters.
REMOVABLEFILE 16 alphanumeric characters.
SERVER 1250 alphanumeric characters.

USEDVolumelist
Specifies the file where a list of volumes used in the export operation will be
stored. This parameter is optional.
This file can be used as input to the import operation. This file will contain
comment lines with the date and time the export was done, and the command
issued to create the export.
Note: If you specify an existing file, the file will be overwritten.
EXPORT SERVER To Sequential Media
Chapter 2. Administrative commands 501
FROMDate
Specifies the earliest date for which objects to be exported were stored on the
server. Objects that were stored on the server earlier than the specified date
will not be exported. This parameter only applies to client file data. This
parameter has no effect on other information that may be exported, for
example policy. Tivoli Storage Manager ignores the FROMDATE parameter
when the FILEDATA parameter is set to NONE.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can specify
is 9999.
TODAY 3 or 3.

If this parameter is not specified, Tivoli Storage Manager exports all objects
stored before the TODATE parameter and as qualified by the FILEDATA
parameter. If no TODATE parameter is specified, then all data as qualified by
the FILEDATA parameter is exported.
TODate
Specifies the latest date for objects to be exported from the server. Objects
stored on the server on a date later than the TODATE value are not exported.
TODATE only applies to client file data and does not affect other information
that is being exported, such as policy. Tivoli Storage Manager ignores the
TODATE parameter when the FILEDATA parameter is set to NONE.
Note: If a TODATE parameter is specified without a TOTIME parameter, the
server exports all objects inserted on or before the day specified by the
TODATE parameter.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 10/15/2006
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY 3 or 3.

Note: If you specified the FROMDATE parameter, the value of TODATE must
be later than or equal to the FROMDATE value. If the TODATE and
FROMDATE are equal, then the TOTIME parameter must be later that
the FROMTIME parameter.
FROMTime
Specifies the earliest time for which objects to be exported were stored on the
server. When you specify FROMTIME, you must also use the FROMDATE
parameter. This parameter only applies to client file data. This parameter has
no effect on other information that may be exported, for example policy.
Objects that were stored on the server before the specified time and date will
EXPORT SERVER To Sequential Media

502 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|||
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
not be exported. Tivoli Storage Manager ignores the FROMTIME parameter
when the FILEDATA parameter is set to NONE.
The default value for this parameter when used with the FROMDATE
parameter is midnight (00:00:00).
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified. The
FROMTIME+ can only be used
with a FROMDATE before
today.
NOW+02:00 or +02:00.
If you issue this command at 5:00 with
FROMTIME=NOW+02:00 or
FROMTIME=+02:00, the export
operation only contains files that were
put on the server after 7:00 on the
FROMDATE that you specify.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW02:00 or 02:00.
If you issue this command at 5:00 with
FROMTIME=NOW02:00 or
FROMTIME=2:00, the export includes
files that were put on the server after
3:00.

TOTime
Specifies the latest time that objects to be exported were stored on the server.
You must specify the TODATE parameter in order to use the TOTIME
parameter. TOTIME only applies to client file data and does not affect other
information that is being exported, such as policy. Tivoli Storage Manager
ignores the TOTIME parameter if the FILEDATA parameter is set to NONE.
The default value for this parameter when used with the TODATE parameter
is midnight minus one second (23:59:59).
Note: The value of TOTIME and TODATE parameters must be later than the
FROMDATE and the FROMTIME value.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW+HH:MM
or+HH:MM
The current time plus hours
and minutes specified.
NOW+02:00 or +02:00.
If you issue this command at 05:00
with FROMTIME=01:00 and
TOTIME=NOW+02:00, the export
includes files that were stored from
01:00 until 07:00.
NOW-HH:MM
or-HH:MM
The current time minus hours
and minutes specified.
NOW-02:00 or -02:00.
If you issue this command at 05:00
with FROMTIME=01:00 and
TOTIME=NOW-02:00, the export
includes files that were stored from
01:00 until 03:00.

EXPORT SERVER To Sequential Media
Chapter 2. Administrative commands 503
|
|
|
|
|
|
|
|
|
|
|
|
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ENCryptionstrength
Indicates which algorithm to use to encrypt passwords when exporting
administrative and node records. This parameter is optional. The default value
is AES. If you are exporting to a server that does not support AES, you should
specify DES. Possible values are:
AES
Specifies the Advanced Encryption Standard (AES).
DES
Specifies the Data Encryption Standard (DES).
ALLOWSHREDdable
Specifies whether data from a storage pool that enforces shredding is exported.
This parameter is optional. The default value is NO. Possible values are:
No
Specifies that the server does not allow data to be exported from a storage
pool that enforces shredding.
Yes
Specifies that the server allows data to be exported from a storage pool
that enforces shredding. The data on the export media will not be
shredded.
Examples
Task 1 From the server, export server information to tape volumes TAPE01,
TAPE02, and TAPE03. Specify that these tape volumes be read by a device
assigned to the MENU1 device class.
Command
export server devclass=menu1
volumenames=tape01,tape02,tape03
Task 2 From the server, export server information to tape volumes listed in a file
named TAPEVOL.DATA. This file contains these lines:
TAPE01
TAPE02
TAPE03
Specify that these tape volumes be used by a device assigned to the
MENU1 device class.
Command
export server devclass=menu1 volumenames=file:tapevol.data
EXPORT SERVER To Sequential Media

504 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
EXPORT SERVER directly to another server
Use this command to export all or part of the server control information and client
file data directly to another server on the network. This results in an immediate
import on the target server.
Server-to-server export operations that have a FILEDATA value other than NONE
can be restarted after the operation is suspended. The server saves the state and
status of the export operation so that it may be restarted from the point at which
the operation failed or was suspended. The export operation can be restarted at a
later date by issuing the RESTART EXPORT command. These export operations
can be manually suspended as well as restarted. Therefore, if an export fails, it is
automatically suspended if it has completed the transmitting definitions phase.
An export operation is suspended when any of the following conditions is
detected:
v A SUSPEND EXPORT command is issued for the running export operation
v Segment preemption - the file being read for export is deleted by some other
process
v Communication errors on a server-to-server export
v No available mount points
v Necessary volumes are unavailable
v I/O Errors encountered
The export operation cannot be restarted if the export operation fails prior to
transmitting the eligible node and filespace definitions to the target server. You
must reenter the command to begin a new export operation.
You can issue a QUERY PROCESS command from the target server to monitor the
progress of the import operation. Issue the QUERY EXPORT command to list all
server-to-server export operations (that have a FILEDATA value other than NONE)
that are running or suspended.
Privilege class
To issue this command, you must have system privilege.
Syntax

EXPort Server
FILEData = None
FILEData

=

ALl

None

ARchive

Backup

BACKUPActive

ALLActive

SPacemanaged

FROMTime

=

00:00:00

FROMDate

=

date

FROMTime

=

time

EXPORT SERVER Directly to Another Server
Chapter 2. Administrative commands 505
|
|
|
|
|
|
|
|
|
|
|
|
|
|

TOTime

=

00:00:00

TODate

=

date

TOTime

=

time

EXPORTIDentifier

=

export_identifier

TOServer

=

servername

PREVIEWImport = No
PREVIEWImport

=

No

Yes
MERGEfilespaces = No
MERGEfilespaces

=

No

Yes

Replacedefs = No
Replacedefs

=

No

Yes
PROXynodeassoc = No
PROXynodeassoc

=

No

Yes

ENCryptionstrength = AES
ENCryptionstrength

=

AES

DES
ALLOWSHREDdable = No
ALLOWSHREDdable

=

No

Yes

Parameters
FILEData
Specifies the type of files to export for all nodes defined to the server. This
parameter is optional. The default value is NONE.
If you are exporting to sequential media: The device class to access the file
data is determined by the device class for the storage pool. If it is the same
device class specified in this command, Tivoli Storage Manager requires two
drives to export server information. You must set the mount limit for the
device class to at least 2.
The following descriptions mention active and inactive backup file versions. An
active backup file version is the most recent backup version for a file that still
exists on the client workstation. All other backup file versions are called
inactive copies. The values are:
ALl
Tivoli Storage Manager exports all backup versions of files, all archived
files, and all space-managed files.
None
Tivoli Storage Manager does not export files, only definitions.
ARchive
Tivoli Storage Manager exports only archived files.
Backup
Tivoli Storage Manager exports only backup versions, whether they are
active or inactive.
BACKUPActive
Tivoli Storage Manager exports only active backup versions.
EXPORT SERVER Directly to Another Server

506 IBM Tivoli Storage Manager for Windows: Administrators Reference
|||||||||
|||
ALLActive
Tivoli Storage Manager exports all active backup versions of files, all
archived files, and all space-managed files.
SPacemanaged
Tivoli Storage Manager exports only space-managed files.
FROMDate
Specifies the earliest date for which objects to be exported were stored on the
server. Objects that were stored on the server earlier than the specified date
will not be exported. This parameter only applies to client file data. This
parameter has no effect on other information that may be exported, for
example policy. Tivoli Storage Manager ignores the FROMDATE parameter
when the FILEDATA parameter is set to NONE.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can specify
is 9999.
TODAY 3 or 3.

If this parameter is not specified, Tivoli Storage Manager exports all objects
stored before the TODATE parameter and as qualified by the FILEDATA
parameter. If no TODATE parameter is specified, then all data as qualified by
the FILEDATA parameter is exported.
TODate
Specifies the latest date for objects to be exported from the server. Objects
stored on the server on a date later than the TODATE value are not exported.
TODATE only applies to client file data and does not affect other information
that is being exported, such as policy. Tivoli Storage Manager ignores the
TODATE parameter when the FILEDATA parameter is set to NONE.
Note: If a TODATE parameter is specified without a TOTIME parameter, the
server exports all objects inserted on or before the day specified by the
TODATE parameter.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 10/15/2006
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY 3 or 3.

Note: If you specified the FROMDATE parameter, the value of TODATE must
be later than or equal to the FROMDATE value. If the TODATE and
FROMDATE are equal, then the TOTIME parameter must be later that
the FROMTIME parameter.
EXPORT SERVER Directly to Another Server
Chapter 2. Administrative commands 507
|
|
|
|
|
|
|
|
|
|
|
|||
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
FROMTime
Specifies the earliest time for which objects to be exported were stored on the
server. When you specify FROMTIME, you must also use the FROMDATE
parameter. This parameter only applies to client file data. This parameter has
no effect on other information that may be exported, for example policy.
Objects that were stored on the server before the specified time and date will
not be exported. Tivoli Storage Manager ignores the FROMTIME parameter
when the FILEDATA parameter is set to NONE.
The default value for this parameter when used with the FROMDATE
parameter is midnight (00:00:00).
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified. The
FROMTIME+ can only be used
with a FROMDATE before
today.
NOW+02:00 or +02:00.
If you issue this command at 5:00 with
FROMTIME=NOW+02:00 or
FROMTIME=+02:00, the export
operation only contains files that were
put on the server after 7:00 on the
FROMDATE that you specify.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW02:00 or 02:00.
If you issue this command at 5:00 with
FROMTIME=NOW02:00 or
FROMTIME=2:00, the export includes
files that were put on the server after
3:00.

TOTime
Specifies the latest time that objects to be exported were stored on the server.
You must specify the TODATE parameter in order to use the TOTIME
parameter. TOTIME only applies to client file data and does not affect other
information that is being exported, such as policy. Tivoli Storage Manager
ignores the TOTIME parameter if the FILEDATA parameter is set to NONE.
The default value for this parameter when used with the TODATE parameter
is midnight minus one second (23:59:59).
Note: The value of TOTIME and TODATE parameters must be later than the
FROMDATE and the FROMTIME value.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW+HH:MM
or+HH:MM
The current time plus hours
and minutes specified.
NOW+02:00 or +02:00.
If you issue this command at 05:00
with FROMTIME=01:00 and
TOTIME=NOW+02:00, the export
includes files that were stored from
01:00 until 07:00.
EXPORT SERVER Directly to Another Server

508 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|||
|||
|
|
|
|
|
|
|
|
|
|
Value Description Example
NOW-HH:MM
or-HH:MM
The current time minus hours
and minutes specified.
NOW-02:00 or -02:00.
If you issue this command at 05:00
with FROMTIME=01:00 and
TOTIME=NOW-02:00, the export
includes files that were stored from
01:00 until 03:00.

TOServer
Specifies the name of a server to which the export data will be sent directly
over the network for immediate import.
Note: The target server must be defined on the originating server with the
DEFINE SERVER command. The administrator that issues the export
command must be defined with the same administrator name and
password and have system authority on the target server.
When you specify TOSERVER, you cannot specify the DEVCLASS,
VOLUMENAMES, and SCRATCH, USEDVOLUMELIST, and PREVIEW
parameters.
PREVIEWImport
Specifies whether to view how much data will be transferred, without actually
moving any data. This information can be used to determine how much
storage pool space is required on the target server. The default is NO.
Valid values are:
Yes
Specifies that you want to preview the results of the import operation on
the target server, without importing the data. Information is reported to the
server console and the activity log.
No
Specifies that you want the data to be imported on the target server
without previewing the results.
MERGEfilespaces
Specifies whether Tivoli Storage Manager merges client files into existing file
spaces on the target server (if they exist), or if Tivoli Storage Manager
generates new file space names. The default is NO.
You can only specify this parameter if you have specified the TOSERVER
parameter.
Valid values are:
Yes
Specifies that imported data on the target server is merged with the
existing file space, if a file space with the same name already exists on the
target server.
No
Specifies that Tivoli Storage Manager generates a new file space name for
imported data on the target server if file spaces with the same name
already exist.
Replacedefs
Specifies whether to replace definitions (not file data) on the server. The
default is NO.
EXPORT SERVER Directly to Another Server
Chapter 2. Administrative commands 509
|||
|
|
|
|
|
|
|
|
|
|
|
|
Valid values are:
Yes
Specifies that definitions are replaced on the server if definitions having
the same name as those being imported already exist on the target server.
No
Specifies that imported definitions are skipped if their names conflict with
definitions that are already defined on the target server.
PROXynodeassoc
Specifies if proxy node associations are exported. This parameter is optional.
The default value is NO.
ENCryptionstrength
Indicates which algorithm to use to encrypt passwords when exporting
administrative and node records. This parameter is optional. The default value
is AES. If you are exporting to a server that does not support AES, you should
specify DES. Possible values are:
AES
Specifies the Advanced Encryption Standard (AES).
DES
Specifies the Data Encryption Standard (DES).
ALLOWSHREDdable
Specifies whether data from a storage pool that enforces shredding is exported.
This parameter is optional. The default value is NO. Possible values are:
No
Specifies that the server does not allow data to be exported from a storage
pool that enforces shredding.
Yes
Specifies that the server allows data to be exported from a storage pool
that enforces shredding. The data on the export media will not be
shredded.
Important: After an export operation has finished identifying files for export,
any changes to the storage pool ALLOWSHREDABLE value is
ignored. An export operation that is suspended retains the original
ALLOWSHREDABLE value throughout the operation. You might
want to consider cancelling your export operation if changes to the
storage pool ALLOWSHREDABLE value jeopardize the operation.
You can reissue the export command after any needed cleanup.
EXPORTIDentifier
This optional parameter specifies the name that you selected to identify this
export operation. If you do not specify a command name, the server generates
one for you. The export identifier name cannot be more than 64 characters,
cannot contain wildcard characters, and is not case sensitive. You can use the
identifier name to reference export operations in the QUERY EXPORT,
SUSPEND EXPORT, RESTART EXPORT, or CANCEL EXPORT commands.
Note: You must specify the TOSERVER parameter if you are specifying the
EXPORTIDENTIFIER parameter.
EXPORTIDENTIFIER is ignored if FILEDATA=NONE or if
PREVIEWIMPORT=YES.
EXPORT SERVER Directly to Another Server

510 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Examples
Task To export server information directly to SERVERB, issue the following
command.
Command
export server filedata=all toserver=serverb
Task To export directly to SERVERB between February 1, 2007 and today, issue
the following command.
Command
export server filedata=all toserver=serverb
fromdate=020107 todate=today
Task To export directly to SERVERB from 8:00 AM on February 1, 2007 until
today at 8:00 AM, issue the following command.
Command
export server filedata=all toserver=serverb
fromdate=020107 fromtime=08:00:00
todate=today totime=08:00:00
EXPORT SERVER Directly to Another Server
Chapter 2. Administrative commands 511
EXTEND commands
Use the EXTEND commands to increase the amount of space that can be used by
the database within all the database and log volumes previously allocated to Tivoli
Storage Manager.
The following is a list of EXTEND commands for Tivoli Storage Manager:
v EXTEND DB (Increase the assigned capacity of the database) on page 513
v EXTEND LOG (Increase the assigned capacity of the recovery log) on page
515
EXTEND commands

512 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXTEND DB (Increase the assigned capacity of the database)
Use this command to increase the space that can be used by the database in all
allocated database volumes.
Attention: You cannot change the size of an allocated database volume after it
has been defined to Tivoli Storage Manager. If you do, Tivoli Storage Manager may
not initialize correctly and data could be lost.
You can issue the EXTEND DB command while users are accessing the server. Use
the QUERY DB command to determine how much you can increase the assigned
capacity of the database.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax

EXTend DB

megabytes
Wait = No
Wait

=

No

Yes

Parameters
megabytes (Required)
Specifies the space, in megabytes, to be added to the assigned capacity of the
database. The value should be in increments of 4MB. If you do not specify the
extension in 4MB increments, Tivoli Storage Manager rounds the number to
the next 4MB partition.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is NO. Possible
values are:
No
Specifies that the server processes this command in the background.
Yes
Specifies that the server processes this command in the foreground.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Extend the assigned capacity of the database by 52MB.
Command
extend db 52
EXTEND DB
Chapter 2. Administrative commands 513
Related commands
Table 158. Commands related to EXTEND DB
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE DBCOPY Creates a volume copy of a database volume.
DEFINE DBVOLUME Assigns a volume to be used for database
storage.
QUERY DB Displays allocation information about the
database.
QUERY PROCESS Displays information about background
processes.
REDUCE DB Attempts to free up a database volume by
reducing usable storage within the volumes
defined.

EXTEND DB

514 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXTEND LOG (Increase the assigned capacity of the recovery
log)
Use this command to increase the space that can be used by the recovery log in all
allocated recovery log volumes.
Attention: Do not change the size of an allocated recovery log volume after it is
defined to Tivoli Storage Manager. If you do, Tivoli Storage Manager may not
initialize correctly and data could be lost.
You can issue the EXTEND LOG command while users are accessing the server.
Use the QUERY LOG command to determine how much you can increase the
assigned capacity of the recovery log.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax

EXTend LOG

megabytes
Wait = No
Wait

=

No

Yes

Parameters
megabytes (Required)
Specifies the space, in megabytes, to be added to the assigned capacity of the
recovery log. The value should be in increments of 4MB. If you do not specify
the extension in 4MB increments, Tivoli Storage Manager rounds the number
to the next 4MB partition.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is NO. Possible
values are:
No
Specifies that the server processes this command in the background.
Yes
Specifies that the server processes this command in the foreground.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Extend the assigned capacity of the recovery log by 4MB.
Command
extend log 4
EXTEND LOG
Chapter 2. Administrative commands 515
Related commands
Table 159. Commands related to EXTEND LOG
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE LOGVOLUME Defines a disk volume to the recovery log.
DEFINE LOGCOPY Creates a volume copy of a recovery log
volume.
QUERY LOG Displays allocation information about the
recovery log.
QUERY PROCESS Displays information about background
processes.
REDUCE LOG Attempts to free up a log volume by
reducing usable storage within the volumes
defined.

EXTEND LOG

516 IBM Tivoli Storage Manager for Windows: Administrators Reference
GENERATE commands
Use the GENERATE BACKUPSET command to generate a backup set for a
selected filespace or client node.
v GENERATE BACKUPSET (Generate a backup set of a clients data) on page
518
GENERATE commands
Chapter 2. Administrative commands 517
GENERATE BACKUPSET (Generate a backup set of a clients
data)
Use this command to generate a backup set for a backup-archive client node. A
backup set is a collection of a clients active backed up data, stored and managed as
a single object, on specific media, in server storage. While the server allows you to
create a backup set for any client node, a backup set can only be used by a
backup-archive client.
Note: You cannot generate a backup set for a NAS node.
The server creates copies of active versions of a clients backed up objects that are
within the one or more file spaces specified with this command, and consolidates
them onto sequential media. Currently, the backup object types supported for
backup sets include directories and files only.
The backup-archive client node can restore its backup set from the server as well
as from the media to which the backup set was written.
This command generates a background process that can be cancelled with the
CANCEL PROCESS command. If the background process created by this command
is cancelled, the media may not contain a complete backup set. You can use the
QUERY PROCESS command to display information about the background process
that is created by this command.
Note: When Tivoli Storage Manager generates a backup set, you can improve
performance if the primary storage pools containing the client data are
collocated. If a primary storage pool is collocated, client node data is likely
to be on fewer tape volumes than it would be if the storage pool were not
collocated. With collocation, less time is spent searching database entries,
and fewer mount operations are required.
Privilege class
To issue this command, you must have system privilege or policy privilege for the
domain to which the client node is assigned.
Syntax

,
GENerate BACKUPSET

node__name

node_group_name

backup_set_name_prefix

*
,

file_space_name

DEVclass

=

device_class_name

GENERATE BACKUPSET

518 IBM Tivoli Storage Manager for Windows: Administrators Reference

SCRatch = Yes
SCRatch

=

Yes

No

,

VOLumes

=

volume_names

RETention = 365
RETention

=

days

NOLimit

DESCription

=

description

Wait = No
Wait

=

No

Yes
NAMEType = SERVER
NAMEType

=

SERVER

UNIcode

FSID

CODEType = BOTH
CODEType

=

UNIcode

NONUNIcode

BOTH
PITDate = current_date
PITDate

=

date

PITTime = current_time
PITTime

=

time

DATAType = FILE
,

DATAType

=

FILE

IMAGE

APPL

ALL

TOC = Preferred
TOC

=

No

Preferred

Yes

TOCMGmtclass

=

class_name

ALLOWSHREDdable = No
ALLOWSHREDdable

=

No

Yes

Parameters
node_name or node_group_name (Required)
Specifies the name of the client node and node groups whose data is contained
in the backup set. To specify multiple node names and node group names,
separate the names with commas and no intervening spaces. You can use
wildcard characters with node names but not with node group names. When
GENERATE BACKUPSET
Chapter 2. Administrative commands 519
multiple node names are specified, the server generates a backup set for each
node and places all of the backup sets together on a single set of output
volumes.
backup_set_name_prefix (Required)
Specifies the name of the backup set for the client node. The maximum length
of the name is 30 characters.
When you select a name, Tivoli Storage Manager adds a suffix to construct
your backup set name. For example, if you name your backup set mybackupset,
Tivoli Storage Manager adds a unique number such as 3099 to the name. The
backup set name is then identified to Tivoli Storage Manager as
mybackupset.3099. To later display information about this backup set, you can
include a wildcard with the name, such as mybackupset.* or you can specify the
fully qualified name, such as mybackupset.3099.
When multiple node names or node group names are specified, the server
generates a backup set for each node or node group and places all the backup
sets on a single set of output volumes. Each backup set is given the same fully
qualified name consisting of the backup_set_name_prefix and a suffix determined
by the server.
file_space_name
Specifies the names of one or more file spaces that contain the data to be
included in the backup set. This parameter is optional. The file space name
you specify can contain wildcard characters. You can specify more than one file
space by separating the names with commas and no intervening spaces. If you
do not specify a file space, data from all the client nodes backed up and active
file spaces is included in the backup set.
For a server that has clients with support for Unicode-enabled file spaces, you
can enter either a file space name or file space ID (FSID). If you enter a file
space name, you may need to have the server convert the file space name that
you enter. For example, you may need to have the server convert the name
you enter from the servers code page to Unicode. See the NAMETYPE
parameter for details. If you do not specify a file space name, or specify only a
single wildcard character for the name, you can use the CODETYPE parameter
to limit the operation to Unicode file spaces or to non-Unicode file spaces.
DEVclass (Required)
Specifies the name of the device class for the volumes to which the backup set
is written. The maximum length of the name is 30 characters.
Note: You cannot specify a device class with a device type of NAS or
CENTERA.
SCRatch
Specifies whether to use scratch volumes for the backup set. If you include a
list of volumes using the VOLUMES parameter, the server uses scratch
volumes only if the data cannot be contained in the volumes you specify. The
default is SCRATCH=YES. The values are:
YES
Specifies to use scratch volumes for the backup set.
NO
Specifies not to use scratch volumes for the backup set.
VOLumes
Specifies the names of one or more volumes that will contain the backup set.
GENERATE BACKUPSET

520 IBM Tivoli Storage Manager for Windows: Administrators Reference
This parameter is optional. You can specify more than one volume by
separating each volume with a comma, with no intervening spaces.
If you do not specify this parameter, scratch volumes are used for the backup
set.
RETention
Specifies the number of days to retain the backup set on the server. You can
specify an integer from 0 to 30000. The default is 365 days. The values are:
days
Specifies the number of days to retain the backup set on the server.
NOLimit
Specifies that the backup set should be retained on the server indefinitely.
If you specify NOLIMIT, the server retains the volumes containing the
backup set forever, unless a user or administrator deletes the volumes from
server storage.
DESCription
Specifies the description to associate with the backup set. This parameter is
optional. The maximum length of the description is 255 characters. Enclose the
description in quotation marks if it contains any blank characters.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is No. The values
are:
Yes
Specifies the command processes in the foreground. Messages created are
not displayed until the command completes processing. You cannot specify
WAIT=YES from the server console.
No
Specifies that the command processes in the background. Use the QUERY
PROCESS command to monitor the background processing of this
command.
NAMEType
Specify how you want the server to interpret the file space names that you
enter. This parameter is useful when the server has clients with support for
Unicode-enabled file spaces. You can use this parameter for Tivoli Storage
Manager clients using Windows, NetWare, or Macintosh OS X operating
systems.
Use this parameter only when you enter a partly or fully qualified file space
name. The default value is SERVER. Possible values are:
SERVER
The server uses the servers code page to interpret the file space names.
UNIcode
The server converts the file space name entered from the server code page
to the UTF-8 code page. The success of the conversion depends on the
actual characters in the name and the servers code page. Conversion can
fail if the string includes characters that are not available in the server code
page, or if the server has a problem accessing system conversion routines.
FSID
The server interprets the file space names as their file space IDs (FSIDs).
GENERATE BACKUPSET
Chapter 2. Administrative commands 521
|
|
|
Note: Use care when specifying this parameter if multiple node names are
also specified. Different nodes may use the same file space ID for
different file spaces, or different file space IDs for the same file space
name. Therefore, specifying a file space ID as the file space names
can result in the wrong data being written to the backup set for
some nodes.
CODEType
Specify what type of file spaces are to be included in the operation. The default
is BOTH, meaning that file spaces are included regardless of code page type.
Use this parameter only when you enter a single wildcard character for the file
space name or when you do not specify any file space names. Possible values
are:
UNIcode
Include only file spaces that are in Unicode.
NONUNIcode
Include only file spaces that are not in Unicode.
BOTH
Include file spaces regardless of code page type.
PITDate
Specifies that files that were active on the specified date and that are still
stored on the Tivoli Storage Manager server are to be included in the backup
set, even if they are inactive at the time you issue the command. This
parameter is optional. The default is the date on which the GENERATE
BACKUPSET command is executed. You can specify the date using one of the
values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY-days or -days The current date minus days
specified
TODAY-7 or -7.
To include files that were
active a week ago, specify
PITDATE=TODAY-7 or
PITDATE=-7
EOLM The last day of the previous
month
EOLM
BOTM The first day of the current
month
BOTM

PITTime
Specifies that files that were active on the specified time and that are still
stored on the Tivoli Storage Manager server are to be included in the backup
set, even if they are inactive at the time you issue the command. This
parameter is optional. IF a PITDate was specified, the default is midnight
(00:00:00); otherwise the default is the time at which the GENERATE
BACKUPSET command is started. You can specify the time using one of the
values below:

Value Description Example
HH:MM:SS A specific time on the
specified PIT date
12:33:28
GENERATE BACKUPSET

522 IBM Tivoli Storage Manager for Windows: Administrators Reference
Value Description Example
NOW The current date on the
specified PIT date
NOW
NOW+HH:MM or +HH:MM The current time plus hours
and minutes on the specified
PIT date
NOW+03:00 or +03:00
If you issue this command at
9:00 with
PITTIME=NOW+03:00 or
PITTIME=+03:00. Tivoli
Storage Manager includes
files that were active at 12:00
on the PIT date.

DATAType
Specifies that backup sets containing the specified types of data that are to be
generated. This parameter is optional. The default is that file level backup sets
are to be generated. To specify multiple data types, separate data types with
commas and no intervening spaces.
The server generates a backup set for each data type and places all the backup
sets on a single set of output volumes. Each backup set is given the same fully
qualified name consisting of the backup_set_name_prefix and a suffix determined
by the server. However, each backup set will have a different data type, as
shown by the QUERY BACKUPSET command. Possible values are:
ALL
Specifies that backup sets for all types of data (file level, image, and
application) that have been backed up on the server are to be generated.
FILE
Specifies that a file level backup set is to be generated. File level backup
sets contain files and directories backed up by the backup client. If no files
or directories have been backed up by the backup client, a file level backup
set is not generated. This is the default.
IMAGE
Specifies that an image backup set is to be generated. Image backup sets
contain images created by the backup client BACKUP IMAGE command.
Image backup sets are generated only if an image has been backed up by
the backup client.
APPL
Specifies that an application backup set is to be generated. Application
backup sets contain data backed up to the Tivoli Storage Manager server
by applications using the Tivoli Storage Manager application programming
interface. This parameter applies only if the Tivoli Storage Manager server
was upgraded from Tivoli Storage Manager Express and only for the Tivoli
Storage Manager Express versions of Data Protection for Exchange and
Data Protection for SQL. Application backup sets are generated only if
application data has been backed up to the server.
TOC
Specifies whether a table of contents (TOC) is saved for each file level backup
set. Tables of contents are always saved for backup sets containing image or
application data. The TOC parameter is ignored when generating image and
application backup sets. A table of contents will always be generated for image
and application backup sets.
GENERATE BACKUPSET
Chapter 2. Administrative commands 523
Consider the following in determining whether you want to save a table of
contents:
v If a table of contents is saved, you can use the QUERY
BACKUPSETCONTENTS command to determine the contents of a backup
set without requiring the backup set be scanned. You can also use the Tivoli
Storage Manager Web backup-archive client to examine the entire file system
tree and choose files and directories to restore. To create a table of contents,
you must define the TOCDESTINATION attribute in the backup copy group
for the management class specified by the TOCMGMTCLASS parameter.
Note that creating a table of contents requires additional processing, storage
pool space, and possibly a mount point during the backup set operation.
v If a table of contents is not saved for a backup set, you can still restore
individual files or directory trees using the backup/archive client RESTORE
BACKUPSET command, if you know the fully qualified name of each file or
directory to be restored.
This parameter is optional. Possible values are:
No
Specifies that table of contents information is not saved for file level
backup sets.
Preferred
Specifies that table of contents information should be saved for file level
backup sets. This is the default. However, a backup set does not fail just
because an error occurs during creation of the table of contents.
Yes
Specifies that table of contents information must be saved for each file
level backup set. A backup set fails if an error occurs during creation of the
table of contents.
TOCMGmtclass
Specifies the name of the management class to which the table of contents
should be bound. If you do not specify a management class, the table of
contents is bound to the default management class for the policy domain to
which the node is assigned. In this case, creation of a table of contents requires
that you define the TOCDESTINATION attribute in the backup copy group for
the specified management class.
ALLOWSHREDdable
Specifies whether data from a storage pool that enforces shredding is included
in the backup set. This parameter is optional. Possible values are:
No
Specifies that the server does not allow data from a storage pool that
enforces shredding to be included in the backup set. This is the default.
Yes
Specifies that the server does allow data from a storage pool that enforces
shredding to be included in the backup set. The data on the backup set
media will not be shredded.
Examples
Task
Generate a backup set of a file space called /srvr that belongs to client node JANE.
Name the backup set PERS_DATA and retain it for 75 days. Specify that volumes
GENERATE BACKUPSET

524 IBM Tivoli Storage Manager for Windows: Administrators Reference
VOL1 and VOL2 contain the data for the backup set. The volumes are to be read
by a device that is assigned to the AGADM device class. Include a description.
Command
generate backupset jane pers_data /srvr devclass=agadm
retention=75 volumes=vol1,vol2
description="area 51 base image"
Task
Generate a backup set of the Unicode-enabled file space, \\joe\c$, that belongs to
client node JOE. Name the backup set JOES_DATA. Specify that volume VOL1
contain the data for the backup set. The volume is to be read by a device that is
assigned to the AGADM device class. Have the server convert the \\joe\c$ file
space name from the server code page to the UTF-8 code page.
Command
generate backupset joe joes_data \\joe\c$ devclass=agadm
volumes=vol1 nametype=unicode
Related commands
Table 160. Commands related to GENERATE BACKUPSET
Command Description
COPY ACTIVEDATA Copies active backup data.
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
QUERY BACKUPSET Displays backup sets.
GENERATE BACKUPSETTOC Generates a table of contents for a backup
set.
QUERY NODEGROUP Displays information about node groups.
QUERY BACKUPSETCONTENTS Displays contents contained in backup sets.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.
UPDATE NODEGROUP Updates the description of a node group.

GENERATE BACKUPSET
Chapter 2. Administrative commands 525
GENERATE BACKUPSETTOC (Generate a table of contents for
a backup set)
Use this command to generate a table of contents for a backup set that does not
already have one. A table of contents allows the backup-archive client to display
the contents of the backup set and allows the selection of individual files to be
restored from the backup set.
Creating a table of contents for a backup set requires storage pool space and
possibly one or more mount points during the creation operation.
Privilege class
To issue this command, you must have system privilege or policy privilege for the
domain to which the client node is assigned.
Syntax
GENerate BACKUPSETTOC node_name backup_set_name

DATAType = ALL
,

DATAType

=

FILE

APPL

IMAGE

TOCMGmtclass

=

class_name

Parameters
node_name (Required)
Specifies the name of the client node whose data is contained in the backup
set. You cannot use wildcard characters to specify a name, nor can you specify
a list of client node names.
backup_set_name (Required)
Specifies the name of the backup set for the client node. The name cannot
contain wildcard characters not can it be a list of backup set names separated
by commas.
DATAType
Specifies the type of data to be included in the table of contents. This
parameter is optional. By default, all data is included. To specify multiple data
types, separate the data types with commas and no intervening spaces.
Possible values are:
ALL
Specifies that the table of contents will include all types of data (file-level,
image, and application) stored in the backup set. This is the default.
FILE
Specifies that the table of contents will include only file-level data.
File-level data consists of files and directories backed up by the
backup-archive client. If the backup set contains no files or directories, the
table of contents will not be generated.
APPL
Specifies that the table of contents will include only application data.
GENERATE BACKUPSETTOC

526 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Application data consists of data backed up to the Tivoli Storage Manager
server by applications using the Tivoli Storage Manager application
programming interface. This parameter applies only if the Tivoli Storage
Manager server was upgraded from Tivoli Storage Manager Express and
only for the Tivoli Storage Manager Express versions of Data Protection for
Exchange and Data Protection for SQL. If the backup set contains no
application data, the table of contents will not be generated.
IMAGE
Specifies that the table of contents will include only image backups. Image
backups consist of file system images created by the backup client
BACKUP IMAGE command. If the backup set contains no image backups,
the table of contents will not be generated.
TOCMGmtclass
Specifies the name of the management class to which the table of contents
should be bound. If you do not specify a management class, the table of
contents is bound to the default management class for the policy domain to
which the node is assigned. If you create a table of contents you must define
the TOCDESTINATION attribute in the backup copy group for the specified
management class.
Examples
Task
Generate a table of contents for a backup set named PROJX_DATA that contains
the data for client node GARY. The table of contents is to be bound to the default
management class.
Command
generate backupsettoc gary projx_data
Related commands
Table 161. Commands related to GENERATE BACKUPSETTOC
Command Description
COPY ACTIVEDATA Copies active backup data.
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
QUERY BACKUPSET Displays backup sets.
QUERY NODEGROUP Displays information about node groups.
QUERY BACKUPSETCONTENTS Displays contents contained in backup sets.
GENERATE BACKUPSETTOC
Chapter 2. Administrative commands 527
|
|
|
|
|
|
|
|
|
|
|
|
Table 161. Commands related to GENERATE BACKUPSETTOC (continued)
Command Description
UPDATE BACKUPSET Updates a retention value associated with a
backup set.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.
UPDATE NODEGROUP Updates the description of a node group.

GENERATE BACKUPSETTOC

528 IBM Tivoli Storage Manager for Windows: Administrators Reference
GRANT commands
Use the GRANT command to authorize the appropriate Tivoli Storage Manager
administrator privilege class.
v GRANT AUTHORITY (Add administrator authority) on page 530
v GRANT PROXYNODE (Grant proxy authority to a client node) on page 534
GRANT commands
Chapter 2. Administrative commands 529
GRANT AUTHORITY (Add administrator authority)
Use this command to grant an administrator one or more administrative privilege
classes, and authority to access client nodes.
You cannot grant restricted privilege to an unrestricted policy or unrestricted
storage administrator. You must use the REVOKE AUTHORITY command to
remove the administrators unrestricted privilege, then use this command to grant
restricted privilege to the administrator.
Privilege class
To issue this command, you must have system privilege.
Syntax

GRant AUTHority

admin_name

,
(1)

CLasses

=

SYstem

Policy

STorage

Operator

Analyst

Node

A

,

(1)

DOmains

=

domain_name

,

(1)

STGpools

=

pool_name


A:
AUTHority = Access
AUTHority

=

Access

Owner

DOmains

=

domain_name

NOde

=

node_name


Notes:
1 You must specify one or more of these parameters.
Parameters
admin_name (Required)
Specifies the name of the administrator being granted an administrative
privilege class.
CLasses
Specifies one or more privilege classes to grant to an administrator. This
parameter is required, except when you specify the STGPOOLS parameter. You
can specify more than one privilege class by separating each with a comma.
Possible classes are:
SYstem
Specifies that you want to grant system privilege to an administrator. A
system administrator has the highest level of authority in Tivoli Storage
GRANT AUTHORITY

530 IBM Tivoli Storage Manager for Windows: Administrators Reference
Manager. A system administrator can issue any administrative command
and has authority to manage all policy domains and all storage pools. Do
not specify additional privilege classes or the DOMAINS or STGPOOLS
parameters when granting system privilege to an administrator. Only a
system administrator can grant authority to other administrators.
Policy
Specifies that you want to grant policy privilege to an administrator. If you
do not specify the DOMAINS parameter, unrestricted policy privilege is
granted. An unrestricted policy administrator can issue commands that
affect all existing policy domains as well as any policy domains that are
defined in the future. An unrestricted policy administrator cannot define,
delete, or copy policy domains. Use the GRANT AUTHORITY command
with CLASSES=POLICY and no DOMAINS parameter to upgrade a
restricted policy administrator to an unrestricted policy administrator.
STorage
Specifies that you want to grant storage privilege to an administrator. If the
STGPOOLS parameter is not specified, unrestricted storage privilege is
granted. An unrestricted storage administrator can issue all commands that
allocate and control storage resources for the server. An unrestricted
storage administrator can issue commands that affect all existing storage
pools as well as any storage pools that are defined in the future. An
unrestricted storage administrator cannot define or delete storage pools.
Using the GRANT AUTHORITY command with CLASSES=STORAGE and
no STGPOOLS parameter upgrades a restricted storage administrator to an
unrestricted storage administrator.
Operator
Specifies that you want to grant operator privilege to an administrator. An
administrator with operator privilege can issue commands that control the
immediate operation of the server and the availability of storage media.
Analyst
Specifies that you want to grant analyst privilege to an administrator. An
administrator with analyst privilege can issue commands that reset the
counters which track server statistics.
Node
Specifies that you want to grant a node privilege to a user. A user with
client node privilege can remotely access a web backup-archive client with
an administrative user ID and password if they have been given owner
authority or access authority. Access authority is the default for a node
privilege class.
Note: When you specify the node privilege class, you must also specify
either the DOMAIN parameter or the NODE parameter, but not
both.
AUTHority
Specifies the authority level of a user with node privilege. This
parameter is optional.
If an administrator already has system or policy privilege to the policy
domain to which the node belongs, this command will not change the
administrators privilege. Possible authority levels are:
Access
Specifies that you want to grant client access authority to a user
with the node privilege class. This is the default when
GRANT AUTHORITY
Chapter 2. Administrative commands 531
CLASSES=NODE is specified. A user with client access authority
can access a web backup-archive client and perform backup and
restore actions on that client.
Note: A user with client access authority cannot access that client
from another system by using the -NODENAME parameter.
A client node can set the REVOKEREMOTEACCESS option
to restrict a user that has node privilege with client access
authority from accessing a client workstation that is running
a web client. This option does not apply to administrators
with client owner authority, system privilege, or policy
privilege to the policy domain to which the node belongs.
Owner
Specifies that you want to grant client owner authority to a user
with the node privilege class. A user with client owner authority
can access a web backup-archive client through the web client
interface and also access their data from another client using the
-NODENAME parameter.
DOmains
Specifies that you want to grant to the administrator client access or
client owner authority to all clients in the specified policy domain. You
cannot use this parameter together with the NODE parameter.
NOde
Specifies that you want to grant the administrator client access or client
owner authority to the node. You cannot use this parameter together
with the DOMAIN parameter.
DOmains
Specifies that you want to grant restricted policy privilege to an administrator.
Restricted policy privilege permits an administrator to issue a subset of the
policy commands for the domains to which the administrator is authorized.
You can use this parameter to grant additional policy domain authority to a
restricted policy administrator. This parameter is optional. You can specify
more than one policy domain by delimiting each policy domain name with a
comma.
You can use wildcard characters to specify a name. Authority for all matching
policy domains is granted.
STGpools
Specifies that you want to grant restricted storage privilege to an administrator.
If the STGPOOLS parameter is specified, then CLASSES=STORAGE is optional.
Restricted storage privilege permits you to issue a subset of the storage
commands for the storage pools to which the administrator is authorized. You
can use this parameter to grant additional storage pool authority to a restricted
storage administrator. This parameter is optional. You can specify more than
one storage pool by delimiting each storage pool name with a comma.
You can use wildcard characters to specify a name. Authority for all matching
storage pools is granted.
GRANT AUTHORITY

532 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task 1
Grant system privilege to administrator LARRY.
Command
grant authority larry classes=system
Task 2
Specify additional policy domains that the restricted policy administrator
CLAUDIA can manage.
Command
grant authority claudia
domains=employee_records,prog1
Task 3
Provide administrator TOM with unrestricted storage privilege and restricted
policy privilege for the domains whose names start with EMP.
Command
grant authority tom classes=storage domains=emp*
Task 4
Grant node privilege to user HELP so that help desk personnel can assist the client
node LABCLIENT in backing up or restoring data without having other
higher-level Tivoli Storage Manager privileges.
Command
grant authority help classes=node node=labclient
Related commands
Table 162. Commands related to GRANT AUTHORITY
Command Description
QUERY ADMIN Displays information about one or more IBM
Tivoli Storage Manager administrators.
REVOKE AUTHORITY Revokes one or more privilege classes or
restricts access to policy domains and storage
pools.

GRANT AUTHORITY
Chapter 2. Administrative commands 533
GRANT PROXYNODE (Grant proxy authority to a client node)
Use this command to grant proxy authority to a client node on the Tivoli Storage
Manager server.
Target client nodes own the data and agent nodes act on behalf of the target nodes.
When granted proxy authority to a target client node, an agent node can perform
backup and restore operations for the target node. Data that the agent node stores
on behalf of the target node is stored under the target nodes name in server
storage.
Privilege class
To perform this task, you must have one of the following privilege classes:
v System privilege
v Unrestricted policy privilege
Syntax
GRant PROXynode TArget = target_node_name AGent = agent_node_name

Parameters
TArget (Required)
Specifies the name of the node that owns the data. Wildcard names cannot be
used to specify the target node name.
AGent (Required)
Specifies the name of the node performing operations for the target node. The
agent node does not have to be in the same domain as the target node.
Wildcard characters and comma-separated lists of node names are allowed.
Examples
Task
Assume that MOE and JOE are nodes in a NAS cluster. Nodes MOE and JOE are
the agent nodes used to backup and restore shared NAS data. To create a proxy
authority relationship for target node NASCLUSTER, use the following command.
Command
grant proxynode target=nascluster agent=moe,joe
Use the following command on agent node MOE to back up NAS cluster data
stored on the E: drive. The name of the target node is NASCLUSTER.
Command
dsmc -asnode=nascluster incremental e:
Related commands
Table 163. Commands related to GRANT PROXYNODE
Command Description
QUERY PROXYNODE Display nodes with authority to act as proxy
nodes.
REVOKE PROXYNODE Revoke proxy authority from an agent node.
GRANT PROXYNODE

534 IBM Tivoli Storage Manager for Windows: Administrators Reference
GRANT PROXYNODE
Chapter 2. Administrative commands 535
HALT (Shut down the server)
Use this command to shut down the server. The HALT command forces an abrupt
shutdown, which cancels all the administrative and client node sessions even if
they are not completed.
Any transactions in progress interrupted by the HALT command are rolled back
when you restart the server. If the QUIESCE option is specified, transaction activity
is halted when current transactions are completed and the server is shut down.
Use the QUIESCE option only if you plan to perform a stand-alone database dump
with the DSMSERV DUMPDB command immediately following server shutdown.
See the DSMSERV DUMPDB command for more information.
Use the HALT command only after the administrative and client node sessions are
completed or canceled. To shut down the server without severely impacting
administrative and client node sessions, perform the following steps:
1. Use the DISABLE SESSIONS command to prevent starting new client node
sessions.
2. Use the QUERY SESSIONS command to identify any existing administrative
and client node sessions.
3. Notify any existing administrative and client node sessions that you plan to
shut down the server (you must do this outside of Tivoli Storage Manager).
4. Use the CANCEL SESSIONS command to cancel any existing administrative or
client node sessions.
5. Issue the HALT command to shut down the server and stop any administrative
and client node sessions.
Note:
The HALT command can be replicated using the ALIASHALT server option.
The server option allows you to define a term other than HALT that will
perform the same function. The HALT command retains its normal function
however, the server option provides an additional method for issuing the
HALT command. See ALIASHALT on page 1277 for additional
information.
Privilege class
To issue this command, you must have system or operator privilege.
Syntax
HALT
Quiesce


Parameters
Quiesce
Specifies that all database transaction activity will be halted when current
transactions complete. Use this option only to perform a stand-alone database
dump with the DSMSERV DUMPDB command to dump database contents to
sequential media, such as tape. This parameter is optional.
HALT

536 IBM Tivoli Storage Manager for Windows: Administrators Reference
When you specify the QUIESCE option, the server attempts to stop all database
update transactions and to record database pages to stable media. This process
provides a consistent image of the database that can be dumped with the
DSMSERV DUMPDB command. This attempt to stop update activity may be
retried a number of times and may fail if there are many transactions in progress.
If this failure occurs, the HALT command stops processing and the server
continues to run. If this occurs, you can cancel all client sessions, cancel all
background server processes, and re-issue the HALT QUIESCE command. The
HALT command without the QUIESCE option causes the server to halt
successfully.
Examples
Task 1
Shut down the server, either from the server console or from an administrative
client. All user activity stops immediately and no new activity can start.
Command
halt
Task 2
Before performing the standalone database dump using the DSMSERV DUMPDB
command, shut down the Tivoli Storage Manager server with the QUIESCE option.
Command
halt quiesce
The standalone dump can now be performed.
Related commands
Table 164. Commands related to HALT
Command Description
CANCEL PROCESS Cancels a background server process.
CANCEL SESSION Cancels active sessions with the server.
DISABLE SESSIONS Prevents new sessions from accessing IBM
Tivoli Storage Manager but permits existing
sessions to continue.
ENABLE SESSIONS Resumes server activity following the
DISABLE command or the ACCEPT DATE
command.
QUERY PROCESS Displays information about background
processes.
QUERY SESSION Displays information about all active
administrator and client sessions with IBM
Tivoli Storage Manager.

HALT
Chapter 2. Administrative commands 537
HELP (Get help on commands and error messages)
Use this command to display administrative commands and error messages. You
can issue the command from an administrative command line client.
Privilege class
Any administrator can issue this command.
Syntax
Help
help_menu_number

command_name

subcommand_name

message_number

server_option_name

utility_name


Parameters
help_topic_number
Specifies the number of your selection from the help topics. This parameter is
optional.
command_name
Specifies the name of the administrative command you want to display. This
parameter is optional.
subcommand_name
Specifies the subcommand name associated with the name of the
administrative command you want to display. This parameter is optional.
message_number
Specifies the number of the message for which you want to display
information. This parameter is optional. You can get help information on server
messages (prefixed by ANR) and client messages (prefixed by ANE or ANS).
Do not include the prefix and severity code when specifying an error message
number.
server_option_name
Specifies the name of the server option for which you want to display
information. This parameter is optional.
utility_name
Specifies the name of the server utility for which you want to display
information. This parameter is optional.
Examples
Task
Display the help topics for the command-line interface.
Command
help
Output
Partial output
HELP

538 IBM Tivoli Storage Manager for Windows: Administrators Reference
||
|
|
|
|
|
|
1.0 Administering the server from the command line
1.1 Issuing commands from the administrative client
1.1.1 Starting and stopping the administrative client
1.1.2 Monitoring server activities from the administrative client

Task
Display help information using the help topic number.
Command
help 1.1.2
Output
Displays information on commands that can be issued by any
administrator.
Task
Display help information on the REMOVE commands.
Command
help remove
Output

3.44 REMOVE commands
Use the REMOVE commands to remove an object from Tivoli Storage Manager
The following is a list of REMOVE commands for Tivoli Storage Manager
* 3.44.1, "REMOVE ADMIN (Delete an administrator)"
* 3.44.2, "REMOVE NODE (Delete a node or an associated machine node)"

Task
Display help information on the error message ANR2535E.
Command
help 2535
Output

ANR2535E Command: The node node name cannot be removed or renamed
because it has an associated data mover.
Explanation: You attempted to remove or rename a node that has an
associated data mover.
System action: The server does not remove or rename the node.
User response: To remove or rename the node, delete the associated data
mover and reissue the command.

Task
Display help information for the BUFPOOLSIZE server option.
Command
help bufpoolsize
Output
Displays description, syntax, and an example for the BUFPOOLSIZE server
option.
HELP
Chapter 2. Administrative commands 539
Task
Display help information for the DSMSERV utility.
Command
help dsmserv
Output
Displays description, syntax, and an example for the DSMSERV utility.
Related commands
None.
HELP

540 IBM Tivoli Storage Manager for Windows: Administrators Reference
IMPORT commands
Use the IMPORT commands to import information from export media to an Tivoli
Storage Manager server.
The following is a list of IMPORT commands for Tivoli Storage Manager:
v IMPORT ADMIN (Import administrator information) on page 542
v IMPORT NODE (Import client node information) on page 545
v IMPORT POLICY (Import policy information) on page 551
v IMPORT SERVER (Import server information) on page 554
IMPORT commands
Chapter 2. Administrative commands 541
IMPORT ADMIN (Import administrator information)
Use this command to import administrator and authority definitions for one or
more administrators from export media to the Tivoli Storage Manager server.
You can use the QUERY ACTLOG command to view the status of the import
operation. You can also view this information from the server console.
This command generates a background process that can be cancelled with the
CANCEL PROCESS command. If an IMPORT ADMIN background process is
cancelled, some of the data is already imported. To display information on
background processes, use the QUERY PROCESS command.
Note:
1. If target and source server levels are not compatible, the operation may
not work. See the Administrators Guide for server compatibility
requirements.
2. Importing data from a CENTERA device class is not supported.
However, files being imported can be stored on a CENTERA storage
device.
Privilege class
To issue this command, you must have system privilege.
Syntax

IMport Admin

*
,

admin_name
Preview = No
Preview

=

No

Yes

DEVclass

=

device_class_name

,
VOLumename

=

volume_name

FILE:

file_name

Replacedefs = No
Replacedefs

=

No

Yes

Parameters
admin_name
Specifies the administrators for which you want to import information. This
parameter is optional. Separate multiple names with commas and no
intervening spaces. You can use wildcard characters to specify names.
Preview
Specifies whether you want to preview the results of the import operation,
without importing administrator information. The PREVIEW=YES option
requires that you mount the export volumes. This parameter is optional. The
default value is NO. The values are:
IMPORT ADMIN

542 IBM Tivoli Storage Manager for Windows: Administrators Reference
No
Specifies that the information is to be imported.
Yes
Specifies that the operation will be previewed but not performed.
Information on the number and types of objects imported, together with
the number of bytes transferred, are reported to the server console and the
activity log.
DEVclass (Required)
Specifies the device class from which import data is to be read. You cannot
specify the DISK, NAS, or CENTERA device classes. If all drives for the device
class are busy when the import runs, Tivoli Storage Manager cancels lower
priority operations, such as reclamation, to make a drive available.
VOLumename (Required)
Specifies the volumes to be used for the import operation. Volumes must be
imported in the same order as they were exported. The values are:
volume_name
Specifies the volume name. To specify multiple volumes, separate names
with commas and no intervening spaces.
FILE:file_name
Specifies the name of a file that contains a list of volumes used for the
imported data. In the file, each volume name must be on a separate line.
Blank and comment lines that begin with an asterisk are ignored.
Use these naming conventions when specifying volumes associated with the
following device types:

For this device Specify
Tape 1 6 alphanumeric characters.
FILE Any fully qualified file name string. For example,
d:\program files\tivoli\tsm\data1.dsm.
OPTICAL 132 alphanumeric characters.
REMOVABLEFILE 16 alphanumeric characters.
SERVER 1250 alphanumeric characters.

Replacedefs
Specifies whether to replace administrator definitions on the target server. The
default value is NO. The values are:
No
Specifies that definitions are not to be replaced.
Yes
Specifies that definitions are to be replaced.
Examples
Task 1
From the server, import the information for all defined administrators from tape
volumes TAPE01, TAPE02, and TAPE03. Specify that these tape volumes be read
by a device assigned to the MENU1 device class.
Command
IMPORT ADMIN
Chapter 2. Administrative commands 543
import admin devclass=menu1
volumenames=tape01,tape02,tape03
Task 2
From the server, import the information for all defined administrators from tape
volumes listed in a file named TAPEVOL.DATA. This file contains these lines:
TAPE01
TAPE02
TAPE03
Specify that these tape volumes be read by a device assigned to the MENU1 device
class.
Command
import admin devclass=menu1 volumenames=file:tapevol.data
Related commands
Table 165. Commands related to IMPORT ADMIN
Command Description
CANCEL PROCESS Cancels a background server process.
EXPORT ADMIN Copies administrative information to external
media.
IMPORT NODE Restores client node information from
external media.
IMPORT POLICY Restores policy information from external
media.
IMPORT SERVER Restores all or part of the server from
external media.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY PROCESS Displays information about background
processes.

IMPORT ADMIN

544 IBM Tivoli Storage Manager for Windows: Administrators Reference
IMPORT NODE (Import client node information)
Use this command to import client node definitions from a server or sequential
media to a target IBM Tivoli Storage Manager server.
The imported nodes are associated with the same policy domain as they were on
the source server, if you specify the domain and if that policy domain exists on the
target server. Otherwise, imported nodes are associated with the STANDARD
policy domain on the target server.
IBM Tivoli Storage Manager servers with retention protection enabled do not allow
import operations.
Note:
1. If target and source server levels are not compatible, the operation may
not work. See the Administrators Guide for server compatibility
requirements.
2. Importing data from a CENTERA device class is not supported.
However, files being imported can be stored on a CENTERA storage
device.
You can use the QUERY ACTLOG command to view the status of the import
operation. You can also view this information from the server console.
This command generates a background process that can be cancelled with the
CANCEL PROCESS command. If an IMPORT NODE background process is
cancelled, some of the data may already be imported. To display information on
background processes, use the QUERY PROCESS command.
For a server that has clients with support for Unicode, you may need to have the
server convert the file space name that you enter, or use the:
v HEXFILESPACE parameter
v UNIFILESPACE parameter
Privilege class
To issue this command, you must have system privilege.
Syntax

IMport Node

*
,

node_name

,

FILESpace

=

file_space_name

,

HEXFILESpace

=

file_space_name

IMPORT NODE
Chapter 2. Administrative commands 545

,

UNIFILESpace

=

file_space_name

,

DOmains

=

domain_name

FILEData = None
FILEData

=

ALl

None

ARchive

Backup

BACKUPActive

ALLActive

SPacemanaged
Preview = No
Preview

=

No

Yes

DEVclass

=

device_class_name
Dates = Absolute
Dates

=

Absolute

Relative

,
VOLumenames

=

volume_name

FILE:

file_name

Replacedefs

=

No

Replacedefs

=

No

Yes

MERGEfilespaces = No
MERGEfilespaces

=

No

Yes
PROXynodeassoc = No
PROXynodeassoc

=

No

Yes

Parameters
node_name
Specifies the client nodes for which you want to import information. This
parameter is optional.
Separate multiple names with commas and no intervening spaces. You can use
wildcard characters to specify names. All matching nodes are included in the
list.
FILESpace
Specifies file space names for which you want to import information. This
parameter is optional. The default is all file spaces.
Separate multiple names with commas and no intervening spaces. You can use
wildcard characters to specify names.
Note:
1. Existing file spaces are not replaced. New file spaces are created
when identical names are encountered. However, this new name
may match an existing name on the client node, which may have file
spaces not yet backed up to the server.
IMPORT NODE

546 IBM Tivoli Storage Manager for Windows: Administrators Reference
2. This parameter can only be specified for non-Unicode file spaces. To
import all file spaces, that are both Unicode and non-Unicode, use
the FILEDATA=ALL parameter without the FILESPACE and
UNIFILESPACE parameters.
DOmains
Specifies the policy domains from which to import node information. These
domains must have been included in the data that was exported. This
parameter is optional. The default is all domains that were exported.
Separate multiple names with commas and no intervening spaces. You can use
wildcard characters to specify a name.
FILEData
Specifies the type of files that should be imported for all nodes specified and
found on the export media. This parameter is optional. The default value is
NONE.
If you are importing from sequential media, the device class used by the file
data is determined by the device class for the storage pool. If it is the same
device class specified in this command, two drives are needed to import the
node information. The mount limit for the device class must be at least 2.
The following descriptions mention active and inactive backup file copies. An
active backup file copy is the most recent backup copy for a file that still exists
on the client workstation. All other backup file copies are called inactive
copies. The values are:
ALl
The server imports all backup versions of files, all archived files, and all
space-managed files. This includes both Unicode and non-Unicode file
spaces.
None
Only node definitions are imported. The server does not import any files.
ARchive
The server imports only archived files.
Backup
The server imports only backup versions, whether active or inactive.
BACKUPActive
The server imports only active backup versions.
ALLActive
The server imports all active backup versions of files, all archived files, and
all space-managed files.
SPacemanaged
The server imports only space-managed files.
Preview
Specifies whether to preview the results of the import operation, without
importing information. The PREVIEW=YES option requires that you mount the
export volumes. This parameter is optional. The default value is NO. Possible
values are:
No
Specifies that the node information is to be imported.
IMPORT NODE
Chapter 2. Administrative commands 547
Yes
Specifies that you want to preview the results of the import operation,
without importing files. Information is reported to the server console and
the activity log.
DEVclass (Required)
Specifies the device class from which import data is to be read. You cannot
specify the DISK, NAS, or CENTERA device classes.
If all drives for the device class are busy when the import runs, the server
cancels lower priority operations, such as reclamation, to make a drive
available.
Dates
Specifies whether the date of the file copies are as specified when the files
were exported (ABSOLUTE), or are adjusted to the date of import (RELATIVE).
The default value is ABSOLUTE.
If the export media has been idle for some time after export (sitting on a shelf
for six months, for example), the original backup or archive dates may be old
enough to trigger immediate expiration of file copies when the data is
imported into a server. The RELATIVE specification for this value will adjust
for time elapsed since export so that the file copies are not immediately
expired.
For example, assume that an export tape contains an archive file copy that was
archived 5 days before the export operation. If the media are saved for 6
months and then imported, the archive file will appear to have been inserted
six months and 5 days ago by default (DATES=ABSOLUTE) and may be
subject to immediate expiration depending on the retention value that is
specified in the files management class. Specifying DATES=RELATIVE will
result in resetting the archive date for the file to 5 days ago during import. The
DATES=RELATIVE parameter thus adjusts file backup and archive dates for
the time that has elapsed since the export operation occurred.
Possible values are:
Absolute
The dates for file copies are set to the values specified when the files were
exported.
Relative
The dates for file copies are adjusted to the date of import.
VOLumenames (Required)
Specifies the volumes to be used for the import operation. Volumes must be
imported in the same order as they were exported. The values are:
volume_name
Specifies the volume name. To specify multiple volumes, separate the
names with commas and no intervening spaces.
FILE:file_name
Specifies the name of a file that contains a list of volumes used for the
imported data. In the file, each volume name must be on a separate line.
Blank and comment lines that begin with an asterisk are ignored.
Use these naming conventions when specifying volumes associated with the
following device types:
IMPORT NODE

548 IBM Tivoli Storage Manager for Windows: Administrators Reference
For this device Specify
Tape 1 6 alphanumeric characters.
FILE Any fully qualified file name string. For example,
d:\program files\tivoli\tsm\data1.dsm.
OPTICAL 132 alphanumeric characters.
REMOVABLEFILE 16 alphanumeric characters.
SERVER 1250 alphanumeric characters.

Replacedefs
Specifies whether to replace definitions on the target server. The default value
is NO. The values are:
No
Objects are not to be replaced.
Yes
Objects are to be replaced.
HEXFILESpace
Specifies the hexadecimal representation of the file space names in UTF-8
format. Separate multiple names with commas and no intervening spaces. This
parameter is optional.
To view the hexadecimal representation of a file space name, you can use the
QUERY FILESPACE command with FORMAT=DETAILED.
UNIFILESpace
Specifies the file spaces that are known to the server to be Unicode enabled.
The server converts the names you enter from the server code page to the
UTF-8 code page to find the file spaces to import. The success of the
conversion depends on the actual characters in the name and the servers code
page. Separate multiple names with commas and no intervening spaces. This
parameter is optional.
MERGEfilespaces
Specifies whether Tivoli Storage Manager merges client files into existing file
spaces on the target server (if they exist), or if Tivoli Storage Manager
generates new file space names. The default is NO.
You can only specify this parameter if you have specified the TOSERVER
parameter.
Valid values are:
Yes
Specifies that imported data on the target server is merged with the
existing file space, if a file space with the same name already exists on the
target server.
No
Specifies that Tivoli Storage Manager generates a new file space name for
imported data on the target server if file spaces with the same name
already exist.
PROXynodeassoc
Specifies if proxy node associations are imported. This parameter is optional.
The default value is NO.
IMPORT NODE
Chapter 2. Administrative commands 549
Examples
Task 1
From the server, import client node information from tape volumes TAPE01,
TAPE02, and TAPE03. Specify that these tape volumes be read by a device
assigned to the MENU1 device class.
Command
import node devclass=menu1 volumenames=tape01,tape02,tape03
Task 2
From the server, import client node information from tape volumes listed in a file
named TAPEVOL.DATA. This file contains these lines:
TAPE01
TAPE02
TAPE03
Specify that these tape volumes be read by a device assigned to the MENU1 device
class.
Command
import node devclass=menu1 volumenames=file:tapevol.data
Task 3
From the server, import the active backup versions of file data for client node JOE
from tape volume TAPE01. The file space is Unicode.
Command
import node joe unifilespace=\\joe\c$ filedata=backupactive
devclass=menu1 volumenames=tape01
Related commands
Table 166. Commands related to IMPORT NODE
Command Description
CANCEL PROCESS Cancels a background server process.
COPY ACTIVEDATA Copies active backup data.
EXPORT NODE Copies client node information to external
media.
IMPORT ADMIN Restores administrative information from
external media.
IMPORT POLICY Restores policy information from external
media.
IMPORT SERVER Restores all or part of the server from
external media.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY PROCESS Displays information about background
processes.

IMPORT NODE

550 IBM Tivoli Storage Manager for Windows: Administrators Reference
IMPORT POLICY (Import policy information)
Use this command to import policy domain information from sequential export
media to the Tivoli Storage Manager server. IBM Tivoli Storage Manager servers
with retention protection enabled do not allow import operations.
Tivoli Storage Manager client data can be moved between servers with export and
import processing, if the same removable media type is supported on both
platforms.
Note:
1. If target and source server levels are not compatible, the operation may
not work. See the Administrators Guide for server compatibility
requirements.
2. Importing data from a CENTERA device class is not supported.
However, files being imported can be stored on a CENTERA storage
device.
You can use the QUERY ACTLOG command to view the status of the import
operation. You can also view this information from the server console.
This command generates a background process that can be cancelled with the
CANCEL PROCESS command. If an IMPORT POLICY background process is
cancelled, some of the data is already imported. To display information on
background processes, use the QUERY PROCESS command.
Privilege class
To issue this command, you must have system privilege.
Syntax

IMport Policy

*
,

domain_name
Preview = No
Preview

=

No

Yes

DEVclass

=

device_class_name

,
VOLumenames

=

volume_name

FILE:

file_name

Replacedefs = No
Replacedefs

=

No

Yes

Parameters
domain_name
Specifies the policy domains for which information is to be imported. Separate
multiple names with commas and no intervening spaces. You can use wildcard
characters to specify names. The default (*) is all policy.
IMPORT POLICY
Chapter 2. Administrative commands 551
Preview
Specifies whether you want to preview the results of the import operation
without importing information. The PREVIEW=YES option requires that you
mount the export volumes. This parameter is optional. The default value is
NO. The values are:
No
Specifies that the information is to be imported.
Yes
Specifies that the operation will be previewed but not performed.
Information is reported to the server console and the activity log.
DEVclass (Required)
Specifies the device class from which import data is to be read. You cannot
specify the DISK, NAS, or CENTERA device classes.
If all drives for the device class are busy when the import runs, Tivoli Storage
Manager cancels lower priority operations, such as reclamation, to make a
drive available.
VOLumenames (Required)
Specifies the volumes to be used for the import operation. Volumes must be
imported in the same order as they were exported. The values are:
volume_name
Specifies the volume name. To specify multiple volumes, separate the
names with commas and no intervening spaces.
FILE:file_name
Specifies the name of a file that contains a list of volumes. In the file, each
volume name must be on a separate line. Blank and comment lines that
begin with an asterisk are ignored.
Use these naming conventions when specifying volumes associated with the
following device types:

For this device Specify
Tape 1 6 alphanumeric characters.
FILE Any fully qualified file name string. For example,
d:\program files\tivoli\tsm\data1.dsm.
OPTICAL 132 alphanumeric characters.
REMOVABLEFILE 16 alphanumeric characters.
SERVER 1250 alphanumeric characters.


Replacedefs
Specifies whether to replace policy definitions on the target server. The default
value is NO. The values are:
Yes
Specifies that objects are to be replaced by the imported objects.
No
Specifies that objects are not to be replaced by imported objects.
IMPORT POLICY

552 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task 1
From the server, import the information for all defined policies from tape volumes
TAPE01, TAPE02, and TAPE03. Specify that these tape volumes be read by a device
assigned to the MENU1 device class.
Command
import policy devclass=menu1
volumenames=tape01,tape02,tape03
Task 2
From the server, import the information for all defined policies from tape volumes
listed in a file named TAPEVOL.DATA. This file contains these lines:
TAPE01
TAPE02
TAPE03
Specify that these tape volumes be read by a device assigned to the MENU1 device
class.
Command
import policy devclass=menu1 volumenames=file:tapevol.data
Related commands
Table 167. Commands related to IMPORT POLICY
Command Description
CANCEL PROCESS Cancels a background server process.
EXPORT POLICY Copies policy information to external media.
IMPORT ADMIN Restores administrative information from
external media.
IMPORT NODE Restores client node information from
external media.
IMPORT SERVER Restores all or part of the server from
external media.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY PROCESS Displays information about background
processes.

IMPORT POLICY
Chapter 2. Administrative commands 553
IMPORT SERVER (Import server information)
Use this command to copy all or part of the server control information and client
file data (if specified) from export media to the Tivoli Storage Manager server.
IBM Tivoli Storage Manager servers with retention protection enabled do not allow
import operations.
Note:
1. If target and source server levels are not compatible, the operation might
not work. See the Administrators Guide for server compatibility
requirements.
2. Importing data from a CENTERA device class is not supported.
However, files being imported can be stored on a CENTERA storage
device.
You can also initiate an import of server information and client file data directly
from the originating server. For more information see the EXPORT commands.
This command generates a background process that can be cancelled with the
CANCEL PROCESS command. If an IMPORT SERVER background process is
cancelled, some of the data is already imported. To display information on
background processes, use the QUERY PROCESS command.
Privilege class
To issue this command, you must have system privilege.
Syntax

IMport Server
FILEData = None
FILEData

=

ALl

None

ARchive

Backup

BACKUPActive

ALLActive

SPacemanaged
Preview = No
Preview

=

No

Yes

DEVclass

=

device_class_name
Dates = Absolute
Dates

=

Absolute

Relative

,
VOLumenames

=

volume_name

FILE:

file_name

Replacedefs

=

No

Replacedefs

=

No

Yes

IMPORT SERVER

554 IBM Tivoli Storage Manager for Windows: Administrators Reference

MERGEfilespaces = No
MERGEfilespaces

=

No

Yes
PROXynodeassoc = No
PROXynodeassoc

=

No

Yes

Parameters
FILEData
Specifies the type of files that should be imported for all nodes defined to the
server. This parameter is optional. The default value is NONE.
The device class used to access the file data is determined by the device class
for the storage pool. If it is the same device class specified in this command,
two drives are needed to import information. The mount limit for the device
class must be set to at least 2.
The following descriptions mention active and inactive backup file copies. An
active backup file copy is the most recent backup copy for a file that still exists
on the client workstation. All other file copies are called inactive copies. The
values are:
ALl
Tivoli Storage Manager imports all backup versions of files, all archived
files, and all space-managed files.
None
Tivoli Storage Manager does not import files, only node definitions.
ARchive
Tivoli Storage Manager imports only archived files.
Backup
Tivoli Storage Manager imports only backup versions, whether the
versions are active or inactive.
BACKUPActive
Tivoli Storage Manager imports only active backup versions.
ALLActive
Tivoli Storage Manager imports all active backup versions of files, all
archived files, and all space-managed files.
SPacemanaged
Tivoli Storage Manager imports only space-managed files.
Preview
Specifies whether to preview the results of the import operation, without
importing information. The PREVIEW=YES option still requires that you
mount the export volumes. This parameter is optional. The default value is
NO. Possible values are:
No
Specifies that the server information is to be imported.
Yes
Specifies that the operation will be previewed but not performed.
Information is transferred to the server console and the activity log.
DEVclass (Required)
Specifies the device class from which import data is to be read. You cannot
specify the DISK, NAS, or CENTERA device classes.
IMPORT SERVER
Chapter 2. Administrative commands 555
If all drives for the device class are busy when the import runs, Tivoli Storage
Manager cancels lower priority operations, such as reclamation, to make a
drive available.
Dates
Specifies whether the dates of the file copies are set as specified when the files
were exported (ABSOLUTE), or are adjusted to the date of import (RELATIVE).
The default value is ABSOLUTE.
If the import media has been idle for some time after export (sitting on a shelf
for six months, for example), the original backup or archive dates may be old
enough to trigger immediate expiration of file copies when the data is
imported into a server. The RELATIVE specification for this value will adjust
for time elapsed since export so that the file copies are not immediately
expired.
For example, assume that an import tape contains an archive file copy that was
archived 5 days before the export operation. If the export media are saved for
6 months and then imported, the archive file will appear to have been inserted
six months and 5 days ago by default (DATES=ABSOLUTE) and may be
subject to immediate expiration depending upon the retention value that is
specified in the files management class. Specifying DATES=RELATIVE results
in resetting the archive date for the file to 5 days ago during import.
DATES=RELATIVE parameter thus adjusts file backup and archive dates for
the time that has elapsed since the export operation occurred.
Possible values are:
Absolute
The dates for file copies are set to the values specified when the files were
exported.
Relative
The date for file copies are adjusted to the date of import.
VOLumenames (Required)
Specifies the volumes to be used for the import operation. Volumes must be
imported in the same order as they were exported. The values are:
volume_name
Specifies the volume name. To specify multiple volumes, separate the
names with commas and no intervening spaces.
FILE:file_name
Specifies the name of a file that contains a list of volumes used for the
imported data. In the file, each volume name must be on a separate line.
Blank and comment lines that begin with an asterisk are ignored.
Use these naming conventions when specifying volumes associated with the
following device types:

For this device Specify
Tape 1 6 alphanumeric characters.
FILE Any fully qualified file name string. For example,
d:\program files\tivoli\tsm\data1.dsm.
OPTICAL 132 alphanumeric characters.
REMOVABLEFILE 16 alphanumeric characters.
SERVER 1250 alphanumeric characters.

IMPORT SERVER

556 IBM Tivoli Storage Manager for Windows: Administrators Reference
Replacedefs
Specifies whether to replace objects on the server. Existing file spaces are not
replaced. New file spaces are created when identical names are encountered.
The default value is NO. Possible values are:
No
Specifies that objects are not to be replaced by imported objects.
Yes
Specifies that objects are to be replaced by the imported objects.
MERGEfilespaces
Specifies whether Tivoli Storage Manager merges client files into existing file
spaces on the target server (if they exist), or if Tivoli Storage Manager
generates new file space names. You cannot merge non-Unicode and Unicode
filespaces together. The default is NO. Possible values are:
No
Specifies that Tivoli Storage Manager generates a new file space name for
imported data on the target server if file spaces with the same name
already exist.
Yes
Specifies that imported data on the target server is merged with the
existing file space, if a file space with the same name already exists on the
target server.
PROXynodeassoc
Specifies if proxy node associations are imported. This parameter is optional.
The default value is NO.
Examples
Task
From the server, import the information for all defined servers from tape volumes
TAPE01, TAPE02, and TAPE03. Specify that these tape volumes be read by a device
assigned to the MENU1 device class.
Command
import server devclass=menu1 volumenames=tape01,tape02,tape03
Task
From the server, import the information for all defined servers from tape volumes
listed in a file named TAPEVOL.DATA. This file contains these lines:
TAPE01
TAPE02
TAPE03
Specify that these tape volumes be read by a device assigned to the MENU1 device
class.
Command
import server devclass=menu1 volumenames=file:tapevol.data
Task
From the server, import the information for all defined servers from tape volumes
TAPE01, TAPE02, and TAPE03. Specify that these tape volumes be read by a device
IMPORT SERVER
Chapter 2. Administrative commands 557
assigned to the MENU1 device class and that client files be merged into file spaces
on the target server if file spaces of the same names already exist.
Command
import server devclass=menu1 volumenames=tape01,tape02,tape03
mergefilespaces=yes
Related commands
Table 168. Commands related to IMPORT SERVER
Command Description
CANCEL PROCESS Cancels a background server process.
COPY ACTIVEDATA Copies active backup data.
EXPORT SERVER Copies all or part of the server to external
media.
IMPORT ADMIN Restores administrative information from
external media.
IMPORT NODE Restores client node information from
external media.
IMPORT POLICY Restores policy information from external
media.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY PROCESS Displays information about background
processes.

IMPORT SERVER

558 IBM Tivoli Storage Manager for Windows: Administrators Reference
INSERT commands
Use the INSERT command to create machine characteristics and recovery
instructions when using the disaster recovery manager.
v INSERT MACHINE (Insert machine characteristics information or recovery
instructions) on page 560
INSERT commands
Chapter 2. Administrative commands 559
INSERT MACHINE (Insert machine characteristics information
or recovery instructions)
Use this command to add client machine characteristics or recovery instructions to
existing machine information in the database.
You can write a program to read files containing the information and generate the
appropriate INSERT MACHINE commands. See the Administrators Guide for
details.
You can use QUERY commands to retrieve the information if a disaster occurs.
Privilege class
To issue this command, you must have system privilege.
Syntax
INsert MAchine machine_name sequence_number
CHaracteristics = text
RECOVERYInstructions

=

text


Parameters
machine_name (Required)
Specifies the name of the client machine.
sequence_number (Required)
Specifies the sequence number for the line of text in the database.
CHaracteristics
Specifies machine characteristics information. You must specify the
characteristics or recovery instructions, but not both. Enclose the text in
quotation marks if it contains blank characters. The text can be up to 1024
characters.
RECOVERYInstructions
Specifies recovery instructions. You must specify the characteristics or recovery
instructions, but not both. Enclose the text in quotation marks if it contains
blank characters. The text can be up to 1024 characters.
Examples
Task
For the machine DISTRICT5, insert this characteristics text on line 1: Machine
owner is Mary Smith.
Command
insert machine district5 1
characteristics="Machine owner is Mary Smith"
INSERT MACHINE

560 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 169. Commands related to INSERT MACHINE
Command Description
DEFINE MACHINE Defines a machine for DRM.
DELETE MACHINE Deletes a machine.
QUERY MACHINE Displays information about machines.

INSERT MACHINE
Chapter 2. Administrative commands 561
ISSUE MESSAGE (Issue a message from a server script)
Use this command with return code processing in a script to issue a message from
a server script to determine where the problem is with a command in the script.
Privilege class
Any administrator can issue this command.
Syntax
ISSUE MESSAGE message_severity message_text

Parameters
message_severity (Required)
Specifies the severity of the message. The message severity indicators are:
I Information. ANR1496I is displayed in the message text.
W Warning. ANR1497W is displayed in the message text.
E Error. ANR1498E is displayed in the message text.
S Severe. ANR1499S is displayed in the message text.
message_text (Required)
Specifies the description of the message.
Examples
Task
Assume you have a script called backupscript that quiesces a clients database,
takes a backup of that database, and then restarts the clients database. For
illustration, your script results in a non-zero return code. Use the ISSUE MESSAGE
command with the message severity and message text. Below is an example of a
server script that calls backupscript on the client machine and issues messages
based on the return code from backupscript.
issue message i "Starting backup"
define clientaction nodename action=command objects="c:\backupscript" wait=yes
if (101) goto qfail
if (102) goto qwarn
if (103) goto backupf
if (104) goto restartf
issue message i "Backup of database complete"
exit
qfail: issue message e "Quiesce of database failed"
exit
qwarn: issue message w "Quiesce of database failed, taking fuzzy backup"

exit
backupf: issue message e "Backup of database failed"
exit
restartf: issue message s "Database restart failed"
exit
Command
issue message e "quiesce of database failed"
ISSUE MESSAGE

562 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 170. Commands related to ISSUE MESSAGE
Command Description
COPY SCRIPT Creates a copy of a script.
DEFINE SCRIPT Defines a script to the IBM Tivoli Storage
Manager server.
DELETE SCRIPT Deletes the script or individual lines from the
script.
RENAME SCRIPT Renames a script to a new name.
RUN Runs a script.
UPDATE SCRIPT Changes or adds lines to a script.

ISSUE MESSAGE
Chapter 2. Administrative commands 563
LABEL commands
Use the LABEL command to label a Tivoli Storage Manager library volume.
v LABEL LIBVOLUME (Label a library volume) on page 565
LABEL commands

564 IBM Tivoli Storage Manager for Windows: Administrators Reference
LABEL LIBVOLUME (Label a library volume)
Use this command to label tape volumes, or in an automated library, to label the
volumes automatically as they are checked in. This command allows the server to
use the full-length label with which the volumes are often pre-labeled.
Note: Use this command only for MANUAL, SCSI, ACSLS, and 349X libraries. The
command processing will not wait for a drive to become available, even if
the drive is only in the IDLE state. If necessary, you can make a library
drive available by issuing the DISMOUNT VOLUME command to dismount
the volume in that particular drive. When the library drive becomes
available, you can reissue the LABEL LIBVOLUME command.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax for a manual library

LABEl LIBVolume

library_name

volume_name
OVERWRITE = No
OVERWRITE

=

No

Yes

WAITTime = 60
WAITTime

=

value

Syntax for a SCSI library
LABEl LIBVolume library_name
volume_name
SEARCH

=

Yes

A

LABELSource

=

Barcode

Bulk

A

Prompt

Vollist

B

CHECKIN

=

SCRatch

PRIvate
OVERWRITE = No
OVERWRITE

=

No

Yes

WAITTime = 60
WAITTime

=

value

A (SEARCH=Yes, SEARCH=Bulk):

VOLRange = volume_name1,volume_name2
,

VOLList

=

volume_name

FILE:

file_name


LABEL LIBVOLUME
Chapter 2. Administrative commands 565
B (LABELSource=Vollist):

,
VOLList

=

volume_name

FILE:

file_name


Syntax for a 349X library
LABEl LIBVolume library_name volume_name
SEARCH

=

Yes

A

CHECKIN

=

SCRatch

PRIvate
OVERWRITE = No
OVERWRITE

=

No

Yes

WAITTime = 60
WAITTime

=

value

A (SEARCH=Yes):

VOLRange = volume_name1,volume_name2
,

VOLList

=

volume_name

FILE:

file_name


Syntax for an ACSLS library
LABEl LIBVolume library_name volume_name
SEARCH

=

Yes

A

CHECKIN

=

SCRatch

PRIvate
OVERWRITE = No
OVERWRITE

=

No

Yes

WAITTime = 60
WAITTime

=

value

A (SEARCH=Yes):

VOLRange = volume_name1,volume_name2
,

VOLList

=

volume_name

FILE:

file_name


LABEL LIBVOLUME

566 IBM Tivoli Storage Manager for Windows: Administrators Reference
Parameters
library_name (Required)
Specifies the name of the library that contains the storage volume.
volume_name
Specifies the name of the volume to be labeled.
v For SCSI libraries: The server requests that the volume be inserted into a slot
in the library or, if available, into an entry/exit port. The server identifies a
slot by the slots element address. If you are labeling a volume in a SCSI
library with multiple entry/exit ports, the volume in the lowest numbered
slot will be labeled.
v For MANUAL libraries: The server requests that the volume be inserted into
a drive.
v For 349X libraries: The volume might already be in the library, or you might
be prompted to put it into the I/O station.
Note: If the specified volume name is already defined in a storage pool or in a
volume history file, the volume will not be labeled, and a message will
be displayed.
CHECKIN
Specifies whether the server checks in the volume. This parameter is optional.
The following are possible values:
SCRatch
Specifies that the server checks in the volumes and adds them to the
librarys scratch pool. If a volume has an entry in volume history, you
cannot check it in as a scratch volume.
PRIvate
Specifies that the server checks in the volumes and designates them as
private. Private volumes are available only when you request them by
name.
If you do not specify a value for this parameter, then the command will only
label the volume but will not check it in. If you do not specify a value for this
parameter and you want to check in the volume, you must issue the
CHECKIN LIBVOLUME command.
SEARCH
Specifies that the server searches the library for usable volumes to label. This
parameter applies to SCSI, 349X, and ACSLS libraries.
Possible values are:
Yes
Specifies that the server labels only volumes that are stored in the library,
unless the volume is already labeled or its bar code cannot be read.
If you specify the LABELSOURCE=PROMPT option, the volume is moved
into the drive from its location in the library or entry and exit ports. The
server prompts you to issue the REPLY command containing the label
string, and that label is written to the tape.
Bulk
Specifies that the server searches the library entry/exit ports for usable
volumes to label. This option is only valid for SCSI libraries.
If you specify LABELSOURCE=BARCODE, the volume bar code is read,
and the tape is moved from its location in the library or in the entry/exit
LABEL LIBVOLUME
Chapter 2. Administrative commands 567
ports to a drive where the bar code label is written. After the tape is
labeled, it is moved back to its location in the library, to the entry/exit
ports, or to a storage slot if the CHECKIN option is specified. For bar code
support to work correctly for libraries supported by Tivoli Storage
Manager, the Tivoli Storage Manager server and the device driver must be
at the same level. Bar code support is available for libraries supported by
Tivoli Storage Manager and which use the Tivoli Storage Manager device
driver or the IBM Magstar

or LTO Ultrium device driver.

Note: You can use the VOLRANGE or VOLLIST parameter to limit the
search.
VOLRange
Specifies a range of volume names separated by a comma. Use this parameter
to limit the search for volumes to be labeled when you specify SEARCH=YES
(349X, ACSLS, and SCSI libraries) or SEARCH=BULK (SCSI libraries only). If
there are no volumes in the library that are within the specified range, the
command completes without errors.
You can specify only volume names that can be numerically incremented. In
addition to the incremental area, a volume name can include an alphanumeric
prefix and an alphanumeric suffix, for example:

Parameter Description
volrange=bar110,bar130 The 21 volumes are labeled: bar110, bar111,
bar112 ,...bar129, bar130.
volrange=bar11a,bar13a The 3 volumes are labeled: bar11a, bar12a,
bar13a.
volrange=123400,123410 The 11 volumes are labeled: 123400, 123401,
...123409, 123410.

VOLList
Specifies a list of volumes. Use this parameter to limit the search for volumes
to be labeled when you specify SEARCH=YES (349X, ACSLS, and SCSI
libraries) or SEARCH=BULK (SCSI libraries only). If there are no volumes in
the library that are in the list, the command completes without errors. The
VOLLIST parameter can also be the source of names to be used to label
volumes if the LABELSOURCE parameter is set to VOLLIST. If
LABELSOURCE=VOLLIST, you must specify the VOLLIST parameter.
Possible values are:
volume_name
Specifies the names of one or more values that are used for the command.
For example: VOLLIST=TAPE01,TAPE02.
FILE:file_name
Specifies the name of a file that contains a list of volumes for the
command. In the file, each volume name must be on a separate line. Blank
lines and comment lines that begin with an asterisk are ignored. For
example, to use volume TAPE01, TAPE02 and TAPE03, create a file named
TAPEVOL that contains these lines:
TAPE01
TAPE02
TAPE03
You can specify the volumes for the command as follows:
VOLLIST=FILE:TAPEVOL.
LABEL LIBVOLUME

568 IBM Tivoli Storage Manager for Windows: Administrators Reference
Note: The file name is case-sensitive.
LABELSource
Specifies how or whether the server reads sequential media labels of volumes.
This option is only valid for SCSI libraries. Specify this parameter only when
SEARCH=YES or SEARCH=BULK.
Possible values are:
Prompt
The server prompts for volume names as necessary.
Barcode
The server attempts to read the bar code label. If the attempt fails, the
server will not label the volume and will display a message.
Note: For bar code support to work properly, the appropriate device
drivers must be installed for the libraries.
Vollist
This option only applies to SCSI libraries. The server attempts to read the
specified file or list of files. If the attempt fails, the server will not label the
volumes and will display a message.
OVERWRITE
Specifies whether the server attempts to overwrite existing labels. This
parameter is optional. The default is NO. Possible values are:
No
Specifies that the server only labels unlabeled volumes. For StorageTek
VolSafe volumes and WORM optical volumes, the value must be NO.
Yes
Specifies that the server overwrites existing labels only if both the existing
label and the prompted or bar code label are not already defined in either
the server storage pool or volume history list.
WAITTime
Specifies the number of minutes that the server will wait for you to reply or
respond to a request. Specify a value in the range 0-9999. If you want to be
prompted by the server, specify a wait time greater than zero. The default
value is 60 minutes. For example, suppose the server prompts you to insert a
tape into the entry/exit port of a library. If you specified a wait time of 60
minutes, the server will issue a request and wait 60 minutes for you to reply.
Suppose, on the other hand, you specify a wait time of 0. If you have already
inserted a tape, a wait time of zero will cause the operation to continue
without prompting. If you have not inserted a tape, a wait time of zero will
cause the operation to fail.
Examples
Task
Label tapes in a SCSI library named AUTO automatically as you are checking the
volumes in.
Command
label libvolume auto checkin=scratch search=yes labelsource=barcode
overwrite=yes
Task
LABEL LIBVOLUME
Chapter 2. Administrative commands 569
Label 3 volumes from bar11a to bar13a in a SCSI library named ABC..
Command
label libvolume abc checkin=scratch search=yes volrange=bar11a,bar13a
labelsource=barcode
The 3 volumes are labeled: bar11a, bar12a, bar13a.
Related commands
Table 171. Commands related to LABEL LIBVOLUME
Command Description
AUDIT LIBRARY Ensures that an automated library is in a
consistent state.
CANCEL PROCESS Cancels a background server process.
CHECKIN LIBVOLUME Checks a storage volume into an automated
library.
CHECKOUT LIBVOLUME Checks a storage volume out of an
automated library.
DEFINE LIBRARY Defines an automated or manual library.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
QUERY LIBRARY Displays information about one or more
libraries.
QUERY LIBVOLUME Displays information about a library volume.
QUERY PROCESS Displays information about background
processes.
REPLY Allows a request to continue processing.
UPDATE LIBVOLUME Changes the status of a storage volume.

LABEL LIBVOLUME

570 IBM Tivoli Storage Manager for Windows: Administrators Reference
LOCK commands
Use the LOCK command to prevent users from accessing the server.
The following is a list of LOCK commands for Tivoli Storage Manager:
v LOCK ADMIN (Lock out an administrator) on page 572
v LOCK NODE (Lock out a client node) on page 573
v LOCK PROFILE (Lock a profile) on page 574
LOCK commands
Chapter 2. Administrative commands 571
LOCK ADMIN (Lock out an administrator)
Use this command to prevent an administrator from accessing the server. The
administrator is locked out until a system administrator uses the UNLOCK
ADMIN command to reestablish access for the administrator.
You cannot issue the LOCK ADMIN command against the SERVER_CONSOLE
administrative ID.
Privilege class
To issue this command, you must have system privilege.
Syntax
LOCK Admin admin_name

Parameters
admin_name (Required)
Specifies the name of the administrator to be locked out.
Examples
Task
Lock out the administrator CLAUDIA.
Command
lock admin claudia
Related commands
Table 172. Commands related to LOCK ADMIN
Command Description
QUERY ADMIN Displays information about one or more IBM
Tivoli Storage Manager administrators.
UNLOCK ADMIN Enables a locked administrator to access IBM
Tivoli Storage Manager.

LOCK ADMIN

572 IBM Tivoli Storage Manager for Windows: Administrators Reference
LOCK NODE (Lock out a client node)
Use this command to prevent a client node from accessing the server. A locked
client cannot perform any Tivoli Storage Manager operations, even if the
operations are scheduled.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the client
node belongs.
Syntax
LOCK Node node_name

Parameters
node_name (Required)
Specifies the name of the client node to lock out.
Examples
Task
Lock the client node SMITH.
Command
lock node smith
Related commands
Table 173. Commands related to LOCK NODE
Command Description
QUERY NODE Displays partial or complete information
about one or more clients.
UNLOCK NODE Enables a locked user in a specific policy
domain to access the server.

LOCK NODE
Chapter 2. Administrative commands 573
LOCK PROFILE (Lock a profile)
Use this command on a configuration manager to temporarily lock a profile so that
configuration information is not distributed to subscribing managed servers.
You can use this command when you are making multiple updates to your
configuration and do not want to distribute this information until the changes are
completed.
Privilege class
To issue this command, you must have system privilege.
Syntax

60
LOCK PROFIle

profile_name

minutes

Parameters
profile_name (Required)
Specifies the profile to lock. You can use wildcard characters to indicate
multiple names.
minutes
Specifies the time, in minutes, before Tivoli Storage Manager unlocks the
configuration profile. Specify an integer from 0 to 10000. The default is 60
minutes. If you specify 0, the configuration profile will not unlock
automatically. Use the UNLOCK PROFILE command to unlock the profile
before the time period elapses, or to unlock it if you have specified a value of
0. This parameter is optional.
Examples
Task
Lock a profile named DELTA for 30 minutes.
Command
lock profile delta 30
Related commands
Table 174. Commands related to LOCK PROFILE
Command Description
COPY PROFILE Creates a copy of a profile.
DEFINE PROFASSOCIATION Associates objects with a profile.
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
DELETE PROFASSOCIATION Deletes the association of an object with a
profile.
DELETE PROFILE Deletes a profile from a configuration
manager.
LOCK PROFILE

574 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 174. Commands related to LOCK PROFILE (continued)
Command Description
QUERY PROFILE Displays information about configuration
profiles.
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UNLOCK PROFILE Enables a locked profile to be distributed to
managed servers.
UPDATE PROFILE Changes the description of a profile.

LOCK PROFILE
Chapter 2. Administrative commands 575
MACRO (Invoke a macro)
Use this command to invoke a file from the administrative command line that
contains one or more Tivoli Storage Manager administrative commands to be
performed.
Attention: This command is used with administrative command-line clients only.
A macro is a file that contains one or more Tivoli Storage Manager administrative
commands. You can only issue a macro from the administrative client in batch or
interactive mode. A macro is stored as a file on the administrative client machine
(or system). Macros are not distributed across servers and cannot be scheduled on
the server.
Creating a macro to enter commands can be helpful when you want to issue
commands that are used repeatedly, to issue commands that contain several
parameters, or to process related commands in a specific order. After you create a
macro, you can update the information it contains and use it again, or you can
copy the macro file, make changes to the copy, and then run the copy.
For detailed information on macros, how to use them, and the differences between
command scripts and administrative command-line client macros, refer to the
Administrators Guide.
Privilege class
Any administrator can issue this command.
Syntax
MACRO macro_name

substitution_value


Parameters
macro_name (Required)
Specifies the name of the macro.
substitution_value
Specifies the value for a substitution variable in a macro. When you use a
substitution variable, you can reuse a macro whenever you need to perform
the same task for different objects or with different parameter values. To
specify a value that contains blanks, you must enclose the value in quotation
marks. This parameter is optional.
Examples
Task 1
Create a macro file named REGNG. Use the macro to register and grant authority
to a new administrator. Write the macro as follows:
MACRO

576 IBM Tivoli Storage Manager for Windows: Administrators Reference
/* Register and grant authority to a new administrator */
REGister Admin jones passwd -
CONtactinfo="x1235"
GRant AUTHority jones -
CLasses=Policy
Command
macro regng.mac
Task 2
Create a macro file named AUTHRG, containing substitution variables, to register
and grant authority to a new administrator. Write the macro as follows:
/* Register and grant authority to a new administrator */
REGister Admin %1 %2 - /* Enter userid and password */
CONtact=%3 /* Enter contact info (in quotes if nec.) */
GRant AUTHority %1 - /* Server uses variable already */
- /* defined by you */
CLasses=%4 /* Enter the privilege class */
Enter the values you want to pass to the server to process the command when you
run the macro.
Command
macro authrg.mac jones passwd x1235 Policy
Related commands
Table 175. Commands related to MACRO
Command Description
COMMIT Makes changes to the database permanent.
ROLLBACK Discards any uncommitted changes to the
database since the last COMMIT was
executed.

MACRO
Chapter 2. Administrative commands 577
MIGRATE STGPOOL (Migrate storage pool to next storage pool)
Use this command to migrate files from one storage pool to the next storage pool
in the storage hierarchy.
This command can only be used with primary storage pools. The storage pool data
format cannot be NETAPPDUMP, CELERRADUMP, or NDMPDUMP. Data cannot
be migrated into or out of storage pools defined with a CENTERA device class.
Only one migration or reclamation process for a given storage pool is allowed at
any given time. If a migration or reclamation process is already running for the
storage pool, you cannot start another migration process for the storage pool.
You should only use this command if you are not going to use automatic
migration for the storage pool. To prevent automatic migration from running, set
the HIGHMIG attribute of the storage pool definition to 100.
The MIGRATE STGPOOL command will honor the values of the following
parameters on the DEFINE STGPOOL and UPDATE STGPOOL commands:
v MIGPROCESS
v MIGDELAY
v MIGCONTINUE
v NEXTPOOL
v LOWMIG. However, you can override the value of this parameter on DEFINE
STGPOOL and UPDATE STGPOOL by specifying a value for the LOWMIG
parameter on the MIGRATE STGPOOL command.
The MIGRATE STGPOOL command will ignore the value of the HIGHMIG
parameter of the storage pool definition. Migration will occur regardless of the
value of the HIGHMIG parameter.
This command creates one or more migration processes that can be canceled with
the CANCEL PROCESS command. The number of processes is limited by the
MIGPROCESS attribute of the storage pool definition. To display information on
background processes, use the QUERY PROCESS command.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for both the storage pool from which the
files are to be migrated and the next storage pool to which files are to be migrated.
Syntax
MIGrate STGpool pool_name
LOwmig

=

number

DUration

=

minutes
REClaim = No
REClaim

=

No

Yes
Wait = No
Wait

=

No

Yes

MIGRATE STGPOOL

578 IBM Tivoli Storage Manager for Windows: Administrators Reference
Parameters
pool_name (Required)
Specifies the primary storage pool from which files are to be migrated.
DUration
Specifies the maximum number of minutes the migration will run before being
automatically cancelled. When the specified number of minutes elapses, the
server will automatically cancel all migration processes for this storage pool.
As soon as the processes recognize the automatic cancellation, they will end.
As a result, the migration may run longer than the value you specified for this
parameter. You can specify a number from 1 to 9999. This parameter is
optional. If not specified, the server will stop only after the low migration
threshold is reached.
LOwmig
For random-access and sequential-access disk storage pools, specifies that the
server stops migration when the amount of data in the pool is at or below this
percentage of the pools estimated capacity. The calculation for
sequential-access disk storage pools includes the capacity of all the scratch
volumes specified for the pool. For other types of sequential-access storage
pools, this parameter specifies that the server stops migration when the ratio of
volumes containing data to the total number of volumes in the storage pool is
at or below this percentage. The total number of volumes includes the
maximum number of scratch volumes. This parameter is optional. You can
specify a number from 0 to 99. The default value is the LOWMIG attribute of
the storage pool definition.
When the storage pool reaches the low migration threshold, the server does
not start migration of another nodes files. However, because all file spaces that
belong to a node or all file spaces for all nodes belonging to a collocation
group are migrated together, the occupancy of the storage pool can fall below
the value you specified for this parameter. To permit migration to empty the
storage pool, you can set LOWMIG=0.
If the storage pool is already below the low migration threshold, no data will
be migrated.
REClaim
Specifies whether reclamation is attempted for the storage pool prior to
performing the migration. This parameter can only be specified for a
sequential-access storage pool. This parameter is optional. The default is No.
Possible values are:
No
Specifies that the server will not attempt a reclamation prior to starting the
migration.
Yes
Specifies that the server will attempt reclamation prior to starting the
migration. Any volumes in the storage pool that meet the reclamation
threshold as specified by the RECLAIM attribute of the storage pool
definition will be reclaimed prior to performing the migration. If no
volumes meet the reclamation threshold or if, after reclamation, the
LOWMIG threshold has not been reached, the server will begin the
migration. Before reclaiming space for storage pools defined with
RECLAMATIONTYPE=SNAPLOCK, the server will delete all empty
WORM FILE volumes during reclamation processing that have exceeded
their reclaim period.
MIGRATE STGPOOL
Chapter 2. Administrative commands 579
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. This default is No. Possible
values are:
No
Specifies that the server processes this command in the background.
You can continue with other tasks while the command is being processed.
Messages created from the background process are displayed either in the
activity log or the server console, depending on where messages are
logged.
To cancel a background process, use the CANCEL PROCESS command. If
you cancel this process, some files may have already been migrated prior
to the cancellation.
Yes
Specifies that the server processes this command in the foreground. The
operation must complete before you can continue with other tasks. The
server then displays the output messages to the administrative client when
the operation completes. Messages are also displayed either in the activity
log or the server console, or both, depending on where the messages are
logged.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Migrate data from the storage pool named BACKUPPOOL to the next storage pool.
Specify that the server should end the migration as soon as possible after 90
minutes.
Command
migrate stgpool backuppool duration=90
Related commands
Table 176. Commands related to MIGRATE STGPOOL
Command Description
CANCEL PROCESS Cancels a background server process.
QUERY PROCESS Displays information about background
process.
QUERY STGPOOL Displays information about storage pools.
RECLAIM STGPOOL Performs reclamation for the storage pool.

MIGRATE STGPOOL

580 IBM Tivoli Storage Manager for Windows: Administrators Reference
MOVE commands
Use the MOVE commands to either transfer backup or archive data between
storage pools, or to move disaster recovery media on and off site.
The following is a list of MOVE commands for Tivoli Storage Manager:
v MOVE DATA (Move files on a storage pool volume) on page 582
v MOVE DRMEDIA (Move disaster recovery media offsite and back onsite) on
page 586
v MOVE GRPMEMBER (Move a server group member) on page 600
v MOVE MEDIA (Move sequential access storage pool media) on page 601
v MOVE NODEDATA (Move data by node in a sequential access storage pool)
on page 609
MOVE commands
Chapter 2. Administrative commands 581
MOVE DATA (Move files on a storage pool volume)
Use this command to move files from one storage pool volume to other storage
pool volumes.
You can move files from a primary storage pool volume only to volumes in the
same or a different primary storage pool. You can move files from a copy storage
pool volume only to volumes in the same copy storage pool. You can move files
from an active-data pool volume only to volumes in the same active-data pool.
In addition to moving data from volumes in storage pools that have NATIVE or
NONBLOCK data formats, this command also lets you move data from volumes in
storage pools that have NDMP data formats (NETAPPDUMP, CELERRADUMP, or
NDMPDUMP). The target storage pool must have the same data format as the
source storage pool. If you are moving data out of a storage pool for the purpose
of upgrading to new tape technology, the target primary storage pool must be
associated with a library that has the new device for the tape drives. Tivoli Storage
Manager supports backend data movement for NDMP images. For details, see the
Administrators Guide.
You cannot move data into or out of a storage pool defined with a CENTERA
device class.
If you are moving files to volumes in the same storage pool, sufficient space must
be available on the volumes. Otherwise, the operation fails.
When you move files from a sequential access volume, multiple sequential access
volume mounts are required to move files that span volumes.
When you move files from a random access volume, the server erases any cached
copies of files on the volume.
After a move data operation completes, a volume may not be empty if one or more
files cannot be relocated to another volume because of input/output errors on the
device or because errors were found in the file. If needed, you can delete the
volume using the option to discard any data. The files with I/O or other errors are
then deleted.
You can use this command to move files from an offsite volume in a copy storage
pool or active-data pool. Because the offsite volume cannot be mounted, the server
obtains the files that are on the offsite volume from either a primary storage pool,
another copy storage pool, or another active-data pool. These files are then written
to the destination volumes in the original copy storage pool or active-data pool.
Do not use the MOVE DATA command if a restore process (RESTORE STGPOOL
or RESTORE VOLUME) is running. The MOVE DATA command could cause the
restore to be incomplete. If you issue the MOVE DATA command during a restore
operation and you receive an error message indicating that one or more files are
locked and cannot be moved, you need to reissue the MOVE DATA command after
the restore operation has completed in order to move any remaining files.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the storage pool to which the volume
belongs and also for the new storage pool, if one is specified.
MOVE DATA

582 IBM Tivoli Storage Manager for Windows: Administrators Reference
Syntax
MOVe Data volume_name
STGpool

=

pool_name

SHREDTONOshred

=

No

SHREDTONOshred

=

No

Yes
(1) (2)
RECONStruct

=

No or Yes

RECONStruct

=

No

Yes

Wait = No
Wait

=

No

Yes

Notes:
1 The default is NO if either the source or target storage pool is random access.
The default is YES if both the source and target storage pools are sequential
access.
2 This parameter is not available or is ignored if the data format is
NETAPPDUMP, CELERRADUMP, or NDMPDUMP data.
Parameters
volume_name (Required)
Specifies the storage pool volume from which to move files.
STGpool
Specifies the primary storage pool to which you want to move files (the target
storage pool). This parameter is optional and applies only to moving data from
primary storage pool volumes. If you do not specify a value for this parameter,
files are moved to other volumes within the same storage pool.
SHREDTONOshred
Specifies whether data will be moved from a storage pool that enforces
shredding to a storage pool that does not enforce shredding. This parameter is
optional. The default value is NO. Possible values are:
No
Specifies that the server will not allow data to be moved from a storage
pool that enforces shredding to a storage pool that does not enforce
shredding. If the source storage pool enforces shredding and the target
storage pool does not, the operation will fail.
Yes
Specifies that the server will allow data to be moved from a storage pool
that enforces shredding to a storage pool that does not enforce shredding.
The source data will be shredded when the operation is complete. The
target data will not be shredded when it is deleted.
RECONStruct
Specifies whether to reconstruct file aggregates during data movement.
Reconstruction removes empty space that has accumulated during deletion of
logical files from an aggregate. This parameter is optional. The parameter is
not available or is ignored if the data format is NETAPPDUMP,
MOVE DATA
Chapter 2. Administrative commands 583
CELERRADUMP, or NDMPDUMP. If both the source and target storage pools
are sequential access, the default value is YES. If either the source or target
storage pool is random access, the default is NO. Possible values are:
No
Specifies that reconstruction of file aggregates is not performed during data
movement.
Yes
Specifies that reconstruction of file aggregates is performed during data
movement. You can only specify this option when both the source and the
target storage pools are sequential-access.
Attention: Reconstruction removes inactive backup files in active-data pools.
Specifying RECONSTRUCT=NO when moving data from volumes in an
active-data pool will prevent the inactive backup files from being removed.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default value is No. Possible
values are:
No
Specifies that the server processes this command in the background. You
can continue with other tasks while the command is being processed. The
server displays messages that are created from the background process
either in the activity log or the server console, depending on where
messages are logged.
To cancel a background process, use the CANCEL PROCESS command. If
a MOVE DATA background process is canceled, some files may have
already moved prior to the cancellation.
Yes
Specifies that the server processes this command in the foreground. You
wait for the command to complete before continuing with other tasks. The
server then displays the output messages to the administrative client when
the command completes.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Move files from storage pool volume STGVOL.1 to any available volumes assigned
to the 8MMPOOL storage pool.
Command
move data stgvol.1 stgpool=8mmpool
Related commands
Table 177. Commands related to MOVE DATA
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
MOVE DATA

584 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 177. Commands related to MOVE DATA (continued)
Command Description
DELETE VOLUME Deletes a volume from a storage pool.
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY PROCESS Displays information about background
processes.
QUERY SHREDSTATUS Displays information about data waiting to
be shredded.
SHRED DATA Manually starts the process of shredding
deleted data.

MOVE DATA
Chapter 2. Administrative commands 585
MOVE DRMEDIA (Move disaster recovery media offsite and
back onsite)
Use this command to track database backup and copy storage pool volumes that
are to be moved offsite and to identify the expired or empty volumes that are to be
moved onsite.
The database backup volumes can be for full plus incremental or snapshot
backups. You cannot specify virtual volumes (backup objects stored on another
server). You can change volumes through each state, or you can use the TOSTATE
parameter and skip states to simplify the movements.
Note: The MOVE DRMEDIA command always processes copy storage pool
volumes (see the description of the COPYSTGPOOL parameter for more
information). You can use the SOURCE parameter to control whether the
command processes database backup volumes.
You can use the QUERY ACTLOG command to see if the MOVE DRMEDIA
command was successful. You can also view this information from the server
console.
Privilege class
To issue this command, you must have one of the following privilege classes:
v If the CMD parameter is specified and the REQSYSAUTHOUTFILE server
option is set to NO: operator, unrestricted storage, or system privilege.
v If the CMD parameter is specified and the REQSYSAUTHOUTFILE server
option is set to YES (the default): system privilege.
Syntax
MOVe DRMedia volume_name
WHERESTate

=

MOuntable

NOTMOuntable

COUrier

VAULTRetrieve

COURIERRetrieve

BEGINDate

=

date

ENDDate

=

date

BEGINTime

=

time

ENDTime

=

time

COPYstgpool

=

pool_name

Source = DBBackup
Source

=

DBBackup

DBSnapshot

DBNOne
REMove = Bulk
REMove

=

No

Yes

Bulk

Untileefull

MOVE DRMEDIA

586 IBM Tivoli Storage Manager for Windows: Administrators Reference

TOSTate

=

NOTMOuntable

COUrier

VAult

COURIERRetrieve

ONSITERetrieve

WHERELOcation

=

location

TOLOcation

=

location

CMd

=

command

CMDFilename

=

file_name
Wait = No
Wait

=

No

Yes

CAP

=

x,y,z

Parameters
volume_name (Required)
Specifies the name of the database backup or copy storage pool volume to be
processed. If you use wildcard characters to specify this name, you must also
specify WHERESTATE.
WHERESTate
Specifies the state of volumes to be processed. This parameter is required if the
TOSTATE is not specified or if you use a wildcard character in the volume
name. For more information, see Table 183 on page 595 and Table 184 on page
595. Possible values are:
MOuntable
These volumes contain valid data and are available for onsite processing.
They will change to NOTMOUNTABLE if the TOSTATE is not specified.
Depending on the behavior of the REMOVE parameter, Tivoli Storage
Manager might eject volumes in an automated library before changing the
destination state.
For external libraries, the server sends requests to the external library
manager to eject the volumes. It depends on the external library manager
as to whether or not the volumes are ejected from the library. Refer to the
external library documentation for information about the procedures that
you should follow when using the MOVE DRMEDIA command to track
the volumes.
NOTMOuntable
These volumes are onsite, contain valid data, and are not available for
onsite processing. They will change to COURIER if the TOSTATE is not
specified.
COUrier
These volumes are with the courier and being moved offsite. They will
change only to VAULT.
VAULTRetrieve
These volumes are located at the offsite vault and do not contain valid
data. They will change to COURIERRETRIEVE if the TOSTATE is not
specified.
COURIERRetrieve
These volumes are with the courier and being moved onsite. They will
MOVE DRMEDIA
Chapter 2. Administrative commands 587
change only to ONSITERETRIEVE. Tivoli Storage Manager deletes from
the database the volume records of the database backup and scratch copy
storage pool volumes.
BEGINDate
Specifies the beginning date used to select volumes. This parameter is optional.
Volumes are considered eligible if the MOVE DRMEDIA command has
changed the volume to its current state on or after the specified date. The
default is the earliest date for which volume information exists.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified
TODAY7 or 7.
To identify volumes that were changed
to their current state a week ago, you
can specify TODAY-7 or simply -7.

ENDDate
Specifies the ending date used to select volumes. This parameter is optional.
Volumes are considered eligible if the MOVE DRMEDIA command has
changed the volume to its current state on or before the specified date. The
default is the current date.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
To identify volumes that were changed
to their current state today, specify
TODAY.
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days is 9999.
TODAY1 or 1.
To identify volumes that were changed
to their current state a week ago, you
can specify TODAY-1 or simply -1.

BEGINTime
Specifies the beginning time used to select volumes for processing. This
parameter is optional. Volumes are considered eligible if the MOVE DRMEDIA
command has changed the volume to its current state on or after the specified
time and date. The default is midnight (00:00:00) on the date specified with the
BEGINDATE parameter.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the specified
begin date
12:33:28
NOW The current time on the
specified begin date
NOW
MOVE DRMEDIA

588 IBM Tivoli Storage Manager for Windows: Administrators Reference
Value Description Example
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes on the specified begin
date
NOW+03:00 or +03:00.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes on the specified
begin date
NOW-03:30 or -03:30.
If you issue the MOVE DRMEDIA
command at 9:00 with
BEGINTIME=NOW-03:30 or
BEGINTIME= -03:30, Tivoli Storage
Manager identifies the volumes that
were changed to their current state at
5:30 on the begin date you specify.

ENDTime
Specifies the ending time used to select volumes for processing. This parameter
is optional. Volumes are considered eligible if the MOVE DRMEDIA command
has changed the volume to its current state on or after the specified time and
date. The default is 23:59:59.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the specified
end date
12:33:28
NOW The current time on the
specified end date
NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes on the specified end
date
NOW+03:00 or +03:00.
If you issue the MOVE DRMEDIA
command at 9:00 with
ENDTIME=NOW+03:30 or
ENDTIME=+03:30, Tivoli Storage
Manager identifies the volumes that
were changed to their current state at
12:30 on the end date you specify.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes on the specified
end date
NOW-03:30 or -03:30.

COPYstgpool
Specifies the name of the copy storage pool whose volumes are to be
processed. This parameter is optional. You can use wildcard characters to
specify this name. The copy storage pools specified with this parameter
override those specified with the SET DRMCOPYSTGPOOL command. If you
do not specify a copy storage pool name, all volumes in the specified state,
except MOUNTABLE state, are processed. See SET DRMCOPYSTGPOOL
command for processing the volumes in the MOUNTABLE state.
Source
Specifies whether to include database backup volumes for processing. This
parameter is optional. The default is DBBACKUP. The choices are:
DBBackup
Specifies that Tivoli Storage Manager includes full and incremental
database backup volumes for processing.
MOVE DRMEDIA
Chapter 2. Administrative commands 589
DBSnapshot
Specifies that Tivoli Storage Manager includes database snapshot backup
volumes for processing.
DBNOne
Specifies that Tivoli Storage Manager does not include any database
backup volumes for processing.
REMove
Specifies whether Tivoli Storage Manager ejects the volumes from the library.
This parameter is optional and applies only when moving from the
MOUNTABLE state. Possible values are YES, BULK, NO, and UNTILEEFULL.
The default is BULK. The response of the server to each option depends on the
particular type of library. The tables that follow describe how the server
responds for different types of libraries.
Table 178. How the Tivoli Storage Manager server responds for 349X libraries
REMOVE=YES or REMOVE=NO
REMOVE=BULK or
REMOVE=UNTILEEFULL
The 3494 Library Manager ejects the
cartridge to the convenience I/O station.
The 3494 Library Manager ejects the
cartridge to the high-capacity output facility.

Table 179. How the Tivoli Storage Manager server responds for SCSI libraries
If a library . . .
And REMOVE=YES,
then...
And REMOVE=
BULK,
then...
And REMOVE=NO,
then...
And REMOVE=
UNTILEEFULL
then...
Does not have
entry/exit ports
The server leaves the
cartridge in its current
slot within the library
and specifies the slot
address in a message.
The server then
prompts you to
remove the cartridge
from the slot and to
issue a REPLY
command.
The server leaves the
cartridge in its current
slot within the library
and specifies the slot
address in a message.
The server does not
prompt you to
remove the cartridge
and does not require
a REPLY command.
The server leaves the
cartridge in its current
slot within the library
and specifies the slot
address in a message.
The server does not
prompt you to
remove the cartridge
and does not require
a REPLY command.
The server leaves the
cartridge in its current
slot within the library
and specifies the slot
address in a message.
The server does not
prompt you to
remove the cartridge
and does not require
a REPLY command.
Has entry/exit ports
and an entry/exit port
is available
The server moves the
cartridge to the
available entry/exit
port and specifies the
port address in a
message.
The server then
prompts you to
remove the cartridge
from the slot and to
issue a REPLY
command.
The server moves the
cartridge to the
available entry/exit
port and specifies the
port address in a
message.
The server does not
prompt you to
remove the cartridge
and does not request
a REPLY command.
The server specifies
the port address in a
message.
The server does not
prompt you to
remove the cartridge
and does not request
a REPLY command.
The server moves the
cartridge to the
available entry/exit
port and specifies the
port address in a
message.
The server does not
prompt you to
remove the cartridge
and does not request
a REPLY command.
MOVE DRMEDIA

590 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 179. How the Tivoli Storage Manager server responds for SCSI libraries (continued)
If a library . . .
And REMOVE=YES,
then...
And REMOVE=
BULK,
then...
And REMOVE=NO,
then...
And REMOVE=
UNTILEEFULL
then...
Has entry/exit ports,
but no ports are
available
The server leaves the
cartridge in its current
slot within the library
and specifies the slot
address in a message.
The server then
prompts you to
remove the cartridge
from the slot and to
issue a REPLY
command.
The server waits for a
port to be made
available.
The server specifies
the port address in a
message.
The server does not
prompt you to
remove the cartridge
and does not request
a REPLY command.
The command fails
and any remaining
eligible volumes are
not processed.
Make the port
available and issue
the command again.

Table 180. How the Tivoli Storage Manager server responds for ACSLS libraries
REMOVE=YES, REMOVE=BULK, or
REMOVE=UNTILEEFULL REMOVE=NO
The server ejects the cartridge to the
convenience I/O station.
The server then deletes the volume entry
from the server library inventory.
While moving volumes from the
MOUNTABLE state with REMOVE=YES
specified, the MOVE MEDIA command uses
more than one slot in the CAP for a
StorageTek library with ACSLS.
The server does not eject the cartridge.
The server deletes the volume entry from the
server library inventory and leaves the
volume in the library.

Table 181. How the Tivoli Storage Manager server responds for external libraries
REMOVE=YES, REMOVE=BULK, REMOVE=UNTILEEFULL, or REMOVE=NO
The server requests the external library manager to eject the volume from the library.
It depends on the external library manager as to whether or not the volume is ejected from
the library. Refer to the external library documentation for information about the procedures
that you should follow when using the MOVE DRMEDIA command to track volumes.

Table 182. How the Tivoli Storage Manager server responds for RSM libraries
REMOVE=YES, REMOVE=BULK, or
REMOVE=UNTILEEFULL REMOVE=NO
The server ejects the cartridge to the
convenience I/O station.
The server then deletes the volume entry
from the server library inventory.
The volume is not ejected.

TOSTate
Specifies the destination state of the volumes being processed. This parameter
is required if WHERESTATE is not specified. If you specify TOSTATE but not
MOVE DRMEDIA
Chapter 2. Administrative commands 591
WHERESTATE, you must specify the volume name. Wildcard characters are
not allowed. For more information, see Table 183 on page 595 and Table 184 on
page 595.
Possible values are:
NOTMOuntable
Specifies that volumes are to change to the NOTMOUNTABLE state. This
value is valid only if the volumes are in the MOUNTABLE state. If
volumes are in an automated library, Tivoli Storage Manager might eject,
depending on the behavior of the REMOVE parameter, the volumes from
the library before changing them to the NOTMOUNTABLE state.
For external libraries, the server sends requests to the external library
manager to eject the volumes. It depends on the external library manager
as to whether or not the volumes are ejected from the library. Refer to the
external library documentation for information about the procedures that
you should follow when using the MOVE DRMEDIA command to track
the volumes.
COUrier
Specifies that volumes are to change to the COURIER state. This value is
valid only if the volumes are in the MOUNTABLE or NOTMOUNTABLE
state. Depending on the behavior of the REMOVE parameter and whether
volumes are in an automated library, Tivoli Storage Manager might eject
the volumes from the library before changing them to the COURIER state.
For external libraries, the server sends requests to the external library
manager to eject the volumes. It depends on the external library manager
as to whether or not the volumes are ejected from the library. Refer to the
external library documentation for information about the procedures that
you should follow when using the MOVE DRMEDIA command to track
the volumes.
VAult
Specifies that volumes are to change to the VAULT state. This value is
valid only if the volumes are in the MOUNTABLE, NOTMOUNTABLE, or
COURIER state. Depending on the behavior of the REMOVE parameter
and whether volumes are in an automated library, Tivoli Storage Manager
might eject the volumes from the library before changing them to the
VAULT state.
For external libraries, the server sends requests to the external library
manager to eject the volumes. It depends on the external library manager
as to whether or not the volumes are ejected from the library. Refer to the
external library documentation for information about the procedures that
you should follow when using the MOVE DRMEDIA command to track
the volumes.
COURIERRetrieve
Specifies that volumes are to change to the COURIERRETRIEVE state. This
value is valid only if the volumes are in the VAULTRETRIEVE state.
ONSITERetrieve
Specifies that volumes are to change to the ONSITERETRIEVE state. This
value is valid only if the volumes are in the VAULTRETRIEVE or
COURIERRETRIEVE state. For database backup and scratch copy storage
pool volumes that are changing to the ONSITERETRIEVE state, Tivoli
Storage Manager deletes the volume records from the database.
MOVE DRMEDIA

592 IBM Tivoli Storage Manager for Windows: Administrators Reference
WHERELOcation
Specifies the current location of the volumes. This parameter is optional. The
maximum length of the location is 255 characters. Enclose the text in quotation
marks if it contains any blank characters.
TOLOcation
Specifies the destination location of the volumes. This parameter is optional.
The maximum length of the location specified is 255 characters. Enclose the
text in quotation marks if it contains any blank characters. If you do not
specify the destination location, the location defined by the SET
DRMNOTMOUNTABLE command is used.
CMd
Specifies the creation of executable commands to process each volume obtained
by this command. This parameter is optional. The maximum length of this
command specification is 255 characters. DRM writes the commands to a file
that is specified by the CMDFILENAME parameter. If the length of the written
command is greater than 240 characters, it is split into multiple lines and
continuation characters (+) are added. You may need to alter the continuation
character according to the product that runs the commands.
command
The command string enclosed in quotation marks. The string must not
include embedded quotation marks. For example, this is a valid CMD
parameter:
cmd="checkin libvol lib8mm &vol status=scratch"
This is an example of a CMD parameter that is not valid:
cmd=""checkin libvol lib8mm" &vol status=scratch""
The command can include substitution variables. The variables are not
case-sensitive, and must not contain blank spaces after the ampersand (&).
The possible variables are:
&VOL
A volume name.
&LOC
A volume location.
&VOLDSN
The file name to be written into the sequential access media labels. For
example, if the applicable device class sets TSM as the tape volume
prefix, a copy storage pool tape volume file name might be TSM.BFS
and a database backup tape volume file name might be TSM.DBB.
&NL
The new line character. When &NL is specified, the command is split
at the &NL variable. If required, you must specify the appropriate
continuation character before the &NL. If the &NL is not specified and
the command line is greater than 240 characters, the line is split into
multiple lines and continuation characters (+) are added.
CMDFilename
Specifies the fully qualified name of the file that will contain the commands
specified by CMD parameter. This parameter is optional. The maximum length
of the file name is 259 characters.
If you do not specify a file name or if you specify a null string (), DRM uses
the file name specified by the SET DRMCMDFILENAME. If you do not specify
MOVE DRMEDIA
Chapter 2. Administrative commands 593
a file name with the SET DRMCMDFILENAME, DRM generates a file name by
appending exec.cmd to the directory representing this instance of the IBM
Tivoli Storage Manager server (typically the directory from which the server
was originally installed). The DRM allocates the file name specified or
generated. If the file name exists, DRM tries to use it; any existing data is
overwritten. If this should happen and the executable commands in the file
have not been run, issue QUERY DRMEDIA command to re-build the
executable commands for the desired date and volume transition
If the MOVE DRMEDIA command fails and none of the command string
specified with the CMD parameter has been written for the volume
successfully moved, the allocated file name is deleted.
APPend
Specifies whether to overwrite any existing contents of the command file or
append the commands to the file. This parameter is optional. The default is
NO. Possible values are:
No
DRM overwrites the contents of the file.
Yes
DRM appends the commands to the file.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default value is NO.
Note: You cannot specify WAIT=YES from the server console.
Possible values are:
No
Specifies that Tivoli Storage Manager processes this command in the
background. Messages created from the background process are displayed
either in the activity log or the server console, depending on where
messages are logged. To see if the operation was successful, issue the
QUERY ACTLOG command.
Yes
Specifies that the server processes this command in the foreground. Wait
for the command to complete before continuing with other tasks. The
server then displays the output messages to the administrative client.
CAP
Specifies which cartridge access port (CAP) to use for ejecting volumes if you
specify REMOVE=YES. This parameter applies to volumes in ACSLS libraries
only. If a CAP priority greater than zero does not exist in the library, this
parameter is required. If a CAP priority greater than zero does exist in the
library, this parameter is optional. If you do not specify the parameter, the
ACSLS server will choose any available CAP with a priority greater than zero.
To display valid CAP identifiers (x,y,z), issue the QUERY CAP command with
ALL specified from the Automated Cartridge System System Administrator
(ACSSA) console on the ACSLS server host. The identifiers are as follows:
x The Automated Cartridge System (ACS) ID. This identifier can be a
number between 0-126.
y The Library Storage Module (LSM) ID. This identifier can be a number
between 0-23.
z The CAP ID. This identifier can be a number between 0-2.
MOVE DRMEDIA

594 IBM Tivoli Storage Manager for Windows: Administrators Reference
For more information, refer to your StorageTek documentation.
Rules for destination states and destination locations
The following table shows how DRM determines the destination state and location
of a volume.
Destination state
v TOSTATE specified.
v The next state of the WHERESTATE specified, if the TOSTATE is not
specified.
Destination location
v TOLOCATION specified.
v The location of the TOSTATE specified, if the TOLOCATION is not
specified.
v The location of the next state of the WHERESTATE specified, if the
TOLOCATION and TOSTATE are not specified.
Table 183. Volume destination and location
Parameters specified Destination state Destination location
WHERESTATE The next state of the
WHERESTATE
Location of the next state
WHERESTATE TOSTATE TOSTATE Location of the TOSTATE
WHERESTATE
TOLOCATION
The next state of the
WHERESTATE
TOLOCATON
WHERESTATE TOSTATE
TOLOCATION
TOSTATE TOLOCATION
TOSTATE TOSTATE Location of the TOSTATE
TOSTATE
WHERELOCATION
TOSTATE Location of the TOSTATE
TOSTATE
WHERELOCATION
TOLOCATION
TOSTATE TOLOCATION

Rules for state transitions
The following tables show the state transitions that volumes are eligible for, based
on their current state.
Table 184. State transitions for volumes
Volumes current
state
Destination state
MOUNTABLE NOTMOUNTABLE COURIER VAULT
MOUNTABLE N Y Y Y
NOTMOUNTABLE N N Y Y
COURIER N N N Y
VAULT N N N N
VAULTRETRIEVE N N N N
COURIERRETRIEVE N N N N
ONSITERETRIEVE N N N N

MOVE DRMEDIA
Chapter 2. Administrative commands 595
Volumes current
state
Destination state
VAULT-RETRIEVE
COURIER-
RETRIEVE ONSITE-RETRIEVE
MOUNTABLE N N N
NOTMOUNTABLE N N N
COURIER N N N
VAULT N N N
VAULTRETRIEVE N Y Y
COURIERRETRIEVE N N Y
ONSITERETRIEVE N N N

Examples
Task
Move DRM media that is in the NOTMOUNTABLE state to the COURIER state.
Command
move drmedia * wherestate=notmountable
tostate=courier

query actlog search="MOVE DRMEDIA"
Output
08/11/1999 11:12:24 ANR0984I Process 10 for MOVE DRMEDIA started
in the BACKGROUND at 11:12:24.
08/11/1999 11:12:24 ANR0610I MOVE DRMEDIA started by HSIAO as
process 10.
08/11/1999 11:12:25 ANR6683I MOVE DRMEDIA: Volume TAPE0P was moved
from NOTMOUNTABLE state to COURIER.
08/11/1999 11:12:25 ANR6683I MOVE DRMEDIA: Volume TAPE1P was moved
from NOTMOUNTABLE state to COURIER.
08/11/1999 11:12:25 ANR6683I MOVE DRMEDIA: Volume DBTP02 was moved
from NOTMOUNTABLE state to COURIER.
08/11/1999 11:12:25 ANR6683I MOVE DRMEDIA: Volume DBTP01 was moved
from NOTMOUNTABLE state to COURIER.
08/11/1999 11:12:25 ANR6682I MOVE DRMEDIA command ended: 4 volumes
processed.
08/11/1999 11:12:25 ANR0611I MOVE DRMEDIA started by HSIAO as
process 10 has ended.
08/11/1999 11:12:25 ANR0985I Process 10 for MOVE DRMEDIA running in
the BACKGROUND processed 4 items with a
completion state of SUCCESS at 11:12:25.

Task
Move DRM media from the MOUNTABLE state to the COURIER state. If the
media is in an automated library, MOVE DRMEDIA ejects the media before
changing the state.
Command
move drmedia * wherestate=mountable tostate=courier wait=yes
Output
MOVE DRMEDIA

596 IBM Tivoli Storage Manager for Windows: Administrators Reference
ANR0984I Process 12 for MOVE DRMEDIA started
in the FOREGROUND at 09:57:17.
ANR0609I MOVE DRMEDIA started as process 12.
ANR0610I MOVE DRMEDIA started by HSIAO as
process 12.
ANR6696I MOVE DRMEDIA: CHECKOUT LIBVOLUME for
volume TAPE01 in library LIB8MM starting.
ANR6697I MOVE DRMEDIA: CHECKOUT LIBVOLUME for
volume TAPE01 in library LIB8MM completed
successful.
ANR6683I MOVE DRMEDIA: Volume TAPE01 was moved
from MOUNTABLE state to COURIER.
ANR6696I MOVE DRMEDIA: CHECKOUT LIBVOLUME for
volume TAPE02 in library LIB8MM starting.
ANR6697I MOVE DRMEDIA: CHECKOUT LIBVOLUME for
volume TAPE02 in library LIB8MM completed
successful.
ANR6683I MOVE DRMEDIA: Volume TAPE02 was moved
from MOUNTABLE state to COURIER.
ANR6696I MOVE DRMEDIA: CHECKOUT LIBVOLUME for
volume DBTP05 in library LIB8MM starting.
ANR6697I MOVE DRMEDIA: CHECKOUT LIBVOLUME for
volume DBTP05 in library LIB8MM completed
successful.
ANR6683I MOVE DRMEDIA: Volume DBTP05 was moved
from MOUNTABLE state to COURIER.
ANR6696I MOVE DRMEDIA: CHECKOUT LIBVOLUME for
volume DBTP04 in library LIB8MM starting.
ANR6697I MOVE DRMEDIA: CHECKOUT LIBVOLUME for
volume DBTP04 in library LIB8MM completed
successful.
ANR6683I MOVE DRMEDIA: Volume DBTP04 was moved
from MOUNTABLE state to COURIER.
ANR6682I MOVE DRMEDIA command ended: 4 volumes
processed.
ANR0611I MOVE DRMEDIA started by HSIAO as
process 12 has ended.
ANR0985I Process 12 for MOVE DRMEDIA running
in the FOREGROUND processed 4 items with a
completion state of SUCCESS at 10:12:25.

Task
Move DRM media that is in the VAULTRETRIEVE state to the ONSITERETRIEVE
state, and generate a CHECKIN LIBVOLUME command for each volume
successfully processed in a file, c:\drm\move\exec.cmd.
Command
move drmedia * wherestate=vaultretrieve tostate=onsiteretrieve
cmdfilename=c:\drm\move\exec.cmd
cmd="checkin libvol lib8mm &vol status=scratch"
query actlog search="MOVE DRMEDIA"
Output
MOVE DRMEDIA
Chapter 2. Administrative commands 597
08/13/1999 09:12:24 ANR0984I Process 15 for MOVE DRMEDIA started in
the BACKGROUND at 09:12:24.
08/13/1999 09:12:24 ANR0610I MOVE DRMEDIA started by HSIAO as
process 15.
08/13/1999 09:12:24 ANR6684I MOVE DRMEDIA: Volume CSTP01 was deleted.
08/13/1999 09:12:24 ANR6684I MOVE DRMEDIA: Volume CSTP02 was deleted.
08/13/1999 09:12:24 ANR6684I MOVE DRMEDIA: Volume DBTP10 was deleted.
08/13/1999 09:12:24 ANR6684I MOVE DRMEDIA: Volume DBTP11 was deleted.
08/13/1999 09:12:27 ANR6682I MOVE DRMEDIA command ended: 4 volumes
processed.
08/13/1999 09:12:42 ANR0611I MOVE DRMEDIA started by HSIAO as process
15 has ended.
08/13/1997 09:12:42 ANR0985I Process 15 for MOVE DRMEDIA running in
the BACKGROUND processed 4 items with a
completion state of SUCCESS at 09:12:42.

MOVE DRMEDIA also created commands in c:\drm\move\exec.cmd:
checkin libvol lib8mm CSTP01 status=scratch
checkin libvol lib8mm CSTP02 status=scratch
checkin libvol lib8mm DBTP10 status=scratch
checkin libvol lib8mm DBTP11 status=scratch

Note: To process the CHECKIN LIBVOLUME commands, issue the MACRO
command with c:\drm\move\exec.cmd as the macro name.
Related commands
Table 185. Commands related to MOVE DRMEDIA
Command Description
BACKUP DB Backs up the IBM Tivoli Storage Manager
database to sequential access volumes.
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
CANCEL PROCESS Cancels a background server process.
CHECKOUT LIBVOLUME Checks a storage volume out of an
automated library.
DISMOUNT VOLUME Dismounts a sequential, removable volume
by the volume name.
PREPARE Creates a recovery plan file.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY DRMSTATUS Displays DRM system parameters.
QUERY PROCESS Displays information about background
processes.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
SET DRMCOPYSTGPOOL Specifies that copy storage pools are
managed by DRM.
SET DRMCOURIERNAME Specifies the name of the courier for the
disaster recovery media.
SET DRMDBBACKUPEXPIREDAYS Specifies criteria for database backup series
expiration.
MOVE DRMEDIA

598 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 185. Commands related to MOVE DRMEDIA (continued)
Command Description
SET DRMVAULTNAME Specifies the name of the vault where DRM
media is stored.
SET DRMCMDFILENAME Specifies a file name for containing DRM
executable commands.
SET DRMFILEPROCESS Specifies whether the MOVE DRMEDIA or
QUERY DRMEDIA command processes files
associated with a device type of file.
SET DRMNOTMOUNTABLENAME Specifies the location name of the DRM
media to be sent offsite.

MOVE DRMEDIA
Chapter 2. Administrative commands 599
MOVE GRPMEMBER (Move a server group member)
Use this command to move a member from one server group to another server
group. The command fails if the member you are moving has the same name as a
current member of the group.
Privilege class
To issue this command, you must have system privilege.
Syntax
MOVe GRPMEMber member_name from_group to_group

Parameters
member_name (Required)
Specifies the member (a server or a server group) to move.
from_group (Required)
Specifies the server group with which the member is currently associated.
to_group (Required)
Specifies the new server group for the member.
Examples
Task
Move member PAYSON from REGION1 group to REGION2 group.
Command
move grpmember payson region1 region2
Related commands
Table 186. Commands related to MOVE GRPMEMBER
Command Description
DEFINE GRPMEMBER Defines a server as a member of a server
group.
DEFINE SERVERGROUP Defines a new server group.
DELETE GRPMEMBER Deletes a server from a server group.
DELETE SERVERGROUP Deletes a server group.
QUERY SERVER Displays information about servers.
QUERY SERVERGROUP Displays information about server groups.
RENAME SERVERGROUP Renames a server group.
UPDATE SERVERGROUP Updates a server group.

MOVE GRPMEMBER

600 IBM Tivoli Storage Manager for Windows: Administrators Reference
MOVE MEDIA (Move sequential access storage pool media)
Use this command to manage overflow storage pools. The database tracks media
that has been moved using this command.
This command applies to sequential access primary and copy storage pool volumes
that are managed by an automated library (including an external library). The
library does not have to be full. One or more sequential access storage pool
volumes can be processed at the same time.
Use the DAYS parameter to identify eligible volumes to be moved. Use the
OVERFLOW LOCATION parameter to record the storage location for the moved
media.
This command generates a background process that you can view using the
QUERY PROCESS command. To cancel, issue the CANCEL PROCESS command.
To determine if the command was successful, issue the QUERY ACTLOG
command or use the server console.
The volumes moved by the MOVE DRMEDIA command for offsite recovery are
not processed by the MOVE MEDIA command.
For additional information see the Administrators Guide.
Privilege class
To issue this command, you must have one of the following privilege classes:
v If the CMD parameter is NOT specified: Operator or system privilege.
v If the CMD parameter is specified and the REQSYSAUTHOUTFILE server option is
set to NO: Operator, unrestricted storage, or system privilege.
v If the CMD parameter is specified and the REQSYSAUTHOUTFILE server option is
set to YES (the default): System privilege.
Syntax

MOVe MEDia

volume_name

STGpool

=

pool_name
Days = 0
Days

=

days

WHERESTate

=

MOUNTABLEInlib

MOUNTABLENotinlib

,

WHERESTATUs

=

FULl

FILling

EMPty

ACCess

=

READWrite

READOnly

MOVE MEDIA
Chapter 2. Administrative commands 601

OVFLOcation

=

location
REMove = Bulk
REMove

=

No

Yes

Bulk

CMd

=

command

CMDFilename

=

file_name
APPend = No
APPend

=

No

Yes

CHECKLabel = Yes
CHECKLabel

=

Yes

No

CAP

=

x,y,z

Parameters
volume_name (Required)
Specifies the name of the sequential access primary or copy storage pool
volume to be processed. You can use a wildcard character to specify the name.
All matching volumes are considered for processing.
STGpool (Required)
Specifies the name of the sequential access primary or copy storage pool that is
used to select the volumes for processing. You can use a wildcard character to
specify the name. All matching storage pools are processed. If the storage pool
specified is not managed by an automated library, no volumes are processed.
Days
Specifies the number of days that must elapse after the volume has been
written or read, before the volume is eligible for processing by the command.
This parameter is optional. You can specify a number from 0 to 9999. The
default value is 0. The most recent of the volumes last written date or last
read date is used to calculate the number of days elapsed.
WHERESTate
Specifies the current state of the volumes to be processed. This parameter is
used to restrict processing to the volumes that are in the specified state. This
parameter is optional. The default value is MOUNTABLEINLIB.
Possible values are:
MOUNTABLEInlib
Specifies that storage pool volumes are to transition from the
MOUNTABLEINLIB state to the MOUNTABLENOTINLIB state. Volumes
in the MOUNTABLEINLIB state contain valid data and are in the library.
MOUNTABLENotinlib
Specifies that storage pool volumes are to change from the
MOUNTABLENOTINLIB state back to the MOUNTABLEINLIB state.
Volumes in the MOUNTABLENOTINLIB state may contain valid data and
are in the overflow location.
v For empty scratch volumes, the MOVE MEDIA command deletes the
volume records so that they can be used again.
v For private volumes, the MOVE MEDIA command resets the volume
location to blank, changes the volumess state to CHECKIN, and changes
the last update date to the current date.
MOVE MEDIA

602 IBM Tivoli Storage Manager for Windows: Administrators Reference
v For scratch volumes with data, the MOVE MEDIA command resets the
volume location to blank, changes the volumess state to CHECKIN, and
changes the last update date to the current date.
Note: Volumes in the CHECKIN state may contain valid data and need to
be checked into the library.
WHERESTATUs
Specifies that the move process should be restricted by volume status. This
parameter is optional. You can specify more than one status in a list by
separating each status with a comma and no intervening spaces. If you do not
specify this parameter, volumes moved from the MOUNTABLEINLIB state to
the MOUNTABLENOTINLIB state are restricted to only full volumes, and
volumes moved from the MOUNTABLENOTINLIB state to the
MOUNTABLEINLIB state are restricted to only empty volumes.
Possible values are:
FULl
Moves volumes with a status of FULL.
FILling
Moves volumes with a status of FILLING.
EMPty
Moves volumes with a status of EMPTY.
ACCess
Specifies how users and system processes access files in the storage pool
volume that is moved out from an automated library and stored in an
overflow location by the MOVE MEDIA command. This parameter is optional.
If you do not specify this parameter, moving volumes from the
MOUNTABLEINLIB state to the MOUNTABLENOTINLIB process updates
volumes access mode to READONLY, and moving volumes from the
MOUNTABLENOTINLIB state to the MOUNTABLEINLIB process updates the
volumes access mode to READWRITE.
Possible values are:
READWrite
Specifies that users and system processes can read from and write to files
stored on the volume that is in the overflow location. If this value is
specified, Tivoli Storage Manager requests the volume to be checked into
the library when the volume is needed for a read or write operation.
READOnly
Specifies that users and system processes can only read files that are stored
on the volume that is in the overflow location. The server requests the
volume to be checked into the library only when the volume is needed for
a read operation.
OVFLOcation
Specifies the overflow location that is the destination of the volumes being
processed. The maximum length of the location name is 255 characters. The
location name information must be enclosed in quotation marks if it contains
any blank characters. If you do not specify an overflow location and the
storage pool also has no overflow location identified, the server changes the
location of the ejected volume to a null string ().
REMove
Specifies whether Tivoli Storage Manager ejects the volumes from the library
MOVE MEDIA
Chapter 2. Administrative commands 603
when moving volumes from the MOUNTABLEINLIB state. This parameter is
optional. Possible values are YES, BULK, and NO. The default is YES. The
response of the server to each option depends on the type of library.
349X Libraries:The following table shows how the server responds for 349X
libraries.
Table 187. How theTivoli Storage Manager Server Responds for 349X Libraries
REMOVE=YES or REMOVE=NO REMOVE=BULK
The 3494 Library Manager ejects the cartridge to the
convenience I/O station. The server then deletes the
volume entry from the server library inventory. This
option applies to all automated libraries.
The 3494 Library Manager ejects the cartridge to the
high-capacity output facility.

SCSI libraries: The following table shows how the server responds to YES,
BULK, and NO for SCSI libraries.
Table 188. How theTivoli Storage Manager Server Responds for SCSI Libraries
If a library . . . And REMOVE=YES. . . And REMOVE=BULK... And REMOVE=NO
Does not have entry/exit
ports
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server then prompts
you to remove the cartridge
from the slot and issue a
REPLY command.
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server does not prompt
you to remove the cartridge
and does not require a
REPLY command.
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server does not prompt
you to remove the cartridge
and does not require a
REPLYcommand.
Has entry/exit ports and an
entry/exit port is available
The server moves the
cartridge to the available
entry/exit port and
specifies the port address in
a message.
The server then prompts
you to remove the cartridge
from the slot and issue a
REPLY command.
The server moves the
cartridge to the available
entry/exit port and
specifies the port address in
a message.
The server does not prompt
you to remove the cartridge
and does not request a
REPLY command.
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server does not prompt
you to remove the cartridge
and does not require a
REPLY command.
Has entry/exit ports, but no
ports are available
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server then prompts
you to remove the cartridge
from the slot and issue a
REPLY command.
The server waits for an
entry/exit port to be made
available.
The server leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
The server does not prompt
you to remove the cartridge
and does not require a
REPLY command.

ACSLS libraries: The following table shows how the server responds for
ACSLS libraries.
MOVE MEDIA

604 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 189. How theTivoli Storage Manager Server Responds for ACSLS Libraries
REMOVE=YES or REMOVE=BULK REMOVE=NO
The server ejects the cartridge to the convenience I/O
station.
The server then deletes the volume entry from the server
library inventory.
While moving volumes from the MOUNTABLE state with
REMOVE=YES specified, the MOVE MEDIA command
uses more than one slot in the CAP for a StorageTek
library with ACSLS.
The server does not eject the cartridge.
The server deletes the volume entry from the server
library inventory and leaves the volume in the library.

External libraries: The following table shows how the server responds for
external libraries.
Table 190. How theTivoli Storage Manager Server Responds for External Libraries
REMOVE=YES or REMOVE=BULK REMOVE=NO
The server ejects the cartridge to the convenience I/O
station. The server then deletes the volume entry from the
server library inventory.
The server does not eject the cartridge.
The server deletes the volume entry from the server
library inventory and leaves the volume in the library.

RSM libraries: The following table shows how the server responds for RSM
libraries.
Table 191. How theTivoli Storage Manager Server Responds for RSM Libraries
REMOVE=YES or REMOVE=BULK REMOVE=NO
The server ejects the cartridge to the convenience I/O
station.
The server then deletes the volume entry from the server
library inventory.
The server does not eject the cartridge.
The server deletes the volume entry from the server
library inventory and leaves the volume in the library.

CMd
Specifies the creation of executable commands. This parameter is optional. You
must enclose your command specification in quotation marks. The maximum
length of the command specification is 255 characters. For each volume
successfully processed by the MOVE MEDIA command, Tivoli Storage
Manager writes the associated commands to a file. Specify the file name with
the CMDFILENAME parameter. If you do not specify the file name, the MOVE
MEDIA command will generate a default file name by appending the string
exec.cmd.media to the Tivoli Storage Manager server directory.
If the length of the command written to the file exceeds 255 characters, it is
split into multiple lines and a continuation character, +, is added to all but the
last line of the command. You may need to alter the continuation character
according to the requirements of the product that executes the commands.
If you do not specify CMD, the MOVE MEDIA command will not generate
any executable commands.
string
Specifies the string to build an executable command. You can specify any
free form text for the string. Enclose the full string in quotation marks. For
example, the following is a valid executable command specification:
CMD="UPDATE VOLUME &VOL"
MOVE MEDIA
Chapter 2. Administrative commands 605
The following is an invalid executable command specification:
CMD=""UPDATE VOLUME" &VOL"
substitution
Specifies a variable for which you want the command to substitute a value.
The possible substitution variables are:
&VOL
Substitute the volume name for &VOL. You can specify lowercase
characters, &vol. No spaces or blanks are allowed between ampersand,
&, and VOL. If there are spaces or blanks between ampersand and
VOL, the MOVE MEDIA command will treat them as strings and no
substitution will be set. If &VOL is not specified, no volume name is
set in the executable command.
&LOC
Substitute the volume location for &LOC. You can specify lowercase
characters, &loc. No spaces or blanks are allowed between ampersand,
&, and LOC. If there are spaces or blanks between ampersand and
LOC, the MOVE MEDIA command will treat them as strings and no
substitution will be set. If &LOC is not specified, no location name is
set in the executable command.
&VOLDSN
Substitute the volume file name for &VOLDSN. An example of a
storage pool tape volume file name using the default prefix ADSM is
ADSM.BFS. If &VOLDSN is not specified, no volume file name is set
in the executable command.
&NL
Substitute a new line character for &NL. When &NL is specified, the
MOVE MEDIA command splits the command at the position where the
&NL is and will not append any continuation character. The user is
responsible for specifying the proper continuation character before the
&NL if one is required. The user is also responsible for the length of
the line written. If the &NL is not specified and the length of the
command line exceeds 255, the command line is split into multiple
lines and a continuation character, +, is added to all but the last line of
the command.
CMDFilename
Specifies the full path name of a file that will contain the commands specified
with CMD. This parameter is optional. The maximum length of the file name
is 1279 characters. If you do not specify a file name, the MOVE MEDIA
command will generate a default file name by appending the string
exec.cmd.media to the Tivoli Storage Manager server directory. The server
directory is determined in the following order:
1. If defined, the directory pointed to by the DSMSERV_DIR environment
variable.
2. If the DSMSERV_DIR environment variable is not defined, the current
working directory of the Tivoli Storage Manager server process.
The MOVE MEDIA command automatically allocates the file name specified or
generated. If the file name exists, you can use the APPEND=YES parameter to
add to the file. Otherwise, the file is overwritten. If a file is accidentally
overwritten and you need to run the commands that had been in the file, issue
the QUERY MEDIA command to rebuild the executable commands for the
desired volumes. If the MOVE MEDIA command fails after the command file
is allocated, the file is not deleted.
MOVE MEDIA

606 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
APPend
Specifies to write at the beginning or ending of the command file data. The
default is NO. Possible values are:
No
Specifies to write the data from the beginning of the command file. If the
given command file exists, its contents are overwritten.
Yes
Specifies to append the command file by writing at the end of the
command file data.
CHECKLabel
Specifies whether Tivoli Storage Manager should read volume labels for
sequential media. For SCSI devices you can suppress label checking by setting
the CHECKLabel to NO. This parameter is not applicable to 349X libraries.
This parameter is optional. The default is NO. Possible values are:
Yes
Specifies that Tivoli Storage Manager attempts to read the media label.
Reading the media label verifies that the correct volume is being checked
out.
No
Specifies that Tivoli Storage Manager does not attempt to read media label.
This increases performance because the read process does not occur.
CAP
Specifies which cartridge access port (CAP) to use for ejecting volumes if you
specify REMOVE=YES. This parameter applies to volumes in ACSLS libraries
only. If a CAP priority greater than zero does not exist in the library, this
parameter is required. If a CAP priority greater than zero does exist in the
library, this parameter is optional. If you do not specify the parameter, the
ACSLS server will choose any available CAP with a priority greater than zero.
To display valid CAP identifiers (x,y,z), issue the QUERY CAP command with
ALL specified from the Automated Cartridge System System Administrator
(ACSSA) console on the ACSLS server host. The identifiers are as follows:
x The Automated Cartridge System (ACS) ID. This identifier can be a
number between 0-126.
y The Library Storage Module (LSM) ID. This identifier can be a number
between 0-23.
z The CAP ID. This identifier can be a number between 0-2.
For more information, refer to your StorageTek documentation.
Examples
Task
Move all full volumes that are in the ARCHIVE sequential primary storage pool
out of the library.
Command
move media * stgpool=archive
Task
MOVE MEDIA
Chapter 2. Administrative commands 607
Generate the CHECKIN LIBVOLUME commands for full and partially full
volumes that are in the ONSITE.ARCHIVE primary storage pool and stored in the
overflow location, Room 2948/Bldg31.
Command
move media * stgpool=onsite.archive
wherestate=mountablenotinlib wherestatus=full,filling
ovflocation=room2948/bldg31
cmd="checkin libvol lib3494 &vol status=private"
cmdfilename=/tsm/move/media/checkin.vols
Output
MOVE MEDIA creates the executable commands in c:\tsm\move\media\
checkin.vols:
checkin libvolume lib3494 TAPE04 status=private
checkin libvolume lib3494 TAPE13 status=private
checkin libvolume lib3494 TAPE14 status=private

Note: Run the CHECKIN LIBVOLUME commands by issuing the MACRO
command with c:\tsm\move\media\checkin.vols as the macro name.
Related commands
Table 192. Commands related to MOVE MEDIA
Command Description
CANCEL PROCESS Cancels a background server process.
QUERY MEDIA Displays information about storage pool
volumes moved by the MOVE MEDIA
command.
QUERY PROCESS Displays information about background
processes.

MOVE MEDIA

608 IBM Tivoli Storage Manager for Windows: Administrators Reference
MOVE NODEDATA (Move data by node in a sequential access
storage pool)
Use this command to move data located in a sequential-access storage pool. You
can move data for one or more nodes or for a group of collocated nodes. You can
also move selected file spaces for a single node. The data can be located in a
primary storage pool, a copy storage pool, or an active-data pool.
This command is helpful for reducing the number of volume mounts during client
restore or retrieve operations by consolidating data for a specific node within a
storage pool, or to move data to another storage pool. For example, you can use
this command for moving data to a random-access storage pool in preparation for
client restore processing.
Ensure that the access mode of the volumes from which you are moving the node
data is read/write or read-only and that the access mode of the volumes to which
you are moving the node data is set to read/write. This operation will not move
data on volumes with access modes of offsite, unavailable, or destroyed.
The MOVE NODEDATA command takes two forms, depending on whether you
are moving data only for selected filespaces. The syntax and parameters for each
form are defined separately.
Note: You cannot move node data into or out of a storage pool defined with a
CENTERA device class.
Table 193. Commands related to MOVE NODEDATA
Command Description
CANCEL PROCESS Cancels a background server process.
COPY ACTIVEDATA Copies active backup data.
DEFINE COLLOCGROUP Defines a collocation group.
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
DELETE COLLOCGROUP Deletes a collocation group.
DELETE COLLOCMEMBER Deletes a client node from a collocation
group.
MOVE DATA Moves data from a specified storage pool
volume to another storage pool volume.
QUERY ACTLOG Displays messages from the server activity
log.
QUERY COLLOCGROUP Displays information about collocation
groups.
QUERY FILESPACE Displays information about data in filespaces
that belong to a client.
QUERY NODEDATA Displays information about the location and
size of data for a client node.
QUERY OCCUPANCY Displays file space information by storage
pool.
QUERY PROCESS Displays information about background
processes.
QUERY STGPOOL Displays information about storage pools.
QUERY VOLUME Displays information about storage pool
volumes.
MOVE NODEDATA
Chapter 2. Administrative commands 609
Table 193. Commands related to MOVE NODEDATA (continued)
Command Description
UPDATE COLLOCGROUP Updates the description of a collocation
group.
MOVE NODEDATA

610 IBM Tivoli Storage Manager for Windows: Administrators Reference
MOVE NODEDATA all file spaces for one or more nodes
Use this command to move data in file spaces belonging to one or more nodes, or
to move data in file spaces belonging to a collocation group. A collocation group is a
group of nodes whose data is collocated on a minimal number of sequential access
volumes.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the source storage pool. If your
authorization is restricted storage privilege and you intend to move data to
another storage pool, you must also have the appropriate authority for the
destination storage pool.
Syntax

,
MOVe NODEdata

node_name

COLLOCGroup

=

group_name

FROMstgpool = source_pool_name
TOstgpool

=

destination_pool_name

Type = ANY
Type

=

ANY

Backup

ARchive

SPacemanaged
MAXPRocess = 1
MAXPRocess

=

num_processes

Wait

=

No

Wait

=

No

Yes
(1)
RECONStruct

=

No or Yes

RECONStruct

=

No

Yes

Notes:
1 The default is NO if either the source or target storage pool is random access.
The default is YES if both the source and target storage pools are sequential
access.
Parameters
node_name (Required unless the COLLOCGROUP parameter is specified)
Specifies the node name related to the data that is moved with this command.
Separate multiple names with commas and no intervening spaces. You can use
wildcard characters to specify names.
COLLOCGroup (Required unless the node_name parameter is specified)
Specifies the name of the collocation group whose data is to be moved. Data
for all the nodes belonging to the collocation group will be moved.
MOVE NODEDATA One or More Nodes
Chapter 2. Administrative commands 611
FROMstgpool (Required)
Specifies the name of a sequential-access storage pool that contains data to be
moved. This storage pool must be in the NATIVE or NONBLOCK data format.
TOstgpool
Specifies the name of a storage pool to which data will be moved. This storage
pool must be in the NATIVE or NONBLOCK data format. This parameter is
optional and does not apply when the source storage pool is a copy storage
pool or an active-data pool. That is, if the source storage pool is a copy storage
pool the destination must be the same copy storage pool. Similarly, if the
source storage pool is an active-data pool, the destination must be the same
active-data pool. If a value is not specified, data is moved to other volumes
within the source pool.
Note: If you are moving data within the same storage pool, there must be
volumes available that do not contain the node data you are moving.
That is, the server cannot use volumes that contain the data to be moved
as destination volumes.
Type
Specifies the type of files to be moved. This parameter is optional. The default
value is ANY. If the source storage pool is an active-data pool, the only valid
values are ANY and BACKUP. However, only the active versions of backup
data are moved if TYPE=ANY. Possible values are:
ANY
Specifies that all types of files are moved.
Backup
Specifies that backup files are moved.
ARchive
Specifies that archive files are moved. This value is not valid for
active-data pools.
SPacemanaged
Specifies that space-managed files are moved. This value is not valid for
active-data pools.
MAXPRocess
Specifies the maximum number of parallel processes to use for moving data.
This parameter is optional. You can specify a value from 1999, inclusive. The
default value is 1. Increasing the number of parallel processes should improve
throughput.
When determining this value, consider the number of logical and physical
drives that can be dedicated to this operation. To access a sequential access
volume, Tivoli Storage Manager uses a mount point and, if the device type is
not FILE, a physical drive. The number of available mount points and drives
depends on other Tivoli Storage Manager and system activity and on the
mount limits of the device classes for the sequential access storage pools that
are involved in the move. Each process needs a mount point for storage pool
volumes, and, if the device type is not FILE, each process also needs a drive.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default value is No. Possible
values are:
No
Specifies that the server processes this command in the background. You
MOVE NODEDATA One or More Nodes

612 IBM Tivoli Storage Manager for Windows: Administrators Reference
can continue with other tasks while the command is being processed. The
server displays messages that are created from the background process
either in the activity log or the server console, depending on where
messages are logged.
To cancel a background process, use the CANCEL PROCESS command. If
a background process is canceled, some files may have already been
moved before the cancellation.
Yes
Specifies that the server processes this command in the foreground. You
wait for the command to complete before continuing with other tasks. The
server then displays the output messages to the administrative client when
the command completes.
Note: You cannot specify WAIT=YES from the server console.
RECONStruct
Specifies whether to reconstruct file aggregates during data movement.
Reconstruction removes empty space that has accumulated during deletion of
logical files from an aggregate. This parameter is optional. If both the source
and target storage pools are sequential access, the default value is YES. If
either the source or target storage pool is random access, the default is NO.
Possible values are:
No
Specifies that reconstruction of file aggregates will not be performed
during the move.
Yes
Specifies that reconstruction of file aggregates will be performed during the
move. You may only specify this option when both the source and the
target storage pools are sequential-access.
Attention: Reconstruction removes inactive backup files in active-data pools.
Specifying RECONSTRUCT=NO when moving data from volumes in an
active-data pool will prevent the inactive backup files from being removed.
Examples
Task
Move all data belonging to node MARY that is stored in storage pool TAPEPOOL.
Data should be moved to disk storage pool BACKUPPOOL.
Command
move nodedata mary
fromstgpool=tapepool tostgpool=backuppool
MOVE NODEDATA One or More Nodes
Chapter 2. Administrative commands 613
MOVE NODEDATA selected file spaces for one node
Use this command to move data for selected filespaces belonging to a single node.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the source storage pool. If your
authorization is restricted storage privilege and you intend to move data to
another storage pool, you must also have the appropriate authority for the
destination storage pool.
Syntax
MOVe NODEdata node_name FROMstgpool = source_pool_name

TOstgpool

=

destination_pool_name

,

FIlespace

=

file_space_name

,

UNIFILESpace

=

unicode_filespace_name

,

FSID

=

filespace_identifier
Type = ANY
Type

=

ANY

Backup

ARchive

SPacemanaged

MAXPRocess = 1
MAXPRocess

=

num_processes
Wait = No
Wait

=

No

Yes

(1)
RECONStruct

=

No or Yes

RECONStruct

=

No

Yes

MOVE NODEDATA For a Single Node with Selected Filespaces

614 IBM Tivoli Storage Manager for Windows: Administrators Reference
Notes:
1 The default is NO if either the source or target storage pool is random access.
The default is YES if both the source and target storage pools are sequential
access.
Parameters
node_name (Required)
Specifies the node name related to the data that is moved with this command.
Separate multiple names with commas and no intervening spaces. You can use
wildcard characters to specify names.
FROMstgpool (Required)
Specifies the name of a sequential-access storage pool that contains data to be
moved. This storage pool must be in the NATIVE or NONBLOCK data format.
TOstgpool
Specifies the name of a storage pool to which data will be moved. This storage
pool must be in the NATIVE or NONBLOCK data format. This parameter is
optional and does not apply when the source storage pool is a copy storage
pool or an active-data pool. That is, if the source storage pool is a copy storage
pool the destination must be the same copy storage pool. Similarly, if the
source storage pool is an active-data pool, the destination must be the same
active-data pool. If a value is not specified, data is moved to other volumes
within the source pool.
Note: If you are moving data within the same storage pool, there must be
volumes available that do not contain the node data you are moving.
That is, the server cannot use volumes that contain the data to be moved
as destination volumes.
FILespace
Specifies the name of the non-Unicode filespace that contains data to be
moved. Separate multiple names with commas and no intervening spaces. You
can use wildcard characters to specify names. This parameter is optional. If
you do not specify a value for this parameter and values for UNIFILESPACE
or the FSID or both, non-Unicode filespaces are not moved.
UNIFILESpace
Specifies the name of the Unicode filespace that contains data to be moved.
Separate multiple names with commas and no intervening spaces. You can use
wildcard characters to specify names. This parameter is optional. If you do not
specify a value for this parameter and values for FILESPACE or the FSID or
both, non-Unicode filespaces are not moved.
FSID
Specifies file space identifiers (FSIDs) for the file spaces to be moved. Separate
multiple names with commas and no intervening spaces. This parameter is
optional.
Type
Specifies the type of files to be moved. This parameter is optional. The default
value is ANY. If the source storage pool is an active-data pool, the only valid
values are ANY and BACKUP. However, only the active versions of backup
data are moved if TYPE=ANY. Possible values are:
ANY
Specifies that all types of files are moved.
MOVE NODEDATA For a Single Node with Selected Filespaces
Chapter 2. Administrative commands 615
Backup
Specifies that backup files are moved.
ARchive
Specifies that archive files are moved. This value is not valid for
active-data pools.
SPacemanaged
Specifies that space-managed files are moved. This value is not valid for
active-data pools.
MAXPRocess
Specifies the maximum number of parallel processes to use for moving data.
This parameter is optional. You can specify a value from 1999, inclusive. The
default value is 1. Increasing the number of parallel processes should improve
throughput.
When determining this value, consider the number of logical and physical
drives that can be dedicated to this operation. To access a sequential access
volume, Tivoli Storage Manager uses a mount point and, if the device type is
not FILE, a physical drive. The number of available mount points and drives
depends on other Tivoli Storage Manager and system activity and on the
mount limits of the device classes for the sequential access storage pools that
are involved in the move. Each process needs a mount point for storage pool
volumes, and, if the device type is not FILE, each process also needs a drive.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default value is No. Possible
values are:
No
Specifies that the server processes this command in the background. You
can continue with other tasks while the command is being processed. The
server displays messages that are created from the background process
either in the activity log or the server console, depending on where
messages are logged.
To cancel a background process, use the CANCEL PROCESS command. If
a background process is canceled, some files may have already moved
before the cancellation.
Yes
Specifies that the server processes this command in the foreground. You
wait for the command to complete before continuing with other tasks. The
server then displays the output messages to the administrative client when
the command completes.
Note: You cannot specify WAIT=YES from the server console.
RECONStruct
Specifies whether to reconstruct file aggregates during data movement.
Reconstruction removes empty space that has accumulated during deletion of
logical files from an aggregate. This parameter is optional. If both the source
and target storage pools are sequential access, the default value is YES. If
either the source or target storage pool is random access, the default is NO.
Possible values are:
No
Specifies that reconstruction of file aggregates will not be performed
during the move.
MOVE NODEDATA For a Single Node with Selected Filespaces

616 IBM Tivoli Storage Manager for Windows: Administrators Reference
Yes
Specifies that reconstruction of file aggregates will be performed during the
move. You may only specify this option when both the source and the
target storage pools are sequential-access.
Attention: Reconstruction removes inactive backup files in active-data pools.
Specifying RECONSTRUCT=NO when moving data from volumes in an
active-data pool will prevent the inactive backup files from being removed.
Examples
Task
Move data for node TOM in storage pool TAPEPOOL. Restrict movement of data
to files in non-Unicode filespaces as well as Unicode filespaces \\jane\d$. Data
should be moved to disk storage pool BACKUPPOOL.
Command
move nodedata tom
fromstgpool=tapepool tostgpool=backuppool
filespace=* unifilespace=\\jane\d$
Task
Move all data for node SARAH, from all primary sequential-access storage pools
(for this example, TAPEPOOL*) to DISKPOOL.
Note: To obtain a list of storage pools that contain data for node SARAH, issue
either the QUERY OCCUPANCY command or the SELECT command:
query occupancy sarah
SELECT * from OCCUPANCY where node_name=sarah
For the example assume that the results were TAPEPOOL1, TAPEPOOL4, and
TAPEPOOL5.
Command
move nodedata sarah
fromstgpool=tapepool1 tostgpool=DISKPOOL

move nodedata sarah
fromstgpool=tapepool4 tostgpool=DISKPOOL

move nodedata sarah
fromstgpool=tapepool5 tostgpool=DISKPOOL
Task
The following is an example of moving non-Unicode and Unicode file spaces for a
node. For node NOAH move non-Unicode filespace \\servtuc\d$ and Unicode
file space \\tsmserv1\e$ that has a filespace ID of 2 from sequential access storage
pool TAPEPOOL to random access storage pool DISKPOOL.
Command
move nodedata noah
fromstgpool=tapepool tostgpool=diskpool
filespace=\\tsmserv1\d$ fsid=2
MOVE NODEDATA For a Single Node with Selected Filespaces
Chapter 2. Administrative commands 617
NOTIFY commands
Use the NOTIFY command on a configuration manager to notify one or more
managed servers to update their profile configuration information.
v NOTIFY SUBSCRIBERS (Notify managed servers to update profiles) on page
619
NOTIFY commands

618 IBM Tivoli Storage Manager for Windows: Administrators Reference
NOTIFY SUBSCRIBERS (Notify managed servers to update
profiles)
Use this command on a configuration manager to notify one or more managed
servers to request that their configuration information be immediately refreshed.
Privilege class
To issue this command, you must have system privilege.
Syntax

NOTIfy SUBSCRIBers

,
PROFIle

=

profile_name

Parameters
PROFIle (Required)
Specifies the name of the profile. Any managed servers that subscribe to the
profile are notified. You can use wildcard characters to specify multiple
profiles. To specify multiple profiles, separate the names with commas and no
intervening spaces.
Examples
Task
Notify all managed servers that subscribe to a profile named DELTA to request to
updated configuration information.
Command
notify subscribers profile=delta
Related commands
Table 194. Commands related to NOTIFY SUBSCRIBERS
Command Description
DEFINE SUBSCRIPTION Subscribes a managed server to a profile.
DELETE SUBSCRIBER Deletes obsolete managed server
subscriptions.
DELETE SUBSCRIPTION Deletes a specified profile subscription.
QUERY SUBSCRIBER Displays information about subscribers and
their subscriptions to profiles.
QUERY SUBSCRIPTION Displays information about profile
subscriptions.
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
SET CONFIGREFRESH Specifies a time interval for managed servers
to contact configuration managers.

NOTIFY SUBSCRIBERS
Chapter 2. Administrative commands 619
PARALLEL (Control running of multiple commands in a script)
Use this command to allow any following commands in the script to run in
parallel. When a script starts, all commands will run serially until a PARALLEL
command is encountered.
Note: Parallel commands accessing common resources, such as tape drives, can
run serially.
The script return code following a PARALLEL command will be the same as the
script return code prior to the PARALLEL command. When a SERIAL command is
encountered, the script return code will be set to the maximum return code from
any previous commands run in parallel.
When invoking server commands that support the WAIT parameter after a
PARALLEL command, the behavior is as follows:
v If you specify (or use the default) WAIT=NO, your script will not wait for the
completion of the command when a subsequent SERIAL command is
encountered and the return code from that command will reflect processing only
up to the point that the command starts a background process. The final return
code from the command will not be available to your script.
v If you specify WAIT=YES, your script will wait for the completion of the
command when a subsequent SERIAL command is encountered and the return
code from that command will reflect processing for the entire command.
In most cases, you should use WAIT=YES on commands being executed in parallel.
Privilege class
Any administrator can issue this command.
Syntax
PARALLEL

Parameters
None.
Examples
Task
Write a script named BACKUP to back up two storage pools simultaneously. When
both backups are complete, perform a snapshot database backup.
Script Contents
/* set up for running parallel commands */
PARALLEL
/* backup two storage pools simultaneously */
BACKUP STGPOOL PRIMPOOL1 COPYPOOL1 WAIT=YES
BACKUP STGPOOL PRIMPOOL2 COPYPOOL2 WAIT=YES
/* wait for all previous commands to finish and set up
running serial commands*/
SERIAL
/* start snapshot db backup */
BACKUP DB DEVCLASS=TAPE TYPE=DBSNAPSHOT WAIT=YES
PARALLEL

620 IBM Tivoli Storage Manager for Windows: Administrators Reference
Command
run backup
Related commands
Table 195. Commands related to PARALLEL
Command Description
DEFINE SCRIPT Defines a script to the IBM Tivoli Storage
Manager server.
RUN Runs a script.
SERIAL Run commands in a script serially.

PARALLEL
Chapter 2. Administrative commands 621
PING command
Use the PING SERVER command to test the connection between servers.
v PING SERVER (Test the connection between servers) on page 623
PING commands

622 IBM Tivoli Storage Manager for Windows: Administrators Reference
PING SERVER (Test the connection between servers)
Use this command to test the connection between the local server and a remote
server.
Attention: The name and password of the administrator client issuing this
command must also be defined on the remote server.
Privilege class
To issue this command, you must have system privilege.
Syntax
PING SERVER server_name

Parameters
server_name (Required)
Specifies the name of the remote server.
Examples
Task
Test the connection to server FRED.
Command
ping server fred
Related commands
Table 196. Commands related to PING SERVER
Command Description
DEFINE SERVER Defines a server for server-to-server
communications.
QUERY SERVER Displays information about servers.

PING SERVER
Chapter 2. Administrative commands 623
PREPARE (Create a recovery plan file)
Use this command to create a recovery plan file, which contains the information
needed to recover a Tivoli Storage Manager server. You can store a recovery plan
file on a file system that is accessible to the source Tivoli Storage Manager server
or on a target Tivoli Storage Manager server.
You can use the QUERY ACTLOG command to view whether the PREPARE
command was successful. You can also view this information from the server
console or, if the WAIT parameter equals YES, an administrative client session.
Privilege class
To issue this command, you must have system privilege.
Syntax

Prepare
Source = DBBackup
Source

=

DBBackup

DBSnapshot

DEVclass

=

device_class_name

PLANPrefix

=

prefix

INSTRPrefix

=

prefix

,

COPYstgpool

=

pool_name

,

PRIMstgpool

=

pool_name

Wait = No
Wait

=

No

Yes

Parameters
Source
Specifies the type of database backup series that Tivoli Storage Manager
assumes when generating the recovery plan file. This parameter is optional.
The default is DBBACKUP. The choices are:
DBBackup
Specifies that Tivoli Storage Manager assumes the latest full with plus
database backup series.
DBSnapshot
Specifies that Tivoli Storage Manager assumes the latest database snapshot
backup series.
DEVclass
Specifies the device class name that is used to create a recovery plan file object
on a target server. The device class must have a device type of SERVER.
Note: The maximum capacity for the device class must be larger than the size
of the recovery plan file. If the size of the recovery plan file exceeds the
PREPARE

624 IBM Tivoli Storage Manager for Windows: Administrators Reference
maximum capacity, the command fails.
The naming convention for the archive object that contains the recovery plan
file on the target server is:
v Filespace name: ADSM.SERVER
v High-level qualifier: devclassprefix\servername.yyyymmdd.hhmmss
v Low-level qualifier: RPF.OBJ.1
The recovery plan file virtual volume name as recorded in the volume history
table on the source server is in the format servername.yyyymmdd.hhmmss.
If the DEVCLASS parameter is not specified, the recovery plan file is written to
a file based on the plan prefix.
If SOURCE=DBBACKUP is specified or is defaulted to, the volume history
entry for the recovery plan file object specifies a volume type of RPFILE. If
SOURCE=DBSNAPSHOT is specified, the volume history entry specifies a
volume type of RPFSNAPSHOT.
PLANPrefix
Specifies the path name prefix that is used in the recovery plan file name. The
maximum length is 200 characters. This parameter is optional.
Tivoli Storage Manager appends to the prefix the sortable date and time format
yyyymmdd.hhmmss. For example: 19971115.051421.
The prefix can be one of the following:
v Directory path: End the prefix with the backslash (\). For example:
PLANPREFIX=c:\adsmsrv\recplans\
The resulting file name looks like this:
c:\adsmsrv\recplans\19971115.051421
Note: If you issue the PREPARE command from the Tivoli Storage Manager
administrative command line client and the last character in the
command line is a backslash, it is interpreted as a continuation
character. To avoid this, place the prefix value in quotes. For example:
PLANPREFIX=c:\adsmsrv\recplans\
v Directory path followed by a string: Tivoli Storage Manager treats the
string as part of the file name. For example:
PLANPREFIX=c:\adsmsrv\recplans\accounting
The resulting file name looks like this:
c:\adsmsrv\recplans\accounting.19971115.051421
Note the period before the date and time.
v String only: Tivoli Storage Manager appends the date and time in the
.yyyymmdd.hhmmss format (note the period before the date and time) to the
prefix. The directory path used by the PREPARE command is the directory
representing this instance of the Tivoli Storage Manager server. Typically,
this directory is the original Tivoli Storage Manager server installation
directory. For example, the directory representing this instance of the server
is c:\Program Files\Tivoli\TSM;\server2 , and you issue a PREPARE
command with the following parameter:
PLANPREFIX=shipping
The resulting recovery plan filename is:
PREPARE
Chapter 2. Administrative commands 625
c:\Program Files\Tivoli\TSM;\server2\shipping.19971115.051421
If the PLANPREFIX parameter is not specified, Tivoli Storage Manager selects
the prefix in one of these ways:
v If the SET DRMPLANPREFIX command has been issued, Tivoli Storage
Manager uses the prefix specified in that command.
v If the SET DRMPLANPREFIX command is not defined, Tivoli Storage
Manager uses as the path the directory representing this instance of the
Tivoli Storage Manager server, which is typically the original Tivoli Storage
Manager server installation directory. For example, the directory
representing this instance of the server is the following:
c:\Program Files\Tivoli\TSM;\server2
The resulting recovery plan file name is the following:
c:\Program Files\Tivoli\TSM;\server2\1997115.051421
INSTRPrefix
Specifies the prefix of the path name used by Tivoli Storage Manager to locate
the files that contain the recovery instructions. The maximum length is 200
characters.
The prefix can be one of the following:
v Directory path: End the prefix with the backslash (\). For example:
INSTRPREFIX=c:\adsmsrv\recinstr\
Tivoli Storage Manager appends the appropriate recovery plan file stanza
name. For the RECOVERY.INSTRUCTIONS.GENERAL file, the resulting file
name is:
c:\adsmsrv\recinstr\RECOVERY.INSTRUCTIONS.GENERAL
Note: If you issue the PREPARE command from the Tivoli Storage Manager
administrative command line client and the last character in the
command line is a backslash, it is interpreted as a continuation
character. To avoid this, place the prefix value in quotes. For example:
INSTRPREFIX="c:\adsmserv\recinstr\"
v Directory path followed by a string: Tivoli Storage Manager treats the
string as part of the file name. For example:
INSTRPREFIX=c:\adsmsrv\recinstr\accounts
Tivoli Storage Manager appends the appropriate recovery plan file stanza
name. For the RECOVERY.INSTRUCTIONS.GENERAL file, the resulting file
name is:
c:\adsmsrv\recinstr\accounts.RECOVERY.INSTRUCTIONS.GENERAL
v String only: Tivoli Storage Manager specifies the directory path and
appends the appropriate recovery plan file stanza name. Tivoli Storage
Manager appends the recovery plan file stanza name to the prefix. If the
prefix is only a string, the directory path used by the PREPARE command is
the directory representing this instance of the Tivoli Storage Manager server.
This is typically the original Tivoli Storage Manager server installation
directory. For example, the directory representing this instance of the server
is c:\Program Files\Tivoli\TSM;\server2, and you issue a PREPARE command
with the following parameter:
INSTRPREFIX=dock
The resulting recovery plan filename is:
c:\Program Files\Tivoli\TSM;\server2\shipping.19971115.051421
PREPARE

626 IBM Tivoli Storage Manager for Windows: Administrators Reference
If you do not specify the INSTRPREFIX parameter, Tivoli Storage Manager
selects the prefix in one of these ways:
v If the SET DRMINSTRPREFIX command has been issued, Tivoli Storage
Manager uses the prefix specified in that command.
v If the SET DRMINSTRPREFIX command has not been issued, Tivoli Storage
Manager uses as the path the directory representing this instance of the
Tivoli Storage Manager server, which is typically the original Tivoli Storage
Manager server installation directory. For example, the directory
representing this instance of the server is the following:
c:\Program Files\Tivoli\TSM;\server2
The resulting recovery plan file name is the following:
c:\Program Files\Tivoli\TSM;\server2\RECOVERY.INSTRUCTIONS.GENERAL
PRIMstgpool
Specifies the names of the primary storage pools that you want to restore.
Separate the storage pool names with commas and no intervening spaces. You
can use wildcard characters. If this parameter is not specified, Tivoli Storage
Manager selects the storage pools as follows:
v If the SET DRMPRIMSTGPOOL command has been issued, Tivoli Storage
Manager includes the primary storage pools named in that command.
v If the SET DRMPRIMSTGPOOL command has not been issued, Tivoli
Storage Manager includes all the primary storage pools.
COPYstgpool
Specifies the names of the copy storage pools used to back up the primary
storage pools that you want to restore (see the PRIMSTGPOOL parameter).
Separate storage pool names with commas and no intervening spaces. You can
use wildcard characters. If this parameter is not specified, Tivoli Storage
Manager selects the storage pools as follows:
v If the SET DRMCOPYSTGPOOL command has been issued, Tivoli Storage
Manager includes those copy storage pools.
v If the SET DRMCOPYSTGPOOL command has not been issued, Tivoli
Storage Manager includes all copy storage pools.
Wait
Specifies whether this command is processed in the background or foreground.
No
Specifies background processing. This is the default.
Yes
Specifies foreground processing.
Examples
Task
Issue the PREPARE command and query the activity log to check the results.
Commands:
prepare
query actlog search=prepare
Output
PREPARE
Chapter 2. Administrative commands 627
05/03/1998 12:01:13 ANR0984I Process 3 for PREPARE started in the
BACKGROUND at 12:01:13.
05/03/1998 12:01:13 ANR6918W PREPARE: Recovery instructions file
c:\drmtest\prepare\RECOVERY.INSTRUCTIONS.DATABASE
not found.
05/03/1998 12:01:13 ANR6918W PREPARE: Recovery instructions file
c:\drmtest\prepare\RECOVERY.INSTRUCTIONS.STGPOOL
not found.
05/03/1998 12:01:13 ANR6913W PREPARE: No volumes with backup data
exist in copy storage pool CSTORAGEP.
05/03/1998 12:01:13 ANR6913W PREPARE: No volumes with backup data
exist in copy storage pool CSTORAGEPSM.
05/03/1998 12:01:14 ANR6920W PREPARE: Generated replacement volume
name BACK4X@ is not valid for device class 8MM.
Original volume name: BACK4X. Stanza is
PRIMARY.VOLUMES.REPLACEMENT macro.
05/03/1998 12:01:14 ANR6900I PREPARE: The recovery plan file
c:\drmtest\prepare\r.p.19980503.120113
was created.
05/03/1998 12:01:14 ANR0985I Process 3 for PREPARE running in the
BACKGROUND completed with completion state
SUCCESS at 12:01:14.

Related commands
Table 197. Commands related to PREPARE
Command Description
DELETE VOLHISTORY Removes sequential volume history
information from the volume history file.
QUERY DRMSTATUS Displays DRM system parameters.
QUERY RPFCONTENT Displays the contents of a recovery plan file.
QUERY RPFILE Displays information about recovery plan
files.
QUERY SERVER Displays information about servers.
QUERY VOLHISTORY Displays sequential volume history
information that has been collected by the
server.
SET DRMCOPYSTGPOOL Specifies that copy storage pools are
managed by DRM.
SET DRMINSTRPREFIX Specifies the prefix portion of the path name
for the recovery plan instructions.
SET DRMPLANVPOSTFIX Specifies the replacement volume names in
the recovery plan file.
SET DRMPLANPREFIX Specifies the prefix portion of the path name
for the recovery plan.
SET DRMPRIMSTGPOOL Specifies that primary storage pools are
managed by DRM.
SET DRMRPFEXPIREDAYS Set criteria for recovery plan file expiration.
UPDATE VOLHISTORY Adds or changes location information for a
volume in the volume history file.

PREPARE

628 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY commands
Use the QUERY command to request or display information about an IBM Tivoli
Storage Manager object.
The following is a list of QUERY commands for Tivoli Storage Manager:
v QUERY ACTLOG (Query the activity log) on page 631
v QUERY ADMIN (Display administrator information) on page 637
v QUERY ASSOCIATION (Query client node associations with a schedule) on
page 641
v QUERY AUDITOCCUPANCY (Query client node storage utilization) on page
643
v QUERY BACKUPSET (Query a backup set) on page 646
v QUERY BACKUPSETCONTENTS (Query contents of a backup set) on page
651
v QUERY CLOPTSET (Query a client option set) on page 654
v QUERY COLLOCGROUP (Query a collocation group) on page 656
v QUERY CONTENT (Query the contents of a storage pool volume) on page
658
v QUERY COPYGROUP (Query copy groups) on page 665
v QUERY DATAMOVER (Display data mover definitions) on page 670
v QUERY DB (Display information on the database) on page 673
v QUERY DBBACKUPTRIGGER (Query the database backup trigger) on page
677
v QUERY DBVOLUME (Display information on one or more database volumes)
on page 679
v QUERY DEVCLASS (Display information on one or more device classes) on
page 682
v QUERY DIRSPACE (Query storage utilization of FILE directories) on page 686
v QUERY DOMAIN (Query a policy domain) on page 687
v QUERY DRIVE (Query information about a drive) on page 691
v QUERY DRMEDIA (Query disaster recovery media) on page 695
v QUERY DRMSTATUS (Query disaster recovery manager system parameters)
on page 703
v QUERY ENABLED (Query enabled events) on page 706
v QUERY EVENT (Query scheduled and completed events) on page 708
v QUERY EVENTRULES (Query rules for server or client events) on page 720
v QUERY EVENTSERVER (Query the event server) on page 723
v QUERY FILESPACE (Query one or more file spaces) on page 730
v QUERY LIBRARY (Query a library) on page 736
v QUERY LIBVOLUME (Query a library volume) on page 739
v QUERY LICENSE (Display license information) on page 742
v QUERY LOG (Display information on the recovery log) on page 743
v QUERY LOGVOLUME (Display information on one or more log volumes) on
page 746
v QUERY MACHINE (Query machine information) on page 749
v QUERY MEDIA (Query sequential access storage pool media) on page 753
v QUERY MGMTCLASS (Query a management class) on page 760
QUERY commands
Chapter 2. Administrative commands 629
v QUERY MOUNT (Display information on mounted sequential access volumes)
on page 763
v QUERY NASBACKUP (Query NAS backup images) on page 765
v QUERY NODE (Query nodes) on page 768
v QUERY NODEDATA (Query client data in volumes) on page 775
v QUERY NODEGROUP (Query a node group) on page 778
v QUERY OCCUPANCY (Query client file spaces in storage pools) on page 780
v QUERY OPTION (Query server options) on page 784
v QUERY PATH (Display a path definition) on page 786
v QUERY POLICYSET (Query a policy set) on page 790
v QUERY PROCESS (Query one or more server processes) on page 793
v QUERY PROFILE (Query a profile) on page 795
v QUERY RECOVERYMEDIA (Query recovery media) on page 800
v QUERY REQUEST (Query one or more pending mount requests) on page 803
v QUERY RESTORE (Query restartable restore sessions) on page 804
v QUERY RPFCONTENT (Query recovery plan file contents stored on a target
server) on page 807
v QUERY RPFILE (Query recovery plan file information stored on a target
server) on page 809
v QUERY SCHEDULE (Query schedules) on page 815
v QUERY SCRIPT (Query Tivoli Storage Manager scripts) on page 823
v QUERY SERVER (Query a server) on page 827
v QUERY SERVERGROUP (Query a server group) on page 831
v QUERY SESSION (Query client sessions) on page 833
v QUERY SHREDSTATUS (Query shredding status ) on page 836
v QUERY SQLSESSION (Display SQL session value) on page 841
v QUERY SPACETRIGGER (Query the space triggers) on page 838
v QUERY STATUS (Query system parameters) on page 843
v QUERY STGPOOL (Query storage pools) on page 849
v QUERY SUBSCRIBER (Display subscriber information) on page 858
v QUERY SUBSCRIPTION (Display subscription information) on page 860
v QUERY SYSTEM (Query the system configuration and capacity) on page 862
v QUERY TAPEALERTMSG (Display status of SET TAPEALERTMSG command)
on page 864
v QUERY TOC (Display table of contents for a backup image) on page 865
v QUERY VIRTUALFSMAPPING (Query a virtual file space mapping) on page
868
v QUERY VOLHISTORY (Display sequential volume history information) on
page 870
v QUERY VOLUME (Query storage pool volumes) on page 878
QUERY commands

630 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY ACTLOG (Query the activity log)
Use this command to display messages generated by the server. This command
offers you various filtering options that can be used to limit the amount of
messages displayed and the time it takes to process this query. If you do not
specify any parameters with this command, all messages generated in the last hour
are displayed.
The activity log contains all messages that are sent to the server console under
normal operation. The results of commands entered at the server console are not
recorded in the activity log, unless the command affects or starts a background
process or client session. Error messages are displayed in the activity log.
Note: You cannot schedule the QUERY ACTLOG command using the DEFINE
SCHEDULE command.
Privilege class
Any administrator can issue this command.
Syntax

Query ACtlog
BEGINDate = current_date
BEGINDate

=

date

BEGINTime = currenttime_minus_1_hour
BEGINTime

=

time
ENDDate = current_date
ENDDate

=

date

ENDTime = current_time
ENDTime

=

time

MSGno

=

message_number

Search

=

string

NODEname

=

node_name

ORiginator = ALL
ORiginator

=

ALL

SErver

CLient

A

A:

OWNERname

=

owner_name

SCHedname

=

schedule_name

DOmainname

=

domain_name

SESsnum

=

session_number


Parameters
BEGINDate
Specifies the beginning date of the range for messages to be displayed. All
QUERY ACTLOG
Chapter 2. Administrative commands 631
messages meeting the time range criteria that occurred after this date are
displayed. The default is the current date. This parameter is optional.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY 7 or 7.
To display information beginning with
messages created a week ago, you can
specify BEGINDATE=TODAY-7 or
BEGINDATE= -7.

BEGINTime
Specifies the beginning time of the range for messages to be displayed. All
messages meeting the time range criteria that occurred after this time are
displayed. If you do not specify time, all messages that occurred in the last
hour are displayed.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the
specified begin date
10:30:08
NOW The current time on the
specified begin date
NOW
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
begin date
NOW+03:00 or +03:00.
If you issue this command at 9:00
with BEGINTIME=NOW+3 or
BEGINTIME=+3, Tivoli Storage
Manager displays messages with a
time of 12:00 or later on the begin
date.
NOW-HH:MM or
-HH:MM
The current time minus hours
and minutes on the specified
begin date
NOW-04:00 or -04:00.
If you issue the QUERY ACTLOG
command at 9:00 with
BEGINTime=NOW-3:30 or
BEGINTime= -3:30, Tivoli Storage
Manager displays messages with a
time of 5:30 or later on the begin
date.

ENDDate
Specifies the ending date of the range for messages to be displayed. All
messages meeting the time range criteria that occurred before this date are
displayed. If you do not specify a value, the current date is used. This
parameter is optional.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
QUERY ACTLOG

632 IBM Tivoli Storage Manager for Windows: Administrators Reference
Value Description Example
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY1 or 1.
To display information created up to
yesterday, you can specify
ENDDATE=TODAY-1 or simply
ENDDATE= -1.

ENDTime
Specifies the ending time of the range for messages to be displayed. All
messages meeting this time range criteria that occurred before this time are
displayed. If you do not specify a value, all messages are displayed up to the
time when you issued this command. This parameter is optional.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the
specified end date
10:30:08
NOW The current time on the
specified end date
NOW
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
end date
NOW+03:00 or +03:00.
If you issue this command at 9:00
with ENDTIME=NOW+3:00 or
ENDTIME= +3:00, Tivoli Storage
Manager displays messages with a
time of 12:00 or earlier on the end
date you specify.
NOW-HH:MM or
-HH:MM
The current time minus hours
and minutes on the specified
end date
NOW-03:30 or -03:30.
If you issue this command at 9:00
with ENDTIME=NOW-3:30 or
ENDTIME= -3:30, IBM Tivoli Storage
Manager displays messages with a
time of 5:30 or earlier on the end date
you specify.

MSGno
Specifies an integer that defines the number of the message to be displayed
from the activity log. This is just the numeric part of the message. This
parameter is optional.
Search
Specifies a text string that you want to search for in the activity log. Enclose
the string expression in quotation marks if it contains blanks. You can use text
and a wildcard character to specify this string. This parameter is optional.
Note: Do not enter as a text string either the IBM Tivoli Storage Manager
server name or text and a wildcard character that would find the server
name. If you do so the output will include messages that do not include
the search string.
NODEname
Specifies that the query displays messages logged for this node. If you do not
specify a value for this parameter, messages for all nodes are displayed.
QUERY ACTLOG
Chapter 2. Administrative commands 633
ORiginator
Specifies that the query displays messages logged by the server, client, or both.
The default is ALL. Possible values are:
ALL
Specifies that the query displays messages that originated from the client
and the server.
SErver
Specifies that the query displays messages that originated from the server.
CLient
Specifies that the query displays messages that originated from the client.
You can specify one of the following values to minimize processing time
when querying the activity log for messages logged by the client:
OWNERname
Specifies that the query displays messages logged for a particular
owner. If you do not specify a value for this parameter, messages for
all owners are displayed.
SCHedname
Specifies that the query displays messages logged by a particular
scheduled client activity. If you do not specify a value for this
parameter, messages for all schedules are displayed.
DOmainname
Specifies that the query displays messages logged for a particular
policy domain to which a named schedule belongs. This parameter is
optional, unless you are specifying a schedule name.
SESsnum
Specifies that the query displays messages logged from a particular
client session number. If you do not specify a value for this parameter,
messages for all client sessions are displayed.
Examples
Task
Search the activity log for any message that contains the string delete. The
output includes only messages produced during the past hour.
Command
query actlog search=delete
Output

Date/Time Message
-------------------- -----------------------------------------
08/27/1998 15:19:43 ANR0812I Inventory client file expiration
complete: 0 files deleted.

Task
Display messages that occurred yesterday between 9:30 and 12:30.
Command
query actlog begindate=today-1
begintime=09:30:00 endtime=12:30:00
QUERY ACTLOG

634 IBM Tivoli Storage Manager for Windows: Administrators Reference
Output

Date/Time Message
------------------- ----------------------------------------------
10/21/1998 10:52:36 ANR0407I Session 3921 started for administrator
ADMIN (WebBrowser) (HTTP 9.115.20.100(2315)).
10/21/1998 11:06:08 ANR0405I Session 3922 ended for administrator
ADMIN (WebBrowser).
10/21/1998 12:16:50 ANR0405I Session 3934 ended for administrator
ADMIN (WebBrowser).
10/21/1998 12:36:18 ANR2501I Schedule AGADM_TEST deleted from
policy domain STANDARD.

Task
Search the activity log for Tivoli Storage Manager messages from the client for
node JEE.
Command
query actlog originator=client node=jee
Output

Date/Time Message
------------------- -------------------------------------------------
06/10/1998 15:46:22 ANE4007E (Session No: 3 Node: JEE) Error
processing /jee/report.out: access to the
object is denied
06/11/1998 15:56:56 ANE4009E (Session No: 4 Node: JEE) Error
processing /jee/work.lst: disk full condition

Task
Search the activity log for Tivoli Storage Manager messages from the client for
node FRED associated with Session 4.
Command
query actlog search="(SESSION:4)"
Output

Date/Time Message
------------------- ------------------------------------------------
09/23/2003 10:26:38 ANR0406I Session 4 started for node FRED (WinNT)
(Tcp/Ip colind(2463)). (SESSION: 4)
09/23/2003 10:26:40 ANR8493I FILE volume C:\CODE\522\00000000.BFS
mounted in drive OUTFILE4 (FILE) in library
OUTFILE. (SESSION: 4)
09/23/2003 10:26:40 ANR8340I FILE volume C:\CODE\522\00000000.BFS
mounted.(SESSION:4)
09/23/2003 10:26:40 ANR8468I FILE volume C:\CODE\522\00000000.BFS
dismounted from drive OUTFILE4 (FILE) in library
OUTFILE. (SESSION:4)
09/23/2003 10:26:40 ANR0403I Session 4 ended for node FRED (WinNT).
(SESSION:4)

QUERY ACTLOG
Chapter 2. Administrative commands 635
Related commands
Table 198. Command related to QUERY ACTLOG
Command Description
SET ACTLOGRETENTION Specifies the number of days to retain log
records in the activity log.

QUERY ACTLOG

636 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY ADMIN (Display administrator information)
Use this command to display information about one or more administrators.
Privilege class
Any administrator can issue this command.
Syntax

Query ADmin
*
admin_name

,

CLasses

=

SYstem

Policy

STorage

Analyst

Operator

Node

Format = Standard
Format

=

Standard

Detailed

Parameters
admin_name
Specifies the name of the administrator for which you want to display
information. This parameter is optional. You can use wildcard characters to
specify this name. If you do not specify a value for this parameter, all
administrators are displayed.
CLasses
Specifies that you want to restrict output to those administrators that have
privilege classes that you specify. This parameter is optional. You can specify
multiple privilege classes in a list by separating the names with commas and
no intervening spaces. If you do not specify a value for this parameter,
information on all administrators is displayed, regardless of privilege class.
Possible values are:
SYstem
Display information on administrators with system privilege.
Policy
Display information on administrators with policy privilege.
STorage
Display information on administrators with storage privilege.
Analyst
Display information on administrators with analyst privilege.
Operator
Display information on administrators with operator privilege.
Node
Display information on users with client node privilege.
QUERY ADMIN
Chapter 2. Administrative commands 637
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the specified
administrators.
Detailed
Specifies that complete information is displayed for the specified
administrators.
Examples
Task 1
Display partial information on all administrators.
Command
query admin
Output

Administrator Days Since Days Since Locked? Privilege Classes
Name Last Access Password
Set
------------- ----------- ---------- --------- ------------------
ADMIN <1 <1 No System
SERVER_CONSOLE No System

See Task 2 for descriptions.
Task 2
From a managed server, display complete information for the administrator named
ADMIN.
Command
query admin admin format=detailed
Output
Administrator Name: ADMIN
Last Access Date/Time: 1998.06.04 17.10.52
Days Since Last Access: <1
Password Set Date/Time: 1998.06.04 17.10.52
Days Since Password Set: 26
Invalid Sign-on Count: 0
Locked?: No
Contact:
System Privilege: Yes
Policy Privilege: **Included with system privilege**
Storage Privilege: **Included with system privilege**
Analyst Privilege: **Included with system privilege**
Operator Privilege: **Included with system privilege**
Client Access Privilege: **Included with system privilege**
Client Owner Privilege: **Included with system privilege**
Registration Date/Time: 05/09/1998 23:54:20
Registering Administrator: SERVER_CONSOLE
Managing profile:
Password Expiration Period: 90 Day (s)
Email Address:

QUERY ADMIN

638 IBM Tivoli Storage Manager for Windows: Administrators Reference
where:
Administrator Name
Specifies the name of the administrator.
Last Access Date/Time
Specifies the date and time that the administrator last accessed the server.
Days Since Last Access
Specifies the number of days since the administrator last accessed the server.
Password Set Date/Time
Specifies the date and time that the administrators password was defined or
most recently updated.
Days Since Password Set
Specifies the number of days since the administrators password was defined
or most recently updated.
Invalid Sign-on Count
Specifies the number of invalid sign-on attempts that have been made since the
last successful sign-on. This count can only be non-zero when an invalid
password limit (SET INVALIDPWLIMIT) is greater than zero. When the
number of invalid attempts equals the limit set by the SET INVALIDPWLIMIT
command, the administrator is locked out of the system.
Locked?
Specifies whether the administrator is locked out of the system.
Contact
Specifies any contact information for the administrator.
System Privilege
Specifies whether the administrator has been granted system privilege.
Policy Privilege
Specifies whether the administrator has been granted unrestricted policy
privilege or the names of any policy domains that the restricted policy
administrator can manage.
Storage Privilege
Specifies whether the administrator has been granted unrestricted storage
privilege or the names of any storage pools that the restricted storage
administrator can manage.
Analyst Privilege
Specifies whether the administrator has been granted analyst privilege.
Operator Privilege
Specifies whether the administrator has been granted operator privilege.
Client Access Privilege
Specifies that client access authority has been granted to a user with node
privilege.
Client Owner Privilege
Specifies that client owner authority has been granted to a user with node
privilege.
Registration Date/Time
Specifies the date and time that the administrator was registered.
Registering Administrator
Specifies the name of the administrator who registered the administrator. If this
QUERY ADMIN
Chapter 2. Administrative commands 639
field contains $$CONFIG_MANAGER$$, the administrator is associated with a
profile that is managed by the configuration manager.
Managing Profile
Specifies the profiles to which the managed server subscribed to get the
definition of this administrator.
Password Expiration Period
Specifies the administrators password expiration period.
Email Address
This parameter is used by IBM Tivoli Storage Manager Express only and is
shown for compatibility purposes.
Related commands
Table 199. Commands related to QUERY ADMIN
Command Description
GRANT AUTHORITY Assigns privilege classes to an administrator.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
REGISTER ADMIN Defines a new administrator without
granting administrative authority.
REMOVE ADMIN Removes an administrator from the list of
registered administrators.
RENAME ADMIN Changes an IBM Tivoli Storage Manager
administrators name.
RESET PASSEXP Resets the password expiration for nodes or
administrators.
REVOKE AUTHORITY Revokes one or more privilege classes or
restricts access to policy domains and storage
pools.
SET INVALIDPWLIMIT Sets the number of invalid logon attempts
before a node is locked.
SET MINPWLENGTH Sets the minimum length for client
passwords.
SET PASSEXP Specifies the number of days after which a
password is expired and must be changed.

QUERY ADMIN

640 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
QUERY ASSOCIATION (Query client node associations with a
schedule)
Use this command to display information about which client nodes are associated
with one or more schedules. Client nodes associated with a schedule perform
operations such as backup or archive according to that schedule.
Privilege class
Any administrator can perform this task.
Syntax

Query ASSOCiation
* *
*

domain_name

schedule_name

Parameters
domain_name
Specifies the name of the policy domain to display. You can use a wildcard
character to specify this name. All matching policy domain names are
displayed. If you do not specify a value for this parameter, all existing policy
domains are queried. If you specify a domain name, you do not have to
specify a schedule name.
schedule_name
Specifies the name of the schedule to display. You can use a wildcard character
to specify this name. All matching schedule names are displayed. If you do not
specify a value for this parameter, all existing schedules are queried. If you
specify a schedule name, you must also specify a policy domain name.
Examples
Task
Display all the client nodes that are associated with each schedule that belongs to
the EMPLOYEE_RECORDS policy domain.
Command
query association employee_records *
Output

Policy Domain Name: EMPLOYEE_RECORDS
Schedule Name: WEEKLY_BACKUP
Associated Nodes: JOE JOHNSON LARRY SMITH SMITHERS TOM

where:
Policy Domain Name
Specifies the name of the policy domain to which the schedule belongs.
Schedule Name
Specifies the name of the schedule.
QUERY ASSOCIATION
Chapter 2. Administrative commands 641
Associated Nodes
Specifies the names of the client nodes that are associated with the specified
schedule.
Related commands
Table 200. Commands related to QUERY ASSOCIATION
Command Description
DEFINE ASSOCIATION Associates clients with a schedule.
DELETE ASSOCIATION Deletes the association between clients and a
schedule.

QUERY ASSOCIATION

642 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY AUDITOCCUPANCY (Query client node storage
utilization)
Use this command to display information about client node server storage
utilization. To display current license audit information from the server, use the
AUDIT LICENSE command prior to issuing the QUERY AUDITOCCUPANCY
command.
Note: As part of a license audit operation, the server calculates, by node, the
amount of backup, archive, and space management storage in use. For
servers managing large amounts of data, this calculation can take a great
deal of CPU time and can stall other server activity. You can use the
AUDITSTORAGE server option to specify that storage is not to be calculated
as part of a license audit.
You can use the information from this query to determine if and where client node
storage utilization needs to be balanced. This information can also assist you with
billing clients for storage usage.
Privilege class
Any administrator can issue this command.
Syntax
Query AUDITOccupancy

,

node_name

,

DOmain

=

domain_name

POoltype = ANY
POoltype

=

ANY

PRimary

COpy

Parameters
node_name
Specifies a list of nodes for which to display server storage use information.
Specify more than one node by separating the node names with commas, with
no intervening spaces. You can use wildcard characters to specify names. The
default (*) is to query all client nodes. Use the DOMAIN parameter to limit
this list by policy domain. This parameter is optional.
DOmain
Specifies a list of policy domains to restrict which nodes are displayed. Nodes
belonging to the specified policy domains are displayed. Specify more than one
policy domain by separating the policy domain names with commas, with no
intervening spaces. You can use wildcard characters to specify names. This
parameter is optional.
POoltype
Specifies the type of storage pool to display. This parameter is optional. The
default is ANY. Possible values are:
QUERY AUDITOCCUPANCY
Chapter 2. Administrative commands 643
ANY
Specifies both primary and copy storage pools. The value presented is the
total for the two pools.
PRimary
Specifies primary storage pools only.
COpy
Specifies copy storage pools only.
Examples
Task
Display combined storage use in primary and copy storage pools.
Command
query auditoccupancy
Output
License information as of last audit on 05/22/1996 14:49:51.

Client Node Name Backup Archive Space-Managed Total
Storage Storage Storage Used Storage
Used (MB) Used (MB) (MB) Used (MB)
--------------------- --------- ---------- ------------ ---------
CLIENT 245 20 0 265
SMITH 245 20 0 265
SMITHERS 245 20 0 265
JOHNSON 300 15 0 320
JOE 245 20 0 265
TOM 300 15 0 320
LARRY 245 20 0 265

where:
Client Node Name
Specifies the name of the client node.
Backup Storage Used (MB)
Specifies, in megabytes, the total backup storage use for the node.
Archive Storage Used (MB)
Specifies, in megabytes, the total archive storage use for the node.
Space-Managed Storage Used (MB)
Specifies, in megabytes, the amount of server storage used to store files
migrated from the client node.
Total Storage Used (MB)
Specifies, in megabytes, the total storage use for the node.
Related commands
Table 201. Commands related to QUERY AUDITOCCUPANCY
Command Description
AUDIT LICENSES Checks for compliance with defined licenses.
QUERY LICENSE Displays information about licenses and
audits.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
QUERY AUDITOCCUPANCY

644 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 201. Commands related to QUERY AUDITOCCUPANCY (continued)
Command Description
REGISTER LICENSE Registers a new license with the IBM Tivoli
Storage Manager server.
SET LICENSEAUDITPERIOD Specifies the number of days between
automatic license audits.

QUERY AUDITOCCUPANCY
Chapter 2. Administrative commands 645
QUERY BACKUPSET (Query a backup set)
Use this command to display information about one or more backup sets.
Privilege class
Any administrator can issue this command.
Syntax

Query BACKUPSET

*
,

node_name

node_group_name

*
,

backup_set_name

BEGINDate

=

date

BEGINTime

=

time

ENDDate

=

date

ENDTime

=

time

WHERERETention

=

days

NOLimit

WHEREDESCription

=

description

WHEREDEVice

=

device_class_name

WHERETOCexists

=

Yes

No

,

WHEREDATAType

=

FILE

IMAGE

APPL

Format = Standard
Format

=

Standard

Detailed

Parameters
node_name or node_group_name (Required)
Specifies the name of the client node and node groups whose data is contained
in the backup set to be displayed. To specify multiple node names and node
group names, separate the names with commas and no intervening spaces. You
can use wildcard characters with node names but not with node group names.
backup_set_name
Specifies the name of the backup set whose information is to be displayed. The
backup set name you specify can contain wildcard characters. You can specify
more than one backup set name by separating the names with commas and no
intervening spaces.
BEGINDate
Specifies the beginning date of the range in which the point-in-time date of the
QUERY BACKUPSET

646 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
backup set to be displayed must fall. This parameter is optional. You can use
this parameter with the BEGINTIME parameter to specify a range for the date
and time. If you specify a begin date without a begin time, the time will be at
12:00 a.m. (midnight) on the date you specify.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1999
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified.
TODAY +3 or +3.
TODAY-days or
-days
The current date minus days
specified.
TODAY -3 or -3.

BEGINTime
Specifies the beginning time of the range in which the point-in-time date of the
backup set to be displayed must fall. This parameter is optional. You can use
this parameter with the BEGINDATE parameter to specify a range for the date
and time. If you specify a begin time without a begin date, the date will be the
current date at the time you specify.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified
NOW+02:00 or +02:00.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW-02:00 or 02:00.

ENDDate
Specifies the ending date of the range in which the point-in-time date of the
backup set to be displayed must fall. This parameter is optional. You can use
this parameter with the ENDTIME parameter to specify an ending date and
time. If you specify an end date without an end time, the time will be at
11:59:59 p.m. on the specified end date.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1999
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified. The maximum
number of days you can specify
is 9999.
TODAY +3 or +3.
TODAY-days or
-days
The current date minus days
specified.
TODAY -3 or -3.

ENDTime
Specifies the ending time of the range in which the point-in-time date of the
backup set to be displayed must fall. This parameter is optional. You can use
QUERY BACKUPSET
Chapter 2. Administrative commands 647
|
|
|
|
|
|
|||
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|||
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|||
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
this parameter with the ENDDATE parameter to specify a date and time. If
you specify an end time without an end date, the date will be the current date
at the time you specify.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified
NOW+02:00 or +02:00.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW-02:00 or 02:00.

WHERERETention
Specifies the retention value, specified in days, that must be associated with
the backup sets to be displayed. You can specify an integer from 0 to 30000.
The values are:
days
Specifies that backup sets that are retained this number of days are
displayed.
NOLimit
Specifies that backup sets that are retained indefinitely are displayed.
WHEREDESCription
Specifies the description that must be associated with the backup set to be
displayed. The description you specify can contain wildcard characters. This
parameter is optional. Enclose the description in quotation marks if it contains
any blank characters.
WHEREDEVice
Specifies the name of the device class that must be associated with the backup
set to be displayed. You can use wildcard characters to specify a device class
name. This parameter is optional.
WHERETOCexists
Specifies whether a backup set must have a table of contents in order to be
displayed. This parameter is optional. The default is to display all backup sets
whether or not they have a table of contents.
WHEREDATAType
Specifies the data type of backup set to be displayed. This parameter is
optional. The default is to display all types of backup sets. To specify multiple
data types, separate data types with commas and no intervening spaces.
FILE
Specifies that a file level backup set is to be displayed. File level backup
sets contain files and directories backed up by the backup-archive client.
IMAGE
Specifies that an image backup set is to be displayed. Image backup sets
contain images created by the backup-archive client BACKUP IMAGE
command.
APPL
Specifies that an application backup set is to be displayed. Application
backup sets contain data backed up to the Tivoli Storage Manager server
by applications using the Tivoli Storage Manager application programming
QUERY BACKUPSET

648 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|||
|||
|||
|
|
|
|
|
|
|
|
|
|
|
|
interface. This parameter applies only if the Tivoli Storage Manager server
was upgraded from Tivoli Storage Manager Express and only for the Tivoli
Storage Manager Express versions of Data Protection for Exchange and
Data Protection for SQL.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the specified backup sets.
Detailed
Specifies that complete information is displayed for the specified backup
sets.
Examples
Task
Display information for backup sets whose names begin with PROJX_DATA*. The
backup sets belong to the node JANE and are assigned to the DVLMENT device
class.
Command
query backupset jane pers_data*
Output

Node Name: JANE
Backup Set Name: PERS_DATA.3089
Data Type: File
Date/Time: 06/09/2006 16:17:47
Retention Period: 60
Device Class Name: DCFILE
Description: backupset created from /srvr
Has Table of Contents (TOC)?: Yes

where:
Node Name
Specifies the name of the client node whose data is contained in the backup
set.
Backup Set Name
Specifies the name of the backup set.
Data Type:
Displays the data type of the backup sets. Possible types are file, image, and
application.
Date/Time
Specifies the date and time (PITDate and PITTime) of the GENERATE
BACKUPSET command. The PITDate and PITTime specify that files that were
active on the specified date and time and that are still stored on the Tivoli
Storage Manager server are to be included in the backup set, even if they are
inactive at the time you issue the GENERATE BACKUPSET command. The
default is the date on which the GENERATE BACKUPSET command is
executed.
QUERY BACKUPSET
Chapter 2. Administrative commands 649
|
|
|
|
|
|
|
Retention Period
Specifies the number of days that the backup set is retained on the server.
Device Class Name
Specifies the name of the device class for which the volumes containing the
backup set is assigned.
Description
Specifies the description associated with the backup set.
Has Table of Contents (TOC)?
Specifies whether the backup set has a table of contents.
Related commands
Table 202. Commands related to QUERY BACKUPSET
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
GENERATE BACKUPSETTOC Generates a table of contents for a backup
set.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
QUERY BACKUPSETCONTENTS Displays contents contained in backup sets.
QUERY NODEGROUP Displays information about node groups.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.
UPDATE NODEGROUP Updates the description of a node group.

QUERY BACKUPSET

650 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY BACKUPSETCONTENTS (Query contents of a backup
set)
Use this command to display information about the files and directories contained
in a backup set for a client node.
Note: Processing this command can use considerable network resources and
mount points.
Privilege class
To issue this command, you must have system privilege or policy privilege for the
domain to which the client node is assigned.
Syntax
Query BACKUPSETCONTENTS node_name backup_set_name

DATAType = FILE
DATAType

=

FILE

IMAGE

(1)

APPL

Notes:
1 The APPL parameter is supported only if Tivoli Storage Manager was
upgraded from Tivoli Storage Manager Express.
Parameters
node_name (Required)
Specifies the name of the client node whose data is contained in the backup set
to display. The name you specify cannot contain wildcard characters nor can it
be a list of node names separated by commas.
backup_set_name (Required)
Specifies the name of the backup set to display. The name you specify cannot
contain wildcard characters nor can it be a list of node names separated by
commas.
DATAType
Specifies that the backup set containing the specified types of data is to be
queried. This parameter is optional. The default is that a file level backup set is
to be queried. Possible values are:
FILE
Specifies that a file level backup set is to be queried. File level backup sets
contain files and directories backed up by the backup-archive client.
IMAGE
Specifies that an image backup set is to be queried. Image backup sets
contain images created by the backup-archive client BACKUP IMAGE
command.
APPL
Specifies that an application backup set is to be queried. Application
backup sets contain data backed up to the Tivoli Storage Manager Server
QUERY BACKUPSETCONTENTS
Chapter 2. Administrative commands 651
by applications using the Tivoli Storage Manager application programming
interface (including Data Protection clients).
Note: Application backup sets are supported only if Tivoli Storage
Manager was upgraded from Tivoli Storage Manager Express.
Examples
Task
Display the contents from backup set named PERS_DATA.3099 belonging to client
node JANE.
Command
query backupsetcontents jane pers_data.3099
Output

Node Name Filespace Clients Name for File
Name
------------------------ ---------- ------------------------
JANE /srvr /deblock
JANE /srvr /deblock.c
JANE /srvr /dsmerror.log
JANE /srvr /dsmxxxxx.log
JANE ... ......
where:
Node Name
Specifies the name of the client node whose data is contained in the backup
set.
Filespace Name
Specifies the name of the file space to which the specified file belongs.
File space names and file names that can be in a different code page or locale
than the server do not display correctly on the Administration Center or the
administrative command-line interface. The data itself is backed up and can be
restored properly, but the file space or file name may display with a
combination of invalid characters or blank spaces.
If the file space name is Unicode enabled, the name is converted to the servers
code page for display. The results of the conversion for characters not
supported by the current code page depends on the operating system. For
names that Tivoli Storage Manager is able to partially convert, you may see
question marks (??), blanks, unprintable characters, or .... These characters
indicate to the administrator that files do exist. If the conversion is not
successful, the name is displayed as .... Conversion can fail if the string
includes characters that are not available in the server code page, or if the
server has a problem accessing system conversion routines.
Clients Name for File
Specifies the name of the file.
File space names and file names that can be in a different code page or locale
than the server do not display correctly on the Administration Center or the
administrative command-line interface. The data itself is backed up and can be
restored properly, but the file space or file name may display with a
combination of invalid characters or blank spaces.
QUERY BACKUPSETCONTENTS

652 IBM Tivoli Storage Manager for Windows: Administrators Reference
If the file space name is Unicode enabled, the name is converted to the servers
code page for display. The results of the conversion for characters not
supported by the current code page depends on the operating system. For
names that Tivoli Storage Manager is able to partially convert, you may see
question marks (??), blanks, unprintable characters, or .... These characters
indicate to the administrator that files do exist. If the conversion is not
successful, the name is displayed as .... Conversion can fail if the string
includes characters that are not available in the server code page, or if the
server has a problem accessing system conversion routines.
Note: Where the file name is displayed as ...... indicates that both the file
path and file name were not successfully converted. An example of the
path and name could be:
my\dir\...
Related commands
Table 203. Commands related to QUERY BACKUPSETCONTENTS
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
GENERATE BACKUPSET Generates a backup set of a clients data.
GENERATE BACKUPSETTOC Generates a table of contents for a backup
set.
DELETE BACKUPSET Deletes a backup set.
QUERY BACKUPSET Displays backup sets.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.

QUERY BACKUPSETCONTENTS
Chapter 2. Administrative commands 653
QUERY CLOPTSET (Query a client option set)
Use this command to query a client option set.
Privilege class
Any administrator can issue this command.
Syntax

*
Query CLOptset

option_set_name

DESCription

=

description

Parameters
option_set_name
Specifies the name of the client option set to be queried. You can use wildcard
characters to specify this name. This parameter is optional. The default is
option set names.
DESCription
Specifies the description used on the DEFINE or UPDATE CLOPTSET
commands to be used as a filter. If the description contains spaces, enclose it in
quotation marks. This parameter is optional.
Examples
Task
From a managed server, query a client option set named ENG.
Command
query cloptset eng
Output

Optionset: ENG
Description:
Last Update by (administrator): $$CONFIG_MANAGER$$
Managing profile:

Option: SCROLLINES
Sequence number: 0
Use Option Set Value (FORCE): No
Option Value: 40

Option: SCROLLPROMPT
Sequence number: 0
Use Option Set Value (FORCE): No
Option Value: yes
where:
Optionset
Specifies the name of the option set.
Description
Specifies the description of the client option set.
QUERY CLOPTSET

654 IBM Tivoli Storage Manager for Windows: Administrators Reference
Last Update by (administrator)
Specifies the name of the administrator that most recently updated the option
set. If this field contains $$CONFIG_MANAGER$$, the client option set is
associated with a profile that is managed by the configuration manager.
Managing Profile
Specifies the profile to which the managed server subscribed to get the
definition of the client option set.
Option
Specifies the name of the option.
Sequence Number
Specifies the sequence number of the option.
Use Option Set Value (FORCE)
Specifies whether the server option setting overrides the clients option setting.
NO indicates the server option setting does not override the client option. YES
indicates the servers option setting overrides the client option setting. This
option is set with the FORCE parameter on the DEFINE CLIENTOPT
command.
Option Value
Specifies the value of the option.
Related commands
Table 204. Commands related to QUERY CLOPTSET
Command Description
COPY CLOPTSET Copies a client option set.
DEFINE CLIENTOPT Adds a client option to a client option set.
DEFINE CLOPTSET Defines a client option set.
DELETE CLIENTOPT Deletes a client option from a client option
set.
DELETE CLOPTSET Deletes a client option set.
UPDATE CLIENTOPT Updates the sequence number of a client
option.
UPDATE CLOPTSET Updates the description of a client option set.
DEFINE PROFASSOCIATION Associates objects with a profile.

QUERY CLOPTSET
Chapter 2. Administrative commands 655
QUERY COLLOCGROUP (Query a collocation group)
Use this command to display the collocation groups defined on the server.
Privilege class
Any administrator can issue this command.
Syntax

Query COLLOCGroup
*
group_name
Format = Standard
Format

=

Standard

Detailed

Parameters
group_name
Specifies the name of the collocation group to display. To specify multiple
names, use a wildcard character. This parameter is optional. The default is to
display all collocation groups.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed. To display the members
of the collocation group, you must specify FORMAT=DETAILED.
Examples
Task 1
Display the collocation groups defined on the server.
Command
query collocgroup
Output

Collocation Group Name Collocation Group Description
-------------------------- ------------------------------
DEPT_ED Education department
GROUP1 Low cap client nodes.

Task 2
Display complete information about all collocation groups and determine which
client nodes belong to which collocation groups.
Command
query collocgroup format=detailed
Output

QUERY COLLOCGROUP

656 IBM Tivoli Storage Manager for Windows: Administrators Reference
Collocation Group Name: DEPT_ED
Collocation Group Description: Education department
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 04/21/2004 10:59:03
Collocation Group Member(s): EDU_1 EDU_7

Collocation Group Name: GROUP1
Collocation Group Description: Low cap client nodes.
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 04/21/2004 10:59:16
Collocation Group Member(s): CHESTER REX NOAH JARED

where:
Collocation Group Name
The name of the collocation group.
Collocation Group Description
The description for the collocation group.
Last Update by (administrator)
The name of the administrator that defined or most recently updated the
collocation group.
Last Update Date/Time
The date and time that an administrator defined or most recently updated the
collocation group.
Collocation Group Member(s)
The members of the collocation group.
Related commands
Table 205. Commands related to QUERY COLLOCGROUP
Command Description
DEFINE COLLOCGROUP Defines a collocation group.
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE COLLOCGROUP Deletes a collocation group.
DELETE COLLOCMEMBER Deletes a client node from a collocation
group.
MOVE NODEDATA Moves data for one or more nodes, or a
single node with selected filespaces.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY NODEDATA Displays information about the location and
size of data for a client node.
QUERY STGPOOL Displays information about storage pools.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
UPDATE COLLOCGROUP Updates the description of a collocation
group.
UPDATE STGPOOL Changes the attributes of a storage pool.

QUERY COLLOCGROUP
Chapter 2. Administrative commands 657
QUERY CONTENT (Query the contents of a storage pool
volume)
Use this command to display information about files in a storage pool volume. You
can use this command to identify files that the server has found to be damaged
and files that have been backed up to a copy storage pool or copied to an
active-data pool.
This command is useful when a volume is damaged or before you:
v Request the server to fix inconsistencies between a volume and the database
v Move files from one volume to another volume
v Delete a volume from a storage pool
Because this command can take a long time to run and the results can be very
large, consider using the COUNT parameter to limit the number of files displayed.
Note: Files that are cached in a disk volume and that are marked as damaged are
not included in the results.
Privilege class
Any administrator can issue this command.
Syntax
Query CONtent volume_name
NODE

=

node_name

FIlespace

=

file_space_name

COUnt

=

number

Type = ANY
Type

=

ANY

Backup

Archive

SPacemanaged
Format = Standard
Format

=

Standard

Detailed

DAmaged

=

ANY

DAmaged

=

ANY

Yes

No
(1)
COPied

=

ANY

COPied

=

ANY

Yes

No

NAMEType = SERVER
NAMEType

=

SERVER

UNIcode

FSID
CODEType = BOTH
CODEType

=

UNIcode

NONUNIcode

BOTH

QUERY CONTENT

658 IBM Tivoli Storage Manager for Windows: Administrators Reference
Notes:
1 Use this parameter only for volumes in primary storage pools.
Parameters
volume_name (Required)
Specifies the volume to be queried.
NODE
Specifies the backup-archive client or the Tivoli Storage Manager for Space
Management (HSM client) associated with the file space to query. This
parameter is optional. You can use wildcard characters to specify this name. If
you do not specify a name, all backup-archive and HSM clients are included.
FIlespace
Specifies the file space to query. This parameter is optional. You can use
wildcard characters to specify this name. File space names are case-sensitive. If
you do not specify a file space name, all file spaces are included.
For a server that has clients with Unicode support, you may need to have the
server convert the file space name that you enter. For example, you may need
to have the server convert the name you enter from the servers code page to
Unicode. See the NAMETYPE parameter for details. If you do not specify a file
space name or specify only a single wildcard character for the name, you can
use the CODETYPE parameter to limit the operation to Unicode file spaces or
non-Unicode file spaces.
COUnt
Specifies the number of files to be displayed. This parameter is optional. You
can specify either a positive integer or a negative integer. If you specify a
positive integer, n, the first n files are displayed. If you specify a negative
integer, -n, the last n files are displayed in reverse order. You cannot specify
COUNT=0. If you do not specify a value for this parameter, all files are
displayed.
Type
Specifies the types of files to query. This parameter is optional. The default
value is ANY. If the volume being queried is assigned to an active-data pool,
the only valid values are ANY and BACKUP. Possible values are:
ANY
Specifies that all types of files in the storage pool volume are queried:
backup versions of files, archived copies of files, and files migrated from
HSM client nodes.
Backup
Specifies that only backup files are queried.
Archive
Specifies that only archive files are queried. This value is not valid for
active-data pools.
SPacemanaged
Specifies that only space-managed files (files migrated from HSM clients)
are queried. This value is not valid for active-data pools.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
QUERY CONTENT
Chapter 2. Administrative commands 659
Standard
Specifies that partial information is displayed. Unicode names are
converted to the server code page.
Detailed
Specifies that complete information is displayed. Unicode names are
displayed in hexadecimal.
DAmaged
Specifies criteria to restrict the query output based on whether files have been
marked as damaged. For purposes of this criteria, the server examines only
physical files (a file that may be a single logical file or an aggregate that
consists of logical files). This parameter is optional. The default value is ANY.
Possible values are:
ANY
Specifies that files are displayed regardless of whether the server has found
the files to be damaged.
Yes
Specifies that only files that have been marked as damaged are displayed.
These are files in which the server found errors when a user attempted to
restore, retrieve, or recall the file, or when an AUDIT VOLUME command
was run.
No
Specifies that only files not known to have been damaged are displayed.
COPied
Specifies criteria to restrict the query output based on whether files have been
backed up to a copy storage pool. Whether files are stored in an active-data
pool does not effect the output. This parameter is optional. The default value is
ANY. Possible values are:
ANY
Specifies that files are displayed regardless of whether the files are backed
up to a copy storage pool. Primary and cached file copies are displayed.
Yes
Specifies that the files displayed are only those for which at least one
usable backup copy exists in a copy storage pool. A file is not displayed if
its copy in the copy storage pool is known to have errors. Cached file
copies are not displayed because these files are never restored.
Use COPIED=YES to identify primary files that can be restored using the
RESTORE VOLUME or RESTORE STGPOOL command.
No
Specifies that the files displayed are only those for which no usable backup
copies exist in a copy storage pool. Cached file copies are not displayed
because these files are never restored.
Use COPIED=NO to identify primary files that cannot be restored using
the RESTORE VOLUME or RESTORE STGPOOL command.
NAMEType
Specify how you want the server to interpret the file space names that you
enter. This parameter is useful when the server has clients with Unicode
support. A backup-archive client with Unicode support is currently available
only for Windows, Macintosh OS 9, Macintosh OS X, and NetWare. Use this
parameter only when you specify a partly or fully qualified file space name.
QUERY CONTENT

660 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
The default value is SERVER. Possible values are:
SERVER
The server uses the servers code page to interpret the file space names.
UNIcode
The server converts the file space names from the server code page to the
UTF-8 code page. The success of the conversion depends on the actual
characters in the names and the servers code page. Conversion can fail if
the string includes characters that are not available in the server code page,
or if the server has a problem accessing system conversion routines.
FSID
The server interprets the file space names as their file space IDs (FSIDs).
CODEType
Specify how you want the server to interpret the file space names that you
enter. Use this parameter only when you enter a single wildcard character for
the file space name.
The default value is BOTH, which means that the file spaces are included
regardless of code page type. Possible values are:
UNIcode
Include only file spaces that are in unicode.
NONUNIcode
Include only file spaces that are not in unicode.
BOTH
Include file spaces regardless of code page type.
Examples
Task 1
Query the contents of the volume that is named f:\tsmstg\diskvol1.dsm. Limit the
query to files backed up from the PEGASUS client node.
Results of the command include all logical files that make up any aggregate that is
on the volume, even if the aggregate is stored on more than this volume. For
aggregates, the query does not determine which logical files are actually stored on
the volume for which the query is performed.
Command
query content f:\tsmstg\diskvol1.dsm node=pegasus
type=backup
Output
Node Name Type Filespace FSID Clients Name for File
Name
--------------- ---- ---------- ---- ----------------------
PEGASUS Bkup \\pegasus\e$ 1 \UNI_TEST\ SM01.DAT
PEGASUS Bkup \\pegasus\e$ 1 \UNI_TEST\ SM02.DAT
See Task 2 for parameter definitions.
Task 2
QUERY CONTENT
Chapter 2. Administrative commands 661
Query the contents of the tape volume named WPD001. Display only files backed
up by the node MARK, and only the first four files on the volume. Display
complete information.
Command
query content wpd001 node=mark count=4 type=backup
format=detailed
Output
Node Name: MARK
Type: Bkup
Filespace Name: \\mark\e$
Hexadecimal Filespace Name:
FSID: 1
Clients Name for File: \UNI_TEST\ SM01.DAT
Hexadecimal Clients Name for File:
Aggregated?: 1/3
Stored Size: 2,746
Segment Number:
Cached Copy?: No

Node Name: MARK
Type: Bkup
Filespace Name: \\mark\e$
Hexadecimal Filespace Name:
FSID: 1
Clients Name for File: \UNI_TEST\ SM02.DAT
Hexadecimal Clients Name for File:
Aggregated?: 2/3
Stored Size: 2,746
Segment Number:
Cached Copy?: No

Node Name: MARK
Type: Bkup
Filespace Name: \\mark\e$
Hexadecimal Filespace Name:
FSID: 1
Clients Name for File: \UNI_TEST\ SM03.DAT
Hexadecimal Clients Name for File:
Aggregated?: 3/3
Stored Size: 2,746
Segment Number:
Cached Copy?: No

Node Name: MARK
Type: Bkup
Filespace Name: \\mark\f$
Hexadecimal Filespace Name: 5c5c6d61726b5c6624
FSID: 2
Clients Name for File: \UNI_TEST\ ELAP.REX
Hexadecimal Clients Name for File: 5c554e495f544553545c20454c41502e52
Aggregated?: 1/3
Stored Size: 2,372
Segment Number:
Cached Copy?: No

Node Name
The node to which the file belongs.
Type
The type of file: archive (Arch), backup (Bkup), or space-managed (SpMg).
Filespace Name
The file space to which the file belongs.
File space names and file names that can be in a different code page or locale
than the server do not display correctly on the Administration Center or the
administrative command-line interface. The data itself is backed up and can be
QUERY CONTENT

662 IBM Tivoli Storage Manager for Windows: Administrators Reference
restored properly, but the file space or file name may display with a
combination of invalid characters or blank spaces.
If the file space name is Unicode enabled, the name is converted to the servers
code page for display. The results of the conversion for characters not
supported by the current code page depends on the operating system. For
names that Tivoli Storage Manager is able to partially convert, you may see
question marks (??), blanks, unprintable characters, or .... These characters
indicate to the administrator that files do exist. If the conversion is not
successful, the name is displayed as .... Conversion can fail if the string
includes characters that are not available in the server code page, or if the
server has a problem accessing system conversion routines.
Hexadecimal Filespace Name
The file space to which the file belongs. If the file space name is in Unicode,
the name is displayed in hexadecimal format.
FSID
The file space ID (FSID) for the file space. The server assigns a unique FSID
when a file space is first stored on the server.
Clients Name for File
The clients name for the file.
File space names and file names that can be in a different code page or locale
than the server do not display correctly on the Administration Center or the
administrative command-line interface. The data itself is backed up and can be
restored properly, but the file space or file name may display with a
combination of invalid characters or blank spaces. The results of the conversion
for characters not supported by the current code page depends on the
operating system. For names that Tivoli Storage Manager is able to partially
convert, you may see question marks (??), blanks, unprintable characters, or
.... These characters indicate to the administrator that files do exist.
Hexadecimal Clients Name for File
The clients name for the file displayed in hexadecimal format.
Aggregated?
Whether the file is a logical file that is stored as part of an aggregate. If the file
is part of an aggregate, the sequence of this file within the aggregate and the
total number of logical files in the aggregate are displayed. Results of the
command include all logical files that make up any aggregate that is on the
volume, even if the aggregate is stored on more than this volume. The query
does not determine which logical files are actually stored on the volume for
which the query is performed.
If the file is not part of an aggregate, the field simply displays no.
Stored Size
The size of the physical file, in bytes. If the file is a logical file that is stored as
part of an aggregate, this value indicates the size of the entire aggregate.
Segment Number
For volumes in sequential-access storage pools, specifies whether the physical
file (either a single logical file or an aggregate of logical files) is stored across
multiple volumes. For example, if the logical file is stored in an aggregate that
spans two volumes, the segment number indicates 1/2 (the first part of the
physical file is stored on the volume) or 2/2 (the second part of the physical file
is stored on the volume). If the segment number is 1/1, the physical file is
completely stored on the volume. For volumes in random-access storage pools,
no value is displayed for this field.
QUERY CONTENT
Chapter 2. Administrative commands 663
Cached Copy?
Whether the physical file is a cached copy of a file migrated to the next storage
pool. If the file is part of an aggregate, this value pertains to the aggregate.
Related commands
Table 206. Commands related to QUERY CONTENT
Command Description
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
COPY ACTIVEDATA Copies active backup data.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
DELETE VOLUME Deletes a volume from a storage pool.
RESTORE STGPOOL Restores files to a primary storage pool from
copy storage pools.
RESTORE VOLUME Restores files stored on specified volumes in
a primary storage pool from copy storage
pools.
UPDATE VOLUME Updates the attributes of storage pool
volumes.

QUERY CONTENT

664 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY COPYGROUP (Query copy groups)
Use this command to display information about one or more copy groups.
Privilege class
Any administrator can issue this command.
Syntax
Query COpygroup

* * * STANDARD
*

*

STANDARD

domain_name

*

STANDARD

policy_set_name

STANDARD

class_name

STANDARD

Type = Backup
Type

=

Backup

Archive
Format = Standard
Format

=

Standard

Detailed

Parameters
domain_name
Specifies the policy domain associated with the copy group to query. This
parameter is optional. You can use wildcard characters to specify names. If you
do not specify a value for this parameter, all policy domains are queried. You
must specify this parameter when querying an explicitly named copy group.
policy_set_name
Specifies the policy set associated with the copy group to query. This
parameter is optional. You can use wildcard characters to specify names. If you
do not specify a value for this parameter, all policy sets are queried. You must
specify this parameter when querying an explicitly named copy group.
class_name
Specifies the management class associated with the copy group to query. This
parameter is optional. You can use wildcard characters to specify names. If you
do not specify a value for this parameter, all management classes are queried.
You must specify this parameter when querying an explicitly named copy
group.
STANDARD
Specifies the name of the copy group. This parameter is optional. The name of
the copy group must be STANDARD. The default is STANDARD.
Type
Specifies the type of copy group to be queried. This parameter is optional. The
default value is BACKUP. Possible values are:
Backup
Specifies that you want to query backup copy groups.
QUERY COPYGROUP
Chapter 2. Administrative commands 665
Archive
Specifies that you want to query archive copy groups.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task 1
Display complete information on the backup copy group assigned to the
ACTIVEFILES management class in the VACATION policy set of the
EMPLOYEE_RECORDS policy domain.
Command
query copygroup employee_records vacation
activefiles format=detailed
Output
Policy Domain Name: EMPLOYEE_RECORDS
Policy Set Name: VACATION
Mgmt Class Name: ACTIVEFILES
Copy Group Name: STANDARD
Copy Group Type: Backup
Versions Data Exists: 5
Versions Data Deleted: 1
Retain Extra Versions: 30
Retain Only Version: 60
Copy Mode: Absolute
Copy Serialization: Shared Static
Copy Frequency: 3
Copy Destination: BACKUPPOOL
Table of Contents (TOC) Destination:
Last Update by (administrator): ADMIN
Last Update Date/Time: 10/02/2002 17.51.49
See Task 5 for parameter definitions.
Task 2
From a managed server, display complete information on the backup copy group
assigned to the STANDARD management class in the STANDARD policy set of the
ADMIN_RECORDS policy domain.
Command
query copygroup admin_records
standard standard format=detailed
Output

QUERY COPYGROUP

666 IBM Tivoli Storage Manager for Windows: Administrators Reference
Policy Domain Name: ADMIN_RECORDS
Policy Set Name: STANDARD
Mgmt Class Name: STANDARD
Copy Group Name: STANDARD
Copy Group Type: Backup
Versions Data Exists: 2
Versions Data Deleted: 1
Retain Extra Versions: 30
Retain Only Version: 60
Copy Mode: Modified
Copy Serialization: Shared Static
Copy Frequency: 0
Copy Destination: BACKUPPOOL
Table of Contents (TOC) Destination:
Last Update by (administrator): $$CONFIG_MANAGER$$
Last Update Date/Time: 2002.10.02 17.51.49
Managing profile: ADMIN_INFO

See Task 5 for parameter definitions.
Task 3
Display complete information on the archive copy group STANDARD that is
assigned to the ACTIVEFILES management class in the VACATION policy set of
the EMPLOYEE_RECORDS policy domain.
Command
query copygroup employee_records vacation
activefiles type=archive format=detailed
Output

Policy Domain Name: EMPLOYEE_RECORDS
Policy Set Name: VACATION
Mgmt Class Name: ACTIVEFILES
Copy Group Name: STANDARD
Copy Group Type: Backup
Versions Data Exists: 5
Versions Data Deleted: 1
Retain Extra Versions: 30
Retain Only Version: 60
Copy Mode: Absolute
Copy Serialization: Shared Static
Copy Frequency: 3
Copy Destination: BACKUPPOOL
Last Update by (administrator): ADMIN
Last Update Date/Time: 10/02/2002 13:15:47

See Task 5 for parameter definitions.
Task 4
From a managed server, display complete information on the archive copy group
STANDARD that is assigned to the MCLASS1 management class in the SUMMER
policy set of the PROG1 policy domain.
Command
query copygroup prog1 summer mclass1
type=archive format=detailed
Output

QUERY COPYGROUP
Chapter 2. Administrative commands 667
Policy Domain Name: PROG1
Policy Set Name: SUMMER
Mgmt Class Name: MCLASS1
Copy Group Name: STANDARD
Copy Group Type: Archive
Retain Version: 730
Retention Initiation: Creation
Minimum Retention:
Copy Serialization: Shared Static
Copy Frequency: Cmd
Copy Mode: Absolute
Copy Destination: ARCHPOOL
Last Update by (administrator): $$CONFIG_MANAGER$$
Last Update Date/Time: 2002.10.02 17.42.49
Managing profile: ADMIN_INFO

See Task 5 for parameter definitions.
Task 5
Query the copy group for the NAS backup.
Command
query copygroup
Output
Policy Domain Name: NASDOMAIN
Policy Set Name: ACTIVE
Mgmt Class Name: STANDARD
Copy Group Name: STANDARD
Copy Group Type: Backup
Versions Data Exists: 2
Versions Data Deleted: 1
Retain Extra Versions: 30
Retain Only Version: 60
Copy Mode: Modified
Copy Serialization: Shared Static
Copy Frequency: 0
Copy Destination: NASPOOL
Table of Contents (TOC) Destination: BACKUPPOOL
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 10/02/2002 12:16:52
Managing profile:

where:
Policy Domain Name
The name of the policy domain.
Policy Set Name
The name of the policy set.
Mgmt Class Name
The name of the management class.
Copy Group Name
The name of the copy group. This name is always STANDARD.
Copy Group Type
The type of the copy group.
Retain Version
The number of days to keep an archive copy.
QUERY COPYGROUP

668 IBM Tivoli Storage Manager for Windows: Administrators Reference
Retention Initiation
The time which the server initiates the retention time specified by the RETAIN
VERSION parameter. CREATION specifies that the retention time is initiated at
the time an archive copy is stored on the server. EVENT specifies that the
retention time is initiated at the time the server is notified of a
retention-initiating event for the archive copy.
Minimum Retention
The minimum number of days to keep an archive copy when Retention
Initiation is EVENT. The value of this parameter is not displayed when
Retention Initiation is CREATION.
Copy Serialization
Whether a file can be in use during an archive operation.
Copy Frequency
The copy frequency of the copy group. For archive copy groups, this value is
always CMD.
Copy Mode
Specifies that files in the copy group are archived regardless of whether they
have been modified. For archive copy groups, this value is always ABSOLUTE.
Copy Destination
The name of the storage pool where the server initially stores files associated
with this archive copy group.
Table of Contents (TOC) Destination
The name of the primary storage pool in which TOCs are initially stored for
image backup operations in which TOC generation is requested.
Last Update by (administrator)
The name of the administrator or server that most recently updated the copy
group. If this field contains $$CONFIG_MANAGER$$, the copy group is
associated with a domain that is managed by the configuration manager.
Last Update Date/Time
The date and time when the copy group was most recently defined or
updated.
Managing Profile
The profile or profiles to which the managed server subscribed to get the
definition of this policy copy group.
Related commands
Table 207. Commands related to QUERY COPYGROUP
Command Description
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DELETE COPYGROUP Deletes a backup or archive copy group from
a policy domain and policy set.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.

QUERY COPYGROUP
Chapter 2. Administrative commands 669
QUERY DATAMOVER (Display data mover definitions)
Use this command to display data mover definitions.
Privilege class
Any administrator can issue this command.
Syntax

Query DATAMover
*
data_mover_name
Format = Standard
Format

=

Standard

Detailed

Type = *
(1)

Type

=

NAS

Notes:
1 The type must be specified if FORMAT=DETAILED
Parameters
data_mover_name
Specifies the name of the data mover to display. You can specify multiple
names with a wildcard character. The default displays all data movers.
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Specifies that the assigned name and addressing information is specified.
Detailed
Specifies that complete information is displayed.
Type
Specifies the type of data mover to be displayed. This parameter must be
specified if the FORMAT = DETAILED.
NAS
Specifies a NAS device.
Examples
Task
Display the data movers on the TSM server.
Command
query datamover
Output

QUERY DATAMOVER

670 IBM Tivoli Storage Manager for Windows: Administrators Reference
Data Mover Name Type Online
------------- ----------- ------
NASMOVER1 NAS Yes
NASMOVER2 NAS No

Task
Display partial information on data mover DATAMOVER6.
Command
query datamover datamover6 type=nas
Output

Source Name Type Online
------------- ------- ------
DATAMOVER6 NAS Yes

See the next task for field descriptions.
Task
Display detailed information on data mover DATAMOVER6. The TYPE parameter
is required when FORMAT = DETAILED.
Command
query datamover datamover6 format=detailed type=nas
Output

Data Mover Name: DataMover6
Type: NAS
HLAddress: 9.115.38.5
LLAddress: 10000
USERid: NDMPadmin
Storage Pool Data Format: NDMPDUMP
Online: Yes
Last Update by (administrator): ADMIN
Last Update Date/Time: 04/28/2003 09:26:33

where:
Data Mover Name
Specifies the name of the data mover
Type
Specifies the type of the data mover
HLAddress
Specifies the IP address for the data mover.
LLAddress
Specifies the TCP port number for the data mover.
User ID
Specifies the user ID that the server uses to get access to the data mover.
Storage Pool Data Format
Specifies the data format that is used by this data mover.
QUERY DATAMOVER
Chapter 2. Administrative commands 671
Online
Specifies the whether the data mover is online and available for use.
Last Update by (administrator)
Specifies the ID of the administrator who performed the last update.
Last Update Date/Time
Specifies the date and time when the last update occurred.
Related commands
Table 208. Commands related to QUERY DATAMOVER
Command Description
DEFINE DATAMOVER Defines a data mover to the IBM Tivoli
Storage Manager server.
DELETE DATAMOVER Deletes a data mover.
UPDATE DATAMOVER Changes the definition for a data mover.

QUERY DATAMOVER

672 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY DB (Display information on the database)
Use this command to display information about the database.
Privilege class
Any administrator can issue this command.
Syntax

Query DB
Format = Standard
Format

=

Standard

Detailed

Parameters
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task
Display statistical information about the database.
Command
query db
Output

Available Assigned Maximum Maximum Page Total Used Pct Max.
Space Capacity Extension Reduction Size Pages Pages Util Pct
(MB) (MB) (MB) (MB) (bytes) Util
--------- -------- --------- --------- ------- ------ ----- ---- ----
8 4 4 0 4,096 1,024 94 9.2 9.2

See parameter definitions after the last task.
Task
Display statistical information about the database in detail.
Command
query db format=detailed
Output

QUERY DB
Chapter 2. Administrative commands 673
Available Space (MB): 8
Assigned Capacity (MB): 4
Maximum Extension (MB): 4
Maximum Reduction (MB): 0
Page Size (bytes): 4,096
Total Usable Pages: 1,024
Used Pages: 94
Pct Util: 9.2
Max. Pct Util: 9.2
Physical Volumes: 3
Buffer Pool Pages: 64
Total Buffer Requests: 4,702
Cache Hit Pct.: 97.68
Cache Wait Pct.: 0.00
Backup in Progress?: No
Type of Backup In Progress:
Incrementals Since Last Full: 0
Changed Since Last Backup (MB): 0.37
Percentage Changed: 100.00
Last Complete Backup Date/Time: 09/15/03 15:51:21
Estimate of Recoverable Space (MB): 321
Last Estimate of Recoverable Space: 09/13/03 06:03:20

where:
Available Space (MB)
The amount of space available, in megabytes.
Assigned Capacity (MB)
The assigned storage capacity, in megabytes.
Maximum Extension (MB)
The maximum amount the database can be extended, in megabytes.
Maximum Reduction (MB)
The maximum amount the database can be reduced, in megabytes.
Page Size (bytes)
The page size, in bytes.
Total Usable Pages
The total number of pages available. The total number of pages will always be
a multiple of the Assigned Capacity value, by a factor of 256 (1 megabyte/256
pages).
Used Pages
The total number of pages currently being used.
Pct Util
The current utilization as a percentage of the assigned capacity.
Max. Pct Util
The maximum occupancy for the database, as a percentage of the available
space. This value is the greatest utilization percentage.
Physical Volumes
The number of database volumes and copies.
Buffer Pool Pages
The number of pages in the database buffer pool.
Total Buffer Requests
The cumulative number of requests for database pages since the last RESET
BUFPOOL command (or since the server was last started).
QUERY DB

674 IBM Tivoli Storage Manager for Windows: Administrators Reference
Cache Hit Pct.
Specifies, as a percentage of the total number of requests, the number of
requests for a database page that are already in the buffer pool.
Cache Wait Pct.
Specifies, as a percentage, the number requests for a database buffer pool page
that was unavailable (because all buffer pool pages are occupied).
Backup in Progress?
Specifies if a backup is in progress.
Type of Backup in Progress
Specifies a full or an incremental backup.
Incremental Since Last Full
The number of incremental backups run since the last full backup.
Changed Since Last Backup (MB)
The database pages, in megabytes, that have changed since the last backup.
Percentage Changed
The percentage of pages that have changed since the last backup.
Last Complete Backup Date/Time
The date and time of the last complete backup.
Estimate of Recoverable Space (MB)
An estimate of the minimum amount of recoverable space, in megabytes.
Last Estimate of Recoverable Space
The date and time of the last recoverable space estimate.
Related commands
Table 209. Commands related to QUERY DB
Command Description
BACKUP DB Backs up the IBM Tivoli Storage Manager
database to sequential access volumes.
DEFINE DBCOPY Creates a volume copy of a database volume.
DEFINE DBVOLUME Assigns a volume to be used for database
storage.
ESTIMATE DBREORGSTATS Estimates the minimum amount of
recoverable space after a database
reorganization.
EXTEND DB Extends usable database storage within the
volumes previously allocated for its use.
EXTEND LOG Extends usable log storage within the
volumes previously allocated for its use.
REDUCE DB Attempts to free up a database volume by
reducing usable storage within the volumes
defined.
REDUCE LOG Attempts to free up a log volume by
reducing usable storage within the volumes
defined.
RESET BUFPOOL Resets the buffer pool statistics for the
database.
RESET DBMAXUTILIZATION Resets the maximum utilization statistic for
the database.
QUERY DB
Chapter 2. Administrative commands 675
QUERY DB

676 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY DBBACKUPTRIGGER (Query the database backup
trigger)
Use this command to display the settings for the database backup trigger.
Privilege class
Any administrator can issue this command.
Syntax

Query DBBackuptrigger
Format = Standard
Format

=

Standard

Detailed

Parameters
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Partial information is displayed.
Detailed
Detailed information is displayed.
Examples
Task
Display the settings for the database backup trigger.
Command
query dbbackuptrigger format=detailed
Output

Full Device Class: TAPECLASS
Incremental Device Class: TAPECLASS
Log Full Percentage: 75
Incrementals Between Fulls: 20
Minimum Backup Interval: 120
Minimum Log Percentage Freed: 10
Last Update by (administrator): JANET
Last Update Date/Time: 02/27/2002 12:57:52

where:
Full Device Class
The name of the device class used for full backups.
Incremental Device Class
The name of the device class used for incremental backups.
Log Full Percentage
The space utilization percentage of the recovery log at which Tivoli Storage
Manager automatically backs up the database.
QUERY DBBACKUPTRIGGER
Chapter 2. Administrative commands 677
Incrementals Between Fulls
The number of incremental database backups that Tivoli Storage Manager runs
between full backups.
Minimum Backup Interval
The minimum number of minutes that must elapse between a previous backup
and a subsequent automatic backup.
Minimum Log Percentage Freed
The minimum amount of log space that must be freed by the automatic
backup before the backup will be performed.
Last Update by (administrator)
The name of the administrator that most recently updated the trigger.
Last Update Date/Time
When the administrator most recently updated the trigger.
Related commands
Table 210. Commands related to QUERY DBBACKUPTRIGGER
Command Description
DEFINE DBBACKUPTRIGGER Defines a trigger for automatic IBM Tivoli
Storage Manager database backups.
DELETE DBBACKUPTRIGGER Deletes the database backup trigger.
UPDATE DBBACKUPTRIGGER Changes one or more attributes of the
database backup trigger.

QUERY DBBACKUPTRIGGER

678 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY DBVOLUME (Display information on one or more
database volumes)
Use this command to display information about database volumes and volume
copies.
Privilege class
Any administrator can issue this command.
Syntax

Query DBVolume
*
volume_name
Format = Standard
Format

=

Standard

Detailed

Parameters
volume_name
Specifies the database volume name. This parameter is optional. You can use
wildcard characters to specify names. If you do not specify a volume name,
information on all database volumes is displayed.
Note: Tivoli Storage Manager displays output in this command from the
lowest to the highest number. If a volume is deleted, Tivoli Storage
Manager reuses that volume number the next time that a volume is
defined. A query can then display volumes that are not in numerical
sequence. You can reset the order of your database volumes by
specifying the desired order with the DSMSERV LOADFORMAT
command.
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task
Display partial information on the database volume named db1.dsm.
Command
query dbvolume db1.dsm
Output

QUERY DBVOLUME
Chapter 2. Administrative commands 679
Volume Name Copy Volume Name Copy Volume Name Copy
(Copy 1) Status (Copy 2) Status (Copy 3) Status
---------------- ------ ---------------- ------ ----------- ------
c:\progra~1\tiv- Syncd c:\progra~1\tiv- Syncd Undef-
oli\tsm\server\- oli\tsm\server\- ined
db1.dsm db2.dsm

See parameter definitions after the last task.
Task
Display detailed information on the database volume named db1.dsm.
Command
query dbvolume db1.dsm format=detailed
Output
Volume Name (Copy 1): L:\WIN32APP\IBM\ADSM\SERVER\DB1.DSM
Copy Status: Syncd
Volume Name (Copy 2): L:\WIN32APP\IBM\ADSM\SERVER\DB3.DSM
Copy Status: Undefined
Volume Name (Copy 3):
Copy Status: Undefined
Available Space (MB): 4
Allocated Space (MB): 4
Free Space (MB): 0

where:
Volume Name (Copy n)
The name of the volume. The output displays status of up to three volume
copies (Copy 1, Copy 2, and Copy 3).
Copy Status
The status of the volume. Possible values are:
Offline
The volume is varied offline.
Stale
The volume is not synchronized with the other volumes and cannot be
used for storage.
Syncd
The volume is synchronized with the other volumes and can be used for
storage.
Undefined
No volume has been defined.
Available Space (MB)
The total amount of space that is available, both allocated and free, in
megabytes.
Allocated Space
The amount of space allocated, in megabytes.
Free Space
The amount of unassigned space for this mirror set that can be allocated for
use, in megabytes.
QUERY DBVOLUME

680 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 211. Commands related to QUERY DBVOLUME
Command Description
DEFINE DBCOPY Creates a volume copy of a database volume.
DEFINE DBVOLUME Assigns a volume to be used for database
storage.
DELETE DBVOLUME Deletes a volume from the database.
VARY Specifies whether a disk volume is available
to the server for use.

QUERY DBVOLUME
Chapter 2. Administrative commands 681
QUERY DEVCLASS (Display information on one or more
device classes)
Use this command to display information on one or more device classes.
Privilege class
Any administrator can issue this command.
Syntax

Query DEVclass
*
device_class_name
Format = Standard
Format

=

Standard

Detailed

Parameters
device_class_name
Specifies the name of the device class to be queried. This parameter is optional.
You can use wildcard characters to specify this name. All matching device
classes are displayed. If you do not specify a value for this parameter, all
device classes are displayed.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the specified device class.
Detailed
Specifies that complete information is displayed for the specified device
class.
Examples
Task
Display information on all device classes.
Command
query devclass
Output
Device Device Storage Device Format Est/Max Mount
Class Access Pool Type Capacity Limit
Name Strategy Count (MB)
----------- ---------- ------- ------ ------ -------- -----
8MMTAPE Sequential 1 8MM DRIVE 6,144.0 2
DISK Random 4
PLAINFILES Sequential 1 FILE 50.0 1
8MMSP2 Sequential 2 8MM DRIVE 44.4 DRIVES

Task
Display information in full detail on the PLAINFILES device class.
QUERY DEVCLASS

682 IBM Tivoli Storage Manager for Windows: Administrators Reference
Command
query devclass plainfiles format=detailed
Output
Device Class Name: PLAINFILES
Device Access Strategy: Sequential
Storage Pool Count: 1
Device Type: FILE
Format:
Est/Max Capacity (MB): 50.0
Mount Limit: 1
Mount Wait (min):
Mount Retention (min):
Label Prefix:
Drive Letter:
Library:
Directory:
Server Name:
Retry Period:
Two-Sided:
Retry Interval:
Shared:
Last Update by (administrator): ADMIN
Last Update Date/Time: 05/31/2000 13:15:36

Task
Display information in full detail on the 3592 device class.
Command
query devclass 3592 format=detailed
Output
Device Class Name: 3592
Device Access Strategy: Sequential
Storage Pool Count: 1
Device Type: 3592
Format: 3592
Est/Max Capacity (MB):
Mount Limit: DRIVES
Mount Wait (min): 60
Mount Retention (min): 60
Label Prefix: ADSM
Drive Letter:
Library: MANLIB
Directory:
Server Name:
Retry Period:
Two-Sided:
Retry Interval:
Shared:
HLAddr:
WORM: No
Scaled Capacity: 90
Drive Encryption: On
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 08/04/03 14:28:31

Device Class Name
The name of the device class.
Device Access Strategy
How data is written to the device class.
Storage Pool Count
The number of storage pools that are assigned to the device class.
QUERY DEVCLASS
Chapter 2. Administrative commands 683
Device Type
The device type of the device class.
Format
The recording format.
Est/Max Capacity (MB)
The estimated or maximum capacity of a volume associated with the device
class.
Mount Limit
The maximum number of sequential access volumes that can be mounted
concurrently or specifies that DRIVES is the mount limit.
Mount Wait (min)
The maximum number of minutes to wait for a sequential access volume to be
mounted.
Mount Retention (min)
The number of minutes to retain an idle sequential access volume before
dismounting it.
Label Prefix
The high-level qualifier of the data set name that the server writes into the
sequential access media labels.
Drive Letter
The drive letter for a removable file.
Library
The name of the defined library object that contains the drives used by the
device class.
Directory
The directory or directories for a shared FILE device class.
Server Name
The name of a defined server.
Retry Period
The interval over which the server should attempt to contact a target server if
communications failure is suspected.
Retry Interval
How often the retries are done within a given retry period.
Two-Sided
Whether a removable file is two-sided.
Shared
Whether this FILE device class will be shared between the server and one or
more storage agents.
HLAddress
The IP address of the device in dotted decimal format.
WORM
Whether this drive is a WORM (write once, read many) device.
Scaled Capacity
The percentage of the media capacity that can be used to store data.
Drive Encryption
Whether drive encryption is permitted. This field applies only to volumes in a
storage pool associated with a device type of 3592 or LTO.
QUERY DEVCLASS

684 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
Last Update by (administrator)
The administrator that made the last update to the device class.
Last Update Date/Time
The date and time of the last update.
Related commands
Table 212. Commands related to QUERY DEVCLASS
Command Description
DEFINE DEVCLASS Defines a device class.
DEFINE SERVER Defines a server for server-to-server
communications.
DELETE DEVCLASS Deletes a device class name.
QUERY DIRSPACE Displays information about FILE directories.
QUERY SERVER Displays information about servers.
UPDATE DEVCLASS Changes the attributes of a device class.

QUERY DEVCLASS
Chapter 2. Administrative commands 685
QUERY DIRSPACE (Query storage utilization of FILE
directories)
Use this command to display information about free space in the directories
associated with a device class with a device type of FILE.
Privilege class
Any administrator can issue this command.
Syntax
Query DIRSPace
device_class_name


Parameters
device_class_name
Specifies the name of the device class to be queried. This parameter is optional.
You can use wildcard characters to specify this name. All matching device
classes of device type FILE are displayed. If you do not specify a value for this
parameter, all device classes of device type FILE are displayed.
Examples
Task
Display information for all device classes with a device type of FILE:
Command
query dirspace
Output

Device Directory Estimated Estimated
Class Capacity Available
----------- ---------------------------- ---------- ----------
DBBKUP G:\This\is\a\large\directory 13,000 M 5,543 M
DBBKUP G:\This\is\directory2 13,000 M 7,123 M
DBBKUP2 G:\This\is\a\huge\directory 2,256 G 2,200 G

where the unit M is equivalent to megabytes, and the unit G is equivalent to
gigabytes.
Related commands
Table 213. Commands related to QUERY DIRSPACE
Command Description
DEFINE DEVCLASS Defines a device class.
DELETE DEVCLASS Deletes a device class name.
QUERY DEVCLASS Displays information about device classes.
UPDATE DEVCLASS Changes the attributes of a device class.

QUERY DIRSPACE

686 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY DOMAIN (Query a policy domain)
Use this command to display information on one or more policy domains.
Privilege class
Any administrator can issue this command.
Syntax

Query DOmain
*
domain_name
Format = Standard
Format

=

Standard

Detailed

Parameters
domain_name
Specifies the policy domain to query. This parameter is optional. You can use
wildcard characters to specify names. If you do not specify a value for this
parameter, all policy domains are displayed.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task
Display partial information for all policy domains on the server.
Command
query domain
Output

Policy Activated Activated Number of Description
Domain Policy Default Registered
Name Set Mgmt Nodes
Class
--------- --------- --------- ---------- -----------------
EMPLOYEE- VACATION ACTIVEFI- 6 Employee Records
_RECORDS LES Domain
PROG1 0 Programming Group
Test Domain
PROG2 0 Programming Group
Test Domain
STANDARD STANDARD STANDARD 1 Installed default
policy domain

See parameter definitions after the last task.
Task
QUERY DOMAIN
Chapter 2. Administrative commands 687
From a managed server, display information in full detail for the
EMPLOYEE_RECORDS policy domain.
Command
query domain employee_records format=detailed
Output

Policy Domain Name: EMPLOYEE_RECORDS
Activated Policy Set: VACATION
Activation Date/Time: 1998.06.04 17.18.30
Days Since Activation: <1
Activated Default Mgmt Class: ACTIVEFILES
Number of Registered Nodes: 6
Description: Employee Records domain
Backup Retention (Grace Period): 30
Archive Retention (Grace Period): 365
Last Update by (administrator): $$CONFIG_MANAGER$$
Last Update Date/Time: 06/04/1998 17:18:30
Managing Profile: ADMIN_INFO

See parameter definitions after the last task.
Task
The active-data pool list is displayed during a QUERY DOMAIN F=D command.
Command
query domain format=detailed
Output

Policy Domain Name: STANDARD
Activated Policy Set: STANDARD
Activation Date/Time: 05/16/2006 16:18:05
Days Since Activation: 15
Activated Default Mgmt Class: STANDARD
Number of Registered Nodes: 1
Description: Installed default policy domain.
Backup Retention (Grace Period): 30
Archive Retention (Grace Period): 365
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 05/31/2006 15:17:48
Managing profile:
Changes Pending: Yes
Active Data Pool List: ADPPOOL

where:
Policy Domain Name
The name of the policy domain.
Activated Policy Set
The name of the policy set that was last activated in the domain.
The definitions in the last activated policy set and the ACTIVE policy set are
not necessarily identical. When you activate a policy set, the server copies the
contents of the policy set to the policy set with the special name ACTIVE. The
copied definitions in the ACTIVE policy set can be modified only by activating
another policy set. You can modify the original policy set without affecting the
ACTIVE policy set. Therefore, definitions in the policy set that was last
activated might not be the same as those in the ACTIVE policy set.
QUERY DOMAIN

688 IBM Tivoli Storage Manager for Windows: Administrators Reference
Activation Date/Time
The date and time that the policy set was activated.
Days Since Activation
The number of days since the policy set was activated.
Activated Default Mgmt Class
The assigned default management class for the policy set.
Number of Registered Nodes
The number of client nodes registered to the policy domain.
Description
The description of the policy domain.
Backup Retention (Grace Period)
The number of days to retain inactive backup versions of files when any of the
following conditions occur:
v A file is rebound to a new management class, but neither the new
management class nor default management class contains a backup copy
group.
v The management class to which a file is bound no longer exists, and the
default management class does not contain a backup copy group.
v The backup copy group is deleted from the management class to which a
file is bound and the default management class does not contain a backup
copy group.
Archive Retention (Grace Period)
The number of days to retain an archive file that meets either of the following
conditions:
v The management class to which a file is bound no longer exists, and the
default management class does not contain an archive copy group.
v The archive copy group is deleted from the management class to which a
file is bound and the default management class does not contain an archive
copy group.
Last Update by (administrator)
The administrator that defined or most recently updated the policy domain. If
this field contains $$CONFIG_MANAGER$$, the policy domain is associated
with a profile that is managed by the configuration manager.
Last Update Date/Time
When the administrator defined or most recently updated the policy domain.
Managing Profile
The profile or profiles to which the managed server subscribed to get the
definition of this policy domain.
Changes Pending
Whether or not changes are being made.
Active Data Pool List
The list of active data pool names in the domain.
Related commands
Table 214. Commands related to QUERY DOMAIN
Command Description
COPY DOMAIN Creates a copy of a policy domain.
QUERY DOMAIN
Chapter 2. Administrative commands 689
Table 214. Commands related to QUERY DOMAIN (continued)
Command Description
DEFINE DOMAIN Defines a policy domain that clients can be
assigned to.
DELETE DOMAIN Deletes a policy domain along with any
policy objects in the policy domain.
UPDATE DOMAIN Changes the attributes of a policy domain.

QUERY DOMAIN

690 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY DRIVE (Query information about a drive)
Use this command to display information about the drives associated with a
library.
Privilege class
Any administrator can issue this command.
Syntax

Query DRive
* *
*

library_name

drive_name
Format = Standard
Format

=

Standard

Detailed

Parameters
library_name
Specifies the name of the library where the queried drive is located. This
parameter is optional. You can use a wildcard character to specify this name.
You must specify a value for this parameter if you specify a drive name
drive_name
Specifies the name assigned to the drive. This parameter is optional. You can
use a wildcard character to specify this name. If you specify a drive name, you
must also specify a LIBRARY_NAME.
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the drive.
Detailed
Specifies that complete information is displayed for the drive.
Examples
Task
Display information about all drives associated with the server.
Command
query drive
Output
Library Drive Device Online
Name Name Type
-------- ------ -------- -----
LIB1 DRIVE01 3590 Yes
LIB2 DRIVE02 3590 Yes

Task
QUERY DRIVE
Chapter 2. Administrative commands 691
Display detailed information about the drive named DRIVE02 that is associated
with the library LIB2.
Command
query drive lib2 drive02 format=detailed
Output
Library Name: LIB2
Drive Name: DRIVE02
Device Type: 3590
On Line: Yes
Drive State: Empty
ACS DriveID:
Allocated to:
Last Update by (administrator): ADMIN
Last Update Date/Time: 02/29/2002 09:26:23
Cleaning Frequency (Gigabytes/ASNEEDED/NONE): NONE

where:
Library Name
The name of the library to which the drive is assigned.
Drive Name
The name assigned to the drive.
Device Type
The device type as specified in the associated device class. The server must
have a path defined from the server to the drive in order to determine the true
device type. As long as there is a path defined from the server to the drive, the
server will display the true device type of the drive even if there are other
paths defined to this drive. Exceptions to this occur if the device type is remote
or unknown.
REMOTE
The server does not have a path to the device. The only defined paths to
the device are from data movers.
UNKNOWN
No path exists.
Note: Review the output of the QUERY PATH command to determine if the
desired paths are defined. If they are not defined, define those desired
paths using the DEFINE PATH command. Also, if using a data mover
device, review the output of the QUERY DATAMOVER command to
determine the type of the data mover device. If you are using a path
from the server to a drive, the device type of the device class and the
drive need to match. If you are using a path from a data mover device
to a drive, review the documentation for your type of data mover to
ensure the device type of the device class is compatible with the type of
data mover device.
On Line
Specifies the status of the drive:
Yes
The drive is online and available for server operations.
No
The drive is offline and was put in this state by an administrator updating
the status.
QUERY DRIVE

692 IBM Tivoli Storage Manager for Windows: Administrators Reference
Unavailable Since
Specifies that the the drive has been unavailable since mm/dd/yy
hh:mm:ss. Output shows the time the server marked the drive as
unavailable.
Polling Since
Specifies that the server is polling the drive because the drive stopped
responding. Output shows the time the server detected a problem and
began polling. The server will poll a drive before stating it is unavailable.
The time output follows the format: mm/dd/yy hh:mm:ss.
For more information on conditions under which the server will poll, see
Administrators Guide.
Drive State
This specifies the current state of this particular drive based on the result of
the last SCSI command to the drive or library. The server tracks the state of the
drive to improve its selection of a drive for an operation and its drive recovery
operations. The values are:
Unavailable
The drive is not available to the library for operations.
Empty
The drive is empty and ready for operations.
Loaded
The drive is currently loaded, and the server is performing operations to
the drive.
Unloaded
The media has been ejected from the drive.
Reserved
The drive is reserved for a mount request.
Unknown
The drive begins in drive state unknown as a result of being defined, as a
result of server initialization, or as a result of having its status updated to
online.
ACS DriveId
The ID that specifies the physical location of the drive in an ACSLS library.
This drive ID is specified as a,l,p,d, where a is the ACSID, l is the LSM (library
storage module), p is the panel number, and d is the drive ID.
Allocated To
The name of the library client that is currently using the drive. This applies to
shared SCSI libraries only; the field is left blank for all other libraries.
Last Update by (administrator)
Who performed the last update to the drive.
Last Update Date/Time
The date and time when the last update occurred.
Cleaning Frequency
How often the server activates drive cleaning. This value can be the number of
gigabytes, NONE, or ASNEEDED.
QUERY DRIVE
Chapter 2. Administrative commands 693
Related commands
Table 215. Commands related to QUERY DRIVE
Command Description
AUDIT LIBRARY Ensures that an automated library is in a
consistent state.
DEFINE DRIVE Assigns a drive to a library.
DEFINE LIBRARY Defines an automated or manual library.
DEFINE PATH Defines a path from a source to a destination.
DELETE DRIVE Deletes a drive from a library.
DELETE LIBRARY Deletes a library.
QUERY LIBRARY Displays information about one or more
libraries.
UPDATE DRIVE Changes the attributes of a drive.

QUERY DRIVE

694 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY DRMEDIA (Query disaster recovery media)
Use this command to display information about database backup and copy storage
pool volumes. You can also use the command to create a file of executable
commands to process the volumes.
The QUERY DRMEDIA command always processes eligible copy storage pool
volumes (see the description of the COPYSTGPOOL parameter for details about
eligible copy storage pool volumes). Database backups (full and incremental types,
or snapshot types) can also be processed, depending on the setting for the
SOURCE parameter. The other parameters of the command (such as
WHERESTATE) can further limit the results of the query.
If you are using an external library and have moved a volume to the
NOTMOUNTBLE state using the MOVE DRMEDIA command, the QUERY
DRMEDIA command might still report the volume state as MOUNTABLE if it
detects that the volume is in the library. Refer to the external library
documentation for information about the procedures that you should follow when
using the MOVE DRMEDIA and the QUERY DRMEDIA commands.
Privilege class
To issue this command, you must have one of the following privilege classes:
v If the CMD parameter is NOT specified: operator or system privilege.
v If the CMD parameter is specified and the REQSYSAUTHOUTFILE server option is
set to NO: operator, unrestricted storage, or system privilege.
v If the CMD parameter is specified and the REQSYSAUTHOUTFILE server option is
set to YES (the default): system privilege.
Syntax

Query DRMedia
*
volume_name
WHERESTate = All
WHERESTate

=

All

MOuntable

NOTMOuntable

COUrier

VAult

VAULTRetrieve

COURIERRetrieve

REmote

BEGINDate

=

date

ENDDate

=

date

BEGINTime

=

time

ENDTime

=

time

COPYstgpool

=

pool_name

QUERY DRMEDIA
Chapter 2. Administrative commands 695

Source = DBBackup
Source

=

DBBackup

DBSnapshot

DBNone
Format = Standard
Format

=

Standard

Detailed

Cmd

WHERELOCation

=

location

CMd

=

command

CMDFilename

=

file_name


Parameters
volume_name
Specifies the names of the database backup and copy storage pool volumes to
be queried. You can use wildcard characters to specify multiple names. This
parameter is optional. The server looks for matching names among the
following eligible volumes:
v Database backup volumes, as selected by the SOURCE parameter of this
command.
v Copy storage pool volumes from copy storage pools named in the
COPYSTGPOOL parameter. If you do not use the COPYSTGPOOL
parameter, the server queries volumes from copy storage pools previously
selected by the SET DRMCOPYSTGPOOL command.
Other parameters can also limit the results of the query.
WHEREState
Specifies the state of volumes to be processed. This parameter is optional. The
default is ALL. Possible values are:
All
Specifies all volumes in all states.
MOuntable
Volumes in this state contain valid data and are accessible for onsite
processing.
NOTMOuntable
Volumes in this state are onsite, contain valid data, and not accessible for
onsite processing.
COUrier
Volumes in this state are being moved to an offsite location.
VAult
Volumes in this state are offsite, contain valid data, and are not accessible
for onsite processing.
VAULTRetrieve
Volumes in this state are located at the offsite vault, do not contain valid
data and can be moved back onsite for reuse or disposal:
v A copy storage pool volume is considered to be in the VAULTRETRIEVE
state if it has been empty for at least the number of days specified with
the REUSEDELAY parameter on the DEFINE STGPOOL command.
QUERY DRMEDIA

696 IBM Tivoli Storage Manager for Windows: Administrators Reference
v A database backup volume is considered to be in the VAULTRETRIEVE
state if it is associated with a database backup series that was expired
based on the value specified using the SET
DRMDBBACKUPEXPIREDAYS command.
Note: When you issue QUERY DRMEDIA
WHERESTATE=VAULTRETRIEVE, the server dynamically
determines which volumes can be moved back onsite for reuse or
disposal. Therefore, to ensure that you identify all volumes that are
in a VAULTRETRIEVE state, issue QUERY DRMEDIA
WHERESTATE=VAULTRETRIEVE without the BEGINDATE,
ENDDATE, BEGINTIME or ENDTIME parameters. The Last Update
Date/Time field in the output for QUERY DRMEDIA
WHERESTATE=VAULTRETRIEVE displays the date and time that a
volume was moved to the VAULT state, not VAULTRETRIEVE.
COURIERRetrieve
Volumes in this state are being moved back to the onsite location.
REmote
Volumes in this state contain valid data and are located at the offsite
remote server.
BEGINDate
Specifies the beginning date used to select volumes. This parameter is optional.
Volumes are considered eligible if the MOVE DRMEDIA command has
changed the volume to its current state on or after the specified date. The
default is the earliest date for which volume information exists.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY-days or -days The current date minus days
specified. The maximum
number of days is 9999.
TODAY7 or 7.
To query volumes beginning with
records changed to their current state
a week ago, you can specify
BEGINDATE=TODAY-7 or
BEGINDATE=-7.

ENDDate
Specifies the ending date used to select volumes. This parameter is optional.
Volumes are considered eligible if the MOVE DRMEDIA command has
changed the volume to its current state on or before the specified date. The
default is the current date.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
QUERY DRMEDIA
Chapter 2. Administrative commands 697
Value Description Example
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days is 9999.
TODAY7 or 7.
To query volumes beginning with
records changed to their current state
a week ago, you can specify
BEGINDATE=TODAY-7 or
BEGINDATE=-7.

BEGINTime
Specifies the beginning time used to select volumes. This parameter is optional.
Volumes are considered eligible if the MOVE DRMEDIA command has
changed the volume to its current state on or after the specified time and date.
The default is midnight (00:00:00) on the date specified with the BEGINDATE
parameter.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the
specified begin date
12:33:28
NOW The current time on the
specified begin date
NOW
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
begin date
NOW+03:00 or +03:00.
If you issue QUERY DRMEDIA
command at 9:00 with
BEGINTIME=NOW+03:00 or
BEGINTIME=+03:00. Tivoli Storage
Manager displays volumes that were
changed to their current state at 12:00
on the begin date you specify.
NOW-HH:MM or
-HH:MM
The current time minus hours
and minutes on the specified
begin date
NOW-03:30 or -03:30.
If you issue QUERY DRMEDIA
command at 9:00 with
BEGINTIME=NOW-03:30 or
BEGINTIME=-03:30. Tivoli Storage
Manager displays volumes that were
changed to their current state at 5:30
on the begin date you specify.

ENDTime
Specifies the ending time used to select volumes. This parameter is optional.
Volumes are considered eligible if the MOVE DRMEDIA command has
changed the volume to its current state on or before the specified time and
date. The default is 23:59:59.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the
specified end date
10:30:08
NOW The current time on the
specified end date
NOW
QUERY DRMEDIA

698 IBM Tivoli Storage Manager for Windows: Administrators Reference
Value Description Example
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
end date
NOW+03:00 or +03:00.
If you issue QUERY DRMEDIA
command at 9:00 with
ENDTIME=NOW+03:00 or
ENDTIME=+03:00, Tivoli Storage
Manager processes volumes that
were changed to their current state
at 12:00 on the end date you specify.
NOW-HH:MM or
-HH:MM
The current time minus
hours and minutes on the
specified end date
NOW-03:30 or -03:30
If you issue QUERY DRMEDIA
command at 9:00 with
ENDTIME=NOW-03:00 or
ENDTIME=-03:00, Tivoli Storage
Manager processes volumes that
were changed to their current state
at 6:00 on the end date you specify.

COPYstgpool
Specifies the name of the copy storage pool whose volumes are to be
processed. This parameter is optional. You can use wildcard characters to
specify this name. The copy storage pools specified with this parameter
override those specified with the SET DRMCOPYSTGPOOL command. If you
do not specify a copy storage pool name, all volumes in the specified state are
processed.
Source
Specifies whether any database backup volumes are selected. This parameter is
optional. The default is DBBACKUP. Possible values are:
DBBackup
Full and incremental database backup volumes are selected.
DBSnapshot
Snapshot database backup volumes are selected.
DBNone
No database backup volumes are selected.
Format
Specifies the information to be displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that detailed information is displayed.
Cmd
Specifies that executable commands are built for the selected volumes. If
you specify FORMAT=CMD, you must also specify the CMD parameter.
WHERELOcation
Specifies the location of the volumes to be queried. This parameter is optional.
The maximum length of the location is 255 characters. Enclose the text in
quotation marks if it contains any blank characters. If you specify a target
server name, the disaster recovery manager displays all database backup
volumes and copy storage pool volumes located on the target server.
QUERY DRMEDIA
Chapter 2. Administrative commands 699
CMd
Specifies the creation of executable commands to process the volume name and
location obtained by this command. This parameter is optional. You must
enclose the command specification in quotation marks. The maximum length
of this parameter is 255 characters. The disaster recovery manager writes the
commands to a file specified by the CMDFILENAME parameter or the SET
DRMCMDFILENAME command, or generated by the QUERY DRMEDIA
command. If the command length is greater than 240 characters, it is split into
multiple lines and a continuation characters (+) are added. You may need to
alter the continuation character according to the product that runs the
commands.
If you do not specify the FORMAT=CMD parameter, this command will not
write create any command lines.
string
The command string. The string must not include embedded quotation
marks. For example, this is a valid CMD parameter:
cmd="checkin libvol lib8mm &vol status=scratch"
This is an example of a CMD parameter that is not valid:
cmd=""checkin libvolume lib8mm" &vol status=scratch""
substitution
Specifies a substitution variable to tell QUERY DRMEDIA to substitute a
value for the variable. The variables are not case-sensitive, and must not
contain blank spaces after the ampersand (&). The possible variables are:
&VOL
A volume name variable.
&LOC
A volume location.
&VOLDSN
The name of the file the server writes into the sequential access media
labels. An example of a copy storage pool tape volume file name using
the default prefix TSM is TSM.BFS. An example of a database backup
tape volume file name using a prefix TSM310 defined with the device
class is TSM310.DBB.
&NL
The new line character. When &NL is specified, QUERY DRMEDIA
command splits the command at the &NL variable and does not
append a continuation character. You must specify the proper
continuation character before the &NL if one is required. If the &NL is
not specified and the command line is greater than 240 characters, the
line is split into multiple lines and continuation characters (+) are
added.
CMDFilename
Specifies the fully qualified name of the file to contain the commands specified
with CMD parameter. This parameter is optional. If you do not specify a file
name with the SET DRMCMDFILENAME, Tivoli Storage Manager creates a
file name by appending exec.cmd to the directory representing this instance of
the Tivoli Storage Manager server (typically the directory that the Tivoli
Storage Manager server was originally installed from). If you specify a null
string () , the commands are displayed on the console only. You can re-direct
the commands to a file using > or >> provided by the system. The disaster
QUERY DRMEDIA

700 IBM Tivoli Storage Manager for Windows: Administrators Reference
recovery manager allocates the file name specified or generated. If the file
exists, the disaster recovery manager tries to use it and any existing data is
overwritten.
If the operation fails after the command file has been created, the file is not
deleted.
Examples
Task 1
Display all volumes to be given to a courier for off-site storage.
Command
query drmedia wherestate=notmountable
format=standard
Output

Volume Name State Last Update Automated
Date/Time LibName
--------------- -------------- -------------------- ---------
TAPE01 Not mountable 01/20/1998 14:25:22
DBTP01 Not mountable 01/20/1998 14:25:22
DBTP03 Not mountable 01/20/1998 14:31:53

Task 2
Display detailed information about all volumes at the vault.
Command
query drmedia wherestate=vault format=detailed
Output
Volume Name: DBTP02
State: Vault
Last Update Date/Time: 01/20/1998 13:29:02
Location: Ironmnt
Volume Type: DBBackup
Copy Storage Pool Name:
Automated LibName:

where:
Volume Name
The name of the database backup or copy storage pool volume.
State
The state of the volume.
Last Update Date/Time
The date and time that the volume state was last updated. For volumes in the
VAULTRETRIEVE state, this field displays the date and time that a volume
was moved to the VAULT state, not VAULTRETRIEVE. The server does not
update volumes to VAULTRETRIEVE. At the time the QUERY DRMEDIA
command is issued, the server dynamically determines whether the data in
copy storage pool volumes and database backup volumes is no longer valid
and whether the volume can be brought back onsite for reuse or disposal.
QUERY DRMEDIA
Chapter 2. Administrative commands 701
Location
The volume location.
Volume Type
The type of volume. Possible values are:
DBBackup
A full or incremental database backup volume.
DBSnapshot
A database snapshot backup volume.
CopyStgPool
A copy storage pool volume.
Copy Storage Pool Name
For a copy storage pool volume, the name of the copy storage pool.
Automated LibName
The name of the automated library if the volume is in a library.
Related commands
Table 216. Commands related to QUERY DRMEDIA
Command Description
BACKUP DB Backs up the IBM Tivoli Storage Manager
database to sequential access volumes.
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
CHECKOUT LIBVOLUME Checks a storage volume out of an
automated library.
MOVE DRMEDIA Moves DRM media onsite and offsite.
SET DRMCOPYSTGPOOL Specifies that copy storage pools are
managed by DRM.
SET DRMDBBACKUPEXPIREDAYS Specifies criteria for database backup series
expiration.
SET DRMCMDFILENAME Specifies a file name for containing DRM
executable commands.
SET DRMFILEPROCESS Specifies whether the MOVE DRMEDIA or
QUERY DRMEDIA command processes files
associated with a device type of file.

QUERY DRMEDIA

702 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY DRMSTATUS (Query disaster recovery manager
system parameters)
Use this command to display information about the system parameters defined for
disaster recovery manager (DRM).
Privilege class
Any administrator can issue this command.
Syntax
Query DRMSTatus

Parameters
None.
Examples
Task
Display information about the DRM system parameters.
Command
query drmstatus
Output
Recovery Plan Prefix:
Plan Instructions Prefix:
Replacement Volume Postfix: @
Primary Storage Pools: PRIM1 PRIM2
Copy Storage Pools: COPY*
Not Mountable Location name: Local
Courier Name: Fedex
Vault Site Name: Ironmnt
DB Backup Series expiration days: 30 Day(s)
Recovery Plan File Expiration Days: 30 Days(s)
Check Label?: No
Process FILE Device Type?: No
Command file name:

where:
Recovery Plan Prefix
User-specified prefix portion of the file name for the recovery plan file.
Plan Instructions Prefix
User-specified prefix portion of the file names for the server recovery
instructions files.
Replacement Volume Postfix
The character added to the end of the replacement volume names in the
recovery plan file.
Primary Storage Pools
The primary storage pools that are eligible for processing by the PREPARE
command. If this field is blank, all primary storage pools are eligible.
QUERY DRMSTATUS
Chapter 2. Administrative commands 703
Copy Storage Pools
The copy storage pools that are eligible for processing by the MOVE
DRMEDIA, PREPARE, and QUERY DRMEDIA commands. If this field is
blank, all copy storage pools are eligible.
Not Mountable Location Name
The name of the offsite location where the media to be shipped are stored.
Courier Name
The name of the courier used to carry the media to the vault.
Vault Site Name
The name of the vault where the media is stored.
DB Backup Series Expiration Days
The minimum number of days that must elapse since a database series has
been created before it is eligible to be expired. See the SET
DRMDBBACKUPEXPIREDAYS command for information about the criteria
that must be met for database backup series expiration.
Recovery Plan File Expiration Days
The minimum number of days that must elapse since a recovery plan file,
stored on a target server, has been created before it is eligible to be expired. See
the SET DRMRPFEXPIREDAYS command for information about the criteria
that must be met for recovery plan file expiration.
Check Label?
Whether media labels are read for sequential media volumes checked out by
the MOVE DRMEDIA command. Possible values are Yes or No.
Process FILE Device Type?
Whether MOVE DRMEDIA or QUERY DRMEDIA commands process database
backup and copy storage pool volumes associated with a device class with a
FILE device type. Possible values are Yes or No.
Command File Name
The full path file name that contains the executable commands generated by
the MOVE DRMEDIA or QUERY DRMEDIA command.
Related commands
Table 217. Commands related to QUERY DRMSTATUS
Command Description
SET DRMCHECKLABEL Specifies whether IBM Tivoli Storage
Manager should read volume labels during
MOVE DRMEDIA command processing.
SET DRMCOPYSTGPOOL Specifies that copy storage pools are
managed by DRM.
SET DRMCMDFILENAME Specifies a file name for containing DRM
executable commands.
SET DRMCOURIERNAME Specifies the name of the courier for the
disaster recovery media.
SET DRMDBBACKUPEXPIREDAYS Specifies criteria for database backup series
expiration.
SET DRMFILEPROCESS Specifies whether the MOVE DRMEDIA or
QUERY DRMEDIA command processes files
associated with a device type of file.
QUERY DRMSTATUS

704 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 217. Commands related to QUERY DRMSTATUS (continued)
Command Description
SET DRMINSTRPREFIX Specifies the prefix portion of the path name
for the recovery plan instructions.
SET DRMPLANVPOSTFIX Specifies the replacement volume names in
the recovery plan file.
SET DRMPLANPREFIX Specifies the prefix portion of the path name
for the recovery plan.
SET DRMPRIMSTGPOOL Specifies that primary storage pools are
managed by DRM.
SET DRMRPFEXPIREDAYS Set criteria for recovery plan file expiration.
SET DRMVAULTNAME Specifies the name of the vault where DRM
media is stored.
SET DRMNOTMOUNTABLENAME Specifies the location name of the DRM
media to be sent offsite.

QUERY DRMSTATUS
Chapter 2. Administrative commands 705
QUERY ENABLED (Query enabled events)
Use this command to display either a list of enabled events or a list of disabled
events, whichever is shorter.
Privilege class
Any administrator can issue this command.
Syntax
Query ENabled CONSOLE
ACTLOG

EVENTSERVER

FILE

FILETEXT

NTEVENTLOG

SNMP

TIVOLI

USEREXIT

NODEname

=

node_name

SERVername

=

server_name


Parameters
receiver
Specifies a type of receiver for enabled events. This is a required parameter.
Valid values are:
ACTLOG
Specifies the Tivoli Storage Manager activity log as a receiver.
CONSOLE
Specifies the standard server console as a receiver.
EVENTSERVER
Specifies the event server as a receiver.
FILE
Specifies a user file as a receiver. Each logged event is a record in the file
and a person cannot read each logged event easily.
FILETEXT
Specifies a user file as a receiver. Each logged event is a fixed-size,
readable line.
NTEVENTLOG
Specifies the Windows application log as a receiver.
SNMP
Specifies the simple network management protocol (SNMP) as a receiver.
TIVOLI
Specifies the Tivoli Management Environment (TME) as a receiver.
USEREXIT
Specifies a user-written routine to which Tivoli Storage Manager writes
information as a receiver.
NODEname
Specifies a node name to be queried. You can specify NODENAME or
SERVERNAME. If neither parameter is specified, the query is for events
enabled for the server running this command.
QUERY ENABLED

706 IBM Tivoli Storage Manager for Windows: Administrators Reference
SERVername
Specifies a server name to be queried. You can specify NODENAME or
SERVERNAME. If neither parameter is specified, the query is for events
enabled for the server running this command.
Examples
Task
Query the server for server events that are enabled for the console. There are 10000
possible server events. Either a list of enabled events or disabled events is
displayed (whichever list is shorter).
Command
query enabled console
Output
9998 events are enabled for the CONSOLE receiver. The
following events are DISABLED for the CONSOLE receiver:

ANR8409, ANR8410

Related commands
Table 218. Commands related to QUERY ENABLED
Command Description
BEGIN EVENTLOGGING Starts event logging to a specified receiver.
DISABLE EVENTS Disables specific events for receivers.
ENABLE EVENTS Enables specific events for receivers.
END EVENTLOGGING Ends event logging to a specified receiver.
QUERY EVENTRULES Displays information about rules for server
and client events.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

QUERY ENABLED
Chapter 2. Administrative commands 707
QUERY EVENT (Query scheduled and completed events)
Use this command to display the status of scheduled events. The time and date
parameters allow you to limit the query to events that were scheduled to occur
within the specified times and dates. Limiting the output to events whose
scheduled start times fall within a date and time range also minimizes the time it
takes to process this query.
The command syntax differs for queries that apply to scheduled client operations
and to scheduled administrative commands.
Table 219. Commands related to QUERY EVENT
Command Description
DEFINE SCHEDULE Defines a schedule for a client operation or
an administrative command.
DELETE EVENT Deletes event records prior to a specified
date and time.
QUERY ACTLOG Displays messages from the server activity
log.
SET EVENTRETENTION Specifies the number of days to retain
records for scheduled operations.
SET RANDOMIZE Specifies the randomization of start times
within a window for schedules in
client-polling mode.
QUERY EVENT

708 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY EVENT client schedules
Use the QUERY EVENT command to display scheduled and completed events for
selected clients.
Tivoli Storage Manager keeps only one version of an event record in the database.
If a client schedule is changed, all previous event records for that schedule are
removed from the database.
Privilege class
Any administrator can issue this command.
Syntax

Query EVent

domain_name

schedule_name
Type = Client

,

Nodes

=

node_name
BEGINDate = current_date
BEGINDate

=

date

BEGINTime = 00:00
BEGINTime

=

time
ENDDate = end_date
ENDDate

=

date
ENDTime = 23:59
ENDTime

=

time

EXceptionsonly = No
EXceptionsonly

=

No

Yes
Format = Standard
Format

=

Standard

Detailed

Parameters
domain_name (Required)
Specifies the name of the policy domain to which the schedules belong. You
can use a wildcard character to specify this name.
schedule_name (Required)
Specifies the name of the schedule for which events are displayed. You can use
a wildcard character to specify this name.
Type=Client
Specifies that the query displays events for client schedules. This parameter is
optional. The default is CLIENT.
Nodes
Specifies the name of the client node that belongs to the specified policy
domain for which events are displayed. You can specify multiple client nodes
by separating the names with commas and no intervening spaces. You can use
wildcard characters to specify nodes. If you do not specify a client name,
events display for all clients that match the domain name and the schedule
name.
BEGINDate
Specifies the beginning date of the time range for events to be displayed. All
events scheduled to start during this time are displayed. This parameter is
optional. The default is the current date.
QUERY EVENT Client Schedules
Chapter 2. Administrative commands 709
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified. The maximum
number of days you can specify
is 9999.
TODAY +3 or +3.
TODAY-days or
-days
The current date minus days
specified
TODAY-7 or -7.
To query events scheduled to start
during the past seven days, specify
BEGINDATE=TODAY-7
ENDDATE=TODAY or BEGINDATE=-7
ENDDATE=TODAY.

BEGINTime
Specifies the beginning time of the range for events to be displayed. All events
scheduled to start during this time are displayed. This parameter is optional.
The default value is 00:00.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the specified
begin date
10:30:08
NOW The current time on the
specified begin date
NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes on the specified begin
date
NOW+03:00 or +03:00.
If you issue this command at 9:00 to
query events scheduled to start 3 hours
from now, you can specify either
BEGINTIME=NOW+03:00 or
BEGINTIME=+03:00. Tivoli Storage
Manager displays events at 12:00 on the
specified begin date.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes on the specified
begin date
NOW-04:00 or -04:00.
If you issue this command at 9:00 to
query events scheduled to start during
the last 4 hours, you can specify either
BEGINTIME=NOW-04:00
ENDTIME=NOW or
BEGINTIME=-04:00 ENDTIME=NOW.
Tivoli Storage Manager displays events
at 5:00 on the specified begin date.

ENDDate
Specifies the ending date of the time range for events to be displayed. All
events that were schedule to start during this time are displayed. This
parameter is optional. The default is the value used for the BEGINDATE.
QUERY EVENT Client Schedules

710 IBM Tivoli Storage Manager for Windows: Administrators Reference
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified. The maximum
number of days you can specify
is 9999.
TODAY +3 or +3.
TODAY-days or
-days
The current date minus days
specified
TODAY8 or 8.
To query events scheduled to start
during a one-week period that ended
yesterday, you can specify either
BEGINDATE=TODAY-8
ENDDATE=TODAY-1 or
BEGINDATE=-8 ENDDATE=-1.

ENDTime
Specifies the ending time of the range for events to be displayed. All events
that were scheduled to start during this time are displayed. This parameter is
optional. The default value is 23:59.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the specified
end date
10:30:08
NOW The current time on the
specified end date
NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes on the specified end
date
NOW+03:00 or +03:00.
If you issue this command at 9:00 to
query events scheduled to start 3 hours
from now, you can specify either
BEGINTIME=NOW
ENDTIME=NOW+03:00 or
BEGINTIME=NOW ENDTIME=+03:00.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes on the specified
end date
NOW-04:00 or -04:00

EXceptionsonly
Specifies the type of information you want on scheduled or completed events.
This parameter is optional. The default is NO. Possible values are:
No
Specifies that the information on past and projected events is displayed.
Yes
Specifies that the events that failed or did not process as scheduled are
displayed.
Format
Specifies how information displays. This parameter is optional. The default is
STANDARD. Possible values are:
QUERY EVENT Client Schedules
Chapter 2. Administrative commands 711
Standard
Specifies that partial information for events displays.
Detailed
Specifies that complete information for events displays.
Examples
Task 1
Display partial information for all events scheduled for DOMAIN1 that did not
execute successfully. Limit the search to the client named JOE. Limit the events
displayed to those that were scheduled to occur from February 11, 2001
(02/11/2001) to February 12, 2001 (02/12/2001).
Command
query event domain1 * nodes=joe begindate=02/11/2001
enddate=02/12/2001 exceptionsonly=yes
Output

Scheduled Start Actual Start Schedule Node Status
Name Name
-------------------- -------------------- --------- ---- ---------
02/11/1999 01:00:00 02/11/1999 01:13:55 BACK1 JOE Failed
02/12/1999 01:00:00 DAILYBKP JOE Missed

Task 2
Display complete information for all events scheduled for processing by client JOE
in DOMAIN1. Use any time from January 15, 1999 (01/15/1999) through January
20, 1999 (01/20/1999).
Command
query event domain1 * nodes=joe
begindate=01/15/1999 enddate=01/20/1999 format=detailed
Output

QUERY EVENT Client Schedules

712 IBM Tivoli Storage Manager for Windows: Administrators Reference
Policy Domain Name: DOMAIN1
Schedule Name: DAILY_BACKUP
Node Name: JOE
Scheduled Start: 01/16/1999 01:00:00
Actual Start:
Completed:
Status: Missed
Result: 0
Reason:

Policy Domain Name: DOMAIN1
Schedule Name: DAILY_BACKUP
Node Name: JOE
Scheduled Start: 01/16/1999 01:00:00
Actual Start: 01/16/1999 01:13:55
Completed: 01/16/1999 01:18:27
Status: Completed
Result: 4
Reason: All operations completed successfully,
but some files were not processed

Policy Domain Name: DOMAIN1
Schedule Name: DAILY_BACKUP
Node Name: JOE
Scheduled Start: 01/16/1999 01:00:00
Actual Start: 01/16/1999 01:13:55
Completed: 01/16/1999 01:18:27
Status: Completed
Result: 8
Reason: All operations completed, with at least one
warning message

Task 3
Display the detailed information for events scheduled for processing by client DOC
between the hours of 10:00am and 11:00am on November 1, 2005 (11/01/2005).
Notice that when the status is FAILED, the result code is displayed.
Command
query event domain1 * nodes=doc begindate=11/01/2005
begint=10:00 endt=11:00 enddate=11/01/2005
exceptionsonly=yes format=detailed
Output

Scheduled Start Actual Start Schedule Node Status
Name Name
-------------------- -------------------- --------- ------ -------
11/01/2005 10:01:01 11/01/2005 10:03:46 T1 DOC Failed 8
11/01/2005 10:16:01 11/01/2005 10:16:10 T1 DOC Failed 4
11/01/2005 10:31:01 11/01/2005 10:33:08 T1 DOC Completed
11/01/2005 10:46:01 T1 DOC Missed
11/01/2005 10:57:49 11/01/2005 10:58:07 T0 DOC Failed 12

where:
Policy Domain Name
Specifies the name of the policy domain to which the schedule is assigned.
Schedule Name
Specifies the name of the schedule that initiated this event.
Node Name
Specifies the client scheduled to perform the operation.
QUERY EVENT Client Schedules
Chapter 2. Administrative commands 713
Scheduled Start
Specifies the scheduled starting date and time for the event.
Actual Start
Specifies the date and time at which the client began processing the scheduled
operation. No information is displayed if the schedule has not started
executing.
Completed
Specifies the date and time the scheduled event is completed.
Status
Specifies the status of the event at the time the QUERY EVENT command is
issued. Possible values are:
Completed
Specifies that the scheduled event has been completed.
Failed
Specifies that the client reports a failure in executing the scheduled
operation and successive retries have not succeeded.
Future
Specifies that the beginning of the startup window for the event is in the
future. This status also indicates that an event record has not been created
for this event.
In Progress
Specifies that the scheduled event is running and has not yet reported the
completion state to the server.
Periodically check the status for completion of the scheduled event. If this
status is not updated in a reasonable amount of time, review your client
dsmsched.log and dsmerror.log to determine why the client did not report
the outcome of this event to the server. If the scheduled backup failed,
rerun the scheduled event or perform a manual incremental backup to
ensure the data backup.
Missed
Specifies that the scheduled startup window for this event has passed and
the schedule has not begun.
Pending
Specifies that the QUERY EVENT command was issued during the startup
window for the event, but processing the scheduled operation has not yet
begun.
Restarted
Specifies that the client has retried processing the scheduled operation.
Severed
Specifies that the communications with the client is severed before the
event can complete.
Started
Specifies that the event has begun processing.
Uncertain
Specifies that the state of the event cannot be determined. The server
specifies Uncertain if the QUERY EVENT command does not find an event
record. An event record will not be found if the record was deleted or if
the server was unavailable during the scheduled startup window (the
schedule was never started). Records with Uncertain status do not reside in
QUERY EVENT Client Schedules

714 IBM Tivoli Storage Manager for Windows: Administrators Reference
the database. If you do not want these records to display, either specify
EXCEPTIONSONLY=YES or delete the schedule if it is no longer needed.
Note: When a scheduled operation is processing, without having been
restarted within its specified duration, the Status field shows Started. If
the operation continues beyond the specified duration, no event record
is created. If a query is issued after the specified duration has passed,
the Status shows as Failed even if the operation is still running. After
the operation completes, an event record is created, and a subsequent
query shows the result in the Status field.
Result
Specifies the return code from the client that identifies whether the schedule
has processed successfully. If the return code is other than a zero, examine the
clients error log and schedule log.

Return Code Explanation
0 All operations completed successfully.
4 The operation completed successfully, but some files were not
processed.
8 The operation completed with at least one warning message.
12 The operation completed with at least one error message (except for
error messages for skipped files).

If a schedule has ACTION=COMMAND as a parameter, and the command is
not a Tivoli Storage Manager command, the command can produce other
values in the Result field. See Backup-Archive Clients Installation and Users Guide
for details.
Reason
Specifies the reason for the return code.
QUERY EVENT Client Schedules
Chapter 2. Administrative commands 715
QUERY EVENT administrative schedules
Use the QUERY EVENT command to display scheduled and completed events for
selected administrative command schedules.
Privilege class
Any administrator can issue this command.
Syntax
Query EVent schedule_name Type = Administrative

BEGINDate = current_date
BEGINDate

=

date
BEGINTime = 00:00
BEGINTime

=

time

ENDDate = begin_date
ENDDate

=

date
ENDTime = 23:59
ENDTime

=

time

EXceptionsonly = No
EXceptionsonly

=

No

Yes
Format = Standard
Format

=

Standard

Detailed

Parameters
schedule_name (Required)
Specifies the name of the schedule for which events display. You can use
wildcard characters to specify names.
Type=Administrative (Required)
Specifies that the query displays events for administrative command schedules.
BEGINDate
Specifies the beginning date of the time range for events to be displayed. All
events scheduled to start during this time are displayed. This parameter is
optional. The default is the current date.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified. The maximum
number of days you can specify
is 9999.
TODAY +3 or +3.
TODAY-days or
-days
The current date minus days
specified
TODAY-7 or -7.
To query events scheduled to start
during the past seven days, specify
BEGINDATE=TODAY-7
ENDDATE=TODAY or BEGINDATE=-7
ENDDATE=TODAY.

QUERY EVENT Administrative Schedules

716 IBM Tivoli Storage Manager for Windows: Administrators Reference
BEGINTime
Specifies the beginning time of the range for events to be displayed. All events
scheduled to start during this time are displayed. This parameter is optional.
The default value is 00:00.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the specified
begin date
10:30:08
NOW The current time on the
specified begin date
NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes on the specified begin
date
NOW+03:00 or +03:00.
If you issue this command at 9:00 to
query events scheduled to start 3 hours
from now, you can specify either
BEGINTIME=NOW+03:00 or
BEGINTIME=+03:00. Tivoli Storage
Manager displays events at 12:00 on the
specified begin date.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes on the specified
begin date
NOW-04:00 or -04:00.
If you issue this command at 9:00 to
query events scheduled to start during
the last 4 hours, you can specify either
BEGINTIME=NOW-04:00
ENDTIME=NOW or
BEGINTIME=-04:00 ENDTIME=NOW.
Tivoli Storage Manager displays events
at 5:00 on the specified begin date.

ENDDate
Specifies the ending date of the time range for events to be displayed. All
events that were schedule to start during this time are displayed. This
parameter is optional. The default is the value used for the BEGINDATE.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified. The maximum
number of days you can specify
is 9999.
TODAY +3 or +3.
TODAY-days or
-days
The current date minus days
specified
TODAY8 or 8.
To query events scheduled to start
during a one-week period that ended
yesterday, you can specify either
BEGINDATE=TODAY-8
ENDDATE=TODAY-1 or
BEGINDATE=-8 ENDDATE=-1.

QUERY EVENT Administrative Schedules
Chapter 2. Administrative commands 717
ENDTime
Specifies the ending time of the range for events to be displayed. All events
that were scheduled to start during this time are displayed. This parameter is
optional. The default value is 23:59.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the specified
end date
10:30:08
NOW The current time on the
specified end date
NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes on the specified end
date
NOW+03:00 or +03:00.
If you issue this command at 9:00 to
query events scheduled to start 3 hours
from now, you can specify either
BEGINTIME=NOW
ENDTIME=NOW+03:00 or
BEGINTIME=NOW ENDTIME=+03:00.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes on the specified
end date
NOW-04:00 or -04:00

EXceptionsonly
Specifies the type of information you want on scheduled or completed events.
This parameter is optional. The default is NO. Possible values are:
No
Specifies that the information on past and projected events is displayed.
Yes
Specifies that the events that failed or did not process as scheduled are
displayed.
Format
Specifies how the information displays. This parameter is optional. The default
value is STANDARD. Possible values are:
Standard
Specifies that partial information for events displays.
Detailed
Specifies that complete information for events displays.
Examples
Task
Display partial information for all events scheduled for an administrative schedule
named DOSADMIN. Limit the query to events that are scheduled for March 30,
1999 (03/30/1999).
Command
query event dosadmin type=administrative
begindate=03/30/1999
enddate=03/30/1999
Output

QUERY EVENT Administrative Schedules

718 IBM Tivoli Storage Manager for Windows: Administrators Reference
Scheduled Start Actual Start Schedule Status
Name
-------------------- -------------------- --------- ---------
03/30/1999 00:00:00 03/30/1999 00:00:01 DOSADMIN Completed
03/30/1999 04:00:00 03/30/1999 04:00:01 DOSADMIN Completed
03/30/1999 12:00:00 DOSADMIN Future
03/30/1999 16:00:00 DOSADMIN Future

where:
Scheduled Start
Specifies the scheduled starting date and time for the event.
Actual Start
Specifies the date and time at which the client began processing the scheduled
operation. No information displays if the schedule has not started executing.
Schedule Name
Specifies the name of the schedule that initiated this event.
Status
Specifies whether the startup of the event has been completed.
QUERY EVENT Administrative Schedules
Chapter 2. Administrative commands 719
QUERY EVENTRULES (Query rules for server or client events)
Use this command to display the history of events that are enabled or disabled by
a specified receiver for the server or for a client node.
Privilege class
Any administrator can issue this command.
Syntax

Query

EVENTRUles

*
,

CONSOLE

ACTLOG

EVENTSERVER

FILE

FILETEXT

NTEVENTLOG

SNMP

TIVOLI

USEREXIT

NODEname

=

node_name

SERVername

=

server_name

Parameters
receivers
Specifies the name of one or more receivers for enabled events. This parameter
is optional.
You can use a wildcard character to specify all receivers.
Valid values are:
CONSOLE
Specifies the standard console as a receiver.
ACTLOG
Specifies the Tivoli Storage Manager activity log as a receiver.
EVENTSERVER
Specifies the event server as a receiver.
FILE
Specifies a user file as a receiver. Each logged event is a record in the file
and a person cannot read each logged event easily.
FILETEXT
Specifies a user file as a receiver. Each logged event is a fixed-size,
readable line.
NTEVENTLOG
Specifies the Windows application log as a receiver.
SNMP
Specifies the simple network management protocol (SNMP) as a receiver.
TIVOLI
Specifies the Tivoli Management Environment (TME) as a receiver.
QUERY EVENTRULES

720 IBM Tivoli Storage Manager for Windows: Administrators Reference
USEREXIT
Specifies a user-written routine to which Tivoli Storage Manager writes
information as a receiver.
NODEname
Specifies a node name to be queried. You can use a wildcard character to
specify a name. You can specify NODENAME or SERVERNAME. If neither
parameter is specified, the query is for event rules for the server running this
command.
SERver
Specifies a server name to be queried. You can use a wildcard character to
specify a name. You can specify NODENAME or SERVERNAME. If neither
parameter is specified, the query is for event rules for the server running this
command.
Examples
Task 1
Display the history of client events enabled or disabled for the server console and
activity log receivers.
Command
query eventrules console,actlog nodename=*
Output
Date/Time Client Event Rules
-------------------- ------------------------------------------------
05/29/97 13:39:58 ENABLE EVENTS CONSOLE ANE4001 NODENAMES=JEE
05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4962 NODENAMES=JEE
05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4963 NODENAMES=JEE
05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4965 NODENAMES=JEE
05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4966 NODENAMES=JEE
05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4967 NODENAMES=JEE
05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4968 NODENAMES=JEE
05/30/97 14:24:20 ENABLE EVENTS CONSOLE ANE4015 NODENAMES=RON
05/30/97 14:24:50 ENABLE EVENTS CONSOLE ANE4026 NODENAMES=DONNA
05/30/97 14:25:59 ENABLE EVENTS CONSOLE ANE4015 NODENAMES=DONNA

Task 2
Display the history of server events enabled or disabled for all receivers.
Command
query eventrules
Output
Date/Time Server Event Rules
-------------------- ------------------------------------------------
05/22/97 14:35:13 ENABLE EVENTS CONSOLE ANR2578
05/30/97 14:29:31 ENABLE EVENTS CONSOLE ANR0272
05/30/97 14:31:46 ENABLE EVENTS USEREXIT ANR0130
05/30/97 14:31:54 ENABLE EVENTS USEREXIT ANR0131
05/30/97 14:50:28 ENABLE EVENTS USEREXIT ANR0266

QUERY EVENTRULES
Chapter 2. Administrative commands 721
Related commands
Table 220. Commands related to QUERY ENABLED
Command Description
BEGIN EVENTLOGGING Starts event logging to a specified receiver.
DISABLE EVENTS Disables specific events for receivers.
ENABLE EVENTS Enables specific events for receivers.
END EVENTLOGGING Ends event logging to a specified receiver.
QUERY ENABLED Displays enabled or disabled events for a
specific receiver.

QUERY EVENTRULES

722 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY EVENTSERVER (Query the event server)
Use this command to display the name of the event server.
Privilege class
Any administrator can issue this command.
Syntax
Query EVENTSERVer

Examples
Task
Display the name of the event server.
Command
query eventserver
Output
ANR1669I Server EVENT is defined as the event server.

Related commands
Table 221. Commands related to QUERY EVENTSERVER
Command Description
BEGIN EVENTLOGGING Starts event logging to a specified receiver.
DEFINE EVENTSERVER Defines a server as an event server.
DEFINE SERVER Defines a server for server-to-server
communications.
DELETE EVENTSERVER Deletes reference to the event server.
DELETE SERVER Deletes the definition of a server.
END EVENTLOGGING Ends event logging to a specified receiver.

QUERY EVENTSERVER
Chapter 2. Administrative commands 723
QUERY EXPORT (Query for active or suspended export
operations)
Use this command to list the restartable export operations. A restartable export is a
server-to-server export operation whose FILEDATA value is not NONE. Only
active server-to-server export operations that can be suspended are displayed.
Any EXPORT NODE or EXPORT SERVER operation with FILEDATA=NONE are
not displayed. Additionally, the QUERY EXPORT command does not show export
operations where the target device is either sequential media or virtual volumes.
Privilege class
An administrator can issue this command.
Syntax

Query EXPort
*
export_identifier
STate = ALl
STate

=

ALl

RUnning

SUSpended

PROCess

=

process_number
Format = Standard
Format

=

Standard

Detailed

Parameters
export_identifier
This optional parameter is the unique string identifier for the server-to-server
export operation. Wildcard characters can be used to specify this name, and all
matching export operations are queried. If you do not specify a value for this
parameter and you also do not specify a PROCESS identifier, then all export
operations are queried.
STate
This optional parameter queries the state of the valid server-to-server export
operations. The default value is ALL. The possible values are:
ALl
Lists all running and suspended server-to-server export operations.
RUnning
Lists all active server-to-server export operations that are identifying
eligible files or exporting files to the target server.
SUSpended
Lists all suspended server-to-server export operations. These suspended
operations have stopped running because of a failure or by the SUSPEND
EXPORT command being issued.
PROCess
This optional parameter specifies the number of a running server-to-server
export operation that you want to query. If PROCESS is specified, Tivoli
Storage Manager only displays the running server-to-server export operation
associated with the process number. If PROCESS is not specified, Tivoli Storage
Manager displays information on all server-to-server export operations. You
QUERY EXPORT

724 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|||||||||||||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
cannot specify this parameter if you specify an export identifier or if you
specify the STATE parameter with a value of SUSPENDED.
Format
This optional parameter specifies how the information is displayed. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the specified export
operations.
Detailed
When specified displays all available information for the export operations.
Examples
Task
List information for all currently running and suspended export operations.
Command
query export state=all
Output

Export Start Time State Process Command
Identifier ID
------------- ------------ --------- --------- -----------------------------
MYEXPORTNODE 01/24/2007 Suspended -- Export NODE me,you,them
10:30:03 filespace=c$ nametype=unicode
filedata=all durunits=
indefinite toserver=athens
exportid=MYEXPORTNODE

EXPORT_HOME_ 01/25/2007 Running 11 Export NODE n2,n3,n4
DIRS 09:30:03 filespace=/home nametype=
server filedata=all durunits=
indefinite toserver=athens
exportid=EXPORT_HOME_DIRS

EXPORT_NODE_ 01/25/2007 Running Not -- Export NODE n5,n6,n7
0001 14:30:33 Suspendible filespace=d$ nametype=unicode
filedata=archive durunits=
indefinite toserver=athens

Task
List information for the currently running export operation with process number
7.
Command
query export process=7
Output
Export Start Time State Process Command
Identifier ID
____________ _________ ______ _______ _______
MYEXPORTNODE 01/24/2007 Running 7 Export NODE me,you,them
10:30:03 filespace=c$ nametype=unicode
filedata=all toserver=athens
exportid=MYEXPORTNODE

QUERY EXPORT
Chapter 2. Administrative commands 725
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Task
List information for all currently suspended export operations.
Command
query export state=suspended format=detailed
Output
Export Identifier : MyExportNode
Start Time : 01/24/2007 10:30:03
State : Suspended
Process Id : --
Command : Export NODE m* filespace=c$ nametype=unicode
filedata=all durunits=indefinite
toserver=athens
Phase : File list complete. Exporting eligible files
Total Running Time : 3 Days 0 Hours 24 Minutes
Current Process Running Time :
Export Operation Restart Count: 0
Date and Time of Last Restart : --
Date and Time of Last Suspend : 01/25/2007 08:30:11
Policy Domains Exported : 0
Policy Sets Exported : 0
Schedules Exported : 0
Mgmt Classes Exported : 0
Copy Groups Exported : 0
Administrators Exported : 1
Option Sets Exported : 0
Node Definitions Exported : 3
Filespace Definitions Exported : 7
Archive Files Exported : 50,000
Backup Files Exported : 150,000
Space Managed Files Exported : 0
Archive Files Skipped : 0
Backup Files Skipped : 25
Space Managed Files Skipped : 0
Total bytes Transferred (MB) : 7,000
Total Files to be Transferred : 900,000
Files Remaining : 700,000

where
Export identifier
The unique identifier assigned to this server-to-server export operation.
Start time
The time and date that this export operation was first initiated.
State The current state of this export operation. The value is one of the
following:
Running - Not Suspendible
The operation is active and is transmitting definitions to the target
server. The process cannot be suspended, and if the process fails
while in this state, you cannot restart it.
Running
The operation is active and is either searching for eligible files or
transmitting file data to the target server.
Running - Suspend in Progress
The operation is in the process of being suspended as a result of a
SUSPEND EXPORT command. The export operation is fully
suspended when all of the data from the export operation is saved.
An export operation in this state does not respond to the following
commands:
QUERY EXPORT

726 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
v CANCEL PROCESS
v CANCEL EXPORT
v RESTART EXPORT
v SUSPEND EXPORT
Suspended
The operation stopped running due to a failure or was suspended
with the SUSPEND EXPORT command.
Process ID
The process ID for the export operation when the status is either
Initializing or Running
Command
The full command entered to start this server-to-server export.
Phase The current step that the operation is performing. The possible phases are
shown below in the order in which they are performed:
Creating definitions on target server
The operation exporting definitions. The process cannot be
suspended. Should the process fail in this phase, it cannot be
restarted.
Identifying and exporting eligible files
The operation is building a list of eligible files for export. Some
files may also be transmitted to the target during this phase. A
process in this phase can be suspended. Should the process fail in
this phase, it can be restarted.
File list complete. Exporting eligible files
The operation has completed building the list of eligible files for
export and it is now transmitting the files to the target. A process
in this phase can be suspended. Should the process fail in this
phase, it can be restarted.
Total running time
The overall running time for this server-to-server export operation. For
example, if this operation started and was then suspended and restarted
two times, this value is the total running time of all three active processes
of the export operation.
Current process running time
The running time of the active process of a server-to-server export
operation. No value is displayed for a suspended operation, because no
active process exists.
Export operation restart count
The number of times the server-to-server export operation was restarted.
Date and time of last restart
The last date and time at which this server-to-server export operation was
restarted.
Date and time of last suspend
The last date and time at which this server-to-server export operation was
suspended.
Policy domains exported
The number of policy domain definitions successfully exported to the
target server.
QUERY EXPORT
Chapter 2. Administrative commands 727
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Policy sets exported
The number of policy set definitions successfully exported to the target
server.
Schedules exported
The number of schedule definitions successfully exported to the target
server.
Mgmt classes exported
The number of management class definitions successfully exported to the
target server.
Copy groups exported
The number of copy group definitions successfully exported to the target
server.
Administrators exported
The number of administrator definitions successfully exported to the target
server.
Option sets exported
The number of option set definitions successfully exported to the target
server.
Node definitions exported
The number of node definitions successfully exported to the target server.
File space definitions exported
The number of file space definitions successfully exported to the target
server.
Archive files exported
The number of archive files successfully exported to the target server.
Backup files exported
The number of backup files successfully exported to the target server.
Space managed files exported
The number of space managed files successfully exported to the target
server.
Archive files skipped
The number of archive files that were eligible for export but were skipped.
Backup files skipped
The number of backup files that were eligible for export but were skipped.
Space managed files skipped
The number of space managed files that were eligible for export but were
skipped.
Total bytes transferred (MB)
The total number bytes transmitted so far to the target server for this
export operation.
Total files to be transferred
The total number files transmitted so far to the target server for this export
operation.
Files remaining
The total number files remaining to be transmitted to the target server for
this export operation.
QUERY EXPORT

728 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Task List detailed information for all currently running server-to-server export
operations.
Command
query export state=running format=detailed
Output
Export Identifier : export_HOME_Dirs
Start Time : 01/25/2007 09:30:03
State : Running
Process Id : 11
Command : Export NODE n2,n3,n4
filespace=/home nametype=
server filedata=all
toserver=athens
Phase : Identifying and exporting
eligible files
Total Running Time : 0 Days 22 Hours 0 Minutes
Current Process Running Time : 01:30:00
Export Operation Restart Count: 4
Date and Time of last Restart : 02/01/2007 11:00:03
Date and Time of last Suspend : 01/31/2007 05:01:00
Policy Domains Exported : 0
Policy Sets Exported : 0
Schedules Exported : 0
Mgmt Classes Exported : 0
Copy Groups Exported : 0
Administrators Exported : 1
Option Sets Exported : 0
Node Definitions Exported : 3
Filespace Definitions Exported : 7
Archive Files Exported : 0
Backup Files Exported : 1000
Space Managed Files Exported : 0
Archive Files Skipped : 0
Backup Files Skipped : 0
Space Managed Files Skipped : 0
Total bytes Transferred (MB) : 50
Total Files to be Transferred : 400,000
Files Remaining : 399,000

Related commands
Table 222. Commands related to QUERY EXPORT
Command Description
CANCEL PROCESS Cancels a background server process.
CANCEL EXPORT Deletes a suspended export operation
EXPORT NODE Copies client node information to external
media.
EXPORT SERVER Copies all or part of the server to external
media.
IMPORT NODE Restores client node information from
external media.
IMPORT SERVER Restores all or part of the server from
external media.
QUERY PROCESS Displays information about background
processes.
RESTART EXPORT Restarts a suspended export operation.
SUSPEND EXPORT Suspends a running export operation.

QUERY EXPORT
Chapter 2. Administrative commands 729
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
||
||
||
||
|
||
|
||
|
||
|
||
|
||
||
|
|
QUERY FILESPACE (Query one or more file spaces)
Use this command to display information about file spaces that belong to a client
node. The information displayed reflects data as of the last incremental backup.
Note: When a node has more than one file space, and a DELETE FILESPACE
command is issued for only one file space, a QUERY FILESPACE command
for the node during the delete process shows no file spaces. When the delete
process ends, the remaining file spaces can be viewed with the QUERY
FILESPACE command.
Privilege class
Any administrator can issue this command.
Syntax

Query FIlespace
* *
*

node_name

file_space_name

Format = Standard
Format

=

Standard

Detailed
NAMEType = SERVER
NAMEType

=

SERVER

UNIcode

FSID

CODEType = BOTH
CODEType

=

UNIcode

NONUNIcode

BOTH

Parameters
node_name
Specifies the client node to which the file space belongs. You can use wildcard
characters to specify this name. This parameter is optional. The default is all
client node names. You must specify a value for this parameter if you specify a
file name.
file_space_name
Specifies the name of the file space to be queried. You can use wildcard
characters to specify this name. This parameter is optional. If a value is not
specified, all file spaces are queried.
For a server that has clients with support for Unicode-enabled file spaces, you
may need to have the server convert the file space name that you enter. For
example, you may need to have the server convert the name you enter from
the servers code page to Unicode. See the NAMETYPE parameter for details.
If you do not specify a file space name, or specify only a single wildcard
character for the name, you can use the CODETYPE parameter to limit the
operation to Unicode file spaces or to non-Unicode file spaces.
File space names are case-sensitive. You can use the QUERY FILESPACE
command to determine the correct capitalization for the file space to be
queried.
QUERY FILESPACE

730 IBM Tivoli Storage Manager for Windows: Administrators Reference
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the specified file space.
Detailed
Specifies that complete information is displayed for the specified file space.
NAMEType
Specify how you want the server to interpret the file space names that you
enter. This parameter is useful when the server has clients with support for
Unicode. You can use this parameter for Unicode-enabled Tivoli Storage
Manager clients using Windows, Macintosh OS X, and NetWare operating
systems.
Use this parameter only when you enter a partly or fully qualified file space
name. The default value is SERVER. Possible values are:
SERVER
The server uses the servers code page to interpret the file space names.
UNIcode
The server converts the file space name entered from the server code page
to the UTF-8 code page. The success of the conversion depends on the
actual characters in the name and the servers code page. Conversion can
fail if the string includes characters that are not available in the server code
page, or if the server has a problem accessing system conversion routines.
FSID
The server interprets the file space names as their file space IDs (FSIDs).
CODEType
Specify what type of file spaces are to be included in the operation. The default
is BOTH, meaning that file spaces are included regardless of code page type.
Use this parameter only when you enter a single wildcard character for the file
space name. Possible values are:
UNIcode
Include only file spaces that are in Unicode.
NONUNIcode
Include only file spaces that are not in Unicode.
BOTH
Include file spaces regardless of code page type.
Examples
Task
Query all file spaces associated with all client nodes.
Command
query filespace
Output

QUERY FILESPACE
Chapter 2. Administrative commands 731
|
|
|
Node Filespace FSID Platform Filespace Is Capacity Pct
Name Name Type Filespace (MB) Util
Unicode?
------ ----------- ---- ------- --------- --------- --------- ----
JOE \\joe\c$ 1 WinNT NTFS Yes 2,502.3 75.2
JOE \\joe\d$ 2 WinNT NTFS Yes 6,173.4 59.6

Task
Display detailed information for the filespace /HomeDir which is a virtual file
space mapping and belongs to the NAS node NAS1.
Command
query filespace nas1 /HomeDir
Output

Node Filespace FSID Platform Filespace Is Capacity Pct
Name Name Type Filespace (MB) Util
Unicode?
------ ----------- ---- ------- --------- --------- --------- ----
NAS1 /HomeDir 1 NetApp WAFL (VFS) No 2,502.3 75.2

where:
Node Name
Specifies the name of the client node.
Filespace Name
Specifies the name of the file space for the client node.
File space names and file names that can be in a different code page or locale
than the server do not display correctly on the Administration Center or the
administrative command-line interface. The data itself is backed up and can be
restored properly, but the file space or file name may display with a
combination of invalid characters or blank spaces.
If the file space name is Unicode enabled, the name is converted to the servers
code page for display. The results of the conversion for characters not
supported by the current code page depends on the operating system. For
names that Tivoli Storage Manager is able to partially convert, you might see
question marks (??), blanks, unprintable characters, or .... These characters
indicate to the administrator that files do exist. If the conversion is not
successful, the name is displayed as .... Conversion can fail if the string
includes characters that are not available in the server code page, or if the
server has a problem accessing system conversion routines.
FSID
Specifies the file space ID of the file space.
Platform
Specifies the platform for the client node.
Filespace Type
Specifies the type of file space. A file space type that is appended with (VFS)
denotes that this file space name is a virtual file space mapping for a directory
path on a NAS device.
Is Filespace Unicode?
Indicates whether the file space is Unicode.
QUERY FILESPACE

732 IBM Tivoli Storage Manager for Windows: Administrators Reference
Capacity (MB)
Specifies the amount of space, in megabytes, assigned to this file space on the
client node. For a file space that is a virtual file space mapping for a directory
path, this is the capacity of the file space on which the directory path is
located.
Pct Util
Specifies the percentage of the file space that is occupied. For a file space that
is a virtual file space mapping for a directory path, the percentage utilized is
calculated as the percentage of the capacity of the file space that was occupied
by the directory at the time of the last full backup.
Display detailed information on the \\joe\c$ file space that belongs to the client
node JOE.
Command
query filespace joe \\joe\c$ nametype=unicode format=detailed
Output

Node Name: JOE
Filespace Name: \\joe\c$
Hexadecimal Filespace Name: 5c5c6a6f655c6324
FSID: 1
Platform: WinNT
Filespace Type: NTFS
Is Filespace Unicode?: Yes
Capacity (MB): 2,502.3
Pct Util: 75.2
Last Backup Start Date/Time:
Days Since Last Backup Started:
Last Backup Completion Date/Time:
Days Since Last Backup Completed:

where:
Node Name
Specifies the name of the client node.
Filespace Name
Specifies the name of the file space for the client node.
File space names and file names that can be in a different code page or locale
than the server do not display correctly on the Administration Center or the
administrative command-line interface. The data itself is backed up and can be
restored properly, but the file space or file name may display with a
combination of invalid characters or blank spaces.
If the file space name is Unicode enabled, the name is converted to the servers
code page for display. The results of the conversion for characters not
supported by the current code page depends on the operating system. For
names that Tivoli Storage Manager is able to partially convert, you may see
question marks (??), blanks, unprintable characters, or .... These characters
indicate to the administrator that files do exist. If the conversion is not
successful, the name is displayed as .... Conversion can fail if the string
includes characters that are not available in the server code page, or if the
server has a problem accessing system conversion routines.
Hexadecimal Filespace Name
Specifies the hexadecimal name of the file space for the client node in UTF-8
format.
QUERY FILESPACE
Chapter 2. Administrative commands 733
FSID
Specifies the file space ID of the file space.
Platform
Specifies the platform for the client node.
Filespace Type
Specifies the type of file space. A file space type that is appended with (VFS)
denotes that this file space name is a virtual file space mapping for a directory
path on a NAS device.
Is Filespace Unicode?
Indicates whether the file space is Unicode.
Capacity (MB)
Specifies the amount of space, in megabytes, assigned to this file space on the
client node.
Pct Util
Specifies the percentage of the file space that is occupied.
Last Backup Start Date/Time
Specifies the start date and time of the last incremental backup of the file
space.
Days Since Last Backup Started
Specifies the number of days since the start of the last incremental backup of
the file space.
Last Backup Completion Date/Time
Specifies the completion date and time of the last incremental backup of the
file space.
Days Since Last Backup Completed
Specifies the number of days since the completion of the last incremental
backup of the file space.
Note: The administrator may not see the expected results after requesting a
detailed format because several fields have to be filled in by the API
application. These include:
v Filespace Type
v Platform
v Capacity (MB)
v Pct Util
v Last Backup Start Date/Time
v Last Backup Completion Date/Time
For more information on specific fields which are updated by the API, refer
to IBM Tivoli Storage Manager Using the Application Programming Interface.
Related commands
Table 223. Commands related to QUERY FILESPACE
Command Description
DEFINE VIRTUALFSMAPPING Define a virtual file space mapping.
DELETE FILESPACE Deletes data associated with clients file
spaces.
QUERY FILESPACE

734 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 223. Commands related to QUERY FILESPACE (continued)
Command Description
REGISTER NODE Defines a client to the server and sets options
for that user.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
RENAME FILESPACE Renames a client filespace on the server.
UPDATE NODE Changes the attributes associated with a
client node.

QUERY FILESPACE
Chapter 2. Administrative commands 735
QUERY LIBRARY (Query a library)
Use this command to display information about libraries.
Privilege class
Any administrator can issue this command.
Syntax

Query LIBRary
*
library_name
Format = Standard
Format

=

Standard

Detailed

Parameters
library_name
Specifies the name of the library to be queried. You can use wildcards to
specify names. This parameter is optional.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the library.
Detailed
Specifies that complete information is displayed for the library.
Examples
Task
Display information about the library named AUTO.
Command
query library auto
Output
Library Name: AUTO
Library Type: SCSI
ACS Id:
Private Category:
Scratch Category:
WORM Scratch Category:
External Manager:
Shared: No
LanFree:
ObeyMountRetention:

Task
Display information in full detail about the library named EZLIFE.
Command
query library ezlife format=detailed
Output
QUERY LIBRARY

736 IBM Tivoli Storage Manager for Windows: Administrators Reference
Library Name: EZLIFE
Library Type: SCSI
ACS Id:
Private Category:
Scratch Category:
WORM Scratch Category:
External Manager:
RSM Media Type:
Shared: YES
LanFree:
ObeyMountRetention:
Primary Library Manager: EZSERVER
WWN:
Serial Number:
AutoLabel: OVERWRITE
Last Update by (administrator): DOCTOR_MIKE
Last Update Date/Time: 2000-12-05 15:24:53

where:
Library Name
The name of the library.
Library Type
The type of library.
ACS Id
Specifies that the library is a StorageTek library that is controlled by StorageTek
Automated Cartridge System Library Software (ACSLS).
Private Category
The category number for private volumes that must be mounted by name.
The information displayed in this field only applies to an IBM 3494 or 3495
Tape Library Dataserver.
Scratch Category
The category number to use for scratch volumes in the library.
The information displayed in this field only applies to an IBM 3494 or 3495
Tape Library Dataserver.
WORM Scratch Category
The category number used for WORM scratch volumes in the library.
The information displayed in this field only applies to an IBM 3494 or 3495
Tape Library Dataserver.
External Manager
The location of the external library manager where the server can send media
access requests.
RSM Media Type
The media type for Windows Removable Storage Manager (RSM).
Shared
Whether this library is shared with other Tivoli Storage Manager servers in a
storage area network (SAN).
LanFree
Whether an external library is used for LAN-free operations.
ObeyMountRetention
Whether the server uses the value set for mount retention in the device class
associated with this external library.
QUERY LIBRARY
Chapter 2. Administrative commands 737
Primary Library Manager
The name of the server that is responsible for controlling access to library
resources.
WWN
The Fibre Channel world wide name for the library.
Serial Number
Specifies the serial number for the library being queried.
AutoLabel
Specifies whether the server attempts to automatically label tape volumes.
Last Update by (administrator)
Who performed the last update to the library.
Last Update Date/Time
The date and time when the last update occurred.
Related commands
Table 224. Commands related to QUERY LIBRARY
Command Description
AUDIT LIBRARY Ensures that an automated library is in a
consistent state.
DEFINE LIBRARY Defines an automated or manual library.
DEFINE PATH Defines a path from a source to a destination.
DELETE LIBRARY Deletes a library.
QUERY PATH Displays information about the path from a
source to a destination.
UPDATE LIBRARY Changes the attributes of a library.
UPDATE PATH Changes the attributes associated with a
path.

QUERY LIBRARY

738 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY LIBVOLUME (Query a library volume)
Use this command to display information about one or more volumes that are
checked into an automated library for use by the Tivoli Storage Manager server.
Privilege class
Any administrator can issue this command.
Syntax

Query LIBVolume
*
library_name
*
volume_name

Format = Standard
Format

=

Standard

Detailed

Parameters
library_name
Specifies the name of the library. You can use wildcard characters to specify
this name. This parameter is optional. The default is all libraries.
volume_name
Specifies the volume name. You can use wildcard characters to specify this
name. This parameter is optional. The default is all volumes.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task
Display information about all of the volumes that are checked into the library
named TAPE.
Command
query libvolume tape
Output
Library Name Volume Name Status Owner Last Use Home Device
Element Type
------------ ----------- -------- ------- -------- ------ ------
TAPE 000114 Scratch 1,000 LTO
TAPE NY1602 Scratch 1,001 DLT

Task
QUERY LIBVOLUME
Chapter 2. Administrative commands 739
Display detailed information about a volume named JJY008.
Command
query libvolume jjy008 format=detailed
Output
Library Name: HPW3494
Volume Name: JJY008
Status: Private
Owner: SUNSET
Last Use: Data
Home Element:
Device Type:
Cleanings Left:
Media Type:

Library Name
The name of the library where the storage volume is located.
Volume Name
The name of the storage volume.
Status
The status of the storage volume according to the library inventory. If the
status is Private, the volume is being used by Tivoli Storage Manager. If the
status is Scratch, the volume is available for use.
Owner
The owner server of the volume, if the volume is private.
Last Use
The type of data on the volume. This field applies only to volumes in Private
status. For storage pool volumes, this field shows Data. For database backup
volumes (full, incremental, or snapshot), this field shows DbBackup.
Home Element
The element address of the library slot containing the volume.
Device Type
The type of device that the volume is used on. This field will display a value
only for volumes checked into a library that has mixed media capabilities.
Cleanings Left
For cleaner cartridges, the number of cleanings left.
Media Type
The type of media the volume represents (for example, 8mm tape).
Related commands
Table 225. Commands related to QUERY LIBVOLUME
Command Description
AUDIT LIBRARY Ensures that an automated
library is in a consistent state.
CHECKIN LIBVOLUME Checks a storage volume into
an automated library.
CHECKOUT LIBVOLUME Checks a storage volume out
of an automated library.
DEFINE VOLUME Assigns a volume to be used
for storage within a specified
storage pool.
QUERY LIBVOLUME

740 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 225. Commands related to QUERY LIBVOLUME (continued)
Command Description
LABEL LIBVOLUME Labels volumes in manual or
automated libraries.
QUERY LIBRARY Displays information about
one or more libraries.
UPDATE LIBVOLUME Changes the status of a
storage volume.

QUERY LIBVOLUME
Chapter 2. Administrative commands 741
QUERY LICENSE (Display license information)
Use this command to display license audit, license terms, and compliance
information.
Privilege class
Any administrator can issue this command.
Syntax
Query LICense

Parameters
None.
Related commands
Table 226. Commands related to QUERY LICENSE
Command Description
AUDIT LICENSES Checks for compliance with defined licenses.
QUERY AUDITOCCUPANCY Displays the server storage utilization for a
client node.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
REGISTER LICENSE Registers a new license with the IBM Tivoli
Storage Manager server.
SET LICENSEAUDITPERIOD Specifies the number of days between
automatic license audits.

QUERY LICENSE

742 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY LOG (Display information on the recovery log)
Use this command to display information about the recovery log.
Privilege class
Any administrator can issue this command.
Syntax

Query LOG
Format = Standard
Format

=

Standard

Detailed

Parameters
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task 1
Display information about the recovery log.
Command
query log
Output

Available Assigned Maximum Maximum Page Total Used Pct Max.
Space Capacity Extension Reduction Size Usable Pages Util Pct
(MB) (MB) (MB) (MB) (bytes) Pages Util
--------- -------- --------- --------- ------- ----- ----- ----- -----
16 8 8 4 4,096 1,536 187 12.2 12.8

See Task 2 for definitions.
Task 2
Display detailed information about the recovery log.
Command
query log format=detailed
Output

QUERY LOG
Chapter 2. Administrative commands 743
Available Space (MB): 16
Assigned Capacity (MB): 8
Maximum Extension (MB): 08
Maximum Reduction (MB): 4
Page Size (bytes): 4,096
Total Usable Pages: 1,536
Used Pages: 187
Pct Util: 12.2
Max. Pct Util: 12.8
Physical Volumes: 3
Log Pool Pages: 64
Log Pool Pct. Util: 0.31
Log Pool Pct. Wait: 0.00
Cumulative Consumption (MB): 0.60
Consumption Reset Date/Time: 05/31/1996 13:02:42

where:
Available Space (MB)
The amount of space available in the recovery log, in megabytes.
Assigned Capacity (MB)
The assigned storage capacity for the recovery log, in megabytes.
Maximum Extension (MB)
The maximum amount of storage space that you can extend the recovery log,
in megabytes.
Maximum Reduction (MB)
The maximum amount of storage space by which you can reduce the recovery
log, in megabytes.
Page Size (bytes)
The page size, in bytes.
Total Usable Pages
The total number of pages available for transactions in the recovery log.
Used Pages
The total number of pages currently in use by the recovery log.
Pct Util
The current utilization as a percentage value of the assigned capacity.
Max. Pct. Util
The maximum occupancy for the recovery log, as a percentage of the available
space since the last reset of this statistic.
Physical Volumes
The total number of recovery log volumes defined to the recovery log,
including volume copies.
Log Pool Pages
The number of pages in the recovery log buffer pool.
Log Pool Pct. Util
The percentage of all recovery log buffer pool pages that are used to write
changes to the recovery log after a transaction is committed.
Log Pool Pct. Wait
The percentage of buffer pool page requests that are not met because all buffer
pool pages are in use.
QUERY LOG

744 IBM Tivoli Storage Manager for Windows: Administrators Reference
Cumulative Consumption (MB)
The amount of log space used by the server since the last reset of this statistic,
in megabytes.
Consumption Reset Date/Time
The date and time of the last reset of the cumulative consumption statistic for
the recovery log.
Related commands
Table 227. Commands related to QUERY LOG
Command Description
DEFINE LOGCOPY Creates a volume copy of a recovery log
volume.
DEFINE LOGVOLUME Defines a disk volume to the recovery log.
EXTEND DB Extends usable database storage within the
volumes previously allocated for its use.
EXTEND LOG Extends usable log storage within the
volumes previously allocated for its use.
REDUCE DB Attempts to free up a database volume by
reducing usable storage within the volumes
defined.
REDUCE LOG Attempts to free up a log volume by
reducing usable storage within the volumes
defined.
RESET LOGCONSUMPTION Resets the statistic on recovery log space
used.
RESET LOGMAXUTILIZATION Resets the maximum utilization statistic for
the recovery log.

QUERY LOG
Chapter 2. Administrative commands 745
QUERY LOGVOLUME (Display information on one or more log
volumes)
Use this command to display information about recovery log volumes and volume
copies.
Privilege class
Any administrator can issue this command.
Syntax

Query LOGVolume
*
volume_name
Format = Standard
Format

=

Standard

Detailed

Parameters
volume_name
Specifies the recovery log volume name. This parameter is optional. You can
use wildcard characters to specify this name. If you do not specify a volume
name, all volumes are displayed.
Note: Tivoli Storage Manager displays output in this command from the
lowest to the highest number. If a volume is deleted, Tivoli Storage
Manager reuses that volume number the next time that a volume is
defined. A query can then display volumes that are not in numerical
sequence. You can reset the order of your recovery log volumes by
specifying the desired order with the DSMSERV LOADFORMAT
command.
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task
Display information about the recovery log volume named log1.dsm.
Command
query logvolume log1.dsm
Output

QUERY LOGVOLUME

746 IBM Tivoli Storage Manager for Windows: Administrators Reference
Volume Name Copy Volume Name Copy Volume Name Copy
(Copy 1) Status (Copy 2) Status (Copy 3) Status
---------------- ------ ---------------- ------ ----------- ------
c:\progra~1\tiv- Syncd c:\progra~1\tiv- Syncd Undef-
oli\tsm\server\- oli\tsm\server\- ined
log1.dsm log2.dsm

Task
Display detailed information about the recovery log volume named log1.dsm.
Command
query logvolume log1.dsm format=detailed
Output

Volume Name (Copy 1): c:\progra~1\tivoli\tsm\server\log1.dsm
Copy Status: Syncd
Volume Name (Copy 2): c:\progra~1\tivoli\tsm\server\log2.dsm
Copy Status: Syncd
Volume Name (Copy 3):
Copy Status: Undefined
Available Space (MB): 8
Allocated Space (MB): 8
Free Space (MB): 0

where:
Volume Name (Copy n)
Specifies the name of the recovery log volume. The output displays status of
the three volume copies (Copy 1, Copy 2, and Copy 3).
Copy Status
The status of the recovery log volume. Possible values are:
Offline
The volume is varied offline.
Stale
The volume is not synchronized with the other volumes in the recovery
log and cannot be used for storage.
Syncd
The volume is synchronized with the other volumes in the recovery log
and can be used for storage.
Undefined
No volume has been defined.
Available Space (MB)
The total amount of space that is available, both allocated and free, for the
recovery log, in megabytes.
Allocated Space (MB)
The amount of space allocated for the recovery log, in megabytes.
Free Space (MB)
The amount of unassigned space in the recovery log that can be allocated for
use, in megabytes.
QUERY LOGVOLUME
Chapter 2. Administrative commands 747
Related commands
Table 228. Commands related to QUERY LOGVOLUME
Command Description
DEFINE LOGCOPY Creates a volume copy of a recovery log
volume.
DEFINE LOGVOLUME Defines a disk volume to the recovery log.
DELETE LOGVOLUME Deletes a volume from the recovery log.
VARY Specifies whether a disk volume is available
to the server for use.

QUERY LOGVOLUME

748 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY MACHINE (Query machine information)
Use this command to display information for one or more machines. You can use
this information to recover Tivoli Storage Manager client machines in case of a
disaster.
Note: Tivoli Storage Manager does not use the information in any way. It is
available only to help you plan for the disaster recovery of client machines.
Tivoli Storage Manager displays information for multiple machines in the
following order:
v According to the priority specified.
v Within a priority, according to the specified location and machine name.
Privilege class
Any administrator can issue this command.
Syntax

Query MACHine
*
machine_name

BUilding

=

building

FLoor

=

floor

ROom

=

room

PRIority

=

priority

ADSMServer

=

Yes

No
Format = Standard
Format

=

Standard

Detailed

RECOVERYInstructions

CHaracteristics

Parameters
machine_name
Specifies the name of one or more machines to be queried. You can use
wildcard characters to specify this name. This parameter is optional. The
default is all machines that meet the specified criteria.
BUilding
Specifies the name or number of the building that the machines are in. This
parameter is optional. Enclose the text in quotation marks if it contains any
blank characters.
FLoor
Specifies the name or number of the floor that the machines are on. This
parameter is optional. Enclose the text in quotation marks if it contains any
blank characters.
ROom
Specifies the name or number of the room that the machines are in. This
parameter is optional. The text can be up to 16 characters. Enclose the text in
quotation marks if it contains any blank characters.
QUERY MACHINE
Chapter 2. Administrative commands 749
PRIority
Specifies the priority number of the machines. This parameter is optional.
ADSMServer
Specifies if the machine contains a Tivoli Storage Manager server. This
parameter is optional. The default is to display any machines that meet the
other criteria. Possible values are:
Yes
The machine contains a Tivoli Storage Manager server.
No
The machines do not contain a Tivoli Storage Manager server.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Tivoli Storage Manager displays partial information for the machines.
Detailed
Tivoli Storage Manager displays all information for the machines.
RECOVERYInstructions
Tivoli Storage Manager displays only machine recovery instructions. This
option is valid only when querying a specific machine.
CHaracteristics
Tivoli Storage Manager displays only machine characteristics. This option
is valid only when querying a specific machine.
Examples
Task 1
Display information for a machine named MACH1.
Command
query machine MACH1
Output
Machine Machine Building Floor Room Node Name Recovery
Name Priority Media Name
------- -------- -------- ----- ----- --------- ----------
MACH1 1 21 2 2929 VIRGINIA RECMED1

Task 2
Display detailed information for all priority 1 machines on the second floor of
building 21.
Command
query machine * building=21 floor=2 priority=1
format=detailed
Output
QUERY MACHINE

750 IBM Tivoli Storage Manager for Windows: Administrators Reference
Machine Name: MACH1
Machine Priority: 1
Building: 21
Floor: 2
Room: 2929
Server?: Yes
Description: TSM server machine
Node Name: VIRGINIA
Recovery Media Name: RECMED1
Characteristics?: Yes
Recovery Instructions?: Yes

where:
Machine Name
The name of the machine.
Machine Priority
The recovery priority of the machine.
Building
The building in which the machine is located.
Floor
The floor on which the machine is located.
Room
The room in which the machine is located.
Server?
Whether the machine contains a Tivoli Storage Manager server.
Description
A description of the machine.
Node Name
The Tivoli Storage Manager client nodes associated with this machine.
Recovery Media Name
The recovery media associated with this machine.
Characteristics?
Whether the characteristics text of the machine is stored in the database.
Recovery Instructions?
Specifies whether recovery instructions text for a machine is stored in the
Tivoli Storage Manager database.
Related commands
Table 229. Commands related to QUERY MACHINE
Command Description
DEFINE MACHINE Defines a machine for DRM.
DEFINE MACHNODEASSOCIATION Associates an IBM Tivoli Storage Manager
node with a machine.
DEFINE RECMEDMACHASSOCIATION Associates recovery media with a machine.
DELETE MACHINE Deletes a machine.
INSERT MACHINE Inserts machine characteristics or recovery
instructions into the IBM Tivoli Storage
Manager database.
QUERY MACHINE
Chapter 2. Administrative commands 751
Table 229. Commands related to QUERY MACHINE (continued)
Command Description
UPDATE MACHINE Changes the information for a machine.

QUERY MACHINE

752 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY MEDIA (Query sequential access storage pool media)
Use this command to display information about the sequential access primary and
copy storage pool volumes moved by the MOVE MEDIA command.
Privilege class
Any administrator with system or operator privilege can issue this command
unless it includes the CMD parameter. If the CMD parameter is specified and the
REQSYSAUTHOUTFILE server option is set to NO, the administrator must have
operator, unrestricted storage, or system privilege. If the CMD parameter is
specified and the REQSYSAUTHOUTFILE server option is set to YES (the default),
the administrator must have system privilege.
Syntax

Query MEDia
*
volume_name

STGpool

=

pool_name
Days = 0
Days

=

days

,

WHERESTATUs

=

FULl

FILling

EMPty

WHEREACCess

=

READWrite

READOnly

Format = Standard
Format

=

Standard

Detailed

Cmd

WHERESTate

=

All

MOUNTABLEInlib

MOUNTABLENotinlib

WHEREOVFLOcation

=

location

CMd

=

command

CMDFilename

=

file_name
APPend = No
APPend

=

No

Yes

Parameters
volume_name
Specifies the name of the sequential access primary or copy storage pool
volume to display. This parameter is optional. You can use a wildcard
character to specify the name. All matching volumes are considered for
processing. If you do not specify this parameter, all volumes defined in the
storage pool specified with the STGPOOL parameter display.
STGpool (Required)
Specifies the name of the sequential access primary or copy storage pool that is
used to select the volumes for processing. You can use wildcard characters to
specify the name. All matching storage pools are processed. If the storage pool
specified is not managed by an automated library, no volumes display.
QUERY MEDIA
Chapter 2. Administrative commands 753
Days
Specifies the number of days that must elapse, after the volume has been
written to or read from, before the volume is eligible for processing. This
parameter is optional. You can specify a number from 0 to 9999. The default
value is 0. The most recent of the volumes last written date or last read date is
used to calculate the number of days elapsed.
WHERESTATUs
Specifies that the output of QUERY should be restricted by volume status. This
parameter is optional. You can specify more than one status in a list by
separating each status with a comma and no intervening spaces. If you do not
specify a value for this parameter, all volumes in the specified storage pool,
regardless of their status, are displayed.
Possible values are:
FULl
Specifies that volumes with a status of FULL display.
FILling
Specifies that volumes with a status of FILLING display.
EMPty
Specifies that volumes with a status of EMPTY display.
WHEREACCess
Specifies that output should be restricted by volume access mode. This
parameter is optional. If you do not specify a value for this parameter, output
is not restricted by access mode.
Possible values are:
READWrite
Specifies that volumes with an access mode of READWRITE display.
READOnly
Specifies that volumes with an access mode of READONLY display.
Format
Specifies how information displays. This parameter is optional. The default
value is STANDARD. Possible values are:
Standard
Specifies that partial information displays for the specified sequential
access storage pool volumes.
Detailed
Specifies that complete information displays for the specified sequential
access storage pool volumes.
Cmd
Specifies that executable commands are built for the storage pool volumes
processed by the QUERY MEDIA command. These commands will be in
the file specified with the CMDFILENAME parameter on the QUERY
MEDIA command. If you want the commands to display on the console
only, specify a null string () for the CMDFILENAME. If FORMAT=CMD
is specified but no command string is specified with the CMD parameter,
the QUERY MEDIA command will fail.
WHEREState
Specifies the state of volumes to process. This parameter restricts processing to
volumes that have the specified state. This parameter is optional. The default is
ALL. Possible values are:
QUERY MEDIA

754 IBM Tivoli Storage Manager for Windows: Administrators Reference
All
Specifies that volumes in all states are queried. The valid states are:
MOUNTABLEINLIB and MOUNTABLENOTINLIB.
MOUNTABLEInlib
Specifies that volumes that are currently in the MOUNTABLEINLIB state
are queried. Volumes in the MOUNTABLEINLIB state are in the library,
and are onsite, contain valid data, and are available for onsite processing.
MOUNTABLENotinlib
Specifies that volumes that are currently in the MOUNTABLENOTINLIB
state are queried. Volumes in the MOUNTABLENOTINLIB state are not in
the library, do not contain valid data, and are not available for onsite
processing.
WHEREOVFLOcation
Specifies the overflow location of the volumes to display. This parameter is
optional. This parameter restricts processing to volumes that are in the
specified location. The maximum length of the location is 255 characters. The
location must be enclosed in quotation marks if it contains any blank
characters.
CMd
Specifies the creation of executable commands. Enclose the command
specification in quotation marks. The maximum length of the command
specification is 255 characters. This parameter is optional.
For each volume successfully processed by the QUERY MEDIA command, the
server writes the associated commands to a file. Specify the file name with the
CMDFILENAME parameter. If you do not specify a filename, the command
will generate a default filename by appending the string exec.cmd.media to
the server directory.
Note:
1. If the command written to the file exceeds 255 characters, it is split
into multiple lines, and a continuation character (+) is added to all
but the last line. You may need to alter the continuation character
according to the requirements of the product that executes the
commands.
2. If an executable command is specified with any value for FORMAT
other than CMD, the command string is ignored, and the QUERY
MEDIA command will not write any command line.
Specify a command string and any substitution variables:
string
Specifies the string to build an executable command to process the volume
name or volume location or both. You can specify any free form text for
the string. Do not use embedded quotation marks. For example, the
following is a valid executable command specification:
cmd="checkin libvolume &vol"
The following is an invalid executable command specification:
cmd="checkin libvolume "&vol""
substitution
Specifies a variable for which you want the QUERY MEDIA command to
substitute a value. The possible substitution variables are:
QUERY MEDIA
Chapter 2. Administrative commands 755
&VOL
Substitute the volume name for &VOL. You can specify lowercase
characters, &vol. No spaces or blanks are allowed between ampersand,
&, and VOL. If there are spaces or blanks between ampersand and
VOL, the QUERY MEDIA command will treat them as strings and no
substitution will be set. If &VOL is not specified, no volume name is
set in the executable command.
&LOC
Substitute the volume location for &LOC. You can specify lowercase
characters, &loc. No spaces or blanks are allowed between ampersand,
&, and LOC. If there are spaces or blanks between ampersand and
LOC, the QUERY MEDIA command will treat them as strings and no
substitution will be set. If &LOC is not specified, no location name is
set in the executable command.
&VOLDSN
Substitute the volume file name for &VOLDSN. An example of a copy
storage pool tape volume file name using the defined prefix IBM Tivoli
Storage Manager310 is IBM Tivoli Storage Manager310.BFS. If
&VOLDSN is not specified, no volume file name is set in the
executable command.
&NL
Substitute the new line character for &NL. When &NL is specified, the
QUERY MEDIA command will split the command at the position
where the &NL is and will not append any continuation character. The
user is responsible for specifying the proper continuation character
before the &NL if one is required. The user is also responsible for the
length of the line written. If the &NL is not specified and the
command exceeds 255 characters, the command is split into multiple
lines, and a continuation character (+) is added to all but the last line.
CMDFilename
Specifies the full path name that will contain the commands specified with
CMD parameter when FORMAT=CMD is specified. This parameter is optional.
The maximum length of the file name is 1279 characters. If you specify with
the CMDFILENAME parameter, the QUERY MEDIA command will generate a
file name by appending the exec.cmd.media to the server directory. The
server directory is determined in the following order:
1. If defined, the directory pointed to by the DSMSERV_DIR environment
variable.
2. If the DSMSERV_DIR environment variable is not defined, the current
working directory of the server process.
If you specify a null string () for the CMDFILENAME, the commands built
are displayed on the console only. You can redirect the commands displayed to
a file by using the redirection characters for the operating system (> or >>).
If the filename is not specified, the command will generate a default filename
by appending the string exec.cmd.media to the server directory.
The QUERY MEDIA command automatically allocates the file name specified
or generated. If the file name exists, the QUERY MEDIA command will
attempt to use it and the existing data, if any, in the file to be overwritten. You
can specify APPEND=YES to prevent the existing data from being overwritten.
If the QUERY MEDIA command fails after the command file is allocated, the
file is not deleted.
QUERY MEDIA

756 IBM Tivoli Storage Manager for Windows: Administrators Reference
APPend
Specifies to write at the beginning or the ending of the command file data.
This parameter is optional. The default is NO. Possible values are:
No
Specifies to write the data from the beginning of the command file. If the
given command file exists, its contents are overwritten.
Yes
Specifies to append the command file by writing at the end of the
command file data.
Examples
Task
Display all full and partial full volumes that are in the sequential access primary
storage pool, ARCHIVE.
Command
query media * stgpool=archive wherestatus=full, filling
Output


Volume Name State Location Automated
LibName
----------- ------------------- -------------------- -----------
TAPE01 Mountable in Library LIB3494
TAPE03 Mountable not in Lib. Room1234/Bldg31
TAPE07 Mountable in Library LIB3494
TAPE09 Mountable not in Lib. Room1234/Bldg31

See Task 2 for parameter definitions.
Task
Display in detail all full volumes in MOUNTABLENOTINLIB state for sequential
access storage pools that have a prefix name of ONSITE.
Command
query media wherestate=mountablenotinlib stgpool=onsite*
wherestatus=full format=detailed
Output

QUERY MEDIA
Chapter 2. Administrative commands 757
Volume Name: TAPE21
State: Mountable not in library
Status: Full
Access: ReadOnly
Last Reference Date: 01/30/98
Last Update Date/Time: 08/20/1996 13:29:02
Location: Rm569/bldg31
Storage Pool Name: ONSITE.ARCHIVE
Automated Libname:

Volume Name: TAPE22
State: Mountable not in library
Status: Full
Access: ReadOnly
Last Reference Date: 01/30/98
Last Update Date/Time: 08/20/1996 15:29:02
Location: Rm569/bldg31
Storage Pool Name: ONSITE.ARCHIVEPOOL
Automated Libname:
where:
Volume Name
Specifies the name of the primary sequential access storage pool volume.
State
Specifies the state of the volume.
Status
Specifies the status of the volume.
Access
Specifies the access mode of the volume.
Last Reference Date
Specifies the volumes last written date or last read date, whichever is more
recent.
Last Update Date/Time
Specifies the date and time when the volume was most recently updated.
Location
Specifies where the volume is stored. If the volume is ejected from the library
and its location is not specified or defined, a question mark (?) is displayed for
the location.
Storage Pool Name
Specifies the name of the sequential access storage pool where the volume is
defined.
Automated LibName
Specifies the automated library name if the volume is in the library.
Task
Generate the CHECKIN LIBVOLUME commands for full and partially full
volumes that are in the ONSITE.ARCHIVE primary storage pool and stored in the
overflow location Room 2948/Bldg31.
Command
query media * stgpool=onsite.archive format=cmd
wherestatus=full,filling wherestate=mountablenotinlib
whereovflocation=room2948/bldg31
cmd="checkin libvol lib3494 &vol status=private"
cmdfilename=/tsm/move/media/checkin.vols
QUERY MEDIA

758 IBM Tivoli Storage Manager for Windows: Administrators Reference
Output
QUERY MEDIA created the executable commands in /tsm/move/media/
checkin.vols:
checkin libvol lib3494 TAPE04 status=private
checkin libvol lib3494 TAPE13 status=private
checkin libvol lib3494 TAPE14 status=private

Note: Run the CHECKIN LIBVOLUME commands by issuing the MACRO
command with /tsm/move/media/checkin.vols as the macro name.
Related commands
Table 230. Commands related to QUERY MEDIA
Command Description
MOVE MEDIA Moves storage pool volumes that are
managed by an automated library.

QUERY MEDIA
Chapter 2. Administrative commands 759
QUERY MGMTCLASS (Query a management class)
Use this command to display information about management classes.
Privilege class
Any administrator can issue this command.
Syntax

Query MGmtclass
* * *
*

*

domain_name

*

policy_set_name

class_name

Format = Standard
Format

=

Standard

Detailed

Parameters
domain_name
Specifies the policy domain associated with the management class to query.
This parameter is optional. You can use wildcard characters to specify this
name. If you do not specify a value for this parameter, management classes in
all policy domains are queried. You must specify this parameter when
querying an explicitly named management class.
policy_set_name
Specifies the policy set associated with the management class to query. This
parameter is optional. You can use wildcard characters to specify this name. If
you do not specify a value for this parameter, management classes in all policy
sets are queried. You must specify this parameter when querying an explicitly
named management class.
class_name
Specifies the management class to query. This parameter is optional. You can
use wildcard characters to specify this name. If you do not specify a value for
this parameter, all management classes are queried.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task 1
QUERY MGMTCLASS

760 IBM Tivoli Storage Manager for Windows: Administrators Reference
Query all management classes for all policy domains. Create the output in
standard format.
Command
query mgmtclass
Output

Policy Policy Mgmt Default Description
Domain Set Name Class Mgmt
Name Name Class ?
--------- --------- --------- --------- ------------------
EMPLOYEE- ACTIVE ACTIVEFI- Yes Modified default
_RECORDS LES management class
EMPLOYEE- HOLIDAY ACTIVEFI- Yes Modified default
_RECORDS LES management class
EMPLOYEE- HOLIDAY FILEHIST- No Test modified
_RECORDS ORY management class
EMPLOYEE- VACATION ACTIVEFI- Yes Original default
_RECORDS LES management class
EMPLOYEE- VACATION FILEHIST- No Test modified
_RECORDS ORY management class
PROG1 SUMMER MCLASS1 No Technical Support
Mgmt Class
PROG2 SUMMER MCLASS1 No Technical Support
Mgmt Class
STANDARD ACTIVE STANDARD Yes Installed default
management class
STANDARD STANDARD STANDARD Yes Installed default
management class

See Task 2 for parameter definitions.
Task 2
Query the ACTIVEFILES management class that is assigned to the VACATION
policy set of the EMPLOYEE_RECORDS policy domain. Create the output in
detailed format.
Command
query mgmtclass employee_records vacation
activefiles format=detailed
Output

Policy Domain Name: EMPLOYEE_RECORDS
Policy Set Name: VACATION
Mgmt Class Name: ACTIVEFILES
Default Mgmt Class ?: Yes
Description: Installed default management class
Space Management Technique: None
Auto-Migrate on Non-Use: 0
Migration Requires Backup?: Yes
Migration Destination: SPACEMGPOOL
Last Update by (administrator): $$CONFIG_MANAGER$$
Last Update Date/Time: 05/31/1998 13:15:45
Managing Profile: EMPLOYEE

where:
Policy Domain Name
The policy domain.
QUERY MGMTCLASS
Chapter 2. Administrative commands 761
Policy Set Name
The policy set.
Mgmt Class Name
The management class.
Default Mgmt Class?
Whether the management class is the default management class for the policy
set.
Description
The description of the management class.
Space Management Technique
The space management technique for the management class, for Tivoli Storage
Manager for Space Management clients (also known as HSM clients).
Auto-Migrate on Non-Use
The number of days that must elapse since a file was last accessed before it is
eligible for automatic migration from HSM clients.
Migration Requires Backup?
Whether a backup version of a file must exist before a file can be migrated
from HSM clients.
Migration Destination
The storage pool that is the destination for files migrated from HSM clients.
Last Update by (administrator)
The administrator or server that most recently updated the management class.
If this field contains $$CONFIG_MANAGER$$, the management class is
associated with a domain that is managed by the configuration manager.
Last Update Date/Time
The date and time when the management class was most recently defined or
updated.
Managing Profile
The profile or profiles to which the managed server subscribed to get the
definition of this management class.
Related commands
Table 231. Commands related to QUERY MGMTCLASS
Command Description
COPY MGMTCLASS Creates a copy of a management class.
DEFINE MGMTCLASS Defines a management class.
DEFINE PROFASSOCIATION Associates objects with a profile.
DELETE MGMTCLASS Deletes a management class and its copy
groups from a policy domain and policy set.
QUERY DOMAIN Displays information about policy domains.
UPDATE MGMTCLASS Changes the attributes of a management
class.

QUERY MGMTCLASS

762 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY MOUNT (Display information on mounted sequential
access volumes)
Use this command to display information about the status of one or more
sequential access volumes that are mounted.
Privilege class
Any administrator can issue this command.
Syntax

Query MOunt
*
volume_name

Parameters
volume_name
Specifies the name of the mounted sequential access volume. You can use
wildcard characters to specify this name. This parameter is optional. The
default is all mounted volumes.
Examples
Task
Display information on all mounted sequential media volumes.
Command
query mount
Output
ANR8330I 3590 volume D6W992 is mounted R/O
in drive RMT1(/dev/rmt1), status: IN USE.
ANR8334I 1 volumes found.
ANR8331I 8MMTAPE volume WPD000 is mounted R/W
in drive 8MM.1 (mt3.0.0.0), status: DISMOUNTING.
ANR8334I 1 volumes found.

Note:
1. If the status of a volume is full or if its access mode is read-only (R/O),
the mount mode of the volume will be R/O. (To determine the status
and access mode of a volume, issue the command QUERY VOLUME
FORMAT=DETAILED.) If a volume can be written to (that is, the status
is filling or empty), the mount mode of the volume will be read/write
(R/W), even if it is currently only being read.
2. In a storage pool associated with the FILE device type, the server allows
multiple read-access and one write-access to the same volume
concurrently. As a result, a volume in a storage pool with a device type
of FILE can appear as mounted more than once.
QUERY MOUNT
Chapter 2. Administrative commands 763
|
|
|
|
Related commands
Table 232. Commands related to QUERY MOUNT
Command Description
DISMOUNT VOLUME Dismounts a sequential, removable volume
by the volume name.
REPLY Allows a request to continue processing.

QUERY MOUNT

764 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY NASBACKUP (Query NAS backup images)
Use this command to display information about the file system image objects that
have been backed up for a specific NAS node and file space. You can only use this
command to display objects that were backed up for a NAS node using NDMP.
The server displays all matching objects, the dates that these objects were backed
up, and information about a table of contents (TOC) for the object.
Privilege class
Any administrator can issue this command.
Syntax

Query NASBAckup

node_name

filespace_name
BEGINDate = TODAY - 7
BEGINDate

=

date

BEGINTime = 00:00:00
BEGINTime

=

time
ENDDate = TODAY
ENDDate

=

date
ENDTime = 23:59:59
ENDTime

=

time

Parameters
node_name (Required)
Specifies the name of the NAS node for which backup objects are displayed.
You cannot use wildcards to specify this name.
filespace_name (Required)
Specifies the name of the file space for which backup objects are displayed.
You can use wildcards to specify this name.
BEGINDate
Specifies the beginning date to select the backup objects to display. All backup
objects that were created on or after the specified date are displayed. The
default is seven days prior to the current date. You can use this parameter with
the BEGINTIME parameter to specify a range for the date and time. This
parameter is optional.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/2002
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY 7 or 7.
To display information about the
image objects that have been created a
week ago, you can specify
BEGINDATE=TODAY-7 or
BEGINDATE= -7.

BEGINTime
Specifies the beginning time to select the backup objects to display. All backup
QUERY NASBACKUP
Chapter 2. Administrative commands 765
objects created on or after the specified time display. This parameter is
optional. The default is midnight (00:00:00) on the date specified for the
BEGINDATE.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the
specified begin date
10:30:08
NOW The current time on the
specified begin date
NOW
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
begin date
NOW+03:00 or +03:00.
If you issue this command at 9:00
with BEGINTIME=NOW+3 or
BEGINTIME=+3, Tivoli Storage
Manager displays image objects with
a time of 12:00 or later on the begin
date.
NOW-HH:MM or
-HH:MM
The current time minus hours
and minutes on the specified
begin date
NOW-04:00 or -04:00.
If you issue this command at 9:00
with BEGINTime=NOW-3:30 or
BEGINTime= -3:30, Tivoli Storage
Manager displays image objects with
a time of 5:30 or later on the begin
date.

ENDDate
Specifies the ending date used to select the backup objects to be displayed. All
backup objects created on or before the specified date are displayed. This
parameter is optional. The default is the current date. You can use this
parameter with the ENDTIME parameter to specify an ending date and time.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/2002
TODAY The current date TODAY
TODAY-days or
-days
The current date minus days
specified. The maximum
number of days you can
specify is 9999.
TODAY1 or 1.
To display information created up to
yesterday, you can specify
ENDDATE=TODAY-1 or simply
ENDDATE= -1.

ENDTime
Specifies the ending time used to select the backup objects to be displayed. All
backup objects created on or before the specified time are displayed. This
parameter is optional. The default is 23:59:59. You can use this parameter with
the ENDDATE parameter to specify a range for the date and time.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the
specified end date
10:30:08
QUERY NASBACKUP

766 IBM Tivoli Storage Manager for Windows: Administrators Reference
Value Description Example
NOW The current time on the
specified end date
NOW
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
end date
NOW+03:00 or +03:00.
If you issue this command at 9:00
with ENDTIME=NOW+3:00 or
ENDTIME= +3:00, Tivoli Storage
Manager displays image objects with
a time of 12:00 or later on the end
date you specify.
NOW-HH:MM or
-HH:MM
The current time minus hours
and minutes on the specified
end date
NOW-03:30 or -03:30.
If you issue this command at 9:00
with ENDTIME=NOW-3:30 or
ENDTIME= -3:30, IBM Tivoli Storage
Manager displays image objects with
a time of 5:30 or later on the end date
you specify.

Examples
Task
Use QUERY NASBACKUP to display information about a node: nas1, and a
filespace: /vol/vol1.
Command
query nasbackup nas1 /vol/vol1
Output
Node Filespace Object Object Creation Has Table Image
Name Name Type Size Date of Contents Storage
(MB) (MB) Contents (TOC) Pool
----- -------- --------- ----- ---------- ---------- --------
NAS1 vol/vol1 Full image 1050.5 10/22/2002 YES NASBACKUPS
10:50:57
NAS1 vol/vol1 Differential 9.1 10/22/2002 YES NASBACKUPS
image 11:03:21
NAS1 vol/vol1 Full image 1050.5 10/22/2006 YES FILEPOOL
10:43:00
NAS1 vol/vol1 Differential 9.1 10/25/2006 YES FILEPOOL
image 11:53:21

Related commands
Table 233. Commands related to QUERY NASBACKUP
Command Description
BACKUP NODE Backs up a network-attached storage (NAS)
node.
BACKUP NAS (Tivoli Storage Manager client
command)
Creates a backup of NAS node data.
QUERY TOC Displays details about the table of contents
for a specified backup image.
RESTORE NODE Restores a network-attached storage (NAS)
node.

QUERY NASBACKUP
Chapter 2. Administrative commands 767
QUERY NODE (Query nodes)
Use this command to display information about one or more registered nodes.
Privilege class
Any administrator can issue this command.
Syntax

Query Node
*
node_name

,

DOmain

=

domain_name

Format = Standard
Format

=

Standard

Detailed
Type = Client
Type

=

Client

NAS

Server

Any

Parameters
node_name
Specifies the name of the client node to be queried. You can use wildcard
characters to specify this name. All matching client nodes are queried. If you
do not specify a value for this parameter, all client nodes are queried. The
parameter is optional.
DOmain
Specifies a list of policy domains that limit the client node query. Only nodes
that are assigned to one of the specified policy domains are displayed. This
parameter is optional. Separate the items in the list by commas, with no
intervening spaces. You can use wildcard characters to specify a domain. All
clients assigned to a matching domain are displayed. If you do not specify a
value for this parameter, all policy domains are included in the query.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the specified client nodes.
Detailed
Specifies that complete information is displayed for the specified client
nodes.
Type
Specifies the type of node to include in the query results. The parameter is
optional. The default value is CLIENT. Possible values are:
Any
Specifies any type of node.
Client
Specifies client nodes that are backup-archive clients, HSM clients, or
application clients.
QUERY NODE

768 IBM Tivoli Storage Manager for Windows: Administrators Reference
NAS
Specifies NAS nodes.
Server
Specifies client nodes that are other Tivoli Storage Manager servers.
Examples
Task 1
Display information on all registered client nodes.
Command
query node
Output

Node Name Platform Policy Domain Days Since Days Since Locked?
Name Last Password
Access Set
--------- -------- -------- --------- ---------- -------
CLIENT1 AIX STANDARD 6 6 No
GEORGE AIX STANDARD 1 1 No
JANET AIX STANDARD 1 1 No
JARED Linux86 STANDARD 1 1 No
JOE2 Mac STANDARD <1 <1 No
TOMC WinNT STANDARD 1 1 No

where:
Node Name
The name of the client node.
Platform
The client nodes operating system Yeas of the last time that the client node
contacted the server. A question mark (?) is displayed until the client node first
accesses the server and reports its platform type.
Policy Domain Name
The name of the policy domain to which the client node is assigned.
Days Since Last Access
The number of days that have elapsed since the last time the client node
accessed the server.
Days Since Password Set
The number of days that have elapsed since the client nodes password was
set.
Locked?
Whether the client node is locked out of Tivoli Storage Manager.
Task 2
Display complete information on the client node named Joe.
Command
query node joe format=detailed
Output
QUERY NODE
Chapter 2. Administrative commands 769
Node Name: JOE
Platform: WinNT
Client OS Level: 4.00
Client Version: Version 5, Release 2, Level 0.0
Policy Domain Name: STANDARD
Last Access Date/Time: 09/24/2002 18:55:46
Days Since Last Access: 6
Password Set Date/Time: 09/24/2002 18:26:43
Days Since Password Set: 6
Invalid Sign-on Count: 0
Locked?: No
Contact:
Compression: Client
Archive Delete Allowed?: Yes
Backup Delete Allowed?: No
Registration Date/Time: 09/24/2002 18:26:43
Registering Administrator: SERVER_CONSOLE
Last Communication Method Used: Tcp/Ip
Bytes Received Last Session: 108,731
Bytes Sent Last Session: 698
Duration of Last Session (sec): 0.00
Pct. Idle Wait Last Session: 0.00
Pct. Comm. Wait Last Session: 0.00
Pct. Media Wait Last Session: 0.00
Optionset:
URL: http://joe.host.name:1581
Node Type: Client
Password Expiration Period: 60
Keep Mount Point?: No
Maximum Mount Points Allowed: 2
Auto Filespace Rename: No
Validate Protocol: No
TCP/IP Name:
TCP/IP Address: 9.11.153.39
Globally Unique ID: 11.9c.54.e0.8a.b5.11.d6.b3.c3.00.06.29.45.cl
Transaction Group Max: 0
Data Write Path: ANY
Data Read Path: ANY
Session Initiation: ClientOrServer
High-level Address:
Low-level Address: 1501
Collocation Group Name:
Proxynode Target:
Proxynode Agent:
Node Groups:
where:
Node Name
The name of the client node.
Platform
The client nodes platform (operating system) as of the last time that the client
node contacted the server. A question mark (?) is displayed until the client
node first accesses the server and reports its platform type.
Client OS Level
The level of the clients operating system as of the last time that the client node
contacted the server.
Client Version
The version of the client that is installed on the client node.
This field does not apply to NAS nodes.
Policy Domain Name
The client nodes assigned policy domain.
QUERY NODE

770 IBM Tivoli Storage Manager for Windows: Administrators Reference
Last Access Date/Time
The last date and time that the client node accessed the server.
Days Since Last Access
The number of days that have elapsed since the last time that the client node
accessed the server.
Password Set Date/Time
The date and time that the client nodes password was set.
Days Since Password Set
The number of days that have elapsed since the client nodes password was
set.
Invalid Sign-on Count
The number of invalid sign-on attempts that have been made since the last
successful sign-on. This count can only be non-zero when the invalid password
limit (SET INVALIDPWLIMIT) is greater than zero. When the number of
invalid attempts equals the limit set by the SET INVALIDPWLIMIT command,
the node is locked out of the system.
Locked?
Whether the client node is locked out of Tivoli Storage Manager.
Contact
Any contact information for the client node.
Compression
Whether compression is enabled on the client node.
This field does not apply to NAS nodes.
Archive Delete Allowed?
Whether the client node can delete its own archive files.
Backup Delete Allowed?
Whether the client node can delete its own backup files.
Registration Date/Time
The date and time that the client node was registered.
Registering Administrator
The name of the administrator that registered the client node.
Last Communication Method Used
The communication method that was last used by the client node to contact
the server.
Bytes Received Last Session
The number of bytes received by the server during the last client node session.
This field does not apply to NAS nodes.
Bytes Sent Last Session
The number of bytes sent to the client node.
This field does not apply to NAS nodes.
Duration of Last Session (sec)
How long the most recent client node session lasted.
This field does not apply to NAS nodes.
Pct. Idle Wait Last Session
The percentage of the total session time that the client was not performing any
functions.
QUERY NODE
Chapter 2. Administrative commands 771
This field does not apply to NAS nodes.
Pct. Comm. Wait Last Session
The percentage of the total session time that the client waited for a
communication response from the server.
This field does not apply to NAS nodes.
Pct. Media Wait Last Session
The percentage of the total session time that the client waited for a removable
volume to be mounted.
This field does not apply to NAS nodes.
Optionset
The name of the client option set.
URL
The clients Uniform Resource Locator (URL) address that the administrator
can use to contact the client from the Administration Center.
Node Type
The type of client node. The value is one of the following:
v Client (a backup-archive client, an HSM client, or an application client)
v Server (a Tivoli Storage Manager server)
v NAS (a NAS file server)
Password Expiration Period
The client nodes password expiration period.
Keep Mount Point?
Whether the client node has the ability to retain a mount point during a
session.
Maximum Mount Points Allowed
The mount points that a client node is allowed to use on the server for backup
and archive operations, and HSM migration. This parameter does not apply to
nodes with a type of NAS or SERVER. If a client node was registered to a
server at Version 3.7 or later, the value will be 0999, depending on the value
that is set with the MAXNUMMP parameter of the REGISTER NODE
command. If the client node was registered under previous versions of the
server and the MAXNUMMP parameter was not explicitly set using the
UPDATE NODE command, then the value is set to NOLIMIT. The
MAXNUMMP value is not evaluated or enforced during client data read
operations such as restore, retrieve, and HSM recall. However, mount points in
use for data read operations are evaluated against attempted concurrent data
store operations for the same client node and may prevent the data store
operations from being able to acquire mount points.
Auto Filespace Rename
Whether Tivoli Storage Manager prompts the client to rename file spaces when
the client system upgrades to a client that supports Unicode. This field is valid
only for client systems that use Windows, Macintosh OS X, or NetWare
operating systems.
Validate Protocol
Whether the client has data validation enabled. If the client has data validation
enabled, this field specifies whether Tivoli Storage Manager validates only the
file data or all data, which includes file metadata. You can enable data
validation by using the REGISTER NODE or UPDATE NODE commands.
QUERY NODE

772 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
TCP/IP Name
The host name of the client node as of the last time that the client node
contacted the server. The field is blank if the client software does not support
reporting this information to the server.
TCP/IP Address
The TCP/IP address of the client node as of the last time that the client node
contacted the server. The field is blank if the client software does not support
reporting this information to the server.
Globally Unique ID
The globally unique identifer (GUID) as of the last time that the client node
contacted the server. This GUID identifies the host machine on which the node
resides.
Transaction Group Max
Specifies the number of files per transaction commit that are transferred
between a client and a server. Client performance may be improved by using a
larger value for this option.
Data Write Path
Specifies the transfer path used when the client sends data to the server,
storage agent, or both during storage operations such as backup or archive. If a
path is unavailable, the node cannot send any data.
Data Read Path
Specifies the transfer path used when the server, storage agent, or both read
data for a client, during operations such as restore or retrieve. If a path is
unavailable, data cannot be read.
Session Initiation
Controls whether the server or client initiates sessions. The two options are:
v ClientOrServer
v Serveronly
High-level Address
Specifies the client IP address that the server contacts to initiate scheduled
events when SESSIONINITIATION is set to SERVERONLY.
Low-level Address
Specifies the client port number on which the client listens for sessions from
the server when SESSIONINITIATION is set to SERVERONLY.
Collocation Group Name
Specifies the name of the collocation group to which a node belongs. If a node
does not belong to a collocation group, this field is blank.
Proxynode Target
Specifies which nodes are proxy nodes (agents) for other nodes, in a space
separated list. If there are no nodes in that type of association, this field is
blank.
Proxynode Agent
Specifies the originating (target) node name for a proxy node session, in a
space separated list. If there are no nodes in that type of association, this field
is blank.
Node Groups
QUERY NODE
Chapter 2. Administrative commands 773
|
|
|
|
Specifies the name of the node group to which a node belongs. If a node does
not belong to a node group, this field is blank.
Related commands
Table 234. Commands related to QUERY NODE
Command Description
LOCK NODE Prevents a client from accessing the server.
QUERY ADMIN Displays information about one or more IBM
Tivoli Storage Manager administrators.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
REGISTER NODE Defines a client to the server and sets options
for that user.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
RENAME NODE Changes the name for a user that belongs to
a specific policy domain.
RESET PASSEXP Resets the password expiration for nodes or
administrators.
SET INVALIDPWLIMIT Sets the number of invalid logon attempts
before a node is locked.
SET MINPWLENGTH Sets the minimum length for client
passwords.
SET PASSEXP Specifies the number of days after which a
password is expired and must be changed.
UNLOCK NODE Enables a locked user in a specific policy
domain to access the server.
UPDATE NODE Changes the attributes associated with a
client node.

QUERY NODE

774 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY NODEDATA (Query client data in volumes)
Use this command to display information about the data for one or more nodes in
a sequential access storage pool. QUERY NODEDATA displays the name of the
volume on which a nodes data is written and the amount of space occupied by
the data on that volume. This information is useful when determining how to
group nodes into collocated storage pools.
Privilege class
Any administrator can issue this command.
Syntax

,
Query NODEData

node_name

COLLOCGroup

=

colloc_group

STGpool

=

pool_name

VOLume

=

vol_name


Parameters
node_name
Specifies the name of the client node for which you want to locate data. You
can specify one or more names. If you specify multiple names, separate the
names with commas; do not use intervening spaces. You can also use wildcard
characters when specifying multiple names. You must specify either a node
name or collocation group name, but not both.
COLLOCGroup
Specifies the name of the collocation group for which you want to locate data.
You must specify either a node name or collocation group name, but not both.
STGpool
Specifies the name of the sequential storage pool to query. This parameter is
optional. You can use wildcard characters to specify the names. If a wildcard
matches the name of a disk storage pool, the name of the disk storage pool
will be ignored. If you do not specify a value for this parameter, all sequential
storage pools are queried.
VOLume
Specifies the volume that contains the data. This parameter is optional. You can
use wildcard characters to specify multiple names. If you do not specify a
value for this parameter, all volumes in the storage pool are queried.
Examples
Task 1
Display information about where node data is stored in a sequential storage pool.
Use a wildcard character to indicate node names.
Command
query nodedata e*
QUERY NODEDATA
Chapter 2. Administrative commands 775
Output

Node Name Volume Name Storage Pool Physical
Name Space
Occupied
(MB)
--------- ------------------------------ ------------ --------
EDU_J2 E:\tsm\server\00000117.BFS EDU512 0.01
EDU_J2 E:\tsm\server\00000122.BFS EDU319 0.01
EDU_J3 E:\tsm\server\00000116.BFS EDU512 0.01
EDU_J3 E:\tsm\server\00000120.BFS EDU319 0.01
EDU_J7 E:\tsm\server\00000118.BFS EDU512 0.04
EDU_J7 E:\tsm\server\00000123.BFS EDU319 0.04
EDU_JJ1 E:\tsm\server\00000116.BFS EDU512 0.01
EDU_JJ1 E:\tsm\server\00000121.BFS EDU512 0.01

where:
Task 2
Display information about the location of node data in a sequential storage pool
for a particular collocation group. In this example, nodes EDU_J3 and EDU_JJ1 are
the only members that belong to collocation group, grp1, and have data in a
sequential access storage pool.
Command
query nodedata collocgroup=grp1
Output

Node Name Volume Name Storage Pool Physical
Name Space
Occupied
(MB)
--------- ------------------------------ ------------ --------
EDU_J3 E:\tsm\server\00000116.BFS EDU512 0.01
EDU_J3 E:\tsm\server\00000120.BFS EDU319 0.01
EDU_JJ1 E:\tsm\server\00000116.BFS EDU512 0.01
EDU_JJ1 E:\tsm\server\00000121.BFS EDU512 0.01

where:
Node Name
Specifies the name of the node.
Volume Name
Specifies the name of the volume that contains the node data.
Storage Pool Name
Specifies the name of the storage pool in which the volume is located.
Physical Space Occupied (MB)
Specifies the amount of physical space occupied by the nodes data. Physical
space includes empty space within aggregates, from which files may have been
deleted or expired.
QUERY NODEDATA

776 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 235. Commands related to QUERY NODEDATA
Command Description
DEFINE COLLOCGROUP Defines a collocation group.
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE COLLOCGROUP Deletes a collocation group.
DELETE COLLOCMEMBER Deletes a client node from a collocation
group.
MOVE NODEDATA Moves data for one or more nodes, or a
single node with selected filespaces.
QUERY COLLOCGROUP Displays information about collocation
groups.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY STGPOOL Displays information about storage pools.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
UPDATE COLLOCGROUP Updates the description of a collocation
group.
UPDATE STGPOOL Changes the attributes of a storage pool.

QUERY NODEDATA
Chapter 2. Administrative commands 777
QUERY NODEGROUP (Query a node group)
Use this command to display the node groups defined on the server.
Privilege class
Any administrator can issue this command.
Syntax

Query NODEGroup
*
group_name
Format = Standard
Format

=

Standard

Detailed

Parameters
group_name
Specifies the name of the node group to display. To specify multiple names,
use a wildcard character. This parameter is optional. The default is to display
all node groups.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed. To display the members
of the node group, you must specify FORMAT=DETAILED.
Examples
Task 1
Display the node groups defined on the server.
Command
query nodegroup
Output

Node Group Name Node Group Description
-------------------------- ------------------------------
DEPT_ED Education department
GROUP1 Low cap client nodes.

Task 2
Display complete information about all node groups and determine which client
nodes belong to which node groups.
Command
query nodegroup format=detailed
QUERY NODEGROUP

778 IBM Tivoli Storage Manager for Windows: Administrators Reference
Output

Node Group Name: DEPT_ED
Node Group Description: Education department
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 04/21/2006 10:59:03
Node Group Member(s): EDU_1 EDU_7

Node Group Name: GROUP1
Node Group Description: Low cap client nodes.
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 04/21/2006 10:59:16
Node Group Member(s): CHESTER REX NOAH JARED

where:
Node Group Name
The name of the node group.
Node Group Description
The description for the node group.
Last Update by (administrator)
The name of the administrator that defined or most recently updated the node
group.
Last Update Date/Time
The date and time that an administrator defined or most recently updated the
node group.
Node Group Member(s)
The members of the node group.
Related commands
Table 236. Commands related to QUERY NODEGROUP
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
QUERY BACKUPSET Displays backup sets.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.
UPDATE NODEGROUP Updates the description of a node group.

QUERY NODEGROUP
Chapter 2. Administrative commands 779
QUERY OCCUPANCY (Query client file spaces in storage
pools)
Use this command to show where client file spaces are stored and how much
space they occupy.
Privilege class
Any administrator can issue this command.
Syntax

Query OCCupancy
* *
*

node_name

file_space_name

STGpool

=

pool_name

DEVclass

=

device_class_name

Type = ANY
Type

=

ANY

Backup

Archive

SPacem
NAMEType = SERVER
NAMEType

=

SERVER

UNIcode

FSID

CODEType = BOTH
CODEType

=

UNIcode

NONUNIcode

BOTH

Parameters
node_name
Specifies the node that owns the file spaces that you want to locate. This
parameter is optional. You can use wildcard characters to specify names. If you
do not specify a value for this parameter, all nodes are queried.
file_space_name
Specifies the file space that you want to locate. This parameter is optional. You
can use wildcard characters to specify names. If you do not specify a value for
this parameter, all file spaces are queried. You must specify a node name if you
specify a file space name.
For a server that has clients with Unicode support, you may need to have the
server convert the file space name that you enter. For example, you may need
to have the server convert the name you enter from the servers code page to
Unicode. See the NAMETYPE parameter for details. If you do not specify a file
space name or specify only a single wildcard character for the name, you can
use the CODETYPE parameter to limit the operation to Unicode file spaces or
non-Unicode file spaces.
STGpool
Specifies the storage pool to query for files from the specified file space. This
QUERY OCCUPANCY

780 IBM Tivoli Storage Manager for Windows: Administrators Reference
parameter is optional. You can use wildcard characters to specify names. If you
do not specify a value for this parameter, all storage pools are queried.
DEVclass
Specifies the device class associated with the devices where the file spaces are
stored. This parameter is optional. You can use wildcard characters to specify
names. If you do not specify a value for this parameter, storage pools
associated with any device class are queried.
Type
Specifies the types of files to query in the file spaces. This parameter is
optional. The default value is ANY. Possible values are:
ANY
Specifies that all types of files are queried: backup versions of files,
archived copies of files, and files migrated from HSM clients.
Backup
Specifies that backup files are queried.
Archive
Specifies that archive files are queried.
SPacem
Specifies that space-managed files (files migrated from HSM clients) are
queried.
NAMEType
Specifies how you want the server to interpret the file space names that you
enter. This parameter is useful when the server has clients with Unicode
support. A backup-archive client with Unicode support is currently available
only for Windows, Macintosh OS 9, Macintosh OS X, and NetWare. Use this
parameter only when you specify a partly or fully qualified file space name.
The default value is SERVER. Possible values are:
SERVER
The server uses the servers code page to interpret the file space names.
UNIcode
The server converts the file space names from the server code page to the
UTF-8 code page. The success of the conversion depends on the actual
characters in the names and the servers code page. Conversion can fail if
the string includes characters that are not available in the server code page,
or if the server has a problem accessing system conversion routines.
FSID
The server interprets the file space names as their file space IDs (FSIDs).
CODEType
Specifies how you want the server to interpret the file space names that you
enter. Use this parameter only when you enter a single wildcard character for
the file space name or when you do not specify any file space name.
The default value is BOTH, which means that the file spaces are included
regardless of code page type. Possible values are:
UNIcode
Include only file spaces that are Unicode enabled.
NONUNIcode
Include only file spaces that are not Unicode enabled.
QUERY OCCUPANCY
Chapter 2. Administrative commands 781
|
|
BOTH
Include file spaces regardless of code page type.
Examples
Task 1
Display information on where all file spaces assigned to the node named DAISY
are stored.
Command
query occupancy daisy
Output

Node Type Filespace FSID Storage Number Physical Logical
Name Name Pool of Space Space
Name Files Occupied Occupied
(MB) (MB)
------- ---- ---------- ----- -------- -------- ------- --------
DAISY Bkup DRIVED 1 COPYFILE 38 0.45 0.42

See Task 2 for parameter definitions.
Task 2
Display information on the file spaces that belong to the node WAYNE, and that
have a backup file type.
Command
query occupancy wayne type=backup
Output

Node Type Filespace FSID Storage Number Physical Logical
Name Name Pool of Space Space
Name Files Occupied Occupied
(MB) (MB)
------ ----- --------- ----- ----------- ------- --------- --------
WAYNE Bkup DWG1 1 BACKUPPOOL1 2,330 53.19 50.01
WAYNE Bkup OS2C 2 BACKUPPOOL1 1,554 32.00 31.30

where:
Node Name
The node that owns the file space.
Type
The type of data. Possible values are:
Arch
Data that has been archived
Bkup
Data that has been backed up
Spmg
Data that has been migrated from an HSM client (space-managed files)
Filespace Name
The name of the file space that belongs to the node. Where the name of the file
QUERY OCCUPANCY

782 IBM Tivoli Storage Manager for Windows: Administrators Reference
space is (archive), that data was archived before collocation by file space was
added to the IBM Tivoli Storage Manager product.
File space names and file names that can be in a different code page or locale
than the server do not display correctly on the Administration Center or the
administrative command-line interface. The data itself is backed up and can be
restored properly, but the file space or file name may display with a
combination of invalid characters or blank spaces.
If the file space name is Unicode enabled, the name is converted to the servers
code page for display. The results of the conversion for characters not
supported by the current code page depends on the operating system. For
names that Tivoli Storage Manager is able to partially convert, you may see
question marks (??), blanks, unprintable characters, or .... These characters
indicate to the administrator that files do exist. If the conversion is not
successful, the name is displayed as .... Conversion can fail if the string
includes characters that are not available in the server code page, or if the
server has a problem accessing system conversion routines.
Storage Pool Name
The storage pool where the file space currently resides.
Number of Files
The number of logical files that belong to the file space and are stored in this
storage pool.
Physical Space Occupied (MB)
The amount of physical space occupied by the file space. Physical space
includes empty space within aggregates, from which files may have been
deleted or expired.
Logical Space Occupied (MB)
The amount of space occupied by logical files in the file space. Logical space is
the space actually used to store files, excluding empty space within aggregates.
FSID
The file space ID (FSID) for the file space. The server assigns a unique FSID
when a file space is first stored on the server.
Related commands
Table 237. Commands related to QUERY OCCUPANCY
Command Description
DELETE FILESPACE Deletes data associated with clients file
spaces.
QUERY FILESPACE Displays information about data in filespaces
that belong to a client.
QUERY NODE Displays partial or complete information
about one or more clients.

QUERY OCCUPANCY
Chapter 2. Administrative commands 783
QUERY OPTION (Query server options)
Use this command to display information about server options.
Change server options by editing the server options file or by issuing the SETOPT
command. If you edit the server options file, you must restart the server before
any changes take effect. Any changes you make by issuing the SETOPT command
take effect immediately.
Privilege class
Any administrator can issue this command.
Syntax

Query OPTion
*
optionname

Parameters
optionname
Specifies the name of an option in the server options file. This parameter is
optional. You can use wildcard characters to specify this name. All matching
server options display. If you do not specify this parameter, information on all
options displays.
Examples
Task
Display general information about all server options.
Command
query option
Output
The output for QUERY OPTION lists all options with their specified
values.
Task
View the option settings for all options that begin with L.
Command
query option l*
Output

Server Option Option Setting
----------------- --------------------
LogPoolSize 256
Language AMENG

QUERY OPTION

784 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 238. Commands related to QUERY OPTION
Command Description
SETOPT Updates a server option without stopping
and restarting the server.

QUERY OPTION
Chapter 2. Administrative commands 785
QUERY PATH (Display a path definition)
Use this command to display the path between a source and a destination.
Privilege class
Any administrator can issue this command.
Syntax

Query PATH
*
*

source_name

destination_name

SRCType = ANY
SRCType

=

ANY

DATAMover

SERVer

DESTType = ANY
DESTType

=

ANY

DRIVE

LIBRary

=

library_name

LIBRary

Format = Standard
Format

=

Standard

Detailed

Parameters
source_name
Specifies the name of a source for which to display paths. This parameter is
optional. You can specify wildcard characters. The default is to display paths
for all sources. A source is a data mover, a server, or a storage agent.
destination_name
Specifies the name of a destination for which to display paths. This parameter
is optional. You can specify wildcard characters. The default is to display paths
for all destinations.
SRCType
Specifies the type of the source. This parameter is optional. The default is to
display paths for all source types. Possible values are:
ANY
Specifies to display paths with any source type.
DATAMover
Specifies to only display paths with the DATAMOVER source type.
SERVer
Specifies to only display paths with the SERVER source type. (A source
that has a source type of SERVER is a storage agent.)
QUERY PATH

786 IBM Tivoli Storage Manager for Windows: Administrators Reference
DESTType
Specifies the type of the destination. This parameter is optional. The default is
to display paths for all destination types. Possible values are:
ANY
Specifies to display paths with any destination type.
DRive
Specifies to display only paths with the DRIVE destination type. When the
destination type is a drive, you must specify the library name. You can
refine which paths are displayed by entering a name in the LIBRARY
parameter.
LIBRary
Specifies that only paths with destination type LIBRARY display.
LIBRary
Specifies the name of the library to which the drive belongs. This parameter is
required when the destination type is a drive (DESTTYPE=DRIVE).
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task
Display information about paths for the source NETAPP1.
Command
query path netapp1
Output

Source Name Source Type Destination Name Destination Type Online
----------- ----------- ---------------- ---------------- ------
NETAPP1 DATAMOVER DRIVE1 DRIVE Yes
NETAPP1 DATAMOVER NASLIB LIBRARY Yes

Descriptions of the query fields are provided after the last task example.
Task
Display detailed information about paths for the source NETAPP1.
Command
query path netapp1 format=detailed
Output

QUERY PATH
Chapter 2. Administrative commands 787
Source Name: NETAPP1
Source Type: DATAMOVER
Destination Name: NASLIB
Destination Type: LIBRARY
Library:
Device: mc0
Directory:
On-Line: Yes
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 06/21/2001 20:52:56

Source Name: NETAPP1
Source Type: DATAMOVER
Destination Name: DRIVE1
Destination Type: DRIVE
Library: NASLIB
Device: rst0l
Directory:
On-Line: Yes
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 06/21/2001 20:55:23

Source Name
The name of the source.
Destination Name
The name of the destination.
Source Type
The type of the source.
Destination Type
The type of the destination.
Library
The name of the library that contains the drive that is the destination. This
field will be blank if the destination type is library. The library name is in
destination name field when the destination is a library.
Node Name
The name of the device that is the destination. Not applicable to MVS.
Device
The name of the device that is the destination. Not applicable to MVS.
Directory
Specifies the directory location of a file on the source.
LUN
Specifies the logical unit name through which the disk can be accessed by the
source.
Online
Whether the path is online and available for use.
Last Update by (administrator)
The ID of the administrator who performed the last update.
Last Update Date/Time
The date and time when the last update occurred.
QUERY PATH

788 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 239. Commands related to QUERY PATH
Command Description
DEFINE PATH Defines a path from a source to a destination.
DELETE PATH Deletes a path from a source to a destination.
UPDATE PATH Changes the attributes associated with a
path.

QUERY PATH
Chapter 2. Administrative commands 789
QUERY POLICYSET (Query a policy set)
Use this command to display information about one or more policy sets.
Privilege class
Any administrator can issue this command.
Syntax

Query POlicyset
* *
*

domain_name

policy_set_name

Format = Standard
Format

=

Standard

Detailed

Parameters
domain_name
Specifies the policy domain associated with the policy set to query. This
parameter is optional. You can use wildcard characters to specify names. If you
do not specify a value for this parameter, all policy domains are queried. You
must specify this parameter when querying an explicitly named policy set.
policy_set_name
Specifies the policy set to query. This parameter is optional. You can use
wildcard characters to specify names. If you do not specify either ACTIVE or a
policy set name, all policy sets are queried.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task 1
Query all policy sets for all policy domains. Create the output in standard format.
Command
query policyset
Output

QUERY POLICYSET

790 IBM Tivoli Storage Manager for Windows: Administrators Reference
Policy Policy Default Description
Domain Set Name Mgmt
Name Class
Name
--------- --------- --------- ------------------------
EMPLOYEE- ACTIVE ACTIVEFI- Personnel Department
_RECORDS LES
EMPLOYEE- HOLIDAY ACTIVEFI- Personnel Department
_RECORDS LES
EMPLOYEE- VACATION ACTIVEFI- Personnel Department
_RECORDS LES
PROG1 SUMMER Programming Group
Policies
PROG2 SUMMER Programming Group
Policies
STANDARD ACTIVE STANDARD Installed default policy
set.
STANDARD STANDARD STANDARD Installed default policy
set.

See Task 2 for parameter definitions.
Task 2
Query the VACATION policy set that is in the EMPLOYEE_RECORDS policy
domain. Create the output in detailed format.
Command
query policyset employee_records vacation
format=detailed
Output
Policy Domain Name: EMPLOYEE_RECORDS
Policy Set Name: VACATION
Default Mgmt Class Name: ACTIVEFILES
Description: Personnel Department
Last Update by (administrator): $$CONFIG_MANAGER$$
Last Update Date/Time: 05/31/1998 13:15:50
Managing profile: ADSM_INFO

where:
Policy Domain Name
The name of the policy domain.
Policy Set Name
The name of the policy set.
Default Mgmt Class Name
The management class assigned as the default for the policy set.
Description
The description of the policy set.
Last Update by (administrator)
The name of the administrator or server that most recently updated the policy
set. If this field contains $$CONFIG_MANAGER$$, the policy set is associated
with a domain that is managed by the configuration manager.
Last Update Date/Time
The date and time when the policy set was most recently defined or updated.
QUERY POLICYSET
Chapter 2. Administrative commands 791
Managing Profile
The profile or profiles that manage the domain to which this policy set
belongs.
Related commands
Table 240. Commands related to QUERY POLICYSET
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
COPY POLICYSET Creates a copy of a policy set.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
DELETE POLICYSET Deletes a policy set, including its
management classes and copy groups, from a
policy domain.
QUERY DOMAIN Displays information about policy domains.
UPDATE POLICYSET Changes the description of a policy set.
VALIDATE POLICYSET Verifies and reports on conditions the
administrator must consider before activating
the policy set.

QUERY POLICYSET

792 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY PROCESS (Query one or more server processes)
Use this command to display active background process information.
Use the CANCEL PROCESS command to cancel background processes.
Privilege class
Any administrator can issue this command.
Syntax
Query PRocess
process_number


Parameters
process_number
Specifies the number of the background process to be queried. This parameter
is optional. If not specified, information on all background processes is
displayed.
Examples
Task
Display information about background process 202.
Command
query process 202
Output

Process Process Description Status
Number
-------- ------------------------ --------------------------
202 EXPORT SERVER ANR0NNNI EXPORT
Identifier MYEXPORTSERVER
ANR0648I Have copied the
following: 8 Domains 2
Policy Sets 10 Management
Classes 4 Copy Groups 1
Administrators 746 Bytes
(0 errors have been
detected)

Current input volume(s): C:\BUILD\540\GA\
BUILD\NT\I386\DEBUG\-00000014.BFS,
(6 Seconds)

where:
Process Number
Specifies the number assigned to the background process.
Process Description
Specifies a description of the background process.
Status
Specifies the completion status of the background process.
QUERY PROCESS
Chapter 2. Administrative commands 793
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Related commands
Table 241. Command related to QUERY PROCESS
Command Description
CANCEL EXPORT Deletes a suspended export operation
CANCEL PROCESS Cancels a background server process.
QUERY EXPORT Displays the export operations that are
currently running or suspended.
RESTART EXPORT Restarts a suspended export operation.
SUSPEND EXPORT Suspends a running export operation.

QUERY PROCESS

794 IBM Tivoli Storage Manager for Windows: Administrators Reference
||
||
|
||
||
QUERY PROFILE (Query a profile)
Use this command to display information about profiles and associated objects.
Issue this command from a configuration manager or from a managed server. You
can use this command to get profile information from any configuration manager
defined to the server, even if the server does not subscribe to any profile.
If you query a locked profile from the configuration manager to which the profile
belongs, complete profile information is displayed. If you query a locked profile
from another server, the query displays only that the profile is locked.
Privilege class
Any administrator can issue this command.
Syntax

Query PROFIle
*
profile_name

(1)

SERVer

=

server_name

Format = Standard
Format

=

Standard

Detailed
USELocal = Yes
USELocal

=

Yes

No

Notes:
1 The server name you specify depends on the server from which you issue the
command. See the description of the SERVER parameter.
Parameters
profile_name
Specifies the profile to display. To specify multiple names, use a wildcard
character. This parameter is optional. The default is to display all profiles.
SERVer
Specifies the configuration manager whose profile information is displayed.
The requirements for the name depends on where the query is issued:
v From a configuration manager: This parameter is optional. The default is the
configuration managers name.
v From a managed server: This parameter is optional. The default is the name
of the configuration manager for this managed server.
v From a server that is neither a configuration manager nor a managed server:
You must specify a name.
Format
Specifies whether partial or detailed information is displayed. The default is
STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that detailed information is displayed.
QUERY PROFILE
Chapter 2. Administrative commands 795
USELocal
When you perform the query from a managed server, this parameter specifies
whether the profile information is obtained from the configuration manager or
the managed server. If the profile information does not exist on the managed
server, the information is obtained from the configuration manager, regardless
of the value of this parameter.
If you use this parameter on a server that is not managed by the configuration
manager that owns the profile, the parameter is ignored. The default value is
YES. Possible values are:
Yes
Specifies that the profile information, if available, is obtained from the
managed server. The configuration manager is contacted if information is
not available from the managed server.
No
Specifies that the profile information is obtained from the configuration
manager even if the information is available from the managed server. This
ensures that you receive current information about the profile.
Examples
Task 1
Display profile information from a configuration manager.
Command
query profile
Output
Configuration Profile name Locked?
manager
--------------- --------------- ------
SERVER1 DEFAULT_PROFILE No
SERVER1 ADMIN_INFO No
SERVER1 EMPLOYEE No
SERVER1 PERSONNEL Yes

Task 2
From a managed server, display current detailed information for profile
ADMIN_INFO.
Note: When the profile is locked, most fields are not displayed.
Command
query profile admin_info
format=detailed uselocal=no
Output
QUERY PROFILE

796 IBM Tivoli Storage Manager for Windows: Administrators Reference
Configuration manager: SERVER1
Profile name: ADMIN_INFO
Locked: No
Description: Distributed administrative schedules
Server administrators: DENNIS EMILY ANDREA
Policy domains: ADMIN RECORDS
Administrative command schedules: ** all objects **
Server Command Scripts:
Client Option Sets:
Servers:
Server Groups:

where:
Configuration manager
The name of the configuration manager that owns the profile.
Profile name
The name of the profile.
Locked?
Whether the profile is locked.
Description
The description of the profile.
Server administrators
The administrators that are associated with the profile.
Policy domains
The policy domains that are associated with the profile.
Administrative command schedules
The administrative schedules that are associated with the profile.
Server Command Scripts
The server command scripts that are associated with the profile.
Client Option Sets
The client option sets that are associated with the profile.
Servers
The servers that are associated with the profile.
Server Groups
The names of server groups that are associated with the profile.
Related commands
Table 242. Commands related to QUERY PROFILE
Command Description
COPY PROFILE Creates a copy of a profile.
DEFINE PROFASSOCIATION Associates objects with a profile.
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
DEFINE SUBSCRIPTION Subscribes a managed server to a profile.
DELETE PROFASSOCIATION Deletes the association of an object with a
profile.
DELETE PROFILE Deletes a profile from a configuration
manager.
QUERY PROFILE
Chapter 2. Administrative commands 797
Table 242. Commands related to QUERY PROFILE (continued)
Command Description
LOCK PROFILE Prevents distribution of a configuration
profile.
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UNLOCK PROFILE Enables a locked profile to be distributed to
managed servers.
UPDATE PROFILE Changes the description of a profile.

QUERY PROFILE

798 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY PROXYNODE (Query proxy authority for a client node)
Use this command to display client nodes with authority to act as proxy to other
client nodes in the Tivoli Storage Manager server.
Privilege class
Any administrator can issue this command.
Syntax

*
Query PROXynode

TArget

=

target_node_name

Parameters
TArget
Specifies the name of the node targeted by the node with proxy authority. It is
optional to specify a target node name. Wildcard names can be used to specify
the target node name. A comma-separated list of node names is also allowed.
Examples
Task
To display all Tivoli Storage Manager client nodes with proxy authority to the
target node named MYCLUSTER, use the following command.
Command
query proxynode target=mycluster
Output

Target Node Agent Node
--------------- ----------------
FRED MOE MINIE MICKEY
ALPHA BETA GAMMA DELTA

Related commands
Table 243. Commands related to QUERY PROXYNODE
Command Description
GRANT PROXYNODE Grant proxy authority to an agent node.
REVOKE PROXYNODE Revoke proxy authority from an agent node.

QUERY PROXYNODE
Chapter 2. Administrative commands 799
QUERY RECOVERYMEDIA (Query recovery media)
Use this command to display information about the media (for example, boot
media) needed to recover a machine. Media are displayed in alphabetical order by
name.
Note: Tivoli Storage Manager does not use the information in any way. It is
available only to help you plan for the disaster recovery of client machines.
Privilege class
Any administrator can issue this command.
Syntax

Query RECOVERYMedia
*
media_name

Type

=

BOot

OTher

LOcation

=

location
Format = Standard
Format

=

Standard

Detailed

Parameters
media_name
Specifies the name of the recovery media. You can use wildcard characters to
specify the name. This parameter is optional. The default is all recovery media.
Type
Specifies the type of media to be queried. This parameter is optional. If this
parameter is not specified, all recovery media are queried. Possible values are:
BOot
Only boot media are queried.
OTher
All media other than boot media are queried.
LOcation
Specifies the location of the recovery media to be queried. This parameter is
optional. You can specify up to 255 characters. Enclose the description in
quotation marks if it contains any blank characters.
Format
Specifies how the information is displayed. This parameter is optional. Possible
values are:
Standard
Tivoli Storage Manager displays partial information. This is the default.
Detailed
Tivoli Storage Manager displays all information.
QUERY RECOVERYMEDIA

800 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task 1
Display information for the recovery media named RECMED1.
Command
query recoverymedia RECMED1
Output
Recovery Media Name Volume Names Location Machine Name
-------------------- ---------------- ---------------- ------------
RECMED1 vol1 vol2 vol3 IRONMOUNTAIN MACH1
vol4

Task 2
Display detailed information for the recovery media named RECMED1.
Command
query recoverymedia RECMED1 format=detailed
Output
Recovery Media Name: RECMED1
Type: Boot
Volume Names: vol1 vol2 vol3 vol4
Location: IRONMOUNTAIN
Description:
Product:
Product Information:
Machine Name: MACH1

where:
Recovery Media Name
The name of the recovery media.
Type
Whether the recovery media are boot media or another type of media. Possible
values are:
Boot
The recovery media are boot media.
Other
The recovery media are not boot media.
Volume Names
The set of volumes that contain the data needed to recover machines
associated with this media.
Location
Where the recovery media is stored.
Description
A description of the recovery media.
Product
The product used to create the boot media.
QUERY RECOVERYMEDIA
Chapter 2. Administrative commands 801
Product Information
Information about the product that created the boot media. This information
may be needed for restoring the machine.
Machine Name
The machines that are associated with this recovery media.
Related commands
Table 244. Commands related to QUERY RECOVERYMEDIA
Command Description
DEFINE RECMEDMACHASSOCIATION Associates recovery media with a machine.
DEFINE RECOVERYMEDIA Defines the media required to recover a
machine.
DELETE RECOVERYMEDIA Deletes recovery media.
UPDATE RECOVERYMEDIA Changes the attributes of recovery media.

QUERY RECOVERYMEDIA

802 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY REQUEST (Query one or more pending mount
requests)
Use this command to display information about one or more pending mount
requests. The server makes requests for the administrator to perform an action, like
inserting a tape volume in a library after a CHECKIN LIBVOL has been issued.
Privilege class
Any administrator can issue this command.
Syntax
Query REQuest
request_number


Parameters
request_number
Specifies the identification number of the pending mount request. This
parameter is optional. The default is all pending mount requests.
Examples
Task
Display information on all pending mount requests after a CHECKIN LIBVOL has
been issued.
Command
query request
Output for a Manual Library
ANR8352I Requests outstanding:
ANR8326I 001: Mount GENERICTAPE volume EXP001 R/W
in drive 8MM.1 (mt3.0.0.0) of library
MANUALLIB within 60 minute(s).

Output for an Automated Library
ANR8352I Requests outstanding:
ANR8306I 001: Insert 3570 volume 133540 R/W into the slot with element
number 31 of library 3570LIB within 60 minutes; issue REPLY
along with the request ID when ready.

Related commands
Table 245. Related commands for QUERY REQUEST
Command Description
CANCEL REQUEST Cancels pending volume mount requests.
REPLY Allows a request to continue processing.

QUERY REQUEST
Chapter 2. Administrative commands 803
QUERY RESTORE (Query restartable restore sessions)
Use this command to display information about the restartable restore sessions.
Privilege class
Any administrator can issue this command.
Syntax
Query RESTore
node_name

file_space_name

Format = Standard
Format

=

Standard

Detailed
NAMEType = SERVER
NAMEType

=

SERVER

UNIcode

FSID

Parameters
node_name
Specifies the client node to be queried. This parameter is optional. If you do
not specify a value, all client nodes with restartable restore sessions are
displayed. You must specify a value for this parameter if you specify a file
space name.
file_space_name
Specifies the file space to be queried. This parameter is optional. If you do not
specify a value, all file spaces are matched for the specified node.
For a server that has clients with support for Unicode, you may need to have
the server convert the file space name that you enter. For example, you may
need to have the server convert the name you enter from the servers code
page to Unicode. See the NAMETYPE parameter for details.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
NAMEType
Specify how you want the server to interpret the file space names that you
enter. This parameter is useful when the server has clients with support for
Unicode. You can use this parameter for Unicode-enabled Tivoli Storage
Manager clients using Windows, Macintosh OS 9, Macintosh OS X, and
NetWare operating systems.
Use this parameter only when you enter a partly or fully qualified file space
name. The default value is SERVER. Possible values are:
SERVER
The server uses the servers code page to interpret the file space names.
QUERY RESTORE

804 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
UNIcode
The server converts the file space name entered from the server code page
to the UTF-8 code page. The success of the conversion depends on the
actual characters in the name and the servers code page. Conversion can
fail if the string includes characters that are not available in the server code
page, or if the server has a problem accessing system conversion routines.
FSID
The server interprets the file space names as their file space IDs (FSIDs).
Examples
Task
Display detailed information about client node JAMES associated with file space
DRIVE_F_R.
Command
query restore james drive_f_r format=detailed
Sess Number: -1
Restore State: Restartable
Elapsed Minutes: 2
Node Name: JAMES
FSID: 1
Filespace Name: DRIVE_F_R:
File Spec: /RESTORE/TESTDIRF\\
where:
Sess Number
Specifies the session number for the restartable restore session. The number for
active restore sessions is the same number displayed on the QUERY SESSION
command. For restore sessions in the restartable state, a negative number is
displayed for the session number. Any session number displayed in the
QUERY RESTORE output may be specified from the QUERY RESTORE output.
Restore State
v Active: Specifies the restore session is actively restoring files to the client.
v Restartable: Specifies the restore session failed and can be restarted from
where it left off.
Elapsed Minutes
Specifies the number of minutes since the restore session started. Any
restartable restore session with an elapsed time greater than the
RESTOREINTERVAL server option can be automatically deleted from the
database when needed or during expiration processing. If the elapsed time is
less than the RESTOREINTERVAL, you can delete this entry (and unlock the
filespace) only by issuing the CANCEL RESTORE command lowering the
RESTOREINTERVAL value.
Node Name
Specifies the node associated with the restartable restore session.
FSID
Specifies the file space ID of the file space.
Filespace Name
Specifies the file space associated with the restartable restore session.
QUERY RESTORE
Chapter 2. Administrative commands 805
File space names and file names that can be in a different code page or locale
than the server do not display correctly on the Administration Center or the
administrative command-line interface. The data itself is backed up and can be
restored properly, but the file space or file name may display with a
combination of invalid characters or blank spaces.
If the file space name is Unicode enabled, the name is converted to the servers
code page for display. The results of the conversion for characters not
supported by the current code page depends on the operating system. For
names that Tivoli Storage Manager is able to partially convert, you may see
question marks (??), blanks, unprintable characters, or .... These characters
indicate to the administrator that files do exist. If the conversion is not
successful, the name is displayed as .... Conversion can fail if the string
includes characters that are not available in the server code page, or if the
server has a problem accessing system conversion routines.
File Spec
Specifies the file specification used on the restore operation. The same file
specification must be specified if a failed restore operation is to be restarted
from where it stopped.
Related commands
Table 246. Commands related to QUERY RESTORE
Command Description
CANCEL RESTORE Cancels a restartable restore session.

QUERY RESTORE

806 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY RPFCONTENT (Query recovery plan file contents
stored on a target server)
Use this command to display the contents of a recovery plan file stored on a target
server (that is, when the DEVCLASS parameter was specified on the PREPARE
command). You can issue this command from either the server that created the file
(the source server) or the server that stores the recovery plan file (the target
server). You cannot issue this command from the server console.
The output may be delayed if the file is on tape.
Privilege class
To issue this command, you must have system privilege.
Syntax
Query RPFContent plan_file_name DEVclass = device_class_name
NODEName

=

node_name


Parameters
plan_file_name (Required)
Specifies the name of the recovery plan file to be queried. The format of the
file name is servername.yyyymmdd.hhmmss. To see the names of existing files,
issue the QUERY RPFILE command.
DEVclass
Specifies the name of the device class used to create the recovery plan file.
Wildcard characters are not allowed.
Specify this parameter when:
v You want to display the contents of the recovery plan file that was created
for this server.
v You are issuing this command to the same server on which the PREPARE
command was issued (the source server).
v The specified device class name was used on the PREPARE command that
created the recovery plan file.
NODEName
Specifies the node name, registered on the target server, of the source server
that created the recovery plan file. Wildcard characters are not allowed.
Specify this parameter when:
v You want to display the contents of the recovery plan file that was stored on
this server.
v You are issuing this command to the server that was the target of the
PREPARE command that created the recovery plan file.
v The specified node name is registered to this server with a node type of
SERVER.
v The Tivoli Storage Manager server that created the recovery plan file is not
available.
Examples
Task 1
QUERY RPFCONTENT
Chapter 2. Administrative commands 807
On the source server: Display the contents of a recovery plan file that was created
for this server on March 19, 1998, at 6:10AM. The PREPARE command specified
the device class REMOTE.
Command
query rpfcontent branch1.19980319.061000 devclass=remote
Task 2
On the target server: Display the contents of a recovery plan file that was stored in
this server on March 19, 1998, at 6:10AM. The server that created the file is
registered on the target server as a node named POLARIS with a node type of
SERVER.
Command
query rpfcontent branch1.19980319.061000 nodename=polaris
Output
The output of these commands is the entire contents of the recovery plan
file. See the Administrators Guide for an example of a disaster recovery plan
file.
Related commands
Table 247. Commands related to QUERY RPFCONTENT
Command Description
PREPARE Creates a recovery plan file.
QUERY RPFILE Displays information about recovery plan
files.
QUERY VOLHISTORY Displays sequential volume history
information that has been collected by the
server.

QUERY RPFCONTENT

808 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY RPFILE (Query recovery plan file information stored
on a target server)
Use this command to display information about recovery plan files stored on a
target server. You can issue this command from either the server that created the
file (the source server) or the server that stores the recovery plan file (the target
server).
Privilege class
Any administrator can issue this command.
Syntax
Query RPFile DEVclass = device_class_name
NODEName

=

node_name

Source = DBBackup
Source

=

DBBackup

DBSnapshot
Format = Standard
Format

=

Standard

Detailed

Parameters
DEVclass
Specifies the name of the device class that was used to create the recovery plan
files. Use this parameter when logged on to the server that created the
recovery plan file. You can use wildcard characters in the device class name.
All recovery plan files that are created with the device class specified are
included in the query.
NODEName
Specifies the node name, registered on the target server, of the source server
that created the recovery plan files. Use this parameter when logged on to the
target server. You can use this parameter when the source server is not
available. You can use wildcard characters to specify the node name. All file
objects that are stored with the node name specified are included in this query.
Source
Specifies the type of database backup that was specified when the recovery
plan file was prepared. This parameter is optional. The default is DBBACKUP.
Possible values are:
DBBackup
The recovery plan file was prepared with full and incremental database
backups specified.
DBSnapshot
The recovery plan file was prepared with snapshot database backups
specified.
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Tivoli Storage Manager displays partial information for the recovery plan
file.
QUERY RPFILE
Chapter 2. Administrative commands 809
Detailed
Tivoli Storage Manager displays all information for the recovery plan file.
Examples
Task 1
Display a list of recovery plan files that were created for this server using the
specified device class.
Command
query rpfile devclass=* format=detailed
Output

Recovery Plan File Name: ALASKA.20000406.170423
Node Name: BRANCH1
Device Class Name: REMOTE
Recovery Plan File Type: RPFILE
Mgmt Class Name: STANDARD
Recovery Plan File Size: 16,255 Bytes
Marked for Deletion: Yes
Deletion Date: 06/12/2000 13:05:31

Recovery Plan File Name: ALASKA.20000407.170845
Node Name: BRANCH1
Device Class Name: REMOTE
Recovery Plan File Type: RPFSNAPSHOT
Mgmt Class Name: STANDARD
Recovery Plan File Size: 16,425 Bytes
Marked for Deletion: No
Deletion Date:

Task 2
Display a list of all recovery plan file objects that are stored with the specified
node name (TYPE=SERVER).
Command
query rpfile nodename=branch1
Output

Recovery Plan File Name Node Name Device Class Name
----------------------- --------- -----------------
ALASKA.19980406.170423 BRANCH1 REMOTE
ALASKA.19980407.170845 BRANCH1 REMOTE

where:
Recovery Plan File Name
The recovery plan file name.
Node Name
The node name that is registered with the target server and used to store the
recovery plan file objects.
Device Class Name
The device class name that is defined in the source server and used to create
the recovery plan files.
QUERY RPFILE

810 IBM Tivoli Storage Manager for Windows: Administrators Reference
Recovery Plan File Type
The type of recovery plan file:
RPFILE
The plan assumes full plus incremental database backups.
RPFSNAPSHOT
The plan assumes snapshot database backups.
Mgmt Class Name
The management class name that the recovery plan file is associated with in
the target server.
Recovery Plan File Size
Estimated size of the recovery plan file object on the target server.
Marked For Deletion
Whether the object that contains the recovery plan file has been deleted from
the source server and marked for deletion on the target server if the grace
period has not expired. Possible values are:
Yes
The object is marked for deletion.
No
The object is not marked for deletion.
Deletion Date
Date that the object has been deleted from the source server and marked for
deletion on the target server. This field is blank if the object has not been
marked for deletion.
Related commands
Table 248. Commands related to QUERY RPFILE
Command Description
PREPARE Creates a recovery plan file.
QUERY VOLHISTORY Displays sequential volume history
information that has been collected by the
server.
QUERY RPFCONTENT Displays the contents of a recovery plan file.

QUERY RPFILE
Chapter 2. Administrative commands 811
QUERY SAN (Query the devices on the SAN)
Use this command to obtain information about devices that can be detected on a
storage area network (SAN), so that you can configure Tivoli Storage Manager for
LAN-free data movement.
The QUERY SAN command requires the hbaapi.dll that supports SNIA common
Host Bus Adapter (HBA) API. With this library object, Tivoli Storage Manager can
call the hbaapi functions specified in the SNIA common HBAAPI standard.
Privilege class
Any administrator can issue this command.
Syntax

Query SAN
Type = Any
Type

=

Any

DISK

DRive

LIBRary

OTHER
Format = Standard
Format

=

Standard

Detailed

Parameters
Type
Specifies the type of device that will be displayed. This parameter is optional.
The default value is Any. Possible values are:
Any
Specifies that any device detected on the SAN is displayed.
DISK
Specifies that only disk devices are displayed.
DRive
Specifies that only drive devices are displayed.
LIBRary
Specifies that only library devices are displayed.
OTHER
Specifies that devices that are not disks, drives, or libraries are displayed.
Format
Specifies the type of information that will be displayed. This parameter is
optional. The default value is Standard. Possible values are:
Standard
Specifies that the information displayed will be summarized.
Detailed
Specifies that complete information will be displayed.
Note: The output may not display the serial number of the device. If this
happens, look on the back of the device or contact the manufacturer of
the device.
QUERY SAN

812 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task
Display summary information for drive devices on a SAN.
Command
query san type=drive
Output

Device Type Vendor Product Serial Device
------------- ---------- --------- --------- ----------
LIBRARY STK L180 MPC01000128 /dev/smc1
DRIVE STK 9840 331001017229 /dev/rmt3
DRIVE Quantum DLT4000 JF62806275 /dev/rmt4
DRIVE Quantum DLT4000 JP73213185 /dev/rmt5
DRIVE STK 9840 331000028779 /dev/rmt6

Task
Display detailed information for all drive devices on a SAN.
Command
query san type=drive format=detailed
Output

Device Type: DRIVE
Vendor: IBM
Product: 03570B02
Serial:
Device: mt10.2.0.3
DataMover: No
Node WWN: 5005076206039E05
Port WWN: 5005076206439E05
Lun: 0
SCSI Port: 3
SCSI Bus: 0
SCSI Target: 10

where:
Device Type
The type of device that is being displayed.
Vendor
The name of the devices vendor.
Product
The name of the product assigned by the vendor.
Serial
The serial number of the device.
Device
The device special file name.
Data Mover
Whether the device is a data mover.
Node WWN
The world wide name for the device.
QUERY SAN
Chapter 2. Administrative commands 813
Port WWN
The world wide name for the device, which is specific to the port that the
device is connected to.
Lun
The Logical Unit Number of the device.
SCSI Port
The port of the Fibre Channel (or SCSI) Host Bus Adapter.
SCSI Bus
The bus of the Host Bus Adapter card.
SCSI Target
The target number of the device.
Related commands
Table 249. Commands related to QUERY SAN
Command Description
DEFINE DATAMOVER Defines a data mover to the IBM Tivoli
Storage Manager server.
DEFINE DRIVE Assigns a drive to a library.
DEFINE LIBRARY Defines an automated or manual library.

QUERY SAN

814 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY SCHEDULE (Query schedules)
Use this command to display information about one or more schedules.
The QUERY SCHEDULE command takes two forms, depending on whether the
schedule applies to client operations or administrative commands. The syntax and
parameters for each operation are defined separately. Some options in the query
display will be blank depending on whether the schedule style is classic or
enhanced.
Table 250. Commands related to QUERY SCHEDULE
Command Description
COPY SCHEDULE Creates a copy of a schedule.
DEFINE SCHEDULE Defines a schedule for a client operation or
an administrative command.
UPDATE SCHEDULE Changes the attributes of a schedule.
QUERY SCHEDULE
Chapter 2. Administrative commands 815
QUERY SCHEDULE client
Use this command to display information about one or more client schedules.
Privilege class
Any administrator can issue this command.
Syntax

Query SCHedule
* *
*

domain_name

schedule_name
Type = Client

,

Nodes

=

node_name
Format = Standard
Format

=

Standard

Detailed

Parameters
domain_name
Specifies the name of the policy domain to which the schedule belongs. You
can use a wildcard character to specify this name. If you specify a domain
name, you do not have to specify a schedule name.
schedule_name
Specifies the name of the schedule that belongs to the specified policy domain.
You can use a wildcard character to specify this name. If you specify a
schedule name, you must also specify a policy domain name.
Type=Client
Specifies that the query displays client schedules. This parameter is optional.
The default is CLIENT.
Nodes
Specifies the name of one or more client nodes that are associated with the
schedules to be displayed. This parameter is optional. You can use a wildcard
character to specify client nodes. If you do not specify a client name, all
schedules matching the DOMAINNAME and SCHEDULENAME parameters
are displayed. You can specify multiple client nodes by separating the names
with commas and no intervening spaces.
Format
Specifies how information is displayed. This parameter is optional. The default
is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the schedules.
Detailed
Specifies that detailed information is displayed for the schedules.
Note: The standard format displays a blank in the period column and an
asterisk in the day column for enhanced schedules. Issue
FORMAT=DETAILED to display complete information about an
enhanced schedule.
QUERY SCHEDULE Client

816 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task
Display all schedules that belong to the EMPLOYEE_RECORDS policy domain.
Command
query schedule employee_records
Output

Domain * Schedule Name Action Start Date/Time Duration Period Day
------- - -------------- ------ -------------------------- ------ ---
EMPLOY WEEKLY_BACKUP Inc Bk 2004.06.04 17.04.20 1 H 1 D Any
EE_RE-
CORDS
EMPLOY- EMPLOYEE_BACKUP Inc Bk 2004.06.04 17.04.20 1 H (*)
EE_RE-
CORDS

where:
Domain
Specifies the name of the policy domain to which the specified schedule
belongs.
* (Asterisk)
Specifies whether the corresponding schedule has expired. If there is an
asterisk in this column, the corresponding schedule has expired.
Schedule Name
Specifies the name of the schedule.
Action
Specifies the action that occurs when this schedule is processed.
Start Date/Time
Specifies the initial starting date and time for this schedule.
Duration
Specifies the length of the startup window for this schedule.
Period
Specifies the time between startup windows (assuming DAYOFWEEK=ANY).
The column is blank for enhanced schedules.
Day
Specifies the day of the week on which the startup windows for the schedule
begin. The column contains an asterisk for enhanced schedules.
Note: The standard format displays a blank in the period column and an asterisk
in the day column for enhanced schedules. Issue FORMAT=DETAILED to
display complete information about an enhanced schedule.
Task 2
From a managed server, display detailed information about client schedules.
Command
query schedule * type=client format=detailed
QUERY SCHEDULE Client
Chapter 2. Administrative commands 817
Output

Policy Domain Name: ADMIN_RECORDS
Schedule Name: ADMIN_BACKUP
Description:
Action: Incremental
Options:
Objects:
Priority: 5
Start Date/Time: 2004.06.04 17.04.20
Duration: 1 Hour(s)
Schedule Style: Classic
Period: 1 Day(s)
Day of Week: Any
Month:
Day of Month:
Week of Month:
Expiration:
Last Update by (administrator): $$CONFIG_MANAGER$$
Last Update Date/Time: 2004.06.04 17.51.49
Managing profile: ADMIN_INFO
Policy Domain Name: EMPLOYEE_RECORDS
Schedule Name: EMPLOYEE_BACKUP
Description:
Action: Incremental
Options:
Objects:
Priority: 5
Start Date/Time: 2004.06.04 17.04.33
Duration: 1 Hour(s)
Schedule Style: Enhanced
Period:
Day of Week: Any
Month: Mar,Jun,Nov
Day of Month: -14,14,22
Week of Month: Last
Expiration:
Last Update by (administrator): $$CONFIG_MANAGER$$
Last Update Date/Time: 2004.06.04 17.18.30
Managing profile: EMPLOYEE

where:
Policy Domain Name
Specifies the name of the policy domain.
Schedule Name
Specifies the name of the schedule.
Description
Specifies the description of the schedule.
Action
Specifies the type of action that occurs when this schedule is run. See the
DEFINE SCHEDULE command for a listing of actions.
Options
Specifies the options that are supplied to the DSMC command when the
schedule is run.
Objects
Specifies the objects for which the specified action is performed.
Priority
Specifies the priority value for the schedule.
Start Date/Time
Specifies the initial starting date and time for the schedule.
QUERY SCHEDULE Client

818 IBM Tivoli Storage Manager for Windows: Administrators Reference
Duration
Specifies the length of the startup window for the schedule.
Schedule Style
Specifies whether classic or enhanced schedule rules are used.
Period
Specifies the time between startup windows (assuming DAYOFWEEK=ANY).
This is not displayed for enhanced syntax schedules.
Day of Week
Specifies the day of the week on which the startup windows for the schedule
begin. Using a standard format displays an asterisk in the day of week field
for enhanced schedules
Month
Specifies the months during which the schedule will run. This is not displayed
for classic syntax schedules.
Day of Month
Specifies the days of the month during which the schedule will run. This is not
displayed for classic syntax schedules.
Week of Month
Specifies the weeks (first, second, third, fourth, or last) of the month during
which the schedule will run. This is not displayed for classic syntax schedules.
Expiration
Specifies the date and time on which this schedule expires. If this column is
blank, the schedule does not expire.
Last Update by (administrator)
Specifies the name of the administrator that most recently updated the
schedule. If this field contains a $$CONFIG_MANAGER$$, the schedule is
associated with a domain that is managed by the configuration manager.
Last Update Date/Time
Specifies the last date and time the schedule was last updated.
Managing Profile
Specifies the profile or profiles to which the managed server subscribed to get
the definition of this schedule.
QUERY SCHEDULE Client
Chapter 2. Administrative commands 819
QUERY SCHEDULE administrative
Use this command to display information about one or more administrative
schedules.
Privilege class
Any administrator can issue this command.
Syntax

Query SCHedule
*
schedule_name

Type

=

Administrative

Format = Standard
Format

=

Standard

Detailed

Parameters
schedule_name
Specifies the name of the schedule to be queried. You can use a wildcard
character to specify this name.
Type=Administrative (Required)
Specifies that the query displays administrative command schedules.
Format
Specifies how information is displayed. This parameter is optional. The default
is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the schedules.
Detailed
Specifies that detailed information is displayed for the schedules.
Note: The standard format displays a blank period column and an asterisk in
the day column for enhanced schedules. Issue FORMAT=DETAILED to
display complete information about an enhanced schedule.
Examples
Task 1
From a managed server, display detailed information about administrative
command schedules.
Command
query schedule * type=administrative
format=detailed
Output

QUERY SCHEDULE Administrative

820 IBM Tivoli Storage Manager for Windows: Administrators Reference
Schedule Name: BACKUP_ARCHIVEPOOL
Description:
Command: backup db
Priority: 5
Start Date/Time: 2004.06.04 16.57.15
Duration: 1 Hour(s)
Schedule Style: Classic
Period: 1 Day(s)
Day of Week: Any
Month:
Day of Month:
Week of Month:
Expiration:
Active: No
Last Update by (administrator): $$CONFIG MANAGER$$
Last Update Date/Time: 2004.06.04 17.51.49
Managing Profile: ADMIN_INFO
Schedule Name: MONTHLY_BACKUP
Description:
Command: q status
Priority: 5
Start Date/Time: 2004.06.04 16.57.14
Duration: 1 Hour(s)
Schedule Style: Enhanced
Period:
Day of Week: Tue,Thu,Fri
Month: Aug,Nov
Day of Month:
Week of Month: Second,Third
Expiration:
Active: No
Last Update by (administrator): $$CONFIG MANAGER
Last Update Date/Time: 2004.06.04 17.51.49
Managing Profile: ADMIN_INFO
where:
Schedule Name
Specifies the name of the schedule.
Description
Specifies the description of the schedule.
Command
Specifies the command that is scheduled.
Priority
Specifies the priority value for this schedule.
Start Date/Time
Specifies the initial starting date and time for this schedule.
Duration
Specifies the length of the startup window.
Schedule Style
Specifies whether classic or enhanced schedule rules are used.
Period
Specifies the time between startup windows (assuming DAYOFWEEK=ANY).
This is not displayed for enhanced syntax schedules.
Day of Week
Specifies the day of the week on which the startup windows begin.
Month
Specifies the months during which the schedule will run. This is not displayed
for classic syntax schedules.
QUERY SCHEDULE Administrative
Chapter 2. Administrative commands 821
Day of Month
Specifies the days of the month during which the schedule will run. This is not
displayed for classic syntax schedules.
Week of Month
Specifies the weeks (first, second, third, fourth, or last) of the month during
which the schedule will run. This is not displayed for classic syntax schedules.
Expiration
Specifies the date after which this schedule will no longer be used. If this
column is blank, the schedule does not expire.
Active
Specifies whether the schedule has been processed according to the time and
date set for this schedule.
Last Update by (administrator)
Specifies the name of the administrator that most recently updated the
schedule. If this field contains a $$CONFIG_MANAGER$$, the schedule is
associated with a domain that is managed by the configuration manager.
Last Update Date/Time
Specifies the last date and time the schedule was modified.
Managing Profile
Specifies the profile or profiles to which the managed server subscribed to get
the definition of this schedule.
QUERY SCHEDULE Administrative

822 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY SCRIPT (Query Tivoli Storage Manager scripts)
Use this command to display information about scripts.
You can use this command in conjunction with the DEFINE SCRIPT command to
create a new script using the contents from another script.
Privilege class
The privilege class required for this command depends on whether the
OUTPUTFILE parameter is specified in the command.
v If the OUTPUTFILE parameter is not specified, any administrator can issue this
command.
v If the OUTPUTFILE parameter is specified and the REQSYSAUTHOUTFILE
server option is set to YES, the administrator must have system privilege.
v If the OUTPUTFILE parameter is specified and the REQSYSAUTHOUTFILE
server option is set to NO, the administrator must have operator, policy, storage,
or system privilege.
Syntax

Query SCRipt
*
script_name

FORMAT = Standard
FORMAT

=

Standard

Lines

Detailed

Raw

Outputfile

=

file_name

Parameters
script_name
Specifies the name of the script for which information is to be displayed. You
can include a wildcard character to specify this name.
Attention: If you do not specify a script, the query displays information
about all scripts. The time used to process this command and the amount of
information displayed can be extensive.
Format
Specifies the output format for displaying script information. The default is
STANDARD. Possible values are:
Standard
Specifies that only the script name and description in a script are
displayed.
Lines
Specifies that the script name, the line number of the commands, comment
lines, and the commands in the script are displayed.
Detailed
Specifies that detailed information about the script is displayed.
QUERY SCRIPT
Chapter 2. Administrative commands 823
Raw
Specifies that commands contained in the script are written to a file named
with the OUTPUTFILE parameter. This format is a way of directing output
from a script to a file so that it can be copied into another script using the
DEFINE SCRIPT command.
Note: The Tivoli Storage Manager server will output the query script
with format=raw to the console when no output file is specified.
Outputfile
Specifies the name of the file to which output is directed when you specify
FORMAT=RAW. The file you specify must reside on the server running this
command. If the file exists, the query output is appended to the end of the file.
Examples
Task 1
Display the standard information about scripts.
Command
query script *
Output

Name Description
--------------- ----------------------------------------------------
QCOLS Display columns for a specified SQL table
QSAMPLE Sample SQL Query
EXAMPLE Backup the store pools and database when no sessions

Task 2
Display the lines information for a script named Q_AUTHORITY.
Command
query script q_authority format=lines
Output

Name Line Command
Number
---------- ------ -------------------------------------------------
Q_AUTHORITY 1 /* ------------------------------------------*/
5 /* Script Name: Q_AUTHORITY */
10 /* Description: Display administrators that */
15 /* have the authority to issue */
20 /* commands requiring a */
25 /* specific privilege. */
30 /* Parameter 1: privilege name - in the form */
35 /* x_priv - EX. policy_priv */
40 /* Example: run q_authority storage_priv */
45 /* ------------------------------------------*/
50 select admin_name from admins where -
55 upper(system_priv) <> NO or -
60 upper($1) <> NO

Task 3
Display detailed information about scripts.
QUERY SCRIPT

824 IBM Tivoli Storage Manager for Windows: Administrators Reference
Command
query script * format=detailed
Output

Name: QCOLS
Line Number: DESCRIPTION
Command: Display columns for a specified SQL
table
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 12/02/1997 16:05:29

Name: QCOLS
Line Number: 1
Command: select colname from columns where
tabname=$1
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 12/02/1997 16:05:29

where:
Name
The name of the script.
Line Number
The line number of the script or the string DESCRIPTION.
Command
The command included on the line number displayed in the previous field.
Last Update by (administrator)
The name of the administrator that has defined or most recently updated the
script.
Last Update Date/Time
The date and time that the administrator defined or updated the script.
Task 4
Query the ENGDEV script and direct the output to a file named MY.SCRIPT.
Command
query script engdev format=raw outputfile=my.script
Task 5
Create a new script by using the contents from file, MY.SCRIPT . Name the new
script AGADM.
Command
define script agadm file=my.script
Related commands
Table 251. Commands related to QUERY SCRIPT
Command Description
COPY SCRIPT Creates a copy of a script.
DEFINE SCRIPT Defines a script to the IBM Tivoli Storage
Manager server.
QUERY SCRIPT
Chapter 2. Administrative commands 825
Table 251. Commands related to QUERY SCRIPT (continued)
Command Description
DELETE SCRIPT Deletes the script or individual lines from the
script.
RENAME SCRIPT Renames a script to a new name.
RUN Runs a script.
UPDATE SCRIPT Changes or adds lines to a script.

QUERY SCRIPT

826 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY SERVER (Query a server)
Use this command to display information about a server definition.
Privilege class
Any administrator can issue this command.
Syntax

Query SERver
*
server_name
Format = Standard
Format

=

Standard

Detailed

Parameters
server_name
Specifies the name of the server to be queried. You can use wildcard characters
to specify this name. This parameter is optional. The default is all server
names.
Format
Specifies how the information is displayed. The parameter is optional. The
default is STANDARD.
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task 1
Display information in standard format about all servers.
Command
query server *
Output
Server Comm. High-level Low-level Days Server Virtual Allow
Name Method Address Address Since Password Volume Replace-
Last Set Password ment
Access Set
-------- ------ ----------- -------- ------ ------- -------- --------
SERVER_A TCPIP 9.115.35.6 1501 11 Yes No No
SERVER_B TCPIP 9.115.45.24 1500 <1 Yes No No
ASTRO TCPIP 9.115.32.21 1500 24 Yes No No

Task 2
From a managed server, display detailed information about SERVER_A.
Command
query server server_a format=detailed
Output
QUERY SERVER
Chapter 2. Administrative commands 827
Server Name: SERVER_A
Comm. Method: TCPIP
High-level Address: 9.115.4.15
Low-level Address: 1500
Description:
Allow Replacement:
Node Name:
Last Access Date/Time: 06/09/1998 12:51:51
Days Since Last Access: <1
Locked?:
Compression: Clients Choice
Archive Delete Allowed?: No
URL:
Registration Date/Time: 06/09/1998 12:51:51
Registering Administrator: $$CONFIG_MANAGER$$
Bytes Received Last Session: 0
Bytes Sent Last Session: 0
Duration of Last Session (sec): 0.00
Pct. Idle Wait Last Session: 0.00
Pct. Comm. Wait Last Session: 0.00
Pct. Media Wait Last Session: 0.00
Grace Deletion Period: 5
Managing Profile:
Server Password Set Date/Time:
Days since Server Password Set:
Invalid Sign-on count for Server:
Virtual Volume Password Set: No
Virtual Volume Password Set Date/Time:(?)
Days Since Virtual Volume Password Set:(?)
Invalid Sign-on Count for Virtual Volume Node: 0
Validate Protocol: No

where:
Server Name
The name of the server.
Communication Method
The communication method used to connect to the server.
High-level Address
The IP address (in dotted decimal format) of the server.
Low-level Address
The port number of the server.
Description
The server description.
Allow Replacement
Whether a server definition on a managed server can be replaced with a
definition from a configuration manager.
Node Name
The name of the client node.
Last Access Date/Time
The last date and time that the client node accessed the server.
Days Since Last Access
The number of days since the client node accessed the server.
Locked?
Whether the client node is locked out of Tivoli Storage Manager.
Compression
The type of compression performed by Tivoli Storage Manager on client files.
QUERY SERVER

828 IBM Tivoli Storage Manager for Windows: Administrators Reference
Archive Delete Allowed?
Whether the client node can delete its own archive files. A value of (?) denotes
that this field is not set and does not apply to this definition.
URL
The URL used to access this server from a Web browser-based interface.
Registration Date/Time
The date and time that the client node was registered.
Registering Administrator
The name of the administrator that registered the client node.
Bytes Received Last Session
the number of bytes received by the server during the last client node session.
Bytes Sent Last Session
The number of bytes sent to the client node.
Duration of Last Session (sec)
The length of the last client node session, in seconds.
Pct. Idle Wait Last Session
The percentage of the total session time that the client was not performing any
functions.
Pct. Comm. Wait Last Session
The percentage of the total session time that the client waited for a response
from the server.
Pct. Media Wait Last Session
The percentage of the total session time that the client waited for a removable
volume to be mounted.
Grace Deletion Period
How many days an object remains on the target server after it has been
marked for deletion.
Managing Profile?
The profile from which the managed server got the definition of this server.
Server Password Set Date/Time
When the servers password was set.
Days since Server Password Set
The number of days since the server password was set.
Invalid Sign-on count for Server
The maximum number of invalid sign-on attempts that the server will accept.
Virtual Volume Password Set
Whether the password used to sign on to the target server has been set.
Virtual Volume Password Set Date/Time
When the password for virtual volume support was last set.
Days Since Virtual Volume Password Set
The number of days since the password for virtual volume support was set.
Invalid Sign-on Count for Virtual Volume Node
The maximum number of invalid sign-on attempts that are accepted on the
target server.
Validate Protocol
Specifies whether the storage agent has data validation enabled.
QUERY SERVER
Chapter 2. Administrative commands 829
Related commands
Table 252. Commands related to QUERY SERVER
Command Description
DEFINE DEVCLASS Defines a device class.
DEFINE SERVER Defines a server for server-to-server
communications.
DELETE DEVCLASS Deletes a device class name.
DELETE FILESPACE Deletes data associated with clients file
spaces.
DELETE SERVER Deletes the definition of a server.
QUERY NODE Displays partial or complete information
about one or more clients.
RECONCILE VOLUMES Reconciles source server virtual volume
definitions and target server archive objects.
REGISTER NODE Defines a client to the server and sets options
for that user.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
UPDATE DEVCLASS Changes the attributes of a device class.
UPDATE NODE Changes the attributes associated with a
client node.
UPDATE SERVER Updates information about a server.

QUERY SERVER

830 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY SERVERGROUP (Query a server group)
Use this command to display information about server groups and group
members.
Privilege class
To issue this command, you must have system privilege.
Syntax

QUERY SERVERGRoup
*
group_name

Parameters
group_name
Specifies the server group to query. This parameter is optional. You can use
wildcard characters to specify this name.
Examples
Task
From a managed server, query all server groups.
Command
query servergroup *
Output
Server Group Group Member Description Managing Profile
------------ ------------ ----------------- ----------------
ADMIN_GROUP SERVER_A Headquarters ADMIN_INFO
SERVER_B
SERVER_C
SERVER_D

where:
Server Group
The name of the server group.
Group Member
The group members.
Description
The description of the server group.
Managing Profile
The profile or profiles to which the managed server subscribed to get the
definition of the server groups.
Related commands
Table 253. Commands related to QUERY SERVERGROUP
Command Description
COPY SERVERGROUP Creates a copy of a server group.
QUERY SERVERGROUP
Chapter 2. Administrative commands 831
Table 253. Commands related to QUERY SERVERGROUP (continued)
Command Description
DEFINE SERVERGROUP Defines a new server group.
DELETE SERVERGROUP Deletes a server group.
QUERY SERVER Displays information about servers.
RENAME SERVERGROUP Renames a server group.
UPDATE SERVERGROUP Updates a server group.

QUERY SERVERGROUP

832 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY SESSION (Query client sessions)
Use this command to display information about administrative and client node
sessions.
Privilege class
Any administrator can issue this command.
Syntax
Query SEssion
sessnum

MINTIMethreshold

=

minutes

MAXTHRoughput

=

kilobytes_per_second
Format = Standard
Format

=

Standard

Detailed

Parameters
sessnum
Specifies the number of the administrative or client node session to query. This
parameter is optional. If you do not specify a value for this parameter, all
sessions display.
MINTIMethreshold
Specifies to display sessions that have had at least this number of minutes
elapse from the time the client sent data to the server for storage. This
parameter is optional. The minimum number of minutes is 1. The maximum
number of minutes is 99999999.
MAXTHRoughput
Specifies to display sessions that are transferring data at a rate less than this
number of kilobytes per second. This parameter is optional. The minimum
number of kilobytes per second is 0. The maximum number of kilobytes per
second is 99999999.
Format
Specifies how the information displays. This parameter is optional. The default
value is STANDARD. Possible values are:
Standard
Specifies that partial information displays for the session.
Detailed
Specifies that complete information displays for the session.
Examples
Task 1
Display information on all administrative and client node sessions that are
communicating with the server.
Command
query session
QUERY SESSION
Chapter 2. Administrative commands 833
Output

Sess Comm. Sess Wait Bytes Bytes Sess Platform Client
Number Method State Time Sent Recvd Type Name
------ ------ ------ ------ ------- ------- ----- -------- ------
77 TCP/IP Run 0 S 134 159 Admin OS/2 ADMIN

See Task 2 for parameter definitions.
Task 2
Display information in full detail about all administrative and client node sessions
that are communicating with the server.
Command
query session format=detailed
Output
Sess Number: 77
Comm. Method: Tcp/Ip
Sess State: MediaW
Wait Time: 13 S
Bytes Sent: 648
Bytes Recvd: 167
Sess Type: Node
Platform: AIX
Client Name: N25XY
Media Access Status: Waiting for mount of output volume:
COPYVOL1, 8MMPOOL ( 12 seconds )

Waiting for mount point:
8MMCLASS, ONSITEPOOL ( 45 seconds )

Waiting for output volume:
COPYVOL2, OFFSITEPOOL ( 30 seconds )
Proxy by Node: mickeynode
User Name:
Date/Time First Data Sent: 07/12/01 13:54:18

where:
Sess Number
Specifies a unique session identification number assigned by the server.
Comm. Method
Specifies the method being used by the client to communicate with the server.
Sess State
Specifies the current communications state of the server. Possible states are:
End The session is ending (session resources are released).
IdleW Waiting for clients next request (session is idle).
MediaW
The session is waiting for access to a sequential access volume.
RecvW
Waiting to receive an expected message from the client.
Run The server is executing a client request (and not waiting to send data).
QUERY SESSION

834 IBM Tivoli Storage Manager for Windows: Administrators Reference
SendW
The server is waiting to send data to the client (waiting for data to be
delivered to the client node that has already been sent).
Start The session is starting (authentication is in progress).
Wait Time
Specifies the amount of time (seconds, minutes, or hours) the server has been
in the current state shown.
Bytes Sent
Specifies the number of bytes of data sent to the client node since the session
was initiated.
Bytes Recvd
Specifies the number of bytes of data received from the client node since the
session was initiated.
Sess Type
Specifies the type of session in process: ADMIN for an administrative session,
NODE for a client node session, or SERVER. SERVER specifies the server starts
a session and initiates server-to-server operations such as central configuration,
library sharing, and storage agent sessions.
Platform
Specifies the type of operating system associated with the client.
Client Name
Specifies the name of the client node or the administrator.
Media Access Status
Specifies the type of media wait state. This information is only provided when
the session state equals MediaW. When a session is in a media wait state, this
field displays a list of all mount points and sequential volumes for the session.
The list of mount points specifies the device class and the associated storage
pool. The list of volumes specifies the primary storage pool volumes in
addition to any copy storage pool and active-data pool volumes along with
their assigned storage pool.
The server allows multiple sessions to read and one session to write to a
volume concurrently in a storage pool associated with the FILE device type. As
a result, a volume in a storage pool with a device type of FILE can appear as
the current volume for more than one session.
Proxy by Node
Specifies the originating node name for a proxy node session.
User Name
Specifies the user ID of the node, on a multi-user system, that connects to the
server when it is not the same system user who originally connected to the
server.
Date/Time First Data Sent
Specifies the date and time that the client first sent data to the server for
storage.
Related commands
Table 254. Command related to QUERY SESSION
Command Description
CANCEL SESSION Cancels active sessions with the server.

QUERY SESSION
Chapter 2. Administrative commands 835
|
QUERY SHREDSTATUS (Query shredding status )
Use this command to display information about data waiting to be shredded.
Privilege class
To issue this command you must have administrator privilege.
Syntax

QUERY SHREDstatus
Format = Standard
Format

=

Standard

Detailed

Parameters
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed. This is the default.
Detailed
Specifies that complete information is displayed.
Examples
Task
Show partial information about data shredding on the server.
Command
query shredstatus
Output
Shredding Objects
Active Awaiting
Shred
------- --------
NO 4

See the next task for field definitions.
Task
Display detailed information about data shredding on the server.
Command
query shredstatus format=detailed
Output
Shredding Objects Occupied Writes to
Active Awaiting Space Complete
Shred (MB) Shred (MB)
--------- -------- -------- ----------
NO 4 182 364

QUERY SHREDSTATUS

836 IBM Tivoli Storage Manager for Windows: Administrators Reference
where:
Shredding Active
Indicates whether or not the server is actively shredding data at this time.
Objects Awaiting Shred
The number of objects currently waiting to be shredded.
Occupied Space (MB)
The amount of server storage space occupied by the objects currently waiting
to be shredded, in megabytes. This is the amount of space that will become
available when the objects are shredded.
Writes to Complete Shred (MB)
The amount of data that must be written in order to complete the shredding,
in megabytes. This includes multiple overwrites. In the example above, the
objects currently waiting to be shredded occupy 182 megabytes of space and
the overwrite count is 2, so a total of 364 megabytes must be written in order
to shred the objects.
Related commands
Table 255. Commands related to QUERY SHREDSTATUS
Command Description
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
EXPORT NODE Copies client node information to external
media.
GENERATE BACKUPSET Generates a backup set of a clients data.
GENERATE BACKUPSETTOC Generates a table of contents for a backup
set.
MOVE DATA Moves data from a specified storage pool
volume to another storage pool volume.
QUERY STGPOOL Displays information about storage pools.
SETOPT Updates a server option without stopping
and restarting the server.
SHRED DATA Manually starts the process of shredding
deleted data.
UPDATE STGPOOL Changes the attributes of a storage pool.

QUERY SHREDSTATUS
Chapter 2. Administrative commands 837
QUERY SPACETRIGGER (Query the space triggers)
Use this command to display the settings for the database, recovery log, or storage
pool space triggers.
Privilege class
Any administrator can issue this command.
Syntax
Query SPACETrigger DB
LOG

STG

STGPOOL

=

storage_pool

Format = Standard
Format

=

Standard

Detailed

Parameters
DB
Specifies the database space trigger.
LOG
Specifies the recovery log space trigger.
STG
Specifies a storage pool space trigger
STGPOOL
Specifies one or more storage pools (using a wildcard) for which storage pool
trigger information will be displayed. If STG is specified but STGPOOL is not,
the default storage pool space trigger, if any, is displayed.
Format
Specifies how the information is displayed. This parameter is optional. The
default is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
Examples
Task
Display detailed settings for a storage pool space trigger.
Command
query spacetrigger stg stgpool=archivepool format=detailed
Output

QUERY SPACETRIGGER

838 IBM Tivoli Storage Manager for Windows: Administrators Reference
STGPOOL Full Percentage: 50
STGPOOL Expansion Percentage: 20
STGPOOL Expansion prefix: c:\program files\tivoli\filevol\
STGPOOL: ARCHIVEPOOL
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 05/10/2004 11:59:59

where:
STGPOOL Full Percentage
The trigger utilization percentage at which Tivoli Storage Manager allocates
more space for the storage pool.
STGPOOL Space Expansion
The percentage of space by which the storage pool should be expanded.
STGPOOL Expansion prefix
The prefix associated with the space trigger.
STGPOOL
The storage pool name associated with the query.
Last Update by (administrator)
The administrator who last updated the storage pool space trigger.
Last Update Date/Time
The date and time when the administrator last updated the storage pool space
trigger.
Task
Display detailed settings for the database space trigger.
Command
query spacetrigger db format=detailed
Output

DB Full Percentage: 80
DB Space Expansion: 20
DB Expansion prefix: c:\program files\tivoli\tsm\
Maximumsize: 1000
Last Update by (administrator): BF
Last Update Date/Time: 03/31/2002 11:59:59

where:
DB Full Percentage
The database utilization percentage at which Tivoli Storage Manager allocates
more space for the database.
DB Space Expansion
The percentage of space by which the database should be expanded.
DB Expansion prefix
The prefix that Tivoli Storage Manager uses to create database files when
expanding the database.
Maximumsize
The maximum size, in megabytes, of the database.
QUERY SPACETRIGGER
Chapter 2. Administrative commands 839
Last Update by (administrator)
The administrator who last updated the database space trigger.
Last Update Date/Time
The date and time when the administrator last updated the database space
trigger.
Task
Display detailed settings for the recovery log space trigger.
Command
query spacetrigger log format=detailed
Output

Log Full Percentage: 80
LOG Space Expansion: 20
LOG Expansion prefix: c:\program files\tivoli\tsm\
Maximumsize: 1000
Last Update by (administrator): BF
Last Update Date/Time: 03/31/2002 11:59:59

where:
Log Full Percentage
The recovery log utilization percentage at which Tivoli Storage Manager
allocates more space for the recovery log.
LOG Space Expansion
The percentage of space by which the recovery log should be expanded.
LOG Expansion prefix
The prefix that Tivoli Storage Manager uses to create recovery log files when
expanding the recovery log.
Maximumsize
The maximum size, in megabytes, of the recovery log.
Last Update by (administrator)
The administrator who last updated the recovery log space trigger.
Last Update Date/Time
The date and time the administrator last updated the recovery log space
trigger.
Related commands
Table 256. Commands related to QUERY SPACETRIGGER
Command Description
DEFINE SPACETRIGGER Defines the database or recovery log space
trigger.
DELETE SPACETRIGGER Deletes the database or recovery log space
trigger.
UPDATE SPACETRIGGER Changes attributes of the database or
recovery log space trigger.

QUERY SPACETRIGGER

840 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY SQLSESSION (Display SQL session value)
Use this command to display the current values of the SQL session attribute.
Privilege class
Any administrator can issue this command.
Syntax
Query SQLsession

Parameters
None
Examples
Task
Display the current values of the SQL session attribute.
Command
query sqlsession
Output

Column Date-Time Arithmetic Cursors
Display Format Mode Allowed?
Format
-------- --------- ---------- --------
Narrow ISO Truncate Yes

Column Display Format
The format in which SQL data types are displayed. The default is NARROW,
and it can be overidden by the SET SQLDISPLAYMODE command.
Date-Time Format
The format in which SQL date, time, and time stamp data are displayed. The
default is ISO, and it can be overidden by the SET SQLDATETIMEFORMAT
command.
Arithmetic Mode
The mode in which SQL arithmetic is carried out. The default is TRUNCATE,
and it can be overidden by the SET SQLMATHMODE command.
Cursors Allowed?
The cursor is an object used for storing the output of a query for row by row
processing by the application.
Related commands
Table 257. Commands related to QUERY SQLSESSION
Command Description
SELECT Allows customized queries of the IBM Tivoli
Storage Manager database.
QUERY SQLSESSION
Chapter 2. Administrative commands 841
Table 257. Commands related to QUERY SQLSESSION (continued)
Command Description
SET SQLDATETIMEFORMAT Controls the formatting of date and time in
the display of SQL queries.
SET SQLDISPLAYMODE Controls the column width in the display of
SQL queries.
SET SQLMATHMODE Controls how decimal numbers are displayed
in SQL queries.

QUERY SQLSESSION

842 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY STATUS (Query system parameters)
Use the QUERY STATUS command to display information about system
parameters.
Use this command for the following:
v To display the service level of the server
v To display information about the general server parameters, such as those
defined by the SET commands
v To request information about client sessions, such as the availability of the
server, password authentication, accounting settings, or the retention period for
the information retained in the activity log
v To display information about the central scheduler, such as the central
scheduling mode of the server
v To display the maximum number of retries that are allowed after a failed
attempt to execute a scheduled command
v To display whether subfiles can be backed up to this server, as indicated by the
SET SUBFILE command.
Privilege class
Any administrator can issue this command.
Syntax
Query STatus

Parameters
None.
Examples
Task
Display general information about server parameters; command was issued on a
configuration manager.
Command
query status
Output
QUERY STATUS
Chapter 2. Administrative commands 843
Server Name: SERVER1
Server host name or IP address: 9.115.44.121
Server TCP/IP port number: 5511
Server URL:
Crossdefine: Off
Server Password Set: Yes
Server Installation Date/Time: October 12, 2002 07:18:16 AM
Server Restart Date/Time: October 12, 2002 01:05:35 PM
Authentication: On
Password Expiration Period: 90 Day(s)
Invalid Sign-on Attempt Limit: 0
Minimum Password Length: 0
Registration: Closed
Subfile Backup: No
Availability: Enabled
Accounting: Off
Activity Log Retention: 1 Day(s)
Activity Summary Retention Period:
Activity Log Number of Records: 15,623
Activity Log Size: 18 M
License Audit Period: 30 Day(s)
Last License Audit: October 12, 2002 07:43:35 AM
Server License Compliance: Valid
Central Scheduler: Active
Maximum Sessions: 25
Maximum Scheduled Sessions: 12
Event Record Retention Period: 10 Day(s)
Client Action Duration: 5 Day(s)
Schedule Randomization Percentage: 25
Query Schedule Period: Clients Choice
Maximum Command Retries: Clients Choice
Retry Period: Clients Choice
Scheduling Modes: Any
Log Mode: Normal
Database Backup Trigger: Not Defined
BufPoolSize: 2,048 K
Active Receivers: CONSOLE ACTLOG
Configuration manager?: On
Refresh interval: 60
Last refresh date/time: October 12, 2002 07:43:45 AM
Context Messaging: On
Table of Contents (TOC) Load Retention: 120 Minute(s)
Machine Globally Unique ID:
Archive Retention Protection: Off
Encryption Strength: AES
where:
Server Name
Specifies the name of the server.
Server host name or IP address
Specifies the server TCP/IP address.
Server TCP/IP port number
Specifies the server port address.
Server URL
Specifies the URL address of the server that issued this command.
Crossdefine
Specifies whether another server running the DEFINE SERVER command will
automatically define itself to this server. See the SET CROSSDEFINE command.
Server Password Set
Specifies whether the password has been set for the server.
Server Installation Date/Time
Specifies the date and time when the server was installed.
QUERY STATUS

844 IBM Tivoli Storage Manager for Windows: Administrators Reference
Server Restart Date/Time
Specifies the last date and time when the server was started.
Authentication
Specifies whether password authentication is set on or off.
Password Expiration Period
Specifies the period, in days, after which the administrator or client node
password expires.
Invalid Sign-on Attempt Limit
Specifies the number of invalid sign-on attempts before a node is locked.
Minimum Password Length
Specifies the minimum number of characters for the password.
Registration
Specifies whether client node registration is open or closed.
Subfile Backup
Specifies whether subfiles can be backed up to this server, as indicated by the
SET SUBFILE command.
Availability
Specifies whether the server is enabled or disabled.
Accounting
Specifies whether an accounting record is generated at the end of each client
node session.
Activity Log Retention
Specifies the number of days information is retained in the activity log, or the
size of the log.
Activity Summary Retention Period
Specifies the number of days information is retained in the SQL activity
summary table.
Activity Log Number of Records
Specifies the number of records in the activity log.
Activity Log Size
Specifies the size of the activity log.
License Audit Period
Specifies the period, in days, after which the license manager automatically
audits the Tivoli Storage Manager license. Additional licensing information is
available by using the QUERY LICENSE command.
Last License Audit
Specifies the date and time when the last license audit occurred. Additional
licensing information is available by using the QUERY LICENSE command.
Server License Compliance
Specifies whether the server is in compliance (Valid) or out of compliance
(Failed) with the license terms. Use the QUERY LICENSE command to see
what factors are causing the server to fail to comply with the license terms.
Central Scheduler
Specifies whether central scheduling is running (active or inactive).
Maximum Sessions
Specifies the maximum number of client/server sessions.
QUERY STATUS
Chapter 2. Administrative commands 845
Maximum Scheduled Sessions
Specifies the maximum number of client/server sessions available for
processing scheduled work.
Event Record Retention Period
Specifies the number of days central scheduler event records are retained.
Client Action Duration
Specifies the duration of the period during which the client processes the
schedule defined with the DEFINE CLIENTACTION command.
Schedule Randomization Percentage
Specifies how much of the startup window is used for executing scheduled
events in client-polling mode.
Query Schedule Period
Specifies the frequency with which clients poll the server to obtain scheduled
work, in client-polling mode. If the value in this field is Client, the polling
frequency is determined by the client node.
Maximum Command Retries
Specifies the maximum number of times that a client scheduler retries after a
failed attempt to execute a scheduled command. If the value in this field is
Client, the client node determines the maximum number of retries.
Retry Period
Specifies the number of minutes between attempts by the client scheduler to
retry after a failed attempt to contact the server or to execute a scheduled
command. If the value in this field is Client, the client node determines the
number of minutes between retries.
Scheduling Modes
Specifies the central scheduling modes supported by the server.
Log Mode
Specifies the mode for saving recovery log records. The mode is either
roll-forward or normal.
Database Backup Trigger
Specifies that Tivoli Storage Manager automatically runs a backup of the
database if the database backup trigger is enabled.
BufPoolSize
Specifies the buffer pool size in kilobytes.
Active Receivers
Specifies the receivers for which event logging has begun.
Configuration manager?
Specifies whether the server is a configuration manager.
Refresh interval
Specifies the interval that elapses before the managed server requests a refresh
of any changes from a configuration manager.
Last refresh date/time
If the server is a managed server, specifies the date and time of the last
successful refresh of configuration information from the configuration manager.
Context Messaging
Specifies whether context messaging is enabled or disabled. See the SET
CONTEXTMESSAGING command.
QUERY STATUS

846 IBM Tivoli Storage Manager for Windows: Administrators Reference
Server-free Status
Specifies whether server-free data movement is on, off, or not supported.
Server-free Batch Size
Specifies the amount of data, in megabytes, that is copied in a single instance
of server-free data movement.
Table of Contents (TOC) Load Retention
Displays the approximate number of minutes that unreferenced TOC data will
be retained in the database.
Machine Globally Unique ID
The globally unique identifier (GUID) as of the last time that the server was
started. This GUID identifies the host machine on which the current server
resides.
Archive Retention Protection
Specifies if archive data retention protection is activated or deactivated.
Encryption Strength
Indicates data encryption strength: AES or DES.
Related commands
Table 258. Commands related to QUERY STATUS
Command Description
BEGIN EVENTLOGGING Starts event logging to a specified receiver.
DISABLE SESSIONS Prevents new sessions from accessing IBM
Tivoli Storage Manager but permits existing
sessions to continue.
ENABLE SESSIONS Resumes server activity following the
DISABLE command or the ACCEPT DATE
command.
END EVENTLOGGING Ends event logging to a specified receiver.
QUERY LICENSE Displays information about licenses and
audits.
SET ACCOUNTING Specifies whether accounting records are
created at the end of each client session.
SET ACTLOGRETENTION Specifies the number of days to retain log
records in the activity log.
SET AUTHENTICATION Specifies whether clients are prompted for a
password at the beginning of a session.
SET CONTEXTMESSAGING Specifies to turn on context messaging to
debug an ANR9999D message.
SET CROSSDEFINE Specifies whether to cross define servers.
SET EVENTRETENTION Specifies the number of days to retain
records for scheduled operations.
SET LOGMODE Sets the mode for saving records in the
recovery log.
SET MAXCMDRETRIES Specifies the maximum number of retries
after a failed attempt to execute a scheduled
command.
SET MAXSCHEDSESSIONS Specifies the maximum number of
client/server sessions available for processing
scheduled work.
QUERY STATUS
Chapter 2. Administrative commands 847
Table 258. Commands related to QUERY STATUS (continued)
Command Description
SET PASSEXP Specifies the number of days after which a
password is expired and must be changed.
SET QUERYSCHEDPERIOD Specifies the frequency for clients to obtain
scheduled work, in client-polling mode.
SET RANDOMIZE Specifies the randomization of start times
within a window for schedules in
client-polling mode.
SET REGISTRATION Specifies whether users can register
themselves or must be registered by an
administrator.
SET RETRYPERIOD Specifies the time between retry attempts by
the client scheduler.
SET SCHEDMODES Specifies the central scheduling mode for the
server.
SET SERVERHLADDRESS Specifies the high-level address of a server.
SET SERVERLLADDRESS Specifies the low-level address of a server.
SET SERVERNAME Specifies the name by which the server is
identified.
SET SERVERPASSWORD Specifies the server password.
SET SUMMARYRETENTION Specifies the number of days to retain
information for the activity summary table.
SET TOCLOADRETENTION Specifies the number of minutes to retain
information for unreferenced TOC sets.

QUERY STATUS

848 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY STGPOOL (Query storage pools)
Use this command to display information about one or more storage pools. You
can also use this command to monitor migration processes for the storage pool.
Privilege class
Any administrator can issue this command.
Syntax

Query STGpool
*
pool_name
Format = Standard
Format

=

Standard

Detailed

POoltype = ANY
POoltype

=

ANY

PRimary

COpy

ACTIVEdata

Parameters
pool_name
Specifies the storage pool to query. This parameter is optional. You can use
wildcard characters to specify this name. If you do not specify a value for this
parameter, all storage pools are displayed.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
POoltype
Specifies the type of storage pool to query. This parameter is optional. The
default value is ANY. Possible values are:
ANY
Query primary storage pools, copy storage pools, and active-data pools.
PRimary
Query only primary storage pools.
COpy
Query only copy storage pools.
ACTIVEdata
Query only active-data pools.
Examples
Task
Display details for the storage pool named DISKPOOL.
QUERY STGPOOL
Chapter 2. Administrative commands 849
Command
query stgpool diskpool format=detailed
Output
Storage Pool Name: DISKPOOL
Storage Pool Type: Primary
Device Class Name: DISK
Estimated Capacity: 66 G
Space Trigger Util: 0.0
Pct Util: 0.0
Pct Migr: 3.1
Pct Logical: 100.0
High Mig Pct: 90
Low Mig Pct: 70
Migration Delay: 0
Migration Continue: Yes
Migration Processes: 1
Reclamation Processes: 1
Next Storage Pool:
Reclaim Storage Pool:
Maximum Size Threshold: No Limit
Access: Read/Write
Description:
Overflow Location:
Cache Migrated Files?:
Collocate?: Group
Reclamation Threshold: 60
Offsite Reclamation Limit:
Maximum Scratch Volumes Allowed: 32
Number of Scratch Volumes Used: 1
Delay Period for Volume Reuse: 0 Day(s)
Migration in Progress?: No
Amount Migrated (MB): 0.00
Elapsed Migration Time (seconds): 0
Reclamation in Progress?: No
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 02/24/2005 13:57:16
Storage Pool Data Format: Native
Copy Storage Pool(s):
Active-data Pool(s):
Continue Copy on Error?: No
CRC Data: Yes
Reclamation Type: Threshold
Overwrite Data when Deleted: 2 Time(s)

Task
Display details for the sequential storage pool named FILEPOOL which uses a
FILE-type device class.
Command
query stgpool filepool format=detailed
Output
QUERY STGPOOL

850 IBM Tivoli Storage Manager for Windows: Administrators Reference
Storage Pool Name: FILEPOOL
Storage Pool Type: Active-data
Device Class Name: FILEC
Estimated Capacity: 0.0 M
Space Trigger Util: 0.0
Pct Util: 0.0
Pct Migr: 0.0
Pct Logical: 0.0
High Mig Pct: 90
Low Mig Pct: 70
Migration Delay: 0
Migration Continue: Yes
Migration Processes: 1
Reclamation Processes: 1
Next Storage Pool:
Reclaim Storage Pool:
Maximum Size Threshold: No Limit
Access: Read/Write
Description:
Overflow Location:
Cache Migrated Files?:
Collocate?: Group
Reclamation Threshold: 60
Offsite Reclamation Limit:
Maximum Scratch Volumes Allowed: 99
Number of Scratch Volumes Used: 0
Delay Period for Volume Reuse: 0 Day(s)
Migration in Progress?: No
Amount Migrated (MB): 0.00
Elapsed Migration Time (seconds): 0
Reclamation in Progress?: No
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 05/03/2004 11:37:57
Storage Pool Data Format: Native
Copy Storage Pool(s):
Active-data Pool(s):
Continue Copy on Error:
CRC Data: Yes
Reclamation Type: Threshold

Task
Display information for the storage pool named POOL1.
Command
query stgpool pool1
Output

Storage Device Estimated Pct Pct High Low Next
Pool Name Class Name Capacity Util Migr Mig Mig Storage
Pct Pct Pool
---------- ---------- --------- ----- ----- ---- ---- --------
POOL1 DISK 58.5 M 0.8 0.7 90 70 POOL2

See field descriptions following the last example.
Task
Display details for the storage pool named 8MMPOOL.
Command
query stgpool 8mmpool format=detailed
QUERY STGPOOL
Chapter 2. Administrative commands 851
Output

Storage Pool Name: 8MMPOOL
Storage Pool Type: Primary
Device Class Name: 8MMTAPE
Estimated Capacity: 0.0 M
Space Trigger Util: 0.0
Pct Util: 0.0
Pct Migr:
Pct Logical: 0.0
High Mig Pct: 90
Low Mig Pct: 70
Migration Delay: 0
Migration Continue: Yes
Migration Processes: 1
Reclamation Processes: 1
Next Storage Pool:
Reclaim Storage Pool:
Maximum Size Threshold: 5 M
Access: Read/Write
Description: Main storage pool
Overflow Location: Room1234/Bldg31
Cache Migrated Files?:
Collocate?: No
Reclamation Threshold: 60
Offsite Reclamation Limit:
Maximum Scratch Volumes Allowed: 5
Number of Scratch Volumes Used: 3
Delay Period for Volume Reuse: 0 Day(s)
Migration in Progress?: No
Amount Migrated (MB): 0.00
Elapsed Migration Time (seconds): 0
Reclamation in Progress?: No
Last Update by (administrator): ADMIN
Last Update Date/Time: 03/22/2002 06:55:45
Storage Pool Data Format: Native
Copy Storage Pool(s): COPYPOOL1
Active-data Pools: ACTIVEPOOL1 ACTIVEPOOL2
Continue Copy on Error: Yes
CRC Data: Yes
Reclamation Type: Threshold

See field descriptions following the last example.
Task
Display details for a storage pool, NAS2LIBPOOL. When you set up this storage
pool, you set the data format to NETAPPDUMP.
Command
query stgpool nas2libpool format=detailed
Output

QUERY STGPOOL

852 IBM Tivoli Storage Manager for Windows: Administrators Reference
Storage Pool Name: NAS2
Storage Pool Name: NAS2LIBPOOL
Storage Pool Type: Primary
Device Class Name: NAS2CLASS
Estimated Capacity: 0.0 M
Space Trigger Util:
Pct Util: 0.0
Pct Migr:
Pct Logical: 0.0
High Mig Pct:
Low Mig Pct:
Migration Delay:
Migration Continue:
Migration Processes:
Reclamation Processes:
Next Storage Pool:
Reclaim Storage Pool:
Maximum Size Threshold:
Access: Read/Write
Description:
Overflow Location:
Cache Migrated Files?:
Collocate?: Group
Reclamation Threshold:
Offsite Reclamation Limit:
Maximum Scratch Volumes Allowed: 50
Number of Scratch Volumes Used: 0
Delay Period for Volume Reuse: 0 Day(s)
Migration in Progress?:
Amount Migrated (MB):
Elapsed Migration Time (seconds):
Reclamation in Progress?:
Last Update by (administrator): SERVER_CONSOLE
Last Update Date/Time: 07/08/2004 16:24:43
Storage Pool Data Format: NetApp Dump
Copy Storage Pool(s):
Active-data Pool(s):
Continue Copy on Error?: No
CRC Data: No
Reclamation Type:

where:
Storage Pool Name
The name of the storage pool.
Storage Pool Type
The type of storage pool.
Device Class Name
The name of the device class assigned to the storage pool.
Estimated Capacity
The estimated capacity of the storage pool in megabytes (M) or gigabytes (G).
For DISK devices, this is the capacity of all volumes in the storage pool,
including any volumes that are varied offline.
For sequential access devices, this is an estimate of the total space of all the
sequential access volumes in the storage pool, regardless of their access mode.
If the storage pool has stored data on at least one scratch volume, the
estimated capacity includes the maximum number of scratch volumes allowed
for the pool.
For Centera, this represents the total capacity of the Centera storage device
being queried.
QUERY STGPOOL
Chapter 2. Administrative commands 853
Space Trigger Util
Utilization of the storage pool, as calculated by the storage pool space trigger,
if any, for this storage pool. Note that you can define space triggers for storage
pools associated with DISK or FILE device types only.
For sequential access devices, space trigger utilization is expressed as a
percentage of the number of used bytes on each sequential access volume
relative to the size of the volume, and the estimated capacity of all existing
volumes in the storage pool. It does not include potential scratch volumes.
Unlike the calculation for percent utilization (Pct Util), the calculation for space
trigger utilization favors creation of new private file volumes by the space
trigger over usage of additional scratch volumes.
For disk devices, space trigger utilization is expressed as a percentage of the
estimated capacity, including cached data. However, it excludes data that
resides on any volumes that are varied offline. The value for space trigger
utilization can be higher than the value for percent migration (Pct Migr) if you
issue QUERY STGPOOL while a file creation is in progress. The value for
space trigger utilization is determined by the amount of space actually
allocated while the transaction is in progress. The value for percent migration
represents only the space occupied by committed files. At the end of the
transaction, these values are synchronized.
The value for space trigger utilization includes cached data on disk volumes.
Therefore, when cache is enabled and migration occurs, the value remains the
same because the migrated data remains on the volume as cached data. The
value decreases only when the cached data expires or when the space that
cached files occupy needs to be used for no-cached files.
Pct Util
An estimate of the utilization of the storage pool, as a percentage.
For sequential access devices, this is expressed as a percentage of the number
of active bytes on each sequential access volume and the estimated capacity of
all volumes in the storage pool, including the number of potential scratch
volumes that may be allocated.
For disk devices, this is expressed as a percentage of the estimated capacity,
including cached data and data that resides on any volumes that are varied
offline. The value for Pct Util can be higher than the value for Pct Migr if you
issue this command while a file creation transaction is in progress. The value
for Pct Util is determined by the amount of space actually allocated (while the
transaction is in progress). The value for Pct Migr represents only the space
occupied by committed files. At the end of the transaction, these values become
synchronized.
The Pct Util value includes cached data on disk volumes. Therefore, when
cache is enabled and migration occurs, the Pct Util value remains the same
because the migrated data remains on the volume as cached data. The Pct Util
value decreases only when the cached data expires or when the space that
cached files occupy needs to be used for noncached files.
For Centera, this represents an estimate of the utilization of the entire Centera
storage device, not the storage pool being queried.
Pct Migr (primary storage pools only)
An estimate of the percentage of data in the storage pool that can be migrated.
The server uses this value and the high and low migration thresholds to
determine when to start and stop migration.
QUERY STGPOOL

854 IBM Tivoli Storage Manager for Windows: Administrators Reference
For random-access disk devices, this value is specified as a percentage of the
value for the estimated capacity, excluding cached data, but including data on
any volumes varied offline.
For sequential-access disk devices, this value is specified as a percentage of the
value for the estimated capacity, including the capacity of all the scratch
volumes specified for the pool. For other types of sequential-access devices,
this value is the percentage of the total number of volumes in the pool that
contain at least one byte of active data. The total number of volumes includes
the maximum number of scratch volumes.
The Pct Util value includes cached data on a volume; the Pct Migr value
excludes cached data. Therefore, when cache is enabled and migration occurs,
the Pct Migr value decreases but the Pct Util value remains the same because
the migrated data remains on the volume as cached data. The Pct Util value
decreases only when the cached data expires or when the space that cached
files occupy needs to be used for noncached files.
Pct Logical
The logical occupancy of the storage pool as a percentage of the total
occupancy. Logical occupancy is space occupied by client files that may or may
not be part of an aggregate. A Pct Logical value less than 100% indicates that
there is vacant space within aggregates in the storage pool.
High Mig Pct (primary storage pools only)
The high migration threshold, which specifies when the server can begin
migration for the storage pool. The server starts migration processes when
capacity utilization reaches this threshold.
Low Mig Pct (primary storage pools only)
The low migration threshold, which specifies when the server can stop
migration for the storage pool. The server stops migration processes when
capacity utilization reaches this threshold.
Migration Delay (primary storage pools only)
The minimum number of days that a file must remain in a storage pool before
the server can migrate the file to the next storage pool. For a disk storage pool,
the days are counted from the time that the file was stored in the storage pool
or last retrieved by a client. For a sequential access storage pool, the days are
counted from the time that the file was stored in the storage pool.
Migration Continue (primary storage pools only)
Whether the server continues to migrate files to the next storage pool even if
the files have not been in the pool for the number of days specified by the
migration delay.
Migration Processes
The number of parallel processes that are used for migrating files from a
random or sequential access primary storage pool.
Reclamation Processes
The number of parallel processes that are used for reclaiming the volumes in a
sequential access primary or copy storage pool.
Next Storage Pool (primary storage pools only)
The storage pool that is the destination for data that is migrated from this
storage pool.
Reclaim Storage Pool (primary, sequential access storage pools only)
If specified, the storage pool that is the destination for data moved from
QUERY STGPOOL
Chapter 2. Administrative commands 855
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
volumes during reclamation processing. If no pool is specified, by default
reclamation processing moves data only among volumes within the same
storage pool.
Maximum Size Threshold (primary storage pools only)
The maximum size of files that may be stored in the storage pool.
Access
How the data in the storage pool can be accessed.
Description
The description of the storage pool.
Overflow Location (sequential access storage pools only)
The location where volumes in the storage pool are stored when they are
ejected from an automated library with the MOVE MEDIA command.
Cache Migrated Files? (random access storage pools only)
Whether caching is enabled for files migrated to the next storage pool.
Collocate? (sequential access storage pools only)
Whether collocation is disabled or enabled. If collocation is disabled, the value
of this field is No. If collocation is enabled, the possible values are Group,
Node, and Filespace.
Reclamation Threshold (sequential access storage pools only)
The threshold that determines when volumes in a storage pool are reclaimed.
The server compares the percentage of reclaimable space on a volume to this
value to determine if reclamation is necessary.
Offsite Reclamation Limit
The number of offsite volumes having their space reclaimed during
reclamation for this storage pool. This field applies only when
POOLTYPE=COPY.
Maximum Scratch Volumes Allowed (sequential access storage pools only)
The maximum number of scratch volumes that the server can request for the
storage pool.
Number of Scratch Volumes Used (sequential access storage pools only)
The number of scratch volumes used in the storage pool.
Delay Period for Volume Reuse (sequential access storage pools only)
The number of days that must elapse after all files have been deleted from a
volume, before the server returns the volume to scratch or reuses the volume.
Migration in Progress? (primary storage pools only)
Whether at least one migration process is active for the storage pool.
Amount Migrated (MB) (primary storage pools only)
The amount of data, in megabytes, that has been migrated, if migration is in
progress. If migration is not in progress, this value indicates the amount of
data migrated during the last migration. When multiple, parallel migration
processes are used for the storage pool, this value indicates the total amount of
data migrated by all processes.
Elapsed Migration Time (seconds) (primary storage pools only)
The amount of time that has elapsed since migration began, if migration is
active. If migration is not active, this value indicates the amount of time
required to complete the last migration. When multiple, parallel migration
processes are used for the storage pool, this value indicates the total time from
the beginning of the first process until the completion of the last process.
QUERY STGPOOL

856 IBM Tivoli Storage Manager for Windows: Administrators Reference
Reclamation in Progress? (sequential access storage pools only)
Whether a reclamation process is active for the storage pool.
Last Update by (administrator)
The name of the administrator that has defined or most recently updated the
storage pool.
Last Update Date/Time
The date and time that an administrator defined or most recently updated the
storage pool.
Storage Pool Data Format
The type of data format used to write data to this storage pool (for example
NATIVE, NETAPPDUMP, CELERRADUMP, or NDMPDUMP).
Copy Storage Pool (s)
The copy storage pools listed here will have data simultaneously written to
them when data is backed up or archived to the primary storage pool queried
by this command.
Active-data Pool(s)
The active-data pools listed here will have data simultaneously written to them
when data is backed up to the primary storage pool queried by this command.
Continue Copy on Error?
Whether a server should continue writing data to other copy storage pools in
the list or terminate the entire transaction when a write failure occurs to one of
the copy pools in the list.This field applies only to primary random-access and
primary sequential-access storage pools.
CRC Data
Whether data is validated by a cyclic redundancy check (CRC) when data is
transferred during data storage and retrieval on a device.
Reclamation Type
Whether volumes in this storage pool are reclaimed by threshold or by
SnapLock retention date.
Overwrite Data when Deleted
The number of times data will be physically overwritten after it has been
deleted from the database.
Related commands
Table 259. Commands related to QUERY STGPOOL
Command Description
COPY ACTIVEDATA Copies active backup data.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE STGPOOL Deletes a storage pool from server storage.
UPDATE STGPOOL Changes the attributes of a storage pool.

QUERY STGPOOL
Chapter 2. Administrative commands 857
QUERY SUBSCRIBER (Display subscriber information)
Use this command on a configuration manager to display information about
subscribers and their profile subscriptions.
Privilege class
Any administrator can issue this command.
Syntax

Query SUBSCRIBer
*
server_name
PROFIle = *
PROFIle

=

profile_name

Parameters
server_name
Specifies the name of managed server a for which subscription information is
displayed. You can use wildcard characters to specify multiple server names.
This parameter is optional. The default is all managed servers.
PROFIle
Specifies a profile name for which information is displayed. You can use
wildcard characters to specify multiple profile names. This parameter is
optional. The default is all profiles.
Examples
Task
Display subscriber information for all profile subscriptions to this configuration
manager.
Command
query subscriber
Output
Subscriber Profile name Is current? Last update
date/time
--------------- --------------- ------------ -----------------
SERVER2 DEFAULT_PROFILE Yes Thu, May 14, 1998
01:14:42 PM
SERVER2 SETUP Yes Thu, May 14, 1998
01:14:42 PM

where:
Subscriber
The name of the subscriber (managed server).
Profile name
The name of the profile.
Is current?
Whether the subscription has been refreshed with the current information
associated with the profile. Possible values are:
QUERY SUBSCRIBER

858 IBM Tivoli Storage Manager for Windows: Administrators Reference
Yes
The managed server is current.
No
The managed server is not current. If this field is NO after the profile has
been refreshed, check the server messages for error conditions that might
cause the refresh to fail.
Unknown
Either the managed server has a more recent version of the profile than the
configuration manager, or the profile no longer exists on the configuration
manager, but the subscription is still associated with the profile.
Last update date/time
Specifies the date and time that configuration information for the subscription
was successfully distributed to the subscriber.
Related commands
Table 260. Commands related to QUERY SUBSCRIBER
Command Description
DEFINE SUBSCRIPTION Subscribes a managed server to a profile.
DELETE SUBSCRIBER Deletes obsolete managed server
subscriptions.
DELETE SUBSCRIPTION Deletes a specified profile subscription.
NOTIFY SUBSCRIBERS Notifies servers to refresh their configuration
information.
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
QUERY SUBSCRIPTION Displays information about profile
subscriptions.

QUERY SUBSCRIBER
Chapter 2. Administrative commands 859
QUERY SUBSCRIPTION (Display subscription information)
Use this command on a managed server to display profile subscription
information.
Privilege class
Any administrator can issue this command.
Syntax

Query SUBSCRIPtion
*
profile_name

Parameters
profile_name
Specifies the name of the profile for which subscription information is
displayed. You can use wildcard characters to specify multiple names. This
parameter is optional. The default is all profiles.
Examples
Task
Display subscription information for all profiles.
Command
query subscription
Output
Configuration Profile name Last update
manager date/time
--------------- --------------- ---------
SERVER1 ADMIN_INFO Thu, May 14, 1998
01:35:13 PM
SERVER1 DEFAULT_PROFILE Thu, May 14, 1998
01:35:13 PM
SERVER1 EMPLOYEE Thu, May 14, 1998
01:35:13 PM

where:
Configuration manager
The name of the configuration manager.
Profile name
The name of the profile.
Last update date/time
When the most recent configuration information was successfully distributed
to the subscriber.
QUERY SUBSCRIPTION

860 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 261. Commands related to QUERY SUBSCRIPTION
Command Description
DEFINE SUBSCRIPTION Subscribes a managed server to a profile.
DELETE SUBSCRIBER Deletes obsolete managed server
subscriptions.
DELETE SUBSCRIPTION Deletes a specified profile subscription.
NOTIFY SUBSCRIBERS Notifies servers to refresh their configuration
information.
QUERY SUBSCRIBER Displays information about subscribers and
their subscriptions to profiles.

QUERY SUBSCRIPTION
Chapter 2. Administrative commands 861
QUERY SYSTEM (Query the system configuration and
capacity)
Use this command to obtain consolidated information regarding Tivoli Storage
Manager configuration and capacity.
This command consolidates output from the following commands:

QUERY ASSOCIATION
QUERY COPYGROUP
QUERY DB
QUERY DBVOLUME
QUERY DEVCLASS
QUERY DOMAIN
QUERY LOG
QUERY LOGVOLUME
QUERY MGMTCLASS
QUERY OPTIONS
QUERY PROCESS
QUERY SCHEDULE
QUERY SESSION
QUERY STATUS
QUERY STGPOOL
QUERY VOLUME

Privilege class
Any administrator can issue this command.
Syntax
Query SYStem

Examples
Task 1
Issue the QUERY SYSTEM command to obtain consolidated system information.
For sample outputs for these query commands, see the individual commands.
Command
query system
Related commands
Table 262. Commands related to QUERY SYSTEM
Command Description
QUERY ASSOCIATION Displays the clients associated with one or
more schedules.
QUERY COPYGROUP Displays the attributes of a copy group.
QUERY DB Displays allocation information about the
database.
QUERY DEVCLASS Displays information about device classes.
QUERY DOMAIN Displays information about policy domains.
QUERY LOG Displays allocation information about the
recovery log.
QUERY LOGVOLUME Displays information about log volumes.
QUERY MGMTCLASS Displays information about management
classes.
QUERY SYSTEM

862 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 262. Commands related to QUERY SYSTEM (continued)
Command Description
QUERY OPTION Displays information about server options.
QUERY PROCESS Displays information about background
processes.
QUERY SCHEDULE Displays information about schedules.
QUERY SESSION Displays information about all active
administrator and client sessions with IBM
Tivoli Storage Manager.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
QUERY STGPOOL Displays information about storage pools.
QUERY VOLUME Displays information about storage pool
volumes.

QUERY SYSTEM
Chapter 2. Administrative commands 863
QUERY TAPEALERTMSG (Display status of SET
TAPEALERTMSG command)
Use this command to display the status of the SET TAPEALERTMSG command.
You can enable or disable tape alerts. When enabled, Tivoli Storage Manager can
retrieve diagnostic information from a tape or library device and display it using
ANR messages. When disabled, Tivoli Storage Manager will not query a device for
this information.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
Query TAPEAlertmsg

Examples
Task
Use the QUERY TAPEALERTMSG command to determine if tape alerts are to be
retrieved from devices and displayed in the form of ANR messages.
Command
query tapealertmsg
Output

ANR2017I Administrator SERVER_CONSOLE issued command:
QUERY TAPEALERTMSG
ANR8960I QUERY TAPEALERTMSG: The display of Tape Alerts from SCSI
devices is Enabled.

Related commands
Table 263. Commands related to QUERY TAPEALERTMSG
Command Description
SET TAPEALERTMSG Specifies whether tape and library devices
report diagnostic information to the server.

QUERY TAPEALERTMSG

864 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERY TOC (Display table of contents for a backup image)
Use this command to display directory and file information contained in the table
of contents (TOC) for a specified backup image. This command will not load table
of contents information into the IBM Tivoli Storage Manager database. The
specified table of contents will be read from a storage pool each time the QUERY
TOC command is issued.
This command cannot be issued from the server console. If the table of contents is
stored on removable media, a mount point will be required and output will be
delayed while the storage pool volume is mounted.
Privilege class
To issue this command you must have either system privilege, policy privilege for
the domain to which the node is assigned, or client owner authority over the node.
Syntax
Query TOC node_name filespace_name

CREATIONDate

=

date

CREATIONTime

=

time

Format = Standard
Format

=

Standard

Detailed

Parameters
node_name (Required)
Specifies the name of the NAS node to which the table of contents (TOC)
belongs. You cannot use wildcards to specify this name.
filespace_name (Required)
Specifies the name of the file space to which the table of contents belongs. The
file space name you specify cannot contain wildcard characters.
CREATIONDate
Specifies the creation date of the backup image for which the table of contents
is to be displayed. This parameter is optional. If you specify CREATIONDate,
you must also specify CREATIONTIME. If you do not specify these
parameters, the contents of the latest backup image for the specified node and
file space will be displayed, provided that this image has a table of contents.
You can only specify the creation date as the following:

Value Description Example
MM/DD/YYYY A specific date 05/15/2002

This specifies that you want to display the contents of the backup image
created on this date. You can obtain this date from the output of the QUERY
NASBACKUP command.
CREATIONTime
Specifies the creation time of the backup image for which the table of contents
is to be displayed. This parameter is optional. If you specify CREATIONTIME,
QUERY TOC
Chapter 2. Administrative commands 865
you must also specify CREATIONDate. If you do not specify these parameters,
the contents of the latest backup image for the specified node and file space
will be displayed, provided that this image has a table of contents. You can
only specify the creation time as the following:

Value Description Example
HH:MM:SS A specific time on the
specified creation date.
10:30:08

This specifies that you want to display the contents of the backup image
created on this time for the specified date. You can obtain this time from the
output of the QUERY NASBACKUP command.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the files.
Detailed
Specifies that complete information is displayed for the files, including the
hexadecimal representation of each file or directory name.
Examples
Task
Use the QUERY TOC command to display information in the table of contents
belonging to NAS node netapp in the filespace /vol/vol1 created on 12/06/2002 at
11:22:46. Specify a detailed format.
Command
query toc netapp /vol/vol1 creationdate=12/06/2002
creationtime=11:22:46 format=detailed
Output

QUERY TOC

866 IBM Tivoli Storage Manager for Windows: Administrators Reference
Objects in the image backed up on 12/06/2002 11:22:46
for filespace /vol/vol1 in node NETAPP:


Object Name: /.etc
Hexadecimal Object Name: 2f657463
Object Type: Directory
Object Size: 4,096
Last data Modification Date/Time: 07/31/2002 14:21:19

Object Name: /.etc/oldmaps/ndmp
Hexadecimal Object Name: 2f6574632f6f6c646d6170
732f6e646d70
Object Type: Directory
Object Size: 4,096
Last data Modification Date/Time: 07/31/2002 14:21:19

Object Name: /.etc/oldmaps/ndmp/TSM
/vol/vol1/3df0e8fd
Hexadecimal Object Name: 2f6574632f6f6c646d6170
732f6e646d702f54534d2
02f766f6c2f766f6c312f3
364663065386664
Object Type: File
Object Size: 36,864
Last data Modification Date/Time: 12/06/2002 11:14:22
Related commands
Table 264. Commands related to QUERY TOC
Command Description
BACKUP NODE Backs up a network-attached storage (NAS)
node.
QUERY NASBACKUP Displays information about NAS backup
images.
RESTORE NODE Restores a network-attached storage (NAS)
node.

QUERY TOC
Chapter 2. Administrative commands 867
QUERY VIRTUALFSMAPPING (Query a virtual file space
mapping)
Use this command to query a virtual file space mapping definition.
Privilege class
Any administrator can issue this command.
Syntax

Query VIRTUALFSmapping
* *
*

node_name

virtual_filespace_name

Parameters
node_name
Specifies the client node to which the virtual file space belongs. You can use
wildcard characters to specify this name. This parameter is optional. The
default is all client node names. You must specify a value for this parameter if
you specify a virtual file space name.
virtual_file_space_name
Specifies the name of the virtual file space mappings to be queried. You can
use wildcard characters to specify this name. This parameter is optional. If a
value is not specified, all virtual file space mappings are queried. Virtual file
space mapping names are case sensitive. Use the QUERY
VIRTUALFSMAPPING command to determine the correct capitalization for the
virtual file space mapping to be queried.
Examples
Task
Display the currently defined virtual file spaces for node NAS1.
Command
query virtualfsmapping nas1
Output

Node Virtual Filespace Filespace Path Hexadecimal
Name Mapping Name Name Path?
------ ----------------- ---------- ----------------- -----------
NAS1 /mikesdir /vol/vol2 /mikes No
NAS1 /tmpdir /vol/vol1 /tmp No
NAS1 /nonASCIIDir /vol/vol3 2f73657276657231 Yes

where:
Node Name
Specifies the name of the client node.
Virtual Filespace Mapping Name
Specifies the name of the virtual file space mapping.
QUERY VIRTUALFSMAPPING

868 IBM Tivoli Storage Manager for Windows: Administrators Reference
Filespace Name
Specifies the name of the file space for the client node.
File space names and file names that can be in a different code page or locale
than the server do not display correctly on the Administration Center or the
administrative command-line interface. The data itself is backed up and can be
restored properly, but the file space or file name may display with a
combination of invalid characters or blank spaces.
If the file space name is Unicode enabled, the name is converted to the servers
code page for display. The results of the conversion for characters not
supported by the current code page depends on the operating system. For
names that Tivoli Storage Manager is able to partially convert, you might see
question marks (??), blanks, unprintable characters, or .... These characters
indicate to the administrator that files do exist. If the conversion is not
successful, the name is displayed as .... Conversion can fail if the string
includes characters that are not available in the server code page, or if the
server has a problem accessing system conversion routines.
Path
Specifies the path to the client node.
Hexadecimal Path
Indicates whether the path is hexadecimal.
Related commands
Table 265. Commands related to QUERY VIRTUALFSMAPPING
Command Description
DEFINE VIRTUALFSMAPPING Define a virtual file space mapping.
DELETE VIRTUALFSMAPPING Delete a virtual file space mapping.
UPDATE VIRTUALFSMAPPING Update a virtual file space mapping.

QUERY VIRTUALFSMAPPING
Chapter 2. Administrative commands 869
QUERY VOLHISTORY (Display sequential volume history
information)
Use this command to display sequential volume history information. To save
sequential volume history information to one or more files, use the BACKUP
VOLHISTORY command.
Use the VOLUMEHISTORY server option to specify one or more volume history
files. After the server is restarted, Tivoli Storage Manager updates volume
information in both the database and the files.
Use the QUERY BACKUPSET command to query specified backup set information.
Privilege class
Any administrator can issue this command.
Syntax

Query VOLHistory
BEGINDate = earliest_date
BEGINDate

=

date

ENDDate = current_date
ENDDate

=

date
BEGINTime = 00:00:00
BEGINTime

=

time

ENDTime = current_time
ENDTime

=

time
Type = All
Type

=

All

BACKUPSET

DBBackup

DBDump

DBRpf

DBSnapshot

EXPort

REMote

RPFile

RPFSnapshot

STGDelete

STGNew

STGReuse

Parameters
BEGINDate
Specifies that you want to display information beginning with records created
on the specified date. This parameter is optional. The default is the earliest
date for which history information exists.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
QUERY VOLHISTORY

870 IBM Tivoli Storage Manager for Windows: Administrators Reference
Value Description Example
TODAY-days or -days The current date minus days
specified
TODAY7 or 7.
To display information beginning
with records created a week ago,
specify BEGINDATE=TODAY-7 or
BEGINDATE=-7.

ENDDate
Specifies that you want to display information ending with records created on
the specified date. This parameter is optional. The default is the current date.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY-days or -days The current date minus days
specified. The maximum
number of days is 9999.
TODAY1 or 1.
To display records created up to
yesterday, specify
ENDDATE=TODAY-1 or
ENDDATE=-1.

BEGINTime
Specifies that you want to display information beginning with records created
at the specified time. This parameter is optional. The default is midnight
(00:00:00).
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the specified
begin date
12:33:28
NOW The current time on the
specified begin date
NOW
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
begin date
NOW+03:00 or +03:00.
If you issue this command at 9:00 with
BEGINTIME=NOW+03:00 or
BEGINTIME=+03:00. Tivoli Storage
Manager displays records with a time
of 12:00 or later on the begin date.
NOW-HH:MM or
-HH:MM
The current time minus hours
and minutes on the specified
begin date
NOW-03:30 or -03:30.
If you issue this command at 9:00 with
BEGINTIME=NOW-03:30 or
BEGINTIME=-03:30, Tivoli Storage
Manager displays records with a time
of 5:30 or later on the begin date.

ENDTime
Specifies that you want to display information ending with records created at
the specified time on the end date. This parameter is optional. The default is
the current time.
QUERY VOLHISTORY
Chapter 2. Administrative commands 871
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time on the specified
end date
10:30:08
NOW The current time on the
specified end date
NOW
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
end date
NOW+03:00 or +03:00.
If you issue this command at 9:00 with
ENDTIME=NOW+03:00 or
ENDTIME=+03:00, Tivoli Storage
Manager displays records with a time
of 12:00 or later on the end date.
NOW-HH:MM or
-HH:MM
The current time minus hours
and minutes on the specified
end date
NOW-03:30 or -03:30
If you issue this command at 9:00 with
ENDTIME=NOW-3:30 or
ENDTIME=-3:30, Tivoli Storage
Manager displays records with a time
of 5:30 or earlier on the end date.

Type
Specifies the type of records to display from the volume history file. This
parameter is optional. The default is ALL. Possible values are:
All
Specifies all records.
DBBackup
Specifies to display only records that contain information about full and
incremental database backup volumes, that is with the volume types of
BACKUPFULL and BACKUPINCR.
DBDump
Specifies only records that contain information about online database
dump volumes.
BACKUPSET
Specifies to display only information about backup set volumes.
DBSnapshot
Specifies to display only records that contain information about volumes
used for database snapshot backups.
DBRpf
Specifies to display only records that contain information about full and
incremental database backup volumes and recovery plan file object
volumes (volume types of BACKUPFULL, BACKUPINCR, and RPFILE).
EXPort
Specifies only records that contain information about export volumes.
REMote
Specifies to display only records that contain information about volumes
used by library clients.
RPFile
Specifies to display only records that contain information about recovery
plan file objects that were created assuming database full and incremental
backups and that are saved on a target server.
QUERY VOLHISTORY

872 IBM Tivoli Storage Manager for Windows: Administrators Reference
RPFSnapshot
Specifies to display only records that contain information about snapshot
recovery plan file objects that were created assuming snapshot database
backups and that are saved on a target server.
STGNew
Specifies only records that contain information about new sequential access
storage volumes.
STGReuse
Specifies only records that contain information about reused sequential
storage pool volumes.
STGDelete
Specifies only records that contain information about deleted sequential
storage pool volumes.
Examples
Task
Display volume history information stored in the Tivoli Storage Manager database.
Command
query volhistory
Output
QUERY VOLHISTORY
Chapter 2. Administrative commands 873
Date/Time: 02/03/1999 18:28:06
Volume Type: STGNEW
Backup Series: 0
Backup Operation: 0
Volume Seq: 0
Device Class: 8MMTAPE
Volume Name: TAPE01
Volume Location:
Command:

Date/Time: 02/04/1999 16:20:46
Volume Type: REMOTE
Backup Series: 0
Backup Operation: 0
Volume Seq: 0
Device Class: DEV.SHARED
Volume Name: F238D25
Volume Location: BASIL
Command:


Date/Time: 02/04/1999 16:20:46
Volume Type: BACKUPFULL
Backup Series: 1
Backup Operation: 0
Volume Seq: 1
Device Class: DEV.JANUS
Volume Name: JANUS.DBB.895533646
Volume Location: JANUS
Command:

Date/Time: 02/05/1999 16:26:02
Volume Type: RPFILE
Backup Operation: 0
Volume Seq: 1
Device Class: DEV.JANUS
Volume Name: JANUS.19980518.162102
Volume Location: JANUS

Date/Time: 02/06/1999 20:38:16
Volume Type: DBSNAPSHOT
Backup Series: 1
Backup Operation: 0
Volume Seq: 2
Device Class: 8MMTAPE
Volume Name: TAPE01
Volume Location: JANUS
Command:

Date/Time: 02/08/2001 22:39:15
Volume Type: BACKUPSET
Backup Series: 1
Backup Operation:
Volume Seq:
Device Class: 8MMTAPE
Volume Name: TAPE01
Volume Location: JANUS
Command: generate backupset bill pers_data devclass=8mmtape

where:
Date/Time
The date and time that the volume was created.
Volume Type
The type of volume:
BACKUPFULL
Full database backup volume.
QUERY VOLHISTORY

874 IBM Tivoli Storage Manager for Windows: Administrators Reference
BACKUPINCR
Incremental database backup volume.
BACKUPSET
Client backupset volume.
DBSNAPSHOT
Snapshot database backup volume.
DBDUMP
Online database dump.
EXPORT
Export volume.
REMOTE
A volume used on the library client, which is the Tivoli Storage Manager
server named in the Volume Location field. See the volume history on the
server that is the library client to get details about how the volume is used.
RPFILE
Recovery plan file object volume created assuming full and incremental
database backups.
RPFSnapshot
Recovery plan file object volume created assuming snapshot database
backups.
STGDELETE
Deleted sequential access storage pool volume.
STGNEW
Added sequential access storage pool volume.
STGREUSE
Reused sequential access storage pool volume.
Backup Series
The value of this field depends on the volume type:
v For BACKUPFULL or BACKUPINCR volume types: the backup series
identifier.
v For the DBSNAPSHOT volume type: the identifier of the backup series that
is associated with the DBSNAPSHOT entry.
v For the RPFILE volume type: the identifier of the backup series that is
associated with the RPFILE entry.
v For the RPFSNAPSHOT volume type: the identifier of the backup series that
is associated with the RPFSNAPSHOT entry.
v For BACKUPSET volume types: this field is blank.
v For all other volume types: always 0.
A backup series is a full backup and all incremental backups that apply to that
full backup. Another series begins with the next full backup of the database.
Backup Operation
For BACKUPFULL or BACKUPINCR volume types: the operation number of
this backup volume within the backup series. The full backup within a backup
series is operation 0. The first incremental backup for that full backup is
operation 1, the second incremental backup is operation 2, and so on.
QUERY VOLHISTORY
Chapter 2. Administrative commands 875
For DBSNAPSHOT volume types: the operation number of this DBSNAPSHOT
volume within the DBSNAPSHOT series.
For all other volume types: always 0.
This field is blank when the volume type is BACKUPSET.
Volume Seq
The sequence or position of the volume within the backup series.
v For BACKUPFULL or BACKUPINCR volume types: the sequence, or
position, of the volume within the backup series. Volume sequence 1
identifies the first volume used for the first operation (a full backup), and so
on. For example, if the full backup occupies three volumes, these volumes
are identified as volume sequence 1, 2, and 3, respectively. The first volume
of the next operation (the first incremental backup) is then volume sequence
4.
v For BACKUPSET volume types: the sequence, or position, of the volume
within the BACKUPSET series.
v For DBSNAPSHOT volume types: the sequence, or position, of the volume
within the DBSNAPSHOT series. Volume sequence 1 identifies the first
volume used for the first DBSNAPSHOT operation, and so on.
v For DBDUMP volume types: the sequence number of the volume when it
was used for dumping data.
v For EXPORT volume types: the sequence number of the volume when it was
used for exporting data.
v For RPFILE volume types: the value of this field is always one (1).
v For all other volume types: always 0.
Device Class
The name of the device class associated with this volume.
Volume Name
The name of the volume.
Volume Location
The location of the volume. This information is available only for the following
volume types:
BACKUPFULL
BACKUPINCR
DBDUMP
EXPORT
REMOTE
RPFILE
For the volume type of REMOTE, this location field is the server name of the
library client that owns this volume.
For the volume type of RPFILE, this location field is the server name defined
in the device class definition used by the PREPARE command when the
DEVCLASS parameter is specified.
Command
When the volume type is EXPORT or BACKUPSET and the volume sequence
is 1 (for example, the first volume), this field shows the command that was
used to generate the volume. If the EXPORT or BACKUPSET is on more than
one volume, the command is displayed with the first volume but not with any
of the other volumes.
For any volume type other than EXPORT or BACKUPSET, this field is blank.
QUERY VOLHISTORY

876 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 266. Commands related to QUERY VOLHISTORY
Command Description
BACKUP VOLHISTORY Records volume history information in
external files.
DELETE VOLHISTORY Removes sequential volume history
information from the volume history file.
PREPARE Creates a recovery plan file.
QUERY RPFILE Displays information about recovery plan
files.
QUERY BACKUPSET Displays backup sets.
UPDATE VOLHISTORY Adds or changes location information for a
volume in the volume history file.

QUERY VOLHISTORY
Chapter 2. Administrative commands 877
||
QUERY VOLUME (Query storage pool volumes)
Use this command to display information about one or more storage pool volumes.
Privilege class
Any administrator can issue this command.
Syntax

Query Volume
*
volume_name

,

ACCess

=

READWrite

READOnly

UNAVailable

OFfsite

DEStroyed

,

STatus

=

ONline

OFfline

EMPty

PENding

FILling

FULl
STGpool = *
STGpool

=

pool_name

DEVclass = *
DEVclass

=

device_class_name
Format = Standard
Format

=

Standard

Detailed

Parameters
volume_name
Specifies the volume to query. This parameter is optional. You can use
wildcard characters to specify names. If you do not specify a name, all storage
pool volumes are included in the query.
ACCess
Specifies that output is restricted by volume access mode. This parameter is
optional. You can specify multiple access modes by separating the modes with
commas and no intervening spaces. If you do not specify a value for this
parameter, output is not restricted by access mode. Possible values are:
READWrite
Display volumes with an access mode of READWRITE. Client nodes and
server processes can read from and write to files stored on the volumes.
READOnly
Display volumes with an access mode of READONLY. Client nodes and
server processes can only read files stored on the volumes.
UNAVailable
Display volumes with an access mode of UNAVAILABLE. Neither client
nodes nor server processes can access files stored on the volumes.
QUERY VOLUME

878 IBM Tivoli Storage Manager for Windows: Administrators Reference
OFFsite
Display copy storage pool volumes with an access mode of OFFSITE. The
volumes are at offsite locations from which they cannot be mounted.
DEStroyed
Display primary storage pool volumes with an access mode of
DESTROYED. The volumes have been designated as permanently
damaged.
STatus
Specifies that output is restricted by volume status. This parameter is optional.
You can specify multiple status values by separating values with commas and
no intervening spaces. If you do not specify a value for this parameter, output
is not restricted by volume status. Possible values are:
ONline
Display random access volumes that are available to the server.
OFfline
Display random access volumes that are not available to the server.
EMPty
Display sequential access volumes that have no data.
PENding
Display volumes with a status of PENDING. These could be
sequential-access volumes from which all files have been deleted, but for
which the time specified by the REUSEDELAY parameter on the DEFINE
STGPOOL command has not elapsed. These volumes could also be
random-access disk volumes that were deleted, but that still contain
discarded data that is waiting to be shredded. After the data is shredded,
the volume will be physically deleted.
FILling
Display sequential access volumes that the server has written to but has
not yet filled to capacity.
FULl
Display sequential access volumes that the server has filled.
STGPool
Specifies the storage pool to include in the query. This parameter is optional.
You can use wildcard characters to specify names. If you do not specify a
storage pool name, all storage pools are included in the query.
DEVclass
Specifies the device class to include in the query. This parameter is optional.
You can use wildcard characters to specify names. If you do not specify a
device class name, all devices are included in the query.
Format
Specifies how the information is displayed. This parameter is optional. The
default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed.
Detailed
Specifies that complete information is displayed.
QUERY VOLUME
Chapter 2. Administrative commands 879
Examples
Task
Display information on all storage pool volumes prefixed with the name ATF.
Command
query volume atf*
Output

Volume Name Storage Device Estimated Pct Volume
Pool Name Class Name Capacity Util Status
(MB)
----------------------- ----------- ---------- --------- ----- -------
ATF001 8MMPOOL 8MMTAPE 4944.0 18.2 Filling
ATF002 8MMPOOL 8MMTAPE 4944.0 18.2 Filling

Task
Display details about the storage pool volume WPDV00.
Command
query volume wpdv00 format=detailed
Output

Volume Name: WPDV00
Storage Pool Name: TAPEPOOL
Device Class Name: TAPE
Estimated Capacity (MB): 5.8
Scaled Capacity Applied:
Pct Util: 0.1
Volume Status: On-line
Access: Read/Write
Pct. Reclaimable Space: 3.2
Scratch Volume?: Yes
In Error State?: No
Number of Writable Sides: 1
Number of Times Mounted: 11
Write Pass Number: 1
Approx. Date Last Written: 04/14/1998 16:17:26
Approx. Date Last Read: 04/01/1998 13:26:18
Date Became Pending:
Number of Write Errors: 0
Number of Read Errors: 0
Volume Location:
Volume is MVS Lanfree Capable: No
Last Update by (administrator): COLLIN
Last Update Date/Time: 05/01/1998 14:07:27
Begin Reclaim Period:
End Reclaim Period:
Drive Encryption Key Manager:

Task
Display details about a volume in a storage pool with a device class name of
FILECLASS.
Command
query volume devclass=fileclass format=detailed
QUERY VOLUME

880 IBM Tivoli Storage Manager for Windows: Administrators Reference
Output

Volume Name: Z:\worm_cfs\0000000e.bfs

Storage Pool Name: FILEPOOL
Device Class Name: FILECLASS
Estimated Capacity (MB): 2,048.0
Scaled Capacity Applied:
Pct Util: 0.0
Volume Status: Filling
Access: Read/Write
Pct. Reclaimable Space: 0.0
Scratch Volume?: Yes
In Error State?: No
Number of Writable Sides: 1
Number of Times Mounted: 1
Write Pass Number: 1
Approx. Date Last Written: 03/22/2004 15:23:46
Approx. Date Last Read: 03/22/2004 15:23:46
Date Became Pending:
Number of Write Errors: 0
Number of Read Errors: 0
Volume Location:
Volume is MVS Lanfree Capable: No
Last Update by (administrator):
Last Update Date/Time: 03/22/2004 15:23:46
Begin Reclaim Period: 03/22/2005
End Reclaim Period: 04/22/2005
Drive Encryption Key Manager:

Task
Display details about a storage pool volume named 000642. The volume is in a
storage pool associated with a 3592 device class.
Command
query volume 000642 format=detailed
Output

Volume Name: 000642
Storage Pool Name: 3592POOL
Device Class Name: 3592CLASS
Estimated Capacity (MB): 2,048.0
Scaled Capacity Applied:
Pct Util: 0.0
Volume Status: Filling
Access: Read/Write
Pct. Reclaimable Space: 0.0
Scratch Volume?: Yes
In Error State?: No
Number of Writable Sides: 1
Number of Times Mounted: 1
Write Pass Number: 1
Approx. Date Last Written: 03/22/2004 15:23:46
Approx. Date Last Read: 03/22/2004 15:23:46
Date Became Pending:
Number of Write Errors: 0
Number of Read Errors: 0
Volume Location:
Volume is MVS Lanfree Capable: No
Last Update by (administrator):
Last Update Date/Time: 03/22/2004 15:23:46
Begin Reclaim Period: 03/22/2005
End Reclaim Period: 04/22/2005
Drive Encryption Key Manager: Tivoli Storage Manager

QUERY VOLUME
Chapter 2. Administrative commands 881
where:
Volume Name
The name of the storage pool volume.
Storage Pool Name
The storage pool to which the volume is defined.
Device Class Name
The device class assigned to the storage pool.
Estimated Capacity (MB)
The estimated capacity of the volume, in megabytes.
For DISK devices, this value is the capacity of the volume.
For sequential access devices, this value is an estimate of the total space
available on the volume, based on the device class.
Scaled Capacity Applied
The percentage of capacity to which a volume is scaled. For example, a value
of 20 for a volume whose maximum capacity is 300 GB indicates that the
volume can only store 20 percent of 300 GB, or 60 GB. This attribute applies
only to IBM 3592 devices.
Pct Util
An estimate of the utilization of the volume. The utilization includes all space
occupied by both files and aggregates, including empty space within
aggregates.
For DISK volumes, the utilization also includes space occupied by cached data.
Volume Status
The status of the volume.
Access
Whether the volume is available to the server.
Pct. Reclaimable Space (sequential access volumes only)
The amount of space on this volume that can be reclaimed because data has
expired or been deleted. This value is compared to the reclamation threshold
for the storage pool to determine if reclamation is necessary. Reclaimable space
includes empty space within aggregates. For volumes belonging to a SnapLock
storage pool, the value is displayed but is not used.
Scratch Volume? (sequential access volumes only)
Whether this volume will be returned to scratch when the volume becomes
empty.
In Error State?
Whether the volume is in an error state. The server cannot write to volumes in
an error state.
Number of Writable Sides
This information is reserved for IBM Tivoli Storage Manager.
Number of Times Mounted
The number of times that the server has opened the volume for use. The
number of times that the server has opened the volume is not always the same
as the number of times that the volume has been physically mounted in a
drive. After a volume is physically mounted, the server can open the same
volume multiple times for different operations, for example for different client
backup sessions.
QUERY VOLUME

882 IBM Tivoli Storage Manager for Windows: Administrators Reference
Write Pass Number (sequential access volumes only)
The number of times the volume has been written to from the beginning to the
end.
Approx. Date Last Written
The approximate date on which the volume was last written.
Approx. Date Last Read
The approximate date on which the volume was last read.
Date Became Pending
The date that the status of the volume changed to pending.
Number of Write Errors
The number of writing errors that have occurred on the volume.
Number of Read Errors
The number of reading errors that have occurred on the volume.
Volume Location
The location of the volume.
Volume is MVS Lanfree Capable
Whether the volume is LAN-free capable. A LAN-free capable volume is one
that has been defined and used (at least once) by the Tivoli Storage Manager
Version 5 Release 2 or higher z/OS data manager server.
Last Update by (administrator)
The administrator that defined or most recently updated the volume.
Last Update Date/Time
When the volume was defined or most recently updated.
Begin Reclaim Period
Represents the date after which the Tivoli Storage Manager server will begin
reclaiming this volume, but not later than the date represented by the end
reclaim period. If, when the reclaim period begins, there are files on the
volume that have not expired, they will be moved to a new WORM volume
during reclamation processing. This field displays a date only if this volume is
in a storage pool for which the value of the RECLAMATIONTYPE parameter
is SNAPLOCK.
If more than one archive is stored on the same volume, the start of the
volumes reclamation period is based on the date of the most recent archive.
For SnapLock volumes, the RETVer parameter of the DEFINE COPYGROUP
command determines how long an archive is stored. If RETVer is set to 100
days, the volumes reclamation period will start 100 days after the first archive
is stored on it. If a second archive is stored on the same volume, the
reclamation start date will be adjusted to 100 days after the new archive is
stored. If the RETVer value is changed after the first archive is stored, the latest
reclamation date will apply for all of the archives on the volume. For example,
assume RETVer is set to 100 for an initial archive, but is then changed to 50. If
a second archive is stored on the volume three days after the first, the
reclamation period will not start until 100 days after the first archive was
stored.
End Reclaim Period
Represents the date by which the Tivoli Storage Manager must complete
reclamation processing on this volume to ensure continued protection of the
data. It also represents the Last Access Date physical file attribute in the
NetApp Filer, which prevents the file from being deleted until after that date.
QUERY VOLUME
Chapter 2. Administrative commands 883
|
|
|
|
|
|
|
|
|
|
|
|
|
This field displays a date only if this volume is in a storage pool for which the
value of the RECLAMATIONTYPE parameter is SNAPLOCK.
Drive Encryption Key Manager
The drive encryption key manager. This field applies only to volumes in a
storage pool associated with a device type of 3592 or LTO.
Related commands
Table 267. Commands related to QUERY VOLUME
Command Description
DEFINE DEVCLASS Defines a device class.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
DELETE VOLUME Deletes a volume from a storage pool.
UPDATE DEVCLASS Changes the attributes of a device class.
UPDATE VOLUME Updates the attributes of storage pool
volumes.
VARY Specifies whether a disk volume is available
to the server for use.

QUERY VOLUME

884 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
QUIT (End the interactive mode of the administrative client)
Use this command to end an administrative client session in interactive mode.
You cannot use the QUIT command from the SERVER_CONSOLE administrative
ID, or the console, batch, or mount modes of the administrative client.
Privilege class
Any administrator can issue this command.
Syntax
QUIT

Parameters
None.
Examples
Task
End an administrative client session in the interactive mode.
Command
quit
Related commands
None.
QUIT
Chapter 2. Administrative commands 885
RECLAIM commands
Use the RECLAIM command to reclaim volumes in a sequential-access storage
pool.
v RECLAIM STGPOOL (Reclaim sequential-access storage pool) on page 887
RECLAIM commands

886 IBM Tivoli Storage Manager for Windows: Administrators Reference
RECLAIM STGPOOL (Reclaim sequential-access storage pool)
Use this command to reclaim volumes in a sequential-access storage pool.
Reclamation makes the fragmented space on volumes usable again by moving any
remaining files from one volume to another volume. This makes the original
volume available for reuse. Reclamation will not move inactive versions of backup
data from volumes in active-data pools. For storage pools defined with
RECLAMATIONTYPE=SNAPLOCK, this command will also delete empty WORM
FILE volumes that have exceeded their reclaim period.
For storage pools that use Write Once Read Many (WORM) devices, reclamation is
not necessary because WORM volumes are not reusable. However, you can run
reclamation to allow the server to consolidate data onto fewer volumes. Volumes
emptied by reclamation can be checked out of the library, freeing slots for new
volumes.
This command can only be used with sequential access storage pools. The storage
pool data format cannot be NETAPPDUMP, CELERRADUMP, or NDMPDUMP.
Storage pools defined with a CENTERA device class cannot be reclaimed.
Only one reclamation or migration process for a given storage pool is allowed at
any given time. If a reclamation or a migration process is already running for the
storage pool, you cannot start another reclamation process for the storage pool.
You should only use this command if you are not going to use automatic
reclamation for the storage pool. You can set the RECLAIM attribute of the storage
pool definition to 100 to prevent automatic reclamation from running. This
command will honor the values of the RECLAIMPROCESS, and
RECLAIMSTGPOOL attributes of the storage pool definition. This command will
also honor the value of the OFFSITERECLAIMLIMIT and RECLAIM attribute of
the storage pool definition, if not overridden by the OFFSITERECLAIMLIMIT and
THRESHOLD command parameters. Use caution when setting the value of the
RECLAIM parameter of an active-data pool to 100, because this will prevent the
removal of inactive versions of backup data.
This command creates one or more reclamation processes that can be canceled with
the CANCEL PROCESS command. The number of processes is limited by the
RECLAIMPROCESS attribute of the storage pool definition. To display information
on background processes, use the QUERY PROCESS command.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the storage pool being reclaimed and
the reclaim storage pool, if applicable.
Syntax
RECLaim STGpool pool_name
THreshold

=

number

RECLAIM STGPOOL
Chapter 2. Administrative commands 887

DUration

=

minutes
Wait = No
Wait

=

No

Yes

OFFSITERECLAIMLimit

=

number_of_volumes


Parameters
pool_name (Required)
Specifies the storage pool in which volumes are to be reclaimed.
DUration
Specifies the maximum number of minutes the reclamation will run before
being automatically cancelled. You can specify a number from 1 to 9999. This
parameter is optional.
When the specified number of minutes elapses, the server will automatically
cancel all reclamation processes for this storage pool. As soon as the processes
recognize the automatic cancellation, they will end. As a result, the reclamation
may run longer than the value you specified for this parameter. If not
specified, the process will stop only after no more volumes meet the threshold.
If you specify a duration value for reclamation of a copy storage pool with
offsite volumes, you may cause the reclamation to terminate before any
volumes are reclaimed. In most situations when initiating reclamation for a
copy storage pool with offsite volumes, you should limit the number of offsite
volumes to be reclaimed rather than limit the duration. See the
OFFSITERECLAIMLIMIT parameter below.
THreshold
Specifies the percentage of reclaimable space that a volume must have in order
to be eligible for reclamation. You can specify a number from 1 to 99. This
parameter is optional. If not specified, the RECLAIM attribute of the storage
pool definition will be used.
Specify a value of 50 percent or greater for this parameter so files stored on
two volumes can be combined into a single output volume.
OFFSITERECLAIMLimit
Specifies the maximum number of offsite storage pool volumes that the server
should attempt to reclaim. This parameter is valid only for copy storage pools.
Limiting the number of offsite volumes can prevent the server from spending
more time analyzing volumes rather than reclaiming them. You can specify a
number from 0 to 99999. This parameter is optional. If not specified, the
OFFSITERECLAIMLIMIT attribute of the storage pool definition will be used.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is No. Possible
values are:
No
Specifies that the server processes this command in the background.
You can continue with other tasks while the command is being processed.
Messages created from the background process are displayed either in the
activity log or the server console, depending on where messages are
logged.
RECLAIM STGPOOL

888 IBM Tivoli Storage Manager for Windows: Administrators Reference
To cancel a background process, use the CANCEL PROCESS command. If
you cancel this process, some files may have already been moved to new
volumes prior to the cancellation.
Yes
Specifies that the server processes this command in the foreground. The
operation must complete before you can continue with other tasks. The
server then displays the output messages to the administrative client when
the operation completes. Messages are also displayed either in the activity
log or the server console, or both, depending on where the messages are
logged.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Reclaim volumes in the storage pool named TAPEPOOL. Specify that the server
should end the reclamation as soon as possible after 60 minutes.
Command
reclaim stgpool tapepool duration=60
Related commands
Table 268. Commands related to RECLAIM STGPOOL
Command Description
CANCEL PROCESS Cancels a background server process.
MIGRATE STGPOOL Performs migration for the storage pool.
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY PROCESS Displays information about background
processes.
QUERY STGPOOL QUERY STGPOOL

RECLAIM STGPOOL
Chapter 2. Administrative commands 889
RECONCILE commands
Issue this command from the source server to reconcile differences between virtual
volume definitions on the source server and archive files on the target server.
v RECONCILE VOLUMES (Reconcile differences in the virtual volume
definitions) on page 891
RECONCILE commands

890 IBM Tivoli Storage Manager for Windows: Administrators Reference
RECONCILE VOLUMES (Reconcile differences in the virtual
volume definitions)
Issue this command from the source server to reconcile differences between virtual
volume definitions on the source server and archive files on the target server.
Tivoli Storage Manager finds all volumes of the specified device class on the
source server and all corresponding archive files on the target server. The target
server inventory is also compared to the local definition for virtual volumes to see
if inconsistencies exist.
Privilege class
To issue this command, you must have system privilege.
Syntax

REConcile Volumes
*
device_class_name
Fix = No
Fix

=

No

Yes

Parameters
device_class_name
Specifies the device class name of the virtual volumes. If you do not specify a
name, Tivoli Storage Manager reconciles all virtual volumes. This parameter is
optional.
FIX
Specifies whether or not Tivoli Storage Manager attempts to correct any
identified inconsistencies. This parameter is optional. The default is NO.
Possible values are:
No
Specifies that Tivoli Storage Manager does not fix any inconsistencies.
Yes
Specifies that Tivoli Storage Manager makes the following corrections:
v Tivoli Storage Manager marks as unavailable storage pool volumes on
the source server that cannot be located on the target server. Volumes
that are only found in the volume history, such as database backups and
import and export volumes, are reported as being inconsistent.
v Archive files on the target server that do not correspond to any virtual
volumes on the source server are marked for deletion from the target
server.
RECONCILE VOLUMES
Chapter 2. Administrative commands 891
The following table shows the details of the actions taken:

FIX= At the
Source
Server
At the Target Server Action
NO
Volumes
exist
No files exist
Report error
Files exist but are
marked for deletion
Active files exist but
attributes do not match
Volumes do
not exist
Active files exist Report error
Files exist but are
marked for deletion
None
YES
Volumes
exist
No files exist Report error
Storage pool volumes: Marked as
unavailable
Files exist but marked
for deletion
Report error
Storage pool volumes: If attributes
match, mark files on the target
server as active again, mark volumes
on the source server as unavailable,
and recommend that an AUDIT
VOLUME be done to verify the data.
If attributes do not match, mark
volumes as unavailable.
Active files exist but
attributes do not match
Report error
Storage pool volumes: Mark as
unavailable and recommend that an
AUDIT VOLUME be done to verify
the data.
Volumes do
not exist
Active files exist Mark files for deletion on the target
server.
Files exist but marked
for deletion
None

Examples
Task
Reconcile the differences between all virtual volumes definitions on the source
server and archive files on the target server to correct any inconsistencies.
Command
reconcile volumes remote1 fix=yes
Related commands
Table 269. Commands related to RECONCILE VOLUMES
Command Description
DEFINE DEVCLASS Defines a device class.
RECONCILE VOLUMES

892 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 269. Commands related to RECONCILE VOLUMES (continued)
Command Description
DEFINE SERVER Defines a server for server-to-server
communications.
DELETE SERVER Deletes the definition of a server.
QUERY SERVER Displays information about servers.
UPDATE SERVER Updates information about a server.

RECONCILE VOLUMES
Chapter 2. Administrative commands 893
REDUCE commands
Use the REDUCE commands to lessen or decrease the amount of space from a
database or recovery log volume.
The following is a list of REDUCE commands for Tivoli Storage Manager:
v REDUCE DB (Decrease the assigned capacity of the database) on page 895
v REDUCE LOG (Decrease the assigned capacity of the recovery log) on page
896
REDUCE commands

894 IBM Tivoli Storage Manager for Windows: Administrators Reference
REDUCE DB (Decrease the assigned capacity of the database)
Use this command to decrease the space that can be used by the database.
Attention: Do not change the size of an allocated database volume after it has
been defined to Tivoli Storage Manager. If you do, Tivoli Storage
Manager may not initialize correctly and data could be lost.
You can issue the REDUCE DB command while users are accessing the server. Use
the QUERY DB command to determine how much you can reduce the assigned
capacity of the database.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
REDuce DB megabytes

Parameters
megabytes (Required)
Specifies the number of megabytes to be removed from the assigned capacity
of the database. This value should be in increments of 4MB. If you do not
specify the reduction in 4MB increments, Tivoli Storage Manager rounds the
number to the next 4MB partition.
Examples
Task
Reduce the size of the database by 52MB.
Command
reduce db 52
Related commands
Table 270. Commands related to REDUCE DB
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE DBCOPY Creates a volume copy of a database volume.
DEFINE DBVOLUME Assigns a volume to be used for database
storage.
EXTEND DB Extends usable database storage within the
volumes previously allocated for its use.
QUERY DB Displays allocation information about the
database.
QUERY DBVOLUME Displays information database volumes.
QUERY PROCESS Displays information about background
processes.

REDUCE DB
Chapter 2. Administrative commands 895
REDUCE LOG (Decrease the assigned capacity of the
recovery log)
Use this command to decrease the space that can be used by the recovery log. You
can issue the REDUCE LOG command while users are accessing the server. Use
the QUERY LOG command to determine how much you can reduce the assigned
capacity of the recovery log.
Attention: Do not change the size of an allocated recovery log volume after it has
been defined to Tivoli Storage Manager. If you do, Tivoli Storage
Manager may not initialize correctly and data could be lost. Also, if the
log mode is set to ROLLFORWARD, the log cannot be reduced.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
REDuce LOG megabytes

Parameters
megabytes (Required)
Specifies the number of megabytes to be removed from the assigned capacity
of the recovery log. The value is in increments of 4MB. If you do not specify
the reduction in 4MB increments, Tivoli Storage Manager rounds the number
to the next 4MB partition
Examples
Task
Reduce the size of the recovery log by 16MB.
Command
reduce log 16
Related commands
Table 271. Commands related to REDUCE LOG
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE DBBACKUPTRIGGER Defines a trigger for automatic IBM Tivoli
Storage Manager database backups.
DEFINE LOGCOPY Creates a volume copy of a recovery log
volume.
DEFINE LOGVOLUME Defines a disk volume to the recovery log.
EXTEND LOG Extends usable log storage within the
volumes previously allocated for its use.
QUERY DBBACKUPTRIGGER Displays information about the database
backup trigger.
REDUCE LOG

896 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 271. Commands related to REDUCE LOG (continued)
Command Description
QUERY LOG Displays allocation information about the
recovery log.
QUERY LOGVOLUME Displays information about log volumes.
QUERY PROCESS Displays information about background
processes.
SET LOGMODE Sets the mode for saving records in the
recovery log.

REDUCE LOG
Chapter 2. Administrative commands 897
REGISTER commands
Use the REGISTER commands to define or add objects to Tivoli Storage Manager.
The following is a list of REGISTER commands for Tivoli Storage Manager:
v REGISTER ADMIN (Register an administrator) on page 899
v REGISTER LICENSE (Register a new license) on page 901
v REGISTER NODE (Register a node) on page 903
REGISTER commands

898 IBM Tivoli Storage Manager for Windows: Administrators Reference
REGISTER ADMIN (Register an administrator)
Use this command to add an administrator to the server. After registration, the
administrator can issue a limited set of commands, including all query commands.
To provide additional privileges, use the GRANT AUTHORITY command.
Privilege class
To issue this command, you must have system privilege.
Syntax
REGister Admin admin_name password
PASSExp

=

days

CONtact

=

text
FORCEPwreset = No
FORCEPwreset

=

No

Yes

EMAILADDRESS

=

userID@node


Parameters
admin_name (Required)
Specifies the name of the administrator to be registered. The maximum length
of the name is 64 characters.
You cannot specify an administrator name of NONE.
password (Required)
Specifies the password of the administrator to be registered. The maximum
length of the password is 64 characters. The password is not case-sensitive. See
Naming Tivoli Storage Manager objects on page 12 for a table that lists the
characters available for specifying a password.
PASSExp
Specifies the number of days the password remains valid. You can set the
password expiration period from 0 to 9999 days. A value of 0 means that the
password never expires. This parameter is optional. If you do not specify this
parameter, the password is set with the global expiration period of 90 days.
CONtact
Specifies information identifying the administrator being registered. This
parameter is optional. The maximum length of this string is 255 characters. The
contact information must be enclosed in quotation marks if it contains any
blanks.
FORCEPwreset
Specifies whether the administrator is required to change or reset the
password. This parameter is optional. The default value is NO. Possible values
are:
No
Specifies that the administrator does not need to change or reset the
password while attempting to sign on to the server.
REGISTER ADMIN
Chapter 2. Administrative commands 899
|||
Yes
Specifies that the administrators password will expire at the next sign-on.
The client or administrator must change or reset the password at that time.
If a password is not specified, you will receive an error message.
EMAILADDRESS
This parameter is used by IBM Tivoli Storage Manager Express only. It is
not currently used by Tivoli Storage Manager. Tivoli Storage Manager
Express uses this parameter to specify the E-mail address or addresses
responsible for this administrator. Any reports that are directed to this
administrator are sent to these E-mail addresses in HTML format.
Examples
Task
Define an administrator, LARRY, with the password PASSONE. You can identify
LARRY as second-shift personnel by specifying this information with the
CONTACT parameter.
Command
register admin larry passone contact=second shift
Related commands
Table 272. Commands related to REGISTER ADMIN
Command Description
GRANT AUTHORITY Assigns privilege classes to an administrator.
LOCK ADMIN Prevents an administrator from accessing
IBM Tivoli Storage Manager.
QUERY ADMIN Displays information about one or more IBM
Tivoli Storage Manager administrators.
REGISTER NODE Defines a client to the server and sets options
for that user.
REMOVE ADMIN Removes an administrator from the list of
registered administrators.
RENAME ADMIN Changes an IBM Tivoli Storage Manager
administrators name.
SET PASSEXP Specifies the number of days after which a
password is expired and must be changed.
UNLOCK ADMIN Enables a locked administrator to access IBM
Tivoli Storage Manager.
UPDATE ADMIN Changes the password or contact information
associated with any administrator.
UPDATE NODE Changes the attributes associated with a
client node.

REGISTER ADMIN

900 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
REGISTER LICENSE (Register a new license)
Use this command to register new licenses for server components, including Tivoli
Storage Manager (base), Tivoli Storage Manager Extended Edition, and System
Storage Archive Manager.
Licenses are stored in enrollment certificate files. The enrollment certificate files
contain licensing information for the server product. The nodelock file preserves
the licensing information for your installation. Your license agreement determines
what you are licensed to use, even if you cannot use the REGISTER LICENSE
command to register all components. You are expected to comply with the license
agreement and use only what you have purchased. Use of the REGISTER LICENSE
command implies that you agree to and accept the license terms specified in your
license agreement.
Note:
1. Before upgrading from a previous version of Tivoli Storage Manager, you
must delete or rename the nodelock file.
2. To unregister licenses, you must erase the nodelock file found in the
server directory of your installation. This will also require you to
reregister any previously-registered licenses.
3. You cannot register licenses for components that are licensed on the basis
of processors (for example, Tivoli Storage Manager for mail, Tivoli
Storage Manager for Databases, Tivoli Storage Manager for ERP, Tivoli
Storage Manager for Hardware, and Tivoli Storage Manager for Space
Management).
Privilege class
To issue this command, you must have system privilege.
Syntax
REGister LICense FILE = tsmbasic.lic
tsmee.lic

dataret.lic

*.lic


Parameters
FILE
Specifies the name of the enrollment certificate file containing the license to be
registered. The specification can contain a wildcard (*). Enter the complete file
name or a wildcard in place of the file name. The file names are case-sensitive.
Possible values are:
tsmbasic.lic
To license base IBM Tivoli Storage Manager.
tsmee.lic
To license IBM Tivoli Storage Manager Extended Edition. This includes the
disaster recovery manager, large libraries, and NDMP.
dataret.lic
To license System Storage Archive Manager. This is required to enable Data
Retention Protection as well as Expiration and Deletion Suspension
(Deletion Hold).
REGISTER LICENSE
Chapter 2. Administrative commands 901
*.lic
To license all IBM Tivoli Storage Manager licenses for server components.
Examples
Task
Register System Storage Archive Manager license.
Command
register license file=dataret.lic
Task
Register all license files using a wildcard.
Command
register license file=*.lic
Related commands
Table 273. Commands related to REGISTER LICENSE
Command Description
AUDIT LICENSES Checks for compliance with defined licenses.
QUERY LICENSE Displays information about licenses and
audits.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET LICENSEAUDITPERIOD Specifies the number of days between
automatic license audits.

REGISTER LICENSE

902 IBM Tivoli Storage Manager for Windows: Administrators Reference
REGISTER NODE (Register a node)
Use this command to register a node to the server.
This command also automatically creates an administrative user ID with client
owner authority over the node. You can use this administrative user ID to access
the Web backup-archive client from remote locations through a Web browser. If an
administrative user ID already exists with the same name as the node being
registered, an administrative user ID is not automatically defined. The client node
is registered without an administrative user ID. This process also applies if your
site uses open registration.
If a client requires a different policy domain than STANDARD, you must register
the client node with this command or update the registered node.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the client
node is assigned.
Syntax
REGister Node node_name password
PASSExp

=

days

USerid = node_name
USerid

=

NONE

user_id

CONtact

=

text

DOmain = STANDARD
DOmain

=

domain_name
COMPression = Client
COMPression

=

Client

Yes

No

ARCHDELete = Yes
ARCHDELete

=

Yes

No
BACKDELete = No
BACKDELete

=

No

Yes

CLOptset

=

option_set_name
FORCEPwreset = No
FORCEPwreset

=

No

Yes

Type = Client
Type

=

Client

NAS

Server

URL

=

url
MAXNUMMP = 1
MAXNUMMP

=

number

REGISTER NODE
Chapter 2. Administrative commands 903

AUTOFSRename = No
AUTOFSRename

=

Yes

No

Client
KEEPMP = No
KEEPMP

=

No

Yes

VALIdateprotocol = No
VALIdateprotocol

=

No

Dataonly

All
TXNGroupmax = 0
TXNGroupmax

=

0

number

DATAWritepath = ANY
DATAWritepath

=
DATAReadpath = ANY
DATAReadpath

=

SESSIONINITiation = Clientorserver
SESSIONINITiation

=

Clientorserver

SERVEROnly

HLAddress

=

ip_address

LLAddress

=

tcp_port

EMAILADDRESS

=

userID@node


Parameters
node_name (Required)
Specifies the name of the client node to be registered. The maximum length of
the name is 64 characters.
You cannot specify a node name of NONE.
password (Required)
Specifies the client nodes password. The maximum length of the name is 64
characters. The password is not case-sensitive. See Naming Tivoli Storage
Manager objects on page 12 for a table that lists the characters available for
specifying a password.
PASSExp
Specifies the number of days the password remains valid. You can set the
password expiration period from 0 to 9999 days. A value of 0 means that the
password never expires. This parameter is optional. If you do not specify this
parameter, the servers common password expiration period is used. The
common password expiration period is 90 days unless changed using the SET
PASSEXP command.
You can change the password expiration period by using the UPDATE NODE
or SET PASSEXP commands. The SET PASSEXP command enables you to set a
common expiration period for all administrators and client nodes, or you may
use it to selectively set password expiration periods. If you selectively set a
password expiration period by using the REGISTER NODE command, the
UPDATE NODE command, or the SET PASSEXP command, the expiration
period is excluded from common password expiration periods that were
created using the SET PASSEXP command.
You can use the RESET PASSEXP command to reset the password expiration
period to the common expiration period.
REGISTER NODE

904 IBM Tivoli Storage Manager for Windows: Administrators Reference
|||
USerid
Specifies the administrative user ID with client owner authority. If you do not
specify a user ID, by default an administrative user ID with client owner
authority is created using the nodename of the client node to be registered. This
parameter is optional. When PASSWORDACCESS=GENERATE is used by the
client to change the password, the administrative ID with the same name can
be used to access the Web backup-archive client from a remote location.
Possible values are:
NONE
Specifies that an administrative user ID will not be automatically defined.
user_id
Specifies a node ID different than the node being registered. You can use
this parameter to grant client owner authority to an existing administrative
user ID.
CONtact
Specifies a text string of information identifying the node. The parameter is
optional. The maximum length of the text string is 255 characters. The contact
information must be enclosed in quotation marks if it contains any blanks.
DOmain
Specifies the name of the policy domain to which the node is assigned. The
parameter is optional. If you do not specify a policy domain name, the node is
assigned to the default policy domain (STANDARD).
When a source server is registered as a node, it is assigned to a policy domain.
Data from the source server is stored in the storage pool specified in the
archive copy group of the default management class of that domain.
COMPression
Specifies whether the client node compresses its files before sending them to
the server for backup and archive. The parameter is optional. The default value
is CLIENT.
Note: This parameter cannot be specified for a NAS node.
Possible values are:
Client
Specifies that the client determines whether to compress files.
Yes
Specifies that the client node compresses its files before sending them to
the server for backup and archive.
No
Specifies that the client node does not compress its files before sending
them to the server for backup and archive.
ARCHDELete
Specifies whether the client node can delete its own archive files from the
server. The parameter is optional. The default value is YES. Possible values are:
Yes
Specifies that the client node can delete its own archive files from the
server.
No
Specifies that the client node cannot delete its own archive files from the
server.
REGISTER NODE
Chapter 2. Administrative commands 905
BACKDELete
Specifies whether the client node can delete its own backup files from the
server. The parameter is optional. The default value is NO. Possible values are:
No
Specifies that the client node cannot delete its own backup files from the
server.
Yes
Specifies that the client node can delete its own backup files from the
server.
CLOptset
Specifies the name of the option set to be used by the client. The parameter is
optional.
FORCEPwreset
Specifies whether to force a client to change or reset the password. The
parameter is optional. The default value is NO. Possible values are:
No
Specifies that the password expiration period is set by the SET PASSEXP
command. The client does not need to change or reset the password while
attempting to logon to the server.
Yes
Specifies that the client node password will expire at the next logon. The
client must change or reset the password at that time. If a password is not
specified, you will receive an error message.
Type
Specifies the type of node being registered. The parameter is optional. The
default value is CLIENT. Possible values are:
Client
Specifies that the client node is a backup-archive client, HSM client, or
application client.
NAS
Specifies that the node is a network-attached storage (NAS) file server
whose data will be protected using NDMP operations. The node name
cannot be SERVER.
Note: The name of the NAS node must be the same as the data mover.
Therefore, the name cannot be changed once a corresponding data
mover is defined.
Server
Specifies that the client node is a source server being registered on the
target server.
URL
Specifies the URL address that is used in your Web browser to administer the
client node. The parameter is optional.
MAXNUMMP
Specifies the maximum number of mount points a node is allowed to use on
the server or storage agent only for operations such as backup, archive, and
HSM migration. The parameter is optional and does not apply to nodes with a
type of NAS or SERVER. The default value is 1. You can specify an integer
from 0999. A value of 0 specifies that a node cannot acquire any mount point
for a client data store operation. The MAXNUMMP value is not evaluated or
REGISTER NODE

906 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
enforced during client data read operations such as restore, retrieve, and HSM
recall. However, mount points in use for data read operations are evaluated
against attempted concurrent data store operations for the same client node
and may prevent the data store operations from being able to acquire mount
points.
For volumes in a storage pool associated with a FILE device type, the server
allows multiple processes to read and one process to write to the same volume
concurrently. To provide efficient access for nodes with data in FILE-type
storage pools, increase the value of the MAXNUMMP parameter to allow for
greater concurrency when accessing FILE volumes.
For nodes that store data into primary storage pools with simultaneous write
enabled, you may need to adjust the value of the MAXNUMMP parameter to
specify the correct number of mount points for each client session. For details,
refer to information about simultaneous write in the Administrators Guide.
For server-to-server backup, if one server is at a different version than the
other server, set the number of mount points on the target server to a value
higher than 1. Otherwise, you will receive an error.
A storage agent independently tracks the number of points used during a
client session. If a node has a storage agent installed it may exceed the
MAXNUMMP value. The MAXNUMMP value may also be exceeded under
conditions where the node does not have to wait for a mount point.
Note: The server may preempt a clients operation for a higher priority
operation and the client may lose a mount point if no other mount
points are available. Refer to the Administrators Guide for more
information.
KEEPMP
Specifies whether the client node keeps the mount point for the entire session.
The parameter is optional. The default value is NO. Possible values are:
Yes
Specifies that the client node must retain the mount point during the entire
session. If policy definitions cause data to be stored to a disk storage pool
after storing data to a sequential access storage pool, any mount points
held by the session will not be released.
No
Specifies that the client node release the mount point during the session. If
policy definitions cause data to be stored to a disk storage pool after
storing data to a sequential access storage pool, any mount points held by
the session will be released.
AUTOFSRename
Specify whether file spaces are renamed when the client system upgrades to a
client that supports Unicode, or let the client decide if the file space should be
renamed. The default is NO. The renaming, if allowed, occurs when the client
runs one of the following operations: archive, selective backup, full incremental
backup, or partial incremental backup. The renaming changes the names of
existing backed-up file spaces that are not in Unicode in server storage. Then
the file spaces are backed up in Unicode. You can use this parameter for
Unicode-enabled Tivoli Storage Manager clients using Windows , Macintosh
OS X, and NetWare operating systems.
REGISTER NODE
Chapter 2. Administrative commands 907
|
|
|
|
|
|
|
|
Note: After the client with support for Unicode is installed, any new file
spaces that the client backs up are stored in server storage using the
UTF-8 code page. UTF-8 is a byte-oriented encoding form specified by
the Unicode Standard.
Possible values are:
Yes
Existing file spaces are automatically renamed when the client system
upgrades to a client that supports Unicode, and the client runs one of the
following operations: archive, selective backup, full incremental backup, or
partial incremental backup. The renaming occurs whether the client uses
the graphical user interface, the command line, or the client scheduler.
For example, the server renames a drive as follows:
Original name: D_DRIVE
New name: D_DRIVE_OLD
The new name indicates that the file space is stored on the server in a
format that is not Unicode.
No
Existing file spaces are not automatically renamed when the client system
upgrades to a client that supports Unicode, and the client runs one of the
following operations: archive, selective backup, full incremental backup, or
partial incremental backup.
Client
The option AUTOFSRENAME in the clients option file determines
whether file spaces are renamed.
By default, the client option is set to PROMPT. When the client system
upgrades to a client that supports Unicode and the client runs a Tivoli
Storage Manager operation with the graphical user interface or the
command line, the program displays a one-time prompt to the user about
whether to rename file spaces.
When the client scheduler runs an operation, the program does not prompt
for a choice about renaming, and does not rename file spaces. Backups of
existing file spaces are sent as before (not in Unicode).
Refer to the appropriate Backup-Archive Clients Installation and Users Guide
book for more information on the client option.
VALIdateprotocol
Specify whether Tivoli Storage Manager performs a cyclic redundancy check
(CRC) to validate the data sent between the client and server. The parameter is
optional. The default is NO. Possible values are:
No
Specifies that data validation not be performed on any data sent between
the client and server.
Dataonly
Specifies that data validation be performed only on file data that is sent
between the client and server. This does not include the file metadata. This
mode impacts performance because additional overhead is required to
calculate and compare CRC values between the client and the server.
All
Specifies that data validation be performed on all client file data, client file
metadata, and Tivoli Storage Manager server metadata that is sent between
REGISTER NODE

908 IBM Tivoli Storage Manager for Windows: Administrators Reference
the client and server. This mode impacts performance as additional
overhead is required to calculate and compare CRC values between the
client and the server.
TXNGroupmax
Specifies the number of files per transaction commit that are transferred
between a client and a server. Client performance may be improved by using a
larger value for this option.
The default value is 0. Specifying 0 indicates the node will use the server
global value that is set in the server options file. To use a value other than the
server global value, specify a value of 4 through 65,000 for this parameter. The
node value takes precedence over the server value.
Attention: Increasing the TXNGROUPMAX value will result in increased
recovery log utilization. Higher recovery log utilization may increase the risk
of running out of log space. Evaluate each nodes performance before changing
this parameter. For more information on managing the recovery log, see the
Administrators Guide.
DATAWritepath
Specifies the transfer path used when the client sends data to the server,
storage agent, or both, during storage operations such as backup or archive.
The parameter is optional. The default is ANY.
Note: If a path is unavailable, the node cannot send any data. For example, if
you select the LAN-free option but a LAN-free path is not defined, the
operation will not work.
Possible values are:
ANY
Specifies that data is sent to the server, storage agent, or both, via any
available path. A LAN-free path will be used if one is available. If a
LAN-free path is unavailable, the data will be moved via the LAN.
LAN
Specifies that data is sent via the LAN.
LANFree
Specifies that data is sent via a LAN-free path.
DATAReadpath
Specifies the transfer path used when the server, storage agent, or both read
data for a client, during operations such as restore or retrieve. The parameter is
optional. The default is ANY.
Note: If a path is unavailable, data cannot be read. For example, if you select
the LAN-free option but a LAN-free path is not defined, the operation
will not work.
Possible values are:
ANY
Specifies that the server, storage agent, or both use any available path to
read data. A LAN-free path will be used if one is available. If a LAN-free
path is unavailable, the data will be read via the LAN.
LAN
Specifies that data is read via the LAN.
REGISTER NODE
Chapter 2. Administrative commands 909
LANFree
Specifies that data is read via a LAN-free path.
SESSIONINITiation
Controls whether the server or the client initiates sessions. The default is that
the client initiates sessions. The parameter is optional.
Clientorserver
Specifies that the client may initiate sessions with the server by
communicating on the TCP/IP port defined with the server option
TCPPORT. Server-prompted scheduling may also be used to prompt the
client to connect to the server.
SERVEROnly
Specifies that the server will not accept client requests for sessions. All
sessions must be initiated by server-prompted scheduling on the port
defined for the client with the REGISTER or UPDATE NODE commands.
You cannot use the client acceptor (dsmcad) to start the scheduler when
SESSIONINITIATION is set to SERVERONLY.
HLAddress
Specifies the client IP address that the server contacts to initiate scheduled
events. This optional parameter is used only when SESSIONINITIATION is set
to SERVERONLY, regardless of any addresses previously used by the client to
contact the server. If SESSIONINITIATION SERVERONLY is not in use, this
option has no effect.
The address can be specified either in numeric or host name format. If a
numeric address is used, it will be saved without verification by a domain
name server. If the address is not correct, it can cause failures when the server
attempts to contact the client. Host name format addresses will be verified
with a domain name server. Verified names will be saved and resolved with
Domain Name Services when the server contacts the client.
LLAddress
Specifies the client port number on which the client listens for sessions from
the server. This optional parameter is used only when SESSIONINITIATION is
set to SERVERONLY, regardless of any addresses previously used by the client
to contact the server. If SESSIONINITIATION SERVERONLY is not in use, this
option has no effect.
The value for this parameter must match the value of client option
TCPCLIENTPORT. The default value is 1501.
EMAILADDRESS
This parameter is used by IBM Tivoli Storage Manager Express only. It is not
currently used by Tivoli Storage Manager. Tivoli Storage Manager Express uses
this parameter to specify the E-mail address or addresses for this administrator.
Any reports that are directed to this administrator are sent to these E-mail
addresses in HTML format.
Examples
Task 1 Register the client node JOEOS2 with the password SECRETCODE and
assign this node to the DOM1 policy domain. This node can delete its own
backup and archive files from the server. All files are compressed by the
client node before they are sent to the server. This command automatically
REGISTER NODE

910 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
creates a JOEOS2 administrative user ID with password SECRETCODE. In
addition, the administrator now has client owner authority to the JOEOS2
node.
Command
register node joeos2 secretcode domain=dom1
archdelete=yes backdelete=yes
compression=yes
Task 2 Register the client node FRAN and prevent an administrative user ID from
being automatically defined.
Command
register node fran xy34z userid=none
Task 3 Grant client owner authority to an existing administrative user ID,
HELPADMIN, when registering the client node JAN. This would not
automatically create an administrator ID named JAN, but would grant
client owner authority for this node to the HELPADMIN administrator.
Command
register node jan pwdsafe userid=helpadmin
Task 4 Register a node name of NAS1 for a NAS file server that is using NDMP
operations. Assign this node to a special NAS domain.
Command
register node nas1 pw4pw domain=nasdom type=nas
Task 5 Register a node name of ED whose data is backed up to a primary storage
pool that also has a list of 2 copy storage pools defined. The primary
storage pool is of disk device type, and the 2 copy storage pools are of
sequential device type. Specify 2 as the maximum number of mount
points. The clients network has been unstable during the last few weeks.
The client wants assurance that his data is not corrupted as it is sent over
the network. Specify that Tivoli Storage Manager should validate all data
that is sent by this user to the server.
Command
register node ed pw45twx maxnummp=2 validateprotocol=all
Task 6 Register a node name of ED and set the TXNGroupmax to 1,000.
Command
register node ed pw45twx txngroupmax=1000
Related commands
Table 274. Commands related to REGISTER NODE
Command Description
DEFINE ASSOCIATION Associates clients with a schedule.
DEFINE DATAMOVER Defines a data mover to the IBM Tivoli
Storage Manager server.
DEFINE MACHNODEASSOCIATION Associates an IBM Tivoli Storage Manager
node with a machine.
DELETE FILESPACE Deletes data associated with clients file
spaces.
LOCK NODE Prevents a client from accessing the server.
REGISTER ADMIN Defines a new administrator without
granting administrative authority.
REGISTER NODE
Chapter 2. Administrative commands 911
Table 274. Commands related to REGISTER NODE (continued)
Command Description
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
RENAME NODE Changes the name for a user that belongs to
a specific policy domain.
RESET PASSEXP Resets the password expiration for nodes or
administrators.
QUERY NODE Displays partial or complete information
about one or more clients.
SET PASSEXP Specifies the number of days after which a
password is expired and must be changed.
SET REGISTRATION Specifies whether users can register
themselves or must be registered by an
administrator.
UNLOCK NODE Enables a locked user in a specific policy
domain to access the server.
UPDATE ADMIN Changes the password or contact information
associated with any administrator.
UPDATE NODE Changes the attributes associated with a
client node.

REGISTER NODE

912 IBM Tivoli Storage Manager for Windows: Administrators Reference
REMOVE commands
Use the REMOVE commands to remove an object from Tivoli Storage Manager.
The following is a list of REMOVE commands for Tivoli Storage Manager:
v REMOVE ADMIN (Delete an administrator) on page 914
v REMOVE NODE (Delete a node or an associated machine node) on page 915
REMOVE commands
Chapter 2. Administrative commands 913
REMOVE ADMIN (Delete an administrator)
Use this command to remove an administrator from the system.
You cannot remove the last system administrator or the SERVER_CONSOLE
administrative ID from the system.
Privilege class
To issue this command, you must have system privilege.
Syntax
REMove Admin admin_name

Parameters
admin_name (Required)
Specifies the name of the administrator to be removed.
Examples
Task
Remove the administrator LARRY.
Command
remove admin larry
Related commands
Table 275. Commands related to REMOVE ADMIN
Command Description
LOCK ADMIN Prevents an administrator from accessing
IBM Tivoli Storage Manager.
QUERY ADMIN Displays information about one or more IBM
Tivoli Storage Manager administrators.
REGISTER ADMIN Defines a new administrator without
granting administrative authority.
RENAME ADMIN Changes an IBM Tivoli Storage Manager
administrators name.

REMOVE ADMIN

914 IBM Tivoli Storage Manager for Windows: Administrators Reference
REMOVE NODE (Delete a node or an associated machine
node)
Use this command to remove a node from the server. If you are using disaster
recovery manager and the node to be removed is associated with a machine, the
association between the node and the machine is also deleted. If a node is a
member of a collocation group and you remove the node from the server, the node
is also removed from the collocation group.
When a node is removed, the corresponding administrative ID is removed only if:
v The administrator name is identical to the node name.
v The administrator has client owner or client access authority only to the node
being removed.
v The administrator is not a managed object.
Attention: Before you can remove a node, you must delete all backup and
archive file spaces that belong to that node. Before you can remove a NAS node
that has a corresponding data mover defined, you must first delete any paths from
the data mover, delete the data mover, delete all virtual file space definitions for
the node, then remove the NAS node.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the client
node is assigned.
Syntax
REMove Node node_name

Parameters
node_name (Required)
Specifies the name of the node to be removed.
Examples
Task
Remove the client node LARRY.
Command
remove node larry
Related commands
Table 276. Commands related to REMOVE NODE
Command Description
DELETE MACHNODEASSOCIATION Deletes association between a machine and
node.
DELETE DATAMOVER Deletes a data mover.
DELETE FILESPACE Deletes data associated with clients file
spaces.
REMOVE NODE
Chapter 2. Administrative commands 915
Table 276. Commands related to REMOVE NODE (continued)
Command Description
DELETE PATH Deletes a path from a source to a destination.
DELETE VIRTUALFSMAPPING Delete a virtual file space mapping.
LOCK NODE Prevents a client from accessing the server.
QUERY COLLOCGROUP Displays information about collocation
groups.
QUERY MACHINE Displays information about machines.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY SESSION Displays information about all active
administrator and client sessions with IBM
Tivoli Storage Manager.
REGISTER NODE Defines a client to the server and sets options
for that user.
RENAME NODE Changes the name for a user that belongs to
a specific policy domain.

REMOVE NODE

916 IBM Tivoli Storage Manager for Windows: Administrators Reference
RENAME commands
Use the RENAME commands to change the name of an existing object.
The following is a list of RENAME commands for Tivoli Storage Manager:
v RENAME ADMIN (Rename an administrator) on page 918
v RENAME FILESPACE (Rename a client file space on the server) on page 919
v RENAME NODE (Rename a node) on page 922
v RENAME SCRIPT (Rename a Tivoli Storage Manager script) on page 923
v RENAME SERVERGROUP (Rename a server group) on page 924
v RENAME STGPOOL (Change the name of a storage pool) on page 925
RENAME commands
Chapter 2. Administrative commands 917
RENAME ADMIN (Rename an administrator)
Use this command to change the name of an existing administrator. Existing
information for this administrator such as password, contact information, and
privilege classes is not altered.
If you are assigning an existing administrative user ID to another person, it is
recommended that you use the UPDATE ADMIN command to change the
password.
You cannot rename the SERVER_CONSOLE administrative ID.
Privilege class
To issue this command, you must have system privilege.
Syntax
REName Admin current_admin_name new_admin_name

Parameters
current_admin_name (Required)
Specifies the name of the administrator to be renamed.
new_admin_name (Required)
Specifies the new administrator name. The maximum length of the name is 64
characters.
Examples
Task
Rename the Tivoli Storage Manager administrator CLAUDIA to BILL.
Command
rename admin claudia bill
Related commands
Table 277. Commands related to RENAME ADMIN
Command Description
QUERY ADMIN Displays information about one or more IBM
Tivoli Storage Manager administrators.
UPDATE ADMIN Changes the password or contact information
associated with any administrator.

RENAME ADMIN

918 IBM Tivoli Storage Manager for Windows: Administrators Reference
RENAME FILESPACE (Rename a client file space on the
server)
Use this command to rename an existing client file space on the server to a new
file space name or to rename imported file spaces.
You might want to rename a file space that has been imported or to cause the
creation of new Unicode-enabled file spaces for Unicode-enabled clients.
Privilege class
Any administrator with unrestricted policy authority or with restricted policy
authority over the clients policy domain can issue this command.
Syntax
REName FIlespace node_name current_file_space_name new_file_space_name

NAMEType = SERVER
NAMEType

=

SERVER

UNIcode

FSID
NEWNAMEType = SERVER
(1)

NEWNAMEType

=

UNIcode

HEXadecimal

Notes:
1 This parameter is the default when you specify NAMEType=UNIcode.
Parameters
node_name (Required)
Specifies the name of the client node to which the file space to be renamed
belongs.
current_file_space_name (Required)
Specifies the name of the file space to be renamed. A file space name is
case-sensitive and must be specified exactly as defined to the server. Virtual
file space mapping names are allowed.
new_file_space_name (Required)
Specifies the new name for the file space. A client file space name is
case-sensitive and must be specified exactly as it is to be defined to the server.
This parameter cannot be an existing virtual file space mapping name. If the
current_file_space_name is a virtual file space, the new_file_space_name must
follow all the rules for defining a virtual file space name. See the DEFINE
VIRTUALFSMAPPING command for more information.
Note: If the new name type is hexadecimal, be careful to specify valid UTF-8
hexadecimal values so the servers code page displays the file space
name as intended. For example, do not specify a value that can be
interpreted as a backspace.
NAMEType
Specify how you want the server to interpret the current file space name that
you enter. This parameter is useful when the server has clients with support
for Unicode. You can use this parameter for Unicode-enabled Tivoli Storage
Manager clients using Windows , Macintosh OS X and NetWare operating
systems.
RENAME FILESPACE
Chapter 2. Administrative commands 919
|
|
|
The default value is SERVER. If a virtual file space mapping name is specified,
you must use SERVER. Possible values are:
SERVER
The server uses the servers code page to interpret the file space name.
UNIcode
The server converts the file space name entered from the server code page
to the UTF-8 code page. The success of the conversion depends on the
actual characters in the name and the servers code page. Conversion can
fail if the string includes characters that are not available in the server code
page, or if the server has a problem accessing system conversion routines.
FSID
The server interprets the file space name as the file space ID (FSID).
NEWNAMEType
Specify how you want the server to interpret the new file space name that you
enter. The default is SERVER if you specified the NAMETYPE as SERVER, or if
the file space to be renamed is not Unicode. The default is UNICODE if you
specified the NAMETYPE as UNICODE, or if the file space to be renamed is
Unicode. If a virtual file space mapping name is specified, you must use
SERVER. Possible values are:
SERVER
The server uses the servers code page to interpret the file space name.
UNIcode
The server converts the file space name entered from the server code page
to the UTF-8 code page. The success of the conversion depends on the
actual characters in the name and the servers code page. If the conversion
is not successful, you may want to specify the HEXADECIMAL parameter.
HEXadecimal
The server interprets the file space name that you enter as the hexadecimal
representation of a name in Unicode. Using hexadecimal ensures that the
server is able to correctly rename the file space, regardless of the servers
code page.
To view the hexadecimal representation of a file space name, you can use
the QUERY FILESPACE command with FORMAT=DETAILED.
Note: You cannot specify a new name of a type that is different from the
original name. You can rename a file space that is Unicode to
another name in Unicode. You can rename a file space that is not
Unicode using a new name in the servers code page. You cannot
mix the two types.
Examples
Task
An AIX client node named LARRY backed up file space /r033 to the Tivoli Storage
Manager server. The file space was exported to tape and later reimported to the
server. When this file space was imported, a system-generated name, /r031, was
created for it because /r033 already existed for client node LARRY.
Client node LARRY, however, already had a file space named /r031 that was not
backed up, therefore, was unknown to the server. Unless the imported file space is
RENAME FILESPACE

920 IBM Tivoli Storage Manager for Windows: Administrators Reference
renamed, it will overlay file space /r031 because the file space name generated by
the IMPORT function is the same as a file space on client node LARRY that is
unknown to the server.
Use the following command to rename imported file space /r031:
Command
rename filespace larry /r031 /imported-r033
The new name, /imported-r033, identifies that the new file space is an imported
image of file space /r033.
Task
Client JOE is using an English Unicode-enabled Tivoli Storage Manager client. JOE
has backed up several large file spaces that are not Unicode enabled in server
storage. File space \\joe\c$ contains some files with Japanese file names that
cannot be backed up to a file space that is not Unicode enabled. Because the file
spaces are large, the administrator does not want to convert all of JOEs file spaces
to Unicode-enabled file spaces at this time. The administrator wants to only
rename the non-Unicode file space, \\joe\c$, so that the next backup of the file
space causes the creation of a new Unicode-enabled file space. The new
Unicode-enabled file space will allow the Japanese files to be successfully backed
up. Use the following command to rename \\joe\c$:
Command
rename filespace joe \\joe\c$ \\joe\c$_old
Related commands
Table 278. Commands related to RENAME FILESPACE
Command Description
DEFINE VIRTUALFSMAPPING Define a virtual file space mapping.
DELETE FILESPACE Deletes data associated with clients file
spaces.
EXPORT NODE Copies client node information to external
media.
QUERY FILESPACE Displays information about data in filespaces
that belong to a client.
QUERY OCCUPANCY Displays file space information by storage
pool.

RENAME FILESPACE
Chapter 2. Administrative commands 921
RENAME NODE (Rename a node)
Use this command to rename a node.
If you are assigning an existing node ID to another person, it is recommended that
you use the UPDATE NODE command to change the password.
Note: You cannot rename a NAS node name that has a corresponding data mover
defined. If the data mover has defined paths, the paths must first be deleted.
For details on the steps that are required when you want to rename a NAS
node, refer to the Administrators Guide.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the client
node is assigned.
Syntax
REName Node current_node_name new_node_name

Parameters
current_node_name (Required)
Specifies the name of the node to be renamed.
new_node_name (Required)
Specifies the new name of the node. The maximum length of the name is 64
characters.
Examples
Task
Rename the node JOE to JOYCE.
Command
rename node joe joyce
Related commands
Table 279. Commands related to RENAME NODE
Command Description
QUERY NODE Displays partial or complete information
about one or more clients.
UPDATE NODE Changes the attributes associated with a
client node.

RENAME NODE

922 IBM Tivoli Storage Manager for Windows: Administrators Reference
RENAME SCRIPT (Rename a Tivoli Storage Manager script)
Use this command to rename a Tivoli Storage Manager script.
Privilege class
To issue this command, you must have operator, policy, system, storage, or system
privilege.
Syntax
REName SCRipt current_script_name new_script_name

Parameters
current_script_name (Required)
Specifies the name of the script to rename.
new_script_name (Required)
Specifies the new name for the script. The name can contain as many as 30
characters.
Examples
Task
Rename SCRIPT1 to a new script named SCRIPT2.
Command
rename script script1 script2
Related commands
Table 280. Commands related to RENAME SCRIPT
Command Description
COPY SCRIPT Creates a copy of a script.
DEFINE SCRIPT Defines a script to the IBM Tivoli Storage
Manager server.
DELETE SCRIPT Deletes the script or individual lines from the
script.
QUERY SCRIPT Displays information about scripts.
RUN Runs a script.
UPDATE SCRIPT Changes or adds lines to a script.

RENAME SCRIPT
Chapter 2. Administrative commands 923
RENAME SERVERGROUP (Rename a server group)
Use this command to rename a server group.
Privilege class
To issue this command, you must have system privilege.
Syntax
RENAME SERVERGRoup current_group_name new_group_name

Parameters
current_group_name (Required)
Specifies the server group to rename.
new_group_name (Required)
Specifies the new name of the server group. The maximum length of the name
is 64 characters.
Examples
Task
Rename server group WEST_COMPLEX to BIG_WEST.
Command
rename servergroup west_complex big_west
Related commands
Table 281. Commands related to RENAME SERVERGROUP
Command Description
COPY SERVERGROUP Creates a copy of a server group.
DEFINE SERVERGROUP Defines a new server group.
DELETE SERVERGROUP Deletes a server group.
QUERY SERVERGROUP Displays information about server groups.
UPDATE SERVERGROUP Updates a server group.

RENAME SERVERGROUP

924 IBM Tivoli Storage Manager for Windows: Administrators Reference
RENAME STGPOOL (Change the name of a storage pool)
Use this command to change the name of a storage pool. You can change storage
pool names so that the same names can be used on a configuration manager and
its managed servers.
When you change a storage pool name, any administrators with restricted storage
privilege for the old storage pool are automatically given restricted storage
privilege for the renamed storage pool. However, if a management class or copy
group specifies the existing storage pool as the destination for files, the destination
is not changed to the new storage pool name.
If processes are active when a storage pool is renamed, the old name may still be
displayed in messages or queries for those processes.
Privilege class
To issue this command, you must have system privilege.
Syntax
REName STGpool current_pool_name new_pool_name

Parameters
current_pool_name (Required)
Specifies the storage pool to rename.
new_pool_name (Required)
Specifies the new name of the storage pool. The maximum length of the name
is 30 characters.
Examples
Task
Rename storage pool STGPOOLA to STGPOOLB:
Command
rename stgpool stgpoola stgpoolb
Related commands
Table 282. Commands related to RENAME STGPOOL
Command Description
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE STGPOOL Deletes a storage pool from server storage.
QUERY STGPOOL Displays information about storage pools.
RESTORE STGPOOL Restores files to a primary storage pool from
copy storage pools.
UPDATE STGPOOL Changes the attributes of a storage pool.

RENAME STGPOOL
Chapter 2. Administrative commands 925
REPLY (Allow a request to continue processing)
Use this command and an identification number to inform the server that you
have completed a requested operation. Not all server requests require a reply. This
command is required only if the request message specifically indicates that a
REPLY is needed.
Privilege class
To issue this command, you must have system privilege or operator privilege.
Syntax
REPLY request_number
LABEL

=

volume_label


Parameters
request_number (Required)
Specifies the identification number of the request.
LABEL
Specifies the label to be written on a volume when you reply to a message
from a LABEL LIBVOLUME command process. This parameter is optional.
Examples
Task
Respond to a reply request using 3 as the request number.
Command
reply 3
Related commands
Table 283. Commands related to REPLY
Command Description
CANCEL REQUEST Cancels pending volume mount requests.
QUERY REQUEST Displays information about all pending
mount requests.

REPLY

926 IBM Tivoli Storage Manager for Windows: Administrators Reference
RESET commands
Use the RESET commands to reset the counters that track server statistics and can
trace Tivoli Storage Manager operations when directed by a service representative.
The following is a list of RESET commands for Tivoli Storage Manager:
v RESET BUFPOOL (Reset the database buffer pool statistics) on page 928
v RESET DBMAXUTILIZATION (Reset the utilization statistic for the database)
on page 929
v RESET LOGCONSUMPTION (Reset the cumulative log consumption statistic)
on page 930
v RESET LOGMAXUTILIZATION (Reset the utilization statistic for the log) on
page 931
v RESET PASSEXP (Reset password expiration) on page 932
RESET commands
Chapter 2. Administrative commands 927
RESET BUFPOOL (Reset the database buffer pool statistics)
Use this command to reset the statistics about the servers use of the database
buffer pool.
The buffer pool statistics consist of the following:
v The number of database requests since the last RESET BUFPOOL command or
since the server was last started
v The percentage of database page requests that are in the buffer pool as cached
copies
v The percentage of database requests that waited for a page in the buffer pool to
become available
You can use the QUERY DB command (FORMAT=DETAILED) to display the
detailed buffer pool statistics.
Privilege class
To issue this command, you must have system privilege or analyst privilege.
Syntax
RESet BUFPool

Parameters
None.
Examples
Task
Reset the buffer pool statistics.
Command
reset bufpool
Related commands
Table 284. Commands related to RESET BUFPOOL
Command Description
QUERY DB Displays allocation information about the
database.
RESET DBMAXUTILIZATION Resets the maximum utilization statistic for
the database.
RESET LOGMAXUTILIZATION Resets the maximum utilization statistic for
the recovery log.

RESET BUFPOOL

928 IBM Tivoli Storage Manager for Windows: Administrators Reference
RESET DBMAXUTILIZATION (Reset the utilization statistic for
the database)
Use this command to reset the maximum utilization statistic for the database to the
current utilization.
You can use the QUERY DB command (FORMAT=DETAILED) to display the
detailed buffer pool statistics.
Privilege class
To issue this command, you must have system privilege or analyst privilege.
Syntax
RESet DBMaxutilization

Parameters
None.
Examples
Task
Reset the maximum utilization statistic for the database.
Command
reset dbmaxutilization
Related commands
Table 285. Commands related to RESET DBMAXUTILIZATION
Command Description
QUERY DB Displays allocation information about the
database.
RESET BUFPOOL Resets the buffer pool statistics for the
database.

RESET DBMAXUTILIZATION
Chapter 2. Administrative commands 929
RESET LOGCONSUMPTION (Reset the cumulative log
consumption statistic)
Use this command to reset the statistic on the amount of recovery log space used
since the last reset.
Privilege class
To issue this command, you must have analyst privilege.
Syntax
RESet LOGConsumption

Parameters
None.
Examples
Task
Reset the statistic for recovery log consumption.
Command
reset logconsumption
Related commands
Table 286. Commands related to RESET LOGCONSUMPTION
Command Description
QUERY LOG Displays allocation information about the
recovery log.
SET LOGMODE Sets the mode for saving records in the
recovery log.

RESET LOGCONSUMPTION

930 IBM Tivoli Storage Manager for Windows: Administrators Reference
RESET LOGMAXUTILIZATION (Reset the utilization statistic for
the log)
Use this command to reset the maximum utilization statistic for the recovery log to
0. You can display the maximum utilization statistic with the QUERY LOG
command.
Privilege class
To issue this command, you must have system privilege or analyst privilege.
Syntax
RESet LOGMaxutilization

Parameters
None.
Examples
Task
Reset the maximum utilization statistic for the recovery log.
Command
reset logmaxutilization
Related commands
Table 287. Command related to RESET LOGMAXUTILIZATION
Command Description
QUERY LOG Displays allocation information about the
recovery log.

RESET LOGMAXUTILIZATION
Chapter 2. Administrative commands 931
RESET PASSEXP (Reset password expiration)
Use this command to reset the password expiration period to the common
expiration period for administrator and client node passwords.
Note: You cannot reset the password expiration period to the common expiration
period with the SET PASSEXP command.
Use the QUERY STATUS command to display the common password expiration
period.
Attention: If you do not specify either the NODE or ADMIN parameters, the
password expiration period for all client nodes and administrators will be reset.
Privilege class
To issue this command, you must have system privilege.
Syntax
RESet PASSExp

,

Node

=

node_name

,

Admin

=

admin_name


Parameters
Node
Specifies the name of the node whose password expiration period you would
like to reset. To specify a list of nodes, separate the names with commas and
no intervening spaces. This parameter is optional.
Admin
Specifies the name of the administrator whose password expiration period you
would like to reset. To specify a list of administrators, separate the names with
commas and no intervening spaces. This parameter is optional.
Examples
Task 1
Reset the password expiration period for client nodes bj and katie.
Command
reset passexp node=bj,katie
Task 2
Reset the password expiration period for all users to the common expiration
period.
Command
reset passexp
RESET PASSEXP

932 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 288. Commands related to RESET PASSEXP
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET PASSEXP Specifies the number of days after which a
password is expired and must be changed.
UPDATE ADMIN Changes the password or contact information
associated with any administrator.
UPDATE NODE Changes the attributes associated with a
client node.

RESET PASSEXP
Chapter 2. Administrative commands 933
RESTART EXPORT (Restarts a suspended export operation)
Use this command to restart a suspended export operation.
An export operation is suspended when any of the following conditions is
detected:
v A SUSPEND EXPORT command is issued for the running export operation
v Segment preemption - the file being read for export is deleted by some other
process
v Communication errors on a server-to-server export
v No available mount points
v Necessary volumes are unavailable
v I/O errors encountered
Note: Nodes or file spaces (on the exporting server) in the original export
operation that are subsequently renamed are not included in the resumed
operation. Any remaining data for nodes or file spaces on the target server
that are deleted prior to resumption is discarded.
Privilege class
You must have system privilege to issue this command.
Syntax

*
RESTART EXPORT

export_identifier

Parameters
export_identifier
This optional parameter is the unique identifier for the suspended
server-to-server export operation. You can use the wildcard character to specify
this name. The export identifier name can be found by issuing the QUERY
EXPORT command to list all the currently suspended server-to-server export
operations.
Examples
Task
Restart the suspended export operation identified by the export identifier
EXPORTALLACCTNODES.
Command
restart export exportallacctnodes
Related commands
Table 289. Commands related to RESTART EXPORT
Command Description
CANCEL EXPORT Deletes a suspended export operation
RESTART EXPORT

934 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
||
||
Table 289. Commands related to RESTART EXPORT (continued)
Command Description
EXPORT NODE Copies client node information to external
media.
EXPORT SERVER Copies all or part of the server to external
media.
QUERY EXPORT Displays the export operations that are
currently running or suspended.
SUSPEND EXPORT Suspends a running export operation.

RESTART EXPORT
Chapter 2. Administrative commands 935
|
||
||
|
||
|
||
|
||
|
|
RESTORE commands
Use the RESTORE commands to restore Tivoli Storage Manager storage pools or
volumes.
The following is a list of RESTORE commands for Tivoli Storage Manager:
v RESTORE NODE (Restore a NAS node) on page 937
v RESTORE STGPOOL (Restore storage pool data from a copy pool or an
active-data pool) on page 941
v RESTORE VOLUME (Restore primary volume data from a copy pool or an
active-data pool) on page 945
RESTORE commands

936 IBM Tivoli Storage Manager for Windows: Administrators Reference
RESTORE NODE (Restore a NAS node)
Use this command to initiate a restore operation for a network-attached storage
(NAS) node.
You can use the RESTORE NODE command to restore backups that were created
by using either the clients BACKUP NAS command or the servers BACKUP
NODE command. NAS data may be restored from primary or copy native Tivoli
Storage Manager pools; primary or copy NAS pools; or any combination needed to
achieve the restore.
Privilege class
To issue this command, you must have system privilege, policy privilege for the
domain to which the node is assigned, or client owner authority over the node.
Syntax

RESTORE Node

node_name

source_file_system
source_file_system
destination_file_system

,

FILELIST

=

file_name

FILE:

file_list
NAMEType = SERVER
NAMEType

=

SERVER

HEXadecimal

UNIcode

PITDate = TODAY
PITDate

=

mm/dd/yyyy

TODAY

TODAY-numdays

-numdays
PITTime = NOW
PITTime

=

hh:mm:ss

NOW

NOW-hh:mm

-hh:mm

Wait = No
Wait

=

No

Yes

Parameters
node_name (Required)
Specifies the name of the node to restore. You cannot use wildcard characters
or specify a list of names.
source_file_system (Required)
Specifies the name of the file system to restore. You cannot use wildcard
characters for this name. You cannot specify more than one file system to
restore. Virtual file space names are allowed.
destination_file_system
Specifies that the file server restores the data to an existing, mounted file
system on the file server. This parameter is optional. The default is the original
location of the file system on the file server. Virtual file space names are
allowed.
RESTORE NODE
Chapter 2. Administrative commands 937
FILELIST
Specifies the list of file or directory names to be restored. This parameter is
optional. The default is to restore the entire file system. If this value is
specified, the server attempts to restore the objects from the appropriate image.
If the PITDATE and PITTIME parameters are specified, then the file is restored
from the last backup image prior to the specified time. If no PITDATE and
PITTIME parameters are specified, the file is restored from the latest backup
image of the file system.
If the image is a differential backup, objects are first restored from the
corresponding full backup and then from the differential backup. The restore is
done by scanning the appropriate images for the specified objects and restoring
any that are found. The TOCs for these images will not be accessed, so the
IBM Tivoli Storage Manager server does not check whether the objects are
actually contained within the images.
The folder path and file name must be entered using forward slash (/)
symbols. However, no ending forward slash (/) is needed at the end of the file
name.
All arguments that contain a space must have double quotes (argument with
spaces) surrounding the entire argument.
FILELIST="/path/to/filename1 with blanks",/path/to/filename2_no_blanks
file_name
Specifies one or more file or directory names to be restored. The names
you specify cannot contain wildcards. Multiple names must be separated
with commas and no intervening blanks. File names are case-sensitive.
FILE:file_list
Specifies the name of a file that contains a list of the file or directory
names to be restored. In the specified file, each file or directory name must
be on a separate line. Blank lines and comment lines that begin with an
asterisk are ignored. For example:
To restore files FILE01, FILE02, and FILE03, create a file named
RESTORELIST that contains a line for each file:
FILE01
FILE02
FILE03
You can specify the files to be restored with the command as follows:
FILELIST=FILE:RESTORELIST
NAMEType
Specifies how you want the server to interpret the names specified as
FILELIST=file_name or the names listed in the file specified with
FILELIST=file_list. This parameter is useful when the names may contain
Unicode characters. It has no effect if the FILELIST parameter is not specified.
The default value is SERVER. Possible values are:
SERVER
The server uses the servers code page to interpret the names.
HEXadecimal
The server interprets the names that you enter as the hexadecimal
representation of a name in Unicode. To view the hexadecimal
representation of a file or directory name, you can use the QUERY TOC
command with FORMAT=DETAILED.
RESTORE NODE

938 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
UNIcode
The server interprets the names as being UTF-8 encoded. This option only
applies when you have specified a list with FILELIST=FILE:file_list.
Note: NDMP has limitations that prevent Tivoli Storage Manager from
reporting whether or not individual files and directories are successfully
restored.
PITDate
Specifies the point-in-time date. When used with the PITTIME option,
PITDATE establishes the point in time from which you want to select the data
to restore. The latest data that was backed up on or before the date and time
that you specify will be restored. This parameter is optional. The default is
TODAY.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 06/25/2001
TODAY The current date TODAY
TODAY-days
or
-days
The current date minus days
specified
TODAY7 or 7.
To restore data that was backed up a
week ago, specify
PITDATE=TODAY-7 or PITDATE=-7.

PITTime
Specifies the point-in-time time. When used with the PITDATE option,
PITTIME establishes the point in time from which you want to select the data
to restore. The latest data that was backed up on or before the date and time
that you specify will be restored. This parameter is optional. The default is the
current time.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time on the specified
date
12:33:28
NOW The current time on the
specified date
NOW
NOW-HH:MM
or
-HH:MM
The current time minus hours
and minutes on the specified
begin date
NOW-03:30 or -03:30.
If you issue this command at 9:00 with
PITTIME=NOW-03:30 or
PITTIME=-03:30, the server restores
backup records with a time of 5:30 or
later on the point-in-time date.

Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. The default is NO. Possible values are:
No
Specifies that the server processes this command in the background. Use
the QUERY PROCESS command to monitor the background processing of
this command.
RESTORE NODE
Chapter 2. Administrative commands 939
Yes
Specifies that the server processes this command in the foreground. You
wait for the command to complete before continuing with other tasks. The
server then displays the output messages to the administrative client when
the command completes.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task 1
Restore the data from the /vol/vol10 file system on NAS node NAS1.
Command
restore node nas1 /vol/vol10
Task 2
For Tasks 2 and 3, assume the following virtual file space definitions exist on the
server for the node NAS1.
VFS Name Filesystem Path
/mikesdir /vol/vol2 /mikes
/TargetDirVol2 /vol/vol2 /tmp
/TargetDirVol1 /vol/vol1 /tmp

Restore the directory-level backup to the original location. The source is the virtual
file space name /MIKESDIR and no destination is specified.
Command
restore node nas1 /mikesdir
Task 3
Restore the directory-level backup to a different file system but preserve the path.
Command
restore node nas1 /mikesdir /vol/vol0
Related commands
Table 290. Commands related to RESTORE NODE
Command Description
BACKUP NODE Backs up a network-attached storage (NAS)
node.
DEFINE VIRTUALFSMAPPING Define a virtual file space mapping.
QUERY NASBACKUP Displays information about NAS backup
images.
QUERY TOC Displays details about the table of contents
for a specified backup image.

RESTORE NODE

940 IBM Tivoli Storage Manager for Windows: Administrators Reference
RESTORE STGPOOL (Restore storage pool data from a copy
pool or an active-data pool)
Use this command to restore files from one or more copy storage pools or
active-data pools to a primary storage pool.
Tivoli Storage Manager restores all the primary storage pool files that:
v Have been identified as having errors
v Reside on a volume with an access mode of DESTROYED
You can also use this command to identify volumes that contain damaged, primary
files. During restore processing, a message is issued for every volume in the
restored storage pool that contains damaged, non-cached files. Use the QUERY
CONTENT command to identify damaged, primary files on a specific volume.
You cannot restore a storage pool defined with a CENTERA device class.
In addition to restoring data to primary storage pools that have NATIVE or
NONBLOCK data formats, this command also lets you restore data to primary
storage pools that have NDMP data formats (NETAPPDUMP, CELERRADUMP, or
NDMPDUMP). The primary storage pool must have the same data format as the
copy storage pool from which data is to be restored. Tivoli Storage Manager
supports backend data movement for NDMP images. For details, see the
Administrators Guide.
Note: To restore NAS client-node data to NAS storage pools, you must manually
change the access mode of the volumes to DESTROYED using the UPDATE
VOLUME command. However, if you are using disaster recovery manager,
the plan file will contain the information the server needs to automatically
mark the volumes as DESTROYED.
Restoration of files might be incomplete if backup file copies in copy storage pools
or active-data pools were moved or deleted by other Tivoli Storage Manager
processes during restore processing. To prevent this problem, do not issue the
following commands for copy storage pool or active-data pool volumes while
restore processing is in progress:
v MOVE DATA
v DELETE VOLUME (DISCARDDATA=YES)
v AUDIT VOLUME (FIX=YES)
Also, you can prevent reclamation processing for your copy storage pools by
setting the RECLAIM percentage to 100 with the UPDATE STGPOOL command.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the primary storage pool for which files
are to be restored. If you are a restricted storage administrator and you want to
restore files to a new primary storage pool, you must also have authority for the
new storage pool.
Syntax
RESTORE STGpool primary_pool_name
COPYstgpool

=

copy_pool_name

RESTORE STGPOOL
Chapter 2. Administrative commands 941

ACTIVEDATAOnly = No
ACTIVEDATAOnly

=

No

Yes

A

NEWstgpool

=

new_primary_pool_name
MAXPRocess = 1
MAXPRocess

=

number

Preview = No
Preview

=

No

Yes
Wait = No
Wait

=

No

Yes

A (Yes):
ACTIVEDATAPool = active-data_pool_name

Parameters
primary_pool_name (Required)
Specifies the name of the primary storage pool that is being restored.
COPYstgpool
Specifies the name of the copy storage pool from which the files are to be
restored. This parameter is optional. If this parameter is not specified, files are
restored from any copy pool in which copies can be located. Do not use this
parameter with the ACTIVEDATAONLY or ACTIVEDATAPOOL parameters.
ACTIVEDATAOnly
Specifies that active versions of backup files are to be restored from active-data
pools only. This parameter is optional. The default is NO. If this parameter is
not specified, files are restored from copy-storage pools. Do not use this
parameter with the COPYSTGPOOL parameter. Possible values are:
No
Specifies that the storage pool will not be restored from active-data pools.
Yes
Specifies that the storage pool will be restored from active-pool or pools
that you specify using the ACTIVEDATAPOOL parameter. If you specify
YES as a value for ACTIVEDATAONLY, but do not specify a value for
ACTIVEDATAPOOL, files are restored from any active-data pool in which
active versions of backup files can be located.
Attention: Restoring a primary storage pool from an active-data pool might
cause some or all inactive files to be deleted from the database if the server
determines that an inactive file needs to be replaced but cannot find it in the
active-data pool.
ACTIVEDATAPool
Specifies the name of the active-data pool from which the active versions of
backup files are to be restored. This parameter is optional. If this parameter is
not specified, files are restored from any active-data pool in which active
versions of backup files can be located.
NEWstgpool
Specifies the name of the new storage pool to which to restore the files. This
RESTORE STGPOOL

942 IBM Tivoli Storage Manager for Windows: Administrators Reference
parameter is optional. If this parameter is not specified, files are restored to the
original primary storage pool (the pool being restored).
MAXPRocess
Specifies the maximum number of parallel processes that are used for restoring
files. Using multiple, parallel processes may improve throughput for the
restore. This parameter is optional. You can specify a value from 1 to 999. The
default is 1.
When determining this value, consider the number of mount points (logical
drives) and physical drives that can be dedicated to this operation. To access a
sequential access volume, Tivoli Storage Manager uses a mount point, and, if
the device type is not FILE, a physical drive. The number of available mount
points and drives depends on other Tivoli Storage Manager and system
activity and on the mount limits of the device classes for the sequential access
storage pools that are involved in the restore.
Each process needs a mount point for copy storage pool volumes, and, if the
device type is not FILE, each process also needs a drive. If you are restoring
files in a sequential storage pool, each process needs an additional mount point
for primary storage pool volumes and, if the device class is not FILE, an
additional drive. For example, suppose you specify a maximum of 3 processes
to restore a primary sequential storage pool from a copy storage pool of the
same device class. Each process requires two mount points and two drives. To
run all three processes, the device class must have a mount limit of at least 6,
and at least 6 mount points and 6 drives must be available.
To preview a restore, only one process is used and no mount points or drives
are needed.
Preview
Specifies if you want to preview but not perform the restore. The preview lets
you identify volumes required to restore the storage pool. The preview
displays:
v A list of primary storage pool volumes that contain damaged files.
v The number of files and the number of bytes to be restored, assuming that
the access mode of the required copy storage pool volumes is READWRITE
or READONLY when the restore operation is performed.
v A list of copy storage pool volumes containing files to be restored. These
volumes must be mounted if you perform the restore.
v A list of any volumes containing files that cannot be restored.
Note: For only a list of offsite copy storage pool volumes to be mounted
during a restore, change the access mode of the copy pool volumes to
UNAVAILABLE. This prevents reclamation and move data processing of
the volumes until they are moved onsite for the restore.
This parameter is optional. The default is NO. Possible values are:
No
Specifies that the restore is done.
Yes
Specifies that you want to preview the restore but not do the restore.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is NO. Possible
values are:
RESTORE STGPOOL
Chapter 2. Administrative commands 943
No
Specifies that the server processes this command in the background.
You can continue with other tasks while the command is being processed.
Messages created from the background process are displayed either in the
activity log or the server console, depending on where messages are
logged. To cancel a background process, use the CANCEL PROCESS
command. If you cancel this process, some files may have already been
restored prior to the cancellation.
Yes
Specifies that the server performs this operation in the foreground. The
operation must complete before you can continue with other tasks. The
server then displays the output messages to the administrative client when
the operation completes.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Restore files from any copy storage pool to the primary storage pool,
PRIMARY_POOL.
Command
restore stgpool primary_pool
Task
Restore files from active-data pool ADP1 to the primary storage pool
PRIMARY_POOL.
Command
restore stgpool primary_pool activedataonly=yes activedatapool=adp1
Related commands
Table 291. Commands related to RESTORE STGPOOL
Command Description
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
CANCEL PROCESS Cancels a background server process.
COPY ACTIVEDATA Copies active backup data.
QUERY CONTENT Displays information about files in a storage
pool volume.
QUERY PROCESS Displays information about background
processes.
RESTORE VOLUME Restores files stored on specified volumes in
a primary storage pool from copy storage
pools.
UPDATE STGPOOL Changes the attributes of a storage pool.
UPDATE VOLUME Updates the attributes of storage pool
volumes.

RESTORE STGPOOL

944 IBM Tivoli Storage Manager for Windows: Administrators Reference
RESTORE VOLUME (Restore primary volume data from a copy
pool or an active-data pool)
Use this command to restore all files on damaged volumes in a primary storage
pool that was backed up to a copy storage pool or copied to an active-data pool.
Tivoli Storage Manager does not restore cached copies of files and removes those
cached files from the database during restore processing.
In addition to restoring data to volumes in storage pools that have NATIVE or
NONBLOCK data formats, this command also lets you restore data to volumes in
storage pools that have NDMP data formats (NETAPPDUMP, CELERRADUMP, or
NDMPDUMP). The volumes to be restored must have the same data format as the
volumes in the copy storage pool. Tivoli Storage Manager supports backend data
movement for NDMP images. For details, see the Administrators Guide.
Note:
1. You cannot restore volumes in storage pools defined with a CENTERA
device class.
2. Before you restore a random-access volume, issue the VARY command to
vary the volume offline.
3. To prevent copy storage pools files from being moved or deleted by
other processes, do not issue the following commands for copy storage
pool volumes during a restore:
v MOVE DATA
v DELETE VOLUME (DISCARDDATA=YES)
v AUDIT VOLUME (FIX=YES)
To prevent reclamation processing of copy storage pools, issue the
UPDATE STGPOOL command with the RECLAIM parameter set to 100.
This command changes the access mode of the specified volumes to DESTROYED.
When all files on a volume are restored to other locations, the destroyed volume is
empty and is deleted from the database.
The restoration may be incomplete for one or more of the following reasons:
v Files were either never backed up or the backup copies are marked as damaged.
Use the QUERY CONTENT command to get more information on the remaining
files on the volume.
v A copy storage pool was specified on the RESTORE command, but files were
backed up to a different copy storage pool. Use the PREVIEW parameter when
you issue the RESTORE command again to determine if this is the problem.
v Volumes in the copy storage pool needed to perform the restore operation are
offsite or unavailable. Check the activity log for messages that occurred during
restore processing.
v Backup file copies in copy storage pools were moved or deleted by other
processes during a restore. See note 3.
v An active-data pool was specified for the restore, and inactive files were not
available to be copied.
Privilege class
To issue this command you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the primary storage pool. If you have
restricted privilege and want to restore files to a new primary storage pool, you
RESTORE VOLUME
Chapter 2. Administrative commands 945
must also have authority for the new storage pool.
Syntax

RESTORE Volume

,
volume_name

COPYstgpool

=

copy_pool_name

ACTIVEDATAOnly = No
ACTIVEDATAOnly

=

No

Yes

A

NEWstgpool

=

new_primary_pool_name
MAXPRocess = 1
MAXPRocess

=

number

Preview = No
Preview

=

No

Yes
Wait = No
Wait

=

No

Yes

A (Yes):
ACTIVEDATAPool = active-data_pool_name

Parameters
volume_name (Required)
Specifies the name of the primary storage pool volume to be restored. To
specify a list of volumes that belong to the same primary storage pool,
separate the names with commas and no intervening spaces.
COPYstgpool
Specifies the name of the copy storage pool from which the files are to be
restored. This parameter is optional. If you do not specify this parameter, files
are restored from any copy pool in which copies can be located. Do not use
this parameter with the ACTIVEDATAONLY or ACTIVEDATAPOOL
parameters.
ACTIVEDATAOnly
Specifies that active versions of backup files are to be restored from active-data
pools only. This parameter is optional. The default is NO. If this parameter is
not specified, files are restored from copy-storage pools. Do not use this
parameter with the COPYSTGPOOL parameter. Possible values are:
No
Specifies that the storage pool will not be restored from active-data pools.
Yes
Specifies that the storage pool will be restored from active-pool or pools
that you specify using the ACTIVEDATAPOOL parameter. If you specify
YES as a value for ACTIVEDATAONLY, but do not specify a value for
RESTORE VOLUME

946 IBM Tivoli Storage Manager for Windows: Administrators Reference
ACTIVEDATAPOOL, files are restored from any active-data pool in which
active versions of backup files can be located.
Attention: Restoring a volume from an active-data pool might cause some or
all inactive files to be deleted from the database if the server determines that
an inactive file needs to be replaced but cannot find it in the active-data pool.
ACTIVEDATAPool
Specifies the name of the active-data pool from which the active versions of
backup files are to be restored. This parameter is optional. If this parameter is
not specified, files are restored from any active-data pool in which active
versions of backup files can be located.
NEWstgpool
Specifies the name of the new storage pool to which to restore the files. This
parameter is optional. If you do not specify this parameter, files are restored to
the original primary storage pool.
MAXPRocess
Specifies the maximum number of parallel processes to use for restoring files.
Using parallel processes may improve throughput. This parameter is optional.
You can specify a value from 1 to 999. The default is 1.
When determining this value, consider the number of mount points (logical
drives) and physical drives that can be dedicated to this operation. To access a
sequential access volume, Tivoli Storage Manager uses a mount point, and, if
the device type is not FILE, a physical drive. The number of available mount
points and drives depends on other Tivoli Storage Manager and system
activity and on the mount limits of the device classes for the sequential access
storage pools that are involved in the restore.
Each process needs a mount point for copy storage pool volumes. If the device
type is not FILE, each process also needs a drive. If you are restoring a
sequential storage pool, each process needs an additional mount point for
primary storage pool volumes and, if the device type is not FILE, an additional
drive. For example, suppose you specify a maximum of three processes to back
up a primary sequential storage pool to a copy storage pool of the same device
class. Each process requires two mount points and two drives. To run all three
processes, the device class must have a mount limit of at least 6, and at least 6
mount points and 6 drives must be available.
To preview a backup, only one process is used and no mount points or drives
are needed.
Preview
Specifies if you want to preview but not perform the restore. You can use this
option to identify the offsite volumes required to restore a storage pool. This
parameter is optional. The default is NO. Possible values are:
No
Specifies that you want to perform the restore operation.
Yes
Specifies that you want to preview the restore operation but restore the
data.
Note: If you preview a restore to see a list of offsite copy pool volumes to
be mounted, you should you change the access mode of the
identified volumes to UNAVAILABLE. This prevents reclamation
RESTORE VOLUME
Chapter 2. Administrative commands 947
and MOVE DATA processing for these volumes until they are
transported to the onsite location for use in restore processing.
The preview displays the following:
v The number of files and bytes to be restored, if the access mode of the
copy storage pool volumes is READWRITE or READONLY when the
restoration is performed.
v A list of copy storage pool volumes containing files to be restored. These
volumes must be mounted if you perform the restore.
v A list of volumes containing files that cannot be restored.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. This default is NO. Possible
values are:
No
Specifies that the server processes this command in the background.
You can continue with other tasks while the command is being processed.
Messages created from the background process are displayed either in the
activity log or the server console, depending on where messages are
logged.
To cancel a background process, use the CANCEL PROCESS command. If
you cancel this process, some files may have already been backed up prior
to the cancellation.
Yes
Specifies that the server processes this command in the foreground. The
operation must complete before you can continue with other tasks. The
server then displays the output messages to the administrative client when
the command completes.
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Restore files stored on volume PVOL2 in primary storage pool PRIMARY_POOL.
Command
restore volume pvol2
Restore files stored on volume VOL001 in primary pool PRIMARY_POOL from
active-data pool ADP1.
Command
restore volume vol001 activedataonly=yes activedatapool=adp1
Related commands
Table 292. Commands related to RESTORE VOLUME
Command Description
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
COPY ACTIVEDATA Copies active backup data.
RESTORE VOLUME

948 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 292. Commands related to RESTORE VOLUME (continued)
Command Description
CANCEL PROCESS Cancels a background server process.
QUERY PROCESS Displays information about background
processes.
RESTORE STGPOOL Restores files to a primary storage pool from
copy storage pools.

RESTORE VOLUME
Chapter 2. Administrative commands 949
REVOKE commands
Use the REVOKE command to revoke one or more privilege classes from an
administrator for Tivoli Storage Manager.
v REVOKE AUTHORITY (Remove administrator authority) on page 951
REVOKE commands

950 IBM Tivoli Storage Manager for Windows: Administrators Reference
REVOKE AUTHORITY (Remove administrator authority)
Use this command to revoke one or more privilege classes from an administrator.
You can also use this command to reduce:
v the number of policy domains to which a restricted policy administrator has
authority.
v the number of storage pools to which a restricted storage administrator has
authority.
If you use the REVOKE AUTHORITY command without the CLASSES,
DOMAINS, and STGPOOLS parameters, you will revoke all privileges for the
specified administrator.
At least one administrator must have system privilege; therefore, if the
administrator is the only one with system privilege, you cannot revoke the
authority.
Privilege class
To issue this command, you must have system privilege.
Syntax
REVoke AUTHority admin_name

,

(1)

CLasses

=

SYstem

Policy

STorage

Operator

Analyst

Node

A

,

(1)

DOmains

=

domain_name

,

(1)

STGpools

=

pool_name


A:
AUTHority = Access
AUTHority

=

Access

Owner

DOmains

=

domain_name

NOde

=

node_name


Notes:
1 If all these parameters are omitted, all administrator privileges will be
revoked for this administrator.
Parameters
admin_name (Required)
Specifies the name of the administrator whose administrative privilege is to be
revoked or reduced.
REVOKE AUTHORITY
Chapter 2. Administrative commands 951
CLasses
Specifies one or more administrative privilege classes to be revoked. You can
specify more than one class by separating each with a comma.
SYstem
Indicates that system authority is to be revoked for this administrator. If
CLASSES=SYSTEM is specified, no other classes can be specified, and the
DOMAINS and STGPOOLS parameters cannot be specified.
Policy
Indicates that policy privilege is to be revoked for this administrator. To
revoke all policy privilege, specify CLASSES=POLICY and do not specify
the DOMAINS parameter.
STorage
Indicates that storage privilege is to be revoked for this administrator. To
revoke all storage privilege, specify CLASSES=STORAGE and do not
specify the STGPOOLS parameter.
Operator
Indicates that operator privilege is to be revoked for this administrator.
Analyst
Indicates that analyst privilege is to be revoked for this administrator.
Node
Indicates that node privilege is to be revoked for this user.
AUTHority
Indicates the authority level to revoke for a user with node privilege.
This parameter is optional.
If an administrator already has system or policy privilege to the policy
domain to which the node belongs, this command will not change the
administrators privilege. Possible authority levels are:
Access
Indicates that client access authority is revoked. This is the default
when CLASSES=NODE is specified.
Note: A client node can set the REVOKEREMOTEACCESS option
to prevent access by a user with node privilege and client
access authority. If a user with node privilege has client
owner authority, or has system or policy privileges to the
policy domain to which the node belongs, that administrator
can still access the web backup-archive client.
Owner
Indicates that client owner authority is revoked.
DOmains
Indicates that you want to revoke an administrators client access or
client owner authority to all clients in the specified policy domain. This
parameter cannot be used together with the NODE parameter.
NOde
Indicates that you want to revoke an administrators client access or
client owner authority to the node. This parameter cannot be used
together with the DOMAIN parameter.
DOmains
Specifies a list of policy domains that can no longer be managed by a restricted
REVOKE AUTHORITY

952 IBM Tivoli Storage Manager for Windows: Administrators Reference
policy administrator. (The administrator had been authorized to manage these
domains until the REVOKE command was issued.) This parameter is optional.
The items in the list are separated by commas, with no intervening spaces. You
can use wildcard characters to specify a name. Authority for all matching
domains will be revoked. If DOMAINS is specified, the parameter
CLASSES=POLICY is optional.
STGpools
Specifies a list of storage pools that can no longer be managed by a restricted
policy administrator. (The administrator had been authorized to manage these
storage pools until the REVOKE command was issued.) This parameter is
optional. The items in the list are separated by commas, with no intervening
spaces. You can use wildcard characters to specify a name. Authority for all
matching storage pools will be revoked. If STGPOOLS is specified then the
parameter CLASSES=STORAGE is optional.
Usage notes
1. To change an unrestricted storage administrator to a restricted storage
administrator, you must first use this command to revoke the unrestricted
privilege. Then, use the GRANT AUTHORITY command to grant the
administrator restricted storage privilege and to identify the storage pools to
which the administrator has authority.
To revoke unrestricted storage privilege from an administrator, specify the
CLASSES=STORAGE parameter. You cannot use the STGPOOLS parameter to
revoke authority for selected storage pools from an unrestricted storage
administrator.
2. To change an unrestricted policy administrator to a restricted policy
administrator, you must first use this command to revoke the unrestricted
privilege. Then, use the GRANT AUTHORITY command to grant the
administrator restricted policy privilege and to identify the policy domains to
which the administrator has authority.
To revoke unrestricted policy privilege from an administrator, specify the
CLASSES=POLICY parameter. You cannot use the DOMAINS parameter to
revoke authority for selected domains from an unrestricted administrator.
Examples
Task 1
Revoke part of administrator CLAUDIAs privileges. CLAUDIA has restricted
policy privilege for the policy domains EMPLOYEE_RECORDS and PROG1.
Restrict CLAUDIAs policy privilege to the EMPLOYEE_RECORDS policy domain.
Command
revoke authority claudia classes=policy
domains=employee_records
Task 2
Administrator LARRY currently has operator, analyst, and restricted policy
privilege. Revoke all administrative privileges for administrator LARRY. To revoke
all administrative privileges for an administrator, identify the administrator, but do
not specify CLASSES, DOMAINS, or STGPOOLS. LARRY remains an administrator
but he can only use those commands that can be issued by any administrator.
REVOKE AUTHORITY
Chapter 2. Administrative commands 953
Command
revoke authority larry
Task 3
Help desk personnel user CONNIE currently has node privilege with client owner
authority for client node WARD3. Revoke her node privilege with client owner
authority.
Command
revoke authority connie classes=node
authority=owner node=ward3
Related commands
Table 293. Commands related to REVOKE AUTHORITY
Command Description
GRANT AUTHORITY Assigns privilege classes to an administrator.
QUERY ADMIN Displays information about one or more IBM
Tivoli Storage Manager administrators.

REVOKE AUTHORITY

954 IBM Tivoli Storage Manager for Windows: Administrators Reference
REVOKE PROXYNODE (Revoke proxy authority for a client
node)
Use this command to revoke authority for an agent client node to perform backup
and restore operations for a target node on the Tivoli Storage Manager server.
Privilege class
To perform this task, you must have one of the following privilege classes:
v System privilege
v Unrestricted policy privilege
Syntax
REVoke PROXynode TArget = target_node_name AGent = agent_node_name

Parameters
TArget (Required)
Specifies the target node to which an agent node has been granted proxy
authority. Wildcard characters and comma-separated lists of node names are
allowed.
AGent (Required)
Specifies which node has authority to act as proxy to the target node. Wildcard
characters and comma-separated lists of node names are allowed.
Examples
Task
To revoke authority from target node NASCLUSTER to act as proxy for all agent
nodes which start with the letter M, use the following command.
Command
revoke proxynode target=nascluster agent=m*
Related commands
Table 294. Commands related to REVOKE PROXYNODE
Command Description
GRANT PROXYNODE Grant proxy authority to an agent node.
QUERY PROXYNODE Display nodes with authority to act as proxy
nodes.

REVOKE PROXYNODE
Chapter 2. Administrative commands 955
ROLLBACK (Rollback uncommitted changes in a macro)
Use this command within a macro to undo any processing changes made by
commands executed by the server but not yet committed to the database. A
committed change is permanent and cannot be rolled back. The ROLLBACK
command is useful for testing macros.
Ensure that your administrative client session is not running with the
ITEMCOMMIT option when using this command.
Note: SETOPT commands inside a macro cannot be rolled back.
Privilege class
Any administrator can issue this command.
Syntax
ROLLBACK

Parameters
None.
Examples
Task
Run the REGN macro with the ROLLBACK command to verify that the macro
works without committing any changes.
Macro Contents:
/* Macro to register policy
administrators and grant authority */
REGister Admin sara hobby
GRant AUTHority sara CLasses=Policy
REGister Admin ken plane
GRant AUTHority ken CLasses=Policy
ROLLBACK /* prevents any changes from being committed */
Command
macro regn
Related commands
Table 295. Commands related to ROLLBACK
Command Description
COMMIT Makes changes to the database permanent.
MACRO Runs a specified macro file.

ROLLBACK

956 IBM Tivoli Storage Manager for Windows: Administrators Reference
RUN (Run a Tivoli Storage Manager script)
Use this command to run a Tivoli Storage Manager script. To issue this command
on another server, the script being run must be defined on that server.
You can include RUN commands in scripts as long as they do not create loops. For
example, you should avoid including RUN commands where SCRIPT_A runs
SCRIPT_B and SCRIPT_B runs SCRIPT_A.
Note: There is no Tivoli Storage Manager command that can cancel a script after it
starts. To stop a script, an administrator must halt the server.
Privilege class
To issue this command, you must have operator, policy, system, storage, or system
privilege.
Syntax

RUn

script_name

,

substitution_value
Preview = No
Preview

=

No

Yes

Verbose = No
Verbose

=

No

Yes

Parameters
script_name (Required)
Specifies the name of the script you want processed. The name you specify
cannot be a substitution variable, such as $1.
substitution_value
Specifies one or more values to substitute for variables when the script is run.
In a script, a substitution variable consists of a $ character, followed by a
number. When you run the script, Tivoli Storage Manager replaces the
substitution variables defined in a script with the values you supply with this
command. You must specify values for each substitution variable defined in
the script or the script will fail. This parameter is optional.
Preview
Specifies whether to preview the command lines of a script without actually
processing the script. The default is NO.
Possible values are:
Yes
Specifies that the command lines included in a script are displayed, but the
script is not processed.
No
Specifies that the command lines included in a script are displayed and the
script is processed.
RUN
Chapter 2. Administrative commands 957
Verbose
Specifies whether command lines, variable substitution, and conditional logic
testing used in a script are displayed as the script is being processed. This
parameter is ignored if PREVIEW=YES is specified. The default is NO.
Possible values are:
Yes
Specifies that the command lines, variable substitution, and conditional
logic testing are displayed as the script is being processed.
No
Specifies that the command lines, variable substitution, and conditional
logic testing do not display as the script is being processed.
Examples
Task 1
Assume that you have defined a script called QSAMPLE to include the following
lines:
001 /* This is a sample SQL Query in wide format */
005 SET SQLDISPLAYMODE WIDE
010 SELECT colname FROM -
015 COLUMNS WHERE TABNAME=$1
Preview the commands in the QSAMPLE script before running the script. Specify
ACTLOG as the value for the substitution variable, $1.
Command
run qsample actlog preview=yes
Output
ANR1461I RUN: Executing command script QSAMPLE.
ANR1466I RUN: Command script QSAMPLE, Line 5 :
set sqldisplaymode wide.
ANR1466I RUN: Command script QSAMPLE, Line 15 :
select colname from columns where tabname=ACTLOG.
ANR1470I RUN: Command script QSAMPLE completed successfully
(PREVIEW mode)

Task 2
Run the script to display column names for the ACTLOG table.
Command
run qsample actlog verbose=yes
Output
RUN

958 IBM Tivoli Storage Manager for Windows: Administrators Reference
ANR1461I RUN: Executing command script QSAMPLE.
ANR1466I RUN: Command script QSAMPLE, Line 5 :
set sqldisplaymode wide.
ANR1466I RUN: Command script QSAMPLE, Line 5 : RC=RC_OK
ANR1466I RUN: Command script QSAMPLE, Line 15 :
select colname from columns where tabname=ACTLOG.

COLNAME
------------------
DATE_TIME
MSGNO
SEVERITY
MESSAGE
ORIGINATOR
NODENAME
OWNERNAME
SCHEDNAME
DOMAINNAME
SESSID

ANR1462I RUN: Command script QSAMPLE, Line 15 : RC=RC_OK
ANR1462I RUN: Command script QSAMPLE completed successfully.

Run the same command without displaying the individual command lines.
Command
run qsample actlog verbose=no
Output
COLNAME
------------------
DATE_TIME
MSGNO
SEVERITY
MESSAGE
ORIGINATOR
NODENAME
OWNERNAME
SCHEDNAME
DOMAINNAME
SESSID

ANR1462I RUN: Command script QSAMPLE completed successfully.

Related commands
Table 296. Commands related to RUN
Command Description
COPY SCRIPT Creates a copy of a script.
DEFINE SCRIPT Defines a script to the IBM Tivoli Storage
Manager server.
DELETE SCRIPT Deletes the script or individual lines from the
script.
QUERY SCRIPT Displays information about scripts.
RENAME SCRIPT Renames a script to a new name.
UPDATE SCRIPT Changes or adds lines to a script.

RUN
Chapter 2. Administrative commands 959
SELECT (Perform an SQL query of the IBM Tivoli Storage Manager
Database)
Use this command to create and format a customized query of the IBM Tivoli
Storage Manager database. On IBM Tivoli Storage Manager, this command uses a
subset of the SQL92 and SQL93 standards.
The SELECT command is consistent with most relational database access products,
such as LOTUS 1-2-3

and Microsoft Access. It presents server information in the
form of relational tables containing rows (records) and columns (fields).
To help you find what information is available, IBM Tivoli Storage Manager
provides three system catalog tables:
SYSCAT.TABLES
Contains information about all tables that can be queried with the SELECT
command.
SYSCAT.COLUMNS
Describes the columns in each table.
SYSCAT.ENUMTYPES
Defines the valid values for each type and the ordering of those values for
columns that have an enumerated data type (SQL93).
You can issue the SELECT command to query these tables to determine the
location of the information that you want.
Usage notes
You cannot issue the SELECT command from a server console.
To stop the processing of a SELECT command after it starts, cancel the
administrative session from which the command was issued. Cancel the session
from either the server console or another administrative session.
Privilege class
Any administrator can issue this command.
Syntax

SELECT

,
value_expression

aggregate_function

AS

column_name

,
FROM

table_name

WHERE

predicate

SELECT

960 IBM Tivoli Storage Manager for Windows: Administrators Reference

GROUP BY

.

column_name

table_name

HAVING

predicate

,

ORDER BY

output_column

ASC

DESC

,

positive_integer

ASC

DESC


Parameters
value_expression or aggregate_function (Required)
Specifies the columns to be returned. Valid values are:
value_expression
Specifies the set of source columns to be returned. In the simplest form,
this is a list of the columns specified in the FROM clause. In a more
advanced form, it can include DISTINCT, CAST, or CASE expressions or
subqueries.
aggregate_function
Specifies a function that extracts a single value from groups of column
names. For example, AVG, COUNT, MAX, or SUM.
AS column_name
Specifies the column title to display. The default is to display the value
expression or aggregate function. The default column name for expressions is
UNNAMED(N).
FROM (Required)
Specifies where to find data in the database. The only valid value is:
table_name
Specifies one or more source tables from which to extract the query rows
and columns. You can find these names by querying SYSCAT.TABLES. If
you specify two or more tables, you are requesting a JOIN of the tables.
You can specify the columns for the JOIN criteria in the WHERE
parameter. Or the tables can be joined by matching every row from one
table to every row from another table.
WHERE predicate
Specifies that only certain rows are displayed based on criteria in the predicate.
This is an optional parameter. You can use the AND, OR, and NOT operators
to string predicates together.
GROUP BY column_name
Specifies groups of rows to be formed if aggregate functions (for example,
AVG, COUNT, MAX, SUM) are specified. This is an optional parameter.
SELECT
Chapter 2. Administrative commands 961
|
|
|
|
|
|
|
|
|
HAVING predicate
Specifies a condition to be used to filter the extracted values before displaying
them. This is an optional parameter.
ORDER BY
Specifies how output sorts for display. You can specify column names or
numeric positions and whether you want the sort in ascending or descending
order. This is an optional parameter. Valid values are:
output_column
Specifies order by column. The columns are sorted according to the order
in which they are specified.
positive_integer
Specifies order by the numeric position of the columns. The columns are
sorted according to the order in which they are specified.
ASC
Specifies that the columns are sorted in ascending order.
DSC
Specifies that the columns are sorted in descending order.
The SELECT command supports the following expressions, clauses, functions, and
predicates:

Clauses, expressions, functions and predicates supported by the SELECT command:
ALL
ANY
AVG
AS
BETWEEN
CASE
CAST
COUNT
CURRENT_DATE
CURRENT_TIME
CURRENT_TIMESTAMP
CURRENT_USER
DISTINCT
EXISTS
EXTRACT
FROM
GROUP BY
HAVING
IN
JOIN
LIKE
MAX
MIN
MOD
NULL
ORDER BY
POSITION
SOME
SUBSTRING
SUM
TRIM
WHERE

Examples
The SELECT command lets you customize a wide variety of queries. To give you
an idea of what you can do with the command, this section includes many
examples. There are, however, many more possibilities.
Note: Query output is shown only for the more complex commands to illustrate
formatting.
v Get a list of all the tables available for querying the IBM Tivoli Storage Manager
database.
Command
select * from syscat.tables
Output (shows partial output)
SELECT

962 IBM Tivoli Storage Manager for Windows: Administrators Reference
TABSCHEMA: SERVER1
TABNAME: ACTLOG
CREATE_TIME: 1999-05-01 07:39:06
COLCOUNT: 10
INDEX_COLCOUNT: 1
UNIQUE_INDEX: FALSE
REMARKS: Server activity log

TABSCHEMA: SERVER1
TABNAME: ADMIN_SCHEDULES
CREATE_TIME: 1995-05-01 07:39:06
COLCOUNT: 14
INDEX_COLCOUNT: 1
UNIQUE_INDEX: TRUE
REMARKS: Administrative command schedules

TABSCHEMA: SERVER1
TABNAME: ADMINS
CREATE_TIME: 1995-05-01 07:39:06
COLCOUNT: 15
INDEX_COLCOUNT: 1
UNIQUE_INDEX: TRUE
REMARKS: Server administrators

TABSCHEMA: SERVER1
TABNAME: ARCHIVES
CREATE_TIME: 1995-05-01 07:39:06
COLCOUNT: 10
INDEX_COLCOUNT: 5
UNIQUE_INDEX: FALSE
REMARKS: Client archive files

v Which client nodes and administrative clients are currently locked from server
access?
Command
select node_name from nodes where locked=YES

select admin_name from admins where locked=YES
v Which client nodes and administrative clients have not specified the correct
password lately?
Command
select node_name from nodes where invalid_pw_count <>0

select admin_name from admins where invalid_pw_count <>0
v Which nodes in the standard policy domain are not associated with the daily
backup schedule DAILYBACKUP?
Command
select node_name from nodes where domain_name=STANDARD and
node_name not in (select node_name from associations
where domain_name=STANDARD and
schedule_name=DAILYBACKUP)
v Which administrators have policy authority?
Command
select admin_name from admins where
upper(system_priv) <>NO
or upper(policy_priv) <>NO
v What messages of type E (ERROR) or W (WARNING) have been issued in the
time period for which activity log records have been maintained?
Command
SELECT
Chapter 2. Administrative commands 963
select date_time,msgno,message from actlog
where severity=E or severity=W
v Which administrative schedules have been defined or altered by administrator
JAKE?
Command
select schedule_name from admin_schedules
where chg_admin=JAKE
v What are the relative administrative schedule priorities?
Command
select schedule_name,priority from admin_schedules order
by priority
v Which management classes have an archive copy group with a retention period
greater than 365 days?
Command
select domain_name,set_name,class_name from ar_copygroups
where retver=NOLIMIT or cast(retver as integer) >365
v Which management classes specify more than 5 backup versions?
Command
select domain_name,set_name,class_name from bu_copygroups
where verexists =NOLIMIT or
cast(verexists as integer)>5
v Which client nodes are using the client option set named SECURE?
Command
select node_name from nodes where option_set=SECURE
v How many client nodes are in each policy domain?
Command
select domain_name,num_nodes from domains
v How many files have been archived from each node?
Attention: This command could take a long time to complete.
Command
select node_name,count(*) from archives
group by node_name
v Which clients are using space management?
Command
select node_name from auditocc where spacemg_mb <>0
v If the reclamation threshold were to be changed to 50 percent for storage pool
TAPE, how many volumes would be reclaimed?
Command
select count(*) from volumes where stgpool_name=TAPE
and upper(status)=FULL and pct_utilized < 50
v If the DAILY management class in the STANDARD policy domain is changed or
deleted, how many backup files would be affected for each node?
Note: This command will take significant time and resource to complete.
Command
SELECT

964 IBM Tivoli Storage Manager for Windows: Administrators Reference
select node_name, count(*) as "Files" from backups
where class_name=DAILY and node_name in
(select node_name from nodes where domain_name=STANDARD)
group by node_name
v For all active client sessions, determine how long have they been connected and
their effective throughput in bytes per second:
Command:
select session_id as "Session",
client_name as "Client",
state as "State",
current_timestamp-start_time as "Elapsed Time",
(cast(bytes_sent as decimal(18,0)) /
cast((current_timestamp-start_time)seconds as decimal(18,0)))
as "Bytes sent/second",
(cast(bytes_received as decimal(18,0)) /
cast((current_timestamp-start_time)seconds as decimal(18,0)))
as "Bytes received/second"
from sessions
Output:
Session: 24
Client: ALBERT
State: Run
Elapsed Time: 0 01:14:05.000000
Bytes sent/second: 564321.9302768451
Bytes received/second: 0.0026748857944

Session: 26
Client: MILTON
State: Run
Elapsed Time: 0 00:06:13.000000
Bytes sent/second: 1638.5284210992221
Bytes received/second: 675821.6888561849

v How long have the current background processes been running and what is
their effective throughput in time and files per second?
Command
select process_num as "Number",
process,
current_timestamp-start_time as "Elapsed Time",
(cast(files_processed as decimal(18,0)) /
cast((current_timestamp-start_time)seconds as decimal(18,0)))
as "Files/second",
(cast(bytes_processed as decimal(18,0)) /
cast((current_timestamp-start_time)seconds as decimal(18,0)))
as "Bytes/second"
from processes
Output
Number: 1
PROCESS: Expiration
Elapsed Time: 0 00:24:36.000000
Files/second: 6.3216755870092
Bytes/second: 0.0000000000000
Note: Expiration does not report the number of bytes processed.
v How many client nodes are there for each platform type?
Command
select platform_name,count(*) as "Number of Nodes"
from nodes group by platform_name
SELECT
Chapter 2. Administrative commands 965
Output
PLATFORM_NAME Number of Nodes
------------- ---------------

AIX 6
SunOS 27
Win32 14
Linux 20

v How many filespaces does each client node have, listed in ascending order?
Command
select node_name, count(*) as "number of filespaces"
from filespaces group by node_name order by 2
Output
NODE_NAME number of filespaces
------------------ --------------------
ALBERT 2
MILTON 2
BARNEY 3
SEBASTIAN 3
MAILHOST 4
FALCON 4
WILBER 4
NEWTON 4
JEREMY 4
WATSON 5
RUSSELL 5
v Obtain statistical information for calculating the number of offsite volumes that
will have their space reclaimed during reclamation of a storage pool.
Command
select * from summary where activity=OFFSITE RECLAMATION
Output
START_TIME: 2004-06-16 13:47:31.000000
END_TIME: 2004-06-16 13:47:34.000000
ACTIVITY: OFFSITE RECLAMATION
NUMBER: 4
ENTITY: COPYPOOL
COMMMETH:
ADDRESS:
SCHEDULE_NAME:
EXAMINED: 170
AFFECTED: 170
FAILED: 0
BYTES: 17821251
IDLE: 0
MEDIAW: 0
PROCESSES: 2
SUCCESSFUL: YES
VOLUME_NAME:
DRIVE_NAME:
LIBRARY_NAME:
LAST_USE:
COMM_WAIT:
NUM_OFFSITE_VOLS: 2

v Obtain statistical information for all export operations.
Command
select * from export_operations
Output
SELECT

966 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
EXPORT IDENTIFIER: MyExportNode
STATUS: RUNNING
COMMAND: Export NODE m* filespace=c$
nametype=unicode
filedata=all toserver=-athens
START TIME: 2007-01-24 09:45:06.000000
PROCESS ID: 35
DATE AND TIME OF LAST RESTART: 2007-01-27 13:01:06.000000
PROCESSING DURATION (MINUTES): 120
TOTAL EXECUTION MINUTES: 457
TOTAL BYTES TRANSFERRED (MB): 7,000

v Obtain statistical information for the EXPORTNODE0001 export operation.
Command
select command from export_operations
where export_identifier=EXPORTNODE0001
Output
COMMAND_NAME: Export NODE m* filespace=c$
nametype=unicode filedata=all toserver=athens

v Obtain process identifier for export operations that are running.
Command
select process_id from export_operations where status=RUNNING
Output
PROCESS_ID
---------------------
35

Related commands
Table 297. Commands related to SELECT
Command Description
QUERY SQLSESSION Displays the current settings of the SQL
formatting commands.
SET SQLDATETIMEFORMAT Controls the formatting of date and time in
the display of SQL queries.
SET SQLDISPLAYMODE Controls the column width in the display of
SQL queries.
SET SQLMATHMODE Controls how decimal numbers are displayed
in SQL queries.


SELECT
Chapter 2. Administrative commands 967
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Effect of the SELECT command on server performance
Complex or long-running SELECT commands can affect the performance of the
Tivoli Storage Manager server.
If a SELECT command requires significant server time or resources, you will be
asked to confirm your request. If you need to do complex or long-running SELECT
commands that might affect the performance of the server, consider extracting the
data from the server database into a relational database. You can use the ODBC
driver supplied with Tivoli Storage Manager. See the Administrators Guide for
details about the driver.
SELECT

968 IBM Tivoli Storage Manager for Windows: Administrators Reference
Requirement for database space for the SELECT command
Because a SELECT command uses temporary table storage in the server database,
at least one 4MB partition must be available in the database.
Without this partition, temporary table storage will become exhausted and the
SELECT command will not run. Some conditions, such as the ORDER BY clause,
the GROUP BY clause, and the DISTINCT operator, may require additional
temporary table storage.
To find how much temporary table storage is available in your database, issue the
QUERY DB command and view the Maximum Reduction parameter. For more
details, see the section about exhausting temporary table storage in the chapter
about monitoring the server in the Administrators Guide.
SELECT
Chapter 2. Administrative commands 969
SQL parameters available
The following syntax diagram and parameter list include the more common
parameters of the SELECT command. Other parameters are available but are not
shown. See any standard SQL documentation.
The following parameters are not supported by the SELECT command in Tivoli
Storage Manager:
v UNION
v INTERSECT
v EXCEPT
v Correlated subqueries
Also, subqueries (SELECT statements) are not supported in a FROM clause but can
be used as predicates.
SELECT

970 IBM Tivoli Storage Manager for Windows: Administrators Reference
SERIAL (Control running of multiple commands in a script)
Use this command in a script to ensure that any preceding commands are
complete before proceeding and to ensure any following commands are run
serially.
When a script starts, all commands run serially until a PARALLEL command is
encountered.
Privilege class
Any administrator can issue this command.
Syntax
SERIAL

Parameters
None.
Examples
Task
Write a script named BACKUP to back up two storage pools simultaneously. When
both backups are complete, perform a snapshot database backup.
Script Contents
/* set up for running parallel commands */
PARALLEL
/* backup two storage pools simultaneously */
BACKUP STGPOOL PRIMPOOL1 COPYPOOL1 WAIT=YES
BACKUP STGPOOL PRIMPOOL2 COPYPOOL2 WAIT=YES
/* wait for all previous commands to finish and set up
running serial commands*/
SERIAL
/* start snapshot db backup */
BACKUP DB DEVCLASS=TAPE TYPE=DBSNAPSHOT WAIT=YES
Command
run backup
Related commands
Table 298. Commands related to SERIAL
Command Description
DEFINE SCRIPT Defines a script to the IBM Tivoli Storage
Manager server.
RUN Runs a script.
PARALLEL Run commands in a script parallel.

SERIAL
Chapter 2. Administrative commands 971
SET commands
Use the SET command to select or specify a value for a Tivoli Storage Manager
object.
The following is a list of SET commands for Tivoli Storage Manager:
v SET ACCOUNTING (Set accounting records on or off) on page 974
v SET ACTLOGRETENTION (Set the retention period or the size of the activity
log) on page 975
v SET ARCHIVERETENTIONPROTECTION (Activate data retention protection)
on page 977
v SET AUTHENTICATION (Set password authentication) on page 979
v SET CLIENTACTDURATION (Set the duration period for the client action) on
page 980
v SET CONFIGMANAGER (Specify a configuration manager) on page 981
v SET CONFIGREFRESH (Set managed server configuration refresh) on page
983
v SET CONTEXTMESSAGING (Set message context reporting on or off) on page
985
v SET CROSSDEFINE (Specifies whether to cross-define servers) on page 986
v SET DRMCHECKLABEL (Specify label checking) on page 987
v SET DRMCMDFILENAME (Specify the name of a file to contain commands)
on page 988
v SET DRMCOPYSTGPOOL (Specify the copy storage pools to be managed by
DRM) on page 989
v SET DRMCOURIERNAME (Specify the courier name) on page 990
v SET DRMDBBACKUPEXPIREDAYS (Criteria for DB backup series expiration)
on page 991
v SET DRMFILEPROCESS (Specify file processing) on page 993
v SET DRMINSTRPREFIX (Specify the prefix for recovery instructions file
names) on page 994
v SET DRMNOTMOUNTABLENAME (Specify the not mountable location
name) on page 996
v SET DRMPLANPREFIX (Specify a prefix for recovery plan file names) on page
997
v SET DRMPLANVPOSTFIX (Specify replacement volume names) on page 999
v SET DRMPRIMSTGPOOL (Specify the primary storage pools to be managed by
DRM) on page 1001
v SET DRMRPFEXPIREDAYS (Set criteria for recovery plan file expiration) on
page 1002
v SET DRMVAULTNAME (Specify the vault name) on page 1004
v SET EVENTRETENTION (Set the retention period for event records) on page
1005
v SET INVALIDPWLIMIT (Set the number of invalid logon attempts) on page
1007
v SET LICENSEAUDITPERIOD (Set license audit period) on page 1008
v SET LOGMODE (Set mode for saving recovery log records) on page 1009
v SET MAXCMDRETRIES (Set the maximum number of command retries) on
page 1011
SET commands

972 IBM Tivoli Storage Manager for Windows: Administrators Reference
v SET MAXSCHEDSESSIONS (Set maximum scheduled sessions) on page 1012
v SET MINPWLENGTH (Set minimum password length) on page 1013
v SET PASSEXP (Set password expiration date) on page 1014
v SET QUERYSCHEDPERIOD (Set query period for polling client nodes) on
page 1016
v SET RANDOMIZE (Set randomization of scheduled start times) on page 1017
v SET REGISTRATION (Set open or closed registration) on page 1019
v SET RETRYPERIOD (Set time between retry attempts) on page 1021
v SET SCHEDMODES (Select a central scheduling mode) on page 1022
v SET SERVERHLADDRESS (Set the high-level address of a server) on page
1024
v SET SERVERLLADDRESS (Set the low-level address of a server) on page 1025
v SET SERVERNAME (Specify the server name) on page 1026
v SET SERVERPASSWORD (Set password for server) on page 1028
v SET SQLDATETIMEFORMAT (Set the format for date, time, and time stamp for
SQL data) on page 1029
v SET SQLDISPLAYMODE (Set the display of SQL data types) on page 1031
v SET SQLMATHMODE (Set the mode for SQL arithmetic) on page 1032
v SET SUBFILE (Set subfile backup for client nodes) on page 1033
v SET SUMMARYRETENTION (Set days to keep data in activity summary
table) on page 1034
v SET TAPEALERTMSG (Set tape alert messages on or off) on page 1035
v SET TOCLOADRETENTION (Set load retention period for table of contents)
on page 1036
SET commands
Chapter 2. Administrative commands 973
SET ACCOUNTING (Set accounting records on or off)
Use this command to determine whether an accounting record is created every
time a client node session ends. An accounting record tracks the amount of storage
used by a client node session.
The accounting records are stored in an accounting file named dsmaccnt.log. A
registry entry controls the location of the accounting log. See the Administrators
Guide for more information on accounting.
Use the QUERY STATUS command to determine whether accounting records are
generated. At installation, this value is set to off.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set ACCounting ON
OFf


Parameters
ON
Specifies that the server creates an accounting record every time a client node
session ends.
OFf
Specifies that the server does not create accounting records.
Examples
Task
Create an accounting record at the end of each client node session.
Command
set accounting on
Related commands
Table 299. Commands related to SET ACCOUNTING
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

SET ACCOUNTING

974 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET ACTLOGRETENTION (Set the retention period or the size
of the activity log)
Use this command to manage the activity log records by date or size. The activity
log contains normal activity messages generated by the server. These messages
include information about server and client operations, such as the start time of
sessions or device I/O errors.
Activity log information includes messages, such as the following:
v Client session starts and ends
v Migration starts and ends
v Diagnostic error messages
v Scheduled administrative command output
You can choose to adjust the length of time that the activity log retains messages to
avoid insufficient or outdated data. The server automatically removes the messages
from the activity log after the retention period passes.
Alternatively, you can choose to limit the total size of the activity log to control the
amount of space occupied by the activity log. The server will periodically remove
the oldest activity log records until the activity log size no longer exceeds the
configured maximum size allowed.
You can issue the QUERY STATUS command to display the current number of
records in the activity log and the size (in MB) that the activity log currently
occupies.
Privilege class
To issue this command, you must have system privilege.
Syntax

Set ACTlogretention

number
Mgmtstyle = Date
Mgmtstyle

=

Date

Size

Parameters
number (Required)
Specifies the number of days to retain messages in the activity log when the
log is managed by date, or specifies the maximum size of the activity log when
it is managed by size. With retention-based management, a value of 1 specifies
to retain the activity log records only for the current day. With size-based
management, a value of 1 specifies a maximum size of 1 MB for the activity
log. You can specify a number from 0 to 9999. A value of 0 disables activity log
retention.
Mgmtstyle
Specifies whether activity log management is retention-based or size-based.
This parameter is optional. The default is DATE. Possible values are:
Date
Specifies that activity log management is retention-based.
SET ACTLOGRETENTION
Chapter 2. Administrative commands 975
Size
Specifies that activity log management is size-based.
Examples
Task
Set the server to retain activity log records for 30 days.
Command
set actlogretention 30
Task
Set the server to limit the size of the activity log to 300 MB.
Command
set actlogretention 300 mgmtstyle=size
Related commands
Table 300. Command related to SET ACTLOGRETENTION
Command Description
QUERY ACTLOG Displays messages from the server activity
log.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

SET ACTLOGRETENTION

976 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET ARCHIVERETENTIONPROTECTION (Activate data
retention protection)
Use this command to activate and deactivate archive data retention protection. The
server cannot contain any data in order for this command to work. At installation,
the value is set to OFF.
When archive data retention protection is active:
v Only archive copies can be stored on the server.
v No archive copy can be deleted until the RETVER parameter in the DEFINE
COPYGROUP (archive) command has been satisfied.
Defining storage pools of type RECLAMATIONTYPE=SNAPLOCK is only
supported on servers with data retention protection enabled.
Use the QUERY STATUS command to display the status of archive data retention
protection.
Privilege class
To issue this command you must have system privilege or unrestricted storage
privilege.
Syntax
Set ARCHIVERETENTIONPROTECTion OFf
ON


Parameters
OFf
Specifies that archive data retention protection is not active.
ON
Specifies the archive data retention protection is active.
Examples
Task
Activate archive data retention protection.
Command
set archiveretentionprotection on
Related commands
Table 301. Commands related to SET ARCHIVERETENTIONPROTECTION
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
AUDIT VOLUME Compares database and storage pool
information, and optionally, resolves any
inconsistencies.
SET ARCHIVERETENTIONPROTECTION
Chapter 2. Administrative commands 977
Table 301. Commands related to SET ARCHIVERETENTIONPROTECTION (continued)
Command Description
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
DELETE FILESPACE Deletes data associated with clients file
spaces.
QUERY COPYGROUP Displays the attributes of a copy group.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.

SET ARCHIVERETENTIONPROTECTION

978 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET AUTHENTICATION (Set password authentication)
Use this command to specify whether administrators and client nodes need a
password to access the server. The value is set to ON at installation.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set AUthentication ON
OFf


Parameters
ON
Specifies that administrators and client nodes need a password to access the
server.
OFf
Specifies that administrators and client nodes do not need a password to access
the server.
Examples
Task
Set authentication to ON to require administrators and client nodes to enter a
password when accessing the server.
Command
set authentication on
Related commands
Table 302. Command related to SET AUTHENTICATION
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

SET AUTHENTICATION
Chapter 2. Administrative commands 979
SET CLIENTACTDURATION (Set the duration period for the
client action)
Use this command to specify the duration for the schedule that was defined with
the DEFINE CLIENTACTION command. A client action defines a schedule that
runs one time on a client.
The program deletes these event records whether or not the client has processed
the schedule. However, the schedules are not deleted until after the first event
records are deleted. The retention period for events defaults to 10 days at
installation.
Privilege class
To issue this command, you must have system privilege.
Syntax
SET CLIENTACTDuration days

Parameters
days (Required)
Specifies the number of days during which the schedule for the client action is
active. You can specify an integer from 0 to 999. The default is 5 days.
The number of days you specify determines how long the database retains the
schedule before deletion. A value of 0 indicates that the schedule duration is
indefinite, and the schedule and associations are not deleted from the database.
Examples
Task
Specify that the schedule for the client action be active for 15 days.
Command
set clientactduration 15
Related commands
Table 303. Commands related to SET ClIENTACTDURATION
Command Description
DEFINE CLIENTACTION Defines a command to be performed at a
client node.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

SET CLIENTACTDURATION

980 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET CONFIGMANAGER (Specify a configuration manager)
Use this command to specify whether a server is a configuration manager. On a
configuration manager, you can define configuration profiles to which other
servers can subscribe.
You cannot designate a server as a configuration manager if the server subscribes
to one or more profiles on another configuration manager.
If a server is a configuration manager, you cannot change this designation until
you delete all profiles, including the default profile.
Issue the QUERY STATUS command to determine if a server is a configuration
manager. When a server is installed, it is not designated as a configuration
manager.
Privilege class
To issue this command, you must have system privilege.
Syntax

Set CONFIGManager
OFf
ON

Parameters
ON
Specifies that the server is a configuration manager.
When you designate a server as a configuration manager, IBM Tivoli Storage
Manager creates a default profile named DEFAULT_PROFILE and associates
with the profile all servers and server groups defined on the configuration
manager. You can modify or delete the default profile.
OFf
Specifies that the server is not a configuration manager.
Examples
Task
Designate a server as a configuration manager.
Command
set configmanager on
Related commands
Table 304. Commands related to SET CONFIGMANAGER
Command Description
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET CONFIGMANAGER
Chapter 2. Administrative commands 981
Table 304. Commands related to SET CONFIGMANAGER (continued)
Command Description
SET CONFIGREFRESH Specifies a time interval for managed servers
to contact configuration managers.

SET CONFIGMANAGER

982 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET CONFIGREFRESH (Set managed server configuration
refresh)
Use this command on a managed server to specify how often that server contacts
its configuration manager for updated configuration information.
To display the current setting, issue the QUERY STATUS command. At installation,
the interval is set to 60 minutes.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set CONFIGRefresh minutes

Parameters
minutes (Required)
Specifies the interval, in minutes, before a managed server contacts its
configuration manager for configuration updates. Specify an integer from 0 to
10000.
v If the value is greater than 0, the managed server immediately contacts the
configuration manager. The next contact occurs when the specified interval
is reached.
v If the value is 0, the managed server does not contact the configuration
manager.
This value is ignored if the server does not subscribe to at least one profile on
a configuration manager.
Examples
Task
Specify that a managed server contacts its configuration manager every 45
minutes.
Command
set configrefresh 45
Related commands
Table 305. Commands related to SET CONFIGREFRESH
Command Description
DEFINE PROFASSOCIATION Associates objects with a profile.
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
DELETE PROFASSOCIATION Deletes the association of an object with a
profile.
NOTIFY SUBSCRIBERS Notifies servers to refresh their configuration
information.
SET CONFIGREFRESH
Chapter 2. Administrative commands 983
Table 305. Commands related to SET CONFIGREFRESH (continued)
Command Description
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UPDATE PROFILE Changes the description of a profile.

SET CONFIGREFRESH

984 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET CONTEXTMESSAGING (Set message context reporting on
or off)
Use this command to get additional information when ANR9999D messages occur.
Tivoli Storage Manager polls the server components for information that includes
process name, thread name, session ID, transaction data, locks that are held, and
database tables that are in use.
Note: When consecutive messages are issued from the same code area by the same
thread, only the first of these messages will report the context information.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set CONTEXTmessaging ON
OFf


Parameters
ON
Specifies to enable message context reporting.
OFf
Specifies to disable message context reporting.
Examples
Task
Turn on context messaging to receive additional information that could help
determine the cause of ANR9999D messages.
Command
set contextmessaging on
Related commands
Table 306. Commands related to SET CONTEXTMESSAGING
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

SET CONTEXTMESSAGING
Chapter 2. Administrative commands 985
SET CROSSDEFINE (Specifies whether to cross-define
servers)
Use this command to specify whether a server is automatically defined to another
server.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set CROSSDefine ON
OFf


Parameters
ON
Specifies that a server may be cross-defined to another server. To automatically
define one server to another, you must also permit cross defining in the server
definition.
OFf
Specifies that a server may not be cross-defined to another server.
Examples
Task
Set crossdefine to allow a server to be cross-defined to another server.
Command
set crossdefine on
Related commands
Table 307. Command related to SET CROSSDEFINE
Command Description
DEFINE SERVER Defines a server for server-to-server
communications.
SET SERVERHLADDRESS Specifies the high-level address of a server.
SET SERVERLLADDRESS Specifies the low-level address of a server.
SET SERVERPASSWORD Specifies the server password.

SET CROSSDEFINE

986 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET DRMCHECKLABEL (Specify label checking)
Use this command to specify whether Tivoli Storage Manager reads the labels of
sequential media checked out by the MOVE DRMEDIA command. At installation,
the value of the DRMCHECKLABEL is set to YES.
Use the QUERY DRMSTATUS command to check the current setting.
Privilege class
To issue this command, you must have system privilege.
Syntax

Set DRMCHECKLabel
Yes
Yes

No

Parameters
Yes
Specifies that Tivoli Storage Manager reads the labels of sequential media
checked out by the MOVE DRMEDIA command.
No
Specifies that Tivoli Storage Manager does not read the labels of sequential
media checked out by the MOVE DRMEDIA command.
Examples
Task
Specify that Tivoli Storage Manager does not perform label checking.
Command
set drmchecklabel no
Related commands
Table 308. Commands related to SET DRMCHECKLABEL
Command Description
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY DRMSTATUS Displays DRM system parameters.

SET DRMCHECKLABEL
Chapter 2. Administrative commands 987
SET DRMCMDFILENAME (Specify the name of a file to contain
commands)
Use this command to name a file that can contain the commands created when the
MOVE DRMEDIA or QUERY DRMEDIA commands are issued. If the SET
DRMCMDFILENAME is not issued, the MOVE DRMEDIA or QUERY DRMEDIA
command generates a file name.
Use the QUERY DRMSTATUS command to display the current command file
name.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set DRMCMDFilename file_name

Parameters
file_name (Required)
Specifies a full path name for a file to contain the commands created by the
MOVE DRMEDIA or QUERY DRMEDIA command. The file name can be up to
259 characters.
Note: If a file of the same name already exists, MOVE DRMEDIA or QUERY
DRMEDIA command tries to use it, and the existing data is overwritten.
Examples
Task
Specify a file name of c:\drm\orm\exec.cmd.
Command
set drmcmdfilename c:\drm\orm\exec.cmd
Related commands
Table 309. Commands related to SET DRMCMDFILENAME
Command Description
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY DRMSTATUS Displays DRM system parameters.

SET DRMCMDFILENAME

988 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET DRMCOPYSTGPOOL (Specify the copy storage pools to
be managed by DRM)
Use this command to specify names of the copy storage pools to be recovered after
a disaster. Tivoli Storage Manager uses these names if the PREPARE command
does not include the COPYSTGPOOL parameter.
If the MOVE DRMEDIA or QUERY DRMEDIA command does not include the
COPYSTGPOOL parameter, the command processes the volumes in the
MOUNTABLE state that are in the copy storage pool named by the SET
DRMCOPYSTGPOOL command. At installation, all copy storage pools are eligible
for DRM processing.
Use the QUERY DRMSTATUS command to display the current settings.
Privilege class
To issue this command, you must have system privilege.
Syntax

Set DRMCOPYstgpool

,
copy_pool_name

Parameters
copy_pool_name (Required)
Specifies the copy storage pool names. Separate multiple names with commas
and no intervening spaces. You can use wildcard characters. The specified
names replace any previous setting. If you enter a null string(), all current
names are removed, and all copy storage pools are eligible for processing.
Examples
Task
Set COPYSTGPOOL1 as the eligible copy storage pool.
Command
set drmcopystgpool copystgpool1
Related commands
Table 310. Commands related to SET DRMCOPYSTGPOOL
Command Description
MOVE DRMEDIA Moves DRM media onsite and offsite.
PREPARE Creates a recovery plan file.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY DRMSTATUS Displays DRM system parameters.
SET DRMPRIMSTGPOOL Specifies that primary storage pools are
managed by DRM.

SET DRMCOPYSTGPOOL
Chapter 2. Administrative commands 989
SET DRMCOURIERNAME (Specify the courier name)
Use this command to specify the courier name. At installation, this name is set to
COURIER. The MOVE DRMEDIA command uses the courier name to set the
location of volumes that are moving to the COURIER state.
You can use the QUERY DRMSTATUS to see the name of the courier.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set DRMCOUriername courier_name

Parameters
courier_name (Required)
Specifies the name of the courier. The name can be up to 255 characters.
Enclose the name in quotation marks if it contains any blank characters.
Examples
Task
Set the name of the courier to Joes Courier Service.
Command
set drmcouriername "Joes Courier Service"
Related commands
Table 311. Commands related to SET DRMCOURIERNAME
Command Description
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY DRMSTATUS Displays DRM system parameters.

SET DRMCOURIERNAME

990 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET DRMDBBACKUPEXPIREDAYS (Criteria for DB backup
series expiration)
Use this command to specify when a database backup series is eligible to be
expired.
The value set by this command applies to both a snapshot and a full plus
incremental database backup series. Any type of database backup series is eligible
for expiration if all of the following are true:
v The age of the last volume of the series has exceeded the expiration value set by
this command.
v For volumes that are not virtual volumes, all volumes in the series are in the
VAULT state.
v The volume is not part of the most recent database backup series.
Note: The most recent backup series of either type is not deleted.
See the MOVE DRMEDIA command for more information on the expiration of
database backup volumes that are not virtual volumes. See the EXPIRE
INVENTORY command for more information on expiration of database backup
volumes that are virtual volumes.
Use the QUERY DRMSTATUS to see the number of days specified.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set DRMDBBackupexpiredays days

Parameters
days (Required)
Specifies the number of days that must elapse since a database series was
created before it is eligible to be expired. The number of days must match the
volume reuse delay period for copy storage pools managed by disaster
recovery manager. Specify an integer from 0 to 9999.
Examples
Task
Set the database backup series expiration value to 60.
Command
set drmdbbackupexpiredays 60
Related commands
Table 312. Commands related to SET DRMDBBACKUPEXPIREDAYS
Command Description
DSMSERV RESTORE DB Restores an IBM Tivoli Storage Manager
database or database volume.
SET DRMDBBACKUPEXPIREDAYS
Chapter 2. Administrative commands 991
Table 312. Commands related to SET DRMDBBACKUPEXPIREDAYS (continued)
Command Description
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY DRMSTATUS Displays DRM system parameters.
QUERY VOLHISTORY Displays sequential volume history
information that has been collected by the
server.

SET DRMDBBACKUPEXPIREDAYS

992 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET DRMFILEPROCESS (Specify file processing)
Use this command to specify if the MOVE DRMEDIA or QUERY DRMEDIA
command should process database backup volumes and copy storage pool
volumes that are associated with a FILE device class. At installation, the value is
set to NO. Use the QUERY DRMSTATUS to determine the current setting.
Privilege class
To issue this command, you must have system privilege.
Syntax

Set DRMFILEProcess
No
No

Yes

Parameters
No
Specifies that the MOVE DRMEDIA and QUERY DRMEDIA commands does
not process database backup and copy storage pool volumes that are
associated with a FILE device class. This is the default.
Yes
Specifies that the MOVE DRMEDIA and QUERY DRMEDIA commands
process database backup and copy storage pool volumes that are associated
with a FILE device class.
Examples
Task
Set the file processing value to no.
Command
set drmfileprocess no
Related commands
Table 313. Commands related to SET DRMFILEPROCESS
Command Description
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY DRMSTATUS Displays DRM system parameters.

SET DRMFILEPROCESS
Chapter 2. Administrative commands 993
SET DRMINSTRPREFIX (Specify the prefix for recovery
instructions file names)
Use this command to specify a prefix to the recovery instructions file name. If you
issue this command, IBM Tivoli Storage Manager uses the specified prefix if the
PREPARE command is issued without the INSTRPREFIX parameter.
Use the QUERY DRMSTATUS command to display the current value for the prefix.
If no prefix is set, the prefix is set to the directory representing this instance of the
server, which is typically the directory that the server was originally installed from.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set DRMINSTRPrefix prefix

Parameters
prefix (Required)
Specifies a path name prefix for the files that contain the recovery instructions.
When processing the PREPARE command, Tivoli Storage Manager appends the
name of the appropriate recovery plan file stanza to find the file. The
maximum length is 200 characters.
The prefix can be one of the following:
v Directory path: End the prefix with a backslash (\). For example:
c:\adsmsrv\recinstr\
For the RECOVERY.INSTRUCTIONS.GENERAL file, the resulting file name
would be:
c:\adsmsrv\recinstr\RECOVERY.INSTRUCTIONS.GENERAL
v Directory path followed by a string: Tivoli Storage Manager treats the
string as part of the file name. For example:
c:\adsmsrv\recinstr\accounts
For the RECOVERY.INSTRUCTIONS.GENERAL file, the resulting file name
would be:
c:\adsmsrv\recinstr\accounts.RECOVERY.INSTRUCTIONS.GENERAL
v String only: Tivoli Storage Manager specifies the directory path and
appends the appropriate recovery plan file stanza name. The directory path
is the directory representing this instance of the Tivoli Storage Manager
server (typically the original Tivoli Storage Manager server installation
directory). For example, the directory representing this instance of the server
is c:\Program Files\Tivoli\TSM;\server2, and you spcify the following prefix:
shipping
The resulting recovery plan file name is:
c:\Program Files\Tivoli\TSM;\server2\shipping.19971115.051421
SET DRMINSTRPREFIX

994 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task
Specify reading the recovery plan instructions from directory c:\win32app\ibm\
adsm\server2\.
Command
set drminstrprefix c:\win32app\ibm\adsm\server2\
Related commands
Table 314. Commands related to SET DRMINSTRPREFIX
Command Description
PREPARE Creates a recovery plan file.
QUERY DRMSTATUS Displays DRM system parameters.

SET DRMINSTRPREFIX
Chapter 2. Administrative commands 995
SET DRMNOTMOUNTABLENAME (Specify the not mountable
location name)
Use this command to specify the name of the onsite location for storing the media.
At installation, the name is set to NOTMOUNTABLE. Use the QUERY
DRMSTATUS to see the location name.
The location name is used by the MOVE DRMEDIA command to set the location
of volumes that are moving to the NOTMOUNTABLE state.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set DRMNOTMOuntablename location

Parameters
location (Required)
Specifies the name of the onsite location for storing the media. The name can
be up to 255 characters. Enclose the name in quotation marks if it contains any
blank characters.
Examples
Task
Set the name of the location to room123/31.
Command
set drmnotmountablename "room 123/31"
Related commands
Table 315. Commands related to SET DRMNOTMOUNTABLENAME
Command Description
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY DRMSTATUS Displays DRM system parameters.

SET DRMNOTMOUNTABLENAME

996 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET DRMPLANPREFIX (Specify a prefix for recovery plan file
names)
Use this command to specify a prefix for a recovery plan file name. If you issue
this command, Tivoli Storage Manager uses the specified prefix if the PREPARE
command does not include the PLANPREFIX parameter.
Use the QUERY DRMSTATUS command to display the current value for the
recovery plan prefix.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set DRMPLANPrefix prefix

Parameters
prefix (Required)
Specifies a prefix for the path name used to generate the recovery plan file
name. The prefix can be up to 200 characters. Tivoli Storage Manager uses the
prefix if the PREPARE command is issued without the PLANPREFIX
parameter. Tivoli Storage Manager builds a unique recovery plan file name by
appending to the prefix the date and time format: yyyymmdd.hhmmss (for
example, 19951115.051421). If you enter a null string (), the current prefix is
removed, and the server uses the algorithm described in the PLANPREFIX
parameter in the PREPARE command.
For the prefix, you can specify:
1. A directory path
2. A directory path followed by a string
3. A string
The following describes the rules for possible prefix specifications:
1. To specify a directory path for the prefix, end the prefix with a backslash
(\). Tivoli Storage Manager appends to the prefix the date and time
information using the yyyymmdd.hhmmss format. For example the SET
DRMPLANPREFIX is set to the following:
c:\adsmsrv\recplans\
The resulting recovery plan file name is:
c:\adsmsrv\recplans\19951115.051421
Note: If you issue the SET DRMPLANPREFIX command from a command
line client and the last character in the command line is a backslash,
Tivoli Storage Manager interprets it as a continuation character. To
avoid this, enclose the prefix in quotation marks. For example:
"c:\adsmsrv\recplans\"
2. If the prefix is a directory path followed by a string, Tivoli Storage Manager
uses the string as part of the file name. Tivoli Storage Manager appends to
the prefix the date and time in the .yyyymmdd.hhmmss format (note the
initial period). For example, the SET DRMPLANPREFIX is set to the
following
SET DRMPLANPREFIX
Chapter 2. Administrative commands 997
c:\adsmsrv\recplans\accounting
The resulting recovery plan filename is the following:
c:\adsmsrv\recplans\accounting.19951115.051421
3. If the prefix is a string that is not preceded by a directory path, Tivoli
Storage Manager appends to the prefix the date and time information in
the .yyyymmdd.hhmmss format (note the initial period). The directory path
that Tivoli Storage Manager uses is the directory path representing this
instance of the Tivoli Storage Manager server (typically the directory that
the Tivoli Storage Manager server was originally installed from). For
example, the directory representing this instance of the server is
c:\Program Files\Tivoli\TSM;\server2, and you set the prefix to:
shipping
The resulting recovery plan filename is:
c:\Program Files\Tivoli\TSM;\server2\shipping.19951115.051421
Examples
Task
Specify a prefix so that the generated recovery plan files are stored in directory
c:\drmtest\prepare\.
Command
set drmplanprefix c:\drmtest\prepare\
Related commands
Table 316. Commands related to SET DRMPLANPREFIX
Command Description
PREPARE Creates a recovery plan file.
QUERY DRMSTATUS Displays DRM system parameters.

SET DRMPLANPREFIX

998 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET DRMPLANVPOSTFIX (Specify replacement volume
names)
Use this command to specify the character to be appended to replacement volume
names in the recovery plan file. The character can help you find or generate
replacement volume names when you use the recovery plan file.
At installation, the character is set to @. Tivoli Storage Manager generates
replacement names for primary storage pool volumes that were added by the
DEFINE VOLUME command. Use the appended character to:
v Find replacement volume names in the recovery plan stanzas so that you can
change the names at recovery time. For example, you may not know the names
of the available tape volumes at the recovery site.
v Generate replacement volume names. You need a naming convention that works
for any device type in your primary storage pools. Consider the following:
The generated length of replacement volume name
Legal characters in the replacement volume name
Conflicts with existing volume names
A replacement volume name must be different from any destroyed, existing,
or new volume name.
Use the QUERY DRMSTATUS to see the character added to the end of the
replacement volume names.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set DRMPLANVpostfix character

Parameters
character (Required)
Specifies the character appended to the replacement volume names in the
recovery plan file. Specify an alphanumeric or special character.
Note: A special character can cause unpredictable results in the Windows
batch/command line environment.
Examples
Task
Set the character appended to the replace volume names to R.
Command
set drmplanvpostfix R
SET DRMPLANVPOSTFIX
Chapter 2. Administrative commands 999
Related commands
Table 317. Commands related to SET DRMPLANVPOSTFIX
Command Description
PREPARE Creates a recovery plan file.
QUERY DRMSTATUS Displays DRM system parameters.

SET DRMPLANVPOSTFIX

1000 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET DRMPRIMSTGPOOL (Specify the primary storage pools to
be managed by DRM)
Use this command to specify the names of primary storage pools that you want to
recover. If the PREPARE command does not include the PRIMSTGPOOL
parameter, DRM processes the names specified in this command.
Use the QUERY DRMSTATUS command to display the current settings. At
installation, all primary storage pools defined to the server are eligible for DRM
processing.
Privilege class
To issue this command, you must have system privilege.
Syntax

Set DRMPRIMstgpool

,
primary_pool_name

Parameters
primary_pool_name (Required)
Specifies the names of the primary storage pool names you want to recover.
Separate multiple names with commas and no intervening spaces. You can use
wildcard characters to specify names. The names that you specify replace any
previous setting. If you enter a null string (), all current names are removed,
and all primary storage pools are eligible for DRM processing.
Examples
Task
Set the primary storage pool to be managed by DRM to PRIMSTGPOOL1.
Command
set drmprimstgpool primstgpool1
Related commands
Table 318. Commands related to SET DRMPRIMSTGPOOL
Command Description
PREPARE Creates a recovery plan file.
QUERY DRMSTATUS Displays DRM system parameters.
SET DRMCOPYSTGPOOL Specifies that copy storage pools are
managed by DRM.

SET DRMPRIMSTGPOOL
Chapter 2. Administrative commands 1001
SET DRMRPFEXPIREDAYS (Set criteria for recovery plan file
expiration)
Use this command to specify when recovery plan files are eligible for expiration.
This command and expiration processing apply only to recovery plan files that
were created with the DEVCLASS parameter specified on the PREPARE command
(that is, virtual volumes of type RPFILE and RPSNAPSHOT). Expiration processing
on the source server expires plan files stored on the target server. Locally created
recovery plan files are not expired.
An RPFILE file is associated with a full plus incremental database backup series.
An RPFSNAPSHOT file is associated with a database snapshot backup series.
Note: The latest RPFILE and RPFSNAPSHOT files are never deleted.
A recovery plan file is eligible for expiration if both of the following are true:
v The last recovery plan file of the series has exceeded the expiration value
specified with the SET DRMRPFEXPIREDAYS command.
v The latest recovery plan file is not associated with the most recent database
backup series.
See the EXPIRE INVENTORY command for more information about expiration
processing.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set DRMRPFEXpiredays days

Parameters
days (Required)
Specifies the number of days that must elapse before a recovery plan file
expires. You can specify a number from 0 to 9999. At installation, this value is
set to 60.
Examples
Task
Set the recovery plan file expiration value to 30.
Command
set drmrpfexpiredays 30
Related commands
Table 319. Commands related to SET DRMRPFEXPIREDAYS
Command Description
PREPARE Creates a recovery plan file.
QUERY DRMSTATUS Displays DRM system parameters.
SET DRMRPFEXPIREDAYS

1002 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 319. Commands related to SET DRMRPFEXPIREDAYS (continued)
Command Description
QUERY RPFCONTENT Displays the contents of a recovery plan file.
QUERY RPFILE Displays information about recovery plan
files.
QUERY VOLHISTORY Displays sequential volume history
information that has been collected by the
server.
SET DRMDBBACKUPEXPIREDAYS Specifies criteria for database backup series
expiration.

SET DRMRPFEXPIREDAYS
Chapter 2. Administrative commands 1003
SET DRMVAULTNAME (Specify the vault name)
Use this command to specify the vault name. At installation the name is set to
VAULT. Use the QUERY DRMSTATUS command to see the name of the vault.
Privilege class
To issue this command, you must have system privilege.
Syntax
SET DRMVAultname vault_name

Parameters
vault_name (Required)
Specifies the name of the vault. The name can be up to 255 characters. Enclose
the name in quotation marks if it contains any blank characters.
Examples
Task
Specify a vault name of ironmountain.
Command
set drmvaultname ironmountain
Related commands
Table 320. Commands related to SET DRMVAULTNAME
Command Description
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY DRMSTATUS Displays DRM system parameters.

SET DRMVAULTNAME

1004 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET EVENTRETENTION (Set the retention period for event
records)
Use this command to set the retention period for event records in the server
database that will allow you to monitor completed schedules. An event record is
created whenever processing of a scheduled command is started or missed.
You can adjust the length of time that the server maintains event information to
avoid insufficient or outdated data. The server automatically removes the event
records from the database after the retention period passes and the startup
window for the event has elapsed.
You can issue the QUERY EVENT command to display information about
scheduled and completed events.
You can issue the DELETE EVENT command to delete event records regardless of
whether their retention period has passed.
You can issue the QUERY STATUS command to display the value for the event
retention period. At installation, this value is set to 10 days.
Privilege class
To perform this task, you must have system privilege.
Syntax
Set EVentretention days

Parameters
days (Required)
The number of days that the database retains event records. You can specify an
integer from 0 to 9999. A value of 0 indicates that only event records for the
current day are retained.
Examples
Task
Set the retention period to 15 days.
Command
set eventretention 15
Related commands
Table 321. Commands related to SET EVENTRETENTION
Command Description
DELETE EVENT Deletes event records prior to a specified
date and time.
QUERY EVENT Displays information about scheduled and
completed events for selected clients.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET EVENTRETENTION
Chapter 2. Administrative commands 1005
SET EVENTRETENTION

1006 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET INVALIDPWLIMIT (Set the number of invalid logon
attempts)
Use this command to set the number of invalid logon attempts allowed before a
node is locked.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set INVALIDPwlimit number

Parameters
number (Required)
Specifies the number of invalid logon attempts allowed before a node is
locked.
You can specify an integer from 0 to 9999. A value of 0 means that invalid
logon attempts are not checked. A value of 1 means that if a user issues an
invalid password once, the node is locked by the server. The default is 0.
Examples
Task
Set the number of invalid logon attempts allowed.
Command
set invalidpwlimit 6
Related commands
Table 322. Commands related to SET INVALIDPWLIMIT
Command Description
QUERY ADMIN Displays information about one or more IBM
Tivoli Storage Manager administrators.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET MINPWLENGTH Sets the minimum length for client
passwords.

SET INVALIDPWLIMIT
Chapter 2. Administrative commands 1007
SET LICENSEAUDITPERIOD (Set license audit period)
Use this command to specify the period, in days, between automatic license audits
performed by IBM Tivoli Storage Manager.
Privilege class
To issue this command, you must have system privilege.
Syntax

30
Set

LICenseauditperiod

days

Parameters
days
Specifies the number of days between automatic server license audits. This
parameter is optional. The default value is 30. You can specify an integer from
1 to 30, inclusive.
Examples
Task
Specify that the server audits licenses every 14 days.
Command
set licenseauditperiod 14
Related commands
Table 323. Commands related to SET LICENSEAUDITPERIOD
Command Description
AUDIT LICENSES Checks for compliance with defined licenses.
QUERY AUDITOCCUPANCY Displays the server storage utilization for a
client node.
QUERY LICENSE Displays information about licenses and
audits.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
REGISTER LICENSE Registers a new license with the IBM Tivoli
Storage Manager server.

SET LICENSEAUDITPERIOD

1008 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET LOGMODE (Set mode for saving recovery log records)
Use this command to specify how long Tivoli Storage Manager saves records in the
recovery log and what kind of database recovery you can use. You cannot change
the log mode during a database backup.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
Set LOGMode Normal
Rollforward


Parameters
Normal
Specifies that Tivoli Storage Manager saves only the records needed to restore
the database to the time of the last backup (point-in-time recovery). Changes
made to the database after the last backup cannot be recovered. This is the
default.
In NORMAL mode, you cannot use a database backup trigger.
Rollforward
Specifies that Tivoli Storage Manager saves the records needed to restore the
database to its most current state (roll-forward recovery). You can use a
database backup series created in ROLLFORWARD mode for either
point-in-time or roll-forward recovery.
In ROLLFORWARD mode, you can use the database backup trigger. If the
trigger is defined when you change to ROLLFORWARD mode, Tivoli Storage
Manager immediately runs a full backup. If the trigger is not defined, your
next database backup must be a full backup. If you attempt an incremental
backup, the operation fails.
If you run the DSMSERV FORMAT or the DSMSERV LOADFORMAT
command, Tivoli Storage Manager resets the log mode to NORMAL.
In ROLLFORWARD mode the log cannot be reduced.
Examples
Task
Change the log mode from roll-forward to normal.
Command
set logmode normal
Related commands
Table 324. Commands related to SET LOGMODE
Command Description
BACKUP DB Backs up the IBM Tivoli Storage Manager
database to sequential access volumes.
SET LOGMODE
Chapter 2. Administrative commands 1009
Table 324. Commands related to SET LOGMODE (continued)
Command Description
DEFINE DBBACKUPTRIGGER Defines a trigger for automatic IBM Tivoli
Storage Manager database backups.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
UPDATE DBBACKUPTRIGGER Changes one or more attributes of the
database backup trigger.

SET LOGMODE

1010 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET MAXCMDRETRIES (Set the maximum number of
command retries)
Use this command to set the maximum number of times that a scheduler on a
client node can retry a failed, scheduled command.
You can use the command to override the maximum number of retries that are
specified by the client node. A clients value is overridden only if the client is able
to connect with the server.
This command is used with the SET RETRYPERIOD command to regulate the time
and the number of retry attempts to execute a failed command.
You can issue the QUERY STATUS command to display the current retry value. At
installation, Tivoli Storage Manager is configured so that each client determines its
own retry value.
Privilege class
To perform this task, you must have system privilege.
Syntax
Set MAXCMDRetries
number


Parameters
number
Specifies the maximum number of times the scheduler on a client node can
retry a failed scheduled command. This parameter is optional.
The default is that each client determines its own value for this parameter. You
can specify an integer from 0 to 9999. See the appropriate client documentation
for more information on setting the maximum command retries from the client.
Examples
Task
Retry, only twice, a failed attempt to process a scheduled command.
Command
set maxcmdretries 2
Related commands
Table 325. Command related to SET MAXCMDRETRIES
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET RETRYPERIOD Specifies the time between retry attempts by
the client scheduler.

SET MAXCMDRETRIES
Chapter 2. Administrative commands 1011
SET MAXSCHEDSESSIONS (Set maximum scheduled
sessions)
Use this command to set the number of sessions that are allowed to the server for
processing scheduled operations. This command specifies the maximum number of
scheduled sessions as a percentage of the total number of available server sessions.
Limiting the number of sessions ensures that sessions are available for
unscheduled operations, such as backup or archive.
You can increase either the total number of sessions (with the MAXSESSIONS
parameter) or the maximum percentage of scheduled sessions. Increasing the total
number of sessions available can affect server performance. Increasing the
maximum percentage of scheduled sessions can reduce the sessions available for
unscheduled operations.
Privilege class
To perform this task, you must have system privilege.
Syntax
Set MAXSCHedsessions percent

Parameters
percent (Required)
Specifies the percentage of total server sessions that can be used for scheduled
operations. You can specify an integer from 0 to 100. The MAXSESSIONS
parameter in the server options file determines the maximum number of total
available server sessions.
If you set the maximum percentage of scheduled sessions to 0, no scheduled
events can begin. If you set the maximum percentage of scheduled sessions to
100, the maximum number of scheduled sessions is the value of the
MAXSESSIONS option.
Examples
Task
The MAXSESSIONS option has a value of 80. To permit no more than 20 sessions
to be available for scheduled activity, set the percentage to 25.
Command
set maxschedsessions 25
Related commands
Table 326. Commands related to SET MAXSCHEDSESSIONS
Command Description
QUERY OPTION Displays information about server options.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

SET MAXSCHEDSESSIONS

1012 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET MINPWLENGTH (Set minimum password length)
Use this command to set the minimum length of a password.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set MINPwlength length

Parameters
length (Required)
Specifies the minimum length of a password. You can specify an integer from 0
to 64. A value of 0 means that the password length is not checked. At
installation, the value for minimum password length is set to 0.
Examples
Task
Set the minimum password length to 5 characters.
Command
set minpwlength 5
Related commands
Table 327. Commands related to SET MINPWLENGTH
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET INVALIDPWLIMIT Sets the number of invalid logon attempts
before a node is locked.

SET MINPWLENGTH
Chapter 2. Administrative commands 1013
SET PASSEXP (Set password expiration date)
Use this command to set the expiration period for administrator and client node
passwords. You can set a common password expiration period for all
administrators and client node passwords or selectively set password expiration
periods.
You can override this setting for one or more nodes by using the REGISTER NODE
or UPDATE NODE command with the PASSEXP parameter.
Attention: If you do not specify the NODE or ADMIN parameters, all client node
and administrator passwords will use the new password expiration period. If you
selectively set a password expiration period for a client node or administrator that
does not already have a set password expiration period, it is not modified if you
later set a password expiration for all users. The NODE or ADMIN parameters
must be specified to change the password expiration period for client nodes or
administrators that have selectively set password expiration periods.
You can use the RESET PASSEXP command to reset the password expiration
period to the common expiration period.
Use the QUERY STATUS command to display the common password expiration
period, which at installation is set to 90 days.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set PASSExp days

,

Node

=

node_name

,

Admin

=

admin_name


Parameters
days (Required)
Specifies the number of days that a password remains valid.
You can specify from 1 to 9999 if you do not specify the NODE or the ADMIN
parameter. If you specify the NODE or the ADMIN parameter, you can specify
from 0 to 9999. A value of 0 means that the password never expires. If a
password expires, the server prompts for a new password when the
administrator or client node contacts the server.
Node
Specifies the name of the node whose password expiration period you would
like to set. To specify a list of nodes, separate the names with commas and no
intervening spaces. This parameter is optional.
Admin
Specifies the name of the administrator whose password expiration period you
SET PASSEXP

1014 IBM Tivoli Storage Manager for Windows: Administrators Reference
would like to set. To specify a list of administrators, separate the names with
commas and no intervening spaces. This parameter is optional.
Examples
Task 1
Set the administrator and client node password expiration period to 45 days.
Command
set passexp 45
Task 2
Set the administrator LARRYs password expiration period to 120 days.
Command
set passexp 120 admin=larry
Related commands
Table 328. Commands related to SET PASSEXP
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
REGISTER NODE Defines a client to the server and sets options
for that user.
RESET PASSEXP Resets the password expiration for nodes or
administrators.
UPDATE ADMIN Changes the password or contact information
associated with any administrator.
UPDATE NODE Changes the attributes associated with a
client node.

SET PASSEXP
Chapter 2. Administrative commands 1015
SET QUERYSCHEDPERIOD (Set query period for polling client
nodes)
Use this command to regulate how often client nodes contact the server to obtain
scheduled work when it is running in the client-polling scheduling mode.
Each client can set its own retry period at the time its scheduler is started. You can
use this command to override the value specified by all clients that can connect
with the server.
If client nodes poll more frequently for schedules, the nodes receive changes to
schedules more quickly. However, increased polling by the client nodes also
increases network traffic.
You can issue the QUERY STATUS command to display the value for the period
between schedule queries. At installation, Tivoli Storage Manager is configured so
that each client node determines its own value for this setting.
Privilege class
To perform this task, you must have system privilege.
Syntax
Set QUERYSCHedperiod
hours


Parameters
hours
Specifies the maximum number of hours the scheduler on a client node waits
between attempts to contact the server to obtain a schedule. This parameter is
optional. You can specify an integer from 1 to 9999. If you do not specify a
value for this parameter, each client determines its own value for this
parameter.
Examples
Task
Have all clients using the polling scheduling mode contact the server every 24
hours.
Command
set queryschedperiod 24
Related commands
Table 329. Commands related to SET QUERYSCHEDPERIOD
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET SCHEDMODES Specifies the central scheduling mode for the
server.

SET QUERYSCHEDPERIOD

1016 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET RANDOMIZE (Set randomization of scheduled start times)
Use this command to set randomized start times within the startup window of
each schedule for clients by using the client-polling scheduling mode. A startup
window is the start time and duration during which a schedule must be initiated.
A client-polling scheduling mode is a client/server communication technique
where the client queries the server for work.
Each schedule has a window during which execution can begin. To balance
network and server load, the start times for clients can be scattered across that
window. Use this command to specify the fraction of the window over which start
times for clients are distributed.
The randomization occurs at the beginning of the window to allow time for retries,
if necessary. Randomization does not occur if the clients first contact with the
server is after the start time for the event.
You can issue the QUERY STATUS command to display the value for the schedule
randomization percentage. At installation, the value is 25 percent.
Set the randomization percentage to a value greater than 0 to prevent
communication errors. Communication errors can result from a large group of
clients contacting the server simultaneously. If you do experience communication
errors, you can increase the randomization percentage so that client contact is
spread out. This decreases the chance for communication overload and failure.
Privilege class
To perform this task, you must have system privilege.
Syntax
Set RANDomize percent

Parameters
percent (Required)
Specifies the percentage of the startup window over which the start times for
individual clients are distributed. You can specify an integer from 0 to 50.
A value of 0 indicates that no randomization occurs and that all clients execute
schedules at the beginning of the startup windows.
A value of 50 indicates that clients are assigned start times that are randomly
scattered across the first half of each startup window.
At installation, this value is 25, indicating that the first 25 percent of the
window is used for randomization.
If you have specified DURUNITS=INDEFINITE in the DEFINE SCHEDULE
command, the percentage is applied to a 24 hour period. For example, a value
of 25 percent would result in a 6 hour window.
Examples
Task
Set randomization to 50 percent.
SET RANDOMIZE
Chapter 2. Administrative commands 1017
Command
set randomize 50
Related commands
Table 330. Commands related to SET RANDOMIZE
Command Description
DEFINE SCHEDULE Defines a schedule for a client operation or
an administrative command.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET SCHEDMODES Specifies the central scheduling mode for the
server.

SET RANDOMIZE

1018 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET REGISTRATION (Set open or closed registration)
Use this command to require a system or policy administrator to register client
nodes (closed registration) or to permit each user to register his own workstation
as a client node with the server (open registration).
With closed registration, an administrator defines the following:
v Each workstations node name and password
v The policy domain to which the client node belongs
v Whether the user can choose to compress files before sending them to server
storage
v Whether the user can delete backup or archive files from server storage
With open registration, when a user accesses the server from an unregistered client
node, the server prompts the user for a node name, password, and contact
information, and registers the workstation. The server sets the following defaults:
v Each client node is assigned to the policy domain named STANDARD
v Each user defines whether data compression is used before files are sent to
server storage
v Each user is allowed to delete archived files from server storage. The user
cannot delete backup files
v The administrator can reassign domains or change node attributes using the
UPDATE NODE command
Existing registered client nodes are not affected by changes in the registration
process.
Use the QUERY STATUS command to display the status of registration. At
installation, this value is set to CLOSED.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the client
node belongs.
Syntax
Set REGistration Closed
Open


Parameters
Closed
Specifies that client nodes must be registered by a system or policy
administrator.
Open
Specifies that users can register their workstations as client nodes with the
server.
SET REGISTRATION
Chapter 2. Administrative commands 1019
Examples
Task 1
A policy or system administrator registers all client nodes to the server.
Command
set registration closed
Task 2
Users register as client nodes to the server.
Command
set registration open
Related commands
Table 331. Command related to SET REGISTRATION
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

SET REGISTRATION

1020 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET RETRYPERIOD (Set time between retry attempts)
Use this command to set the number of minutes the scheduler on a client node
waits between retry attempts after a failed attempt to contact the server or after a
scheduled command fails to process.
Each client can set its own retry period at the time its scheduler program is started.
You can use this command to override the values specified by all clients that can
connect with the server.
This command is used in conjunction with the SET MAXCMDRETRIES command
to regulate the period of time and the number of retry attempts to execute a failed
command.
You can issue the QUERY STATUS command to display the value for the period
between retries. At installation, Tivoli Storage Manager allows each client to
determine its own retry period.
Privilege class
To perform this task, you must have system privilege.
Syntax
Set RETRYPeriod
minutes


Parameters
minutes
Specifies the number of minutes the scheduler on a client node waits between
retry attempts after a failed attempt to contact the server or after a scheduled
command fails to process. When setting the retry period, set a time period that
permits more than one retry attempt within a typical startup window. You can
specify an integer from 1 to 9999.
Examples
Task
Have the client scheduler retry failed attempts to contact the server or to process
scheduled commands every 15 minutes.
Command
set retryperiod 15
Related commands
Table 332. Commands related to SET RETRYPERIOD
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET MAXCMDRETRIES Specifies the maximum number of retries
after a failed attempt to execute a scheduled
command.

SET RETRYPERIOD
Chapter 2. Administrative commands 1021
SET SCHEDMODES (Select a central scheduling mode)
Use this command to determine how the clients communicate with the server to
begin scheduled work. You must configure each client to select the scheduling
mode in which it operates.
Use this command with the SET RETRYPERIOD command to regulate the time
and the number of retry attempts to process a failed command.
You can issue the QUERY STATUS command to display the value for the
scheduling mode supported. At installation, this value is ANY.
Privilege class
To perform this task, you must have system privilege.
Syntax
Set SCHEDMODes ANY
POlling

PRompted


Parameters
ANY
Specifies that the server allows clients to run in either the client-polling or the
server-prompted scheduling mode.
POlling
Specifies that only the client-polling mode can be used. Client nodes poll the
server at prescribed time intervals to obtain scheduled work.
PRompted
Specifies that only the server-prompted mode can be used. This mode is only
available for clients that communicate with TCP/IP. Client nodes wait to be
contacted by the server when scheduled work needs to be performed and a
session is available.
Examples
Task
A server allows both server-prompted and client-polling central scheduling. You
want to temporarily restrict the scheduled operations to clients that use the
client-polling mode. If you set the schedule mode to POLLING, the server
discontinues prompting clients to execute scheduled commands. This means that
any client scheduler using the server-prompted mode waits until you set the
schedule mode to ANY or PROMPTED.
Command
set schedmodes polling
SET SCHEDMODES

1022 IBM Tivoli Storage Manager for Windows: Administrators Reference
Related commands
Table 333. Command related to SET SCHEDMODES
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET RETRYPERIOD Specifies the time between retry attempts by
the client scheduler.

SET SCHEDMODES
Chapter 2. Administrative commands 1023
SET SERVERHLADDRESS (Set the high-level address of a
server)
Use this command to set the high-level address (IP) of a server. IBM Tivoli Storage
Manager uses the address when you issue a DEFINE SERVER command with
CROSSDEFINE=YES.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set SERVERHladdress ip_address

Parameters
ip_address (Required)
Specifies a server high-level address as a numeric dotted decimal name or a
host name. If a host name is specified, a server that can resolve the name to
the dotted decimal form must be available.
Examples
Task
Set the high-level address of HQ_SERVER to 9.230.99.66.
Command
set serverhladdress 9.230.99.66
Related commands
Table 334. Command related to SET SERVERHLADDRESS
Command Description
SET CROSSDEFINE Specifies whether to cross define servers.
SET SERVERLLADDRESS Specifies the low-level address of a server.
SET SERVERPASSWORD Specifies the server password.

SET SERVERHLADDRESS

1024 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET SERVERLLADDRESS (Set the low-level address of a
server)
Use this command to set the low-level address of a server. Tivoli Storage Manager
uses the address when you issue a DEFINE SERVER command with
CROSSDEFINE=YES.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set SERVERLladdress tcp_port

Parameters
tcp_port (Required)
Specifies the low-level address of the server. Generally, this address is identical
to the TCPPORT option in the server option file of the server.
Examples
Task
Set the low-level address of HQ_SERVER to 1500.
Command
set serverlladdress 1500
Related commands
Table 335. Command related to SET SERVERLLADDRESS
Command Description
SET CROSSDEFINE Specifies whether to cross define servers.
SET SERVERHLADDRESS Specifies the high-level address of a server.
SET SERVERPASSWORD Specifies the server password.

SET SERVERLLADDRESS
Chapter 2. Administrative commands 1025
SET SERVERNAME (Specify the server name)
Use this command to change the server name. When you install the Tivoli Storage
Manager server, the name is set at installation to SERVER1.
Use the QUERY STATUS command to display the server name.
Note: If you migrate from ADSM to Tivoli Storage Manager, the name is set to
ADSM or the name last specified to ADSM with a SET SERVERNAME
command.
Attention:
v If this is a source server for a virtual volume operation, changing its name can
impact its ability to access and manage the data it has stored on the
corresponding target server.
v To prevent problems related to volume ownership, do not change the name of a
server if it is a library client.
When changing the name of a server, be aware of the following additional
restrictions:
v Windows clients use the server name to identify which passwords belong to
which servers. Changing the server name after the clients are connected forces
the clients to re-enter the passwords.
v You must set unique names on servers that communicate with each other. For
details, see the Administrators Guide. On a network where clients connect to
multiple servers, it is recommended that all of the servers have unique names.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set SERVername server_name

Parameters
server_name (Required)
Specifies the new server name. The name must be unique across a server
network for enterprise event logging, enterprise configuration, command
routing, or virtual volumes. The maximum length of the name is 64 characters.
Examples
Task
Name the server WELLS_DESIGN_DEPT.
Command
set servername wells_design_dept
SET SERVERNAME

1026 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
Related commands
Table 336. Command related to SET SERVERNAME
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

SET SERVERNAME
Chapter 2. Administrative commands 1027
SET SERVERPASSWORD (Set password for server)
Use this command to set the password for communication between servers to
support enterprise administration and enterprise event logging and monitoring.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set SERVERPAssword password

Parameters
password (Required)
Specifies a password for the server. Other servers must have the same
password in their definitions of this server.
Examples
Task
Set the password for HQ_SERVER to agave.
Command
set serverpassword agave
Related commands
Table 337. Command related to SET SERVERPASSWORD
Command Description
SET CROSSDEFINE Specifies whether to cross define servers.
SET SERVERHLADDRESS Specifies the high-level address of a server.
SET SERVERLLADDRESS Specifies the low-level address of a server.

SET SERVERPASSWORD

1028 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET SQLDATETIMEFORMAT (Set the format for date, time, and
time stamp for SQL data)
Use this command to control the format in which SQL date, time, and time stamp
data are displayed.
See your SQL documentation for details about these formats.
Note: This command keeps the settings in effect only for the current
administrative client session.
Privilege class
Any administrator can issue this command.
Syntax

Set SQLDATETIMEformat
Iso
Iso

Usa

Eur

Jis

Local

Parameters
Select one of the following formats:
Iso
Specifies the International Standards Organization (ISO) format. ISO is the
default.
Usa
Specifies the IBM USA standard format.
Eur
Specifies the IBM European standard format.
Jis Specifies the Japanese Industrial Standard Christian Era. Currently the JIS
format is the same as the ISO format.
Local
Site-defined. Currently, the LOCAL format is the same as the ISO format.
Examples
Task
Set the format for SQL date, time, and time stamp data to ISO.
Command
set sqldatetimeformat iso
SET SQLDATETIMEFORMAT
Chapter 2. Administrative commands 1029
Related commands
Table 338. Commands related to SET SQLDATETIMEFORMAT
Command Description
QUERY SQLSESSION Displays the current settings of the SQL
formatting commands.
SELECT Allows customized queries of the IBM Tivoli
Storage Manager database.
SET SQLDISPLAYMODE Controls the column width in the display of
SQL queries.
SET SQLMATHMODE Controls how decimal numbers are displayed
in SQL queries.

SET SQLDATETIMEFORMAT

1030 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET SQLDISPLAYMODE (Set the display of SQL data types)
Use this command to control how SQL data types are displayed.
This command keeps the settings in effect only for the current administrative client
session.
Privilege class
Any administrator can issue this command.
Syntax

Set SQLDISPlaymode
Narrow
Narrow

Wide

Parameters
Narrow
Specifies that the column display width is set to 18. Any wider string is forced
onto multiple lines at the client. NARROW is the default.
Wide
Specifies that the column display width is set to 250.
Examples
Task
Set the SQL data type display to wide column.
Command
set sqldisplaymode wide
Related commands
Table 339. Commands related to SET SQLDISPLAYMODE
Command Description
QUERY SQLSESSION Displays the current settings of the SQL
formatting commands.
SELECT Allows customized queries of the IBM Tivoli
Storage Manager database.
SET SQLDATETIMEFORMAT Controls the formatting of date and time in
the display of SQL queries.
SET SQLMATHMODE Controls how decimal numbers are displayed
in SQL queries.

SET SQLDISPLAYMODE
Chapter 2. Administrative commands 1031
SET SQLMATHMODE (Set the mode for SQL arithmetic)
Use this command to round or truncate decimal numbers for SQL arithmetic.
This command keeps the settings in effect only for the current administrative client
session.
Privilege class
Any administrator can issue this command.
Syntax

Set SQLMATHmode
Truncate
Truncate

Round

Parameters
Truncate
Specifies that decimal numbers are truncated according to DB2 SQL formulas.
TRUNCATE is the default.
Round
Specifies that decimal numbers are rounded according to DB2 SQL formulas.
Examples
Task
Set SQL arithmetic mode to TRUNCATE.
Command
set sqlmathmode truncate
Related commands
Table 340. Commands related to SET SQLMATHMODE
Command Description
QUERY SQLSESSION Displays the current settings of the SQL
formatting commands.
SELECT Allows customized queries of the IBM Tivoli
Storage Manager database.
SET SQLDATETIMEFORMAT Controls the formatting of date and time in
the display of SQL queries.
SET SQLDISPLAYMODE Controls the column width in the display of
SQL queries.

SET SQLMATHMODE

1032 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET SUBFILE (Set subfile backup for client nodes)
Use this command to set up the server to allow clients to back up subfiles. On the
clients machine, the SUBFILEBACKUP, SUBFILECACHEPATH, and
SUBFILECACHESIZE options must be specified in the clients options file
(dsm.opt).
With subfile backups, when a clients file has been previously backed up, any
subsequent backups are typically made to the portion (a subfile) of the clients file
that has changed, rather than the entire file.
Use the QUERY STATUS command to determine whether subfiles can be backed
up to the server running this command.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set SUBFILE Client
No


Parameters
Client
Specifies that the client node can determine whether to use subfile backup.
No
Specifies that the subfile backups are not to be used. At installation, this value
is set to No.
Examples
Task
Allow the client node to backup subfiles on the server.
Command
set subfile client
Related commands
Table 341. Command related to SET SUBFILE
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

SET SUBFILE
Chapter 2. Administrative commands 1033
SET SUMMARYRETENTION (Set days to keep data in activity
summary table)
Use this command to specify the number of days to keep information in the SQL
activity summary table.
The SQL activity summary table contains statistics about each client session and
server processes. For a description of the information in the SQL activity summary
table, use the following command:
select colname, remarks from columns where tabname=SUMMARY
Issue the QUERY STATUS command to display the number of days the
information is kept. At installation, Tivoli Storage Manager allows each server to
determine its own number of days for keeping information in the SQL activity
summary table.
Privilege class
To issue this command, you must have system privilege.
Syntax
Set SUMmaryretention
days


Parameters
days
Specifies the number of days to keep information in the activity summary
table. You can specify a number from 0 to 9999. A value of 0 means that
information in the activity summary table is not kept. A value of 1 specifies to
keep the activity summary table for the current day.
Examples
Task
Set the server to retain the activity summary table information for 15 days.
Command
set summaryretention 15
Related commands
Table 342. Commands related to SET SUMMARYRETENTION
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
SET ACTLOGRETENTION Specifies the number of days to retain log
records in the activity log.
QUERY ACTLOG Displays messages from the server activity
log.
SELECT Allows customized queries of the IBM Tivoli
Storage Manager database.

SET SUMMARYRETENTION

1034 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET TAPEALERTMSG (Set tape alert messages on or off)
Use this command to allow the Tivoli Storage Manager server to log notification of
diagnostic information from library and drive devices. At installation, this value is
set to OFF. When enabled, Tivoli Storage Manager can retrieve diagnostic
information from a tape or library device and display it using ANR messages.
When disabled, Tivoli Storage Manager will not query a device for this
information.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
Set TAPEAlertmsg ON
OFf


Parameters
ON
Specifies that diagnostic information will be reported to the Tivoli Storage
Manager server.
OFf
Specifies that diagnostic information will not be reported to the Tivoli Storage
Manager server.
Examples
Task 1
Allow the Tivoli Storage Manager server to receive diagnostic information
messages.
Command
set tapealertmsg on
Related commands
Table 343. Command related to SET TAPEALERTMSG
Command Description
QUERY TAPEALERTMSG Displays whether the server logs hardware
diagnostic information.

SET TAPEALERTMSG
Chapter 2. Administrative commands 1035
SET TOCLOADRETENTION (Set load retention period for table
of contents)
Use this command to specify the approximate number of minutes that
unreferenced table of contents data will remain loaded in the server database.
During NDMP-controlled backup operations of NAS file systems, the server can
optionally collect information about files and directories in the image and store this
information in a table of contents within a storage pool. The Web client can be
used to examine files and directories in one or more file-system images by
displaying entries from the table of contents data. The server loads the necessary
table of contents data into a temporary database table. Once the data have been
loaded, the user can then select those files and directories to be restored. Because
this database table is temporary, the data will only remain loaded for a specified
time since the last reference to that data. At installation, the retention time is set to
120 minutes.
Note: Use the QUERY STATUS command to see the table of contents load
retention time.
Privilege class
To issue this command you must have system privilege.
Syntax
Set TOCLOADRetention minutes

Parameters
minutes (Required)
Specifies the approximate number of minutes that an unreferenced table of
contents data is retained in the database. You can specify an integer from 30 to
1000.
Examples
Task
Use the command, SET TOCLOADRETENTION, to specify that unreferenced table
of contents data is to be retained in the database for 45 minutes.
Command
set tocloadretention 45
Related commands
Table 344. Commands related to SET TOCLOADRETENTION
Command Description
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.

SET TOCLOADRETENTION

1036 IBM Tivoli Storage Manager for Windows: Administrators Reference
SETOPT (Set a server option for dynamic update)
Use this command to update a server option dynamically without stopping and
restarting the server. A SETOPT command contained in a macro or a script cannot
be rolled back.
Privilege class
To issue this command, you must have system privilege.
Syntax
SETOPT option_name option_value

Parameters
option_name (Required)
Specifies a text string of information identifying the server option to be
updated. The maximum length of the text string is 255 characters. The
following options are available:
BUFPOOLSIZE
COMMTIMEOUT
DATEFORMAT
DNSLOOKUP
EXPINTERVAL
EXPQUIET
IDLETIMEOUT
LOGWARNFULLPERCENT
MAXSESSIONS
MOVEBATCHSIZE
MOVESIZETHRESH
NUMBERFORMAT
RESTOREINTERVAL
SHREDDING
THROUGHPUTDATATHRESHOLD
THROUGHPUTTIMETHRESHOLD
TIMEFORMAT
TXNGROUPMAX
option_value (Required)
Specifies the value for the server option.
Examples
Task
Update the server option for the maximum number of client sessions to a value of
40.
Command
setopt maxsessions 40
SETOPT
Chapter 2. Administrative commands 1037
Related commands
Table 345. Commands related to SETOPT
Command Description
QUERY OPTION Displays information about server options.
QUERY SYSTEM Displays details about the IBM Tivoli Storage
Manager server system.

SETOPT

1038 IBM Tivoli Storage Manager for Windows: Administrators Reference
SHRED commands
Use the SHRED DATA command to shred deleted data.
v SHRED DATA (Shred data) on page 1040
SHRED commands
Chapter 2. Administrative commands 1039
SHRED DATA (Shred data)
Use this command to manually start the process of shredding deleted sensitive
data. Manual shredding is possible only if automatic shredding is disabled.
You can control automatic shred processing with the SHREDDING server option.
This command creates a background process that can be cancelled with the
CANCEL PROCESS command. To display information on background processes,
use the QUERY PROCESS command.
If data from a storage pool that enforces shredding is deleted while a manual
shredding process is running, it will be added to the running process.
Privilege class
To issue this command you must have system privilege.
Syntax

SHRED DATA

DUration

=

minutes
Wait = No
Wait

=

No

Yes

IOERROR = SHREDFailure
IOERROR

=

SHREDFailure

SHREDSuccess

Parameters
DURATION
Specifies the maximum number of minutes the shredding process runs before
being automatically cancelled. When the specified number of minutes elapses,
the server cancels the shredding process. As soon as the process recognizes the
cancellation, it ends. Because of this, the process may run longer than the value
you specified for this parameter. You can specify a number from 1 to 9999. This
parameter is optional. If not specified, the server will stop only after all deleted
sensitive data has been shredded.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is No. Possible
values are:
No
Specifies that the server processes this command in the background. You
can continue with other tasks while the command is being processed.
Messages created from the background process are displayed either in the
activity log or the server console, or both, depending on where messages
are logged. To cancel a background process, use the CANCEL PROCESS
command. If you cancel this process, some files might already have been
shredded before the cancellation. This is the default.
Yes
Specifies that the server processes this command in the foreground. You
must wait for the operation to complete before continuing with other tasks.
SHRED DATA

1040 IBM Tivoli Storage Manager for Windows: Administrators Reference
The server displays the output messages to the administrative client when
the operation completes. Messages are also displayed either in the activity
log or the server console, or both, depending on where messages are
logged.
IOERROR
Specifies whether an I/O error encountered while shredding the data is to be
considered a successful shred. This parameter is optional. The default is
SHREDFAILURE. Possible values are:
SHREDFailure
Specifies that if the server encounters an I/O error while shredding, the
data will not be considered successfully shredded and the owning file will
be marked as damaged. The server will attempt to shred the data again the
next time the shredding process runs, giving you a chance to correct the
error and ensure the data can be properly shredded.
SHREDSuccess
Specifies that if the server encounters an I/O error while shredding and
the owning file had been previously marked as damaged, the data will be
considered successfully shredded. You should use this option only after the
server has reported I/O errors while shredding and you are unable to
correct the error.
Examples
Task
Manually start the shredding of all deleted sensitive data. Continue the process for
up to six hours before automatically cancelling it.
Command
shred data duration=360
Related commands
Table 346. Commands related to SHRED DATA
Command Description
CANCEL PROCESS Cancels a background server process.
QUERY PROCESS Displays information about background
processes.
QUERY SHREDSTATUS Displays information about data waiting to be
shredded.

SHRED DATA
Chapter 2. Administrative commands 1041
|
||
||
||
||
|
||
|
|
|
SUSPEND EXPORT (Suspends a currently running export operation)
Use this command to suspend a currently running server-to-server export
operation which has a FILEDATA value that is not NONE. The export operation
that you want to suspend must be past the initialization phase to be eligible for
suspension. The state of the export operation is saved. The operation can be
restarted by issuing the RESTART EXPORT command.
Privilege class
You must have system privilege to issue this command.
Syntax

*
SUSPend EXPOrt

export_identifier

Parameters
EXPORTIDentifier
This optional parameter specifies the name of the suspended export operation.
You can find a name by issuing the QUERY EXPORT command to list all the
currently running server-to-server export operations that can be suspended.
You can use the wildcard character to specify the name.
Examples
Task
Suspend the running export operation EXPORTALLACCTNODES.
Command
suspend export exportallacctnodes
Note: No output is generated. You must issue the QUERY EXPORT
command to verify that the EXPORTALLACCTNODES operation is
suspended.
Task
Suspend all the export operations with a state of RUNNING.
Command
suspend export *
Related commands
Table 347. Commands related to SUSPEND EXPORT
Command Description
CANCEL EXPORT Deletes a suspended export operation
EXPORT NODE Copies client node information to external
media.
EXPORT SERVER Copies all or part of the server to external
media.
SUSPEND EXPORT

1042 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
||
||
||
|
||
|
Table 347. Commands related to SUSPEND EXPORT (continued)
Command Description
QUERY EXPORT Displays the export operations that are
currently running or suspended.
RESTART EXPORT Restarts a suspended export operation.

SUSPEND EXPORT
Chapter 2. Administrative commands 1043
|
||
||
|
||
|
|
UNDO commands
Use the UNDO ARCHCONVERSION command to remove all directory and file
entries for a node from the archive description tables.
v UPDATE ARCHIVE (Manage archive usage and performance) on page 1053
UNDO commands

1044 IBM Tivoli Storage Manager for Windows: Administrators Reference
UNDO ARCHCONVERSION (Reverse archive conversion for
the node)
Use this command to remove the archive package performance enhancements for a
node. The command can also be used to audit a nodes archive packages by first
issuing UNDO ARCHCONVERSION, then CONVERT ARCHIVE.
See the Administrators Guide for details.
Privilege class
To issue this command you must have policy privilege for the policy domain for
the node.
Syntax
UNDO ARCHConversion node_name

Parameters
node_name (Required)
Specifies the node name for the operation.
Examples
Task
Undo conversion to the node ENGRS.
Command
undo archconversion engrs
Related commands
Table 348. Commands related to UNDO ARCHCONVERSION
Command Description
CONVERT ARCHIVE Improves performance for archive functions
for a node.
UPDATE ARCHIVE Manages archive usage and performance.

UNDO ARCHCONVERSION
Chapter 2. Administrative commands 1045
UNLOCK commands
Use the UNLOCK command to reaccess a server after having being locked out.
The following is a list of UNLOCK commands for Tivoli Storage Manager:
v UNLOCK ADMIN (Unlock an administrator) on page 1047
v UNLOCK NODE (Unlock a client node) on page 1048
v UNLOCK PROFILE (Unlock a profile) on page 1049
UNLOCK commands

1046 IBM Tivoli Storage Manager for Windows: Administrators Reference
UNLOCK ADMIN (Unlock an administrator)
Use this command to allow a locked administrator to access the server again.
Privilege class
To issue this command, you must have system privilege.
Syntax
UNLOCK Admin admin_name

Parameters
admin_name (Required)
Specifies the name of the administrator to unlock.
Examples
Task
The administrator JOE is locked out of IBM Tivoli Storage Manager. Permit JOE to
access the server.
Command
unlock admin joe
Related commands
Table 349. Commands related to UNLOCK ADMIN
Command Description
LOCK ADMIN Prevents an administrator from accessing
IBM Tivoli Storage Manager.
QUERY ADMIN Displays information about one or more IBM
Tivoli Storage Manager administrators.

UNLOCK ADMIN
Chapter 2. Administrative commands 1047
UNLOCK NODE (Unlock a client node)
Use this command to allow a locked client node to access the server again.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the client
node is assigned.
Syntax
UNLOCK Node node_name

Parameters
node_name (Required)
Specifies the name of the client node to unlock.
Examples
Task
The client node SMITH is locked out of IBM Tivoli Storage Manager. Permit
SMITH to access the server.
Command
unlock node smith
Related commands
Table 350. Commands related to UNLOCK NODE
Command Description
LOCK NODE Prevents a client from accessing the server.
QUERY NODE Displays partial or complete information
about one or more clients.

UNLOCK NODE

1048 IBM Tivoli Storage Manager for Windows: Administrators Reference
UNLOCK PROFILE (Unlock a profile)
Use this command on a configuration manager to unlock a configuration profile so
it can be distributed to subscribing managed servers.
Privilege class
To issue this command, you must have system privilege.
Syntax
UNLOCK PROFIle profile_name

Parameters
profile_name (Required)
Specifies the profile to unlock. You can use wildcard characters to indicate
multiple names.
Examples
Task
Unlock a profile named TOM.
Command
unlock profile tom
Related commands
Table 351. Commands related to UNLOCK PROFILE
Command Description
COPY PROFILE Creates a copy of a profile.
DEFINE PROFASSOCIATION Associates objects with a profile.
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
DELETE PROFASSOCIATION Deletes the association of an object with a
profile.
DELETE PROFILE Deletes a profile from a configuration
manager.
LOCK PROFILE Prevents distribution of a configuration
profile.
QUERY PROFILE Displays information about configuration
profiles.
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UPDATE PROFILE Changes the description of a profile.

UNLOCK PROFILE
Chapter 2. Administrative commands 1049
UPDATE commands
Use the UPDATE command to modify one or more attributes of an existing Tivoli
Storage Manager object.
The following is a list of UPDATE commands for Tivoli Storage Manager:
v UPDATE ADMIN (Update an administrator) on page 1051
v UPDATE ARCHIVE (Manage archive usage and performance) on page 1053
v UPDATE BACKUPSET (Update a retention value assigned to a backup set) on
page 1055
v UPDATE CLIENTOPT (Update a client option sequence number) on page 1060
v UPDATE CLOPTSET (Update a client option set description) on page 1061
v UPDATE COLLOCGROUP (Update a collocation group) on page 1062
v UPDATE COPYGROUP (Update a copy group) on page 1064
v UPDATE DATAMOVER (Update a data mover) on page 1072
v UPDATE DBBACKUPTRIGGER (Update the database backup trigger) on page
1074
v UPDATE DEVCLASS (Update the attributes of a device class) on page 1076
v UPDATE DOMAIN (Update a policy domain) on page 1139
v UPDATE DRIVE (Update a drive) on page 1141
v UPDATE LIBRARY (Update a library) on page 1145
v UPDATE LIBRARY (Update a library) on page 1145
v UPDATE MACHINE (Update machine information) on page 1153
v UPDATE MGMTCLASS (Update a management class) on page 1155
v UPDATE NODE (Update node attributes) on page 1158
v UPDATE NODEGROUP (Update a node group) on page 1166
v UPDATE PATH (Change a path) on page 1167
v UPDATE POLICYSET (Update a policy set description) on page 1173
v UPDATE PROFILE (Update a profile description) on page 1175
v UPDATE RECOVERYMEDIA (Update recovery media) on page 1176
v UPDATE SCHEDULE (Update a schedule) on page 1178
v UPDATE SCRIPT (Update a Tivoli Storage Manager script) on page 1199
v UPDATE SERVER (Update a server defined for server-to-server
communications) on page 1201
v UPDATE SERVERGROUP (Update a server group description) on page 1205
v UPDATE SPACETRIGGER (Update the space triggers) on page 1206
v UPDATE STGPOOL (Update a storage pool) on page 1210
v UPDATE VIRTUALFSMAPPING (Update a virtual file space mapping) on
page 1244
v UPDATE VOLHISTORY (Update sequential volume history information) on
page 1246
v UPDATE VOLUME (Change a storage pool volume) on page 1248
UPDATE commands

1050 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE ADMIN (Update an administrator)
Use this command to change the password or contact information for an
administrator. However, you cannot update the SERVER_CONSOLE administrator
name.
You must use the RENAME ADMIN command to change the name of a registered
administrator.
Privilege class
To issue this command to change another administrators password or contact
information, you must have system privilege. Any administrator can issue this
command to update his or her own password or contact information.
Syntax

(1)
UPDate Admin

admin_name

password

PASSExp

=

days

CONtact

=

text

FORCEPwreset

=

No

Yes

EMAILADDRESS

=

userID@node


Notes:
1 You must specify at least one optional parameter on this command.
Parameters
admin_name (Required)
Specifies the name of the administrator to be updated.
password
Specifies the administrators password. This parameter is optional. Passwords
remain current for a period determined by the password expiration period.
PASSExp
Specifies the number of days the password remains valid. You can set the
password expiration period from 0 to 9999 days. A value of 0 means that the
password never expires. This parameter is optional. If you do not specify this
parameter the password expiration period is unchanged.
CONtact
Specifies a text string that identifies the administrator. This parameter is
optional. Enclose the text string in quotation marks if it contains any blanks. To
remove previously defined contact information, specify a null string ().
FORCEPwreset
Specifies whether the administrator is required to change or reset the
password. This parameter is optional. Possible values are:
No
Specifies that the administrator does not need to change or reset the
UPDATE ADMIN
Chapter 2. Administrative commands 1051
|||
password while attempting to sign on to the server. The password
expiration period is set by the SET PASSEXP command.
Yes
Specifies that the administrators password will expire at the next sign on.
The administrator must change or reset the password at that time. If a
password is not specified, you will receive a syntax error.
EMAILADDRESS
This parameter is used by IBM Tivoli Storage Manager Express only. It is
not currently used by Tivoli Storage Manager. Tivoli Storage Manager
Express uses this parameter to specify the E-mail address or addresses for
this administrator. Any reports that are directed to this administrator are
sent to these E-mail addresses in HTML format.
Examples
Task
Update the administrator LARRY to have the password SECRETWORD and a
password expiration period of 120 days.
Command
update admin larry secretword passexp=120
Related commands
Table 352. Commands related to UPDATE ADMIN
Command Description
QUERY ADMIN Displays information about one or more IBM
Tivoli Storage Manager administrators.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
REGISTER ADMIN Defines a new administrator without
granting administrative authority.
REGISTER NODE Defines a client to the server and sets options
for that user.
RENAME ADMIN Changes an IBM Tivoli Storage Manager
administrators name.
SET PASSEXP Specifies the number of days after which a
password is expired and must be changed.
UPDATE NODE Changes the attributes associated with a
client node.

UPDATE ADMIN

1052 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
UPDATE ARCHIVE (Manage archive usage and performance)
Use this command to manage performance and server storage for nodes that
archive large numbers of files. You should issue the UPDATE ARCHIVE command
for nodes that have not had archives converted. If the node has been converted,
you can first issue the UNDO ARCHCONVERSION command, or UPDATE
ARCHIVE processing will perform that operation.
See the Administrators Guide for details.
Note: Do not run the UPDATE ARCHIVE command while any other processing
for the node is running. If this command is issued for a node with any other
object insertion or deletion activity occurring at the same time, locking
contention may occur. This may result in processes and sessions hanging
until the resource timeout is reached and the processes and sessions
terminate.
Privilege class
To issue this command you must have policy privilege for the policy domain for
the node.
Syntax

UPDate ARCHIve

node_name
SHOWstats
SHOWstats

RESETDescriptions

DELETEDirs
Wait = No
Wait

=

No

Yes

Parameters
node_name (Required)
Specifies the node name for the operation.
SHOWstats
Displays statistics about the specified node. This is the default.
The statistics include:
v Number of files and directories
v Whether the node is converted
v Number of entries for directories with the same path specification but
different descriptions
RESETDescriptions
Resets the description field to the same description for all archive entries for a
node. This reduces the number of entries for a given directory specification to
one. If you do not specify either this option or DELETEDIRS, SHOWSTATS
will be the default.
To keep the number of archive packages to a minimum, you should explicitly
specify a description with each archive operation. Note that a single blank is a
valid description in this case.
Attention: This option is destructive. Do not use this option if client users
manage archives by packages, including those who use the GUI and Web
interfaces..
UPDATE ARCHIVE
Chapter 2. Administrative commands 1053
DELETEDirs
Deletes all archive directory objects, including the access permissions, for a
node. If you do not specify either this option or RESETDESCRIPTIONS,
SHOWSTATS will be the default.
Attention: This option is destructive. Do not use this option if client users
need access permissions for archived directories.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is NO. Possible
values are:
No
Specifies that the server processes this command in the background.
Yes
Specifies that the server processes this command in the foreground
Note: You cannot specify WAIT=YES from the server console.
Examples
Task
Display statistics about the node ENGRS. This command can operate in the
background.
Command
update archive engrs showstats
Related commands
Table 353. Commands related to UPDATE ARCHIVE
Command Description
CONVERT ARCHIVE Improves performance for archive functions
for a node.
UNDO ARCHCONVERSION Reverses archive conversion for the node.

UPDATE ARCHIVE

1054 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE BACKUPSET (Update a retention value assigned to a
backup set)
Use this command to update the retention value associated with a clients backup
set.
Privilege class
To issue this command, you must have system privilege or policy privilege for the
domain to which the client node is assigned.
Syntax

UPDate BACKUPSET

,
node__name

node_group_name

,
backup_set_name

RETention = days
NOLimit

BEGINDate

=

date

BEGINTime

=

time

ENDDate

=

date

ENDTime

=

time

WHERERETention

=

days

NOLimit

WHEREDATAType = ALL
,

WHEREDATAType

=

FILE

IMAGE

APPL

WHEREDESCription

=

description

Preview=

No

Yes

VERSion = Any
VERSion

=

Any

Latest

Parameters
node_name or node_group_name(Required)
Specifies the names of the client nodes or node groups whose data is contained
in the specified backup set to be updated. To specify multiple node and node
group names, separate the names with commas and no intervening spaces. The
node names that you specify can contain wildcard characters, but node group
names cannot contain wildcard characters.
UPDATE BACKUPSET
Chapter 2. Administrative commands 1055
backup_set_name (Required)
Specifies the name of the backup set to update. The backup set name you
specify can contain wildcard characters. You can specify more than one backup
set name by separating the names with commas and no intervening spaces.
RETention (Required)
Specifies the updated number of days to retain the backup set on the server.
You can specify an integer from 0 to 30000. The values are:
days
Specifies the updated number of days to retain the backup set.
NOLimit
Specifies that the backup set is retained on the server indefinitely. If you
specify NOLIMIT, the server retains the volumes containing the backup set
forever, unless a user or administrator deletes the volumes from server
storage.
Note: Updating the retention period of a backup set may cause it to expire
at a different time from other backup sets that might be stored on
the same output media. In either case, the media will not be made
available for other uses until all of its backup sets have expired.
BEGINDate
Specifies the beginning date in which the backup set to update was created.
This parameter is optional. The default is the current date. You can use this
parameter with the BEGINTIME parameter to specify a range for the date and
time. If you specify a begin date without a begin time, the time will be at 12:00
a.m. (midnight) on the date you specify.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1999
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified.
TODAY +3 or +3.
TODAY-days or
-days
The current date minus days
specified.
TODAY-3 or -3.

BEGINTime
Specifies the beginning time in which the backup set to update was created.
This parameter is optional. The default is the current time. You can use this
parameter with the BEGINDATE parameter to specify a range for the date and
time. If you specify a begin time without a begin date, the date will be the
current date at the time you specify.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes on the specified end
date
NOW+02:00 or +02:00.
UPDATE BACKUPSET

1056 IBM Tivoli Storage Manager for Windows: Administrators Reference
Value Description Example
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes on the specified
end date
NOW-02:00 or 02:00.

ENDDate
Specifies the ending date in which the backup set to update was created. This
parameter is optional. You can use this parameter with the ENDTIME
parameter to specify a range for the date and time. If you specify an end date
without an ending time, the time will be at 11:59:59 p.m. on the specified end
date.
You can specify the date by using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1999
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified.
TODAY +3 or +3.
TODAY-days or
days
The current date minus days
specified.
TODAY -3 or -3.

ENDTime
Specifies the ending time in which the backup set to update was created. This
parameter is optional. You can use this parameter with the ENDDATE
parameter to specify a range for the date and time. If you specify an end time
without an end date, the date will be the current date at the time you specify.
You can specify the time by using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified
NOW+02:00 or +02:00.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW-02:00 or 02:00.

WHERERETention
Specifies the retention value, specified in days, that is associated with the
backup set to update. The values are:
days
Specifies that the backup set that is retained this number of days is
updated.
NOLimit
Specifies that the backup set retained indefinitely is updated.
WHEREDESCription
Specifies the description that is associated with the backup set to update. This
parameter is optional. You can specify wildcard characters for the description.
Enclose the description in quotation marks if it contains any blank characters.
WHEREDATAType
Specifies the backup sets containing the specified types of data are to be
UPDATE BACKUPSET
Chapter 2. Administrative commands 1057
updated. This parameter is optional. The default is that backup sets for all
types of data (file level, image, and application) are to be updated. To specify
multiple data types, separate each data type with a comma and no intervening
spaces. Possible values are:
ALL
Specifies that backup sets for all types of data (file level, image, and
application) are to be updated. This is the default.
FILE
Specifies that a file level backup set is to be updated. File level backup sets
contain files and directories backup up by the backup-archive client.
IMAGE
Specifies that an image backup set is to be updated. Image backup sets
contain images created by the backup-archive client BACKUP IMAGE
command.
APPL
Specifies that an application backup set is to be updated. Application
backup sets contain data backed up to the Tivoli Storage Manager server
by applications using the Tivoli Storage Manager application programming
interface. This parameter applies only if the Tivoli Storage Manager server
was upgraded from Tivoli Storage Manager Express and only for the Tivoli
Storage Manager Express versions of Data Protection for Exchange and
Data Protection for SQL.
Preview
Specifies whether to preview the list of backup sets to update, without actually
updating the backup sets. This parameter is optional. The default is No. The
values are:
No
Specifies that the backup sets are updated.
Yes
Specifies that the server displays the backup sets to update, without
actually updating the backup sets.
VERSion
Specifies the version of the backup set to update. Backup sets with the same
prefix name are considered to be different versions of the same backup set.
This parameter is optional. The default is to update any version that matches
the criteria specified on the command. The values are:
Any
Specifies that any version that matches the criteria specified on the
command should be updated.
Latest
Specifies that only the most recent version of the backup set should be
updated. If other criteria specified on the command (for example,
ENDDATE or WHERERETENTION) exclude the most recent version of the
backup set, then no backup set will be updated.
Examples
Task
UPDATE BACKUPSET

1058 IBM Tivoli Storage Manager for Windows: Administrators Reference
Update the retention period where the description is Healthy Computers. The
retention period is assigned to backup set PERS_DATA.3099 that contains data
from client node JANE. Change the retention period to 70 days.
Command
update backupset jane pers_data.3099
retention=70 wheredescription="healthy computers"
Related commands
Table 354. Commands related to UPDATE BACKUPSET
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DELETE BACKUPSET Updates a retention value associated with a
backup set.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
GENERATE BACKUPSETTOC Generates a table of contents for a backup set.
QUERY BACKUPSET Displays backup sets.
QUERY BACKUPSETCONTENTS Displays contents contained in backup sets.
QUERY NODEGROUP Displays information about node groups.
UPDATE NODEGROUP Updates the description of a node group.

UPDATE BACKUPSET
Chapter 2. Administrative commands 1059
UPDATE CLIENTOPT (Update a client option sequence
number)
Use this command to update the sequence number of a client option in a client
option set.
Privilege class
To issue this command, you must have system privilege or unrestricted policy
privilege.
Syntax
UPDate CLIENTOpt option_set_name option_name
current_sequence_number new_sequence_number

Parameters
option_set_name (Required)
Specifies the name of the option set.
option_name (Required)
Specifies a valid client option.
current_sequence_number (Required)
Specifies the current sequence number of the option.
new_sequence_number (Required)
Specifies the new sequence number of the option.
Examples
Task
Update current client option sequence number.
Command
update clientopt eng dateformat 0 9
Related commands
Table 355. Commands related to UPDATE CLIENTOPT
Command Description
COPY CLOPTSET Copies a client option set.
DEFINE CLIENTOPT Adds a client option to a client option set.
DELETE CLIENTOPT Deletes a client option from a client option
set.
DELETE CLOPTSET Deletes a client option set.
QUERY CLOPTSET Displays information about a client option
set.

UPDATE CLIENTOPT

1060 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE CLOPTSET (Update a client option set description)
Use this command to update the description for a client option set.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the client
node is assigned.
Syntax
UPDate CLOptset option_set_name DESCription = description

Parameters
option_set_name (Required)
Specifies the name of the option set.
DESCription (Required)
Specifies a description of the client option set. The maximum length of the
description is 255 characters. Enclose the description in quotation marks if it
contains blank characters.
Examples
Task
Update the description for a client option set named ENG.
Command
update cloptset eng description="unix"
Related commands
Table 356. Commands related to UPDATE CLOPTSET
Command Description
COPY CLOPTSET Copies a client option set.
DEFINE CLIENTOPT Adds a client option to a client option set.
DEFINE CLOPTSET Defines a client option set.
DELETE CLIENTOPT Deletes a client option from a client option
set.
DELETE CLOPTSET Deletes a client option set.
QUERY CLOPTSET Displays information about a client option
set.
UPDATE CLIENTOPT Updates the sequence number of a client
option.

UPDATE CLOPTSET
Chapter 2. Administrative commands 1061
UPDATE COLLOCGROUP (Update a collocation group)
Use this command to modify the description of a collocation group.
Privilege class
To issue this command, you must have system or unrestricted storage privilege.
Syntax
UPDate COLLOCGroup group_name DESCription = description

Parameters
group_name
Specifies the name of the collocation group whose description you want to
update.
DESCription
Specifies a description of the collocation group. This parameter is required. The
maximum length of the description is 255 characters. If the description contains
any blanks, enclose the entire description in quotation marks.
Examples
Task
Update the collocation group, group1, with a new description.
Command
update collocgroup group1 "Human Resources"
Related commands
Table 357. Commands related to UPDATE COLLOCGROUP
Command Description
DEFINE COLLOCGROUP Defines a collocation group.
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE COLLOCGROUP Deletes a collocation group.
DELETE COLLOCMEMBER Deletes a client node from a collocation
group.
MOVE NODEDATA Moves data for one or more nodes, or a
single node with selected filespaces.
QUERY COLLOCGROUP Displays information about collocation
groups.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY NODEDATA Displays information about the location and
size of data for a client node.
QUERY STGPOOL Displays information about storage pools.
UPDATE COLLOCGROUP

1062 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 357. Commands related to UPDATE COLLOCGROUP (continued)
Command Description
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
UPDATE STGPOOL Changes the attributes of a storage pool.

UPDATE COLLOCGROUP
Chapter 2. Administrative commands 1063
UPDATE COPYGROUP (Update a copy group)
Use this command to update a backup or archive copy group. To allow clients to
use the updated copy group, you must activate the policy set that contains the
copy group.
Note: The UPDATE COPYGROUP command fails if you specify a copy storage
pool as a destination.
The UPDATE COPYGROUP command takes two forms, depending upon whether
the update is for a backup copy group or for an archive copy group. The syntax
and parameters for each form are defined separately.
Table 358. Commands related to UPDATE COPYGROUP
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
ASSIGN DEFMGMTCLASS Assigns a management class as the default
for a specified policy set.
COPY MGMTCLASS Creates a copy of a management class.
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DEFINE MGMTCLASS Defines a management class.
DELETE COPYGROUP Deletes a backup or archive copy group from
a policy domain and policy set.
DELETE MGMTCLASS Deletes a management class and its copy
groups from a policy domain and policy set.
EXPIRE INVENTORY Manually starts inventory expiration
processing.
QUERY COPYGROUP Displays the attributes of a copy group.
QUERY MGMTCLASS Displays information about management
classes.
UPDATE COPYGROUP

1064 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE COPYGROUP backup
Use this command to update a defined backup copy group.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the copy
group belongs.
Syntax
UPDate COpygroup domain_name policy_set_name class_name
STANDARD

Type

=

Backup

DESTination

=

pool_name

FREQuency

=

days

VERExists

=

number

NOLimit

VERDeleted

=

number

NOLimit

RETExtra

=

days

NOLimit

RETOnly

=

days

NOLimit

MODE

=

MODified

ABSolute

SERialization

=

SHRSTatic

STatic

SHRDYnamic

DYnamic

TOCDestination

=

pool_name


Parameters
domain_name (Required)
Specifies the policy domain to which the copy group belongs.
policy_set_name (Required)
Specifies the policy set to which the copy group belongs. You cannot update a
copy group in the ACTIVE policy set.
class_name (Required)
Specifies the management class to which the copy group belongs.
STANDARD
Specifies the copy group, which must be STANDARD. This parameter is
optional.
Type=Backup
Specifies that you want to update a backup copy group. This parameter is
optional.
DESTination
Specifies the primary storage pool where the server initially stores backup
data. This parameter is optional. You cannot specify a copy storage pool as the
destination.
UPDATE COPYGROUP Backup
Chapter 2. Administrative commands 1065
FREQuency
Specifies how frequently the server can back up a file. This parameter is
optional. The server backs up a file only when the specified number of days
has elapsed since the last backup. The FREQUENCY value is used only during
a full incremental backup operation. This value is ignored during selective
backup or partial incremental backup. You can specify an integer from 0 to
9999. The value 0 means that the server can back up a file regardless of when
the file was last backed up.
VERExists
Specifies the maximum number of backup versions to retain for files that are
currently on the client file system. This parameter is optional.
If an incremental backup causes the limit to be exceeded, the server expires the
oldest backup version that exists in server storage. Possible values are:
number
Specifies the number of backup versions to retain for files that are
currently on the client file system. You can specify an integer from 1 to
9999.
NOLimit
Specifies that you want the server to retain all backup versions.
The number of backup versions to retain is controlled by this parameter until
versions exceed the retention time specified by the RETEXTRA parameter.
VERDeleted
Specifies the maximum number of backup versions to retain for files that have
been deleted from the client file system after being backed up using the server.
This parameter is optional.
If a user deletes a file from the client file system, the next incremental backup
causes the server to change the active backup version of the file to inactive and
expire the oldest versions in excess of this number. The expiration date for the
remaining versions is determined by the retention time specified by the
RETEXTRA or RETONLY parameter. Possible values are:
number
Specifies the number of backup versions to retain for files that are deleted
from the client file system after being backed up. You can specify a value
from 0 to 9999.
NOLimit
Specifies that you want the server to retain all backup versions for files
that are deleted from the client file system after being backed up.
RETExtra
Specifies the number of days that the server retains a backup version after that
version becomes inactive. A version of a file becomes inactive when the client
stores a more recent backup version, or when the client deletes the file from
the workstation and then runs a full incremental backup. The server deletes
inactive versions based on retention time even if the number of inactive
versions does not exceed the number allowed by the VEREXISTS or
VERDELETED parameters. This parameter is optional. Possible values are:
days
Specifies the number of days to retain inactive backup versions. You can
specify an integer from 0 to 9999.
NOLimit
Specifies that you want to retain inactive backup versions indefinitely.
UPDATE COPYGROUP Backup

1066 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
If you specify NOLIMIT, the server deletes extra backup versions based on
the VEREXISTS parameter (when the file still exists on the client file
system) or the VERDELETED parameter (when the file no longer exists on
the client file system).
RETOnly
Specifies the number of days to retain the last backup version of a file that has
been deleted from the client file system. This parameter is optional. Possible
values are:
days
Specifies the number of days to retain the last remaining inactive copy of a
file. You can specify an integer from 0 to 9999.
NOLimit
Specifies that you want to keep the last remaining inactive version of a file
indefinitely.
If you specify NOLIMIT, the server retains the last remaining backup
version forever, unless a user or administrator deletes the file from server
storage.
MODE
Specifies whether the server backs up a file only if the file has changed since
the last backup, or whenever a client requests a backup. This parameter is
optional. Possible values are:
MODified
Specifies that the file is backed up only if it has changed since the last
backup. A file is considered changed if any of the following is true:
v The date last modified is different
v The file size is different
v The file owner is different
v The file permissions are different
ABSolute
Specifies that the file is backed up regardless of whether it has been
changed.
The MODE value is used only for full incremental backup. This value is
ignored during partial incremental backup or selective backup.
SERialization
Specifies how the server handles files or directories when they are modified
during backup processing. This parameter is optional. Possible values are:
SHRSTatic
Specifies that the server backs up a file or directory only if it is not being
modified during backup. The server attempts to perform a backup as
many as four times, depending on the value specified for the
CHANGINGRETRIES client option. If the file or directory is modified
during each backup attempt, the server does not back it up.
STatic
Specifies that the server backs up a file or directory only if it is not being
modified during backup. The server attempts to perform the backup only
once.
Platforms that do not support the STATIC option default to SHRSTATIC.
UPDATE COPYGROUP Backup
Chapter 2. Administrative commands 1067
SHRDYnamic
Specifies that if the file or directory is being modified during a backup
attempt, the server backs up the file or directory during the last attempt
even though the file or directory is being modified. the server attempts to
perform a backup as many as four times, depending on the value specified
for the CHANGINGRETRIES client option.
DYnamic
Specifies that the server backs up a file or directory on the first attempt,
regardless of whether the file or directory is being modified during backup
processing.
Attention: Be careful about using the SHRDYNAMIC and DYNAMIC values.
These values allow the server to back up a file or directory while modifications
are occurring. As a result, the backup version might be a fuzzy backup. A
fuzzy backup does not accurately reflect what is currently in the file or
directory because it contains some, but not all, modifications. If a file that
contains a fuzzy backup is restored, the file may or may not be usable,
depending on the application that uses the file. If a fuzzy backup is not
acceptable, be sure to use a serialization value that allows the server to create a
backup version only if the file or directory is not being modified (SHRSTATIC
or STATIC).
TOCDestination
Specifies the primary storage pool in which a table of contents (TOC) will
initially be stored for any NDMP backup or backup set operation for which a
TOC is generated. This parameter is optional. You cannot specify a copy
storage pool as the destination. The storage pool specified for the destination
must have NATIVE or NONBLOCK data format. To avoid mount delays, it is
recommended that the storage pool have a device class of DISK or
DEVTYPE=FILE. TOC generation is an option for NDMP backup operations,
but is not supported for other image-backup operations.
To remove an existing TOC destination from the copy group, specify a null
string () for this value.
If TOC creation is requested for a backup operation that uses NDMP and the
image is bound to a management class whose backup copy group does not
specify a TOC destination, the outcome will depend on the TOC parameter for
the backup operation.
v If TOC=PREFERRED (the default), the backup proceeds without creation of
a TOC.
v If TOC=YES, the entire backup fails because no TOC can be created.
Examples
Task
Update the backup copy group (STANDARD) in the EMPLOYEE_RECORDS policy
domain, VACATION policy set, ACTIVEFILES management class. Change the
destination to DISKPOOL, with a minimum interval of seven days between
backups, regardless of whether the files have been modified. Retain up to three
backup versions while a file still exists on a client file system.
Command
update copygroup employee_records vacation
activefiles type=backup destination=diskpool
frequency=7 verexists=3 mode=absolute
UPDATE COPYGROUP Backup

1068 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE COPYGROUP archive
Use this command to update a defined archive copy group.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the copy
group belongs.
Syntax
UPDate COpygroup domain_name policy_set_name class_name
STANDARD

Type = Archive
DESTination

=

pool_name

FREQuency

=

Cmd

RETVer

=

days

NOLimit

MODE

=

ABSolute

RETMin

=

days

SERialization

=

SHRSTatic

STatic

SHRDYnamic

DYnamic


Parameters
domain_name (Required)
Specifies the policy domain to which the copy group belongs.
policy_set_name (Required)
Specifies the policy set to which the copy group belongs. You cannot update a
copy group in the ACTIVE policy set.
class_name (Required)
Specifies the management class to which the copy group belongs.
STANDARD
Specifies the copy group, which must be STANDARD. This parameter is
optional.
Type=Archive
Specifies that you want to update an archive copy group. This parameter is
required.
DESTination
Specifies the primary storage pool where the server initially stores the archive
copy. This parameter is optional. You cannot specify a copy storage pool as the
destination.
FREQuency=Cmd
Specifies the copy frequency, which must be CMD. This parameter is optional.
RETVer
Specifies the number of days to keep an archive copy. This parameter is
optional. Possible values are:
UPDATE COPYGROUP Archive
Chapter 2. Administrative commands 1069
days
Specifies the number of days to keep an archive copy. You can specify an
integer from 0 to 30000.
NOLimit
Specifies that you want to keep an archive copy indefinitely.
If you specify NOLIMIT, the server retains archive copies forever, unless a
user or administrator deletes the file from server storage.
The value of the RETVER parameter can affect the management class to which
the server binds an archived directory. If the client does not use the ARCHMC
option, the server binds directories that are archived to the default
management class. If the default management class has no archive copy group,
the server binds directories that are archived to the management class with the
shortest retention period.
MODE=ABSolute
Specifies that a file is always archived when the client requests it. The MODE
must be ABSOLUTE. This parameter is optional.
RETMin
Specifies the minimum number of days to keep an archive copy after it has
been archived. This parameter is optional. The default value is 365.
SERialization
Specifies how the server handles files that are modified during archive. This
parameter is optional. Possible values are:
SHRSTatic
Specifies that the server does not archive a file that is being modified. The
server attempts to perform an archive as many as four times, depending
on the value specified for the CHANGINGRETRIES client option. If the file
is modified during the archive attempt, the server does not archive the file.
STatic
Specifies that the server does not archive a file that is being modified. If a
file is modified during the archive attempt, the server does not archive the
file.
Platforms that do not support the STATIC option default to SHRSTATIC.
SHRDYnamic
Specifies that if the file is being modified during an archive attempt, the
server archives the file during its last attempt even though the file is being
modified. The server attempts to archive the file as many as four times,
depending on the value specified for the CHANGINGRETRIES client
option.
DYnamic
Specifies that the server archives a file on the first attempt, regardless of
whether the file is being modified during archive processing.
UPDATE COPYGROUP Archive

1070 IBM Tivoli Storage Manager for Windows: Administrators Reference
Attention: Be careful about using the SHRDYNAMIC and DYNAMIC values.
These values allow the server to archive a file while modifications are
occurring. As a result, the archive copy might be a fuzzy backup. A fuzzy
backup does not accurately reflect what is currently in the file because it
contains some, but not all, modifications. If a file that contains a fuzzy backup
is retrieved, the file may or may not be usable, depending on the application
that uses the file. If a fuzzy backup is not acceptable, be sure to use a
serialization value that allows the server to create an archive copy only if the
file is not being modified (SHRSTATIC or STATIC).
Attention: Be cautious when selecting retention values for primary storage
pools which are of type RECLAMATIONTYPE=SNAPLOCK. Volumes in these
types of storage pools cannot be deleted until after their retention dates have
passed.
Examples
Task
Update the archive copy group (STANDARD) in the EMPLOYEE_RECORDS policy
domain, VACATION policy set, ACTIVEFILES management class. Change the
destination to TAPEPOOL. Keep archive copies for 190 days.
Command
update copygroup employee_records vacation
activefiles standard type=archive
destination=tapepool retver=190
UPDATE COPYGROUP Archive
Chapter 2. Administrative commands 1071
UPDATE DATAMOVER (Update a data mover)
Use this command to update the definition for a data mover or set a data mover
off-line when the hardware is being maintained.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DATAMover data_mover_name
HLAddress

=

address

LLAddress

=

tcp_port

USERid

=

userid

PASsword

=

password

ONLine

=

Yes

No


Parameters
data_mover_name (Required)
Specifies the name of the data mover.
HLAddress
Specifies either the new numerical IP address or the new domain name, which
is used to access the NAS file server. This parameter is optional.
LLAddress
Specifies the new TCP port number to access the NAS file server for Network
Data Management Protocol (NDMP) sessions. This parameter is optional.
USERid
Specifies the user ID for a user that is authorized to initiate an NDMP session
with the NAS file server. For example, enter the administrative ID for a
Network Appliance file server. This parameter is optional.
PASsword
Specifies the new password for the user ID to log onto the NAS file server.
This parameter is optional.
ONLine
Specifies whether the data mover is available for use. This parameter is
optional.
Yes
Specifies that the data mover is available for use.
No
Specifies that the data mover is not available for use.
Attention: If a library is controlled using a path from a data mover to the
library, and the data mover is offline, the server will not be able to access
the library. If the server is halted and restarted while the data mover is
offline, the library will not be initialized.
UPDATE DATAMOVER

1072 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task
Update the data mover for the node named NAS1. Change the numerical IP
address from 9.67.97.103 to 9.67.97.109.
Command
update datamover nas1 hladdress=9.67.97.109
Task
Update the data mover for the node named NAS1. Change the numerical IP
address from 9.67.97.109 to the domain name of NETAPP2.TUCSON.IBM.COM.
Command
update datamover nas1 hladdress=netapp2.tucson.ibm.com
Related commands
Table 359. Commands related to UPDATE DATAMOVER
Command Description
DEFINE DATAMOVER Defines a data mover to the IBM Tivoli
Storage Manager server.
DEFINE PATH Defines a path from a source to a destination.
DELETE DATAMOVER Deletes a data mover.
QUERY DATAMOVER Displays data mover definitions.
REGISTER NODE Defines a client to the server and sets options
for that user.
UPDATE NODE Changes the attributes associated with a
client node.

UPDATE DATAMOVER
Chapter 2. Administrative commands 1073
UPDATE DBBACKUPTRIGGER (Update the database backup
trigger)
Use this command to update the database backup trigger.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DBBackuptrigger
LOGFullpct

=

percentage

DEVclass

=

device_class_name

INCRDEVclass

=

device_class_name

NUMINCremental

=

number

MININTerval

=

minutes

MINLOGFREEpct

=

percent


Parameters
LOGFullpct
Specifies a recovery log utilization percentage. When this value is exceeded,
Tivoli Storage Manager backs up the database. The range is from 1 to 99.
DEVclass
Specifies the name of the sequential access device class to use for backups.
If all drives associated with this device class are busy when the backup is
triggered, Tivoli Storage Manager cancels lower priority operations, such as
reclamation, to make a drive available for the backup.
INCRDEVclass
Specifies the name of the sequential access device class to use for incremental
backups.
NUMINCremental
Specifies the maximum number of incremental backups that can be run before
a full backup is required. The range is from 0 to 32. A value of 0 specifies that
Tivoli Storage Manager runs only full backups.
Each incremental backup, whether run automatically or run by an
administrator request, is added to the count of incremental backups run.
Each full backup, whether run automatically or run by an administrator
request, resets the count for incremental backups to zero.
Note: If you explicitly request an incremental backup, Tivoli Storage Manager
performs one even if the number exceeds this setting. This occurs if the
backup is done by an administrator or through an administrative
schedule.
UPDATE DBBACKUPTRIGGER

1074 IBM Tivoli Storage Manager for Windows: Administrators Reference
MININTerval
Specifies the minimum number of minutes that must elapse between a
previous backup and a subsequent automatic backup. The range is from 0 to
9999.
Each backup, whether run automatically or requested by an administrator,
resets the time of the last backup. A database snapshot will not reset the time
of the last backup. When the server is started, the time of the last backup is
assumed to be far in the past, beyond the longest minimum interval.
Either the minimum interval condition or the minimum amount of log space
freed condition or both conditions must be met in order for the automatic
backup to take place.
MINLOGFREEpct
Specifies a recovery log utilization percentage from 0 to 99. This is the
minimum amount of log space that must be freed by the automatic backup
before the backup will be performed.
Either the minimum interval condition or the minimum amount of log space
freed condition must be met in order for an automatic backup to take place.
Examples
Task
Reset the database backup trigger to 60 percent and the number of incremental
backups to 5.
Command
update dbbackuptrigger logfull=60 numincremental=5
Related commands
Table 360. Commands related to UPDATE DBBACKUPTRIGGER
Command Description
BACKUP DB Backs up the IBM Tivoli Storage Manager
database to sequential access volumes.
DEFINE DBBACKUPTRIGGER Defines a trigger for automatic IBM Tivoli
Storage Manager database backups.
DEFINE DEVCLASS Defines a device class.
DELETE DBBACKUPTRIGGER Deletes the database backup trigger.
QUERY DBBACKUPTRIGGER Displays information about the database
backup trigger.
SET LOGMODE Sets the mode for saving records in the
recovery log.

UPDATE DBBACKUPTRIGGER
Chapter 2. Administrative commands 1075
UPDATE DEVCLASS (Update the attributes of a device class)
Use this command to update a defined device class.
Note: The DISK device class is predefined by IBM Tivoli Storage Manager and
cannot be modified with the UPDATE DEVCLASS command.
The syntax and parameter descriptions are provided according to the device type.
The syntax and parameter information is presented in the following order:
v 3570 (Syntax on page 1077)
v 3590 (Syntax on page 1080)
v 3592(Syntax on page 1084)
v 4MM (Syntax on page 1088)
v 8MM (Syntax on page 1092)
v CENTERA (Syntax on page 1097)
v DLT (Syntax on page 1099)
v DTF (Syntax on page 1104)
v FILE (Syntax on page 1111)
v GENERICTAPE (Syntax on page 1115)
v LTO (Syntax on page 1117)
v NAS (Syntax on page 1122)
v OPTICAL and WORM Types (Syntax on page 1124)
v QIC (Syntax on page 1128)
v REMOVABLEFILE (Syntax on page 1132)
v SERVER (Syntax on page 1134)
v VOLSAFE(Syntax on page 1136)
Table 361. Commands related to UPDATE DEVCLASS
Command Description
BACKUP DEVCONFIG Backs up IBM Tivoli Storage Manager device
information to a file.
DEFINE DEVCLASS Defines a device class.
DEFINE LIBRARY Defines an automated or manual library.
DELETE DEVCLASS Deletes a device class name.
QUERY DEVCLASS Displays information about device classes.
QUERY DIRSPACE Displays information about FILE directories.
UPDATE LIBRARY Changes the attributes of a library.
UPDATE DEVCLASS

1076 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE DEVCLASS 3570
Use the 3570 device class when you are using 3570 tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

DRIVE

3570B

3570C

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be defined.
LIBRary
Specifies the name of the defined library object that contains the tape drives
that can be used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
The following table lists the recording formats and estimated capacities for
3570 devices:
Table 362. Recording format and default estimated capacity for 3570 tape volumes
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
3570B 5.0GB Uncompressed (basic) format
UPDATE DEVCLASS 3570
Chapter 2. Administrative commands 1077
Table 362. Recording format and default estimated capacity for 3570 tape
volumes (continued)
Format
Estimated
Capacity Description
3570C
See note
10.0GB
Compressed format
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

ESTCAPacity
Specifies the estimated capacity for the volumes categorized by this device
class. This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes).
For more information on the default estimated capacity for 3570 cartridge
tapes, see Table 362 on page 1077.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The maximum length of this prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, consider using a volume prefix that
conforms to your naming conventions.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the number of minutes, to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types setting this parameter to a low value (for example, two minutes)
enhances device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
UPDATE DEVCLASS 3570

1078 IBM Tivoli Storage Manager for Windows: Administrators Reference
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mountlimit value
(including online status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.
UPDATE DEVCLASS 3570
Chapter 2. Administrative commands 1079
UPDATE DEVCLASS 3590
Use the 3590 device class when you are using 3590 tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

DRIVE

3590B

3590C

3590E-B

3590E-C

3590H-B

3590H-C

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be defined.
LIBRary
Specifies the name of the defined library object that contains the tape drives
that can be used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
The following tables list the recording formats, estimated capacities and
recording format options for 3590 devices:
UPDATE DEVCLASS 3590

1080 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 363. Recording formats and default estimated capacities for 3590
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
3590B 10.0GB Uncompressed (basic) format
3590C See note
20.0GB
Compressed format
3590E-B 10.0GB Uncompressed (basic) format, similar to the 3590B
format
3590E-C See note
20.0GB
Compressed format, similar to the 3590C format
3590H-B 30.0GB (J
cartridge
standard length)
60.0GB (K
cartridge
extended length)
Uncompressed (basic) format, similar to the 3590B
format
3590H-C See note
60.0GB (J
cartridge
standard length)
120.0GB (K
cartridge
extended length)
Compressed format, similar to the 3590C format
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

Table 364. 3590 device recording format selections
Device
Format
3590B 3590C 3590E-B 3590E-C 3590H-B 3590H-C
3590
Ultra SCSI
3590E
3590H
Read/Write
Read/Write
Read
Read
Read/Write
Read/Write
Read
Read


Read/Write
Read


Read/Write
Read



Read/Write



Read/Write

ESTCAPacity
Specifies the estimated capacity for the sequential access volumes categorized
by this device class. This parameter is optional.
UPDATE DEVCLASS 3590
Chapter 2. Administrative commands 1081
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The maximum length of this prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, consider using a volume prefix that
conforms to your naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetical or national (@,#,$),
followed by alphabetical, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types, setting this parameter to a low value (for example, two minutes)
enhances device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
UPDATE DEVCLASS 3590

1082 IBM Tivoli Storage Manager for Windows: Administrators Reference
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete, but new transactions will
be terminated.
UPDATE DEVCLASS 3590
Chapter 2. Administrative commands 1083
UPDATE DEVCLASS 3592
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

SCALECAPacity

=

100

90

20

FORMAT

=

DRIVE

3592

3592C

3592-2

3592-2C

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0

DRIVEEncryption

=

ON

ALLOW

OFF


Parameters
device_class_name (Required)
Specifies the name of the device class to be updated. The maximum length of
the device class name is 30 characters.
LIBRary
Specifies the name of the defined library object that contains the tape drives
that can be used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
SCALECAPacity
Specifies the percentage of the media capacity that can be used to store data.
This parameter is optional. Possible values are 20, 90, or 100.
Setting the scale capacity percentage to 100 provides maximum storage
capacity. Setting it to 20 provides fastest access time.
Note: The scale capacity value will only take effect when data is first written
to a volume. Any updates to the device class for scale capacity will not
affect volumes that already have data written to them until the volume
is returned to scratch status.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
UPDATE DEVCLASS 3592

1084 IBM Tivoli Storage Manager for Windows: Administrators Reference
If the drives are in a library that includes drives of different tape technology,
do not use the DRIVE value. Use the specific format that the drives use. Refer
to the Administrators Guide for more information.
The following table lists the recording formats, estimated capacities and
recording format options for 3592 devices:
Table 365. Recording formats and default estimated capacities for 3592
Format
Estimated
Capacity
Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
3592 300GB Uncompressed (basic) format
3592C
See note
900GB
Compressed format
3592-2 500 GB Uncompressed (basic) format
3592-2C 1500 GB Compressed format
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

Note: Mixing 3592 and 3592-2 drives in a SCSI library is not recommended. If
you must mix drive generations in a SCSI library, use one of the special
configurations described in the Administrators Guide to prevent or
minimize media problems. For optimal performance, upgrade all drives
to 3592-2.
Special configurations are also required for mixing 3592 and 3592-2
drives in 349x and ACSLS libraries. For details, see the Administrators
Guide.
ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
PREFIX
Specifies the high-level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
UPDATE DEVCLASS 3592
Chapter 2. Administrative commands 1085
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The maximum length of this prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
MOUNTRetention
Specifies the amount of time, in minutes, to retain an idle sequential access
volume before dismounting it. This parameter is optional. You can specify a
number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types, setting this parameter to a low value (for example, two minutes)
enhances device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DRIVEEncryption
Specifies whether drive encryption is permitted. This parameter is optional.
UPDATE DEVCLASS 3592

1086 IBM Tivoli Storage Manager for Windows: Administrators Reference
Updating this parameter will affect empty volumes only. If a filling volume
was previously encrypted or is currently unencrypted, and you update the
DRIVEENCRYPTION parameter, the volume maintains its original
encrypted or unencrypted status. The filling volume also maintains its
original key-management status.
ON
Specifies that Tivoli Storage Manager is the key manager for drive
encryption and will permit drive encryption for empty storage pool
volumes only if the application method is enabled. (Other types of
volumesfor example, backup sets, export volumes, and database
backup volumeswill not be encrypted.) If you specify ON and you
enable either the library or system method of encryption, drive
encryption will not be permitted and backup operations will fail.
ALLOW
Specifies that Tivoli Storage Manager does not manage the keys for
drive encryption. However, drive encryption for empty volumes is
permitted if either the library or system method of encryption is
enabled.
OFF
Specifies that drive encryption will not be permitted. If you enable
either the library or system method of encryption, backups will fail. If
you enable the application method, Tivoli Storage Manager will disable
encryption and backups will be attempted.
UPDATE DEVCLASS 3592
Chapter 2. Administrative commands 1087
|
|
|
|
|
|
|
UPDATE DEVCLASS 4MM
Use the 4MM device class when you are using 4 mm tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

DRIVE

DDS1

DDS1C

DDS2

DDS2C

DDS3

DDS3C

DDS4

DDS4C

DDS5

DDS5C

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTWait

=

minutes

MOUNTRetention

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be defined.
LIBRary
Specifies the name of the defined library object that contains the 4mm tape
drives used by this device class. This parameter is optional. For information
about defining a library object, see the DEFINE LIBRARY command.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
The following table lists the recording formats and estimated capacities for
4mm devices:
UPDATE DEVCLASS4MM

1088 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 366. Recording formats and default estimated capacities for 4mm tapes
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
DDS1 1.3GB (60-meter)
2.0GB (90-meter)
Uncompressed format, applies only to 60-meter and
90-meter tapes
DDS1C See note
1.3GB (60-meter)
2.0GB (90-meter)
Compressed format, applies only to 60-meter and
90-meter tapes
DDS2 4.0GB Uncompressed format, only applies to 120-meter
tapes
DDS2C See note
8.0GB
Compressed format, only applies to 120-meter tapes
DDS3 12.0GB Uncompressed format, only applies to 125-meter
tapes
DDS3C See note
24.0GB
Compressed format, only applies to 125-meter tapes
DDS4 20.0GB Uncompressed format, only applies to 150-meter
tapes
DDS4C See note
40.0GB
Compressed format, only applies to 150-meter tapes
DDS5 36GB Uncompressed format, when using DAT 72 media
DDS5C See note
72GB
Compressed format, when using DAT 72 media
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

ESTCAPacity
Specifies the estimated capacity for the sequential access volumes categorized
by this device class. This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
UPDATE DEVCLASS4MM
Chapter 2. Administrative commands 1089
For more information on the default estimated capacity for 4mm tapes, see
Table 366 on page 1089.
PREFIX
Specifies the high level qualifier of the file name that the server writes into the
sequential access media labels. For each sequential access volume assigned to
this device class, the server uses this prefix to create the data set name. This
parameter is optional. The maximum length of this prefix is 8 characters.
If you have already established a tape label naming convention that supports
your current tape management system, consider using a tape volume prefix
that conforms to your naming conventions.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mount limit value
(including online status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
UPDATE DEVCLASS4MM

1090 IBM Tivoli Storage Manager for Windows: Administrators Reference
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.
UPDATE DEVCLASS4MM
Chapter 2. Administrative commands 1091
UPDATE DEVCLASS 8MM
Use the 8MM device class when you are using 8 mm tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

DRIVE

8200

8200C

8500

8500C

8900

AIT

AITC

M2

M2C

SAIT

SAITC

VXA2

VXA2C

VXA3

VXA3C

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be updated.
LIBRary
Specifies the name of the defined library object that contains the 8mm tape
drives that can be used by this device class. For information about defining a
library object see the DEFINE LIBRARY command.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
The following table lists the recording formats and estimated capacities for
8mm devices:
UPDATE DEVCLASS 8MM

1092 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 367. Recording format and default estimated capacity for 8mm tape
Format
Medium Type Estimated Capacity Description
DRIVE The server selects the highest format that is supported by
the drive on which a volume is mounted.
Attention: Avoid specifying DRIVE when a mixture of
drives is used within the same library. For example, do not
use this option for a library containing some drives that
support recording formats superior to other drives.
8200 2.3GB Uncompressed (standard) format, using standard 112-meter
tape cartridges
8200C See note
3.5GB
4.6GB
Compressed format, using standard 112-meter tape
cartridges
8500
15m
15m
15m
54m
54m
54m
112m
112m
112m
160m XL
See note
600MB
600MB
600MB
2.35GB
2.35GB
2.35GB
5GB or 10.0GB
5GB or 10.0GB
5GB or 10.0GB
7GB
Drives (Read Write)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
8500C
15m
15m
15m
54m
54m
54m
112m
112m
112m
160m XL
See note
1.2GB
1.2GB
1.2GB
4.7GB
4.7GB
4.7GB
5GB or 10.0GB
5GB or 10.0GB
5GB or 10.0GB
7GB
Drives (Read Write)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
Exabyte 8500/8500C (RW)
Exabyte 8505 (RW)
Eliant 820 (RW)
8900
15m
54m
112m
160m XL
22m
125m
170m
See note




2.5 GB

40 GB
Drive (Read Write)
Mammoth 8900 (R)
Mammoth 8900 (R)
Mammoth 8900 (R)
Mammoth 8900 (R)
Mammoth 8900 (RW)
Mammoth 8900 (RW with upgrade)
Mammoth 8900 (RW)
UPDATE DEVCLASS 8MM
Chapter 2. Administrative commands 1093
Table 367. Recording format and default estimated capacity for 8mm tape (continued)
Format
Medium Type Estimated Capacity Description
AIT
SDX125C
SDX135C
SDX236C
SDX250C
SDX3100C
SDX3X-150C
SDX4200C
SDX5-400C
See note
25GB
35GB
36GB
50GB
100GB
150GB
200GB
400GB
Drive
AIT, AIT2 and AIT3 drives
AIT, AIT2 and AIT3 drives
AIT2 and AIT3 drives
AIT2 and AIT3 drives
AIT3, AIT4, and AIT5 drives
AIT3-Ex, AIT4, and AIT5 drives
AIT4 and AIT5 drives
AIT5 drive
AITC
SDX125C
SDX135C
SDX236C
SDX250C
SDX3100C
SDX3X-150C
SDX4200C
SDX5-400C
See note
50GB
91GB
72GB
130GB
260GB
390GB
520GB
1040GB
Drive
AIT, AIT2 and AIT3 drives
AIT, AIT2 and AIT3 drives
AIT2 and AIT3 drives
AIT2 and AIT3 drives
AIT3, AIT4, and AIT5 drives
AIT3-Ex, AIT4, and AIT5 drives
AIT4 and AIT5 drives
AIT5 drive
M2
75m
150m
225m
See note
20.0GB
40.0GB
60.0GB
Drive (Read Write)
Mammoth II (RW)
Mammoth II (RW)
Mammoth II (RW)
M2C
75m
150m
225m
See note
50.0GB
100.0GB
150.0GB
Drive (Read Write)
Mammoth II (RW)
Mammoth II (RW)
Mammoth II (RW)
SAIT See note
500GB
Drive (Read Write)
Sony SAIT1500(RW)
SAITC See note
1300GB (1.3TB)
Drive (Read Write)
Sony SAIT1500(RW)
VXA2
V6 (62m)
V10 (124m)
V17 (170m)
See note
20GB
40GB
60GB
Drive (Read Write)
VXA2
VXA2C
V6 (62m)
V10 (124m)
V17 (170m)
See note
40GB
80GB
120GB
Drive (Read Write)
VXA2
VXA3
X6 (62m)
X10 (124m)
X23 (230m)
See note
40GB
86GB
160GB
Drive (Read Write)
VXA3
UPDATE DEVCLASS 8MM

1094 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 367. Recording format and default estimated capacity for 8mm tape (continued)
Format
Medium Type Estimated Capacity Description
VXA3C
X6 (62m)
X10 (124m)
X23 (230m)
See note
80GB
172GB
320GB
Drive (Read Write)
VXA3
Note: The actual capacities may vary depending on which cartridges and drives are used.
v For the AITC and SAITC formats, the normal compression ratio is 2.6:1.
v For the M2C format, the normal compression ratio is 2.5:1.

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes. The smallest value allowed is
100KB (that is, ESTCAPACITY=100K).
For more information on the default estimated capacity for 8mm tapes, see
Table 367 on page 1093.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The maximum length of this prefix is 8 characters.
If you have already established a tape label naming convention that supports
your current tape management system, consider using a tape volume prefix
that conforms to your naming conventions.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online.
For EXTERNAL library types (that is, a library managed by an external media
management system), set this parameter to a low value (for example, two
minutes) to enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
UPDATE DEVCLASS 8MM
Chapter 2. Administrative commands 1095
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mountlimit value
(including online status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete, but new transactions will
be terminated.
Examples
Task
Update a device class named 8MMTAPE. Change the mount limit to 3 and the
estimated capacity to 10GB.
Command
update devclass 8mmtape mountlimit=3 estcapacity=10G
Task
Update an 8mm device class named 8MMTAPE to a 15-minute mount retention.
Command
update devclass 8mmtape mountretention=15
UPDATE DEVCLASS 8MM

1096 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE DEVCLASS CENTERA
Use the CENTERA device class when you are using EMC Centera storage devices.
The CENTERA device type uses files as volumes to store data sequentially. It is
similar to the FILE device class.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax

UPDate DEVclass

device_class_name
(1)
HLAddress

=

ip_address?PEA_file

MINCAPacity

=

size

MOUNTLimit

=

number


Notes:
1 For each Centera device class, you must specify an IP address. However, a
Pool Entry Authorization (PEA) file name and path are optional, and the PEA
file specification must follow the IP address. Use the ? character to separate
the PEA file name and path from the IP address.
Parameters
device_class_name (Required)
Specifies the name of the device class to be updated. The maximum length of
the device class name is 30 characters.
HLAddress
Specifies an IP address for the Centera storage device and, optionally, the name
and path of one Pool Entry Authorization (PEA) file. Specify the IP address
using the dotted decimal format (for example, 9.10.111.222). A Centera device
might have multiple IP addresses. However, you only need to specify one of
them as a value for this parameter.
If you append the name and path of a PEA file, ensure that the file is stored in
a directory on the system running the Tivoli Storage Manager server. Separate
the PEA file name and path from the IP address or addresses using the ?
character, for example:
HLADDRESS=9.10.111.222?c:\controlFiles\TSM.PEA
Specify only one PEA file name and path for each device class definition. If
you specify two different Centera device classes that point to the same Centera
storage device and if the device class definitions contain different PEA file
names and paths, the Tivoli Storage Manager server will use the PEA file
specified in the device class HLADDRESS parameter that was first used to
open the Centera storage device.
Note:
1. The Tivoli Storage Manager server does not include a PEA file
during installation. If you do not create a PEA file, the Tivoli Storage
Manager server uses the Centera default profile, which can allow
applications to read, write, delete, purge, and query data on a
UPDATE DEVCLASS CENTERA
Chapter 2. Administrative commands 1097
Centera storage device. To provide tighter control, create a PEA file
using the command line interface provided by EMC Centera. For
details about Centera authentication and authorization, refer to the
EMC Centera Programmers Guide.
2. You can also specify the PEA file name and path in an environment
variable using the syntax CENTERA_PEA_LOCATION=filePath_
fileName. The PEA file name and path specified using this
environment variable apply to all Centera clusters. If you use this
variable, you do not need to specify the PEA file name and path
using the HLADDRESS parameter.
3. Updating the device class with a new or changed PEA file name and
location could require a server restart if the Centera storage device
identified by the IP address has already been accessed in the current
instance of the Tivoli Storage Manager server.
MINCAPacity
Specifies the new minimum size for Centera volumes assigned to a storage
pool in this device class. This value represents the minimum amount of data
stored on a Centera volume before the Tivoli Storage Manager server marks it
full. Centera volumes will continue to accept data until the minimum amount
of data has been stored. This parameter is optional.
size
Specify this value as an integer followed by K (Kilobytes), M (Megabytes),
or G (Gigabytes). The minimum value allowed is 1MB
(MINCAPACITY=1M). The maximum value allowed is 128GB
(MINCAPacity=128G).
MOUNTLimit
Specifies the new maximum number of sessions accessing the Centera device.
This parameter is optional. You can specify any number from 0 or greater;
however, the sum of all mount limit values for all device classes assigned to
the same Centera device should not exceed the maximum number of sessions
allowed by Centera.
UPDATE DEVCLASS CENTERA

1098 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE DEVCLASS DLT
Use the DLT device class when you are using DLT tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

DRIVE

DLT1

DLT1C

DLT10

DLT10C

DLT15

DLT15C

DLT20

DLT20C

DLT35

DLT35C

DLT40

DLT40C

DLT2

DLT2C

DLT4

DLT4C

SDLT

SDLTC

SDLT320

SDLT320C

SDLT600

SDLT600C

DLTS4

DLTS4C

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be updated.
LIBRary
Specifies the name of the defined library object that contains the DLT tape
drives that can be used by this device class. For information about defining a
library object see the DEFINE LIBRARY command.
UPDATE DEVCLASS DLT
Chapter 2. Administrative commands 1099
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
The following table lists the recording formats and estimated capacities for
DLT devices:
Table 368. Recording format and default estimated capacity for DLT
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
DLT1 40.0GB Uncompressed format, using only CompacTape III or
CompacTape IV cartridges
DLT1C See note 1 on
page 1102.
80.0GB
Compressed format, using only CompacTape III and
CompacTape IV cartridges
DLT10 10.0GB Uncompressed format, using only CompacTape III or
CompacTape IV cartridges
DLT10C See note 1 on
page 1102.
20.0GB
Compressed format, using only CompacTape III and
CompacTape IV cartridges
DLT15 15.0GB Uncompressed format, using only CompacTape IIIxt
or CompacTape IV cartridges (not CompacTape III)
Note: Valid with DLT2000XT, DLT4000, and DLT7000
drives
DLT15C See note 1 on
page 1102.
30.0GB
Compressed format, using only CompacTape IIIxt or
CompacTape IV cartridges (not CompacTape III)
Valid with DLT2000XT, DLT4000, and DLT7000 drives
DLT20 20.0GB Uncompressed format, using only CompacTape IV
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT20C See note 1 on
page 1102.
40.0GB
Compressed format, using only CompacTape IV
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT35 35.0GB Uncompressed format, using only CompacTape IV
cartridges
Valid with DLT7000 and DLT8000 drives
DLT35C See note 1 on
page 1102.
70.0GB
Compressed format, using only CompacTape IV
cartridges
Valid with DLT7000 and DLT8000 drives
UPDATE DEVCLASS DLT

1100 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 368. Recording format and default estimated capacity for DLT (continued)
Format
Estimated
Capacity Description
DLT40 40.0GB Uncompressed format, using CompacTape IV
cartridges
Valid with a DLT8000 drive
DLT40C See note 1 on
page 1102.
80.0GB
Compressed format, using CompacTape IV cartridges
Valid with a DLT8000 drive
DLT2 80.0GB Uncompressed format, using Quantum DLT tape VS1
media
DLT2C See note 1 on
page 1102.
160.0GB
Compressed format, using Quantum DLT tape VS1
media
DLT4 160.0GB Uncompressed format, using Quantum DLTtape VS1
cartridges.
Valid with Quantum DLT-V4 drive
DLT4C See note 1 on
page 1102.
320.0GB
Compressed format, using Quantum DLTtape VS1
cartridges.
Valid with Quantum DLT-V4 drive
SDLT
See note 2 on
page 186.
100.0GB Uncompressed format, using Super DLT Tape 1
cartridges
Valid with a Super DLT drive
SDLTC
See note 2 on
page 186.
See note 1 on
page 186.
200.0GB
Compressed format, using Super DLT Tape 1
cartridges
Valid with a Super DLT drive
SDLT320
See note 2 on
page 186.
160.0GB Uncompressed format, using Quantum SDLT I media
Valid with a Super DLT drive
SDLT320C
See note 2 on
page 186.
See note 1 on
page 186.
320.0GB
Compressed format, using Quantum SDLT I media
Valid with a Super DLT drive
SDLT600 300.0GB Uncompressed format, using SuperDLTtape-II media
Valid with a Super DLT drive
SDLT600C See note 1 on
page 1102.
600.0GB
Compressed format, using SuperDLTtape-II media
Valid with a Super DLT drive
DLTS4 800GB Uncompressed format, using Quantum DLT S4
media.
Valid with a DLT-S4 drive
DLTS4C See note 1 on
page 1102.
1.6TB
Compressed format, using Quantum DLT S4 media.
Valid with a DLT-S4 drive
UPDATE DEVCLASS DLT
Chapter 2. Administrative commands 1101
Table 368. Recording format and default estimated capacity for DLT (continued)
Format
Estimated
Capacity Description
Note:
1. Depending on the effectiveness of compression, the actual capacity may be greater than
the listed value.
2. IBM Tivoli Storage Manager does not support a library that contains both Backward
Read Compatible (BRC) SDLT and Non-Backward Read Compatible (NBRC) SDLT
drives.

ESTCAPacity
Specifies the estimated capacity for the sequential access volumes categorized
by this device class. This parameter is optional. You can specify this parameter
if the default estimated capacity for the device class is inaccurate due to
compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes. The smallest value allowed is
100KB (that is, ESTCAPACITY=100K).
For more information on estimated capacities, see Table 368 on page 1100.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The maximum length of this prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, consider using a volume prefix that
conforms to your naming conventions.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
UPDATE DEVCLASS DLT

1102 IBM Tivoli Storage Manager for Windows: Administrators Reference
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true MOUNTLIMIT value
(including online status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete, but new transactions will
be terminated.
UPDATE DEVCLASS DLT
Chapter 2. Administrative commands 1103
UPDATE DEVCLASS DTF
Use the DTF device class when you are using DTF tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

DRIVE

DTF

DTFC

DTF2

DTF2C

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary
Specifies the name of the defined library object that contains the DTF tape
drives used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
The following table lists the recording formats and estimated capacities for
DTF devices:
UPDATE DEVCLASS DTF

1104 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 369. Recording format and default estimated capacity for DTF
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
DTF 12.0GB
42.0GB
Using GW-240 tape cassettes
Using GW-730L tape cassettes
DTFC 24.0GB
84.0GB
Using GW-240 tape cassettes
Using GW-730L tape cassettes
DTF2 60.0GB
200.0GB
Using GW2-60GS tape cassettes
Using GW2-200GL tape cassettes
DTF2C 120.0GB
400.0GB
Using GW2-60GS tape cassettes
Using GW2-200GL tape cassettes

ESTCAPacity
Specifies the estimated capacity for the sequential access volumes categorized
by this device class. This parameter is optional. You can specify this parameter
if the default estimated capacity for the device class is inaccurate due to
compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes).
The smallest value allowed is 100KB (that is, ESTCAPACITY=100K).
For more information on estimated capacities, see Table 369.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The maximum length of this prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
UPDATE DEVCLASS DTF
Chapter 2. Administrative commands 1105
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mountlimit value,
(including online status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.
UPDATE DEVCLASS DTF

1106 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE DEVCLASS ECARTRIDGE
Use the ECARTRIDGE device class when you are using StorageTek drives such as
the StorageTek SD-3, 9490, 9840 or 9940.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

DRIVE

18T

18TC

36T

36TC

SD3A

SD3AC

SD3B

SD3BC

SD3C

SD3CC

9840

9840-C

9940

9940-C

9940B

994B-C

M8100

M8100C

T9840C

T9840C-C

T10000A

T10000A-C

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be updated.
LIBRary
Specifies the name of the defined library object with the ECARTRIDGE tape
drives that can be used by this device class. For information about defining a
library object, see the DEFINE LIBRARY command.
UPDATE DEVCLASS ECARTRIDGE
Chapter 2. Administrative commands 1107
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
Attention: If you specify DRIVE for a device class that has non-compatible
sequential access devices, then you must mount volumes on devices that are
capable of reading or writing the format established when the volume was first
mounted. This can cause delays if the only sequential access device that can
access the volume is already in use.
The following table lists the recording formats and estimated capacities for
ECARTRIDGE devices:
Table 370. Recording formats and default estimated capacities for ECARTRIDGE tapes
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
18T 360MB 18-track uncompressed (standard) (read-only) format.
18TC See note
1.44GB
18-track extended (read-only), compressed format.
36T 720MB 36-track extended (read and write) format.
36TC See note
2.88GB
36-track extended (read and write), compressed
format.
SD3A 10GB Uncompressed (standard) format, using a 10GB A
cartridge with 91 meters (298 feet) of tape.
SD3AC See note
40GB
Compressed format, using a 10GB A cartridge with
91 meters (298 feet) of tape.
SD3B 25GB Uncompressed (standard) format, using a 25GB B
cartridge with 204 meters (668 feet) of tape.
SD3BC See note
100GB
Compressed format, using a 25GB B cartridge with
204 meters (668 feet) of tape.
SD3C 50GB Uncompressed (standard) format, using a 50GB C
cartridge with 392 meters (1286 feet) of tape.
SD3CC See note
200GB
Compressed format, using a 50GB C cartridge with
392 meters (1286 feet) of tape.
9840 20GB Uncompressed (standard) format, using a 20GB
cartridge with 270 meters (885 feet) of tape.
9840-C See note
80GB
LZ-1 Enhanced (4:1) compressed format, using a
80GB cartridge with 270 meters (885 feet) of tape.
9940 60GB Uncompressed (standard) format, using a 60GB
cartridge.
UPDATE DEVCLASS ECARTRIDGE

1108 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 370. Recording formats and default estimated capacities for ECARTRIDGE
tapes (continued)
Format
Estimated
Capacity Description
9940-C See note
120GB
Compressed format, using a 60GB cartridge.
9940B 200GB Uncompressed (standard) format, using a 200GB
cartridge.
9940B-C See note
400GB
Compressed format, using a 200GB cartridge.
M8100 10GB Uncompressed (standard) format, using a 10GB
cartridge.
M8100C 10GB Compressed format, using a 10GB cartridge. Because
there is no mechanism to determine the type of
cartridge in an M8100 drive, the server assumes a
10GB estimated uncompressed capacity.
T9840C 40GB Uncompressed (standard) format, using a STK media.
T9840C-C 80GB Compressed format, using STK media.
T10000A 500GB Uncompressed (standard) format, using STK media.
T10000A-C 1TB Compressed format, using STK media.
Note: Some formats use a tape drive hardware compression feature. Depending on the
effectiveness of compression, the actual capacity may be double or more than the listed
value.

ESTCAPacity
Specifies the estimated capacity for the sequential access volumes categorized
by this device class. This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
For more information on the default estimated capacity for cartridge tapes, see
Table 370 on page 1108.
PREFIX
Specifies the high-level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional.
If you have already established a tape label naming convention that supports
your current tape management system, consider using a tape volume prefix
that conforms to your naming conventions.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
UPDATE DEVCLASS ECARTRIDGE
Chapter 2. Administrative commands 1109
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mountlimit value
(including online status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.
UPDATE DEVCLASS ECARTRIDGE

1110 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE DEVCLASS FILE
Use the FILE device class when you are using files on magnetic disk storage as
volumes that store data sequentially (as on tape).
The FILE device class does not support EXTERNAL or RSM libraries. For
information about disk subsystem requirements for FILE-type disk storage, see the
Administrators Guide.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
MOUNTLimit

=

number

MAXCAPacity

=

size

,

DIRectory

=

directory_name

SHAREd

=

No

Yes


Parameters
device_class_name (Required)
Specifies the name of the device class to be updated.
MOUNTLimit
Specifies the maximum number of files that can be simultaneously open for
input/output. This parameter is optional. You can specify a number from 1 to
4096. If the device class will be shared with a storage agent (by specifying the
SHARED=YES parameter), drives will be defined or deleted to match the
MOUNTLIMIT value.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
MAXCAPacity
Specifies the maximum size of any data storage files categorized by this device
class. This parameter is optional.
size
Specify this value as an integer followed by K (Kilobytes), M (Megabytes),
or G (Gigabytes). The minimum value allowed is 100KB
(MAXCAPACITY=100K).
For example, MAXCAPACITY=5G specifies that the maximum capacity for a
volume in this device class is 5 gigabytes. The value specified should be less
than or equal to the maximum supported size of a file on the target file
system.
UPDATE DEVCLASS FILE
Chapter 2. Administrative commands 1111
DIRectory
Specifies the directory location or locations of the files used in this device class.
Enclose the entire list of directories within quotation marks, using commas to
separate individual directory names. Special characters (for example, blank
spaces) are permitted within directory names. For example, the directory list
abc def,xyz contains two directories: abc def and xyz. This parameter is
optional.
By specifying a directory name or names, you identify the locations where the
server places the files that represent storage volumes for this device class.
Note: If you are using storage agents for shared access to FILE volumes, you
need to use the DEFINE PATH command to define a path for each
storage agent. The path definition includes the directory names used by
the storage agent to access each directory.
Later, if the server needs to allocate a scratch volume, it creates a new file in
one of these directories. (The server can choose any of the directories in which
to create new scratch volumes.) For scratch volumes used to store client data,
the file created by the server has a file name extension of .bfs. For scratch
volumes used to store export data, a file name extension of .exp is used. For
example, if you define a device class with a directory of c:\server and the
server needs a scratch volume in this device class to store export data, the file
that the server creates might be named c:\server\00566497.exp.
Attention: Space trigger functions and storage pool space calculations take
into account the space remaining in each directory. Ideally, each directory
should be associated with a separate file system. If you specify multiple
directories for a device class and the directories reside in the same file system,
the server will calculate space by adding values representing the space
remaining in each directory. These space calculations will be inaccurate. Rather
than choosing a storage pool with sufficient space for an operation, the server
could choose the wrong storage pool and run out of space prematurely. For
space triggers, an inaccurate calculation could result in a failure to expand the
space available in a storage pool. Failure to expand space in a storage pool is
one of the conditions that can cause a trigger to become disabled. If a trigger is
disabled because the space in a storage pool could not be expanded, you can
re-enable the trigger by specifying the following command: update
spacetrigger stg. No further changes are required to the space trigger.
Note: You can modify a list of directories only by replacing the entire list.
SHAREd
Specifies that this FILE devclass will be shared between the server and one or
more storage agents. To prepare for sharing, a library will be automatically
defined along with a number of drives corresponding to the MOUNTLIMIT
associated with the device class. If the library and drives already exist and the
MOUNTLIMIT is changed, drives will either be created to reach a new higher
MOUNTLIMIT value or deleted to reach a new lower value.
Storage agents using FILE volumes
You must ensure that storage agents can access newly created FILE volumes. To
access FILE volumes, storage agents replace names from the directory list in the
device-class definition with the names in the directory list for the associated path
definition. The following illustrates the importance of matching device classes and
paths to ensure that storage agents can access newly created FILE volumes.
UPDATE DEVCLASS FILE

1112 IBM Tivoli Storage Manager for Windows: Administrators Reference
Suppose you want to use these three directories for a FILE library:
c:\server
d:\server
e:\server
1. You use the following command to set up a FILE library named CLASSA with
one drive named CLASSA1 on SERVER1:
define devclass classa devtype=file
directory="c:\server,d:\server,e:\server"
shared=yes mountlimit=1
2. You want the storage agent STA1 to be able to use the FILE library, so you
define the following path for storage agent STA1:
define path server1 sta1 srctype=server desttype=drive device=file
directory="\\192.168.1.10\c\server,\\192.168.1.10\d\server,
\\192.168.1.10\e\server" library=classa
In this scenario, the storage agent, STA1, will replace the directory name
c:\server with the directory name \\192.168.1.10\c\server to access FILE
volumes that are in the c:\server directory on the server.
3. File volume c:\server\file1.dsm is created by SERVER1. If you later change the
first directory for the device class with the following command:
update devclass classa directory="c:\otherdir,d:\server,e:\server"
SERVER1 will still be able to access file volume c:\server\file1.dsm, but the
storage agent STA1 will not be able to access it because a matching directory
name in the PATH directory list no longer exists. If a directory name is not
available in the directory list associated with the device class, the storage agent
can lose access to a FILE volume in that directory. Although the volume will
still be accessible from the Tivoli Storage Manager server for reading, failure of
the storage agent to access the FILE volume can cause operations to be retried
on a LAN-only path or to fail.
Examples
Task
Prepare a FILE device class (named PLAINFILES) for sharing with a Tivoli Storage
Manager storage agent.
Command
update devclass plainfiles shared=yes
Task
Update a file device class named STORFILES to a maximum capacity of 25MB.
Command
update devclass storfiles maxcap=25m
Task
Update the FILE device class, classa, by adding an additional directory, c:\otherdir,
to the directory list. The directories d:\server and e:\server were specified when
the device class was first defined.
Command
UPDATE DEVCLASS FILE
Chapter 2. Administrative commands 1113
update devclass classa
directory="d:\server,e:\server,c:\otherdir"
UPDATE DEVCLASS FILE

1114 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE DEVCLASS GENERICTAPE
Use the GENERICTAPE device class for tape drives supported by operating system
device drivers.
When using this device type, the server does not recognize either the type of
device or the cartridge recording format. Because the server does not recognize the
type of device, if an I/O error occurs, error information is less detailed compared
to error information for a specific device type (for example, 8mm). When defining
devices to the server, do not mix various types of devices within the same device
type.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

ESTCAPacity

=

size

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be updated.
LIBRary
Specifies the name of the defined library object that contains the tape drives
used by this device class. This parameter is optional. For information about
defining a library object, see the DEFINE LIBRARY command.
ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
Specify a capacity appropriate to the particular tape drive being used.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
UPDATE DEVCLASS GENERICTAPE
Chapter 2. Administrative commands 1115
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types, setting this parameter to a low value (for example, two minutes)
enhances device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mountlimit value
(including online status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.
UPDATE DEVCLASS GENERICTAPE

1116 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE DEVCLASS LTO
Use the LTO device class when you are using LTO tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

DRIVE

ULTRIUM

ULTRIUMC

ULTRIUM2

ULTRIUM2C

ULTRIUM3

ULTRIUM3C

ULTRIUM4

ULTRIUM4C

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0

(1) (2)
DRIVEEncryption

=

ALLOW

DRIVEEncryption

=

ON

ALLOW

OFF

Notes:
1 You cannot specify DRIVEENCRYPTION=ON if your drives are using
WORM (write once, read many) media.
2 Drive encryption is supported only for IBM and HP Ultrium 4 drives and
media.
UPDATE DEVCLASS LTO
Chapter 2. Administrative commands 1117
||
||||||||
|
|
|
|
Parameters
device_class_name (Required)
Specifies the name of the device class to be updated. The maximum length of
the device class name is 30 characters.
LIBRary
Specifies the name of the defined library object that contains the LTO tape
drives used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
When migrating all drives from Ultrium to Ultrium 2 devices:
v Delete all existing Ultrium drive definitions and the paths associated with
them.
v Define the new Ultrium 2 drives and paths.
If you are considering mixing different generations of LTO media and drives,
be aware of the following restrictions. For more information about mixing
drives and media, refer to the Administrators Guide.
Table 371. Read - write capabilities for different generations of LTO drives
Drives
Generation 1
media
Generation 2
media
Generation 3
media
Generation 4
media
Generation 1 Read and write n/a n/a n/a
Generation 2 Read and write Read and write n/a n/a
Generation 3
1
Read only Read and write Read and write n/a
Generation 4
2
n/a Read only Read and write Read and write
1
In a library with a Generation 3 drive, all Generation 1 scratch volumes need to be
checked out, and all Generation 1 storage pool volumes need to be updated to read-only.
2
In a library with a Generation 4 drive, all Generation 2 scratch volumes need to be
checked out, and all Generation 2 storage pool volumes need to be updated to read-only.

The following table lists the recording formats and estimated capacities for
LTO devices:
Table 372. Recording format and default estimated capacity for LTO
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
ULTRIUM 100.0GB Uncompressed format, using Ultrium cartridges
ULTRIUMC See note
200.0GB
Compressed format, using Ultrium cartridges
UPDATE DEVCLASS LTO

1118 IBM Tivoli Storage Manager for Windows: Administrators Reference
|||||
|
|
Table 372. Recording format and default estimated capacity for LTO (continued)
Format
Estimated
Capacity Description
ULTRIUM2 200GB Uncompressed (standard) format, using Ultrium 2
cartridges
ULTRIUM2C See note
400GB
Compressed format, using Ultrium 2 cartridges
ULTRIUM3 400GB Uncompressed (standard) format, using Ultrium 3
cartridges
ULTRIUM3C See note
800GB
Compressed format, using Ultrium 3 cartridges
ULTRIUM4 800GB Uncompressed (standard) format, using IBM or HP
Ultrium 4 cartridges
ULTRIUM4C See note
1.6TB
Compressed format, using IBM or HP Ultrium 4
cartridges
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

ESTCAPacity
Specifies the estimated capacity for the sequential access volumes categorized
by this device class. This parameter is optional. You can specify this parameter
if the default estimated capacity for the device class is inaccurate due to
compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=100G specifies that the estimated capacity for a
volume in this device class is 100 gigabytes.
For more information on estimated capacities, see Table 372 on page 1118.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The maximum length of this prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, for a library managed by an external media management
program), you can enhance device sharing between applications by setting this
parameter to a low value (for example, two minutes) .
UPDATE DEVCLASS LTO
Chapter 2. Administrative commands 1119
|||
|
||
|
|
|
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DRIVEEncryption
Specifies whether drive encryption will be permitted. This parameter is
optional. The default is ALLOW.
Note: Drive encryption is supported only for IBM and HP Ultrium 4 drives
and media.
ON
Specifies that Tivoli Storage Manager is the key manager for drive
encryption and will permit drive encryption for empty storage pool
volumes only if the application method is enabled. (Other types of
volumesfor example, backup sets, export volumes, and database backup
volumeswill not be encrypted.) If you specify ON and you enable
another method of encryption, drive encryption will not be permitted and
backup operations will fail.
Note: You cannot specify Tivoli Storage Manager as the key manager for
drive encryption of WORM (write once, read many) media. (If you
are using WORM media, you cannot specify
DRIVEENCRYPTION=ON.)
UPDATE DEVCLASS LTO

1120 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ALLOW
Specifies that Tivoli Storage Manager does not manage the keys for drive
encryption. However, drive encryption for empty volumes is permitted if
another method of encryption is enabled.
OFF
Specifies that drive encryption will not be permitted. If you enable another
method of encryption, backups will fail. If you enable the application
method, Tivoli Storage Manager will disable encryption and backups will
be attempted.
Examples
Task
Update a device class named LTOTAPE. Change the mount limit to 2.
Command
update devclass ltotape mountlimit=2
UPDATE DEVCLASS LTO
Chapter 2. Administrative commands 1121
|
|
|
|
|
|
|
|
|
UPDATE DEVCLASS NAS
Use the NAS device class when you are using NDMP (Network Data Management
Protocol) operations to back up network-attached storage (NAS) file servers. The
device class is for drives supported by the NAS file server for backups.
The NAS device class does not support EXTERNAL or RSM libraries.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

MOUNTRetention

=

0

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0

ESTCAPacity

=

size

PREFIX

=

tape_volume_prefix


Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary
Specifies the name of the defined library object that contains the SCSI tape
drives used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
MOUNTRetention=0
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. Zero (0) is the only supported value for device classes
with DEVType=NAS.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
UPDATE DEVCLASS NAS

1122 IBM Tivoli Storage Manager for Windows: Administrators Reference
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
This value must be an integer followed by K (kilobytes), M (megabytes), or G
(gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=100G specifies that the estimated capacity for a
volume in this device class is 100 gigabytes.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The maximum length of this prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Examples
Task
Update a device class named NASTAPE. Change the estimated capacity to 200GB.
Command
update devclass nastape library=naslib estcapacity=200G
UPDATE DEVCLASS NAS
Chapter 2. Administrative commands 1123
UPDATE DEVCLASS OPTICAL and WORM TYPES
Use the OPTICAL device class when you are using optical devices. Use the WORM
device class when you are using optical devices that have WORM capability.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

DRIVE

650MB

1300MB

2600MB

5200MB

5600MB

6800MB

9100MB

10200MB

12000MB

14800MB

23GB

30GB

60GB

ESTCAPacity

=

size

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be defined.
LIBRary
Specifies the name of the defined library object that contains the Optical or
WORM drives that can be used by this device class. For information about
defining a library object see the DEFINE LIBRARY command.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
The following table lists the recording formats and estimated capacities for
OPTICAL and WORM devices:
UPDATE DEVCLASS OPTICAL and WORM TYPES

1124 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
Table 373. Estimated capacities for OPTICAL and WORM drives
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
650MB 650MB Using a 650 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
1300MB 1300MB Using a 1300 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
2600MB 2600MB Using a 2600 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
5200MB 5200MB Using a 5200 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
5600MB 5600MB Using a 5600 MB 12-inch optical drive
Only valid for WORM12 device types
6800MB 6800MB Using a 6800 MB 14-inch optical drive
Only valid for WORM14 device types
9100MB 9100MB Using a 9100 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
10200MB 10200MB Using a 10200 MB 14-inch optical drive
Only valid for WORM14 device typesdevice types
12000MB 12000MB Using a 12000 MB 12-inch optical drive
Only valid for WORM12 device types
14800MB 14800MB Using a 14800 MB 14-inch optical drive
Only valid for WORM14 device types
23GB 23GB Using Sony Blue Laser read-write and WORM media
Not valid for WORM12 or WORM14 device types
30GB 30GB Using Plasmon UDO1 read-write and WORM media
Not valid for WORM12 or WORM14 device types
60GB 60GB Using Plasmon or IBM UDO2 read-write and WORM
media
Not valid for WORM12 or WORM14 device types

Note: If you are considering mixing different generations of UDO media and
drives, be aware of the following:
UPDATE DEVCLASS OPTICAL and WORM TYPES
Chapter 2. Administrative commands 1125
|||
|
|
|
|
v UDO1 drives can read and write UDO1 media only.
v UDO2 drives can read from, but not write to, UDO1 media.
ESTCAPacity
Specifies the estimated capacity for the sequential access volumes categorized
by this device class. This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
For more information on estimated capacities, see Table 373 on page 1125.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types, setting this parameter to a low value (for example, two minutes)
enhances device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mount limit value
(including online status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
UPDATE DEVCLASS OPTICAL and WORM TYPES

1126 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.
UPDATE DEVCLASS OPTICAL and WORM TYPES
Chapter 2. Administrative commands 1127
UPDATE DEVCLASS QIC
Use the QIC device class when you are using QIC tape devices.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

DRIVE

QIC120

QIC150

QIC525

QIC1000

QIC2GB

QIC2GBC

QIC4GB

QIC4GBC

QIC12GB

QIC12GBC

QIC20GB

QIC20GBC

QIC30GB

QIC30GBC

QIC5010

QIC5010C

QIC25GB

QIC25GBC

QIC50GB

QIC50GBC

QIC70GB

QIC70GBC

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be defined.
LIBRary
Specifies the name of the defined library object that contains the tape drives
that can be used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
UPDATE DEVCLASS QIC

1128 IBM Tivoli Storage Manager for Windows: Administrators Reference
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional.
The following tables list the recording formats, estimated capacities and
recording format options for QIC devices:
Table 374. Recording format and default estimated capacity for quarter-inch cartridge (QIC)
tape
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that can be
supported by the sequential access drive on which a
volume is mounted.
Avoid specifying the DRIVE value when a mixture of
devices is used within the same library.
For example, if you have drives that support
recording formats superior to other drives in a
library, do not specify the FORMAT=DRIVE option.
QIC120 26.0MB 172.0MB 120 QIC format, depending on media
QIC150 31.0MB 207.0MB 150 QIC format, depending on media
QIC525 65.0MB 427.0MB 525 QIC format, depending on media
QIC1000 169.0MB 1.1GB 1000 QIC format, depending on media
QIC2GB 2.0GB Uncompressed 2000 QIC format
QIC2GBC See note
4.0GB
Compressed 2000 QIC format
QIC4GB 4.0GB Uncompressed 4000 QIC format
QIC4GBC See note
8.0GB
Compressed 4000 QIC format
QIC12GB 12.0GB Uncompressed 12000 QIC format, using 343meter
tape
QIC12GBC See note
24.0GB
Compressed 12000 QIC format, using 343meter tape
QIC5010 13.0GB 16.0GB Uncompressed 5010 QIC format, depending on
media
QIC5010C See note
26.0GB 32.0GB
Compressed 5010 QICformat, depending on media
QIC20GB 20.0GB Uncompressed 20000 QIC format
QIC20GBC See note
40.0GB
Compressed 20000 QIC format
QIC25GB 25.0GB Uncompressed 25000 QIC format
QIC25GBC See note
50.0GB
Compressed 25000 QIC format
QIC30GB 30.0GB Uncompressed 30000 QIC format
UPDATE DEVCLASS QIC
Chapter 2. Administrative commands 1129
Table 374. Recording format and default estimated capacity for quarter-inch cartridge (QIC)
tape (continued)
Format
Estimated
Capacity Description
QIC30GBC See note
60.0GB
Compressed 30000 QIC format
QIC50GB 50.0GB Uncompressed 50GB QIC format
QIC50GBC See note
100.0GB
Compressed 50GB QIC format
QIC70GB 70.0GB Uncompressed 70GB QIC format
QIC70GBC See note
140.0GB
Compressed 70GB QIC format
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity may be greater than the listed value.

Table 375. QIC tape recording format options
Tape Format QIC-120 QIC-150 QIC-525 QIC-1000
3M DC300XLP
3M DC600A
3M DC600XTD
3M DC6150
3M DC6320
3M DC6525
3M DC9100
3M DC9120XL

Read
Read/Write
Read/Write
Read/Write
Read/Write




Read/Write
Read/Write
Read/Write
Read/Write






Read/Write
Read/Write








Read/Write
Read/Write
Note: The server cannot use 3M DC300XLP and 3M DC600A tapes.

ESTCAPacity
Specifies the estimated capacity for the sequential access volumes categorized
by this device class. This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
For more information on the default estimated capacity for QIC tapes, see
Table 374 on page 1129.
PREFIX
Specifies the high level qualifier of the file name that the server writes into the
sequential access media labels. For each sequential access volume assigned to
this device class, the server uses this prefix to create the data set name. This
parameter is optional. The maximum length of this prefix is 8 characters.
UPDATE DEVCLASS QIC

1130 IBM Tivoli Storage Manager for Windows: Administrators Reference
If you have already established a media label naming convention that supports
your current management system, consider using a volume prefix that
conforms to your naming conventions.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mountlimit value
(including online status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.
UPDATE DEVCLASS QIC
Chapter 2. Administrative commands 1131
UPDATE DEVCLASS REMOVABLEFILE
Use the REMOVABLEFILE device class for removable media devices that are
attached as local, removable file systems.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

MAXCAPacity

=

size

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be updated.
LIBRary
Specifies the name of the defined library object that contains the removable
media drives used by this device class. This parameter is optional.
MAXCAPacity
Specifies the maximum size of any volumes defined to a storage pool
categorized by this device class. This parameter is optional.
Because the server opens only one file per physical removable medium, specify
a capacity that enables one file to make full use of your media capacity.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes).
For example, MAXCAPACITY=5M specifies that the maximum capacity for a
volume in this device class is 5 megabytes. The smallest value allowed is
100KB (that is, MAXCAPACITY=100K).
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. You can specify a number
from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. You can specify a number from
0 to 9999.
UPDATE DEVCLASS REMOVABLEFILE

1132 IBM Tivoli Storage Manager for Windows: Administrators Reference
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. You
can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mountlimit value
(including online status).
Note: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.
UPDATE DEVCLASS REMOVABLEFILE
Chapter 2. Administrative commands 1133
UPDATE DEVCLASS SERVER
Use the SERVER device class to use storage volumes or files archived in another
Tivoli Storage Manager server.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDdate DEVclass device_class_name
SERVERName

=

server_name

MAXCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

RETRYPeriod

=

minutes

RETRYInterval

=

seconds

MOUNTRetention

=

minutes

MOUNTLimit

=

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be updated.
SERVERName
Specifies the name of the server. The SERVERNAME parameter must match a
defined server.
Note: If you change the SERVERNAME of an existing server to a new name,
data on the volumes under the old SERVERNAME will no longer be
accessible with this device class.
MAXCAPacity
Specifies the maximum size that objects can be when created on the target
server. This parameter is optional.
Specify this value as an integer followed by K (Kilobytes), M (Megabytes), or
G (Gigabytes). The minimum value allowed is 100KB (MAXCAPACITY=100K).
PREFIX
Specifies the beginning portion of the high-level archive file name on the target
server. This parameter is optional. The maximum length of this prefix is 8
characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
RETRYPeriod
Specifies the retry period in minutes. The retry period is the interval during
which the server attempts to contact a target server if there is a suspected
communications failure. This parameter is optional.
UPDATE DEVCLASS SERVER

1134 IBM Tivoli Storage Manager for Windows: Administrators Reference
RETRYInterval
Specifies the retry interval in seconds. The retry interval is how often retries
are done within a given time period. This parameter is optional.
MOUNTRetention
Specifies the number of minutes to retain an idle connection with the target
server before closing the connection. This parameter is optional. You can
specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of simultaneous sessions between the source
server and the target server. Any attempts to access more sessions than
indicated by the mount limit cause the requester to wait. This parameter is
optional. You can specify a number from 1 to 4096.
The following are possible values:
number
Specifies the maximum number of simultaneous sessions between the
source server and the target server.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete, but new transactions will
be terminated.
UPDATE DEVCLASS SERVER
Chapter 2. Administrative commands 1135
UPDATE DEVCLASS VOLSAFE
Use the VOLSAFE device type to work with StorageTek VolSafe brand media and
drives. This technology uses media that cannot be overwritten. Therefore, do not
use these media for short-term backups of client files, the server database, or
export tapes.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DEVclass device_class_name
LIBRary

=

library_name

FORMAT

=

9840

9840C

ESTCAPacity

=

size

PREFIX

=

ADSM

tape_volume_prefix

MOUNTRetention

=

minutes

MOUNTWait

=

minutes

MOUNTLimit

=

DRIVES

number

0


Parameters
device_class_name (Required)
Specifies the name of the device class to be updated. The maximum length of
the device class name is 30 characters.
LIBRary
Specifies the name of the defined library object that contains the VolSafe drives
that can be used by this device class. If any drives in a library are
VolSafe-enabled, all drives in the library must be VolSafe-enabled. See
DEFINE DEVCLASS VOLSAFE on page 225 for additional information on
the VolSafe device type.
FORMAT
Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional; the default value is DRIVE.
Attention: If you specify DRIVE for a device class that has non-compatible
sequential access devices, then you must mount volumes on devices that are
capable of reading or writing the format established when the volume was first
mounted. This can cause delays if the only sequential access device that can
access the volume is already in use.
The following table lists the recording formats and estimated capacities for
VolSafe devices:
UPDATE DEVCLASS VOLSAFE

1136 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 376. Recording formats and default estimated capacities for volsafe tapes
Format
Estimated
Capacity Description
DRIVE The server selects the highest format that is
supported by the drive on which a volume is
mounted.
Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
9840 20GB Uncompressed (standard) format, using a 20GB
cartridge with 270 meters (885 feet) of tape
9840C 80GB LZ-1 Enhanced (4:1) compressed format, using a
80GB cartridge with 270 meters (885 feet) of tape

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
You can specify this parameter if the default estimated capacity for the device
class is inaccurate due to compression of data.
You must specify this value as an integer followed by K (Kilobytes), M
(Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes.
For more information on the default estimated capacity for cartridge tapes, see
Table 376.
PREFIX
Specifies the high-level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional.
If you have already established a tape label naming convention that supports
your current tape management system, consider using a tape volume prefix
that conforms to your naming conventions.
MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume
before dismounting it. This parameter is optional. The default value is 60. You
can specify a number from 0 to 9999.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online. However, for EXTERNAL
library types (that is, a library managed by an external media management
system), set this parameter to a low value (for example, two minutes) to
enhance device sharing between applications.
MOUNTWait
Specifies the maximum number of minutes the server will wait for an operator
to respond to a request to either mount a volume in a drive in a manual
library or check in a volume to be mounted in an automated library. This
UPDATE DEVCLASS VOLSAFE
Chapter 2. Administrative commands 1137
parameter is optional. If the mount request is not satisfied within the specified
amount of time, the mount request is canceled. The default value is 60
minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 1 to 4096.
If you plan to use the simultaneous write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction will fail. For details about the
simultaneous write function, refer to the Administrators Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true value (including online
status).
Note: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value. Specify the number of drives for the library as
the MOUNTLIMIT value.
number
Specifies the maximum number of drives used concurrently in this device
class by the server. This value must never be allowed to exceed the
number of drives that are defined and online in the library that services
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
UPDATE DEVCLASS VOLSAFE

1138 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE DOMAIN (Update a policy domain)
Use this command to change a policy domain.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the specified policy domain.
Syntax
UPDate DOmain domain_name
DESCription

=

description

BACKRETention

=

days

ARCHRETention

=

days

,

ACTIVEDESTination

=

active-data_pool_name


Parameters
domain_name (Required)
Specifies the name of the policy domain.
DESCription
Describes the policy domain using a text string. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters. To remove a previously
defined description, specify a null string ().
BACKRETention
Specifies the number of days (from the date the backup versions became
inactive) to retain backup versions that are no longer on the client file system.
This parameter is optional. You can specify an integer from 0 to 9999. The
server uses the backup retention value to manage inactive versions of files
when any of the following conditions occur:
v A file is rebound to a new management class, but neither the new
management class nor the default management class contains a backup copy
group.
v The management class to which a file is bound no longer exists, and the
default management class does not contain a backup copy group.
v The backup copy group is deleted from the management class to which a
file is bound and the default management class does not contain a backup
copy group.
ARCHRETention
Specifies the number of days (from the date of archive) to retain archive copies.
This parameter is optional. You can specify an integer from 0 to 30000. The
server uses the archive retention value to manage archive copies of files when
either of the following conditions occur:
v The management class to which a file is bound no longer exists, and the
default management class does not contain an archive copy group.
UPDATE DOMAIN
Chapter 2. Administrative commands 1139
v The archive copy group is deleted from the management class to which a
file is bound and the default management class does not contain an archive
copy group.
ACTIVEDESTination
Specifies the names of active-data pools that store active versions of backup
data for nodes assigned to the domain. This parameter is optional. Spaces
between the names of the active-data pools are not permitted. You cannot
specify more than ten active-data pools for a domain.
Before the Tivoli Storage Manager server writes data to an active-data pool, it
verifies that the node owning the data is assigned to a domain that has the
active-data pool listed in the ACTIVEDESTINATION list. If the server verifies
that the node meets this criteria, the data is stored in the active-data pool. If
the node does not meet the criteria, then the data is not stored in the
active-data pool. If the backup is performed with simultaneous write to an
active-data pool, the server performs the verification during backup operations
by Tivoli Storage Manager backup-archive clients or by application clients
using the Tivoli Storage Manager API. The verification is also performed when
active-data is being copied using the COPY ACTIVEDATA command.
Examples
Task
For the EMPLOYEE_RECORDS policy domain, set the backup retention to 45 days
and the archive retention to 75 days.
Command
update domain employee_records
backretention=45 archretention=75
Related commands
Table 377. Commands related to UPDATE DOMAIN
Command Description
COPY DOMAIN Creates a copy of a policy domain.
DEFINE DOMAIN Defines a policy domain that clients can be
assigned to.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
DELETE DOMAIN Deletes a policy domain along with any
policy objects in the policy domain.
QUERY DOMAIN Displays information about policy domains.

UPDATE DOMAIN

1140 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE DRIVE (Update a drive)
Use this command to update a drive.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate DRive library_name drive_name
SERial

=

serial_number

AUTODetect

ONLine

=

Yes

No

ELEMent

=

address

AUTODetect

(1)

ACSDRVID

=

drive_id
(2) (3)
CLEANFREQuency

=

NONE

CLEANFREQuency

=

NONE

ASNEEDED

gigabytes

Notes:
1 The ACSDRVID parameter is valid only for drives in ACSLS libraries.
2 The CLEANFREQUENCY parameter is valid only for drives in SCSI libraries.
3 The CLEANFREQUENCY=ASNEEDED parameter value does not work for
all tape drives. To determine whether a drive supports this function, see the
following Web site: www.ibm.com/software/sysmgmt/products/support/
IBM_TSM_Supported_Devices_for_AIXHPSUNWIN.html. At this Web site,
click the drive to view detailed information. If ASNEEDED is not supported,
you can use the gigabytes value for automatic cleaning.
Parameters
library_name (Required)
Specifies the name of the library to which the drive is assigned.
drive_name (Required)
Specifies the name that is assigned to the drive.
SERial
Specifies the serial number for the drives being updated. This parameter is
valid only for drives in SCSI libraries. This parameter is optional. The possible
values are:
serial_number
Specifies the serial number for the drive being updated.
UPDATE DRIVE
Chapter 2. Administrative commands 1141
|
|
|
|
|
|
Note: If a path to this drive has already been defined, then the number
you enter here will be compared to the number detected by Tivoli
Storage Manager. If the numbers do not match, then this command
will fail.
AUTODETECT
Specifies that the serial number will be automatically detected and used by
Tivoli Storage Manager if a path has already been defined to this drive.
If a path to this drive has not been defined, then the serial number will not
be detected.
ONLine
Specifies whether the drive is available for use. This parameter allows drives to
be taken offline and used for another activity, such as maintenance. This
parameter is optional.
You can issue this command when the drive is involved in an active process or
session, but it is not recommended. If you take the drive offline while it is in
use, the drive will be marked offline. However, the mounted volume will
complete its current process. If this volume was part of a series of volumes for
a given transaction, the drive will not be available to complete mounting the
series. If no other drives are available, the process fails.
Attention: When a drive is in use, do not specify the ELEMENT parameter
with the ONLINE parameter. The drive will not be updated, and the command
will fail.
The drive state is not changed even if the server is halted and restarted. If a
drive is offline when the server is restarted, a warning message is issued
stating that the drive must be manually brought online. If all the drives in a
library have been updated to be offline, processes that need a library mount
point will fail, rather than queue up for a mount point.
YES
Specifies that the drive is available for use (online).
No
Specifies that the drive is not available for use (offline).
ELEMent
Specifies the element address of the drive within a SCSI library. The server
uses the element address to connect the physical location of the drive to the
SCSI address of the drive. The possible values are:
address
Specifies the element address for the drive being updated.
Note: If a path to this drive has already been defined, then the number
you enter here will be compared to the number previously detected
by Tivoli Storage Manager. If the numbers do not match, then this
command will fail.
AUTODETECT
Specifies that the element number will be automatically detected and used
by Tivoli Storage Manager if a path has already been defined to this drive.
If a path to this drive has not been defined, then the element number will
not be detected.
UPDATE DRIVE

1142 IBM Tivoli Storage Manager for Windows: Administrators Reference
Note: If the library in which the drive is located does not support the
Read Element Status SCSI command, and
ELEMENT=AUTODETECT, the command will fail with a Tivoli
Storage Manager error message.
To find the element address for your library configuration, consult the
manufacturers information.
Additional information on element addresses can be found at the IBM Tivoli
Storage Manager Web site: http://www.ibm.com/software/sysmgmt/
products/support/IBMTivoliStorageManager.html. Follow the links to device
information. Select the appropriate product and platform, then scroll to the
required device. Click on a specific device to see element addresses.
Note: This parameter is valid for a drive in a SCSI library when the command
is issued from a Tivoli Storage Manager library manager server.
ACSDRVID
Specifies the ID of the drive being accessed. The drive ID is a set of numbers
that indicates the physical location of a drive within an ACSLS library. This
drive ID must be specified as a,l,p,d, where a is the acsid, l is the LSM (library
storage module), p is the panel number, and d is the drive ID. The server needs
the drive ID to connect the physical location of the drive to the drives SCSI
address. See your StorageTek documentation for details.
CLEANFREQuency
Specifies how often the server activates drive cleaning. This parameter is
optional. For the most complete automation of cleaning for an automated
library, you must have a cleaner cartridge checked into the librarys volume
inventory. This parameter is valid only for drives in SCSI libraries, and not
valid for externally managed libraries, such as 3494 libraries or StorageTek
libraries managed under ACSLS. For details on using this parameter for
automated and manual libraries, see the Administrators Guide.
Note: There are special considerations if you plan to use server-activated drive
cleaning with a SCSI library that provides automatic drive cleaning
support in its device hardware. See the Administrators Guide for details.
NONE
Specifies that the server does not track cleaning for this drive. Use this
parameter for libraries that have their own automatic cleaning.
ASNEEDED
Specifies that the server loads the drive with a checked-in cleaner cartridge
only when a drive reports to the device driver that it needs cleaning.
Note: Tivoli Storage Manager does not control the drives connected to the
NAS file server. If a drive is attached only to a NAS file server (no
connection to a storage agent or server), do not specify ASNEEDED
for the cleaning frequency.
gigabytes
Specifies, in gigabytes, how much data is processed on the drive before the
server loads the drive with a cleaner cartridge. The server resets the
gigabytes-processed counter each time it loads a cleaner cartridge in the
drive.
UPDATE DRIVE
Chapter 2. Administrative commands 1143
Consult the drive manufacturers information for cleaning
recommendations. If the information gives recommendations for cleaning
frequency in terms of hours of use, convert to a gigabytes value by doing
the following:
1. Use the bytes-per-second rating for the drive to determine a
gigabytes-per-hour value.
2. Multiply the gigabytes-per-hour value by the recommended hours of
use between cleanings.
3. Use the result as the cleaning frequency value.
Note: For IBM 3590 and IBM 3570, specify a value for the cleaning
frequency to ensure that the drives receive adequate cleaning.
Consult the drive manufacturers information for cleaning
recommendations. Using the cleaning frequency recommended by
IBM will not overclean the drives.
Examples
Task
Update DRIVE3, located in the library named AUTO, by changing the element
address to 119.
Command
update drive auto drive3 element=119
Task
Update DRIVE3, located in the library MANLIB, to take it offline.
Command
update drive manlib drive3 online=no
Related commands
Table 378. Commands related to UPDATE DRIVE
Command Description
CLEAN DRIVE Marks a drive for cleaning.
DEFINE DRIVE Assigns a drive to a library.
DEFINE PATH Defines a path from a source to a destination.
DELETE DRIVE Deletes a drive from a library.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more
libraries.
UPDATE PATH Changes the attributes associated with a
path.

UPDATE DRIVE

1144 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE LIBRARY (Update a library)
Use this command to update a library definition.
To update the device name, the ACS number, or the external manager path name
of a library, you must use the UPDATE PATH command.
This section includes syntax diagrams for a number of different library
configurations:

Configuration Task Syntax Diagram
LAN -- Update an ACSLS library Syntax for an ACSLS library on a LAN
SAN -- Update an ACSLS library Syntax for an ACSLS library to a library
manager, on a SAN
SAN -- Update a library (SCSI, 349X, FILE)
defined to a library manager server
Syntax for library sharing in a SAN, not for
NDMP operations on page 1146 (SAN --
Update a library defined to a library
manager)
SAN -- Update a library (SHARED) defined
to a library client server
Syntax for library sharing in a SAN, not for
NDMP operations on page 1146 (SAN --
Update a library defined to a library client)
SAN -- Update a library used for NDMP
operations
Syntax for a library used for NDMP
operations on page 1147 (Update a library
controlled directly by Tivoli Storage
Manager)
SAN -- Update an EXTERNAL library to be
to be shared with storage agents
Syntax for an EXTERNAL library shared
with storage agents on page 1147

Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax for an ACSLS library on a LAN
UPDate LIBRary library_name
ACSID

=

number

AUTOLabel

=

No

Yes

OVERWRITE


Syntax for an ACSLS library to a library manager, on a SAN
UPDate LIBRary library_name
SHAREd

=

Yes

UPDATE LIBRARY
Chapter 2. Administrative commands 1145

RESETDrives = Yes (1)

RESETDrives

=

Yes

No

AUTOLabel

=

No

Yes

OVERWRITE

Notes:
1 RESETDRIVES defaults to Yes only when a library is defined with
SHARED=Yes; otherwise, the parameter defaults to No.
Syntax for library sharing in a SAN, not for NDMP operations

Update a library defined to a library manager
UPDate LIBRary library_name
SHAREd

=

Yes

RESETDrives = Yes (1)

RESETDrives

=

Yes

No

AUTOLabel

=

No

Yes

OVERWRITE

A (SCSI)
B

(349X)


A (SCSI):

SERial

=

serial_number

AUTODetect

AUTOLabel

=

No

Yes

OVERWRITE


B (349X):

WORMSCRatchcategory

=

number


Notes:
1 RESETDRIVES defaults to YES only when a library is defined with
SHARED=YES; otherwise, the parameter defaults to No.

Update a library defined to a library client
UPDate LIBRary library_name PRIMarylibmanager = server_name


UPDATE LIBRARY

1146 IBM Tivoli Storage Manager for Windows: Administrators Reference
Syntax for a library used for NDMP operations

Update a library controlled directly by Tivoli Storage Manager
UPDate LIBRary library_name
SHAREd

=

Yes

AUTOLabel

=

No

Yes

OVERWRITE



Syntax for an EXTERNAL library shared with storage agents
UPDate LIBRary library_name
LANFree

=

Yes

No


Parameters
library_name (Required)
Specifies the name of the library to be updated.
SHAREd
Specifies that this library is shared with other servers in a storage area network
(SAN). You must issue this command from the server defined as the primary
library manager for the shared library. This parameter is required for libraries
defined to a library manager and for libraries used for NDMP operations.
Specify SHARED=YES to update a library that is not currently shared.
Note: If a library has a path from a data mover (such as a NAS file server) but
no connection to the Tivoli Storage Manager server, the library cannot be
shared with another Tivoli Storage Manager server.
WORMSCRatchcategory
Indicates the category number used for WORM scratch volumes in a library.
This applies to IBM 3494 or 3495 Tape Library Dataservers only.
Note: You can specify a value for the WORMSCRATCHCATEGORY parameter
only if you did not previously specify a value using the DEFINE
LIBRARY command. To determine whether a value has been specified,
issue the QUERY LIBRARY command. If the output field WORM
Scratch Category does not contain a value, you can use the UPDATE
LIBRARY command to specify a value. However, if the field does
contain a value, you cannot use the UPDATE LIBRARY command to
change it.
SERial
Specifies the serial number for the library being updated. This parameter is
valid only for SCSI libraries. This parameter is optional. The possible values
are:
serial_number
Specifies the serial number for the library being updated.
UPDATE LIBRARY
Chapter 2. Administrative commands 1147
If a path to this library has already been defined, then the number you
enter here will be compared to the number detected by Tivoli Storage
Manager. If the numbers do not match, then this command will fail. If a
path has not been defined, this serial number will be verified when a path
is defined.
AUTODetect
Specifies that the serial number will be automatically detected and used by
Tivoli Storage Manager if a path has already been defined to this library.
If a path to this library has not been defined, then the serial number will
not be detected.
ACSID
Specifies the ID of the drive that is being accessed in an ACSLS library. The
drive ID is a set of numbers that indicates the physical location of a drive
within an ACSLS library. This drive ID must be specified as a,l,p,d, where a is
the ACSID, l is the LSM (library storage module), p is the panel number, and d
is the drive ID. The server needs the drive ID to connect the physical location
of the drive to the drives SCSI address. See the StorageTek documentation for
details.
AUTOLabel
Specifies whether the server attempts to automatically label tape volumes. This
parameter is optional. The default for 349X, ACSLS, External and Manual
libraries is Yes. The default for SCSI libraries is No.
To use this option, you need to check in the tapes with
CHECKLABEL=BARCODE on the CHECKIN LIBVOLUME command.
No
Specifies that the server does not attempt to label any volumes.
Yes
Specifies that the server only labels unlabeled volumes.
OVERWRITE
Specifies that the server attempts to overwrite an existing label. The server
overwrites existing labels only if both the existing label and the bar code
label are not already defined in any server storage pool or volume history
list.
PRIMarylibmanager
Specifies the name of the IBM Tivoli Storage Manager server that is responsible
for controlling access to library resources. You must define this server with the
DEFINE SERVER command before you can use it for a primary library
manager. This parameter is only valid for libraries defined to a library client.
ACSID
Specifies the number of this StorageTek library assigned by the ACSSA
(Automatic Cartridge System System Administrator). This can be a number
from 0 to 126. Issue QUERY ACS on your system to get the number for your
library ID. See your StorageTek documentation for more information.
LANFree
Specifies whether the external library is used for LAN-free operations.
Yes
Specifies that this library is used for LAN-free data movement.
No
Specifies that this library is not used for LAN-free data movement.
UPDATE LIBRARY

1148 IBM Tivoli Storage Manager for Windows: Administrators Reference
RESETDrives
Specifies whether the server performs a target reset when the server is
restarted or when a library client or storage agent re-connection is established.
Note: This parameter only applies to SCSI, 3494, Manual, and ACSLS type
libraries.
Yes
Specifies that the target reset is to be performed. YES is the default for
SCSI, 3494, Manual, and ACSLS libraries defined or updated with
SHARED=YES.
No
Specifies that the target reset is not performed. NO is the default for SCSI,
3494, Manual, and ACSLS libraries defined with SHARED=NO.
Examples
Task
Update a 3494 shared library named 3494LIB2 with new device names.
Command
update library 3494lib device=lb3.0.0.0,lb4.0.0.0,lb5.0.0.0
Task
Update an ACSLS library named ACSLSLIB with a new ID number.
Command
update library acslslib acsid=1
Task
Update an external library named EXTLIB with a new path name for the media
manager.
Command
update library extlib externalmanager=c:\server\mediamanager
Task
For a library client server, change the name of the library manager server to
CASTOR.
Command
update library pollux primarylibmanager=castor
Task
Update an external library named EXTLIB to be used in a LAN-free environment.
Command
update library extlib lanfree=yes
UPDATE LIBRARY
Chapter 2. Administrative commands 1149
Related commands
Table 379. Commands related to UPDATE LIBRARY
Command Description
AUDIT LIBRARY Ensures that an automated library is in a
consistent state.
DEFINE DRIVE Assigns a drive to a library.
DEFINE LIBRARY Defines an automated or manual library.
DEFINE PATH Defines a path from a source to a destination.
DELETE DRIVE Deletes a drive from a library.
DELETE LIBRARY Deletes a library.
DELETE PATH Deletes a path from a source to a destination.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more
libraries.
QUERY PATH Displays information about the path from a
source to a destination.
UPDATE DRIVE Changes the attributes of a drive.
UPDATE PATH Changes the attributes associated with a
path.

UPDATE LIBRARY

1150 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE LIBVOLUME (Change the status of a storage volume)
Use this command to change the status of a sequential access storage volume in a
library.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate LIBVolume library_name volume_name
STATus

=

PRIvate

SCRatch

OWNer

=

server_name


Parameters
library_name (Required)
Specifies the name of the library.
volume_name (Required)
Specifies the volume name of the storage volume.
STATus
Specifies a change to the status of a storage volume. Possible values are:
PRIvate
Specifies that the server updates the storage volume to a private volume.
SCRatch
Specifies that the server updates the storage volume to a scratch volume.
OWNer
Specifies which server owns a private volume in a shared library that is shared
across a SAN. You can change the owner of a private volume in a shared
library (SAN) when you issue the command from the library manager server. If
you do not specify this parameter, the library manager server owns the private
volume.
Note: OWNER is invalid for all scratch volumes, but is valid when changing a
scratch volume to private.
Examples
Task
Update the volume named WPDV00 located in the library named AUTO to reflect
a status of PRIVATE.
Command
update libvolume auto wpdv00 status=private
UPDATE LIBVOLUME
Chapter 2. Administrative commands 1151
Related commands
Table 380. Commands related to UPDATE LIBVOLUME
Command Description
AUDIT LIBRARY Ensures that an automated library is in a
consistent state.
CHECKIN LIBVOLUME Checks a storage volume into an automated
library.
CHECKOUT LIBVOLUME Checks a storage volume out of an
automated library.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
LABEL LIBVOLUME Labels volumes in manual or automated
libraries.
QUERY LIBRARY Displays information about one or more
libraries.
QUERY LIBVOLUME Displays information about a library volume.

UPDATE LIBVOLUME

1152 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE MACHINE (Update machine information)
Use this command to update machine information. This information will be
included in the plan file to help you to recover the client machines.
Privilege class
To issue this command, you must have system privilege.
Syntax
UPDate MACHine machine_name
DESCription

=

description

BUilding

=

building

FLoor

=

floor

ROom

=

room

PRIority

=

number

ADSMServer

=

Yes

No


Parameters
machine_name (Required)
Specifies the name of the machine to be updated.
DESCription
Specifies a description of the machine. This parameter is optional. The text can
be up to 255 characters. Enclose the text in quotation marks if it contains any
blank characters. To remove existing text, specify a null string ().
BUilding
Specifies the name or number of the building that this machine is in. This
parameter is optional. The text can be up to 16 characters. Enclose the text in
quotation marks if it contains any blank characters. To remove existing text,
specify a null string ().
FLoor
Specifies the name or number of the floor that this machine is on. This
parameter is optional. The text can be up to16 characters. Enclose the text in
quotation marks if it contains any blank characters. To remove existing text,
specify a null string ().
ROom
Specifies the name or number of the room that this machine is in. This
parameter is optional. The text can be up to 16 characters. Enclose the text in
quotation marks if it contains any blank characters. To remove existing text,
specify a null string ().
PRIority
Specifies the restore priority for the machine as an integer from 1 to 99. The
highest priority is 1. This parameter is optional. IBM Tivoli Storage Manager
uses this value to prioritize client machine recovery.
ADSMServer
Specifies whether the machine contains a IBM Tivoli Storage Manager server.
This parameter is optional. Possible values are:
No
This machine does not contain a IBM Tivoli Storage Manager server.
UPDATE MACHINE
Chapter 2. Administrative commands 1153
Yes
This machine contains a IBM Tivoli Storage Manager server. Only one
machine can be defined as containing an Tivoli Storage Manager server.
Examples
Task
Update the DISTRICT5 machine information to reflect that it contains the server.
Command
update machine district5 adsmserver=yes
Related commands
Table 381. Commands related to UPDATE MACHINE
Command Description
DEFINE MACHINE Defines a machine for DRM.
DELETE MACHINE Deletes a machine.
INSERT MACHINE Inserts machine characteristics or recovery
instructions into the IBM Tivoli Storage
Manager database.
QUERY MACHINE Displays information about machines.

UPDATE MACHINE

1154 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE MGMTCLASS (Update a management class)
Use this command to change a management class. To allow clients to use the
updated management class, you must activate the policy set that contains the
management class.
Note: The UPDATE MGMTCLASS command fails if a copy storage pool is
specified as the destination for space-managed files.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the policy
set belongs.
Syntax
UPDate MGmtclass domain_name policy_set_name class_name

SPACEMGTECHnique

=

AUTOmatic

SELective

NONE

AUTOMIGNonuse

=

days

MIGREQUIRESBkup

=

Yes

No

MIGDESTination

=

pool_name

DESCription

=

description


Parameters
domain_name (Required)
Specifies the policy domain to which the management class belongs.
policy_set_name (Required)
Specifies the policy set to which the management class belongs. You cannot
update a management class that belongs to the ACTIVE policy set.
class_name (Required)
Specifies the management class to update.
SPACEMGTECHnique
Specifies whether a file using this management class is eligible for migration.
This parameter is optional. This parameter is effective only for Tivoli Storage
Manager for Space Management clients (also known as HSM clients), not for
backup-archive clients or application clients. Possible values are:
AUTOmatic
Specifies that the file is eligible for both automatic migration and selective
migration.
SELective
Specifies that the file is eligible for selective migration only.
NONE
Specifies that the file is not eligible for migration.
UPDATE MGMTCLASS
Chapter 2. Administrative commands 1155
AUTOMIGNonuse
Specifies the number of days that must elapse since a file was last used before
it is eligible for automatic migration. This parameter is optional. If
SPACEMGTECHNIQUE is not AUTOMATIC, the server ignores this attribute.
You can specify an integer from 0 to 9999.
This parameter is effective only for HSM clients, not for backup-archive clients
or application clients.
MIGREQUIRESBkup
Specifies whether a backup version of a file must exist before a file can be
migrated. This parameter is optional. This parameter is effective only for HSM
clients, not for backup-archive clients or application clients. Possible values are:
Yes
Specifies that a backup version must exist.
No
Specifies that a backup version is optional.
MIGDESTination
Specifies the primary storage pool where the server initially stores files
migrated from HSM clients. This parameter is effective only for HSM clients,
not for backup-archive clients or application clients.
The command fails if you specify a copy storage pool as the destination.
DESCription
Specifies a description of the management class. This parameter is optional.
The maximum length of the description is 255 characters. Enclose the
description in quotation marks if it contains any blank characters. To remove a
previously defined description, specify a null string ().
Examples
Task
For the management class ACTIVEFILES, in policy set VACATION in the
EMPLOYEE_RECORDS policy domain, change the storage pool where migrated
files are stored.
Command
update mgmtclass employee_records vacation
activefiles migdestination=diskpool2
Related commands
Table 382. Commands related to UPDATE MGMTCLASS
Command Description
ASSIGN DEFMGMTCLASS Assigns a management class as the default
for a specified policy set.
COPY MGMTCLASS Creates a copy of a management class.
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DEFINE MGMTCLASS Defines a management class.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
UPDATE MGMTCLASS

1156 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 382. Commands related to UPDATE MGMTCLASS (continued)
Command Description
DELETE MGMTCLASS Deletes a management class and its copy
groups from a policy domain and policy set.
QUERY COPYGROUP Displays the attributes of a copy group.
QUERY MGMTCLASS Displays information about management
classes.
QUERY POLICYSET Displays information about policy sets.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.

UPDATE MGMTCLASS
Chapter 2. Administrative commands 1157
UPDATE NODE (Update node attributes)
Use this command to modify the attributes of a registered node.
You must use the RENAME NODE command to change the name of a registered
node.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the client
node belongs.
Syntax

(1)
UPDate Node

node_name

password

FORCEPwreset

=

No

Yes

FORCEPwreset

=

Yes

PASSExp

=

days

CLOptset

=

option_set_name

CONtact

=

text

DOmain

=

domain_name

COMPression

=

Client

Yes

No

ARCHDELete

=

Yes

No

BACKDELete

=

No

Yes

WHEREDOmain

=

domain_name

WHEREPLatform

=

client_platform_name

MAXNUMMP

=

number

KEEPMP

=

No

Yes

URL

=

url_address

AUTOFSRename

=

Yes

No

Client

VALIdateprotocol

=

No

Dataonly

All

TXNGroupmax

=

0

number

DATAWritepath

=

DATAReadpath

=

UPDATE NODE

1158 IBM Tivoli Storage Manager for Windows: Administrators Reference

SESSIONINITiation

=

Clientorserver

SERVEROnly

HLAddress

=

ip_address

LLAddress

=

tcp_port

EMAILADDRESS

=

userID@node


Notes:
1 You must specify at least one optional parameter on this command.
Parameters
node_name (Required)
Specifies the name of the client node to be updated. You can use wildcard
characters to specify this name.
password
Specifies the new password for the client node. This parameter is optional. The
maximum length of the password is 64 characters. Passwords remain current
for a period determined by the password expiration period.
FORCEPwreset
Specifies whether to force a client to change or reset the password. This
parameter is optional. Possible values are:
No
Specifies that the password expiration period is set by the SET
PASSEXP command. The administrator does not force a client to
change or reset the password while attempting to logon to the server.
Note: This value is valid only when you specify a password.
Yes
Specifies that the client node or administrators password will expire at
the next logon. The client must change or reset the password at that
time.
PASSExp
Specifies the number of days the password remains valid. You can set the
password expiration period from 0 to 9999 days. A value of 0 means that the
password never expires. This parameter is optional. If you do not specify this
parameter, the password expiration period is unchanged.
You can change the password expiration period by using the UPDATE NODE
or SET PASSEXP commands. The SET PASSEXP command enables you to set a
common expiration period for all administrators and client nodes, or you may
use it to selectively set password expiration periods. If you selectively set a
password expiration period by using the REGISTER NODE command, the
UPDATE NODE command, or the SET PASSEXP command, the expiration
period is excluded from common password expiration periods that were
created using the SET PASSEXP command.
You can use the RESET PASSEXP command to reset the password expiration
period to the common expiration period.
CLOptset
Specifies the name of the option set to be used by the client. This parameter is
optional.
UPDATE NODE
Chapter 2. Administrative commands 1159
|||
CONtact
Specifies a text string of information identifying the client node. This
parameter is optional. The maximum length of the text string is 255 characters.
Enclose the contact information in quotation marks if it contains any blanks. To
remove previously defined contact information, specify a null string ().
DOmain
Specifies the name of the policy domain to which the client node is registered.
This parameter is optional.
Note: For servers with data retention protection enabled, an archived
registered node cannot be reassigned to a different policy domain. See
the Administrators Guide for more information.
COMPression
Specifies whether the client node compresses its files before sending them to
the server for backup and archive. This parameter is optional.
Note: This parameter cannot be specified for a NAS node.
Possible values are:
Client
Specifies that the client determines whether files will be compressed.
Yes
Specifies that the client node compresses its files before sending them to
the server for backup and archive.
No
Specifies that the client node does not compress its files before sending
them to the server for backup and archive.
ARCHDELete
Specifies whether the client node can delete its own archived files from the
server. This parameter is optional. Possible values are:
Yes
Specifies that the client node can delete its own archive files from the
server.
No
Specifies that the client node cannot delete its own archive files from the
server.
BACKDELete
Specifies whether the client node can delete its own backup files from the
server. This parameter is optional. Possible values are:
No
Specifies that the client node cannot delete its own backup files from the
server.
Yes
Specifies that the client node can delete its own backup files from the
server.
WHEREDOmain
Specifies the name of the policy domain to be used as a filter in combination
with the node name to select nodes to update. This parameter is optional.
UPDATE NODE

1160 IBM Tivoli Storage Manager for Windows: Administrators Reference
WHEREPLatform
Specifies the name of the client platform to be used as a filter in combination
with the node name to select nodes to update. This parameter is optional.
MAXNUMMP
Specifies the maximum number of mount points a node is allowed to use on
the server or storage agent only for operations such as backup, archive, and
HSM migration. The parameter is optional and does not apply to nodes with a
type of NAS or SERVER. The default value is 1. You can specify an integer
from 0999. A value of 0 specifies that a node cannot acquire any mount point
for a client data store operation. The MAXNUMMP value is not evaluated or
enforced during client data read operations such as restore, retrieve, and HSM
recall. However, mount points in use for data read operations are evaluated
against attempted concurrent data store operations for the same client node
and may prevent the data store operations from being able to acquire mount
points.
For volumes in a storage pool associated with the FILE device type, the server
allows multiple sessions to read and one process to write to the same volume
concurrently. To provide efficient access for nodes with data in FILE-type
storage pools, increase the value of the MAXNUMMP parameter to allow for
greater concurrency when accessing FILE volumes.
For nodes that store data into primary storage pools with simultaneous write
enabled, you may need to adjust the value of the MAXNUMMP parameter to
specify the correct number of mount points for each client session. For details,
refer to information about simultaneous write in the Administrators Guide.
URL
Specifies the clients Uniform Resource Locator (URL) address that the
administrator can use to administer the Tivoli Storage Manager client. If you
want to remove the value for this field, specify empty single quotes or empty
double quotes with no spaces, or .
KEEPMP
Specifies whether the client node keeps the mount point for the entire session.
The parameter is optional. Possible values are:
No
Specifies that the client node release the mount point during the session. If
policy definitions cause data to be stored to a disk storage pool after
storing data to a sequential access storage pool, any mount points held by
the session will be released.
Yes
Specifies that the client node must retain the mount point during the entire
session. If policy definitions cause data to be stored to a disk storage pool
after storing data to a sequential access storage pool, any mount points
held by the session will not be released.
AUTOFSRename
Specifies whether the client is prompted for renaming file spaces when the
client system upgrades to a client that supports Unicode. The prompting and
renaming, if allowed, occur only when the client runs one of the following
operations: archive, selective backup, full incremental backup, or partial
incremental backup. The renaming changes the names of existing backed-up
file spaces that are not in Unicode in server storage. Then the file spaces are
backed up in Unicode. You can use this parameter for Unicode-enabled Tivoli
Storage Manager clients using Windows, Macintosh OS X, and NetWare
operating systems.
UPDATE NODE
Chapter 2. Administrative commands 1161
|
|
|
|
|
|
|
|
|
|
Note: After the client with support for Unicode is installed, any new file
spaces that the client backs up are stored in server storage using the
UTF-8 code page. UTF-8 is a byte-oriented encoding form specified by
the Unicode Standard.
Possible values are:
Yes
The server automatically renames existing file spaces when the client
system upgrades to a client that supports Unicode, and the client runs one
of the following operations: archive, selective backup, full incremental
backup, or partial incremental backup. The renaming occurs whether the
client uses the graphical user interface, the command line, or the client
scheduler.
For example, the server renames a drive as follows:

Original name: D_DRIVE
New name: D_DRIVE_OLD

The new name indicates that the file space is stored on the server in format
that is not Unicode.
No
The server does not rename file spaces automatically when the client
system upgrades to a client that supports Unicode, and the client runs one
of the following operations: archive, selective backup, full incremental
backup, or partial incremental backup.
Client
The option AUTOFSRENAME in the clients option file determines
whether file spaces are renamed.
By default, the client option is set to PROMPT. When the client system
upgrades to a client that supports Unicode and the client runs a Tivoli
Storage Manager operation with the graphical user interface or the
command line, the program displays a one-time prompt to the user about
whether to rename file spaces.
When the client scheduler runs an operation, the program does not prompt
for a choice about renaming, and does not rename file spaces. Backups of
existing file spaces are sent as before (not in Unicode).
Refer to the appropriate Backup-Archive Clients Installation and Users Guide
book for more information on the client option.
VALIdateprotocol
Specify whether Tivoli Storage Manager performs a cyclic redundancy
check to validate the data sent between the client and the server. The
parameter is optional. Possible values are:
No
Specifies that Tivoli Storage Manager does not perform data validation
on any data sent between the client and server.
Dataonly
Specifies that Tivoli Storage Manager performs data validation only on
file data that is sent between the client and server. This does not
include the file metadata. This mode impacts performance because
additional overhead is required to calculate and compare cyclic
redundancy check (CRC) values between the client and the server.
UPDATE NODE

1162 IBM Tivoli Storage Manager for Windows: Administrators Reference
All
Specifies that Tivoli Storage Manager performs data validation on all
client file data, client file metadata, and server metadata that is sent
between the client and server. This mode impacts performance because
additional overhead is required to calculate and compare CRC values
between the client and the server.
TXNGroupmax
Specifies the number of files that are transferred as a group between a
client and a server between transaction commit points. Client performance
may be improved by using a larger value for this option.
Specifying 0 indicates the node will use the server global value that is set
in the server options file. To use a value other than the server global value,
specify a value of 4 through 65,000 for this parameter. The node value
takes precedence over the server value.
Attention: Increasing the TXNGROUPMAX value will result in increased
recovery log utilization. Higher recovery log utilization may increase the
risk of running out of log space. Evaluate each nodes performance before
changing this parameter. For more information on managing the recovery
log, see the Administrators Guide.
DATAWritepath
Specifies the transfer path used when the client sends data to the server,
storage agent, or both, during storage operations such as backup or
archive. The parameter is optional.
Note: If a path is unavailable, the node cannot send any data. For
example, if you select the LAN-free option but a LAN-free path is
not defined, the operation will not work.
Possible values are:
ANY
Specifies that data is sent to the server, storage agent, or both, via any
available path. A LAN-free path will be used if one is available. If a
LAN-free path is unavailable, the data will be moved via the LAN.
LAN
Specifies that data is sent via the LAN.
LANFree
Specifies that data is sent via a LAN-free path.
DATAReadpath
Specifies the transfer path used when the server, storage agent, or both
read data for a client, during operations such as restore or retrieve. The
parameter is optional.
Note: If a path is unavailable, data cannot be read. For example, if you
select the LAN-free option but a LAN-free path is not defined, the
operation will not work.
Possible values are:
ANY
Specifies that the server, storage agent, or both use any available path
to read data. A LAN-free path will be used if one is available. If a
LAN-free path is unavailable, the data will be read via the LAN.
UPDATE NODE
Chapter 2. Administrative commands 1163
LAN
Specifies that data is read via the LAN.
LANFree
Specifies that data is read via a LAN-free path.
SESSIONINITiation
Controls whether the server or the client initiates sessions. The parameter
is optional.
Clientorserver
Specifies that the client may initiate sessions with the server by
communicating on the TCP/IP port defined with the server option
TCPPORT. Server-prompted scheduling may also be used to prompt
the client to connect to the server.
SERVEROnly
Specifies that the server will not accept client requests for sessions. All
sessions must be initiated by server-prompted scheduling on the port
defined for the client with the REGISTER or UPDATE NODE
commands. You cannot use the client acceptor (dsmcad) to start the
scheduler when SESSIONINITIATION is set to SERVERONLY.
HLAddress
Specifies the client IP address that the server contacts to initiate scheduled
events. This optional parameter is used only when SESSIONINITIATION is
set to SERVERONLY, regardless of any addresses previously used by the
client to contact the server. If SESSIONINITIATION SERVERONLY is not in
use, this option has no effect.
The address can be specified either in numeric or host name format. If a
numeric address is used, it will be saved without verification by a domain
name server. If the address is not correct, it can cause failures when the
server attempts to contact the client. Host name format addresses will be
verified with a domain name server. Verified names will be saved and
resolved with Domain Name Services when the server contacts the client.
LLAddress
Specifies the client port number on which the client listens for sessions
from the server. This optional parameter is used only when
SESSIONINITIATION is set to SERVERONLY, regardless of any addresses
previously used by the client to contact the server. If SESSIONINITIATION
SERVERONLY is not in use, this option has no effect.
The value for this parameter must match the value of client option
TCPCLIENTPORT. The default value is 1501.
EMAILADDRESS
This parameter is used by IBM Tivoli Storage Manager Express only. It is
not currently used by Tivoli Storage Manager. Tivoli Storage Manager
Express uses this parameter to specify the E-mail address or addresses for
this administrator. Any reports that are directed to this administrator are
sent to these E-mail addresses in HTML format.
Examples
Task 1
UPDATE NODE

1164 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Update node LARRY so that the data on node LARRY will be compressed when it
is backed up or archived by Tivoli Storage Manager and so that the client cannot
delete archived files.
Command
update node larry compression=yes archdelete=no
Task 2
Update node LARRY and increase the TXNGroupmax to 1,000.
Command
update node larry txngroupmax=1000
Related commands
Table 383. Commands related to UPDATE NODE
Command Description
QUERY NODE Displays partial or complete information
about one or more clients.
REGISTER ADMIN Defines a new administrator without
granting administrative authority.
REGISTER NODE Defines a client to the server and sets options
for that user.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
RENAME NODE Changes the name for a user that belongs to
a specific policy domain.
RESET PASSEXP Resets the password expiration for nodes or
administrators.
SET PASSEXP Specifies the number of days after which a
password is expired and must be changed.
UPDATE ADMIN Changes the password or contact information
associated with any administrator.

UPDATE NODE
Chapter 2. Administrative commands 1165
UPDATE NODEGROUP (Update a node group)
Use this command to modify the description of a node group.
Privilege class
To issue this command, you must have system or unrestricted policy privilege.
Syntax
UPDate NODEGroup group_name DESCription = description

Parameters
group_name
Specifies the name of the node group whose description you want to update.
DESCription
Specifies a description of the node group. This parameter is required. The
maximum length of the description is 255 characters. If the description contains
any blanks, enclose the entire description in quotation marks.
Examples
Task
Update the node group, group1, with a new description.
Command
update nodegroup group1 description="Human Resources"
Related commands
Table 384. Commands related to UPDATE NODEGROUP
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a clients data.
QUERY BACKUPSET Displays backup sets.
QUERY NODEGROUP Displays information about node groups.
UPDATE BACKUPSET Updates a retention value associated with a
backup set.

UPDATE NODEGROUP

1166 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE PATH (Change a path)
Use this command to update a path definition.
Privilege class
To issue this command you must have system privilege or unrestricted storage
privilege.
Syntax when the destination is a drive
UPDate PATH source_name destination_name SRCType = DATAMover
SERVer

AUTODetect

=

No

Yes
DESTType = DRive LIBRary = library_name

DEVIce

=

device_name

ONLine

=

Yes

No

,

DIRectory

=

directory_name


Syntax when the destination is a library
UPDate PATH source_name destination_name SRCType = DATAMover
SERVer

AUTODetect

=

No

Yes
DESTType = LIBRary

DEVIce

=

device_name

EXTERNALManager

=

path_name

ONLine

=

Yes

No


Parameters
source_name (Required)
Specifies the name of source for the path. This parameter is required.
destination_name (Required)
Specifies the name of the destination. This parameter is required. The
destination can be a drive or a library.
Note: To define a path from a NAS data mover to a library, the library must
have LIBTYPE of SCSI, 349x, or ACSLS.
SRCType (Required)
Specifies the type of the source. This parameter is required. Possible values are:
DATAMover
Specifies that a data mover is the source.
UPDATE PATH
Chapter 2. Administrative commands 1167
SERVer
Specifies that a server or a storage agent is the source.
AUTODetect
Specifies whether the serial number for a drive or library will be automatically
detected, reported, and updated in IBM Tivoli Storage Manager. This
parameter is optional. This parameter is only valid for paths defined from the
local server to a drive or a library. Possible values are:
No
Specifies that the serial number will not be automatically updated.
Yes
Specifies that the serial number will be automatically updated to reflect the
same serial number that the drive reports to IBM Tivoli Storage Manager.
Note:
1. If you have not previously entered a serial number, then
AUTODETECT defaults to YES. If you have previously entered a
serial number, then AUTODETECT defaults to NO.
2. AUTODETECT=YES in this command overrides the serial
number set in the DEFINE DRIVE command.
3. DESTTYPE=DRIVE only: If you set DESTTYPE=DRIVE and
AUTODETECT=YES, then the drive element number in the IBM
Tivoli Storage Manager database will be automatically changed
to reflect the same element number that corresponds to the serial
number of that drive. This is true for drives in a SCSI library. For
more information about the element number, see the DEFINE
DRIVE command.
4. Depending on the capabilities of the device, the AUTODETECT
parameter may not be supported.
DESTType (Required)
Specifies the type of the destination. This parameter is required. Possible
values are:
DRive
Specifies that a drive is the destination. When the destination is a drive,
you must specify a library name.
LIBRary
Specifies that a library is the destination.
LIBRary
Specifies the name of the library to which the drive is assigned. This parameter
is required if DESTTYPE=DRIVE. The library and its drives must already be
defined to the IBM Tivoli Storage Manager server. If the path is from a NAS
data mover to a library, the library must have LIBTYPE of SCSI, 349x, or
ACSLS.
DEVIce
Specifies the name of the device as known to the source, or FILE if the device
is a logical drive in a FILE library.
The source uses the device name to access the drive or library. See Table 385 on
page 1169 for examples.
UPDATE PATH

1168 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 385. Examples of device names
Source to destination Example
Server to a drive (not a FILE drive) mt3
Server to a drive (REMOVABLEFILE drive) e:
Server to a library lb4.1
Storage agent to a drive (not a FILE drive) mt3
Storage agent to a drive when the drive is a logical
drive in a FILE library
FILE
NAS data mover to a library mc0
NAS data mover to a drive Network Appliance NAS file server:
rst0l
EMC Celerra NAS file server:
c436t0l1
IBM System Storage N Series: rst0l

Note:
1. For more complete information about device names when the source
is a server, see Administrators Guide.
2. For information about the device name when the source is a storage
agent, see the Storage Agent Users Guide.
3. For 349X libraries, the alias name is a symbolic name that is specified
in the /etc/ibmatl.conf file. For more information, refer to the IBM
TotalStorage Tape Device Drivers Installation and Users Guide. The
Guides can be downloaded from the FTP site at
ftp://ftp.software.ibm.com/storage/devdrvr/. They are located in
the Doc folder.
4. For information about how to obtain names for devices that are
connected to a NAS file server, consult the product information for
the file server. For example, for a Network Appliance file server,
connect to the file server using telnet and issue the SYSCONFIG
command. Use this command to determine device names for drives:
sysconfig -t
Use this command to determine the device name for a library:
sysconfig -m
EXTERNALManager
Specifies the location of the external library manager where IBM Tivoli Storage
Manager can send media access requests. This parameter is required when the
library name is an external library. Use single quotes around the value of this
parameter. For example, enter: c:\Program Files\bin\elm.exe
ONLine
Specifies whether the path is available for use. This parameter is optional.
Possible values are:
Yes
Specifies that the path is available for use.
No
Specifies that the path is not available for use.
UPDATE PATH
Chapter 2. Administrative commands 1169
The source and the destination must both be available to use the path. For
example, if the path from a data mover to a drive is online, but either the data
mover or the drive is offline, you cannot use the path.
Attention: If the path to a library is offline, the server will not be able to
access the library. If the server is halted and restarted while the path to the
library is offline, the library will not be initialized. See Administrators Guide for
additional information.
DIRectory
Specifies the directory location or locations for a storage agent to access the
files in a FILE library. The DIRECTORY parameter is also used for devices of
type REMOVABLEFILE. For REMOVABLEFILE devices, the DIRECTORY
parameter provides information for the server (not a storage agent) along with
the DRIVE parameter to describe access to the device. This parameter is
optional.
On storage agents, this parameter is only valid when all of the following
conditions are true:
v The source type is SERVER (meaning a storage agent that has been defined
as a server to this server).
v The source name is the name of a storage agent, not the server.
v The destination is a logical drive that is part of a FILE library.
v If multiple directories were specified for the device class associated with the
FILE library, the same number of directories must be specified with the
DIRectory parameter of the DEFINE PATH command, for each drive in the
FILE library. Storage agent directories are not validated on the Tivoli Storage
Manager server. Specifying incorrect directories can cause a run-time failure.
The directory name or names identify the locations where the storage agent
reads and writes the files that represent storage volumes for the FILE device
class that is associated with the FILE library. The default value for
DIRECTORY is the directory of the server at the time the command is issued,
unless the DSMSERV_DIR environment variable has been set.
Use a naming convention that allows you to associate the directory with a
particular physical drive. This can help ensure that your configuration is valid
for sharing the FILE library between the server and storage agent. If the
storage agent is on a Windows system, use a universal naming convention
(UNC) name. When the storage agent lacks permission to access remote
storage, the storage agent will experience mount failures.
The account associated with the storage agent service must be either an
account within the local administrators group or an account within the
domain administrators group. If the account is in the local administrators
group, the user ID and password must match that of an account with
permissions to access storage as provided by the machine which administers
the remote share. For example, if a SAMBA server is providing access to
remote storage, the user ID and password in the SAMBA configuration must
match that of the local administrator user ID and password associated with the
storage agent service.
define devclass file devtype=file shared=yes mountlimit=1
directory=d:\filedir\dir1
define path sta1 file1 srctype=server desttype=drive
library=file1 device=file directory=\\192.168.1.10\filedir\dir1
In the example above, the DEFINE DEVCLASS command establishes the
shared file system in the directory accessed by the server as
UPDATE PATH

1170 IBM Tivoli Storage Manager for Windows: Administrators Reference
D:\FILEDIR\DIR1. The storage agent, however, is using UNC name
\\192.168.1.10\FILEDIR\DIR1. This means that the machine with TCP/IP
address 192.168.1.10 is sharing the same directory using FILEDIR as the shared
name. Also, the storage agent service has an account which can access this
storage. It can access it either because it is associated with a local account with
the same user ID and password as 192.168.1.10 or it is associated with a
domain account which is available on both the storage agent and on
192.168.1.10. If appropriate to the installation, you can replace the 192.168.1.10
with a symbolic name such as:
example.yourcompany.com
Note: Tivoli Storage Manager does not create shares or permissions, or mount
the target file system. You must perform these actions before starting the
storage agent.
For information about the DSMSERV_DIR variable, refer to Installation Guide.
Note:
1. You can modify a list of directories only by replacing the entire list.
2. You must ensure that storage agents can access newly created FILE
volumes. To access FILE volumes, storage agents replace names from
the directory list in the device-class definition with the names in the
directory list for the associated path definition. The following
illustrates the importance of matching device classes and paths to
ensure that storage agents can access newly created FILE volumes.
Suppose you want to use these three directories for a FILE library:
c:\server
d:\server
e:\server
a. You use the following command to set up a FILE library named
CLASSA with one drive named CLASSA1 on SERVER1:
define devclass classa devtype=file
directory="c:\server,d:\server,e:\server"
shared=yes mountlimit=1
b. You want the storage agent STA1 to be able to use the FILE
library, so you define the following path for storage agent STA1:
define path server1 sta1 srctype=server desttype=drive device=file
directory="\\192.168.1.10\c\server,\\192.168.1.10\d\server,
\\192.168.1.10\e\server" library=classa
In this scenario, the storage agent, STA1, will replace the
directory name c:\server with the directory name
\\192.168.1.10\c\server to access FILE volumes that are in the
c:\server directory on the server.
c. File volume c:\server\file1.dsm is created by SERVER1. If you
later change the first directory for the device class with the
following command:
update devclass classa directory="c:\otherdir,d:\server,e:\server"
SERVER1 will still be able to access file volume
c:\server\file1.dsm, but the storage agent STA1 will not be able
to access it because a matching directory name in the PATH
directory list no longer exists. If a directory name is not available
in the directory list associated with the device class, the storage
UPDATE PATH
Chapter 2. Administrative commands 1171
agent can lose access to a FILE volume in that directory.
Although the volume will still be accessible from the Tivoli
Storage Manager server for reading, failure of the storage agent
to access the FILE volume can cause operations to be retried on a
LAN-only path or to fail.
Examples
Task
Update a path from a data mover that is a NAS file server to the drive TAPEDRV2
that the data mover uses for backup and restore operations. In this example, the
NAS data mover is NAS1, the library is NASLIB, and the device name for the
drive is rst0l.
Command
update path nas1 tapedrv2 srctype=datamover desttype=drive
library=naslib device=rst0l
Related commands
Table 386. Commands related to UPDATE PATH
Command Description
DEFINE DATAMOVER Defines a data mover to the IBM Tivoli
Storage Manager server.
DEFINE DRIVE Assigns a drive to a library.
DEFINE LIBRARY Defines an automated or manual library.
DEFINE PATH Defines a path from a source to a destination.
DELETE PATH Deletes a path from a source to a destination.
QUERY PATH Displays information about the path from a
source to a destination.
UPDATE DATAMOVER Changes the definition for a data mover.

UPDATE PATH

1172 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE POLICYSET (Update a policy set description)
Use this command to change the description of a policy set. You cannot change the
description of the ACTIVE policy set.
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the policy
set belongs.
Syntax
UPDate POlicyset domain_name policy_set_name
DESCription = description

Parameters
domain_name (Required)
Specifies the policy domain to which the policy set belongs.
policy_set_name (Required)
Specifies the policy set to update. You cannot change the ACTIVE policy set.
DESCription (Required)
Specifies text that describes the policy set. The maximum length of the
description is 255 characters. Enclose the description in quotation marks if it
contains any blank characters. To remove a previously defined description,
specify a null string ().
Examples
Task
Update a policy set called VACATION for the EMPLOYEE_RECORDS policy
domain with a description of Schedule Planning Information.
Command
update policyset employee_records vacation
description="schedule planning information"
Related commands
Table 387. Commands related to UPDATE POLICYSET
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
COPY MGMTCLASS Creates a copy of a management class.
DEFINE DOMAIN Defines a policy domain that clients can be
assigned to.
DEFINE MGMTCLASS Defines a management class.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
DELETE POLICYSET Deletes a policy set, including its
management classes and copy groups, from a
policy domain.
UPDATE POLICYSET
Chapter 2. Administrative commands 1173
Table 387. Commands related to UPDATE POLICYSET (continued)
Command Description
QUERY POLICYSET Displays information about policy sets.
VALIDATE POLICYSET Verifies and reports on conditions the
administrator must consider before activating
the policy set.

UPDATE POLICYSET

1174 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE PROFILE (Update a profile description)
Use this command on a configuration manager to update a profile description.
Privilege class
To issue this command, you must have system privilege.
Syntax
UPDate PROFIle profile_name DESCription = description

Parameters
profile_name (Required)
Specifies the profile to update.
DESCription (Required)
Specifies a description for the profile. The maximum length of the description
is 255 characters. Enclose the description in quotation marks if it contains any
blank characters. To remove a description, specify a null string ().
Examples
Task
Update the description for profile DELTA.
Command
update profile delta description="PAYROLL domain"
Related commands
Table 388. Commands related to UPDATE PROFILE
Command Description
COPY PROFILE Creates a copy of a profile.
DEFINE PROFASSOCIATION Associates objects with a profile.
DEFINE PROFILE Defines a profile for distributing information
to managed servers.
DELETE PROFASSOCIATION Deletes the association of an object with a
profile.
DELETE PROFILE Deletes a profile from a configuration
manager.
LOCK PROFILE Prevents distribution of a configuration
profile.
QUERY PROFILE Displays information about configuration
profiles.
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UNLOCK PROFILE Enables a locked profile to be distributed to
managed servers.

UPDATE PROFILE
Chapter 2. Administrative commands 1175
UPDATE RECOVERYMEDIA (Update recovery media)
Use this command to update information about recovery media.
Privilege class
To issue this command, you must have system privilege.
Syntax
UPDate RECOVERYMedia media_name

,

VOLumenames

=

volume_name

DESCription

=

description

LOcation

=

location

Type

=

BOot

OTher

PROduct

=

product_name

PRODUCTInfo

=

product_information


Parameters
media_name (Required)
Specifies the name of the recovery media to be updated.
VOLumenames
Specifies the names of volumes that contain the recoverable data (for example,
operating system image copies). If you specify a TYPE=BOOT, you must
specify the boot media volume names in the order in which they are to be
loaded at recovery time. The volume names list can be up to 255 characters.
Enclose the list in quotation marks if it contains any blank characters. To
remove all volume names, specify a null string ().
DESCription
Specifies the description of the recovery media. This parameter is optional. You
can use up to 255 characters. Enclose the text in quotation marks if it contains
any blank characters.
LOcation
Describes the location of the recovery media. This parameter is optional. You
can use up to 255 characters. Enclose the text in quotation marks if it contains
any blank characters. To remove a location description, specify a null string ()
for the value.
Type
Specifies the type of recovery media. This parameter is optional. Possible
values are:
BOot
Specifies that this is boot media. You must specify volume names if the
type is BOOT.
OTher
Specifies that this is not boot media. For example, a CD-ROM that contains
operating system manuals.
UPDATE RECOVERYMEDIA

1176 IBM Tivoli Storage Manager for Windows: Administrators Reference
PROduct
Specifies the name of the product that wrote to this media. This parameter is
optional. You can use up to 16 characters. Enclose the text in quotation marks
if it contains any blank characters. To remove a product name, specify a null
string () for the value.
PRODUCTInfo
Specifies any information about the product that wrote to the media that you
may need to restore the machine. This parameter is optional. You can use up to
255 characters. Enclose the text in quotation marks if it contains any blank
characters. To remove previously defined product information, specify a null
string () for the value.
Examples
Task
Update the location description for recovery media DIST5RM to Corporate
Headquarters Data Vault.
Command
update recoverymedia dist5rm
location="Corporate Headquarters Data Vault"
Related commands
Table 389. Commands related to UPDATE RECOVERYMEDIA
Command Description
DEFINE RECOVERYMEDIA Defines the media required to recover a
machine.
DELETE RECOVERYMEDIA Deletes recovery media.
QUERY RECOVERYMEDIA Displays media available for machine
recovery.

UPDATE RECOVERYMEDIA
Chapter 2. Administrative commands 1177
UPDATE SCHEDULE (Update a schedule)
Use this command to update a client or administrative command schedule.
The UPDATE SCHEDULE command takes two forms, depending on whether the
schedule applies to client operations or administrative commands. Within these
two forms, you can select either classic or enhanced style schedules. The syntax
and parameters for each form are defined separately.
Table 390. Commands related to UPDATE SCHEDULE
Command Description
COPY SCHEDULE Creates a copy of a schedule.
DEFINE SCHEDULE Defines a schedule for a client operation or
an administrative command.
DELETE SCHEDULE Deletes a schedule from the database.
QUERY EVENT Displays information about scheduled and
completed events for selected clients.
QUERY SCHEDULE Displays information about schedules.
SET MAXCMDRETRIES Specifies the maximum number of retries
after a failed attempt to execute a scheduled
command.
SET MAXSCHEDSESSIONS Specifies the maximum number of
client/server sessions available for processing
scheduled work.
SET RETRYPERIOD Specifies the time between retry attempts by
the client scheduler.
UPDATE SCHEDULE

1178 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE SCHEDULE client
Use the UPDATE SCHEDULE to update selected parameters for a client schedule.
This command does not change the client associations that have been made to this
schedule. Any clients that are associated with the original schedule process the
modified schedule.
Note: Not all clients can run all scheduled operations, even though Tivoli Storage
Manager allows you to define the schedule on the server and associate it
with the client. For example, a Macintosh client cannot run a schedule when
the action is to restore or retrieve files, or run an executable script. An
executable script is also known as a command file, a batch file, or a script
on different client operating systems.
Privilege class
To update a client schedule, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the schedule
belongs.
Syntax for a classic client schedule

(1)
UPDate SCHedule

domain_name

schedule_name

Type

=

Client

DESCription

=

description

ACTion

=

Incremental

Selective

Archive

REStore

RETrieve

IMAGEBACkup

IMAGEREStore

Command

Macro

OPTions

=

option_string

OBJects

=

object_string

PRIority

=

number

STARTDate

=

date

STARTTime

=

time

DURation

=

number

DURUnits

=

Minutes

Hours

Days

INDefinite

SCHEDStyle

=

Classic

PERiod

=

number

UPDATE SCHEDULE Client
Chapter 2. Administrative commands 1179

PERUnits

=

Hours

Days

Weeks

Months

Years

Onetime

DAYofweek

=

ANY

WEEKDay

WEEKEnd

SUnday

Monday

TUesday

Wednesday

THursday

Friday

SAturday

EXPiration

=

Never

date


Notes:
1 You must specify at least one optional parameter on this command.
Syntax for an enhanced client schedule

(1)
UPDate SCHedule

domain_name

schedule_name

Type

=

Client

DESCription

=

description

ACTion

=

Incremental

Selective

Archive

REStore

RETrieve

IMAGEBACkup

IMAGEREStore

Command

Macro

OPTions

=

option_string

OBJects

=

object_string

PRIority

=

number

STARTDate

=

date

STARTTime

=

time

DURation

=

number

DURUnits

=

Minutes

Hours

Days

UPDATE SCHEDULE Client

1180 IBM Tivoli Storage Manager for Windows: Administrators Reference

SCHEDStyle

=

Enhanced

MONth

=

ANY

JAnuary

February

MARch

APril

May

JUNe

JULy

AUgust

September

October

November

December

DAYOFMonth

=

ANY

Day

WEEKofmonth

=

ANY

FIrst

Second

Third

FOurth

Last

DAYofweek

=

ANY

WEEKDay

WEEKEnd

SUnday

Monday

TUesday

Wednesday

THursday

Friday

SAturday

EXPiration

=

Never

date


Notes:
1 You must specify at least one optional parameter on this command.
Parameters
domain_name (Required)
Specifies the name of the policy domain to which this schedule belongs.
schedule_name (Required)
Specifies the name of the schedule to be updated.
Type=Client
Specifies that a client schedule is updated. This parameter is optional. The
default is CLIENT.
DESCription
Specifies a description of the schedule. This parameter is optional. You can
specify up to 255 characters for the description. Enclose the description in
quotation marks if it contains blank characters. To remove a previously defined
description, specify a null string () for this value.
UPDATE SCHEDULE Client
Chapter 2. Administrative commands 1181
ACTion
Specifies the action that occurs when this schedule is processed. Possible
values are:
Incremental
Specifies that the schedule backs up all files that are new or that have
changed since the last incremental backup. Incremental also backs up any
file for which all existing backups may have expired.
Selective
Specifies that the schedule backs up only files that are specified with the
OBJECTS parameter.
Archive
Specifies that the schedule archives files that are specified with the
OBJECTS parameter.
REStore
Specifies that the schedule restores files that are specified with the
OBJECTS parameter.
When you specify ACTION=RESTORE for a scheduled operation, and the
REPLACE option is set to PROMPT, no prompting occurs. If you set the
option to PROMPT, the files are skipped. If you specify a second file
specification, this second file specification acts as the restore destination. If
you need to restore multiple groups of files, schedule one for each file
specification that you need to restore.
RETrieve
Specifies that the schedule retrieves files that are specified with the
OBJECTS parameter.
IMAGEBACkup
Specifies that the schedule backs up logical volumes that are specified with
the OBJECTS parameter.
IMAGEREStore
Specifies that the schedule restores logical volumes that are specified with
the OBJECTS parameter.
Command
Specifies that the schedule processes a client operating system command or
script that is specified with the OBJECTS parameter.
Macro
Specifies that a client processes a macro whose file name is specified with
the OBJECTS parameter.
OPTions
Specifies the client options that you specify to the scheduled command at the
time the schedule is processed. This parameter is optional.
Only those options that are valid on the scheduled command may be specified
for this parameter. Refer to the appropriate client manual for information about
options that are valid from the command line. All options described there as
valid only on the initial command line will either result in an error or simply
be ignored when the schedule from the server is run. For example, do not
include the following options because they have no effect when the client
processes the scheduled command:
MAXCMDRETRIES
OPTFILE
UPDATE SCHEDULE Client

1182 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERYSCHEDPERIOD
RETRYPERIOD
SCHEDLOGNAME
SCHEDMODE
SERVERNAME
TCPCLIENTADDRESS
TCPCLIENTPORT
When you define a scheduler service by using the DSMCUTIL command or the
wizard in the backup-archive client GUI, you specify an options file for the
scheduler service to use. You cannot override the options in that options file by
issuing the scheduled command. You must modify the options in your
scheduler service.
If the option string contains multiple options or options with embedded
spaces, surround the entire option string with one pair of single quotes.
Individual options that contain spaces should be enclosed in double quotes. A
leading minus sign is required in front of the option. Errors can occur if the
option string contains spaces that are not quoted correctly.
The following examples show how to specify some client options:
v To specify subdir=yes and domain all-local -systemobject, enter:
options=-subdir=yes -domain="all-local -c: -systemobject"
v To specify domain all-local -c: -d:, enter:
options=-domain="all-local -c: -d:"
Note: For Windows clients running in batch mode: If the use of double
quotes is necessary, use interactive mode (Processing a series of
commands from the administrative client on page 3) or operating
system escape characters. See Processing commands one at a time from
the administrative client on page 3 for additional information.
OBJects
Specifies the objects for which the specified action is performed. Use a single
space between each object. This parameter is required except when
ACTION=INCREMENTAL. If the action is a backup, archive, retrieve, or
restore operation, the objects are file spaces, directories, or logical volumes. See
the Backup-Archive Clients Installation and Users Guide for command syntax
information. If the action is to run a command or macro, the object is the name
of the command or macro to run.
When you specify ACTION=INCREMENTAL without specifying a value for
this parameter, the scheduled command is invoked without specified objects
and attempts to process the objects as defined in the clients option file. To
select all file spaces or directories for an action, explicitly list them in the object
string. Entering only an asterisk in the object string causes the backup to occur
only for the directory where the scheduler was started.
Note:
1. If you specify a second file specification, and it is not a valid
destination, you receive this error:
ANS1082E Invalid destination file specification <filespec> entered.
2. If you specify more than two file specifications, you receive this
error:
UPDATE SCHEDULE Client
Chapter 2. Administrative commands 1183
ANS1102E Excessive number of command line arguments passed to the
program!
When you specify ACTION=ARCHIVE, INCREMENTAL, or SELECTIVE for
this parameter, you can list a maximum of twenty (20) file specifications.
Enclose the object string in double quotes if it contains blank characters
(spaces), and then surround the double quotes with single quotes. If the object
string contains multiple file names, enclose each file name with its own pair of
double quotes, then surround the entire string with one pair of single quotes.
Errors can occur if file names contain a space that is not quoted correctly. The
following examples show how to specify some file names:
v To specify C:\FILE 2, D:\GIF FILES, and E:\MY TEST FILE, enter:
OBJECTS="C:\FILE 2" "D:\GIF FILES" "E:\MY TEST FILE"
v To specify D:\TEST FILE, enter:
OBJECTS="D:\TEST FILE"
Note: For Windows clients running in batch mode: If the use of double
quotes is necessary, use interactive mode (Processing a series of
commands from the administrative client on page 3) or operating
system escape characters. See Processing commands one at a time from
the administrative client on page 3 for additional information.
PRIority
Specifies the priority value for a schedule. This parameter is optional. You can
specify an integer from 1 to 10, with 1 being the highest priority and 10 being
the lowest. The default is 5.
If two or more schedules have the same window start time, the value you
specify determines when Tivoli Storage Manager processes the schedule. The
schedule with the highest priority starts first. For example, a schedule with
PRIORITY=3 starts before a schedule with PRIORITY=5.
STARTDate
Specifies the date for the beginning of the window in which the schedule is
first processed. This parameter is optional. The default is the current date. Use
this parameter with the STARTTIME parameter to specify when the initial
startup window of the schedule starts.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified. The maximum
number of days you can specify
is 9999.
TODAY +3 or +3.

STARTTime
Specifies the time for the beginning of the window in which the schedule is
first processed. This parameter is optional. The default is the current time. This
parameter is used in conjunction with the STARTDATE parameter to specify
when the initial startup window begins.
UPDATE SCHEDULE Client

1184 IBM Tivoli Storage Manager for Windows: Administrators Reference
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified
NOW+02:00 or +02:00.
If you issue this command at 5:00 with
STARTTIME=NOW+02:00 or
STARTTIME=+02:00, the beginning of
the startup window is at 7:00.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW-02:00 or 02:00.
If you issue this command at 5:00 with
STARTTIME=NOW02:00 or
STARTTIME=-02:00, the beginning of
the startup window is at 3:00.

DURation
Specifies the number of units that define the length of the startup window of
the scheduled operation. This parameter is optional. This value must be from 1
to 999. The default is 1.
Use this parameter with the DURUNITS parameter to specify the length of the
startup window. For example, if you specify DURATION=20 and
DURUNITS=MINUTES, the schedule must be started within 20 minutes of the
start date and start time. The default length of the startup window is 1 hour.
The duration of the window must be shorter than the period between
windows.
This value is ignored if you specify DURUNITS=INDEFINITE.
DURUnits
Specifies the time units used to determine the duration of the window in
which the schedule can start. This parameter is optional. The default is
HOURS.
Use this parameter with the DURATION parameter to specify how long the
startup window remains open to process the schedule. For example, if
DURATION=20 and DURUNITS=MINUTES, the schedule must be started
within 20 minutes of the start date and start time. The schedule may not
necessarily complete processing within this window. If the schedule needs to
be retried for any reason, the retry attempts must begin before the startup
window elapses, or the operation does not restart.
The default value for the length of the startup window is 1 hour. Possible
values are:
Minutes
Specifies that the duration of the window is defined in minutes.
Hours
Specifies that the duration of the window is defined in hours.
Days
Specifies that the duration of the window is defined in days.
INDefinite
Specifies that the startup window of the scheduled operation has an
indefinite duration. The schedule can run any time after the scheduled
UPDATE SCHEDULE Client
Chapter 2. Administrative commands 1185
start time, until the schedule expires. You cannot specify
DURUNITS=INDEFINITE, unless you specify PERUNITS=ONETIME. The
INDEFINITE value is not allowed with enhanced schedules.
SCHEDStyle
This parameter is optional. SCHEDSTYLE defines either the interval between
times when a schedule should run, or the days on which it should run. The
style can be either classic or enhanced. This parameter must be specified when
you change a schedule from classic to enhanced or back to classic. Otherwise,
the value for the existing schedule is used.
For classic schedules, these parameters are allowed: PERIOD, PERUNITS, and
DAYOFWEEK. These parameters are not allowed: MONTH, DAYOFMONTH,
and WEEKOFMONTH. If the previous schedule style was enhanced, the
MONTH, DAYOFMONTH, WEEKOFMONTH, and DAYOFWEEK parameters
will be reset. DAYOFWEEK, PERIOD, and PERUNITS will be set to default
values unless they are specified with the update command.
For enhanced schedules, these parameters are allowed: MONTH,
DAYOFMONTH, WEEKOFMONTH, and DAYOFWEEK. These parameters are
not allowed: PERIOD and PERUNITS. If the previous schedule style was
classic, the DAYOFWEEK, PERIOD, and PERUNITS parameters will be reset.
MONTH, DAYOFMONTH, WEEKOFMONTH, and DAYOFWEEK will be set
to default values unless they are specified with the update command.
PERiod
Specifies the length of time between startup windows for this schedule. This
parameter is optional. This parameter is used only with classic schedules. You
can specify an integer from 1 to 999. The default is 1.
Use this parameter with the PERUNITS parameter to specify the period
between startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is
scheduled every five days after the initial start date and start time. The period
between startup windows must exceed the duration of each window. The
default is 1 day.
This value is ignored if you specify PERUNITS=ONETIME.
PERUnits
Specifies the time units used to determine the period between startup windows
for this schedule. This parameter is optional. This parameter is used only with
classic schedules. The default is DAYS.
Use this parameter with the PERIOD parameter to specify the period between
startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is
scheduled every 5 days after the initial start date and start time. The default is
1 day. Possible values are:
Hours
Specifies that the time between startup windows is in hours.
Days
Specifies that the time between startup windows is in days.
Weeks
Specifies that the time between startup windows is in weeks.
Months
Specifies that the time between startup windows is in months.
UPDATE SCHEDULE Client

1186 IBM Tivoli Storage Manager for Windows: Administrators Reference
Note: When you specify PERUNITS=MONTHS, the scheduled operation
will be processed each month on the same date. For example, if the
start date for the scheduled operation is 02/04/1998, the schedule
will process on the 4th of every month thereafter. However, if the
date is not valid for the next month, then the scheduled operation
will be processed on the last valid date in the month. Thereafter,
subsequent operations are based on this new date. For example, if
the start date is 03/31/1998, the next months operation will be
scheduled for 04/30/1998. Thereafter, all subsequent operations will
be on the 30th of the month until February. Because February has
only 28 days, the operation will be scheduled for 02/28/1999.
Subsequent operations will be processed on the 28th of the month.
Years
Specifies that the time between startup windows for the schedule is in
years.
Note: When you specify PERUNITS=YEARS, the scheduled operation will
be processed on the same month and date of each year. For example,
if the start date for the scheduled operation is 02/29/2004, the next
years scheduled operation will be 02/28/2005 because February
only has 28 days. Thereafter, subsequent operations will be
scheduled for February 28th.
Onetime
Specifies that the schedule processes once. This value overrides the value
you specified for the PERIOD parameter.
DAYofweek
Specifies the day of the week on which the startup window for the schedule
begins. This parameter is optional. You can specify different options for the
DAYofweek parameter, depending on whether the schedule style has been
defined as Classic or Enhanced:
Classic Schedule
Specifies the day of the week on which the startup window for the
schedule begins. This parameter is optional. You can either specify one
day of the week, or WEEKDAY, WEEKEND, or ANY. If the start date
and start time fall on a day that does not correspond to a day you
specify, the start date and start time will be shifted forward in 24hour
increments until the DAYOFWEEK parameter is satisfied.
If you select a value for DAYOFWEEK other than ANY, and depending
on the values for PERIOD and PERUNITS, schedules may not be
processed when you would expect. The default is ANY.
Enhanced Schedule
Specifies the days of the week on which to run the schedule. You can
either specify multiple days separated by commas and no intervening
blanks, or WEEKDAY, WEEKEND, or ANY. If you specify multiple
days, the schedule will run on each of the specified days. If you
specify WEEKDAY or WEEKEND, you must also specify either
WEEKOFMONTH=FIRST or WEEKOFMONTH=LAST, and the
schedule will run just once per month.
The default value is ANY, meaning the schedule will run every day of
the week or on the day or days determined by other enhanced
UPDATE SCHEDULE Client
Chapter 2. Administrative commands 1187
schedule parameters. DAYOFWEEK must have a value of ANY (either
by default or specified with the command) when used with the
DAYOFMONTH parameter.
Possible values for the DAYofweek parameter are:
ANY
Specifies that the startup window can begin on any day of the week.
WEEKDay
Specifies that the startup window can begin on Monday, Tuesday,
Wednesday, Thursday, or Friday.
WEEKEnd
Specifies that the startup window can begin on Saturday or Sunday.
SUnday
Specifies that the startup window begins on Sunday.
Monday
Specifies that the startup window begins on Monday.
TUesday
Specifies that the startup window begins on Tuesday.
Wednesday
Specifies that the startup window begins on Wednesday.
THursday
Specifies that the startup window begins on Thursday.
Friday
Specifies that the startup window begins on Friday.
SAturday
Specifies that the startup window begins on Saturday.
MONth
Specifies the months of the year during which to run the schedule. This
parameter is used only with enhanced schedules. Specify multiple values by
using commas and no intervening blanks. The default value is ANY. This
means the schedule will run during every month of the year.
DAYOFMonth
Specifies the day of the month to run the schedule. This parameter is used
only with enhanced schedules. You can either specify ANY or a number from
-31 through 31, excluding zero. Negative values are a day from the end of the
month, counting backwards. For example, the last day of the month is -1, the
next-to-the-last day of the month is -2, etc. You can specify multiple values
separated by commas and no intervening blanks. If you specify multiple
values, the schedule will run on each of the specified days of the month. If
multiple values resolve to the same day, the schedule will run only once that
day.
The default value is ANY. This means the schedule will run on every day of
the month or on the days determined by other enhanced schedule parameters.
DAYOFMONTH must have a value of ANY (either by default or specified with
the command) when used with the DAYOFWEEK or WEEKOFMONTH
parameters.
If an existing schedule specifies a value other than ANY for DAYOFWEEK and
WEEKOFMONTH, and DAYOFMONTH is updated, DAYOFWEEK and
WEEKOFMONTH are reset to ANY.
UPDATE SCHEDULE Client

1188 IBM Tivoli Storage Manager for Windows: Administrators Reference
WEEKofmonth
Specifies the week of the month in which to run the schedule. This parameter
is used only with enhanced schedules. A week is considered any seven-day
period which does not start on a particular day of the week. You can specify
FIRST, SECOND, THIRD, FOURTH, LAST, or ANY. You can specify multiple
values separated by commas and no intervening blanks. If you specify multiple
values, the schedule will run during each of the specified weeks of the month.
If multiple values resolve to the same week, the schedule will run only once
during that week.
The default value is ANY, meaning the schedule will run during every week of
the month or on the day or days determined by other enhanced schedule
parameters. WEEKOFMONTH must have a value of ANY (either by default or
specified with the command) when used with the DAYOFMONTH parameter.
EXPiration
Specifies the date after which this schedule is no longer used. This parameter
is optional. The default is NEVER. Possible values are:
Never
Specifies that the schedule never expires.
expiration_date
Specifies the date on which this schedule expires, in MM/DD/YYYY
format. If you specify an expiration date, the schedule expires at 23:59:59
on the date you specify.
Examples
Task 1
Update the MONTHLY_BACKUP schedule that belongs to the STANDARD policy
domain by setting its priority value to 1.
Command
update schedule standard monthly_backup priority=1
Task 2
Update the WEEKLY_BACKUP schedule that belongs to the
EMPLOYEE_RECORDS policy domain to expire on March 29, 1999 (03/29/1999).
Command
update schedule employee_records weekly_backup expiration=03/29/1999
Task 3
Update a schedule from archiving files quarterly on the last Friday of the month to
archiving on the last day of the specified months.
Note: WEEKOFMONTH and DAYOFWEEK will be reset to ANY.
Command
update schedule employee_records quarterly_archive dayofmonth=-1
UPDATE SCHEDULE Client
Chapter 2. Administrative commands 1189
UPDATE SCHEDULE administrative
Use this command to update selected parameters for an administrative command
schedule.
You cannot schedule MACRO or QUERY ACTLOG commands.
Privilege class
To update an administrative schedule, you must have system privilege.
Syntax
Classic administrative schedule

(1)
UPDate SCHedule

schedule_name

Type

=

Administrative

CMD

=

command

ACTIVE

=

Yes

No

DESCription

=

description

PRIority

=

number

STARTDate

=

date

STARTTime

=

time

DURation

=

number

DURUnits

=

Minutes

Hours

Days

INDefinite

SCHEDStyle

=

Classic

PERiod

=

number

PERUnits

=

Hours

Days

Weeks

Months

Years

Onetime

DAYofweek

=

ANY

WEEKDay

WEEKEnd

SUnday

Monday

TUesday

Wednesday

THursday

Friday

SAturday

EXPiration=

Never

date


Notes:
1 You must specify at least one optional parameter on this command.
UPDATE SCHEDULE Administrative

1190 IBM Tivoli Storage Manager for Windows: Administrators Reference
Syntax
Enhanced administrative schedule

(1)
UPDate SCHedule

schedule_name

Type

=

Administrative

CMD

=

command

ACTIVE

=

Yes

No

DESCription

=

description

PRIority

=

number

STARTDate

=

date

STARTTime

=

time

DURation

=

number

DURUnits

=

Minutes

Hours

Days

SCHEDStyle

=

Enhanced

MONth

=

ANY

JAnuary

February

MARch

APril

May

JUNe

JULy

AUgust

September

October

November

December

DAYOFMonth

=

ANY

Day

WEEKofmonth

=

ANY

FIrst

Second

Third

FOurth

Last

UPDATE SCHEDULE Administrative
Chapter 2. Administrative commands 1191

DAYofweek

=

ANY

WEEKDay

WEEKEnd

SUnday

Monday

TUesday

Wednesday

THursday

Friday

SAturday

EXPiration=

Never

date


Notes:
1 You must specify at least one optional parameter on this command.
Parameters
schedule_name (Required)
Specifies the name of the schedule to be updated.
Type=Administrative (Required)
Specifies that an administrative command schedule is updated.
CMD
Specifies the administrative command to be scheduled for processing. This
parameter is optional. The command you specify can contain up to 512
characters. Enclose the command in quotation marks if it contains blanks.
Note: You cannot specify redirection characters with this parameter.
ACTIVE
Specifies whether the administrative command is eligible for processing. This
parameter is optional. An administrative command schedule will not be
processed unless it is set to the active state. Possible values are:
YES
Specifies that the administrative command is eligible for processing.
NO
Specifies that the administrative command is not eligible for processing.
DESCription
Specifies a description of the schedule. This parameter is optional. You can
specify up to 255 characters for the description. Enclose the description in
quotation marks if it contains blanks. To remove a previously defined
description, specify a null string () for this value.
PRIority
Specifies the priority value for a schedule. This parameter is optional. You can
specify an integer from 1 to 10, with 1 being the highest priority and 10 being
the lowest. The default is 5.
If two or more schedules have the same window start time, the value you
specify determines when Tivoli Storage Manager processes the schedule. The
schedule with the highest priority starts first. For example, a schedule with
PRIORITY=3 starts before a schedule with PRIORITY=5.
STARTDate
Specifies the date for the beginning of the window in which the schedule is
UPDATE SCHEDULE Administrative

1192 IBM Tivoli Storage Manager for Windows: Administrators Reference
first processed. This parameter is optional. The default is the current date. Use
this parameter with the STARTTIME parameter to specify when the initial
startup window of the schedule starts.
You can specify the date using one of the values below:

Value Description Example
MM/DD/YYYY A specific date 09/15/1998
TODAY The current date TODAY
TODAY+days or
+days
The current date plus days
specified. The maximum
number of days you can specify
is 9999.
TODAY +3 or +3.

STARTTime
Specifies the time for the beginning of the window in which the schedule is
first processed. This parameter is optional. The default is the current time. This
parameter is used in conjunction with the STARTDATE parameter to specify
when the initial startup window begins.
You can specify the time using one of the values below:

Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM
or +HH:MM
The current time plus hours and
minutes specified
NOW+02:00 or +02:00.
If you issue this command at 5:00 with
STARTTIME=NOW+02:00 or
STARTTIME=+02:00, the beginning of
the startup window is at 7:00.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW-02:00 or 02:00.
If you issue this command at 5:00 with
STARTTIME=NOW02:00 or
STARTTIME=-02:00, the beginning of
the startup window is at 3:00.

DURation
Specifies the number of units that define the length of the startup window of
the scheduled operation. This parameter is optional. This value must be from 1
to 999. The default is 1.
Use this parameter with the DURUNITS parameter to specify the length of the
startup window. For example, if you specify DURATION=20 and
DURUNITS=MINUTES, the schedule must be started within 20 minutes of the
start date and start time. The default length of the startup window is 1 hour.
The duration of the window must be shorter than the period between
windows.
This value is ignored if you specify DURUNITS=INDEFINITE.
DURUnits
Specifies the time units used to determine the duration of the window in
which the schedule can start. This parameter is optional. The default is
HOURS.
UPDATE SCHEDULE Administrative
Chapter 2. Administrative commands 1193
Use this parameter with the DURATION parameter to specify how long the
startup window remains open to process the schedule. For example, if
DURATION=20 and DURUNITS=MINUTES, the schedule must be started
within 20 minutes of the start date and start time. The schedule may not
necessarily complete processing within this window. If the schedule needs to
be retried for any reason, the retry attempts must begin before the startup
window elapses, or the operation does not restart.
The default value for the length of the startup window is 1 hour. Possible
values are:
Minutes
Specifies that the duration of the window is defined in minutes.
Hours
Specifies that the duration of the window is defined in hours.
Days
Specifies that the duration of the window is defined in days.
INDefinite
Specifies that the startup window of the scheduled operation has an
indefinite duration. The schedule can run any time after the scheduled
start time, until the schedule expires. You cannot specify
DURUNITS=INDEFINITE, unless you specify PERUNITS=ONETIME. The
INDEFINITE value is not allowed with enhanced schedules.
SCHEDStyle
This parameter is optional. SCHEDSTYLE defines either the interval between
times when a schedule should run, or the days on which it should run. The
style can be either classic or enhanced. This parameter must be specified when
you change a schedule from classic to enhanced or back to classic. Otherwise,
the value for the existing schedule is used.
For classic schedules, these parameters are allowed: PERIOD, PERUNITS, and
DAYOFWEEK. These parameters are not allowed: MONTH, DAYOFMONTH,
and WEEKOFMONTH. If the previous schedule style was enhanced, the
MONTH, DAYOFMONTH, WEEKOFMONTH, and DAYOFWEEK parameters
will be reset. DAYOFWEEK, PERIOD, and PERUNITS will be set to default
values unless they are specified with the update command.
For enhanced schedules, these parameters are allowed: MONTH,
DAYOFMONTH, WEEKOFMONTH, and DAYOFWEEK. These parameters are
not allowed: PERIOD and PERUNITS.. If the previous schedule style was
classic, the DAYOFWEEK, PERIOD, and PERUNITS parameters will be reset.
MONTH, DAYOFMONTH, WEEKOFMONTH, and DAYOFWEEK will be set
to default values unless they are specified with the update command.
PERiod
Specifies the length of time between startup windows for this schedule. This
parameter is optional. This parameter is used only with classic schedules. You
can specify an integer from 1 to 999. The default is 1.
Use this parameter with the PERUNITS parameter to specify the period
between startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is
scheduled every five days after the initial start date and start time. The period
between startup windows must exceed the duration of each window. The
default is 1 day.
This value is ignored if you specify PERUNITS=ONETIME.
UPDATE SCHEDULE Administrative

1194 IBM Tivoli Storage Manager for Windows: Administrators Reference
PERUnits
Specifies the time units used to determine the period between startup windows
for this schedule. This parameter is optional. This parameter is used only with
classic schedules. The default is DAYS.
Use this parameter with the PERIOD parameter to specify the period between
startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is
scheduled every 5 days after the initial start date and start time. The default is
1 day. Possible values are:
Hours
Specifies that the time between startup windows is in hours.
Days
Specifies that the time between startup windows is in days.
Weeks
Specifies that the time between startup windows is in weeks.
Months
Specifies that the time between startup windows is in months.
Note: When you specify PERUNITS=MONTHS, the scheduled operation
will be processed each month on the same date. For example, if the
start date for the scheduled operation is 02/04/1998, the schedule
will process on the 4th of every month thereafter. However, if the
date is not valid for the next month, then the scheduled operation
will be processed on the last valid date in the month. Thereafter,
subsequent operations are based on this new date. For example, if
the start date is 03/31/1998, the next months operation will be
scheduled for 04/30/1998. Thereafter, all subsequent operations will
be on the 30th of the month until February. Because February has
only 28 days, the operation will be scheduled for 02/28/1999.
Subsequent operations will be processed on the 28th of the month.
Years
Specifies that the time between startup windows for the schedule is in
years.
Note: When you specify PERUNITS=YEARS, the scheduled operation will
be processed on the same month and date of each year. For example,
if the start date for the scheduled operation is 02/29/2004, the next
years scheduled operation will be 02/28/2005 because February
only has 28 days. Thereafter, subsequent operations will be
scheduled for February 28th.
Onetime
Specifies that the schedule processes once. This value overrides the value
you specified for the PERIOD parameter.
DAYofweek
Specifies the day of the week on which the startup window for the schedule
begins. This parameter is optional. You can specify different options for the
DAYofweek parameter, depending on whether the schedule style has been
defined as Classic or Enhanced:
Classic Schedule
Specifies the day of the week on which the startup window for the
schedule begins. This parameter is optional. You can either specify one
UPDATE SCHEDULE Administrative
Chapter 2. Administrative commands 1195
day of the week, or WEEKDAY, WEEKEND, or ANY. If the start date
and start time fall on a day that does not correspond to a day you
specify, the start date and start time will be shifted forward in 24hour
increments until the DAYOFWEEK parameter is satisfied.
If you select a value for DAYOFWEEK other than ANY, and depending
on the values for PERIOD and PERUNITS, schedules may not be
processed when you would expect. The default is ANY.
Enhanced Schedule
Specifies the days of the week on which to run the schedule. You can
either specify multiple days separated by commas and no intervening
blanks, or WEEKDAY, WEEKEND, or ANY. If you specify multiple
days, the schedule will run on each of the specified days. If you
specify WEEKDAY or WEEKEND, you must also specify either
WEEKOFMONTH=FIRST or WEEKOFMONTH=LAST, and the
schedule will run just once per month.
The default value is ANY, meaning the schedule will run every day of
the week or on the day or days determined by other enhanced
schedule parameters. DAYOFWEEK must have a value of ANY (either
by default or specified with the command) when used with the
DAYOFMONTH parameter.
Possible values for the DAYofweek parameter are:
ANY
Specifies that the startup window can begin on any day of the week.
WEEKDay
Specifies that the startup window can begin on Monday, Tuesday,
Wednesday, Thursday, or Friday.
WEEKEnd
Specifies that the startup window can begin on Saturday or Sunday.
SUnday
Specifies that the startup window begins on Sunday.
Monday
Specifies that the startup window begins on Monday.
TUesday
Specifies that the startup window begins on Tuesday.
Wednesday
Specifies that the startup window begins on Wednesday.
THursday
Specifies that the startup window begins on Thursday.
Friday
Specifies that the startup window begins on Friday.
SAturday
Specifies that the startup window begins on Saturday.
MONth
Specifies the months of the year during which to run the schedule. This
parameter is used only with enhanced schedules. Specify multiple values by
using commas and no intervening blanks. The default value is ANY. This
means the schedule will run during every month of the year.
UPDATE SCHEDULE Administrative

1196 IBM Tivoli Storage Manager for Windows: Administrators Reference
DAYOFMonth
Specifies the day of the month to run the schedule. This parameter can only be
specified with enhanced schedules. You can either specify ANY or a number
from -31 through 31, excluding zero. Negative values are a day from the end of
the month, counting backwards. For example, the last day of the month is -1,
the next-to-the-last day of the month is -2, etc. You can specify multiple values
separated by commas and no intervening blanks. If you specify multiple
values, the schedule will run on each of the specified days of the month. If
multiple values resolve to the same day, the schedule will run only once that
day.
The default value is ANY. This means the schedule will run on every day of
the month or on the days determined by other enhanced schedule parameters.
DAYOFMONTH must have a value of ANY (either by default or specified with
the command) when used with the DAYOFWEEK or WEEKOFMONTH
parameters.
WEEKofmonth
Specifies the week of the month in which to run the schedule. This parameter
can only be specified with enhanced schedules. A week is considered any
seven-day period which does not start on a particular day of the week. You
can specify FIRST, SECOND, THIRD, FOURTH, LAST, or ANY. You can specify
multiple values separated by commas and no intervening blanks. If you specify
multiple values, the schedule will run during each of the specified weeks of
the month. If multiple values resolve to the same week, the schedule will run
only once during that week.
The default value is ANY, meaning the schedule will run during every week of
the month or on the day or days determined by other enhanced schedule
parameters. WEEKOFMONTH must have a value of ANY (either by default or
specified with the command) when used with the DAYOFMONTH parameter.
EXPiration
Specifies the date after which this schedule is no longer used. This parameter
is optional. The default is NEVER. Possible values are:
Never
Specifies that the schedule never expires.
expiration_date
Specifies the date on which this schedule expires, in MM/DD/YYYY
format. If you specify an expiration date, the schedule expires at 23:59:59
on the date you specify.
Examples
Task 1
Update existing administrative schedule named BACKUP_BACKUPPOOL so that
starting today, the BACKUPPOOL primary storage pool is backed up to the
COPYSTG copy storage pool every three days at 10:00 p.m.
Command
update schedule backup_backuppool type=administrative cmd="backup
stgpool backuppool copystg" active=yes starttime=22:00 period=3
Task 2
UPDATE SCHEDULE Administrative
Chapter 2. Administrative commands 1197
Update a schedule named BACKUP_ARCHIVEPOOL that backs up the primary
storage pool ARCHIVEPOOL to the copy storage pool RECOVERYPOOL. The
existing schedule runs on the first and tenth day of every month. Update it to run
the first and third Friday of every month.
Note: DAYOFMONTH will be reset to ANY.
Command
update schedule backup_archivepool
dayofweek=friday weekofmonth=first,third
UPDATE SCHEDULE Administrative

1198 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE SCRIPT (Update a Tivoli Storage Manager script)
Use this command to change a command line or to add a new command line to an
IBM Tivoli Storage Manager script.
The Administration Center only supports ASCII characters for input. If you need to
enter characters that are not ASCII, issue the DEFINE SCRIPT and UPDATE
SCRIPT commands from the server console.
Privilege class
To issue this command, the administrator must have previously defined the script
or must have system privilege.
Syntax
UPDate SCRipt script_name
command_line

Line

=

number

DESCription

=

description


Parameters
script_name (Required)
Specifies the name of the script to be updated.
command_line
Specifies a new or updated command to be processed in a script. You must
update a command, a description, or both when you issue this command.
Command can contain substitution variables and may be continued across
multiple lines if you specify a continuation character (-) as the last character in
the command. You can specify up to 1200 characters for the command. Enclose
the command in quotation marks if it contains blanks. If you specify this
parameter, you can optionally specify the following parameter.
Line
Specifies the line number for the command. If you do not specify a line
number, the command line is appended to the existing series of command
lines. The appended command line is assigned a line number of five
greater than the last command line number in the sequence. For example,
if the last line in your script is 015, the appended command line is
assigned a line number of 020.
If you specify a line number, the command will replace an existing line (if
the number is the same as an existing line). Or the command will insert
the specified line (if the line number does not correspond to an existing
line number for the command line sequence).
DESCription
Specifies a description for the script. You can specify up to 255 characters for
the description. Enclose the description in quotation marks if it contains blank
characters.
Examples
Task 1
UPDATE SCRIPT
Chapter 2. Administrative commands 1199
Assume that you have defined a script named QSAMPLE with the following three
lines:
001 /* This is a sample script */
005 QUERY STATUS
010 QUERY PROCESS
1. Add command QUERY SESSION to the end of the QSAMPLE script.
Command
update script qsample "query session"
The script consists of the following lines after it processes:
001 /* This is a sample script */
005 QUERY STATUS
010 QUERY PROCESS
015 QUERY SESSION
2. Change line 010 so that it processes the QUERY STGPOOL command instead of
the QUERY PROCESS command:
Command
update script qsample "query stgpool" line=010
After the script processes, the script now consists of the following lines:
001 /* This is a sample script */
005 QUERY STATUS
010 QUERY STGPOOL
015 QUERY SESSION
Task 2
Insert a new command line (SET REGISTRATION OPEN) after the QUERY
STATUS command line in the QSAMPLE script:
Command
update script qsample "set registration open"
line=007
The following command lines result:
001 /* This is a sample script */
005 QUERY STATUS
007 SET REGISTRATION OPEN
010 QUERY STGPOOL
015 QUERY SESSION
Related commands
Table 391. Commands related to UPDATE SCRIPT
Command Description
COPY SCRIPT Creates a copy of a script.
DEFINE SCRIPT Defines a script to the IBM Tivoli Storage
Manager server.
DELETE SCRIPT Deletes the script or individual lines from the
script.
QUERY SCRIPT Displays information about scripts.
RENAME SCRIPT Renames a script to a new name.
RUN Runs a script.

UPDATE SCRIPT

1200 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE SERVER (Update a server defined for
server-to-server communications)
Use this command to update a server definition.
Attention: If this is a source server for a virtual volume operation, changing any
of these values can affect the ability of the source server to access and manage the
data it has stored on the corresponding target server. Changing the server name
using the SET SERVERNAME command might have additional implications,
varying by platform. The following are some examples:
v Passwords might be invalidated
v Device information might be affected
v Registry information on Windows platforms might change
Privilege class
To issue this command, you must have system privilege.
Syntax for enterprise configuration, enterprise event logging,
command routing, and storage agent
UPDate SERver server_name
SERVERPAssword

=

password

HLAddress

=

ip_address

LLAddress

=

tcp_port

COMMmethod

=

TCPIP

URL

=

url

ALLOWReplace

=

Yes

No

DESCription

=

description

FORCESync

=

Yes

No

(1)

VALIdateprotocol

=

No

All


Notes:
1 The VALIDATEPROTOCOL parameter only applies to storage agent
definitions.
Syntax for virtual volumes
UPDate SERver server_name
PAssword

=

password

HLAddress

=

ip_address

LLAddress

=

tcp_port

COMMmethod

=

TCPIP

URL

=

url

DELgraceperiod

=

days

UPDATE SERVER
Chapter 2. Administrative commands 1201

NODEName

=

node_name

FORCESync

=

Yes

No

DESCription

=

description


Parameters
server_name (Required)
Specifies the name of the server to be updated. This parameter is required.
PAssword
Specifies the password used to sign on to the target server for virtual volumes.
This parameter is optional.
SERVERPAssword
Specifies the server password, which is used for enterprise configuration,
command routing, and server-to-server event logging functions. The password
must match the server password set by the SET SERVERPASSWORD
command. This parameter is optional.
HLAddress
Specifies the IP address (in dotted decimal format) of the server. This
parameter is optional.
LLAddress
Specifies the low-level address of the server. This address is usually the same
as that in the TCPPORT server option of the target server. This parameter is
optional.
COMMmethod
Specifies the communication method used to connect to the server. This
parameter is optional.
URL
Specifies the URL address used to access this server from a Web administrative
interface. The parameter is optional.
DELgraceperiod
Specifies a number of days that an object remains on the target server after it
has been marked for deletion. Possible values are 0-9999. This parameter is
optional.
NODEName
Specifies a node name to be used by the server to connect to the target server.
This parameter is optional.
DESCription
Specifies a description of the server. This parameter is optional. The description
can be up to 255 characters. Enclose the description in quotation marks if it
contains blank characters. To remove an existing description, specify a null
string ().
FORCESync
Specifies whether to reset the server verification key when the source server
next signs on to the target server. A valid verification key lets a source server
put objects on the target server, manage the grace deletion period value, and
update the password (if the current password is known and the verification
key matches). The parameter is optional. Possible values are:
UPDATE SERVER

1202 IBM Tivoli Storage Manager for Windows: Administrators Reference
Yes
Specifies that a new verification key will be sent to and accepted by the
target server if a valid password is received.
No
Specifies that a new verification key will not be sent to the target server.
VALIdateprotocol
Specify whether a cyclic redundancy check should be performed to validate
the data sent between the storage agent and Tivoli Storage Manager server.
The parameter is optional. The default is NO. Possible values are:
No
Specifies that data validation not be performed on any data sent between
the storage agent and server.
All
Specifies that data validation be performed on all client file data, client file
metadata, and the Tivoli Storage Manager server metadata that is sent
between the storage agent and server. This mode impacts performance as
additional overhead is required to calculate and compare CRC values
between the storage agent and the server.
ALLOWReplace
Specifies whether a server definition that was defined by a managed server can
be replaced with a definition from the configuration manager. This parameter
is optional. Possible values are:
Yes
Specifies that a server definition can be replaced by a definition from the
configuration manager.
No
Specifies that a server definition cannot be replaced by the definition from
the configuration manager.
Examples
Task 1
Update the definition of SERVER2 to specify that objects remain on the target
server for 10 days after they have been marked for deletion.
Command
update server server2 delgraceperiod=10
Task 2
Update the definition of NEWSERVER to specify its URL address to be
http://newserver:1580/.
Command
update server newserver url=http://newserver:1580/
Related commands
Table 392. Commands related to UPDATE SERVER
Command Description
DEFINE DEVCLASS Defines a device class.
UPDATE SERVER
Chapter 2. Administrative commands 1203
Table 392. Commands related to UPDATE SERVER (continued)
Command Description
DEFINE SERVER Defines a server for server-to-server
communications.
DELETE DEVCLASS Deletes a device class name.
DELETE FILESPACE Deletes data associated with clients file
spaces.
DELETE SERVER Deletes the definition of a server.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY SERVER Displays information about servers.
RECONCILE VOLUMES Reconciles source server virtual volume
definitions and target server archive objects.
REGISTER NODE Defines a client to the server and sets options
for that user.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.
UPDATE DEVCLASS Changes the attributes of a device class.
UPDATE NODE Changes the attributes associated with a
client node.

UPDATE SERVER

1204 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE SERVERGROUP (Update a server group description)
Use this command to update the description of a server group.
Privilege class
To issue this command, you must have system privilege.
Syntax
UPDate SERVERGRoup group_name DESCription = description

Parameters
group_name (Required)
Specifies the server group to update.
DESCription (Required)
Specifies a description of the server group. The maximum length of the
description is 255 characters. Enclose the description in quotation marks if it
contains blank characters.
Examples
Task
Update the description of the server group named WEST_COMPLEX to Western
Region Complex.
Command
update servergroup west_complex
description="western region complex"
Related commands
Table 393. Commands related to UPDATE SERVERGROUP
Command Description
COPY SERVERGROUP Creates a copy of a server group.
DEFINE SERVERGROUP Defines a new server group.
DELETE SERVERGROUP Deletes a server group.
QUERY SERVERGROUP Displays information about server groups.
RENAME SERVERGROUP Renames a server group.

UPDATE SERVERGROUP
Chapter 2. Administrative commands 1205
UPDATE SPACETRIGGER (Update the space triggers)
Use this command to define settings for triggers that determine when and how
Tivoli Storage Manager resolves space shortages in the database or recovery logs,
and in storage pools using sequential-access FILE and random-access DISK device
classes. For storage pools with a parameter RECLAMATIONTYPE=SNAPLOCK,
space triggers are not enabled.
Attention: Space trigger functions and storage pool space calculations take into
account the space remaining in each directory. Ideally, you should associate each
directory with a separate file system. If you specify multiple directories for a
device class and the directories reside in the same file system, the server will
calculate space by adding values representing the space remaining in each
directory. These space calculations will be inaccurate. Rather than choosing a
storage pool with sufficient space for an operation, the server could choose the
wrong storage pool and run out of space prematurely. For space triggers, an
inaccurate calculation could result in a failure to expand the space available in a
storage pool. Failure to expand space in a storage pool is one of the conditions that
can cause a trigger to become disabled. If a trigger is disabled because the space in
a storage pool could not be expanded, you can re-enable the trigger by specifying
the following command: update spacetrigger stg. No further changes are
required to the space trigger.
See the DEFINE SPACETRIGGER command for more information.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
UPDate SPACETrigger DB
LOG

STG

Fullpct

=

percent

SPACEexpansion

=

percent

EXPansionprefix

=

prefix

MIRRORprefixes

=

prefix

prefix 1, prefix 2

MAXimumsize

=

megabytes

STGPOOL

=

storage_pool_name


Parameters
STG
Specifies a storage pool space trigger
DB
Specifies a database space trigger.
LOG
Specifies a recovery log space trigger.
UPDATE SPACETRIGGER

1206 IBM Tivoli Storage Manager for Windows: Administrators Reference
Fullpct
For database and recovery log space triggers, this parameter specifies a space
utilization percentage of the database or recovery log. When this value is
reached, Tivoli Storage Manager tries to allocate more space. This parameter is
optional. You can specify an integer value from 0 to 99. A value of zero (0)
disables the space trigger.
For storage pool space triggers, this parameter specifies the utilization
percentage of the storage pool. When this value is exceeded, the space trigger
creates new volumes. You can determine storage pool utilization by issuing the
QUERY STGPOOL command with FORMAT=DETAILED. The percentage of
storage pool utilization for the storage pool is displayed in the field Space
Trigger Util. The calculation for this percentage does not include potential
scratch volumes. The calculation for the percentage utilization used for
migration and reclamation, however, does include potential scratch volumes.
SPACEexpansion
For database and recovery log space triggers, this parameter specifies, as a
percentage of current size, the amount by which the database or recovery log
can be increased. This parameter is optional. Specify an integer from 0 to 200.
The database must be at least 4MB (5MB file with processing space); the
recovery log must be at least 8MB (9MB file with processing space). New
database or recovery log volumes must be multiples of 5MB or 9MB
respectively. A value of zero (0) disables expansion.
For space triggers for sequential-access FILE-type storage pools , this
parameter is used in determining the number of additional volumes that are
created in the storage pool. Volumes are created using the MAXCAPACITY
value from the storage pools device class.
For space triggers for random-access DISK storage pools, the space trigger
creates a single volume using the EXPANSIONPREFIX.
EXPansionprefix
For space triggers for databases, recovery logs, and random-access DISK
storage-pools, this specifies the prefix that Tivoli Storage Manager uses to
create new database, recovery log, or storage pool files.
The prefix can include one or more directory separator characters, for example,
c:\program files\tivoli\tsm\. You can specify up to 200 characters. If you
specify an invalid prefix, automatic expansion can fail.
This parameter is not valid for space triggers for sequential-access FILE storage
pools. For sequential storage pool space triggers, prefixes are obtained from the
directories specified with the associated device class.
This is an optional parameter. The default prefix is the Tivoli Storage Manager
install path.If Tivoli Storage Manager server is running as a Windows service,
the default prefix is the c:\wnnt\system32 directory.
MIRRORprefixes
Specifies the prefix or prefixes that Tivoli Storage Manager uses to create new
files for database or recovery log copy volumes. A prefix can include one or
more directory separator characters (for example, c:\program
files\tivoli\tsm\). You can specify up to 200 characters. If you specify an
invalid prefix, automatic expansion can fail. Only one or two copy volumes
can be created per database or recovery log space trigger. Therefore, you can
specify only one or two prefixes. If you specify one prefix and two copy
UPDATE SPACETRIGGER
Chapter 2. Administrative commands 1207
volumes are created, that single prefix will be used for both copy volumes. If
you specify two prefixes, each prefix will be used in creating a single copy
volume.
MAXimumsize
Specifies the maximum size, in megabytes, of the database or recovery log.
This parameter is optional. When this size is reached, expansion stops, and
Tivoli Storage Manager issues a message. You can specify a value from 9 to
13000 (13GB) for the recovery log, or from 4 to is 530000 (530GB) for the
database. A value of zero (0) or omitting this parameter disables checking for
maximum size. Increasing the size of the recovery log significantly can increase
the time required to restart the server, back up the database, and restore the
database. This parameter does not apply to storage pool space triggers.
STGPOOL
Specifies the storage pool associated with this space trigger. This parameter
does not apply to database and recovery log space triggers. If STG parameter
is specified and STGPOOL is not, the default storage pool space trigger is
updated. This parameter does not apply to storage pools with the parameter
RECLAMATIONTYPE=SNAPLOCK.
Examples
Task
Update the setting of the database expansion to 50 percent.
Command
update spacetrigger db spaceexpansion=50
Task
Disable automatic expansion of the recovery log.
Command
update spacetrigger log spaceexpansion=0
Task
Update a storage pool space trigger to increase the amount of space in a storage
pool by 50 percent when it is filled to 80 percent utilization of existing volumes.
Space will be created in the directories associated with the device class.
Command
update spacetrigger stg spaceexpansion=50 stgpool=file
Related commands
Table 394. Commands related to UPDATE SPACETRIGGER
Command Description
DEFINE LOGVOLUME Defines a disk volume to the recovery log.
DEFINE DBBACKUPTRIGGER Defines a trigger for automatic IBM Tivoli
Storage Manager database backups.
DEFINE SPACETRIGGER Defines the database or recovery log space
trigger.
DELETE SPACETRIGGER Deletes the database or recovery log space
trigger.
UPDATE SPACETRIGGER

1208 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 394. Commands related to UPDATE SPACETRIGGER (continued)
Command Description
QUERY SPACETRIGGER Displays information about the database or
recovery log space trigger.
SET LOGMODE Sets the mode for saving records in the
recovery log.

UPDATE SPACETRIGGER
Chapter 2. Administrative commands 1209
UPDATE STGPOOL (Update a storage pool)
Use this command to change a storage pool.
The UPDATE STGPOOL command takes four forms:
v Updating a primary storage pool assigned to random access devices
v Updating a primary storage pool assigned to sequential access devices
v Updating a copy storage pool (always assigned to sequential access devices)
v Updating an active-data pool (always assigned to sequential access devices)
The syntax and parameters for each form are defined separately.
Table 395. Commands related to UPDATE STGPOOL
Command Description
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
COPY ACTIVEDATA Copies active backup data.
DEFINE COLLOCGROUP Defines a collocation group.
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
DELETE COLLOCGROUP Deletes a collocation group.
DELETE COLLOCMEMBER Deletes a client node from a collocation
group.
DELETE STGPOOL Deletes a storage pool from server storage.
MOVE DRMEDIA Moves DRM media onsite and offsite.
MOVE MEDIA Moves storage pool volumes that are
managed by an automated library.
QUERY COLLOCGROUP Displays information about collocation
groups.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY NODEDATA Displays information about the location and
size of data for a client node.
QUERY SHREDSTATUS Displays information about data waiting to
be shredded.
QUERY STGPOOL Displays information about storage pools.
RESTORE STGPOOL Restores files to a primary storage pool from
copy storage pools.
RESTORE VOLUME Restores files stored on specified volumes in
a primary storage pool from copy storage
pools.
SET DRMDBBACKUPEXPIREDAYS Specifies criteria for database backup series
expiration.
SHRED DATA Manually starts the process of shredding
deleted data.
UPDATE COLLOCGROUP Updates the description of a collocation
group.
UPDATE STGPOOL

1210 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE STGPOOL primary random access
Use this command to update a random access storage pool.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the storage pool to be updated.
Syntax
UPDate STGpool pool_name
DESCription

=

description

ACCess

=

READWrite

READOnly

UNAVailable

MAXSIze

=

maximum_file_size

NOLimit

CRCData

=

Yes

No

NEXTstgpool

=

pool_name

HIghmig

=

percent

LOwmig

=

percent

CAChe

=

Yes

No

MIGPRocess

=

number

MIGDelay

=

days

MIGContinue

=

Yes

No

,

COPYSTGpools

=

copypoolname

COPYContinue

=

Yes

No

,

ACTIVEDATApools

=

active-data_pool_name

SHRED = 0
SHRED

=

overwrite_count

Parameters
pool_name (Required)
Specifies the storage pool to update. This parameter is required.
UPDATE STGPOOL Primary Random Access
Chapter 2. Administrative commands 1211
DESCription
Specifies a description of the storage pool. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters. To remove an existing
description, specify a null string ().
ACCess
Specifies how client nodes and server processes (such as migration and
reclamation) can access files in the storage pool. This parameter is optional.
Possible values are:
READWrite
Specifies that client nodes and server processes can read and write to files
stored on volumes in the storage pool.
READOnly
Specifies that client nodes can only read files from the volumes in the
storage pool.
Server processes can move files within the volumes in the storage pool.
However, no new writes are permitted to volumes in the storage pool from
volumes outside the storage pool.
If this storage pool has been specified as a subordinate storage pool (with
the NEXTSTGPOOL parameter) and is defined as readonly, the storage pool
is skipped when server processes attempt to write files to the storage pool.
UNAVailable
Specifies that client nodes cannot access files stored on volumes in the
storage pool.
Server processes can move files within the volumes in the storage pool and
can also move or copy files from this storage pool to another storage pool.
However, no new writes are permitted to volumes in the storage pool from
volumes outside the storage pool.
If this storage pool has been specified as a subordinate storage pool (with
the NEXTSTGPOOL parameter) and is defined as unavailable, the storage
pool is skipped when server processes attempt to write files to the storage
pool.
MAXSIze
Specifies the maximum size for a physical file that the server can store in the
storage pool. This parameter is optional. Possible values are:
NOLimit
Specifies that there is no maximum size limit for physical files stored in the
storage pool.
maximum_file_size
Limits the maximum physical file size. Specify an integer from 1 to 999999,
followed by a scale factor. For example, MAXSIZE=5G specifies that the
maximum file size for this storage pool is 5 gigabytes. Scale factors are:

Scale factor Meaning
K kilobyte
M megabyte
G gigabyte
T terabyte

UPDATE STGPOOL Primary Random Access

1212 IBM Tivoli Storage Manager for Windows: Administrators Reference
If a file exceeds the maximum size and no pool is specified as the next storage
pool in the hierarchy, the server does not store the file. If a file exceeds the
maximum size and a pool is specified as the next storage pool, the server
stores the file in the next storage pool that can accept the file size. If you
specify the next storage pool parameter, at least one storage pool in your
hierarchy should have no limit on the maximum size of a file. By having no
limit on the size for at least one pool, you ensure that no matter what its size,
the server can store the file.
For logical files that are part of an aggregate, the server considers the size of
the aggregate to be the file size. Therefore, the server does not store logical
files that are smaller than the maximum size limit if the files are part of an
aggregate that is larger than the maximum size limit.
CRCData
Specifies whether a cyclic redundancy check (CRC) validates storage pool data
when audit volume processing occurs on the server. This parameter is optional.
The default value is NO. By setting CRCDATA to YES and scheduling an
AUDIT VOLUME command you can continually ensure the integrity of data
stored in your storage hierarchy. Possible values are:
Yes
Specifies that data is stored containing CRC information, allowing for audit
volume processing to validate storage pool data. This mode impacts
performance because additional overhead is required to calculate and
compare CRC values between the storage pool and the server.
No
Specifies that data is stored without CRC information.
NEXTstgpool
Specifies a primary storage pool to which files are migrated. This parameter is
optional.
To remove an existing storage pool from the storage hierarchy, specify a null
string () for this value.
If this storage pool does not have a next storage pool, the server cannot
migrate files from this storage pool and cannot store files that exceed the
maximum size for this storage pool in another storage pool.
You cannot create a chain of storage pools that leads to an endless loop
through the NEXTSTGPOOL parameter. At least one storage pool in the
hierarchy must have no value specified for NEXTSTGPOOL.
HIghmig
Specifies that the server starts migration for this storage pool when the amount
of data in the pool reaches this percentage of the pools estimated capacity.
This parameter is optional. You can specify an integer from 0 to 100.
When the storage pool exceeds the high migration threshold, the server can
start migration of files by node to the next storage pool, as defined with the
NEXTSTGPOOL parameter. You can specify HIGHMIG=100 to prevent
migration for this storage pool.
LOwmig
Specifies that the server stops migration for this storage pool when the amount
of data in the pool reaches this percentage of the pools estimated capacity.
This parameter is optional. You can specify an integer from 0 to 99.
When the storage pool reaches the low migration threshold, the server does
not start migration of another nodes files. Because all file spaces that belong to
UPDATE STGPOOL Primary Random Access
Chapter 2. Administrative commands 1213
a node are migrated together, the occupancy of the storage pool can fall below
the value you specified for this parameter. You can set LOWMIG=0 to permit
migration to empty the storage pool.
CAChe
Specifies whether the migration process leaves a cached copy of a file in this
storage pool after migrating the file to the next storage pool. This parameter is
optional. Possible values are:
Yes
Specifies that caching is enabled.
No
Specifies that caching is disabled.
Using cache may improve the retrievability of files, but may affect the
performance of other processes. See the Administrators Guide for details.
MIGPRocess
Specifies the number of processes that are used for migrating files from this
storage pool. This parameter is optional. You can specify an integer from 1 to
999.
During migration, these processes are performed in parallel to provide the
potential for improved migration rates.
Note: The number of migration processes is dependent upon the setting of the
MIGPROCESS parameter and the number of nodes or the number of
collocation groups with data in the migrating storage pool. For example,
if the MIGPROCESS parameter is equal to six, but there are only two
nodes with data on the storage pool, migration processing only consists
of two processes, not six.
MIGDelay
Specifies the minimum number of days a file must remain in a storage pool
before it becomes eligible for migration. To calculate a value to compare to the
specified MIGDELAY value, the server counts the number of days that the file
has been in the storage pool and the number of days, if any, since the file was
retrieved by a client. The lesser of the two values is compared to the specified
MIGDELAY value. For example, if all the following conditions are true, a file is
not migrated:
v A file has been in a storage pool for five days.
v The file was accessed by a client within the past three days.
v The value specified for the MIGDELAY parameter is four days.
This parameter is optional. You can specify an integer from 0 to 9999.
If you want the server to count the number of days based only on when a file
was stored and not when it was retrieved, use the NORETRIEVEDATE server
option.
MIGContinue
Specifies whether you allow the server to migrate files that do not satisfy the
migration delay time. This parameter is optional.
Because you can require that files remain in the storage pool for a minimum
number of days, the server may migrate all eligible files to the next storage
pool yet not meet the low migration threshold. This parameter allows you to
specify whether the server is allowed to continue the migration process by
migrating files that do not satisfy the migration delay time.
UPDATE STGPOOL Primary Random Access

1214 IBM Tivoli Storage Manager for Windows: Administrators Reference
Possible values are:
Yes
Specifies that, when necessary to meet the low migration threshold, the
server continues to migrate files that do not satisfy the migration delay
time.
If you allow more than one migration process for the storage pool, some
files that do not satisfy the migration delay time may be migrated
unnecessarily. As one process migrates files that satisfy the migration delay
time, a second process could begin migrating files that do not satisfy the
migration delay time to meet the low migration threshold. The first process
that is still migrating files that satisfy the migration delay time might have,
by itself, caused the low migration threshold to be met.
No
Specifies that the server stops migration when no eligible files remain to be
migrated, even before reaching the low migration threshold. The server
does not migrate files unless the files satisfy the migration delay time.
COPYSTGpools
Specifies the names of copy storage pools where the server simultaneously
writes data. Beginning with Tivoli Storage Manager Version 5.3, you can
specify a maximum of three copy pool names separated by commas. (In
versions earlier than Version 5.3, the maximum number was ten.) Spaces
between the names of the copy pools are not permitted. To add or remove one
or more copy storage pools, specify the pool name or names that you want to
include in the updated list. For example, if the existing copy pool list includes
COPY1 and COPY2 and you want to add COPY3, specify
COPYSTGPOOLS=COPY1,COPY2,COPY3. To remove all existing copy storage
pools associated with the primary storage pool, specify a null string () for the
value (for example, COPYSTGPOOLS=).
When specifying a value for the COPYSTGPOOLS parameter, you can also
specify a value for the COPYCONTINUE parameter. For additional
information, see the COPYCONTINUE parameter.
The combined total number of storage pools specified in the COPYSGTPOOLS
and ACTIVEDATAPOOLS parameters cannot exceed three.
The simultaneous write function changed in Tivoli Storage Manager Version
5.3. In Version 5.3 and later, when a data storage operation switches from a
primary storage pool to a next storage pool, the next storage pool inherits the
list of copy storage pools and the COPYCONTINUE value from the primary
storage pool. The primary storage pool is specified by the copy group of the
management class that is bound to the data. For details, refer to information
about simultaneous write in the Administrators Guide.
The server can perform simultaneous write to copy storage pools for the
following operations:
v Backup and archive operations by Tivoli Storage Manager backup-archive
clients or application clients using the Tivoli Storage Manager API
v Migration operations by Hierarchical Space Management (HSM) clients
v Import operations that involve copying exported file data from external
media to a primary storage pool associated with a copy storage pool list
Note: Simultaneous write is not supported for the following store operations:
UPDATE STGPOOL Primary Random Access
Chapter 2. Administrative commands 1215
v When the operation is using LAN-free data movement. Simultaneous
write takes precedence over LAN-free operations, causing the
operations to go over the LAN. However, the simultaneous write
configuration is honored.
v NAS backup operations. If the primary storage pool specified in the
DESTINATION or TOCDESTINATION in the copy group of the
management class has copy storage pools defined, the copy storage
pools are ignored and the data is stored into the primary storage pool
only.
Attention: The function provided by the COPYSTGPOOLS parameter is not
intended to replace the BACKUP STGPOOL command. If you use the
COPYSTGPOOLS parameter, continue to use the BACKUP STGPOOL
command to ensure that the copy storage pools are complete copies of the
primary storage pool. There are cases when a copy might not be created. For
more information, see the COPYCONTINUE parameter description.
COPYContinue
Specifies how the server should react to a copy storage pool write failure for
any of the copy storage pools listed in the COPYSTGPOOLS parameter. This
parameter is optional. When specifying the COPYCONTINUE parameter, either
a COPYSTGPOOLS list must already exist or the COPYSTGPOOLS parameter
must also be specified.
This parameter has no effect on active-data pools. If a write error occurs while
writing to an active-data pool, the server will stop writing to the failing
active-data pool for the remainder of the session.
Possible values are:
Yes
If the COPYCONTINUE option is set to YES, the server will stop writing
to the failing copy pools for the remainder of the session, but continue
storing files into the primary pool and any remaining copy pools. The copy
storage pool list is active only for the life of the client session and applies
to all the primary storage pools in a particular storage pool hierarchy.
For additional information about the COPYCONTINUE parameter, refer to
the information about simultaneous write in the Administrators Guide.
No
If the COPYCONTINUE option is set to NO, the server will fail the current
transaction and discontinue the store operation.
ACTIVEDATApools
Specifies the names of active-data pools where the server simultaneously
writes data during a client backup operation. The ACTIVEDATAPOOLS
parameter is optional. Spaces between the names of the active-data pools are
not permitted.
The combined total number of storage pools specified in the COPYSGTPOOLS
and ACTIVEDATAPOOLS parameters cannot exceed three.
When a data storage operation switches from a primary storage pool to a next
storage pool, the next storage pool inherits the list of active-data pools from
the destination storage pool specified in the copy group. The primary storage
pool is specified by the copy group of the management class that is bound to
the data. For details, refer to information about simultaneous write in the
Administrators Guide.
UPDATE STGPOOL Primary Random Access

1216 IBM Tivoli Storage Manager for Windows: Administrators Reference
The server can perform simultaneous write to active-data pools only during
backup operations by Tivoli Storage Manager backup-archive clients or
application clients using the Tivoli Storage Manager API.
Note:
1. This parameter is available only to primary storage pools that use
NATIVE or NONBLOCK data format. This parameter is not available
for storage pools that use the following data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
2. Simultaneous write to active-data pools is not supported when the
operation is using LAN-free data movement. Simultaneous write
takes precedence over LAN-free operations, causing the operations to
go over the LAN. However, the simultaneous write configuration is
honored.
3. Simultaneous write is not supported when a NAS backup operation
is writing a TOC file. If the primary storage pool specified in the
TOCDESTINATION in the copy group of the management class has
active-data pools defined, the active-data pools are ignored and the
data is stored into the primary storage pool only.
4. You cannot use the simultaneous write function with Centera storage
devices.
5. Data being imported will not be stored in active-data pools. After an
import operation, use the COPY ACTIVEDATA command to store
the imported data in an active-data pool.
Attention: The function provided by the ACTIVEDATAPOOLS parameter is
not intended to replace the COPY ACTIVEDATA command. If you use the
ACTIVEDATAPOOLS parameter, use the COPY ACTIVEDATA command to
ensure that the active-data pools contain all active data of the primary storage
pool.
SHRED
Specifies whether data will be physically overwritten when it is deleted. This
parameter is optional. You can specify an integer from 0 to 10.
If you specify a value of 0, the Tivoli Storage Manager server will delete the
data from the database. However, the storage used to contain the data will not
be overwritten, and the data will still exist in storage until that storage is
reused for other data. It might be possible to discover and reconstruct the data
after it has been deleted. Changing the value (for example, resetting it to 0)
will not affect data that has already been deleted and is currently waiting to be
overwritten.
If you specify a value greater than 0, the Tivoli Storage Manager server will
delete the data both logically and physically. The server will overwrite the
storage used to contain the data the specified number of times. This prevents
any attempts to discover and reconstruct the data after it has been deleted.
To ensure that all copies of the data are shredded, specify a SHRED value
greater than 0 for the storage pool specified in the NEXTSTGPOOL parameter,
and do not specify either the COPYSTGPOOLS or ACTIVEDATAPOOLS.
Specifying relatively high values for the overwrite count will generally
improve the level of security, but could affect performance adversely.
UPDATE STGPOOL Primary Random Access
Chapter 2. Administrative commands 1217
Overwriting of deleted data is performed asynchronously after the delete
operation is complete. Therefore, the space occupied by the deleted data will
remain occupied for some period of time and will not be available as free
space for new data.
A SHRED value greater than zero cannot be used if the value of the CACHE
parameter is YES. If you want to enable shredding for an existing storage pool
for which caching is already enabled, you must change the value of the
CACHE parameter to NO. Note that existing cached files will remain in
storage so that subsequent retrieval requests can be satisfied quickly. If space is
needed to store new data, the existing cached files are erased so that the space
they occupied can be used for the new data. The existing cached files will not
be shredded when they are erased.
Important: After an export operation has finished identifying files for export,
any changes to the storage pool SHRED value is ignored. An
export operation that is suspended retains the original SHRED
value throughout the operation. You might want to consider
cancelling your export operation if changes to the storage pool
SHRED value jeopardize the operation. You can reissue the export
command after any needed cleanup.
Examples
Task
Update the random access storage pool named BACKUPPOOL to permit caching
when the server migrates files to the next storage pool.
Command
update stgpool backuppool cache=yes
UPDATE STGPOOL Primary Random Access

1218 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|
|
UPDATE STGPOOL primary sequential access
Use this command to update a primary sequential access storage pool.
Note:
1. You cannot use this command to change the data format for the storage
pool.
2. If the value for DATAFORMAT is NETAPPDUMP, CELERRADUMP, or
NDMPDUMP, you can modify only the following attributes:
v DESCRIPTION
v ACCESS
v COLLOCATE
v MAXSCRATCH
v REUSEDELAY
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the storage pool to be updated.
Syntax
UPDate STGpool pool_name
DESCription

=

description

ACCess

=

READWrite

READOnly

UNAVailable

(1)

(2)

MAXSIze

=

maximum_file_size

NOLimit

(1)

CRCData

=

Yes

No

(1)

(2)

NEXTstgpool

=

pool_name

(1)

(2)

HIghmig

=

percent

(1)

(2)

LOwmig

=

percent

(1)

(2)

REClaim

=

percent

(1)

(2)

RECLAIMPRocess

=

number

(1)

(2)

RECLAIMSTGpool

=

pool_name

UPDATE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 1219

(2)

COLlocate

=

No

GRoup

NODe

FIlespace

(2)

MAXSCRatch

=

number

(2)

REUsedelay

=

days

(1)

(2)

OVFLOcation

=

location

(1)

(2)

MIGDelay

=

days

(1)

(2)

MIGContinue

=

Yes

No

(1)

(2)

MIGPRocess

=

number

,

(1)

(2)

COPYSTGpools

=

copypoolname

(1)

(2)

COPYContinue

=

Yes

No

,

ACTIVEDATApools

=

active-data_pool_name


Notes:
1 This parameter is not available for storage pools that use the data formats
NETAPPDUMP, CELERRADUMP, or NDMPDUMP.
2 This parameter is not available for Centera storage pools.
Parameters
pool_name (Required)
Specifies the name of the storage pool to be updated.
DESCription
Specifies a description of the storage pool. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters. To remove an existing
description, specify a null string ().
ACCess
Specifies how client nodes and server processes (such as migration and
reclamation) can access files in the storage pool. This parameter is optional.
Possible values are:
READWrite
Specifies that client nodes and server processes can read and write to files
stored on volumes in the storage pool.
UPDATE STGPOOL Primary Sequential Access

1220 IBM Tivoli Storage Manager for Windows: Administrators Reference
READOnly
Specifies that client nodes can only read files from the volumes in the
storage pool.
Server processes can move files within the volumes in the storage pool.
However, no new writes are permitted to volumes in the storage pool from
volumes outside the storage pool.
If this storage pool has been specified as a subordinate storage pool (with
the NEXTSTGPOOL parameter) and is defined as readonly, the storage pool
is skipped when server processes attempt to write files to the storage pool.
UNAVailable
Specifies that client nodes cannot access files stored on volumes in the
storage pool.
Server processes can move files within the volumes in the storage pool and
can also move or copy files from this storage pool to another storage pool.
However, no new writes are permitted to volumes in the storage pool from
volumes outside the storage pool.
If this storage pool has been specified as a subordinate storage pool (with
the NEXTSTGPOOL parameter) and is defined as unavailable, the storage
pool is skipped when server processes attempt to write files to the storage
pool.
MAXSIze
Specifies the maximum size for a physical file that the server can store in the
storage pool. This parameter is optional. Possible values are:
NOLimit
Specifies that there is no maximum size limit for physical files stored in the
storage pool.
maximum_file_size
Limits the maximum physical file size. Specify an integer from 1 to 999999,
followed by a scale factor. For example, MAXSIZE=5G specifies that the
maximum file size for this storage pool is 5 gigabytes. Scale factors are:

Scale factor Meaning
K kilobyte
M megabyte
G gigabyte
T terabyte

If a file exceeds the maximum size and no pool is specified as the next storage
pool in the hierarchy, the server does not store the file. If a file exceeds the
maximum size and a pool is specified as the next storage pool, the server
stores the file in the next storage pool that can accept the file size. If you
specify the next storage pool parameter, at least one storage pool in your
hierarchy should have no limit on the maximum size of a file. By having no
limit on the size for at least one pool, you ensure that no matter what its size,
the server can store the file.
For logical files that are part of an aggregate, the server considers the size of
the aggregate to be the file size. Therefore, the server does not store logical
files that are smaller than the maximum size limit if the files are part of an
aggregate that is larger than the maximum size limit.
UPDATE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 1221
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
CRCData
Specifies whether a cyclic redundancy check (CRC) validates storage pool data
when audit volume processing occurs on the server. This parameter is only
valid for NATIVE data format storage pools. This parameter is optional. The
default value is NO. By setting CRCDATA to YES and scheduling an AUDIT
VOLUME command you can continually ensure the integrity of data stored in
your storage hierarchy. Possible values are:
Yes
Specifies that data is stored containing CRC information, allowing for audit
volume processing to validate storage pool data. This mode impacts
performance because additional overhead is required to calculate and
compare CRC values between the storage pool and the server.
No
Specifies that data is stored without CRC information.
NEXTstgpool
Specifies a primary storage pool to which files are migrated. You cannot
migrate data from a sequential access storage pool to a random access storage
pool. This parameter is optional. The next storage pool must be a primary
storage pool.
To remove an existing value, specify a null string ().
If this storage pool does not have a next storage pool, the server cannot
migrate files from this storage pool and cannot store files that exceed the
maximum size for this storage pool in another storage pool.
When there is insufficient space available in the current storage pool, the
NEXTSTGPOOL parameter for sequential access storage pools does not allow
data to be stored into the next pool. In this case the server issues a message
and the transaction fails.
For next storage pools with a device type of FILE, the server performs a
preliminary check to determine whether sufficient space is available. If space is
not available, the server skips to the next storage pool in the hierarchy. If space
is available, the server attempts to store data in that pool. However, it is
possible that the storage operation could fail because, at the time the actual
storage operation is attempted, the space is no longer available.
You cannot create a chain of storage pools that leads to an endless loop
through the NEXTSTGPOOL parameter. At least one storage pool in the
hierarchy must have no value specified for NEXTSTGPOOL.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
HIghmig
Specifies that the server starts migration when storage pool utilization reaches
UPDATE STGPOOL Primary Sequential Access

1222 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
this percentage. For sequential-access disk (FILE) storage pools, utilization is
the ratio of data in a storage pool to the pools total estimated data capacity,
including the capacity of all scratch volumes specified for the pool. For storage
pools that use tape or optical media, utilization is the ratio of volumes that
contain data to the total number of volumes in the storage pool. The total
number of volumes includes the maximum number of scratch volumes. This
parameter is optional. You can specify an integer from 0 to 100.
When the storage pool exceeds the high migration threshold, the server can
start migration of files by volume to the next storage pool defined for the
storage pool. You can set the high migration threshold to 100 to prevent
migration for the storage pool.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
LOwmig
Specifies that the server stops migration when storage pool utilization is at or
below this percentage. For sequential-access disk (FILE) storage pools,
utilization is the ratio of data in a storage pool to the pools total estimated
data capacity, including the capacity of all scratch volumes specified for the
pool. For storage pools that use tape or optical media, utilization is the ratio of
volumes that contain data to the total number of volumes in the storage pool.
The total number of volumes includes the maximum number of scratch
volumes. This parameter is optional. You can specify an integer from 0 to 99.
When the storage pool reaches the low migration threshold, the server does
not start migration of files from another volume. You can set the low migration
threshold to 0 to permit migration to empty the storage pool.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
REClaim
Specifies when the server reclaims a volume, based on the percentage of
reclaimable space on a volume. Reclamation makes the fragmented space on
volumes usable again by moving any remaining unexpired files from one
volume to another volume, thus making the original volume available for
reuse. This parameter is optional. You can specify an integer from 1 to 100.
Specify a value of 50 percent or greater for this parameter so that files stored
on two volumes can be combined onto a single output volume.
For storage pools that use WORM devices, you can lower the value from the
default of 100. Lowering the value allows the server to consolidate data onto
fewer volumes when needed. Volumes emptied by reclamation can be checked
out of the library, freeing slots for new volumes. Because the volumes are
write-once, the volumes cannot be reused.
Note: This parameter is not available for storage pools that use the following
data formats:
UPDATE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 1223
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
RECLAIMPRocess
Specifies the number of parallel processes to use for reclaiming the volumes in
this storage pool. This parameter is optional. Enter a value from 1 to 999.
When calculating the value for this parameter, consider the number of
sequential storage pools that will be involved with the reclamation and the
number of logical and physical drives that can be dedicated to the operation.
To access a sequential access volume, Tivoli Storage Manager uses a mount
point and, if the device type is not FILE, a physical drive. The number of
available mount points and drives depends on other Tivoli Storage Manager
and system activity and on the mount limits of the device classes for the
sequential access storage pools that are involved in the reclamation.
For example, suppose that you want to reclaim the volumes from two
sequential storage pools simultaneously and that you want to specify four
processes for each of the storage pools. The storage pools have the same device
class. Assuming that the RECLAIMSTGPOOL parameter is not specified or that
the reclaim storage pool has the same device class as the storage pool being
reclaimed, each process requires two mount points and, if the device type is
not FILE, two drives. (One of the drives is for the input volume, and the other
drive is for the output volume.) To run eight reclamation processes
simultaneously, you need a total of at least 16 mount points and 16 drives. The
device class for the two storage pools must have a mount limit of at least 16.
If the number of reclamation processes you specify is more than the number of
available mount points or drives, the processes that do not obtain mount
points or drives will wait for mount points or drives to become available. If
mount points or drives do not become available within the MOUNTWAIT
time, the reclamation processes will terminate. For information about
specifying the MOUNTWAIT time, see DEFINE DEVCLASS (Define a device
class) on page 158.
The Tivoli Storage Manager server will start the specified number of
reclamation processes regardless of the number of volumes that are eligible for
reclamation. For example, if you specify ten reclamation processes and only six
volumes are eligible for reclamation, the server will start ten processes and
four of them will complete without processing a volume.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
RECLAIMSTGpool
Specifies another primary storage pool as a target for reclaimed data from this
storage pool. This parameter is optional. When the server reclaims volumes for
the storage pool, unexpired data is moved from the volumes being reclaimed
to the storage pool named with this parameter.
To remove an existing value, specify a null string ().
UPDATE STGPOOL Primary Sequential Access

1224 IBM Tivoli Storage Manager for Windows: Administrators Reference
A reclaim storage pool is most useful for a storage pool that has only one drive
in its library. When you specify this parameter, the server moves all data from
reclaimed volumes to the reclaim storage pool regardless of the number of
drives in the library.
To move data from the reclaim storage pool back to the original storage pool,
use the storage pool hierarchy. Specify the original storage pool as the next
storage pool for the reclaim storage pool.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
COLlocate
Specifies whether the server attempts to keep data belonging to a single client
node, group of client nodes, or client file space assigned to as few volumes as
possible. This parameter is optional.
Collocation reduces the number of sequential access media mounts for restore,
retrieve, and recall operations. However, collocation increases both the amount
of server time needed to collocate files for storing and the number of volumes
required. For details, see the Administrators Guide.
Possible values are:
No
Specifies that collocation is disabled.
GRoup
Specifies that collocation is enabled at the group level for client nodes. The
server attempts to put data for nodes that belong to the same collocation
group on as few volumes as possible. If the nodes in the collocation group
have multiple file spaces, the server does not attempt to collocate those file
spaces.
If you specify COLLOCATE=GROUP but do not define any collocation
groups or if you specify COLLOCATE=GROUP but do not add nodes to a
collocation group, data is collocated by node. Be sure to consider tape
usage when organizing client nodes into collocation groups. For example,
if a tape-based storage pool consists of data from grouped and ungrouped
nodes and you specify COLLOCATE=GROUP, the server does the
following:
v Collocates by group the data for grouped nodes only. Whenever
possible, the server collocates data belonging to a group of nodes on a
single tape or on as few tapes as possible. Data for a single node can
also be spread across several tapes associated with a group.
v Collocates by node the data for ungrouped nodes. Whenever possible,
the server stores the data for a single node on a single tape. All available
tapes that already have data for the node are used before available space
on any other tape is used.
NODe
Specifies that collocation is enabled at the client node level. The server
attempts to put data for one node on as few volumes as possible. If the
node has multiple file spaces, the server does not attempt to collocate those
file spaces. For backward compatibility, COLLOCATE=YES is still accepted
by the server to specify collocation at the client node level.
UPDATE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 1225
If a storage pool contains data for a node that is a member of a collocation
group and you specify COLLOCATE=NODE, the data will be collocated by
node not by group.
FIlespace
Specifies that collocation is enabled at the file space level for client nodes.
The server attempts to put data for one node and file space on as few
volumes as possible. If a node has multiple file spaces, the server attempts
to put data for different file spaces on different volumes.
MAXSCRatch
Specifies the maximum number of scratch volumes that the server can request.
This parameter is optional. You can specify an integer from 0 to 100000000. By
allowing the server to request scratch volumes, you avoid having to define
each volume to be used.
The value specified for this parameter is used to estimate the total number of
volumes available in the storage pool and the corresponding estimated
capacity for the storage pool.
Scratch volumes are automatically deleted from the storage pool when they
become empty. When scratch volumes with the device type of FILE are
deleted, the space that the volumes occupied is freed by the server and
returned to the file system.
REUsedelay
Specifies the number of days that must elapse after all files are deleted from a
volume before the volume can be rewritten or returned to the scratch pool.
This parameter is optional. You can specify an integer from 0 to 9999. The
value 0 means that a volume can be rewritten or returned to the scratch pool
as soon as all files are deleted from the volume.
By specifying this parameter, you can ensure that the database could be
restored to an earlier level and database references to files in the storage pool
would still be valid.
OVFLOcation
Specifies the overflow location for the storage pool. The server assigns this
location name to a volume that is ejected from the library by the MOVE
MEDIA command. This parameter is optional. The location name can be a
maximum length of 255 characters. Enclose the location name in quotation
marks if the location name contains any blank characters.
To remove an existing value, specify a null string ().
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
MIGDelay
Specifies the minimum number of days a file must remain in a storage pool
before it becomes eligible for migration. All files on a volume must be eligible
for migration before the server selects the volume for migration. To calculate a
value to compare to the specified MIGDELAY, the server counts the number of
days that the file has been in the storage pool.
This parameter is optional. You can specify an integer from 0 to 9999.
UPDATE STGPOOL Primary Sequential Access

1226 IBM Tivoli Storage Manager for Windows: Administrators Reference
If you want the server to count the number of days based only on when a file
was stored and not when it was retrieved, use the NORETRIEVEDATE server
option.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
MIGContinue
Specifies whether you allow the server to migrate files that do not satisfy the
migration delay time. This parameter is optional.
Because you can require that files remain in the storage pool for a minimum
number of days, the server may migrate all eligible files to the next storage
pool yet not meet the low migration threshold. This parameter allows you to
specify whether the server is allowed to continue migration by migrating files
that do not satisfy the migration delay time.
Possible values are:
Yes
Specifies that, when necessary to meet the low migration threshold, the
server continues to migrate files that have not been stored in the storage
pool for the number of days specified by the migration delay period.
No
Specifies that the server stops migration when no eligible files remain to be
migrated, even before reaching the low migration threshold. The server
does not migrate files unless the files have been stored in the storage pool
for the number of days specified by the migration delay period.
Note: This parameter is not available for storage pools that use the following
data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
MIGPRocess
Specifies the number of parallel processes to use for migrating the files from
the volumes in this storage pool. This parameter is optional. Enter a value
from 1 to 999.
When calculating the value for this parameter, consider the number of
sequential storage pools that will be involved with the migration, and the
number of logical and physical drives that can be dedicated to the operation.
To access a sequential-access volume, Tivoli Storage Manager uses a mount
point and, if the device type is not FILE, a physical drive. The number of
available mount points and drives depends on other Tivoli Storage Manager
and system activity and on the mount limits of the device classes for the
sequential access storage pools that are involved in the migration.
For example, suppose you want to simultaneously migrate the files from
volumes in two primary sequential storage pools and that you want to specify
three processes for each of the storage pools. The storage pools have the same
device class. Assuming that the storage pool to which files are being migrated
has the same device class as the storage pool from which files are being
UPDATE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 1227
migrated, each process requires two mount points and, if the device type is not
FILE, two drives. (One drive is for the input volume, and the other drive is for
the output volume.) To run six migration processes simultaneously, you need a
total of at least 12 mount points and 12 drives. The device class for the storage
pools must have a mount limit of at least 12.
If the number of migration processes you specify is more than the number of
available mount points or drives, the processes that do not obtain mount
points or drives will wait for mount points or drives to become available. If
mount points or drives do not become available within the MOUNTWAIT
time, the migration processes will terminate. For information about specifying
the MOUNTWAIT time, see DEFINE DEVCLASS (Define a device class) on
page 158.
The Tivoli Storage Manager server will start the specified number of migration
processes regardless of the number of volumes that are eligible for migration.
For example, if you specify ten migration processes and only six volumes are
eligible for migration, the server will start ten processes and four of them will
complete without processing a volume.
COPYSTGpools
Specifies the names of copy storage pools where the server simultaneously
writes data. Beginning with Tivoli Storage Manager Version 5.3, you can
specify a maximum of three copy pool names separated by commas. (In
versions earlier than Version 5.3, the maximum number was ten.) Spaces
between the names of the copy pools are not permitted. To add or remove one
or more copy storage pools, specify the pool name or names that you want to
include in the updated list. For example, if the existing copy pool list includes
COPY1 and COPY2 and you want to add COPY3, specify
COPYSTGPOOLS=COPY1,COPY2,COPY3. To remove all existing copy storage
pools associated with the primary storage pool, specify a null string () for the
value (for example, COPYSTGPOOLS=).
When specifying a value for the COPYSTGPOOLS parameter, you can also
specify a value for the COPYCONTINUE parameter. For additional
information, see the COPYCONTINUE parameter.
The combined total number of storage pools specified in the COPYSGTPOOLS
and ACTIVEDATAPOOLS parameters cannot exceed three.
The simultaneous write function changed in Tivoli Storage Manager Version
5.3. In Version 5.3 and later, when a data storage operation switches from a
primary storage pool to a next storage pool, the next storage pool inherits the
list of copy storage pools and the COPYCONTINUE value from the primary
storage pool. The primary storage pool is specified by the copy group of the
management class that is bound to the data. For details, refer to information
about simultaneous write in the Administrators Guide.
The server can perform simultaneous write to copy storage pools for the
following operations:
v Backup and archive operations by Tivoli Storage Manager backup-archive
clients or application clients using the Tivoli Storage Manager API
v Migration operations by Hierarchical Space Management (HSM) clients
v Import operations that involve copying exported file data from external
media to a primary storage pool associated with a copy storage pool list
Note:
UPDATE STGPOOL Primary Sequential Access

1228 IBM Tivoli Storage Manager for Windows: Administrators Reference
1. This parameter is available only to primary storage pools that use
NATIVE or NONBLOCK data format. This parameter is not available
for storage pools that use the following data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
2. Simultaneous write takes precedence over LAN-free operations,
causing the operations go over the LAN. However, the simultaneous
write configuration is honored.
3. Simultaneous write is not supported for NAS backup operations. If
the primary storage pool specified in the DESTINATION or
TOCDESTINATION in the copy group of the management class has
copy storage pools defined, the copy storage pools are ignored and
the data is stored into the primary storage pool only.
4. You cannot use the simultaneous write function with Centera storage
devices.
Attention: The function provided by the COPYSTGPOOLS parameter is not
intended to replace the BACKUP STGPOOL command. If you use the
COPYSTGPOOLS parameter, continue to use the BACKUP STGPOOL
command to ensure that the copy storage pools are complete copies of the
primary storage pool. There are cases when a copy may not be created. For
more information, see the COPYCONTINUE parameter description.
COPYContinue
Specifies how the server should react to a copy storage pool write failure for
any of the copy storage pools listed in the COPYSTGPOOLS parameter. This
parameter is optional. The default is YES. When specifying the
COPYCONTINUE parameter, either a COPYSTGPOOLS list must already exist
or the COPYSTGPOOLS parameter must also be specified.
This parameter has no effect on active-data pools. If a write error occurs while
writing to an active-data pool, the server will stop writing to the failing
active-data pool for the remainder of the session.
Possible values are:
Yes
If the COPYCONTINUE option is set to YES, the server will stop writing
to the failing copy pools for the remainder of the session, but continue
storing files into the primary pool and any remaining copy pools. The copy
storage pool list is active only for the life of the client session and applies
to all the primary storage pools in a particular storage pool hierarchy.
For additional information about the COPYCONTINUE parameter, refer to
the information about simultaneous write in the Administrators Guide.
No
If the COPYCONTINUE option is set to NO, the server will fail the current
transaction and discontinue the store operation.
ACTIVEDATApools
Specifies the names of active-data pools where the server simultaneously
writes data during a client backup operation. The ACTIVEDATAPOOLS
parameter is optional. Spaces between the names of the active-data pools are
not permitted.
UPDATE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 1229
The combined total number of storage pools specified in the COPYSGTPOOLS
and ACTIVEDATAPOOLS parameters can not exceed three.
When a data storage operation switches from a primary storage pool to a next
storage pool, the next storage pool inherits the list of active-data pools from
the destination storage pool specified in the copy group. The primary storage
pool is specified by the copy group of the management class that is bound to
the data. For details, refer to information about simultaneous write in the
Administrators Guide.
The server can perform simultaneous write to active-data pools only during
backup operations by Tivoli Storage Manager backup-archive clients or
application clients using the Tivoli Storage Manager API.
Note:
1. This parameter is available only to primary storage pools that use
NATIVE or NONBLOCK data format. This parameter is not available
for storage pools that use the following data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
2. Simultaneous write to active-data pools is not supported when the
operation is using LAN-free data movement. Simultaneous write
takes precedence over LAN-free operations, causing the operations
go over the LAN. However, the simultaneous write configuration is
honored.
3. Simultaneous write is not supported when a NAS backup operation
is writing a TOC file. If the primary storage pool specified in the
TOCDESTINATION in the copy group of the management class has
active-data pools defined, the active-data pools are ignored and the
data is stored into the primary storage pool only.
4. You cannot use the simultaneous write function with Centera storage
devices.
5. Data being imported will not be stored in active-data pools. After an
import operation, use the COPY ACTIVEDATA command to store
the imported data in an active-data pool.
Note:
1. Simultaneous write to active-data pools is not supported when the
operation is using LAN-free data movement. Simultaneous write
takes precedence over LAN-free operations, causing the operations
go over the LAN. However, the simultaneous write configuration is
honored.
2. Data being imported will not be stored in active-data pools. After an
import operation, use the COPY ACTIVEDATA command to store
the imported data in an active-data pool.
Attention: The function provided by the ACTIVEDATAPOOLS parameter is
not intended to replace the COPY ACTIVEDATA command. If you use the
ACTIVEDATAPOOLS parameter, use the COPY ACTIVEDATA command to
ensure that the active-data pools contain all active data of the primary storage
pool.
UPDATE STGPOOL Primary Sequential Access

1230 IBM Tivoli Storage Manager for Windows: Administrators Reference
Examples
Task
Update the primary sequential storage pool named TAPEPOOL1 to permit as
many as 10 scratch volumes to be mounted.
Command
update stgpool tapepool1 maxscratch=10
UPDATE STGPOOL Primary Sequential Access
Chapter 2. Administrative commands 1231
UPDATE STGPOOL copy sequential access
Use this command to update a copy sequential access storage pool.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the storage pool to be updated.
Syntax
UPDate STGpool pool_name
DESCription

=

description

ACCess

=

READWrite

READOnly

UNAVailable

COLlocate

=

No

GRoup

NODe

FIlespace

REClaim

=

percent

RECLAIMPRocess

=

number

OFFSITERECLAIMLimit

=

NOLimit

number

MAXSCRatch

=

number

REUsedelay

=

days

OVFLOcation

=

location

CRCData

=

Yes

No


Parameters
pool_name (Required)
Specifies the name of the copy storage pool to be updated.
DESCription
Specifies a description of the copy storage pool. This parameter is optional.
The maximum length of the description is 255 characters. Enclose the
description in quotation marks if it contains any blank characters. To remove
an existing description, specify a null string ().
ACCess
Specifies how client nodes and server processes (such as reclamation) can
access files in the copy storage pool. This parameter is optional. Possible values
are:
READWrite
Specifies that files can be read from and written to the volumes in the copy
storage pool.
READOnly
Specifies that client nodes can only read files stored on the volumes in the
copy storage pool.
Server processes can move files within the volumes in the storage pool.
The server can use files in the copy storage pool to restore files to primary
UPDATE STGPOOL Copy Sequential Access

1232 IBM Tivoli Storage Manager for Windows: Administrators Reference
storage pools. However, no new writes are permitted to volumes in the
copy storage pool from volumes outside the storage pool. A storage pool
cannot be backed up to the copy storage pool.
UNAVailable
Specifies that client nodes cannot access files stored on volumes in the
copy storage pool.
Server processes can move files within the volumes in the storage pool.
The server can use files in the copy storage pool to restore files to primary
storage pools. However, no new writes are permitted to volumes in the
copy storage pool from volumes outside the storage pool. A storage pool
cannot be backed up to the copy storage pool.
COLlocate
Specifies whether the server attempts to keep data belonging to a single client
node, group of client nodes, or client file space assigned to as few volumes as
possible. This parameter is optional.
Collocation reduces the number of sequential access media mounts for restore,
retrieve, and recall operations. However, collocation increases both the amount
of server time needed to collocate files for storing and the number of volumes
required. For details, see the Administrators Guide.
Possible values are:
No
Specifies that collocation is disabled.
GRoup
Specifies that collocation is enabled at the group level for client nodes. The
server attempts to put data for nodes that belong to the same collocation
group on as few volumes as possible. If the nodes in the collocation group
have multiple file spaces, the server does not attempt to collocate those file
spaces.
If you specify COLLOCATE=GROUP but do not define any collocation
groups or if you specify COLLOCATE=GROUP but do not add nodes to a
collocation group, data is collocated by node. Be sure to consider tape
usage when organizing client nodes into collocation groups. For example,
if a tape-based storage pool consists of data from grouped and ungrouped
nodes and you specify COLLOCATE=GROUP, the server does the
following:
v Collocates by group the data for grouped nodes only. Whenever
possible, the server collocates data belonging to a group of nodes on a
single tape or on as few tapes as possible. Data for a single node can
also be spread across several tapes associated with a group.
v Collocates by node the data for ungrouped nodes. Whenever possible,
the server stores the data for a single node on a single tape. All available
tapes that already have data for the node are used before available space
on any other tape is used.
NODe
Specifies that collocation is enabled at the client node level. The server
attempts to put data for one node on as few volumes as possible. If the
node has multiple file spaces, the server does not attempt to collocate those
file spaces. For backward compatibility, COLLOCATE=YES is still accepted
by the server to specify collocation at the client node level.
UPDATE STGPOOL Copy Sequential Access
Chapter 2. Administrative commands 1233
If a storage pool contains data for a node that is a member of a collocation
group and you specify COLLOCATE=NODE, the data will be collocated by
node not by group.
FIlespace
Specifies that collocation is enabled at the file space level for client nodes.
The server attempts to put data for one node and file space on as few
volumes as possible. If a node has multiple file spaces, the server attempts
to put data for different file spaces on different volumes.
REClaim
Specifies when the server reclaims a volume, based on the percentage of
reclaimable space on a volume. Reclamation makes the fragmented space on
volumes usable again by moving any remaining active files from one volume
to another volume, thus making the original volume available for reuse. This
parameter is optional. You can specify an integer from 1 to 100. The value 100
means that reclamation is not performed.
If you change the value from the default of 100, specify a value of 50 percent
or greater so that files stored on two volumes can be combined onto a single
output volume.
When a copy pool volume that is offsite becomes eligible for reclamation, the
reclamation process attempts to obtain the active files on the reclaimable
volume from a primary or copy storage pool that is onsite. The process then
writes these files to an available volume in the original copy storage pool.
Effectively, these files are moved back to the onsite location. However, the files
could be obtained from the offsite volume after a disaster if a database backup
is used that references the files on the offsite volume. Because of the way
reclamation works with offsite volumes, use it carefully with copy storage
pools.
RECLAIMPRocess
Specifies the number of parallel processes to use for reclaiming the volumes in
this storage pool. This parameter is optional. Enter a value from 1 to 999.
When calculating the value for this parameter, consider the number of
sequential storage pools that will be involved with the reclamation and the
number of logical and physical drives that can be dedicated to the operation.
To access a sequential access volume, Tivoli Storage Manager uses a mount
point and, if the device type is not FILE, a physical drive. The number of
available mount points and drives depends on other Tivoli Storage Manager
and system activity and on the mount limits of the device classes for the
sequential access storage pools that are involved in the reclamation.
For example, suppose that you want to reclaim the volumes from two
sequential storage pools simultaneously and that you want to specify four
processes for each of the storage pools. The storage pools have the same device
class. Each process requires two mount points and, if the device type is not
FILE, two drives. (One of the drives is for the input volume, and the other
drive is for the output volume.) To run eight reclamation processes
simultaneously, you need a total of at least 16 mount points and 16 drives. The
device class for each storage pool must have a mount limit of at least eight.
If the number of reclamation processes you specify is more than the number of
available mount points or drives, the processes that do not obtain mount
points or drives will wait for mount points or drives to become available. If
mount points or drives do not become available within the MOUNTWAIT
UPDATE STGPOOL Copy Sequential Access

1234 IBM Tivoli Storage Manager for Windows: Administrators Reference
time, the reclamation processes will terminate. For information about
specifying the MOUNTWAIT time, see DEFINE DEVCLASS (Define a device
class) on page 158.
The Tivoli Storage Manager server will start the specified number of
reclamation processes regardless of the number of volumes that are eligible for
reclamation. For example, if you specify ten reclamation processes and only six
volumes are eligible for reclamation, the server will start ten processes and
four of them will complete without processing a volume.
OFFSITERECLAIMLimit
Specifies the number of offsite volumes to have their space reclaimed during
reclamation for this storage pool. This parameter is optional. Possible values
are:
NOLimit
Specifies that you want to have the space reclaimed in all of your offsite
volumes.
number
Specifies the number of offsite volumes to have their space reclaimed. You
can specify an integer from 0 to 99999. A value of zero means that none of
the offsite volumes will be reclaimed.
Note: When determining the value for the OFFSITERECLAIMLIMIT,
consider using the statistical information in the message issued at
the end of the offsite volume reclamation operation. Alternatively,
you can use the following Tivoli Storage Manager SQL select
command to obtain the statistical information from the SUMMARY
table for the offsite volume reclamation operation:
select * from summary where activity=OFFSITE RECLAMATION
The statistical information includes the following:
v The number of offsite volumes that were processed
v The number of parallel processes that were used
v The total amount of time required for the processing
The order in which offsite volumes are reclaimed is based on the amount of
unused space in a volume. (Unused space includes both space that has never
been used on the volume and space that has become empty because of file
deletion.) Volumes with the largest amount of unused space are reclaimed first.
For example, suppose a copy storage pool contains three volumes: VOL1,
VOL2, and VOL3. VOL1 has the largest amount of unused space, and VOL3
has the least amount of unused space. Suppose further that the percentage of
unused space in each of the three volumes is greater than the value of the
RECLAIM parameter. If you do not specify a value for the
OFFSITERECLAIMLIMIT parameter, all three volumes will be reclaimed when
the reclamation runs. If you specify a value of 2, only VOL1 and VOL2 will be
reclaimed when the reclamation runs. If you specify a value of 1, only VOL1
will be reclaimed.
MAXSCRatch
Specifies the maximum number of scratch volumes that the server can request
for this storage pool. This parameter is optional. You can specify an integer
from 0 to 100000000. By allowing the server to request scratch volumes as
needed, you avoid having to define each volume to be used.
UPDATE STGPOOL Copy Sequential Access
Chapter 2. Administrative commands 1235
The value specified for this parameter is used to estimate the total number of
volumes available in the copy storage pool and the corresponding estimated
capacity for the copy storage pool.
Scratch volumes are automatically deleted from the storage pool when they
become empty. However, if the access mode for a scratch volume is OFFSITE,
the volume is not deleted from the copy storage pool until the access mode is
changed. This allows an administrator to query the server for empty, offsite
scratch volumes and return these to the onsite location.
When scratch volumes with the device type of FILE become empty and are
deleted, the space that the volumes occupied is freed by the server and
returned to the file system.
REUsedelay
Specifies the number of days that must elapse after all files are deleted from a
volume before the volume can be rewritten or returned to the scratch pool.
This parameter is optional. You can specify an integer from 0 to 9999. A value
of 0 means that a volume can be rewritten or returned to the scratch pool as
soon as all files are deleted from the volume.
Important: Use this parameter to help ensure that when you restore the
database to an earlier level, database references to files in the copy
storage pool are still valid. You must set this parameter to a value
greater than the number of days you plan to retain the oldest
database backup. The number of days specified for this parameter
should be the same as the number specified for the SET
DRMDBBACKUPEXPIREDAYS command. For more information,
see the Administrators Guide.
OVFLOcation
Specifies the overflow location for the storage pool. The server assigns this
location name to a volume that is ejected from the library by the MOVE
MEDIA command. This parameter is optional. The location name can be a
maximum length of 255 characters. Enclose the location name in quotation
marks if the location name contains any blank characters.
To remove an existing value, specify a null string ().
CRCData
Specifies whether a cyclic redundancy check (CRC) validates storage pool data
when audit volume processing occurs on the server. This parameter is only
valid for NATIVE data format storage pools. This parameter is optional. The
default value is NO. By setting CRCDATA to YES and scheduling an AUDIT
VOLUME command you can continually ensure the integrity of data stored in
your storage hierarchy. Possible values are:
Yes
Specifies that data is stored containing CRC information, allowing for audit
volume processing to validate storage pool data. This mode impacts
performance because additional overhead is required to calculate and
compare CRC values between the storage pool and the server.
No
Specifies that data is stored without CRC information.
Examples
Task
UPDATE STGPOOL Copy Sequential Access

1236 IBM Tivoli Storage Manager for Windows: Administrators Reference
Update the copy storage pool named TAPEPOOL2 to change the delay for volume
reuse to 30 days and to collocate files by client node.
Command
update stgpool tapepool2 reusedelay=30 collocate=node
UPDATE STGPOOL Copy Sequential Access
Chapter 2. Administrative commands 1237
UPDATE STGPOOL active-data sequential access
Use this command to update an active-data pool.
Privilege class
To issue this command, you must have system privilege, unrestricted storage
privilege, or restricted storage privilege for the storage pool to be updated.
Syntax
UPDate STGpool pool_name
DESCription

=

description

ACCess

=

READWrite

READOnly

UNAVailable

COLlocate

=

No

GRoup

NODe

FIlespace

REClaim

=

percent

RECLAIMPRocess

=

number

OFFSITERECLAIMLimit

=

NOLimit

number

MAXSCRatch

=

number

REUsedelay

=

days

OVFLOcation

=

location

CRCData

=

Yes

No


Parameters
pool_name (Required)
Specifies the name of the active-data pool to be updated.
DESCription
Specifies a description of the active-data pool. This parameter is optional. The
maximum length of the description is 255 characters. Enclose the description in
quotation marks if it contains any blank characters. To remove an existing
description, specify a null string ().
ACCess
Specifies how client nodes and server processes (such as reclamation) can
access files in the active-data pool. This parameter is optional. Possible values
are:
READWrite
Specifies that files can be read from and written to the volumes in the
active-data pool.
READOnly
Specifies that client nodes can only read files stored on the volumes in the
active-data pool.
Server processes can move files within the volumes in the storage pool.
The server can use files in the active-data pool to restore active versions of
UPDATE STGPOOL Active-data Sequential Access

1238 IBM Tivoli Storage Manager for Windows: Administrators Reference
backup files to primary storage pools. However, no new writes are
permitted to volumes in the active-data pool from volumes outside the
storage pool. A storage pool cannot be copied to the active-data pool.
UNAVailable
Specifies that client nodes cannot access files stored on volumes in the
active-data pool.
Server processes can move files within the volumes in the storage pool.
The server can use files in the active-data pool to restore active versions of
backup files to primary storage pools. However, no new writes are
permitted to volumes in the active-data pool from volumes outside the
storage pool. A storage pool cannot be copied to the active-data pool.
COLlocate
Specifies whether the server attempts to keep data belonging to a single client
node, group of client nodes, or client file space assigned to as few volumes as
possible. This parameter is optional.
Collocation reduces the number of sequential access media mounts for restore,
retrieve, and recall operations. However, collocation increases both the amount
of server time needed to collocate files for storing and the number of volumes
required. For details, see the Administrators Guide.
Possible values are:
No
Specifies that collocation is disabled.
GRoup
Specifies that collocation is enabled at the group level for client nodes. The
server attempts to put data for nodes that belong to the same collocation
group on as few volumes as possible. If the nodes in the collocation group
have multiple file spaces, the server does not attempt to collocate those file
spaces.
If you specify COLLOCATE=GROUP but do not define any collocation
groups or if you specify COLLOCATE=GROUP but do not add nodes to a
collocation group, data is collocated by node. Be sure to consider tape
usage when organizing client nodes into collocation groups. For example,
if a tape-based storage pool consists of data from grouped and ungrouped
nodes and you specify COLLOCATE=GROUP, the server does the
following:
v Collocates by group the data for grouped nodes only. Whenever
possible, the server collocates data belonging to a group of nodes on a
single tape or on as few tapes as possible. Data for a single node can
also be spread across several tapes associated with a group.
v Collocates by node the data for ungrouped nodes. Whenever possible,
the server stores the data for a single node on a single tape. All available
tapes that already have data for the node are used before available space
on any other tape is used.
NODe
Specifies that collocation is enabled at the client node level. The server
attempts to put data for one node on as few volumes as possible. If the
node has multiple file spaces, the server does not attempt to collocate those
file spaces. For backward compatibility, COLLOCATE=YES is still accepted
by the server to specify collocation at the client node level.
UPDATE STGPOOL Active-data Sequential Access
Chapter 2. Administrative commands 1239
If a storage pool contains data for a node that is a member of a collocation
group and you specify COLLOCATE=NODE, the data will be collocated by
node not by group.
FIlespace
Specifies that collocation is enabled at the file space level for client nodes.
The server attempts to put data for one node and file space on as few
volumes as possible. If a node has multiple file spaces, the server attempts
to put data for different file spaces on different volumes.
REClaim
Specifies when the server reclaims a volume, based on the percentage of
reclaimable space on a volume. Reclamation makes the fragmented space on
volumes usable again by moving any remaining active files from one volume
to another volume, thus making the original volume available for reuse. This
parameter is optional. You can specify an integer from 1 to 100. The value 100
means that reclamation is not performed.
If you change the value from the default of 60, specify a value of 50 percent or
greater so that files stored on two volumes can be combined onto a single
output volume.
When an active-data pool volume that is offsite becomes eligible for
reclamation, the reclamation process attempts to obtain the active files on the
reclaimable volume from a primary or active-data pool that is onsite. The
process then writes these files to an available volume in the original active-data
pool. Effectively, these files are moved back to the onsite location. However,
the files could be obtained from the offsite volume after a disaster if a database
backup is used that references the files on the offsite volume. Because of the
way reclamation works with offsite volumes, use it carefully with active-data
pools.
RECLAIMPRocess
Specifies the number of parallel processes to use for reclaiming the volumes in
this storage pool. This parameter is optional. Enter a value from 1 to 999.
When calculating the value for this parameter, consider the number of
sequential storage pools that will be involved with the reclamation and the
number of logical and physical drives that can be dedicated to the operation.
To access a sequential access volume, Tivoli Storage Manager uses a mount
point and, if the device type is not FILE, a physical drive. The number of
available mount points and drives depends on other Tivoli Storage Manager
and system activity and on the mount limits of the device classes for the
sequential access storage pools that are involved in the reclamation.
For example, suppose that you want to reclaim the volumes from two
sequential storage pools simultaneously and that you want to specify four
processes for each of the storage pools. The storage pools have the same device
class. Each process requires two mount points and, if the device type is not
FILE, two drives. (One of the drives is for the input volume, and the other
drive is for the output volume.) To run eight reclamation processes
simultaneously, you need a total of at least 16 mount points and 16 drives. The
device class for each storage pool must have a mount limit of at least eight.
If the number of reclamation processes you specify is more than the number of
available mount points or drives, the processes that do not obtain mount
points or drives will wait for mount points or drives to become available. If
mount points or drives do not become available within the MOUNTWAIT
UPDATE STGPOOL Active-data Sequential Access

1240 IBM Tivoli Storage Manager for Windows: Administrators Reference
time, the reclamation processes will terminate. For information about
specifying the MOUNTWAIT time, see DEFINE DEVCLASS (Define a device
class) on page 158.
The Tivoli Storage Manager server will start the specified number of
reclamation processes regardless of the number of volumes that are eligible for
reclamation. For example, if you specify ten reclamation processes and only six
volumes are eligible for reclamation, the server will start ten processes and
four of them will complete without processing a volume.
OFFSITERECLAIMLimit
Specifies the number of offsite volumes to have their space reclaimed during
reclamation for this storage pool. This parameter is optional. Possible values
are:
NOLimit
Specifies that you want to have the space reclaimed in all of your offsite
volumes.
number
Specifies the number of offsite volumes to have their space reclaimed. You
can specify an integer from 0 to 99999. A value of zero means that none of
the offsite volumes will be reclaimed.
Note: When determining the value for the OFFSITERECLAIMLIMIT,
consider using the statistical information in the message issued at
the end of the offsite volume reclamation operation. Alternatively,
you can use the following Tivoli Storage Manager SQL select
command to obtain the statistical information from the SUMMARY
table for the offsite volume reclamation operation:
select * from summary where activity=OFFSITE RECLAMATION
The statistical information includes the following:
v The number of offsite volumes that were processed
v The number of parallel processes that were used
v The total amount of time required for the processing
The order in which offsite volumes are reclaimed is based on the amount of
unused space in a volume. (Unused space includes both space that has never
been used on the volume and space that has become empty because of file
deletion.) Volumes with the largest amount of unused space are reclaimed first.
For example, suppose an active-data pool contains three volumes: VOL1,
VOL2, and VOL3. VOL1 has the largest amount of unused space, and VOL3
has the least amount of unused space. Suppose further that the percentage of
unused space in each of the three volumes is greater than the value of the
RECLAIM parameter. If you do not specify a value for the
OFFSITERECLAIMLIMIT parameter, all three volumes will be reclaimed when
the reclamation runs. If you specify a value of 2, only VOL1 and VOL2 will be
reclaimed when the reclamation runs. If you specify a value of 1, only VOL1
will be reclaimed.
MAXSCRatch
Specifies the maximum number of scratch volumes that the server can request
for this storage pool. This parameter is optional. You can specify an integer
from 0 to 100000000. By allowing the server to request scratch volumes as
needed, you avoid having to define each volume to be used.
UPDATE STGPOOL Active-data Sequential Access
Chapter 2. Administrative commands 1241
The value specified for this parameter is used to estimate the total number of
volumes available in the active-data pool and the corresponding estimated
capacity for the active-data pool.
Scratch volumes are automatically deleted from the storage pool when they
become empty. However, if the access mode for a scratch volume is OFFSITE,
the volume is not deleted from the active-data pool until the access mode is
changed. This allows an administrator to query the server for empty, offsite
scratch volumes and return these to the onsite location.
When scratch volumes with the device type of FILE become empty and are
deleted, the space that the volumes occupied is freed by the server and
returned to the file system.
REUsedelay
Specifies the number of days that must elapse after all files are deleted from a
volume before the volume can be rewritten or returned to the scratch pool.
This parameter is optional. You can specify an integer from 0 to 9999. A value
of 0 means that a volume can be rewritten or returned to the scratch pool as
soon as all files are deleted from the volume.
Important: Use this parameter to help ensure that when you restore the
database to an earlier level, database references to files in the
active-data pool are still valid. You must set this parameter to a
value greater than the number of days you plan to retain the oldest
database backup. The number of days specified for this parameter
should be the same as the number specified for the SET
DRMDBBACKUPEXPIREDAYS command. For more information,
see the Administrators Guide.
OVFLOcation
Specifies the overflow location for the storage pool. The server assigns this
location name to a volume that is ejected from the library by the MOVE
MEDIA command. This parameter is optional. The location name can be a
maximum length of 255 characters. Enclose the location name in quotation
marks if the location name contains any blank characters.
To remove an existing value, specify a null string ().
CRCData
Specifies whether a cyclic redundancy check (CRC) validates storage pool data
when audit volume processing occurs on the server. This parameter is only
valid for NATIVE data format storage pools. This parameter is optional. The
default value is NO. By setting CRCDATA to YES and scheduling an AUDIT
VOLUME command you can continually ensure the integrity of data stored in
your storage hierarchy. Possible values are:
Yes
Specifies that data is stored containing CRC information, allowing for audit
volume processing to validate storage pool data. This mode impacts
performance because additional overhead is required to calculate and
compare CRC values between the storage pool and the server.
No
Specifies that data is stored without CRC information.
Examples
Task
UPDATE STGPOOL Active-data Sequential Access

1242 IBM Tivoli Storage Manager for Windows: Administrators Reference
Update the active-data pool named TAPEPOOL2 to change the delay for volume
reuse to 30 days and to collocate files by client node.
Command
update stgpool tapepool3 reusedelay=30 collocate=node
UPDATE STGPOOL Active-data Sequential Access
Chapter 2. Administrative commands 1243
UPDATE VIRTUALFSMAPPING (Update a virtual file space
mapping)
Use this command to update an existing virtual file space mapping definition.
Refer to the documentation about your NAS device for more information about
this command.
The NAS node must have an associated data mover definition because when the
Tivoli Storage Manager server updates a virtual file space mapping, the server
attempts to contact the NAS device to validate the virtual file system and file
system name.
Privilege class
To perform this task, you must have one of the following privilege classes:
v System privilege
v Unrestricted policy privilege
v Restricted policy privilege for the domain to which the NAS node is assigned
Syntax
UPDate VIRTUALFSMapping node_name virtual_filespace_name

FILESystem

=

new_file_system_name

NAMEType

=

SERVER

PATH

=

new_path_name

NAMEType

=

SERVER

HEXadecimal


Parameters
node_name (Required)
Specifies the NAS node on which the file system and path reside. You cannot
use wildcard characters or specify a list of names.
virtual_filespace_name (Required)
Specifies the virtual file space mapping to update. You cannot use wildcard
characters or specify a list of names.
FILESystem
Specifies the new name of the file system in which the path is located. The file
system name must exist on the specified NAS node. The file system name
cannot contain wildcard characters. The file system name should only be
modified when the file system name is modified on the NAS device or, for
example, the directory is moved to a different file system. This parameter is
optional.
PATH
Specifies the new path from the root of the filesystem to the directory. The path
can only reference a directory. This should only be modified when the path on
the NAS device has changed; for example, the directory is moved to a different
UPDATE VIRTUALFSMAPPING

1244 IBM Tivoli Storage Manager for Windows: Administrators Reference
path. The maximum length of the path is 1024 characters. The path name is
case sensitive. This parameter is optional.
NAMEType
Specifies how the server should interpret the path name specified. Specify this
parameter only if you specify a path. This parameter is useful when a path
contains characters that are not part of the code page on which the server is
running. The default value is SERVER.
Possible values are:
SERVER
The code page in which the server is running is used to interpret the path.
HEXadecimal
The server interprets the path that you enter as the hexadecimal
representation of the path. This option should be used when a path
contains characters that cannot be entered. For example, this could occur if
the NAS file system is set to a language different from the one in which
the server is running.
Examples
Task
Update the virtual file space mapping named /mikeshomedir for the NAS node
NAS1 by modifying the path.
Command
update virtualfsmapping nas1 /mikeshomedir path=/new/home/mike
Related commands
Table 396. Commands related to UPDATE VIRTUALFSMAPPING
Command Description
DEFINE VIRTUALFSMAPPING Define a virtual file space mapping.
DELETE VIRTUALFSMAPPING Delete a virtual file space mapping.
QUERY VIRTUALFSMAPPING Query a virtual file space mapping.

UPDATE VIRTUALFSMAPPING
Chapter 2. Administrative commands 1245
UPDATE VOLHISTORY (Update sequential volume history
information)
Use this command to update volume history information for a volume produced
by a database dump, a database backup, or an export operation. This command
does not apply to storage pool volumes.
Use the UPDATE BACKUPSET command to update specified backup set volume
information in the volume history file. Do not use this UPDATE VOLHISTORY
command to update backup set volume information in the volume history file.
Privilege class
You must have system privilege or unrestricted storage privilege to issue this
command.
Syntax
UPDate VOLHistory volume_name DEVclass = device_class_name

LOcation

=

location

ORMSTate

=

MOuntable

NOTMOuntable

COUrier

VAult

COURIERRetrieve


Parameters
volume_name (Required)
Specifies the volume name. The volume must have been used for a database
dump, a database backup, or an export operation.
DEVclass (Required)
Specifies the name of the device class for the volume.
LOcation
Specifies the volume location. This parameter is required if the ORMSTATE
parameter is not specified. The maximum text length is 255 characters. Enclose
the text in quotation marks if it contains any blank characters.
Note: The UPDATE VOLHISTORY command supports updates to the location
information and ORMSTATE for snapshot database backup volumes.
ORMSTate
Specifies a change to the state of a database backup volume. This parameter is
required if the LOCATION parameter is not specified.
Note: Specify this parameter only if Tivoli Disaster Recovery Manager is
licensed for your system.
Possible states are:
MOuntable
The volume contains valid data and is accessible for onsite processing.
NOTMOuntable
The volume is onsite, contains valid data, and is not accessible for onsite
processing.
UPDATE VOLHISTORY

1246 IBM Tivoli Storage Manager for Windows: Administrators Reference
COUrier
The volume is being moved offsite.
VAult
The volume is offsite, contains valid data, and is not accessible for onsite
processing.
COURIERRetrieve
The volume is being moved onsite.
Examples
Task
Update the location of a volume used for database backup, BACKUP1, to show
that it has been moved to an offsite location.
Command
update volhistory backup1 devclass=tapebkup
location="700 w. magee rd."
Related commands
Table 397. Commands related to UPDATE VOLHISTORY
Command Description
BACKUP VOLHISTORY Records volume history information in
external files.
DELETE VOLHISTORY Removes sequential volume history
information from the volume history file.
MOVE DRMEDIA Moves DRM media onsite and offsite.
PREPARE Creates a recovery plan file.
QUERY DRMEDIA Displays information about disaster recovery
volumes.
QUERY VOLHISTORY Displays sequential volume history
information that has been collected by the
server.

UPDATE VOLHISTORY
Chapter 2. Administrative commands 1247
UPDATE VOLUME (Change a storage pool volume)
Use this command to change the access mode for one or more volumes in storage
pools.
You can correct an error condition associated with a volume by updating the
volume to an access mode of READWRITE. You can also use this command to
change the location information for one or more volumes in sequential access
storage pools.
Note: If you specify values for both the ACCESS and LOCATION parameters but
the access mode cannot be updated for a particular volume, the location
attribute is also not updated for that volume. For example, if you specify
ACCESS=OFFSITE and a LOCATION value for a primary storage pool
volume, neither the access nor location values are updated because a
primary storage pool volume cannot be given an access mode of OFFSITE.
Privilege class
To issue this command, you must have system privilege or operator privilege.
Syntax

(1)
UPDate Volume

volume_name

ACCess

=

READWrite

READOnly

UNAVailable

(2)

DEStroyed

(3)

OFfsite

(4)

LOcation

=

location
WHERESTGpool = *
WHERESTGpool

=

pool_name

WHEREDEVclass = *
WHEREDEVclass

=

device_class_name

,

WHEREACCess

=

READWrite

READOnly

UNAVailable

OFfsite

DEStroyed

,

WHERESTatus

=

ONline

OFfline

EMPty

PENding

FILling

FULl

Preview = No
Preview

=

No

Yes

UPDATE VOLUME

1248 IBM Tivoli Storage Manager for Windows: Administrators Reference
Notes:
1 You must update at least one attribute (ACCESS or LOCATION).
2 This value is valid only for volumes in primary storage pools.
3 This value is valid only for volumes in copy storage pools.
4 This parameter is valid only for volumes in sequential access storage pools.
Parameters
volume_name (Required)
Specifies the storage pool volume to update. You can use wildcard characters
to specify names.
ACCess
Specifies how client nodes and server processes (such as migration) can access
files in the storage pool volume. This parameter is optional. Possible values
are:
READWrite
Specifies that client nodes and server processes can read from and write to
files stored on the volume.
If the volume being updated is an empty scratch volume that had an
access mode of offsite, the server deletes the volume from the database.
READOnly
Specifies that client nodes and server processes can only read files stored
on the volume.
If the volume being updated is an empty scratch volume that had an
access mode of offsite, the server deletes the volume from the database.
UNAVailable
Specifies that neither client nodes nor server processes can access files
stored on the volume.
Before making a random access volume unavailable, you must vary the
volume offline. After you make a random access volume unavailable, you
cannot vary the volume online.
If you make a sequential access volume unavailable, the server does not
attempt to mount the volume.
If the volume being updated is an empty scratch volume that had an
access mode of offsite, the server deletes the volume from the database.
DEStroyed
Specifies that a primary storage pool volume has been permanently
damaged. Neither client nodes nor server processes can access files stored
on the volume. Use this access mode to indicate an entire volume that
needs to be restored by using the RESTORE STGPOOL command. After all
files on a destroyed volume have been restored to other volumes, the
server automatically deletes the destroyed volume from the database.
Only volumes in primary storage pools can be updated to DESTROYED.
Before updating a random access volume to DESTROYED access, you must
vary the volume offline. After you update a random access volume to
DESTROYED, you cannot vary the volume online.
If you update a sequential access volume to DESTROYED, the server does
not attempt to mount the volume.
UPDATE VOLUME
Chapter 2. Administrative commands 1249
If a volume contains no files and you change the access mode to
DESTROYED, the server deletes the volume from the database.
OFfsite
Specifies that a copy storage pool volume is at an offsite location from
which it cannot be mounted. Only volumes in copy storage pools can have
the access mode of OFFSITE.
Use this mode to help you track volumes that you move to offsite
locations. See the Administrators Guide for details.
LOcation
Specifies the location of the volume. This parameter is optional. It can be
specified only for volumes in sequential access storage pools. The maximum
length of the location is 255 characters. Enclose the location in quotation marks
if it contains any blank characters. To remove a previously defined location,
specify the null string ().
WHERESTGpool
Specifies the name of the storage pool for volumes to be updated. Use this
parameter to restrict the update by storage pool. This parameter is optional.
You can use wildcard characters to specify names. If you do not specify a
storage pool name, volumes belonging to any storage pool are updated.
WHEREDEVclass
Specifies the name of the device class for volumes to be updated. Use this
parameter to restrict the update by device class. This parameter is optional.
You can use wildcard characters to specify names. If you do not specify a
device class name, volumes with any device class are updated.
WHEREACCess
Specifies the current access mode of volumes to be updated. Use this
parameter to restrict the update to volumes that currently have the specified
access mode. This parameter is optional. You can specify multiple access
modes by separating the modes with commas and no intervening spaces. If
you do not specify a value for this parameter, the update is not restricted by
the current access mode of a volume. Possible values are:
READWrite
Update volumes with an access mode of READWRITE.
READOnly
Update volumes with an access mode of READONLY.
UNAVailable
Update volumes with an access mode of UNAVAILABLE.
OFfsite
Update volumes with an access mode of OFFSITE.
DEStroyed
Update volumes with an access mode of DESTROYED.
WHERESTatus
Specifies the status of volumes to be updated. Use this parameter to restrict the
update to volumes that have a specified status. This parameter is optional. You
can specify multiple status values by separating the values with commas and
no intervening spaces. If you do not specify a value for this parameter, the
update is not restricted by volume status. Possible values are:
ONline
Update volumes with a status of ONLINE.
UPDATE VOLUME

1250 IBM Tivoli Storage Manager for Windows: Administrators Reference
OFfline
Update volumes with a status of OFFLINE.
EMPty
Update volumes with a status of EMPTY.
PENding
Update volumes with a status of PENDING. These are volumes from
which all files have been deleted, but the time specified by the
REUSEDELAY parameter has not elapsed.
FILling
Update volumes with a status of FILLING.
FULl
Update volumes with a status of FULL.
Preview
Specifies whether you want to preview the update operation without actually
updating volumes. This parameter is optional. The default value is NO.
Possible values are:
No
Specifies that volumes are actually updated.
Yes
Specifies that you want only to preview the update operation. This option
displays the volumes that will be updated if you actually perform the
update operation.
Examples
Task
Update a tape volume named DSMT20 to make it unavailable to client nodes and
server processes.
Command
update volume dsmt20 access=unavailable
Task
Update all empty, offsite volumes in the TAPEPOOL2 storage pool. Set the access
mode to READWRITE and delete the location information for the updated
volumes.
Command
update volume * access=readwrite location="" wherestgpool=tapepool2
whereaccess=offsite wherestatus=empty
Related commands
Table 398. Commands related to UPDATE VOLUME
Command Description
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
DELETE VOLUME Deletes a volume from a storage pool.
QUERY VOLUME Displays information about storage pool
volumes.
UPDATE VOLUME
Chapter 2. Administrative commands 1251
Table 398. Commands related to UPDATE VOLUME (continued)
Command Description
VARY Specifies whether a disk volume is available
to the server for use.

UPDATE VOLUME

1252 IBM Tivoli Storage Manager for Windows: Administrators Reference
VALIDATE commands
Use the VALIDATE command to verify that an object is complete or valid for
Tivoli Storage Manager.
v VALIDATE LANFREE (Validate LAN-Free paths) on page 1254
v VALIDATE POLICYSET (Verify a policy set) on page 1256
VALIDATE commands
Chapter 2. Administrative commands 1253
VALIDATE LANFREE (Validate LAN-Free paths)
Use this command to determine which destinations for a given node using a
specific storage agent are capable of LAN-Free data movement.
Privilege class
To issue this command, you must have system privilege.
Syntax
VALidate LAnfree node_name stgagent_name

Parameters
node_name (Required)
The name of the node to evaluate.
stgagent_name (Required)
The name of the storage agent to evaluate.
Examples
Task
Validate the current server definitions and configuration for node TIGER to use
storage agent AIX_STA1 for LAN-free data operations.
Command
validate lanfree tiger aix_sta1
Output

Node Storage Operation Mgmt Class Destination LAN-Free Explanation
Name Agent Name Name capable?
----- -------- --------- ---------- ----------- -------- -----------
TIGER AIX_STA1 BACKUP STANDARD OUTPOOL NO No available
online paths.
TIGER AIX_STA1 BACKUP STANDARD PRIMARY NO Destination
storage pool
is configured
for simultan-
eous write.
TIGER AIX_STA1 BACKUP STANDARD SHRPOOL YES
TIGER AIX_STA1 ARCHIVE STANDARD OUTPOOL NO No available
online paths.
TIGER AIX_STA1 ARCHIVE STANDARD PRIMARY NO Destination
storage pool
is configured
for simultan-
eous write.
TIGER AIX_STA1 ARCHIVE STANDARD SHRPOOL YES

Related commands
Table 399. Commands related to VALIDATE LANFREE
Command Description
QUERY COPYGROUP Displays the attributes of a copy group.
QUERY DEVCLASS Displays information about device classes.
VALIDATE LANFREE

1254 IBM Tivoli Storage Manager for Windows: Administrators Reference
Table 399. Commands related to VALIDATE LANFREE (continued)
Command Description
QUERY DOMAIN Displays information about policy domains.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more
libraries.
QUERY MGMTCLASS Displays information about management
classes.
QUERY NODE Displays partial or complete information
about one or more clients.
QUERY PATH Displays information about the path from a
source to a destination.
QUERY POLICYSET Displays information about policy sets.
QUERY SERVER Displays information about servers.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
QUERY STGPOOL Displays information about storage pools.

VALIDATE LANFREE
Chapter 2. Administrative commands 1255
VALIDATE POLICYSET (Verify a policy set)
Use this command to verify that a policy set is complete and valid before you
activate it. The command examines the management class and copy group
definitions in the policy set and reports on conditions that you need to consider
before activating the policy set.
The VALIDATE POLICYSET command fails if any of the following conditions
exist:
v The policy set has no default management class.
v A copy group within the policy set specifies a copy storage pool as a destination.
v A management class specifies a copy storage pool as the destination for
space-managed files.
v A TOCDESTINATION parameter is specified, and the storage pool is either a
copy pool or has a data format other than NATIVE or NONBLOCK.
The server issues warning messages for the following conditions:
v A copy group specifies a storage pool that does not exist as a destination for
backed-up or archived files.
If you activate a policy set with copy groups that specify nonexistent storage
pools, the client backup or archive operations fail.
v A management class specifies a storage pool that does not exist as a destination
for files migrated from HSM clients.
v The policy set does not have one or more management classes that exist in the
current ACTIVE policy set.
If you activate the policy set, backup files bound to the deleted management
classes are rebound to the default management class in the new active policy set.
v The policy set does not have one or more copy groups that exist in the current
ACTIVE policy set.
If you activate the policy set, files bound to the management classes with
deleted copy groups are no longer archived or backed up.
v The default management class for the policy set does not contain a backup or
archive copy group.
If you activate the policy set with this default management class, clients using
the default cannot back up or archive files.
v A management class specifies that a backup version must exist before a file can
be migrated from a client node (MIGREQUIRESBKUP=YES), but the
management class does not contain a backup copy group.
If the server has data retention protection enabled, the following conditions must
exist:
v All management classes in the policy set to be validated must contain an archive
copy group.
v If a management class exists in the active policy set, a management class with
the same name must exist in the policy set to be validated.
v If an archive copy group exists in the active policy set, the corresponding copy
group in the policy set to be validated must have a RETVER value at least as
large as the corresponding values in the active copy group.
VALIDATE POLICYSET

1256 IBM Tivoli Storage Manager for Windows: Administrators Reference
Privilege class
To issue this command, you must have system privilege, unrestricted policy
privilege, or restricted policy privilege for the policy domain to which the policy
set belongs.
Syntax
VALidate POlicyset domain_name policy_set_name

Parameters
domain_name (Required)
Specifies the name of the policy domain to which the policy set is assigned.
policy_set_name (Required)
Specifies the name of the policy set to be validated.
Examples
Task
Validate the policy set VACATION located in the EMPLOYEE_RECORDS policy
domain.
Command
validate policyset employee_records vacation
Related commands
Table 400. Commands related to VALIDATE POLICYSET
Command Description
ACTIVATE POLICYSET Validates and activates a policy set.
COPY POLICYSET Creates a copy of a policy set.
DEFINE COPYGROUP Defines a copy group for backup or archive
processing within a specified management
class.
DEFINE MGMTCLASS Defines a management class.
DELETE POLICYSET Deletes a policy set, including its
management classes and copy groups, from a
policy domain.
QUERY POLICYSET Displays information about policy sets.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.
UPDATE POLICYSET Changes the description of a policy set.

VALIDATE POLICYSET
Chapter 2. Administrative commands 1257
VARY (Bring a random access volume online or offline)
Use this command to make a random access volume online or offline to the server
as a database, recovery log, or storage pool volume. This command is valid only
for volumes on random access devices. For example, use this command during
maintenance or corrective action of a random access volume. You cannot vary a
random access volume online that is defined as unavailable.
Privilege class
To issue this command, you must have system privilege or operator privilege.
Syntax

VARy

ONline

OFfline

volume_name
Wait = No
Wait

=

No

Yes

Parameters
ONline
Specifies that the server can use the random access volume.
OFfline
Specifies that the server cannot use the volume.
volume_name (Required)
Specifies the volume identifier. Volume names cannot contain embedded
blanks or equal signs.
Wait
Specifies whether to wait for the server to complete processing this command
in the foreground. This parameter is optional. The default is NO. Possible
values are:
No
Specifies that the server processes this command in the background, while
other tasks run. The server displays messages created from the background
process either in the activity log or the server console, depending on where
messages are logged.
Yes
Specifies that the server processes this command in the foreground. Wait
for the command to complete before you continue with other tasks. The
server displays the output messages to the administrative client when the
command completes.
Note: You cannot specify Wait=Yes from the server console.
Examples
Task
Make volume j:\storage\fp_vol01.dsm available to the server for use as a database
volume.
Command
VARY

1258 IBM Tivoli Storage Manager for Windows: Administrators Reference
vary online j:\storage\fp_vol01.dsm
Related commands
Table 401. Commands related to VARY
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE DBVOLUME Assigns a volume to be used for database
storage.
DEFINE LOGVOLUME Defines a disk volume to the recovery log.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.
DELETE DBVOLUME Deletes a volume from the database.
DELETE LOGVOLUME Deletes a volume from the recovery log.
DELETE VOLUME Deletes a volume from a storage pool.
QUERY DBVOLUME Displays information database volumes.
QUERY LOGVOLUME Displays information about log volumes.
QUERY PROCESS Displays information about background
processes.
QUERY VOLUME Displays information about storage pool
volumes.

VARY
Chapter 2. Administrative commands 1259
VARY

1260 IBM Tivoli Storage Manager for Windows: Administrators Reference
Chapter 3. Server options
At installation, IBM Tivoli Storage Manager provides a server options file named
dsmserv.opt, which contains a set of default options to start the server.
See the Installation Guide for your platform to determine where your server options
file resides.
Server options let you customize the following:
v Communication
v Server storage
v Client-server
v Date, number, time, and language
v Database and recovery log
v Data transfer
v Message
v Event logging
v Security and licensing
v Miscellaneous
To display the current option settings, enter:
query option
Modifying server options
The server reads the server options file at server initialization. When you update a
server option by editing the file, you must stop and start the server to activate the
updated server options file.
You can change some options dynamically by issuing the SETOPT command. See
SETOPT (Set a server option for dynamic update) on page 1037 for details.
You can modify server options by using the options file editor included in the IBM
Tivoli Storage Manager Console. This editor provides communications parameter
detection, value validation, and help for all options. The options file editor is the
preferred way to change server options, but you can also use a text editor.
Types of server options
Server options let you customize how some functions and processes work.


Copyright IBM Corp. 1993, 2007 1261
Communication options
You can use server options to specify server communication methods and their
characteristics.
Table 402. Communication options
Option Description
ADMINONCLIENTPORT The port that determines whether administrative sessions can use the port
specified in the TCPPORT option
COMMMETHOD The server communication method
DNSLOOKUP Control of use of Domain Name Services to lookup names of systems
contacting the server
NAMEDPIPENAME The named pipes communication method
NPBUFFERSIZE The size of the Named Pipes communication buffer
SHMPORT The port that the server listens on for shared memory connections.
SNMPHEARTBEATINTERVAL The interval in minutes between queries of the Tivoli Storage Manager server
SNMPMESSAGECATEGORY The trap types used when messages are forwarded from the server
SNMPSUBAGENT The parameters needed for the Tivoli Storage Manager subagent to
communicate with the SNMP daemon
SNMPSUBAGENTHOST The location of the Tivoli Storage Manager SNMP subagent
SNMPSUBAGENTPORT The port address of the Tivoli Storage Manager SNMP subagent
SSLTCPADMINPORT The port address on which the servers TCP/IP communication driver waits
for requests for SSL-enabled sessions for the command-line administrative
client
SSLTCPPORT The SSL-only port number on which the servers TCP/IP communication
driver waits for requests for SSL-enabled sessions for the command line
backup-archive client and administrative client
TCPADMINPORT The TCP/IP port number for administrative sessions
TCPPORT The TCP/IP port number for client sessions
TCPWINDOWSIZE The client node TCP/IP sliding window

Server storage options
You can use server options to configure server storage operations and device
operations.
Table 403. Server storage options
Option Description
3494SHARED Enables sharing of a 3494 library with applications other than Tivoli Storage
Manager
ACSACCESSID The ID for the ACS access control
ACSLOCKDRIVE Allows the drives within the ACSLS libraries to be locked
ACSQUICKINIT Allows a quick or full initialization of the ACSLS library
ACSTIMEOUTX The multiple for the built-in timeout value for the ACSLS API
ASSISTVCRRECOVERY Specifies whether the server assists an IBM 3570 or 3590 drive in recovering
from a lost or corrupted Vital Cartridge Records (VCR) condition
DEVCONFIG The name of the file that store backup copies of device configuration
information

1262 IBM Tivoli Storage Manager for Windows: Administrators Reference
||
|
|
||
|
|
Table 403. Server storage options (continued)
Option Description
DRIVEACQUIRERETRY The number of times that the server retries the acquisition of a drive in an
IBM 349x library that is shared among multiple applications
RESOURCETIMEOUT The length of time that the server waits for a resource before canceling the
pending acquisition of a resource
SANDISCOVERY Whether the Tivoli Storage Manager SAN discovery function is enabled
SANREFRESHTIME Amount of time before cached SAN discovery information is refreshed
SEARCHMPQUEUE The order in which the server satisfies requests in the mount queue

Client-server options
You can use server options to control client-server processing.
Table 404. Client-Server options
Option Description
COMMTIMEOUT The number of seconds the server waits for a response from a client before
timing out the client session
DISABLESCHEDS Whether administrative and client schedules are disabled during the Tivoli
Storage Manager server recovery scenario
IDLETIMEOUT The number of minutes the server allows a client session to remain idle
before timing out the client session
MAXSESSIONS The maximum number of simultaneous client sessions with the server
THROUGHPUTDATATHRESHOLD The throughput threshold that a client session must reach to prevent being
cancelled after the time threshold is reached
THROUGHPUTTIMETHRESHOLD The time threshold for a session after which it may be cancelled for low
throughput
VERBCHECK Whether additional error checking is done for commands sent by the client

Date, number, time, and language options
You can use server options to specify display formats for the dates, times,
numbers, and national language.
Table 405. Date, number, time, and language options
Option Description
DATEFORMAT The format by which dates are displayed
LANGUAGE The national language is used to present client messages
NUMBERFORMAT The format for displaying numbers
TIMEFORMAT The format displaying times



Chapter 3. Server options 1263
Database and recovery log options
You can use server options to control some aspects of database and recovery log
processing.
Table 406. Database and recovery log options
Option Description
BUFPOOLSIZE The size of database buffer pool
DBPAGESHADOW Whether database page shadowing is enabled
DBPAGESHADOWFILE The name of the file to use for database page shadowing
LOGPOOLSIZE The size of recovery log buffer pool
LOGWARNFULLPERCENT The log utilization threshold at which warning messages are issued
MIRRORREAD How mirrored volumes are to be accessed when the server reads pages to
the recovery log or database during normal processing
MIRRORWRITE How mirrored volumes are to be accessed when the server writes pages to
the recovery log or database during normal processing
SELFTUNEBUFPOOLSIZE Whether the server can automatically tune the database buffer pool size

Data transfer options
You can use server options to control how Tivoli Storage Manager groups and
transfers data.
Table 407. Group options
Option Description
MOVEBATCHSIZE The number of files that are to be moved and grouped in a batch, within a
transaction
MOVESIZETHRESH The threshold for the amount of data moved as a batch, within the same
server transaction
TXNGROUPMAX The number of files that are transferred as a group between a client and the
server between transaction commit points

Message options
You can use server options to give you more flexibility in the way Tivoli Storage
Manager issues messages.
Table 408. Message options
Option Description
EXPQUIET Whether Tivoli Storage Manager sends detailed informational messages
during expiration processing
MESSAGEFORMAT Whether a message number is displayed in all lines of a multi-line message
MSGINTERVAL The time, in minutes, between messages prompting an operator to mount a
tape for Tivoli Storage Manager
MSGSTACKTRACE Whether Tivoli Storage Manager server displays helpful diagnostic data
when certain messages are displayed.



1264 IBM Tivoli Storage Manager for Windows: Administrators Reference
Event logging options
You can use server options to give you more flexibility in the way Tivoli Storage
Manager issues messages.
Use the following options described in Table 409 to manage event logging
receivers.
Table 409. Event logging options
Option Description
EVENTSERVER Whether the server should try to contact the event server when the server
starts up
FILEEXIT A file to which enabled events are routed (binary format)
FILETEXTEXIT A file to which enabled events are routed (readable format)
REPORTRETRIEVE Record client restore and retrieve operations
TECBEGINEVENTLOGGING Whether event logging for the Tivoli receiver should begin when the server
starts up
TECHOST The host name or IP address for the Tivoli event server
TECPORT The TCP/IP port address on which the Tivoli event server is listening
TECUTF8EVENT A Tivoli Enterprise Console (TEC) event sent from the Tivoli Storage
Manager server in UTF8 format
UNIQUETDPTECEVENTS Tivoli Data Protection (TDP) events sent to the Tivoli Enterprise Console as
unique
UNIQUETECEVENTS Events sent to the Tivoli Enterprise Console as unique
USEREXIT A user-defined exit that will be given control to handle an event

Security options and licensing options
You can use server options to customize Tivoli Storage Manager.
Table 410. Security and licensing options
Option Description
ADSMGROUPNAME The name of a Windows group
AUDITSTORAGE Specifies that during a license audit operation, the server calculates, by node,
the amount of backup, archive, and space management storage in use
NPAUDITFAILURE Specifies that a node can access only its own data
NPAUDITSUCCESS Specifies that an event is sent to the event log when a client node user is
authenticated for access to the server through SECUREPIPE
QUERYAUTH The administrative authority level required to issue QUERY or SQL SELECT
commands
REQSYSAUTHOUTFILE Specifies if system authority is required for administrative commands that
cause Tivoli Storage Manager to write to an external file
SECUREPIPES With named pipes protocol, specifies that the server checks the Windows
group to authenticate a client



Chapter 3. Server options 1265
Miscellaneous options
You can use a variety of miscellaneous server options to customize Tivoli Storage
Manager.
Table 411. Miscellaneous options
Option Description
ADREGISTER Specifies whether to register the server with Active Directory at server start
up
ADSETDC The TCP/IP address of the domain controller
ADUNREGISTER Specifies whether to unregister the server with Active Directory at server
shut down
ALIASHALT Allows administrators to give the Tivoli Storage Manager HALT command a
different name.
DISPLAYLFINFO Specifies whether accounting records and summary table entries report the
storage agent name
EXPINTERVAL The interval between automatic inventory expiration processes
NDMPCONTROLPORT Specifies the port number to be used for internal communications for certain
NDMP operations.
NDMPPORTRANGE Specifies the range of port numbers through which Tivoli Storage Manager
cycles to obtain a port number for accepting a session from a NAS device for
data transfer.
NOPREEMPT Specifies that no operation can preempt another for access to a volume and
that only a database backup operation can preempt another operation for
access to a device
NORETRIEVEDATE Specifies that the server does not update the retrieve date of a file in a disk
storage pool when a client restores or retrieves the file
RESTOREINTERVAL The length of time that a restartable restore session can be saved in the
server database
VOLUMEHISTORY The name of the file to be automatically updated whenever server sequential
volume history information is changed

1266 IBM Tivoli Storage Manager for Windows: Administrators Reference
3494SHARED
The 3494SHARED option specifies whether an IBM 3494 library can share
applications other than Tivoli Storage Manager.
The default is NO, meaning that no application other than Tivoli Storage Manager
can share the 3494. When you set this option to YES, for every mount request,
Tivoli Storage Manager determines if each drive is in use. After the query
completes, Tivoli Storage Manager selects an available drive that is not in use by
another application. Enable sharing only if you have more than two drives in your
library. If you are currently sharing an IBM 3494 library with other applications,
you must specify this option.
Syntax
3494SHARED Yes
No


Parameters
Yes
Specifies that other applications can share the 3494 library.
No
Specifies that no other applications can share the 3494 library.
Examples
Enable sharing of a 3494 library:
3494shared yes
3494SHARED
Chapter 3. Server options 1267
ACSACCESSID
The ACSACCESSID option specifies the ID for the ACS access control for an
ACSLS library.
Syntax
ACSACCESSID name

Parameters
name
Specifies a 1 to 64 character ID. The default ID is your local host name.
Examples
acsaccessid region
ACSACCESSID

1268 IBM Tivoli Storage Manager for Windows: Administrators Reference
ACSLOCKDRIVE
The ACSLOCKDRIVE option specifies if the drives within the ACSLS libraries are
locked. Drive locking ensures the exclusive use of the drive in the ACSLS library in
a shared environment. However, there is some performance gain if libraries are not
locked. When other applications do not share the Tivoli Storage Manager drives,
drive locking is not required.
Syntax
ACSLOCKDRIVE Yes
No


Parameters
Yes
Specifies that drives are locked.
No
Specifies that drives are not locked.
Examples
acslockdrive yes
ACSLOCKDRIVE
Chapter 3. Server options 1269
ACSQUICKINIT
The ACSQUICKINIT option specifies whether, at server startup, the initialization of
the ACSLS library is a quick or full initialization. The default is Yes. A quick
initialization avoids the overhead associated with synchronizing the Tivoli Storage
Manager server inventory with the ACSLS library inventory (through an audit of
the library).
Syntax
ACSQUICKINIT Yes
No


Parameters
Yes
Specifies that a quick initialization of the ACSLS library is performed. When
the option is set to Yes, Tivoli Storage Manager bypasses library inventory
verification, initializing the library quickly, and making it available to Tivoli
Storage Manager sooner than if a full initialization is done.
This option should be set to Yes when it is known that the physical library
inventory and the Tivoli Storage Manager library inventory have not changed
and an audit is not needed.
No
Specifies that a full initialization of the ACSLS library and library inventory is
performed. When the option is set to No, Tivoli Storage Manager synchronizes
its library volume inventory with what is reported by the ACSLS library
manager.
Examples
acsquickinit yes
ACSQUICKINIT

1270 IBM Tivoli Storage Manager for Windows: Administrators Reference
ACSTIMEOUTX
The ACSTIMEOUTX option specifies the multiple for the built-in timeout value for
ACSLS APIs. The built-in timeout value for the ENTER, EJECT, and AUDIT ACS
API is 1800 seconds; for all other ACSLS APIs it is 600 seconds. For example, if the
multiple value specified is 5, the timeout value for audit API becomes 9000
seconds, and all other APIs become 3000 seconds.
Syntax
ACSTIMEOUTX value

Parameters
value
Specifies the multiple for the built-in timeout value for ACSLS API. The range
is from 1 to 100. The default is 1.
Examples
acstimeoutx 1
ACSTIMEOUTX
Chapter 3. Server options 1271
ADMINONCLIENTPORT
The ADMINONCLIENTPORT option defines whether or not the TCPPORT can be
used by administrative sessions. The default is YES.
Syntax
ADMINONCLIENTPORT YES
NO


Parameters
YES
If the option is set to YES, or if the TCPPORT and TCPADMINPORT are the
same value (the default), then administrative sessions can use the TCPPORT.
NO
If the option is set to NO, and if the TCPADMINPORT value is different than
the TCPPORT value, then administrative sessions cannot use the TCPPORT.
Examples
Specify that the TCPPORT can be used by administrative sessions.
adminonclientport yes
ADMINONCLIENTPORT

1272 IBM Tivoli Storage Manager for Windows: Administrators Reference
ADREGISTER
The ADREGISTER option specifies whether to register the server with Active
Directory at server startup. The default is NO.
Syntax
ADREGISTER YES
NO


Parameters
YES
Register the server with Active Directory at server start up.
NO
Do not register the server with Active Directory at server start up.
Examples
Specify that the server is to be registered with Active Directory at server startup.
adregister yes
ADREGISTER
Chapter 3. Server options 1273
ADSETDC
The ADSETDC option specifies the TCP/IP address of the domain controller. If no
address is set, the server searches for the Active Directory.
Syntax
ADSETDC domain_controller_address

Parameters
domain_controller_address
The address of the domain controller.
Examples
Specify the address of the domain controller:
adsetdc 200.12.34.7
The address can be specified with the name instead of numbers:
adsetdc w2kdctl.company.com
ADSETDC

1274 IBM Tivoli Storage Manager for Windows: Administrators Reference
ADSMGROUPNAME
The ADSMGROUPNAME option specifies the name of a Windows group. A client
node must be a member of this group to use the Tivoli Storage Manager server
through NT Unified Logon. The client node must also be a registered Tivoli
Storage Manager client node.
Syntax
ADSMGROUPname group_name

Parameters
group_name
Specifies a Windows group name.
Examples
Specify IDD as a Windows group:
adsmgroup idd
ADSMGROUPNAME
Chapter 3. Server options 1275
ADUNREGISTER
The ADUNREGISTER option specifies whether to unregister the server with Active
Directory at server shutdown. The default is NO.
Syntax
ADUNREGISTER YES
NO


Parameters
YES
Unregister the server with Active Directory at server shutdown.
NO
Do not unregister the server with Active Directory at server shutdown.
Examples
Specify that the server is to be unregistered with Active Directory at server
shutdown:
adunregister yes
ADUNREGISTER

1276 IBM Tivoli Storage Manager for Windows: Administrators Reference
ALIASHALT
The ALIASHALT option allows administrators to give the Tivoli Storage Manager
HALT command a different name.
Note: The administrative client recognizes an alias for the HALT command only
when the client is started with the CHECKALIASHALT option specified. See
Administrative client options on page 5 for details.
Syntax
ALIASHALT newname

Parameters
newname
Specifies the alias of the HALT command for shutting down the Tivoli Storage
Manager server. Minimum length of newname is 1; maximum length is 16.
Examples
aliashalt tsmhalt
ALIASHALT
Chapter 3. Server options 1277
ASSISTVCRRECOVERY
The ASSISTVCRRECOVERY option specifies whether Tivoli Storage Manager
assists an IBM 3570 or 3590 drive in recovering from a lost or corrupted Vital
Cartridge Records (VCR) condition. If you specify YES (the default) and if Tivoli
Storage Manager detects an error during the mount processing, it locates to the
end-of-data during the dismount processing to allow the drives to restore the VCR.
During the tape operation, there may be some small effect on performance because
the drive cannot perform a fast locate with a lost or corrupted VCR. However,
there is no loss of data.
Syntax
ASSISTVCRRECovery Yes
No


Parameters
Yes
Specifies server assistance in recovery.
No
Specifies no server assistance in recovery.
Examples
Turn off recovery assistance:
assistvcrrecovery no
ASSISTVCRRECOVERY

1278 IBM Tivoli Storage Manager for Windows: Administrators Reference
AUDITSTORAGE
As part of a license audit operation, the server calculates, by node, the amount of
server storage used for backup, archive, and spacemanaged files. For servers
managing large amounts of data, this calculation can take a great deal of CPU time
and can stall other server activity. You can use the AUDITSTORAGE option to
specify that storage is not to be calculated as part of a license audit.
Note: This option was previously called NOAUDITSTORAGE.
Syntax
AUDITSTorage Yes
No


Parameters
Yes
Specifies that storage is to be calculated as part of a license audit. The default
is Yes.
No
Specifies that storage is not to be calculated as part of a license audit.
Examples
auditstorage yes
AUDITSTORAGE
Chapter 3. Server options 1279
BUFPOOLSIZE
The BUFPOOLSIZE option specifies the size of the database buffer pool in
kilobytes. A large buffer pool means that database pages remain longer in memory
cache, and Tivoli Storage Manager requires fewer input/output operations to
server storage. However, a large buffer pool also requires more memory.
You can use this option to adjust the buffer pool size, or you can have Tivoli
Storage Manager make the adjustments. If you set the SELFTUNEBUFPOOLSIZE
server option to YES, Tivoli Storage Manager uses the default or the
BUFPOOLSIZE setting as a starting point for adjustments.
You can update this server option without stopping and restarting the server by
using the SETOPT command. See SETOPT (Set a server option for dynamic
update) on page 1037.
Syntax
BUFPoolsize kilobytes

Parameters
kilobytes
Specifies the size of the database buffer pool in kilobytes. The minimum value
is 256. The maximum value is limited by available virtual memory size. The
default value is 32768.
Examples
bufpoolsize 512
BUFPOOLSIZE

1280 IBM Tivoli Storage Manager for Windows: Administrators Reference
COMMMETHOD
The COMMMETHOD option specifies a communication method to be used by the
server. You can specify multiple COMMMETHOD options in the server options
file.
Syntax
COMMMethod NAMEDPIPE
NONE

SHAREDMEM

SNMP

TCPIP

V6TCPIP


Parameters
You can choose one of the following communication methods:
NAMEDPIPES
Specifies the named pipes communication method option.
NONE
Specifies that no communication method is used. This option does not allow
users to connect to the server and is useful for experimenting with policy
commands.
SHAREDMEM
Specifies the shared memory communication method option. This method uses
the same area of memory to send data between several applications at the
same time. Both the server and the backup-archive client need to be configured
to support the shared memory communication method, and they must be
installed on the same machine.
SNMP
Specifies the SNMP communication method option.
TCPIP
Specifies the TCP/IP communication method option. This is the default. When
TCPIP is specified, TCP/IP Version 4 is used exclusively.
V6TCPIP
Specifies the TCP/IP communication method option. If TCP/IP Version 4 and
Version 6 are both configured, Tivoli Storage Manager uses both protocols
simultaneously. If both COMMMETHOD TCPIP and COMMMETHOD
V6TCPIP are specified, V6TCPIP overrides the specification of TCPIP. A valid
domain name server (DNS) environment must be present to use either TCP/IP
Version 4 or TCP/IP Version 6 if this option is specified.
Examples
commmethod tcpip
commmethod v6tcpip
COMMMETHOD
Chapter 3. Server options 1281
|
|
|
|
|
|
|
|
|
|
COMMTIMEOUT
The COMMTIMEOUT option specifies how long the server waits for an expected
client message during an operation that causes a database update. If the length of
time exceeds this time-out, the server ends the session with the client. You may
want to increase the time-out value to prevent clients from timing out. Clients may
time out if there is a heavy network load in your environment or they are backing
up large files.
You can update this server option without stopping and restarting the server by
using the SETOPT command. See SETOPT (Set a server option for dynamic
update) on page 1037.
Syntax
COMMTimeout seconds

Parameters
seconds
Specifies the maximum number of seconds that a server waits for a client
response. The default value is 60. The minimum value is 1.
Examples
commtimeout 60
COMMTIMEOUT

1282 IBM Tivoli Storage Manager for Windows: Administrators Reference
DATEFORMAT
The DATEFORMAT option specifies the format in which dates are displayed by
the server.
Note: The DATEFORMAT is overridden by the locale format if the locale is
initialized at server startup. The locale is specified in the LANGUAGE
option.
Syntax
DATEformat n

Parameters
n Select a number from 1 to 5 to identify the date format used by the server. The
default value is 1.
1 MM/DD/YYYY
2 DD-MM-YYYY
3 YYYY-MM-DD
4 DD.MM.YYYY
5 YYYY.MM.DD
Examples
dateformat 4
DATEFORMAT
Chapter 3. Server options 1283
DBPAGESHADOW
The DBPAGESHADOW option specifies whether database page shadowing is
enabled. If database page shadowing is enabled, Tivoli Storage Manager mirrors
every write to a database page. You can enable shadowing only if database volume
mirrors are written to in parallel (that is, the MIRRORWRITE DB option is set to
PARALLEL). The default is YES.
For more information on specifying mirroring and database page shadowing server
options, see the Administrators Guide.
Syntax
DBPAGEShadow Yes
No


Parameters
Yes
Perform page shadowing.
No
Do not perform page shadowing.
Examples
dbpageshadow no
DBPAGESHADOW

1284 IBM Tivoli Storage Manager for Windows: Administrators Reference
DBPAGESHADOWFILE
The DBPAGESHADOWFILE option specifies the name of the file to use for
database page shadowing. If database page shadowing is enabled, the page
shadow either goes to the default file or is created in the directory that the server
is running from. The default file, dbpgshdw.bdt, resides in the directory where the
server is installed.
Syntax
DBPAGESHADOWFILE dbpgshdw.bdt
file_name


Parameters
file_name
Specifies the name of the file in which the database page shadow is stored.
Examples
dbpageshadowfile shadow.bdt
DBPAGESHADOWFILE
Chapter 3. Server options 1285
DEVCONFIG
The DEVCONFIG option specifies the name of a file in which you want Tivoli
Storage Manager to store a backup copy of device configuration information.
Tivoli Storage Manager stores the following information in the device configuration
file:
v Device class definitions created by using the DEFINE DEVCLASS command
v Drive definitions created by using the DEFINE DRIVE command
v Library definitions created by using the DEFINE LIBRARY command
v Library inventory information for the LIBTYPE=SCSI automated libraries
v Path definitions created by using the DEFINE PATH command
v Server definitions created with the DEFINE SERVER command
v Server name created with the SET SERVERNAME command
v Sever password created with the SET SERVERPASSWORD command
Note:
1. Only path definitions with SRCTYPE=SERVER are backed up to the
device configuration file. Paths of SRCTYPE=DATAMOVER are not
written to the file.
2. Library volume location information is stored as comments (/*...*/) in
the device configuration file whenever CHECKIN LIBVOLUME,
CHECKOUT LIBVOLUME, and AUDIT LIBRARY commands are issued
for SCSI libraries.
You can include one or more DEVCONFIG options in the server options file. When
you use multiple DEVCONFIG options, Tivoli Storage Manager automatically
updates and stores a backup copy of device configuration information in each file
you specify.
Syntax
DEVCONFig file_name

Parameters
file_name
Specifies the name of a file in which to store a backup copy of device
configuration information.
Examples
devconfig devices.sav
DEVCONFIG

1286 IBM Tivoli Storage Manager for Windows: Administrators Reference
DISABLESCHEDS
The DISABLESCHEDS option specifies whether administrative and client schedules
are disabled during Tivoli Storage Manager server recovery.
Syntax
DISABLESCheds Yes
No


Parameters
Yes
Specifies that administrative and client schedules are disabled.
No
Specifies that administrative and client schedules are enabled.
Examples
disablescheds no
DISABLESCHEDS
Chapter 3. Server options 1287
DISPLAYLFINFO
The DISPLAYLFINFO option specifies how the accounting records and summary
table entries report the node name.
When this option is enabled, the accounting records and summary table entries
report node_name(storage_agent_name) for the node name. If the option is not
enabled, the accounting records and summary table entries simply report
node_name for the node name. The default is No.
Syntax
DISPLAYLFINFO Yes
No


Parameters
Yes
Specifies that the accounting records and summary table entries will report the
storage agent name.
No
Specifies that the accounting records and summary table entries will not report
the storage agent name. This is the default.
Examples
displaylfinfo yes
The result shows the following accounting record with the storage agent name
displayed (STA53):
5,0,ADSM,07/13/2004,15:35:14,COLIND-TUC(STA53),,WinNT,1,Tcp/Ip,1,0,0,0,
0,223,4063,0,0,222,7,8,3,1,4,0,0,0,0,3,0
The corresponding summary table also displays the storage agent name:
START_TIME: 2004-07-13 15:35:07.000000
END_TIME: 2004-07-13 15:35:14.000000
ACTIVITY: BACKUP
NUMBER: 8
ENTITY: COLIND-TUC(STA53)
COMMMETH: Tcp/Ip
ADDRESS: colind-tuc:2229
SCHEDULE_NAME:
EXAMINED: 0
AFFECTED: 223
FAILED: 0
BYTES: 4160875
IDLE: 8
MEDIAW: 1
PROCESSES: 1
SUCCESSFUL: YES
VOLUME_NAME:
DRIVE_NAME:
LIBRARY_NAME:
LAST_USE:
COMM_WAIT: 3
NUM_OFFSITE_VOLS:

DISPLAYLFINFO

1288 IBM Tivoli Storage Manager for Windows: Administrators Reference
DNSLOOKUP
The DNSLOOKUP option specifies whether the server uses system API calls to
determine the domain name server (DNS) names of systems that contact the server.
Syntax
DNSLOOKUP Yes
No


Parameters
Yes
Specifies that the server obtains the DNS names of contacting systems. Yes is
the default.
No
Specifies that the server does not obtain the DNS names of contacting systems.
Examples
dnslookup yes
DNSLOOKUP
Chapter 3. Server options 1289
DRIVEACQUIRERETRY
The DRIVEACQUIRERETRY option lets you specify how many times the server
retries the acquisition of a drive in an IBM 349x library. If the library is shared
among multiple applications, its drives may appear to be available to the server
(through the use of a background polling process) when they are not.
This option is only valid if you specified 3494SHARED YES in the dsmserv.opt file.
If you specified DRIVEACQUIRERETRY NEVER, you need to monitor how long
jobs have been waiting for drives and how long the server has been polling the
drives. You may also need to check the status of these drives in the other Tivoli
Storage Manager servers. There may be cartridges stuck in the drives, and the
other Tivoli Storage Manager servers may have marked the drives as offline. If this
is the case, you need to mark the drives offline in the Tivoli Storage Manager server
that is polling the drives. If necessary, also cancel any waiting jobs.
Syntax
DRIVEACQuireretry Forever
Never

number_of_retries


Parameters
Forever
The acquisition of a drive is retried until one is successfully acquired. This is
the default.
Never
The server does not retry the acquisition of a drive and fails the operation.
number_of_retries
Specifies the maximum number of times, from 1 to 9999, that the server retries
the acquisition of a drive.
Examples
Specify that the server should attempt no more than 10 times to acquire the drive:
driveacquireretry 10
DRIVEACQUIRERETRY

1290 IBM Tivoli Storage Manager for Windows: Administrators Reference
EVENTSERVER
The EVENTSERVER option specifies whether at startup the server should try to
contact the event server.
Syntax
EVENTSERVer Yes
No


Parameters
Yes
Specifies that, at startup, the server tries to contact the event server. Contact
occurs only if a DEFINE EVENTSERVER command has already been issued.
This is the default.
No
Specifies that, at startup, the server does not try to contact the event server.
Examples
eventserver yes
EVENTSERVER
Chapter 3. Server options 1291
EXPINTERVAL
The EXPINTERVAL option specifies the interval, in hours, between automatic
inventory expiration processes by Tivoli Storage Manager. Inventory expiration
removes client backup and archive file copies from the server as specified by the
management classes to which the client files are bound. If expiration is not run
periodically, storage pool space is not reclaimed from expired client files, and the
server requires more storage space than required by policy.
You can also use the EXPIRE INVENTORY command to start inventory expiration.
Expiration can make space available in your storage pools for additional client
backup or archive files.
You can update this server option without stopping and restarting the server by
using the SETOPT command. See SETOPT (Set a server option for dynamic
update) on page 1037.
Syntax
EXPINterval hours

Parameters
hours
Specifies the time, in hours, between automatic inventory expiration processes.
You can specify from 0 to 336 (14 days). A value of 0 means that expiration
must be started with the EXPIRE INVENTORY command. The default is 24.
Examples
expinterval 5
EXPINTERVAL

1292 IBM Tivoli Storage Manager for Windows: Administrators Reference
EXPQUIET
The EXPQUIET option specifies whether Tivoli Storage Manager sends detailed
messages during expiration processing.
You can update this server option without stopping and restarting the server by
using the SETOPT command. See SETOPT (Set a server option for dynamic
update) on page 1037.
Syntax
EXPQUiet No
Yes


Parameters
No
Specifies that the server sends detailed messages. This is the default.
Yes
Specifies that the server sends only minimal messages. These messages are sent
only for files that have expired based on the copy group in the default
management class or retention grace period for the domain.
Examples
expquiet no
EXPQUIET
Chapter 3. Server options 1293
FILEEXIT
The FILEEXIT option specifies a file to which enabled events are routed. Each
logged event is a record in the file.
Syntax
FILEEXIT No
Yes
file_name REPLACE
APPEND

PRESERVE


Parameters
Yes
Specifies that event logging to the file exit receiver begins automatically at
server startup.
No
Specifies that event logging to the file exit receiver does not begin
automatically at server startup. When this parameter has been specified, you
must begin event logging manually by issuing the BEGIN EVENTLOGGING
command.
file_name
Specifies the name of the file in which the events are stored.
REPLACE
Specifies that if the file already exists, it will be overwritten.
APPEND
Specifies that if the file already exists, data is appended to it.
PRESERVE
Specifies that if the file already exists, it will not be overwritten.
Examples
fileexit yes \tsm\server\data replace
FILEEXIT

1294 IBM Tivoli Storage Manager for Windows: Administrators Reference
FILETEXTEXIT
The FILETEXTEXIT option specifies a file to which enabled events are routed. Each
logged event is a fixed-size, readable line.
Syntax
FILETEXTEXIT No
Yes
file_name REPLACE
APPEND

PRESERVE


Parameters
Yes
Specifies that event logging to the file exit receiver begins automatically at
server startup.
No
Specifies that event logging to the file exit receiver does not begin
automatically at server startup. When this parameter has been specified, you
must begin event logging manually by issuing the BEGIN EVENTLOGGING
command.
file_name
Specifies the name of the file in which the events are stored.
REPLACE
Specifies that if the file already exists, it will be overwritten.
APPEND
Specifies that if the file already exists, data will be appended to it.
PRESERVE
Specifies that if the file already exists, it will not be overwritten.
Examples
filetextexit yes \tsm\server\data replace
FILETEXTEXIT
Chapter 3. Server options 1295
IDLETIMEOUT
The IDLETIMEOUT option specifies the amount of time, in minutes, that a client
session can be idle before the server cancels the session. You may want to increase
the time-out value to prevent clients from timing out if there is a heavy network
load in your environment. Note, however, that a large number of idle sessions
could prevent other users from connecting to the server.
You can update this server option without stopping and restarting the server by
using the SETOPT command. See SETOPT (Set a server option for dynamic
update) on page 1037.
Syntax
IDLETimeout minutes

Parameters
minutes
Specifies the maximum number of minutes that a server waits for an idle
client. The default value is 15 minutes. The minimum value is 1 minute.
Examples
idletimeout 15
IDLETIMEOUT

1296 IBM Tivoli Storage Manager for Windows: Administrators Reference
LANGUAGE
The LANGUAGE option controls the initialization of locales. A locale includes the
language and the date, time, and number formats to be used for the console and
server.
Note:
v If the initialization of the locale fails, the server defaults to American
English and uses the date, time, and number formats set by the
DATEFORMAT, TIMEFORMAT, and NUMBERFORMAT server options.
v If your client and server are running different languages, the messages
generated may not be understandable.
Syntax
LANGuage AMENG
locale


Parameters
AMENG
Specifies that American English will be used as the default language for the
server.
locale
Specifies the name of the locale supported by the server:

Locale Language
ptb Brazilian Portuguese
fra French
deu German
ita Italian
jpn Japanese
kor Korean
chs Simplified Chinese
esp Spanish
cht Traditional Chinese

Examples
lang jpn
LANGUAGE
Chapter 3. Server options 1297
LOGPOOLSIZE
The LOGPOOLSIZE option specifies the size, in kilobytes, of the recovery log
buffer pool. A large buffer pool may increase the rate by which recovery log
transactions are committed to the database, but it also requires more memory.
Syntax
LOGPoolsize kilobytes

Parameters
kilobytes
Specifies the size of the recovery log buffer pool in kilobytes. The minimum
value is 128. The maximum value is limited by available virtual memory size.
The default value is 512.
Examples
logpoolsize 128
LOGPOOLSIZE

1298 IBM Tivoli Storage Manager for Windows: Administrators Reference
LOGWARNFULLPERCENT
The LOGWARNFULLPERCENT option specifies the log utilization threshold at
which warning messages are issued.
You can update this server option without stopping and restarting the server by
using the SETOPT command. See SETOPT (Set a server option for dynamic
update) on page 1037.
Syntax
LOGWARNFULLPercent percent

Parameters
percent
Specifies the percentage of log utilization at which warning messages begin.
After messages begin, they are issued for every 2% increase in log utilization
until the utilization drops below the specified percentage. The default is 90.
The minimum value is 0; the maximum is 98.
Examples
Set the log utilization level at which warning messages begin to 60%:
Logwarnfullpercent 60
LOGWARNFULLPERCENT
Chapter 3. Server options 1299
MAXSESSIONS
The MAXSESSIONS option specifies the maximum number of simultaneous client
sessions that can connect with the server.
You can update this server option without stopping and restarting the server by
using the SETOPT command. See SETOPT (Set a server option for dynamic
update) on page 1037.
Syntax
MAXSessions number_of_sessions

Parameters
number_of_sessions
Specifies the maximum number of simultaneous client sessions. The default
value is 25 client sessions. The minimum value is 2 client sessions. The
maximum value is limited only by available virtual memory size or
communication resources.
Examples
maxsessions 25
MAXSESSIONS

1300 IBM Tivoli Storage Manager for Windows: Administrators Reference
MESSAGEFORMAT
The MESSAGEFORMAT option specifies whether a message number is displayed
in all lines of a multi-line message.
Syntax
MESsageformat number

Parameters
number
Select a number to specify if a message number is to be displayed only on the
first line of a multi-line message or is to be displayed on all lines.
1 The message number for a message is displayed only in the first line of
the message. This is the default.
2 The message number for a message is displayed in all lines of a
message.
Examples
messageformat 2
MESSAGEFORMAT
Chapter 3. Server options 1301
MIRRORREAD
The MIRRORREAD option specifies how mirrored volumes are to be accessed
when the server reads a recovery log or database page during normal processing.
The defaults are:
mirrorread log normal
mirrorread db normal
Syntax
MIRRORRead LOG
DB
Normal
Verify


Parameters
LOG
Specifies that this is the mode to be used for reading recovery log pages.
DB
Specifies that this is the mode to be used for reading database pages.
Normal
Specifies only one mirrored volume is read to obtain the desired page. This is
the default.
Verify
Specifies that the server read all mirror volumes for a page every time a
recovery log or database page is read. If an invalid page is encountered on a
mirror volume, it is automatically re-synchronized with valid contents from
another mirror volume. This mode decreases server performance since each
mirror volume for the page is accessed on every read.
Examples
Specify that the server read all mirror volumes for a page every time a recovery
log or database page is read:
mirrorread log verify
mirrorread db verify
MIRRORREAD

1302 IBM Tivoli Storage Manager for Windows: Administrators Reference
MIRRORWRITE
The MIRRORWRITE option specifies how mirrored volumes are accessed when the
server writes pages to the recovery log or database during normal processing.
The defaults are:
mirrorwrite db sequential
mirrorwrite log parallel
Syntax
MIRRORWrite LOG
DB
Sequential
Parallel


Parameters
LOG
Specifies that this is the mode to be used for writing recovery log pages
DB
Specifies that this is the mode to be used for writing database pages
Sequential
Specifies that the server writes to the mirrored volume one after another.
Server performance decreases because a successful I/O must occur before the
next write can occur.
Parallel
Specifies that the server writes to all mirrored volumes in parallel. This mode
allows all mirrors to obtain the new page at approximately the same time.
Note: If a system outage occurs at exactly the instant that each mirror is
partially complete in writing its page, a partial write to each mirror
could result.
Examples
Specify that the server writes to all mirrored database volumes in parallel and to
the mirrored log volumes one after another.
mirrorwrite db parallel
mirrorwrite log sequential
MIRRORWRITE
Chapter 3. Server options 1303
MOVEBATCHSIZE
The MOVEBATCHSIZE option specifies the number of client files that are to be
moved and grouped together in a batch, within the same server transaction. This
data movement results from storage pool backups and restores, migration,
reclamation, and MOVE DATA operations. This option works with the
MOVESIZETHRESH option.
Syntax
MOVEBatchsize number_of_files

Parameters
number_of_files
Specifies a number of files between 1 and 1000. The default is 1000.
Examples
movebatchsize 100
MOVEBATCHSIZE

1304 IBM Tivoli Storage Manager for Windows: Administrators Reference
MOVESIZETHRESH
The MOVESIZETHRESH option specifies, in megabytes, a threshold for the
amount of data moved as a batch, within the same server transaction. When this
threshold is reached, no more files are added to the current batch, and a new
transaction is started after the current batch is moved.
Syntax
MOVESizethresh megabytes

Parameters
megabytes
Specifies the number of megabytes as an integer from 1 to 2048. The default
value is 2048. This option works in conjunction with the MOVEBATCHSIZE
option.
Examples
movesizethresh 500
MOVESIZETHRESH
Chapter 3. Server options 1305
MSGINTERVAL
The MSGINTERVAL option specifies the time, in minutes, between messages
prompting an operator to mount a tape for the server.
Syntax
MSGINTerval minutes

Parameters
minutes
Specifies the time interval at which the operator is prompted by the server to
mount a tape. The default value is 1 minute. The minimum value is 1 minute.
Examples
msginterval 2
MSGINTERVAL

1306 IBM Tivoli Storage Manager for Windows: Administrators Reference
MSGSTACKTRACE
The MSGSTACKTRACE option allows the Tivoli Storage Manager server to display
helpful diagnostic data when certain messages are displayed. The default is ON.
Syntax
MSGSTACKTRACE ON
OFf


Parameters
ON
Specifies that a list of functions will be shown on the server console, and will
also be directed to the activity log after specific messages have been issued.
The output will help the Tivoli Storage Manager service team to diagnose
specific problems quicker. It is recommended that this option be set to ON.
OFf
Specifies that the output will not be issued.
Examples
msgstacktrace on
MSGSTACKTRACE
Chapter 3. Server options 1307
NAMEDPIPENAME
The NAMEDPIPENAME option specifies a communication method that allows
processes to communicate with one another without having to know where the
sender and receiver processes are located. The name acts like an alias, connecting
the two processes regardless of whether they are on the same computer or across
connected domains.
Syntax
NAMEDpipename name

Parameters
name
Specifies the named pipes name for the server to use. Named pipes are ideal
for running in an environment where client and server are on the same
machine. No communication software is required and no setup is required.
Examples
namedpipename \\.\PIPE\TSMPIPE
NAMEDPIPENAME

1308 IBM Tivoli Storage Manager for Windows: Administrators Reference
NDMPCONTROLPORT
The NDMPCONTROLPORT option specifies the port number to be used for
internal communications for certain NDMP operations. The Tivoli Storage Manager
server does not function as a general purpose NDMP tape server.
Syntax
NDMPControlport port_number

Parameters
port_number
The port number to be used for internal communications for certain NDMP
operations. The port number must be from 1024 to 32767. The default is 10000.
Examples
ndmpcontrolport 9999
NDMPCONTROLPORT
Chapter 3. Server options 1309
NDMPPORTRANGE
The NDMPPORTRANGE option specifies the range of port numbers through
which Tivoli Storage Manager cycles to obtain a port number for accepting a
session from a NAS device for data transfer. The default is 0,0 which means that
Tivoli Storage Manager lets the operating system provide a port (ephemeral port).
If all ports specified are in use when a NAS device attempts to connect to the
server, the operation fails. If a single port number is chosen (no comma and no
port number for the high value), the default for the high port number is the low
port number plus 100.
When NDMP data is directed to a Tivoli Storage Manager native pool,
communication can be initiated from either the NDMP systems or the Tivoli
Storage Manager server. If a firewall separates the server and NAS devices, it may
be necessary to specify port numbers in firewall rules to allow traffic to pass to
and from the NAS devices. NAS devices communicate to the Tivoli Storage
Manager server the port numbers that they will use when contacting the server.
The port numbers of the server are controlled with the NDMPPortrange options.
Port number control for NAS devices is specific to vendors. Consult your vendor
documentation.
Syntax
NDMPPortrange port_number_low
,port_number_high


Parameters
port_number_low
The low port number from which Tivoli Storage Manager starts to cycle when
needing a port number for accepting session from a NAS device for data
transfer. The minimum port number value is 1024.
port_number_high
The high port number to which Tivoli Storage Manager can cycle when
needing a port number for accepting session from a NAS device for data
transfer. The maximum port number value is 32767. The high port number
must be the same or larger than the low port number.
Examples
Specify that Tivoli Storage Manager can cycle from port numbers 10 through 1000.
ndmpportrange 10,1000
NDMPPORTRANGE

1310 IBM Tivoli Storage Manager for Windows: Administrators Reference
NOPREEMPT
The server allows certain operations to preempt other operations for access to
volumes and devices. You can specify the NOPREEMPT option to disable
preemption. When preemption is disabled, no operation can preempt another for
access to a volume, and only a database backup operation can preempt another
operation for access to a device.
For example, a client data restore operation preempts a client data backup for use
of a specific device or access to a specific volume. See the Administrators Guide for
details.
Syntax
NOPREEMPT

Parameters
None
Examples
Disable preemption among server operations:
nopreempt
NOPREEMPT
Chapter 3. Server options 1311
NORETRIEVEDATE
The NORETRIEVEDATE option specifies that the server does not update the
retrieve date of a file in a disk storage pool when a client restores or retrieves the
file. This option and the MIGDELAY storage pool parameter control when the
server migrates files.
If you do not specify NORETRIEVEDATE, the server migrates files after they have
been in the storage pool for the number of days specified by the MIGDELAY
parameter. The number of days is counted from the day that the file was stored in
the storage pool or retrieved by a client, whichever is more recent. If you specify
NORETRIEVEDATE, the server does not update the retrieve date of a file, and the
number of days is counted from the day the file entered the disk storage pool.
If you specify this option and caching is enabled for a disk storage pool,
reclamation of cached space is affected. When space is needed in a disk storage
pool that contains cached files, the server gets the space by selectively erasing
cached copies. Files that have the oldest retrieve dates and occupy the largest
amount of space are selected for removal. When you specify NORETRIEVEDATE,
the server does not update the retrieve date when a file is retrieved. This may
cause cached copies to be removed even though they have recently been retrieved
by a client.
Syntax
NORETRIEVEDATE

Parameters
None.
Examples
Specify that the retrieve dates of files in disk storage pools are not updated when
clients restore and retrieve the files:
noretrievedate
NORETRIEVEDATE

1312 IBM Tivoli Storage Manager for Windows: Administrators Reference
NPAUDITFAILURE
The NPAUDITFAILURE option specifies whether an event is sent to the event log
when a node logs in to the server using a name that is in the Windows group but
does not match the Windows account login name. To ensure that a node can access
only its own data, the node name and the Windows account name must match.
Syntax
NPAUDITFailure Yes
No


Parameters
Yes
Specifies that an event is sent to the event log when a node logs in to the
server using a name that is in the Windows group. But, this name does not
match the Windows account login name.
No
Specifies that an audit failure event is not sent to the event log.
Examples
Specify that an event is sent to the event log when a node logs in to the server
using a name that is in the Windows group. But, this name does not match the
Windows account login name.
npauditfailure yes
NPAUDITFAILURE
Chapter 3. Server options 1313
NPAUDITSUCCESS
The NPAUDITSUCCESS option specifies that an event is sent to the event log
when a client node user is authenticated for access to the server through
SECUREPIPE.
Syntax
NPAUDITSuccess Yes
No


Parameters
Yes
Specifies that an event is sent to the event log when a client node user is
authenticated for access to the server through SECUREPIPES.
No
Specifies that an event is not sent to the Windows log.
Examples
Specify that an event is sent to the event log when a client node is authenticated
for access to the server.
npauditsuccess yes
NPAUDITSUCCESS

1314 IBM Tivoli Storage Manager for Windows: Administrators Reference
NPBUFFERSIZE
The NPBUFFERSIZE option specifies the size of the Named Pipes communication
buffer.
Syntax
NPBUFfersize kilobytes

Parameters
kilobytes
Specifies the size, in kilobytes, of the Named Pipes communication buffer. The
default is 8.
Examples
Specify a 16KB Named Pipes communication buffer:
npbuffersize 16
NPBUFFERSIZE
Chapter 3. Server options 1315
NUMBERFORMAT
The NUMBERFORMAT option specifies the number format that the server
displays.
Note: The NUMBERFORMAT is overridden by the number formatting definition
of the locale if the locale is successfully initialized at server startup. The
locale is specified in the LANGUAGE option.
Syntax
NUMberformat number

Parameters
number
Select a number from 1 to 6 to identify the number format used by the server.
The default is 1.
1 1,000.00
2 1,000,00
3 1 000,00
4 1 000.00
5 1.000,00
6 1000,00
Examples
numberformat 4
NUMBERFORMAT

1316 IBM Tivoli Storage Manager for Windows: Administrators Reference
QUERYAUTH
The QUERYAUTH option specifies the administrative authority level required to
issue QUERY or SQL SELECT commands. By default any administrator can issue
QUERY and SELECT commands. You can use this option to restrict the use of
these commands.
Syntax
QUERYAuth NOne
SYstem

POlicy

STorage

OPerator

ANalyst


Parameters
NOne
Any administrator can issue QUERY or SELECT commands without requiring
any administrative authority.
SYstem
Administrators must have SYSTEM authority to issue QUERY or SELECT
commands.
POlicy
Administrators must have POLICY authority over one or more policy domains
or SYSTEM authority to issue QUERY or SELECT commands.
STorage
Administrators must have STORAGE authority over one or more storage pools
or SYSTEM authority to issue QUERY or SELECT commands.
OPerator
Administrators must have OPERATOR or SYSTEM authority to issue QUERY
or SELECT commands.
ANalyst
Administrators must have ANALYST or SYSTEM authority to issue QUERY or
SELECT commands.
Examples
To restrict the use of QUERY and SELECT commands to administrators with
system or storage authority, enter:
queryauth storage
QUERYAUTH
Chapter 3. Server options 1317
REPORTRETRIEVE
The REPORTRETRIEVE option reports on restore or retrieve operations that are
performed by client nodes or administrators. The default is NO.
Syntax
REPORTRETRIEVE YES
NO


Parameters
YES
Specifies that messages will be issued to the server console and stored in the
activity log whenever files are restored or retrieved from the Tivoli Storage
Manager server. The messages will specify the name of the objects being
restored or retrieved and identify the client node or administrator performing
the operation.
NO
Specifies that messages will not be issued.
Examples
Specify that messages will be issued and stored in the activity log whenever files
are restored or retrieved from the IBM Tivoli Storage Manager server:
reportretrieve yes
The following message is issued for an administrator client session:
ANR0411I Session 8 for administrator COLIND-TUC logged in as node
COLIND-TUC restored or retrieved Backup object: node COLIND-TUC,
filespace \\colind-tuc\c$, object\CODE\TESTDATA\ XXX.OUT
REPORTRETRIEVE

1318 IBM Tivoli Storage Manager for Windows: Administrators Reference
REQSYSAUTHOUTFILE
The REQSYSAUTHOUTFILE option specifies if system authority is required for
administrative commands that cause Tivoli Storage Manager to write to an external
file.
This option applies to the following commands:
v BACKUP DEVCONFIG with the FILENAMES parameter
v BACKUP VOLHISTORY with the FILENAMES parameter
v DEFINE BACKUPSET
v DELETE BACKUPSET
v MOVE DRMEDIA with the CMD parameter
v MOVE MEDIA with the CMD parameter
v QUERY DRMEDIA with the CMD parameter
v QUERY MEDIA with the CMD parameter
v QUERY SCRIPT with the OUTPUTFILE parameter
Syntax
REQSYSauthoutfile Yes
No


Parameters
Yes
System authority is required for administrative commands that cause Tivoli
Storage Manager to write to an external file.
No
System authority is not required for administrative commands that cause Tivoli
Storage Manager to write to an external file. That is, there is no change to the
authority level that is required to issue the command.
Examples
reqsysauthoutfile no
REQSYSAUTHOUTFILE
Chapter 3. Server options 1319
RESOURCETIMEOUT
The RESOURCETIMEOUT option specifies how long the server waits for a
resource before canceling the pending acquisition of a resource. When a timeout
occurs the request for the resource will be canceled.
Note: When managing a set of shared library resources, such as servers designated
as library managers and clients, consider setting this option at the same time
limit for all participants in the shared configuration. In any case of error
recovery, Tivoli Storage Manager will always defer to the longest time limit.
Syntax
RESOURCETimeout minutes

Parameters
minutes
Specifies the maximum number of minutes that the server waits for a resource.
The default value is 60 minutes. The minimum value is 1 minute.
Examples
Specify that the server will wait 15 minutes for a server resource:
resourcetimeout 15
RESOURCETIMEOUT

1320 IBM Tivoli Storage Manager for Windows: Administrators Reference
RESTOREINTERVAL
The RESTOREINTERVAL option specifies how long a restartable restore session
can be saved in the server database. As long as the restore session is saved in the
database, it can be restarted from the point at which it stopped.
You can update this server option without stopping and restarting the server by
using the SETOPT command. See SETOPT (Set a server option for dynamic
update) on page 1037.
Syntax
RESTOREINTERVAL minutes

Parameters
minutes
Specifies how long, in minutes, that a restartable restore session can be in the
database before it can be expired. The minimum value is 0. The maximum is
10080 (one week). The default is 1440 minutes (24 hours). If the value is set to
0 and the restore is interrupted or fails, the restore is still put in the restartable
state. However, it is immediately eligible to be expired.
Examples
restoreinterval 1440
RESTOREINTERVAL
Chapter 3. Server options 1321
RETENTIONEXTENSION
The RETENTIONEXTENSION option specifies the number of days to extend the
retention date of a SnapLock volume. This option allows the server to extend the
retention date of a SnapLock volume in order to avoid excessive reclamation.
Syntax
RETENTIONEXTENSION number_of_days

Parameters
number_of_days
Specifies the number of days to extend the retention date of a SnapLock
volume. The minimum value is 30 days; the maximum value is 9999 days; the
default
If a SnapLock volume is the target volume for data from another SnapLock
volume and if the remaining retention of the data on the volume is less than
the value specified, then the retention date is set using the value specified.
Otherwise, the remaining retention of the data is used to set the retention of
the volume.
If a SnapLock volume has entered the reclamation period but the percentage of
reclaimable space of the volume has not exceeded the reclamation threshold of
the storage pool or the value specified on the THRESHOLD parameter of a
RECLAIM STGPOOL command, then the retention date of the SnapLock
volume is extended by the amount specified in the RETENTIONEXTENSION
option.
Examples
Specify that the retention date is extended by 60 days:
retentionextension 60
RETENTIONEXTENSION

1322 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
|
|
|||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SANDISCOVERY
The SANDISCOVERY option specifies whether the Tivoli Storage Manager SAN
discovery function is enabled.
When set to ON, the server will perform SAN discovery in the following instances:
v During server initialization
v When the device path has been changed
v When the QUERY SAN command is issued
Using SAN discovery, the server can automatically correct the devices special file
name if it has been changed.
The Tivoli Storage Manager server does not require persistent binding with the
SAN discovery function enabled. To display a list of devices seen by the server,
you can issue the QUERY SAN command.
Note: To use SAN discovery, every device on the SAN must have a unique
worldwide name (WWN). Some virtual tape libraries use the same WWN
for all of their drives. SAN discovery will fail for these libraries. If this
happens, set the SANDISCOVERY option to OFF and manually define or
update the drive paths. If the virtual tape library provides no WWNs, SAN
discovery will attempt to use serial numbers to identify the drives.
Syntax
SANDISCOVERY ON
OFF


Parameters
ON
With this option specified, the server will perform SAN discovery during
server initialization, when the device path has been changed, or when the
QUERY SAN command is issued. This is the default.
OFF
With this option specified, the server will not perform SAN discovery during
the server initialization, when the device path has been changed, or when the
QUERY SAN command is issued.
Examples
sandiscovery on
SANDISCOVERY
Chapter 3. Server options 1323
|
|
|
|
|
|
SANREFRESHTIME
The SANREFRESHTIME option specifies the amount of time that elapses before
the cached SAN discovery information is refreshed. The SANREFRESHTIME
option has a default value of 0, which means there is no SAN discovery cache.
Each time the server performs a SAN discovery operation, the information is
obtained directly from the HBA.
Note: The QUERY SAN server command always receives SAN information at the
time the command is issued and ignores any value specified for
SANREFRESHTIME.
Syntax
SANREFRESHTIME time

Parameters
time
The length of time, in seconds, before the cached SAN discovery information is
refreshed. The default value is 0 and specifies that SAN discovery information
is not cached. If a value other than 0 is specified, for example, 100 seconds,
then the SAN discovery information is refreshed 100 seconds after the prior
SAN discovery operation.
Examples
Refresh SAN discovery information after 100 seconds.
SANREFRESHTIME 100
Turn off the caching of SAN discovery information.
SANREFRESHTIME 0
SANREFRESHTIME

1324 IBM Tivoli Storage Manager for Windows: Administrators Reference
SEARCHMPQUEUE
The SEARCHMPQUEUE option specifies the order in which the server satisfies
requests in the mount queue. If the option is specified, the server first tries to
satisfy requests for volumes that are already mounted. These requests may be
satisfied before other requests, even if the others have been waiting longer for the
mount point. If this option is not specified, the server satisfies requests in the order
in which they are received.
Syntax
SEARCHMPQUEUE

Parameters
None
Examples
Specify that the server tries to first satisfy a request for a volume that is already
mounted:
searchmpqueue
SEARCHMPQUEUE
Chapter 3. Server options 1325
SECUREPIPES
When using the named pipes protocol, enabling SECUREPIPES forces the server to
check the Windows group designated by ADSMGROUPNAME in order to
authenticate a client node/user.
The user name and password defined in the Windows group are used to
authenticate the node/user for access to the server data. The node/user must also
be a registered Tivoli Storage Manager client node. However, the Tivoli Storage
Manager client node password is ignored, and the Windows password associated
with the user is used.
Syntax
SECUREPipes Yes
No


Parameters
Yes
Specifies that Tivoli Storage Manager checks the Windows group designated by
ADSMGROUPNAME in order to authenticate a client node/user.
No
Specifies that Tivoli Storage Manager does not check the Windows group
designated by ADSMGROUPNAME in order to authenticate a client
node/user.
Examples
Specify that Tivoli Storage Manager checks the Windows group to authenticate
client nodes.
securepipes yes
SECUREPIPES

1326 IBM Tivoli Storage Manager for Windows: Administrators Reference
SELFTUNEBUFPOOLSIZE
The SELFTUNEBUFPOOLSIZE option specifies whether Tivoli Storage Manager
can automatically tune the database buffer pool size. If you specify YES, Tivoli
Storage Manager resets the buffer cache hit statistics at the start of expiration
processing. The default is NO.
After expiration completes, if cache hit statistics are less than 98%, Tivoli Storage
Manager increases the database buffer pool size to try to increase the cache hit
percentage.
Syntax
SELFTUNEBUFpoolsize Yes
No


Parameters
Yes
Specifies that Tivoli Storage Manager can automatically tune the size of the
database buffer pool.
No
Specifies that Tivoli Storage Manager does not automatically tune the size of
the database buffer pool.
Examples
Specify that Tivoli Storage Manager can automatically tune the size of the database
buffer pool:
selftunebufpoolsize yes
SELFTUNEBUFPOOLSIZE
Chapter 3. Server options 1327
SHMPORT
The SHMPORT option specifies the port that the server listens on for shared
memory connections.
Syntax
SHMPort port_number

Parameters
port_number
Specifies the port number. You can specify a value from 1 to 32767. The default
value is 1.
Examples
shmport 1
SHMPORT

1328 IBM Tivoli Storage Manager for Windows: Administrators Reference
SHREDDING
The SHREDDING option specifies whether shredding of deleted sensitive data is
performed automatically or manually. Shredding applies only to data in storage
pools that have been explicitly configured to support shredding.
Syntax
SHREDding AUTOmatic
MANual


Parameters
AUTOmatic
Specifies that shredding occurs automatically as sensitive data is deleted. Use
this option to shred sensitive data as soon as possible after it is deleted. If the
SHREDDING option is not specified, this is the default behavior. If there is an
I/O error during automatic shredding, an error is reported, and shredding of
the current object halts. If the I/O error cannot be corrected, you might need to
run shredding manually and use the IOERROR keyword.
MANual
Specifies that shredding occurs manually, only when the SHRED DATA
command is invoked. Use this option to control when shredding takes place, in
order to ensure that it does not interfere with other server activities.
Examples
Specify that Tivoli Storage Manager automatically shreds data in a storage pool
configured for shredding after that data is deleted:
shredding automatic
SHREDDING
Chapter 3. Server options 1329
SNMPHEARTBEATINTERVAL
The SNMPHEARTBEATINTERVAL option specifies the interval in minutes
between queries of the Tivoli Storage Manager server.
Syntax
SNMPHEARTBEATINTERVAL minutes

Parameters
minutes
Specifies the heartbeat interval in minutes. Valid values are from 0 to 1440 (1
day). The default is 5 minutes.
Examples
snmpheartbeatinterval 20
SNMPHEARTBEATINTERVAL

1330 IBM Tivoli Storage Manager for Windows: Administrators Reference
SNMPMESSAGECATEGORY
The SNMPMESSAGECATEGORY option specifies the trap types used when
messages are forwarded from the server, through the SNMP subagent, to the
SNMP manager.
Syntax
SNMPMESSAGECATEGORY SEVERITY
INDIVIDUAL


Parameters
SEVERITY
Specifies that there are four trap types based on message severity level:
1 Severe
2 Error
3 Warning
4 Information
This is the default.
INDIVIDUAL
Specifies that a separate trap type is used for each message. The numeric part
of the message identifier indicates the trap type.
Examples
snmpmessagecategory individual
SNMPMESSAGECATEGORY
Chapter 3. Server options 1331
SNMPSUBAGENT
The SNMPSUBAGENT option specifies the parameters needed for the Tivoli
Storage Manager subagent to communicate with the SNMP daemon. This option is
only to configure the SNMP subagent for communicating with the SNMP agent; it
is ignored by the server.
Syntax
SNMPSUBAGENT
HOSTname

host_name

COMMunityname

community_name

TIMEOUT

seconds


Parameters
HOSTname host_name
Specifies the TCP/IP name or number of the host running the SNMP agent
that the Tivoli Storage Manager SNMP subagent connects to. This parameter is
optional. The default name is localhost.
COMMunityname community_name
Specifies the configured community name on the system running the SNMP
agent. This parameter is optional. The default name is public.
TIMEOUT seconds
Specifies the time, in seconds, in which a request must be received. This
parameter is optional. The default value is 600.
Examples
snmpsubagent hostname jimbo communityname public timeout 2600
SNMPSUBAGENT

1332 IBM Tivoli Storage Manager for Windows: Administrators Reference
SNMPSUBAGENTHOST
The SNMPSUBAGENTHOST option specifies the location of the Tivoli Storage
Manager SNMP subagent. The default for this option is 127.0.0.1.
Syntax
SNMPSUBAGENTHOST host_name

Parameters
host_name
Specifies the TCP/IP host name or number on which the Tivoli Storage
Manager SNMP subagent is located. The subagent and server must be on the
same node.
Examples
snmpsubagenthost 9.116.23.450
SNMPSUBAGENTHOST
Chapter 3. Server options 1333
SNMPSUBAGENTPORT
The SNMPSUBAGENTPORT option specifies the port number of the Tivoli Storage
Manager SNMP subagent.
Syntax
SNMPSUBAGENTPORT port_number

Parameters
port_number
Specifies the port number of the Tivoli Storage Manager SNMP subagent. Valid
values are from 1024 to 32767. The default is 1521.
Examples
snmpsubagentport 1525
SNMPSUBAGENTPORT

1334 IBM Tivoli Storage Manager for Windows: Administrators Reference
SSLTCPADMINPORT
The SSLTCPADMINPORT option specifies the port address on which the server
TCP/IP communication driver waits for requests for SSL-enabled sessions for the
command line administrative client
The following types of sessions do not use SSL: Server-to-server, NDMP, ACSLS,
SNMP subagent, storage agent, library client, managed server, and event server.
If the ADMINONCLIENTPORT option is set to NO, SSL-enabled sessions for the
administrative client require SSLTCPADMINPORT with a port number other than
that specified by the SSLTCPPORT option. The SSLTCPADMINPORT option does
not affect the TCPPORT or TCPADMINPORT options and their interaction with the
ADMINONCLIENTPORT option.
The TCP/IP communications driver must be enabled with COMMMETHOD
TCPIP or COMMMETHOD V6TCPIP.
Syntax
SSLTCPADMINPORT port_number

Parameters
port_number
Specifies the port number of the server. There is no default.
Examples
SSLTCPADMINPORT 1543
SSLTCPADMINPORT
Chapter 3. Server options 1335
SSLTCPPORT
The SSLTCPPORT option specifies the SSL-only port number on which the server
TCP/IP communication driver waits for requests for SSL-enabled sessions for the
command line backup-archive client and the command line administrative client.
The following types of sessions do not use SSL: Server-to-server, NDMP, ACSLS,
SNMP subagent, storage agent, library client, managed server, and event server.
If the ADMINONCLIENTPORT option is set to NO, SSL-enabled sessions for the
administrative client require SSLTCPADMINPORT with a port number other than
that specified by the SSLTCPPORT option. The SSLTCPPORT option does not affect
the TCPPORT or TCPADMINPORT options and their interaction with the
ADMINONCLIENTPORT option.
The TCP/IP communications driver must be enabled with COMMMETHOD
TCPIP or COMMMETHOD V6TCPIP.
Syntax
SSLTCPPORT port_number

Parameters
port_number
Specifies the port number of the server. There is no default.
Examples
SSLTCPPORT 1542
SSLTCPPORT

1336 IBM Tivoli Storage Manager for Windows: Administrators Reference
TCPADMINPORT
The TCPADMINPORT option specifies the port number on which the server
TCP/IP communication driver is to wait for requests for sessions other than client
sessions. This includes administrative sessions, server-to-server sessions, SNMP
subagent sessions, storage agent sessions, library client sessions, managed server
sessions, and event server sessions.
Using different port numbers for the options TCPPORT and TCPADMINPORT
enables you to create one set of firewall rules for client sessions and another set for
the other session types listed above. By using the SESSIONINITIATION parameter
of REGISTER and UPDATE NODE, you can close the port specified by TCPPORT
at the firewall, and specify nodes whose scheduled sessions will be started from
the server. If the two port numbers are different, separate threads will be used to
service client sessions and the session types. If you allow the two options to use
the same port number (by default or by explicitly setting them to the same port
number), a single server thread will be used to service all session requests. Client
sessions which attempt to use the port specified by TCPADMINPORT will be
terminated (if TCPPORT and TCPADMINPORT specify different ports).
Administrative sessions are allowed on either port, (unless the
ADMINONCLIENTPORT option is set to NO) but by default will use the port
specified by TCPADMINPORT.
Syntax
TCPADMINPort port_number

Parameters
port_number
Specifies the port number of the server. The default is the value of TCPPORT.
Examples
tcpadminport 1502
TCPADMINPORT
Chapter 3. Server options 1337
TCPNODELAY
The TCPNODELAY option specifies whether the server disables the delay of
sending successive small packets on the network.
Change the value from the default of YES only under one of these conditions:
v You are directed to change the option by your service representative.
v You fully understand the effects of the TCP Nagle algorithm on network
transmissions. Setting the option to NO enables the Nagle algorithm, which
delays sending small successive packets.
Syntax
TCPNodelay Yes
No


Parameters
Yes
Specifies that the server allows successive small packets to be sent immediately
over the network. Setting this option to YES might improve performance in
some high-speed networks. The default is YES.
No
Specifies that the server does not allow successive small packets to be sent
immediately over the network.
Examples
tcpnodelay no
TCPNODELAY

1338 IBM Tivoli Storage Manager for Windows: Administrators Reference
TCPPORT
The TCPPORT option specifies the port number on which the server TCP/IP
communication driver is to wait for requests for client sessions.
Using different port numbers for the options TCPPORT and TCPADMINPORT
enables you to create one set of firewall rules for client sessions and another set for
other session types (administrative sessions, server-to-server sessions, SNMP
subagent sessions, storage agent sessions, library client sessions, managed server
sessions, and event server sessions). If the two port numbers are different, separate
threads will be used to service client sessions and the other session types. If you
allow the two options to use the same port number (by default or by explicitly
setting them to the same port number), a single server thread will be used to
service all session requests.
Syntax
TCPPort port_number

Parameters
port_number
Specifies the port number of the server. The default value is 1500.
Examples
tcpport 1500
TCPPORT
Chapter 3. Server options 1339
TCPWINDOWSIZE
The TCPWINDOWSIZE option specifies, in kilobytes, the amount of receive data
that can be buffered at one time on a TCP/IP connection. The sending host cannot
send more data until it receives an acknowledgment and a TCP receive window
update. Each TCP packet contains the advertised TCP receive window on the
connection. A larger window lets the sender continue sending data, and may
improve communication performance, especially on fast networks with high
latency.
Note:
1. To improve backup performance, increase the TCPWINDOWSIZE on the
server. To improve restore performance, increase the TCPWINDOWSIZE
on the client.
2. The TCP window acts as a buffer on the network.
3. A window size larger than the buffer space on the network adapter
might degrade throughput due to resending packets that were lost on
the adapter.
Syntax
TCPWindowsize kilobytes

Parameters
kilobytes
Specifies the size you want to use, in kilobytes, for the TCP/IP sliding window
for your client node. You can specify a value from 0 to 2048. The default is 63.
If you specify 0, the server uses the default window size set by the operating
system. Values from 1 to 2048 indicate that the window size is in the range of
1KB to 2MB.
Examples
tcpwindowsize 8
TCPWINDOWSIZE

1340 IBM Tivoli Storage Manager for Windows: Administrators Reference
TECBEGINEVENTLOGGING
The TECBEGINEVENTLOGGING option specifies whether event logging for the
Tivoli receiver should begin when the server starts up. If the TECHOST option is
specified, TECBEGINEVENTLOGGING defaults to YES.
Syntax
TECBegineventlogging Yes
No


Parameters
Yes
Specifies that event logging begins when the server starts up and if a
TECHOST option is specified.
No
Specifies that event logging should not begin when the server starts up. To
later begin event logging to the Tivoli receiver (if the TECHOST option has
been specified), you must issue the BEGIN EVENTLOGGING command.
Examples
tecbegineventlogging yes
TECBEGINEVENTLOGGING
Chapter 3. Server options 1341
TECHOST
The TECHOST option specifies the host name or IP address for the Tivoli event
server.
Syntax
TECHost host_name

Parameters
host_name
Specifies the host name or IP address for the Tivoli event server.
Examples
techost 9.114.22.345
TECHOST

1342 IBM Tivoli Storage Manager for Windows: Administrators Reference
TECPORT
The TECPORT option specifies the TCP/IP port address on which the Tivoli event
server is listening. This option is only required if the Tivoli event server is on a
system that does not have a Port Mapper service running.
Syntax
TECPort port_number

Parameters
port_number
Specifies the Tivoli event server port address. The value must be between 0
and 32767.
Examples
tecport 1555
TECPORT
Chapter 3. Server options 1343
TECUTF8EVENT
The TECUTF8EVENT option allows the Tivoli Storage Manager administrator to
send information to the Tivoli Enterprise Console (TEC) server in UTF8 data
format. The default is No. QUERY OPTION displays whether or not this option is
enabled.
Syntax
TECUTF8event Yes
No


Parameters
Yes
Specifies that the Tivoli Storage Manager server will encode the TEC event into
UTF8 before issuing the event to the TEC server.
No
Specifies that Tivoli Storage Manager server will not encode the TEC event into
UTF8 and it will be issued to the TEC server in ASCII format.
Examples
tecutf8event yes
TECUTF8EVENT

1344 IBM Tivoli Storage Manager for Windows: Administrators Reference
THROUGHPUTDATATHRESHOLD
The THROUGHPUTDATATHRESHOLD option specifies a throughput threshold
that a client session must reach to prevent being cancelled after the time threshold
is reached. The time threshold is the value set by the
THROUGHPUTTIMETHRESHOLD server option plus the media wait time. The
time threshold starts when the client begins sending data to the server for storage
(as opposed to setup or session housekeeping data).
You can update this server option without stopping and restarting the server by
using the SETOPT command. See SETOPT (Set a server option for dynamic
update) on page 1037.
Syntax
THROUGHPUTDatathreshold kilobytes_per_second

Parameters
kilobytes_per_second
Specifies the throughput that client sessions must achieve to prevent
cancellation after THROUGHPUTTIMETHRESHOLD minutes have elapsed.
This threshold does not include time spent waiting for media mounts. A value
of 0 prevents examining client sessions for insufficient throughput. Throughput
is computed by adding send and receive byte counts and dividing by the
length of the session. The length does not include time spent waiting for media
mounts and starts at the time a client sends data to the server for storage. The
default is 0. The minimum value is 0; the maximum is 99999999.
Note: This option is used in conjunction with the
THROUGHPUTTIMETHRESHOLD server option.
Examples
Specify that the server is to wait until 90 minutes plus the media wait time after a
session has started sending data before storage examines it as a candidate for
cancellation due to low throughput. If a session is not achieving 50KB per second
in transfer rates, it will be cancelled.
throughputtimethreshold 90
Throughputdatathreshold 50
THROUGHPUTDATATHRESHOLD
Chapter 3. Server options 1345
THROUGHPUTTIMETHRESHOLD
The THROUGHPUTTIMETHRESHOLD option specifies the time threshold for a
session after which it may be cancelled for low throughput.
You can update this server option without stopping and restarting the server by
using the SETOPT command. See SETOPT (Set a server option for dynamic
update) on page 1037.
Syntax
THROUGHPUTTimethreshold minutes

Parameters
minutes
Specifies the threshold for examining client sessions and cancelling them if the
data throughput threshold is not met (see the
THROUGHPUTDATATHRESHOLD server option). This threshold does not
include time spent waiting for media mounts. The time threshold starts when a
client begins sending data to the server for storage (as opposed to setup or
session housekeeping data). A value of 0 prevents examining client sessions for
low throughput. The default is 0. The minimum value is 0; the maximum is
99999999.
Examples
Specify that the server is to wait until 90 minutes plus the media wait time after a
session has started sending data before examining it as a candidate for
cancellation. If a session is not achieving 50 thousand bytes per second in transfer
rates, it will be cancelled.
throughputtimethreshold 90
Throughputdatathreshold 50
THROUGHPUTTIMETHRESHOLD

1346 IBM Tivoli Storage Manager for Windows: Administrators Reference
TIMEFORMAT
The TIMEFORMAT option specifies the format in which time is displayed by the
server.
Note: The TIMEFORMAT is overridden by the time formatting definition of the
locale if the locale is successfully initialized at server startup. The locale is
specified in the LANGUAGE option.
Syntax
TIMEformat format_number

Parameters
format_number
Select a number from 1 to 4 to identify the time format used by the server. The
default is 1.
1 hh:mm:ss
2 hh,mm,ss
3 hh.mm.ss
4 hh:mm:ss a.m and p.m.
Examples
timeformat 4
TIMEFORMAT
Chapter 3. Server options 1347
TXNGROUPMAX
The TXNGROUPMAX option specifies the number of objects that are transferred as
a group between a client and the server between transaction commit points. The
minimum value is 4 objects and the maximum value is 65000 objects. The default
value is 256 objects. The objects transferred are actual files, directories, or both. The
server counts each file or directory as one object.
It is possible to affect the performance of client backup, archive, restore, and
retrieve operations by using a larger value for this option:
1. If you increase the value of the TXNGROUPMAX option by a large amount,
watch for possible effects on the recovery log. A larger value for the
TXNGROUPMAX option can result in increased utilization of the recovery log,
as well as an increased length of time for a transaction to commit. If the effects
are severe enough, they can lead to problems with operation of the server. For
more information on managing the recovery log, see the Administrators Guide.
2. Increasing the value of the TXNGROUPMAX option can improve throughput
for operations storing data directly to tape, especially when storing a large
number of objects. However, a larger value of the TXNGROUPMAX option can
also increase the number of objects that must be resent in the case where the
transaction is aborted because an input file changed during backup, or because
a new storage volume was required. The larger the value of the
TXNGROUPMAX option, the more data must be resent.
3. Increasing the TXNGROUPMAX value will affect the responsiveness of
stopping the operation and the client may will have to wait longer for the
transaction to complete.
You can override the value of this option for individual client nodes. See the
TXNGROUPMAX parameter in REGISTER NODE (Register a node) on page 903
and UPDATE NODE (Update node attributes) on page 1158.
This option is related to the TXNBYTELIMIT option in the client options file.
TXNBYTELIMIT controls the number of bytes, as opposed to the number of
objects, that are transferred between transaction commit points. At the completion
of transferring an object, the client commits the transaction if the number of bytes
transferred during the transaction reaches or exceeds the value of TXNBYTELIMIT,
regardless of the number of objects transferred.
Syntax
TXNGroupmax number_of_objects

Parameters
number_of_objects
Specifies a number from 4 to 65000 for the maximum number of objects per
transaction. The default is 256.
Examples
txngroupmax 50
TXNGROUPMAX

1348 IBM Tivoli Storage Manager for Windows: Administrators Reference
UNIQUETDPTECEVENTS
The UNIQUETDPTECEVENTS option generates a unique Tivoli Enterprise Console
(TEC) event class for each individual Tivoli Storage Manager message, including
client, server, and Tivoli Data Protection (TDP) agent messages. The default is No.
Syntax
UNIQUETDPtecevents Yes
No


Parameters
Yes
Specifies that unique TDP messages are sent to the TEC event server.
Dynamically sets UNIQUETECevents to YES.
No
Specifies that general messages are sent to the TEC event server.
Examples
uniquetdptecevents yes
UNIQUETDPTECEVENTS
Chapter 3. Server options 1349
UNIQUETECEVENTS
The UNIQUETECEVENTS option generates a unique Tivoli Enterprise Console
(TEC) event class for each individual Tivoli Storage Manager message. The default
is No.
Syntax
UNIQUETECevents Yes
No


Parameters
Yes
Specifies that unique messages are sent to the TEC event server.
No
Specifies that general messages are sent to the TEC event server.
Examples
uniquetecevents yes
UNIQUETECEVENTS

1350 IBM Tivoli Storage Manager for Windows: Administrators Reference
USEREXIT
The USEREXIT option specifies a user-defined exit that will be given control to
handle an event.
Syntax
USEREXIT Yes
No
DLL_name function

Parameters
Yes
Specifies that event logging to the user exit receiver begins automatically at
server startup.
No
Specifies that event logging to the user exit receiver does not begin
automatically at server startup. When this parameter has been specified, you
must begin event logging manually by issuing the BEGIN EVENTLOGGING
command.
DLL_name
Specifies the DLL name that contains the user-exit function.
function
Specifies the name of the user-exit function in the DLL.
Examples
userexit yes dllname.dll dllmodulename
USEREXIT
Chapter 3. Server options 1351
VERBCHECK
The VERBCHECK option specifies that the server will do additional error checking
on the structure of commands sent by the client. This option should only be
enabled when the client sends incorrectly formed requests to the server, causing
the server to crash. When this option is enabled, you will get a protocol error
instead of a server crash.
Syntax
VERBCHECK

Parameters
None
Examples
Enable additional error checking for commands sent by the client:
verbcheck
VERBCHECK

1352 IBM Tivoli Storage Manager for Windows: Administrators Reference
VOLUMEHISTORY
The VOLUMEHISTORY option specifies the name of files to be automatically
updated whenever server sequential volume history information is changed. There
is no default for this option.
You can include one or more VOLUMEHISTORY options in the server options file.
When you use multiple VOLUMEHISTORY options, the server automatically
updates and stores a backup copy of the volume history information in each file
you specify.
Syntax
VOLUMEHistory file_name

Parameters
file_name
Specifies the name of the file where you want the server to store a backup
copy of the volume history information that it collects.
Examples
volumehistory volhist.out
VOLUMEHISTORY
Chapter 3. Server options 1353
VOLUMEHISTORY

1354 IBM Tivoli Storage Manager for Windows: Administrators Reference
Chapter 4. IBM Tivoli Storage Manager Utilities
IBM Tivoli Storage Manager provides utilities that allow you to perform services to
the server. Use the following tables to determine which utility to process for the
server.
Miscellaneous utilities
The following utilities are available with IBM Tivoli Storage Manager.
Table 412. Miscellaneous utilities
Utility Description Reference Page
DSMMAXSG Increases the maximum
transfer length for writing to
tape.
DSMMAXSG (Increasing the
block size for writing data)
on page 1357
DSMSERV Starts the server. May also
specify that the database be
upgraded or that a file be
run.
DSMSERV (Start the
server) on page 1358
DSMSERV EXTEND LOG Extends the size of the
recovery log
DSMSERV EXTEND LOG
(Emergency log extension)
on page 1372
DSMSERV LOADFORMAT Formats the database and
recovery log for the
DSMSERV LOADDB utility
DSMSERV LOADFORMAT
(Format the database and log
for load) on page 1379

Database recovery utilities
Use the following utilities to recover an IBM Tivoli Storage Manager database from
a backup copy of the database.
Table 413. Database recovery utilities
Utility Description Reference Page
DSMSERV DISPLAY
DBBACKUPVOLUME
Displays information about
database backup volumes.
DSMSERV DISPLAY
DBBACKUPVOLUME
(Display database
backup volume
information) on page
1363
DSMSERV DISPLAY
DBVOLUMES
Displays information about all
database volumes.
DSMSERV DISPLAY
DBVOLUMES (Display
database volume
information) on page
1365
DSMSERV DISPLAY
LOGVOLUMES
Displays information about all
recovery log volumes.
DSMSERV DISPLAY
LOGVOLUMES
(Display recovery log
volume information)
on page 1367

Copyright IBM Corp. 1993, 2007 1355
Table 413. Database recovery utilities (continued)
Utility Description Reference Page
DSMSERV RESTORE DB Restores an IBM Tivoli Storage
Manager database or database
volume.
DSMSERV RESTORE
DB (Restore the
database) on page 1382
DSMSERV UNLOADDB Unload the contents of the
database when the server is
offline
DSMSERV
UNLOADDB (Unload
the database) on page
1391

Database salvage utilities
Use the following utilities to re-establish your server database if a catastrophic
error occurs, and the database cannot be recovered effectively using the DSMSERV
RESTORE DB utility.
Table 414. Database salvage utilities
Utility Description Reference Page
DSMSERV AUDITDB Verifies database information DSMSERV
AUDITDB (Verify
database
information) on
page 1360
DSMSERV DUMPDB Dumps the database DSMSERV
DUMPDB (Dump
the database) on
page 1369
DSMSERV FORMAT Initializes the database and recovery log DSMSERV
FORMAT (Format
the database and
log) on page 1373
DSMSERV LOADDB Reloads a dumped IBM Tivoli Storage
Manager database.
DSMSERV
LOADDB (Reload
the database) on
page 1376

The DSMSERV DUMPDB and DSMSERV LOADDB utilities use the device
configuration file. This file contains a copy of the device class, library, and drive
definitions in your database. IBM Tivoli Storage Manager automatically creates and
maintains a current device configuration file if you specify the DEVCONFIG
option in the server options file. You can also create the file by using the BACKUP
DEVCONFIG command. If no device configuration file has been maintained or
created, you must manually create one with an editor. For information on how to
create a device configuration file manually, see Administrators Guide.

1356 IBM Tivoli Storage Manager for Windows: Administrators Reference
DSMMAXSG (Increasing the block size for writing data)
Running the DSMMAXSG utility increases the maximum transfer length for host
bus adapters (HBAs). As a result, the block size used by the Tivoli Storage
Manager server for writing data to and getting data from certain types of tape
drives is increased.
With this utility, the maximum supported block size is 256 KB. Depending on your
system environment, the increase in block size could improve the rate at which
Tivoli Storage Manager processes data for backups and restores and for archives
and retrieves. Note, however, that the utility does not affect the generation of
backup sets.
The only supported tape drives are those that are attached to SCSI or Fibre
Channel HBAs and that have the following device types:
v 3570
v 3590
v 3592
v DLT
v DTF
v ECARTRIDGE
v LTO
Normally, the utility is executed automatically as part of the Tivoli Storage
Manager server and storage agent installation. However, if you install a new HBA
on your system after server or storage agent installation or if you install a new
version of an existing HBA device driver that resets the value of the maximum
transfer size, you must run the utility manually in order to take advantage of the
larger block size.
When you run this utility, it modifies one registry key for every HBA driver on
your system. The name of the key is MaximumSGList.
Note: If data is backed up or archived to tape using the 256 KB block size, the
tape cannot be appended to or read from using an HBA that does not
support the 256 KB block size. For example, if you use a 256 KB Windows
system for backing up client data to the Tivoli Storage Manager server, you
cannot restore the data using a Windows system that supports a different
transfer length. If you want to append to or read from tape written to using
a 256 KB transfer length, you need to install an HBA that supports 256 KB
transfers.
Syntax
dsmmaxsg

Examples
Task Run the DSMMAXSG utility to increase the block size used by the Tivoli
Storage Manager.
dsmmaxsg
DSMMAXSG
Chapter 4. IBM Tivoli Storage Manager Utilities 1357
DSMSERV (Start the server)
Use this command to start the Tivoli Storage Manager server. You may be asked to
specify the UPGRADEDB or RUNFILE parameter after maintenance or a new
version of Tivoli Storage Manager is installed.
Syntax

-k Server1
DSMSERV

-k

key_name

UPGRADEDB

RUNFILE

file_name

Parameters
-k key_name
Specifies the name of the Windows registry key from which to retrieve
information about the server. The default is SERVER1.
RUNFILE file_name
Specifies the name of a text file to be run on the server that contains a list of
Tivoli Storage Manager server commands.
Attention: Whenever the RUNFILE parameter is used, the server halts upon
completion of the command. The server must then be restarted using the
DSMSERV command.
UPGRADEDB
Specifies that the server database is to be upgraded.
Note: Include the UPGRADEDB parameter only once. Do not include the
parameter in any automated process that starts the server.
Examples
Task
Start the server for normal operation.
Command
dsmserv
Task
Start an additional server using the registry key named SERVER2.
Command
dsmserv -k server2
Task
Upgrade the server database after a new version of the server program is installed.
Command
dsmserv upgradedb
Task
DSMSERV

1358 IBM Tivoli Storage Manager for Windows: Administrators Reference
Load the sample script file that is provided with the server.
Command
dsmserv runfile scripts.smp
DSMSERV
Chapter 4. IBM Tivoli Storage Manager Utilities 1359
DSMSERV AUDITDB (Verify database information)
Use this command to ensure that the database is returned to a consistent state after
it is reloaded by issuing the DSMSERV LOADDB command. A message at the end
of the output from the DSMSERV LOADDB command indicates whether or not
this command is required.
Issue this command before starting the server, and do not restart the server until
the command has completed processing.
Attention: Contact Tivoli Storage Manager Software Support before issuing the
DSMSERV AUDITDB command if you are using this command in
situations other than when a message indicates it is necessary.
Issue this command only if one of the following conditions is true:
v The recovery log mode was set to normal before the server was halted.
v The database was backed up just before the server was halted.
No other server activity is allowed during DSMSERV AUDITDB processing.
Note:
1. If the server database volumes are mirrored and synchronized, change
the MIRRORREAD DB server option to MIRRORREAD DB VERIFY
before attempting AUDITDB.
2. If the recovery log mode was set to roll-forward before the server was
halted, set the recovery log mode to normal before issuing the DSMSERV
AUDITDB utility. This action will avoid running out of log space during
DSMSERV AUDITDB processing.
3. If STANDARD policy objects are deleted before Tivoli Storage Manager
reinstallation, you will receive a message during the audit processing
indicating that an instance count does not agree with actual data. If you
delete the STANDARD policy objects, they are restored during
reinstallation. The command does not delete the objects. Instead, it
synchronizes the instance count to include the restored objects.
4. If you have the following conditions, any inconsistencies encountered in
the database tables that have to do with the volumes in the
RECLAMATION=SNAPLOCK storage pools will not be repaired with
the DSMSERV AUDITDB command:
v Running a server with archive retention protection enabled
v Data stored in storage pools that are defined with the parameter
RECLAMATIONTYPE=SNAPLOCK
v Running the DSMSERV AUDITDB with the FIX=YES parameter
Instead, messages will be issued telling you to run the AUDIT VOLUME
command with the FIX=YES parameter to repair those inconsistencies. If
you receive any of those messages once the server is operational, you
will need to run the AUDIT VOLUME command with the FIX=YES
parameter for each volume indicated in those messages to completely
repair the database tables. If you do not receive any such messages, the
database tables associated with those volumes are correct.
DSMSERV AUDITDB

1360 IBM Tivoli Storage Manager for Windows: Administrators Reference
Syntax

DSMSERV
-k Server1
-k

key_name

AUDITDB
FIX = No
FIX

=

No

Yes

DETAIL = No
DETAIL

=

No

Yes

FILE

=

file_name

Parameters
-k key_name
Specifies the name of a Windows registry key used to store information about
this server. Use this parameter only to install additional servers on the same
system. After you install a server by using this parameter, you must always
start it with the value of this parameter. The default is SERVER1.
FIX
Specifies how Tivoli Storage Manager resolves inconsistencies in the database.
This parameter is optional. The default is NO. When you are recovering a
database, you should specify YES. Possible values are:
No
Tivoli Storage Manager reports, but does not fix, any logical inconsistencies
found.
If the audit finds inconsistencies, re-issue the command specifying
FIX=YES before making the server available for production work. Because
AUDITDB must be run with FIX=YES to recover the database, the
recommended usage in a recovery situation is FIX=YES the first time.
Yes
Tivoli Storage Manager fixes any inconsistencies and issues messages
indicating the actions taken.
DETAIL
Specifies the level of database testing that Tivoli Storage Manager will do. This
parameter is optional. The default value is NO. Possible values are:
No
Tivoli Storage Manager only tests the referential integrity of the database.
Yes
Tivoli Storage Manager tests the referential integrity of the database and
the integrity of each database entry.
FILE
Specifies that the output is redirected to the specified file. This parameter is
optional.
Examples
Task
Audit the Tivoli Storage Manager database for inconsistencies, but do not fix
inconsistencies if they exist.
DSMSERV AUDITDB
Chapter 4. IBM Tivoli Storage Manager Utilities 1361
Command
dsmserv auditdb fix=no
DSMSERV AUDITDB

1362 IBM Tivoli Storage Manager for Windows: Administrators Reference
DSMSERV DISPLAY DBBACKUPVOLUME (Display database backup
volume information)
Use this command to display information about snapshot database backup
volumes or full and incremental backup volumes when volume history information
is not available.
Syntax

DSMSERV
-k Server1
-k

key_name

DISPlay DBBackupvolume

DEVclass

=

device_class_name

,
VOLumenames

=

volume_name

Parameters
-k key_name
Specifies the name of a Windows registry key used to store information about
this server. Use this parameter only to install additional servers on the same
system. After you install a server by using this parameter, you must always
start it with the value of this parameter. The default is SERVER1.
DEVclass (Required)
Specifies the name of the sequential access device class to use. The device class
must be defined in a device configuration file specified by the DEVCONFIG
server option.
If a device configuration file is not available, you can manually create one. See
the Administrators Guide for details.
VOLumenames (Required)
Specifies the database backup volume names. If you specify multiple names,
separate them with commas and no intervening spaces.
Examples
Task
Display information about database backup volumes, 33778195.dbb and
33868064.dbb.
Command
dsmserv display dbbackupvolume devclass=file
volumenames=33778195.dbb,33868064.dbb
Output

DSMSERV DISPLAY DBBACKUPVOLUME
Chapter 4. IBM Tivoli Storage Manager Utilities 1363
Date/Time: 06/02/1998 22:00:09
Volume Type: BACKUPFULL
Backup Series: 2
Backup Operation: 0
Volume Seq: 2
ANR8340I FILE volume L:-DBBACKUP-33868064.DBB mounted.
Device Class: DBFILE
Volume Name: L:-DBBACKUP-33778195.DBB

Date/Time: 06/02/1998 22:00:09
Volume Type: BACKUPINCR
Backup Series: 2
Backup Operation: 1
Volume Seq: 2
evice Class: DBFILE
Volume Name: L:-DBBACKUP-33868064.DBB

where:
Date/Time
The date and time that backup data was recorded on the volume.
Volume Type
Whether the backup was full or incremental.
Backup Series
The identifying number of the backup series. A backup series is a full backup
and all incremental backups before the next full backup.
Backup Operation
The operation number of the backup volume. In a backup series the full
backup is operation 0, the first incremental backup is operation 1, the second
incremental backup is operation 2, and so on.
Volume Seq
The sequence, or position, of the volume in the backup series. Volume
sequence 1 identifies the first volume of the first operation (a full backup), and
so on. If a full backup occupies three volumes, the volume sequence numbers
are 1, 2, and 3.
Device Class
The name of the device class for the volume.
Volume Name
The name of the volume.
DSMSERV DISPLAY DBBACKUPVOLUME

1364 IBM Tivoli Storage Manager for Windows: Administrators Reference
DSMSERV DISPLAY DBVOLUMES (Display database volume
information)
Use this command to display information about all database volumes known to
Tivoli Storage Manager.
Syntax

DSMSERV
-k Server1
-k

key_name

DISPlay DBVolumes

Parameters
-k key_name
Specifies the name of a Windows registry key used to store information about
this server. Use this parameter only to install additional servers on the same
system. After you install a server by using this parameter, you must always
start it with the value of this parameter. The default is SERVER1.
Examples
Task
Display information about all database volumes.
Command
dsmserv display dbvolumes
Output

Volume Name (Copy 1): D:\ADSMSERV\SERVER\DB1.DSM
Copy Status: Syncd
Volume Name (Copy 2):
Copy Status: Undefined
Volume Name (Copy 3):
Copy Status: Undefined
Available Space (MB): 4
Allocated Space (MB): 4
Free Space (MB): 0

where:
Volume Name (Copy n)
The database volume name. The output displays the status of the three
possible volume copies: Copy 1, Copy 2, and Copy 3.
Copy Status
The status of the database volume:
Offline
The volume is varied offline.
Stale
The volume is not synchronized with the other volumes in the database
and cannot be used for storage.
DSMSERV DISPLAY DBVOLUMES
Chapter 4. IBM Tivoli Storage Manager Utilities 1365
Syncd
The volume is synchronized with the other volumes in the database and
can be used for storage.
Undefined
No volume has been defined.
Available Space (MB)
The total available space for the database volume, in megabytes.
Allocated Space (MB)
The space allocated to the database volume, in megabytes.
Free Space (MB)
The unassigned space for this mirror set that can be allocated for use, in
megabytes.
DSMSERV DISPLAY DBVOLUMES

1366 IBM Tivoli Storage Manager for Windows: Administrators Reference
DSMSERV DISPLAY LOGVOLUMES (Display recovery log volume
information)
Use this command to display information about Tivoli Storage Manager recovery
log volumes.
Syntax

DSMSERV
-k Server1
-k

key_name

DISPlay LOGVolumes

Parameters
-k key_name
Specifies the name of a Windows registry key used to store information about
this server. Use this parameter only to install additional servers on the same
system. After you install a server by using this parameter, you must always
start it with the value of this parameter. The default is SERVER1.
Examples
Task
Display information about all recovery log volumes.
Command
dsmserv display logvolumes
Output
Volume Name (Copy 1):
D:\ADSMSERV\SERVER\LOG1.DSM
Copy Status: Syncd
Volume Name (Copy 2):
Copy Status: Undefined
Volume Name (Copy 3):
Copy Status: Undefined
Available Space (MB): 8
Allocated Space (MB): 8
Free Space (MB): 0

where:
Volume Name (Copy n)
The name of the recovery log volume. The output displays status of the three
possible volume copies: Copy 1, Copy 2, and Copy 3.
Copy Status
The recovery log volume status:
Offline
The volume is varied offline.
Stale
The volume is not synchronized with the other volumes in the recovery
log and cannot be used for storage.
DSMSERV DISPLAY LOGVOLUMES
Chapter 4. IBM Tivoli Storage Manager Utilities 1367
Syncd
The volume is synchronized with the other volumes in the recovery log
and can be used for storage.
Undefined
No volume has been defined.
Available Space (MB)
The total available space, both allocated and free, for the recovery log, in
megabytes.
Allocated Space (MB)
The space allocated for the recovery log, in megabytes.
Free Space (MB)
The unassigned space in the recovery log that can be allocated for use, in
megabytes.
DSMSERV DISPLAY LOGVOLUMES

1368 IBM Tivoli Storage Manager for Windows: Administrators Reference
DSMSERV DUMPDB (Dump the database)
Use this command as the first step in dumping, reinitializing, and reloading the
server database if a catastrophic error occurs (recovery log corruption, for
example), and the DSMSERV RESTORE DB command cannot be used. No other
server activity is allowed during DSMSERV DUMPDB command processing.
Attention:
v For assistance when using the DSMSERV DUMPDB utility, contact IBM Support.
v If you are attempting to recover your database, first create a new database and
recovery log. Keep the original database and recovery log available in case you
need to repeat the recovery effort.
After DSMSERV DUMPDB processing is complete, perform the following steps:
1. Issue the DSMSERV LOADFORMAT command to reinitialize the database and
recovery log.
2. Issue the DSMSERV LOADDB command to reload the database.
3. If necessary, issue the DSMSERV AUDITDB command to locate and correct any
database inconsistencies.
Note: A message at the end of the output from the DSMSERV LOADDB
command indicates whether you must audit the database.
You must have a device configuration file that includes the definition for this
device class, and any libraries and drives needed. You must also specify the name
of that device configuration file by using the DEVCONFIG option in your server
options file. The device configuration file should be available if you had previously
included a DEVCONFIG option in the server options file and then started the
server. If the device configuration file has been lost or was never created, do one of
the following:
v If the server can be restarted, restart the server and issue the BACKUP
DEVCONFIG command.
v If the server cannot be restarted, create the device configuration file manually
with an editor. For information on how to create a device configuration file
manually, see the Administrators Guide.
Consider the following before dumping the database:
v Before dumping the database to sequential access media, estimate how much
media is required. If you cannot bring up the server, use the size of your
existing database volumes.
If you can bring the server up, estimate the size by following these steps:
1. Issue the QUERY DB command.
2. From the output of the QUERY DB command, multiply the number of used
pages by 4096 bytes to determine space occupied by the database.
3. Divide the product of step 2 by the capacity of a single medium to estimate
the number of media required.
v Record the order in which the volumes are mounted during dump processing.
You must remount the volumes in the same order during recovery processing.
Label the volumes to indicate the order in which they have been mounted. For
example, label tapes as DSM001, DSM002, DSM003, and so on.
v When dumping, you can use scratch volumes to ensure that there is space to
store the database. Whether you use private or scratch volumes, record the label
DSMSERV DUMPDB
Chapter 4. IBM Tivoli Storage Manager Utilities 1369
names and sequence for each volume mounted during the dump. The volumes
used by the DSMSERV DUMPDB command are not recorded in the sequential
volume history information.
v The server recovery log is not accessed during the dump process. Therefore,
database entries that were not written to the database at the time of the dump
are not recorded. During recovery from a catastrophic failure, the most recent
database updates may not be recoverable.
Note: When a database is loaded or restored, the server-to-server communication
verification token is changed. The verification token is an attribute of the
database and is not stored in the database itself. Part of the token is the
install date and time for the database. For servers that have been defined for
server-to-server communications, you must issue an UPDATE SERVER
command with FORCESYNC=YES.
Syntax

DSMSERV
-k Server1
-k

key_name

DUMPDB

DEVclass

=

device_class_name

Scratch = Yes
Scratch

=

Yes

No

,

VOLumenames

=

volume_name

FILE:

file_name

Parameters
-k key_name
Specifies the name of a Windows registry key used to store information about
this server. Use this parameter only to install additional servers on the same
system. After you install a server by using this parameter, you must always
start it with the value of this parameter. The default is SERVER1.
DEVclass
Specifies the name of the device class associated with the volumes to which the
database dump will be written.
Note:
1. You cannot use a device class with a device type of NAS.
2. The operation fails if a database dump is directed to a FILE library.
A FILE library is created if the FILE device class specifies
SHARED=YES.
Scratch
Specifies whether or not scratch volumes can be used for dumping the
database. The default value is YES.
Yes
Scratch volumes can be used. If you include a list of volumes on the
VOLUMENAMES parameter, scratch volumes are used only if there is not
enough space to dump the database on the volumes specified. If the device
type associated with the specified device class is FILE, file names for the
scratch volumes are generated based on a time stamp.
DSMSERV DUMPDB

1370 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
No
Scratch volumes cannot be used. You must include a list of volumes on the
VOLUMENAMES parameter to contain all of the database data.
Note: This parameter is only valid for 349X, Manual and External library
types.
VOLumenames
Specifies the volumes to use to dump the database. This parameter is optional,
but must be specified if SCRATCH=NO. If you do not specify this parameter
and SCRATCH=YES is specified or assumed, scratch volumes are used. You
must also specify this parameter if you want to use AUTOLABEL with a
Manual library.
Tivoli Storage Manager does not record the use of volumes by the DSMSERV
DUMPDB command in the volume history file. Therefore, you must record the
volume names used and specify them in the exact same order on a future
DSMSERV LOADDB command.
Possible values are:
volume_name
The names of one or more volumes to use to dump the database. Specify
multiple volumes by separating volume names with commas and no
intervening spaces. The volumes will be used in the order in which they
are listed.
FILE:file_name
The name of a file that contains a list of the volumes to use to dump the
database. Enter each volume name on a separate line in the file. List the
volumes in the order in which they are to be used.
Examples
Task 1
Dump the database to previously labeled tapes named DB0001, DB0002, DB0003:
1. Halt the server.
2. Ensure that the DEVCONFIG option has been specified in the server options
file. The device configuration file must contain the device class, library, and
drive definitions needed for the dump operation.
3. Issue the DSMSERV DUMPDB command.
Command
dsmserv dumpdb devclass=tapeclass
volumenames=db0001,db0002,db0003
Task 2
Dump the database using tapes listed in a file named ADSM.VOLLIST.
Command
dsmserv dumpdb devclass=tapeclass
volnames=file:adsm.vollist
DSMSERV DUMPDB
Chapter 4. IBM Tivoli Storage Manager Utilities 1371
DSMSERV EXTEND LOG (Emergency log extension)
Use this command to extend the size of the recovery log when you need additional
log space to restart the server. Issue this command if you receive an ANR9999D
LOGSEG message. This indicates that your log space has been overcommitted and
your server terminates with a LOGSEG871 error.
After the server is running, you can do the following:
v Back up the database, which frees the recovery log space.
v Adjust the size of the recovery log, the database backup trigger full percentage,
or both to allow for successful future database backups.
Syntax

DSMSERV
-k Server1
-k

key_name

EXTEND LOG

volume_name

megabytes

Parameters
-k key_name
Specifies the name of a Windows registry key used to store information about
this server. Use this parameter only to install additional servers on the same
system. After you install a server by using this parameter, you must always
start it with the value of this parameter. The default is SERVER1.
volume_name (Required)
Specifies the name to be used for the new recovery log extension volume
megabytes (Required)
Specifies the size, in megabytes, of the new volume. The size must be a
multiple of 4MB and 1MB less than the size of the volume specified in the
volume_name parameter. For example, if the volume is 5MB, specify a value of
4.
Examples
Task
The server halts, and there is not enough recovery log space to restart. After you
have formatted a 21MB volume named new.reclog, extend the recovery log using
the new volume.
Command
dsmserv extend log new.reclog 20
DSMSERV EXTEND LOG

1372 IBM Tivoli Storage Manager for Windows: Administrators Reference
DSMSERV FORMAT (Format the database and log)
Use this command to initialize the server database and recovery log. No other
server activity is allowed while initializing the database and recovery log.
Attention:
v Do not use this command to install a Tivoli Storage Manager server if you are
going to perform a DSMSERV LOADDB; use the DSMSERV LOADFORMAT
utility instead.
v The installation program creates a set of registry keys. One of these keys points
to the directory where a default server, named Server1, is created. When you
issue the DSMSERV FORMAT command, a file named dsmserv.dsk is created.
This file points to the directory that contains the database and recovery log.
v Running this command resets the log mode to normal mode. See SET
LOGMODE (Set mode for saving recovery log records) on page 1009.
To install an additional server, create a new directory and issue the DSMSERV
FORMAT command, with the -k parameter, from that directory. That directory
becomes the location of the server. The registry tracks the installed servers.
Syntax

dsmserv
-k Server1
-k

key_name

format

number_of_log_files

log_file_name

log_size

file:

log_file_name

number_of_db_files

db_name

db_size

file:

db_file_name

Parameters
-k key_name
Specifies the name of a Windows registry key used to store information about
this server. Use this parameter only to install additional servers on the same
system. After you install a server by using this parameter, you must always
start it with the value of this parameter. The default is SERVER1.
number_of_log_files (Required)
Specifies the number of recovery log files.
log_file_name
Specifies one or more recovery log file names. The files must not exist before
you issue the command, or the command fails.
The number of names must match the number specified by the
number_of_log_files parameter. The minimum size for the log is 9MB.
log_size (Required)
Specifies the size of the recovery log file in megabytes. The minimum size is
9MB.
DSMSERV FORMAT
Chapter 4. IBM Tivoli Storage Manager Utilities 1373
file:log_file_name
Specifies the name of a file that contains a list of recovery log volume names
and sizes (one name and size per line) used to format the recovery log. If the
files exist before you issue the command, the command fails.
It is recommended that you specify a fully-qualified name enclosed in single
quotes so that you will not be affected by data set name qualification rules that
depend on your operating environment.
The number of names must match the number specified by the
number_of_log_files parameter. You must list the volumes in the order in which
they are to be used. The minimum size for the log is 9MB.
number_of_db_files (Required)
Specifies the number of database files.
db_file_name
Specifies one or more database file names. If the files exist before you issue the
command, the command fails.
The number of names must match the number specified by the
number_of_db_files parameter. The minimum size for the database is 5MB.
db_size (Required)
Specifies the size of the database in megabytes. The minimum size is 5MB.
file:db_file_name
Specifies the name of a file that contains a list of database volume names and
sizes (one name and size per line). The files must not exist before you issue the
command or the command fails.
The number of names must match the number specified by the
number_of_db_files parameter. You must list the volumes in the order they are to
be used. The minimum size for the database is 5MB.
It is recommended that you specify a fully-qualified name enclosed in single
quotes so that you will not be affected by data set name qualification rules that
depend on your operating environment.
Examples
Task 1:
To manually install the first server on a Windows system, change to that directory
that contains the server executable and issue the DSMSERV FORMAT command.
For example, from a Windows prompt, enter the following commands:
1. cd:\"program files"\tivoli\tsm\server
2. dsmserv format 1 log1.dsm 9 1 db1.dsm 13
Because the -k parameter is not specified, Tivoli Storage Manager creates an NT
registry key of Server1. When this command is run without specifying a -k
parameter, it uses information stored in the system registry under the key
SERVER1.
It is recommended that you use the Tivoli Storage Manager Management Console
to create server instances. The console manages all of the steps for you. When
complete, the server instance can be started as a Windows service or from a DOS
window.
DSMSERV FORMAT

1374 IBM Tivoli Storage Manager for Windows: Administrators Reference
Use the following example to install an additional server on a Windows machine.
The server is installed on the c:\"program files"\tivoli\tsm\server\server2
directory and TCP/IP communications method is used.
Note: If you have installed Tivoli Storage Manager in a different location,
substitute that location for the one listed in the example below.
1. From the c:\"program files"\tivoli\tsm directory, enter the following
commands to create a new directory and change to that directory:
md server2
cd server2
2. From the c:\"program files"\tivoli\tsm\server2 directory, enter the
following commands:
..\server\dsmserv -k server2 format 1 log1.dsm 9 1 db1.dsm 13
3. From the c:\"program files"\tivoli\tsm\server2 directory, enter the
following command to create a copy of the sample options file:
Copy..\server\dsmserv.opt.smp dsmserv.opt
4. From the c:\"program files"\tivoli\tsm\server2 directory, enter the
following to install the server as a Windows service where userid is the
Windows user under which the service will run and where password is the
password of that user:
..\console\install "TSM Server2" "c:\program files\tivoli\tsm\server\dsmsvc.exe"
userid password
You can now access the new server from the Tivoli Storage Manager Management
Console. The options file can be edited and the server can be started as a Windows
service. To start the server in a DOS window, enter the following from the
c:\"program files"\tivoli\tsm\server2 directory:
..\server\dsmserv -k server2
Task 2:
Initialize the recovery log and database volumes by specifying files containing the
volume names and sizes (in megabytes):
v File c:\"program files"\tivoli\tsm\server2\log.vols contains the volume
names, each with 9 megabytes of storage:
log1vol 9
log2vol 9
v File c:\"program files"\tivoli\tsm\server2\db.vols contains the volume name
with 5 megabytes of storage:
db1vol 5
Command
c:\"program files"\tivoli\tsm\server2>dsmserv -k server2 in
file:log.vols 1 file:db.vols
DSMSERV FORMAT
Chapter 4. IBM Tivoli Storage Manager Utilities 1375
DSMSERV LOADDB (Reload the database)
Use this command to reload a Tivoli Storage Manager database in optimal order.
Note: The VOLUMEHISTORY file used by LOADDB to set the sequence numbers
for a database backup and a database snapshot is the volume history file
specified in the server options file. The sequence numbers for a database
backup and a database snapshot will be set for future operations based on
the information read from the volume history file.
No other server activity is allowed while reloading the database. Perform the
applicable steps in this order:
1. Do one of the following, depending on whether you are reorganizing the
database or attempting to recover after a catastrophic error:
v If you are reorganizing the database, first back it up using the BACKUP DB
command. If an outage occurs while you are loading, you can use your
backup copy for recovering the database.
v If you are attempting to recover your database, first create a new database
and recovery log. Keep the original database and recovery log available in
case you need to repeat the recovery effort.
Attention: Do not reinitialize DISK storage pool volumes.
2. Save the current sequential volume history to a file. The load process regresses
the sequential volume history information. The saved copy should be printed
or copied to a safe location. The information in the file will be needed after the
database is reloaded. If the data is not printed or copied, key information may
be lost when the server is restarted after loading the database.
3. The DSMSERV LOADDB utility specifies a device class to be used when
reading the database information. Ensure that a device configuration file that
includes the definitions for this device class and for any required libraries and
drives is available.
Attention: The DSMSERV LOADDB command supports only manual libraries
(LIBTYPE = MANUAL) unless you are using a device class of FILE. For
additional information, see the section on reorganizing the database in the
Administrators Guide.
4. Run the DSMSERV LOADDB utility.
5. After running DSMSERV LOADDB, you will get a message indicating whether
you need to audit the database using the DSMSERV AUDITDB command.
Auditing the database will verify its consistency and integrity, report errors if
any exist, and repair them if possible. However, auditing the database after
reorganization is usually not necessary. On the other hand, you should audit
the database after salvaging it using the DSMSERV DUMPDB, DSMSERV
FORMAT, and DSMSERV LOADDB commands.
If there was any storage pool volume activity after the dump, audit the
volumes by using the AUDIT VOLUME command. Run the command from the
command prompt while the server running in normal mode.
v Audit all disk volumes.
v Use the volume history information to identify sequential volumes to be
audited. Audit all volumes that have been reused after the last dump.
Volumes identified as deleted in the sequential volume history file which are
still available, have not been reinstalled, and have not been reused by
another application should also be audited. If the deleted volumes are no
DSMSERV LOADDB

1376 IBM Tivoli Storage Manager for Windows: Administrators Reference
longer available, delete all references to them using the DELETE VOLUME
command with the DISCARDDATA=YES parameter.
Note: When a database is loaded or restored, the server-to-server communication
verification token is changed. The verification token is an attribute of the
database and is not stored in the database itself. Part of the token is the
install date and time for the database. For servers that have been defined for
server-to-server communications, you must issue an UPDATE SERVER
command with FORCESYNC=YES.
Syntax

DSMSERV
-k Server1
-k

key_name

LOADDB

DEVclass

=

device_class_name

,
VOLumenames

=

volume_name

FILE:

file_name

Parameters
-k key_name
Specifies the name of a Windows registry key used to store information about
this server. Use this parameter only to install additional servers on the same
system. After you install a server by using this parameter, you must always
start it with the value of this parameter. The default is SERVER1.
DEVclass (Required)
Specifies the device class to be used when reading the database information.
Note:
1. You cannot use a device class with a device type of NAS.
2. A reload database operation fails if the source for the restore is a
FILE library. A FILE library is created if the device class specifies
SHARED=YES.
VOLumenames (Required)
Specifies the volumes needed to load the database. Possible values are:
volume_name
The names of the volumes. To specify multiple volumes, separate the
names with commas and no intervening spaces. List the volumes in the
order in which they were used for the DSMSERV DUMPDB command.
FILE:file_name
The name of a file that contains a list of the volumes. Each volume name
must be on a separate line in the order in which they were used for the
DSMSERV DUMPDB command.
Examples
Task 1
Load the database from the DB0001, DB0002, and DB0003 tapes.
DSMSERV LOADDB
Chapter 4. IBM Tivoli Storage Manager Utilities 1377
Command
dsmserv loaddb devclass=tapeclass
volumenames=db0001,db0002,db0003
Task 2
Load the database using tapes listed in the ADSM.VOLLIST file.
Command
dsmserv loaddb devclass=tapeclass
volumenames=file:adsm.vollist
DSMSERV LOADDB

1378 IBM Tivoli Storage Manager for Windows: Administrators Reference
DSMSERV LOADFORMAT (Format the database and log for load)
Use this command to format the database and recovery log for a subsequent
DSMSERV LOADDB or DSMSERV RESTORE DB.
Attention: Any recovery log volumes that are specified in the DSMSERV
LOADFORMAT command will be overwritten.
You must run a DSMSERV LOADFORMAT before you run a DSMSERV LOADDB.
After you run a DSMSERV LOADFORMAT, you must run a DSMSERV LOADDB
or DSMSERV RESTORE DB before the server will start.
Note:
1. If you are attempting to recover your database from an error, first create
a new database and recovery log. Keep the original database and
recovery log available in case you need to repeat the recovery effort.
2. If you are reorganizing the database, first back it up using the BACKUP
DB command. If an outage occurs while you are loading, you can use
your backup copy for recovering the database.
3. If a DSMSERV LOADFORMAT was run, and a DSMSERV LOADDB
cannot be run, you can restore the database to a point in time with a
DSMSERV RESTORE DB. See DSMSERV RESTORE DB (Restore the
database) on page 1382 for additional information.
4. When a database is loaded or restored, the server-to-server
communication verification token is changed. The verification token is an
attribute of the database and is not stored in the database itself. Part of
the token is the install date and time for the database. For servers that
have been defined for server-to-server communications, you must issue
an UPDATE SERVER command with FORCESYNC=YES.
5. Running this command resets the log mode to normal mode. See SET
LOGMODE (Set mode for saving recovery log records) on page 1009.
Syntax

dsmserv
-k server1
-k

key_name

loadformat

number_of_log_files

log_file_name

log_size

file:

log_file_name

number_of_db_files

db_name

db_size

file:

db_file_name

Parameters
-k key_name
Specifies the server instance. The default is SERVER1.
number_of_log_files (Required)
Specifies the number of recovery log files.
DSMSERV LOADFORMAT
Chapter 4. IBM Tivoli Storage Manager Utilities 1379
log_file_name
Specifies one or more recovery log file names. The files must not exist before
you issue the command, or the command fails.
The number of names must match the number specified by the
number_of_log_files parameter. The minimum size for the log is 9MB.
log_size (Required)
Specifies the size of the recovery log file in megabytes. The minimum size is
9MB.
file:log_file_name
Specifies the name of a file that contains a list of recovery log volume names
and sizes (one name and size per line) used to format the recovery log. If the
files exist before you issue the command, the command fails.
It is recommended that you specify a fully-qualified name enclosed in single
quotes so that you will not be affected by data set name qualification rules that
depend on your operating environment.
The number of names must match the number specified by the
number_of_log_files parameter. You must list the volumes in the order in which
they are to be used. The minimum size for the log is 9MB.
number_of_db_files (Required)
Specifies the number of database files.
db_file_name
Specifies one or more database file names. If the files exist before you issue the
command, the command fails.
The number of names must match the number specified by the
number_of_db_files parameter. The minimum size for the database is 5MB.
db_size (Required)
Specifies the size of the database in megabytes. The minimum size is 5MB.
file:db_file_name
Specifies the name of a file that contains a list of database volume names and
sizes (one name and size per line). The files must not exist before you issue the
command or the command fails.
The number of names must match the number specified by the
number_of_db_files parameter. You must list the volumes in the order they are to
be used. The minimum size for the database is 5MB.
It is recommended that you specify a fully-qualified name enclosed in single
quotes so that you will not be affected by data set name qualification rules that
depend on your operating environment.
Examples
Task:
To prepare to recover the first server on a Windows system, change to the
directory that contains the server executable and issue the DSMSERV
LOADFORMAT command. For example, from a Windows prompt, enter the
following commands:
1. cd c:\program files\tivoli\tsm\server
2. dsmserv loadformat 1 log1.dsm 9 1 db1.dsm 13
DSMSERV LOADFORMAT

1380 IBM Tivoli Storage Manager for Windows: Administrators Reference
Because the -k parameter is not specified, Tivoli Storage Manager creates an NT
registry key named Server1.
Use the following example to prepare to recover an additional server on a
Windows machine. The server is installed in the c:\"program files"\tivoli\tsm\
server directory and TCP/IP is the communications method used.
Note: If you have installed Tivoli Storage Manager in a different location,
substitute that location for the one listed in the example below.
1. From the c:\"program files"\tivoli\tsm directory, enter the following
commands to create a new directory and change into that directory:
md server2
cd server2
2. From the c:\"program files"\tivoli\tsm\server2 directory, enter the
following commands:
..\server\dsmserv -k server2 loadformat 1 log1.dsm 9 1 db1.dsm 13
3. From the tree view, select Server Options.
4. From the list, select Server2.
5. Click Edit.
6. Select TCP/IP and Port Address.
7. Change the value for the Port Address to 1501.
8. Click on the Client Settings button to view the parameters the clients must
use in the Client Options File to connect to the new server.
9. Click OK .
10. Enter ..\server\dsmserv -k server2 to start the new server.
11. Install the server
DSMSERV LOADFORMAT
Chapter 4. IBM Tivoli Storage Manager Utilities 1381
DSMSERV RESTORE DB (Restore the database)
Use this command to restore your database by using a database backup.
Use this command for the following tasks:
v Restoring a database to its most current state on page 1384
v Restoring a single database volume to its most current state on page 1385
v Restoring a database to a point-in-time volume history file available on
page 1387
v Restoring a database to a point-in-time volume history file unavailable on
page 1389
Before you perform any of these operations, you should be familiar with the
procedures as they are described in the Administrators Guide.
The restore operation uses database backups created with the BACKUP DB
command or created automatically based on the settings specified in the DEFINE
DBBACKUPTRIGGER command. You cannot use the DSMSERV RESTORE DB
command to load a dump created with the DSMSERV DUMPDB or DSMSERV
UNLOADDB commands.
Note:
1. To restore a database or volume to its most current state, the log mode
must have been set to roll-forward continuously from the time that the
last backup series was created.
2. If the original database or recovery log volumes are available, issue only
the DSMSERV RESTORE DB command. If those volumes are not
available, issue the DSMSERV LOADFORMAT to initialize the database
and recovery log, then issue the DSMSERV RESTORE DB command.
3. During a point-in-time restore, the recovery log is reformatted. If your
recovery log is large, this may take a while.
4. After a point-in-time restore, issue the AUDIT VOLUME command to
audit all DISK volumes and resolve any inconsistencies between
database information and storage pool volumes. If you saved a copy of
the volume history file before restoring the database, examine that file to
find out about sequential access storage pool volumes that were deleted
or reused since the point in time to which the database was restored.
DSMSERV RESTORE DB

1382 IBM Tivoli Storage Manager for Windows: Administrators Reference
Attention: If the log mode is set to roll-forward after a point-in-time
database restoration, a database backup starts when the server is brought
up for the first time. This can cause loss of data: a tape can have current
data on it, but because of the point-in-time restoration, it can be marked
as scratch. When the server starts for the first time, it may use this tape
to write the database backup, thus destroying the original data on this
tape.
This situation could occur if roll-forward mode is enabled, but the
administrator restored the database as if the server was operating in
normal mode, not roll-forward mode. For example: the database is to be
backed up at midnight everyday Monday through Friday. On Friday, the
database was restored to a point in time of midnight Wednesday.
Thursdays database backup was not used; this tape exists and does
contain valid data. But because the database was restored to Wednesday
at midnight, the Thursdays tape was marked as scratch. This tape was
then inadvertently chosen and written with the database backup
information. Therefore, the data for Thursday was lost.
5. When a database is loaded or restored, the server-to-server
communication verification token is changed. The verification token is an
attribute of the database and is not stored in the database itself. Part of
the token is the install date and time for the database. For servers that
have been defined for server-to-server communications, you must issue
an UPDATE SERVER command with FORCESYNC=YES.
DSMSERV RESTORE DB
Chapter 4. IBM Tivoli Storage Manager Utilities 1383
|
|
|
|
|
|
Restoring a database to its most current state
You can restore a database to its most current state (roll-forward recovery) under
certain conditions.
The following conditions must be true:
v The log mode was set to roll-forward continuously from the time that the last
backup series was created.
v An intact recovery log is available.
v An intact volume history file is available.
A device configuration file with the applicable device information (library, drive,
and device class definitions) must also be available, or you must manually create
one (see the Administrators Guide).
Tivoli Storage Manager requests volume mounts to load the most recent backup
series and then uses the recovery log to update the database to its most current
state.
Snapshot database backups cannot be used to restore a database to its most current
state.
Syntax

DSMSERV RESTORE DB
Preview = No
Preview

=

No

Yes

Parameters
Preview
Specifies whether you want the server to display a list of the volumes needed
to restore the database to its most current state, but not to perform the restore.
This parameter is optional. The default value is NO. Possible values are:
No
Specifies that you want to restore the database.
Yes
Specifies that you only want to display the list of database backup
volumes.
Examples
Task
Preview the list of volumes required to restore the database to its most current
state.
Command:
dsmserv restore db preview=yes
DSMSERV RESTORE DB (Database to its most current state)

1384 IBM Tivoli Storage Manager for Windows: Administrators Reference
Restoring a single database volume to its most current state
You can restore a single database volume to its most current state (roll-forward
recovery) under certain conditions.
The following conditions must be true:
v The log mode was set to roll-forward continuously from the time that the last
backup series was created, until the database volume was damaged or lost.
v An intact recovery log is available.
A device configuration file with the applicable device information (library, drive,
and device class definitions) must also be available, or you must manually create
one (see the Administrators Guide).
Tivoli Storage Manager requests volume mounts to load the most recent backup
series and then uses the recovery log to update the volume to its most current
state.
When Tivoli Storage Manager restores a mirrored database volume, only one copy
of the volume is restored. Use the VARY command to bring the mirrored volume
online. The mirrored volume is then synchronized the with the restored volume.
Snapshot database backups cannot be used to restore a database to its most current
state.
Syntax

DSMSERV RESTORE DB
Preview = No
DBVol

=

volume_name

Preview

=

No

Yes

Parameters
DBVol (Required)
Specifies the name of the database volume to restore. If the volume is
mirrored, you can specify the name of any volume that contains a copy of the
volume to be restored. Use the DSMSERV DISPLAY DBVOLUMES command
to find the volume names.
Preview
Specifies whether you want the server to display a list of the database backup
volumes needed to restore the database volume you specify, without
performing the restore. This parameter is optional. The default value is NO.
Possible values are:
No
Specifies that you want to restore the database volume.
Yes
Specifies that you only want to display the list of database backup
volumes.
Examples
Task
DSMSERV RESTORE DB (Single volume to its most current state)
Chapter 4. IBM Tivoli Storage Manager Utilities 1385
Restore database volume dbvol2 to its most current state. The recovery log is
available and intact.
Command:
dsmserv restore db dbvol=dbvol2
DSMSERV RESTORE DB (Single volume to its most current state)

1386 IBM Tivoli Storage Manager for Windows: Administrators Reference
Restoring a database to a point-in-time volume history file
available
If a volume history file is available, you can restore a database to a point in time.
A device configuration file with the applicable device information must also be
available, or you must manually create one.
To manually create a device configuration file with the applicable device
information (library, drive, and device class definitions) see the Administrators
Guide).
If the volume history file is not available, use the method described in Restoring a
database to a point-in-time volume history file unavailable on page 1389.
Full and incremental database backups or snapshot database backups can be used
to restore a database to a point in time.
Syntax

DSMSERV RESTORE DB

TODate

=

date
TOTime = 23:59:59
TOTime

=

time

Source = DBBackup
Source

=

DBBackup

DBSnapshot
Preview = No
Preview

=

No

Yes

Parameters
TODate (Required)
Specifies the date to which to restore the database. Possible values are:
MM/DD/YYYY
Specifies that you want to restore a database using the last backup series
created before the specified date.
TODAY
Specifies that you want to restore a database using the most recent backup
series that was created before the current date.
TODAY-numdays or -numdays
Specifies that you want to restore a database using the most recent backup
series that was created the specified number of days before the current
date.
TOTime
Specifies the time of day to which to restore the database. This parameter is
optional. The default is the end of the day (23:59:59). Possible values are:
HH:MM:SS
Specifies that you want to restore the database using the last backup series
created on or before the specified time on the specified date.
NOW
Specifies that you want to restore the database using a backup series
created on or before the current time on the specified date.
DSMSERV RESTORE DB (To a point-in-time with volume history file available)
Chapter 4. IBM Tivoli Storage Manager Utilities 1387
For example, if you issue the DSMSERV RESTORE DB command at 9:00
with TOTIME=NOW, the database is restored using the last backup series
created on or prior to 9:00 on the specified date.
NOW-numhours:numminutes or -numhours:numminutes
Specifies that you want to restore the database using a backup series
created on or before the current time minus a specified number of hours
and, optionally, minutes on the specified date.
For example, if you issue the DSMSERV RESTORE DB command at 9:00
with TOTIME=NOW-3:30 or TOTIME+-3:30, the database is restored using
the last backup series created on or prior to 5:30 on the specified date.
Source
Specifies whether the database is restored using either database full and
incremental backup volumes or snapshot database volumes. This parameter is
optional. The default value is DBBackup. Possible values are:
DBBackup
Specifies that the database is restored as follows:
1. Reads the volume history file to locate the database full and
incremental backup volumes needed
2. Requests mounts and loads data from database full and incremental
backup volumes as required to restore the database volume to the
specified time.
DBSnapshot
Specifies that the database is restored as follows:
1. Reads the volume history file to locate the snapshot database volumes
needed
2. Requests mounts and loads data from snapshot database volumes as
required to restore the volume to the specified time.
Preview
Specifies whether you want the server to display a list of the volumes needed
to restore the database, without performing the restore. This parameter is
optional. The default value is NO. Possible values are:
No
Specifies that you want to perform the restore operation.
Yes
Specifies that you only want to display the list of database backup
volumes.
Examples
Task
Restore the database to its state on May 12, 1999 at 2:25 pm. The volume history
file is available.
Command:
dsmserv restore db todate=05/12/1999 totime=14:45 preview=no
DSMSERV RESTORE DB (To a point-in-time with volume history file available)

1388 IBM Tivoli Storage Manager for Windows: Administrators Reference
Restoring a database to a point-in-time volume history file
unavailable
If the volume history file is unavailable, you can use one or more DSMSERV
RESTORE DB commands to restore the database to a specific point in time. A
device configuration file with the applicable device information must also be
available, or you must manually create one.
For example, to load a full backup and one or more incremental backups, issue a
DSMSERV RESTORE DB command for the full backup and an additional
DSMSERV RESTORE DB command for each incremental backup. When you use
multiple DSMSERV RESTORE DB commands, specify COMMIT=NO for each
command except the last one. For the last command, specify COMMIT=YES. The
database remains in an inconsistent and unusable state until you issue a DSMSERV
RESTORE DB command with a COMMIT=YES.
To manually create a device configuration file with the applicable device
information (library, drive, and device class definitions) see the Administrators
Guide).
Full and incremental database backups or snapshot database backups can be used
to restore a database to a point in time.
To restore the database using snapshot backup volumes, you must:
1. Specify all the volume names for the same snapshot backup series
2. List the volumes in the sequence in which the backup was written
3. Specify COMMIT=YES
Note:
1. If you issue a DSMSERV RESTORE DB command with COMMIT=NO,
and you decide not to load another incremental backup, reissue the last
DSMSERV RESTORE DB command with COMMIT=YES.
2. If you issue a DSMSERV RESTORE DB command with COMMIT=YES,
and you decide to load an additional incremental backup, reissue all the
DSMSERV RESTORE DB commands in order with COMMIT=NO on
each. Then, enter any additional DSMSERV RESTORE DB commands,
with COMMIT=YES on the last one.
Syntax
DSMSERV RESTORE DB DEVclass = device_class_name

,
VOLumenames

=

volume_name

FILE:

file_name

COMMIT

=

No

COMMIT

=

No

Yes

Parameters
DEVclass (Required)
Specifies the name of the sequential access device class to use. The device class
DSMSERV RESTORE DB (To a point-in-time with volume history file unavailable)
Chapter 4. IBM Tivoli Storage Manager Utilities 1389
must be defined in a device configuration file. If a device configuration file is
not available, you can manually create one (see the Administrators Guide).
Note:
1. You cannot use a device class with a device type of NAS.
2. A restore database operation fails if the source for the restore is a
FILE library. A FILE library is created if the device class specifies
SHARED=YES.
VOLumenames (Required)
Specifies the backup volumes to use to restore the database. Possible values
are:
volume_name
Specifies the names of the volumes. To specify multiple volumes, separate
the names with commas and without intervening spaces. List the volumes
in the order in which they were written.
FILE:file_name
Specifies the name of a file that contains a list of the volumes. Enter the
volumes in the order in which they were written with each name on a
separate line.
COMMIT
Specifies whether this is the last restore command needed to restore the
database. This parameter is optional. The default value is NO. Possible values
are:
No
Specifies that you will issue one or more additional DSMSERV RESTORE
DB commands.
Yes
Specifies that this is the last restore command to restore the database.
Examples
Task 1
Restore the database to the time of its most recent incremental backup. The volume
history file is not available. Tape volumes FULL1, FULL2, INCR1, and INCR2
contain the database backup series.
Commands
dsmserv restore db devclass=tape volumenames=full1,full2 commit=no
dsmserv restore db devclass=tape volumenames=incr1 commit=no
dsmserv restore db devclass=tape volumenames=incr2 commit=yes
Task 2
Restore a database to the time of its most recent snapshot backup. The volume
history file is not available. Tape volumes TAPE01 and TAPE02 are snapshot
volume names in a volume sequence that spans two tapes.
Command
dsmserv restore db devclass=8MM volumenames=tape01,tape01 commit=yes
DSMSERV RESTORE DB (To a point-in-time with volume history file unavailable)

1390 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
DSMSERV UNLOADDB (Unload the database)
Use this command to reorganize the contents of the database when the server is
offline. This command unloads the database in key order so when the database is
reloaded the space required for the database is minimized. A database audit could
be required after the database is reloaded.
After DSMSERV UNLOADDB processing is complete, perform the following steps:
1. Issue the DSMSERV LOADFORMAT command to reinitialize the database and
recovery log.
2. Issue the DSMSERV LOADDB command to reload the database.
3. Issue the DSMSERV AUDITDB command to locate and correct any database
inconsistencies.
The DSMSERV UNLOADDB command supports only manual libraries (LIBTYPE =
MANUAL) unless you are using a device class of FILE. For additional information,
see the section on reorganizing the database in the Administrators Guide.
Attention: This database unload operation assumes that the Tivoli Storage
Manager database is usable and reads device information from the database, not
from the device configuration file. A database dump operation (DSMSERV
DUMPDB), on the other hand, does not assume a usable database and reads from
the device configuration file.
Consider the following before unloading the database:
v Before unloading the database to sequential access media, estimate how much
media is required. If you do not know, use the size of your existing database
volumes. If necessary, label additional volumes using the LABEL LIBVOLUME
command.
v Record the order in which the volumes are mounted during DSMSERV
UNLOADDB processing. The volume order will be important during DSMSERV
LOADDB processing so that the volumes can be remounted in the same order.
To ensure that volumes are mounted in the correct order, prelabel the volumes
with information that indicates the order in which they will be mounted. For
example, label tapes as DSM001, DSM002, DSM003, and so on to indicate the
order in which data is stored on the tape volumes.
v When unloading, you can use scratch volumes to ensure that there is space to
store the database. If you use scratch volumes, record the label names and
sequence for each volume mounted during the unloading process.
v Obviously, the server recovery log is not accessed during the unloading process.
Therefore, database entries that were not written to the database at the time of
the unloading are not recorded. During recovery from a catastrophic failure, the
most recent database updates may not be recoverable.
v Save the volume history file to another location. You should do this before
executing the UNLOADDB or LOADFORMAT commands.
Note: After a server database is loaded or restored the server-to-server
communication verification token has been changed. The verification token
is an attribute of the database and is not stored in the database itself. Part of
the token is the install date and time for the server database. For servers
that have been defined for Server-to-Server communications, you must issue
an UPDATE SERVER command with the server name and
FORCESYNC=YES.
DSMSERV UNLOADDB
Chapter 4. IBM Tivoli Storage Manager Utilities 1391
Syntax

DSMSERV
-k Server1
-k

key_name

UNLOADDB

DEVclass

=

device_class_name

Scratch = Yes
Scratch

=

Yes

No

,

VOLumenames

=

volume_name

Consistent = Yes
Consistent

=

Yes

No

Parameters
-k key_name
Specifies the name of a Windows registry key used to store information about
this server. Use this parameter only to install additional servers on the same
system. After you install a server by using this parameter, you must always
start it with the value of this parameter. The default is SERVER1.
DEVclass
Specifies the device class to which the database information will be written.
Note:
1. You cannot use a device class with a device type of NAS.
2. The unload database operation fails if it is directed to a FILE library.
A FILE library is created if the FILE device class specifies
SHARED=YES.
VOLumenames
Specifies the volumes to use to dump the database. This parameter is optional,
but must be specified if SCRATCH=NO. If you do not specify this parameter
and SCRATCH=YES is specified or assumed, scratch volumes are used.
Tivoli Storage Manager does not record the use of volumes by the DSMSERV
UNLOADDB command in the volume history file. Therefore, you must record
the volume names used and specify them in the exact same order on a future
DSMSERV LOADDB command.
Possible values are:
volume_name
The names of one or more volumes to use to dump the database. Specify
multiple volumes by separating volume names with commas and no
intervening spaces. The volumes will be used in the order in which they
are listed.
FILE:file_name
The name of a file that contains a list of the volumes to use to dump the
database. Enter each volume name on a separate line in the file. List the
volumes in the order in which they are to be used.
DSMSERV UNLOADDB

1392 IBM Tivoli Storage Manager for Windows: Administrators Reference
|
|
|
Scratch
Specifies whether or not scratch volumes can be used for unloading the
database. The default value is YES.
Yes
Scratch volumes can be used. If you include a list of volumes on the
VOLUMENAMES parameter, scratch volumes are used only if there is not
enough space to unload the database on the volumes specified. If the
device type associated with the specified device class is FILE, file names
for the scratch volumes are generated based on a time stamp.
No
Scratch volumes cannot be used. You must include a list of volumes on the
VOLUMENAMES parameter to contain all of the database data.
Consistent
Specifies whether server transaction processing should be suspended so that
the unloaded database is a transactionally-consistent image. The default is YES.
Yes
Specifies that a database audit will not be required when you reload the
database; because during unloading, you preserved a
transactionallyconsistent database.
No
Specifies that when reloading the database, a database audit will be
required because during unloading a transactionally-consistent database
image was not maintained. CONSISTENT=NO should only be used when
the CONSISTENT=YES fails.
Examples
Task
Unload the database to previously labeled tapes named DB0001, DB0002, DB0003:
1. Halt the server, if it is not already offline. This command can only be used
when the server is offline.
2. Issue the DSMSERV UNLOADDB command.
Command
dsmserv unloaddb devclass=tapeclass
volumenames=db0001,db0002,db0003
Task
Unload the database using tapes listed in a file named ADSM.VOLLIST.
Command
dsmserv unloaddb devclass=tapeclass
volnames=file:adsm.vollist
DSMSERV UNLOADDB
Chapter 4. IBM Tivoli Storage Manager Utilities 1393
DSMSERV UNLOADDB

1394 IBM Tivoli Storage Manager for Windows: Administrators Reference
Appendix A. Return codes for use in IBM Tivoli Storage
Manager scripts
You can write IBM Tivoli Storage Manager scripts that use return codes to
determine how script processing proceeds. The return codes can be one of three
severities: OK, WARNING, ERROR.
IBM Tivoli Storage Manager scripts use the symbolic return code for processing,
not the numeric value. The administrative client displays the numeric values when
a command is run. The return codes are shown in the following table.
Table 415. Return codes
Return code Severity
Numeric
value Description
RC_OK OK 0 Command completed successfully
RC_NOTFOUND WARNING 11 Returned by a QUERY or SQL SELECT
command when no objects are found that
match specifications
RC_UNKNOWN ERROR 2 Command is not found; not a known
command
RC_SYNTAX ERROR 3 Command is valid, but one or more
parameters were not specified correctly
RC_ERROR ERROR 4 An internal server error prevented the
command from successfully completing
RC_NOMEMORY ERROR 5 The command could not be completed
because of insufficient memory on the server
RC_NOLOG ERROR 6 The command could not be completed
because of insufficient recovery log space on
the server
RC_NODB ERROR 7 The command could not be completed
because of insufficient database space on the
server
RC_NOSTORAGE ERROR 8 The command could not be completed
because of insufficient storage space on the
server
RC_NOAUTH ERROR 9 The administrator is not authorized to issue
the command
RC_EXISTS ERROR 10 The command failed because the specified
object already exists on the server
RC_INUSE ERROR 12 The command failed because the object to be
operated upon was in use
RC_ISREFERENCED ERROR 13 The command failed because the object to be
operated upon is still referenced by some
other server construct
RC_NOTAVAILABLE ERROR 14 The command failed because the object to be
operated upon is not available
RC_IOERROR ERROR 15 The command failed because an
input/output (I/O) error was encountered
on the server

Copyright IBM Corp. 1993, 2007 1395
Table 415. Return codes (continued)
Return code Severity
Numeric
value Description
RC_NOTXN ERROR 16 The command failed because a database
transaction failed on the server
RC_NOLOCK ERROR 17 The command failed because a lock conflict
was encountered in the server database
RC_NOTHREAD ERROR 19 The command could not be completed
because of insufficient memory on the server
RC_LICENSE ERROR 20 The command failed because the server is
not in compliance with licensing
RC_INVDEST ERROR 21 The command failed because a destination
value was invalid
RC_IFILEOPEN ERROR 22 The command failed because an input file
that was needed could not be opened
RC_OFILEOPEN ERROR 23 The command failed because it could not
open a required output file
RC_OFILEWRITE ERROR 24 The command failed because it could not
successfully write to a required output file
RC_INVADMIN ERROR 25 The command failed because the
administrator was not defined
RC_SQLERROR ERROR 26 An SQL error was encountered during a
SELECT statement query


1396 IBM Tivoli Storage Manager for Windows: Administrators Reference
Appendix B. 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 users 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. 1993, 2007 1397
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.

1398 IBM Tivoli Storage Manager for Windows: Administrators Reference
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:
Table 416. Trademarks
AIX
AS/400
DB2
DFSMS/MVS
DFSMSrmm
Enterprise Storage Server
eServer
IBM
Informix
iSeries
Lotus
Lotus Domino
Lotus 1-2-3
Magstar
MVS
NetView
OS/2
OS/390
OS/400
Passport Advantage
pSeries
RACF
Rational
Redbooks
SecureWay
StorageSmart
System Storage
Tivoli
Tivoli Enterprise Console
Tivoli Management Environment
TME
TotalStorage
VTAM
WebSphere
z/OS
zSeries

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
Linux is a registered 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.

Appendix B. Notices 1399
1400 IBM Tivoli Storage Manager for Windows: Administrators Reference
Glossary
The glossary defines terms as they pertain to the IBM Tivoli Storage Manager
documentation.
If you do not find the term you need, see the IBM Software Glossary on the Web at
this address: http://www.ibm.com/ibm/terminology/.
This glossary may include terms and definitions from:
v The American National Standard Dictionary for Information Systems, ANSI
X3.172-1990, copyright (ANSI). Copies may be purchased from the American
National Standards Institute, 11 West 42nd Street, 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).
absolute mode
A backup copy group mode that specifies that a file is considered for
incremental backup even if the file has not changed since the last backup.
See also mode. Contrast with modified mode.
access mode
An attribute of a storage pool or a storage volume that specifies whether
the server can write to or read from the storage pool or storage volume.
The access mode can be read/write, read-only, or unavailable. Volumes in
primary storage pools can also have an access mode of destroyed. Volumes
in copy storage pools can also have an access mode of offsite.
activate
To validate the contents of a policy set and then make it the active policy
set.
active-data pool
A named set of storage pool volumes that contains only active versions of
client backup data.
active policy set
The activated policy set that contains the policy rules currently in use by
all client nodes assigned to the policy domain. See also policy domain and
policy set.
active version
The most recent backup copy of a file stored by IBM Tivoli Storage
Manager. The active version of a file cannot be deleted until a backup
process detects that the user has either replaced the file with a newer
version or has deleted the file from the workstation. Contrast with inactive
version.
activity log
A log that records normal activity messages generated by the server. These
messages include information about server and client operations, such as
the start time of sessions or device I/O errors. Each message includes a
message ID, date and time stamp, and a text description. The number of
days to retain messages in the activity log can be specified.

Copyright IBM Corp. 1993, 2007 1401
administrative client
A program that runs on a file server, workstation, or mainframe that
administrators use to control and monitor the IBM Tivoli Storage Manager
server. Contrast with backup-archive client.
administrative command schedule
A database record that describes the planned processing of an
administrative command during a specific time period. See also client
schedule.
administrative privilege class
See privilege class.
administrative session
A period of time in which an administrator user ID communicates with a
server to perform administrative tasks. Contrast with client node session.
administrator
A user who has been registered to the server. Administrators can be
authorized to one or more of the following administrative privilege classes:
system, policy, storage, operator, or analyst. Administrators can use the
administrative commands and queries allowed by their privileges.
agent node
A client node that has been granted proxy authority to perform operations
on behalf of another client node, which is the target node.
aggregate
An object, stored in one or more storage pools, consisting of a group of
logical files packaged together. See logical file and physical file.
analyst privilege class
A privilege class that allows an administrator to reset statistics. See also
privilege class.
application client
One of the IBM Tivoli Storage Manager data protection programs installed
on a system to protect an application. The IBM Tivoli Storage Manager
server provides backup services to an application client.
archive
To copy one or more files to a storage pool for long-term storage. Archived
files can include descriptive information and can be retrieved by archive
date, by file name, or by description. Contrast with retrieve.
archive copy
A file that was archived to server storage.
archive copy group
A policy object containing attributes that control the generation,
destination, and expiration of archived files. An archive copy group
belongs to a management class.
archive retention grace period
The number of days that IBM Tivoli Storage Manager retains an archived
file when the server is unable to rebind the file to an appropriate
management class.
assigned capacity
The portion of available space that can be used to store database or
recovery log information. See also available space.

1402 IBM Tivoli Storage Manager for Windows: Administrators Reference
association
The defined relationship between a client node and a client schedule. An
association identifies the name of a schedule, the name of the policy
domain to which the schedule belongs, and the name of a client node that
performs scheduled operations.
On a configuration manager, the defined relationship between a profile and
an object such as a policy domain. Profile associations define the
configuration information that will be distributed to a managed server
when it subscribes to the profile.
audit To check for logical inconsistencies between information that the server has
and the actual condition of the system. IBM Tivoli Storage Manager can
audit volumes, the database, libraries, and licenses. For example, when
IBM Tivoli Storage Manager audits a volume, the server checks for
inconsistencies between information about backed-up or archived files
stored in the database and the actual data associated with each backup
version or archive copy in server storage.
authentication
The process of checking a users password before allowing that user access
to the server. Authentication can be turned on or off by an administrator
with system privilege.
authority
The right granted to a user to perform tasks with IBM Tivoli Storage
Manager servers and clients. See also privilege class.
autochanger
A small, multislot tape device that automatically puts tape cartridges into
tape drives. See also library.
available space
The amount of space, in megabytes, that is available to the database or the
recovery log. This space can be used to extend the capacity of the database
or the recovery log, or to provide sufficient free space before a volume is
deleted from the database or the recovery log.
back up
To copy information to another location to ensure against loss of data. In
IBM Tivoli Storage Manager, you can back up user files, the IBM Tivoli
Storage Manager database, and storage pools. Contrast with restore. See
also database backup series and incremental backup.
backup-archive client
A program that runs on a workstation or file server and provides a means
for users to back up, archive, restore, and retrieve files. Contrast with
administrative client.
backup copy group
A policy object containing attributes that control the generation,
destination, and expiration of backup versions of files. A backup copy
group belongs to a management class.
backup retention grace period
The number of days that IBM Tivoli Storage Manager retains a backup
version after the server is unable to rebind the file to an appropriate
management class.

Glossary 1403
backup set
A portable, consolidated group of active backup versions of files, generated
for a backup-archive client.
backup version
A file that a user backed up to server storage. More than one backup
version can exist in server storage, but only one backup version is the
active version. See also active version and inactive version.
binding
The process of associating a file with a management class name. See
rebinding.
buffer pool
Temporary space used by the server to hold database or recovery log
pages. See database buffer pool and recovery log buffer pool.
cache The process of leaving a duplicate copy on random access media when the
server migrates a file to another storage pool in the hierarchy.
central scheduler
A function that allows an administrator to schedule client operations and
administrative commands. The operations can be scheduled to occur
periodically or on a specific date. See client schedule and administrative
command schedule.
client A program running on a PC, workstation, file server, LAN server, or
mainframe that requests services of another program, called the server. The
following types of clients can obtain services from an IBM Tivoli Storage
Manager server: administrative client, application client, API client,
backup-archive client, and HSM client (also known as Tivoli Storage
Manager for Space Management).
client domain
The set of drives, file systems, or volumes that the user selects to back up
or archive using the backup-archive client.
client migration
The process of copying a file from a client node to server storage and
replacing the file with a stub file on the client node. The space
management attributes in the management class control this migration. See
also space management.
client node
A file server or workstation on which the backup-archive client program
has been installed, and which has been registered to the server.
client node session
A period of time in which a client node communicates with a server to
perform backup, restore, archive, retrieve, migrate, or recall requests.
Contrast with administrative session.
client options file
A file that a client can change, containing a set of processing options that
identify the server, communication method, and options for backup,
archive, hierarchical storage management, and scheduling. Also called the
dsm.opt file.
client-polling scheduling mode
A client/server communication technique where the client queries the
server for work. Contrast with server-prompted scheduling mode.

1404 IBM Tivoli Storage Manager for Windows: Administrators Reference
client schedule
A database record that describes the planned processing of a client
operation during a specific time period. The client operation can be a
backup, archive, restore, or retrieve operation, a client operating system
command, or a macro. See also administrative command schedule.
client system options file
A file, used on UNIX clients, containing a set of processing options that
identify the IBM Tivoli Storage Manager servers to be contacted for
services. This file also specifies communication methods and options for
backup, archive, hierarchical storage management, and scheduling. Also
called the dsm.sys file. See also client user options file.
client user options file
A user-created file, used on UNIX clients, containing a set of processing
options that identify the server, communication method, backup and
archive options, space management options, and scheduling options. Also
called the dsm.opt file. See also client system options file.
closed registration
A registration process in which only an administrator can register
workstations as client nodes with the server. Contrast with open registration.
collocation
The process of keeping all data belonging to a single client file space, a
single client node, or a group of client nodes on a minimal number of
sequential-access volumes within a storage pool. Collocation can reduce
the number of volumes that must be accessed when a large amount of data
must be restored.
collocation group
A user-defined group of client nodes whose data is stored on a minimal
number of volumes through the process of collocation.
compression
The process of saving storage space by eliminating empty fields or
unnecessary data in a file. In IBM Tivoli Storage Manager, compression can
occur at a workstation before files are backed up or archived to server
storage. On some types of tape drives, hardware compression can be used.
configuration manager
One IBM Tivoli Storage Manager server that distributes configuration
information to other IBM Tivoli Storage Manager servers (called managed
servers) via profiles. Configuration information can include policy and
schedules. See managed server and profile.
copy group
A policy object whose attributes control how backup versions or archive
copies are generated, where backup versions or archive copies are initially
located, and when backup versions or archive copies expire. A copy group
belongs to a management class. See also archive copy group, backup copy
group, backup version, and management class.
copy storage pool
A named set of volumes that contains copies of files that reside in primary
storage pools. Copy storage pools are used only to back up the data stored
in primary storage pools. A copy storage pool cannot be a destination for a
backup copy group, an archive copy group, or a management class (for
space-managed files). See primary storage pool and destination.

Glossary 1405
damaged file
A physical file for which IBM Tivoli Storage Manager has detected read
errors.
database
A collection of information about all objects managed by the server,
including policy management objects, users and administrators, and client
nodes.
database backup series
One full backup of the database, plus up to 32 incremental backups made
since that full backup. Each full backup that is run starts a new database
backup series. A number identifies each backup series.
database backup trigger
A set of criteria that defines when and how database backups are run
automatically. The criteria determine how often the backup is run, whether
the backup is a full or incremental backup, and where the backup is stored.
database buffer pool
Storage that is used as a cache to allow database pages to remain in
memory for long periods of time, so that the server can make continuous
updates to pages without requiring input or output (I/O) operations from
external storage.
database snapshot
A complete backup of the entire IBM Tivoli Storage Manager database to
media that can be taken off-site. When a database snapshot is created, the
current database backup series is not interrupted. A database snapshot
cannot have incremental database backups associated with it. See also
database backup series. Contrast with full backup.
data mover
A device, defined to IBM Tivoli Storage Manager, that moves data on
behalf of the server. A NAS file server can be a data mover.
default management class
A management class assigned to a policy set that the server uses to
manage backed-up or archived files when a user does not specify a
management class for a file.
desktop client
The group of backup-archive clients supported by IBM Tivoli Storage
Manager that includes clients on Windows, Apple, and Novell NetWare
operating systems.
destination
A copy group or management class attribute that specifies the primary
storage pool to which a client file will be backed up, archived, or migrated.
device class
A named set of characteristics applied to a group of storage devices. Each
device class has a unique name and represents a device type of disk, file,
optical disk, or tape.
device configuration file
A file that contains information about defined device classes, and, on some
IBM Tivoli Storage Manager servers, defined libraries and drives. The file
can be created by using an IBM Tivoli Storage Manager administrative

1406 IBM Tivoli Storage Manager for Windows: Administrators Reference
command or by using an option in the server options file. The information
is a copy of the device configuration information in the IBM Tivoli Storage
Manager database.
disaster recovery manager (DRM)
A function in IBM Tivoli Storage Manager that assists in preparing and
later using a disaster recovery plan file for the IBM Tivoli Storage Manager
server.
disaster recovery plan
A file created by disaster recovery manager (DRM) that contains
information about how to recover computer systems if a disaster occurs
and scripts that can be run to perform some recovery tasks. The file
includes information about the software and hardware used by the IBM
Tivoli Storage Manager server, and the location of recovery media.
domain
See policy domain or client domain.
DRM A short name for disaster recovery manager.
dsm.opt file
See client options file and client user options file.
dsmserv.opt
See server options file.
dsm.sys file
See client system options file.
dynamic
A value for serialization that specifies that IBM Tivoli Storage Manager
accepts the first attempt to back up or archive a file regardless of whether
the file is modified during the backup or archive process. See also
serialization. Contrast with shared dynamic, shared static, and static.
enterprise configuration
A method of setting up IBM Tivoli Storage Manager servers so that the
administrator can distribute the configuration of one of the servers to the
other servers, using server-to-server communication. See configuration
manager, managed server, profile, and subscription.
enterprise logging
The sending of events from IBM Tivoli Storage Manager servers to a
designated event server. The event server routes the events to designated
receivers, such as to a user exit. See also event.
estimated capacity
The available space, in megabytes, of a storage pool.
event An administrative command or a client operation that is scheduled to be
run using IBM Tivoli Storage Manager scheduling.
A message that an IBM Tivoli Storage Manager server or client issues.
Messages can be logged using IBM Tivoli Storage Manager event logging.
event record
A database record that describes actual status and results for events.
event server
A server to which other servers can send events for logging. The event
server routes the events to any receivers that are enabled for the sending
servers events.

Glossary 1407
exclude
To identify files that you do not want to include in a specific client
operation, such as backup or archive. You identify the files in an
include-exclude list.
exclude-include list
See include-exclude list.
expiration
The process by which files are identified for deletion because their
expiration date or retention period has passed. Backed-up or archived files
are marked expired by IBM Tivoli Storage Manager based on the criteria
defined in the backup or archive copy group.
expiration date
On some IBM Tivoli Storage Manager servers, a device class attribute used
to notify tape management systems of the date when IBM Tivoli Storage
Manager no longer needs a tape volume. The date is placed in the tape
label so that the tape management system does not overwrite the
information on the tape volume before the expiration date.
export To copy administrator definitions, client node definitions, policy
definitions, server control information, or file data to external media, or
directly to another server. Used to move or copy information between
servers.
extend
To increase the portion of available space that can be used to store
database or recovery log information. Contrast with reduce.
file space
A logical space in IBM Tivoli Storage Manager server storage that contains
a group of files backed up or archived by a client. For clients on Windows
systems, a file space contains files from a logical partition that is identified
by a volume label. For clients on UNIX systems, a file space contains files
from the same file system, or the part of a file system that stems from a
virtual mount point. Clients can restore, retrieve, or delete their file spaces
from IBM Tivoli Storage Manager server storage. IBM Tivoli Storage
Manager does not necessarily store all the files belonging to a single file
space together, but can identify all the files in server storage that belong to
a single file space.
file space ID (FSID)
A unique numeric identifier that the server assigns to a file space when it
is stored in server storage.
frequency
A copy group attribute that specifies the minimum interval, in days,
between incremental backups.
FSID See file space ID.
full backup
The process of backing up the entire server database. A full backup begins
a new database backup series. See also database backup series and incremental
backup. Contrast with database snapshot.
fuzzy copy
A backup version or archive copy of a file that might not accurately reflect

1408 IBM Tivoli Storage Manager for Windows: Administrators Reference
the original content of the file because IBM Tivoli Storage Manager backed
up or archived the file while the file was being modified. See also backup
version and archive copy.
hierarchical storage management (HSM) client
The Tivoli Storage Manager for Space Management program that runs on
workstations to allow users to maintain free space on their workstations by
migrating and recalling files to and from IBM Tivoli Storage Manager
storage. Synonymous with space manager client.
high migration threshold
A percentage of the storage pool capacity that identifies when the server
can start migrating files to the next available storage pool in the hierarchy.
Contrast with low migration threshold. See server migration.
HSM client
Hierarchical storage management client. Also known as the space manager
client.
IBM Tivoli Storage Manager command script
A sequence of IBM Tivoli Storage Manager administrative commands that
are stored in the database of the IBM Tivoli Storage Manager server. You
can run the script from any interface to the server. The script can include
substitution for command parameters and conditional logic.
image backup
A backup of a full file system or raw logical volume as a single object.
import
The process of copying exported administrator definitions, client node
definitions, policy definitions, server control information or file data from
external media to a target server. A subset of information can be imported
to a target server from the external media. Used to move or copy
information between servers. See export.
inactive version
A backup version of a file that is either not the most recent backup version,
or that is a backup version of a file that no longer exists on the client
system. Inactive backup versions are eligible for expiration processing
according to the management class assigned to the file. Contrast with active
version.
include-exclude file
A file containing statements that IBM Tivoli Storage Manager uses to
determine whether to include certain files in specific client operations, and
to determine the associated management classes to use for backup, archive,
and space management. See include-exclude list.
include-exclude list
A group of include and exclude option statements that IBM Tivoli Storage
Manager uses. The exclude options identify files that are not to be included
in specific client operations such as backup or space management. The
include options identify files that are exempt from the exclusion rules. The
include options can also assign a management class to a file or group of
files for backup, archive, or space management services. The
include-exclude list for a client may include option statements from the
client options file, from separate include-exclude files, and from a client
option set on the server.

Glossary 1409
incremental backup
The process of backing up files or directories that are new or have changed
since the last incremental backup. See also selective backup.
The process of copying only the pages in the database that are new or
changed since the last full or incremental backup of the database. Contrast
with full backup. See also database backup series.
LAN-free data movement
The direct movement of client data between a client machine and a storage
device on a SAN, rather than on the LAN.
library
A repository for demountable recorded media, such as magnetic tapes.
For IBM Tivoli Storage Manager, a collection of one or more drives, and
possibly robotic devices (depending on the library type), which can be
used to access storage volumes.
In the AS/400

system, a system object that serves as a directory to other
objects. A library groups related objects, and allows the user to find objects
by name.
library client
An IBM Tivoli Storage Manager server that uses server-to-server
communication to access a library that is managed by another IBM Tivoli
Storage Manager server. See also library manager.
library manager
An IBM Tivoli Storage Manager server that controls device operations
when multiple IBM Tivoli Storage Manager servers share a storage device.
The device operations include mount, dismount, volume ownership, and
library inventory. See also library client.
logical file
A file stored in one or more server storage pools, either by itself or as part
of an aggregate. See also aggregate and physical file.
logical occupancy
The space used by logical files in a storage pool. Because logical occupancy
does not include the unused space created when logical files are deleted
from aggregates, it may be less than physical occupancy. See also physical file
and logical file.
logical volume
A portion of a physical volume that contains a file system.
For the IBM Tivoli Storage Manager server, the combined space on all
volumes for either the database or the recovery log. The database is one
logical volume, and the recovery log is one logical volume.
low migration threshold
A percentage of the storage pool capacity that specifies when the server
can stop the migration of files to the next storage pool. Contrast with high
migration threshold. See server migration.
macro file
A file that contains one or more IBM Tivoli Storage Manager
administrative commands, which can be run only from an administrative
client by using the MACRO command. Contrast with IBM Tivoli Storage
Manager command script.

1410 IBM Tivoli Storage Manager for Windows: Administrators Reference
managed object
A definition in the database of a managed server that was distributed to
the managed server by a configuration manager. When a managed server
subscribes to a profile, all objects associated with that profile become
managed objects in the database of the managed server. In general, a
managed object cannot be modified locally on the managed server. Objects
can include policy, schedules, client options sets, server scripts,
administrator registrations, and server and server group definitions.
managed server
An IBM Tivoli Storage Manager server that receives configuration
information from a configuration manager via subscription to one or more
profiles. Configuration information can include definitions of objects such
as policy and schedules. See configuration manager, subscription, and profile.
managed system
A client or server that requests services from the IBM Tivoli Storage
Manager server.
management class
A policy object that users can bind to each file to specify how the server
manages the file. The management class can contain a backup copy group,
an archive copy group, and space management attributes. The copy groups
determine how the server manages backup versions or archive copies of
the file. The space management attributes determine whether the file is
eligible to be migrated by the space manager client to server storage and
under what conditions the file is migrated. See also copy group, space
manager client, binding, and rebinding.
maximum extension
Specifies the maximum amount of storage space, in megabytes, that you
can extend the database or the recovery log.
maximum reduction
Specifies the maximum amount of storage space, in megabytes, that you
can reduce the database or the recovery log.
maximum utilization
The highest percentage of assigned capacity used by the database or the
recovery log.
migrate
To move data from one storage location to another. See also client migration
and server migration.
mirroring
The process of writing the same data to multiple disks at the same time.
The mirroring of data protects against data loss within the database or
within the recovery log.
mode A copy group attribute that specifies whether to back up a file that has not
been modified since the last time the file was backed up. See modified and
absolute.
modified mode
A backup copy group mode that specifies that a file is considered for
incremental backup only if it has changed since the last backup. A file is
considered changed if the date, size, owner, or permissions of the file has
changed. See also mode. Contrast with absolute mode.

Glossary 1411
mount To place a data medium (such as a tape cartridge) on a drive in a position
to operate.
mount limit
A device class attribute that specifies the maximum number of volumes
that can be simultaneously accessed from the same device class. The mount
limit determines the maximum number of mount points. See mount point.
mount point
A logical drive through which volumes in a sequential access device class
are accessed. For removable media device types, such as tape, a mount
point is a logical drive associated with a physical drive. For the file device
type, a mount point is a logical drive associated with an I/O stream. The
number of mount points for a device class is defined by the value of the
mount limit attribute for that device class. See mount limit.
mount retention period
A device class attribute that specifies the maximum number of minutes
that the server retains a mounted sequential access media volume that is
not being used before it dismounts the sequential access media volume.
mount wait period
A device class attribute that specifies the maximum number of minutes
that the server waits for a sequential access volume mount request to be
satisfied before canceling the request.
NAS Network-attached storage.
NAS node
A client node that is a network-attached storage (NAS) file server. Data for
the NAS node is transferred by the NAS file server, which is controlled by
the IBM Tivoli Storage Manager server. The Tivoli Storage Manager server
uses the network data management protocol (NDMP) to direct the NAS
file server in its backup and restore operations. A NAS node is also called
a NAS file server node.
native format
A format of data that is written to a storage pool directly by the IBM Tivoli
Storage Manager server. Contrast with non-native data format.
NDMP
Network Data Management Protocol.
network-attached storage (NAS) file server
A dedicated storage device with an operating system that is optimized for
file-serving functions. In IBM Tivoli Storage Manager, a NAS file server can
have the characteristics of both a node and a data mover. See also data
mover and NAS node.
Network Data Management Protocol (NDMP)
An industry-standard protocol that allows a network storage-management
application (such as IBM Tivoli Storage Manager) to control the backup
and recovery of an NDMP-compliant file server, without installing
third-party software on that file server.
node A workstation or file server that is registered with an IBM Tivoli Storage
Manager server to receive its services. See also client node and NAS node.
In a Microsoft cluster configuration, one of the computer systems that
make up the cluster.

1412 IBM Tivoli Storage Manager for Windows: Administrators Reference
node privilege class
A privilege class that allows an administrator to remotely access
backup-archive clients for a specific client node or for all clients in a policy
domain. See also privilege class.
non-native data format
A format of data written to a storage pool that is different from the format
that the server uses for basic LAN-based operations. The data is written by
a data mover instead of the server. Storage pools with data written in a
non-native format may not support some server operations, such as audit
of a volume. The NETAPPDUMP data format for NAS node backups is an
example of a non-native data format.
open registration
A registration process in which any users can register their own
workstations as client nodes with the server. Contrast with closed
registration.
operator privilege class
A privilege class that allows an administrator to issue commands that
disable or halt the server, enable the server, cancel server processes, and
manage removable media. See also privilege class.
page A unit of space allocation within IBM Tivoli Storage Manager database
volumes.
path An IBM Tivoli Storage Manager object that defines a one-to-one
relationship between a source and a destination. Using the path, the source
accesses the destination. Data may flow from the source to the destination,
and back. An example of a source is a data mover (such as a NAS file
server), and an example of a destination is a tape drive.
physical file
A file stored in one or more storage pools, consisting of either a single
logical file, or a group of logical files packaged together (an aggregate). See
also aggregate and logical file.
physical occupancy
The amount of space used by physical files in a storage pool. This space
includes the unused space created when logical files are deleted from
aggregates. See also physical file, logical file, and logical occupancy.
policy domain
A grouping of policy users with one or more policy sets, which manage
data or storage resources for the users. In IBM Tivoli Storage Manager, the
users are client nodes. See policy set, management class, and copy group.
policy privilege class
A privilege class that allows an administrator to manage policy objects,
register client nodes, and schedule client operations for client nodes.
Authority can be restricted to certain policy domains. See also privilege
class.
policy set
A policy object that contains a group of management classes that exist for a
policy domain. Several policy sets can exist within a policy domain but
only one policy set is active at one time. See management class and active
policy set.

Glossary 1413
premigration
For a space manager client, the process of copying files that are eligible for
migration to server storage, while leaving the original file intact on the
local system.
primary storage pool
A named set of volumes that the server uses to store backup versions of
files, archive copies of files, and files migrated from HSM client nodes. You
can back up a primary storage pool to a copy storage pool. See destination
and copy storage pool.
privilege class
A level of authority granted to an administrator. The privilege class
determines which administrative tasks the administrator can perform. For
example, an administrator with system privilege class can perform any
administrative task. Also called administrative privilege class. See also
system privilege class, policy privilege class, storage privilege class, operator
privilege class, analyst privilege class, and node privilege class.
profile
A named group of configuration information that can be distributed from a
configuration manager when a managed server subscribes. Configuration
information can include registered administrators, policy, client schedules,
client option sets, administrative schedules, IBM Tivoli Storage Manager
command scripts, server definitions, and server group definitions. See
configuration manager and managed server.
randomization
The process of distributing schedule start times for different clients within
a specified percentage of the schedules startup window.
rebinding
The process of associating a backed-up file with a new management class
name. For example, rebinding occurs when the management class
associated with a file is deleted. See binding.
recall To access files that were migrated from workstations to server storage by
using the space manager client. Contrast with migrate.
receiver
A server repository that contains a log of server messages and client
messages as events. For example, a receiver can be a file exit, a user exit,
or the IBM Tivoli Storage Manager server console and activity log. See also
event.
reclamation
A process of consolidating the remaining data from many sequential access
volumes onto fewer new sequential access volumes.
reclamation threshold
The percentage of reclaimable space that a sequential access media volume
must have before the server can reclaim the volume. Space becomes
reclaimable when files are expired or are deleted. The percentage is set for
a storage pool.
recovery log
A log of updates that are about to be written to the database. The log can
be used to recover from system and media failures.

1414 IBM Tivoli Storage Manager for Windows: Administrators Reference
recovery log buffer pool
Storage that the server uses to hold new transaction records until they can
be written to the recovery log.
reduce
To free up enough space from the database or the recovery log, such that
you can delete a volume. Contrast with extend.
register
To define a client node or administrator who can access the server. See
registration.
To specify licenses that have been purchased for the server.
registration
The process of identifying a client node or administrator to the server.
restore
To copy information from its backup location to the active storage location
for use. In IBM Tivoli Storage Manager, you can restore the server
database, storage pools, storage pool volumes, and users backed-up files.
The backup version of a file in the storage pool is not affected by the
restore operation. Contrast with backup.
retention
The amount of time, in days, that inactive backed-up or archived files are
kept in the storage pool before they are deleted. Copy group attributes and
default retention grace periods for the domain define retention.
retention period
On an MVS server, a device class attribute that specifies how long files are
retained on sequential access media. When used, IBM Tivoli Storage
Manager passes this information to the MVS operating system to ensure
that other tape management systems do not overwrite tape volumes that
contain retained data.
retrieve
To copy archived information from the storage pool to the client node for
use. The retrieve operation does not affect the archive copy in the storage
pool. Contrast with archive.
rollback
To remove changes that were made to database files since the last commit
point.
schedule
A database record that describes scheduled client operations or
administrative commands. See administrative command schedule and client
schedule.
scheduling mode
The method of interaction between a server and a client for running
scheduled operations on the client. IBM Tivoli Storage Manager supports
two scheduling modes for client operations: client-polling and
server-prompted.
scratch volume
A labeled volume that is either blank or contains no valid data, that is not
currently defined to IBM Tivoli Storage Manager, and that is available for
use.
script See IBM Tivoli Storage Manager command script.

Glossary 1415
selective backup
The process of backing up selected files or directories from a client domain.
See also incremental backup.
serialization
The process of handling files that are modified during backup or archive
processing. See static, dynamic, shared static, and shared dynamic.
server migration
The process of moving data from one storage pool to the next storage pool
defined in the hierarchy, based on the migration thresholds defined for the
storage pools. See also high migration threshold and low migration threshold.
server options file
A file that contains settings that control various server operations. These
settings, or options, affect such things as communications, devices, and
performance.
server-prompted scheduling mode
A client/server communication technique where the server contacts the
client when a scheduled operation needs to be done. Contrast with
client-polling scheduling mode.
server storage
The primary and copy storage pools used by the server to store users files:
backup versions, archive copies, and files migrated from space manager
client nodes (space-managed files). See primary storage pool, copy storage
pool, storage pool volume, and volume.
session resource usage
The amount of wait time, CPU time, and space used or retrieved during a
client session.
shared dynamic
A value for serialization that specifies that a file must not be backed up or
archived if it is being modified during the operation. IBM Tivoli Storage
Manager retries the backup or archive operation a number of times; if the
file is being modified during each attempt, IBM Tivoli Storage Manager
will back up or archive the file on its last try. See also serialization. Contrast
with dynamic, shared static, and static.
shared library
A library device that is shared among multiple IBM Tivoli Storage
Manager servers.
shared static
A value for serialization that specifies that a file must not be backed up or
archived if it is being modified during the operation. IBM Tivoli Storage
Manager retries the backup or archive operation a number of times; if the
file is being modified during each attempt, IBM Tivoli Storage Manager
will not back up or archive the file. See also serialization. Contrast with
dynamic, shared dynamic, and static.
snapshot
See database snapshot.
source server
A server that can send data, in the form of virtual volumes, to another
server. Contrast with target server.

1416 IBM Tivoli Storage Manager for Windows: Administrators Reference
space-managed file
A file that is migrated from a client node by the space manager client
(HSM client). The space manager client recalls the file to the client node on
demand.
space management
The process of keeping sufficient free storage space available on a client
node by migrating files to server storage. The files are migrated based on
criteria defined in management classes to which the files are bound, and
the include-exclude list. Synonymous with hierarchical storage management.
See also migration.
space manager client
The Tivoli Storage Manager for Space Management program that enables
users to maintain free space on their workstations by migrating and
recalling files to and from server storage. Also called hierarchical storage
management (HSM) client.
startup window
A time period during which a schedule must be initiated.
static A value for serialization that specifies that a file must not be backed up or
archived if it is being modified during the operation. IBM Tivoli Storage
Manager does not retry the operation. See also serialization. Contrast with
dynamic, shared dynamic, and shared static.
storage agent
A program that enables IBM Tivoli Storage Manager to back up and restore
client data directly to and from SAN-attached storage.
storage hierarchy
A logical ordering of primary storage pools, as defined by an
administrator. The ordering is usually based on the speed and capacity of
the devices that the storage pools use. In IBM Tivoli Storage Manager, the
storage hierarchy is defined by identifying the next storage pool in a
storage pool definition. See storage pool.
storage pool
A named set of storage volumes that is the destination that the IBM Tivoli
Storage Manager server uses to store client data. A storage pool stores
backup versions, archive copies, and files that are migrated from space
manager client nodes. You back up a primary storage pool to a copy
storage pool. See primary storage pool and copy storage pool.
storage pool volume
A volume that has been assigned to a storage pool. See volume, copy storage
pool, and primary storage pool.
storage privilege class
A privilege class that allows an administrator to control how storage
resources for the server are allocated and used, such as monitoring the
database, the recovery log, and server storage. Authority can be restricted
to certain storage pools. See also privilege class.
stub file
A file that replaces the original file on a client node when the file is
migrated from the client node to server storage by Tivoli Storage Manager
for Space Management.
subscription
In a Tivoli environment, the process of identifying the subscribers that the

Glossary 1417
profiles are distributed to. For IBM Tivoli Storage Manager, this is the
process by which a managed server requests that it receive configuration
information associated with a particular profile on a configuration
manager. See managed server, configuration manager, and profile.
system privilege class
A privilege class that allows an administrator to issue all server
commands. See also privilege class.
tape library
A term used to refer to a collection of drives and tape cartridges. The tape
library may be an automated device that performs tape cartridge mounts
and demounts without operator intervention.
tape volume prefix
A device class attribute that is the high-level-qualifier of the file name or
the data set name in the standard tape label.
target node
A client node for which other client nodes (called agent nodes) have been
granted proxy authority. The proxy authority allows the agent nodes to
perform operations such as backup and restore on behalf of the target
node, which owns the data being operated on.
target server
A server that can receive data sent from another server. Contrast with
source server. See also virtual volumes.
UCS-2 An ISO/IEC 10646 encoding form, Universal Character Set coded in 2
octets. The IBM Tivoli Storage Manager client on Windows uses the UCS-2
code page when the client is enabled for Unicode.
Unicode Standard
A universal character encoding standard that supports the interchange,
processing, and display of text that is written in any of the languages of
the modern world. It can also support many classical and historical texts
and is continually being expanded. The Unicode Standard is compatible
with ISO/IEC 10646. For more information, see www.unicode.org.
UTF-8 Unicode transformation format - 8. A byte-oriented encoding form
specified by the Unicode Standard.
validate
To check a policy set for conditions that can cause problems if that policy
set becomes the active policy set. For example, the validation process
checks whether the policy set contains a default management class.
version
A backup copy of a file stored in server storage. The most recent backup
copy of a file is the active version. Earlier copies of the same file are
inactive versions. The number of versions retained by the server is
determined by the copy group attributes in the management class.
virtual file space
A representation of a directory on a network-attached storage (NAS) file
system as a path to that directory. A virtual file space is used to back up
the directory as a file space in IBM Tivoli Storage Manager server storage.
virtual volume
An archive file on a target server that represents a sequential media volume
to a source server.

1418 IBM Tivoli Storage Manager for Windows: Administrators Reference
volume
The basic unit of storage for the IBM Tivoli Storage Manager database,
recovery log, and storage pools. A volume can be an LVM logical volume,
a standard file system file, a tape cartridge, or an optical cartridge. Each
volume is identified by a unique volume identifier. See database volume,
scratch volume, and storage pool volume.
volume history file
A file that contains information about: volumes used for database backups
and database dumps; volumes used for export of administrator, node,
policy, or server data; and sequential access storage pool volumes that have
been added, reused, or deleted. The information is a copy of the same
types of volume information in the IBM Tivoli Storage Manager database.

Glossary 1419
1420 IBM Tivoli Storage Manager for Windows: Administrators Reference
Index
Numerics
3494SHARED option 1267
3570 device type 159
3590 device type 162
3592 device type 166, 1084
4MM device type 171
8MM device type 175
A
ACCEPT DATE command 27
ACCESS parameter 365, 1249
accessibility features xvii
account record, setting 974
ACSACCESSID option 1268
ACSLOCKDRIVE option 1269
ACSLS library 246
ACSQUICKINIT option 1270
ACSTIMEOUTX option 1271
action, restore 126, 289, 1182
ACTIVATE POLICYSET command 30
activating policy sets 30
active-data pool
defining a new active-data pool 352
identifying with a QUERY command 849
restoring data
restoring storage pools 942
restoring volumes 946
specifying as backups for primary storage pools 328, 343,
1216, 1229
updating an existing active-data pool 1238
activity log
querying 631
setting retention period 975
setting size limit 975
administrative client
batch mode 1, 3
console mode 1, 2
continuation characters 11
interactive mode 1, 3
mount mode 1, 3
options 5
privilege classes 18
starting 2
stopping 2
using 1
administrative client options
alwaysprompt 5
commadelimited 5
consolemode 5
displaymode 6
id 6
itemcommit 6
mountmode 6
newlineafterprompt 6
noconfirm 6
outfile 2, 3, 6
password 6
quiet 6
tabdelimited 6
administrative client options (continued)
tcpport 6
tcpserveraddress 7
administrative command
background processing 14
components 7
entry rules 7
foreground processing 14
help 538
issued by all administrators 24
issued with analyst privilege 23
issued with operator privilege 22
issued with policy privilege 20
issued with storage privilege 21
issued with system privilege 18
naming conventions 12
privilege class for 18
scheduling 298
using 25
using wildcard characters 12
administrative commands
parameters, entering 10
administrative schedule
associating with profile 273
copying 110
defining 298
deleting 419
distributing 279
updating 1178
administrative session, canceling 71
administrator
associating with profile 273
distributing 279
exporting 467
importing 542
locking 572
querying 637
registering 899
removing 914
renaming 918
updating 1051
ADMINONCLIENTPORT option 1272
administrative sessions using TCPPORT 1272
using with TCPADMINPORT 1337
ADREGISTER option 1273
ADSETDC option 1274
ADSMGROUPNAME option 1275
ADUNREGISTER option 1276
affect performance, raw partitions 321
ALIASHALT server option 1277
ANR9999D error message 985, 1372
ANS1082E message 128, 291, 1183
ANS1102E message 128, 291, 1184
ARCHDELETE parameter 905, 1160
archive
defining 145
description of 145
frequency 146
increasing throughput 1357
retention grace period 229, 1139

Copyright IBM Corp. 1993, 2007 1421
archive copy group
attributes of 145
defining 145
serialization 145
archive file deletion via a client 905, 1160
ASSIGN DEFMGMTCLASS command 33
assigning
client node to domain 903, 1158
default management class 33
ASSISTVCRRECOVERY option 1278
association of client with schedule
defining 118
deleting 371
querying 641
association, object with profile
defining 273
deleting 412
audit database 1360
AUDIT LIBRARY command 36
AUDIT LICENSES command 38
audit occupancy
displaying storage pool utilization 643
querying 643
AUDIT VOLUME command 39
AUDIT, DSMSERV 1360
auditing
library 36
storage pool volume 39
AUDITSTORAGE option 1279
authentication
password 979
setting open or closed 979
authority
client access 530
client owner 530
for command use 18
granting 530
QUERYAUTH option 1317
REQSYSAUTHOUTFILE option 1319
revoking 951
unlocking 1047
AUTOMIGNONUSE parameter 259, 1156
B
BACKDELETE parameter 906, 1160
background process
canceling 67
query process 67, 793
backup
backup file deletion 906, 1160
client 140
database 46
database volume information 1363
device information 49
increasing throughput 1357
primary storage pool 55
scheduling for client 286
trigger for database 152
volume history 59
backup copy group
attributes of 140
defining 140
serialization 140
TOCDestination parameter 143
updating 1065
BACKUP DB command 46
BACKUP DEVCONFIG command 49
BACKUP NODE command 51
backup set
defining 120
deleting 373
displaying contents of 651
generating 518
node groups
defining a group 261
defining a member 262
deleting a group 407
deleting a member 408
querying a group 778
updating a group 1166
querying 646
updating retention period 1055
BACKUP STGPOOL command 55
BACKUP VOLHISTORY command 59
batch mode
restrictions 3, 127, 128, 290, 291, 1183, 1184
starting and ending 3
using 3
BEGIN EVENTLOGGING command 62
BEGINDATE parameter 632, 711
BEGINTIME parameter 632, 711, 766
block size, 256 KB 1357
buffer pool statistic, resetting 928
BUFPOOLSIZE option 1280
C
CACHE parameter
DEFINE STGPOOL, primary random access 326
UPDATE STGPOOL, primary random access 1214
cancel
administrative session 71
client node session 71
expiration process 65
mount requests 69
process 67
restartable restore session 70
CANCEL EXPIRATION command 65
CANCEL PROCESS 15
CANCEL PROCESS command 67
CANCEL REQUEST command 69
CANCEL RESTORE command 70
CANCEL SESSION command 71
canceling commands 15
CAP parameter
CHECKOUT LIBVOLUME command 86
MOVE DRMEDIA 594
MOVE MEDIA command 607
CD-ROM support 220
Centera storage device
authentication and authorization 181, 1097
defining a device class 181
updating a device class 1097
changing date and time on the server 27
characters available for specifying passwords 12
CHECKIN LIBVOLUME command 73
checking in
library volume 73
with labeling 73
checking out a library volume 82
CHECKLABEL parameter
AUDIT LIBRARY 37
CHECKIN LIBVOLUME 77

1422 IBM Tivoli Storage Manager for Windows: Administrators Reference
CHECKLABEL parameter (continued)
CHECKOUT LIBVOLUME 85
CHECKOUT LIBVOLUME command 82
CLASSES parameter
GRANT AUTHORITY 530
REVOKE AUTHORITY 952
CLEAN DRIVE command 89
cleaning a drive, frequency 234
client access authority 530
client node session
canceling 71
scheduling 285
client option 130
client owner authority 530
client-server options, setting 1263
client, backing up subfiles for 1033
COLLOCATE parameter
DEFINE STGPOOL
active-data pool 353
copy sequential access 346
primary sequential access 337
UPDATE STGPOOL
active-data pool 1239
copy sequential access 1233
primary sequential access 1225
collocation
group
defining 135
deleting 380
querying 656
updating 1062
group member
defining 137
deleting 382
specifying for a storage pool
active-data pool 353, 1239
copy sequential access 346, 1233
primary sequential access 337, 1225
command line interface
administrative client 1
server console 1
using 1
command line, Administration Center 7
command output, formattting 4
command routing
defining server groups for 15
defining servers for 15
command scripts
copying 114
defining 307
deleting 422
DSMMAXSG 1357
querying 823
renaming 923
running 957
running commands in parallel 620
running commands serially 971
updating 1199
commands 441
ACCEPT DATE 27
ACTIVATE POLICYSET 30
ASSIGN DEFMGMTCLASS 33
AUDIT LIBRARY 36
AUDIT LICENSES 38
AUDIT VOLUME 39
BACKUP DB 46
BACKUP DEVCONFIG 49
commands (continued)
BACKUP NODE 51
BACKUP STGPOOL 55
BACKUP VOLHISTORY 59
BEGIN EVENTLOGGING 62
CANCEL EXPIRATION 65
CANCEL EXPORT 66
CANCEL PROCESS 67
CANCEL REQUEST 69
CANCEL RESTORE 70
CANCEL SESSION 71
CHECKIN LIBVOLUME 73
CHECKOUT LIBVOLUME 82
CLEAN DRIVE 89
COMMIT 91
CONVERT ARCHIVE 94
COPY ACTIVEDATA 97
COPY CLOPTSET 101
COPY DOMAIN 102
COPY MGMTCLASS 104
COPY POLICYSET 106
COPY PROFILE 108
COPY SCHEDULE 110
COPY SCRIPT 114
COPY SERVERGROUP 115
DEFINE ASSOCIATION 118
DEFINE BACKUPSET 120
DEFINE CLIENTACTION 125
DEFINE CLIENTOPT 130
DEFINE CLOPTSET 134
DEFINE COLLOCGROUP 135
DEFINE COLLOCMEMBER 137
DEFINE COPYGROUP 139
DEFINE DATAMOVER 149
DEFINE DBBACKUPTRIGGER 152
DEFINE DBCOPY 154
DEFINE DBVOLUME 156
DEFINE DEVCLASS 158
DEFINE DOMAIN 229
DEFINE DRIVE 232
DEFINE EVENTSERVER 237
DEFINE GRPMEMBER 238
DEFINE LIBRARY 240
DEFINE LOGCOPY 250
DEFINE LOGVOLUME 252
DEFINE MACHINE 254
DEFINE MACHNODEASSOCIATION 256
DEFINE MGMTCLASS 258
DEFINE NODEGROUP 261
DEFINE NODEGROUPMEMBER 262
DEFINE PATH 263
DEFINE POLICYSET 271
DEFINE PROFASSOCIATION 273
DEFINE PROFILE 279
DEFINE RECMEDMACHASSOCIATION 281
DEFINE RECOVERYMEDIA 283
DEFINE SCHEDULE 285
DEFINE SCRIPT 307
DEFINE SERVER 310
DEFINE SERVERGROUP 315
DEFINE SPACETRIGGER 316
DEFINE STGPOOL 321
DEFINE SUBSCRIPTION 359
DEFINE VIRTUALFSMAPPING 361
DEFINE VOLUME 363
DELETE ASSOCIATION 371
DELETE BACKUPSET 373

Index 1423
commands (continued)
DELETE CLIENTOPT 378
DELETE CLOPTSET 379
DELETE COLLOCGROUP 380
DELETE COLLOCMEMBER 382
DELETE COPYGROUP 384
DELETE DATAMOVER 386
DELETE DBBACKUPTRIGGER 387
DELETE DBVOLUME 388
DELETE DEVCLASS 389
DELETE DOMAIN 390
DELETE DRIVE 391
DELETE EVENT 392
DELETE EVENTSERVER 394
DELETE FILESPACE 395
DELETE GRPMEMBER 399
DELETE LIBRARY 401
DELETE LOGVOLUME 402
DELETE MACHINE 403
DELETE MACHNODEASSOCIATION 404
DELETE MGMTCLASS 405
DELETE NODEGROUP 407
DELETE NODEGROUPMEMBER 408
DELETE PATH 409
DELETE POLICYSET 411
DELETE PROFASSOCIATION 412
DELETE PROFILE 415
DELETE RECMEDMACHASSOCIATION 417
DELETE RECOVERYMEDIA 418
DELETE SCHEDULE 419
DELETE SCRIPT 422
DELETE SERVER 423
DELETE SERVERGROUP 424
DELETE SPACETRIGGER 425
DELETE STGPOOL 427
DELETE SUBSCRIBER 429
DELETE SUBSCRIPTION 430
DELETE VIRTUALFSMAPPING 431
DELETE VOLHISTORY 432
DELETE VOLUME 437
DISABLE SESSIONS 445
DISMOUNT VOLUME 448
DISPLAY OBJNAME 450
DSMADMC 1
DSMSERV 1358
DSMSERV AUDITDB 1360
DSMSERV DISPLAY DBBACKUPVOLUME 1363
DSMSERV DISPLAY DBVOLUMES 1365
DSMSERV DISPLAY LOGVOLUMES 1367
DSMSERV DUMPDB 1369
DSMSERV EXTEND LOG 1372
DSMSERV FORMAT 1373
DSMSERV LOADDB 1376
DSMSERV RESTORE DB 1384, 1385, 1387, 1389
DSMSERV RUNFILE 1358
DSMSERV UNLOADDB 1391
ENABLE EVENTS 452
ENABLE SESSIONS 455
END EVENTLOGGING 458
ESTIMATE DBREORGSTATS 460
EXPIRE INVENTORY 463
EXPORT ADMIN 467
EXPORT NODE 473
directly to another server 483
EXPORT POLICY 491
EXPORT SERVER 497
directly to another server 505
commands (continued)
EXPORT SERVER (continued)
to sequential media 499
EXTEND DB 513
EXTEND LOG 515
GENERATE BACKUPSET 518
GENERATE BACKUPSETTOC 526
GRANT AUTHORITY 530
GRANT PROXYNODE 534
HALT 536
HELP 538
IMPORT ADMIN 542
IMPORT NODE 545
IMPORT POLICY 551
IMPORT SERVER 554
INSERT MACHINE 560
ISSUE MESSAGE 562
LABEL LIBVOLUME 565
LOCK ADMIN 572
LOCK NODE 573
LOCK PROFILE 574
MACRO 576
MIGRATE STGPOOL 578
MOVE DATA 582
MOVE DRMEDIA 586
MOVE GRPMEMBER 600
MOVE MEDIA 601
MOVE NODEDATA 609
NOTIFY SUBSCRIBERS 619
PARALLEL 620
PING SERVER 623
PREPARE 624
QUERY ACTLOG 631
QUERY ADMIN 637
QUERY ASSOCIATION 641
QUERY AUDITOCCUPANCY 643
QUERY BACKUPSET 646
QUERY BACKUPSETCONTENTS 651
QUERY CLOPTSET 654
QUERY COLLOCGROUP 656
QUERY CONTENT 658
QUERY COPYGROUP 665
QUERY DATAMOVER 670
QUERY DB 673
QUERY DBBACKUPTRIGGER 677
QUERY DBVOLUME 679
QUERY DEVCLASS 682
QUERY DIRSPACE 686
QUERY DOMAIN 687
QUERY DRIVE 691
QUERY DRMEDIA 695
QUERY DRMSTATUS 703
QUERY ENABLED 706
QUERY EVENT 708
QUERY EVENTRULES 720
QUERY EVENTSERVER 723
QUERY EXPORT 724
QUERY FILESPACE 730
QUERY LIBRARY 736
QUERY LIBVOLUME 739
QUERY LICENSE 742
QUERY LOG 743
QUERY LOGVOLUME 746
QUERY MACHINE 749
QUERY MEDIA 753
QUERY MGMTCLASS 760
QUERY MOUNT 763

1424 IBM Tivoli Storage Manager for Windows: Administrators Reference
commands (continued)
QUERY NASBACKUP 765
QUERY NODE 768
QUERY NODEDATA 775
QUERY OCCUPANCY 780
QUERY OPTION 784
QUERY PATH 786
QUERY POLICYSET 790
QUERY PROCESS 793
QUERY PROFILE 795
QUERY PROXYNODE 799
QUERY RECOVERYMEDIA 800
QUERY REQUEST 803
QUERY RESTORE 804
QUERY RPFCONTENT 807
QUERY RPFILE 809
QUERY SAN 812
QUERY SCHEDULE 815
QUERY SCRIPT 823
QUERY SERVER 827
QUERY SERVERGROUP 831
QUERY SESSION 833
QUERY SHREDSTATUS 836
QUERY SPACETRIGGER 838
QUERY SQLSESSION 841
QUERY STATUS 843
QUERY STGPOOL 849
QUERY SUBSCRIBER 858
QUERY SUBSCRIPTION 860
QUERY SYSTEM 862
QUERY TAPEALERTMSG 864
QUERY TOC 865
QUERY VIRTUALFSMAPPING 868
QUERY VOLHISTORY 870
QUERY VOLUME 878
QUIT 885
RECLAIM STGPOOL 887
RECONCILE VOLUMES 891
REDUCE DB 895
REDUCE LOG 896
REGISTER ADMIN 899
REGISTER LICENSE 901
REGISTER NODE 903
REMOVE ADMIN 914
REMOVE NODE 915
RENAME ADMIN 918
RENAME FILESPACE 919
RENAME NODE 922
RENAME SCRIPT 923
RENAME SERVERGROUP 924
RENAME STGPOOL 925
RESET BUFPOOL 928
RESET DBMAXUTILIZATION 929
RESET LOGCONSUMPTION 930
RESET LOGMAXUTILIZATION 931
RESET PASSEXP 932
RESTORE NODE 937
RESTORE STGPOOL 941
RESTORE VOLUME 945
RESUME EXPORT 934
REVOKE AUTHORITY 951
REVOKE PROXYNODE 955
ROLLBACK 956
RUN 957
SELECT 960
SERIAL 971
SET ACCOUNTING 974
commands (continued)
SET ACTLOGRETENTION 975
SET ARCHIVERETENTIONPROTECTION 977
SET AUTHENTICATION 979
SET CLIENTACDURATION 980
SET CONFIGMANAGER 981
SET CONFIGREFRESH 983
SET CONTEXTMESSAGING 985
SET CROSSDEFINE 986
SET DRMCHECKLABEL 987
SET DRMCMDFILENAME 988
SET DRMCOPYSTGPOOL 989
SET DRMCOURIERNAME 990
SET DRMDBBACKUPEXPIREDAYS 991
SET DRMFILEPROCESS 993
SET DRMINSTRPREFIX 994
SET DRMNOTMOUNTABLENAME 996
SET DRMPLANPREFIX 997
SET DRMPLANVPOSTFIX 999
SET DRMPRIMSTGPOOL 1001
SET DRMRPFEXPIREDAYS 1002
SET DRMVAULTNAME 1004
SET EVENTRETENTION 1005
SET INVALIDPWLIMIT 1007
SET LICENSEAUDITPERIOD 1008
SET LOGMODE 1009
SET MAXCMDRETRIES 1011
SET MAXSCHEDSESSIONS 1012
SET MINPWLENGTH 1013
SET PASSEXP 1014
SET QUERYSCHEDPERIOD 1016
SET RANDOMIZE 1017
SET REGISTRATION 1019
SET RETRYPERIOD 1021
SET SCHEDMODES 1022
SET SERVERHLADDRESS 1024
SET SERVERLLADDRESS 1025
SET SERVERNAME 1026
SET SERVERPASSWORD 1028
SET SQLDATETIMEFORMAT 1029
SET SQLDISPLAYMODE 1031
SET SQLMATHMODE 1032
SET SUMMARYRETENTION 1034
SET TOCLOADRETENTION 1036
SETOPT 1037
SHRED DATA 1040
SUSPEND EXPORT 1042
UNDO ARCHCONVERSION 1045
UNLOCK ADMIN 1047
UNLOCK NODE 1048
UNLOCK PROFILE 1049
UPDATE ADMIN 1051
UPDATE ARCHIVE 1053
UPDATE BACKUPSET 1055
UPDATE CLIENTOPT 1060
UPDATE CLOPTSET 1061
UPDATE COLLOCGROUP 1062
UPDATE COPYGROUP 1064
UPDATE DATAMOVER 1072
UPDATE DBBACKUPTRIGGER 1074
UPDATE DEVCLASS 1076
UPDATE DOMAIN 1139
UPDATE DRIVE 1141
UPDATE LIBRARY 1145
UPDATE LIBVOLUME 1151
UPDATE MACHINE 1153
UPDATE MGMTCLASS 1155

Index 1425
commands (continued)
UPDATE NODE 1158
UPDATE NODEGROUP 1166
UPDATE PATH 1167
UPDATE POLICYSET 1173
UPDATE PROFILE 1175
UPDATE RECOVERYMEDIA 1176
UPDATE SCHEDULE 1178
UPDATE SCRIPT 1199
UPDATE SERVER 1201
UPDATE SERVERGROUP 1205
UPDATE SPACETRIGGER 1206
UPDATE STGPOOL 1210
UPDATE VIRTUALFSMAPPING 1244
UPDATE VOLHISTORY 1246
UPDATE VOLUME 1248
VALIDATE LANFREE 1254
VALIDATE POLICYSET 1256
VARY 1258
Commands
DELETE KEYRING 400
commands in a macro
committing 91
rolling back 956
commands, administrative 7
commands, canceling 15
COMMIT command 91
committing commands in a macro 91
COMMMETHOD option 1281
COMMTIMEOUT option 1282
communications, server-to-server 310
COMMMETHOD option 1281
shared memory between server and client 1281
configuration manager 359
configuration profile 279
console mode
ending 2
restrictions 2
using 2
continuation characters
for a list of values 11
for a quoted list of values 11
in output file 5
using the maximum number of 11
conventions
typographic xvii
CONVERT ARCHIVE command 94
COPIED parameter, QUERY CONTENT 660
COPY ACTIVEDATA command 97
COPY CLOPTSET command 101
COPY DOMAIN command 102
copy group
defining archive 145
defining backup 140
deleting 384
description of 139
querying 665
restriction 139
updating archive 1069
updating backup 1065
COPY MGMTCLASS command 104
COPY POLICYSET command 106
COPY PROFILE command 108
COPY SCHEDULE command 110
COPY SCRIPT 114
COPY SERVERGROUP command 115
COPYCONTINUE parameter
DEFINE STGPOOL, primary random access 328
DEFINE STGPOOL, primary sequential access 343
UPDATE STGPOOL, primary random access 1216
UPDATE STGPOOL, primary sequential access 1229
copying
management class 104
policy domain 102
policy set 106
profile 108
schedule 110
script 114
server group 115
COPYSTGPOOLS parameter
DEFINE STGPOOL, primary random access 327
DEFINE STGPOOL, primary sequential access 342
UPDATE STGPOOL, primary random access 1215
UPDATE STGPOOL, primary sequential access 1228
COUNT parameter, QUERY CONTENT 659
CRCDATA parameter
DEFINE STGPOOL, primary random access 325
DEFINE STGPOOL, primary sequential access 334, 351
UPDATE STGPOOL, primary random access 1213
UPDATE STGPOOL, primary sequential access 1222, 1236
creating
backup set 518
client files onto a set of media 518
customer support, contacting xv
D
DAMAGED parameter, QUERY CONTENT 660
data
moving 582
removing expired 463
data mover
defining 149
deleting 386
querying 670
updating 1072
data protection using WORM FILE volumes and SnapLock
when defining active-data pools 355
when defining copy storage pools 348
when defining sequential access storage pools 337
data shredding, storage pools
backing up 56
defining 329
moving data 583
updating 1217
database
auditing 1360
backup 46
backup trigger 152
backup volume information 1363
dumping 1369
extending 513
installing 1373
querying 673
reducing 895
reloading 1376
resetting maximum utilization statistic 929
restoring 1384, 1385, 1387, 1389
setting options for 1264
size, setting the maximum 318, 1208
space trigger 316
transfer by data mover 149
unloading 1391

1426 IBM Tivoli Storage Manager for Windows: Administrators Reference
database (continued)
verifying 1360
volume information 679, 1365
volume order 679
database maximum utilization statistic
resetting 929
database recovery
back up volume history 59
delete volume history 432
query volume history 870
database volume
defining 156
deleting 388
displaying information 1365
querying 679
DATAFORMAT parameter, define primary sequential access
storage pool 341, 350
DATEFORMAT option 1283
DATES parameter
IMPORT NODE 548
IMPORT SERVER 556
DAYOFWEEK parameter
UPDATE SCHEDULE
client 1188
DBBACKUPVOLUME, DSMSERV DISPLAY 1363
DBPAGESHADOW option 1284
DBPAGESHADOWFILE option 1285
DBVOLUMES, DSMSERV DISPLAY 1365
debug ANR9999D message 985
default management class, assigning 33
DEFINE ASSOCIATION command 118
DEFINE BACKUPSET command 120
DEFINE CLIENTACTION command 125
DEFINE CLIENTOPT command 130
DEFINE CLOPTSET command 134
DEFINE COLLOCGROUP command 135
DEFINE COLLOCMEMBER command 137
DEFINE COPYGROUP command 139
DEFINE DATAMOVER command 149
DEFINE DBBACKUPTRIGGER command 152
DEFINE DBCOPY command 154
DEFINE DBVOLUME command 156
DEFINE DEVCLASS command 158
DEFINE DOMAIN command 229
DEFINE DRIVE command 232
DEFINE EVENTSERVER command 237
DEFINE GRPMEMBER command 238
DEFINE LIBRARY command 240
DEFINE LOGCOPY command 250
DEFINE LOGVOLUME command 252
DEFINE MACHINE command 254
DEFINE MACHNODEASSOCIATION command 256
DEFINE MGMTCLASS command 258
DEFINE PATH command 263
DEFINE POLICYSET command 271
DEFINE PROFASSOCIATION command 273
DEFINE PROFILE command 279
DEFINE RECMEDMACHASSOCIATION command 281
DEFINE RECOVERYMEDIA command 283
DEFINE SCHEDULE command 285
DEFINE SCRIPT command 307
DEFINE SERVER command 310
DEFINE SERVERGROUP command 315
DEFINE SPACETRIGGER command 316
DEFINE STGPOOL command 321
DEFINE SUBSCRIPTION command 359
DEFINE VIRTUALFSMAPPING command 361
DEFINE VOLUME command 363
defining
association 118
backup set 120
client with schedule 286
collocation group member 137
collocation groups 135
configuration manager 359
copy group 139
database backup trigger 152
database volume 156
device class 158
domain 229
drive 232
event server 237
group member 238
library 240
management class 258
mirrored database volume 154
mirrored log volume 250
node group 261
node group member 262
object with profile 273
path for NAS data mover 263
path for NDMP (NAS) connection 263
policy set 271
profile 279
profile association 273
recovery log volume 252
schedule 285
script 307
server 310
server group 315
space trigger 316
storage pool 321
storage pool volume 363
subscription 359
DELETE ASSOCIATION command 371
DELETE BACKUPSET 373
DELETE CLIENTOPT command 378
DELETE CLOPTSET command 379
DELETE COLLOCGROUP command 380
DELETE COLLOCMEMBER command 382
DELETE COPYGROUP command 384
DELETE DATAMOVER 386
DELETE DBBACKUPTRIGGER command 387
DELETE DBVOLUME command 388
DELETE DEVCLASS command 389
DELETE DOMAIN command 390
DELETE DRIVE command 391
DELETE EVENT command 392
DELETE EVENTSERVER command 394
DELETE FILESPACE command 395
DELETE KEYRING command 400
DELETE LIBRARY command 401
DELETE LOGVOLUME command 402
DELETE MACHINE command 403
DELETE MACHNODEASSOCIATION command 404
DELETE MGMTCLASS command 405
DELETE PATH 409
DELETE POLICYSET command 411
DELETE PROFASSOCIATION command 412
DELETE PROFILE command 415
DELETE RECMEDMACHASSOCIATION command 417, 988
DELETE RECOVERYMEDIA command 418
DELETE SCHEDULE command 419
DELETE SCRIPT command 422

Index 1427
DELETE SERVER command 423
DELETE SERVERGROUP command 424
DELETE SPACETRIGGER command 425
DELETE STGPOOL command 427
DELETE SUBSCRIBER command 429
DELETE SUBSCRIPTION command 430
DELETE VIRTUALFSMAPPING command 431
DELETE VOLHISTORY command 432
DELETE VOLUME command 437
deleting
archive file deletion via a client, allowing 905, 1160
backup file deletion via a client, allowing 906, 1160
backup set 373
collocation group 380
collocation group member 382
copy group 384
database backup trigger 387
database volume 388
device class 389
domain 390
drive 391
event record 392
event server 394
expired data 463
file space 395
group member 399
library 401
management class 405
node group 407
node group member 408
policy set 411
profile 415
profile association 412
recovery log volume 402
schedule 419
script 422
server 423
server group 424
space trigger 425
storage pool 427
storage pool volume 437
subscriber 429
subscription 430
volume history 432
determining retention periods for policy domains 687
DEVCONFIG option 1286
device class
3590 1080
3592 166
CENTERA 181, 1097
defining 158
deleting 389
NAS 208, 1122
OPTICAL 1124
QIC 215, 1128
querying 682
updating 1076
VOLSAFE 77, 225, 1136
WORM 1124
device configuration file 49
device driver, utility for writing to tape 1357
device names
for devices connected to NAS file server 265, 1168
device type
3570 159
3590 162, 1077, 1080
3592 166, 1084
device type (continued)
4MM 171, 1088
8MM 175, 1092
CENTERA 181, 1097
DLT 183, 1099, 1104
DTF 189
ECARTRIDGE 192, 1107
FILE 197, 686
GENERICTAPE 200, 1115
LTO 203, 1117
NAS 208, 1122
OPTICAL 211, 1124
QIC 215, 1128
REMOVABLEFILE 220, 1132
SERVER 223, 1134
VOLSAFE 225, 1136
WORM 211, 1124
WORM12 211, 1124
WORM14 211, 1124
directories, specifying multiple for FILE volumes 198, 1112
DISABLE EVENTS 441
DISABLE EVENTS command 441
DISABLE SESSIONS command 445
DISABLESCHEDS option 1287
disabling
context messaging for ANR9999D messages 985
server 445
DISCARDDATA parameter 438
disk space, migrating data to create 325, 579, 1213
disk volume performance 321
disk volumes 321
disk-only backup
defining FILE device classes 198
defining volumes 363
updating FILE device classes 1112
DISKMAP option 1289
DISMOUNT VOLUME command 448
dismounting volumes 448
DISPLAY
DBBACKUPVOLUME, DSMSERV 1363
DBVOLUMES, DSMSERV 1365
LOGVOLUMES, DSMSERV 1367
DISPLAY OBJNAME command 450
displaying
database volumes 679
full object name 450
output 6
recovery log volumes 746
scheduled and completed events 708
DISPLAYLFINFO option 1288
DLT
device type 183
WORM media 184
domain
associating with profile 273
copy 102
defining 229
deleting 390
distributing 279
querying 687
updating 1139
drive
cleaning 89, 234
defining 232, 691
deleting 391
querying 691
updating 1141

1428 IBM Tivoli Storage Manager for Windows: Administrators Reference
drive encryption
3592 device class 170, 1086
LTO device class 207, 1120
DRIVEACQUIRERETRY option 1290
DRIVEENCRYPTION parameter
3592 device class 170, 1086
LTO device class 207, 1120
DSMADMC command 1
DSMADMC options 5
DSMMAXSG utility 1357
DSMSERV AUDITDB command 1360
DSMSERV command 1358
DSMSERV DISPLAY DBBACKUPVOLUME command 1363
DSMSERV DISPLAY DBVOLUMES command 1365
DSMSERV DISPLAY LOGVOLUMES command 1367
DSMSERV DUMPDB command 1369
DSMSERV EXTEND LOG command 1372
DSMSERV FORMAT command 1373
DSMSERV LOADDB command 1376
DSMSERV LOADFORMAT command 1379
DSMSERV RESTORE DB command 1384
DSMSERV RUNFILE command 1358
DSMSERV UNLOADDB command 1391
DUMPDB, DSMSERV 1369
dumping the IBM Tivoli Storage Manager database 1369
DURATION parameter
DEFINE SCHEDULE, administrative command 302
DEFINE SCHEDULE, client 293
SHRED DATA, administrative command 1040
UPDATE SCHEDULE, administrative command 1194
UPDATE SCHEDULE, client 1186
E
ECARTRIDGE device type 192
education
see Tivoli technical training xiv
ENABLE EVENTS command 452
ENABLE SESSIONS command 455
ENABLECLIENTENCRYPTKEY option 131
enabling
context messaging for ANR9999D 985
server 455
encryption
application
3592 170, 1086
LTO 207, 1120
drive
3592 170, 1086
LTO 207, 1120
library 170, 1086
system 170, 1086
END EVENTLOGGING command 458
ENDDATE parameter 632, 711, 766
ending
batch mode 3
console mode 2
interactive mode 2
mount mode 3
ENDTIME parameter 633, 711, 766
error
ANR9999D message 985, 1372
file specification 128, 291, 1183
In Progress status for QUERY EVENT 714
LOGSEG871 error 1372
ESTCAPACITY parameter
DEFINE DEVCLASS
3570 160
3590 164
3592 168
4MM 172
8MM 178
DLT 186
DTF 190
ECARTRIDGE 195
GENERICTAPE 201
LTO 205
NAS 209
Optical/WORM 213
QIC 218
VOLSAFE 226
UPDATE DEVCLASS
3570 1078
3590 1081
3592 1085
4MM 1089
8MM 1095
DLT 1102
DTF 1105
ECARTRIDGE 1109
GENERICTAPE 1115
NAS 1123
Optical/WORM 1126
QIC 1130
VOLSAFE 1137
ESTIMATE DBREORGSTATS command 460
event logging
send events to receivers 62
set logging off by receivers 458
event record
description of 392, 1005
managing 1005
querying 708
removing from the database 392
setting retention period 1005
event record retention period
managing 1005
querying 843
event, querying 708
EVENTSERVER option 1291
EXCEPTIONSONLY parameter 711
EXPINTERVAL option 1292
EXPIRATION parameter
DEFINE SCHEDULE, administrative command 298
DEFINE SCHEDULE, client 286
UPDATE SCHEDULE, administrative command 1190
UPDATE SCHEDULE, client 1179
EXPIRE INVENTORY command 463
expiring inventory 463
export
administrator 467
node 473
policy information 491
server 497
EXPORT ADMIN command 467
EXPORT NODE command 473
EXPORT POLICY command 491
EXPORT SERVER command 497
EXPQUIET option 1293
EXTEND DB command 513
EXTEND LOG command 515
EXTEND LOG, DSMSERV 1372

Index 1429
extending
database 513
recovery log 515
F
FILE device type
concurrent read/write access to FILE volumes
increasing number of client mount points 907, 1161
visible as output in QUERY MOUNT 763
visible as output in QUERY SESSION 835
creating and formatting private volumes 363
defining the device class 197
updating the device class 1111
file server, NAS
names for connected devices 265, 1168
node 149, 906
file space
automatic rename for Unicode support 1161
deleting 395
FSID 920
hexadecimal representation 920
querying 730
renaming 919
specification errors, restrictions 126, 289, 1182
FILEDATA parameter
EXPORT NODE 477, 485
IMPORT NODE 547
FILEEXIT option 1294
FILENAMES parameter
BACKUP DEVCONFIG 49
BACKUP VOLHISTORY 60
files
collocating by client 337, 346, 353
moving 582
removing expired 463
FILESPACE parameter
EXPORT NODE 476, 484
IMPORT NODE 546
FILETEXTEXIT option 1295
firewall, opening server ports
administrative sessions 1337
client sessions 1339
TCP/IP ports 1337, 1339
fixes, obtaining xv
FORCE parameter, CHECKOUT LIBVOLUME 86
FORMAT parameter
DEFINE DEVCLASS
3570 159
3590 162
3592 167
4MM 172
8MM 176
DLT 184
DTF 189
ECARTRIDGE 193
LTO 204
Optical/WORM 212
QIC 216
VOLSAFE 226
UPDATE DEVCLASS
3570 1077
3590 1080
3592 1084
4MM 1088
8MM 1092
DLT 1100
FORMAT parameter (continued)
UPDATE DEVCLASS (continued)
DTF 1104
ECARTRIDGE 1108
LTO 1118
QIC 1124, 1129
VOLSAFE 1136
FORMAT, DSMSERV 1373
FREQUENCY parameter
DEFINE COPYGROUP, archive 146
DEFINE COPYGROUP, backup 141
UPDATE COPYGROUP, archive 1069
UPDATE COPYGROUP, backup 1066
full object name
displaying 450
G
GENERATE BACKUPSET command 518
GENERATE BACKUPSETTOC 526
GENERICTAPE device type 200, 1115
globally unique identifier (GUID) 773
GRANT AUTHORITY command 530
GRANT PROXYNODE command 534
granting
authority 530
types of privilege classes 530
group, collocation by
defining a group 135
defining a group member 137
deleting a group 380
deleting a group member 382
querying a group 656
updating a group 1062
group, node
defining 261
defining a member 262
deleting a group 407
deleting a member 408
querying a group 778
updating a group 1166
GUID 773
H
HALT command 536
halting the server 536
HBA (host bus adapter), utility for writing to tape 1357
HELP command 538
help for administrative commands 538
hierarchical storage management
DEFINE MGMTCLASS 258
description of 258
UPDATE MGMTCLASS 1155
hierarchy of storage pools
considerations for backup 55
defining 321
high level address, Centera 181, 1097
HIGHMIG parameter
DEFINE STGPOOL
primary random access 325
primary sequential access 334
UPDATE STGPOOL
primary random access 1213
primary sequential access 1222

1430 IBM Tivoli Storage Manager for Windows: Administrators Reference
history information
backing up 59
deleting 432
querying 870
host bus adapter (HBA), utility for writing to tape 1357
HSM (hierarchical storage management) 259, 1155
I
IBM Software Support
submitting a problem xvi
IBM Support Assistant xiv
IDLETIMEOUT option 1296
IMPORT ADMIN command 542
IMPORT NODE command 545
IMPORT POLICY command 551
IMPORT SERVER command 554
importing
administrator 542
node 545
policy information 551
server 554
In Progress status for QUERY EVENT command 714
INCRDEVCLASS parameter
DEFINE DBBACKUPTRIGGER 152
UPDATE DBBACKUPTRIGGER 1074
incremental backup of database 46
inheritance, copy storage pool lists and
defining random access storage pools 328
defining sequential access storage pools 342
updating random access storage pools 1215
updating sequential access storage pools 1228
INSERT MACHINE command 560
installing
database 1373
recovery log 1373
interactive mode
continuation characters 11
ending 2
quitting 885
restrictions 3
using 3
Internet, search for problem resolution xiv
Internet, searching for problem resolution xv
inventory expiring 463
IP address, Centera 181, 1097
ISSUE MESSAGE command 562
issuing commands for a one-time action 125
ITEMCOMMIT option 6
K
knowledge bases, searching xiv
L
label
for REMOVABLEFILE device type 232
library volume 565
LAN-free data movement
validating 1254
language limitations 1
LANGUAGE option 1297
library
auditing 36
defining 240
library (continued)
deleting 401
querying 736
RSM 245
shared 246, 1148
updating 1145
library volume
checking in 73
checking out 82
labeling 565
querying 739
updating 1151
license
auditing 38
querying 742
registering 901
setting audit period 1008
LOADDB, DSMSERV 1376
LOADFORMAT, DSMSERV 1379
LOCK ADMIN command 572
LOCK NODE command 573
LOCK PROFILE command 574
locking
administrator 572
node 573
profile 574
log mode, setting 1009
log volume, displaying 746
LOG, DSMSERV EXTEND 1372
LOGFULLPCT parameter
DEFINE DBBACKUPTRIGGER 152
UPDATE DBBACKUPTRIGGER 1074
logic flow statements in scripts 1395
LOGPOOLSIZE option 1298
LOGSEG error 1372
LOGVOLUMES, DSMSERV DISPLAY 1367
LOGWARNFULLPERCENT option 1299
LOWMIG parameter
DEFINE STGPOOL
primary random access 326
primary sequential access 335
UPDATE STGPOOL
primary random access 1213
primary sequential access 1223
LTO
device class
defining 203
updating 1117
WORM 204
M
MACRO command 576
macros
continuation characters 11
rolling back 956
using 576
managed server 359
managed system for storage area network (SAN)
DEFINE LIBRARY command 240
UPDATE LIBRARY command 1145
management class
copying 104
defining the default 33
deleting 405
querying 760
updating 1155

Index 1431
MAXCAPACITY parameter
DEFINE DEVCLASS
FILE 197
REMOVABLEFILE 221
SERVER 223
UPDATE DEVCLASS
FILE 1111
REMOVABLEFILE 1132
SERVER 1134
maximum retries, setting 1011
MAXPROCESS parameter
BACKUP STGPOOL 56
UPDATE STGPOOL 943
MAXSCRATCH parameter
DEFINE STGPOOL
active-data pool 356
copy sequential access 349
primary sequential access 338
UPDATE STGPOOL
active-data pool 1241
copy sequential access 1235
primary sequential access 1226
MAXSESSIONS option 1300
MAXSIZE parameter
DEFINE STGPOOL
primary random access 324
primary sequential access 334
UPDATE STGPOOL
primary random access 1212
primary sequential access 1221
media mount requests 69
media support, CD-ROM 220
media type, RSM 245
member, server group 238
MERGEFILESPACES parameter
EXPORT NODE 489
EXPORT SERVER 510
IMPORT NODE 549
IMPORT SERVER 554
message diagnosis, ANR9999D 985
MESSAGEFORMAT option 1301
MIGDESTINATION parameter
DEFINE MGMTCLASS 259
UPDATE MGMTCLASS 1156
MIGPROCESS parameter
DEFINE STGPOOL, primary random access 326
UPDATE STGPOOL, primary random access 1214
MIGRATE STGPOOL command 578
migration
files from client node 259
specifying multiple concurrent processes
using the DEFINE STGPOOL command 340
using the UPDATE STGPOOL command 1227
starting manually 578
storage pool, random access
high migration threshold 325, 1213
low migration threshold 326, 579, 1213
storage pool, sequential access
high migration threshold 334, 1222
low migration threshold 335, 579, 1223
MIGREQUIRESBKUP parameter
DEFINE MGMTCLASS 259
UPDATE MGMTCLASS 1156
mirrored database volume
defining 154
description of 154
mirrored log volume
defining 250
description of 156
MIRRORREAD option 1302
MIRRORWRITE option 1303
MODE parameter
DEFINE COPYGROUP, archive 147
DEFINE COPYGROUP, backup 142
UPDATE COPYGROUP, archive 1070
UPDATE COPYGROUP, backup 1067
monitoring
Tivoli Storage Manager activities 3
monitoring Tivoli Storage Manager activities 2
mount mode
ending 3
using 3
mount request 69
canceling 69
querying 803
mounted sequential access volumes
dismounting 448
querying 763
MOUNTLIMIT parameter
DEFINE DEVCLASS
3570 161
3590 164
3592 169
4MM 174
8MM 175
CENTERA 182
DLT 187
DTF 191
ECARTRIDGE 196
GENERICTAPE 201
LTO 206
NAS 209
Optical/WORM 214
QIC 219
REMOVABLEFILE 221
SERVER 224
VOLSAFE 227
UPDATE DEVCLASS
3570 1079
3590 1080
3592 1086
4MM 1090
8MM 1092
CENTERA 1098
DLT 1102
DTF 1106
ECARTRIDGE 1110
FILE 1111
GENERICTAPE 1116
LTO 1120
Optical/WORM 1126
QIC 1131
REMOVABLEFILE 1133
VOLSAFE 1138
MOUNTRETENTION parameter
DEFINE DEVCLASS
3570 161
3590 164
3592 169
4MM 173
8MM 179
DLT 187
DTF 191

1432 IBM Tivoli Storage Manager for Windows: Administrators Reference
MOUNTRETENTION parameter (continued)
DEFINE DEVCLASS (continued)
ECARTRIDGE 195
GENERICTAPE 201
LTO 206
NAS 208
Optical/WORM 213
QIC 218
REMOVABLEFILE 221
SERVER 224
VOLSAFE 227
UPDATE DEVCLASS
3570 1078
3590 1082
3592 1086
4MM 1090
8MM 1095
DLT 1102
DTF 1105
ECARTRIDGE 1109
GENERICTAPE 1115
LTO 1119
NAS 1122
Optical/WORM 1126
QIC 1131
REMOVABLEFILE 1132
SERVER 1135
VOLSAFE 1137
MOUNTWAIT parameter
DEFINE DEVCLASS
3570 161
3590 164
3592 169
4MM 173
8MM 179
DLT 187
DTF 191
ECARTRIDGE 196
GENERICTAPE 201
LTO 206
NAS 209
Optical/WORM 213
QIC 218
REMOVABLEFILE 221
VOLSAFE 227
UPDATE DEVCLASS
3570 1078
3590 1082
3592 1086
4MM 1090
8MM 1095
DLT 1102
DTF 1105
ECARTRIDGE 1110
GENERICTAPE 1116
LTO 1120
NAS 1122
Optical/WORM 1126
QIC 1131
REMOVABLEFILE 1132
SERVER 1135
VOLSAFE 1138
MOVE DATA command 582
MOVE DRMEDIA command 586
MOVE GRPMEMBER command 600
MOVE MEDIA command 601
MOVE NODEDATA command 609
MOVEBATCHSIZE option 1304
MOVESIZETHRESH option 1305
moving
data in storage pool 582
files 582
group member 600
MSGINTERVAL option 1306
MSGNO parameter, QUERY ACTLOG 633
MSGSTACKTRACE option 1307
N
name
devices 265
for device connected to NAS file server 265, 1168
NAMEDPIPENAME option 1308
naming conventions
introduction 12
naming volumes 12
passwords 12
restrictions 12
NAS file server
data mover, defining 149
name for connected device 265, 1168
node name 149
path, defining 263
NDMPCONTROLPORT option 1309
NDMPPORTRANGE option 1310
NetApp DataONTAP, for managing FILE volumes
when defining active-data pools 355
when defining copy storage pools 348
when defining sequential access storage pools 337
network-attached storage (NAS) file server
data mover, defining 149
device class 208, 1122
path, defining 263
NEXTSTGPOOL parameter
DEFINE STGPOOL
primary random access 325
primary sequential access 334
UPDATE STGPOOL
primary random access 1213
primary sequential access 334, 1222
node
associating with a schedule 118
exporting 473
finding file for 780
importing 545
locking 573
name for data mover 149
NAS file server 149, 906
node group
defining a group 261
defining a member 262
deleting a group 407
deleting a member 408
querying a group 778
updating a group 1166
querying 768
registering 903
removing 915
renaming 922
unlocking 1048
updating 1158
NOPREEMPT option 1311
NORETRIEVEDATE option 1312
normal recovery log mode 46, 1009

Index 1433
NOTIFY SUBSCRIBERS command
example 619
related commands 619
NPAUDITFAILURE option 1313
NPAUDITSUCCESS option 1314
NPBUFFERSIZE option 1315
NUMBERFORMAT option 1316
NUMINCREMENTAL parameter
DEFINE DBBACKUPTRIGGER 152
UPDATE DBBACKUPTRIGGER 1074
O
OBJECTS parameter
DEFINE SCHEDULE, client 293
UPDATE SCHEDULE, client 1186
occupancy
displaying file space information 780
querying 780
offsite volumes, specifying the number to be reclaimed
using the DEFINE STGPOOL command 349, 356
using the UPDATE STGPOOL command 1235, 1241
OPTICAL device type 211, 1124
option set 130
OPTIONS parameter
DEFINE SCHEDULE, client 293
UPDATE SCHEDULE, client 1186
options, client 130
options, server
importance for recovery 46
querying 784
order
query db volumes 679
query log volumes 746
output
displaying 6
OWNER parameter, DELETE FILESPACE 397
P
PARALLEL command 620
parameters, descriptions in 14
parameters, entering 10
password
case-sensitivity 12
characters allowed for entering 12
entered with the REGISTER ADMIN command 899
entered with the REGISTER NODE command 903
entered with the UPDATE ADMIN command 1051
setting expiration interval 1014
setting the maximum length 12
path
defining 263
deleting 409
querying 786
updating 1167
pattern-matching expression, creating 12
performance
improving communications with client using shared
memory 1281, 1328
limiting offsite volumes to be reclaimed
using the DEFINE STGPOOL command 349, 356
using the UPDATE STGPOOL command 1235, 1241
specifying multiple concurrent migration processes
using the DEFINE STGPOOL command 340
using the UPDATE STGPOOL command 1227
performance (continued)
specifying multiple concurrent reclamation processes
using the DEFINE STGPOOL command 348, 355
using the UPDATE STGPOOL command 1234, 1240
PERUNITS parameter
DEFINE SCHEDULE, administrative command 304
UPDATE SCHEDULE, administrative command 1196
UPDATE SCHEDULE, client 1188
policy domain
associating with profile 273
copy 102
defining 229
deleting 390
distributing 279
querying 687
updating 1139
policy privilege class
privilege class
policy 20
restricted 20
unrestricted 20
policy set
activating 30
copying 106
defining 271
deleting 411
querying 790
updating 1173
validating 1256
polling
information about 1016
setting frequency 1016
Pool Entry Authorization (PEA) file, Centera 181, 1097
ports for firewall
administrative sessions 1337
client sessions 1339
TCP/IP ports 1337, 1339
preempting of operations 1311
PREFIX parameter
DEFINE DEVCLASS
3570 160
3590 164
3592 168
4MM 173
8MM 179
DLT 187
DTF 190
ECARTRIDGE 195
LTO 206
NAS 209
QIC 218
SERVER 224
VOLSAFE 227
UPDATE DEVCLASS
3570 1078
3590 1082
3592 1086
4MM 1090
8MM 1095
DLT 1102
DTF 1105
ECARTRIDGE 1109
LTO 1119
NAS 1122, 1123
QIC 1130
SERVER 1134
VOLSAFE 1137

1434 IBM Tivoli Storage Manager for Windows: Administrators Reference
PREPARE command 624
preparing to use the DSMSERV LOADFORMAT utility 1379
PREVIEW parameter
EXPORT NODE 547
IMPORT NODE 477
PREVIEWIMPORT parameter
EXPORT ADMIN 472
EXPORT NODE 489
EXPORT POLICY 495
EXPORT SERVER 510
printing redirected output 4
privilege class
administrator issued 24
analyst 23
none required 24
operator 22
policy 21
restricted 21
storage 21, 22
system 18
unrestricted 21
problem determination
describing problem for IBM Software Support xvi
determining business impact for IBM Software
Support xvi
submitting a problem to IBM Software xvi
process
canceling 67
querying 793
profile 279
profile association 273
protecting WORM volumes with SnapLock
when defining active-data pools 355
when defining copy storage pools 348
when defining sequential access storage pools 337
publications
download xi
order xi
related hardware xiii
search xi
Tivoli Storage Manager xi
Q
QIC device type 215, 1128
QUERY ACTLOG command 631
QUERY ADMIN command 637
QUERY ASSOCIATION command 641
QUERY AUDITOCCUPANCY command 643
QUERY BACKUPSET 646
QUERY BACKUPSETCONTENTS 651
QUERY CLOPTSET command 654
QUERY COLLOCGROUP command 656
QUERY CONTENT command 658
QUERY COPYGROUP command 665
QUERY DATAMOVER command 670
QUERY DB command 673
QUERY DBBACKUPTRIGGER command 677
QUERY DBVOLUME command 679
QUERY DEVCLASS command 682
QUERY DOMAIN command 687
QUERY DRIVE command 691
QUERY DRMEDIA command 695
QUERY DRMSTATUS command 703
QUERY ENABLED command 706
QUERY EVENT command 708
QUERY EVENTRULES command 720, 723
QUERY FILESPACE command 730
QUERY LIBRARY command 736
QUERY LIBVOLUME command 739
QUERY LICENSE command 742
QUERY LOG command 743
QUERY LOGVOLUME command 746
QUERY MACHINE command 749
QUERY MEDIA command 753
QUERY MGMTCLASS command 760
QUERY MOUNT command 763
QUERY NASBACKUP command 765
QUERY NODE command 768
QUERY NODEDATA command 775
QUERY OCCUPANCY command 780
QUERY OPTION command 784
QUERY PATH command 786
QUERY POLICYSET command 790
QUERY PROCESS command 793
QUERY PROFILE command 795
QUERY PROXYNODE command 799
QUERY RECOVERYMEDIA command 800
QUERY REQUEST command 803
QUERY RESTORE command 804
QUERY RPFCONTENT command 807
QUERY RPFILE command 809
QUERY SAN command 812
QUERY SCHEDULE command 815
QUERY SCRIPT command 823
QUERY SERVER command 827
QUERY SERVERGROUP command 831
QUERY SESSION command 833
QUERY SHREDSTATUS command 836
QUERY SPACETRIGGER command 838
QUERY SQLSESSION command 841
QUERY STATUS command 843
QUERY STGPOOL command 849
QUERY SUBSCRIBER command 858
QUERY SUBSCRIPTION command 860
QUERY SYSTEM command 862
QUERY TAPEALERTMSG command 864
QUERY TOC command 865
QUERY VIRTUALFSMAPPING command 868
QUERY VOLHISTORY command 870
QUERY VOLUME command 878
QUERYAUTH server option 1317
querying
activity log 631
administrator 637
audit occupancy 643
backup sets 646
clients with schedules 641
completed events 708
contents of a backup set 651
contents of a volume 658
copy group 665
database 673
database backup trigger 677
database volume 679
device class 682
domain 687
drive 691
event server 723
file space 730
library 736
library volume 739
license 742
management class 760

Index 1435
querying (continued)
mount requests 803
node 768
node groups 778
occupancy 780
option 784
policy set 790
process 793
profile 795
recovery log 743
recovery log volume 746
recovery plan file 809
recovery plan file content 807
scheduled events 708
schedules 815
script 823
server group 831
session 833
space trigger 838
status 843
storage pool 849
storage pool volume 878
subscriber 858
subscription 860
volume history file 870
QUIT command 885
quitting
batch mode 3
interactive mode 2, 885
mount mode 3
R
random access volumes 321
raw partitions, performance effect 321
RECLAIM parameter
DEFINE STGPOOL
active-data pool 354
copy sequential access 347
primary sequential access 335
UPDATE STGPOOL
active-data pool 1240
copy sequential access 1234
primary sequential access 1223
RECLAIM STGPOOL command 887
reclamation of volumes
specifying a threshold of reclaimable space
using the DEFINE STGPOOL command 335, 347, 354
using the UPDATE STGPOOL command 1223, 1234,
1240
specifying multiple concurrent processes
using the DEFINE STGPOOL command 348, 355
using the UPDATE STGPOOL command 1234, 1240
starting manually 887
RECLAMATIONTYPE parameter
defining active-data pools 355
defining copy storage pools 348
defining sequential access storage pools 337
RECONCILE VOLUMES command 891
recoverable space 460, 675
recovery log
backup trigger 152
consumption statistic, resetting 930
displaying log volumes 746
error, ANR9999D with LOGSEG 1372
extending 515
installing 1373
recovery log (continued)
maximum utilization statistic, resetting 931
reducing 896
setting mode 1009
setting options for 1264
volume information 1367
recovery log volume
defining 252
deleting 402
querying 746
recovery plan file
display contents 807
query information 809
set expire days 1002
recovery plan prefix 997
redirecting command output 4
redirection characters
types of 4
using 4
REDUCE DB command 895
REDUCE LOG command 896
reducing
database 895
recovery log 896
REGISTER ADMIN command 899
REGISTER LICENSE command 901
REGISTER NODE command 903
registering
administrator 899
license 901
node 903
registration
closed 1019
description of 1019
setting 1019
reloading the database 1376
REMOVABLEFILE device type 220, 1132
REMOVABLEFILE, CD-ROM support 220
REMOVE ADMIN command 914
REMOVE NODE command 915
removing
administrator 914
client association 371
node 915
RENAME ADMIN command 918
RENAME FILESPACE command 919
RENAME NODE command 922
RENAME SCRIPT command 923
RENAME SERVERGROUP command 924
RENAME STGPOOL command 925
renaming
administrator 918
file space 919
node 922
script 923
server group 924
storage pool 925
REPLACEDEFS parameter
EXPORT ADMIN 472
EXPORT NODE 489
EXPORT POLICY 495
EXPORT SERVER 510
IMPORT ADMIN 543
IMPORT NODE 549
IMPORT POLICY 552
REPLY command 926
reporting error message for ANR9999D 985

1436 IBM Tivoli Storage Manager for Windows: Administrators Reference
REPORTRETRIEVE server option 1318
REQSYSAUTHOUTFILE option 1319
request, mount 69, 803
RESET BUFPOOL command 928
RESET DBMAXUTILIZATION command 929
RESET LOGCONSUMPTION command 930
RESET LOGMAXUTILIZATION command 931
RESET PASSEXP command 932
resetting
buffer pool statistic 928
maximum utilization statistic (recovery log) 931
recovery log consumption statistic 930
RESOURCETIMEOUT option 1320
RESTORE DB, DSMSERV 1382
RESTORE NODE command 937
RESTORE STGPOOL command 941
RESTORE VOLUME command 945
RESTOREINTERVAL option 1321
restoring
as action on client command 126, 289, 1182
increasing throughput 1357
retention period
description of 1005
setting 1005
retention period, event record
managing 1005
querying 843
RETENTIONEXTENSION option 1322
RETONLY parameter
DEFINE COPYGROUP, backup 142
UPDATE COPYGROUP, backup 1067
retrieving, increasing throughput when 1357
retry period
description of 1021
setting 1021
return code checking 1395
RETVER parameter
DEFINE COPYGROUP, archive 146
UPDATE COPYGROUP, archive 1069
REUSEDELAY parameter
DEFINE STGPOOL
active-data pool 357
copy sequential access 350
primary sequential access 339
UPDATE STGPOOL
active-data pool 1242
copy sequential access 1236
primary sequential access 1226
reusing volumes
active-data pool 354, 1240
copy sequential access 347, 1234
primary sequential access 335, 1223
REVOKE AUTHORITY command 951
REVOKE PROXYNODE command 955
revoking
authority 951
types of privilege classes 951
roll-forward recovery log mode 46, 1009
ROLLBACK command 956
rolling back commands in a macro 956
routing commands 15
RSM library type 245
RUN command 957
S
SAN
DEFINE LIBRARY command 240
UPDATE LIBRARY command 1145
SAN tape devices 244, 247
SANREFRESHTIME server option 1324
schedule
administrative command 298
associating with a client node 118
client 286, 298
copying 110
defining 258, 285
deleting 419
description of 298
querying 815
querying results of (events) 708
restrictions of 286
startup window, defining schedule 293, 302
startup window, updating schedule 1186, 1194
types of 285
updating 1178
schedule event
querying 708
setting start date for displaying 709
setting start time for displaying 710, 711, 716, 717
viewing information about 708
scheduling mode
information about 1022
setting 1022
scratch volumes in storage pool
defining a storage pool 338, 349, 356
updating a storage pool 1226, 1235, 1241
scripts
copying 114
defining 307
deleting 422
DSMMAXSG 1357
querying 823
renaming 923
running 957
running commands in parallel 620
running commands serially 971
updating 1199
SEARCHMPQUEUE option 1325
SECUREPIPE option 1326
security, encryption
3592 devices 170, 1086
LTO devices 207, 1120
SELECT command 960
SELFTUNEBUFPOOLSIZE option 1327
sequential volume history
backing up 59
deleting 432
display sequential volume history 870
querying 870
SERIAL command 971
SERIALIZATION parameter
DEFINE COPYGROUP, archive 147
DEFINE COPYGROUP, backup 142
UPDATE COPYGROUP, archive 1070
UPDATE COPYGROUP, backup 1067
server
disabling 445
enabling 455
exporting 497
importing 554
migrating 578

Index 1437
server (continued)
reclaiming 887
setting name for 1026
server console
restrictions 7
using 7
server name settings 1026
server options
3494SHARED 1267
ACSACCESSID 1268
ACSLOCKDRIVE 1269
ACSQUICKINIT 1270
ACSTIMEOUTX 1271
ADMINONCLIENTPORT 1272
ADREGISTER 1273
ADSETDC 1274
ADSMGROUPNAME 1275
ADUNREGISTER 1276
ALIASHALT 1277
ASSISTVCRRECOVERY 1278
AUDITSTORAGE 1279
BUFPOOLSIZE 1280
changing with SETOPT command 784
COMMMETHOD 1281
COMMTIMEOUT 1282
DATEFORMAT 1283
DBPAGESHADOW 1284
DBPAGESHADOWFILE 1285
DEVCONFIG 1286
DISABLESCHEDS 1287
DISKMAP 1289
DISPLAYLFINFO 1288
DRIVEACQUIRERETRY 1290
EVENTSERVER 1291
EXPINTERVAL 1292
EXPQUIET 1293
FILEEXIT 1294
FILETEXTEXIT 1295
IDLETIMEOUT 1296
LANGUAGE 1297
LOGPOOLSIZE 1298
LOGWARNFULLPERCENT 1299
MAXSESSIONS 1300
MESSAGEFORMAT 1301
MIRRORREAD 1302
MIRRORWRITE 1303
modifying the file 1261
MOVEBATCHSIZE 1304
MOVESIZETHRESH 1305
MSGINTERVAL 1306
MSGSTACKTRACE 1307
NAMEDPIPENAME 1308
NDMPCONTROLPORT 1309
NDMPPORTRANGE 1310
NOPREEMPT 1311
NORETRIEVEDATE 1312
NPAUDITFAILURE 1313
NPAUDITSUCCESS 1314
NPBUFFERSIZE 1315
NUMBERFORMAT 1316
QUERYAUTH 1317
querying 1261
REPORTRETRIEVE 1318
REQSYSAUTHOUTFILE 1319
RESOURCETIMEOUT 1320
RESTOREINTERVAL 1321
RETENTIONEXTENSION 1322
server options (continued)
SANREFRESHTIME 1324
SEARCHMPQUEUE 1325
SECUREPIPE 1326
SELFTUNEBUFPOOLSIZE 1327
SHMPORT 1328
SHREDDING 1329
SNMPHEARTBEATINTERVAL 1330
SNMPMESSAGECATEGORY 1331
SNMPSUBAGENT 1332
SNMPSUBAGENTHOST 1333
SNMPSUBAGENTPORT 1334
SSLTCPADMINPORT 1335
SSLTCPPORT 1336
tailoring 1261
TCPADMINPORT 1337
TCPNODELAY 1338
TCPPORT 1339
TCPWINDOWSIZE 1340
TECBEGINEVENTLOGGING 1341
TECHOST 1342
TECPORT 1343
TECUTF8EVENT 1344
THROUGHPUTDATATHRESHOLD 1345
THROUGHPUTTIMETHRESHOLD 1346
TIMEFORMAT 1347
TXNGROUPMAX 1348
UNIQUETDPTECEVENTS 1349
UNIQUETECEVENTS 1350
VOLUMEHISTORY 1353
server scripts
copying 114
defining 307
deleting 422
DSMMAXSG 1357
querying 823
renaming 923
running 957
running commands in parallel 620
running commands serially 971
updating 1199
server-to-server communications 310
COMMMETHOD option 1281
shared memory between server and client 1281
session
maximum number scheduled 1012
querying 833
SET ACCOUNTING command 974, 1033
SET ACTLOGRETENTION command 975
SET AUTHENTICATION command 979
SET CLIENTACTDURATION command 980
SET CONFIGMANAGER command 981
SET CONFIGREFRESH command 983
SET CROSSDEFINE command 986
SET DRMCHECKLABEL command 987
SET DRMCMDFILENAME command 988
SET DRMCOPYSTGPOOL command 989
SET DRMCOURIERNAME command 990
SET DRMDBBACKUPEXPIREDAYS command 991
SET DRMFILEPROCESS command 993
SET DRMINSTRPREFIX command 994
SET DRMNOTMOUNTABLENAME command 996
SET DRMPLANPREFIX command 997
SET DRMPLANVPOSTFIX command 999
SET DRMPRIMSTGPOOL command 1001
SET DRMRPFEXPIREDAYS command 1002
SET DRMVAULTNAME command 1004

1438 IBM Tivoli Storage Manager for Windows: Administrators Reference
SET EVENTRETENTION command 1005
SET INVALIDPWLIMIT command 1007
SET LICENSEAUDITPERIOD command 1008
SET LOGMODE command 1009
SET MAXCMDRETRIES command 1011
SET MAXSCHEDSESSIONS command 1012
SET MINPWLENGTH command 1013
SET PASSEXP command 1014
SET QUERYSCHEDPERIOD 1016
SET RANDOMIZE command 1017
SET REGISTRATION command 1019
SET RETRYPERIOD command 1021
SET SCHEDMODES command 1022
SET SERVERHLADDRESS command 1024
SET SERVERLLADDRESS command 1025
SET SERVERNAME command 1026
SET SERVERPASSWORD command 1028
SET SQLDATETIMEFORMAT command 1029
SET SQLDISPLAYMODE command 1031
SET SQLMATHMODE command 1032
SET SUBFILE command 1033
SET SUMMARYRETENTION command 1034
SET TAPEALERTMSG command 1035
SET TOCLOADRETENTION command 1036
SETARCHIVERETENTIONPROTECTION command 977
SETOPT command 1037
setting
accounting record 974
authentication 979
configuration manager 981
configuration refresh 983
cross define of a server 986
frequency for client-polling 1016
frequency for one-time client action 980
high level address of a server 1024
license audit period 1008
low level address of a server 1025
maximum retries of a command 1011
maximum scheduled sessions 1012
password for a server 1028
password for expiration date 1014
randomization of start times 1017
recovery log mode 1009
registration 1019
retention period for activity log 975
retention period for event records 1005
retry period 1021
scheduling mode 1022
server name 1026
summary retention days 1034
setting communication options 1262
shared library type 246, 1148
SHMPORT option 1328
specifying a TCP/IP port address 1328
using shared memory 1328
SHRED DATA command 1040
shredding data, storage pools
backing up 56
defining 329
moving data 583
updating 1217
SHREDDING option 1329
simultaneous write to copy storage pools
defining random access storage pools 328
defining sequential access storage pools 342
updating random access storage pools 1215
updating sequential access storage pools 1228
SKIPPARTIAL parameter, AUDIT VOLUME 41
SnapLock for managing WORM FILE volumes
when defining active-data pools 355
when defining copy storage pols 348
when defining sequential access storage pools 337
SNMPHEARTBEATINTERVAL option 1330
SNMPMESSAGECATEGORY option 1331
SNMPSUBAGENT option 1332
SNMPSUBAGENTHOST option 1333
SNMPSUBAGENTPORT option 1334
Software Support
contacting xv
describing problem for IBM Software Support xvi
determining business impact for IBM Software
Support xvi
Sony Blue Laser RW and WORM media 213, 1125
space management
DEFINE MGMTCLASS 258
description of 258
UPDATE MGMTCLASS 1155
space trigger commands
DEFINE SPACETRIGGER 316
DELETE SPACETRIGGER 425
QUERY SPACETRIGGER 838
UPDATE SPACETRIGGER 1206
SPACEMGTECHNIQUE parameter
DEFINE MGMTCLASS 259
UPDATE MGMTCLASS 1155
SSLTCPADMINPORT server option 1335
SSLTCPPORT server option 1336
start time
information about 285
setting 1017
STARTDATE parameter
DEFINE SCHEDULE, administrative command 302
DEFINE SCHEDULE, client 293
UPDATE SCHEDULE, administrative command 1194
UPDATE SCHEDULE, client 1186
STARTTIME parameter
DEFINE SCHEDULE, administrative command 302
DEFINE SCHEDULE, client 293
UPDATE SCHEDULE, administrative command 1194
UPDATE SCHEDULE, client 1186
status
event completion 714
information about 843
querying 843
STGPOOL parameter, MOVE DATA 583
STGPOOLS parameter
GRANT AUTHORITY 532
REVOKE AUTHORITY 953
storage area network (SAN)
DEFINE LIBRARY command 240
UPDATE LIBRARY command 1145
storage pool
collocating
active-data pool 353, 1239
copy sequential access 346, 1233
primary sequential access 337, 1225
defining 321
deleting 427
migrating 578
querying 849
reclaiming 887
restoring 941
updating 1210

Index 1439
storage pool volume
auditing 39
defining 363
deleting 437
querying 658, 878
scratch, active-data pool 356, 1241
scratch, copy sequential access 349, 1235
scratch, primary sequential access 338, 1226
updating 1248
varying 1258
storage volumes
naming 12
performance increase with raw partitions 321
support information xiv
SWAP parameter, CHECKIN LIBVOLUME 78
syntax diagram
abbreviations 7
default value 8
fragments 10
optional choice 8
repeatable choice 9
repeating values 9
required parameters 8
symbols 9
using 7
variables 9
SYSCONFIG command (on NAS file server) 265, 1168
system privilege class
administrative commands 18
T
tape
AUDIT LIBRARY command 36
AUDIT VOLUME command 39
CHECKIN LIBVOLUME command 73
CHECKOUT LIBVOLUME command 82
DEFINE DEVCLASS command 158
DEFINE LIBRARY command 240
DEFINE STGPOOL command 321, 331, 345
DEFINE VOLUME command 363
DELETE DEVCLASS command 389
DELETE DRIVE command 391
DELETE LIBRARY command 401
DELETE VOLUME command 437
LABEL LIBVOLUME command 565
QUERY DEVCLASS command 682
QUERY DRIVE command 691
QUERY LIBRARY command 736
QUERY LIBVOLUME command 739
QUERY VOLUME command 878
storage area network (SAN) 244, 247
UPDATE DEVCLASS command 1076
UPDATE LIBRARY command 1145
UPDATE LIBVOLUME command 1151
UPDATE VOLUME command 1248
tape-device encryption
3592 170, 1086
LTO 207, 1120
TCPADMINPORT server option 1337
TCPNODELAY option 1338
TCPPORT option 1339
TCPWINDOWSIZE option 1340
TECBEGINEVENTLOGGING option 1341
TECHOST option 1342
TECPORT option 1343
TECUTF8EVENT option 1344
threshold, migration
random-access storage pools
high threshold 325, 1213
low threshold 326, 1213
sequential-access storage pools
high threshold 334, 1222
low threshold 335, 1223
THROUGHPUTDATATHRESHOLD option 1345
THROUGHPUTTIMETHRESHOLD option 1346
time interval, setting for checking in volumes 1102, 1120,
1126
TIMEFORMAT option 1347
Tivoli technical training xiv
TOCDestination parameter 143, 1068
TODATE parameter
EXPORT NODE 479, 486, 502, 507
TOSERVER parameter
EXPORT ADMIN 472
EXPORT NODE 489
EXPORT POLICY 495
EXPORT SERVER 510
TOTIME parameter
EXPORT NODE 480, 487, 503, 508
training, Tivoli technical xiv
transfer data by data mover 149
transfer length, increasing 1357
trigger, for database backup 152, 677
troubleshooting LAN-free data movement 1254
TXNGROUPMAX option 1348
type, device
3570 159
3590 162, 1077, 1080
3592 166, 1084
4MM 171, 1088
8MM 175, 1092
CENTERA 181, 1097
DLT 183, 1099, 1104
DTF 189
ECARTRIDGE 192, 1107
FILE 197, 223, 1111, 1134
GENERICTAPE 200, 1115
LTO 203, 1117
OPTICAL 211, 1124
QIC 215, 1128
REMOVABLEFILE 220, 1132
SERVER 223, 1134
VOLSAFE 225, 1136
WORM 211, 1124
WORM12 211, 1124
typographic conventions xvii
U
UNDO ARCHCONVERSION 1045
unified logon 1275
UNIQUETDPTECEVENTS option 1349
UNIQUETECEVENTS option 1350
UNLOADDB, DSMSERV 1391
unloading the Tivoli Storage Manager database 1391
UNLOCK ADMIN command 1047
UNLOCK NODE command 1048
UNLOCK PROFILE command 1049
unlocking
administrator 1047
node 1048
profile 1049
UPDATE ADMIN command 1051

1440 IBM Tivoli Storage Manager for Windows: Administrators Reference
UPDATE ARCHIVE 1053
UPDATE BACKUPSET 1055
UPDATE CLIENTOPT command 1060
UPDATE CLOPTSET command 1061
UPDATE COLLOCGROUP command 1062
UPDATE COPYGROUP command 1064
UPDATE DATAMOVER command 1072
UPDATE DBBACKUPTRIGGER command 1074
UPDATE DEVCLASS command 1076
UPDATE DOMAIN command 1139
UPDATE DRIVE command 1141
UPDATE LIBRARY command 1145
UPDATE LIBVOLUME command 1151
UPDATE MACHINE command 1153
UPDATE MGMTCLASS command 1155
UPDATE NODE command 1158
UPDATE PATH command 1167
UPDATE POLICYSET command 1173
UPDATE PROFILE command 1175
UPDATE RECOVERYMEDIA command 1176
UPDATE SCHEDULE command 1178
UPDATE SCRIPT command 1199
UPDATE SERVER command 1201
UPDATE SERVERGROUP command 1205
UPDATE SPACETRIGGER command 1206
UPDATE STGPOOL command 1210
UPDATE VIRTUALFSMAPPING command 1244
UPDATE VOLHISTORY command 1246
UPDATE VOLUME command 1248
updating
administrator 1051
archive copy group 1069
backup copy group 1065
backup set 1055
copy group 1064
database and recovery log space triggers 1206
database backup trigger 1074
device class 1076
domain 1139
drive 1141
library 1145
library volume 1151
management class 1155
node 1158
node group 1166
policy set 1173
profile 1175
retention period for a backup set 1055
schedule 1178
script 1199
server group 1205
storage pool 1210
storage pool volume 1248
TOCDestination copy group parameter 1068
volume history 1246
USEREXIT option 1351
using
administrative client options 5
command-line interface 1
continuation characters 11
DSMSERV LOADFORMAT 1379
macros 576
redirection 4
redirection characters 4
syntax diagram 7
system date on the server 27
V
VALIDATE LANFREE command 1254
VALIDATE POLICYSET command 1256
validating
LAN-free 1254
policy set 1256
VARY command 1258
varying volumes 1258
VERDELETED parameter
DEFINE COPYGROUP, backup 141
UPDATE COPYGROUP, backup 1066
VEREXISTS parameter
DEFINE COPYGROUP, backup 141
UPDATE COPYGROUP, backup 1066
verify automated library inventory 36
verifying the database 1360
VOLSAFE
device type 225, 1136
labeling volumes 569
volume
displaying db 679
displaying log 746
labeling library 565
volume history
deleting 432
querying 870
VOLUMEHISTORY option 1353
volumes, storage
defining 363
limiting offsite volumes to be reclaimed
using the DEFINE STGPOOL command 349, 356
using the UPDATE STGPOOL command 1235, 1241
naming 12
reclaiming
from active-data pool 354, 1240
from copy sequential access 347, 1234
from primary sequential access 335, 1223
restoring 945
scratch, maximum in active-data pool 356, 1241
scratch, maximum in copy sequential access 349, 1235
scratch, maximum in primary sequential access 338, 1226
W
WAITTIME parameter
CHECKIN LIBVOLUME command 78
LABEL LIBVOLUME command 569
WHEREACCESS parameter, UPDATE VOLUME 1250
WHERESTATUS parameter, UPDATE VOLUME 1250
WHERESTGPOOL parameter, UPDATE VOLUME 1250
wildcard
match-any examples 13
match-exactly-one examples 13
using 12
WORM devices and media
8mm devices 176
DLT 184
IBM 3592 167
LTO 204
SnapLock for managing WORM FILE volumes 337, 348,
355
Sony AIT50/AIT100, supported in 8mm class
definition 176
Sony Blue Laser 213
StorageTek VolSafe 193

Index 1441
WORM devices and media (continued)
WORM optical devices
defining the class 211
updating the class 1124
WORM12 212
WORM14 212

1442 IBM Tivoli Storage Manager for Windows: Administrators Reference

Program Number: 5608-HSM

5608-ISM
5608-ISX
5608-SAN
5608-ARM

Printed in USA


SC32-0127-01

S
p
i
n
e

i
n
f
o
r
m
a
t
i
o
n
:
I
B
M

T
i
v
o
l
i

S
t
o
r
a
g
e

M
a
n
a
g
e
r

f
o
r

W
i
n
d
o
w
s

V
e
r
s
i
o
n

5
.
5

A
d
m
i
n
i
s
t
r
a
t
o
r

s

R
e
f
e
r
e
n
c
e