IBM Tivoli Storage Manager for Windows: Administrator`s Reference

IBM Tivoli Storage Manager
for Windows
Version 6.3.4
Administrator's Reference
SC23-9779-05
IBM Tivoli Storage Manager
for Windows
Version 6.3.4
Administrator's Reference
SC23-9779-05
Note:
Before using this information and the product it supports, read the information in “Notices” on page 1575.
This edition applies to Version 6.3.4 of IBM Tivoli Storage Manager (product numbers 5608-E01, 5608-E02,
5608-E03), and to all subsequent releases and modifications until otherwise indicated in new editions or technical
newsletters. This edition replaces SC23-9779-04.
© Copyright IBM Corporation 1993, 2013.
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 publication . . . . . . . xi
Publications . . . . . . . . . . . . . . xi
Tivoli Storage Manager publications . . . . . xii
Tivoli Storage FlashCopy Manager publications xiv
Related hardware publications . . . . . . . xiv
Conventions used in this publication . . . . . xiv
New for IBM Tivoli Storage Manager
Version 6.3 . . . . . . . . . . . . xvii
Server updates . . .
New for the server
New for the server
New for the server
New for the server
. . . . . . . . . . xvii
in Version 6.3.4 . . . . . xvii
in Version 6.3.3 . . . . . xviii
in Version 6.3.1 . . . . . xx
in Version 6.3.0 . . . . . xx
Chapter 1. Administering the server
from the command-line interface . . . . 1
Issuing commands from the administrative client .
Starting and stopping the administrative client .
Monitoring server activities from the
administrative client . . . . . . . . . .
Monitoring removable-media mounts from the
administrative client . . . . . . . . . .
Processing commands one at a time from the
administrative client . . . . . . . . . .
Processing a series of commands from the
administrative client . . . . . . . . . .
Formatting output from commands . . . . .
Saving command output to a specified location .
Administrative client options . . . . . . .
Issuing commands from the Administration Center
Issuing commands from the server console . . .
Entering administrative commands . . . . . .
Reading syntax diagrams . . . . . . . .
Entering long commands . . . . . . . .
Naming Tivoli Storage Manager objects . . .
Using wildcard characters to specify object
names . . . . . . . . . . . . . .
Specifying descriptions in keyword parameters
Controlling command processing . . . . . .
Server command processing . . . . . . .
Cancelling commands . . . . . . . . .
Performing tasks concurrently on multiple servers
Routing commands to a single server. . . .
Routing commands to multiple servers . . .
Routing commands to a server group. . . .
Routing commands to server groups . . . .
Routing commands to two servers and a server
group . . . . . . . . . . . . . .
Routing commands inside scripts . . . . .
Privilege classes for commands . . . . . . .
Commands requiring system privilege . . .
Commands requiring policy privilege . . .
Commands requiring storage privilege . . .
© Copyright IBM Corp. 1993, 2013
. 1
. 2
. 2
. 3
. 3
. 3
. 4
. 4
. 5
. 7
. 7
. 8
. 8
. 12
. 13
. 14
15
. 15
. 15
. 16
17
. 17
. 17
. 18
. 18
.
.
.
.
.
.
18
18
19
19
22
23
Commands requiring operator privilege .
Commands any administrator can issue .
.
.
.
.
. 24
. 25
Chapter 2. Administrative commands
ACCEPT DATE (Accepts the current system date)
ACTIVATE POLICYSET (Activate a new policy set)
ASSIGN DEFMGMTCLASS (Assign a default
management class) . . . . . . . . . . . .
AUDIT commands . . . . . . . . . . . .
AUDIT LDAPDIRECTORY (Audit an LDAP
directory server) . . . . . . . . . . . .
AUDIT LIBRARY (Audit volume inventories in
an automated library) . . . . . . . . . .
AUDIT LICENSES (Audit server storage usage)
AUDIT VOLUME (Verify database information
for a storage pool volume) . . . . . . . .
BACKUP commands . . . . . . . . . . .
BACKUP DB (Back up the database) . . . . .
BACKUP DEVCONFIG (Create backup copies of
device configuration information) . . . . . .
BACKUP NODE (Back up a NAS node) . . . .
BACKUP STGPOOL (Back up primary storage
pool to copy storage pool) . . . . . . . .
BACKUP VOLHISTORY (Save sequential volume
history information) . . . . . . . . . .
BEGIN EVENTLOGGING (Begin logging events) . .
CANCEL commands . . . . . . . . . . .
CANCEL EXPIRATION (Cancel an expiration
process) . . . . . . . . . . . . . .
CANCEL EXPORT (Delete a suspended export
operation) . . . . . . . . . . . . . .
CANCEL PROCESS (Cancel an administrative
process) . . . . . . . . . . . . . .
CANCEL REPLICATION (Cancel node
replication processes) . . . . . . . . . .
CANCEL REQUEST (Cancel one or more mount
requests) . . . . . . . . . . . . . .
CANCEL RESTORE (Cancel a restartable restore
session). . . . . . . . . . . . . . .
CANCEL SESSION (Cancel one or more client
sessions) . . . . . . . . . . . . . .
CHECKIN LIBVOLUME (Check a storage volume
into a library). . . . . . . . . . . . . .
CHECKOUT LIBVOLUME (Check a storage volume
out of a library) . . . . . . . . . . . . .
CLEAN DRIVE (Clean a drive) . . . . . . . .
COMMIT (Control committing of commands in a
macro) . . . . . . . . . . . . . . . .
COPY commands . . . . . . . . . . . .
COPY ACTIVEDATA (Copy active backup data
from a primary storage pool to an active-data
pool) . . . . . . . . . . . . . . .
COPY CLOPTSET (Copy a client option set) . .
COPY DOMAIN (Copy a policy domain) . . .
COPY MGMTCLASS (Copy a management class)
27
28
29
31
33
34
36
39
40
46
47
51
53
58
62
64
66
67
68
69
71
72
73
74
75
83
89
90
91
92
96
97
99
iii
|
|
COPY POLICYSET (Copy a policy set) . . . .
COPY PROFILE (Copy a profile) . . . . . .
COPY SCHEDULE (Copy a client or an
administrative command schedule) . . . . .
COPY SCRIPT (Copy a Tivoli Storage Manager
script) . . . . . . . . . . . . . . .
COPY SERVERGROUP (Copy a server group)
DEFINE commands . . . . . . . . . . .
DEFINE ALERTTRIGGER (Define an alert
trigger) . . . . . . . . . . . . . .
DEFINE ASSOCIATION (Associate client nodes
with a schedule) . . . . . . . . . . .
DEFINE BACKUPSET (Define a backup set) . .
DEFINE CLIENTACTION (Define a one-time
client action) . . . . . . . . . . . .
DEFINE CLIENTOPT (Define an option to an
option set) . . . . . . . . . . . . .
DEFINE CLOPTSET (Define a client option set
name) . . . . . . . . . . . . . . .
DEFINE COLLOCGROUP (Define a collocation
group). . . . . . . . . . . . . . .
DEFINE COLLOCMEMBER (Define collocation
group member). . . . . . . . . . . .
DEFINE COPYGROUP (Define a copy group)
DEFINE DATAMOVER (Define a data mover)
DEFINE DEVCLASS (Define a device class) . .
DEFINE DOMAIN (Define a new policy
domain) . . . . . . . . . . . . . .
DEFINE DRIVE (Define a drive to a library) . .
DEFINE EVENTSERVER (Define a server as the
event server) . . . . . . . . . . . .
DEFINE GRPMEMBER (Add a server to a
server group) . . . . . . . . . . . .
DEFINE LIBRARY (Define a library). . . . .
DEFINE MACHINE (Define machine
information for disaster recovery) . . . . .
DEFINE MACHNODEASSOCIATION
(Associate a node with a machine) . . . . .
DEFINE MGMTCLASS (Define a management
class) . . . . . . . . . . . . . . .
DEFINE NODEGROUP (Define a node group)
DEFINE NODEGROUPMEMBER (Define node
group member). . . . . . . . . . . .
DEFINE PATH (Define a path) . . . . . .
DEFINE POLICYSET (Define a policy set) . . .
DEFINE PROFASSOCIATION (Define a profile
association) . . . . . . . . . . . . .
DEFINE PROFILE (Define a profile) . . . . .
DEFINE RECMEDMACHASSOCIATION
(Associate recovery media with a machine) . .
DEFINE RECOVERYMEDIA (Define recovery
media) . . . . . . . . . . . . . .
DEFINE SCHEDULE (Define a client or an
administrative command schedule) . . . . .
DEFINE SCRIPT (Define a Tivoli Storage
Manager script) . . . . . . . . . . .
DEFINE SERVER (Define a server for
server-to-server communications). . . . . .
DEFINE SERVERGROUP (Define a server
group). . . . . . . . . . . . . . .
iv
101
103
105
|
|
109
110
111
112
115
117
121
127
130
131
133
135
145
148
224
226
230
231
232
252
254
256
259
260
261
271
273
279
281
283
285
309
312
319
|
|
DEFINE SPACETRIGGER (Define the space
trigger) . . . . . . . . . . . . .
DEFINE STATUSTHRESHOLD (Define a status
monitoring threshold) . . . . . . . .
DEFINE STGPOOL (Define a storage pool) .
DEFINE SUBSCRIPTION (Define a profile
subscription) . . . . . . . . . . .
DEFINE VIRTUALFSMAPPING (Define a
virtual file space mapping) . . . . . . .
DEFINE VOLUME (Define a volume in a
storage pool) . . . . . . . . . . .
DELETE commands . . . . . . . . . .
DELETE ALERTTRIGGER (Remove a message
from an alert trigger) . . . . . . . . .
DELETE ASSOCIATION (Delete the node
association to a schedule) . . . . . . .
DELETE BACKUPSET (Delete a backup set) .
DELETE CLIENTOPT (Delete an option in an
option set) . . . . . . . . . . . .
DELETE CLOPTSET (Delete a client option set)
DELETE COLLOCGROUP (Delete a collocation
group). . . . . . . . . . . . . .
DELETE COLLOCMEMBER (Delete collocation
group member). . . . . . . . . . .
DELETE COPYGROUP (Delete a backup or
archive copy group) . . . . . . . . .
DELETE DATAMOVER (Delete a data mover)
DELETE DEVCLASS (Delete a device class) .
DELETE DOMAIN (Delete a policy domain)
DELETE DRIVE (Delete a drive from a library)
DELETE EVENT (Delete event records). . .
DELETE EVENTSERVER (Delete the definition
of the event server) . . . . . . . . .
DELETE FILESPACE (Delete client node data
from the server) . . . . . . . . . .
DELETE GRPMEMBER (Delete a server from a
server group) . . . . . . . . . . .
DELETE KEYRING (Delete password
information in the key database) . . . . .
DELETE LIBRARY (Delete a library). . . .
DELETE MACHINE (Delete machine
information) . . . . . . . . . . . .
DELETE MACHNODEASSOCIATION (Delete
association between a machine and a node) .
DELETE MGMTCLASS (Delete a management
class) . . . . . . . . . . . . . .
DELETE NODEGROUP (Delete a node group)
DELETE NODEGROUPMEMBER (Delete node
group member). . . . . . . . . . .
DELETE PATH (Delete a path) . . . . .
DELETE POLICYSET (Delete a policy set) . .
DELETE PROFASSOCIATION (Delete a profile
association) . . . . . . . . . . . .
DELETE PROFILE (Delete a profile) . . . .
DELETE RECMEDMACHASSOCIATION
(Delete recovery media and machine
association) . . . . . . . . . . . .
DELETE RECOVERYMEDIA (Delete recovery
media) . . . . . . . . . . . . .
DELETE SCHEDULE (Delete a client or an
administrative command schedule) . . . .
IBM Tivoli Storage Manager for Windows: Administrator's Reference
. 320
. 323
. 327
. 374
. 376
. 378
. 384
. 386
. 387
. 389
. 394
395
. 396
. 397
. 399
401
. 402
403
404
. 405
. 407
. 408
. 412
. 413
. 414
. 415
. 416
. 417
418
. 419
. 420
. 422
. 423
. 426
. 428
. 429
. 430
|
|
DELETE SCRIPT (Delete command lines from a
script or delete the entire script) . . . . . .
DELETE SERVER (Delete a server definition)
DELETE SERVERGROUP (Delete a server
group). . . . . . . . . . . . . . .
DELETE SPACETRIGGER (Delete the storage
pool space triggers) . . . . . . . . . .
DELETE STATUSTHRESHOLD (Delete a status
monitoring threshold) . . . . . . . . .
DELETE STGPOOL (Delete a storage pool) . .
DELETE SUBSCRIBER (Delete subscriptions
from a configuration manager database) . . .
DELETE SUBSCRIPTION (Delete a profile
subscription) . . . . . . . . . . . .
DELETE VIRTUALFSMAPPING (Delete a
virtual file space mapping) . . . . . . . .
DELETE VOLHISTORY (Delete sequential
volume history information) . . . . . . .
DELETE VOLUME (Delete a storage pool
volume) . . . . . . . . . . . . . .
DISABLE commands . . . . . . . . . . .
DISABLE EVENTS (Disable events for event
logging) . . . . . . . . . . . . . .
DISABLE REPLICATION (Prevent outbound
replication processing on a server) . . . . .
DISABLE SESSIONS (Prevent new sessions from
accessing Tivoli Storage Manager) . . . . .
DISMOUNT command . . . . . . . . . .
DISMOUNT VOLUME (Dismount a volume by
volume name) . . . . . . . . . . . .
DISPLAY OBJNAME (Display a full object name)
ENABLE commands . . . . . . . . . . .
ENABLE EVENTS (Enable server or client
events for logging) . . . . . . . . . .
ENABLE REPLICATION (Allow outbound
replication processing on a server) . . . . .
ENABLE SESSIONS (Resume user activity on
the server) . . . . . . . . . . . . .
END EVENTLOGGING (Stop logging events) . .
EXPIRE INVENTORY (Manually start inventory
expiration processing) . . . . . . . . . .
EXPORT commands . . . . . . . . . . .
EXPORT ADMIN (Export administrator
information) . . . . . . . . . . . . .
EXPORT NODE (Export client node
information) . . . . . . . . . . . . .
EXPORT POLICY (Export policy information)
EXPORT SERVER (Export server information)
EXTEND DBSPACE (Increase space for the
database) . . . . . . . . . . . . . . .
GENERATE commands . . . . . . . . . .
GENERATE BACKUPSET (Generate a backup
set of Backup-Archive Client data) . . . . .
GENERATE BACKUPSETTOC (Generate a table
of contents for a backup set) . . . . . . .
GRANT commands . . . . . . . . . . .
GRANT AUTHORITY (Add administrator
authority) . . . . . . . . . . . . .
GRANT PROXYNODE (Grant proxy authority
to a client node) . . . . . . . . . . .
HALT (Shut down the server) . . . . . . . .
433
434
435
436
437
439
440
441
442
443
448
451
452
456
457
459
460
461
462
463
466
467
469
471
475
476
483
504
511
529
531
532
540
542
543
547
548
|
|
|
|
HELP (Get help on commands and error messages)
IDENTIFY DUPLICATES (Identify duplicate data
in a storage pool) . . . . . . . . . . . .
IMPORT commands . . . . . . . . . . .
IMPORT ADMIN (Import administrator
information) . . . . . . . . . . . . .
IMPORT NODE (Import client node
information) . . . . . . . . . . . . .
IMPORT POLICY (Import policy information)
IMPORT SERVER (Import server information)
INSERT MACHINE (Insert machine characteristics
information or recovery instructions) . . . . .
ISSUE MESSAGE (Issue a message from a server
script) . . . . . . . . . . . . . . . .
LABEL LIBVOLUME (Label a library volume) . .
LOCK commands . . . . . . . . . . . .
LOCK ADMIN (Lock out an administrator) . .
LOCK NODE (Lock out a client node) . . . .
LOCK PROFILE (Lock a profile) . . . . . .
MACRO (Invoke a macro) . . . . . . . . .
MIGRATE STGPOOL (Migrate storage pool to next
storage pool) . . . . . . . . . . . . .
MOVE commands . . . . . . . . . . . .
MOVE DATA (Move files on a storage pool
volume) . . . . . . . . . . . . . .
MOVE DRMEDIA (Move disaster recovery
media offsite and back onsite) . . . . . . .
MOVE GRPMEMBER (Move a server group
member) . . . . . . . . . . . . . .
MOVE MEDIA (Move sequential access storage
pool media) . . . . . . . . . . . . .
MOVE NODEDATA (Move data by node in a
sequential access storage pool) . . . . . .
NOTIFY SUBSCRIBERS (Notify managed servers
to update profiles). . . . . . . . . . . .
PERFORM LIBACTION (Define or delete all drives
and paths for a library) . . . . . . . . . .
PING SERVER (Test the connection between
servers) . . . . . . . . . . . . . . .
PREPARE (Create a recovery plan file) . . . . .
QUERY commands . . . . . . . . . . .
QUERY ACTLOG (Query the activity log) . . .
QUERY ADMIN (Display administrator
information) . . . . . . . . . . . . .
QUERY ALERTTRIGGER (Query the list of
defined alert triggers) . . . . . . . . .
QUERY ALERTSTATUS (Query the status of an
alert) . . . . . . . . . . . . . . .
QUERY ASSOCIATION (Query client node
associations with a schedule) . . . . . . .
QUERY AUDITOCCUPANCY (Query client
node storage utilization). . . . . . . . .
QUERY BACKUPSET (Query a backup set) . .
QUERY BACKUPSETCONTENTS (Query
contents of a backup set) . . . . . . . .
QUERY CLOPTSET (Query a client option set)
QUERY COLLOCGROUP (Query a collocation
group). . . . . . . . . . . . . . .
QUERY CONTENT (Query the contents of a
storage pool volume) . . . . . . . . . .
QUERY COPYGROUP (Query copy groups) . .
Contents
550
552
556
557
561
568
571
576
577
579
585
586
588
590
592
594
597
598
602
618
619
627
636
637
640
641
647
650
656
661
663
668
670
673
678
681
683
686
694
v
QUERY DATAMOVER (Display data mover
definitions) . . . . . . . . . . . . .
QUERY DB (Display database information) . .
QUERY DBSPACE (Display database storage
space) . . . . . . . . . . . . . . .
QUERY DEVCLASS (Display information on
one or more device classes). . . . . . . .
QUERY DIRSPACE (Query storage utilization of
FILE directories) . . . . . . . . . . .
QUERY DOMAIN (Query a policy domain) . .
QUERY DRIVE (Query information about a
drive) . . . . . . . . . . . . . . .
QUERY DRMEDIA (Query disaster recovery
media) . . . . . . . . . . . . . .
QUERY DRMSTATUS (Query disaster recovery
manager system parameters) . . . . . . .
QUERY ENABLED (Query enabled events) . .
QUERY EVENT (Query scheduled and
completed events) . . . . . . . . . . .
QUERY EVENTRULES (Query rules for server
or client events) . . . . . . . . . . .
QUERY EVENTSERVER (Query the event
server). . . . . . . . . . . . . . .
QUERY EXPORT (Query for active or
suspended export operations) . . . . . . .
QUERY FILESPACE (Query one or more file
spaces) . . . . . . . . . . . . . .
QUERY LIBRARY (Query a library) . . . . .
QUERY LIBVOLUME (Query a library volume)
QUERY LICENSE (Display license information)
QUERY LOG (Display information on the
recovery log) . . . . . . . . . . . .
QUERY MACHINE (Query machine
information) . . . . . . . . . . . . .
QUERY MEDIA (Query sequential access
storage pool media) . . . . . . . . . .
QUERY MGMTCLASS (Query a management
class) . . . . . . . . . . . . . . .
QUERY MONITORSETTINGS (Query the
configuration settings for monitoring alerts and
server status) . . . . . . . . . . . .
QUERY MONITORSTATUS (Query the
monitoring status) . . . . . . . . . . .
QUERY MOUNT (Display information on
mounted sequential access volumes). . . . .
QUERY NASBACKUP (Query NAS backup
images) . . . . . . . . . . . . . .
QUERY NODE (Query nodes) . . . . . . .
QUERY NODEDATA (Query client data in
volumes) . . . . . . . . . . . . . .
QUERY NODEGROUP (Query a node group)
QUERY OCCUPANCY (Query client file spaces
in storage pools) . . . . . . . . . . .
QUERY OPTION (Query server options) . . .
QUERY PATH (Display a path definition) . . .
QUERY POLICYSET (Query a policy set) . . .
QUERY PROCESS (Query one or more server
processes) . . . . . . . . . . . . .
QUERY PROFILE (Query a profile) . . . . .
QUERY PROXYNODE (Query proxy authority
for a client node) . . . . . . . . . . .
|
|
|
|
|
vi
699
702
705
706
710
711
714
718
727
730
732
744
747
748
755
762
765
768
770
772
775
781
784
787
791
793
797
808
811
813
817
819
823
826
829
832
|
|
QUERY PVUESTIMATE (Display processor
value unit estimate) . . . . . . . . . .
QUERY RECOVERYMEDIA (Query recovery
media) . . . . . . . . . . . . . .
QUERY REPLICATION (Query node replication
processes) . . . . . . . . . . . . .
QUERY REPLNODE (Display information about
replication status for a client node) . . . . .
QUERY REPLRULE (Query replication rules)
QUERY REQUEST (Query one or more pending
mount requests) . . . . . . . . . . .
QUERY RESTORE (Query restartable restore
sessions) . . . . . . . . . . . . . .
QUERY RPFCONTENT (Query recovery plan
file contents stored on a target server) . . . .
QUERY RPFILE (Query recovery plan file
information stored on a target server) . . . .
QUERY SAN (Query the devices on the SAN)
QUERY SCHEDULE (Query schedules). . . .
QUERY SCRIPT (Query Tivoli Storage Manager
scripts) . . . . . . . . . . . . . .
QUERY SERVER (Query a server) . . . . .
QUERY SERVERGROUP (Query a server group)
QUERY SESSION (Query client sessions) . . .
QUERY SHREDSTATUS (Query shredding
status ) . . . . . . . . . . . . . .
QUERY SPACETRIGGER (Query the space
triggers) . . . . . . . . . . . . . .
QUERY SSLKEYRINGPW (Query SSL key
database file password) . . . . . . . . .
QUERY STATUS (Query system parameters)
QUERY STATUSTHRESHOLD (Query status
monitoring thresholds) . . . . . . . . .
QUERY STGPOOL (Query storage pools) . . .
QUERY SUBSCRIBER (Display subscriber
information) . . . . . . . . . . . . .
QUERY SUBSCRIPTION (Display subscription
information) . . . . . . . . . . . . .
QUERY SYSTEM (Query the system
configuration and capacity). . . . . . . .
QUERY TAPEALERTMSG (Display status of
SET TAPEALERTMSG command) . . . . .
QUERY TOC (Display table of contents for a
backup image) . . . . . . . . . . . .
QUERY VIRTUALFSMAPPING (Query a virtual
file space mapping) . . . . . . . . . .
QUERY VOLHISTORY (Display sequential
volume history information) . . . . . . .
QUERY VOLUME (Query storage pool
volumes) . . . . . . . . . . . . . .
QUIT (End the interactive mode of the
administrative client) . . . . . . . . . . .
RECLAIM STGPOOL (Reclaim volumes in a
sequential-access storage pool) . . . . . . .
RECONCILE VOLUMES (Reconcile differences in
the virtual volume definitions) . . . . . . .
REGISTER commands . . . . . . . . . .
REGISTER ADMIN (Register an administrator
ID) . . . . . . . . . . . . . . . .
REGISTER LICENSE (Register a new license)
REGISTER NODE (Register a node) . . . . .
IBM Tivoli Storage Manager for Windows: Administrator's Reference
833
837
840
850
854
856
857
860
862
865
868
876
879
883
885
889
891
893
894
902
905
916
918
920
922
923
926
928
936
944
945
949
952
953
957
959
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
REMOVE commands . . . . . . . . . . . 975
REMOVE ADMIN (Delete an administrator user
ID) . . . . . . . . . . . . . . . . 976
REMOVE NODE (Delete a node or an
associated machine node) . . . . . . . . 978
REMOVE REPLNODE (Remove a client node
from replication) . . . . . . . . . . . 980
RENAME commands . . . . . . . . . . . 982
RENAME ADMIN (Rename an administrator)
983
RENAME FILESPACE (Rename a client file
space on the server) . . . . . . . . . . 985
RENAME NODE (Rename a node) . . . . . 988
RENAME SCRIPT (Rename a Tivoli Storage
Manager script) . . . . . . . . . . . 990
RENAME SERVERGROUP (Rename a server
group). . . . . . . . . . . . . . . 991
RENAME STGPOOL (Change the name of a
storage pool) . . . . . . . . . . . . 992
REPLICATE NODE (Replicate data in file spaces
that belong to a client node) . . . . . . . . 993
REPLY (Allow a request to continue processing)
1000
RESET PASSEXP (Reset password expiration)
1001
RESTART EXPORT (Restart a suspended export
operation) . . . . . . . . . . . . . . 1003
RESTORE commands . . . . . . . . . . 1005
RESTORE NODE (Restore a NAS node) . . . 1006
RESTORE STGPOOL (Restore storage pool data
from a copy pool or an active-data pool) . . . 1011
RESTORE VOLUME (Restore primary volume
data from a copy pool or an active-data pool) . 1015
REVOKE commands . . . . . . . . . . 1019
REVOKE AUTHORITY (Remove administrator
authority) . . . . . . . . . . . . . 1020
REVOKE PROXYNODE (Revoke proxy
authority for a client node) . . . . . . . 1024
ROLLBACK (Rollback uncommitted changes in a
macro) . . . . . . . . . . . . . . . 1025
RUN (Run a Tivoli Storage Manager script) . . . 1026
SELECT (Perform an SQL query of the Tivoli
Storage Manager database) . . . . . . . . 1029
SET commands . . . . . . . . . . . . 1039
SET ACCOUNTING (Set accounting records on
or off) . . . . . . . . . . . . . . 1042
SET ACTLOGRETENTION (Set the retention
period or the size of the activity log) . . . . 1043
SET ALERTACTIVEDURATION (Set the
duration of an active alert) . . . . . . . 1045
SET ALERTCLOSEDDURATION (Set the
duration of a closed alert) . . . . . . . . 1046
SET ALERTEMAIL (Set the alert monitor to
email alerts to administrators. . . . . . . 1047
SET ALERTEMAILFROMADDR (Set the email
address of the sender) . . . . . . . . . 1049
SET ALERTEMAILSMTPHOST (Set the SMTP
mail server host name) . . . . . . . . . 1050
SET ALERTEMAILSMTPPORT (Set the SMTP
mail server host port) . . . . . . . . . 1051
SET ALERTSUMMARYTOADMINS (Set the
list of administrators to receive alert
summaries by email ) . . . . . . . . . 1052
|
|
|
|
|
|
SET ALERTINACTIVEDURATION (Set the
duration of an inactive alert) . . . . . . .
SET ALERTMONITOR (Set the alert monitor to
on or off) . . . . . . . . . . . . .
SET ALERTUPDATEINTERVAL (Set how often
the alert monitor updates and prunes alerts) .
SET ARCHIVERETENTIONPROTECTION
(Activate data retention protection) . . . . .
SET ARREPLRULEDEFAULT (Set the server
replication rule for archive data) . . . . .
SET AUTHENTICATION (Set password
authentication) . . . . . . . . . . .
SET BKREPLRULEDEFAULT (Set the server
replication rule for backup data) . . . . .
SET CLIENTACTDURATION (Set the duration
period for the client action) . . . . . . .
SET CONFIGMANAGER (Specify a
configuration manager). . . . . . . . .
SET CONFIGREFRESH (Set managed server
configuration refresh) . . . . . . . . .
SET CONTEXTMESSAGING (Set message
context reporting on or off) . . . . . . .
SET CPUINFOREFRESH (Refresh interval for
the client workstation information scan) . . .
SET CROSSDEFINE (Specifies whether to
cross-define servers) . . . . . . . . . .
SET DBRECOVERY (Set the device class for
automatic backups) . . . . . . . . . .
SET DBREPORTMODE (Set the level of
database reporting) . . . . . . . . . .
SET DEDUPVERIFICATIONLEVEL (Set the
percentage of extents to verify) . . . . . .
SET DEFAULTAUTHENTICATION (Set the
default authentication method for REGISTER
NODE and REGISTER ADMIN commands) . . . .
SET DRMACTIVEDATASTGPOOL (Specify the
active-data pools to be managed by DRM) . .
SET DRMCHECKLABEL (Specify label
checking) . . . . . . . . . . . . .
SET DRMCMDFILENAME (Specify the name
of a file to contain commands) . . . . . .
SET DRMCOPYSTGPOOL (Specify the copy
storage pools to be managed by DRM) . . .
SET DRMCOURIERNAME (Specify the courier
name) . . . . . . . . . . . . . .
SET DRMDBBACKUPEXPIREDAYS (Specify
DB backup series expiration) . . . . . . .
SET DRMFILEPROCESS (Specify file
processing) . . . . . . . . . . . . .
SET DRMINSTRPREFIX (Specify the prefix for
recovery instructions file names) . . . . .
SET DRMNOTMOUNTABLENAME (Specify
the not mountable location name) . . . . .
SET DRMPLANPREFIX (Specify a prefix for
recovery plan file names) . . . . . . . .
SET DRMPLANVPOSTFIX (Specify
replacement volume names) . . . . . . .
SET DRMPRIMSTGPOOL (Specify the primary
storage pools to be managed by DRM) . . .
SET DRMRPFEXPIREDAYS (Set criteria for
recovery plan file expiration) . . . . . . .
Contents
1053
1054
1055
1056
1058
1060
1061
1064
1065
1066
1067
1068
1069
1070
1072
1073
1075
1077
1078
1079
1080
1081
1082
1084
1085
1087
1088
1090
1091
1092
vii
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SET DRMVAULTNAME (Specify the vault
name) . . . . . . . . . . . . . .
SET EVENTRETENTION (Set the retention
period for event records) . . . . . . . .
SET INVALIDPWLIMIT (Set the number of
invalid logon attempts). . . . . . . . .
SET LDAPPASSWORD (Set the LDAP
password for the server) . . . . . . . .
SET LDAPUSER (Define the server
administrator for the LDAP directory server) .
SET LICENSEAUDITPERIOD (Set license audit
period) . . . . . . . . . . . . . .
SET MAXCMDRETRIES (Set the maximum
number of command retries) . . . . . . .
SET MAXSCHEDSESSIONS (Set maximum
scheduled sessions) . . . . . . . . . .
SET MINPWLENGTH (Set minimum password
length) . . . . . . . . . . . . . .
SET MONITORINGADMIN (Set the name of
the monitoring administrator) . . . . . .
SET MONITOREDSERVERGROUP (Set the
group of monitored servers) . . . . . . .
SET PASSEXP (Set password expiration date)
SET QUERYSCHEDPERIOD (Set query period
for polling client nodes) . . . . . . . .
SET RANDOMIZE (Set randomization of
scheduled start times) . . . . . . . . .
SET REGISTRATION (Set open or closed
registration) . . . . . . . . . . . .
SET REPLRETENTION (Set the retention
period for replication records) . . . . . .
SET REPLSERVER (Set the target replication
server) . . . . . . . . . . . . . .
SET RETRYPERIOD (Set time between retry
attempts) . . . . . . . . . . . . .
SET SCHEDMODES (Select a central
scheduling mode) . . . . . . . . . .
SET SERVERHLADDRESS (Set the high-level
address of a server) . . . . . . . . . .
SET SERVERLLADDRESS (Set the low-level
address of a server) . . . . . . . . . .
SET SERVERNAME (Specify the server name)
SET SERVERPASSWORD (Set password for
server) . . . . . . . . . . . . . .
SET SPREPLRULEDEFAULT (Set the server
replication rule for space-managed data) . . .
SET SSLKEYRINGPW (Set the SSL key ring
password) . . . . . . . . . . . . .
SET STATUSATRISKINTERVAL (Specifies
whether to enable client at-risk activity interval
evaluation) . . . . . . . . . . . . .
SET STATUSMONITOR (Specifies whether to
enable status monitoring) . . . . . . . .
SET STATUSREFRESHINTERVAL (Set refresh
interval for status monitoring) . . . . . .
SET STATUSSKIPASFAILURE (Specifies
whether to use client at-risk skipped files as
failure evaluation) . . . . . . . . . .
SET SUBFILE (Set subfile backup for client
nodes) . . . . . . . . . . . . . .
viii
1094
1095
1096
1098
1099
1101
1102
1103
1105
1106
1107
1108
1110
1111
1113
1115
1117
1119
1120
1122
1123
1124
1125
1126
1128
1129
1131
1133
1134
1136
|
|
|
|
SET SUMMARYRETENTION (Set number of
days to keep data in activity summary table) .
SET TAPEALERTMSG (Set tape alert messages
on or off) . . . . . . . . . . . . .
SET TOCLOADRETENTION (Set load
retention period for table of contents) . . . .
SETOPT (Set a server option for dynamic update)
SHRED DATA (Shred data) . . . . . . . .
SUSPEND EXPORT (Suspend a currently running
export operation) . . . . . . . . . . . .
UNLOCK commands . . . . . . . . . .
UNLOCK ADMIN (Unlock an administrator)
UNLOCK NODE (Unlock a client node) . . .
UNLOCK PROFILE (Unlock a profile). . . .
UPDATE commands. . . . . . . . . . .
UPDATE ALERTTRIGGER (Update a defined
alert trigger) . . . . . . . . . . . .
UPDATE ALERTSTATUS (Update the status of
an alert) . . . . . . . . . . . . . .
UPDATE ADMIN (Update an administrator)
UPDATE BACKUPSET (Update a retention
value assigned to a backup set) . . . . . .
UPDATE CLIENTOPT (Update a client option
sequence number) . . . . . . . . . .
UPDATE CLOPTSET (Update a client option
set description) . . . . . . . . . . .
UPDATE COLLOCGROUP (Update a
collocation group) . . . . . . . . . .
UPDATE COPYGROUP (Update a copy group)
UPDATE DATAMOVER (Update a data mover)
UPDATE DEVCLASS (Update the attributes of
a device class) . . . . . . . . . . . .
UPDATE DOMAIN (Update a policy domain)
UPDATE DRIVE (Update a drive) . . . . .
UPDATE FILESPACE (Update file-space
node-replication rules) . . . . . . . . .
UPDATE LIBRARY (Update a library) . . . .
UPDATE LIBVOLUME (Change the status of a
storage volume) . . . . . . . . . . .
UPDATE MACHINE (Update machine
information) . . . . . . . . . . . .
UPDATE MGMTCLASS (Update a
management class) . . . . . . . . . .
UPDATE NODE (Update node attributes) . .
UPDATE NODEGROUP (Update a node
group) . . . . . . . . . . . . . .
UPDATE PATH (Change a path) . . . . .
UPDATE POLICYSET (Update a policy set
description) . . . . . . . . . . . .
UPDATE PROFILE (Update a profile
description) . . . . . . . . . . . .
UPDATE RECOVERYMEDIA (Update recovery
media) . . . . . . . . . . . . . .
UPDATE REPLRULE (Update replication rules)
UPDATE SCHEDULE (Update a schedule)
UPDATE SCRIPT (Update a Tivoli Storage
Manager script) . . . . . . . . . . .
UPDATE SERVER (Update a server defined for
server-to-server communications) . . . . .
UPDATE SERVERGROUP (Update a server
group description) . . . . . . . . . .
IBM Tivoli Storage Manager for Windows: Administrator's Reference
1137
1138
1139
1140
1142
1144
1145
1146
1148
1150
1151
1152
1155
1157
1161
1166
1167
1168
1169
1177
1179
1246
1248
1252
1257
1273
1275
1277
1280
1295
1296
1305
1307
1308
1310
1312
1335
1338
1342
|
|
UPDATE SPACETRIGGER (Update the space
triggers) . . . . . . . . . . . . .
UPDATE STATUSTHRESHOLD (Update a
status monitoring threshold) . . . . . .
UPDATE STGPOOL (Update a storage pool)
UPDATE VIRTUALFSMAPPING (Update a
virtual file space mapping) . . . . . .
UPDATE VOLHISTORY (Update sequential
volume history information) . . . . . .
UPDATE VOLUME (Change a storage pool
volume) . . . . . . . . . . . . .
VALIDATE commands . . . . . . . . .
VALIDATE LANFREE (Validate LAN-Free
paths) . . . . . . . . . . . . .
VALIDATE POLICYSET (Verify a policy set)
VALIDATE REPLICATION (Validate
replication for a client node) . . . . . .
VARY (Bring a random access volume online or
offline) . . . . . . . . . . . . . .
Chapter 3. Server options
. 1343
. 1345
1349
. 1389
. 1391
. 1393
. 1397
. 1398
1400
. 1402
. 1406
. . . . . 1409
Modifying server options . . . . . . .
Types of server options. . . . . . . .
Server communication options . . . .
Server storage options . . . . . . .
Client-server options . . . . . . .
Date, number, time, and language options
Database options . . . . . . . . .
Data transfer options . . . . . . .
Message options . . . . . . . . .
Event logging options . . . . . . .
Security options and licensing options. .
Miscellaneous options . . . . . . .
3494SHARED . . . . . . . . . . .
ACSACCESSID . . . . . . . . . .
ACSLOCKDRIVE . . . . . . . . .
ACSQUICKINIT . . . . . . . . . .
ACSTIMEOUTX . . . . . . . . . .
ACTIVELOGDIRECTORY . . . . . . .
ACTIVELOGSIZE . . . . . . . . .
ADMINCOMMTIMEOUT . . . . . . .
ADMINIDLETIMEOUT . . . . . . .
ADMINONCLIENTPORT . . . . . . .
ADREGISTER . . . . . . . . . . .
ADSETDC . . . . . . . . . . . .
ADSMGROUPNAME . . . . . . . .
ADUNREGISTER . . . . . . . . .
ALIASHALT . . . . . . . . . . .
ALLOWREORGINDEX. . . . . . . .
ALLOWREORGTABLE . . . . . . . .
ARCHFAILOVERLOGDIRECTORY. . . .
ARCHLOGDIRECTORY . . . . . . .
ASSISTVCRRECOVERY . . . . . . .
AUDITSTORAGE . . . . . . . . .
CHECKTAPEPOS . . . . . . . . .
CLIENTDEDUPTXNLIMIT . . . . . .
COMMMETHOD . . . . . . . . .
COMMTIMEOUT . . . . . . . . .
DATEFORMAT . . . . . . . . . .
DBDIAGLOGSIZE . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1409
1410
1410
1412
1413
1413
1413
1414
1414
1415
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1440
1442
1444
1445
1446
DBDIAGPATHFSTHRESHOLD
threshold for free space) . .
DBMEMPERCENT . . . .
DBMTCPPORT . . . . .
DEDUPREQUIRESBACKUP .
DEDUPTIER2FILESIZE. . .
DEDUPTIER3FILESIZE. . .
DEVCONFIG . . . . . .
DISABLESCHEDS . . . .
DISPLAYLFINFO. . . . .
DNSLOOKUP . . . . . .
DRIVEACQUIRERETRY . .
ENABLENASDEDUP . . .
EVENTSERVER . . . . .
EXPINTERVAL . . . . .
EXPQUIET . . . . . . .
FFDCLOGNAME . . . .
FFDCMAXLOGSIZE . . .
FILEEXIT . . . . . . .
FILETEXTEXIT . . . . .
FSUSEDTHRESHOLD . . .
IDLETIMEOUT . . . . .
LANGUAGE . . . . . .
LDAPCACHEDURATION. .
LDAPURL . . . . . . .
MAXSESSIONS . . . . .
MESSAGEFORMAT . . . .
MIRRORLOGDIRECTORY .
MOVEBATCHSIZE . . . .
MOVESIZETHRESH . . .
MSGINTERVAL . . . . .
NAMEDPIPENAME . . .
NDMPCONTROLPORT . .
NDMPENABLEKEEPALIVE .
NDMPKEEPIDLEMINUTES .
NDMPPORTRANGE . . .
NDMPPREFDATAINTERFACE
NOPREEMPT . . . . . .
NORETRIEVEDATE. . . .
NPAUDITFAILURE . . . .
NPAUDITSUCCESS . . . .
NPBUFFERSIZE . . . . .
NUMBERFORMAT . . . .
NUMOPENVOLSALLOWED.
QUERYAUTH . . . . . .
RECLAIMDELAY . . . .
RECLAIMPERIOD . . . .
REORGBEGINTIME. . . .
REORGDURATION . . . .
REPORTRETRIEVE . . . .
REPLBATCHSIZE . . . .
REPLSIZETHRESH . . . .
REQSYSAUTHOUTFILE . .
RESOURCETIMEOUT . . .
RESTOREINTERVAL . . .
RETENTIONEXTENSION . .
SANDISCOVERY. . . . .
SANDISCOVERYTIMEOUT .
SANREFRESHTIME . . . .
SEARCHMPQUEUE. . . .
SECUREPIPES. . . . . .
(Specify
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
a
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1470
1471
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
Contents
ix
SERVERDEDUPTXNLIMIT . . .
SHMPORT . . . . . . . . .
SHREDDING . . . . . . . .
SNMPHEARTBEATINTERVAL . .
SNMPMESSAGECATEGORY . . .
SNMPSUBAGENT . . . . . .
SNMPSUBAGENTHOST . . . .
SNMPSUBAGENTPORT . . . .
SSLFIPSMODE . . . . . . .
SSLTCPADMINPORT . . . . .
SSLTCPPORT . . . . . . . .
SSLTLS12 . . . . . . . . .
TCPADMINPORT . . . . . .
TCPNODELAY . . . . . . .
TCPPORT . . . . . . . . .
TCPWINDOWSIZE . . . . . .
TECBEGINEVENTLOGGING . .
TECHOST . . . . . . . . .
TECPORT . . . . . . . . .
TECUTF8EVENT . . . . . . .
THROUGHPUTDATATHRESHOLD
THROUGHPUTTIMETHRESHOLD
TIMEFORMAT . . . . . . .
TXNGROUPMAX . . . . . .
UNIQUETDPTECEVENTS . . .
UNIQUETECEVENTS . . . . .
USEREXIT . . . . . . . . .
VERBCHECK . . . . . . . .
VOLUMEHISTORY . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1510
1512
1513
1514
1515
1516
1517
1518
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
Chapter 4. Server utilities. . . . . . 1539
DSMMAXSG (Increase the block size for writing
data) . . . . . . . . . . . . . . .
DSMSERV (Start the server) . . . . . . .
DSMSERV DISPLAY DBSPACE (Display
information about database storage space) . .
DSMSERV DISPLAY LOG (Display recovery log
information) . . . . . . . . . . . .
DSMSERV FORMAT (Format the database and
log) . . . . . . . . . . . . . . .
DSMSERV INSERTDB (Move a server database
into an empty database) . . . . . . . .
x
. 1540
. 1541
. 1542
. 1543
. 1545
DSMSERV LOADFORMAT (Format a database)
DSMSERV REMOVEDB (Remove a database)
DSMSERV RESTORE DB (Restore the database)
DSMSERV RESTORE DB (Restore a database to
its most current state) . . . . . . . . .
DSMSERV RESTORE DB (Restore a database to
a point-in-time) . . . . . . . . . . .
DSMSERV UPDATE (Create registry entries for a
server instance) . . . . . . . . . . . .
1551
1553
1554
1555
1558
1562
Appendix A. Return codes for use in
IBM Tivoli Storage Manager scripts . 1563
Appendix B. Support information
1567
Getting technical training . . . . . . . . .
Searching knowledge bases . . . . . . . .
Searching the Internet . . . . . . . . .
Using IBM Support Assistant. . . . . . .
Finding product fixes . . . . . . . . .
Receiving notification of product fixes. . . .
Contacting IBM Software Support . . . . . .
Setting up a subscription and support contract
Determining the business impact . . . . .
Describing the problem and gathering
background information . . . . . . . .
Submitting the problem to IBM Software
Support . . . . . . . . . . . . . .
1567
1567
1568
1568
1569
1569
1569
1570
1570
1570
1571
Appendix C. Accessibility features
for the Tivoli Storage Manager
product family . . . . . . . . . . 1573
Notices . . . . . . . . . . . . . 1575
Trademarks
.
.
.
.
.
.
.
.
.
.
.
.
. 1577
Glossary . . . . . . . . . . . . . 1579
Index . . . . . . . . . . . . . . 1601
. 1548
IBM Tivoli Storage Manager for Windows: Administrator's 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.
This publication provides you with the commands and options that you can use to
manage the Tivoli Storage Manager server.
Who should read this publication
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
Publications for the IBM Tivoli Storage Manager family of products are available
online. The Tivoli Storage Manager product family includes IBM Tivoli Storage
FlashCopy® Manager, IBM Tivoli Storage Manager for Space Management, IBM
Tivoli Storage Manager for Databases, and several other storage management
products from IBM Tivoli.
To search all publications, search across the appropriate Tivoli Storage Manager
information center:
v Version 6.3 information center: http://pic.dhe.ibm.com/infocenter/tsminfo/v6r3
v Version 6.4 information center: http://pic.dhe.ibm.com/infocenter/tsminfo/v6r4
You can download PDF versions of publications from the Tivoli Storage Manager
information center or from the IBM Publications Center at http://www.ibm.com/
shop/publications/order/.
Go to Tivoli Documentation Central to find information centers that contain official
product documentation for current and previous versions of Tivoli products,
including the Tivoli Storage Manager product family. You can find Tivoli
Documentation Central at http://www.ibm.com/tivoli/documentation.
You can also order some related publications from the IBM Publications Center
website at http://www.ibm.com/shop/publications/order/. The website provides
information about ordering publications from countries other than the United
States. In the United States, you can order publications by calling 1-800-879-2755.
© Copyright IBM Corp. 1993, 2013
xi
Tivoli Storage Manager publications
The following tables list the publications that make up the Tivoli Storage Manager
library.
Table 1. Tivoli Storage Manager server publications
Publication title
Order number
IBM Tivoli Storage Manager for AIX Installation Guide
GC23-9781
IBM Tivoli Storage Manager for AIX Administrator's Guide
SC23-9769
IBM Tivoli Storage Manager for AIX Administrator's Reference
SC23-9775
IBM Tivoli Storage Manager for HP-UX Installation Guide
GC23-9782
IBM Tivoli Storage Manager for HP-UX Administrator's Guide
SC23-9770
IBM Tivoli Storage Manager for HP-UX Administrator's Reference
SC23-9776
IBM Tivoli Storage Manager for Linux Installation Guide
GC23-9783
IBM Tivoli Storage Manager for Linux Administrator's Guide
SC23-9771
IBM Tivoli Storage Manager for Linux Administrator's Reference
SC23-9777
IBM Tivoli Storage Manager for Oracle Solaris Installation Guide
GC23-9784
IBM Tivoli Storage Manager for Oracle Solaris Administrator's Guide
SC23-9772
IBM Tivoli Storage Manager for Oracle Solaris Administrator's Reference
SC23-9778
IBM Tivoli Storage Manager for Windows Installation Guide
GC23-9785
IBM Tivoli Storage Manager for Windows Administrator's Guide
SC23-9773
IBM Tivoli Storage Manager for Windows Administrator's Reference
SC23-9779
IBM Tivoli Storage Manager for z/OS Media Installation and User's
Guide
SC27-4018
IBM Tivoli Storage Manager Upgrade and Migration Guide for V5
Servers
GC27-4017
IBM Tivoli Storage Manager Integration Guide for Tivoli Storage
Manager FastBack®
SC27-2828
Table 2. Tivoli Storage Manager storage agent publications
Publication title
Order number
IBM Tivoli Storage Manager for SAN for AIX Storage Agent User's
Guide
SC23-9797
IBM Tivoli Storage Manager for SAN for HP-UX Storage Agent User's
Guide
SC23-9798
IBM Tivoli Storage Manager for SAN for Linux Storage Agent User's
Guide
SC23-9799
IBM Tivoli Storage Manager for SAN for Oracle Solaris Storage Agent
User's Guide
SC23-9800
IBM Tivoli Storage Manager for SAN for Windows Storage Agent User's
Guide
SC23-9553
Table 3. Tivoli Storage Manager client publications
xii
Publication title
Order number
IBM Tivoli Storage Manager for UNIX and Linux: Backup-Archive
Clients Installation and User's Guide
SC23-9791
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Table 3. Tivoli Storage Manager client publications (continued)
Publication title
Order number
IBM Tivoli Storage Manager for Windows: Backup-Archive Clients
Installation and User's Guide
SC23-9792
IBM Tivoli Storage Manager Using the Application Programming
Interface
SC23-9793
IBM Tivoli Storage Manager for Space Management for UNIX and Linux: SC23-9794
User’s Guide
IBM Tivoli Storage Manager HSM for Windows Administration Guide
SC23-9795
Table 4. Tivoli Storage Manager data protection publications
Publication title
Order number
IBM Tivoli Storage Manager for Databases: Data Protection for Microsoft
SQL Server Installation and User’s Guide
GC27-4010
IBM Tivoli Storage Manager for Databases: Data Protection for Oracle for SC27-4019
UNIX and Linux Installation and User’s Guide
IBM Tivoli Storage Manager for Databases: Data Protection for Oracle for SC27-4020
Windows Installation and User’s Guide
IBM Tivoli Storage Manager for Mail: Data Protection for Microsoft
Exchange Server Installation and User’s Guide
GC27-4009
IBM Tivoli Storage Manager for Mail: Data Protection for Lotus Domino
UNIX and Linux Installation and User’s Guide
SC27-4021
IBM Tivoli Storage Manager for Mail: Data Protection for Lotus Domino
for Windows Installation and User’s Guide
SC27-4022
IBM Tivoli Storage Manager for Enterprise Resource Planning: Data
Protection for SAP Installation and User’s Guide for DB2
SC33-6341
IBM Tivoli Storage Manager for Enterprise Resource Planning: Data
Protection for SAP Installation and User’s Guide for Oracle
SC33-6340
IBM Tivoli Storage Manager for Virtual Environments Installation and
User’s Guide
SC27-2898
IBM Tivoli Storage Manager for Microsoft SharePoint Guide
N/A
Table 5. IBM Tivoli Storage Manager troubleshooting and tuning publications
Publication title
Order number
IBM Tivoli Storage Manager Problem Determination Guide
GC23-9789
IBM Tivoli Storage Manager Optimizing Performance
GC23-9788
IBM Tivoli Storage Manager Client Messages and Application
Programming Interface Return Codes
SC27-2878
IBM Tivoli Storage Manager Server Messages and Error Codes
SC27-2877
IBM Tivoli Storage Manager for Mail: Data Protection for Microsoft
Exchange Server Messages
GC27-4011
IBM Tivoli Storage Manager for Databases: Data Protection for Microsoft
SQL Server Messages
GC27-4012
IBM Tivoli Storage Manager for Databases: Data Protection for Oracle
Messages
SC27-4014
IBM Tivoli Storage Manager for Mail: Data Protection for Lotus Domino
Messages
SC27-4015
About this publication
xiii
Table 5. IBM Tivoli Storage Manager troubleshooting and tuning publications (continued)
Publication title
Order number
IBM Tivoli Storage Manager for Enterprise Resource Planning: Data
Protection for SAP Messages
SC27-4016
Note: You can find information about IBM System Storage® Archive Manager at
the Tivoli Storage Manager v6.3.0 information center.
Tivoli Storage FlashCopy Manager publications
The following table lists the publications that make up the Tivoli Storage
FlashCopy Manager library.
Table 6. Tivoli Storage FlashCopy Manager publications
Publication title
Order number
IBM Tivoli Storage FlashCopy Manager for UNIX and Linux Installation
and User’s Guide
SC27-4005
IBM Tivoli Storage FlashCopy Manager for Windows Installation and
User’s Guide
SC27-4006
IBM Tivoli Storage FlashCopy Manager for VMware Installation and
User’s Guide
SC27-4007
IBM Tivoli Storage FlashCopy Manager Messages
GC27-4008
Related hardware publications
The following table lists related IBM hardware products publications.
For additional information on hardware, see the resource library for tape products
at http://www.ibm.com/systems/storage/tape/library.html.
Title
Order Number
IBM TotalStorage 3494 Tape Library Introduction and Planning Guide
GA32-0448
IBM TotalStorage 3494 Tape Library Operator Guide
GA32-0449
IBM 3490E Model E01 and E11 User’s Guide
GA32-0298
IBM Tape Device Drivers Installation and User’s Guide
GC27-2130
IBM TotalStorage Enterprise Tape System 3590 Operator Guide
GA32-0330
IBM TotalStorage Enterprise Tape System 3592 Operator Guide
GA32-0465
Conventions used in this publication
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
xiv
IBM Tivoli Storage Manager for Windows: Administrator's Reference
may represent fewer actual characters.
About this publication
xv
xvi
IBM Tivoli Storage Manager for Windows: Administrator's Reference
New for IBM Tivoli Storage Manager Version 6.3
Many features in the Tivoli Storage Manager Version 6.3 server are new for
previous Tivoli Storage Manager users.
Server updates
New features and other changes are available in the IBM Tivoli Storage Manager
V6.3 server. Technical updates since the previous edition are marked with a vertical
bar ( | ) in the left margin.
New for the server in Version 6.3.4
Server fix pack 6.3.4 contains several new features, in addition to fixes for
problems.
The server that is included with the Tivoli Storage Manager and IBM Tivoli Storage
Manager Extended Edition V6.4 products is at the V6.3.4 level. The V6.3.4 server is
also available for download separately, as a fix pack for current users of V6.3.
Tivoli Storage Manager migration to V6.3.4 or later on Linux
x86_64
|
|
|
|
|
You can now migrate a Tivoli Storage Manager V5 server that runs on an AIX®,
HP-UX, or Solaris operating system to V6.3.4 or later on a Linux x86_64 operating
system.
|
|
|
Depending on your hardware and software environment, this migration procedure
might be useful for achieving server consolidation, load balancing, or
standardization on the Linux operating system.
|
|
|
IBM Tivoli Storage Manager Operations Center
|
|
|
|
|
|
The V6.4.1 Operations Center includes an Overview page that shows the
interaction of Tivoli Storage Manager servers and clients. You can use the
Operations Center to identify potential issues at a glance, manage alerts, and
access the Tivoli Storage Manager command line. The Administration Center
interface is also available, but the Operations Center is the preferred monitoring
interface.
|
|
|
|
Tivoli Monitoring for Tivoli Storage Manager updates
|
The following new Cognos reports are available:
|
|
|
|
Status reports
v Client storage summary and details
v VE activity status
v VE backup type summary
v VE current occupancy summary
|
The V6.4.1 IBM Tivoli Storage Manager Operations Center is a new web-based user
interface for managing a storage environment.
Tivoli Monitoring for Tivoli Storage Manager V6.3.4 includes some new Cognos®
reports, and features, including some methods for distributing Cognos reports to
other organizations.
© Copyright IBM Corp. 1993, 2013
xvii
|
|
Trending reports
v Client storage usage trends
|
|
To allow reports to be shared, Cognos reports can be exported and imported in to
other Tivoli Common Reporting instances.
|
|
The Agent Log workspace is enhanced to display whether the monitored servers
are up and running.
|
|
|
Pruning values are now automatically configured during new installations. If you
upgraded the application, you must manually configure the pruning settings to
periodically remove data from the WAREHOUS database.
New for the server in Version 6.3.3
Server fix pack 6.3.3 contains several new features, in addition to fixes for
problems.
The server that is included with the Tivoli Storage Manager and IBM Tivoli Storage
Manager Extended Edition V6.4 products is at the V6.3.3 level. The V6.3.3 server is
also available for download separately, as a fix pack for current users of V6.3.
LDAP-authenticated passwords
IBM Tivoli Storage Manager server V6.3.3 can use an LDAP directory server to
authenticate passwords. LDAP-authenticated passwords give you an extra level of
security by being case-sensitive, offering advanced password rule enforcement, and
a centralized server on which to authenticate them.
You must have an LDAP directory server on which to authenticate a hash
representation of the password. After you configure the Tivoli Storage Manager
server, you can authenticate administrator and node passwords with the LDAP
directory server.
The two methods of authentication are LDAP and LOCAL. LOCAL means that the
password is authenticated with the Tivoli Storage Manager server.
Passwords that are authenticated with the Tivoli Storage Manager server are not
case-sensitive. All passwords can be composed of characters from the following
list:
a
A
0
~
b
B
1
!
c
C
2
@
d
D
3
#
e
E
4
$
f
F
5
%
g
G
6
^
h
H
7
&
i
I
8
*
j k l m n o p q r s t u v w x y z
J K L M N O P Q R S T U V W X Y Z
9
_ - + = ` | ( ) { } [ ] : ; < > , . ? /
Restriction: Client nodes must be at V6.4 or later to use the LDAP directory server
to authenticate passwords.
xviii
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Tivoli Monitoring for Tivoli Storage Manager updates
Tivoli Monitoring for Tivoli Storage Manager now includes some new Tivoli
Enterprise Portal workspaces, new Cognos reports, and the option for existing IBM
Tivoli Monitoring customers to install and deploy monitoring agents from a small
agent package.
The new Cognos reports are:
Status reports:
v Client activity status
v Client backup currency
v Client backup status
v
v
v
v
v
v
Client schedule status
Client storage pool usage summary
Current client occupancy summary
Current storage pool summary
Highest storage space usage
Server schedule status
v Yesterday's missed and failed client schedules
Trending Reports
v Client activity success rate
v Client schedule success rate
v Server database growth trends
v Server storage growth trends
New Tivoli Enterprise Portal monitoring workspaces are:
v Activity summary workspace, which provides data about server and client
operations for both virtual and non-virtual environments.
v Sessions workspace, which provides a view of all the active client sessions
running on the specified server.
Additional VMware backup information is now provided in the Tivoli Storage
Manager server activity log and summary table for Data Protection for VMware
operations. This new information provides improved data collection and reporting
content when you use reporting facilities such as Tivoli Common Reporting.
A new option to enable LDAP authentication, when creating and configuring
monitoring agent instances.
The improved ability to exclude, or filter-out message numbers, to narrow results.
Existing IBM Tivoli Monitoring users can now install the small agent package, and
remotely deploy monitoring agents without having to download the larger Tivoli
Monitoring for Tivoli Storage Manager package.
New for IBM Tivoli Storage Manager Version 6.3
xix
Control for inactive NDMP operation connections
Transmission Control Protocol (TCP) keepalive is a mechanism by which small packets
of data are sent across the network at predefined intervals. The packets prevent a
long-running, inactive connection from being closed by firewall software that
detects and closes inactive connections. With this release, you can enable the TCP
keepalive function for control connections of network data-management protocol
(NDMP).
Enhancements for expiration processing
Improvements for expiring inventory are available with this release. Node
processing can now be spread across more than one thread in parallel, at the file
space level. This change in process helps distribute the workload and more
efficiently avoid bottlenecks for nodes that use virtual servers.
Related reference:
“EXPIRE INVENTORY (Manually start inventory expiration processing)” on page
471
New for the server in Version 6.3.1
Server fix pack 6.3.1 contains new features, in addition to fixes for problems.
Data validation during read/write operations to tape
With logical block protection, IBM Tivoli Storage Manager includes a cyclic
redundancy check (CRC) value at the end of each logical block of data to be
written to tape. You can specify CRC data-block validation during read and write
operations, or only during write operations.
You can use logical block protection only with the following types of drives and
media:
v IBM LTO5 and later
v IBM 3592 Generation 3 drives, and later, with 3592 Generation 2 media, and later
New for the server in Version 6.3.0
New features and other changes are available in the Tivoli Storage Manager V6.3
server.
Node replication
Node replication is the process of incrementally copying or replicating client node
data from one server of Tivoli Storage Manager to another server of Tivoli Storage
Manager for the purpose of disaster recovery.
The server from which client node data is replicated is called a source replication
server. The server to which client node data is replicated is called a target replication
server.
Node replication avoids the logistics and security exposure of physically moving
tape media to a remote location. If a disaster occurs and the source replication
server is unavailable, backup-archive clients of Tivoli Storage Manager can recover
their data from the target replication server. If you cannot recover the source
replication server, you can convert client nodes to nonreplicating nodes for store
operations on the target replication server.
xx
IBM Tivoli Storage Manager for Windows: Administrator's Reference
If you use the export and import functions of Tivoli Storage Manager to store client
node data on a disaster-recovery server, you can convert the nodes to replicating
nodes. When replicating data, you can also use data deduplication to reduce
bandwidth and storage requirements.
Tivoli Storage Manager V6.3 servers can be used for node replication. However,
you can replicate data for client nodes that are at V6.3 or earlier. You can also
replicate data that was stored on a Tivoli Storage Manager V6.2 or earlier server
before you upgraded it to V6.3.
You cannot replicate nodes from a Tivoli Storage Manager V6.3.3 server to a server
that is running on an earlier level of Tivoli Storage Manager.
New for IBM Tivoli Storage Manager Version 6.3
xxi
Related reference:
“CANCEL REPLICATION (Cancel node replication processes)” on page 71
“DEFINE SERVER (Define a server for server-to-server communications)” on page
312
“DISABLE SESSIONS (Prevent new sessions from accessing Tivoli Storage
Manager)” on page 457
“ENABLE REPLICATION (Allow outbound replication processing on a server)” on
page 466
“ENABLE SESSIONS (Resume user activity on the server)” on page 467
“DISABLE REPLICATION (Prevent outbound replication processing on a server)”
on page 456
“QUERY FILESPACE (Query one or more file spaces)” on page 755
“QUERY NODE (Query nodes)” on page 797
“QUERY REPLICATION (Query node replication processes)” on page 840
“QUERY REPLNODE (Display information about replication status for a client
node)” on page 850
“QUERY REPLRULE (Query replication rules)” on page 854
“QUERY SERVER (Query a server)” on page 879
“QUERY STATUS (Query system parameters)” on page 894
“REGISTER NODE (Register a node)” on page 959
“REMOVE REPLNODE (Remove a client node from replication)” on page 980
“REPLICATE NODE (Replicate data in file spaces that belong to a client node)” on
page 993
“SET ARREPLRULEDEFAULT (Set the server replication rule for archive data)” on
page 1058
“SET BKREPLRULEDEFAULT (Set the server replication rule for backup data)” on
page 1061
“SET REPLRETENTION (Set the retention period for replication records)” on page
1115
“SET REPLSERVER (Set the target replication server)” on page 1117
“SET SPREPLRULEDEFAULT (Set the server replication rule for space-managed
data)” on page 1126
“UPDATE FILESPACE (Update file-space node-replication rules)” on page 1252
“UPDATE NODE (Update node attributes)” on page 1280
“UPDATE REPLRULE (Update replication rules)” on page 1310
“UPDATE SERVER (Update a server defined for server-to-server communications)”
on page 1338
“VALIDATE REPLICATION (Validate replication for a client node)” on page 1402
xxii
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Deduplication of NetApp file-server data
Deduplication of data that belongs to network-attached storage (NAS) file-servers
is disabled by default. To enable deduplicaton of NetApp file-server data, use the
new ENABLENASDEDUP server option.
Related reference:
“ENABLENASDEDUP” on page 1458
Database table and index reorganization
If automatic table and index reorganization is affecting server performance, you
can manually schedule reorganizations.
Related reference:
“ALLOWREORGINDEX” on page 1432
“ALLOWREORGTABLE” on page 1433
“REORGBEGINTIME” on page 1496
“REORGDURATION” on page 1497
Automatic backup-archive client deployment
IBM Tivoli Storage Manager, Version 6.3 can be scheduled to automatically deploy
backup-archive client software to all workstations that have the backup-archive
client installed.
You can deploy backup-archive clients on Microsoft Windows operating systems
from a fix pack or interim fixes for all releases at V5.4 or later. You can migrate the
Backup-Archive Client to a newer version, release, modification, or fix pack level
that is V5.5 and later.
You can deploy backup-archive clients on operating systems other than Windows
from all releases at V5.5 or later. These Backup-Archive Clients can go to any later
version, release, modification, or fix level. You can coordinate the updates to each
Backup-Archive Client from the Administration Center.
Multistream database backup and restore processing
Multiple, concurrent data streams can reduce the amount of time that is required
to back up or restore the database. You can specify multiple, concurrent data
streams for automatic or manual database-backup operations.
During restore operations, the Tivoli Storage Manager server attempts to use the
same number of data streams that you specified for the backup operation. For
example, suppose that you specify four data streams for a database backup
operation. During a restore operation, the server attempts to use four drives. If one
drive is offline and unavailable, the server uses three drives for the restore
operation.
The benefit of multiple, concurrent data streaming depends on the size of the
database. In general, if the database is less than 100 GB, the amount of time that
you can save is relatively small. Multiple, concurrent data streaming also uses
more volumes. If the volumes are high-capacity and if you use data compression,
the result can be wasted space.
New for IBM Tivoli Storage Manager Version 6.3
xxiii
Related reference:
“BACKUP DB (Back up the database)” on page 47
“QUERY DB (Display database information)” on page 702
“QUERY VOLHISTORY (Display sequential volume history information)” on page
928
“SELECT (Perform an SQL query of the Tivoli Storage Manager database)” on page
1029
“SET DBRECOVERY (Set the device class for automatic backups)” on page 1070
Tivoli Monitoring for Tivoli Storage Manager updates
IBM Tivoli Monitoring for Tivoli Storage Manager, previously referred to as the
Reporting and Monitoring feature, has an improved installation wizard. Cognos is
now included for custom report creation.
Updates to Tivoli Monitoring for Tivoli Storage Manager include the following
items:
v Cognos Business Intelligence V8 is an integrated business intelligence suite that
is provided as part of Tivoli Common Reporting. Tivoli Common Reporting is
included in the Administration Center installation when you select the Tivoli
Common Reporting component. See Customizing reports with Cognos Business
Intelligence, in the Monitoring operations section of the Administrator's Guide for
details. All of the information regarding client and server reports can also be
found in that section.
v The installation process has been improved to include a prerequisite checker,
and now performs all installation configuration tasks automatically.
v A customizable dashboard workspace has been added to display many
commonly viewed items in a single view. With the default setting, the dashboard
displays data about the storage space used by node; unsuccessful client and
server schedules; and details about storage pools, drives, and activity log error
messages.
v You can include multiple servers in a single report. Reports have been enhanced
to refine the accuracy of the data being displayed.
v New Tivoli Enterprise Portal workspaces are: activity log, agent log, updates to
client node status, drives, libraries, occupancy, PVU details, and replication
status and details.
v New client reports are available: storage pool media details, storage summary
details, replication details, replication growth, and replication summary.
v New server reports are available: activity log details, server throughput, and an
updated server throughput report for data collected by agents earlier than
version 6.3.
Estimation of processor value units
You can use new methods to obtain information about the number of client and
server devices connected to the system, and the utilization of processor value units
(PVUs) by server devices. The new methods provide information to help you
assess the license compliance of the Tivoli Storage Manager system.
By using the new QUERY PVUESTIMATE command, you can generate reports that
estimate the number of server devices and client devices managed by the Tivoli
Storage Manager server. You can also view PVU information on a per-node basis.
These reports are not legally binding, but provide a starting point for determining
license requirements. Alternatively, you can view PVU information in the
xxiv
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Tivoli Monitoring for Tivoli Storage Manager updates in Version 6.3
Administration Center. The Administration Center provides summaries of client
devices, server devices, and estimated PVUs, and more detailed information.
For purposes of PVU estimation, only nodes on Windows 7, Windows XP
Professional, and Apple systems are classified as client devices by default. Nodes
on all other platforms are classified as server devices by default. You can update
the role classification by issuing the UPDATE NODE command. You can also view and
change the role classifications in the Administration Center client node notebook.
For a detailed report, issue the SQL SELECT * FROM PVUESTIMATE_DETAILS command.
This command extracts information at the node level. This data can be exported to
a spreadsheet and modified to more accurately represent the system environment.
For more information about PVU calculations and their use for licensing purposes,
see the topic describing the role of PVUs in the Administrator's Guide.
Prerequisite checker
Tivoli Storage Manager Version 6.3 includes a prerequisite checker, a tool that can
be run before starting the Tivoli Storage Manager installation.
The prerequisite checker verifies requirements for the Tivoli Storage Manager
server, the Administration Center, and Tivoli Monitoring for Tivoli Storage
Manager. The prerequisite checker verifies the operating system, the amount of free
disk space, the required memory for the server, and other prerequisites. The tool
presents a summary of results, informs you about changes that are required in
your environment before installation, and creates required directories. In this way,
the prerequisite checker can help simplify the installation process.
For more information, see the section about running the prerequisite checker in the
Installation Guide.
Storage device updates
New device support and other changes to storage devices are available in Tivoli
Storage Manager Version 6.3.
Virtual tape libraries:
With enhancements available in Version 6.3, you can define a library as a virtual
tape library (VTL) to Tivoli Storage Manager.
VTLs primarily use disk subsystems to internally store data. Because they do not
use tape media, you can exceed the capabilities of a physical tape library when
using VTL storage. Using a VTL, you can define many volumes and drives which
provides for greater flexibility in the storage environment and increases
productivity by allowing more simultaneous mounts and tape I/O.
Related reference:
DEFINE LIBRARY
PERFORM LIBACTION
UPDATE LIBRARY
New for IBM Tivoli Storage Manager Version 6.3
xxv
Tivoli Monitoring for Tivoli Storage Manager updates in Version 6.3
Access to storage devices attached by FICON on a z/OS system:
The database of a Tivoli Storage Manager V5 server that is running on a z/OS®
system can be migrated to a V6.3 server that runs on AIX or Linux on System z®.
After the upgrade, z/OS users can continue to access data stored on tape volumes
whose contents are accessed by using FICON® attached storage devices.
The Tivoli Storage Manager V6.3 server accesses client data by using a storage
device attached to z/OS. The storage device is made available by IBM Tivoli
Storage Manager for z/OS Media.
In addition, Tivoli Storage Manager for z/OS Media facilitates access to Virtual
Storage Access Method (VSAM) linear data sets on z/OS by using an enhanced
sequential FILE storage method.
For more information, see the section about migrating Tivoli Storage Manager V5
servers on z/OS systems to V6 in the Tivoli Storage Manager Upgrade and Migration
Guide for V5 Servers.
Append-only mode for IBM LTO-5 drives:
The CHECKTAPEPOS server option allows the Tivoli Storage Manager server to check
the validity and consistency of data block positions on tape.
Enhancements to this option enable a drive to check for data overwrite problems
before each WRITE operation and allow Tivoli Storage Manager to reposition tapes
to the correct location and continue to write data. Use the CHECKTAPEPOS option
with IBM LTO Generation 5 drives.
Note: You can enable append-only mode for IBM LTO Generation 5 and later
drives, and for any drives that support this feature.
Related reference:
QUERY OPTION
SETOPT
CHECKTAPEPOS
Persistent reserve for tape drives:
Persistent reservation allows tape drive reservations from other servers to be
cleared, if, for example, a server crashes.
In Tivoli Storage Manager Version 6.3, persistent reserve is enabled for drives and
driver levels that support the feature.
For additional details about persistent reserve support, see http://www.ibm.com/
support/docview.wss?uid=swg21470319.
Related reference:
DEFINE LIBRARY
UPDATE LIBRARY
xxvi
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Tivoli Monitoring for Tivoli Storage Manager updates in Version 6.3
Administration Center updates
New Administration Center support is available in Tivoli Storage Manager Version
6.3.
Tivoli Integrated Portal, Version 2.1:
The Tivoli Storage Manager Administration Center uses Tivoli Integrated Portal for
its graphical user interface (GUI). With Tivoli Integrated Portal V2.1, you can now
monitor the Administration Center with Internet Explorer 8 and Mozilla Firefox
3.5. All browsers that you used with Tivoli Integrated Portal V1.1.1 and later can
be used with this latest version.
When you install Tivoli Integrated Portal V2.1 installing Tivoli Common Reporting,
embedded security service, or the time scheduling service is optional. These
features can be added and registered with Tivoli Integrated Portal V2.1 at a later
time.
Administration Center policy domain updates:
With enhancements to the Administration Center, you can now specify server
event-based archive settings using the Policy Domain and Management Class
wizards.
If you set an archive retention period for an object through the server, you can
update these settings using the Administration Center Management Class
notebook.
Setting an archive retention period ensures that objects are not deleted from the
Tivoli Storage Manager server until policy-based retention requirements for that
object are satisfied.
Analysis of client performance data:
With the new client performance monitor function, you have the capability to
gather and analyze performance data about backup and restore operations for an
IBM Tivoli Storage Manager client.
The client performance monitor function is accessed from the Tivoli Storage
Manager Administration Center and uses data that is collected by the API. You can
view performance information about processor, disk, and network utilization, and
performance data that relates to data transfer rates and data compression. You can
analyze data throughput rates at any time during a backup or restore operation.
Also, you can use the performance information to analyze processor, disk, or
network performance bottlenecks.
Server session disablement and enablement
You can now temporarily disable and enable all outbound or inbound sessions for
a particular Tivoli Storage Manager server.
This feature is useful, for example, if you have a planned network outage that
might affect communication between a source and a target replication server. To
prevent replication failures, you can disable outbound sessions from the source
replication server before the outage. After communications have been reestablished,
you can resume replication by enabling outbound sessions.
New for IBM Tivoli Storage Manager Version 6.3
xxvii
Related reference:
“DISABLE SESSIONS (Prevent new sessions from accessing Tivoli Storage
Manager)” on page 457
“ENABLE SESSIONS (Resume user activity on the server)” on page 467
Command-line help for subcommands
In this release, you can obtain help for Tivoli Storage Manager subcommands. For
example, you can display help for the DEFINE DEVCLASS command for 3570 device
classes and for 3590 device classes. To display command-line help for a
subcommand, type help followed by the topic number for the command.
Topic numbers are listed in the table of contents, for example:
3.0 Administrative commands
...
3.13.10 DEFINE DEVCLASS (Define a device class)
3.13.10.1 DEFINE DEVCLASS (Define a 3570 device class)
3.13.10.2 DEFINE DEVCLASS (Define a 3590 device class)
...
To display help for the DEFINE DEVCLASS command for 3570 device classes, type:
help 3.13.10.1
As in previous releases, you can use this method to display help for commands
that have unique names, such as REGISTER NODE:
3.46 REGISTER
3.46.1 REGISTER ADMIN (Register an administrator)
3.46.2 REGISTER LICENSE (Register a new license)
3.46.3 REGISTER NODE (Register a node)
To display help for the REGISTER NODE command, you can type:
help 3.46.1
You can also type help commandName, where commandName is the name of the
server command for which you want information:
help register node
Related reference:
“HELP (Get help on commands and error messages)” on page 550
Data encryption with TLS/SSL
You can use Transport Layer Security (TLS)/Secure Sockets Layer (SSL) on HP-UX,
Linux, Oracle Solaris, AIX, and Windows platforms.
With TLS/SSL industry-standard communications, you can encrypt all traffic
between the backup-archive client, the administrative command-line clients, and
the IBM Tivoli Storage Manager server. You can use either self-signed or
vendor-acquired SSL certificates.
For Tivoli Storage Manager V6.3 and later, to use SSL with self-signed certificates,
use the SSLTLS12 option after you distribute new self-signed certificates to all V6.3
backup-archive clients. You can use certificates from previous server versions, but
you then cannot use TLS 1.2.
For Tivoli Storage Manager V6.3.3 server, TLS/SSL is available for LAN-free and
server-to-server functions.
xxviii
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Chapter 1. Administering the server from the command-line
interface
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 server
commands.
Compared to the administrative client, the capabilities of the server console are
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
command-line window on the system on which the server is installed, you must be
physically located at the server system to use the console. The administrative client
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
server commands.
Server scripts provide for automation of common administrative tasks. A macro is
a file that contains one or more Tivoli Storage Manager administrative commands.
When you issue the MACRO command, the server processes all commands in the
macro file in order, including commands contained in any nested macros. For
information about scripts and macros, see the Administrator's Guide.
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 1468 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.
© Copyright IBM Corp. 1993, 2013
1
Note: Text strings that are sent from the client to the server do not depend on the
server language setting. The text will be displayed properly if the administrative
client runs in the same locale when sending the string and when receiving the
string.
For example, assume that you update a node contact field with a value that
contains national characters (update node myNode contact=NLcontact_info), and
later query the node (query node myNode format=detailed). If the client is running
in the same locale when you update as when you query, the NLcontact_info will
display properly. If you update the node contact field when the client is running in
one locale, and query the node when the client is running in a different locale, it is
possible that the NLcontact_info will not display properly.
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: 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.
Stop an administrative command-line client session by entering the following
command on your workstation:
quit
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 7.
Table 7. Keyboard break sequences
Environment
UNIX-based and Linux clients
Windows
TSO
2
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Break Sequence
Ctrl+C
Ctrl+C, Ctrl+Break
ATTN
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 7 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 quotation marks for
commands in batch mode, because your operating system might not parse the
quotation marks correctly.
You can bypass this batch mode double quotation mark restriction for Windows
clients by using the back slash (\) escape character. For example, on the OBJECTS
parameter of the DEFINE CLIENTACTION command, you could enter the string
with the \ character preceding the double quotation marks 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.
Chapter 1. Administering the server from the command-line interface
3
v The administrative client session was canceled with the CANCEL SESSION
command.
You can use continuation characters when using interactive mode. For more
information, see “Entering long commands” on page 12.
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 such as >,
>>, 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 following examples.
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 dsmadmc -id=xxx -pa=xxx query domain acctg >> dominfo.acc
QUERY DOMAIN command
to the end of an existing Double greater-than signs (>>) indicates that Tivoli Storage
file in batch or
Manager appends the output to the end of an existing file.
interactive mode
4
IBM Tivoli Storage Manager for Windows: Administrator's Reference
If you want to:
Enter this:
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.
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 1431 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
Chapter 1. Administering the server from the command-line interface
5
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, databases, and report generators.
-CONsolemode
Specifies that Tivoli Storage Manager runs in console mode. All server console
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.
-DATAONLY=NO or YES
Specifies whether product version information and output headers display
with the output. The default is NO.
NO Specifies that the product version information and output column headers
display.
YES
Suppresses the product version information and output column headers.
-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 administrator's 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.
6
IBM Tivoli Storage Manager for Windows: Administrator's Reference
-PAssword=password
Specifies the administrator's 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. The
TCPPORT option is only supported by administrative clients running on
Windows operating systems and is valid on the Windows administrative client
command line.
-TCPServeraddress
Specifies a TCP/IP server address for a Tivoli Storage Manager server. The
TCPSERVERADDRESS option is only supported by administrative clients running
on Windows operating systems and is valid on the Windows administrative
client command line.
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.
Chapter 1. Administering the server from the command-line interface
7
Entering administrative commands
Commands consist of command names and usually parameters and variables.
Syntax diagrams depict the rules to follow when entering commands.
To display command-line help for server commands that have unique names, you
can type help commandName, where commandName is the name of the server
command for which you want information. For example, to display help for the
REGISTER NODE command, type help register node. Command syntax and
parameter descriptions are displayed in the output.
You can also type help followed by the topic number for the command. Topic
numbers are listed in the table of contents for command-line help, for example:
3.0 Administrative commands
3.46 REGISTER
3.46.1 REGISTER ADMIN (Register an administrator)
3.46.2 REGISTER LICENSE (Register a new license)
3.46.3 REGISTER NODE (Register a node)
To display help about the REGISTER NODE command, type:
help 3.46.3
Use topic numbers to display command-line help for subcommands. DEFINE
DEVCLASS is an example of a command that has subcommands. For example, you
can specify the DEFINE DEVCLASS command for 3570 device classes and for 3590
device classes:
3.0 Administrative commands
...
3.13.10 DEFINE DEVCLASS (Define a device class)
3.13.10.1 DEFINE DEVCLASS (Define a 3570 device class)
3.13.10.2 DEFINE DEVCLASS (Define a 3590 device class)
...
To display help for the DEFINE DEVCLASS command for 3570 device classes, type:
help 3.13.10.1
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.
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
8
IBM Tivoli Storage Manager for Windows: Administrator's Reference
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 (=).
Chapter 1. Administering the server from the command-line interface
9
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 =
10
value1
value2
value3
IBM Tivoli Storage Manager for Windows: Administrator's Reference
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 following example
shows a portion of the command for defining a copy storage pool:
DEFine STGpool pool_name device_class_name POoltype =
REClaim =
100
REClaim =
percent
COpy
DESCription =
description
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”.
Chapter 1. Administering the server from the command-line interface
11
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.
12
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Naming Tivoli Storage Manager objects
IBM 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
A–Z
Any letter, A through Z
0–9
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
The following characters are available for defining password names:
a
A
0
~
b
B
1
!
c
C
2
@
d
D
3
#
e
E
4
$
f
F
5
%
g
G
6
^
h
H
7
&
i
I
8
*
j k l m n o p q r s t u v w x y z
J K L M N O P Q R S T U V W X Y Z
9
_ - + = ` | ( ) { } [ ] : ; < > , . ? /
Passwords considered “LOCAL” are those passwords that authenticate with the
Tivoli Storage Manager server and are not case-sensitive. Passwords considered
“LDAP” are those passwords that authenticate with an LDAP directory server and
are case-sensitive.
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 that you are using. Refer
to the specific VOLUME command for details.
Chapter 1. Administering the server from the command-line interface
13
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 8 provides references to wildcard characters for some operating systems. Use
wildcard characters appropriate for your system.
Table 8. Wildcard characters by operating system
Operating system
Match any
Match exactly one
AIX, HP-UX, Linux, OS/2, Oracle
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 9 shows additional examples of using wildcard characters to match any
characters.
Table 9. 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 10 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 10. Match-exactly-one character
14
Pattern
Matches
Does not match
ab?
abc
ab, abab, abzzzz
ab?rs
abfrs
abrs, abllrs
ab?ef?rs
abdefjrs
abefrs, abdefrs, abefjrs
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Table 10. Match-exactly-one character (continued)
Pattern
Matches
Does not match
ab??rs
abcdrs, abzzrs
abrs, abjrs, abkkkrs
Specifying descriptions in keyword parameters
If a description (a string of text) for a parameter begins with a single or double
quotation mark, 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
manager's
contact="manager's" or contact='manager"s'
"manager"
contact='"manager"' or contact="""manager"""
manager's report
contact="manager's report" or contact='manager''s
report'
manager's "report"
contact='manager''s "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:
Chapter 1. Administering the server from the command-line interface
15
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.
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.
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.
16
IBM Tivoli Storage Manager for Windows: Administrator's Reference
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.
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 Administrator's 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
Chapter 1. Administering the server from the command-line interface
17
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
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
18
IBM Tivoli Storage Manager for Windows: Administrator's Reference
to these servers.
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 four administrator privilege classes in Tivoli Storage Manager:
v System
v Policy
v Storage
v Operator
After an administrator has been registered using 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 11 on page 20 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 1501.
Chapter 1. Administering the server from the command-line interface
19
Table 11. System privilege commands
Command Name
20
Command Name
AUDIT LDAPDIRECTORY
DEFINE SPACETRIGGER
AUDIT LICENSES
DEFINE STGPOOL
ACCEPT DATE
DEFINE SUBSCRIPTION
BEGIN EVENTLOGGING
DEFINE VIRTUALFSMAPPING
CANCEL EXPIRATION
DEFINE VOLUME
CANCEL PROCESS
DELETE BACKUPSET
CANCEL REPLICATION
DELETE CLIENTOPT
CANCEL REQUEST
DELETE CLOPTSET
CANCEL RESTORE
DEFINE COLLOCGROUP
CLEAN DRIVE
DEFINE COLLOCMEMBER
COPY ACTIVEDATA
DELETE DOMAIN
COPY DOMAIN
DELETE DRIVE
COPY POLICYSET
DELETE EVENTSERVER
COPY PROFILE
DELETE GRPMEMBER
COPY SCHEDULE (See note.)
DELETE LIBRARY
COPY SCRIPT
DELETE MACHINE
COPY SERVERGROUP
DELETE MACHNODEASSOCIATION
DEFINE BACKUPSET
DELETE NODEGROUP
DEFINE CLIENTACTION
DELETE NODEGROUPMEMBER
DEFINE CLIENTOPT
DELETE PROFASSOCIATION
DEFINE CLOPTSET
DELETE PROFILE
DEFINE COLLOCGROUP
DELETE RECMEDMACHASSOCIATION
DEFINE COLLOCMEMBER
DELETE RECOVERYMEDIA
DEFINE DEVCLASS
DELETE SCHEDULE (See note.)
DEFINE DOMAIN
DELETE SCRIPT
DEFINE DRIVE
DELETE SERVER
DEFINE EVENTSERVER
DELETE SERVERGROUP
DEFINE GRPMEMBER
DELETE SPACETRIGGER
DEFINE LIBRARY
DELETE STGPOOL
DEFINE MACHINE
DELETE SUBSCRIBER
DEFINE MACHNODEASSOCIATION
DELETE SUBSCRIPTION
DEFINE NODEGROUP
DELETE VIRTUALFSMAPPING
DEFINE NODEGROUPMEMBER
DISABLE EVENTS
DEFINE PATH
ENABLE EVENTS
DEFINE PROFASSOCIATION
END EVENTLOGGING
DEFINE PROFILE
EXPIRE INVENTORY
DEFINE RECMEDMACHASSOCIATION
EXPORT ADMIN
DEFINE RECOVERYMEDIA
EXPORT NODE
DEFINE SCHEDULE (See note.)
EXPORT POLICY
DEFINE SCRIPT
EXPORT SERVER
DEFINE SERVER
GENERATE BACKUPSET
DEFINE SERVERGROUP
GRANT AUTHORITY
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Table 11. System privilege commands (continued)
Command Name
Command Name
GRANT PROXYNODE
SET CONFIGMANAGER
IDENTIFY DUPLICATES
SET CONFIGREFRESH
IMPORT NODE
SET CONTEXTMESSAGING
IMPORT POLICY
SET CROSSDEFINE
IMPORT SERVER
SET DBRECOVERY
INSERT MACHINE
SET DEFAULTAUTHENTICATION
LABEL LIBVOLUME
SET DRMACTIVEDATASTGPOOL
LOCK ADMIN
SET DRMCHECKLABEL
LOCK PROFILE
SET DRMCMDFILENAME
MIGRATE STGPOOL
SET DRMCOPYSTGPOOL
MOVE DRMEDIA
SET DRMCOURIERNAME
MOVE MEDIA
SET DRMDBBACKUPEXPIREDAYS
MOVE GRPMEMBER
SET DRMFILEPROCESS
NOTIFY SUBSCRIBERS
SET DRMINSTRPREFIX
PERFORM LIBACTION
SET DRMNOTMOUNTABLENAME
PING SERVER
SET DRMPLANPREFIX
PREPARE
SET DRMPLANVPOSTFIX
QUERY BACKUPSETCONTENTS
SET DRMPRIMSTGPOOL
QUERY MEDIA
SET DRMRPFEXPIREDAYS
QUERY RPFCONTENT
SET DRMVAULTNAME
QUERY TOC
SET EVENTRETENTION
RECLAIM STGPOOL
SET INVALIDPWLIMIT
RECONCILE VOLUMES
SET LDAPPASSWORD
REGISTER ADMIN
SET LDAPUSER
REGISTER LICENSE
SET LICENSEAUDITPERIOD
REMOVE ADMIN
SET MAXCMDRETRIES
REMOVE REPLNODE
SET MAXSCHEDSESSIONS
RENAME ADMIN
SET MINPWLENGTH
RENAME SCRIPT
SET PASSEXP
RENAME SERVERGROUP
SET QUERYSCHEDPERIOD
RENAME STGPOOL
SET RANDOMIZE
REPLICATE NODE
SET REGISTRATION
RESET PASSEXP
SET REPLRETENTION
RESTORE NODE
SET REPLSERVER
REVOKE AUTHORITY
SET RETRYPERIOD
REVOKE PROXYNODE
SET SCHEDMODES
RUN
SET SERVERHLADDRESS
SET ACCOUNTING
SET SERVERLLADDRESS
SET ACTLOGRETENTION
SET SERVERNAME
SET ARCHIVERETENTIONPROTECTION
SET SERVERPASSWORD
SET AUTHENTICATION
SET SPREPLRULEDEFAULT
SET ARREPLRULEDEFAULT
SET SUBFILE
SET BKREPLRULEDEFAULT
SET TOCLOADRETENTION
SET CLIENTACTDURATION
Chapter 1. Administering the server from the command-line interface
21
Table 11. System privilege commands (continued)
Command Name
Command Name
SETOPT
UPDATE NODEGROUP
UNLOCK ADMIN
UPDATE PATH
UNLOCK PROFILE
UPDATE PROFILE
UPDATE ADMIN
UPDATE RECOVERYMEDIA
UPDATE BACKUPSET
UPDATE REPLRULE
UPDATE CLIENTOPT
UPDATE SCHEDULE (See note.)
UPDATE CLOPTSET
UPDATE SCRIPT
UPDATE COLLOCGROUP
UPDATE SERVER
UPDATE DEVCLASS
UPDATE SERVERGROUP
UPDATE DRIVE
UPDATE SPACETRIGGER
UPDATE LIBRARY
UPDATE VIRTUALFSMAPPING
UPDATE LIBVOLUME
UPDATE VOLHISTORY
UPDATE MACHINE
VALIDATE LANFREE
VALIDATE REPLICATION
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.
For example, the DELETE MGMTCLASS command requires you to have policy
privilege for the policy domain to which the management class belongs.
Table 12 on page 23 lists the commands that an administrator with policy privilege
can issue.
22
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Table 12. Policy privilege commands
Command Name
Command Name
ACTIVATE POLICYSET
DELETE POLICYSET
ASSIGN DEFMGMTCLASS
DELETE PATH
CLEAN DRIVE
DELETE SCHEDULE (See note 2.)
BACKUP NODE
GENERATE BACKUPSET
COPY MGMTCLASS
LOCK NODE
COPY POLICYSET
QUERY BACKUPSETCONTENTS
COPY SCHEDULE (See note 2.)
REGISTER NODE
DEFINE ASSOCIATION
REMOVE NODE
DEFINE BACKUPSET
RENAME FILESPACE
DEFINE COPYGROUP
RENAME NODE
DEFINE CLIENTACTION
SET SUMMARYRETENTION
DEFINE CLIENTOPT
RESTORE NODE
DEFINE MGMTCLASS
QUERY TOC
DEFINE NODEGROUP
UNLOCK NODE
DEFINE NODEGROUPMEMBER
UPDATE BACKUPSET
DEFINE POLICYSET
UPDATE COPYGROUP
DEFINE SCHEDULE
UPDATE DOMAIN
DELETE ASSOCIATION
UPDATE MGMTCLASS
DELETE BACKUPSET
UPDATE NODE
DELETE COPYGROUP
UPDATE NODEGROUP
DELETE EVENT (See note 1.)
UPDATE POLICYSET
DELETE FILESPACE
UPDATE SCHEDULE (See note 2.)
DELETE MGMTCLASS
VALIDATE POLICYSET
DELETE NODEGROUP
DELETE NODEGROUPMEMBER
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.
Chapter 1. Administering the server from the command-line interface
23
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.
Table 13 lists the commands an administrator with storage privilege can issue.
Table 13. Storage privilege commands
Command Name
Command Name
AUDIT LIBRARY
DELETE SPACETRIGGER
AUDIT VOLUME (See note.)
DELETE VIRTUALFSMAPPING
BACKUP DB
DELETE VOLHISTORY
BACKUP DEVCONFIG
DELETE VOLUME (See note.)
BACKUP STGPOOL
GRANT PROXYNODE
BACKUP VOLHISTORY
LABEL LIBVOLUME
CHECKIN LIBVOLUME
MIGRATE STGPOOL
CHECKOUT LIBVOLUME
MOVE DATA (See note.)
COPY ACTIVEDATA (See note.)
MOVE MEDIA
DEFINE COLLOCGROUP
QUERY TAPEALERTMSG
DEFINE COLLOCMEMBER
RECLAIM STGPOOL
DEFINE DATAMOVER
RESTORE STGPOOL
DEFINE DEVCLASS
RESTORE VOLUME
DEFINE DRIVE
REVOKE PROXYNODE
DEFINE LIBRARY
SET TAPEALERTMSG
DEFINE PATH
UPDATE COLLOCGROUP
DEFINE VIRTUALFSMAPPING
UPDATE DATAMOVER
DEFINE VOLUME (See note.)
UPDATE DEVCLASS
DEFINE SPACETRIGGER
UPDATE DRIVE
DELETE COLLOCGROUP
UPDATE LIBRARY
DELETE COLLOCMEMBER
UPDATE PATH
DELETE DATAMOVER
UPDATE SPACETRIGGER
DELETE DEVCLASS
UPDATE STGPOOL (See note.)
DELETE DRIVE
UPDATE VIRTUALFSMAPPING
DELETE LIBRARY
DELETE PATH
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 14 on page 25 lists the commands an administrator with operator privilege
can issue.
24
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Table 14. Operator privilege commands
Command Name
Command Name
CANCEL SESSION
MOVE DRMEDIA
DISABLE SESSIONS
MOVE MEDIA
DISMOUNT VOLUME
QUERY MEDIA
ENABLE SESSIONS
REPLY
HALT
UPDATE VOLUME
VARY
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.
Table 15 on page 26 lists the commands any registered administrator can issue.
Chapter 1. Administering the server from the command-line interface
25
Table 15. Commands issued by all administrators
Command Name
COMMIT
QUERY NODE
HELP
QUERY NODEDATA
ISSUE MESSAGE
QUERY NODEGROUP
MACRO
QUERY OCCUPANCY
PARALLEL
QUERY OPTION
QUERY ACTLOG
QUERY PATH
QUERY ADMIN
QUERY POLICYSET
QUERY ASSOCIATION
QUERY PROCESS
QUERY AUDITOCCUPANCY
QUERY PROFILE
QUERY BACKUPSET
QUERY PROXYNODE
QUERY CLOPTSET
QUERY RECOVERYMEDIA
QUERY COLLOCGROUP
QUERY REPLICATION
QUERY CONTENT
QUERY REPLNODE
QUERY COPYGROUP
QUERY REPLRULE
QUERY DATAMOVER
QUERY REQUEST
QUERY DB
QUERY RESTORE
QUERY DBSPACE
QUERY RPFILE
QUERY DEVCLASS
QUERY SCHEDULE
QUERY DIRSPACE
QUERY SCRIPT
QUERY DOMAIN
QUERY SERVER
QUERY DRIVE
QUERY SERVERGROUP
QUERY DRMEDIA
QUERY SESSION
QUERY DRMSTATUS
QUERY SPACETRIGGER
QUERY ENABLED
QUERY STATUS
QUERY EVENT
QUERY STGPOOL
QUERY EVENTRULES
QUERY SUBSCRIBER
QUERY EVENTSERVER
QUERY SUBSCRIPTION
QUERY FILESPACE
QUERY SYSTEM
QUERY LIBRARY
QUERY VIRTUALFSMAPPING
QUERY LIBVOLUME
QUERY VOLHISTORY
QUERY LICENSE
QUERY VOLUME
QUERY LOG
QUIT
QUERY MACHINE
ROLLBACK
QUERY MGMTCLASS
SELECT
QUERY MOUNT
SERIAL
QUERY NASBACKUP
26
Command Name
IBM Tivoli Storage Manager for Windows: Administrator's 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, 2013
27
ACCEPT DATE
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 Administrator's 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.
Example: Accept the current system date
Allow the server to accept the current date as the valid date.
accept date
Related commands
Table 16. Command related to ACCEPT DATE
28
Command
Description
ENABLE SESSIONS
Resumes server activity following the
DISABLE command or the ACCEPT DATE
command.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
ACTIVATE POLICYSET
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 files that
were migrated by a Tivoli Storage Manager for Space Management client.
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.
Attention:
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.
Chapter 2. Administrative commands
29
ACTIVATE POLICYSET
Example: Activate a policy set on a specific policy domain
Activate the VACATION policy set in the EMPLOYEE_RECORDS policy domain.
activate policyset employee_records vacation
Related commands
Table 17. Commands related to ACTIVATE POLICYSET
30
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
ASSIGN DEFMGMTCLASS
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 Administrator's 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.
Example: Assign a default management class
Assign DEFAULT1 as the default management class for policy set SUMMER in the
PROG1 policy domain.
assign defmgmtclass prog1 summer default1
Related commands
Table 18. Commands related to ASSIGN DEFMGMTCLASS
Command
Description
ACTIVATE POLICYSET
Validates and activates 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.
Chapter 2. Administrative commands
31
ASSIGN DEFMGMTCLASS
Table 18. Commands related to ASSIGN DEFMGMTCLASS (continued)
32
Command
Description
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
AUDIT command
AUDIT commands
Use the AUDIT commands to review or examine the adequacy of the database
information and the storage pool volume. The AUDIT LDAPDIRECTORY command
deletes nodes or administrator IDs from an LDAP directory server, that do not
authenticate their passwords with the LDAP directory server.
v “AUDIT LDAPDIRECTORY (Audit an LDAP directory server)” on page 34
v “AUDIT LIBRARY (Audit volume inventories in an automated library)” on page
36
v “AUDIT LICENSES (Audit server storage usage)” on page 39
v “AUDIT VOLUME (Verify database information for a storage pool volume)” on
page 40
Chapter 2. Administrative commands
33
AUDIT LDAPDIRECTORY
AUDIT LDAPDIRECTORY (Audit an LDAP directory server)
Use this command to audit an IBM Tivoli Storage Manager-controlled namespace
on a Lightweight Directory Access Protocol (LDAP) server. The LDAP directory
server and namespace are specified through one or more LDAPURL options.
Nodes and administrator user IDs that do not authenticate their passwords with
the LDAP directory server are deleted with the AUDIT LDAPDIRECTORY FIX=YES
command. Nodes or administrator user IDs that no longer exist in the Tivoli
Storage Manager database are also deleted.
Before you issue this command, ensure that the LDAPURL option is specified in the
dsmserv.opt file. See the LDAPURL option for more information. If you specified
more than one LDAPURL option in the dsmserv.opt file, each option is validated in
the order in which they are placed. If the LDAPURL option is not specified, the
command fails.
Privilege class
You must have system privileges to issue this command.
Syntax
Fix
=
Fix
=
No
Wait
=
Wait
=
No
AUDIT LDAPdirectory
No
Yes
No
Yes
Parameters
Fix
This optional parameter specifies how the Tivoli Storage Manager server
resolves inconsistencies between the database and the external directory. The
default is NO. You can specify the following values:
No The server reports all inconsistencies but does not change the external
directory.
Yes
The server resolves any inconsistencies that it can and suggests further
actions, if needed.
Important: If there are LDAP entries that are shared with other Tivoli
Storage Manager servers, choosing YES might cause those servers to
become out-of-sync.
Wait
This optional parameter specifies whether to wait for the Tivoli Storage
Manager server to complete processing this command in the foreground. The
default is NO. You can specify the following values:
No The server processes this command in the background and you can
continue with other tasks while the command is processing. Messages
related to the background process are shown either in the activity log file
or the server console, depending on where the messages are logged.
Yes
The server processes this command in the foreground. The operation must
34
IBM Tivoli Storage Manager for Windows: Administrator's Reference
AUDIT LDAPDIRECTORY
complete before you can continue with other tasks. Messages are shown
either in the activity log file or the server console, or both, depending on
where the messages are logged.
Restriction: You cannot specify WAIT=YES from the server console.
Example: Audit an LDAP directory and repair inconsistencies
Audit the LDAP directory that you specified in the LDAPURL option. The Tivoli
Storage Manager server resolves some inconsistencies.
audit ldapdirectory fix=yes
ANR2749W Admin ADMIN1 was located in the LDAP directory server but not in the database.
ANR2749W Admin ADMIN2 was located in the LDAP directory server but not in the database.
ANR2749W Admin NODE1 was located in the LDAP directory server but not in the database.
ANR2749W Admin NODE2 was located in the LDAP directory server but not in the database.
ANR2748W Node NODE1 was located in the LDAP directory server but not in the database.
ANR2748W Node NODE2 was located in the LDAP directory server but not in the database.
ANR2745I AUDIT LDAPDIRECTORY command completed: 4 administrator entries are only in the
LDAP directory server (not in the Tivoli Storage Manager server), 0 administrator entries
are only in the Tivoli Storage Manager server (not in the LDAP directory server), 2 node
entries are only in the LDAP directory server (not in the Tivoli Storage Manager server),
0 node entries are only in the Tivoli Storage Manager server, (not in the LDAP directory
server), 6 entries were deleted from the LDAP server in total.
Related commands
Table 19. Commands related to AUDIT LDAPDIRECTORY
Command
Description
SET DEFAULTAUTHENTICATION
Specifies the default password authentication
method for any REGISTER NODE or
REGISTER ADMIN commands.
SET LDAPPASSWORD
Sets the password for the LDAPUSER.
SET LDAPUSER
Sets the user who oversees the passwords
and administrators on the LDAP directory
server.
Chapter 2. Administrative commands
35
AUDIT LIBRARY
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.
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.
Syntax
CHECKLabel =
Yes
AUDIT LIBRary library_name
CHECKLabel =
36
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Yes
Barcode
AUDIT LIBRARY
REFRESHstate =
No
REFRESHstate =
No
Yes
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.
Attention: 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.
REFRESHstate
Specifies whether the server's information about a library, which is normally
obtained during initialization, is refreshed, so that any changes in configuration
are reflected. By setting the REFRESHSTATE parameter to Yes, this action is
completed without having to restart the server or re-define the library. The
default is No. Possible values are:
No Specifies that the Tivoli Storage Manager server does not refresh the
library's state when the library is audited.
Yes
Specifies that the Tivoli Storage Manager server does refresh the library's
state when the AUDIT LIBRARY command is issued.
Example: Audit an automated library
Audit the EZLIFE automated library.
audit library ezlife
Related commands
Table 20. 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.
Chapter 2. Administrative commands
37
AUDIT LIBRARY
Table 20. Commands related to AUDIT LIBRARY (continued)
38
Command
Description
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
AUDIT LICENSES
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.
Example: Audit server licenses
Issue the AUDIT LICENSES command.
audit licenses
Related commands
Table 21. 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 license with the Tivoli Storage
Manager server.
SET LICENSEAUDITPERIOD
Specifies the number of days between
automatic license audits.
Chapter 2. Administrative commands
39
AUDIT VOLUME
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. Processing information generated during an audit is sent to
the activity log and server console.
You can only audit volumes that belong to storage pools with
DATAFORMAT=NATIVE and DATAFORMAT=NONBLOCK.
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.
40
IBM Tivoli Storage Manager for Windows: Administrator's Reference
AUDIT VOLUME
|
|
|
|
|
|
Attention: Use the FIX=Yes parameter only if your tape drive and storage area
network (SAN) infrastructure is stable. Ensure that the tape heads are clean and
that the tape device drivers are stable and reliable. Otherwise, you risk deleting
data that is error free when you use this parameter. The Tivoli Storage Manager
server cannot determine whether a tape is physically damaged or whether a tape
infrastructure is unstable.
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.
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
SKIPPartial =
No
Fix
=
Fix
=
No
Quiet =
No
Yes
No
SKIPPartial =
No
Yes
Quiet =
No
Yes
A (at least one of these parameters must be specified):
(1)
FROMDate =
TODAY
FROMDate =
(1)
STGPool =
date
poolname
(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.
Chapter 2. Administrative commands
41
AUDIT VOLUME
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 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.
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.
42
IBM Tivoli Storage Manager for Windows: Administrator's Reference
AUDIT VOLUME
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.
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 following values:
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.
Chapter 2. Administrative commands
43
AUDIT VOLUME
Value
Description
Example
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
BOTM (Beginning
Of This Month)
The first day of the current
month.
BOTM
BOTM+days
The first day of the current
month, plus days specified.
BOTM+9
To include files that were active a day
before the last day of the previous
month.
To include files that were active on
the 10th day of the current month.
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
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 following values:
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.
TODAY–1 or –1.
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
To display information created up to
yesterday, you can specify
TODATE=TODAY-1 or simply
TODATE= -1.
To include files that were active a day
before the last day of the previous
month.
BOTM (Beginning The first day of the current
Of This Month)
month.
BOTM
BOTM+days
BOTM+9
The first day of the current
month, plus days specified.
To include files that were active on the
10th day of the current month.
STGPool
This parameter specifies that the server only audits the volumes from the
44
IBM Tivoli Storage Manager for Windows: Administrator's Reference
AUDIT VOLUME
specified storage pool. This parameter is optional. You cannot use this
parameter if you have specified a volume.
Example: Verify database information for a specific storage pool
volume
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.
audit volume prog2 fix=yes
Example: Verify database information for all volumes written to
during a specific date range
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.
audit volume fromdate=03/20/2002 todate=03/22/2002
Example: Verify database information for all volumes in a
specific storage pool
Verify that the database information for all volumes in storage pool STPOOL3 is
consistent with data stored on the volume for today.
audit volume stgpool=STPOOL3
Example: Verify database information for all volumes in a
specific storage pool written to in the last two days
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.
audit volume stgpool=STPOOL3 fromdate=-1
Related commands
Table 22. 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.
Chapter 2. Administrative commands
45
BACKUP commands
BACKUP commands
Use the BACKUP commands to create backup copies of Tivoli Storage Manager
information or objects.
v “BACKUP DB (Back up the database)” on page 47
v “BACKUP DEVCONFIG (Create backup copies of device configuration
information)” on page 51
v “BACKUP NODE (Back up a NAS node)” on page 53
v “BACKUP STGPOOL (Back up primary storage pool to copy storage pool)” on
page 58
v “BACKUP VOLHISTORY (Save sequential volume history information)” on page
62
46
IBM Tivoli Storage Manager for Windows: Administrator's Reference
BACKUP DB
BACKUP DB (Back up the database)
Use this command to back up a Tivoli Storage Manager database to sequential
access volumes.
Attention: To restore a database, the server must use information from the
volume history file and the device configuration file. You must make and save
copies of the volume history file and the device configuration file. These files
cannot be recreated.
To determine how much additional storage space a backup requires, issue the
QUERY DB command.
Restriction: You cannot restore a server database from a different Tivoli Storage
Manager server if both of the following conditions are present:
v The database backup is stored on virtual volumes
v The connection to the Tivoli Storage Manager server is protected by SSL (Secure
Sockets Layer)
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
BAckup DB DEVclass =
Type
=
Type
=
Incremental
device_class_name
Incremental
Full
DBSnapshot
NUMStreams =
1
NUMStreams =
number
,
volume_name
FILE:
file_name
VOLumenames =
Scratch =
Yes
Wait
=
Wait
=
No
DEDUPDEVice =
No
Scratch =
Yes
No
No
Yes
DEDUPDEVice =
No
Yes
Parameters
DEVclass (Required)
Specifies the name of the sequential access device class to use for the backup.
If you issue the BACKUP DB command, and the device class is not the one that is
specified in the SET DBRECOVERY command, a warning message is issued.
However, the backup operation continues and is not affected.
If the SET DBRECOVERY command has not been issued to set a device class, the
BACKUP DB command fails.
Restriction:
v You cannot use a device class with a device type of NAS or CENTERA.
Chapter 2. Administrative commands
47
BACKUP DB
v A restore database operation fails 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. An incremental (or cumulative) backup image contains
a copy of all database data that has changed since the last successful full
backup operation was performed.
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
that contains these lines:
DB0001
DB0002
DB0003
Name the file appropriately. For example:
TAPEVOL.DATA
You can then specify the volumes for the command as follows:
VOLUMENAMES=FILE:TAPEVOL.DATA
NUMStreams
Specifies the number of parallel data movement streams to use when backing
up the database. The minimum value is 1, and the maximum value is 4.
Increasing the value causes a corresponding increase in the number of database
backup sessions to be used and the number of drives to be used for the device
class. If you specify a NUMSTREAMS value in the BACKUP DB command, it
48
IBM Tivoli Storage Manager for Windows: Administrator's Reference
BACKUP DB
overrides any value set in the SET DBRECOVERY command. Otherwise, the value
set in the SET DBRECOVERY command is used. The NUMSTREAMS value is used for
all types of database backups.
If a value is specified that is greater than the number of drives available for the
device class, only the number of available drives are used. The available drives
are those defined to the device class by the MOUNTLIMIT parameter or by the
number of online drives for the specified device class. The session is displayed
in the QUERY SESSION output.
If you increase the number of streams, more volumes are used from the
corresponding device class for this operation. Using more volumes might
improve the speed of the database backups, but at the cost of more volumes
that are not fully used.
For details about using multiple streams for database backup and restore
operations, see the Administrator's Guide.
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 only uses 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 fails 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.
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 might
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.
Restriction: You cannot specify WAIT=YES from the server console.
DEDUPDEVice
Specifies that a target storage device supports data deduplication. When set to
Chapter 2. Administrative commands
49
BACKUP DB
YES, the format for backup images is optimized for data deduplication devices,
making backup operations more efficient. Possible values are:
No Specifies that a target storage device does not support data deduplication.
NO is the default.
Ensure that this parameter is set to NO for the following devices:
v SCSI libraries
v All devices that are defined with a FILE device class
v Virtual tape libraries (VTL) that do not support the data deduplication
function
Yes
Specifies that a target device supports data deduplication and that you
want to optimize backups for this function. You can set this parameter to
YES if you are using a VTLs that supports data deduplication.
Example: Run an incremental backup by using a scratch volume
Run an incremental backup of the database by using a scratch volume. Use a
device class of FILE for the backup.
backup db devclass=file type=incremental
Related commands
Table 23. Commands related to BACKUP DB
50
Command
Description
BACKUP DEVCONFIG
Backs up Tivoli Storage Manager device
information to a file.
BACKUP VOLHISTORY
Records volume history information in
external files.
CANCEL PROCESS
Cancels a background server process.
DELETE VOLHISTORY
Removes sequential volume history
information from the volume history file.
EXPIRE INVENTORY
Manually starts inventory expiration
processing.
MOVE DRMEDIA
Moves DRM media on-site and off-site.
PREPARE
Creates a recovery plan file.
QUERY DB
Displays allocation information about the
database.
QUERY PROCESS
Displays information about background
processes.
QUERY VOLHISTORY
Displays sequential volume history
information that has been collected by the
server.
SET DBRECOVERY
Specifies the device class to be used for
automatic backups.
SET DRMDBBACKUPEXPIREDAYS
Specifies criteria for database backup series
expiration.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
BACKUP DEVCONFIG
BACKUP DEVCONFIG (Create backup copies of device
configuration information)
Use this command to back up information about device configuration for the
server.
Attention: To restore a database, the server must use information from the
volume history file and the device configuration file. You must make and save
copies of the volume history file and the device configuration file. These files
cannot be recreated.
This command backs up the following information in one or more files:
v Device class definitions
v Library definitions
v Drive definitions
v Path definitions when SRCTYPE=SERVER
v Server definitions
v Server name
v Server password
v Volume location information for LIBTYPE=SCSI libraries
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.
Chapter 2. Administrative commands
51
BACKUP DEVCONFIG
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.
Example: Backup device configuration information to a file
Back up device configuration information to a file named DEVICE.
backup devconfig filenames=device
Related commands
Table 24. Commands related to BACKUP DEVCONFIG
52
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 LIBRARY
Changes the attributes of a library.
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
BACKUP NODE
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 server's RESTORE NODE command or the client's 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
TOC
=
TOC
=
Preferred
Wait
=
Wait
=
No
MGmtclass =
MODE
=
MODE
=
mcname
DIFFerential
No
Preferred
Yes
TYPE
=
TYPE
=
No
Yes
BACKUPImage
FULL
DIFFerential
BACKUPImage
SNAPMirror
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.
Tip: See the virtual file space name parameter in the DEFINE VIRTUALFSMAPPING
command for more naming considerations.
Chapter 2. Administrative commands
53
BACKUP NODE
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 Network Data Management Protocol (NDMP) data is sent
into the Tivoli Storage Manager native hierarchy. After 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.
When you specify a management class with the BACKUP NODE command, all
versions of the backup data that belong to the NAS node are rebound to the
new management class.
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.
54
IBM Tivoli Storage Manager for Windows: Administrator's Reference
BACKUP NODE
Attention: 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.
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.
Attention:
You cannot specify WAIT=YES from the server console.
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 that only the files that have changed since the most recent full
backup should be backed up. If you choose a differential backup, and a
full backup is not found, a full backup is performed. You cannot specify
TYPE=SNAPMIRROR when the MODE parameter is set to DIFFERENTIAL.
TYPE
Specifies the backup method used to perform the NDMP backup operation.
The default value for this parameter is BACKUPIMAGE and it should be used
to perform a standard NDMP base or differential backup. Other image types
represent backup methods that might be specific to a particular file server.
Possible values are:
BACKUPImage
Specifies that the file system should be backed up using an NDMP dump
operation. This is the default method for performing an NDMP backup.
The BACKUPIMAGE type operation supports full and differential backups,
file-level restore processing and directory-level backup.
SNAPMirror
Specifies that the file system should be copied to a Tivoli Storage Manager
storage pool using the NetApp SnapMirror to Tape function. SnapMirror
images are block level full backup images of a file system. Typically, a
SnapMirror backup takes significantly less time to perform than a
traditional NDMP full file system backup. However there are limitations
and restrictions on how SnapMirror images can be used. The SnapMirror
to Tape function is intended to be used as a disaster-recovery option for
copying very large NetApp file systems to secondary storage.
Chapter 2. Administrative commands
55
BACKUP NODE
For most NetApp file systems, use the standard NDMP full or differential
backup method. See the Administrator's Guide for limitations on using
SnapMirror images as a backup method.
Refer to the documentation that came with your NetApp file server for
more information. When setting the TYPE parameter to SNAPMirror, note
the following restrictions:
1. You cannot specify TOC=YES or TOC=PREFERRED.
2. The file_system_name cannot be a virtual filespace name.
3. The snapshot which is created automatically by the file server during
the SnapMirror copy operation will be deleted at end of the operation.
4. This parameter is valid for NetApp and IBM N-Series file servers only.
Example: Perform a full backup
Perform a full backup on the /vol/vol10 file system of NAS node NAS1.
backup node nas1 /vol/vol10 mode=full
Example: Perform a backup on a directory and create a table of
contents
Back up the directory /vol/vol2/mikes on the node NAS1 and create a table of
contents for the image. For the following two examples, assume Table 25 contains
the virtual file space definitions exist on the server for the node NAS1.
backup node nas1 /mikesdir
Table 25. Virtual file space definitions
Virtual file space name
File system
Path
/mikesdir
/vol/vol2
/mikes
/DataDirVol2
/vol/vol2
/project1/data
/TestDirVol1
/vol/vol1
/project1/test
Example: Perform a backup on two directories
Back up the directories /vol/vol2/project1/data and /vol/vol1/project1/test of
the node NAS1. Refer to Table 25 for the the virtual file space definitions that exist
on the server for the node NAS1.
backup node nas1 /DataDirVol2,/testdirvol1
mode=full toc=yes
Related commands
Table 26. Commands related to BACKUP NODE
Command
Description
BACKUP NAS (Tivoli Storage Manager client Creates a backup of NAS node data.
command)
56
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
BACKUP NODE
Table 26. Commands related to BACKUP NODE (continued)
Command
Description
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.
Chapter 2. Administrative commands
57
BACKUP STGPOOL
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 Administrator's 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 as damaged. However, a new
copy is not created if the file in the primary storage pool is also marked as
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.
Remember: Issuing this command for a primary storage pool that is set up for
data deduplication removes duplicate data, if the copy storage pool is also set up
for data deduplication.
Restriction: Do not run the MOVE DRMEDIA and BACKUP STGPOOL commands
concurrently. Ensure that the storage pool backup processes are complete before
you issue the MOVE DRMEDIA command.
|
|
|
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
58
IBM Tivoli Storage Manager for Windows: Administrator's Reference
BACKUP STGPOOL
MAXPRocess =
1
Preview =
MAXPRocess =
number
Preview =
No
No
Yes
(1)
VOLumesonly
SHREDTONOshred =
No
Wait
=
Wait
=
No
SHREDTONOshred =
No
Yes
No
Yes
Notes:
1
Valid only for storage pools associated with a sequential-access device class.
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:
Chapter 2. Administrative commands
59
BACKUP STGPOOL
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:
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.
Example: Backup the primary storage pool
Back up the primary storage pool named PRIMARY_POOL to the copy storage
pool named COPYSTG.
backup stgpool primary_pool copystg
Related commands
Table 27. Commands related to BACKUP STGPOOL
60
Command
Description
CANCEL PROCESS
Cancels a background server process.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
BACKUP STGPOOL
Table 27. Commands related to BACKUP STGPOOL (continued)
Command
Description
MOVE DRMEDIA
Moves DRM media on-site and off-site.
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.
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.
Chapter 2. Administrative commands
61
BACKUP VOLHISTORY
BACKUP VOLHISTORY (Save sequential volume history
information)
Use this command to back up sequential volume history information to one or
more files.
Note: You must 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 Archive log volumes
v Database backup 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
Attention: To restore a database, the server must use information from the
volume history file and the device configuration file. You must make and save
copies of the volume history file and the device configuration file. These files
cannot be recreated.
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.
62
IBM Tivoli Storage Manager for Windows: Administrator's Reference
BACKUP VOLHISTORY
Syntax
BAckup VOLHistory
,
Filenames =
file_name
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.
Example: Back up the volume history information to a file
Back up the volume history information to a file called VOLHIST.
backup volhistory filenames=volhist
Related commands
Table 28. 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.
Chapter 2. Administrative commands
63
BEGIN EVENTLOGGING
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
ALL
BEGin EVentlogging
,
CONSOLE
ACTLOG
EVENTSERVER
FILE
FILETEXT
NTEVENTLOG
(1)
SNMP
TIVOLI
USEREXIT
Notes:
1
This parameter is only available for the Windows operating system.
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.
64
IBM Tivoli Storage Manager for Windows: Administrator's Reference
BEGIN EVENTLOGGING
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.
Example: Begin logging events
Begin logging events to the Tivoli Storage Manager activity log.
begin eventlogging actlog
Related commands
Table 29. 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.
Chapter 2. Administrative commands
65
CANCEL commands
CANCEL commands
Use the CANCEL commands to end a task or process before it is completed.
v “CANCEL EXPIRATION (Cancel an expiration process)” on page 67
v “CANCEL EXPORT (Delete a suspended export operation)” on page 68
v “CANCEL PROCESS (Cancel an administrative process)” on page 69
v
v
v
v
66
“CANCEL REPLICATION (Cancel node replication processes)” on page 71
“CANCEL REQUEST (Cancel one or more mount requests)” on page 72
“CANCEL RESTORE (Cancel a restartable restore session)” on page 73
“CANCEL SESSION (Cancel one or more client sessions)” on page 74
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CANCEL EXPIRATION
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
Example: Cancel an inventory expiration process
Cancel the process that was generated by an inventory expiration operation.
cancel expiration
Related commands
Table 30. Command related to CANCEL EXPIRATION
Command
Description
QUERY PROCESS
Displays information about background
processes.
EXPIRE INVENTORY
Manually starts inventory expiration
processing.
Chapter 2. Administrative commands
67
CANCEL EXPORT
CANCEL EXPORT (Delete 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.
Example: Delete a specific suspended export operation
Cancel the suspended server-to-server export operation EXPORTALLACCTNODES.
cancel export exportallacctnodes
Example: Delete all suspended server-to-server export
operations
Cancel all suspended server-to-server export processes.
cancel export *
Related commands
Table 31. Commands related to CANCEL EXPORT
68
Command
Description
CANCEL PROCESS
Cancels a background server process.
EXPORT NODE
Copies client node information to external
media or directly to another server.
EXPORT SERVER
Copies all or part of the server to external
media or directly to another server.
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CANCEL PROCESS
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 EXPORT SERVER
v AUDIT LICENSES
v GENERATE BACKUPSET
v AUDIT VOLUME
v IMPORT ADMIN
v BACKUP DB
v IMPORT NODE
v BACKUP NODE
v IMPORT POLICY
v BACKUP STGPOOL
v IMPORT SERVER
v CHECKIN LIBVOLUME
v MIGRATE STGPOOL
v CHECKOUT LIBVOLUME
v MOVE DATA
v DELETE FILESPACE
v MOVE DRMEDIA
v DELETE VOLUME
v MOVE MEDIA
v EXPIRE INVENTORY
v PREPARE
v EXPORT ADMIN
v RECLAIM STGPOOL
v EXPORT NODE
v RESTORE NODE
v EXPORT POLICY
v RESTORE STGPOOL
v RESTORE VOLUME
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. 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.
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.
Chapter 2. Administrative commands
69
CANCEL PROCESS
Syntax
CANcel PRocess process_number
Parameters
process_number (Required)
Specifies the number of the background process you want to cancel.
Example: Cancel a background process using its process
number
Cancel background process number 3.
cancel process 3
Related commands
Table 32. Commands related to CANCEL PROCESS
70
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CANCEL REPLICATION
CANCEL REPLICATION (Cancel node replication processes)
Use this command to cancel all node replication processes.
Issue this command on the server that acts as a source for replicated data.
Privilege class
To issue this command, you must have system privilege.
Syntax
CANcel REPLication
Parameters
None.
Example: Cancel node replication processes
Cancel all node replication processes.
cancel replication
Related commands
Table 33. Commands related to CANCEL REPLICATION
Command
Description
QUERY PROCESS
Displays information about background
processes.
QUERY REPLICATION
Displays information about node replication
processes.
Chapter 2. Administrative commands
71
CANCEL REQUEST
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.
Example: Cancel a mount request
Cancel request number 2.
cancel request 2
Related commands
Table 34. Commands related to CANCEL REQUEST
72
Command
Description
QUERY REQUEST
Displays information about all pending
mount requests.
UPDATE VOLUME
Updates the attributes of storage pool
volumes.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CANCEL RESTORE
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.
Example: Cancel restore operations
Cancel all restore operations.
cancel restore all
Related commands
Table 35. Commands related to CANCEL RESTORE
Command
Description
QUERY RESTORE
Displays information about restartable restore
sessions.
Chapter 2. Administrative commands
73
CANCEL SESSION
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, server, or client node sessions that
you want to cancel.
ALl
Specifies that all client node sessions are cancelled. You cannot use this
parameter to cancel administrative client or server sessions.
Example: Cancel a specific client node session
Cancel the client node session with NODEP (session 3).
cancel session 3
Related commands
Table 36. Commands related to CANCEL SESSION
74
Command
Description
DISABLE SESSIONS
Prevents new sessions from accessing Tivoli
Storage Manager but permits existing
sessions to continue.
LOCK ADMIN
Prevents an administrator from accessing
Tivoli Storage Manager.
LOCK NODE
Prevents a client from accessing the server.
QUERY SESSION
Displays information about all active
administrator and client sessions with Tivoli
Storage Manager.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CHECKIN LIBVOLUME
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.
Important:
1. The CHECKIN LIBVOLUME command processing does 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 external media
management systems use to operate with the server. For more information,
refer to the Administrator's Guide.
3. 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.
For detailed and current drive and library support information, see the Supported
Devices Web site for your operating system:
http://www.ibm.com/software/sysmgmt/products/support/
IBM_TSM_Supported_Devices_for_AIXHPSUNWIN.html
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax for SCSI libraries
SEARCH =
CHECKIn LIBVolume library_name
No
volume_name
SEARCH = Yes
A
SEARCH =
Bulk
A
STATus =
PRIvate
SCRatch
CLEaner
CHECKLabel =
OWNer =
""
OWNer =
server_name
Yes
SWAP
=
SWAP
=
No
WAITTime =
60
WAITTime =
value
CHECKLabel =
Yes
No
Barcode
No
Yes
Chapter 2. Administrative commands
75
CHECKIN LIBVOLUME
CLEanings =
number
A (SEARCH=Yes, SEARCH=Bulk):
VOLRange =
volume_name1,volume_name2
,
volume_name
FILE: file_name
VOLList =
Syntax for 349X libraries
SEARCH =
No
volume_name
SEARCH = Yes
CHECKIn LIBVolume library_name
A
STATus =
PRIvate
SCRatch
CHECKLabel =
OWNer =
""
OWNer =
server_name
Yes
SWAP
=
SWAP
=
No
CHECKLabel =
Yes
No
WAITTime =
60
WAITTime =
value
DEVType =
3590
3592
No
Yes
A (SEARCH=Yes):
VOLRange =
VOLList =
volume_name1,volume_name2
,
volume_name
FILE: file_name
Syntax for ACSLS libraries
SEARCH =
volume_name
SEARCH = Yes
CHECKIn LIBVolume library_name
No
A
STATus =
76
PRIvate
SCRatch
OWNer =
""
OWNer =
server_name
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CHECKIN LIBVOLUME
CHECKLabel =
Yes
SWAP
=
SWAP
=
No
WAITTime =
60
WAITTime =
value
CHECKLabel =
Yes
No
No
Yes
A (SEARCH=Yes):
VOLRange =
VOLList =
volume_name1,volume_name2
,
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
Chapter 2. Administrative commands
77
CHECKIN LIBVOLUME
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.
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 library's entry/exit ports for volumes
that can be checked in automatically. This option only applies to SCSI
libraries.
Important:
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:
78
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CHECKIN LIBVOLUME
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:
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.
Attention:
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.
Attention:
1. For SCSI libraries, do not specify both SEARCH=YES and
CHECKLABEL=NO in the same command.
2. 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.
Chapter 2. Administrative commands
79
CHECKIN LIBVOLUME
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.
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 waits 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 issues a request and waits 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 causes 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 is used until its
CLEANINGS value decreases to zero. Another cleaner is then be selected, and
the first cleaner can be checked out and discarded.
Example: Check a volume into a SCSI library
Check in a volume named WPDV00 into the SCSI library named AUTO.
checkin libvolume auto wpdv00 status=scratch
Example: Use a bar code reader to scan a library for a cleaner
cartridge
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.
80
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CHECKIN LIBVOLUME
checkin libvolume autolib1 search=yes vollist=cleanv status=cleaner
cleanings=10 checklabel=barcode
Example: Scan a library to put unused volumes in a specific
range in scratch status
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.
checkin libvolume abc search=yes volrange=bar110,bar130
status=scratch
Example: Scan a library to put a specific volume in scratch
status
Use the barcode reader to scan a SCSI library named MYLIB for VOL1, and put it in
scratch status.
checkin libvolume mylib search=yes vollist=vol1 status=scratch
checklabel=barcode
Related commands
Table 37. 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.
Chapter 2. Administrative commands
81
CHECKIN LIBVOLUME
Table 37. Commands related to CHECKIN LIBVOLUME (continued)
82
Command
Description
UPDATE LIBVOLUME
Changes the status of a
storage volume.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CHECKOUT LIBVOLUME
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.
Restrictions:
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.
For detailed and current drive and library support information, see the Supported
Devices Web site for your operating system:
http://www.ibm.com/software/sysmgmt/products/support/
IBM_TSM_Supported_Devices_for_AIXHPSUNWIN.html
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax for SCSI library
REMove =
CHECKOut LIBVolume library_name
CHECKLabel =
Yes
FORCE =
volume_name
A
Bulk
REMove =
Yes
No
Bulk
No
CHECKLabel =
Yes
No
FORCE =
No
Yes
A :
VOLRange =
VOLList =
volume_name1,volume_name2
,
volume_name
FILE: file_name
Chapter 2. Administrative commands
83
CHECKOUT LIBVOLUME
Syntax for 349X library
REMove =
CHECKOut LIBVolume library_name
volume_name
A
Bulk
REMove =
Yes
No
Bulk
A :
VOLRange =
VOLList =
volume_name1,volume_name2
,
volume_name
FILE: file_name
Syntax for ACSLS library
REMove =
CHECKOut LIBVolume library_name
volume_name
A
Yes
REMove =
Yes
No
Bulk
CAP
=
x,y,z
A :
VOLRange =
VOLList =
volume_name1,volume_name2
,
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:
84
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CHECKOUT LIBVOLUME
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.
Attention:
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 38. How the Tivoli 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.
Chapter 2. Administrative commands
85
CHECKOUT LIBVOLUME
Table 39. How the Tivoli Storage Manager server responds for SCSI libraries
And REMOVE=YES,
And REMOVE=BULK,
And REMOVE=NO,
If a library . . .
then...
then...
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 leaves the
cartridge in its current slot
within the library and
specifies the slot address in
a message.
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 does not prompt
you to remove the cartridge
and does not require a
REPLY command.
The server does not prompt
you to remove the cartridge
and does not require a
REPLY command.
The server moves the
The server leaves the
Has entry/exit ports and an The server moves the
entry/exit port is available
cartridge to the available
cartridge to the available
cartridge in its current slot
within the library and
entry/exit port and
entry/exit port and
specifies the port address in specifies the port address in specifies the slot address in
a message.
a message.
a message.
The server then prompts
you to remove the cartridge
from the slot and to issue a
REPLY command.
Has entry/exit ports, but no The server leaves the
ports are available
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 request a
REPLY command.
The server does not prompt
you to remove the cartridge
and does not require 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.
The server then prompts
you to remove the cartridge
from the slot and to issue a
REPLY command.
ACSLS libraries: The default is YES. If the parameter is set to YES, and the
cartridge access port (CAP) has an automatic selection priority value of 0, you
must specify a CAP ID. The following table shows how the server responds for
ACSLS libraries.
Table 40. How the Tivoli 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.
Attention:
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.
86
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CHECKOUT LIBVOLUME
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.
Attention:
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 applies to volumes in ACSLS libraries
only. If the CAP priority value is set to 0 in the library, this parameter is
required. If a CAP priority value greater than 0 is set in the library, this
parameter is optional. By default, all CAPs initially have a priority value of 0,
which means that ACSLS does not automatically select the CAP.
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 in the range 0 - 126.
y
The Library Storage Module (LSM) ID. This identifier can be a number
in the range 0 - 23.
z
The CAP ID. This identifier can be a number in the range 0 - 11.
For more information, see the StorageTek documentation.
Example: Check out a volume and check the label
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.
checkout libvolume forest exb004 checklabel=yes remove=no
Related commands
Table 41. 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.
DEFINE LIBRARY
Defines an automated or manual library.
DEFINE VOLUME
Assigns a volume to be used for storage
within a specified storage pool.
Chapter 2. Administrative commands
87
CHECKOUT LIBVOLUME
Table 41. Commands related to CHECKOUT LIBVOLUME (continued)
88
Command
Description
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
CLEAN DRIVE
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.
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
Administrator's Guide for details.
Restriction: 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.
Example: Clean a specific tape drive
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.
clean drive autolib tapedrive3
Related commands
Table 42. 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.
Chapter 2. Administrative commands
89
COMMIT
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.
Example: Control committing of commands in a macro
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 43. Commands related to COMMIT
90
Command
Description
MACRO
Runs a specified macro file.
ROLLBACK
Discards any uncommitted changes to the
database since the last COMMIT was
executed.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
COPY commands
COPY commands
Use the COPY commands to create a copy of Tivoli Storage Manager objects or data.
v “COPY ACTIVEDATA (Copy active backup data from a primary storage pool to
an active-data pool)” on page 92
v “COPY CLOPTSET (Copy a client option set)” on page 96
v “COPY DOMAIN (Copy a policy domain)” on page 97
v “COPY MGMTCLASS (Copy a management class)” on page 99
v “COPY POLICYSET (Copy a policy set)” on page 101
v “COPY PROFILE (Copy a profile)” on page 103
v “COPY SCHEDULE (Copy a client or an administrative command schedule)” on
page 105
v “COPY SCRIPT (Copy a Tivoli Storage Manager script)” on page 109
v “COPY SERVERGROUP (Copy a server group)” on page 110
Chapter 2. Administrative commands
91
COPY ACTIVEDATA
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.
Remember:
v You can only copy active data from storage pools that have a data format of
NATIVE or NONBLOCK.
v Issuing this command for a primary storage pool that is set up for data
deduplication removes duplicate data, if the active-data pool is also set up for
data deduplication.
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
Preview =
No
MAXProcess =
number
Preview =
No
Yes
(1)
VOLumesonly
Wait
=
Wait
=
No
SHREDTONOshred =
No
No
Yes
SHREDTONOshred =
No
Yes
Notes:
1
92
The VOLUMESONLY parameter applies to sequential-access storage pools only.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
COPY ACTIVEDATA
Parameters
primary_pool_name (Required)
Specifies the primary storage pool.
active_data_pool_name (Required)
Specifies the active-data pool.
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 parameter, 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.
Chapter 2. Administrative commands
93
COPY ACTIVEDATA
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 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.
Example: Copy primary storage pool data to active-data pool
Copy the active data from a primary storage pool named PRIMARY_POOL to the
active-data pool named ACTIVEPOOL. Issue the command:
copy activedata primary_pool activepool
Related commands
Table 44. Commands related to COPY ACTIVEDATA
94
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 or directly to another server.
EXPORT SERVER
Copies all or part of the server to external
media or directly to another server.
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 file spaces.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
COPY ACTIVEDATA
Table 44. 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.
Chapter 2. Administrative commands
95
COPY CLOPTSET
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.
Example: Copy a client option set
Copy a client option set named ENG to a new client option set named ENG2.
copy cloptset eng eng2
Related commands
Table 45. Commands related to COPY CLOPTSET
96
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 in a client option set.
UPDATE CLOPTSET
Updates the description of a client option set.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
COPY DOMAIN
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.
Example: Copy a policy domain to a new policy domain
Copy the policy domain PROG1 to new policy domain PROG2.
copy domain prog1 prog2
Related commands
Table 46. 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.
DELETE DOMAIN
Deletes a policy domain along with any
policy objects in the policy domain.
Chapter 2. Administrative commands
97
COPY DOMAIN
Table 46. Commands related to COPY DOMAIN (continued)
98
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 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 node 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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
COPY MGMTCLASS
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 Tivoli Storage Manager for Space
Management 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.
Example: Copy a management class to a new management class
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.
copy mgmtclass employee_records vacation
activefiles filehistory
Related commands
Table 47. Commands related to COPY MGMTCLASS
Command
Description
DEFINE COPYGROUP
Defines a copy group for backup or archive
processing within a specified management
class.
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.
Chapter 2. Administrative commands
99
COPY MGMTCLASS
Table 47. Commands related to COPY MGMTCLASS (continued)
100
Command
Description
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
COPY POLICYSET
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.
Example: Copy a policy set to a new policy set
Copy the policy set VACATION to the new policy set HOLIDAY in the
EMPLOYEE_RECORDS policy domain.
copy policyset employee_records vacation holiday
Related commands
Table 48. 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.
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.
Chapter 2. Administrative commands
101
COPY POLICYSET
102
IBM Tivoli Storage Manager for Windows: Administrator's Reference
COPY PROFILE
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.
Example: Make a copy of a profile
Copy a profile named VAL to a new profile named VAL2.
copy profile val val2
Related commands
Table 49. 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.
QUERY SUBSCRIPTION
Displays information about profile
subscriptions.
Chapter 2. Administrative commands
103
COPY PROFILE
Table 49. Commands related to COPY PROFILE (continued)
104
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
COPY SCHEDULE
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.
v “COPY SCHEDULE (Create a copy of a schedule for client operations)” on page
106
v “COPY SCHEDULE (Create a copy of a schedule for administrative operations)”
on page 108
Table 50. 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.
Chapter 2. Administrative commands
105
COPY SCHEDULE
COPY SCHEDULE (Create a copy of a schedule for client
operations)
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
REPlace =
new_sched_name
REPlace =
No
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.
Example: Copy a schedule from one policy domain to another
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.
106
IBM Tivoli Storage Manager for Windows: Administrator's Reference
COPY SCHEDULE
copy schedule employee_records weekly_backup
prog1 weekly_back2
Chapter 2. Administrative commands
107
COPY SCHEDULE
COPY SCHEDULE (Create a copy of a schedule for
administrative operations)
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
REPlace =
Type
=
Administrative
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.
Example: Copy an administrative command schedule to another
schedule
Copy the administrative command schedule, DATA_BACKUP and name the
schedule DATA_ENG. If there is already a schedule with this name, replace it.
copy schedule data_backup data_eng
type=administrative replace=yes
108
IBM Tivoli Storage Manager for Windows: Administrator's Reference
COPY SCRIPT
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.
Example: Make a copy of a script
Copy script TESTDEV to a new script and name it ENGDEV.
copy script testdev engdev
Related commands
Table 51. Commands related to COPY SCRIPT
Command
Description
DEFINE SCRIPT
Defines a script to the 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.
Chapter 2. Administrative commands
109
COPY SERVERGROUP
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.
Example: Make a copy of a server group
Copy the server group GRP_PAYROLL to the new group HQ_PAYROLL.
copy servergroup grp_payroll hq_payroll
Related commands
Table 52. Commands related to COPY SERVERGROUP
110
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE commands
DEFINE commands
Use the DEFINE commands to create Tivoli Storage Manager objects.
v “DEFINE ALERTTRIGGER (Define an alert trigger)” on page 112
v “DEFINE ASSOCIATION (Associate client nodes with a schedule)” on page 115
v “DEFINE BACKUPSET (Define a backup set)” on page 117
v
v
v
v
v
v
v
“DEFINE
“DEFINE
“DEFINE
“DEFINE
“DEFINE
“DEFINE
“DEFINE
CLIENTACTION (Define a one-time client action)” on page 121
CLIENTOPT (Define an option to an option set)” on page 127
CLOPTSET (Define a client option set name)” on page 130
COLLOCGROUP (Define a collocation group)” on page 131
COLLOCMEMBER (Define collocation group member)” on page 133
COPYGROUP (Define a copy group)” on page 135
DATAMOVER (Define a data mover)” on page 145
v “DEFINE DEVCLASS (Define a device class)” on page 148
v “DEFINE DOMAIN (Define a new policy domain)” on page 224
“DEFINE
“DEFINE
“DEFINE
“DEFINE
“DEFINE
page 252
v “DEFINE
page 254
v
v
v
v
v
v
v
v
v
v
“DEFINE
“DEFINE
“DEFINE
“DEFINE
“DEFINE
DRIVE (Define a drive to a library)” on page 226
EVENTSERVER (Define a server as the event server)” on page 230
GRPMEMBER (Add a server to a server group)” on page 231
LIBRARY (Define a library)” on page 232
MACHINE (Define machine information for disaster recovery)” on
MACHNODEASSOCIATION (Associate a node with a machine)” on
MGMTCLASS (Define a management class)” on page 256
NODEGROUP (Define a node group)” on page 259
NODEGROUPMEMBER (Define node group member)” on page 260
PATH (Define a path)” on page 261
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 309
v “DEFINE SERVER (Define a server for server-to-server communications)” on
page 312
v “DEFINE SERVERGROUP (Define a server group)” on page 319
v “DEFINE SPACETRIGGER (Define the space trigger)” on page 320
v “DEFINE STATUSTHRESHOLD (Define a status monitoring threshold)” on page
323
v “DEFINE STGPOOL (Define a storage pool)” on page 327
v “DEFINE SUBSCRIPTION (Define a profile subscription)” on page 374
v “DEFINE VIRTUALFSMAPPING (Define a virtual file space mapping)” on page
376
v “DEFINE VOLUME (Define a volume in a storage pool)” on page 378
Chapter 2. Administrative commands
111
DEFINE ALERTTRIGGER
DEFINE ALERTTRIGGER (Define an alert trigger)
|
|
|
|
Use this command to trigger an alert whenever a server issues a specific error
message. You can define a message number to be an alert trigger, assign it to a
category, or specify administrators who can be notified of the alert by email.
|
Privilege class
|
To issue this command, you must have system privilege.
|
Syntax
|
|
,
DEfine ALERTTrigger
|
|
CATegory =
+
message_number
SErver
CATegory =
APplication
INventory
CLient
DEvice
SErver
STorage
SYstem
VMclient
,
ADmin
= admin_name
|
|
Parameters
|
|
|
|
|
message_number (Required)
Specifies the message number that you want to associate with the alert trigger.
Specify multiple message numbers, which are separated by commas, and no
intervening spaces. Message numbers are a maximum of eight characters in
length. Wildcard characters can be used to specify message numbers.
|
|
|
CATegory
Specifies the category type for the alert, which is determined by the message
types. The default value is SERVER. Specify one of the following values:
|
|
|
APplication
Alert is classified as application category. For example, you can specify this
category for messages that are associated with application (TDP) clients.
|
|
|
|
CAtalog
Alert is classified as catalog category. For example, you can specify this
category for messages that are associated with the database, active log file,
or archive log file.
Note: Changing the category of an alert trigger does not change the
category of existing alerts on the server. New alerts are categorized with
the new category.
|
|
|
|
|
|
CLient
Alert is classified as client category. For example, you can specify this
category for messages that are associated with general client activities.
112
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE ALERTTRIGGER
|
|
|
|
DEvice
Alert is classified as device category. For example, you can specify this
category for messages that are associated with device classes, libraries,
drives, or paths.
|
|
|
|
SErver
Alert is classified as general server category. For example, you can specify
this category for messages that are associated with general server activities
or events.
|
|
|
STorage
Alert is classified as storage category. For example, you can specify this
category for messages that are associated with storage pools.
|
|
|
|
|
SYstems
Alert is classified under system clients category. For example, you can
specify this category for messages that are associated with system backup
and archive or hierarchical storage management (HSM) backup-archive
clients.
|
|
|
VMclient
Alert is classified under VMclient category. For example, you can specify
this category for messages that are associated with virtual machine clients.
|
|
|
|
ADmin
This optional parameter specifies the name of the administrator who receives
email notification of this alert. The alert trigger is defined successfully even if
no administrator names are specified.
|
Assign two message numbers to an alert
|
|
|
Issue the following command to specify that you want two message numbers to
trigger an alert:
|
|
Assign a message number to an alert and email two
administrators
|
|
|
Issue the following command to specify the message numbers that you want to
trigger an alert and have them sent by email to two administrators:
|
Related commands
|
Table 53. Commands related to DEFINE ALERTTRIGGER
|
Command
Description
|
|
“DELETE ALERTTRIGGER (Remove a
message from an alert trigger)” on page 386
Removes a message number that can trigger
an alert.
|
|
“QUERY ALERTSTATUS (Query the status of Displays information about alerts that have
an alert)” on page 663
been issued on the server.
|
|
“QUERY ALERTTRIGGER (Query the list of
defined alert triggers)” on page 661
Displays message numbers that trigger an
alert.
|
|
|
“QUERY MONITORSETTINGS (Query the
configuration settings for monitoring alerts
and server status)” on page 784
Displays information about monitoring alerts
and server status settings.
|
|
“UPDATE ALERTTRIGGER (Update a
defined alert trigger)” on page 1152
Updates the attributes of one or more alert
triggers.
define alerttrigger ANR1067E,ANR1073E
define alerttrigger ANR1067E,ANR1073E ADmin=BILL,DJADMIN
Chapter 2. Administrative commands
113
DEFINE ALERTTRIGGER
|
Table 53. Commands related to DEFINE ALERTTRIGGER (continued)
|
Command
|
|
|
|
“UPDATE ALERTSTATUS (Update the status Updates the status of a reported alert.
of an alert)” on page 1155
114
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Description
DEFINE ASSOCIATION
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 issue this command, 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.
Example: Associate client nodes with a schedule
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 employee_records
weekly_backup smith*,john*
Chapter 2. Administrative commands
115
DEFINE ASSOCIATION
Example: Associate client nodes with a schedule
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.
define association employee_records
winter joe,tom,larry
Related commands
Table 54. Commands related to DEFINE ASSOCIATION
116
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 node to the server and sets
options for that user.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE BACKUPSET
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 defined 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 =
RETention =
volume_names
365
RETention =
WHEREDATAType =
days
NOLimit
DESCription =
description
ALL
,
WHEREDATAType =
TOC
FILE
IMAGE
=
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
names, separate the names with commas and no intervening spaces. Node
Chapter 2. Administrative commands
117
DEFINE BACKUPSET
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:
days
Specifies the number of days to retain the backup set on the server.
118
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE BACKUPSET
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.
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.
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
Chapter 2. Administrative commands
119
DEFINE BACKUPSET
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.
Example: Define a backup set
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.
define backupset jane pers_data devclass=agadm
volumes=vol1,vol2 retention=50
description="sector 7 base image"
Related commands
Table 55. Commands related to DEFINE BACKUPSET
120
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 client's 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 BACKUPSET
Updates a retention value associated with a
backup set.
UPDATE NODEGROUP
Updates the description of a node group.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE CLIENTACTION
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 the 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.
Remember: The start of the Tivoli Storage Manager scheduler depends on the
processing of other threads in the server and other processes on the Tivoli Storage
Manager server host system. The amount of time it takes to start the scheduler also
depends on network traffic and how long it takes to open a socket, to connect with
the Tivoli Storage Manager client, and to receive a response from the client. In
general, the greater the processing and connectivity requirements on the Tivoli
Storage Manager server and client, the longer it can take to start the scheduler.
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
Chapter 2. Administrative commands
121
DEFINE CLIENTACTION
ACTion =
Incremental
ACTion =
Incremental
Selective
Archive
""
SUBACTion =
FASTBack
SYSTEMSTate
VM
Backup
""
SUBACTion =
FASTBack
SYSTEMSTate
VM
REStore
RETrieve
IMAGEBACkup
IMAGEREStore
Command
Macro
OPTions =
Wait
=
Wait
=
option_string
OBJects =
object_string
No
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
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
122
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE CLIENTACTION
changed since the last incremental backup. Incremental also backs up any
file for which all existing backups might 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.
Backup
Specifies that the schedule backs up 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
Indicates that the schedule retrieves files that are specified with the
OBJECTS parameter.
Remember: A second file that is specified acts as the retrieve destination.
If you need to retrieve multiple groups of files, create a separate schedule
for each group of files.
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.
SUBACTion
Possible values are:
"" When a null string (two double quotes) is specified with
ACTION=BACKUP the backup is an incremental.
FASTBAck
Specifies that a FastBack client operation that is identified by the
ACTION parameter is to be scheduled for processing. The ACTION
parameter must be either ARCHIVE or BACKUP.
Chapter 2. Administrative commands
123
DEFINE CLIENTACTION
SYSTEMSTate
Specifies that a client Systemstate backup is scheduled.
VM Specifies that a client VMware backup operation is scheduled.
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 can 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 result in an error or are ignored when
running the schedule from the server. For example, do not include the
following options because they have no impact 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
backup-archive client GUI wizard, you specify an options file. 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 apostrophes. Enclose
individual options that contain spaces in quotation marks. 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:"’
Tip: For Windows clients running in batch mode, if the use of quotation marks
is necessary, use interactive mode or operating system escape characters. For
additional information, see:
v “Processing a series of commands from the administrative client” on page 3
v “Processing commands one at a time from the administrative client” on page
3
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
124
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE CLIENTACTION
the Backup-Archive Clients Installation and User's 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 client 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.
Important:
v 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.
v 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.
If you are using characters that have a special meaning for Windows users,
such as commas, surround the entire argument in two pairs of double quotes,
then surround the entire string with single quotes. The following examples
show you 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"’
v To specify D:TEST,FILE:
OBJECTS=’""D:\TEST,FILE""’
Tip: For Windows clients running in batch mode, if the use of double quotes is
necessary, use interactive mode or operating system escape characters. For
additional information, see:
v “Processing a series of commands from the administrative client” on page 3
v “Processing commands one at a time from the administrative client” on page
3
Wait
Specifies whether to wait for a scheduled client operation to complete. This
parameter is useful when defining client actions from 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. If you specify this value and the value of the ACTION
parameter is COMMAND, the return code indicates whether the client
action was defined.
Chapter 2. Administrative commands
125
DEFINE CLIENTACTION
Yes
Specifies that you wait for the scheduled client operation to complete. If
you specify this value and the value of the ACTION parameter is
COMMAND, the return code indicates the status of the client operation.
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.
Restriction: 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.
Example: Perform a one-time incremental backup
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).
define clientaction tom domain=employee_records
action=incremental
Related commands
Table 56. Commands related to DEFINE CLIENTACTION
126
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE CLIENTOPT
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 User's 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.
For a list of valid client options, see "Client options that can be set by the
Tivoli Storage Manager server" at the Tivoli Storage Manager information
center (http://pic.dhe.ibm.com/infocenter/tsminfo/v6r3).
Note: To define include-exclude values, specify the include or exclude option
with option-name, and use option_value to 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.*"
option_value (Required)
Specifies the value for the option. If the option includes more than one value,
enclose the value in quotation marks. For the values you can specify with the
option refer to Backup-Archive Clients Installation and User's Guide.
Note:
1. The QUIET and VERBOSE options do not have an option value in the
client option's 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 quotation marks around the file specification,
and double quotation marks around the entire option. See “Example: Add
an option to a client option set” on page 128 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
Chapter 2. Administrative commands
127
DEFINE CLIENTOPT
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.
Example: Add an option to a client option set
Add a client option (MAXCMDRETRIES 5) to a client option set named ENG.
define clientopt eng maxcmdretries 5
Example: Add an option to exclude a file from backup
Add a client option to the option set ENGBACKUP to exclude the
c:\admin\file.txt from backup services.
define clientopt engbackup inclexcl "exclude c:\admin\file.txt"
Example: Add an option to exclude a directory from backup
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 quotation marks around the file
specification, then double quotation marks around the entire option.
define clientopt winspec inclexcl "exclude.dir ’*:\...\Temporary Internet Files’"
Example: Add an option to bind files in specified directories
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.
define clientopt winspec inclexcl "include C:\Data\...\* prodclass"
define clientopt winspec inclexcl "include ’C:\Program
Files\My Apps\...\*’ prodclass"
Related commands
Table 57. Commands related to DEFINE CLIENTOPT
128
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 node to the server and sets
options for that user.
QUERY CLOPTSET
Displays information about a client option
set.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE CLIENTOPT
Table 57. Commands related to DEFINE CLIENTOPT (continued)
Command
Description
UPDATE CLIENTOPT
Updates the sequence number of a client
option in a client option set.
UPDATE CLOPTSET
Updates the description of a client option set.
UPDATE NODE
Changes the attributes associated with a
client node.
Chapter 2. Administrative commands
129
DEFINE CLOPTSET
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, issue 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.
Example: Define a client option set
To define a client option set named ENG issue the following command.
define cloptset eng
Related commands
Table 58. Commands related to DEFINE CLOPTSET
130
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 in a client option set.
UPDATE CLOPTSET
Updates the description of a client option set.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE COLLOCGROUP
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.
Example: Define a collocation group
To define a collocation group named GROUP1 issue the following command:
define collocgroup group1
Related commands
Table 59. 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 file spaces.
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.
Chapter 2. Administrative commands
131
DEFINE COLLOCGROUP
Table 59. Commands related to DEFINE COLLOCGROUP (continued)
132
Command
Description
UPDATE COLLOCGROUP
Updates the description of a collocation
group.
UPDATE STGPOOL
Changes the attributes of a storage pool.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE COLLOCMEMBER
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.
Example: Define two collocation group members
Define two members, NODE1 and NODE2, to a collocation group, GROUP1.
define collocmember group1 node1,node2
Related commands
Table 60. 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 file spaces.
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.
Chapter 2. Administrative commands
133
DEFINE COLLOCMEMBER
Table 60. Commands related to DEFINE COLLOCMEMBER (continued)
134
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE COPYGROUP
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.
Attention: 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.
v “DEFINE COPYGROUP (Define an archive copy group)” on page 141
v “DEFINE COPYGROUP (Define a backup copy group)” on page 136
Table 61. 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.
Chapter 2. Administrative commands
135
DEFINE COPYGROUP–backup
DEFINE COPYGROUP (Define a backup copy group)
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
STANDARD
DEFine COpygroup domain_name policy_set_name class_name
STANDARD
Type
=
Backup
DESTination =
Type
=
2
0
FREQuency =
days
Backup
VERExists =
FREQuency =
pool_name
VERDeleted =
1
VERExists =
RETExtra =
number
NOLimit
30
VERDeleted =
RETOnly =
number
NOLimit
60
RETExtra =
MODE
=
MODE
=
days
NOLimit
MODified
RETOnly =
SERialization =
days
NOLimit
SHRSTatic
MODified
ABSolute
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.
136
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE COPYGROUP–backup
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
Chapter 2. Administrative commands
137
DEFINE COPYGROUP–backup
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) 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 processes files or directories when they
are modified during backup processing. This parameter is optional. The default
value is SHRSTATIC. Possible values are:
138
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE COPYGROUP–backup
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. Tivoli Storage Manager uses these values to determine if it backs
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, set
SERIALIZATION to SHRSTATIC or STATIC so that Tivoli Storage Manager
creates a backup version only if the file or directory is not being modified.
TOCDestination
Specifies the primary storage pool in which a table of contents (TOC) will
initially be stored for any Network Data Management Protocol (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.
Chapter 2. Administrative commands
139
DEFINE COPYGROUP–backup
Example: Create a backup copy group
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.
define copygroup employee_records
vacation activefiles standard type=backup
destination=backuppool frequency=3
verexists=5 mode=absolute
140
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE COPYGROUP–archive
DEFINE COPYGROUP (Define an archive copy group)
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
STANDARD
DEFine COpygroup domain_name policy_set_name class_name
STANDARD
Type
=
Archive DESTination =
RETVer =
365
FREQuency =
Cmd
FREQuency =
Cmd
pool_name
RETInit =
CREATion
RETInit =
EVent
RETVer =
RETMin =
days
NOLimit
365
MODE
=
ABSolute
MODE
=
ABSolute
RETMin =
days
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.
Chapter 2. Administrative commands
141
DEFINE COPYGROUP–archive
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 length of time to keep an archive copy. You can specify an
integer in the range 0 - 30000.
The RETENTIONEXTENSION server option can affect the volume retention if
the following conditions are true:
v You specify zero for the number of days
v The destination storage pool for the archive copy group is a SnapLock
storage pool (RECLAMATIONTYPE=SNAPLOCK)
If the two conditions are met, retention of the volumes is defined by the
value of the RETENTIONEXTENSION server option. The RETENTIONEXTENSION
server option value also applies if data is copied or moved into the
SnapLock storage pool by a server process such as migration, or by using
the MOVE DATA or MOVE NODEDATA commands.
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.
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.
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.
RETInit
Specifies when the retention time specified by the RETVER attribute is
initiated. This parameter is optional. If you define the RETINIT value during
copy group creation, you cannot modify it at a later time. The default value is
CREATION. Possible values are:
142
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE COPYGROUP–archive
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.
Tip: You can place a deletion hold on an object that was stored with
RETINIT=EVENT for which the event has not been signaled. If the event is
signaled 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 processes 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.
Chapter 2. Administrative commands
143
DEFINE COPYGROUP–archive
Attention: Be careful about using the SHRDYNAMIC and DYNAMIC
values. Tivoli Storage Manager uses them to determine if it archives 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 might or might not be usable,
depending on the application that uses the file. If a fuzzy backup is not
acceptable, set SERIALIZATION to SHRSTATIC or STATIC so that Tivoli
Storage Manager creates an archive copy only if the file is not being
modified.
Example: Define an archive copy group for event-based retention
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.
define copygroup prog1 summer eventmc standard type=archive
destination=archivepool retinit=event retver=30 retmin=90
144
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DATAMOVER
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
LLAddress =
10000
LLAddress =
tcp_port
USERid =
ONLine =
NAS HLAddress =
userid PASsword =
address
password
Yes
DATAFormat =
ONLine =
=
Yes
No
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
NetApp file server.
PASsword (Required)
Specifies the password for the user ID to log onto the NAS file server.
Chapter 2. Administrative commands
145
DEFINE DATAMOVER
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. When the hardware
is being maintained, you can use the UPDATE DATAMOVER command to
set the data mover off-line.
Important: 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.
DATAFormat (Required)
Specifies the data format that is used by this data mover.
NETAPPDump
NETAPPDUMP must be used for NetApp 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 NetApp or EMC
file servers.
Example: Define a data mover for a NetApp file server by IP
address
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 NetApp
device.
define datamover nas1 type=nas hladdress=9.67.97.103 lladdress=10000 userid=root
password=admin dataformat=netappdump
Example: Define a data mover by domain name
Define a data mover for the node named NAS1. The domain name for the data
mover is, NETAPP2.TUCSON.IBM.COM at port 10000.
define datamover nas1 type=nas hladdress=netapp2.tucson.ibm.com lladdress=10000
userid=root password=admin dataformat=netappdump
Example: Define a data mover by IP address
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 NetApp or
an EMC file server.
define datamover nas1 type=nas hladdress=9.67.97.103 lladdress=10000
userid=root password=admin dataformat=ndmpdump
146
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DATAMOVER
Related commands
Table 62. 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 node to the server and sets
options for that user.
UPDATE DATAMOVER
Changes the definition for a data mover.
Chapter 2. Administrative commands
147
DEFINE DEVCLASS
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 the use of a device.
For the most up-to-date list of supported devices and valid device class formats,
see the Tivoli Storage Manager Supported Devices Web site:
http://www.ibm.com/software/sysmgmt/products/support/
IBM_TSM_Supported_Devices_for_AIXHPSUNWIN.html
Note: The DISK device class is defined by IBM Tivoli Storage Manager and cannot
be modified with the DEFINE DEVCLASS command.
The following Tivoli Storage Manager device classes are ordered by device type.
v “DEFINE DEVCLASS (Define a 3570 device class)” on page 149
v “DEFINE DEVCLASS (Define a 3590 device class)” on page 152
v “DEFINE DEVCLASS (Define a 3592 device class)” on page 156
v
v
v
v
v
“DEFINE
“DEFINE
“DEFINE
“DEFINE
“DEFINE
DEVCLASS
DEVCLASS
DEVCLASS
DEVCLASS
DEVCLASS
(Define
(Define
(Define
(Define
(Define
a 4MM device class)” on page 162
an 8MM device class)” on page 166
a CENTERA device class)” on page 172
a DLT device class)” on page 174
a DTF device class)” on page 180
v “DEFINE DEVCLASS (Define an ECARTRIDGE device class)” on page 183
v “DEFINE DEVCLASS (Define a FILE device class)” on page 190
v “DEFINE DEVCLASS (Define a GENERICTAPE device class)” on page 193
v “DEFINE DEVCLASS (Define
v “DEFINE DEVCLASS (Define
v “DEFINE DEVCLASS (Define
206
v “DEFINE DEVCLASS (Define
an LTO device class)” on page 196
a NAS device class)” on page 203
OPTICAL and WORM device classes)” on page
a QIC device class)” on page 210
v “DEFINE DEVCLASS (Define a REMOVABLEFILE device class)” on page 215
v “DEFINE DEVCLASS (Define a SERVER device class)” on page 218
v “DEFINE DEVCLASS (Define a VOLSAFE device class)” on page 220
Table 63. Commands related to DEFINE DEVCLASS
148
Command
Description
BACKUP DEVCONFIG
Backs up Tivoli Storage Manager device
information to a file.
DEFINE LIBRARY
Defines an automated or manual library.
DELETE DEVCLASS
Deletes 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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 3570
DEFINE DEVCLASS (Define a 3570 device class)
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 =
FORMAT =
DEVType =
DRIVE
3570
FORMAT =
PREFIX =
library_name
DRIVE
3570B
3570C
ADSM
ESTCAPacity =
size
MOUNTRetention =
60
MOUNTRetention =
minutes
PREFIX =
ADSM
tape_volume_prefix
MOUNTWait =
60
MOUNTLimit =
MOUNTWait =
minutes
MOUNTLimit =
DRIVES
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:
Chapter 2. Administrative commands
149
DEFINE DEVCLASS — 3570
Table 64. Recording format and default estimated capacity for 3570 tape volumes
Format
Estimated
Capacity
DRIVE
—
Description
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.0 GB
Uncompressed (basic) format
3570C
See note
Compressed format
10.0 GB
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 100 KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 MB.
For more information on the default estimated capacity for 3570 cartridge
tapes, see Table 64.
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, national, hyphen, or numeric characters.
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
150
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 3570
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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's 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.
Chapter 2. Administrative commands
151
DEFINE DEVCLASS — 3590
DEFINE DEVCLASS (Define a 3590 device class)
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 =
FORMAT =
DEVType =
DRIVE
3590
FORMAT =
PREFIX =
library_name
DRIVE
3590B
3590C
3590E-B
3590E-C
3590H-B
3590H-C
ADSM
ESTCAPacity =
size
MOUNTRetention =
60
MOUNTRetention =
minutes
PREFIX =
ADSM
tape_volume_prefix
MOUNTWait =
60
MOUNTLimit =
MOUNTWait =
minutes
MOUNTLimit =
DRIVES
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 Administrator's Guide for more information.
The following tables list the recording formats, estimated capacities and
recording format options for 3590 devices:
152
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 3590
Table 65. Recording formats and default estimated capacities for 3590
Format
Estimated
Capacity
DRIVE
–
Description
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.0 GB
Uncompressed (basic) format
3590C
See note
Compressed format
20.0 GB
3590E-B
10.0 GB
Uncompressed (basic) format, similar to the 3590B
format
3590E-C
See note
Compressed format, similar to the 3590C format
20.0 GB
3590H-B
30.0 GB (J
cartridge –
standard—
length)
Uncompressed (basic) format, similar to the 3590B
format
60.0 GB (K
cartridge extended length)
3590H-C
Compressed format, similar to the 3590C format
See note
60.0 GB (J
cartridge standard length)
120.0 GB (K
cartridge extended length)
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 66. 3590 device recording format selections
Format
Device
3590B
3590
Ultra SCSI
3590E
3590H
3590C
3590E-B
3590E-C
3590H-B
3590H-C
–
–
–
–
Read/Write Read/Write
–
–
–
–
Read/Write Read/Write
–
–
Read/Write Read/Write
Read
Read
Read/Write Read/Write
Read
Read
Read
Read
ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class.
This parameter is optional.
Chapter 2. Administrative commands
153
DEFINE DEVCLASS — 3590
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 100 KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 MB.
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, 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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's Guide.
154
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 3590
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.
Chapter 2. Administrative commands
155
DEFINE DEVCLASS — 3592
DEFINE DEVCLASS (Define a 3592 device class)
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 =
LBProtect =
DEVType =
library_name
No
WORM
=
WORM
=
No
3592
LBProtect =
SCALECAPacity =
100
READWrite
WRITEOnly
No
FORMAT =
Yes
No
DRIVE
SCALECAPacity =
100
90
20
FORMAT =
PREFIX =
DRIVE
3592
3592C
3592-2
3592-2C
3592-3
3592-3C
3592-4
3592-4C
ADSM
ESTCAPacity =
size
PREFIX =
ADSM
tape_volume_prefix
MOUNTRetention =
60
MOUNTWait =
60
MOUNTRetention =
minutes
MOUNTWait =
minutes
MOUNTLimit =
DRIVES
DRIVEEncryption =
ALLOW
MOUNTLimit =
DRIVES
number
0
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 that the 3592 device type is assigned to the device class.
156
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 3592
LBProtect
Specifies whether logical block protection is used to ensure the integrity of
data stored on tape. When LBPROTECT is set to READWRITE or to WRITEONLY,
the server uses this feature of the tape drive for logical block protection and
generates cyclic redundancy check (CRC) protection information for each data
block written on tape. The server also validates the CRC protection information
when data is read from the tape.
The default is NO.
The following values are possible:
READWrite
Specifies that logical block protection is enabled in the server and the tape
drive for both read and write operations. Data is stored with CRC
information in each block. This mode affects performance because
additional processor usage is required for Tivoli Storage Manager and the
tape drive to calculate and compare CRC values. The READWRITE value
does not affect backup sets and data that is generated by the BACKUP DB
command.
When the LBPROTECT parameter is set to READWRITE, you do not have to
specify the CRCDATA parameter in a storage pool definition because logical
block protection provides better protection against data corruption.
WRITEOnly
Specifies that logical block protection is enabled in the server and the tape
drive for write operations only. Data is stored containing CRC information
in each block. For read operations, the server and the tape drive do not
validate the CRC. This mode affects performance because additional
processor usage is required for Tivoli Storage Manager to generate the CRC
and for the tape drive to calculate and compare CRC values for write
operations. The WRITEONLY value does not affect backup sets and data
that are generated by the BACKUP DB command.
No Specifies that logical block protection is not enabled in the server and the
tape drive for read and write operations. However, the server enables
logical block protection on write operations for a filling volume that
already has data with logical block protection.
Restriction: Logical block protection is supported only on IBM 3592
Generation 3 drives and later with 3592 Generation 2 media and later.
WORM
Specifies whether the drives use 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.
Remember:
1. To use 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 use 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 232.
Chapter 2. Administrative commands
157
DEFINE DEVCLASS — 3592
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
Administrator's 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 Administrator's Guide for more information.
The following table lists the recording formats, estimated capacities and
recording format options for 3592 devices:
Table 67. Recording formats and default estimated capacities for 3592
Format
Estimated
Capacity
DRIVE
–
Description
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
300 GB
Uncompressed (basic) format
3592C
See note
Compressed format
900 GB
3592-2
3592-2C
3592–3
158
500 GB
Uncompressed (basic) format JA tapes
700 GB
Uncompressed (basic) format JB tapes
1.5 TB
Compressed format JA tapes
2.1 TB
Compressed format JB tapes
640 GB
Uncompressed (basic) format JA tapes
1 TB
Uncompressed (basic) format JB tapes
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 3592
Table 67. Recording formats and default estimated capacities for 3592 (continued)
Format
Estimated
Capacity
Description
3592–3C
1.9 TB
Compressed format JA tapes
3 TB
Compressed format JB tapes
400 GB
Uncompressed (basic) format JK tapes
1.5 TB
Uncompressed (basic) format JB tapes
3.1 TB
Uncompressed (basic) format JC tape
1.2 TB
Compressed format JK tapes
4.4 TB
Compressed format JB tapes
9.4 TB
Compressed format JC tapes
3592-4
3592-4C
Note: If this format uses the tape drive hardware compression feature, depending on the
effectiveness of compression, the actual capacity might be different than the listed value.
Important: For optimal performance, avoid mixing different generations of
drives in a single SCSI library. If you must mix drive generations in an SCSI
library, use one of the special configurations that are described in the
Administrator's Guide to prevent or minimize media problems.
Special configurations are also required for mixing different generations of 3592
drives in 349x and ACSLS libraries.
For details, see the Administrator's 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 100 KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 MB.
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
Chapter 2. Administrative commands
159
DEFINE DEVCLASS — 3592
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, 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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's 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).
Tip: 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 will be permitted. This parameter is
optional. The default is ALLOW.
ON Specifies that Tivoli Storage Manager is the key manager for drive
160
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 3592
encryption and will permit drive encryption for empty storage pool
volumes only if the application method is enabled. (Other types of
volumes-for example, backup sets, export volumes, and database backup
volumes-will 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.
Chapter 2. Administrative commands
161
DEFINE DEVCLASS — 4MM
DEFINE DEVCLASS (Define a 4MM device class)
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 =
FORMAT =
DEVType =
DRIVE
DDS1
DDS1C
DDS2
DDS2C
DDS3
DDS3C
DDS4
DDS4C
DDS5
DDS5C
DDS6
DDS6C
ADSM
ESTCAPacity =
size
MOUNTWait =
60
MOUNTWait =
minutes
PREFIX =
ADSM
tape_volume_prefix
MOUNTRetention =
60
MOUNTLimit =
MOUNTRetention =
minutes
MOUNTLimit =
DRIVES
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 4 mm 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 4 mm 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.
162
DRIVE
4MM
FORMAT =
PREFIX =
library_name
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 4MM
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 Administrator's Guide for more information.
The following table lists the recording formats and estimated capacities for 4
mm devices:
Table 68. Recording formats and default estimated capacities for 4 mm tapes
Format
Estimated
Capacity
DRIVE
—
Description
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.6 GB (60-meter)
4.0 GB (90-meter)
DDS1C
See note
1.3 GB (60-meter)
Uncompressed format, only applies to 60-meter and
90-meter tapes
Compressed format, only applies to 60-meter and
90-meter tapes
2.0 GB (90-meter)
DDS2
4.0 GB
Uncompressed format, only applies to 120-meter
tapes
DDS2C
See note
Compressed format, only applies to 120-meter tapes
8.0 GB
DDS3
12.0 GB
Uncompressed format, only applies to 125-meter
tapes
DDS3C
See note
Compressed format, only applies to 125-meter tapes
24.0 GB
DDS4
20.0 GB
Uncompressed format, only applies to 150-meter
tapes
DDS4C
See note
Compressed format, only applies to 150-meter tapes
40.0 GB
DDS5
36 GB
Uncompressed format, when using DAT 72 media
DDS5C
See note
Compressed format, when using DAT 72 media
72 GB
DDS6
80 GB
Uncompressed format, when using DAT 160 media
DDS6C
See note
Compressed format, when using DAT 160 media
160 GB
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.
Chapter 2. Administrative commands
163
DEFINE DEVCLASS — 4MM
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 100 KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 MB.
For more information on the default estimated capacity for 4 mm tapes, see
Table 68 on page 163.
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, 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
164
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 4MM
simultaneously mounted for the device class. This parameter is optional. The
default is DRIVES. You can specify a number from 0 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 fails.
For details about the simultaneous-write function, see the Administrator's 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.
Chapter 2. Administrative commands
165
DEFINE DEVCLASS — 8MM
DEFINE DEVCLASS (Define an 8MM device class)
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 =
DEVType =
WORM
=
WORM
=
NO
library_name
FORMAT =
DRIVE
8MM
NO
YES
FORMAT =
PREFIX =
DRIVE
8200
8200C
8500
8500C
8900
AIT
AITC
M2
M2C
SAIT
SAITC
VXA2
VXA2C
VXA3
VXA3C
ADSM
ESTCAPacity =
size
PREFIX =
ADSM
tape_volume_prefix
MOUNTRetention =
60
MOUNTWait =
60
MOUNTRetention =
minutes
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 8 mm tape
drives used by this device class. For information about defining a library
object, see the DEFINE LIBRARY command.
166
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 8MM
DEVType=8MM (Required)
Specifies that the 8MM device type is assigned to the device class. 8MM
indicates that 8 mm 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 Administrator's 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 Administrator's Guide for more information.
The following table lists the recording formats and estimated capacities for 8
mm devices:
Table 69. Recording format and default estimated capacity for 8 mm tape
Format
Medium Type Estimated Capacity
DRIVE
–
Description
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.3 GB
Uncompressed (standard) format, using
standard 112-meter tape cartridges
8200C
See note
Compressed format, using standard 112-meter
tape cartridges
3.5 GB
4.6 GB
Chapter 2. Administrative commands
167
DEFINE DEVCLASS — 8MM
Table 69. Recording format and default estimated capacity for 8 mm tape (continued)
Format
Medium Type Estimated Capacity
8500
15m
15m
15m
54m
54m
54m
112m
112m
112m
160m XL
8500C
15m
15m
15m
54m
54m
54m
112m
112m
112m
160m XL
8900
15m
54m
112m
160m XL
22m
125m
170m
AIT
SDX1–25C
SDX1–35C
SDX2–36C
SDX2–50C
SDX3–100C
SDX3X-150C
SDX4–200C
SDX5-400C
AITC
SDX1–25C
SDX1–35C
SDX2–36C
SDX2–50C
SDX3–100C
SDX3X-150C
SDX4–200C
SDX5-400C
168
Description
See note
Drives (Read Write)
600 MB
600 MB
600 MB
2.35 GB
2.35 GB
2.35 GB
5 GB or 10.0 GB
5 GB or 10.0 GB
5 GB or 10.0 GB
7 GB
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)
See note
Drives (Read Write)
1.2 GB
1.2 GB
1.2 GB
4.7 GB
4.7 GB
4.7 GB
5 GB or 10.0 GB
5 GB or 10.0 GB
5 GB or 10.0 GB
7 GB
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)
See note
Drive (Read Write)
–
–
–
–
2.5 GB
–
40 GB
Mammoth
Mammoth
Mammoth
Mammoth
Mammoth
Mammoth
Mammoth
See note
Drive
25 GB
35 GB
36 GB
50 GB
100 GB
150 GB
200 GB
400 GB
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
See note
Drive
50 GB
91 GB
72 GB
130 GB
260 GB
390 GB
520 GB
1040 GB
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
IBM Tivoli Storage Manager for Windows: Administrator's Reference
8900
8900
8900
8900
8900
8900
8900
(R)
(R)
(R)
(R)
(RW)
(RW with upgrade)
(RW)
DEFINE DEVCLASS — 8MM
Table 69. Recording format and default estimated capacity for 8 mm tape (continued)
Format
Medium Type Estimated Capacity
M2
75m
150m
225m
M2C
75m
150m
225m
SAIT
SAITC
VXA2
V6 (62m)
V10 (124m)
V17 (170m)
VXA2C
V6 (62m)
V10 (124m)
V17 (170m)
VXA3
X6 (62m)
X10 (124m)
X23 (230m)
VXA3C
X6 (62m)
X10 (124m)
X23 (230m)
Description
See note
Drive (Read Write)
20.0 GB
40.0 GB
60.0 GB
Mammoth II (RW)
Mammoth II (RW)
Mammoth II (RW)
See note
Drive (Read Write)
50.0 GB
100.0 GB
150.0 GB
Mammoth II (RW)
Mammoth II (RW)
Mammoth II (RW)
See note
Drive (Read Write)
500 GB
Sony SAIT1–500(RW)
See note
Drive (Read Write)
1300 GB (1.3 TB)
Sony SAIT1–500(RW)
See note
Drive (Read Write)
20 GB
40 GB
60 GB
VXA–2
See note
Drive (Read Write)
40 GB
80 GB
120 GB
VXA–2
See note
Drive (Read Write)
40 GB
86 GB
160 GB
VXA–3
See note
Drive (Read Write)
80 GB
172 GB
320 GB
VXA–3
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).
Chapter 2. Administrative commands
169
DEFINE DEVCLASS — 8MM
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 MB. The smallest value allowed is 100 KB (that
is, ESTCAPACITY=100K).
For more information on the default estimated capacity for 8 mm tapes, see
Table 69 on page 167.
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, 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 0 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 fails.
The following are possible values:
170
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — 8MM
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.
Example: Define an 8 mm device class
Define a device class named 8MMTAPE for an 8 mm 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 6 GB.
define devclass 8mmtape devtype=8mm library=auto
format=drive mountlimit=2 mountretention=10
prefix=adsmvol estcapacity=6G
Chapter 2. Administrative commands
171
DEFINE DEVCLASS — CENTERA
DEFINE DEVCLASS (Define a CENTERA device class)
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
=
MOUNTLimit =
1
MOUNTLimit =
number
MINCAPacity =
100M
MINCAPacity =
size
?PEA_file
Notes:
1
For each Centera device class, you must specify one or more IP addresses.
However, a Pool Entry Authorization (PEA) file name and path are optional,
and up to one PEA file specification can follow the IP addresses. Use the "?"
character to separate the PEA file name and path from the IP addresses.
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 one ore more IP addresses for the Centera storage device and,
optionally, the name and path of one Pool Entry Authorization (PEA) file.
Specify the IP addresses using the dotted decimal format (for example,
9.10.111.222). A Centera device might have multiple IP addresses. If multiple IP
addresses are specified, then the store or retrieve operation will attempt a
connection using each IP address specified until a valid address is found.
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,9.10.111.223?c:\controlFiles\TSM.PEA
172
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — CENTERA
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.
Tips:
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 Programmer's 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. This parameter is optional.
Specify this value as an integer followed by K (kilobytes), M (megabytes), or G
(gigabytes). The default value is 100 MB (MINCAPACITY=100M). The
minimum value allowed is 1 MB (MINCAPACITY=1M). The maximum value
allowed is 128 GB (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.
Chapter 2. Administrative commands
173
DEFINE DEVCLASS — DLT
DEFINE DEVCLASS (Define a DLT device class)
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 =
DEVType =
WORM
=
WORM
=
NO
library_name
FORMAT =
DRIVE
DLT
NO
YES
FORMAT =
PREFIX =
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
ADSM
ESTCAPacity =
size
PREFIX =
ADSM
tape_volume_prefix
MOUNTRetention =
60
MOUNTWait =
60
MOUNTRetention =
minutes
MOUNTWait =
minutes
MOUNTLimit =
DRIVES
MOUNTLimit =
174
DRIVES
number
0
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — DLT
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 Administrator's 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 Administrator's Guide for more information.
The following table lists the recording formats and estimated capacities for
DLT devices:
Table 70. Recording format and default estimated capacity for DLT
Format
Estimated
Capacity
DRIVE
–
Description
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.0 GB
Uncompressed format, using only CompacTape III
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT1C
See note 1 on
page 177.
Compressed format, using only CompacTape III
cartridges
80.0 GB
Valid with DLT4000, DLT7000, and DLT8000 drives
Chapter 2. Administrative commands
175
DEFINE DEVCLASS — DLT
Table 70. Recording format and default estimated capacity for DLT (continued)
Format
Estimated
Capacity
DLT10
10.0 GB
Description
Uncompressed format, using only CompacTape III
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT10C
DLT15
See note 1 on
page 177.
Compressed format, using only CompacTape III
cartridges
20.0 GB
Valid with DLT4000, DLT7000, and DLT8000 drives
15.0 GB
Uncompressed format, using only CompacTape IIIxt
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT15C
DLT20
See note 1 on
page 177.
Compressed format, using only CompacTape IIIxt
cartridges
30.0 GB
Valid with DLT4000, DLT7000, and DLT8000 drives
20.0 GB
Uncompressed format, using only CompacTape IV
cartridges
Valid with DLT4000, DLT7000, and DLT8000 drives
DLT20C
DLT35
See note 1 on
page 177.
Compressed format, using only CompacTape IV
cartridges
40.0 GB
Valid with DLT4000, DLT7000, and DLT8000 drives
35.0 GB
Uncompressed format, using only CompacTape IV
cartridges
Valid with DLT7000 and DLT8000 drives
DLT35C
DLT40
See note 1 on
page 177.
Compressed format, using only CompacTape IV
cartridges
70.0 GB
Valid with DLT7000 and DLT8000 drives
40.0 GB
Uncompressed format, using CompacTape IV
cartridges
Valid with a DLT8000 drive
DLT40C
See note 1 on
page 177.
Compressed format, using CompacTape IV cartridges
Valid with a DLT8000 drive
80.0 GB
DLT2
80.0 GB
Uncompressed format, using Quantum DLT tape VS1
media
DLT2C
See note 1 on
page 177.
Compressed format, using Quantum DLT tape VS1
media
160.0 GB
DLT4
160.0 GB
Uncompressed format, using Quantum DLTtape VS1
cartridges.
Valid with Quantum DLT-V4 drive
176
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — DLT
Table 70. Recording format and default estimated capacity for DLT (continued)
Format
Estimated
Capacity
DLT4C
See note 1.
320.0 GB
Description
Compressed format, using Quantum DLTtape VS1
cartridges.
Valid with Quantum DLT-V4 drive
SDLT
100.0 GB
See note 2.
Uncompressed format, using Super DLT Tape 1
cartridges
Valid with a Super DLT drive
SDLTC
See note 1.
See note 2.
200.0 GB
Compressed format, using Super DLT Tape 1
cartridges
Valid with a Super DLT drive
SDLT320
160.0 GB
See note 2.
Uncompressed format, using Quantum SDLT I media
Valid with a Super DLT drive
SDLT320C
See note 1.
Compressed format, using Quantum SDLT I media
See note 2.
320.0 GB
Valid with a Super DLT drive
SDLT600
300.0 GB
Uncompressed format, using SuperDLTtape-II media
Valid with a Super DLT drive
SDLT600C
DLTS4
See note 1.
Compressed format, using SuperDLTtape-II media
600.0 GB
Valid with a Super DLT drive
800 GB
Uncompressed format, using Quantum DLT S4
media.
Valid with a DLT-S4 drive
DLTS4C
See note 1.
Compressed format, using Quantum DLT S4 media.
1.6 TB
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.
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 MB. The smallest value allowed is 100 KB (that
is, ESTCAPACITY=100K).
For more information on estimated capacities, see Table 70 on page 175.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
Chapter 2. Administrative commands
177
DEFINE DEVCLASS — DLT
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, 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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's 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.
178
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — DLT
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.
Chapter 2. Administrative commands
179
DEFINE DEVCLASS — DTF
DEFINE DEVCLASS (Define a DTF device class)
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 =
FORMAT =
DEVType =
DRIVE
DTF
DTFC
DTF2
DTF2C
ADSM
ESTCAPacity =
size
MOUNTRetention =
60
MOUNTRetention =
minutes
PREFIX =
ADSM
tape_volume_prefix
MOUNTWait =
60
MOUNTLimit =
MOUNTWait =
minutes
MOUNTLimit =
DRIVES
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 Administrator's Guide for more information.
The following table lists the recording formats and estimated capacities for
DTF devices:
180
DRIVE
DTF
FORMAT =
PREFIX =
library_name
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — DTF
Table 71. Recording format and default estimated capacity for DTF
Format
Estimated
Capacity
DRIVE
–
Description
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.0 GB
42.0 GB
Using GW-240 tape cassettes
Using GW-730L tape cassettes
DTFC
24.0 GB
84.0 GB
Using GW-240 tape cassettes
Using GW-730L tape cassettes
DTF2
60.0 GB
200.0 GB
Using GW2-60GS tape cassettes
Using GW2-200GL tape cassettes
DTF2C
120.0 GB
400.0 GB
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 100 KB (that is,
ESTCAPACITY=100K).
For more information on estimated capacities, see Table 71.
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, 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.
Chapter 2. Administrative commands
181
DEFINE DEVCLASS — DTF
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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's 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.
182
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — ECARTRIDGE
DEFINE DEVCLASS (Define an ECARTRIDGE device class)
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 =
LBProtect =
DEVType =
=
WORM
=
No
ECARTridge
LBProtect =
WORM
library_name
NO
FORMAT =
READWrite
WRITEOnly
No
DRIVE
NO
YES
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
T9840D
T9840D-C
T10000A
T10000A-C
T10000B
T10000B-C
T10000C
T10000C-C
ESTCAPacity =
size
Chapter 2. Administrative commands
183
DEFINE DEVCLASS — ECARTRIDGE
PREFIX =
ADSM
MOUNTRetention =
60
MOUNTRetention =
minutes
PREFIX =
ADSM
tape_volume_prefix
MOUNTWait =
60
MOUNTLimit =
MOUNTWait =
minutes
MOUNTLimit =
DRIVES
DRIVES
number
0
(1) (2)
DRIVEEncryption =
ALLOW
DRIVEEncryption =
ON
ALLOW
EXTERNAL
OFF
Notes:
1
You cannot specify both WORM=YES and DRIVEENCRYPTION=ON.
2
You can use drive encryption only for Oracle StorageTek T10000B drives with
a format value of DRIVE, T10000B or T10000B-C, and for Oracle StorageTek
T10000C drives with a format value of DRIVE, T10000C or T10000C-C.
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.
LBProtect
Specifies whether logical block protection is used to ensure the integrity of
data stored on tape. When LBPROTECT is set to READWRITE or to WRITEONLY,
the server uses this feature of the tape drive for logical block protection and
generates cyclic redundancy check (CRC) protection information for each data
block written on tape. The server also validates the CRC protection information
when data is read from the tape.
The default is NO.
The following values are possible:
READWrite
Specifies that logical block protection is enabled in the server and the tape
drive for both read and write operations. Data is stored with CRC
information in each block. This mode affects performance because
184
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — ECARTRIDGE
additional processor usage is required for Tivoli Storage Manager and the
tape drive to calculate and compare CRC values. The READWRITE value
does not affect backup sets and data that is generated by the BACKUP DB
command.
When the LBPROTECT parameter is set to READWRITE, you do not have to
specify the CRCDATA parameter in a storage pool definition because logical
block protection provides better protection against data corruption.
WRITEOnly
Specifies that logical block protection is enabled in the server and the tape
drive for write operations only. Data is stored containing CRC information
in each block. For read operations, the server and the tape drive do not
validate the CRC. This mode affects performance because additional
processor usage is required for Tivoli Storage Manager to generate the CRC
and for the tape drive to calculate and compare CRC values for write
operations. The WRITEONLY value does not affect backup sets and data
that are generated by the BACKUP DB command.
No Specifies that logical block protection is not enabled in the server and the
tape drive for read and write operations. However, the server enables
logical block protection on write operations for a filling volume that
already has data with logical block protection.
Restriction: Logical block protection is supported only on Oracle StorageTek
T10000C drives.
WORM
Specifies whether the drives use WORM (write once, read many) media. The
parameter is optional. The default is NO.
Restriction: If you select YES, the only options that are available for the
FORMAT parameter are:
v DRIVE
v
v
v
v
9840
9840-C
T9840D
T9840D-C
v T10000A
v T10000A-C
v
v
v
v
T10000B
T10000B-C
T10000C
T10000C-C
Refer to the Administrator's 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
Administrator's Guide for more information.
Important: If you specify DRIVE for a device class that has non-compatible
sequential access devices, then you must mount volumes on devices that are
Chapter 2. Administrative commands
185
DEFINE DEVCLASS — ECARTRIDGE
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 72. Recording formats and default estimated capacities for ECARTRIDGE tapes
Format
Estimated
capacity
DRIVE
–
Description
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.
186
18T
360 MB
18-track uncompressed (standard) (read-only) format
18TC
1.44 GB
18-track extended (read-only), compressed format
36T
720 MB
36-track extended (read and write) format
36TC
2.88 GB
36-track extended (read and write), compressed
format
SD3A
10 GB
Uncompressed (standard) format, using a 10 GB 'A'
cartridge with 91 meters (298 feet) of tape
SD3AC
40 GB
Compressed format, using a 10 GB 'A' cartridge with
91 meters (298 feet) of tape
SD3B
25 GB
Uncompressed (standard) format, using a 25 GB 'B'
cartridge with 204 meters (668 feet) of tape
SD3BC
100 GB
Compressed format, using a 25 GB 'B' cartridge with
204 meters (668 feet) of tape
SD3C
50 GB
Uncompressed (standard) format, using a 50 GB 'C'
cartridge with 392 meters (1286 feet) of tape
SD3CC
200 GB
Compressed format, using a 50 GB 'C' cartridge with
392 meters (1286 feet) of tape
9840
20 GB
Uncompressed 9840 format, using a StorageTek 9840
cartridge. This format is valid for StorageTek 9840
and 9840B drives
9840-C
80 GB
LZ-1 Enhanced (4:1) compressed 9840 format, using a
StorageTek 9840 cartridge
9940
60 GB
Uncompressed 9940 format, using a StorageTek 9940
cartridge
9940-C
120 GB
Compressed 9940 format, using a StorageTek 9940
cartridge
9940B
200 GB
Uncompressed 9940B format, using a StorageTek 9940
cartridge
9940B-C
400 GB
Compressed 9940B format, using a StorageTek 9940
cartridge
M8100
10 GB
Uncompressed (standard) format, using a 10 GB
cartridge
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — ECARTRIDGE
Table 72. Recording formats and default estimated capacities for ECARTRIDGE
tapes (continued)
Format
Estimated
capacity
M8100C
10 GB
Compressed format, using a 10 GB cartridge. Because
there is no mechanism to determine the type of
cartridge in an M8100 drive, the server assumes a 10
GB estimated uncompressed capacity.
T9840C
40 GB
Uncompressed T9840C format, using a StorageTek
9840 cartridge
T9840C-C
80 GB
Compressed T9840C format, using a StorageTek 9840
cartridge
T9840D
75 GB
Uncompressed T9840D format, using a StorageTek
9840 cartridge
T9840D-C
150 GB
Compressed T9840D format, using a StorageTek 9840
cartridge
T10000A
500 GB
Uncompressed T10000A format, using a StorageTek
T10000 cartridge
T10000A-C
1 TB
Compressed T10000A format, using a StorageTek
T10000 cartridge
T10000B
1 TB
Uncompressed T10000B format, using an Oracle
StorageTek T10000 cartridge
T10000B-C
2 TB
Compressed T10000B format, using an Oracle
StorageTek T10000 cartridge
T10000C
5 TB
Uncompressed T10000C format, using an Oracle
StorageTek T10000 T2 cartridge
T10000C-C
10 TB
Compressed T10000C format, using an Oracle
StorageTek T10000 T2 cartridge
Description
Notes:
v 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.
v T10000A drives can read and write the T10000A format only. T10000B drives can read, but
cannot write, the T10000A format. T10000C drives can read, but cannot write, the
T10000A and T10000B formats.
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 100 KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 MB.
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
Chapter 2. Administrative commands
187
DEFINE DEVCLASS — ECARTRIDGE
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, 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.
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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's 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).
Tip: 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.
188
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — ECARTRIDGE
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.
The default is ALLOW.
Restrictions:
1. You can use drive encryption only for the following drives:
v Oracle StorageTek T10000B drives that have a format value of DRIVE,
T10000B, or T10000B-C
v Oracle StorageTek T10000C drives that have a format value of DRIVE,
T10000C, or T10000C-C
2. You cannot specify Tivoli Storage Manager as the key manager for drive
encryption of write once, read many (WORM) media. You cannot specify
both WORM=YES and DRIVEENCRYPTION=ON.
3. If encryption is enabled for a device class, and the device class is associated
with a storage pool, the storage pool should not share a scratch pool with
other device classes that cannot be encrypted. If a tape is encrypted, and
you plan to use it on a drive that cannot be encrypted, you must manually
relabel the tape before it can be used on that drive.
ON Specifies that Tivoli Storage Manager is the key manager for drive
encryption and permits drive encryption for empty storage pool volumes
only if the application method is enabled. (Other types of volumes are not
encrypted. For example, backup sets, export volumes, and database backup
volumes are not encrypted.) If you specify ON and you enable another
method of encryption, drive encryption is not permitted and backup
operations 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.
EXTERNAL
Specifies that Tivoli Storage Manager does not manage the keys for drive
encryption. Use this setting with an encryption methodology that is
provided by another vendor and that is used with Application Method
Encryption (AME) enabled on the drive. When you specify EXTERNAL
and Tivoli Storage Manager detects that AME encryption is enabled, Tivoli
Storage Manager does not turn off encryption. By contrast, when you
specify ALLOW and Tivoli Storage Manager detects that AME encryption
is enabled, Tivoli Storage Manager turns off encryption.
OFF
Specifies that drive encryption is not permitted. If you enable another
method of encryption, backups fail. If you enable the application method,
Tivoli Storage Manager disables encryption and backups are not attempted.
Chapter 2. Administrative commands
189
DEFINE DEVCLASS — FILE
DEFINE DEVCLASS (Define a FILE device class)
Use the FILE device class when you are using files on magnetic disk storage as
volumes that store data sequentially (as on tape).
For information about disk subsystem requirements for FILE-type disk storage, see
the Administrator's Guide.
The FILE 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 =
MOUNTLimit =
20
MAXCAPacity =
2G
MOUNTLimit =
number
MAXCAPacity =
size
FILE
DIRectory =
current_directory_name
SHAREd =
No
,
DIRectory =
SHAREd =
No
Yes
directory_name
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 and output. This parameter is optional. The default value is 20. You can
specify a number from 0 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 fails.
For details about the simultaneous-write function, see the Administrator's Guide.
190
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — FILE
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 2 GB (MAXCAPACITY=2G). The value specified should be less than or equal
to the maximum supported size of a file on the target file system.
Specify this value as an integer followed by K (kilobytes), M (megabytes), or G
(gigabytes). The minimum size is 1 MB (MAXCAPACITY=1M). If you are defining a
FILE device class for database-backup volumes, specify a value for
MAXCAPACITY that is appropriate for the size of the database and that
minimizes the number of database volumes.
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 Administrator's 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.
Important: 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 261.
Tip: If you specify multiple directories for a device class, ensure that the
directories are associated with separate file systems. Space trigger functions
and storage pool space calculations take into account the space remaining in
each directory. 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
Chapter 2. Administrative commands
191
DEFINE DEVCLASS — FILE
sufficient space for an operation, the server might choose the wrong storage
pool and run out of space prematurely. For space triggers, an inaccurate
calculation might 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 issuing 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.
For information about prerequisites when storage is shared by the server and
storage agent, see http://www.ibm.com/support/entry/portal/Overview/
Software/Tivoli/Tivoli_Storage_Manager.
Example: Define a FILE device class with multiple directories
Define a device class that specifies multiple directories.
define devclass multidir devtype=file
directory=e:\xyz,f:\abc,g:\uvw
Example: Define a FILE device class with a 50 MB capacity
Define a device class named PLAINFILES with a FILE device type and a
maximum capacity of 50 MB.
define devclass plainfiles devtype=file
maxcapacity=50m
192
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — GENERICTAPE
DEFINE DEVCLASS (Define a GENERICTAPE device class)
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 =
DEVType =
library_name
GENERICTAPE
ESTCAPacity =
size
MOUNTRetention =
60
MOUNTWait =
60
MOUNTRetention =
minutes
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 system's 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.
Chapter 2. Administrative commands
193
DEFINE DEVCLASS — GENERICTAPE
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 100 KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 MB.
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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's 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.
194
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — GENERICTAPE
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
Chapter 2. Administrative commands
195
DEFINE DEVCLASS — LTO
DEFINE DEVCLASS (Define an LTO device class)
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
(1)
LBProtect =
DEVType =
No
=
WORM
=
NO
LTO
LBProtect =
FORMAT =
WORM
READWrite
WRITEOnly
No
NO
YES
DRIVE
FORMAT =
PREFIX =
DRIVE
ULTRIUM
ULTRIUMC
ULTRIUM2
ULTRIUM2C
ULTRIUM3
ULTRIUM3C
ULTRIUM4
ULTRIUM4C
ULTRIUM5
ULTRIUM5C
ULTRIUM6
ULTRIUM6C
ESTCAPacity =
ADSM
size
MOUNTRetention =
60
MOUNTRetention =
minutes
PREFIX =
ADSM
tape_volume_prefix
MOUNTWait =
60
MOUNTLimit =
MOUNTWait =
minutes
MOUNTLimit =
DRIVES
196
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DRIVES
number
0
DEFINE DEVCLASS — LTO
(1) (2)
DRIVEEncryption =
ALLOW
DRIVEEncryption =
ON
ALLOW
EXTERNAL
OFF
Notes:
1
You cannot specify both WORM=YES and DRIVEENCRYPTION=ON.
2
Drive encryption is supported only for Ultrium 4, Ultrium 5, and Ultrium 6
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
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.
LBProtect
Specifies whether logical block protection is used to ensure the integrity of
data stored on tape. When LBPROTECT is set to READWRITE or to WRITEONLY,
the server uses this feature of the tape drive for logical block protection and
generates cyclic redundancy check (CRC) protection information for each data
block written on tape. The server also validates the CRC protection information
when data is read from the tape.
The default is NO.
The following values are possible:
READWrite
Specifies that logical block protection is enabled in the server and the tape
drive for both read and write operations. Data is stored with CRC
information in each block. This mode affects performance because
additional processor usage is required for Tivoli Storage Manager and the
tape drive to calculate and compare CRC values. The READWRITE value
does not affect backup sets and data that is generated by the BACKUP DB
command.
When the LBPROTECT parameter is set to READWRITE, you do not have to
specify the CRCDATA parameter in a storage pool definition because logical
block protection provides better protection against data corruption.
WRITEOnly
Specifies that logical block protection is enabled in the server and the tape
drive for write operations only. Data is stored containing CRC information
in each block. For read operations, the server and the tape drive do not
validate the CRC. This mode affects performance because additional
processor usage is required for Tivoli Storage Manager to generate the CRC
Chapter 2. Administrative commands
197
DEFINE DEVCLASS — LTO
and for the tape drive to calculate and compare CRC values for write
operations. The WRITEONLY value does not affect backup sets and data
that are generated by the BACKUP DB command.
No Specifies that logical block protection is not enabled in the server and the
tape drive for read and write operations. However, the server enables
logical block protection on write operations for a filling volume that
already has data with logical block protection.
Restriction: Logical block protection is supported only on IBM LTO5 and
supported LTO6 drives.
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 Administrator's 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 Administrator's 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 Administrator's Guide.
Table 73. Read - write capabilities for different generations of LTO drives
Drives
198
Generation Generation Generation Generation Generation Generation
1 media
2 media
3 media
4 media
5 media
6 media
Generation
1
Read and
write
n/a
n/a
n/a
n/a
n/a
Generation
2
Read and
write
Read and
write
n/a
n/a
n/a
n/a
Generation
31
Read only
Read and
write
Read and
write
n/a
n/a
n/a
Generation
42
n/a
Read only
Read and
write
Read and
write
n/a
n/a
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — LTO
Table 73. Read - write capabilities for different generations of LTO drives (continued)
Drives
Generation Generation Generation Generation Generation Generation
1 media
2 media
3 media
4 media
5 media
6 media
Generation
53
n/a
n/a
Read only
Read and
write
Read and
write
n/a
Generation
64
n/a
n/a
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.
3
In a library with a Generation 5 drive, all Generation 3 scratch volumes need to be
checked out, and all Generation 3 storage pool volumes need to be updated to read-only.
4
In a library with a Generation 6 drive, all Generation 4 scratch volumes need to be
checked out, and all Generation 4 storage pool volumes need to be updated to read-only.
The following table lists the recording formats and estimated capacities for
LTO devices:
Table 74. Recording format and default estimated capacity for LTO
Format
Estimated
capacity
DRIVE
–
Description
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 GB
Uncompressed format, using Ultrium cartridges
ULTRIUMC
See note
Compressed format, using Ultrium cartridges
200 GB
ULTRIUM2
200 GB
Uncompressed (standard) format, using Ultrium 2
cartridges
ULTRIUM2C
See note
Compressed format, using Ultrium 2 cartridges
400 GB
ULTRIUM3
400 GB
Uncompressed (standard) format, using Ultrium 3
cartridges
ULTRIUM3C
See note
Compressed format, using Ultrium 3 cartridges
ULTRIUM4
800 GB
Uncompressed (standard) format, using Ultrium 4
cartridges
ULTRIUM4C
See note
Compressed format, using Ultrium 4 cartridges
800 GB
1.6 TB
Chapter 2. Administrative commands
199
DEFINE DEVCLASS — LTO
Table 74. Recording format and default estimated capacity for LTO (continued)
Format
Estimated
capacity
ULTRIUM5
1.5 TB
Uncompressed (standard) format, using Ultrium 5
cartridges
ULTRIUM5C
See note
Compressed format, using Ultrium 5 cartridges
Description
3.0 TB
ULTRIUM6
2.5 TB
Uncompressed (standard) format, using Ultrium 6
cartridges
ULTRIUM6C
See note
Compressed format, using Ultrium 6 cartridges
6.25 TB
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), G (gigabytes), or T (terabytes). The smallest value allowed is 100
KB (that is, ESTCAPACITY=100K).
For example, ESTCAPACITY=100G specifies that the estimated capacity for a
volume in this device class is 100 GB.
For more information on estimated capacities, see Table 74 on page 199.
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, 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.
200
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — LTO
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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's 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.
DRIVEEncryption
Specifies whether drive encryption will be permitted. This parameter is
optional. The default is ALLOW. Drive encryption is supported only for
Ultrium 4, Ultrium 5, and Ultrium 6 drives and media.
Restriction: If encryption is enabled for a device class, and the device class is
associated with a storage pool, the storage pool should not share a scratch pool
with other device classes that cannot be encrypted. If a tape is encrypted, and
you plan to use it on a drive that cannot be encrypted, you must manually
relabel the tape before it can be used on that drive.
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
volumes will not be encrypted. For example, backup sets, export volumes,
and database backup volumes are not encrypted.) If you specify ON and
Chapter 2. Administrative commands
201
DEFINE DEVCLASS — LTO
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. (Specifying
both WORM=YES and DRIVEENCRYPTION=ON is not supported.)
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.
EXTERNAL
Specifies that Tivoli Storage Manager does not manage the keys for drive
encryption. Use this setting with an encryption methodology that is
provided by another vendor and that is used with Application Method
Encryption (AME) enabled on the drive. When you specify EXTERNAL
and Tivoli Storage Manager detects that AME encryption is enabled, Tivoli
Storage Manager does not turn encryption off. By contrast, when you
specify ALLOW and Tivoli Storage Manager detects that AME encryption
is enabled, Tivoli Storage Manager turns encryption off.
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.
Example: Define an LTO device class
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 100 GB.
define devclass ltotape devtype=lto library=ltolib
format=ultrium mountlimit=12 mountretention=5
prefix=smvol estcapacity=100G
202
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — NAS
DEFINE DEVCLASS (Define a NAS device class)
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 =
LIBRary =
library_name MOUNTRetention =
MOUNTLimit =
MOUNTWait =
60
MOUNTWait =
minutes
0
ESTCAPacity =
PREFIX =
DRIVES
MOUNTLimit =
NAS
size
DRIVES
number
0
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
Chapter 2. Administrative commands
203
DEFINE DEVCLASS — NAS
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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's 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).
Tip: 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 100 KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=100G specifies that the estimated capacity for a
volume in this device class is 100 GB.
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, national, hyphen, or numeric characters.
204
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — NAS
An example of a tape volume data set name using the default prefix is
ADSM.BFS.
Example: Define a NAS device class
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 200 GB.
define devclass nastape devtype=nas library=naslib
mountretention=0 mountlimit=drives
prefix=smvol estcapacity=200G
Chapter 2. Administrative commands
205
DEFINE DEVCLASS — OPTICAL and WORM types
DEFINE DEVCLASS (Define OPTICAL and WORM device classes)
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 =
FORMAT =
DEVType =
OPTical
WORM
WORM12
WORM14
library_name
DRIVE
FORMAT =
DRIVE
(1)
650MB
(1)
1300MB
(1)
2600MB
(1)
5200MB
(2)
5600MB
(3)
6800MB
(1)
9100MB
(3)
10200MB
(2)
12000MB
(3)
14800MB
(1)
23GB
(1)
30GB
(1)
60GB
MOUNTRetention =
60
MOUNTRetention =
minutes
ESTCAPacity =
size
MOUNTWait =
60
MOUNTLimit =
MOUNTWait =
minutes
MOUNTLimit =
DRIVES
DRIVES
number
0
Notes:
206
1
Not available for WORM12 or WORM14 device types
2
Available only for WORM12 device types
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — OPTICAL and WORM types
3
Available only for WORM14 device types
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.
WORM
Specifies that the device class uses two-sided 5.25 inch write-once
read-many (WORM) optical media.
Do not use this device type for 12-inch or 14-inch 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
Administrator's Guide for more information.
The following table lists the recording formats and estimated capacities for
OPTICAL and WORM devices:
Table 75. Estimated capacities for OPTICAL and WORM drives
Format
Estimated
capacity
DRIVE
–
Description
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
650 MB
Using a 650 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
Chapter 2. Administrative commands
207
DEFINE DEVCLASS — OPTICAL and WORM types
Table 75. Estimated capacities for OPTICAL and WORM drives (continued)
Format
Estimated
capacity
Description
1300MB
1300 MB
Using a 1300 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
2600MB
2600 MB
Using a 2600 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
5200MB
5200 MB
Using a 5200 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
5600MB
5600 MB
Using a 5600 MB 12-inch optical drive
Valid for WORM12 device types only
6800MB
6800 MB
Using a 6800 MB 14-inch optical drive
Valid for WORM14 device types only
9100MB
9100 MB
Using a 9100 MB 5.25-inch optical drive
Not valid for WORM12 or WORM14 device types
10200MB
10200 MB
Using a 10200 MB 14-inch optical drive
Only valid for WORM14 device types
12000MB
12000 MB
Using a 12000 MB 12-inch optical drive
Valid for WORM12 device types only
14800MB
14800 MB
Using a 14800 MB 14-inch optical drive
Valid for WORM14 device types only
23GB
23 GB
Using Sony Blue Laser read-write and WORM media
Not valid for WORM12 or WORM14 device types
30GB
30 GB
Using Plasmon UDO1 read-write and WORM media
Not valid for WORM12 or WORM14 device types
60GB
60 GB
Using Plasmon or IBM UDO2 read-write and WORM
media
Not valid for WORM12 or WORM14 device types
Restriction: 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 100 KB (that is,
ESTCAPACITY=100K).
208
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — OPTICAL and WORM types
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 MB.
For more information on estimated capacities, see Table 75 on page 207.
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.
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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's 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).
Tip: 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.
Chapter 2. Administrative commands
209
DEFINE DEVCLASS — QIC
DEFINE DEVCLASS (Define a QIC device class)
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 =
FORMAT =
DEVType =
DRIVE
QIC
FORMAT =
PREFIX =
library_name
DRIVE
QIC120
QIC150
QIC525
QIC1000
QIC2GB
QIC2GBC
QIC4GB
QIC4GBC
QIC12GB
QIC12GBC
QIC20GB
QIC20GBC
QIC30GB
QIC30GBC
QIC5010
QIC5010C
QIC25GB
QIC25GBC
QIC50GB
QIC50GBC
QIC70GB
QIC70GBC
ADSM
ESTCAPacity =
size
MOUNTRetention =
60
MOUNTRetention =
minutes
PREFIX =
ADSM
tape_volume_prefix
MOUNTWait =
60
MOUNTLimit =
MOUNTWait =
minutes
MOUNTLimit =
DRIVES
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
210
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — QIC
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 Administrator's Guide for information.
The following tables list the recording formats, estimated capacities and
recording format options for QIC devices:
Table 76. Recording format and default estimated capacity for quarter-inch cartridge (QIC)
tape
Format
Estimated
Capacity
DRIVE
–
Description
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 MB – 172 MB
120 QIC format, depending on media
Using DC600XTD, DC6150, DC6320, and DC6525
QIC150
31 MB – 207 MB
150 QIC format, depending on media
Using DC600XTD, DC6150, DC6320, and DC6525
QIC525
65 MB – 427 MB
525 QIC format, depending on media
Using DC6320 and DC6525
QIC1000
169 MB – 1.1 GB
1000 QIC format, depending on media
Using DC9100 and DC9120XL
QIC2GB
2 GB
Uncompressed 2000 QIC format
Using DC9100 and DC9120XL
QIC2GBC
See note
Compressed 2000 QIC format
4 GB
QIC4GB
4 GB
Uncompressed 4000 QIC format
QIC4GBC
See note
Compressed 4000 QIC format
8 GB
QIC12GB
12 GB
Uncompressed 12000 QIC format, using 343–meter
tape
Chapter 2. Administrative commands
211
DEFINE DEVCLASS — QIC
Table 76. Recording format and default estimated capacity for quarter-inch cartridge (QIC)
tape (continued)
Format
Estimated
Capacity
Description
QIC12GBC
See note
Compressed 12000 QIC format, using 343–meter tape
24 GB
QIC5010
13 GB – 16 GB
Uncompressed 5010 QIC format, depending on
media
QIC5010C
See note
Compressed 5010 QIC format, depending on media
26 GB – 32 GB
QIC20GB
20 GB
Uncompressed 20000 QIC format
QIC20GBC
See note
Compressed 20000 QIC format
40 GB
QIC25GB
25 GB
Uncompressed 25000 QIC format
QIC25GBC
See note
Compressed 25000 QIC format
50 GB
QIC30GB
30 GB
Uncompressed 30000 QIC format
QIC30GBC
See note
Compressed 30000 QIC format
60 GB
QIC50GB
50 GB
Uncompressed 50GB QIC format
QIC50GBC
See note
Compressed 50GB QIC format
100 GB
QIC70GB
70 GB
Uncompressed 70GB QIC format
QIC70GBC
See note
Compressed 70GB QIC format
140 GB
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 77. QIC tape recording format options
Tape Format
3M
3M
3M
3M
3M
3M
3M
3M
DC300XLP
DC600A
DC600XTD
DC6150
DC6320
DC6525
DC9100
DC9120XL
QIC-120
QIC-150
QIC-525
QIC-1000
–
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 volumes assigned to this device class.
This parameter is optional.
212
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — QIC
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 100 KB (that is,
ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 MB.
For more information on the default estimated capacity for QIC tapes, see
Table 76 on page 211.
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, 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 0 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
Chapter 2. Administrative commands
213
DEFINE DEVCLASS — QIC
simultaneous-write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction fails.
For details about the simultaneous-write function, see the Administrator's 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).
Tip: 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.
214
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — REMOVABLEFILE
DEFINE DEVCLASS (Define a REMOVABLEFILE device class)
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 =
DEVType =
library_name
MAXCAPacity =
space_remaining
MAXCAPacity =
size
REMOVABLEfile
MOUNTRetention =
60
MOUNTWait =
60
MOUNTRetention =
minutes
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 manufacturer's 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 the Administrator's Guide for more information.
Chapter 2. Administrative commands
215
DEFINE DEVCLASS — REMOVABLEFILE
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 media, the maximum capacity should be no greater than
650 MB.
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 MB. The smallest value allowed is 100 KB (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 0 - 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 fails.
For details about the simultaneous-write function, see the Administrator's 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).
Tip: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value. Specify the number of drives for the library as the
MOUNTLIMIT value.
216
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — REMOVABLEFILE
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.
Chapter 2. Administrative commands
217
DEFINE DEVCLASS — SERVER
DEFINE DEVCLASS (Define a SERVER device class)
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 Administrator's 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 =
SERVERName =
SERVER
MAXCAPacity =
500M
MAXCAPacity =
size
server_name
MOUNTLimit =
1
MOUNTRetention =
60
MOUNTLimit =
number
MOUNTRetention =
minutes
PREFIX =
ADSM
RETRYPeriod =
10
RETRYPeriod =
retry_value_(minutes)
PREFIX =
ADSM
volume_prefix
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 (500 MB).
size
Specify this value as an integer followed by K (kilobytes), M (megabytes),
or G (gigabytes). The minimum value allowed is 100 KB
(MAXCAPACITY=100K).
218
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — SERVER
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, 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.
Chapter 2. Administrative commands
219
DEFINE DEVCLASS — VOLSAFE
DEFINE DEVCLASS (Define a VOLSAFE device class)
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.
Restrictions:
1. NAS-attached libraries are not supported.
2. VolSafe media and read/write media must be 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 one time, no additional data can be
written to them.
See the Administrator's 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 LIBRary =
|
FORMAT =
DEVType =
library_name
DRIVE
VOLSAFE
FORMAT =
DRIVE
9840
9840-C
MOUNTRetention =
60
PREFIX =
MOUNTRetention =
minutes
PREFIX =
ESTCAPacity =
size
ADSM
MOUNTWait =
60
MOUNTLimit =
MOUNTWait =
minutes
MOUNTLimit =
ADSM
volume_prefix
DRIVES
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.
220
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — VOLSAFE
For information about defining a library object, see “DEFINE LIBRARY (Define
a library)” on page 232.
DEVType=VOLSAFE (Required)
Specifies that the VOLSAFE device type is assigned to the device class. The
label on this type of cartridge can 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 data is written to sequential
access media. This parameter is optional; the default value is DRIVE.
Important: 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 78. Recording formats and default estimated capacities for Volsafe media
Format
Estimated
Capacity
DRIVE
–
Description
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 that
contains some drives that support recording formats
superior to other drives.
9840
20 GB
Uncompressed (standard) format, using a 20 GB
cartridge with 270 meters (885 feet) of tape
9840-C
See note
LZ-1 Enhanced (4:1) compressed format, using an 80
GB cartridge with 270 meters (885 feet) of tape
80 GB
ESTCAPacity
Specifies the estimated capacity for the volumes that are 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 that is allowed is 100 KB (that
is, ESTCAPACITY=100K).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 MB.
For more information about the default estimated capacity for cartridge tapes,
see Table 78.
Chapter 2. Administrative commands
221
DEFINE DEVCLASS — VOLSAFE
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 be a maximum of eight
characters including periods. For example, the following value is acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be alphabetic or national (@,#,$),
followed by alphabetic, national, hyphen, or numeric characters.
An example of a high-level archive file name that uses 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 0 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 fails.
For details about the simultaneous-write function, see the Administrator's Guide.
The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives
that are defined to the library is used to calculate the true value (including
online status).
Tip: 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 that are used concurrently in this
222
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DEVCLASS — VOLSAFE
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.
Chapter 2. Administrative commands
223
DEFINE DOMAIN
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
ARCHRETention =
365
BACKRETention =
days
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.
224
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DOMAIN
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
This optional parameter specifies the names of active-data pools that store
active versions of backup data for nodes assigned to the domain. You can
specify up to ten active-data pools for a domain, separated by commas. Spaces
are not permitted between the names.
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 simultaneous-write function is used to write data 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.
Example: Define a policy domain
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.
define domain prog1
description="Programming Group Domain"
backretention=60 archretention=90
Related commands
Table 79. 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.
UPDATE DOMAIN
Changes the attributes of a policy domain.
Chapter 2. Administrative commands
225
DEFINE DRIVE
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 261.
You can define more than one drive for a library by issuing the DEFINE DRIVE
command for each drive. Stand-alone drives always require a manual library.
Restriction: Before you issue the DEFINE DRIVE command for a removable media
device such as a Jaz, Zip, or CD drive, you must load the drive with properly
formatted and labeled media.
For detailed and current drive support information, see the Supported Devices
website for your operating system:
http://www.ibm.com/software/sysmgmt/products/support/
IBM_TSM_Supported_Devices_for_AIXHPSUNWIN.html
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
SERial =
AUTODetect
DEFine DRive library_name drive_name
SERial =
AUTODetect
serial_number
(1)
ONLine =
Yes
ELEMent =
AUTODetect
ONLine =
Yes
No
ELEMent =
AUTODetect
address
(3)
CLEANFREQuency =
NONE
(2)
ACSDRVID =
CLEANFREQuency =
NONE
(4)
drive_id
ASNEEDED
gigabytes
Notes:
226
1
The ELEMENT parameter is valid only for drives in SCSI libraries when the
drive type is not a network attached SCSI (NAS) drive. 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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DRIVE
4
The CLEANFREQUENCY=ASNEEDED parameter value does not work for
all tape drives. See the parameter description for more information.
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 that is 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 is used as the serial number.
If SERIAL=serial_number, then the serial number that is entered is 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
might not be supported. In this case, the serial number is 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 a drive within a SCSI or virtual tape library
(VTL). The server uses the element address to connect the physical location of
the drive to the SCSI or VTL address of the drive. The default is
AUTODETECT.
If ELEMENT=AUTODETECT, then the element number is automatically
detected by Tivoli Storage Manager when the path to the drive is defined.
To find the element address for your library configuration, consult the
information from the manufacturer.
Restriction:
v The ELEMENT parameter is valid only for drives in SCSI libraries or VTLs
when the drive type is not a network attached SCSI (NAS) drive.
v This parameter is not effective when the command is issued from a library
client server (that is, when the library type is SHARED).
v Depending on the capabilities of the library, ELEMENT=AUTODETECT
might not be supported. In this case, you must 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
Chapter 2. Administrative commands
227
DEFINE DRIVE
is the drive ID. The server needs the drive ID to connect the physical location
of the drive to the drive's SCSI address. See the StorageTek documentation for
details.
Restriction: In order to use ACSLS functions, the installation of StorageTek
Library Attach software is required.
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
library's volume inventory.
This parameter is not valid for externally managed libraries, such as 3494
libraries or StorageTek libraries that are managed under ACSLS.
Important: 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.
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.
The CLEANFREQUENCY=ASNEEDED parameter value does not work for
all tape drives. Visit the Supported Devices website for your operating
system to view detailed drive information. If ASNEEDED is not supported,
you can use the gigabytes value for automatic cleaning.
Restriction: Tivoli Storage Manager does not control the drives that are
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.
Important: When CLEANFREQUENCY=gigabyte, drive cleaning can occur
before the gigabyte setting is reached, if the drive notifies the device driver
that a cleaning is necessary.
|
|
|
Consult the information from the drive manufacturer 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.
228
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE DRIVE
Using the cleaning frequency that is recommended by IBM for IBM drives
ensures that the drives are not overcleaned.
For IBM 3590 and IBM 3570, specify a gigabyte value for the cleaning
frequency to ensure that the drives receive adequate cleaning.
Example: Define a drive to library
Define a drive in a manual library with a library name of LIB01 and a drive name
of DRIVE01.
define drive lib01 drive01
define path server01 drive01 srctype=server desttype=drive
library=lib01 device=mt3.0.0.0
Example: Define a drive in an ACSLS library
Define a drive in an ACSLS library with a library name of ACSLIB and a drive
name of ACSDRV1.
define drive acslib acsdrv1 acsdrvid=1,2,3,4
define path server01 acsdrv1 srctype=server desttype=drive
library=acslib device=mt3.0.0.0
Example: Define a drive in an automated library
Define a drive in an automated library with a library name of AUTO8MMLIB and
a drive name of DRIVE01.
define drive auto8mmlib drive01 element=82
define path server01 drive01 srctype=server desttype=drive
library=auto8mmlib device=mt3.0.0.0
Related commands
Table 80. 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.
PERFORM LIBACTION
Defines all drives and paths for 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 PATH
Changes the attributes associated with a
path.
Chapter 2. Administrative commands
229
DEFINE EVENTSERVER
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
Administrator's 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.
Example: Designate the event server
Designate ASTRO to be the event server.
define eventserver astro
Related commands
Table 81. Commands related to DEFINE EVENTSERVER
230
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE GRPMEMBER
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.
Example: Define a server to a server group
Define the server SANJOSE to server group CALIFORNIA.
define grpmember california sanjose
Example: Define a server and a server group to a server group
Define the server TUCSON and the server group CALIFORNIA to server group
WEST_COMPLEX.
define grpmember west_complex tucson,california
Related commands
Table 82. 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.
RENAME SERVERGROUP
Renames a server group.
UPDATE SERVERGROUP
Updates a server group.
Chapter 2. Administrative commands
231
DEFINE LIBRARY
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: a Tivoli Storage Manager server or a
data mover. However, the drives in a library can be accessed by multiple sources.
The following library types can be defined to the Tivoli Storage Manager server.
Syntax and parameter descriptions are available for each type.
v “DEFINE LIBRARY (Define a 349X library)” on page 234
v “DEFINE LIBRARY (Define an ACSLS library)” on page 237
v “DEFINE LIBRARY (Define an External library)” on page 239
v “DEFINE LIBRARY (Define a FILE library)” on page 241
v “DEFINE LIBRARY (Define a manual library)” on page 242
v
v
v
v
“DEFINE
“DEFINE
“DEFINE
“DEFINE
LIBRARY
LIBRARY
LIBRARY
LIBRARY
(Define
(Define
(Define
(Define
an RSM library)” on page 244
a SCSI library)” on page 245
a shared library)” on page 248
a VTL library)” on page 249
For detailed and current library support information, see the Supported Devices
website for your operating system:
http://www.ibm.com/software/sysmgmt/products/support/
IBM_TSM_Supported_Devices_for_AIXHPSUNWIN.html
Related commands
Table 83. Commands related to DEFINE LIBRARY
232
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 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 LIBRARY
Deletes a library.
DELETE PATH
Deletes a path from a source to a destination.
LABEL LIBVOLUME
Labels volumes in manual or automated
libraries.
PERFORM LIBACTION
Defines all drives and paths for a library.
QUERY DRIVE
Displays information about drives.
QUERY LIBRARY
Displays information about one or more
libraries.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE LIBRARY
Table 83. Commands related to DEFINE LIBRARY (continued)
Command
Description
QUERY LIBVOLUME
Displays information about a library volume.
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 LIBVOLUME
Changes the status of a storage volume.
UPDATE PATH
Changes the attributes associated with a
path.
Chapter 2. Administrative commands
233
DEFINE LIBRARY - 349X
DEFINE LIBRARY (Define a 349X library)
Use this syntax to define a 349X library.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
SHAREd =
DEFine LIBRary library_name LIBType =
SHAREd =
RESETDrives =
No
No
349X
AUTOLabel =
Yes
No
Yes
(1)
RESETDrives =
AUTOLabel =
Yes
No
No
Yes
OVERWRITE
SCRATCHCATegory =
301
PRIVATECATegory =
300
SCRATCHCATegory =
number
PRIVATECATegory =
number
WORMSCRatchcategory =
number
Notes:
1
The default value of the RESETDRIVES parameter is conditional. If the SHARED
parameter is set to NO, the value of the RESETDRIVES parameter is NO. If the
SHARED parameter is set to YES, the value of the RESETDRIVES parameter is
YES.
Parameters
library_name (Required)
Specifies the name of the library to be defined. The maximum length of this
name is 30 characters.
LIBType=349X (Required)
Specifies that the library is an IBM 3494 Tape Library Dataserver
Restriction: IBM 3494 libraries support only one unique device type at a time.
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.
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.
234
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE LIBRARY - 349X
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.
AUTOLabel
Specifies whether the server attempts to automatically label tape volumes. This
parameter is optional. The default is YES.
To use this option, you must 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 labels only 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.
SCRATCHCATegory
Specifies the category number to be used for scratch volumes in the library.
This parameter is optional. The default value is 301 (becomes X'12D' 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 from the other
category numbers in this library.
PRIVATECATegory
Specifies the category number for private volumes that must be mounted by
name. This parameter is optional. The default value is 300 (this value becomes
X'12C' on the IBM 3494 because 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 from the
other category numbers in this library.
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 from the
other category numbers in this library. This parameter is only valid when 3592
WORM volumes are used.
Restriction: If the WORMSCRATCHCATEGORY is not defined and the WORM
parameter is set to YES for the device class, the mount operation fails with an
error message.
RESETDrives
Specifies whether the server preempts a drive reservation with persistent
reserve when the server is restarted or when a library client or storage agent
reconnection is established. If, for example, a storage agent becomes
unavailable but is still holding the path to a drive, persistent reserve allows the
server to break the storage agent’s reservation and access the drive.
If persistent reserve is not supported, the server performs a reset of the path to
the target device.
Support for persistent reservation has the following limitations:
Chapter 2. Administrative commands
235
DEFINE LIBRARY - 349X
v If you are using the Tivoli Storage Manager device driver, persistent reserve
is only supported on some tape drives. See Technote 1470319 at
http://www.ibm.com/support/docview.wss?uid=swg21470319 for details.
v If you are using the IBM device driver, persistent reserve must be enabled at
the device driver level. See the IBM Tape Device Drivers Installation and User's
Guide at http://www.ibm.com/support/docview.wss?uid=ssg1S7002972 for
information about driver configuration.
v If you are using a virtual tape library that is emulating a supported drive, it
might not support persistent reserve.
Yes
Specifies that drive preemption through persistent reserve and target reset
are used. YES is the default for a library that is defined with
SHARED=YES. The RESETDRIVES parameter must be set to YES in a
clustered environment or the drive is unavailable following failover.
No Specifies that drive preemption through persistent reserve and target reset
are not used. NO is the default for a library that is defined with
SHARED=NO.
Example: Define a 3494 library
Define a library named my3494 with a scratch category number of 550, a private
category number of 600, and a WORM scratch category number of 400
define library my3494 libtype=349x scratchcategory=550
privatecategory=600 wormscratchcategory=400
236
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE LIBRARY - ACSLS
DEFINE LIBRARY (Define an ACSLS library)
Use this syntax to define an ACSLS library.
Privilege class
In order to use ACSLS functions, the installation of StorageTek Library Attach
software is required.
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
SHAREd =
DEFine LIBRary library_name LIBType =
SHAREd =
RESETDrives =
No
No
ACSLS
AUTOLabel =
Yes
No
Yes
(1)
RESETDrives =
ACSID =
Yes
No
AUTOLabel =
No
Yes
OVERWRITE
number
Notes:
1
The default value of the RESETDRIVES parameter is conditional. If the SHARED
parameter is set to NO, the value of the RESETDRIVES parameter is NO. If the
SHARED parameter is set to YES, the value of the RESETDRIVES parameter is
YES.
Parameters
library_name (Required)
Specifies the name of the library to be defined. The maximum length of this
name is 30 characters.
LIBType=ACSLS (Required)
Specifies that the library is a StorageTek library that is controlled by StorageTek
Automated Cartridge System Library Software (ACSLS).
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.
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 preempts a drive reservation with persistent
Chapter 2. Administrative commands
237
DEFINE LIBRARY - ACSLS
reserve when the server is restarted or when a library client or storage agent
reconnection is established. If, for example, a storage agent becomes
unavailable but is still holding the path to a drive, persistent reserve allows the
server to break the storage agent’s reservation and access the drive.
If persistent reserve is not supported, the server performs a reset of the path to
the target device.
Support for persistent reservation has the following limitations:
v If you are using the Tivoli Storage Manager device driver, persistent reserve
is only supported on some tape drives. See Technote 1470319 at
http://www.ibm.com/support/docview.wss?uid=swg21470319 for details.
v If you are using the IBM device driver, persistent reserve must be enabled at
the device driver level. See the IBM Tape Device Drivers Installation and User's
Guide at http://www.ibm.com/support/docview.wss?uid=ssg1S7002972 for
information about driver configuration.
v If you are using a virtual tape library that is emulating a supported drive, it
might not support persistent reserve.
Yes
Specifies that drive preemption through persistent reserve and target reset
are used. YES is the default for a library that is defined with
SHARED=YES. The RESETDRIVES parameter must be set to YES in a
clustered environment or the drive is unavailable following failover.
No Specifies that drive preemption through persistent reserve and target reset
are not used. NO is the default for a library that is defined with
SHARED=NO.
AUTOLabel
Specifies whether the server attempts to automatically label tape volumes. This
parameter is optional. The default is YES.
To use this option, you must 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 labels only 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 that is assigned by the ACSSA
(Automatic Cartridge System System Administrator). This number can be from
0 to 126. Issue QUERY ACS on your system to get the number for your library
ID. This parameter is required.
For more information, see your StorageTek documentation.
Example: Define a shared ACSLS library
Define a library named ACSLIB with the library type of ACSLS and an ACSID of
1.
define library acslib libtype=acsls acsid=1 shared=yes
238
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE LIBRARY - EXTERNAL
DEFINE LIBRARY (Define an External library)
Use this syntax to define an External library.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine LIBRary library_name LIBType =
AUTOLabel =
EXTernal
Yes
AUTOLabel =
No
Yes
OVERWRITE
Parameters
library_name (Required)
Specifies the name of the library to be defined. The maximum length of this
name is 30 characters.
LIBType=EXTernal (Required)
Specifies that the library is managed by an external media management
system. This library type does not support drive definitions with 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. 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.
AUTOLabel
Specifies whether the server attempts to automatically label tape volumes. This
parameter is optional. The default is YES.
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.
Chapter 2. Administrative commands
239
DEFINE LIBRARY - EXTERNAL
Example: Define an external library for a SAN configuration
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 file is
located in the following directory:
c:\program files\GES\EDT\bin\elm.exe
1. Define the library:
define library extlib libtype=external
2. Define the path:
define path server1 extlib srctype=server desttype=library
externalmanager="c:\program files\GES\EDT\bin\elm.exe"
240
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE LIBRARY - FILE
DEFINE LIBRARY (Define a FILE library)
Use this syntax to define a FILE library.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
SHAREd =
DEFine LIBRary library_name LIBType =
No
FILE
SHAREd =
Yes
No
Parameters
library_name (Required)
Specifies the name of the library to be defined. The maximum length of this
name is 30 characters.
LIBType=FILE (Required)
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. Shared FILE libraries
are supported for use in LAN-free backup configurations only. You cannot use
a shared FILE library in an environment in which a library manager is used to
manage library clients.
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.
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.
Example: Define a shared FILE library
Define a file library with shared=yes.
define library file1 libtype=file shared=yes
Chapter 2. Administrative commands
241
DEFINE LIBRARY - MANUAL
DEFINE LIBRARY (Define a manual library)
Use this syntax to define a manual library.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine LIBRary library_name LIBType =
RESETDrives =
Yes
AUTOLabel =
MANUAL
Yes
RESETDrives =
Yes
No
AUTOLabel =
No
Yes
OVERWRITE
Parameters
library_name (Required)
Specifies the name of the library to be defined. The maximum length of this
name is 30 characters.
LIBType=MANUAL (Required)
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.
AUTOLabel
Specifies whether the server attempts to automatically label tape volumes. This
parameter is optional. The default is YES.
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.
RESETDrives
Specifies whether the server preempts a drive reservation with persistent
reserve when the server is restarted or when a library client or storage agent
reconnection is established. If, for example, a storage agent becomes
unavailable but is still holding the path to a drive, persistent reserve allows the
server to break the storage agent’s reservation and access the drive.
If persistent reserve is not supported, the server performs a reset of the path to
the target device.
Support for persistent reservation has the following limitations:
242
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE LIBRARY - MANUAL
v If you are using the Tivoli Storage Manager device driver, persistent reserve
is only supported on some tape drives. See Technote 1470319 at
http://www.ibm.com/support/docview.wss?uid=swg21470319 for details.
v If you are using the IBM device driver, persistent reserve must be enabled at
the device driver level. See the IBM Tape Device Drivers Installation and User's
Guide at http://www.ibm.com/support/docview.wss?uid=ssg1S7002972 for
information about driver configuration.
v If you are using a virtual tape library that is emulating a supported drive, it
might not support persistent reserve.
Yes
Specifies that drive preemption through persistent reserve and target reset
are used. YES is the default for a library that is defined with
SHARED=YES. The RESETDRIVES parameter must be set to YES in a
clustered environment or the drive is unavailable following failover.
No Specifies that drive preemption through persistent reserve and target reset
are not used. NO is the default for a library that is defined with
SHARED=NO.
Example: Define a manual library
Define a library named MANUALMOUNT with the library type of MANUAL.
define library manualmount libtype=manual
Chapter 2. Administrative commands
243
DEFINE LIBRARY - RSM
DEFINE LIBRARY (Define an RSM library)
Use this syntax to define an RSM library.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine LIBRary library_name LIBType =
RSM
MEDIAType =
media_type
Parameters
library_name (Required)
Specifies the name of the library to be defined. The maximum length of this
name is 30 characters.
LIBType=RSM (Required)
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.
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.
Example: Define an RSM library
Define a library named RSMLIB with a library type of RSM. The media type for
the library is LTO Ultrium.
define library rsmlib libtype=rsm mediatype="LTO Ultrium"
244
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE LIBRARY - SCSI
DEFINE LIBRARY (Define a SCSI library)
Use this syntax to define a SCSI library.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
SHAREd =
DEFine LIBRary library_name LIBType =
SHAREd =
RESETDrives =
No
No
SCSI
AUTOLabel =
Yes
No
No
(1)
RESETDrives =
RELABELSCRatch =
AUTOLabel =
Yes
No
No
SERial =
No
Yes
OVERWRITE
AUTODetect
RELABELSCRatch =
No
Yes
SERial =
AUTODetect
serial_number
Notes:
1
The default value of the RESETDRIVES parameter is conditional. If the SHARED
parameter is set to NO, the value of the RESETDRIVES parameter is NO. If the
SHARED parameter is set to YES, the value of the RESETDRIVES parameter is
YES.
Parameters
library_name (Required)
Specifies the name of the library to be defined. The maximum length of this
name is 30 characters.
LIBType=SCSI (Required)
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.
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.
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.
Chapter 2. Administrative commands
245
DEFINE LIBRARY - SCSI
AUTOLabel
Specifies whether the server attempts to automatically label tape volumes. This
parameter is optional. The default is NO.
To use this option, you must 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 labels only 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.
RELABELSCRatch
Specifies whether the server relabels volumes that were deleted and returned
to scratch. When this parameter is set to YES, a LABEL LIBVOLUME operation
is started and the existing volume label is overwritten. This parameter is
optional and intended for use with a Virtual Tape Library (VTL).
Note: If you have both virtual and real volumes in your VTL, both types are
relabeled when this parameter is enabled. If the VTL includes real volumes,
specifying this option might impact performance.
No Specifies that the server does not relabel volumes that are deleted and
returned to scratch.
Yes
Specifies that the server relabels volumes that are deleted and returned to
scratch.
RESETDrives
Specifies whether the server preempts a drive reservation with persistent
reserve when the server is restarted or when a library client or storage agent
reconnection is established. If, for example, a storage agent becomes
unavailable but is still holding the path to a drive, persistent reserve allows the
server to break the storage agent’s reservation and access the drive.
If persistent reserve is not supported, the server performs a reset of the path to
the target device.
Support for persistent reservation has the following limitations:
v If you are using the Tivoli Storage Manager device driver, persistent reserve
is only supported on some tape drives. See Technote 1470319 at
http://www.ibm.com/support/docview.wss?uid=swg21470319 for details.
v If you are using the IBM device driver, persistent reserve must be enabled at
the device driver level. See the IBM Tape Device Drivers Installation and User's
Guide at http://www.ibm.com/support/docview.wss?uid=ssg1S7002972 for
information about driver configuration.
v If you are using a virtual tape library that is emulating a supported drive, it
might not support persistent reserve.
Yes
Specifies that drive preemption through persistent reserve and target reset
are used. YES is the default for a library that is defined with
SHARED=YES. The RESETDRIVES parameter must be set to YES in a
clustered environment or the drive is unavailable following failover.
246
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE LIBRARY - SCSI
No Specifies that drive preemption through persistent reserve and target reset
are not used. NO is the default for a library that is defined with
SHARED=NO.
SERial
Specifies the serial number for the library that is 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 is used as the serial number.
If SERIAL=serial_number, then the number you entered is compared to the
number detected by Tivoli Storage Manager.
Attention: Depending on the capabilities of the device,
SERIAL=AUTODETECT might not be supported. In this case, the serial
number is reported as blank.
Example: Define a SCSI library
Define a library named SCSILIB with a library type of SCSI.
define library scsilib libtype=scsi
The library requires a path. The device name for the library is:
lb3.0.0.0
Define the path:
define path server1 scsilib srctype=server desttype=library
device=lb3.0.0.0
Chapter 2. Administrative commands
247
DEFINE LIBRARY - SHARED
DEFINE LIBRARY (Define a shared library)
Use this syntax to define a shared library.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine LIBRary library_name LIBType =
PRIMarylibmanager =
SHAREd
server_name
Parameters
library_name (Required)
Specifies the name of the library to be defined. The maximum length of this
name is 30 characters.
LIBType=SHAREd (Required)
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.
Important: Specify this library type when defining the library on a library
client.
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.
Example: Define a shared library
In a SAN, define a library named SHAREDTSM to a library client server named
LIBMGR1
define library sharedtsm libtype=shared primarylibmanager=libmgr1
248
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE LIBRARY - VTL
DEFINE LIBRARY (Define a VTL library)
Use this syntax to define a library that has a SCSI-controlled media changer device
that is represented by a virtual tape library (VTL).
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
SHAREd =
DEFine LIBRary library_name LIBType =
SHAREd =
RESETDrives =
No
No
VTL
AUTOLabel =
Yes
No
No
(1)
RESETDrives =
RELABELSCRatch =
AUTOLabel =
Yes
No
Yes
SERial =
No
Yes
OVERWRITE
AUTODetect
RELABELSCRatch =
No
Yes
SERial =
AUTODetect
serial_number
Notes:
1
The default value of the RESETDRIVES parameter is conditional. If the SHARED
parameter is set to NO, the value of the RESETDRIVES parameter is NO. If the
SHARED parameter is set to YES, the value of the RESETDRIVES parameter is
YES.
Parameters
library_name (Required)
Specifies the name of the library to be defined. The maximum length of this
name is 30 characters.
LIBType=VTL (Required)
Specifies that the library has a SCSI-controlled media changer device that is
represented by a virtual tape library. To mount volumes in drives in this type
of library, Tivoli Storage Manager uses the media changer device.
If you are defining a VTL library, your environment must not include any
mixed-media and paths must be defined between all drives in the library and
all defined servers, including storage agents, that use the library. If either of
these characteristics are not true, the overall performance can degrade to the
same levels as the SCSI library type; especially during times of high stress.
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.
YES
Specifies that this library can be shared with other servers. When you
Chapter 2. Administrative commands
249
DEFINE LIBRARY - VTL
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 preempts a drive reservation with persistent
reserve when the server is restarted or when a library client or storage agent
reconnection is established. If, for example, a storage agent becomes
unavailable but is still holding the path to a drive, persistent reserve allows the
server to break the storage agent’s reservation and access the drive.
If persistent reserve is not supported, the server performs a reset of the path to
the target device.
Support for persistent reservation has the following limitations:
v If you are using the Tivoli Storage Manager device driver, persistent reserve
is only supported on some tape drives. See Technote 1470319 at
http://www.ibm.com/support/docview.wss?uid=swg21470319 for details.
v If you are using the IBM device driver, persistent reserve must be enabled at
the device driver level. See the IBM Tape Device Drivers Installation and User's
Guide at http://www.ibm.com/support/docview.wss?uid=ssg1S7002972 for
information about driver configuration.
v If you are using a virtual tape library that is emulating a supported drive, it
might not support persistent reserve.
Yes
Specifies that drive preemption through persistent reserve and target reset
are used. YES is the default for a library that is defined with
SHARED=YES. The RESETDRIVES parameter must be set to YES in a
clustered environment or the drive is unavailable following failover.
No Specifies that drive preemption through persistent reserve and target reset
are not used. NO is the default for a library that is defined with
SHARED=NO.
AUTOLabel
Specifies whether the server attempts to automatically label tape volumes. This
parameter is optional. The default is NO.
To use this option, you must 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 labels only 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.
RELABELSCRatch
Specifies whether the server relabels volumes that were deleted and returned
to scratch. When this parameter is set to YES, a LABEL LIBVOLUME operation is
started and the existing volume label is overwritten.
250
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE LIBRARY - VTL
Note: If you have both virtual and real volumes in your VTL, both types are
relabeled when this parameter is enabled. If the VTL includes real volumes,
specifying this option might impact performance.
Yes
Specifies that the server relabels volumes that are deleted and returned to
scratch. YES is the default.
No Specifies that the server does not relabel volumes that are deleted and
returned to scratch.
SERial
Specifies the serial number for the library that is 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 is used as the serial number.
If SERIAL=serial_number, then the number you entered is compared to the
number detected by Tivoli Storage Manager.
Attention: Depending on the capabilities of the device,
SERIAL=AUTODETECT might not be supported. In this case, the serial
number is reported as blank.
Example: Define a VTL library
Define a library named VTLLIB with a library type of VTL.
define library vtllib libtype=vtl
The library requires a path. The device name for the library is:
lb3.0.0.0
Define the path:
define path server1 vtllib srctype=server desttype=library
device=lb3.0.0.0
Chapter 2. Administrative commands
251
DEFINE MACHINE
DEFINE MACHINE (Define machine information for disaster
recovery)
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
PRIority =
50
FLoor =
floor
ADSMServer =
ROom
=
room
No
PRIority =
number
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:
252
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE MACHINE
No This machine is not a Tivoli Storage Manager server.
Yes
This machine is a Tivoli Storage Manager server.
Example: Define a machine's disaster recovery information
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.
define machine district5 building=101 floor=27
room=datafacilities priority=1
Related commands
Table 84. Commands related to DEFINE MACHINE
Command
Description
DEFINE MACHNODEASSOCIATION
Associates a 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 Tivoli Storage Manager
database.
QUERY MACHINE
Displays information about machines.
UPDATE MACHINE
Changes the information for a machine.
Chapter 2. Administrative commands
253
DEFINE MACHNODEASSOCIATION
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.
Example: Associate a node with a machine
Associate the node named ACCOUNTSPAYABLE with the machine named
DISTRICT5.
define machnodeassociation district5 accountspayable
Related commands
Table 85. Commands related to DEFINE MACHNODEASSOCIATION
254
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.
REGISTER NODE
Defines a client node 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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE MACHNODEASSOCIATION
Chapter 2. Administrative commands
255
DEFINE MGMTCLASS
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.
Attention: The DEFINE MGMTCLASS command fails if a copy storage pool is
specified as the destination for files that were migrated by a Tivoli Storage
Manager for Space Management client.
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
AUTOMIGNOnuse =
0
AUTOMIGNOnuse =
days
SPACEMGTECHnique =
MIGREQUIRESBkup =
AUTOmatic
SELective
NONE
Yes
MIGDESTination =
SPACEMGPOOL
MIGDESTination =
pool_name
MIGREQUIRESBkup =
Yes
No
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
256
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE MGMTCLASS
only for Tivoli Storage Manager for Space Management 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 Tivoli Storage Manager for Space
Management 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 Tivoli Storage Manager for Space Management 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 by Tivoli Storage Manager for Space Management clients. This
parameter is effective only for Tivoli Storage Manager for Space Management
clients, and is not effective 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.
Example: Define a management class for a specific policy set
and policy domain
Define a management class called MCLASS1 for policy set SUMMER in the PROG1
policy domain. For Tivoli Storage Manager for Space Management clients, allow
both automatic and selective migration, and store migrated files in the SMPOOL
storage pool. Add the description, “Technical Support Mgmt Class.”
define mgmtclass prog1 summer mclass1
spacemgtechnique=automatic migdestination=smpool
description="technical support mgmt class"
Chapter 2. Administrative commands
257
DEFINE MGMTCLASS
Related commands
Table 86. Commands related to DEFINE MGMTCLASS
258
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE NODEGROUP
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 64 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.
Example: Define a node group
Define a node group named group1.
define nodegroup group1
Related commands
Table 87. 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 client's 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.
Chapter 2. Administrative commands
259
DEFINE NODEGROUPMEMBER
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.
Example: Define node group members
Define two members, node1 and node2, to a node group, group1.
define nodegroupmember group1 node1,node2
Related commands
Table 88. Commands related to DEFINE NODEGROUPMEMBER
260
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 client's 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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE PATH
DEFINE PATH (Define a path)
Use this command to define a path for a source to access a destination. Both the
source and destination must be defined 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
Tivoli Storage Manager software.
Syntax and parameter descriptions are available for the following path types.
v “DEFINE PATH (Define a path when the destination is a drive)” on page 262
v “DEFINE PATH (Define a path when the destination is a library)” on page 268
For detailed and current device support information, see the Supported Devices
website for your operating system:
http://www.ibm.com/software/sysmgmt/products/support/
IBM_TSM_Supported_Devices_for_AIXHPSUNWIN.html
Related commands
Table 89. Commands related to DEFINE PATH
Command
Description
DEFINE DATAMOVER
Defines a data mover to the 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.
PERFORM LIBACTION
Defines all drives and paths for a library.
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.
Chapter 2. Administrative commands
261
DEFINE PATH - Destination is a drive
DEFINE PATH (Define a path when the destination is a drive)
Use this syntax when defining a path to a drive.
Privilege class
To issue this command you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine PATH source_name destination_name
SRCType =
LIBRary =
DATAMover
SERVer
DESTType =
AUTODetect =
library_name DEVIce =
GENERICTAPE =
No
DRive
device_name
FILE
ONLine =
No
Yes
Yes
GENERICTAPE =
DIRectory =
Yes
No
ONLine =
Yes
No
current_directory_name
,
DIRectory =
directory_name
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.
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 is 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.
Possible values are:
No Specifies that the serial number is not 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.
262
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE PATH - Destination is a drive
Yes
Specifies that the serial number is not automatically updated to reflect the
same serial number that the drive reports to Tivoli Storage Manager.
Important:
1. If you did not set the serial number when you defined the drive, 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 definition is updated with the detected serial
number.
3. If you set DESTTYPE=DRIVE and AUTODETECT=YES, then the drive
element number in the Tivoli Storage Manager database is
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 might not be supported.
DESTType=DRive (Required)
Specifies that a drive is the destination. When the destination is a drive, you
must specify a library name.
LIBRary
Specifies the name of the library to which the drive is assigned. The library
and its drives must already be defined to the 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. See Table 90 for examples.
Table 90. Examples of device names
Source to destination
Example
Server to a drive (not a FILE drive)
mt3
Storage agent (on a Windows system) to a drive (not a mt3
FILE drive)
Storage agent to a drive when the drive is a logical
drive in a FILE library
FILE
NAS data mover to a drive
NetApp NAS file server: rst0l
EMC Celerra NAS file server:
c436t0l1
IBM System Storage N Series: rst0l
Important:
v For more complete information about device names when the source is a
server, see the Administrator's Guide.
Chapter 2. Administrative commands
263
DEFINE PATH - Destination is a drive
v For information about the device name when the source is a storage agent,
see the Storage Agent User's Guide.
v 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 Tape
Device Drivers Installation and User’s Guide. The guide can be downloaded
from the IBM Systems support site at the following URL:
http://www.ibm.com/support/docview.wss?uid=ssg1S7002972.
v 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 NetApp 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
GENERICTAPE
Specifies whether the tape drive to be used is a GENERICTAPE device class
type. If the device is a tape drive and is not supported by Tivoli Storage
Manager but is supported for the Windows operating system, you can use it
with the generic tape format. To use the drive, specify GENERICTAPE=Yes
when defining a path to the drive. The default is No.
This parameter is not valid for optical drives. Possible values are:
Yes
Specifies that the tape drive to be used is a GENERICTAPE device class
type.
No Specifies that the tape drive to be used is not a GENERICTAPE device
class type.
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.
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.
For a path from a storage agent to a FILE device, 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.
264
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE PATH - Destination is a drive
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.
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 which you can use 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, it experiences mount failures.
The account associated with the storage agent service must either be an
account within the local administrator's group or an account within the
domain administrator's group. If the account is in the local administrator's
group, the user ID and password must match that of an account with
permissions to access storage as provided by the system 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 previous example, 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 system 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
Chapter 2. Administrative commands
265
DEFINE PATH - Destination is a drive
Attention:
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 Tivoli Storage Manager server.
2. 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.
Example: Define a path from a server to a drive
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.
define path net1 tapedrv6 srctype=server autodetect=no desttype=drive
library=netlib device=mt4
Example: Define a path from a data mover server to a drive for backup
and restore
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.
define path nas1 tapedrv3 srctype=datamover desttype=drive library=naslib
device=rst0l
Example: Define a path from a storage agent to a drive for backup and
restore
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 /dev/mt3.
define path sa1 tapedrv4 srctype=server desttype=drive library=tsmlib
device=/dev/mt3
Example: Define a path to give a storage agent access to shared disk
storage
Define a path that gives the storage agent access to files on disk storage shared
with the Tivoli Storage Manager server. Drive FILE9 is defined to library FILE1 on
the server. The storage agent SA1 accesses FILE9. On the storage agent, this data is
on directory \\192.168.1.10\filedata.
The data for FILE9 resides on the server at d:\tsmdata\filedata.
define path sa1 file9 srctype=server desttype=drive library=file1 device=file
directory="\\192.168.1.10\filedata"
Example: Configure a storage agent to use a FILE library
The following example 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
266
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE PATH - Destination is a drive
v d:\server
v e:\server
1. 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 sta1 classa1 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, replaces 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 is still able to access file volume c:\server\file1.dsm, but the
storage agent STA1 is not 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 is still
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 is still able to access file volume /opt/tivoli1/file1.dsm, but the
storage agent STA1 is not 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 is still
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.
Chapter 2. Administrative commands
267
DEFINE PATH - Destination is a library
DEFINE PATH (Define a path when the destination is a library)
Use this syntax when defining a path to a library.
Privilege class
To issue this command you must have system privilege or unrestricted storage
privilege.
Syntax
(1)
DEFine PATH source_name destination_name SRCType =
DESTType =
AUTODetect =
LIBRary
No
Yes
ONLine =
DATAMover
SERVer
DEVIce = device_name
EXTERNALManager = path_name
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.
Attention: 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.
Yes
Specifies that the serial number will be automatically updated to reflect the
same serial number that the drive reports to Tivoli Storage Manager.
268
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE PATH - Destination is a library
Important:
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. Depending on the capabilities of the device, the AUTODETECT
parameter may not be supported.
DESTType=LIBRary (Required)
Specifies that a library is the destination. This parameter is required.
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 library. See Table 91 for
examples.
Table 91. Examples of device names
Source to destination
Example
Server to a library
lb4.1
Storage agent to a drive when the drive is a logical
drive in a FILE library
FILE
NAS data mover to a library
mc0
Important:
v For more complete information about device names when the source is a
server, see the Administrator's Guide.
v For information about the device name when the source is a storage agent,
see the Storage Agent User's Guide.
v 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 Tape
Device Drivers Installation and User’s Guide. The guide can be downloaded
from the IBM Systems support site at the following URL:
http://www.ibm.com/support/docview.wss?uid=ssg1S7002972.
v 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 NetApp 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 Tivoli Storage
Manager can send media access requests. Use single quotation marks around
the value of this parameter. For example, enter:
C:\Program Files\GES\EDT-ACSLS\bin\elmdt.exe
Chapter 2. Administrative commands
269
DEFINE PATH - Destination is a library
This parameter is required when the library name is an external library.
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.
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 Administrator's Guide
for additional information.
Example: Define a path from a server to a library
Define a path from the server SATURN to the SCSI type library SCSILIB:
define path saturn scsilib srctype=server
desttype=library device=lb3.0.0.0
270
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE POLICYSET
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.
Example: Define a policy set
Define a policy set called SUMMER for the PROG1 policy domain and include the
description, “Programming Group Policies.”
define policyset prog1 summer
description="Programming Group Policies"
Related commands
Table 92. 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.
Chapter 2. Administrative commands
271
DEFINE POLICYSET
Table 92. Commands related to DEFINE POLICYSET (continued)
272
Command
Description
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE PROFASSOCIATION
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
Tip: 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 =
*
ADSCHeds =
,
domain_name
*
,
schedule_name
SCRipts =
*
,
script_name
Chapter 2. Administrative commands
273
DEFINE PROFASSOCIATION
CLOptsets =
*
,
option_set_name
SERVers =
*
SERVERGroups =
,
server_name
*
,
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.
274
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE PROFASSOCIATION
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.
Important: 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.
Tip: 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.
Chapter 2. Administrative commands
275
DEFINE PROFASSOCIATION
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 parameter's 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.
Important:
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 replacement, on the
276
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE PROFASSOCIATION
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.
Tip: 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.
Example: Associate a specific domain with a specific profile
Associate a domain named MARKETING with a profile named DELTA.
define profassociation delta domains=marketing
Example: Associate all domains with a specific profile
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.
define profassociation gamma domains=*
Related commands
Table 93. 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.
DELETE PROFILE
Deletes a profile from a configuration
manager.
LOCK PROFILE
Prevents distribution of a configuration
profile.
Chapter 2. Administrative commands
277
DEFINE PROFASSOCIATION
Table 93. Commands related to DEFINE PROFASSOCIATION (continued)
278
Command
Description
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE PROFILE
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.
Example: Define a new profile
Define a profile named ALPHA with a description of "Programming Center."
define profile alpha
description="Programming Center"
Related commands
Table 94. 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.
SET CONFIGMANAGER
Specifies whether a server is a configuration
manager.
UNLOCK PROFILE
Enables a locked profile to be distributed to
managed servers.
Chapter 2. Administrative commands
279
DEFINE PROFILE
Table 94. Commands related to DEFINE PROFILE (continued)
280
Command
Description
UPDATE PROFILE
Changes the description of a profile.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE RECMEDMACHASSOCIATION
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.
Example: Associate machines to recovery media
Associate machines DISTRICT1 and DISTRICT5 to the DIST5RM recovery media.
define recmedmachassociation dist5rm
district1,district5
Related commands
Table 95. 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.
DELETE RECOVERYMEDIA
Deletes recovery media.
QUERY MACHINE
Displays information about machines.
Chapter 2. Administrative commands
281
DEFINE RECMEDMACHASSOCIATION
Table 95. Commands related to DEFINE RECMEDMACHASSOCIATION (continued)
282
Command
Description
QUERY RECOVERYMEDIA
Displays media available for machine
recovery.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE RECOVERYMEDIA
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 =
Type
=
Type
=
description
LOcation =
location
OTher
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.
Chapter 2. Administrative commands
283
DEFINE RECOVERYMEDIA
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 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.
Example: Define the media needed to recover a machine
Define the recovery media named DIST5RM. Include a description and the
location.
define recoverymedia dist5rm
description="district 5 base system image"
location="district 1 vault"
Related commands
Table 96. Commands related to DEFINE RECOVERYMEDIA
284
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCHEDULE
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.
v “DEFINE SCHEDULE (Define a schedule for an administrative command)” on
page 300
v “DEFINE SCHEDULE (Define a client schedule)” on page 286
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 97. 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.
Chapter 2. Administrative commands
285
DEFINE SCHEDULE
DEFINE SCHEDULE (Define a client schedule)
Use the DEFINE SCHEDULE command to define a client schedule. Tivoli Storage
Manager uses this schedule to automatically perform a variety of client 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.
Not all clients can run all scheduled operations, even though you can 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.
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 =
286
=
description
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCHEDULE
ACTion =
Incremental
ACTion =
Incremental
Selective
Archive
""
SUBACTion =
FASTBack
Backup
""
SUBACTion =
FASTBack
SYSTEMSTate
(1)
VM
REStore
RETrieve
IMAGEBACkup
IMAGEREStore
Command
Macro
Deploy
OPTions =
option_string
(2)
OBJects
=
object_string
PRIority =
5
STARTDate =
current_date
PRIority =
number
STARTDate =
date
STARTTime =
current_time
DURation =
1
STARTTime =
time
DURation =
number
DURUnits =
Hours
SCHEDStyle =
Classic
SCHEDStyle =
Classic
DURUnits =
Minutes
Hours
Days
INDefinite
PERiod =
1
PERUnits =
PERiod =
number
PERUnits =
Days
Hours
Days
Weeks
Months
Years
Onetime
Chapter 2. Administrative commands
287
DEFINE SCHEDULE
DAYofweek =
ANY
EXPiration =
Never
DAYofweek =
ANY
WEEKDay
WEEKEnd
SUnday
Monday
TUesday
Wednesday
THursday
Friday
SAturday
EXPiration =
Never
date
Notes:
|
|
1
You can define or update a SYSTEMSTATE or VM subaction on the
Administration Center but these actions are not saved.
2
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 =
ACTion =
description
Incremental
ACTion =
Incremental
Selective
Archive
SUBACTion =
FASTBack
Backup
""
SUBACTion =
FASTBack
SYSTEMSTate
VM
REStore
RETrieve
IMAGEBACkup
IMAGEREStore
Command
Macro
OPTions =
option_string
(1)
OBJects
288
IBM Tivoli Storage Manager for Windows: Administrator's Reference
=
object_string
DEFINE SCHEDULE
PRIority =
5
STARTDate =
current_date
PRIority =
number
STARTDate =
date
STARTTime =
current_time
DURation =
1
STARTTime =
time
DURation =
number
DURUnits =
Hours
SCHEDStyle =
DURUnits =
MONth =
Enhanced
Minutes
Hours
Days
ANY
DAYOFMonth =
ANY
MONth =
ANY
JAnuary
February
MARch
APril
May
JUNe
JULy
AUgust
September
October
November
December
WEEKofmonth =
ANY
DAYOFMonth =
ANY
Day
DAYofweek =
ANY
WEEKofmonth =
EXPiration =
ANY
FIrst
Second
Third
FOurth
Last
DAYofweek =
ANY
WEEKDay
WEEKEnd
SUnday
Monday
TUesday
Wednesday
THursday
Friday
SAturday
Never
EXPiration =
Never
date
Notes:
1
The OBJECTS parameter is optional when ACTION=INCREMENTAL, but is required
for other actions.
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.
Chapter 2. Administrative commands
289
DEFINE SCHEDULE
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 might 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.
Backup
Specifies that the schedule backs up 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
Indicates that the schedule retrieves files that are specified with the
OBJECTS parameter.
Remember: A second file that is specified acts as the retrieve destination.
If you need to retrieve multiple groups of files, create a separate schedule
for each group of files.
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.
290
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCHEDULE
Macro
Specifies that a client processes a macro whose file name is specified with
the OBJECTS parameter.
SUBACTion
Possible values are:
"" When a null string (two double quotes) is specified with
ACTION=BACKUP the backup is an incremental.
FASTBAck
Specifies that a FastBack client operation that is identified by the
ACTION parameter is to be scheduled for processing. The ACTION
parameter must be either ARCHIVE or BACKUP.
SYSTEMSTate
Specifies that a client Systemstate backup is scheduled.
VM Specifies that a client VMware backup operation is scheduled.
Deploy
Specifies whether to update client workstations with deployment packages
that are specified with the OBJECTS parameter. The OBJECTS parameter must
contain two specifications, the package files to retrieve and the location
from which to retrieve them. Ensure that the objects are in the order files
location. For example:
define schedule standard deploy_1 action=DEPLOY objects=
"\\IBM_ANR_WIN\c$\tsm\maintenance\client\v6r2\Windows\X32\v620\v6200\*
..\IBM_ANR_WIN\"
Values for the following options are restricted when you specify
ACTION=DEPLOY:
PERUNITS
Specify PERUNITS=ONETIME. If you specify PERUNITS=PERIOD, the
parameter is ignored.
DURUNITS
Specify MINUTES, HOURS, or DAYS for the DURUNITS parameter. Do not
specify INDEFINITE.
SCHEDSTYLE
Specify the default style, CLASSIC.
The SCHEDULE command fails if the parameters do not conform to the
required parameter values, such as the V.R.M.F.
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 can 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 result in an error or are ignored when
running the schedule from the server. For example, do not include the
following options because they have no impact when the client processes the
scheduled command:
MAXCMDRETRIES
OPTFILE
Chapter 2. Administrative commands
291
DEFINE SCHEDULE
QUERYSCHEDPERIOD
RETRYPERIOD
SCHEDLOGNAME
SCHEDMODE
SERVERNAME
TCPCLIENTADDRESS
TCPCLIENTPORT
When you define a scheduler service by using the DSMCUTIL command or the
backup-archive client GUI wizard, you specify an options file. 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 apostrophes. Enclose
individual options that contain spaces in quotation marks. 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:"’
Tip: For Windows clients running in batch mode, if the use of quotation marks
is necessary, use interactive mode or operating system escape characters. For
additional information, see:
v “Processing a series of commands from the administrative client” on page 3
v “Processing commands one at a time from the administrative client” on page
3
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 User's 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 client 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.
Important:
v 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.
v If you specify more than two file specifications, you receive this error:
ANS1102E Excessive number of command line arguments passed to the
program!
292
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCHEDULE
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.
If you are using characters that have a special meaning for Windows users,
such as commas, surround the entire argument in two pairs of double quotes,
then surround the entire string with single quotes. The following examples
show you 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"’
v To specify D:TEST,FILE:
OBJECTS=’""D:\TEST,FILE""’
Tip: For Windows clients running in batch mode, if the use of double quotes is
necessary, use interactive mode or operating system escape characters. For
additional information, see:
v “Processing a series of commands from the administrative client” on page 3
v “Processing commands one at a time from the administrative client” on page
3
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 The current date plus days
TODAY +3 or +3.
+days
specified. The maximum
number of days you can specify
is 9999.
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
Chapter 2. Administrative commands
293
DEFINE SCHEDULE
Value
Description
Example
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
BOTM
(Beginning Of
This Month)
The first day of the current
month.
BOTM
BOTM+days
The first day of the current
month, plus days specified.
BOTM+9
To include files that were active a day
before the last day of the previous
month.
To include files that were active on the
10th day of the current month.
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 NOW+02:00 or +02:00.
minutes specified
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=NOW–02: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.
Tip: Define schedules with durations longer than 10 minutes. Doing this will
give the Tivoli Storage Manager scheduler enough time to process the schedule
and prompt the client.
294
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCHEDULE
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 can run, or the days on which it runs. The default is
the classic syntax.
Possible values are:
Classic
The parameters for the Classic syntax are: PERIOD, PERUNITS, and
DAYOFWEEK. You cannot use these parameters: MONTH,
DAYOFMONTH, and WEEKOFMONTH.
Enhanced
The parameters for the Enhanced syntax are: MONTH, DAYOFMONTH,
WEEKOFMONTH, and DAYOFWEEK. You cannot use these parameters:
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.
Chapter 2. Administrative commands
295
DEFINE SCHEDULE
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.
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 month's
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.
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 year's
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
296
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCHEDULE
specify, the start date and start time will be shifted forward in 24–hour
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, which
means that the schedule runs 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
Chapter 2. Administrative commands
297
DEFINE SCHEDULE
-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, and so on. You can specify multiple
values separated by commas and no intervening blanks. If you specify multiple
values, the schedule runs on each of the specified days of the month. If
multiple values resolve to the same day, the schedule runs only once that day.
The default value is ANY. ANY means that the schedule runs 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 runs during each of the specified weeks of the month. If
multiple values resolve to the same week, the schedule runs only once during
that week.
The default value is ANY. ANY means that the schedule runs 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.
Example: Define a schedule for a monthly incremental backup
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.
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
Example: Define a schedule for a weekly incremental backup
Define a schedule named WEEKLY_BACKUP that initiates an incremental backup
of all associated nodes. The initial startup window for this schedule extends from
298
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCHEDULE
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 run.
define schedule employee_records weekly_backup
startdate=06/07/1997 starttime=23:00 duration=4
durunits=hours perunits=weeks
dayofweek=saturday options=-quiet
Example: Define a schedule that archives a specific directory every
quarter
Define a schedule that archives specific files quarterly on the last Friday of the
month.
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
Chapter 2. Administrative commands
299
DEFINE SCHEDULE
DEFINE SCHEDULE (Define a schedule for an 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 15.
Privilege class
To define an administrative command schedule, you must have system privilege.
Syntax
Classic administrative schedule
DEFine SCHedule schedule_name
Type
CMD
ACTIVE =
No
ACTIVE =
Yes
=
Administrative
= command
DESCription =
PRIority =
5
STARTDate =
current_date
PRIority =
number
STARTDate =
date
description
STARTTime =
current_time
DURation =
1
STARTTime =
time
DURation =
number
DURUnits =
Hours
SCHEDStyle =
Classic
SCHEDStyle =
Classic
DURUnits =
Minutes
Hours
Days
INDefinite
PERiod =
1
PERUnits =
PERiod =
number
PERUnits =
Days
300
IBM Tivoli Storage Manager for Windows: Administrator's Reference
Hours
Days
Weeks
Months
Years
Onetime
DEFINE SCHEDULE
DAYofweek =
ANY
EXPiration =
Never
DAYofweek =
ANY
WEEKDay
WEEKEnd
SUnday
Monday
TUesday
Wednesday
THursday
Friday
SAturday
EXPiration =
Never
date
Syntax
Enhanced administrative schedule
DEFine SCHedule schedule_name
Type
CMD
=
ACTIVE =
NO
ACTIVE =
YES
=
Administrative
Command
DESCription =
PRIority =
5
STARTDate =
current_date
PRIority =
number
STARTDate =
date
description
STARTTime =
current_time
DURation =
1
STARTTime =
time
DURation =
number
DURUnits =
Hours
SCHEDStyle =
DURUnits =
MONth =
Enhanced
Minutes
Hours
Days
ANY
DAYOFMonth =
ANY
MONth =
ANY
JAnuary
February
MARch
APril
May
JUNe
JULy
AUgust
September
October
November
December
DAYOFMonth =
ANY
Day
Chapter 2. Administrative commands
301
DEFINE SCHEDULE
WEEKofmonth =
ANY
DAYofweek =
ANY
WEEKofmonth =
EXPiration =
ANY
FIrst
Second
Third
FOurth
Last
DAYofweek =
ANY
WEEKDay
WEEKEnd
SUnday
Monday
TUesday
Wednesday
THursday
Friday
SAturday
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.
Restriction: 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.
302
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCHEDULE
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 The current date plus days
TODAY +3 or +3.
+days
specified. The maximum
number of days you can specify
is 9999.
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
BOTM
(Beginning Of
This Month)
The first day of the current
month.
BOTM
BOTM+days
The first day of the current
month, plus days specified.
BOTM+9
To include files that were active a day
before the last day of the previous
month.
To include files that were active on the
10th day of the current month.
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 NOW+02:00 or +02:00.
minutes specified
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.
Chapter 2. Administrative commands
303
DEFINE SCHEDULE
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 5:00 with
STARTTIME=NOW–02: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
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.
304
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCHEDULE
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.
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.
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 month's
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.
Chapter 2. Administrative commands
305
DEFINE SCHEDULE
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 year's
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 24–hour
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.
306
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCHEDULE
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.
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.
Chapter 2. Administrative commands
307
DEFINE SCHEDULE
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.
Example: Define a schedule to back up the primary storage pool every
two days
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.
define schedule backup_archivepool type=administrative
cmd="backup stgpool archivepool recoverypool"
active=yes starttime=20:00 period=2
Example: Define a schedule to back up the primary storage pool twice
a month
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.
define schedule backup_archivepool type=administrative
cmd="backup stgpool archivepool recoverypool"
schedstyle=enhanced dayofmonth=1,15
308
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCRIPT
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.
Tips:
v 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.
v 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.
v You cannot redirect the output of a command within a Tivoli Storage Manager
script. Instead, run the script and then specify command redirection. For
example, to direct the output of script1 to the c:\temp\test.out directory, run
the script and specify command redirection as in the following example:
run script1 > c:\temp\test.out
Privilege class
To issue this command, you must have operator, policy, storage, or system
privilege.
Syntax
DEFine SCRipt script_name
Line
=
001
Line
file_name
=
number
command_line
File
=
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.
You can run commands serially, in parallel, or serially and in parallel by
specifying the SERIAL or PARALLEL script commands for the COMMAND_LINE
Chapter 2. Administrative commands
309
DEFINE SCRIPT
parameter. You can run multiple commands in parallel and wait for them to
complete before proceeding to the next command. Commands will run serially
until the parallel command is encountered.
Conditional logic flow statements can be used. These statements include IF,
EXIT, and GOTO.
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.
Example: Write a script to display AIX clients
Define a script that will display all AIX clients.
define script qaixc "select node_name from nodes where platform_name=’AIX’"
desc=’Display aix clients’
Example: Write and run a script to route a command to a server
group
Define and run a script that will route the QUERY STGPOOL command to a server
group named DEV_GROUP.
define script qu_stg "(dev_group) query stgpool"
run qu_stg
Example: Create a script from an existing script
Define a script whose command lines are read in from a file that is named
MY.SCRIPT and name the new script AGADM.
define script agadm file=my.script
Refer to the Administrator's Guide for more information on the following topics:
v Running commands in parallel or serially
v Using logic flow statements in scripts
v Performing tasks concurrently on multiple servers
310
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SCRIPT
Related commands
Table 98. 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.
Chapter 2. Administrative commands
311
DEFINE SERVER
DEFINE SERVER (Define a server for server-to-server
communications)
Use this command to define a server to use functions such as virtual volumes,
node replication, command routing, and LAN-free data movement, among others.
Use this command to define a server for the following functions:
v Enterprise configuration
v Enterprise event logging
v Command routing
v
v
v
v
v
|
|
Virtual volumes
LAN-free data movement
Node replication
Status monitoring of remote servers
Alert monitoring of remote servers
If you use an LDAP directory server to authenticate passwords, any target servers
must be configured for LDAP-authenticated passwords. Data that is replicated
from a node that authenticates with an LDAP directory server is inaccessible if the
target replication server is not properly configured. If your target replication server
is not configured, replicated data from an LDAP node can make it to the target
server. But the target replication server must be configured to use LDAP if you
want to access the data.
The use of virtual volumes is not supported when the source server and the target
server are on the same Tivoli Storage Manager server.
This command also is used to define a Tivoli Storage Manager storage agent as if it
were a server.
Privilege class
To issue this command, you must have system privilege.
Syntax
For:
v
v
v
v
v
Enterprise configuration
Enterprise event logging
Command routing
Storage agent
Node replication source and target servers
DEFine SERver
HLAddress =
server_name SERVERPAssword =
ip_address LLAddress =
password
tcp_port
COMMmethod =
312
IBM Tivoli Storage Manager for Windows: Administrator's Reference
TCPIP
DEFINE SERVER
URL
= url
DESCription =
description
(1)
CROSSDEFine =
No
(2)
VALIdateprotocol =
No
CROSSDEFine =
SSL
=
SSL
=
No
Yes
VALIdateprotocol =
No
All
No
No
Yes
Notes:
1
The CROSSDEFINE parameter does not apply to storage agent definitions.
2
The VALIDATEPROTOCOL parameter applies only to storage agent
definitions.
Syntax for virtual volumes
DEFine SERver
HLAddress =
server_name PAssword =
ip_address LLAddress =
password
tcp_port
COMMmethod =
TCPIP
URL
= url
DELgraceperiod =
days
NODEName =
node_name
DESCription =
description
SSL
=
Yes
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 server-to-server event logging, library sharing, and node replication, you
must specify a server name that matches the name that was set by issuing 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.
Chapter 2. Administrative commands
313
DEFINE SERVER
Tip: Command routing uses the ID and the password of the administrator
who is issuing the command.
HLAddress (Required)
Specifies the IP address (in dotted decimal format) of the server.
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 the address in the TCPPORT server option of the target server. When
SSL=YES, the port must already be designated for SSL communications on 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.
DELgraceperiod
Specifies a number of days that an object remains on the target server after it
was marked for deletion. You can specify a value 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 that is running this command defines itself to the
server that is being specified by this command. This parameter is optional.
Important: 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.
Remember:
v For replication operations, the names of the source and target replication
servers must match the names that you specify in this command.
v CROSSDEFINE can be used with SSL=YES if all of the conditions specified for
the SSL=YES parameter are in place on the source and target server.
You can specify one of the following values:
No Cross definition is not performed.
Yes
Cross definition is performed.
314
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SERVER
VALIdateprotocol
Specify a cyclic redundancy check to validate the data sent between the storage
agent and Tivoli Storage Manager server. The parameter is optional. The
default is NO. You can specify one of the following values:
No Specifies that data validation is not performed on any data sent between
the storage agent and server.
All
Specifies that data validation is 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 affects performance as additional
resources are required to calculate and compare CRC values between the
storage agent and the server.
SSL
Specifies the communication mode of the server. The default is NO. You can
specify one of the following values:
No Specifies that unencrypted communication with the specified server occurs
over a TCP/IP session without SSL.
Yes
Specifies an SSL session for communication with the specified server. The
following conditions apply if you specify YES:
v Before starting the servers, self-signed certificates of the partner servers
must be in the key database file (cert.kdb) of each of the servers.
v You can define multiple server names with different parameters for the
same target server.
v SSL support is active if the server options file contains the SSLTCPPORT or
SSLTCPADMINPORT option or if a server is defined with SSL=YES at startup.
v Storage agents can issue the DSMSTA SETSTORAGESERVER command and
include the STAKEKEYDBPW and SSL parameters to create the key database.
v If third-party certificates are used, the CA (certificate authority)
certificate must be kept in the key database of the partner server. If you
upgrade from a release earlier than V6.3.0 and have a key database file
in your instance directory, update it to allow third-party certificates. To
update the key database file, issue the following command:
gsk8capicmd_64 -keydb -convert -populate
-db cert.kdb -pw passwordofkeydatabasefile
To issue the command on a Windows server, set the path to include
x:\Program Files\IBM\gsk8\bin;x:\Program Files\IBM\gsk8\lib64,
where x is the system drive.
Example: Set up two servers to use SSL to communicate
You must set up two servers to use SSL to communicate. The server addresses are
as follows:
v ServerA is at bfa.tucson.ibm.com
v ServerB is at bfb.tucson.ibm.com
Complete the following steps to set up the two servers for SSL:
1. Specify options SSLTCPPORT 1542 and TCPPORT 1500 for both servers in the
dsmserv.opt option file.
2. Start both servers and run the following command to set up the key database
file password:
Chapter 2. Administrative commands
315
DEFINE SERVER
SET SSLKEYRINGPW newpw UPDATE=Y
3. Shut down both servers to import the cert256 partner certificate. For ServerA,
the certificate is in the /tsma instance directory. For ServerB, the certificate is in
the /tsmb instance directory.
4. Start both servers. The /tsma/cert256.arm file is copied to
/tsmb/cert256.bfa.arm on the bfb.tucson.ibm.com address. The
/tsmb/cert256.arm file is copied to /tsmb/cert256.bfb.arm on the
bfa.tucson.ibm.com address.
5. Issue the following command:
v From ServerA:
gsk8capicmd_64 -cert -add -db cert.kdb -pw newpw -format ascii
-label "bfb" -file /tsma/cert256.bfb.arm
v From ServerB:
gsk8capicmd_64 -cert -add -db cert.kdb -pw newpw -format ascii
-label "bfa" -file /tsmb/cert256.bfa.arm
From each server, you can view the certificates in the key database by issuing
the following command:
gsk8capicmd_64 -cert -list -db cert.kdb -pw newpw
6. Restart the servers.
7. Issue the appropriate DEFINE SERVER command. For ServerA, issue the
following example command:
DEFINE SERVER BFB hla=bfb.tucson.ibm.com lla=1542
serverpa=passwordforbfb SSL=YES
For ServerB, issue the following example command:
DEFINE SERVER BFA hla=bfa.tucson.ibm.com lla=1542
serverpa=passwordforbfa SSL=YES
If you do not use SSL, issue the following example DEFINE SERVER command on
ServerA:
DEFINE SERVER BFBTCP hla=bfb.tucson.ibm.com lla=1500
serverpa=passwordforbfb SSL=NO
If you do not use SSL, issue the following example DEFINE SERVER command on
ServerB:
DEFINE SERVER BFATCP hla=bfa.tucson.ibm.com lla=1500
serverpa=passwordforbfa SSL=NO
Example: Define a target server
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, and set the
password to SECRET. Specify that objects remain on the target server for seven
days after they are marked for deletion.
define server server2 password=secret
hladdress=9.115.3.45 lladdress=1570 delgraceperiod=7
Example: Define a server to receive commands from other
servers
Define a server that can receive commands routed from other servers. Name the
server WEST_COMPLEX and set the password to CACTUS. Set the high-level
address to 9.172.12.35, the low-level address to 1500, and the URL address to
http://west_complex:1580/.
316
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SERVER
define server west_complex serverpassword=cactus
hladdress=9.172.12.35 lladdress=1500
url=http://west_complex:1580/
Example: Cross-define two servers
Use cross definition to define SERVER_A and SERVER_B.
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
set
set
set
set
servername server_b
serverpassword mylife
serverhladdress 9.115.20.80
serverlladdress 1860
crossdefine on
2. On SERVER_A, specify the server name, password, and high- and low-level
addresses of SERVER_A.
set
set
set
set
servername server_a
serverpassword yourlife
serverhladdress 9.115.20.97
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
See the Tivoli Storage Manager Storage Agent User’s Guide for information about the
DSMSTA SETSTORAGESERVER command.
Table 99. Commands related to DEFINE SERVER
Command
Description
DEFINE DEVCLASS
Defines a device class.
DELETE DEVCLASS
Deletes a device class.
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 node 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.
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.
SET REPLSERVER
Specifies a target replication server.
Chapter 2. Administrative commands
317
DEFINE SERVER
Table 99. Commands related to DEFINE SERVER (continued)
318
Command
Description
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SERVERGROUP
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.
Example: Define a server group
Define a server group named WEST_COMPLEX.
define servergroup west_complex
Related commands
Table 100. 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.
Chapter 2. Administrative commands
319
DEFINE SPACETRIGGER
DEFINE SPACETRIGGER (Define the space trigger)
Use this command to define settings for triggers that determine when and how the
server prepares additional space when predetermined thresholds have been
exceeded in storage pools that use FILE and DISK device classes. Space triggers are
not enabled for storage pools with a parameter
RECLAMATIONTYPE=SNAPLOCK.
Tivoli Storage Manager allocates more space when space utilization reaches a
specified value. After allocating more space, Tivoli Storage Manager either adds the
space to the specified pool (random-access or sequential-access disk).
Important: Space trigger functions and storage pool space calculations take into
account the space remaining in each directory. 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.
For example, 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 directory that is specified for the device
class and run out of space prematurely.
To prevent possible problems and ensure an accurate calculation, you associate
each directory with a separate file system. If a trigger becomes 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.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DEFine SPACETrigger
Fullpct =
80
Fullpct =
percent
STG
SPACEexpansion =
percent
EXPansionprefix =
prefix
STGPOOL =
storage_pool_name
Parameters
STG
Specifies a storage pool space trigger.
Fullpct
This parameter specifies the utilization percentage of the storage pool. This
320
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SPACETRIGGER
parameter is optional. Specify an integer value from 0 to 99. The default is 80.
A value of zero (0) disables the space trigger. 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 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 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
pool's device class. For random-access DISK storage pools, the space trigger
creates a single volume using the EXPANSIONPREFIX.
EXPansionprefix
For random-access DISK storage-pools, this parameter specifies the prefix that
the server uses to create new storage pool files. This parameter is optional and
applies only to random-access DISK device classes. The default prefix is the
server installation path.
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. If the server is running as a Windows service, the default
prefix is the c:\wnnt\system32 directory.
This parameter is not valid for space triggers for sequential-access FILE storage
pools. Prefixes are obtained from the directories specified with the associated
device class.
STGPOOL
Specifies the storage pool associated with this space trigger. This parameter is
optional for storage pool space triggers. If you specify the STG parameter but
not the STGPOOL parameter, 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.
Example: Define a space trigger to increase storage pool space
25 percent
Set up 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.
define spacetrigger stg spaceexpansion=25 stgpool=file
Chapter 2. Administrative commands
321
DEFINE SPACETRIGGER
Example: Define a space trigger to increase storage pool space
40 percent
Set up 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.
define spacetrigger stg spaceexpansion=40 stgpool=winpool1
Related commands
Table 101. Commands related to DEFINE SPACETRIGGER
322
Command
Description
DEFINE VOLUME
Assigns a volume to be used for storage
within a specified storage pool.
DELETE SPACETRIGGER
Deletes the storage pool space trigger.
QUERY SPACETRIGGER
Displays information about a storage pool
space trigger.
UPDATE SPACETRIGGER
Changes attributes of storage pool space
trigger.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STATUSTHRESHOLD
|
|
DEFINE STATUSTHRESHOLD (Define a status monitoring
threshold)
|
Use this command to define a new status monitoring threshold.
|
|
Status monitoring thresholds compare the defined conditions to the status
monitoring server queries and inserts the results in the status monitoring table.
|
|
|
|
Multiple thresholds can be defined for an activity. For example, you can create a
threshold that provides a warning status if storage pool capacity utilization is
greater than 80%. You can then create another threshold that provides error status
if storage pool capacity utilization is greater than 90%.
|
|
Note: If a threshold is already defined for an EXISTS condition, you cannot define
another threshold with one of the other condition types.
|
Privilege class
|
To issue this command, you must have system privilege.
|
Syntax
|
|
DEFine STAtusthreshold threshold_name activity
|
|
Condition =
EXists
Condition =
|
|
STatus =
EXists
GT
GE
LT
LE
EQual
Value =
value
Normal
STatus =
Normal
Warning
Error
|
|
Parameters
|
|
threshold_name (Required)
Specifies the threshold name. The name cannot exceed 48 characters in length.
|
|
|
activity (Required)
Specifies the activity for which you want to create status indicators. Specify
one of the following values:
|
|
PROCESSSUMMARY
Specifies the number of processes that are currently active.
|
|
SESSIONSUMMARY
Specifies the number of sessions that are currently active.
|
|
CLIENTSESSIONSUMMARY
Specifies the number of client sessions that are currently active.
Chapter 2. Administrative commands
323
DEFINE STATUSTHRESHOLD
|
|
SCHEDCLIENTSESSIONSUMMARY
Specifies the number of scheduled client sessions.
|
|
|
DBUTIL
Specifies the database utilization percentage. The default warning threshold
value is 80%, and the default error threshold value is 90%.
|
|
DBFREESPACE
Specifies the free space available in the database in gigabytes.
|
|
DBUSEDSPACE
Specifies the amount of database space that is used, in gigabytes.
|
|
ARCHIVELOGFREESPACE
Specifies the free space that is available in the archive log, in gigabytes.
|
|
|
STGPOOLUTIL
Specifies the storage pool utilization percentage. The default warning
threshold value is 80%, and the default error threshold value is 90%.
|
|
STGPOOLCAPACITY
Specifies the storage pool capacity in gigabytes.
|
|
|
|
AVGSTGPOOLUTIL
Specifies the average storage pool utilization percentage across all storage
pools. The default warning threshold value is 80%, and the default error
threshold value is 90%.
|
|
|
TOTSTGPOOLCAPACITY
Specifies the total storage pool capacity in gigabytes for all available
storage pools.
|
|
TOTSTGPOOLS
Specifies the number of defined storage pools.
|
|
|
TOTRWSTGPOOLS
Specifies the number of defined storage pools that are readable or
writeable.
|
|
|
TOTNOTRWSTGPOOLS
Specifies the number of defined storage pools that are not readable or
writeable.
|
|
STGPOOLINUSEANDDEFINED
Specifies the total number of defined volumes that are in use.
|
|
|
|
ACTIVELOGUTIL
Specifies the current percent utilization of the active log. The default
warning threshold value is 80%, and the default error threshold value is
90%.
|
|
|
ARCHLOGUTIL
Specifies the current utilization of the archive log. The default warning
threshold value is 80%, and the default error threshold value is 90%.
|
|
|
|
CPYSTGPOOLUTIL
Specifies the percent utilization for a copy storage pool. The default
warning threshold value is 80%, and the default error threshold value is
90%.
|
|
|
|
PMRYSTGPOOLUTIL
Specifies the percent utilization for a primary storage pool. The default
warning threshold value is 80%, and the default error threshold value is
90%.
324
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STATUSTHRESHOLD
|
|
|
|
DEVCLASSPCTDRVOFFLINE
Specifies the percent utilization of drives that are offline, by device class.
The default warning threshold value is 25%, and the default error
threshold value is 50%.
|
|
|
DEVCLASSPCTDRVPOLLING
Specifies the drives polling, by device class. The default warning threshold
value is 25%, and the default error threshold value is 50%.
|
|
|
|
DEVCLASSPCTLIBPATHSOFFLINE
Specifies the library paths that are offline, by device class. The default
warning threshold value is 25%, and the default error threshold value is
50%.
|
|
|
|
DEVCLASSPCTPATHSOFFLINE
Specifies the percentage of device class paths that are offline, by device
class. The default warning threshold value is 25%, and the default error
threshold value is 50%.
|
|
|
|
DEVCLASSPCTDISKSNOTRW
Specifies the percentage of disks that are not writable for the disk device
class. The default warning threshold value is 25%, and the default error
threshold value is 50%.
|
|
|
|
DEVCLASSPCTDISKSUNAVAILABLE
Specifies the percentage of the disk volumes that are unavailable, by device
class. The default warning threshold value is 25%, and the default error
threshold value is 50%.
|
|
|
|
FILEDEVCLASSPCTSCRUNALLOCATABLE
Specifies the percentage of scratch volumes that the server cannot allocate
for a given non-shared file device class. The default warning threshold
value is 25%, and the default error threshold value is 50%.
|
|
|
|
Condition
Specifies the condition that is used to compare the activity output to the
specified value. The default value is EXISTS. Specify one of the following
values:
|
|
EXists
Creates a status monitoring indicator if the activity exists.
|
|
GT Creates a status monitoring indicator if the activity outcome is greater than
the specified value.
|
|
GE Creates a status monitoring indicator if the activity outcome is greater than
or equal to the specified value.
|
|
LT Creates a status monitoring indicator if the activity outcome is less than
the specified value.
|
|
LE Creates a status monitoring indicator if the activity outcome is less than or
equal to the specified value.
|
|
|
EQual
Creates a status monitoring indicator if the activity outcome is equal to the
specified value.
|
|
|
|
Value (Required)
Specifies the value to compare to the activity output of the specified condition.
VALUE must be specified unless CONDITION is set to EXISTS. You can
specify an integer from 0 to 9223372036854775807.
Chapter 2. Administrative commands
325
DEFINE STATUSTHRESHOLD
|
|
|
|
STatus
Specifies that the status indicator created in status monitoring if the condition
that is being evaluated passes. This optional parameter has a default value of
NORMAL. Specify one of the following values:
|
|
Normal
Specifies that the status indicator has a normal status value.
|
|
Warning
Specifies that the status indicator has a warning status value.
|
|
Error
Specifies that the status indicator has an error status value.
|
Define status threshold
|
|
|
|
Define a status threshold for average storage pool utilization percentage by issuing
the following command:
|
Related commands
|
Table 102. Commands related to DEFINE STATUSTHRESHOLD
|
Command
Description
|
|
“DELETE STATUSTHRESHOLD (Delete a
status monitoring threshold)” on page 437
Deletes a status monitoring threshold.
|
|
“QUERY MONITORSTATUS (Query the
monitoring status)” on page 787
Displays information about monitoring alerts
and server status settings.
|
|
|
“QUERY MONITORSETTINGS (Query the
configuration settings for monitoring alerts
and server status)” on page 784
Displays information about monitoring alerts
and server status settings.
|
|
“QUERY STATUSTHRESHOLD (Query status Displays information about a status
monitoring thresholds)” on page 902
monitoring thresholds.
|
|
“SET STATUSMONITOR (Specifies whether
to enable status monitoring)” on page 1131
Specifies whether to enable status
monitoring.
|
|
|
“SET STATUSATRISKINTERVAL (Specifies
whether to enable client at-risk activity
interval evaluation)” on page 1129
Specifies whether to enable client at-risk
activity interval evaluation.
|
|
|
“SET STATUSREFRESHINTERVAL (Set
refresh interval for status monitoring)” on
page 1133
Specifies the refresh interval for status
monitoring.
|
|
|
“SET STATUSSKIPASFAILURE (Specifies
whether to use client at-risk skipped files as
failure evaluation)” on page 1134
Specifies whether to use client at-risk
skipped files as failure evaluation.
|
|
|
|
“UPDATE STATUSTHRESHOLD (Update a
status monitoring threshold)” on page 1345
Changes the attributes of an existing status
monitoring threshold.
define statusthreshold avgstgpl "AVGSTGPOOLUTIL" value=85
condition=gt status=warning
326
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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.
Restriction: If a client is using the simultaneous-write function and data
deduplication, the data deduplication feature is disabled during backups to a
storage pool.
The DEFINE STGPOOL command takes four forms.
v “DEFINE STGPOOL (Define a primary storage pool assigned to random access
devices)” on page 329
v “DEFINE STGPOOL (Define a primary storage pool assigned to sequential
access devices)” on page 338
v “DEFINE STGPOOL (Define a copy storage pool assigned to sequential access
devices)” on page 356
v “DEFINE STGPOOL (Define an active-data pool assigned to sequential-access
devices)” on page 365
The syntax and parameters for each form are defined separately.
Table 103. Commands related to DEFINE STGPOOL
Command
Description
BACKUP DB
Backs up the 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.
Chapter 2. Administrative commands
327
DEFINE STGPOOL
Table 103. Commands related to DEFINE STGPOOL (continued)
328
Command
Description
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.
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
DEFINE STGPOOL (Define a primary storage pool assigned to
random access devices)
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
POoltype =
PRimary
POoltype =
PRimary
DISK
ACCess =
READWrite
DESCription =
ACCess =
description
READWrite
READOnly
UNAVailable
MAXSIze =
NOLimit
CRCData =
MAXSIze =
maximum_file_size
CRCData =
No
Yes
No
HIghmig =
90
HIghmig =
percent
NEXTstgpool =
pool_name
LOwmig =
70
CAChe =
LOwmig =
percent
CAChe =
No
MIGPRocess =
1
MIGPRocess =
number
Yes
No
MIGDelay =
0
MIGContinue =
MIGDelay =
days
MIGContinue =
AUTOCopy =
CLient
Yes
Yes
No
AUTOCopy =
None
CLient
MIGRation
All
,
COPYContinue =
COPYSTGpools =
Yes
copy_pool_name
COPYContinue =
Yes
No
Chapter 2. Administrative commands
329
DEFINE STGPOOL
,
ACTIVEDATApools =
SHRED =
active-data_pool_name
0
(1)
SHRED =
overwrite_count
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.
330
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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 GB. Scale factors are:
Scale factor
K
M
G
T
Meaning
kilobyte
megabyte
gigabyte
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.
Chapter 2. Administrative commands
331
DEFINE STGPOOL
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.
If you specify a sequential access pool as the NEXTSTGPOOL, the pool can
only be NATIVE or NONBLOCK dataformat.
HIghmig
Specifies that the server starts migration for this storage pool when the amount
of data in the pool reaches this percentage of the pool's 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 pool's 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 node's 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 Administrator's 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.
Tips:
v The number of migration processes is dependent upon the setting of the
MIGPROCESS parameter and the number of nodes or the number of
332
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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.
v When specifying this parameter, consider whether the simultaneous-write
function is enabled for server data migration. Each migration process
requires a mount point and a drive for each copy storage pool and
active-data pool defined to the target storage pool.
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. 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.
Chapter 2. Administrative commands
333
DEFINE STGPOOL
AUTOCopy
Specifies when Tivoli Storage Manager performs simultaneous-write
operations. The default value is CLIENT. This parameter is optional and affects
the following operations:
v Client store sessions
v Server import processes
v Server data-migration processes
If an error occurs while data is being simultaneously written to a copy storage
pool or active-data pool during a migration process, the server stops writing to
the failing storage pools for the remainder of the process. However, the server
continues to store files into the primary storage pool and any remaining copy
storage pools or active-data pools. These pools remain active for the duration
of the migration process. Copy storage pools are specified using the
COPYSTGPOOLS parameter. Active-data pools are specified using the
ACTIVEDATAPOOLS parameter.
Possible values are:
None
Specifies that the simultaneous-write function is disabled.
CLient
Specifies that data is written simultaneously to copy storage pools and
active-data pools during client store sessions or server import processes.
During server import processes, data is written simultaneously to only
copy storage pools. Data is not written to active-data pools during server
import processes.
MIGRation
Specifies that data is written simultaneously to copy storage pools and
active-data pools only during migration to this storage pool. During server
data-migration processes, data is written simultaneously to copy storage
pools and active-data pools only if the data does not exist in those pools.
Nodes whose data is being migrated must be in a domain associated with
an active-data pool. If the nodes are not in a domain associated with an
active pool, the data cannot be written to the pool.
All
Specifies that data is written simultaneously to copy storage pools and
active-data pools during client store sessions, server import processes, or
server data-migration processes. Specifying this value ensures that data is
written simultaneously whenever this pool is a target for any of the
eligible operations.
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. 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.
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
334
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
bound to the data. For details, refer to information about the
simultaneous-write function in the Administrator's Guide.
The server can write data simultaneously to copy storage pools during 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 Tivoli Storage Manager for Space Management
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
Restriction: The simultaneous-write function is not supported for the
following store operations:
v When the operation is using LAN-free data movement. Simultaneous-write
operations take precedence over LAN-free data movement, 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.
Possible values are:
Yes
If the COPYCONTINUE parameter 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 the simultaneous-write function in the Administrator's
Guide.
No If the COPYCONTINUE parameter is set to NO, the server will fail the current
transaction and discontinue the store operation.
Restrictions:
v The setting of the COPYCONTINUE parameter does not affect active-data pools.
If a write failure occurs for any of the active-data pools, the server stops
writing to the failing active-data pool for the remainder of the session, but
Chapter 2. Administrative commands
335
DEFINE STGPOOL
continues storing files into the primary pool and any remaining active-data
pools and copy storage pools. The active-data pool list is active only for the
life of the session and applies to all the primary storage pools in a particular
storage pool hierarchy.
v The setting of the COPYCONTINUE parameter does not affect the
simultaneous-write function during server import. If data is being written
simultaneously and a write failure occurs to the primary storage pool or any
copy storage pool, the server import process fails.
v The setting of the COPYCONTINUE parameter does not affect the
simultaneous-write function during server data migration. If data is being
written simultaneously and a write failure occurs to any copy storage pool
or active-data pool, the failing storage pool is removed and the data
migration process continues. Write failures to the primary storage pool cause
the migration process to fail.
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 the simultaneous-write
function in the Administrator's Guide.
The server can write data simultaneously to active-data pools only during
backup operations by Tivoli Storage Manager backup-archive clients or
application clients using the Tivoli Storage Manager API.
Restrictions:
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. Writing data simultaneously to active-data pools is not supported when
using LAN-free data movement. Simultaneous-write operations take
precedence over LAN-free data movement, causing the operations to go
over the LAN. However, the simultaneous-write configuration is honored.
3. The simultaneous-write function 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.
336
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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.
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.
Example: Define a primary storage pool for a DISK device class
Define a primary storage pool, POOL1, to use the DISK device class, with caching
enabled. Limit the maximum file size to 5 MB. Store any files larger than 5 MB 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.
define stgpool pool1 disk
description="main disk storage pool" maxsize=5m
highmig=70 lowmig=30 cache=yes
nextstgpool=prog2
Chapter 2. Administrative commands
337
DEFINE STGPOOL
DEFINE STGPOOL (Define a primary storage pool assigned to
sequential access devices)
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
POoltype =
PRimary
POoltype =
PRimary
DEFine STGpool pool_name device_class_name
ACCess =
READWrite
DESCription =
MAXSIze =
ACCess =
description
NOLimit
READWrite
READOnly
UNAVailable
CRCData =
No
(1) (2)
MAXSIze =
CRCData =
Yes
maximum_file_size
(1)
No
HIghmig =
90
(1) (2)
(1) (2)
NEXTstgpool =
LOwmig =
HIghmig =
pool_name
70
REClaim =
percent
60
(1) (2)
LOwmig =
(1) (2)
percent
RECLAIMPRocess =
REClaim =
percent
1
(1) (2)
RECLAIMPRocess =
number
(1) (2)
RECLAIMSTGpool =
RECLAMATIONType =
pool_name
THRESHold
(1) (2) (3)
RECLAMATIONType =
338
THRESHold
SNAPlock
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
COLlocate =
GRoup
(2)
MAXSCRatch =
number
(2)
COLlocate =
No
GRoup
NODe
FIlespace
REUsedelay =
0
(2)
REUsedelay =
MIGDelay =
(1) (2)
days
OVFLOcation =
0
location
MIGContinue =
Yes
(1) (2)
MIGDelay =
(1) (2)
days
MIGPRocess =
MIGContinue =
No
Yes
1
(1) (2)
MIGPRocess =
number
DATAFormat =
NATive
AUTOCopy =
CLient
(2) (4)
DATAFormat =
AUTOCopy =
NATive
NONblock
NETAPPDump
CELERRADump
NDMPDump
None
CLient
MIGRation
All
,
(1) (2)
COPYSTGpools =
copy_pool_name
COPYContinue =
Yes
(1) (2)
COPYContinue =
Yes
No
,
active-data_pool_name
ACTIVEDATApools =
DEDUPlicate =
No
IDENTIFYPRocess =
1
DEDUPlicate =
No
(6)
(5)
IDENTIFYPRocess =
number
Yes
Notes:
1
This parameter is not available for storage pools that use the data formats
NETAPPDUMP, CELERRADUMP, or NDMPDUMP.
Chapter 2. Administrative commands
339
DEFINE STGPOOL
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.
5
This parameter is valid only for storage pools that are defined with a
FILE-type device class.
6
This parameter is available only when the value of the DEDUPLICATE
parameter is YES.
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.
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.
340
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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
K
M
G
T
Meaning
kilobyte
megabyte
gigabyte
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.
Restriction: 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:
Chapter 2. Administrative commands
341
DEFINE STGPOOL
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.
Restriction: This parameter is not available for storage pools that use the
following data formats:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
Tip: For storage pools that are associated with the 3592, LTO, or
ECARTRIDGE device type, logical block protection provides better protection
against data corruption than CRC validation for a storage pool. If you specify
CRC validation for a storage pool, data is validated only during volume
auditing operations. Errors are identified after data is written to tape.
To enable logical block protection, specify a value of READWRITE for the
LBPROTECT parameter on the DEFINE DEVCLASS and UPDATE DEVCLASS commands
for the 3592, LTO, or ECARTRIDGE device types. Logical block protection is
supported only on the following types of drives and media:
v IBM LTO5 and later.
v IBM 3592 Generation 3 drives and later with 3592 Generation 2 media and
later.
v Oracle StorageTek T10000C drives.
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.
Restriction: This parameter is not available for storage pools that use the
following data formats:
v NETAPPDUMP
342
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
v CELERRADUMP
v NDMPDUMP
If you specify a sequential access pool as the NEXTSTGPOOL, the pool can
only be NATIVE or NONBLOCK dataformat.
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 pool's 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. 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.
Restriction: 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 pool's 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.
Restriction: 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. Reclaimable space is the amount of space
occupied by files that are expired or deleted from the Tivoli Storage Manager
database.
Reclamation makes the fragmented space on volumes usable again by moving
any remaining unexpired files from one volume to another volume, thus
Chapter 2. Administrative commands
343
DEFINE STGPOOL
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.
When determining which volumes in a storage pool to reclaim, the Tivoli
Storage Manager server first determines the reclamation threshold indicated by
the RECLAIM. The server then examines the percentage of reclaimable space for
each volume in the storage pool. If the percentage of reclaimable space on a
volume is greater that the reclamation threshold of the storage pool, the
volume is a candidate for reclamation.
For example, suppose storage pool FILEPOOL has a reclamation threshold of
70 percent. This value indicates that the server can reclaim any volume in the
storage pool that has a percentage of reclaimable space that is greater that 70
percent. The storage pool has three volumes:
v FILEVOL1 with 65 percent reclaimable space
v FILEVOL2 with 80 percent reclaimable space
v FILEVOL3 with 95 percent reclaimable space
When reclamation begins, the server compares the percent of reclaimable space
for each volume with the reclamation threshold of 70 percent. In this example,
FILEVOL2 and FILEVOL3 are candidates for reclamation because their
percentages of reclaimable space are greater than 70. To determine the
percentage of reclaimable space for a volume, issue the QUERY VOLUME
command and specify FORMAT=DETAILED. The value in the field Pct. Reclaimable
Space is the percentage of reclaimable space for the volume.
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.
Restriction: 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, IBM 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
344
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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 end. For information about specifying the
MOUNTWAIT time, see “DEFINE DEVCLASS (Define a device class)” on page
148.
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.
Restriction: 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.
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.
Restriction:
v 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:
Chapter 2. Administrative commands
345
DEFINE STGPOOL
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.
Restriction: 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
of server time needed to collocate files for storing and the number of volumes
required. For details, see the Administrator's 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 performs the
following actions:
346
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
v Collocates by group the data for grouped nodes only. Whenever
possible, the server collocates data that belongs 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.
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.
Tip: For server-to-server operations that use virtual volumes and that store a
small amount of data, consider specifying a value for the MAXSCRATCH
parameter that is higher than the value you typically specify for write
operations to other types of volumes. After a write operation to a virtual
volume, Tivoli Storage Manager marks the volume as FULL, even if the value
of the MAXCAPACITY parameter on the device-class definition has not been
reached. The Tivoli Storage Manager server does not keep virtual volumes in
FILLING status and does not append to them. If the value of the
MAXSCRATCH parameter is too low, server-to-server operations can fail.
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.
Chapter 2. Administrative commands
347
DEFINE STGPOOL
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
Administrator's 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.
Restriction: 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.
Restriction: 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.
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.
348
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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 end. For information about specifying the
MOUNTWAIT time, see “DEFINE DEVCLASS (Define a device class)” on page
148.
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.
Tip: When specifying this parameter, consider whether the simultaneous-write
function is enabled for server data migration. Each migration process requires
a mount point and a drive for each copy storage pool and active-data pool
defined to the target storage pool.
Restriction: This parameter is not available for storage pools that use the
following data formats:
v NETAPPDUMP
Chapter 2. Administrative commands
349
DEFINE STGPOOL
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 Tivoli Storage Manager server
format and includes block headers.
NONblock
Specifies the data format is the native Tivoli Storage Manager server
format and does not include block headers.
Important: 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 Tivoli Storage Manager for Space
Management or Tivoli Storage Manager HSM for Windows), 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 NetApp 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 NetApp 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 NetApp or EMC Celerra file server. The 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.
AUTOCopy
Specifies when Tivoli Storage Manager performs simultaneous-write
operations. The default value is CLIENT. This parameter is optional and affects
the following operations:
v Client store sessions
v Server import processes
350
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
v Server data-migration processes
If an error occurs while data is being simultaneously written to a copy storage
pool or active-data pool during a migration process, the server stops writing to
the failing storage pools for the remainder of the process. However, the server
continues to store files into the primary storage pool and any remaining copy
storage pools or active-data pools. These pools remain active for the duration
of the migration process. Copy storage pools are specified using the
COPYSTGPOOLS parameter. Active-data pools are specified using the
ACTIVEDATAPOOLS parameter.
Possible values are:
None
Specifies that the simultaneous-write function is disabled.
CLient
Specifies that data is written simultaneously to copy storage pools and
active-data pools during client store sessions or server import processes.
During server import processes, data is written simultaneously to only
copy storage pools. Data is not written to active-data pools during server
import processes.
MIGRation
Specifies that data is written simultaneously to copy storage pools and
active-data pools only during migration to this storage pool. During server
data-migration processes, data is written simultaneously to copy storage
pools and active-data pools only if the data does not exist in those pools.
Nodes whose data is being migrated must be in a domain associated with
an active-data pool. If the nodes are not in a domain associated with an
active pool, the data cannot be written to the pool.
All
Specifies that data is written simultaneously to copy storage pools and
active-data pools during client store sessions, server import processes, or
server data-migration processes. Specifying this value ensures that data is
written simultaneously whenever this pool is a target for any of the
eligible operations.
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 COPYSTGPOOLS
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 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 the
simultaneous-write function in the Administrator's Guide.
The server can write data simultaneously to copy storage pools during the
following operations:
Chapter 2. Administrative commands
351
DEFINE STGPOOL
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 Tivoli Storage Manager for Space Management
clients
v Import operations that involve copying exported file data from external
media to a storage pool defined with a copy storage pool list
Restrictions:
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. Writing data simultaneously to copy storage pools is not supported when
using LAN-free data movement. Simultaneous-write operations take
precedence over LAN-free data movement, causing the operations to go
over the LAN. However, the simultaneous-write configuration is honored.
3. The simultaneous-write function 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 value is YES. When specifying the
COPYCONTINUE parameter, you must also specify the COPYSTGPOOLS
parameter.
The COPYCONTINUE parameter has no effect on the simultaneous-write
function during migration.
Possible values are:
Yes
If the COPYCONTINUE parameter 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 the simultaneous-write function in the Administrator's
Guide.
352
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
No If the COPYCONTINUE parameter is set to NO, the server will fail the current
transaction and discontinue the store operation.
Restrictions:
v The setting of the COPYCONTINUE parameter does not affect active-data pools.
If a write failure occurs for any of the active-data pools, the server stops
writing to the failing active-data pool for the remainder of the session, but
continues storing files into the primary pool and any remaining active-data
pools and copy storage pools. The active-data pool list is active only for the
life of the session and applies to all the primary storage pools in a particular
storage pool hierarchy.
v The setting of the COPYCONTINUE parameter does not affect the
simultaneous-write function during server import. If data is being written
simultaneously and a write failure occurs to the primary storage pool or any
copy storage pool, the server import process fails.
v The setting of the COPYCONTINUE parameter does not affect the
simultaneous-write function during server data migration. If data is being
written simultaneously and a write failure occurs to any copy storage pool
or active-data pool, the failing storage pool is removed and the data
migration process continues. Write failures to the primary storage pool cause
the migration process to fail.
Restriction: 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 the simultaneous-write
function in the Administrator's Guide.
The server can write data simultaneously to active-data pools only during
backup operations by Tivoli Storage Manager backup-archive clients or
application clients using the Tivoli Storage Manager API.
Restrictions:
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
Chapter 2. Administrative commands
353
DEFINE STGPOOL
2. Write data simultaneously to active-data pools is not supported when using
LAN-free data movement. Simultaneous-write operations take precedence
over LAN-free data movement, causing the operations to go over the LAN.
However, the simultaneous-write configuration is honored.
3. The simultaneous-write function 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.
DEDUPlicate
Specifies whether the data that is stored in this storage pool will be
deduplicated. This parameter is optional and is valid only for storage pools
that are defined with a FILE-type device class. The default value is NO.
IDENTIFYPRocess
Specifies the number of parallel processes to use for server-side duplicate
identification. This parameter is optional and is valid only for storage pools
that are defined with a FILE device class. Enter a value from 0 to 20. The
default value is 1. If the value of the DEDUPLICATE parameter is NO, the
default setting for IDENTIFYPROCESS has no effect.
When calculating the value for this parameter, consider the workload on the
server and the amount of data requiring data deduplication. Server-side
duplicate identification requires disk I/O and processor resources, so the more
processes you allocate to data deduplication, the heavier the workload that you
place on your system. In addition, consider the number of volumes that
require processing. Server-side duplicate-identification processes work on
volumes containing data that requires deduplication. If you update a storage
pool, specifying that the data in the storage pool is to be deduplicated, all the
volumes in the pool require processing. For this reason, you might have to
define a high number of duplicate-identification processes initially. Over time,
however, as existing volumes are processed, only the volumes containing new
data have to be processed. When that happens, you can reduce the number of
duplicate-identification processes.
Remember: Duplicate-identification processes can be either active or idle.
Processes that are working on files are active. Processes that are waiting for
files to work on are idle. Processes remain idle until volumes with data to be
deduplicated become available. The output of the QUERY PROCESS command for
a duplicate-identification process includes the total number of bytes and files
that have been processed since the process first started. For example, if a
duplicate-identification process processes four files, becomes idle, and then
processes five more files, then the total number of files processed is nine.
Processes end only when canceled or when the number of
duplicate-identification processes for the storage pool is changed to a value less
than the number currently specified.
354
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
Example: Define a primary storage pool with an 8MMTAPE device
class
Define a primary storage pool named 8MMPOOL to the 8MMTAPE device class
(with a device type of 8MM) with a maximum file size of 5 MB. Store any files
larger than 5 MB in subordinate pools, beginning with POOL1. Enable collocation
of files for client nodes. Allow as many as 5 scratch volumes for this storage pool.
define stgpool 8mmpool 8mmtape maxsize=5m
nextstgpool=pool1 collocate=node
maxscratch=5
Chapter 2. Administrative commands
355
DEFINE STGPOOL
DEFINE STGPOOL (Define a copy storage pool assigned to
sequential access devices)
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 =
ACCess =
COpy
READWrite
DESCription =
COLlocate =
description
No
ACCess =
READWrite
READOnly
UNAVailable
REClaim =
100
REClaim =
percent
COLlocate =
No
GRoup
NODe
FIlespace
RECLAIMPRocess =
1
RECLAMATIONType =
RECLAIMPRocess =
number
THRESHold
(1)
RECLAMATIONType =
OFFSITERECLAIMLimit =
NOLimit
OFFSITERECLAIMLimit =
number
MAXSCRatch =
REUsedelay =
0
REUsedelay =
days
DATAFormat =
NATive
THRESHold
SNAPlock
number
OVFLOcation =
location
CRCData =
No
(2)
DATAFormat =
DEDUPlicate =
CRCData =
Yes
No
NATive
NONblock
NETAPPDump
CELERRADump
NDMPDump
No
IDENTIFYPRocess =
0
DEDUPlicate =
No
(4)
(3)
IDENTIFYPRocess =
number
Yes
Notes:
1
356
The RECLAMATIONTYPE=SNAPLOCK setting is valid only for storage
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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 that are defined with a FILE device class.
3
This parameter is valid only for storage pools that are defined with a FILE
device class.
4
This parameter is available only when the value of the DEDUPLICATE
parameter is YES.
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
Chapter 2. Administrative commands
357
DEFINE STGPOOL
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 Administrator's 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 performs the
following actions:
v Collocates by group the data for grouped nodes only. Whenever
possible, the server collocates data that belongs 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. Reclaimable space is the amount of space
occupied by files that are expired or deleted from the Tivoli Storage Manager
database.
Reclamation makes the fragmented space on volumes usable again by moving
any remaining unexpired files from one volume to another volume, thus
358
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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.
When determining which volumes in a storage pool to reclaim, the Tivoli
Storage Manager server first determines the reclamation threshold indicated by
the RECLAIM. The server then examines the percentage of reclaimable space for
each volume in the storage pool. If the percentage of reclaimable space on a
volume is greater that the reclamation threshold of the storage pool, the
volume is a candidate for reclamation.
For example, suppose storage pool FILEPOOL has a reclamation threshold of
70 percent. This value indicates that the server can reclaim any volume in the
storage pool that has a percentage of reclaimable space that is greater that 70
percent. The storage pool has three volumes:
v FILEVOL1 with 65 percent reclaimable space
v FILEVOL2 with 80 percent reclaimable space
v FILEVOL3 with 95 percent reclaimable space
When reclamation begins, the server compares the percent of reclaimable space
for each volume with the reclamation threshold of 70 percent. In this example,
FILEVOL2 and FILEVOL3 are candidates for reclamation because their
percentages of reclaimable space are greater than 70. To determine the
percentage of reclaimable space for a volume, issue the QUERY VOLUME
command and specify FORMAT=DETAILED. The value in the field Pct. Reclaimable
Space is the percentage of reclaimable space for the volume.
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
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, IBM 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
Chapter 2. Administrative commands
359
DEFINE STGPOOL
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 end. For information about specifying the
MOUNTWAIT time, see “DEFINE DEVCLASS (Define a device class)” on page
148.
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.
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.
360
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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.
Important: 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 items:
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.
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.
Tip: For server-to-server operations that use virtual volumes and that store a
small amount of data, consider specifying a value for the MAXSCRATCH
parameter that is higher than the value you typically specify for write
operations to other types of volumes. After a write operation to a virtual
volume, Tivoli Storage Manager marks the volume as FULL, even if the value
of the MAXCAPACITY parameter on the device-class definition has not been
Chapter 2. Administrative commands
361
DEFINE STGPOOL
reached. The Tivoli Storage Manager server does not keep virtual volumes in
FILLING status and does not append to them. If the value of the
MAXSCRATCH parameter is too low, server-to-server operations can fail.
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
Administrator's 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.
Important: 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 Tivoli Storage Manager for Space
Management or Tivoli Storage Manager HSM for Windows), 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 that the data is in a NetApp 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 NetApp 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
362
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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 NetApp
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.
Tip: For storage pools that are associated with the 3592, LTO, or
ECARTRIDGE device type, logical block protection provides better protection
against data corruption than CRC validation for a storage pool. If you specify
CRC validation for a storage pool, data is validated only during volume
auditing operations. Errors are identified after data is written to tape.
To enable logical block protection, specify a value of READWRITE for the
LBPROTECT parameter on the DEFINE DEVCLASS and UPDATE DEVCLASS commands
for the 3592, LTO, or ECARTRIDGE device types. Logical block protection is
supported only on the following types of drives and media:
v IBM LTO5 and later.
v IBM 3592 Generation 3 drives and later with 3592 Generation 2 media and
later.
v Oracle StorageTek T10000C drives.
DEDUPlicate
Specifies whether the data that is stored in this storage pool will be
deduplicated. This parameter is optional and is valid only for storage pools
that are defined with a FILE-type device class. The default value is NO.
IDENTIFYPRocess
Specifies the number of parallel processes to use for server-side duplicate
identification. This parameter is optional and is valid only for storage pools
that are defined with a FILE device class. Enter a value from 0 to 20.
Chapter 2. Administrative commands
363
DEFINE STGPOOL
The default value for this parameter is 0. Duplicate-identification processes for
a copy storage pool are not necessary if you specify duplicate-identification
processes for the primary storage pool. When Tivoli Storage Manager analyzes
a file in a storage pool, Tivoli Storage Manager also analyzes the file in all
other storage pools.
When calculating the value for this parameter, consider the workload on the
server and the amount of data requiring data deduplication. Server-side
duplicate identification requires disk I/O and processor resources, so the more
processes you allocate to data deduplication, the heavier the workload that you
place on your system. In addition, consider the number of volumes that
require processing. Server-side duplicate-identification processes work on
volumes containing data that requires deduplication. If you update a storage
pool, specifying that the data in the storage pool is to be deduplicated, all the
volumes in the pool require processing. For this reason, you might have to
define a high number of duplicate-identification processes initially. Over time,
however, as existing volumes are processed, only the volumes containing new
data have to be processed. When that happens, you can reduce the number of
duplicate-identification processes.
Remember: Duplicate-identification processes can be either active or idle.
Processes that are working on files are active. Processes that are waiting for
files to work on are idle. Processes remain idle until volumes with data to be
deduplicated become available. The output of the QUERY PROCESS command for
a duplicate-identification process includes the total number of bytes and files
that have been processed since the process first started. For example, if a
duplicate-identification process processes four files, becomes idle, and then
processes five more files, then the total number of files processed is nine.
Processes end only when canceled or when the number of
duplicate-identification processes for the storage pool is changed to a value less
than the number currently specified.
Example: Define a copy storage pool with a DC480 device class.
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.
define stgpool tapepool2 dc480 pooltype=copy
maxscratch=50 reusedelay=45
364
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
DEFINE STGPOOL (Define an active-data pool assigned to
sequential-access devices)
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 =
ACCess =
ACTIVEdata
READWrite
DESCription =
COLlocate =
description
No
ACCess =
READWrite
READOnly
UNAVailable
REClaim =
60
REClaim =
percent
COLlocate =
No
GRoup
NODe
FIlespace
RECLAIMPRocess =
1
RECLAMATIONType =
RECLAIMPRocess =
number
THRESHold
(1)
RECLAMATIONType =
OFFSITERECLAIMLimit =
NOLimit
OFFSITERECLAIMLimit =
number
MAXSCRatch =
REUsedelay =
0
REUsedelay =
days
DATAFormat =
NATive
THRESHold
SNAPlock
number
OVFLOcation =
location
CRCData =
No
DATAFormat =
DEDUPlicate =
NATive
NONblock
No
CRCData =
Yes
No
IDENTIFYPRocess =
0
DEDUPlicate =
No
(3)
(2)
IDENTIFYPRocess =
number
Yes
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.
Chapter 2. Administrative commands
365
DEFINE STGPOOL
2
This parameter is valid only for storage pools that are defined with a FILE
device class.
3
This parameter is available only when the value of the DEDUPLICATE
parameter is YES.
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
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 Administrator's Guide.
366
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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 performs the
following actions:
v Collocates by group the data for grouped nodes only. Whenever
possible, the server collocates data that belongs 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. Reclaimable space is the amount of space
occupied by files that are expired or deleted from the Tivoli Storage Manager
database.
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.
When determining which volumes in a storage pool to reclaim, the Tivoli
Storage Manager server first determines the reclamation threshold indicated by
the RECLAIM. The server then examines the percentage of reclaimable space for
Chapter 2. Administrative commands
367
DEFINE STGPOOL
each volume in the storage pool. If the percentage of reclaimable space on a
volume is greater that the reclamation threshold of the storage pool, the
volume is a candidate for reclamation.
For example, suppose storage pool FILEPOOL has a reclamation threshold of
70 percent. This value indicates that the server can reclaim any volume in the
storage pool that has a percentage of reclaimable space that is greater that 70
percent. The storage pool has three volumes:
v FILEVOL1 with 65 percent reclaimable space
v FILEVOL2 with 80 percent reclaimable space
v FILEVOL3 with 95 percent reclaimable space
When reclamation begins, the server compares the percent of reclaimable space
for each volume with the reclamation threshold of 70 percent. In this example,
FILEVOL2 and FILEVOL3 are candidates for reclamation because their
percentages of reclaimable space are greater than 70. To determine the
percentage of reclaimable space for a volume, issue the QUERY VOLUME
command and specify FORMAT=DETAILED. The value in the field Pct. Reclaimable
Space is the percentage of reclaimable space for the volume.
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.
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, IBM 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
368
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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 end. For information about specifying the
MOUNTWAIT time, see “DEFINE DEVCLASS (Define a device class)” on page
148.
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.
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.
Important: 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
Chapter 2. Administrative commands
369
DEFINE STGPOOL
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 items:
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.
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.
Tip: For server-to-server operations that use virtual volumes and that store a
small amount of data, consider specifying a value for the MAXSCRATCH
parameter that is higher than the value you typically specify for write
operations to other types of volumes. After a write operation to a virtual
volume, Tivoli Storage Manager marks the volume as FULL, even if the value
of the MAXCAPACITY parameter on the device-class definition has not been
reached. The Tivoli Storage Manager server does not keep virtual volumes in
FILLING status and does not append to them. If the value of the
MAXSCRATCH parameter is too low, server-to-server operations can fail.
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.
370
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
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
Administrator's 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.
Important: 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 Tivoli Storage Manager for Space
Management or Tivoli Storage Manager HSM for Windows), 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
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.
Tip: For storage pools that are associated with the 3592, LTO, or
ECARTRIDGE device type, logical block protection provides better protection
Chapter 2. Administrative commands
371
DEFINE STGPOOL
against data corruption than CRC validation for a storage pool. If you specify
CRC validation for a storage pool, data is validated only during volume
auditing operations. Errors are identified after data is written to tape.
To enable logical block protection, specify a value of READWRITE for the
LBPROTECT parameter on the DEFINE DEVCLASS and UPDATE DEVCLASS commands
for the 3592, LTO, or ECARTRIDGE device types. Logical block protection is
supported only on the following types of drives and media:
v IBM LTO5 and later.
v IBM 3592 Generation 3 drives and later with 3592 Generation 2 media and
later.
v Oracle StorageTek T10000C drives.
DEDUPlicate
Specifies whether the data that is stored in this storage pool will be
deduplicated. This parameter is optional and is valid only for storage pools
that are defined with a FILE device class. The default value is NO.
IDENTIFYPRocess
Specifies the number of parallel processes to use for server-side duplicate
identification. This parameter is optional and is valid only for storage pools
that are defined with a FILE device class. Enter a value from 0 to 20.
The default value for this parameter is 0. Duplicate-identification processes for
a copy storage pool are not necessary if you specify duplicate-identification
processes for the primary storage pool. When Tivoli Storage Manager analyzes
a file in a storage pool, Tivoli Storage Manager also analyzes the file in all
other storage pools.
When calculating the value for this parameter, consider the workload on the
server and the amount of data requiring data deduplication. Server-side
duplicate identification requires disk I/O and processor resources, so the more
processes you allocate to data deduplication, the heavier the workload that you
place on your system. In addition, consider the number of volumes that
require processing. Server-side duplicate-identification processes work on
volumes containing data that requires deduplication. If you update a storage
pool, specifying that the data in the storage pool is to be deduplicated, all the
volumes in the pool require processing. For this reason, you might have to
define a high number of duplicate-identification processes initially. Over time,
however, as existing volumes are processed, only the volumes containing new
data have to be processed. When that happens, you can reduce the number of
duplicate-identification processes.
Remember: Duplicate-identification processes can be either active or idle.
Processes that are working on files are active. Processes that are waiting for
files to work on are idle. Processes remain idle until volumes with data to be
deduplicated become available. The output of the QUERY PROCESS command for
a duplicate-identification process includes the total number of bytes and files
that have been processed since the process first started. For example, if a
duplicate-identification process processes four files, becomes idle, and then
processes five more files, then the total number of files processed is nine.
Processes end only when canceled or when the number of
duplicate-identification processes for the storage pool is changed to a value less
than the number currently specified.
372
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE STGPOOL
Example: Define an active-data pool with a DC500 device class
Define an active-data pool, TAPEPOOL2, to the DC500 device class. Allow up to 50
scratch volumes for this pool. Delay the reuse of volumes for 45 days.
define stgpool tapepool3 dc500 pooltype=activedata
maxscratch=50 reusedelay=45
Chapter 2. Administrative commands
373
DEFINE SUBSCRIPTION
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.
Restrictions:
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.
Example: Define a profile subscription
Subscribe a profile named BETA that resides on a configuration manager named
TOM.
define subscription beta server=tom
Related commands
Table 104. Commands related to DEFINE SUBSCRIPTION
374
Command
Description
COPY PROFILE
Creates a copy of a profile.
DEFINE PROFILE
Defines a profile for distributing information
to managed servers.
DELETE PROFILE
Deletes a profile from a configuration
manager.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE SUBSCRIPTION
Table 104. Commands related to DEFINE SUBSCRIPTION (continued)
Command
Description
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.
Chapter 2. Administrative commands
375
DEFINE VIRTUALFSMAPPING
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 issue this command, 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
NAMEType =
SERVER
file_system_name path
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. When selecting a virtual file space name, consider the following
restrictions:
v 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. 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.
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
376
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE VIRTUALFSMAPPING
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 verifies that a
name conflict does not occur prior to starting the operation.
v The virtual file space name appears 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. Therefore, 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.
Example: Define a virtual file space mapping
Define the virtual file space mapping name /mikeshomedir for the path /home/mike
on the file system /vol/vol1 on the NAS node named NAS1.
define virtualfsmapping nas1 /mikeshomedir /vol/vol1 /home/mike
Related commands
Table 105. 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.
Chapter 2. Administrative commands
377
DEFINE VOLUME
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. Alternatively, you can use space
triggers to create preassigned volumes when predetermined space-utilization
thresholds are exceeded. For details about space triggers, see “DEFINE
SPACETRIGGER (Define the space trigger)” on page 320. 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.
Attention: Volumes for the z/OS media server that are created using the DEFINE
VOLUME command remain physically full or allocated after Tivoli Storage Manager
empties the volume, for example, after expiration or reclamation. For FILE
volumes, the DASD space is not relinquished to the system when the volume is
emptied. If a storage pool requires an empty or filling volume, the FILE volume
can be used. In contrast, tape volumes that are logically empty are the same as
physically empty. FILE and tape volumes remain defined in Tivoli Storage
Manager. In contrast, SCRATCH volumes, including the physical storage allocated
for SCRATCH FILE volumes, are returned to the system when emptied.
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.
Alternatively, you can have the server create volumes that use storage-pool space
triggers.
Tivoli Storage Manager does not validate the existence of a volume name when
defining a volume in a storage pool that is associated with a library. The defined
volume has “0” EST capacity until data is written to the volume.
Attention: The size of a storage pool volume cannot be changed after 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
might not initialize correctly and data can 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.
Physical files that are allocated with DEFINE VOLUME command are not removed
from a file space if you issue the DELETE VOLUME command.
378
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE VOLUME
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
ACCess =
READWrite
DEFine Volume pool_name volume_name
ACCess =
READWrite
READOnly
UNAVailable
(1)
OFfsite
Formatsize =
Wait
=
Wait
=
No
megabytes
Numberofvolumes =
No
Yes
1
(2)
Numberofvolumes
(3)
=
number
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.
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.
Remember: Volume names cannot contain embedded blanks or equal signs,
except for DISK or FILE volumes.
See the following tables for volume name requirements:
v Table 106 on page 380: DISK
v Table 107 on page 380: FILE
v Table 108 on page 380: Tape
Chapter 2. Administrative commands
379
DEFINE VOLUME
v Table 109: Optical and WORM
v Table 110: REMOVABLEFILE
Table 106. Volume name requirements for DISK
Volume Name Requirements
Example
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.
"c:\program files\tivoli\tsm\server\data3.dsm"
If a name contains embedded blanks, equal signs, or other special
characters, enclose the list in quotation marks.
Table 107. Volume name requirements for FILE
Volume Name Requirements
Example
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.
"f:\data storage\fpool01.dsm"
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 261.
Table 108. Volume name requirements for tape
Volume Name Requirements
Example
Use 1 - 32 alphanumeric characters.
DSMT01
The volume name cannot contain any embedded blanks or equal
signs.
Table 109. Volume name requirements by OPTICAL or WORM
Volume Name Requirements
Example
Use 1 - 32 alphanumeric characters
DSM_SP001
The server converts volume names to uppercase.
Table 110. Volume name requirements for REMOVABLEFILE
Volume Name Requirements
Example
1–6 alphanumeric characters
DSM01
The server converts volume names to uppercase.
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.
380
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE VOLUME
UNAVailable
Specifies that client nodes or server processes cannot 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 off-site 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 off-site locations. The server
treats volumes designated as off-site differently:
v The server does not generate mount requests for volumes designated
off-site.
v The server reclaims or moves data from off-site volumes by retrieving
files from other storage pools.
v The server does not automatically delete empty, off-site 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. The maximum
size is 8 000 000 MB (8 terabytes). 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.
If you are allocating volumes on a z/OS media server, this parameter is not
valid.
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 you
specify 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 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.
Chapter 2. Administrative commands
381
DEFINE VOLUME
If you are allocating volumes on a z/OS media server, the only value that this
parameter supports is the default value of 1.
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 and tivolivol002. 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.
Important: You must ensure that storage agents can access newly created FILE
volumes. For more information, see “DEFINE PATH (Define a path)” on page
261.
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. The NO value is the default when you also specify a
format size.
Yes
Specifies that a volume creation and formatting operation is performed in
the foreground.
Remember: You cannot specify WAIT=YES from the server console.
Example: Use a background process to define a new 100 MB
volume for a disk storage pool
Create a 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.
define volume backuppool j:\storage\bf.dsm formatsize=100
Example: Define a volume to a disk storage pool with read and
write access
A storage pool named POOL1 is assigned to a tape device class. Define a volume
named TAPE01 to this storage pool, with READWRITE access.
define volume pool1 tape01 access=readwrite
Example: Define a volume to a file storage pool
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.
define volume filepool j:\storage\fp_vol01.dsm
Example: Example: Use a background process to define 10
volumes for a file storage pool with a device class 5 GB
maximum capacity
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 must occur in the
background.
382
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DEFINE VOLUME
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 111. 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.
UPDATE VOLUME
Updates the attributes of storage pool
volumes.
Chapter 2. Administrative commands
383
DELETE commands
DELETE commands
Use the DELETE commands to delete or remove a Tivoli Storage Manager object.
v “DELETE ASSOCIATION (Delete the node association to a schedule)” on page
387
v “DELETE ALERTTRIGGER (Remove a message from an alert trigger)” on page
386
v “DELETE BACKUPSET (Delete a backup set)” on page 389
v “DELETE CLIENTOPT (Delete an option in an option set)” on page 394
v “DELETE CLOPTSET (Delete a client option set)” on page 395
v “DELETE COLLOCGROUP (Delete a collocation group)” on page 396
v “DELETE COLLOCMEMBER (Delete collocation group member)” on page 397
v
v
v
v
v
v
v
v
v
v
v
v
v
“DELETE COPYGROUP (Delete a backup or archive copy group)” on page 399
“DELETE DATAMOVER (Delete a data mover)” on page 401
“DELETE DEVCLASS (Delete a device class)” on page 402
“DELETE DOMAIN (Delete a policy domain)” on page 403
“DELETE DRIVE (Delete a drive from a library)” on page 404
“DELETE EVENT (Delete event records)” on page 405
“DELETE EVENTSERVER (Delete the definition of the event server)” on page
407
“DELETE FILESPACE (Delete client node data from the server)” on page 408
“DELETE GRPMEMBER (Delete a server from a server group)” on page 412
“DELETE KEYRING (Delete password information in the key database)” on
page 413
“DELETE LIBRARY (Delete a library)” on page 414
“DELETE MACHINE (Delete machine information)” on page 415
“DELETE MACHNODEASSOCIATION (Delete association between a machine
and a node)” on page 416
v “DELETE MGMTCLASS (Delete a management class)” on page 417
v “DELETE NODEGROUP (Delete a node group)” on page 418
v “DELETE NODEGROUPMEMBER (Delete node group member)” on page 419
v “DELETE PATH (Delete a path)” on page 420
“DELETE POLICYSET (Delete a policy set)” on page 422
“DELETE PROFASSOCIATION (Delete a profile association)” on page 423
“DELETE PROFILE (Delete a profile)” on page 426
“DELETE RECMEDMACHASSOCIATION (Delete recovery media and machine
association)” on page 428
v “DELETE RECOVERYMEDIA (Delete recovery media)” on page 429
v “DELETE SCHEDULE (Delete a client or an administrative command schedule)”
on page 430
v
v
v
v
v “DELETE SCRIPT (Delete command lines from a script or delete the entire
script)” on page 433
v “DELETE SERVER (Delete a server definition)” on page 434
v “DELETE SERVERGROUP (Delete a server group)” on page 435
v “DELETE SPACETRIGGER (Delete the storage pool space triggers)” on page 436
v “DELETE STATUSTHRESHOLD (Delete a status monitoring threshold)” on page
437
384
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE commands
v “DELETE STGPOOL (Delete a storage pool)” on page 439
v “DELETE SUBSCRIBER (Delete subscriptions from a configuration manager
database)” on page 440
v “DELETE SUBSCRIPTION (Delete a profile subscription)” on page 441
v “DELETE VIRTUALFSMAPPING (Delete a virtual file space mapping)” on page
442
v “DELETE VOLHISTORY (Delete sequential volume history information)” on
page 443
v “DELETE VOLUME (Delete a storage pool volume)” on page 448
Chapter 2. Administrative commands
385
DELETE ALERTTRIGGER
|
DELETE ALERTTRIGGER (Remove a message from an alert
trigger)
|
Use this command to remove a message from the list of alert triggers.
|
Privilege class
|
To issue this command, you must have system privilege.
|
Syntax
|
|
,
DELete ALERTTrigger
+
message_number
|
|
Parameters
|
|
|
|
|
|
message_number (Required)
Specifies the message number that you want to remove from the list of alert
triggers. Specify multiple message numbers, which are separated by commas,
and no intervening spaces. Message numbers are a maximum of eight
characters in length. Wildcard characters can be used to specify message
numbers.
|
Delete alert trigger
|
|
|
Delete two message numbers that are designated as alerts, by issuing the following
command:
|
Related commands
|
Table 112. Commands related to DELETE ALERTTRIGGER
|
Command
Description
|
|
“DEFINE ALERTTRIGGER (Define an alert
trigger)” on page 112
Associates specified messages to an alert
trigger.
|
|
“QUERY ALERTSTATUS (Query the status of Displays information about alerts that have
an alert)” on page 663
been issued on the server.
|
|
“QUERY ALERTTRIGGER (Query the list of
defined alert triggers)” on page 661
Displays message numbers that trigger an
alert.
|
|
|
“QUERY MONITORSETTINGS (Query the
configuration settings for monitoring alerts
and server status)” on page 784
Displays information about monitoring alerts
and server status settings.
|
|
“UPDATE ALERTTRIGGER (Update a
defined alert trigger)” on page 1152
Updates the attributes of one or more alert
triggers.
|
|
|
|
“UPDATE ALERTSTATUS (Update the status Updates the status of a reported alert.
of an alert)” on page 1155
delete alerttrigger ANR1067E,ANR1073E
386
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE ASSOCIATION
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 issue this command, 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.
Example: Delete a node association to a schedule
To delete the association of the node JEFF, assigned to the DOMAIN1 policy
domain, to the WEEKLY_BACKUP schedule issue the following command:
delete association domain1 weekly_backup jeff
Example: Delete a node association to a schedule using a
wildcard for node selection
Delete the association of selected clients, assigned to the DOMAIN1 policy domain,
to the WEEKLY_BACKUP schedule so that this schedule is no longer run by these
clients. The nodes that are disassociated from the schedule contain ABC or XYZ in
the node name. Issue the command:
delete association domain1 weekly_backup *abc*,*xyz*
Chapter 2. Administrative commands
387
DELETE ASSOCIATION
Related commands
Table 113. Commands related to DELETE ASSOCIATION
388
Command
Description
DEFINE ASSOCIATION
Associates clients with a schedule.
QUERY ASSOCIATION
Displays the clients associated with one or
more schedules.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE BACKUPSET
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 client's backup set from the
server before it is scheduled to expire by using the DELETE BACKUPSET command.
Attention: 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 ,
backup_set_name
node_name
node_group_name
BEGINDate =
date
BEGINTime =
time
WHEREDATAType =
ENDDate =
date
ALL
ENDTime =
,
time
WHEREDATAType =
FILE
IMAGE
WHERERETention =
Preview =
days
NOLimit
WHEREDESCription =
description
No
Preview =
No
Yes
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
Chapter 2. Administrative commands
389
DELETE BACKUPSET
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 following values:
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.
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
To include files that were active a day
before the last day of the previous
month.
BOTM (Beginning The first day of the current
Of This Month)
month.
BOTM
BOTM+days
BOTM+9
The first day of the current
month, plus days specified.
To include files that were active on the
10th day of the current month.
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 following values:
390
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE BACKUPSET
Value
Description
Example
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.
You can specify the date by using one of the following values:
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.
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
BOTM (Beginning
Of This Month)
The first day of the current
month.
BOTM
BOTM+days
The first day of the current
month, plus days specified.
BOTM+9
To include files that were active a day
before the last day of the previous
month.
To include files that were active on the
10th day of the current month.
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 following values:
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.
Chapter 2. Administrative commands
391
DELETE BACKUPSET
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.
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.
Example: Delete a backup set
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".
delete backupset pers_data.3099
begindate=11/19/1998 begintime=10:30:05
wheredescription="documentation shop"
392
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE BACKUPSET
Related commands
Table 114. 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 client's data.
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.
Chapter 2. Administrative commands
393
DELETE CLIENTOPT (Delete an option in an option set)
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.
Example: Delete the date format option
Delete the date format option in an option set named ENG.
delete clientopt eng dateformat
Related commands
Table 115. Commands related to DELETE CLIENTOPT
394
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 in a client option set.
UPDATE CLOPTSET
Updates the description of a client option set.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE CLOPTSET
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.
Example: Delete a client option set
Delete the client option set named ENG.
delete cloptset eng
Related commands
Table 116. 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 in a client option set.
UPDATE CLOPTSET
Updates the description of a client option set.
Chapter 2. Administrative commands
395
DELETE COLLOCGROUP
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.
Example: Delete a collocation group
Delete a collocation group named group1.
delete collocgroup group1
Related commands
Table 117. Commands related to DELETE COLLOCGROUP
396
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 file spaces.
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.
UPDATE STGPOOL
Changes the attributes of a storage pool.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE COLLOCMEMBER
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.
Example: Delete collocation group member
Delete two nodes, NODE1 and NODE2, from a collocation group, GROUP1.
delete collocmember group1 node1,node2
Related commands
Table 118. 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 file spaces.
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.
Chapter 2. Administrative commands
397
DELETE COLLOCMEMBER
Table 118. Commands related to DELETE COLLOCMEMBER (continued)
398
Command
Description
UPDATE STGPOOL
Changes the attributes of a storage pool.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE COPYGROUP
DELETE COPYGROUP (Delete a backup or archive 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
STANDARD
DELete COpygroup domain_name policy_set_name class_name
STANDARD
Type
=
Type
=
Backup
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.
Chapter 2. Administrative commands
399
DELETE COPYGROUP
Example: Delete a backup copy group
Delete the backup copy group from the ACTIVEFILES management class that is in
the VACATION policy set of the EMPLOYEE_RECORDS policy domain.
delete copygroup employee_records
vacation activefiles
Example: Delete an archive copy group
Delete the archive copy group from the MCLASS1 management class that is in the
SUMMER policy set of the PROG1 policy domain.
delete copygroup prog1 summer mclass1 type=archive
Related commands
Table 119. Commands related to DELETE COPYGROUP
400
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE DATAMOVER
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.
Example: Delete a data mover
Delete the data mover for the node named NAS1.
delete datamover nas1
Related commands
Table 120. Commands related to DELETE DATAMOVER
Command
Description
DEFINE DATAMOVER
Defines a data mover to the 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.
Chapter 2. Administrative commands
401
DELETE DEVCLASS
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 that are assigned to
the device class and, if necessary, cancel any database 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.
Example: Delete a device class
Delete the device class named MYTAPE. There are no storage pools assigned to the
device class.
delete devclass mytape
Related commands
Table 121. Commands related to DELETE DEVCLASS
402
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE DOMAIN
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: Delete a policy domain
Delete the EMPLOYEE_RECORDS policy domain.
delete domain employee_records
Related commands
Table 122. 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.
Chapter 2. Administrative commands
403
DELETE DRIVE
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.
Example: Delete a drive from a library
Delete DRIVE3 from the library named AUTO.
delete drive auto drive3
Related commands
Table 123. Commands related to DELETE DRIVE
404
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.
PERFORM LIBACTION
Defines all drives and paths for a library.
QUERY DRIVE
Displays information about drives.
QUERY LIBRARY
Displays information about one or more
libraries.
UPDATE DRIVE
Changes the attributes of a drive.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE EVENT
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
00:00
TYPE
=
time
TYPE
=
Client
DELete EVent date
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 following values:
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.
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
BOTM
(Beginning Of
This Month)
The first day of the current
month.
BOTM
BOTM+days
The first day of the current
month, plus days specified.
BOTM+9
To include files that were active a day
before the last day of the previous
month.
To include files that were active on the
10th day of the current month.
Chapter 2. Administrative commands
405
DELETE EVENT
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 following values:
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 NOW+03:00 or +03:00
minutes specified
Attention: 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.
Example: Delete event records
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.
delete event 05/26/1998 08:00
Related commands
Table 124. Commands related to DELETE EVENT
406
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE EVENTSERVER
DELETE EVENTSERVER (Delete 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
Example: Delete an event server definition
Delete the definition for the event server ASTRO.
delete eventserver
Related commands
Table 125. 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.
Chapter 2. Administrative commands
407
DELETE FILESPACE
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, active-data, 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.
Important:
v 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.
v The server will not delete archive files that are on deletion hold until the hold is
released.
v 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
=
Type
=
ANY
DAta
=
DAta
=
ANY
Wait
=
Wait
=
ANY
Backup
ARchive
SPacemanaged
SERver
ANY
FIles
(1)
IMages
No
NAMEType =
SERVER
408
No
Yes
OWNer =
owner_name
IBM Tivoli Storage Manager for Windows: Administrator's Reference
NAMEType =
SERVER
UNIcode
FSID
DELETE FILESPACE
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 server's 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 a Tivoli
Storage Manager for Space Management 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 user's local file system by a Tivoli Storage
Manager for Space Management 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:
ANY
Delete files, directories, and images.
Chapter 2. Administrative commands
409
DELETE FILESPACE
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.
Restriction: 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
Solaris OS.
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 server's 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 server's 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:
410
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE FILESPACE
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.
Example: Delete a file space
Delete the file space named C_Drive that belongs to the client node HTANG.
delete filespace htang C_Drive
Example: Delete all space-managed files for a client node
Delete all files migrated from client node APOLLO (that is, all space-managed
files).
delete filespace apollo * type=spacemanaged
Related commands
Table 126. 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 file
spaces 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.
Chapter 2. Administrative commands
411
DELETE GRPMEMBER
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.
Example: Delete a server from a server group
Delete member PHOENIX from group WEST_COMPLEX.
delete grpmember west_complex phoenix
Related commands
Table 127. Commands related to DELETE GRPMEMBER
412
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE KEYRING
DELETE KEYRING (Delete password information in the key
database)
Use this command to delete the password information in the Tivoli Storage
Manager database for the key database (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 the cert.kdb file
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 Secure
Sockets Layer (SSL).
If the password information is lost after it was updated outside of the server, use
this command to delete the key database file information from the server database.
You can also delete cert.* files from the server instance directory. When the server
is restarted, it regenerates the cert.kdb file.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete KEYRing
Parameters
None
Example: Delete password information in the key database
The Tivoli Storage Manager administrator has deleted the current cert.kdb file and
wants Tivoli Storage Manager to generate a new one at server startup for use by
SSL.
delete keyring
Related commands
Table 128. Commands related to DELETE KEYRING
Command
Description
QUERY SSLKEYRINGPW
Displays the Secure Sockets Layer (SSL) key
database file password.
SET SSLKEYRINGPW
Sets or updates the key database file
password.
Chapter 2. Administrative commands
413
DELETE LIBRARY
DELETE LIBRARY (Delete a library)
Use this command to delete a library. Before you delete a library, you must delete
other associated objects, such as the path.
Use this command to delete a 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.
Example: Delete a manual library
Delete the manual library named LIBR1.
delete library libr1
Related commands
Table 129. Commands related to DELETE LIBRARY
414
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.
PERFORM LIBACTION
Defines all drives and paths for 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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE MACHINE
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
Type
=
Type
=
All
DELete MACHine machine_name
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.
Example: Delete a specific machine's information
Delete the machine characteristics associated with the DISTRICT5 machine.
delete machine district5 type=characteristics
Related commands
Table 130. Commands related to DELETE MACHINE
Command
Description
DEFINE MACHINE
Defines a machine for DRM.
INSERT MACHINE
Inserts machine characteristics or recovery
instructions into the 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.
Chapter 2. Administrative commands
415
DELETE MACHNODEASSOCIATION
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.
Example: Delete an association between a node and a machine
Delete the association between the DISTRICT5 machine and the
ACCOUNTSPAYABLE node.
delete machnodeassociation district5 accountspayable
Related commands
Table 131. Commands related to DELETE MACHNODEASSOCIATION
416
Command
Description
DEFINE MACHNODEASSOCIATION
Associates a Tivoli Storage Manager node
with a machine.
QUERY MACHINE
Displays information about machines.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE MGMTCLASS
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.
Example: Delete a management class
Delete the ACTIVEFILES management class from the VACATION policy set of the
EMPLOYEE_RECORDS policy domain.
delete mgmtclass employee_records
vacation activefiles
Related commands
Table 132. 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.
UPDATE MGMTCLASS
Changes the attributes of a management
class.
Chapter 2. Administrative commands
417
DELETE NODEGROUP
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.
Attention: 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.
Example: Delete a node group
Delete a node group named group1.
delete nodegroup group1
Related commands
Table 133. Commands related to DELETE NODEGROUP
418
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 client's 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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE NODEGROUPMEMBER
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.
Example: Delete node group members
Delete two nodes, node1 and node2, from a node group, group1.
delete nodegroupmember group1 node1,node2
Related commands
Table 134. 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 client's 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.
Chapter 2. Administrative commands
419
DELETE PATH
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 =
DESTType =
DRive LIBRary =
LIBRary
DATAMover
SERVer
library_name
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.
Example: Delete a NAS data mover path
Delete a path from a NAS data mover NAS1 to the library NASLIB.
delete path nas1 naslib srctype=datamover desttype=library
420
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE PATH
Related commands
Table 135. Commands related to DELETE PATH
Command
Description
DEFINE DATAMOVER
Defines a data mover to the Tivoli Storage
Manager server.
DEFINE PATH
Defines a path from a source to a destination.
PERFORM LIBACTION
Defines all drives and paths for a library.
QUERY PATH
Displays information about the path from a
source to a destination.
UPDATE PATH
Changes the attributes associated with a
path.
Chapter 2. Administrative commands
421
DELETE POLICYSET
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.
Example: Delete a policy set
Delete the VACATION policy set from the EMPLOYEE_RECORDS policy domain.
Command
delete policyset employee_records vacation
Related commands
Table 136. Commands related to DELETE POLICYSET
422
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE PROFASSOCIATION
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.
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 =
*
ADSCHeds =
,
*
,
domain_name
schedule_name
SCRipts =
*
,
script_name
CLOptsets =
*
,
option_set_name
SERVers =
*
SERVERGroups =
,
*
,
server_name
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.
Chapter 2. Administrative commands
423
DELETE PROFASSOCIATION
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:
424
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE PROFASSOCIATION
v A server definition is not deleted if
connection to another server.
v A server definition is not deleted if
the device type SERVER that refers
v A server definition is not deleted if
managed server.
the managed server has an open
the managed server has a device class of
to the other server.
the server is the event server for the
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.
Example: Delete the domain associations for a specific profile
Delete all domain associations from a profile named MIKE.
delete profassociation mike domains=*
Related commands
Table 137. 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.
Chapter 2. Administrative commands
425
DELETE PROFILE
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.
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
Force =
No
DELete PROFIle profile_name
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: Delete a profile
Delete a profile named BETA, even if one or more managed servers subscribe to it.
delete profile beta force=yes
Related commands
Table 138. Commands related to DELETE PROFILE
426
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE PROFILE
Table 138. Commands related to DELETE PROFILE (continued)
Command
Description
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.
Chapter 2. Administrative commands
427
DELETE RECMEDMACHASSOCIATION
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.
Example: Delete a machine's association with recovery media
Delete the association between the DIST5RM recovery media and the DISTRICT1
and DISTRICT5 machines.
delete recmedmachassociation
dist5rm district1,district5
Related commands
Table 139. Commands related to DELETE RECMEDMACHASSOCIATION
428
Command
Description
DEFINE RECMEDMACHASSOCIATION
Associates recovery media with a machine.
QUERY MACHINE
Displays information about machines.
QUERY RECOVERYMEDIA
Displays media available for machine
recovery.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE RECOVERYMEDIA
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.
Example: Delete a recovery media definition
Delete the DIST5RM recovery media.
delete recoverymedia dist5rm
Related commands
Table 140. 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.
Chapter 2. Administrative commands
429
DELETE SCHEDULE
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.
v “DELETE SCHEDULE (Delete an administrative schedule)” on page 432
v “DELETE SCHEDULE (Delete a client schedule)” on page 431
Table 141. Commands related to DELETE SCHEDULE
430
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE SCHEDULE
DELETE SCHEDULE (Delete a client schedule)
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
Type
=
Client
DELete SCHedule domain_name schedule_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 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.
Example: Delete a specific schedule from a specific policy domain
Delete the WEEKLY_BACKUP schedule, which belongs to the
EMPLOYEE_RECORDS policy domain.
delete schedule employee_records weekly_backup
Chapter 2. Administrative commands
431
DELETE SCHEDULE
DELETE SCHEDULE (Delete an administrative schedule)
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.
Example: Delete an administrative command schedule
Delete the administrative command scheduled named DATA_ENG.
delete schedule data_eng type=administrative
432
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE SCRIPT
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.
Example: Delete a specific line from a script
Using the following script named QSAMPLE and issue a command to delete line
005 from it.
001
005
010
/* This is a sample script */
QUERY STATUS
QUERY PROCESS
delete script qsample line=5
Related commands
Table 142. Commands related to DELETE SCRIPT
Command
Description
COPY SCRIPT
Creates a copy of a script.
DEFINE SCRIPT
Defines a script to the 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.
Chapter 2. Administrative commands
433
DELETE SERVER
DELETE SERVER (Delete a server definition)
Use this command to delete a server definition.
This command fails if the server:
v
v
v
v
Is defined as the event server.
Is named in a device class definition whose device type is SERVER.
Has an open connection to or from another server.
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.
Example: Delete a server's definition
Delete the definition for a server named SERVER2.
delete server server2
Related commands
Table 143. Commands related to DELETE SERVER
434
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE SERVERGROUP
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.
Example: Delete a server group
Delete a server group named WEST_COMPLEX.
delete servergroup west_complex
Related commands
Table 144. 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.
Chapter 2. Administrative commands
435
DELETE SPACETRIGGER
DELETE SPACETRIGGER (Delete the storage pool space
triggers)
Use this command to delete the definition of the storage pool space trigger.
Privilege class
To issue this command, you must have system privilege or unrestricted storage
privilege.
Syntax
DELete SPACETrigger STG
STGPOOL =
storage_pool_name
Parameters
STG
Specifies a storage pool space trigger.
STGPOOL
Specifies the storage pool trigger to be deleted. If STG is specified without
specifying STGPOOL, the default storage pool space trigger is the deletion
target.
Example: Delete a space trigger definition
Delete the space trigger definition for the WINPOOL1 storage pool.
delete spacetrigger stg stgpool=winpool1
Related commands
Table 145. Commands related to DELETE SPACETRIGGER
436
Command
Description
DEFINE SPACETRIGGER
Defines a space trigger to expand the space
for a storage pool.
QUERY SPACETRIGGER
Displays information about a storage pool
space trigger.
UPDATE SPACETRIGGER
Changes attributes of storage pool space
trigger.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE STATUSTHRESHOLD
|
|
DELETE STATUSTHRESHOLD (Delete a status monitoring
threshold)
|
Use this command to delete an existing status monitoring threshold.
|
|
Status monitoring thresholds compare the defined conditions to the status
monitoring server queries and inserts the results in the status monitoring table.
|
|
|
|
Multiple thresholds can be defined for an activity. For example, you can create a
threshold that provides a warning status if storage pool capacity utilization is
greater than 80%. You can then create another threshold that provides error status
if storage pool capacity utilization is greater than 90%.
|
|
Note: If a threshold is already defined for an EXISTS condition, you cannot define
another threshold with one of the other condition types.
|
Privilege class
|
To issue this command, you must have system privilege.
|
Syntax
|
|
DELete STAtusthreshold threshold_name
|
Parameters
|
|
threshold_name (Required)
Specifies the threshold name that you want to delete.
|
Delete an existing status threshold
|
|
Delete an existing status threshold by issuing the following command:
|
Related commands
|
Table 146. Commands related to DELETE STATUSTHRESHOLD
|
Command
Description
|
|
“DEFINE STATUSTHRESHOLD (Define a
status monitoring threshold)” on page 323
Defines a status monitoring threshold.
|
|
“QUERY MONITORSTATUS (Query the
monitoring status)” on page 787
Displays information about monitoring alerts
and server status settings.
|
|
|
“QUERY MONITORSETTINGS (Query the
configuration settings for monitoring alerts
and server status)” on page 784
Displays information about monitoring alerts
and server status settings.
|
|
“QUERY STATUSTHRESHOLD (Query status Displays information about a status
monitoring thresholds)” on page 902
monitoring thresholds.
|
|
“SET STATUSMONITOR (Specifies whether
to enable status monitoring)” on page 1131
Specifies whether to enable status
monitoring.
|
|
|
“SET STATUSREFRESHINTERVAL (Set
refresh interval for status monitoring)” on
page 1133
Specifies the refresh interval for status
monitoring.
delete statusthreshold avgstgpl
Chapter 2. Administrative commands
437
DELETE STATUSTHRESHOLD
|
Table 146. Commands related to DELETE STATUSTHRESHOLD (continued)
|
Command
Description
|
|
|
|
“UPDATE STATUSTHRESHOLD (Update a
status monitoring threshold)” on page 1345
Changes the attributes of an existing status
monitoring threshold.
438
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE STGPOOL
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.
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.
Important:
v 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.
v When deleting a copy storage pool that has been previously included in a
primary storage-pool definition (specifically in the COPYSTGPOOLS list), you
must remove the copy storage pool 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.
Example: Delete a storage pool
Delete the storage pool named POOLA.
delete stgpool poola
Related commands
Table 147. 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.
SET DRMCOPYSTGPOOL
Specifies that copy storage pools are
managed by DRM.
UPDATE STGPOOL
Changes the attributes of a storage pool.
Chapter 2. Administrative commands
439
DELETE SUBSCRIBER
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
manager's 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.
Example: Delete subscription entries for a specific managed
server
Delete all subscription entries for a managed server named DAN.
delete subscriber dan
Related commands
Table 148. Commands related to DELETE SUBSCRIBER
440
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE SUBSCRIPTION
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
DISCARDobjects =
No
DELete SUBSCRIPtion profile_name
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.
Example: Delete a profile subscription
Delete a subscription to a profile named ALPHA and its associated objects from a
managed server.
delete subscription alpha discardobjects=yes
Related commands
Table 149. 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.
Chapter 2. Administrative commands
441
DELETE VIRTUALFSMAPPING
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 issue this command, 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.
Example: Delete a virtual file space mapping
Delete the virtual file space mapping definition /mikeshomedir for the NAS node
named NAS1.
delete virtualfsmapping nas1 /mikeshomedir
Related commands
Table 150. Commands related to DELETE VIRTUALFSMAPPING
442
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE VOLHISTORY
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.
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.
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 Manager's 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.
Notes:
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.
Privilege class
To issue this command, you must have system privilege.
Syntax
DELete VOLHistory TODate =
TOTime =
23:59:59
TOTime =
time
date
Chapter 2. Administrative commands
443
DELETE VOLHISTORY
Type
=
All
DBBackup
DEVclass =
class_name
DBSnapshot
DEVclass =
class_name
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.
TODAY–30 or –30.
EOLM (End Of Last The last day of the previous
Month)
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
BOTM (Beginning
Of This Month)
The first day of the current
month.
BOTM
BOTM+days
The first day of the current
month, plus days specified.
BOTM+9
To delete records that are 30 or more
days old, you can specify TODAY-30
or simply -30.
To include files that were active a day
before the last day of the previous
month.
To include files that were active on
the 10th day of the current month.
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:
444
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE VOLHISTORY
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
NOW+HH:MM or
+HH:MM
The current time plus hours
and minutes on the specified
date
NOW+03:00 or +03:00.
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+03:00 or
TOTIME=+03:00, Tivoli Storage
Manager deletes records with a time
of 12:00 or earlier on the specified
date.
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.
Note: The DELETE VOLHISTORY command does not delete records of remote
volumes.
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
Chapter 2. Administrative commands
445
DELETE VOLHISTORY
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
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
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.
446
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE VOLHISTORY
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
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.
Example: Delete recovery plan file information
Delete all recovery plan file information created on or before 03/28/2005.
delete volhistory type=rpfile todate=03/28/2005
Related commands
Table 151. 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 on-site and off-site.
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.
Chapter 2. Administrative commands
447
DELETE VOLUME
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 you issue the DELETE VOLUME command, volume information is deleted from the
Tivoli Storage Manager database. However, the physical files that are allocated
with DEFINE VOLUME command are not removed from the file space.
If this command is applied to a WORM (write once, read many) volume, the
volume returns 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 remains private. To remove the volume
from the library, you must use the CHECKOUT LIBVOLUME command.
The DELETE VOLUME command automatically updates the server library inventory
for sequential volumes if the volume is 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 is
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 fails 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 is placed in the pending state
until shredding is run. Shredding is necessary to complete the deletion, even if the
volume is empty.
If you issue the DELETE VOLUME command for a volume in a storage pool that is set
up for data deduplication, the Tivoli Storage Manager destroys any object that is
referencing data on that volume.
448
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DELETE VOLUME
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
DISCARDdata =
No
DELete Volume volume_name
DISCARDdata =
Wait
=
Wait
=
No
Yes
No
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.
Remember:
1. The Tivoli Storage Manager server does not delete archive files that are
on deletion hold.
2. If archive retention protection is enabled, the Tivoli Storage Manager
server deletes 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.
If the volume being deleted is a copy storage pool volume, only files on
the copy pool volume are deleted. The primary storage pool files are not
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.
Chapter 2. Administrative commands
449
DELETE VOLUME
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
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.
Remember: You cannot specify WAIT=YES from the server console.
Example: Delete a storage pool volume
Delete storage pool volume stgvol.1 from the storage pool FILEPOOL.
delete volume stgvol.1
Related commands
Table 152. Commands related to DELETE VOLUME
450
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 on-site and off-site.
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DISABLE commands
DISABLE commands
Use DISABLE commands to prevent some types of operations by the server.
v “DISABLE EVENTS (Disable events for event logging)” on page 452
v “DISABLE REPLICATION (Prevent outbound replication processing on a
server)” on page 456
v “DISABLE SESSIONS (Prevent new sessions from accessing Tivoli Storage
Manager)” on page 457
Chapter 2. Administrative commands
451
DISABLE EVENTS
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.
Tip: 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.
Restriction:
v 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.
v Server messages from the server on which this command is issued cannot be
disabled for the activity log.
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 =
SERVername =
452
node_name
,
server_name
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DISABLE EVENTS
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
3500–3649
Data Protection for Lotus® Domino®
ACD
5200–5299
Chapter 2. Administrative commands
453
DISABLE EVENTS
Tivoli Storage Manager application client
Prefix
Range
Data Protection for Oracle
ANS
500–599
ANS
600–699
ACO
3000–3999
Data Protection for Informix
®
Data Protection for Microsoft SQL Server
Remember: 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.
Example: Disable specific categories of events
Disable all client events in the INFO and WARNING categories for the activity log
and console receivers for all nodes.
disable events actlog,console
info,warning nodename=*
Related commands
Table 153. Commands related to DISABLE EVENTS
454
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.
QUERY ENABLED
Displays enabled or disabled events for a
specific receiver.
QUERY EVENTRULES
Displays information about rules for server
and client events.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DISABLE EVENTS
Table 153. Commands related to DISABLE EVENTS (continued)
Command
Description
QUERY STATUS
Displays the settings of server parameters,
such as those selected by the SET commands.
Chapter 2. Administrative commands
455
DISABLE REPLICATION
DISABLE REPLICATION (Prevent outbound replication
processing on a server)
Use this command to prevent a source replication server from starting new
replication processes.
The use of this command does not stop running replication processes. Running
replication processes continue until they complete or until they end without
completing. Use this command and the ENABLE REPLICATION command to control
replication processing.
Issue this command on the server that acts as a source for replicated data.
Privilege class
To issue this command, you must have system privilege.
Syntax
DISAble REPLication
Parameters
None.
Example: Disable replication processing
Disable replication processing on a source replication server.
disable replication
Related commands
Table 154. Commands related to DISABLE REPLICATION
456
Command
Description
CANCEL REPLICATION
Cancels node replication processes.
DISABLE SESSIONS
Prevents new sessions from accessing Tivoli
Storage Manager but permits existing
sessions to continue.
ENABLE REPLICATION
Allows outbound replication processing on a
server.
ENABLE SESSIONS
Resumes server activity following the
DISABLE command or the ACCEPT DATE
command.
QUERY STATUS
Displays the settings of server parameters,
such as those selected by the SET commands.
REPLICATE NODE
Replicates data in file spaces that belong to a
client node.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DISABLE SESSIONS
DISABLE SESSIONS (Prevent new sessions from accessing
Tivoli Storage Manager)
Use this command to prevent new sessions from accessing Tivoli Storage Manager.
Active sessions will complete. For a particular server, you can specify whether to
disable inbound sessions, outbound sessions, or both.
Server processes, such as migration and reclamation, are not affected when you
issue the DISABLE SESSIONS command.
Privilege class
To issue this command, you must have system privilege or operator privilege.
Syntax
DISAble SESSions
CLIent
CLIent
ALL
ADMin
SERVer
DIRection =
Both
server_name
DIRection =
DIRection =
DIRection =
Both
INbound
OUTbound
Parameters
Specifies the type of session to be disabled. This parameter is optional. The default
value is CLIENT. You can specify one of the following values:
CLIent
Disables only backup and archive client sessions.
ALL
Disables all session types.
ADMin
Disables only administrative sessions.
SERVer
Disables only server-to-server sessions. Only the following types of sessions are
disabled:
v Server-to-server event logging
v Enterprise management
v
v
v
v
Server registration
LAN-free: storage agent - server
Virtual volumes
Node replication
You can also specify whether to disable inbound sessions, outbound sessions,
or both for a particular server.
Chapter 2. Administrative commands
457
DISABLE SESSIONS
server_name
Specifies the name of a server whose sessions you want to disable. This
parameter is optional. If you do not specify this parameter, new sessions
with other servers do not start. Running sessions are not canceled.
DIRection
Specifies whether to disable inbound sessions, outbound sessions, or
both. This parameter is optional. The default is BOTH. The following
values are possible:
Both
Specifies that inbound sessions from the specified server and
outbound sessions to the specified server are disabled.
INbound
Specifies that only inbound sessions from the specified server are
disabled.
OUTbound
Specifies that only outbound sessions to the specified server are
disabled.
Example: Prevent new client node backup and archive sessions
on the server
Temporarily prevent new client node sessions from accessing the server.
disable sessions
Example: Prevent all new sessions on the server
Temporarily prevent any new sessions from accessing the server.
disable sessions all
Example: Disable outbound sessions to a server
Disable outbound sessions to a server named REPLSRV.
disable sessions server replsrv direction=outbound
Related commands
Table 155. Commands related to DISABLE SESSIONS
458
Command
Description
CANCEL SESSION
Cancels active sessions with the server.
DISABLE REPLICATION
Prevents outbound replication processing on
a 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 Tivoli
Storage Manager.
QUERY STATUS
Displays the settings of server parameters,
such as those selected by the SET commands.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DISMOUNT commands
DISMOUNT command
Use the DISMOUNT command to dismount a volume by the real device address or by
volume name.
v “DISMOUNT VOLUME (Dismount a volume by volume name)” on page 460
Chapter 2. Administrative commands
459
DISMOUNT VOLUME
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.
Example: Dismount a specific volume
Dismount the volume BTV005.
dismount volume btv005
Related commands
Table 156. Command related to DISMOUNT VOLUME
460
Command
Description
QUERY MOUNT
Displays information about mounted
sequential access media.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
DISPLAY OBJNAME
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.objID]. 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.
Example: Display the full object name of a token ID in a message
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.
display obj 1.1.649498
Related commands
Table 157. Commands related to DISPLAY OBJNAME
Command
Description
QUERY CONTENT
Displays information about files in a storage
pool volume.
Chapter 2. Administrative commands
461
ENABLE commands
ENABLE commands
Use ENABLE commands to allow some types of operations by the server.
v “ENABLE EVENTS (Enable server or client events for logging)” on page 463
v “ENABLE REPLICATION (Allow outbound replication processing on a server)”
on page 466
v “ENABLE SESSIONS (Resume user activity on the server)” on page 467
462
IBM Tivoli Storage Manager for Windows: Administrator's Reference
ENABLE EVENTS
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.
Restriction: 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.
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 =
SERVername =
node_name
,
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.
Chapter 2. Administrative commands
463
ENABLE EVENTS
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
3500–3649
Data Protection for Lotus Domino
ACD
5200–5299
Data Protection for Oracle
ANS
500–599
Data Protection for Informix
ANS
600–699
Data Protection for Microsoft SQL Server
ACO
3000–3999
Restriction: The application client must have enhanced Tivoli Event
Console support enabled in order to route these messages to the Tivoli
Event Console.
Tip:
v Specifying the ALL option enables these messages. However, the INFO,
WARNING, ERROR, and SEVERE options have no effect on the
messages.
464
IBM Tivoli Storage Manager for Windows: Administrator's Reference
ENABLE EVENTS
v 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.
Example: Enable specific categories of events
Enable all ERROR and SEVERE client events to the USEREXIT receiver for the
node BONZO.
enable events userexit error,severe nodename=bonzo
Related commands
Table 158. 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.
Chapter 2. Administrative commands
465
ENABLE REPLICATION
ENABLE REPLICATION (Allow outbound replication
processing on a server)
Use this command to allow a source replication server to begin normal replication
processing after a database restore. You can also use this command to resume
replication processing after issuing the DISABLE REPLICATION command.
Attention: Before enabling replication after a database restore, determine whether
copies of data that are on the target server are needed. If they are, you must
synchronize client node data by replicating the data from the target replication
server to the source replication server. The replication process replaces the data on
the source server that was lost because of the database restore.
For details about this procedure, see the Administrator's Guide.
Issue this command on the server that acts as a source for replicated data.
Privilege class
To issue this command, you must have system privilege.
Syntax
ENable REPLication
Parameters
None.
Example: Allow replication processing
Allow replication processing on a source replication server.
enable replication
Related commands
Table 159. Commands related to ENABLE REPLICATION
466
Command
Description
DISABLE REPLICATION
Prevents outbound replication processing on
a server.
DISABLE SESSIONS
Prevents new sessions from accessing Tivoli
Storage Manager but permits existing
sessions to continue.
ENABLE SESSIONS
Resumes server activity following the
DISABLE command or the ACCEPT DATE
command.
QUERY STATUS
Displays the settings of server parameters,
such as those selected by the SET commands.
REPLICATE NODE
Replicates data in file spaces that belong to a
client node.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
ENABLE SESSIONS
ENABLE SESSIONS (Resume user activity on the server)
Use this command after issuing the DISABLE SESSIONS command to start new
sessions that can access a server. For a particular server, you can specify whether to
enable inbound sessions, outbound sessions, or both.
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
ADMin
SERVer
DIRection =
Both
server_name
DIRection =
DIRection =
DIRection =
Both
INbound
OUTbound
Parameters
Specifies the type of session to be enabled. This parameter is optional. The default
value is CLIENT. You can specify one of the following values:
CLIent
Enables only backup and archive client sessions.
ALL
Enables all session types.
ADMin
Enables only administrative sessions.
SERVer
Enables only server-to-server sessions. You can also specify whether to enable
inbound sessions, outbound sessions, or both for a particular server.
server_name
Specifies the name of a particular server whose sessions you want to
enable. This parameter is optional. If you do not specify this parameter,
new sessions with all other servers are enabled.
DIRection
Specifies whether to enable inbound sessions, outbound sessions, or
both. This parameter is optional. The default is BOTH. The following
values are possible:
Chapter 2. Administrative commands
467
ENABLE SESSIONS
Both
Specifies that inbound sessions from the specified server and
outbound sessions to the specified server are enabled.
INbound
Specifies that only inbound sessions to the specified server are
enabled.
OUTbound
Specifies that only outbound sessions from the specified server are
enabled.
Example: Resume client node activity on the server
Resume normal operation, permitting client nodes to access the server.
enable sessions
Example: Resume all activity on the server
Resume normal operation, permitting all sessions to access the server.
enable sessions all
Example: Enable outbound sessions to a server
Enable outbound sessions to a server named REPLSRV.
enable sessions server replsrv direction=outbound
Related commands
Table 160. Commands related to ENABLE SESSIONS
468
Command
Description
ACCEPT DATE
Accepts the current date on the server.
CANCEL SESSION
Cancels active sessions with the server.
ENABLE REPLICATION
Allows outbound replication processing on a
server.
DISABLE SESSIONS
Prevents new sessions from accessing Tivoli
Storage Manager but permits existing
sessions to continue.
QUERY SESSION
Displays information about all active
administrator and client sessions with Tivoli
Storage Manager.
QUERY STATUS
Displays the settings of server parameters,
such as those selected by the SET commands.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
END EVENTLOGGING
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.
Chapter 2. Administrative commands
469
END EVENTLOGGING
USEREXIT
Specifies a user-written routine to which Tivoli Storage Manager writes
information as a receiver.
Example: Stop logging events
End logging of events to the user exit.
end eventlogging userexit
Related commands
Table 161. Commands related to END EVENTLOGGING
470
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.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPIRE INVENTORY
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. Removal is based on policy specifications 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 by the following processes:
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, but this process can be
distributed among a maximum of 40 threads. 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 option to 0, the server does not run expiration
automatically, and you must issue the EXPIRE INVENTORY command to start
expiration processing.
This command creates a background process that can be canceled with the CANCEL
PROCESS command. To display information about background processes, use the
QUERY PROCESS command.
If this command is applied to a WORM volume, the volume returns to being a
scratch volume if it has remaining space in which data can be written. Data on
WORM volumes, including deleted and expired data, cannot be overwritten.
Therefore, data can be written only 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 remains private. To remove the volume from the library, you
must use the CHECKOUT LIBVOLUME command.
Run the EXPIRE INVENTORY command to delete files from server storage if they
were not completely deleted when you used client delete operations.
See the Backup-Archive Clients Installation and User's Guide for more information
about client delete operations.
Privilege class
To issue this command, you must have system privilege.
Syntax
Quiet =
No
Wait
=
Wait
=
No
EXPIre Inventory
Quiet =
No
Yes
No
Yes
Chapter 2. Administrative commands
471
EXPIRE INVENTORY
Node
=
Node
=
Type
=
Type
=
*
node_name
node_group_name
ALl
DOmain =
domain_name
REsource =
4
SKipdirs =
REsource =
number
SKipdirs =
No
ALl
Archive
Backup
Other
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 was
used to expire the files.
You can also specify the EXPQUIET option in the server options file to
automatically determine whether expiration processing is run 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.
Restriction: 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 expires files and directories based upon the
appropriate policy criteria.
472
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPIRE INVENTORY
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.
Attention: This option should not be used all of the time. With Tivoli
Storage Manager version 6.0 and later, you can run multiple threads
(resources) for an expiration process. Also, if you specify YES often, the
database grows as the directory objects accumulate, and the time spent for
expiration increases. Run SKIPDIRS=NO periodically to expire the
directories and reduce the size of the database.
Node
Specifies the name of the client nodes or node groups whose data is to be
processed. To specify multiple node and node group names, separate the
names with commas and no intervening spaces. Node names can contain
wildcard characters, but node group names cannot.
You can specify either NODE or DOMAIN. If you specify both, only those
nodes that match the criteria for both specified command options are
processed. If you do not specify either NODE or DOMAIN with a value, data
for all nodes is processed.
Domain
Specifies that only data for client nodes assigned to the specified domain is to
be processed. You can specify either NODE or DOMAIN. If you specify both,
only those nodes that match the criteria for both specified command options
are processed. If you do not specify either NODE or DOMAIN with a value,
data for all nodes is processed.
Type
Specifies the type of data to be processed. The default value is ALL. Possible
values are:
ALl
Process all types of data that are eligible for expiration
Archive
Process only client archive data
Backup
Process only client backup data
Other
Process only items for disaster recovery manager functions, such as
recovery plan files and obsolete database backups
REsource
Specifies the number of threads that can run in parallel. Specify a number from
one to 40. The default is 4.
Expiration runs as a single process, although the resources represent parallel
work by the server within the single expiration process. Archive data for a
node runs only on a single resource, but backup data can be spread across
resources on a file space level. For example, if you specify NODE=X,Y,Z each
with three file spaces and RESOURCE=5, then expiration processing for the three
X, Y, and Z client nodes run in parallel. At least one resource processes each
node, and at least one node uses multiple resources for processing backup data
across the multiple file spaces.
Chapter 2. Administrative commands
473
EXPIRE INVENTORY
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. If this parameter is not
specified, the duration of the expiration process is not limited by time.
Example: Run inventory expiration processing for a specific time
period
Run the expiration process for two hours.
expire inventory duration=120
Example: Run inventory expiration processing for backup data
for two client nodes
Run inventory expiration processing for the backup data for two client nodes,
CHARLIE and ROBBIE. Allow the server to run expiration processing until
completed.
expire inventory node=charlie,robbie resource=2 type=backup
Related commands
Table 162. Commands related to EXPIRE INVENTORY
474
Command
Description
AUDIT LICENSES
Verifies compliance with defined licenses.
CANCEL PROCESS
Cancels a background server process.
QUERY PROCESS
Displays information about background
processes.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT commands
EXPORT commands
Use the EXPORT commands to copy information from a Tivoli Storage Manager
server to sequential removable media.
Important: For commands that export administrators or nodes, you must consider
the method of authentication. The Tivoli Storage Manager server cannot export or
import passwords for nodes or administrators that are authenticating with LDAP
directory servers. If the current authentication method uses an LDAP directory
server and the password is not already synchronized by that server, you must
update the password. After issuing the EXPORT command, set the password by
issuing the UPDATE ADMIN or UPDATE NODE command.
v “EXPORT ADMIN (Export administrator information)” on page 476
v “EXPORT NODE (Export client node information)” on page 483
v “EXPORT POLICY (Export policy information)” on page 504
v “EXPORT SERVER (Export server information)” on page 511
Chapter 2. Administrative commands
475
EXPORT ADMIN
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.
Important: For commands that export administrators or nodes, you must consider
the method of authentication. The Tivoli Storage Manager server cannot export or
import passwords for nodes or administrators that are authenticating with LDAP
directory servers. If the current authentication method uses an LDAP directory
server and the password is not already synchronized by that server, you must
update the password. After issuing the EXPORT command, set the password by
issuing the UPDATE ADMIN or UPDATE NODE command.
Important:
v If target and source server levels are not compatible, the operation might not
work. See the Administrator's Guide for server compatibility requirements.
v You cannot use a CENTERA device class as the target medium for an export
command, or as the source medium for an import command.
Tivoli Storage Manager exports administrator information such as:
v Administrator name, password, and contact information
v Administrative privilege classes granted to the administrator
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 canceled with the
CANCEL PROCESS command. If you export information to sequential media and the
background process is canceled, 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 canceled, a partial import might result. Evaluate any
imported data on the target server to determine whether you want to keep or
delete the imported data. Review the import messages for details. To display
information about background processes, use the QUERY PROCESS command.
Limitation: The Tivoli Storage Manager server does not convert code pages during
export, import, and node replication operations. If servers are running in different
locales, some information in databases or system output might become unreadable.
Invalid characters might be displayed, for example, in the contact information for
the administrator and client nodes, and in descriptions of policy domains. Any
field that is stored in the server character set and that includes extended ASCII
characters can be affected. To resolve the issue, after the import or node replication
operation, update the fields with the appropriate UPDATE commands. This server
limitation does not affect client data. Any client data that was exported, imported,
or replicated can be restored, retrieved, and recalled.
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.
v “EXPORT ADMIN (Export administrator definitions to sequential media)” on
page 478
476
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT ADMIN
v “EXPORT ADMIN (Export administrator information directly to another server)”
on page 481
Table 163. Commands related to EXPORT ADMIN
Command
Description
CANCEL PROCESS
Cancels a background server process.
EXPORT NODE
Copies client node information to external
media or directly to another server.
EXPORT POLICY
Copies policy information to external media
or directly to another server.
EXPORT SERVER
Copies all or part of the server to external
media or directly to another server.
IMPORT ADMIN
Restores administrative information from
external media.
QUERY ACTLOG
Displays messages from the server activity
log.
QUERY PROCESS
Displays information about background
processes.
Chapter 2. Administrative commands
477
EXPORT ADMIN–to sequential media
EXPORT ADMIN (Export administrator definitions 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
*
Preview =
No
EXPort Admin
,
(1) (2)
Preview
=
admin_name
Scratch =
No
Yes
Yes
(2)
(1)
DEVclass
=
device_class_name
Scratch
=
Yes
No
,
(2)
VOLumenames
=
volume_name
FILE: file_name
ENCryptionstrength =
AES
USEDVolumelist =
file_name
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.
478
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT ADMIN–to sequential media
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. This parameter
is required if you specify PREVIEW=NO.
You cannot specify the DISK, NAS, or CENTERA device classes.
If all drives for the device class are busy when the export runs, Tivoli Storage
Manager cancels lower priority operations to make a drive available.
Tip: 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 Administrator's Guide.
Scratch
Specifies whether scratch volumes can be used. The default value is YES.
Possible 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 might 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.
Possible 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
1–32 alphanumeric characters.
REMOVABLEFILE
1–6 alphanumeric characters.
SERVER
1–250 alphanumeric characters.
Chapter 2. Administrative commands
479
EXPORT ADMIN–to sequential media
USEDVolumelist
Specifies the file where a list of volumes used in the export operation are
stored. This parameter is optional.
This file can be used in the import operation. This file contains comment lines
with the date and time the export was done, and the command issued to create
the export.
Attention:
If you specify an existing file, the file is overwritten.
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, specify
DES. Possible values are:
AES
Specifies the Advanced Encryption Standard.
DES
Specifies the Data Encryption Standard.
Example: Export administrator definitions to tape volumes
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. Issue the
command:
export admin devclass=menu1
volumenames=tape01,tape02,tape03
Example: Export administrator definitions to tape volumes listed in a
file
From the server, export the information for all defined administrators to tape
volumes that are listed in the following file:
TAPEVOL.DATA
This file contains the following lines:
TAPE01
TAPE02
TAPE03
Specify that these tape volumes be used by a device assigned to the MENU1
device class. Issue the command:
export admin devclass=menu1 volumenames=file:tapevol.data
The number and type of objects exported are reported to the system console and in
the activity log.
480
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT ADMIN–directly to another server
EXPORT ADMIN (Export administrator information 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
,
TOServer =
servername
admin_name
PREVIEWImport =
No
Replacedefs =
No
PREVIEWImport =
No
Yes
ENCryptionstrength =
Replacedefs =
No
Yes
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 is sent directly over the
network for immediate import.
Important: 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 is 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:
Chapter 2. Administrative commands
481
EXPORT ADMIN–directly to another server
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 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. This parameter is optional. The default value
is AES. If you are exporting to a server that does not support AES, specify
DES. Possible values are:
AES
Specifies the Advanced Encryption Standard.
DES
Specifies the Data Encryption Standard.
Example: Export administrator definitions to a target server
Export all the administrator definitions to the target server defined as
OTHERSERVER. Preview the import operations on the target server. Issue the
command:
export admin * toserver=otherserver previewimport=yes
From the target server, OTHERSERVER, you can view the import operations by
issuing the command:
query process
482
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT NODE
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.
Important: For commands that export administrators or nodes, you must consider
the method of authentication. The Tivoli Storage Manager server cannot export or
import passwords for nodes or administrators that are authenticating with LDAP
directory servers. If the current authentication method uses an LDAP directory
server and the password is not already synchronized by that server, you must
update the password. After issuing the EXPORT command, set the password by
issuing the UPDATE ADMIN or UPDATE NODE command.
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.
The following information is included in each client node definition:
v User ID, password, and contact information.
v Name of the client's 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 items:
v File space definitions.
v Backed-up, archived, and files that were migrated by a Tivoli Storage Manager
for Space Management client.
v Access authorization information pertaining to the file spaces exported.
v Archive data that is in deletion hold status (the hold status is preserved). When
the archive data is imported, it remains in deletion hold.
If you use an LDAP directory server to authenticate passwords, any servers that
you export to must be configured for LDAP passwords. Node data that is exported
from a node that authenticates with an LDAP directory server is inaccessible if the
target server is not properly configured. If your target server is not configured,
exported data from an LDAP node can still be exported. But the target server must
be configured to use LDAP, to access the data.
Limitation: The Tivoli Storage Manager server does not convert code pages during
export, import, and node replication operations. If servers are running in different
locales, some information in databases or system output might become unreadable.
Invalid characters might be displayed, for example, in the contact information for
the administrator and client nodes, and in descriptions of policy domains. Any
field that is stored in the server character set and that includes extended ASCII
characters can be affected. To resolve the issue, after the import or node replication
operation, update the fields with the appropriate UPDATE commands. This server
limitation does not affect client data. Any client data that was exported, imported,
or replicated can be restored, retrieved, and recalled.
The EXPORT NODE command generates a background process that can be
canceled with the CANCEL PROCESS command. If you are exporting node information
Chapter 2. Administrative commands
483
EXPORT NODE
to sequential media and the background process is canceled, the sequential media
that is holding the exported data are incomplete and should not be used for
importing data. If a server-to-server export background process is canceled, a
partial import might result. Evaluate any imported data on the target server to
determine whether you want to keep or delete the imported data. Review the
import messages for details. To display information about background processes,
issue the QUERY PROCESS command.
To display information about any running and suspended server-to-server export
operations, issue the QUERY EXPORT command. The QUERY EXPORT command displays
information only for exports that are, or can be, suspended. Export operations that
can be suspended, and then 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.
Restrictions:
v If target and source server levels are not compatible, the operation might not
work. See the Administrator's Guide for server compatibility requirements.
v You cannot use a CENTERA device class as the target medium for an export
command, or as the source medium for an import command.
Because of unpredictable results, do not run expiration, migration, backup, or
archive when issuing the EXPORT NODE command. See the Administrator's Guide for
more information.
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.
v “EXPORT NODE (Export node definitions or file data directly to another
server)” on page 495
v “EXPORT NODE (Export node definitions to sequential media)” on page 486
Table 164. Commands related to EXPORT NODE
484
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 or directly to another server.
EXPORT POLICY
Copies policy information to external media
or directly to another server.
EXPORT SERVER
Copies all or part of the server to external
media or directly to another server.
IMPORT NODE
Restores client node information from
external media.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT NODE
Table 164. Commands related to EXPORT NODE (continued)
Command
Description
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.
Chapter 2. Administrative commands
485
EXPORT NODE–to sequential media
EXPORT NODE (Export node definitions 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
file_space_name
FILESpace =
,
FSID
,
= file_space_ID
file_space_name
UNIFILESpace =
FILEData =
None
FILEData =
,
DOmains =
domain_name
Preview =
No
ALl
None
ARchive
Backup
BACKUPActive
ALLActive
SPacemanaged
(1) (2)
Preview
(1)
=
Scratch =
No
Yes
DEVclass
=
device_class_name
Yes
(2)
Scratch
,
=
Yes
No
(2)
VOLumenames
volume_name
FILE: file_name
USEDVolumelist =
file_name
FROMDate =
486
=
FROMTime =
00:00:00
FROMTime =
time
date
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT NODE–to sequential media
TODate =
TOTime =
23:59:59
TOTime =
time
date
ENCryptionstrength =
AES
ALLOWSHREDdable =
No
ENCryptionstrength =
AES
DES
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.
Restriction: 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 server's 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.
Chapter 2. Administrative commands
487
EXPORT NODE–to sequential media
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.
Note: If you are exporting a node that has group data, data that is not a part
of the target objects might be exported. An example of group data is virtual
machine data or system state backup data. For example, if
FILEDATA=BACKUPACTIVE when the FROMDATE or TODATE parameters
are specified, it is possible to include inactive backup data. The incremental
backup processing for the data can cause extra files that do not meet the
filtering criteria to be exported.
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.
Important: 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
files that were migrated by a Tivoli Storage Manager for Space
Management client.
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. These active backup
versions are the active versions in the Tivoli Storage Manager database at
the time that the EXPORT command is issued.
ALLActive
The server exports all active backup versions of files, all archived files, and
all files that were migrated by a Tivoli Storage Manager for Space
Management client. The active backup versions are the active versions in
the Tivoli Storage Manager database at the time that the EXPORT command
is issued.
SPacemanaged
The server exports only files that were migrated by a Tivoli Storage
Manager for Space Management client.
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:
488
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT NODE–to sequential media
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. This parameter
is required if you specify PREVIEW=NO.
You cannot specify the DISK, NAS, or CENTERA device classes.
If all drives for the device class are busy when the export runs, Tivoli Storage
Manager cancels lower priority operations to make a drive available.
Tip: 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 Administrator's Guide.
Scratch
Specifies whether scratch volumes can be used. The default value is YES.
Possible 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 might 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.
Possible 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
1–32 alphanumeric characters.
REMOVABLEFILE
1–6 alphanumeric characters.
Chapter 2. Administrative commands
489
EXPORT NODE–to sequential media
For this device
Specify
SERVER
1–250 alphanumeric characters.
USEDVolumelist
Specifies the file where a list of volumes used in the export operation are
stored. This parameter is optional.
This file can be used in the import operation. This file contains comment lines
with the date and time the export was done, and the command issued to create
the export.
Attention:
If you specify an existing file, the file is overwritten.
FROMDate
Specifies the earliest date for which files to be exported were stored on the
server. Files that were stored on the server earlier than the specified date are
not exported. This parameter only applies to client file data. This parameter
does not affect other information that might be exported, for example, policy.
Tivoli Storage Manager ignores the FROMDATE parameter when the
FILEDATA parameter is set to NONE.
Directory processing: The FROMDATE parameter does not apply to
directories. All directories in a file space are processed even if the directories
were not backed up in the specified date range.
Important: If group data is on the node that you are exporting, data that was
backed up before the designated FROMDATE and FROMTIME can be
exported. Group data on the node is, for example, virtual machine data or
system state backup data. This export is a result of incremental backup
processing for the data. The incremental backup processing can cause extra
files that do not meet the filtering criteria to be exported.
|
|
|
|
|
|
Use one of the following values to specify the date:
490
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
TODAY –3 or –3.
specified. The maximum
number of days you can specify
is 9999.
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
BOTM
(Beginning Of
This Month)
The first day of the current
month.
BOTM
BOTM+days
The first day of the current
month, plus days specified.
BOTM+9
IBM Tivoli Storage Manager for Windows: Administrator's Reference
To include files that were active a day
before the last day of the previous
month.
To include files that were active on the
10th day of the current month.
EXPORT NODE–to sequential media
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.
When a server-to-server export operation uses a relative FROMDATE, for
example, TODAY-1, and the operation is restarted at a later date, the restarted
process still uses the date that was used during the original operation. For
example, if a server-to-server export operation is started on 07/04/2009 and
the FROMDATE is specified as TODAY-1, the date that is used for selecting
files is 07/03/2009. If this same export operation is suspended and restarted
ten days later (07/14/2009), the date that is used for selecting files is still
07/03/2009. This behavior ensures that the entire export operation uses the
same cutoff date for selecting files to export.
TODate
Specifies the latest date for files to be exported from the server. Files 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.
v Tivoli Storage Manager ignores the TODATE parameter when the FILEDATA
parameter is set to NONE.
v 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.
v 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.
v The TODATE parameter does not apply to directories. All directories in a file
space are processed even if the directories were not backed up in the
specified date range.
Use one of the following values to specify the date:
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.
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
BOTM (Beginning
Of This Month)
The first day of the current
month.
BOTM
BOTM+days
The first day of the current
month, plus days specified.
BOTM+9
To include files that were active a day
before the last day of the previous
month.
To include files that were active on
the 10th day of the current month.
Chapter 2. Administrative commands
491
EXPORT NODE–to sequential media
When a server-to-server export operation uses a relative TODATE, for example,
TODAY-1, and the operation is restarted at a later date, the restarted process
still uses the date that was used during the original operation. For example, if
a server-to-server export operation is started on 07/04/2009 and the TODATE
is specified as TODAY-1, the date that is used for selecting files is 07/03/2009.
If this same export operation is suspended and restarted ten days later
(07/14/2009), the date that is used for selecting files is still 07/03/2009. This
behavior ensures that the entire export operation uses the same cutoff date for
selecting files to export.
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 does
not affect other information that might be exported, for example, policy.
Objects that were stored on the server before the specified time and date are
not exported. Tivoli Storage Manager ignores the FROMTIME parameter when
the FILEDATA parameter is set to NONE.
Important: If group data is on the node that you are exporting, data that was
backed up before the designated FROMDATE and FROMTIME can be
exported. Group data on the node is, for example, virtual machine data or
system state backup data. This export is a result of incremental backup
processing for the data. The incremental backup processing can cause extra
files that do not meet the filtering criteria to be exported.
|
|
|
|
|
|
The default value for this parameter when used with the FROMDATE
parameter is midnight (00:00:00).
Use one of the following values to specify the time:
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.
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
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.
If you issue this command at 5:00 with
FROMTIME=NOW–02: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.
492
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT NODE–to sequential media
The default value for this parameter, when used with the TODATE parameter,
is midnight minus one second (23:59:59).
Important: The value of the TOTIME and TODATE parameters must be later
than the FROMDATE and the FROMTIME value.
Use one of the following values to specify the time:
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.
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 07: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.
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, specify
DES. Possible values are:
AES
Specifies the Advanced Encryption Standard.
DES
Specifies the Data Encryption Standard.
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 data is not exported from a storage pool that enforces
shredding.
Yes
Specifies that data can be exported from a storage pool that enforces
shredding. The data on the export media will not be shredded.
Example: Export client node information to specific tape volumes
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.
export node devclass=menu1 volumenames=tape01,tape02,tape03
Chapter 2. Administrative commands
493
EXPORT NODE–to sequential media
Example: Export client node information using the FSID
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.
1. To determine the FSID, issue a QUERY FILESPACE command.
query filespace joe
Node Name Filespace
Name
FSID Platform Filespace
Is
Capacity
Type
Filespace
(MB)
Unicode?
--------- ---------- ---- ------- --------- --------- -------JOE
\\joe\c$
1 WinNT
NTFS
Yes
2,502.3
JOE
\\joe\d$
2 WinNT
NTFS
Yes
6,173.4
Pct
Util
---75.2
59.6
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
Example: Export client node information to tape volumes listed in a file
From the server, export client node information to tape volumes that are listed in
the following file:
TAPEVOL.DATA
The file contains the following lines:
TAPE01
TAPE02
TAPE03
Specify that the tape volumes be used by a device assigned to the MENU1 device
class. Issue the following command:
export node devclass=menu1 volumenames=file:tapevol.data
494
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT NODE— directly to another server
EXPORT NODE (Export node definitions or file data directly to
another server)
Use this command to export client node definitions or file data directly to another
server for immediate import.
Important: 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.
Important: An export operation is suspended when any of the following
conditions are 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
v
v
v
Communication errors on a server-to-server export
No available mount points
Necessary volumes are unavailable
I/O errors encountered
Issue the QUERY EXPORT command to display information on any running and
suspended export operations.
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
Chapter 2. Administrative commands
495
EXPORT NODE— directly to another server
FILEData =
None
DOmains =
FILEData =
domain_name
ALl
None
ARchive
Backup
BACKUPActive
ALLActive
SPacemanaged
FROMDate =
FROMTime =
00:00:00
FROMTime =
time
date
TODate =
TOTime =
23:59:59
TOTime =
time
date
EXPORTIDentifier =
PREVIEWImport =
export_identifier
No
TOServer =
MERGEfilespaces =
servername
No
PREVIEWImport =
Replacedefs =
No
Yes
MERGEfilespaces =
No
PROXynodeassoc =
No
Yes
No
Replacedefs =
No
Yes
ENCryptionstrength =
PROXynodeassoc =
AES
No
Yes
ALLOWSHREDdable =
No
ENCryptionstrength =
AES
DES
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.
Restriction: 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 of the
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.
496
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT NODE— directly to another server
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 server's 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.
Note: If you are exporting a node that has group data, data that is not a part
of the target objects might be exported. An example of group data is virtual
machine data or system state backup data. For example, if
FILEDATA=BACKUPACTIVE when the FROMDATE or TODATE parameters
are specified, it is possible to include inactive backup data. The incremental
backup processing for the data can cause extra files that do not meet the
filtering criteria to be exported.
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.
Important: 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
files migrated by a Tivoli Storage Manager for Space Management client.
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.
Chapter 2. Administrative commands
497
EXPORT NODE— directly to another server
BACKUPActive
The server exports only active backup versions. These active backup
versions are the active versions in the Tivoli Storage Manager database at
the time that the EXPORT command is issued.
ALLActive
The server exports all active backup versions of files, all archived files, and
all files that were migrated by a Tivoli Storage Manager for Space
Management client. The active backup versions are the active versions in
the Tivoli Storage Manager database at the time that the EXPORT command
is issued.
SPacemanaged
The server exports only files that were migrated by a Tivoli Storage
Manager for Space Management client.
FROMDate
Specifies the earliest date for which files to be exported were stored on the
server. Files that were stored on the server earlier than the specified date are
not exported. This parameter only applies to client file data. This parameter
does not affect other information that might be exported, for example, policy.
Tivoli Storage Manager ignores the FROMDATE parameter when the
FILEDATA parameter is set to NONE.
Directory processing: The FROMDATE parameter does not apply to
directories. All directories in a file space are processed even if the directories
were not backed up in the specified date range.
Important: If group data is on the node that you are exporting, data that was
backed up before the designated FROMDATE and FROMTIME can be
exported. Group data on the node is, for example, virtual machine data or
system state backup data. This export is a result of incremental backup
processing for the data. The incremental backup processing can cause extra
files that do not meet the filtering criteria to be exported.
|
|
|
|
|
|
Use one of the following values to specify the date:
Value
Description
Example
MM/DD/YYYY
A specific date
09/15/1998
TODAY
The current date
TODAY
TODAY-days or
-days
TODAY –3 or –3.
The current date minus days
specified. The maximum
number of days you can specify
is 9999.
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
The first day of the current
month.
BOTM
BOTM
(Beginning Of
This Month)
498
IBM Tivoli Storage Manager for Windows: Administrator's Reference
To include files that were active a day
before the last day of the previous
month.
EXPORT NODE— directly to another server
Value
Description
Example
BOTM+days
The first day of the current
month, plus days specified.
BOTM+9
To include files that were active on the
10th day of the current month.
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.
When a server-to-server export operation uses a relative FROMDATE, for
example, TODAY-1, and the operation is restarted at a later date, the restarted
process still uses the date that was used during the original operation. For
example, if a server-to-server export operation is started on 07/04/2009 and
the FROMDATE is specified as TODAY-1, the date that is used for selecting
files is 07/03/2009. If this same export operation is suspended and restarted
ten days later (07/14/2009), the date that is used for selecting files is still
07/03/2009. This behavior ensures that the entire export operation uses the
same cutoff date for selecting files to export.
TODate
Specifies the latest date for files to be exported from the server. Files 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.
v Tivoli Storage Manager ignores the TODATE parameter when the FILEDATA
parameter is set to NONE.
v 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.
v 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.
v The TODATE parameter does not apply to directories. All directories in a file
space are processed even if the directories were not backed up in the
specified date range.
Use one of the following values to specify the date:
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.
EOLM (End Of
Last Month)
The last day of the previous
month.
EOLM
EOLM-days
The last day of the previous
month minus days specified.
EOLM-1
To include files that were active a day
before the last day of the previous
month.
Chapter 2. Administrative commands
499
EXPORT NODE— directly to another server
Value
Description
Example
BOTM (Beginning
Of This Month)
The first day of the current
month.
BOTM
BOTM+days
The first day of the current
month, plus days specified.
BOTM+9
To include files that were active on
the 10th day of the current month.
When a server-to-server export operation uses a relative TODATE, for example,
TODAY-1, and the operation is restarted at a later date, the restarted process
still uses the date that was used during the original operation. For example, if
a server-to-server export operation is started on 07/04/2009 and the TODATE
is specified as TODAY-1, the date that is used for selecting files is 07/03/2009.
If this same export operation is suspended and restarted ten days later
(07/14/2009), the date that is used for selecting files is still 07/03/2009. This
behavior ensures that the entire export operation uses the same cutoff date for
selecting files to export.
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 does
not affect other information that might be exported, for example, policy.
Objects that were stored on the server before the specified time and date are
not exported. Tivoli Storage Manager ignores the FROMTIME parameter when
the FILEDATA parameter is set to NONE.
Important: If group data is on the node that you are exporting, data that was
backed up before the designated FROMDATE and FROMTIME can be
exported. Group data on the node is, for example, virtual machine data or
system state backup data. This export is a result of incremental backup
processing for the data. The incremental backup processing can cause extra
files that do not meet the filtering criteria to be exported.
|
|
|
|
|
|
The default value for this parameter when used with the FROMDATE
parameter is midnight (00:00:00).
Use one of the following values to specify the time:
500
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.
NOW-HH:MM
or -HH:MM
The current time minus hours
and minutes specified
NOW–02:00 or –02:00.
IBM Tivoli Storage Manager for Windows: Administrator's Reference
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.
If you issue this command at 5:00 with
FROMTIME=NOW–02:00 or
FROMTIME=–2:00, the export includes
files that were put on the server after
3:00.
EXPORT NODE— directly to another server
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).
Important: The value of the TOTIME and TODATE parameters must be later
than the FROMDATE and the FROMTIME value.
Use one of the following values to specify the time:
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.
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 07: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 is sent directly over the
network for immediate import.
Important: 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 is 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.
Chapter 2. Administrative commands
501
EXPORT NODE— directly to another server
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.
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 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 exists.
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 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, specify
DES. Possible values are:
AES
Specifies the Advanced Encryption Standard.
DES
Specifies the Data Encryption Standard.
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 export data from a storage pool that
enforces shredding.
Yes
Specifies that the server does export from a storage pool that enforces
shredding. The data on the export media will not be shredded.
Restriction: After an export operation finishes 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
502
IBM Tivoli Storage Manager for Windows: Administrator's Reference
EXPORT NODE— directly to another server
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.
Restriction: You must specify the TOSERVER parameter if you are specifying the
EXPORTIDENTIFIER parameter.
EXPORTIDENTIFIER is ignored if FILEDATA=NONE.
Example: Export client node information and all client files
To export client node information and all client files for NODE1 directly to SERVERB,
issue the following command:
export node node1 filedata=all toserver=serverb
Example: Export client node information and all client files for a
specific date range
To export client node information and all client files for NODE1 directly to SERVERB
between February 1, 2009 and today.
export node node1 filedata=all toserver=serverb
fromdate=02/01/2009 todate=today
Example: Export client node information and all client files for a
specific date and time range
To export client node information and all client files for NODE1 directly to SERVERB
from 8:00 AM on February 1, 2009 until today at 8:00 AM, issue the following
command:
export node node1 filedata=all toserver=serverb
fromdate=02/01/2009 fromtime=0