Ibm tivoli storage manager for windows administrator's reference 6.2

Tivoli Storage Manager
®

for Windows
Version 6.2

Administrator's Reference

SC23-9779-02

Note:
Before using this information and the product it supports, read the information in “Notices” on page 1315.

| This edition applies to Version 6.2 of IBM Tivoli Storage Manager (product numbers 5608-E01, 5608-E02, 5608-E03,
| 5608-E07, 5608-E12)), and to all subsequent releases and modifications until otherwise indicated in new editions or
| technical newsletters. This edition replaces SC23-9779-01.
© Copyright IBM Corporation 1993, 2010.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.

Contents
Preface . . . . . . . . . . . . . . . xi Specifying descriptions in keyword parameters 14
Who should read this publication . . . . . . . xi Controlling command processing . . . . . . . 14
Publications . . . . . . . . . . . . . . xi Server command processing . . . . . . . . 14
Tivoli Storage Manager publications . . . . . xi Cancelling commands . . . . . . . . . . 15
Related hardware publications . . . . . . . xiii Performing tasks concurrently on multiple servers 16
Support information . . . . . . . . . . . xiii Routing commands to a single server. . . . . 16
| Getting technical training . . . . . . . . xiii Routing commands to multiple servers . . . . 16
Searching knowledge bases . . . . . . . . xiv Routing commands to a server group. . . . . 17
Contacting IBM Software Support . . . . . . xv Routing commands to server groups . . . . . 17
Conventions used in this publication . . . . . xvii Routing commands to two servers and a server
group . . . . . . . . . . . . . . . 17
New for IBM Tivoli Storage Manager Routing commands inside scripts . . . . . . 17
Privilege classes for commands . . . . . . . . 18
Version 6.2. . . . . . . . . . . . . xix Commands requiring system privilege . . . . 18
New for the server in Version 6.2 . . . . . . . xix Commands requiring policy privilege . . . . 21
| Client-side data deduplication . . . . . . . xix Commands requiring storage privilege . . . . 22
| Automatic backup-archive client deployment . . xx Commands requiring operator privilege . . . . 23
| Simultaneous-write operations during storage Commands any administrator can issue . . . . 24
| pool migration . . . . . . . . . . . . xx
| In-flight data encryption using SSL . . . . . xxi
New for the Tivoli Storage Manager reporting
Chapter 2. Administrative commands 27
and monitoring feature in version 6.2 . . . . xxi ACCEPT DATE (Accepts the current system date) 28
| SCSI passthru support for Windows. . . . . xxii ACTIVATE POLICYSET (Activate a new policy set) 29
| Concurrent read-and-write access to Centera ASSIGN DEFMGMTCLASS (Assign a default
| volumes . . . . . . . . . . . . . . xxii management class) . . . . . . . . . . . . 31
| The Tivoli Integrated Portal GUI . . . . . . xxii AUDIT commands . . . . . . . . . . . . 33
| The Administration Center not installable on AUDIT LIBRARY (Audit volume inventories in
| HP-UX . . . . . . . . . . . . . . xxiii an automated library) . . . . . . . . . . 34
| Sun StorageTek T10000B drive encryption . . xxiii AUDIT LICENSES (Audit server storage usage) 36
| MOVESIZETHRESH server option . . . . . xxiii AUDIT VOLUME (Verify database information
| CHECKTAPEPOS server option to validate for a storage pool volume) . . . . . . . . 37
| data position on tape . . . . . . . . . xxiii BACKUP commands . . . . . . . . . . . 43
BACKUP DB (Back up the database) . . . . . 44
BACKUP DEVCONFIG (Create backup copies of
Chapter 1. Administering the server device configuration information) . . . . . . 47
from the command-line interface . . . . 1 BACKUP NODE (Back up a NAS node) . . . . 49
Issuing commands from the administrative client . . 1 BACKUP STGPOOL (Back up primary storage
Starting and stopping the administrative client . . 2 pool to copy storage pool) . . . . . . . . 54
Monitoring server activities from the BACKUP VOLHISTORY (Save sequential volume
administrative client . . . . . . . . . . . 2 history information) . . . . . . . . . . 58
Monitoring removable-media mounts from the BEGIN EVENTLOGGING (Begin logging events) . . 60
administrative client . . . . . . . . . . . 2 CANCEL commands . . . . . . . . . . . 62
Processing commands one at a time from the CANCEL EXPIRATION (Cancel an expiration
administrative client . . . . . . . . . . . 3 process) . . . . . . . . . . . . . . 63
Processing a series of commands from the CANCEL EXPORT (Delete a suspended export
administrative client . . . . . . . . . . . 3 operation) . . . . . . . . . . . . . . 64
Formatting output from commands . . . . . . 4 CANCEL PROCESS (Cancel an administrative
Saving command output to a specified location . . 4 process) . . . . . . . . . . . . . . 65
Administrative client options . . . . . . . . 5 CANCEL REQUEST (Cancel one or more mount
Issuing commands from the Administration Center . 7 requests) . . . . . . . . . . . . . . 67
Issuing commands from the server console . . . . 7 CANCEL RESTORE (Cancel a restartable restore
Entering administrative commands . . . . . . . 8 session). . . . . . . . . . . . . . . 68
Reading syntax diagrams . . . . . . . . . 8 CANCEL SESSION (Cancel one or more client
Entering long commands . . . . . . . . . 11 sessions) . . . . . . . . . . . . . . 69
Naming Tivoli Storage Manager objects . . . . 12 CHECKIN LIBVOLUME (Check a storage volume
Using wildcard characters to specify object into a library). . . . . . . . . . . . . . 70
names . . . . . . . . . . . . . . . 13

© Copyright IBM Corp. 1993, 2010 iii

CHECKOUT LIBVOLUME (Check a storage volume DEFINE RECOVERYMEDIA (Define recovery
out of a library) . . . . . . . . . . . . . 78 media) . . . . . . . . . . . . . . 260
CLEAN DRIVE (Clean a drive) . . . . . . . . 84 DEFINE SCHEDULE (Define a client or an
COMMIT (Control committing of commands in a administrative command schedule) . . . . . 262
macro) . . . . . . . . . . . . . . . . 85 DEFINE SCRIPT (Define a Tivoli Storage
COPY commands . . . . . . . . . . . . 86 Manager script) . . . . . . . . . . . 285
COPY ACTIVEDATA (Copy active backup data DEFINE SERVER (Define a server for
from a primary storage pool to an active-data server-to-server communications). . . . . . 287
pool) . . . . . . . . . . . . . . . 87 DEFINE SERVERGROUP (Define a server
COPY CLOPTSET (Copy a client option set) . . 91 group). . . . . . . . . . . . . . . 292
COPY DOMAIN (Copy a policy domain) . . . 92 DEFINE SPACETRIGGER (Define the space
COPY MGMTCLASS (Copy a management class) 94 trigger) . . . . . . . . . . . . . . 293
COPY POLICYSET (Copy a policy set) . . . . 96 DEFINE STGPOOL (Define a storage pool) . . 296
COPY PROFILE (Copy a profile) . . . . . . 98 DEFINE SUBSCRIPTION (Define a profile
COPY SCHEDULE (Copy a client or an subscription) . . . . . . . . . . . . 339
administrative command schedule) . . . . . 100 DEFINE VIRTUALFSMAPPING (Define a
COPY SCRIPT (Copy a Tivoli Storage Manager virtual file space mapping) . . . . . . . . 341
script) . . . . . . . . . . . . . . . 104 DEFINE VOLUME (Define a volume in a
COPY SERVERGROUP (Copy a server group) 105 storage pool) . . . . . . . . . . . . 343
DEFINE commands . . . . . . . . . . . 106 DELETE commands . . . . . . . . . . . 349
DEFINE ASSOCIATION (Associate client nodes DELETE ASSOCIATION (Delete the node
with a schedule) . . . . . . . . . . . 107 association to a schedule) . . . . . . . . 351
DEFINE BACKUPSET (Define a backup set) . . 109 DELETE BACKUPSET (Delete a backup set) . . 353
DEFINE CLIENTACTION (Define a one-time DELETE CLIENTOPT (Delete an option in an
client action). . . . . . . . . . . . . 113 option set) . . . . . . . . . . . . . 357
DEFINE CLIENTOPT (Define an option to an DELETE CLOPTSET (Delete a client option set) 358
option set) . . . . . . . . . . . . . 119 DELETE COLLOCGROUP (Delete a collocation
DEFINE CLOPTSET (Define a client option set group). . . . . . . . . . . . . . . 359
name) . . . . . . . . . . . . . . . 122 DELETE COLLOCMEMBER (Delete collocation
DEFINE COLLOCGROUP (Define a collocation group member). . . . . . . . . . . . 360
group). . . . . . . . . . . . . . . 123 DELETE COPYGROUP (Delete a backup or
DEFINE COLLOCMEMBER (Define collocation archive copy group) . . . . . . . . . . 362
group member). . . . . . . . . . . . 125 DELETE DATAMOVER (Delete a data mover) 364
DEFINE COPYGROUP (Define a copy group) 127 DELETE DEVCLASS (Delete a device class) . . 365
DEFINE DATAMOVER (Define a data mover) 137 DELETE DOMAIN (Delete a policy domain) 366
DEFINE DEVCLASS (Define a device class) . . 140 DELETE DRIVE (Delete a drive from a library) 367
DEFINE DOMAIN (Define a new policy DELETE EVENT (Delete event records). . . . 368
domain) . . . . . . . . . . . . . . 213 DELETE EVENTSERVER (Delete the definition
DEFINE DRIVE (Define a drive to a library) . . 215 of the event server) . . . . . . . . . . 370
DEFINE EVENTSERVER (Define a server as the DELETE FILESPACE (Delete client node data
event server) . . . . . . . . . . . . 219 from the server) . . . . . . . . . . . 371
DEFINE GRPMEMBER (Add a server to a DELETE GRPMEMBER (Delete a server from a
server group) . . . . . . . . . . . . 220 server group) . . . . . . . . . . . . 375
DEFINE LIBRARY (Define a library). . . . . 221 DELETE KEYRING (Delete password
DEFINE MACHINE (Define machine information in the key database) . . . . . . 376
information for disaster recovery) . . . . . 231 DELETE LIBRARY (Delete a library). . . . . 377
DEFINE MACHNODEASSOCIATION DELETE MACHINE (Delete machine
(Associate a node with a machine) . . . . . 233 information) . . . . . . . . . . . . . 378
DEFINE MGMTCLASS (Define a management DELETE MACHNODEASSOCIATION (Delete
class) . . . . . . . . . . . . . . . 235 association between a machine and a node) . . 379
DEFINE NODEGROUP (Define a node group) 238 DELETE MGMTCLASS (Delete a management
DEFINE NODEGROUPMEMBER (Define node class) . . . . . . . . . . . . . . . 380
group member). . . . . . . . . . . . 239 DELETE NODEGROUP (Delete a node group) 381
DEFINE PATH (Define a path) . . . . . . 240 DELETE NODEGROUPMEMBER (Delete node
DEFINE POLICYSET (Define a policy set) . . . 248 group member). . . . . . . . . . . . 382
DEFINE PROFASSOCIATION (Define a profile DELETE PATH (Delete a path) . . . . . . 383
association) . . . . . . . . . . . . . 250 DELETE POLICYSET (Delete a policy set) . . . 385
DEFINE PROFILE (Define a profile) . . . . . 256 DELETE PROFASSOCIATION (Delete a profile
DEFINE RECMEDMACHASSOCIATION association) . . . . . . . . . . . . . 386
(Associate recovery media with a machine) . . 258 DELETE PROFILE (Delete a profile) . . . . . 389

iv IBM Tivoli Storage Manager for Windows: Administrator's Reference

DELETE RECMEDMACHASSOCIATION HALT (Shut down the server) . . . . . . . . 499
(Delete recovery media and machine HELP (Get help on commands and error messages) 501
association) . . . . . . . . . . . . . 391 IDENTIFY DUPLICATES (Identify duplicate data
DELETE RECOVERYMEDIA (Delete recovery in a storage pool) . . . . . . . . . . . . 503
media) . . . . . . . . . . . . . . 392 IMPORT commands . . . . . . . . . . . 507
DELETE SCHEDULE (Delete a client or an IMPORT ADMIN (Import administrator
administrative command schedule) . . . . . 393 information) . . . . . . . . . . . . . 508
DELETE SCRIPT (Delete command lines from a IMPORT NODE (Import client node
script or delete the entire script) . . . . . . 396 information) . . . . . . . . . . . . . 511
DELETE SERVER (Delete a server definition) 397 IMPORT POLICY (Import policy information) 517
DELETE SERVERGROUP (Delete a server IMPORT SERVER (Import server information) 520
group). . . . . . . . . . . . . . . 398 INSERT MACHINE (Insert machine characteristics
DELETE SPACETRIGGER (Delete the storage information or recovery instructions) . . . . . 525
pool space triggers) . . . . . . . . . . 399 ISSUE MESSAGE (Issue a message from a server
DELETE STGPOOL (Delete a storage pool) . . 400 script) . . . . . . . . . . . . . . . . 527
DELETE SUBSCRIBER (Delete subscriptions LABEL LIBVOLUME (Label a library volume) . . 529
from a configuration manager database) . . . 401 LOCK commands . . . . . . . . . . . . 535
DELETE SUBSCRIPTION (Delete a profile LOCK ADMIN (Lock out an administrator) . . 536
subscription) . . . . . . . . . . . . 402 LOCK NODE (Lock out a client node) . . . . 537
DELETE VIRTUALFSMAPPING (Delete a LOCK PROFILE (Lock a profile) . . . . . . 538
virtual file space mapping) . . . . . . . . 403 MACRO (Invoke a macro) . . . . . . . . . 540
DELETE VOLHISTORY (Delete sequential MIGRATE STGPOOL (Migrate storage pool to next
volume history information) . . . . . . . 404 storage pool) . . . . . . . . . . . . . 542
DELETE VOLUME (Delete a storage pool MOVE commands . . . . . . . . . . . . 545
volume) . . . . . . . . . . . . . . 409 MOVE DATA (Move files on a storage pool
DISABLE commands . . . . . . . . . . . 412 volume) . . . . . . . . . . . . . . 546
DISABLE EVENTS (Disable events for event MOVE DRMEDIA (Move disaster recovery
logging) . . . . . . . . . . . . . . 413 media offsite and back onsite) . . . . . . . 550
DISABLE SESSIONS (Temporarily prevent client MOVE GRPMEMBER (Move a server group
node access to the server) . . . . . . . . 417 member) . . . . . . . . . . . . . . 565
DISMOUNT command . . . . . . . . . . 419 MOVE MEDIA (Move sequential access storage
DISMOUNT VOLUME (Dismount a volume by pool media) . . . . . . . . . . . . . 566
volume name) . . . . . . . . . . . . 420 MOVE NODEDATA (Move data by node in a
DISPLAY OBJNAME (Display a full object name) 421 sequential access storage pool) . . . . . . 574
ENABLE commands . . . . . . . . . . . 422 NOTIFY SUBSCRIBERS (Notify managed servers
ENABLE EVENTS (Enable server or client to update profiles). . . . . . . . . . . . 583
events for logging) . . . . . . . . . . 423 PARALLEL (Run multiple commands in a script in
ENABLE SESSIONS (Resume user activity on parallel) . . . . . . . . . . . . . . . 584
the server) . . . . . . . . . . . . . 426 PING SERVER (Test the connection between
END EVENTLOGGING (Stop logging events) . . 428 servers) . . . . . . . . . . . . . . . 586
EXPIRE INVENTORY (Manually start inventory PREPARE (Create a recovery plan file) . . . . . 587
expiration processing) . . . . . . . . . . 430 QUERY commands . . . . . . . . . . . 593
EXPORT commands . . . . . . . . . . . 434 QUERY ACTLOG (Query the activity log) . . . 595
EXPORT ADMIN (Export administrator QUERY ADMIN (Display administrator
information) . . . . . . . . . . . . . 435 information) . . . . . . . . . . . . . 600
EXPORT NODE (Export client node QUERY ASSOCIATION (Query client node
information) . . . . . . . . . . . . . 441 associations with a schedule) . . . . . . . 604
EXPORT POLICY (Export policy information) 459 QUERY AUDITOCCUPANCY (Query client
EXPORT SERVER (Export server information) 465 node storage utilization). . . . . . . . . 606
EXTEND DBSPACE (Increase space for the QUERY BACKUPSET (Query a backup set) . . 609
database) . . . . . . . . . . . . . . . 481 QUERY BACKUPSETCONTENTS (Query
GENERATE commands . . . . . . . . . . 482 contents of a backup set) . . . . . . . . 614
GENERATE BACKUPSET (Generate a backup QUERY CLOPTSET (Query a client option set) 617
set of a client's data) . . . . . . . . . . 483 QUERY COLLOCGROUP (Query a collocation
GENERATE BACKUPSETTOC (Generate a table group). . . . . . . . . . . . . . . 619
of contents for a backup set) . . . . . . . 491 QUERY CONTENT (Query the contents of a
GRANT commands . . . . . . . . . . . 493 storage pool volume) . . . . . . . . . . 622
GRANT AUTHORITY (Add administrator QUERY COPYGROUP (Query copy groups) . . 630
authority) . . . . . . . . . . . . . 494 QUERY DATAMOVER (Display data mover
GRANT PROXYNODE (Grant proxy authority definitions) . . . . . . . . . . . . . 635
to a client node) . . . . . . . . . . . 498 QUERY DB (Display database information) . . 638

Contents v

QUERY DBSPACE (Display database storage QUERY RPFILE (Query recovery plan file
space) . . . . . . . . . . . . . . . 641 information stored on a target server) . . . . 762
QUERY DEVCLASS (Display information on QUERY SAN (Query the devices on the SAN) 765
one or more device classes). . . . . . . . 642 QUERY SCHEDULE (Query schedules). . . . 768
QUERY DIRSPACE (Query storage utilization of QUERY SCRIPT (Query Tivoli Storage Manager
FILE directories) . . . . . . . . . . . 646 scripts) . . . . . . . . . . . . . . 776
QUERY DOMAIN (Query a policy domain) . . 647 QUERY SERVER (Query a server) . . . . . 779
QUERY DRIVE (Query information about a QUERY SERVERGROUP (Query a server group) 783
drive) . . . . . . . . . . . . . . . 650 QUERY SESSION (Query client sessions) . . . 785
QUERY DRMEDIA (Query disaster recovery QUERY SHREDSTATUS (Query shredding
media) . . . . . . . . . . . . . . 654 status ) . . . . . . . . . . . . . . 789
QUERY DRMSTATUS (Query disaster recovery QUERY SPACETRIGGER (Query the space
manager system parameters) . . . . . . . 663 triggers) . . . . . . . . . . . . . . 791
QUERY ENABLED (Query enabled events) . . 666 | QUERY SSLKEYRINGPW (Query SSL key
QUERY EVENT (Query scheduled and | database file password) . . . . . . . . . 793
completed events) . . . . . . . . . . . 668 QUERY STATUS (Query system parameters) 794
QUERY EVENTRULES (Query rules for server QUERY STGPOOL (Query storage pools) . . . 800
or client events) . . . . . . . . . . . 680 QUERY SUBSCRIBER (Display subscriber
QUERY EVENTSERVER (Query the event information) . . . . . . . . . . . . . 811
server). . . . . . . . . . . . . . . 683 QUERY SUBSCRIPTION (Display subscription
QUERY EXPORT (Query for active or information) . . . . . . . . . . . . . 813
suspended export operations) . . . . . . . 684 QUERY SYSTEM (Query the system
QUERY FILESPACE (Query one or more file configuration and capacity). . . . . . . . 815
spaces) . . . . . . . . . . . . . . 691 QUERY TAPEALERTMSG (Display status of
QUERY LIBRARY (Query a library) . . . . . 696 SET TAPEALERTMSG command) . . . . . 817
QUERY LIBVOLUME (Query a library volume) 699 QUERY TOC (Display table of contents for a
QUERY LICENSE (Display license information) 702 backup image) . . . . . . . . . . . . 818
QUERY LOG (Display information on the QUERY VIRTUALFSMAPPING (Query a virtual
recovery log) . . . . . . . . . . . . 703 file space mapping) . . . . . . . . . . 821
QUERY MACHINE (Query machine QUERY VOLHISTORY (Display sequential
information) . . . . . . . . . . . . . 705 volume history information) . . . . . . . 823
QUERY MEDIA (Query sequential access QUERY VOLUME (Query storage pool
storage pool media) . . . . . . . . . . 708 volumes) . . . . . . . . . . . . . . 829
QUERY MGMTCLASS (Query a management QUIT (End the interactive mode of the
class) . . . . . . . . . . . . . . . 714 administrative client) . . . . . . . . . . . 836
QUERY MOUNT (Display information on RECLAIM STGPOOL (Reclaim volumes in a
mounted sequential access volumes). . . . . 717 sequential-access storage pool) . . . . . . . 837
QUERY NASBACKUP (Query NAS backup RECONCILE VOLUMES (Reconcile differences in
images) . . . . . . . . . . . . . . 718 the virtual volume definitions) . . . . . . . 840
QUERY NODE (Query nodes) . . . . . . . 722 REGISTER commands . . . . . . . . . . 843
QUERY NODEDATA (Query client data in REGISTER ADMIN (Register an administrator) 844
volumes) . . . . . . . . . . . . . . 730 REGISTER LICENSE (Register a new license) 846
QUERY NODEGROUP (Query a node group) 733 REGISTER NODE (Register a node) . . . . . 848
QUERY OCCUPANCY (Query client file spaces REMOVE commands . . . . . . . . . . . 859
in storage pools) . . . . . . . . . . . 735 REMOVE ADMIN (Delete an administrator) . . 860
QUERY OPTION (Query server options) . . . 739 REMOVE NODE (Delete a node or an
QUERY PATH (Display a path definition) . . . 740 associated machine node) . . . . . . . . 861
QUERY POLICYSET (Query a policy set) . . . 744 RENAME commands . . . . . . . . . . . 863
QUERY PROCESS (Query one or more server RENAME ADMIN (Rename an administrator) 864
processes) . . . . . . . . . . . . . 747 RENAME FILESPACE (Rename a client file
QUERY PROFILE (Query a profile) . . . . . 749 space on the server) . . . . . . . . . . 865
QUERY PROXYNODE (Query proxy authority RENAME NODE (Rename a node) . . . . . 868
for a client node) . . . . . . . . . . . 752 RENAME SCRIPT (Rename a Tivoli Storage
QUERY RECOVERYMEDIA (Query recovery Manager script) . . . . . . . . . . . 869
media) . . . . . . . . . . . . . . 753 RENAME SERVERGROUP (Rename a server
QUERY REQUEST (Query one or more pending group). . . . . . . . . . . . . . . 870
mount requests) . . . . . . . . . . . 756 RENAME STGPOOL (Change the name of a
QUERY RESTORE (Query restartable restore storage pool) . . . . . . . . . . . . 871
sessions) . . . . . . . . . . . . . . 757 REPLY (Allow a request to continue processing) 872
QUERY RPFCONTENT (Query recovery plan RESET PASSEXP (Reset password expiration) . . 873
file contents stored on a target server) . . . . 760

vi IBM Tivoli Storage Manager for Windows: Administrator's Reference

RESTART EXPORT (Restart a suspended export SET DRMNOTMOUNTABLENAME (Specify the
operation) . . . . . . . . . . . . . . 875 not mountable location name) . . . . . . . 938
RESTORE commands. . . . . . . . . . . 877 SET DRMPLANPREFIX (Specify a prefix for
RESTORE NODE (Restore a NAS node) . . . 878 recovery plan file names) . . . . . . . . 939
RESTORE STGPOOL (Restore storage pool data SET DRMPLANVPOSTFIX (Specify replacement
from a copy pool or an active-data pool) . . . 883 volume names) . . . . . . . . . . . . 941
RESTORE VOLUME (Restore primary volume SET DRMPRIMSTGPOOL (Specify the primary
data from a copy pool or an active-data pool) . 887 storage pools to be managed by DRM) . . . . 942
REVOKE commands . . . . . . . . . . . 892 SET DRMRPFEXPIREDAYS (Set criteria for
REVOKE AUTHORITY (Remove administrator recovery plan file expiration) . . . . . . . 943
authority) . . . . . . . . . . . . . 893 SET DRMVAULTNAME (Specify the vault
REVOKE PROXYNODE (Revoke proxy name) . . . . . . . . . . . . . . . 945
authority for a client node) . . . . . . . . 897 SET EVENTRETENTION (Set the retention
ROLLBACK (Rollback uncommitted changes in a period for event records) . . . . . . . . 946
macro). . . . . . . . . . . . . . . . 898 SET INVALIDPWLIMIT (Set the number of
RUN (Run a Tivoli Storage Manager script) . . . 899 invalid logon attempts) . . . . . . . . . 947
SELECT (Perform an SQL query of the IBM Tivoli SET LICENSEAUDITPERIOD (Set license audit
Storage Manager database) . . . . . . . . . 902 period) . . . . . . . . . . . . . . 948
SERIAL (Run multiple commands in a script in SET MAXCMDRETRIES (Set the maximum
serial) . . . . . . . . . . . . . . . . 909 number of command retries) . . . . . . . 949
SET commands . . . . . . . . . . . . . 910 SET MAXSCHEDSESSIONS (Set maximum
SET ACCOUNTING (Set accounting records on scheduled sessions) . . . . . . . . . . 950
or off) . . . . . . . . . . . . . . . 912 SET MINPWLENGTH (Set minimum password
SET ACTLOGRETENTION (Set the retention length) . . . . . . . . . . . . . . 951
period or the size of the activity log) . . . . 913 SET PASSEXP (Set password expiration date) 952
SET ARCHIVERETENTIONPROTECTION SET QUERYSCHEDPERIOD (Set query period
(Activate data retention protection) . . . . . 915 for polling client nodes) . . . . . . . . . 954
SET AUTHENTICATION (Set password SET RANDOMIZE (Set randomization of
authentication) . . . . . . . . . . . . 917 scheduled start times) . . . . . . . . . 955
SET CLIENTACTDURATION (Set the duration SET REGISTRATION (Set open or closed
period for the client action). . . . . . . . 918 registration) . . . . . . . . . . . . . 957
SET CONFIGMANAGER (Specify a SET RETRYPERIOD (Set time between retry
configuration manager) . . . . . . . . . 919 attempts) . . . . . . . . . . . . . . 959
SET CONFIGREFRESH (Set managed server SET SCHEDMODES (Select a central scheduling
configuration refresh). . . . . . . . . . 920 mode) . . . . . . . . . . . . . . . 960
SET CONTEXTMESSAGING (Set message SET SERVERHLADDRESS (Set the high-level
context reporting on or off) . . . . . . . . 921 address of a server) . . . . . . . . . . 962
SET CROSSDEFINE (Specifies whether to SET SERVERLLADDRESS (Set the low-level
cross-define servers) . . . . . . . . . . 922 address of a server) . . . . . . . . . . 963
SET DBRECOVERY (Set the device class for SET SERVERNAME (Specify the server name) 964
automatic backups) . . . . . . . . . . 923 SET SERVERPASSWORD (Set password for
SET DBREPORTMODE (Set the level of server). . . . . . . . . . . . . . . 965
database reporting) . . . . . . . . . . 924 | SET SSLKEYRINGPW (Set the SSL key ring
| SET DEDUPVERIFICATIONLEVEL (Set the | password) . . . . . . . . . . . . . 966
| percentage of extents to verify) . . . . . . 925 SET SUBFILE (Set subfile backup for client
SET DRMACTIVEDATASTGPOOL (Specify the nodes) . . . . . . . . . . . . . . . 967
active-data pools to be managed by DRM) . . 927 SET SUMMARYRETENTION (Set number of
SET DRMCHECKLABEL (Specify label days to keep data in activity summary table) . . 968
checking) . . . . . . . . . . . . . . 929 SET TAPEALERTMSG (Set tape alert messages
SET DRMCMDFILENAME (Specify the name of on or off) . . . . . . . . . . . . . . 969
a file to contain commands) . . . . . . . 930 SET TOCLOADRETENTION (Set load retention
SET DRMCOPYSTGPOOL (Specify the copy period for table of contents) . . . . . . . 970
storage pools to be managed by DRM) . . . . 931 SETOPT (Set a server option for dynamic update) 971
SET DRMCOURIERNAME (Specify the courier SHRED DATA (Shred data). . . . . . . . . 973
name) . . . . . . . . . . . . . . . 932 SUSPEND EXPORT (Suspend a currently running
SET DRMDBBACKUPEXPIREDAYS (Specify DB export operation) . . . . . . . . . . . . 975
backup series expiration) . . . . . . . . 933 UNLOCK commands . . . . . . . . . . . 976
SET DRMFILEPROCESS (Specify file UNLOCK ADMIN (Unlock an administrator) 977
processing) . . . . . . . . . . . . . 935 UNLOCK NODE (Unlock a client node) . . . 978
SET DRMINSTRPREFIX (Specify the prefix for UNLOCK PROFILE (Unlock a profile) . . . . 979
recovery instructions file names) . . . . . . 936 UPDATE commands . . . . . . . . . . . 980

Contents vii

UPDATE ADMIN (Update an administrator) 981 Date, number, time, and language options . . 1190
UPDATE BACKUPSET (Update a retention Database options . . . . . . . . . . . 1191
value assigned to a backup set) . . . . . . 983 Data transfer options . . . . . . . . . 1191
UPDATE CLIENTOPT (Update a client option Message options . . . . . . . . . . . 1191
sequence number) . . . . . . . . . . . 988 Event logging options . . . . . . . . . 1192
UPDATE CLOPTSET (Update a client option set Security options and licensing options. . . . 1192
description) . . . . . . . . . . . . . 989 Miscellaneous options . . . . . . . . . 1193
UPDATE COLLOCGROUP (Update a 3494SHARED . . . . . . . . . . . . . 1194
collocation group) . . . . . . . . . . . 990 ACSACCESSID . . . . . . . . . . . . 1195
UPDATE COPYGROUP (Update a copy group) 991 ACSLOCKDRIVE. . . . . . . . . . . . 1196
UPDATE DATAMOVER (Update a data mover) 999 ACSQUICKINIT . . . . . . . . . . . . 1197
UPDATE DEVCLASS (Update the attributes of ACSTIMEOUTX . . . . . . . . . . . . 1198
a device class) . . . . . . . . . . . . 1001 ACTIVELOGDIR . . . . . . . . . . . . 1199
UPDATE DOMAIN (Update a policy domain) 1066 ACTIVELOGSIZE . . . . . . . . . . . 1200
UPDATE DRIVE (Update a drive) . . . . . 1068 ADMINONCLIENTPORT . . . . . . . . . 1201
UPDATE LIBRARY (Update a library) . . . . 1072 ADREGISTER . . . . . . . . . . . . . 1202
UPDATE LIBVOLUME (Change the status of a ADSETDC . . . . . . . . . . . . . . 1203
storage volume) . . . . . . . . . . . 1077 ADSMGROUPNAME . . . . . . . . . . 1204
UPDATE MACHINE (Update machine ADUNREGISTER . . . . . . . . . . . 1205
information) . . . . . . . . . . . . 1079 ALIASHALT . . . . . . . . . . . . . 1206
UPDATE MGMTCLASS (Update a ARCHFAILOVERLOGDIR . . . . . . . . 1207
management class) . . . . . . . . . . 1081 ARCHLOGDIR . . . . . . . . . . . . 1208
UPDATE NODE (Update node attributes) . . 1084 ASSISTVCRRECOVERY . . . . . . . . . 1209
UPDATE NODEGROUP (Update a node AUDITSTORAGE . . . . . . . . . . . 1210
group) . . . . . . . . . . . . . . 1093 | CHECKTAPEPOS . . . . . . . . . . . 1211
UPDATE PATH (Change a path) . . . . . 1094 | CLIENTDEDUPTXNLIMIT . . . . . . . . 1212
UPDATE POLICYSET (Update a policy set COMMMETHOD . . . . . . . . . . . 1214
description) . . . . . . . . . . . . 1100 COMMTIMEOUT . . . . . . . . . . . 1215
UPDATE PROFILE (Update a profile DATEFORMAT . . . . . . . . . . . . 1216
description) . . . . . . . . . . . . 1102 DBMEMPERCENT . . . . . . . . . . . 1217
UPDATE RECOVERYMEDIA (Update recovery DEDUPREQUIRESBACKUP . . . . . . . . 1218
media) . . . . . . . . . . . . . . 1103 DEVCONFIG . . . . . . . . . . . . . 1219
UPDATE SCHEDULE (Update a schedule) 1105 DISABLESCHEDS . . . . . . . . . . . 1220
UPDATE SCRIPT (Update a Tivoli Storage DISKSTGPOOLMEMSIZE . . . . . . . . . 1220
Manager script) . . . . . . . . . . . 1127 DISPLAYLFINFO. . . . . . . . . . . . 1221
UPDATE SERVER (Update a server defined for DNSLOOKUP . . . . . . . . . . . . . 1222
server-to-server communications) . . . . . 1129 DRIVEACQUIRERETRY . . . . . . . . . 1223
UPDATE SERVERGROUP (Update a server EVENTSERVER . . . . . . . . . . . . 1224
group description) . . . . . . . . . . 1133 EXPINTERVAL . . . . . . . . . . . . 1225
UPDATE SPACETRIGGER (Update the space EXPQUIET . . . . . . . . . . . . . . 1226
triggers) . . . . . . . . . . . . . . 1134 FILEEXIT . . . . . . . . . . . . . . 1227
UPDATE STGPOOL (Update a storage pool) 1136 FILETEXTEXIT . . . . . . . . . . . . 1228
UPDATE VIRTUALFSMAPPING (Update a IDLETIMEOUT . . . . . . . . . . . . 1229
virtual file space mapping) . . . . . . . 1172 LANGUAGE . . . . . . . . . . . . . 1230
UPDATE VOLHISTORY (Update sequential MAXSESSIONS . . . . . . . . . . . . 1232
volume history information) . . . . . . . 1174 MESSAGEFORMAT . . . . . . . . . . . 1233
UPDATE VOLUME (Change a storage pool MIRRORLOGDIR . . . . . . . . . . . 1234
volume) . . . . . . . . . . . . . . 1176 MOVEBATCHSIZE . . . . . . . . . . . 1235
VALIDATE commands . . . . . . . . . . 1180 MOVESIZETHRESH . . . . . . . . . . 1236
VALIDATE LANFREE (Validate LAN-Free MSGINTERVAL . . . . . . . . . . . . 1237
paths) . . . . . . . . . . . . . . 1181 NAMEDPIPENAME . . . . . . . . . . 1238
VALIDATE POLICYSET (Verify a policy set) 1183 NDMPCONTROLPORT . . . . . . . . . 1239
VARY (Bring a random access volume online or NDMPPORTRANGE . . . . . . . . . . 1240
offline) . . . . . . . . . . . . . . . 1185 NDMPPREFDATAINTERFACE . . . . . . . 1241
NOPREEMPT . . . . . . . . . . . . . 1242
Chapter 3. Server options . . . . . 1187 NORETRIEVEDATE. . . . . . . . . . . 1243
Modifying server options . . . . . . . . . 1187 NPAUDITFAILURE . . . . . . . . . . . 1244
Types of server options . . . . . . . . . . 1188 NPAUDITSUCCESS . . . . . . . . . . . 1245
Server communication options . . . . . . 1188 NPBUFFERSIZE . . . . . . . . . . . . 1246
Server storage options . . . . . . . . . 1189 NUMBERFORMAT . . . . . . . . . . . 1247
Client-server options . . . . . . . . . 1190 NUMOPENVOLSALLOWED. . . . . . . . 1248

viii IBM Tivoli Storage Manager for Windows: Administrator's Reference

QUERYAUTH . . . . . . . . . . . . . 1250 VOLUMEHISTORY . . . . . . . . . . . 1290
RECLAIMDELAY . . . . . . . . . . . 1251
RECLAIMPERIOD . . . . . . . . . . . 1252 Chapter 4. Server utilities. . . . . . 1291
REPORTRETRIEVE . . . . . . . . . . . 1253 DSMMAXSG (Increase the block size for writing
REQSYSAUTHOUTFILE . . . . . . . . . 1254 data) . . . . . . . . . . . . . . . . 1292
RESOURCETIMEOUT . . . . . . . . . . 1255 DSMSERV (Start the server) . . . . . . . . 1293
RESTOREINTERVAL . . . . . . . . . . 1256 DSMSERV DISPLAY DBSPACE (Display
RETENTIONEXTENSION . . . . . . . . . 1257 information about database storage space) . . . 1294
SANDISCOVERY. . . . . . . . . . . . 1258 DSMSERV DISPLAY LOG (Display recovery log
SANDISCOVERYTIMEOUT . . . . . . . . 1259 information) . . . . . . . . . . . . . 1295
SANREFRESHTIME . . . . . . . . . . . 1260 DSMSERV FORMAT (Format the database and
SEARCHMPQUEUE. . . . . . . . . . . 1261 log) . . . . . . . . . . . . . . . . 1297
SECUREPIPES. . . . . . . . . . . . . 1262 DSMSERV INSERTDB (Move a server database
| SERVERDEDUPTXNLIMIT . . . . . . . . 1263 into an empty database) . . . . . . . . . 1299
SHMPORT . . . . . . . . . . . . . . 1265 DSMSERV LOADFORMAT (Format a database) 1301
SHREDDING . . . . . . . . . . . . . 1266 DSMSERV REMOVEDB (Remove a database) 1303
SNMPHEARTBEATINTERVAL . . . . . . . 1267 DSMSERV RESTORE DB (Restore the database) 1304
SNMPMESSAGECATEGORY . . . . . . . . 1268 DSMSERV RESTORE DB (Restore a database to
SNMPSUBAGENT . . . . . . . . . . . 1269 its most current state) . . . . . . . . . 1305
SNMPSUBAGENTHOST . . . . . . . . . 1270 DSMSERV RESTORE DB (Restore a database to
SNMPSUBAGENTPORT . . . . . . . . . 1271 a point-in-time) . . . . . . . . . . . 1307
SSLTCPADMINPORT . . . . . . . . . . 1272 DSMSERV UPDATE (Create registry entries for a
SSLTCPPORT . . . . . . . . . . . . . 1273 server instance) . . . . . . . . . . . . 1310
TCPADMINPORT . . . . . . . . . . . 1274
TCPNODELAY . . . . . . . . . . . . 1275
Appendix A. Return codes for use in
TCPPORT . . . . . . . . . . . . . . 1276
TCPWINDOWSIZE . . . . . . . . . . . 1277 IBM Tivoli Storage Manager scripts . 1311
TECBEGINEVENTLOGGING . . . . . . . 1278
TECHOST . . . . . . . . . . . . . . 1279 Appendix B. Accessibility features
TECPORT . . . . . . . . . . . . . . 1280 for Tivoli Storage Manager . . . . . 1313
TECUTF8EVENT . . . . . . . . . . . . 1281
THROUGHPUTDATATHRESHOLD . . . . . 1282 Notices . . . . . . . . . . . . . 1315
THROUGHPUTTIMETHRESHOLD . . . . . 1283
Trademarks . . . . . . . . . . . . . 1317
TIMEFORMAT . . . . . . . . . . . . 1284
TXNGROUPMAX . . . . . . . . . . . 1285
UNIQUETDPTECEVENTS . . . . . . . . 1286 Glossary . . . . . . . . . . . . . 1319
UNIQUETECEVENTS . . . . . . . . . . 1287
USEREXIT . . . . . . . . . . . . . . 1288 Index . . . . . . . . . . . . . . 1341
VERBCHECK . . . . . . . . . . . . . 1289

Contents ix

x IBM Tivoli Storage Manager for Windows: Administrator's Reference

Preface
IBM® Tivoli® Storage Manager is a client/server program that provides storage
management solutions to customers in a multi-vendor computer environment. IBM
Tivoli Storage Manager provides an automated, centrally scheduled,
policy-managed backup, archive, and space-management facility for file servers
and workstations.

Who should read this 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
IBM Tivoli Storage Manager publications and other related publications are
available online.

You can search all publications in the Tivoli Storage Manager Information Center:
http://publib.boulder.ibm.com/infocenter/tsminfo/v6r2.

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 Tivoli Storage Manager products at http://www.ibm.com/
| developerworks/wikis/display/tivolidoccentral/Tivoli+Storage+Manager.

| You can also order some related publications from the IBM Publications Center
| Web site. The Web site 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.

Tivoli Storage Manager publications
Publications are available for the server, storage agent, client, and Data Protection.
| Table 1. IBM Tivoli Storage Manager troubleshooting and tuning publications
| Publication title Order number
| IBM Tivoli Storage Manager Client Messages and Application SC27-2877
| Programming Interface Return Codes
| IBM Tivoli Storage Manager Server Messages and Error Codes SC27-2878

© Copyright IBM Corp. 1993, 2010 xi

| Table 1. IBM Tivoli Storage Manager troubleshooting and tuning publications (continued)
| Publication title Order number
| IBM Tivoli Storage Manager Performance Tuning Guide GC23-9788
| IBM Tivoli Storage Manager Problem Determination Guide GC23-9789
|
Table 2. 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 Sun Solaris Installation Guide GC23-9784
IBM Tivoli Storage Manager for Sun Solaris Administrator's Guide SC23-9772
IBM Tivoli Storage Manager for Sun 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 Server Upgrade Guide SC23-9554
IBM Tivoli Storage Manager Integration Guide for Tivoli Storage SC27-2828
Manager FastBack

Table 3. Tivoli Storage Manager storage agent publications
IBM Tivoli Storage Manager for SAN for AIX Storage Agent User's SC23-9797
Guide
IBM Tivoli Storage Manager for SAN for HP-UX Storage Agent User's SC23-9798
Guide
IBM Tivoli Storage Manager for SAN for Linux Storage Agent User's SC23-9799
Guide
IBM Tivoli Storage Manager for SAN for Sun Solaris Storage Agent SC23-9800
User's Guide
IBM Tivoli Storage Manager for SAN for Windows Storage Agent User's SC23-9553
Guide

Table 4. Tivoli Storage Manager client publications
IBM Tivoli Storage Manager for UNIX and Linux: Backup-Archive SC23-9791
Clients Installation and User's Guide
IBM Tivoli Storage Manager for Windows: Backup-Archive Clients SC23-9792
Installation and User's Guide

xii IBM Tivoli Storage Manager for Windows: Administrator's Reference

Table 4. Tivoli Storage Manager client publications (continued)
IBM Tivoli Storage Manager for Space Management for UNIX and Linux: SC23-9794
User's Guide
| IBM Tivoli Storage Manager Using the Application Programming SC23-9793
| Interface

Table 5. Tivoli Storage Manager Data Protection publications
IBM Tivoli Storage Manager for Enterprise Resource Planning: Data SC33-6341
Protection for SAP Installation and User's Guide for DB2
IBM Tivoli Storage Manager for Enterprise Resource Planning: Data SC33-6340
Protection for SAP Installation and User's Guide for Oracle

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

Support information
You can find support information for IBM products from various sources.

Start at the IBM Support Portal: http://www.ibm.com/support/entry/portal/. You
can select the products that you are interested in, and search for a wide variety of
relevant information.

| Getting technical training
| Information about Tivoli technical training courses is available online.

| Go to these Web sites for training information:
| Tivoli software training and certification
| Choose from instructor led, online classroom training, self-paced Web
| classes, Tivoli certification preparation, and other training options at this
| site: http://www.ibm.com/software/tivoli/education/
| Tivoli Support Technical Exchange
| Technical experts share their knowledge and answer your questions in
| these webcasts: http://www.ibm.com/software/sysmgmt/products/
| support/supp_tech_exch.html

Preface xiii

Searching knowledge bases
If you have a problem with IBM Tivoli Storage Manager, there are several
knowledge bases that you can search.

Begin by searching the Tivoli Storage Manager Information Center at
http://publib.boulder.ibm.com/infocenter/tsminfo/v6r2. From this Web site, you
can search the current Tivoli Storage Manager documentation.

Searching the Internet
If you cannot find an answer to your question in the Tivoli Storage Manager
Information Center, search the Internet for the information that might help you
resolve your problem.

| To search multiple Internet resources, go to the support Web site for Tivoli Storage
| Manager at http://www.ibm.com/support/entry/portal/Overview/Software/
| Tivoli/Tivoli_Storage_Manager.

| You can search for information without signing in. Sign in using your IBM ID and
| password, if you want to customize the site based on your product usage and
| information needs. If you do not already have an IBM ID and password, click Sign
| in at the top of the page and follow the instructions to register.

From the Support Web site, you can search various resources including:
| v IBM technotes
| v IBM downloads
| v IBM Redbooks® publications
| v IBM Authorized Program Analysis Reports (APARs)
Select the product and click Downloads to search the APAR list.

If you still cannot find a solution to the problem, you can search forums and
newsgroups on the Internet for the latest information that might help you resolve
your problem.

| An independent user discussion list, ADSM-L, is hosted by Marist College. You can
| subscribe by sending an e-mail to listserv@vm.marist.edu. The body of the message
| must contain the following text: SUBSCRIBE ADSM-L your_first_name
| your_family_name.

| To share your experiences and learn from others in the Tivoli Storage Manager
| user community, go to the Tivoli Storage Manager wiki at http://www.ibm.com/
| developerworks/wikis/display/tivolistoragemanager.

Using IBM Support Assistant
| IBM Support Assistant is a complimentary software product that helps you with
| problem determination. You can install the stand-alone IBM Support Assistant
| application on any workstation. You can then enhance the application by installing
| product-specific plug-in modules for the IBM products that you use.

IBM Support Assistant helps you gather support information when you need to
open a problem management record (PMR), which you can then use to track the
problem. For more information, see the IBM Support Assistant Web site at
http://www.ibm.com/software/support/isa/.

xiv IBM Tivoli Storage Manager for Windows: Administrator's Reference

The product-specific plug-in modules provide you with the following resources:
v Support links
v Education links
v Ability to submit problem management reports

| Find add-ons for specific products here: http://www.ibm.com/support/
| docview.wss?&uid=swg27012689.

Finding product fixes
A product fix to resolve your problem might be available from the IBM Software
Support Web site.

| You can determine what fixes are available by checking the IBM Software Support
| Web site at http://www.ibm.com/support/entry/portal/.
| v If you previously customized the site based on your product usage:
| 1. Click the link for your Tivoli Storage Manager product, or one of the other
| Tivoli Storage Manager components that you want to find a fix for.
| 2. Click Downloads, and then click Fixes by version.
| v If you have not customized the site based on your product usage, click
| Downloads and search for your product.

| Receiving notification of product fixes
| You can receive notifications about fixes, flashes, upgrades, and other news about
| IBM products.

| To sign up to receive notifications about IBM products, follow these steps:
| 1. From the support page at http://www.ibm.com/support/entry/portal/, click
| My notifications in the notifications module.
| 2. Sign in using your IBM ID and password. If you do not have an ID and
| password, click register now above the IBM ID and password.
| 3. Click the Subscribe tab to select your product family and click Continue.
| 4. Select the type of information that you want to receive, and add your personal
| preferences. You can specify how you want to be notified, how often, and you
| can also optionally select a folder for the notifications.
| 5. Click Submit.
| 6. For notifications for other products, repeat steps 4 and 5.

| Tip: You can also pick a product first, from the main support portal site, and
| then click in the Notifications section to create or update your subscription for
| that product.

| Contacting IBM Software Support
| You can contact IBM Software Support if you have an active IBM subscription and
| support contract and if you are authorized to submit problems to IBM.

Before you contact IBM Software Support, follow these steps:
1. Set up a subscription and support contract.
2. Determine the business impact of your problem.
3. Describe your problem and gather background information.

Preface xv

Then see “Submitting the problem to IBM Software Support” on page xvii for
information on contacting IBM Software Support.

Setting up a subscription and support contract
| Set up a subscription and support contract. The type of contract that you need
| depends on the type of product you have.

| For IBM distributed software products (including, but not limited to, IBM Tivoli,
| Lotus®, and Rational® products, as well as IBM DB2® and IBM WebSphere®
| products that run on Microsoft® Windows® or UNIX® operating systems), enroll in
| IBM Passport Advantage® in one of the following ways:
| v Online: Go to the Passport Advantage Web page at http://www.ibm.com/
| software/lotus/passportadvantage/, click How to enroll, and follow the
| instructions.
| v By Phone: You can call 1-800-IBMSERV (1-800-426-7378) in the United States, or
| for the phone number to call in your country, go to the IBM Software Support
| Handbook Web page at http://www14.software.ibm.com/webapp/set2/sas/f/
| handbook/home.html and click Contacts.

Determining the business impact
When you report a problem to IBM, you are asked to supply a severity level.
Therefore, you must understand and assess the business impact of the problem
you are reporting.

Severity 1 Critical business impact: You are unable to use the program,
resulting in a critical impact on operations. This condition
requires an immediate solution.
Severity 2 Significant business impact: The program is usable but is
severely limited.
Severity 3 Some business impact: The program is usable with less
significant features (not critical to operations) unavailable.
Severity 4 Minimal business impact: The problem causes little impact on
operations, or a reasonable circumvention to the problem has
been implemented.

Describing the problem and gather background information
When explaining a problem to IBM, it is helpful to be as specific as possible.
Include all relevant background information so that IBM Software Support
specialists can help you solve the problem efficiently.

To save time, know the answers to these questions:
v What software versions were you running when the problem occurred?
v Do you have logs, traces, and messages that are related to the problem
symptoms? IBM Software Support is likely to ask for this information.
v Can the problem be recreated? If so, what steps led to the failure?
v Have any changes been made to the system? For example, hardware, operating
system, networking software, and so on.
| v Are you using a workaround for this problem? If so, be prepared to explain it
| when you report the problem.

xvi IBM Tivoli Storage Manager for Windows: Administrator's Reference

Submitting the problem to IBM Software Support
You can submit the problem to IBM Software Support online or by phone.
Online
| Go to the IBM Software Support Web site at http://www.ibm.com/
| support/entry/portal/Open_service_request/Software/
| Software_support_(general). Sign in to access IBM Service Requests, and
| enter your information into the problem submission tool.
By phone
For the phone number to call in your country, go to the contacts page of
the IBM Software Support Handbook at http://www14.software.ibm.com/
webapp/set2/sas/f/handbook/home.html.

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
may represent fewer actual characters.

Preface xvii

xviii IBM Tivoli Storage Manager for Windows: Administrator's Reference

New for IBM Tivoli Storage Manager Version 6.2
Many features in the Tivoli Storage Manager Version 6.2 server are new for
previous Tivoli Storage Manager users.

New for the server in Version 6.2
Tivoli Storage Manager server Version 6.2 contains many new features and
changes. Any updates that have been made to the information since the previous
edition are marked with a vertical bar ( | ) in the left margin.

| Client-side data deduplication
| In client-side data deduplication, the Tivoli Storage Manager backup-archive client
| and the server work together to identify duplicate data.

| Data deduplication is a method of reducing storage needs by eliminating
| redundant data. In Tivoli Storage Manager V6.1, only the server could identify and
| remove redundant data. In V6.2, you have the option of identifying and removing
| redundant data during backup and archive processing before data is sent to the
| server. This method of data deduplication is called client-side data deduplication. It is
| available with V6.2 backup-archive clients and the V6.2 Tivoli Storage Manager
| application programming interface (API).

| Client-side data deduplication provides several advantages to server-side data
| deduplication. Client-side data deduplication reduces the amount of data sent over
| the local area network (LAN). In addition, the processing power that is required to
| identify duplicate data is offloaded from the server to client nodes. The processing
| that is required to remove duplicate data on the server is eliminated. Space savings
| occur immediately.

| If you used server-side data deduplication, V6.2 client nodes can access existing
| deduplicated data and storage pools that are already set up for data deduplication.
| When restoring or retrieving files, the client node queries for and displays files as
| it normally does. If a user selects a file that exists in a deduplicated storage pool,
| the server manages the work of reconstructing the file.

| You enable client-side data deduplication using a combination of settings on the
| client node and the server. The primary storage pool that is specified by the copy
| group of the management class associated with the client data must be a
| sequential-access disk (FILE) storage pool that is enabled for data deduplication.

© Copyright IBM Corp. 1993, 2010 xix

Client-side data deduplication: Changes for V6.2

| Related reference
| “CLIENTDEDUPTXNLIMIT” on page 1212
| Use this option to specify the maximum size of a transaction when client-side
| deduplicated data is backed up or archived.
| “QUERY CONTENT (Query the contents of a storage pool volume)” on page 622
| Use this command to identify files that are linked to files on other volumes in a
| deduplicated storage pool.
| “REGISTER NODE (Register a node)” on page 848
| Use this command to register a node to the server.
| “SERVERDEDUPTXNLIMIT” on page 1263
| Use this option to specify the maximum size of objects that can be deduplicated on
| the server.
| “SET DEDUPVERIFICATIONLEVEL (Set the percentage of extents to verify)” on
| page 925
| Use this command to verify extents sent to the server during client-side
| deduplication.
| “UPDATE NODE (Update node attributes)” on page 1084
| Use this command to modify the attributes of a registered node.

| Automatic backup-archive client deployment
| IBM Tivoli Storage Manager V6.2 can deploy backup-archive client code to
| workstations that already have the backup-archive client installed.

| You can now deploy backup-archive client code to candidate client workstations
| from the Tivoli Storage Manager V6.2 Administration Center. From the
| Administration Center, you can coordinate the client updates to each workstation
| that is at release 5.4 and later to V6.2. You are helped through the process by
| wizards that configure your workstation and schedule the deployments. The
| backup-archive client deployment feature is available for Windows backup-archive
| clients only.

| Simultaneous-write operations during storage pool migration
| With Tivoli Storage Manager, you can now write data simultaneously to copy
| storage pools and active-data pools during server data-migration processes.

| The simultaneous-write function during migration can reduce the amount of time
| required to back up storage pools or copy active data. Data that is simultaneously
| written to copy storage pools or active-data pools during migration is not copied
| again to the copy storage pools or active-data pools. For example, suppose that
| you migrate all the data in your primary random-access disk storage pool nightly
| and then back up your primary storage pools. By using the simultaneous-write
| function during migration, you can significantly reduce the amount of time
| required for backup operations.

| You can also use the simultaneous-write function during migration if you have
| many client nodes and the number of mount points that are required to perform
| the simultaneous-write function during client store operations is unacceptable. If
| mounting and demounting tapes when writing data simultaneously during client
| store operations is taking too much time, consider writing data simultaneously
| during migration.

xx IBM Tivoli Storage Manager for Windows: Administrator's Reference

Client-side data deduplication: Changes for V6.2

| With Tivoli Storage Manager V6.2, you can specify the simultaneous-write function
| for a primary storage pool if it is the target for any of the eligible operations (client
| store sessions, server import processes, and server data-migration processes).
| Related reference
| “DEFINE STGPOOL (Define a primary storage pool assigned to random access
| devices)” on page 298
| Use this command to define a primary storage pool assigned to a random-access
| device.
| “UPDATE STGPOOL (Update a primary random access storage pool)” on page
| 1137
| Use this command to update the definition of a storage pool assigned to a
| random-access device.
| “DEFINE STGPOOL (Define a primary storage pool assigned to sequential access
| devices)” on page 307
| Use this command to define a storage pool defined to a sequential-access storage
| device.
| “UPDATE STGPOOL (Update a primary sequential access pool)” on page 1146
| Use this command to update the definition of a storage pool assigned to
| sequential-access storage device.

| In-flight data encryption using SSL
| Support for Secure Sockets Layer (SSL) is available on HP-UX, Linux®, Solaris,
| AIX®, and Windows platforms.

| With 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.

New for the Tivoli Storage Manager reporting and monitoring
feature in version 6.2
The Tivoli Storage Manager reporting and monitoring feature, Version 6.2 has a
few new changes.

The Tivoli Storage Manager reporting and monitoring feature, Version 6.2, has been
integrated into a new user interface called the Tivoli Integrated Portal. This move
affects the reporting and monitoring reports that are run from the Administration
Center. The Administration Center moved from the Integrated Solutions Console to
the Tivoli Integrated Portal. The Tivoli Integrated Portal provides all the functions
that were available in the Integrated Solutions Console, but with a new
look-and-feel.

The Administration Center is installed separately and is not included in the
reporting and monitoring installation.

There is a new information roadmap for the Tivoli Storage Manager reporting and
monitoring feature on theTivoli Storage Manager Wiki. This roadmap has detailed
information on planning, installing, configuring, customizing, and trouble
shooting.Reporting and monitoring feature information roadmap

New for IBM Tivoli Storage Manager Version 6.2 xxi

IBM Tivoli Integrated Portal and the Tivoli Storage Manager reporting and monitoring
feature updated in version 6.2

| SCSI passthru support for Windows
| SCSI passthru support is available for Windows in Tivoli Storage Manager Version
| 6.2.

| With this support, you can choose to use a Windows Hardware Qualification Lab
| certified native device driver instead of the Tivoli Storage Manager device driver to
| control devices. Devices currently controlled by the Tivoli Storage Manager device
| driver can be switched to a native driver without updating drive or device class
| definitions.

| Concurrent read-and-write access to Centera volumes
| In previous versions of Tivoli Storage Manager, a client session or server process
| had to wait for a Centera volume if the volume was in use by another session or
| process. In V6.2, server read-access and write-access to a Centera volume are
| available concurrently.

| Concurrent access improves restore performance. Two or more clients can read the
| same volume at the same time. One client can also write to the volume while it is
| being read. In addition, multiple client sessions and server processes (for example,
| a client restore operation and an export node operation) can read the same volume
| concurrently.

| The following server processes can share read access to Centera volumes:
| v Exporting client node definitions or file data to sequential media or directly to
| another server for immediate import
| v Exporting all or part of server control information and client file data (if
| specified) from the server to sequential media
| v Generating a backup set for a backup-archive client node

| The following server processes cannot share read access to Centera volumes:
| v Checking for inconsistencies between a storage pool volume and database
| information
| v Deleting a storage pool volume and, optionally, the files stored in the volume

| A Centera volume can appear as the current volume for more than one session and
| as the target of concurrent read and write operations. There are no command
| changes associated with this feature.

| The Tivoli Integrated Portal GUI
| The IBM Tivoli Integrated Portal is a graphical user interface (GUI) that is included
| with Tivoli Storage Manager V6.2. The Tivoli Integrated Portal provides all the
| functions that were available in the Integrated Solutions Console.

| The Administration Center, Tivoli Storage Manager reporting and monitoring
| feature, and other applications are integrated into this new graphical user interface.
| The Administration Center can be moved to the Tivoli Integrated Portal if the
| servers being managed are at version 5.5 or later. By deploying the Tivoli
| Integrated Portal early, you can prepare your system for an upgrade to Tivoli
| Storage Manager V6.2. Servers at versions earlier than 6.2 that are managed using
| the V6.2 Administration Center cannot use the version V6.2 features.

xxii IBM Tivoli Storage Manager for Windows: Administrator's Reference


| The Administration Center not installable on HP-UX
| The Administration Center, a Web-based interface for centrally configuring and
| managing Tivoli Storage Manager servers, cannot be installed on an HP-UX server.

| In IBM Tivoli Storage Manager Version 6.2, the Administration Center cannot be
| installed on an HP-UX server. However, when installed on a supported server
| platform, the Administration Center can be used to manage HP-UX servers. For
| Administration Center system requirements, see the following Web site:
| http://www.ibm.com/support/docview.wss?uid=swg21410467

| Sun StorageTek T10000B drive encryption
| You can now use tape device encryption with Sun StorageTek T10000B drives.
| Encryption provides security for data on individual tapes and protects sensitive
| information that is transported off-site. When enabled, Tivoli Storage Manager
| handles encrypting and decrypting data on tapes according to specifications set
| when defining an ECARTRIDGE device class.
| Related reference
| “DEFINE DEVCLASS (Define an ECARTRIDGE device class)” on page 174
| Use the ECARTRIDGE device class when you are using StorageTek drive T10000B.
| “UPDATE DEVCLASS (Update an ECARTRIDGE device class)” on page 1032
| Use the ECARTRIDGE device class when you are using StorageTek drive T10000B.

| MOVESIZETHRESH server option
| The MOVESIZETHRESH server option default and maximum values have been
| increased.

| The MOVESIZETHRESH option specifies, in megabytes, a threshold for the
| amount of data moved as a batch, within the same server transaction. When this
| threshold is reached, no more files are added to the current batch, and a new
| transaction is started after the current batch is moved. The default value for
| MOVESIZETHRESH has been increased from 2048 to 4096; and the maximum
| value has also been increased from 2048 to 32768.
| Related reference
| MOVESIZETHRESH
| Use this command to specify a threshold for the amount of data moved as a batch
| within the same server transaction.

| CHECKTAPEPOS server option to validate data position on
| tape
| With the new CHECKTAPEPOS server option, you can determine the validity and
| consistency of the position of data blocks on tape.

| The CHECKTAPEPOS option applies to only operations using tape drives. It does
| not apply to non-tape, sequential-access device classes such as FILE or OPTICAL.
| If the server information about position does not match the position detected by
| the drive, an error message is displayed, the transaction is rolled back, and the
| data is not committed to the database.
| Related reference
| “CHECKTAPEPOS” on page 1211
| The CHECKTAPEPOS option specifies whether the Tivoli Storage Manager
| validates data position on tape. Use this option to determine the validity and
| consistency of data on tape.

New for IBM Tivoli Storage Manager Version 6.2 xxiii


xxiv 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 and all
server commands.

Compared to the administrative client, the capabilities of the server console are
somewhat limited. For example, you cannot issue certain commands from the
server console, and you cannot specify that certain commands process before other
commands can be issued. (This procedure can be useful if, for example, you want
to run two commands in quick succession.) Furthermore, because the server
console is a DOS window on the machine on which the server is installed, you
must be physically located at the server machine to use the console. The
administrative client, on the other hand, can be accessed remotely from a different
location. You cannot route commands to other servers from the server console.

The Administration Center is a Web-based, task-oriented interface for centrally
configuring and managing Tivoli Storage Manager servers. The Administration
Center provides a command line interface that you can use if necessary. For
example, you might want to use the command line interface to perform Tivoli
Storage Manager functions that are limited or not supported in the Administration
Center. Using the command line in the Administration Center, you can issue any
and all server commands.

Issuing commands from the administrative client
The administrative command-line client is a program that runs on a file server,
workstation, or mainframe.

Ensure that your administrative client and your server are running in compatible
languages. See “LANGUAGE” on page 1230 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, 2010 1

Starting and stopping the administrative client
Use the DSMADMC command to start an administrative client session.

The Tivoli Storage Manager server must be running before an administrative client
can connect. For instructions about starting the server, see the Installation Guide.

To start an administrative client session in command-line mode, enter this
command on your workstation:
dsmadmc -id=admin -password=admin -dataonly=yes

Note: 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 6.
Table 6. Keyboard break sequences
Environment Break Sequence
UNIX-based and Linux clients Ctrl+C
Windows Ctrl+C, Ctrl+Break
TSO 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 6.

2 IBM Tivoli Storage Manager for Windows: Administrator's Reference

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 filestest*"'

Processing a series of commands from the administrative
client
Use the interactive mode to process a series of administrative commands.

To start an administrative client session in interactive mode, a server session must
be available. To ensure the availability of server sessions for both administrative
and client node sessions, the interactive mode of the administrative client is
disconnected if one or more of the following conditions is true:
v The server was stopped using the HALT command.
v Commands were not issued from the administrative client session for the length
of time specified with the IDLETIMEOUT server option.
v The administrative client session was canceled with the CANCEL SESSION
command.

You can use continuation characters when using interactive mode. For more
information, see “Entering long commands” on page 11.

To start an administrative session in interactive mode, enter:
dsmadmc

Do not enter a server command with the DSMADMC command. Doing so will
start the administrative client in batch, not interactive, mode. For example, do not
enter:
dsmadmc server_command

You can automatically restart your administrative client session by entering
another command each time the tsm: servername > prompt appears.

Chapter 1. Administering the server from the command-line interface 3

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 dsmadmc -id=xxx -pa=xxx query domain acctg dominfo.acc
QUERY DOMAIN
command to a new file A single greater-than sign (>) indicates that Tivoli Storage
in batch or interactive Manager redirects the output to a new file or writes over an
mode existing file.
Append the output of a dsmadmc -id=xxx -pa=xxx query domain acctg >> dominfo.acc
QUERY DOMAIN
command to the end of Double greater-than signs (>>) indicates that Tivoli Storage
an existing file in batch Manager appends the output to the end of an existing file.
or interactive mode
Redirect all output from dsmadmc -console -id=admin -password=xxx | filter.exe
an administrative client
session in console mode The program can be set up to monitor the output for individual
to a program called messages as they occur and take appropriate action, such as
filter.exe 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 1206 for
details.
-COMMAdelimited
Specifies that any tabular output from a server query is to be formatted as
comma-separated strings rather than in readable format. This option is
intended to be used primarily when redirecting the output of an SQL query
(SELECT command). The comma-separated value format is a standard data
format, which can be processed by many common programs, including
spreadsheets, 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=LISt or TABle
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.
-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.


Entering administrative commands
Commands consist of command names and usually parameters and variables.
Syntax diagrams depict the rules to follow when entering commands.

Reading syntax diagrams
To read a syntax diagram for entering a command, follow the path of the line.
Read from left to right and from top to bottom.
v The ─── symbol indicates the beginning of a syntax diagram.
v The ─── symbol at the end of a line indicates that the syntax diagram continues
onto the next line.
v The ─── symbol at the beginning of a line indicates that a syntax diagram
continues from the previous line.
v The ─── symbol indicates the end of a syntax diagram.

Command names

The command name can consist of a single action word, such as HALT, or it can
consist of an action word and an object for the action, such as DEFINE DOMAIN.
You can enter the command in any column of the input line.

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

CMDNAme

Note: Command names in descriptive text are always capitalized.

Required parameters

When a parameter is on the same line as the command name, the parameter is
required. When two or more parameter values are in a stack and one of them is on
the line, you must specify one value.

In this example, you must enter PARMNAME=A, PARMNAME=B, or
PARMNAME=C. Do not include any blanks immediately before or after the equal
sign (=).

PARMName = A
B
C

Optional parameters

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


PARMName = A

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

PARMNAme = A
B
C

Defaults

Defaults are above the line. The system uses the default unless you override it. You
can override the default by entering an option from the stack below the line.

In this example, PARMNAME=A is the default. You can also enter
PARMNAME=A, PARMNAME=B, or PARMNAME=C. Do not include any blanks
before or after the equal sign (=).

PARMNAme = A

PARMName = A
B
C

Variables

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

CMDNAme var_name

PARMname = var_name

Special characters

You must code these symbols exactly as they appear in the syntax diagram.
* Asterisk
: Colon
, Comma
= Equal sign
- Hyphen
() Parentheses
. Period


Repeating values

An arrow returning to the left means that the item can be repeated. A character
within the arrow means that you must separate repeated items with that character.

,

file_name

Repeatable choices

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

,

PARMNAme = value1
value2
value3

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 = COpy

REClaim = 100

DESCription = description REClaim = percent

The first two parameters in this command (pool_name and device_class_name are
required parameters. pool_name and device_class_name are also positional. That is,
they must be entered in the order shown, immediately after the command name.
The POOLTYPE parameter is a required keyword parameter. DESCRIPTION and
RECLAIM, are optional keyword parameters. Keyword parameters are identified
by an equal sign that specifies a specific value or a variable. Keyword parameters
must follow any positional parameters in a command.


The following command entries, in which the keyword parameters are ordered
differently, are both acceptable:
define stgpool mycopypool mydeviceclass pooltype=copy description=engineering
reclaim=50
define stgpool mycopypool mydeviceclass description=engineering pooltype=copy
reclaim=50

The following example, in which one of the positional parameters follows a
keyword parameter, is not acceptable:
define stgpool mycopypool pooltype=copy mydeviceclass description=engineering
reclaim=50

Syntax fragments

Some diagrams, because of their length, must display parts of the syntax with
fragments. The fragment name appears between vertical bars in the diagram.

The expanded fragment appears in the diagram after all other parameters or at the
bottom of the diagram. A heading with the fragment name identifies the expanded
fragment. Commands appearing directly on the line are required.

In this example, the fragment is named “Fragment”.

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.

Naming Tivoli Storage Manager objects
Tivoli Storage Manager restricts the number and type of characters that you can
use to name objects.

The following characters are available for defining object names.

Character Description
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, 64
passwords, server groups, server, names, virtual file
space names
Restartable export identifiers 64
High-level and low-level TCP/IP (IPv4 or IPv6) 64
addresses
Device classes, drives, libraries, management classes, 30
policy domains, profiles, schedules scripts, backup
sets, storage pools

When you use DEFINE commands to define database, recovery log, and storage
pool volumes, the naming convention for the volume name is dependent on the
type of sequential access media or random access media you are using. Refer to
the specific VOLUME command for details.


Using wildcard characters to specify object names
In some commands, such as the query commands, you can use wildcard characters
to create a pattern-matching expression that specifies more than one object. Using
wildcard characters makes it easier to tailor a command to your needs.

The wildcard characters you use depend on the operating system from which you
issue commands. For example, you can use wildcard characters such as an asterisk
(*) to match any (0 or more) characters, or you can use a question mark (?) or a
percent sign (%) to match exactly one character.

Table 7 provides references to wildcard characters for some operating systems. Use
wildcard characters appropriate for your system.
Table 7. Wildcard characters by operating system
Operating system Match any Match exactly one
AIX, HP-UX, Linux, OS/2, Sun Solaris, * ?
Windows
TSO * %

For example, if you want to query all the management classes whose names begin
with DEV in all the policy sets in DOMAIN1, and your system uses an asterisk as
the match-any character, you can enter:
query mgmtclass domain1 * dev*

If your system uses a question mark as the match-exactly-one character, and you
want to query the management classes in POLICYSET1 in DOMAIN1, you can
enter:
query mgmtclass domain1 policyset1 mc?

Tivoli Storage Manager displays information about management classes with
names MC.

Table 8 shows additional examples of using wildcard characters to match any
characters.
Table 8. 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 9 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 9. Match-exactly-one character
ab? abc ab, abab, abzzzz
ab?rs abfrs abrs, abllrs
ab?ef?rs abdefjrs abefrs, abdefrs, abefjrs


Table 9. Match-exactly-one character (continued)
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:


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.


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


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

(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

(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

(dev_group,mercury,jupiter) query stgpool

Routing commands inside scripts
When routing commands inside scripts, you must enclose the server or server
group in parentheses and omit the colon. Otherwise, the command will not be
routed when the RUN command is issued, and will only be run on the server
where the RUN command is issued.

For example, to route the QUERY STGPOOL command inside a script:
1. Define a script called QU_STG to route it to the DEV_GROUP server group.
define script qu_stg "(dev_group) query stgpool"
2. Run the QU_STG script:
run qu_stg


In this example, the server group DEV_GROUP has servers SALES, MARKETING,
and STAFF defined as group members. The QUERY STGPOOL command is routed
to these servers.

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 10 on page 19 lists the commands that administrators with system privilege
can issue. In some cases administrators with lower levels of authority, for example,
unrestricted storage privilege, can also issue these commands. In addition, the
REQSYSAUTHOUTFILE server option can be used to specify that certain
commands require system privilege if they cause Tivoli Storage Manager to write
to an external file. For more information about this server option see
“REQSYSAUTHOUTFILE” on page 1254.


Table 10. System privilege commands
Command Name Command Name

AUDIT LICENSES DEFINE STGPOOL
ACCEPT DATE DEFINE SUBSCRIPTION
BEGIN EVENTLOGGING DEFINE VIRTUALFSMAPPING
CANCEL EXPIRATION DEFINE VOLUME
CANCEL PROCESS DELETE BACKUPSET
CANCEL REQUEST DELETE CLIENTOPT
CANCEL RESTORE DELETE CLOPTSET
CLEAN DRIVE DEFINE COLLOCGROUP
COPY ACTIVEDATA DEFINE COLLOCMEMBER
COPY DOMAIN DELETE DOMAIN
COPY POLICYSET DELETE DRIVE
COPY PROFILE DELETE EVENTSERVER
COPY SCHEDULE (See note.) DELETE GRPMEMBER
COPY SCRIPT DELETE LIBRARY
COPY SERVERGROUP DELETE MACHINE
DEFINE BACKUPSET DELETE MACHNODEASSOCIATION
DEFINE CLIENTACTION DELETE NODEGROUP
DEFINE CLIENTOPT DELETE NODEGROUPMEMBER
DEFINE CLOPTSET DELETE PROFASSOCIATION
DEFINE COLLOCGROUP DELETE PROFILE
DEFINE COLLOCMEMBER DELETE RECMEDMACHASSOCIATION
DEFINE DEVCLASS DELETE RECOVERYMEDIA
DEFINE DOMAIN DELETE SCHEDULE (See note.)
DEFINE DRIVE DELETE SCRIPT
DEFINE EVENTSERVER DELETE SERVER
DEFINE GRPMEMBER DELETE SERVERGROUP
DEFINE LIBRARY DELETE SPACETRIGGER
DEFINE MACHINE DELETE STGPOOL
DEFINE MACHNODEASSOCIATION DELETE SUBSCRIBER
DEFINE NODEGROUP DELETE SUBSCRIPTION
DEFINE NODEGROUPMEMBER DELETE VIRTUALFSMAPPING
DEFINE PATH DISABLE EVENTS
DEFINE PROFASSOCIATION ENABLE EVENTS
DEFINE PROFILE END EVENTLOGGING
DEFINE RECMEDMACHASSOCIATION EXPIRE INVENTORY
DEFINE RECOVERYMEDIA EXPORT ADMIN
DEFINE SCHEDULE (See note.) EXPORT NODE
DEFINE SCRIPT EXPORT POLICY
DEFINE SERVER EXPORT SERVER
DEFINE SERVERGROUP GENERATE BACKUPSET
DEFINE SPACETRIGGER GRANT AUTHORITY


Table 10. System privilege commands (continued)

GRANT PROXYNODE SET CROSSDEFINE
IDENTIFY DUPLICATES SET DBRECOVERY
IMPORT NODE SET DRMACTIVEDATASTGPOOL
IMPORT POLICY SET DRMCHECKLABEL
IMPORT SERVER SET DRMCMDFILENAME
INSERT MACHINE SET DRMCOPYSTGPOOL
LABEL LIBVOLUME SET DRMCOURIERNAME
LOCK ADMIN SET DRMDBBACKUPEXPIREDAYS
LOCK PROFILE SET DRMFILEPROCESS
MIGRATE STGPOOL SET DRMINSTRPREFIX
MOVE DRMEDIA SET DRMNOTMOUNTABLENAME
MOVE MEDIA SET DRMPLANPREFIX
MOVE GRPMEMBER SET DRMPLANVPOSTFIX
NOTIFY SUBSCRIBERS SET DRMPRIMSTGPOOL
PING SERVER SET DRMRPFEXPIREDAYS
PREPARE SET DRMVAULTNAME
QUERY BACKUPSETCONTENTS SET EVENTRETENTION
QUERY MEDIA SET INVALIDPWLIMIT
QUERY RPFCONTENT SET LICENSEAUDITPERIOD
QUERY TOC SET MAXCMDRETRIES
RECLAIM STGPOOL SET MAXSCHEDSESSIONS
RECONCILE VOLUMES SET MINPWLENGTH
REGISTER ADMIN SET PASSEXP
REGISTER LICENSE SET QUERYSCHEDPERIOD
REMOVE ADMIN SET RANDOMIZE
RENAME ADMIN SET REGISTRATION
RENAME SCRIPT SET RETRYPERIOD
RENAME SERVERGROUP SET SCHEDMODES
RENAME STGPOOL SET SERVERHLADDRESS
RESET PASSEXP SET SERVERLLADDRESS
RESTORE NODE SET SERVERNAME
REVOKE AUTHORITY SET SERVERPASSWORD
REVOKE PROXYNODE SET SUBFILE
RUN SET TOCLOADRETENTION
SET ACCOUNTING SETOPT
SET ACTLOGRETENTION UNLOCK ADMIN
SET ARCHIVERETENTIONPROTECTION UNLOCK PROFILE
SET AUTHENTICATION UPDATE ADMIN
SET CLIENTACTDURATION UPDATE BACKUPSET
SET CONFIGMANAGER UPDATE CLIENTOPT
SET CONFIGREFRESH UPDATE CLOPTSET
SET CONTEXTMESSAGING UPDATE COLLOCGROUP


Table 10. System privilege commands (continued)

UPDATE DEVCLASS UPDATE SCHEDULE (See note.)
UPDATE DRIVE UPDATE SCRIPT
UPDATE LIBRARY UPDATE SERVER
UPDATE LIBVOLUME UPDATE SERVERGROUP
UPDATE MACHINE UPDATE SPACETRIGGER
UPDATE NODEGROUP UPDATE VIRTUALFSMAPPING
UPDATE PATH UPDATE VOLHISTORY
UPDATE PROFILE VALIDATE LANFREE
UPDATE RECOVERYMEDIA
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 11 on page 22 lists the commands that an administrator with policy privilege
can issue.


Table 11. Policy privilege commands

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.


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 12 lists the commands an administrator with storage privilege can issue.
Table 12. Storage privilege commands

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 13 on page 24 lists the commands an administrator with operator privilege
can issue.


Table 13. Operator privilege commands

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 14 on page 25 lists the commands any registered administrator can issue.


Table 14. Commands issued by all administrators

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 REQUEST
QUERY CONTENT QUERY RESTORE
QUERY COPYGROUP QUERY RPFILE
QUERY DATAMOVER QUERY SCHEDULE
QUERY DB QUERY SCRIPT
QUERY DBSPACE QUERY SERVER
QUERY DEVCLASS QUERY SERVERGROUP
QUERY DIRSPACE QUERY SESSION
QUERY DOMAIN QUERY SPACETRIGGER
QUERY DRIVE QUERY STATUS
QUERY DRMEDIA QUERY STGPOOL
QUERY DRMSTATUS QUERY SUBSCRIBER
QUERY ENABLED QUERY SUBSCRIPTION
QUERY EVENT QUERY SYSTEM
QUERY EVENTRULES QUERY VIRTUALFSMAPPING
QUERY EVENTSERVER QUERY VOLHISTORY
QUERY FILESPACE QUERY VOLUME
QUERY LIBRARY QUIT
QUERY LIBVOLUME ROLLBACK
QUERY LICENSE SERIAL
QUERY LOG SELECT
QUERY MACHINE
QUERY MGMTCLASS
QUERY MOUNT
QUERY NASBACKUP


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, 2010 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 15. Command related to ACCEPT DATE
Command Description
ENABLE SESSIONS Resumes server activity following the
DISABLE command or the ACCEPT DATE
command.


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.


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 16. Commands related to ACTIVATE POLICYSET
Command Description
COPY POLICYSET Creates a copy of a policy set.
DEFINE POLICYSET Defines a policy set within the specified
policy domain.
DELETE POLICYSET Deletes a policy set, including its
management classes and copy groups, from a
policy domain.
QUERY DOMAIN Displays information about policy domains.
QUERY POLICYSET Displays information about policy sets.
UPDATE POLICYSET Changes the description of a policy set.
VALIDATE POLICYSET Verifies and reports on conditions the
administrator must consider before activating
the policy set.


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

set belongs.

Syntax
ASsign DEFMGmtclass domain_name policy_set_name class_name

Parameters
Specifies the policy domain to which the management class belongs.
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 17. 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.


ASSIGN DEFMGMTCLASS

Table 17. Commands related to ASSIGN DEFMGMTCLASS (continued)
Command Description
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.
UPDATE COPYGROUP Changes one or more attributes of a copy
group.
UPDATE MGMTCLASS Changes the attributes of a management
class.
the policy set.


AUDIT command

AUDIT commands
Use the AUDIT commands to review or examine the adequacy of the database
information and the storage pool volume.

The following is a list of AUDIT commands for Tivoli Storage Manager:
v “AUDIT LIBRARY (Audit volume inventories in an automated library)” on page
34
v “AUDIT LICENSES (Audit server storage usage)” on page 36
v “AUDIT VOLUME (Verify database information for a storage pool volume)” on
page 37


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 = Yes
Barcode


AUDIT LIBRARY

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.

Example: Audit an automated library

Audit the EZLIFE automated library.
audit library ezlife

Related commands
Table 18. Commands related to AUDIT LIBRARY
Command Description
CANCEL PROCESS Cancels a background server process.
DEFINE LIBRARY Defines an automated or manual library.
DELETE LIBRARY Deletes a library.
DISMOUNT VOLUME Dismounts a sequential, removable volume
by the volume name.
QUERY LIBRARY Displays information about one or more
libraries.
QUERY LIBVOLUME Displays information about a library volume.
QUERY PROCESS Displays information about background
processes.
UPDATE LIBRARY Changes the attributes of a library.


AUDIT 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


Syntax
AUDit LICenses

Parameters

None.

Example: Audit server licenses

Issue the AUDIT LICENSES command.
audit licenses

Related commands
Table 19. Commands related to AUDIT LICENSES
Command Description
QUERY AUDITOCCUPANCY Displays the server storage utilization for a
client node.
QUERY LICENSE Displays information about licenses and
audits.
processes.
QUERY STATUS Displays the settings of server parameters,
such as those selected by the SET commands.
REGISTER LICENSE Registers a new license with the IBM Tivoli
Storage Manager server.
SET LICENSEAUDITPERIOD Specifies the number of days between
automatic license audits.


AUDIT 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.

This command creates a background process that can be canceled with the
CANCEL PROCESS command. To display information on background processes,
use the QUERY PROCESS command.


AUDIT VOLUME

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
Fix = No
AUDit Volume volume_name
A Fix = No
Yes

SKIPPartial = No Quiet = No

SKIPPartial = No Quiet = No
Yes Yes

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

(1)
FROMDate = TODAY

(1) FROMDate = date
STGPool = 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.
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.


AUDIT VOLUME

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.
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:


AUDIT VOLUME

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 The current date minus days TODAY –7 or –7.
-days specified. The maximum
number of days you can To display information beginning with
specify is 9999. volumes written a week ago, you can
specify FROMDATE=TODAY-7 or
FROMDATE= -7.

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


AUDIT VOLUME


If a date is entered, all candidate
volumes written on that day (ending at
11:59:59 pm) will be evaluated.
TODAY-days or The current date minus days TODAY–1 or –1.
-days specified. The maximum
number of days you can To display information created up to
specify is 9999. yesterday, you can specify
TODATE=TODAY-1 or simply
TODATE= -1.

STGPool
This parameter specifies that the server only audits the volumes from the
specified storage pool. This parameter is optional. You cannot use this
parameter if you have specified a volume.

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 20. Commands related to AUDIT VOLUME
Command Description


AUDIT VOLUME

Table 20. Commands related to AUDIT VOLUME (continued)
Command Description
QUERY CONTENT Displays information about files in a storage
pool volume.
processes.
QUERY VOLUME Displays information about storage pool
volumes.
SET ARCHIVERETENTIONPROTECTION Specifies whether data retention protection is
activated.


BACKUP commands

BACKUP commands
Use the BACKUP command to create backup copies of Tivoli Storage Manager
information or objects.

The following are the BACKUP commands for Tivoli Storage Manager:
v “BACKUP DB (Back up the database)” on page 44
v “BACKUP DEVCONFIG (Create backup copies of device configuration
information)” on page 47
v “BACKUP NODE (Back up a NAS node)” on page 49
v “BACKUP STGPOOL (Back up primary storage pool to copy storage pool)” on
page 54
v “BACKUP VOLHISTORY (Save sequential volume history information)” on page
58


BACKUP DB

BACKUP DB (Back up the database)
Use this command to back up a Tivoli Storage Manager database to sequential
access volumes.

To determine how much additional storage space a backup requires, use the
QUERY DB command.

Privilege class

privilege.

Syntax
Type = Incremental
BAckup DB DEVclass = device_class_name
Type = Incremental
Full
DBSnapshot

Scratch = Yes

, Scratch = Yes
No
VOLumenames = volume_name
FILE: file_name

Wait = No

Wait = No
Yes

Parameters
DEVclass (Required)
Specifies the name of the sequential access device class to use for the backup.

Restriction:
v You cannot use a device class with a device type of NAS or CENTERA.
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.


BACKUP DB

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
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:


BACKUP DB

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 may
have already been backed up before the cancellation.
Yes
Specifies that the server processes this command in the foreground. Wait
for the command to complete before continuing with other tasks. The
server then displays the output messages to the administrative client when
the command completes.

Restriction: You cannot specify WAIT=YES from the server console.

Example: Run an incremental backup using a scratch volume

Run an incremental backup of the database using a scratch volume. Use a device
class of FILE for the backup.
backup db devclass=file type=incremental

Related commands
Table 21. Commands related to BACKUP DB
Command Description
BACKUP DEVCONFIG Backs up IBM Tivoli Storage Manager device
information to a file.
BACKUP VOLHISTORY Records volume history information in
external files.
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.
processes.
QUERY VOLHISTORY Displays sequential volume history
information that has been collected by the
server.
SET DRMDBBACKUPEXPIREDAYS Specifies criteria for database backup series
expiration.


BACKUP DEVCONFIG

BACKUP DEVCONFIG (Create backup copies of device
configuration information)
Use this command to back up information about device configuration for the
server. To restore the Tivoli Storage Manager database, device configuration
information must be available.

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.
If you do not specify a file name, Tivoli Storage Manager stores the
information in all files specified with the DEVCONFIG option in the server
options file.


BACKUP DEVCONFIG

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 22. Commands related to BACKUP DEVCONFIG
Command Description
CHECKIN LIBVOLUME Checks a storage volume into an automated
library.
CHECKOUT LIBVOLUME Checks a storage volume out of an
automated library.
DEFINE DEVCLASS Defines a device class.
DEFINE DRIVE Assigns a drive to a library.
DEFINE 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.
SET SERVERNAME Specifies the name by which the server is
identified.
SET SERVERPASSWORD Specifies the server password.
UPDATE DEVCLASS Changes the attributes of a device class.
UPDATE DRIVE Changes the attributes of a drive.
UPDATE LIBVOLUME Changes the status of a storage volume.
UPDATE PATH Changes the attributes associated with a
path.
UPDATE SERVER Updates information about a server.


BACKUP 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 = Preferred Wait = No

MGmtclass = mcname TOC = No Wait = No
Preferred Yes
Yes

MODE = DIFFerential TYPE = BACKUPImage

MODE = FULL TYPE = BACKUPImage
DIFFerential 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.


BACKUP NODE

Tip: See the virtual file space name parameter in the DEFINE
VIRTUALFSMAPPING command for more naming considerations.
In determining the file systems to process, the server will not use any
DOMAIN.NAS, INCLUDE.FS.NAS, or EXCLUDE.FS.NAS statements in any
client option file or client option set. If you back up multiple file systems, the
backup of each file system is a separate server process.
MGmtclass
Specifies the name of the management class to which this backup data is
bound. If you do not specify a management class, the backup data is bound to
the default management class of the policy domain to which the node is
assigned. In determining the management class, the server will not use any
INCLUDE.FS.NAS statements in any client option file or client option set. The
destination management class may refer to a Tivoli Storage Manager native
pool, in which case 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.
TOC
Specifies whether a table of contents (TOC) is saved for each file system
backup. Consider the following in determining whether you want to save a
table of contents.
v If a table of contents is saved, you will be able to use the QUERY TOC
command to determine the contents of a file system backup in conjunction
with the RESTORE NODE command to restore individual files or directory
trees. You will also be able to use the Tivoli Storage Manager Web
backup-archive client to examine the entire file system tree and choose files
and directories to restore. Creation of a table of contents requires that you
define the TOCDESTINATION attribute in the backup copy group for the
management class to which this backup image is bound. Note that a table of
contents creation requires additional processing, network resources, storage
pool space, and possibly a mount point during the backup operation.
v A table of contents for a NAS file system cannot have a directory path
greater than 1024 characters.
v If a table of contents is not saved for a file system backup, you will still be
able to restore individual files or directory trees using the RESTORE NODE
command, provided that you know the fully qualified name of each file or
directory to be restored and the image in which that object was backed up.
This parameter is optional. The default value is Preferred. Possible values
are:
No
Specifies that table of contents information is not saved for file system
backups.
Preferred
Specifies that table of contents information should be saved for file
system backups. However, a backup does not fail just because an error
occurs during creation of the table of contents. This is the default value.
Yes
Specifies that table of contents information must be saved for each file
system backup. A backup fails if an error occurs during creation of the
table of contents.


BACKUP NODE

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
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.


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 23 contains
the virtual file space definitions exist on the server for the node NAS1.
backup node nas1 /mikesdir
Table 23. 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 23 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 24. Commands related to BACKUP NODE
Command Description
BACKUP NAS (Tivoli Storage Manager client Creates a backup of NAS node data.
command)
class.
DEFINE VIRTUALFSMAPPING Define a virtual file space mapping.
QUERY NASBACKUP Displays information about NAS backup
images.


BACKUP NODE

Table 24. Commands related to BACKUP NODE (continued)
Command Description
QUERY TOC Displays details about the table of contents
for a specified backup image.
RESTORE NAS (Tivoli Storage Manager Restores a backup of NAS node data.
client command)
RESTORE NODE Restores a network-attached storage (NAS)
node.
group.


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.

Privilege class

privilege, or restricted storage privilege for the copy storage pool in which backup
copies are to be produced.

Syntax
BAckup STGpool primary_pool_name copy_pool_name

MAXPRocess = 1 Preview = No

MAXPRocess = number Preview = No
Yes
(1)
VOLumesonly


BACKUP STGPOOL

SHREDTONOshred = No Wait = No

SHREDTONOshred = No Wait = No
Yes 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:
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


BACKUP STGPOOL

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
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.
logged.
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 25. Commands related to BACKUP STGPOOL
Command Description
MOVE DRMEDIA Moves DRM media on-site and off-site.
QUERY DRMEDIA Displays information about disaster recovery
volumes.


BACKUP STGPOOL

Table 25. Commands related to BACKUP STGPOOL (continued)
Command Description
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.


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

At installation, the server options file includes a VOLUMEHISTORY option that
specifies a default volume history file named volhist.out. Tivoli Storage Manager
updates volume history files whenever server sequential volume history
information is changed.

In order to ensure updates are complete before the server is halted, we recommend
you:
v Not halt the server for a few minutes after issuing the BACKUP VOLHISTORY
command.
v Specify multiple VOLUMEHISTORY options in the server options file.
v Examine the volume history file to see if the file has been updated.

Privilege class

Any administrator can issue this command unless it includes the FILENAMES
parameter. If the FILENAMES parameter is specified and the
REQSYSAUTHOUTFILE server option is set to YES, the administrator must have
system privilege. If the FILENAMES parameter is specified and the
REQSYSAUTHOUTFILE server option is set to NO, the administrator must have
operator, policy, storage or system privilege.

Syntax
BAckup VOLHistory
,

Filenames = file_name


BACKUP VOLHISTORY

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 26. 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.


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


Syntax
ALL
BEGin EVentlogging
,

CONSOLE
ACTLOG
EVENTSERVER
FILE
FILETEXT
(1)
NTEVENTLOG
(2)
SNMP
TIVOLI
USEREXIT

Notes:
1 This parameter is only available for Windows operating system.
2 This parameter is only available for AIX, HP-UX, Linux, Solaris, Windows
operating systems.

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.


BEGIN EVENTLOGGING

FILE
Specifies a user file as a receiver. Each logged event is a record in the file and a
person cannot read each logged event easily.
FILETEXT
Specifies a user file as a receiver. Each logged event is a fixed-size, readable
line.
NTEVENTLOG
Specifies the Windows application log as a receiver.
SNMP
Specifies the simple network management protocol (SNMP) as a receiver.
TIVOLI
Specifies the Tivoli Management Environment (TME) as a receiver.
USEREXIT
Specifies a user-written routine to which Tivoli Storage Manager writes
information as a receiver.

Example: Begin logging events

Begin logging events to the Tivoli Storage Manager activity log.
begin eventlogging actlog

Related commands
Table 27. 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.


CANCEL commands

CANCEL commands
Use the CANCEL commands to end a task before it is completed.

The following is a list of CANCEL commands for Tivoli Storage Manager:
v “CANCEL EXPIRATION (Cancel an expiration process)” on page 63
v “CANCEL EXPORT (Delete a suspended export operation)” on page 64
v “CANCEL PROCESS (Cancel an administrative process)” on page 65
v “CANCEL REQUEST (Cancel one or more mount requests)” on page 67
v “CANCEL RESTORE (Cancel a restartable restore session)” on page 68
v “CANCEL SESSION (Cancel one or more client sessions)” on page 69


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


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 28. Command related to CANCEL EXPIRATION
Command Description
processes.
processing.


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 29. Commands related to CANCEL EXPORT
Command Description
EXPORT NODE Copies client node information to external
media.
EXPORT SERVER Copies all or part of the server to external
media.
QUERY EXPORT Displays the export operations that are
currently running or suspended.
RESTART EXPORT Restarts a suspended export operation.
SUSPEND EXPORT Suspends a running export operation.


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



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 30. Commands related to CANCEL PROCESS
Command Description
CANCEL EXPORT Deletes a suspended export operation
CANCEL REQUEST Cancels pending volume mount requests.
QUERY EXPORT Displays the export operations that are
currently running or suspended.
processes.
REPLY Allows a request to continue processing.
RESTART EXPORT Restarts a suspended export operation.
SUSPEND EXPORT Suspends a running export operation.


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 31. Commands related to CANCEL REQUEST
Command Description
QUERY REQUEST Displays information about all pending
mount requests.
UPDATE VOLUME Updates the attributes of storage pool
volumes.


CANCEL 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 32. Commands related to CANCEL RESTORE
Command Description
QUERY RESTORE Displays information about restartable restore
sessions.


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 or client node session that you want
to cancel.
ALl
Specifies that all client node sessions are cancelled. You cannot use this
parameter to cancel administrative client sessions.

Example: Cancel a specific client node session
Cancel the client node session with NODEP (session 3).
cancel session 3

Related commands
Table 33. Commands related to CANCEL SESSION
Command Description
DISABLE SESSIONS Prevents new sessions from accessing IBM
Tivoli Storage Manager but permits existing
sessions to continue.
LOCK ADMIN Prevents an administrator from accessing
IBM Tivoli Storage Manager.
LOCK NODE Prevents a client from accessing the server.
QUERY SESSION Displays information about all active
administrator and client sessions with IBM
Tivoli Storage Manager.


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

privilege.

Syntax for SCSI libraries
SEARCH = No
CHECKIn LIBVolume library_name volume_name
SEARCH = Yes
A
SEARCH = Bulk
A

OWNer = ""
STATus = PRIvate
SCRatch OWNer = server_name
CLEaner

CHECKLabel = Yes SWAP = No WAITTime = 60

CHECKLabel = Yes SWAP = No WAITTime = value
No Yes
Barcode


CHECKIN LIBVOLUME

CLEanings = number

A (SEARCH=Yes, SEARCH=Bulk):

VOLRange = volume_name1,volume_name2
,

VOLList = volume_name
FILE: file_name

Syntax for 349X libraries
SEARCH = No
SEARCH = Yes
A

OWNer = ""
STATus = PRIvate

CHECKLabel = Yes SWAP = No

CHECKLabel = Yes DEVType = 3590 SWAP = No
No 3592 Yes

WAITTime = 60

WAITTime = value

A (SEARCH=Yes):

,

FILE: file_name

Syntax for ACSLS libraries
SEARCH = No
SEARCH = Yes
A

OWNer = ""
STATus = PRIvate


CHECKIN LIBVOLUME

CHECKLabel = Yes SWAP = No WAITTime = 60

CHECKLabel = Yes SWAP = No WAITTime = value
No Yes

A (SEARCH=Yes):

,

FILE: file_name

Parameters
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


CHECKIN LIBVOLUME

library client, as recorded in the volume history file on the library manager. If
the volume is not owned by any library client, then the server delegates
ownership to the library manager.
SEARCH
Specifies whether the server searches the library to find volumes that were not
checked in. This parameter is optional. The default is NO.
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:

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.


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.
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.
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.


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


CHECKIN LIBVOLUME

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.
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 34. 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.


CHECKIN LIBVOLUME

Table 34. Commands related to CHECKIN LIBVOLUME (continued)
Command Description
QUERY PROCESS Displays information
about background
processes.
REPLY Allows a request to
continue processing.
UPDATE LIBVOLUME Changes the status of a
storage volume.


CHECKOUT LIBVOLUME

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:

Privilege class

privilege.

Syntax for SCSI library
REMove = Bulk
CHECKOut LIBVolume library_name volume_name
A REMove = Yes
No
Bulk

CHECKLabel = Yes FORCE = No

CHECKLabel = Yes FORCE = No
No Yes


CHECKOUT LIBVOLUME

A :

,

FILE: file_name

Syntax for 349X library
REMove = Bulk
A REMove = Yes
No
Bulk

A :

,

FILE: file_name

Syntax for ACSLS library
REMove = Yes
A REMove = Yes
No
Bulk

CAP = x,y,z

A :

,

FILE: file_name

Parameters
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


CHECKOUT LIBVOLUME

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:

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.
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 are YES, BULK, and NO. 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 35. How theTivoli Storage Manager Server Responds for 349X Libraries
REMOVE=YES REMOVE=BULK REMOVE=NO
The 3494 Library Manager ejects the The 3494 Library Manager ejects the The 3494 Library Manager does not
cartridge to the convenience I/O cartridge to the high-capacity output eject the volume.
station. facility.
The server leaves the cartridge in the
library in the INSERT category for
use by other applications.


CHECKOUT LIBVOLUME

SCSI libraries: The default is BULK. The following table shows how the server
responds for a SCSI libraries.
Table 36. How theTivoli 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 The server leaves the The server leaves the The server leaves the
ports cartridge in its current slot cartridge in its current slot cartridge in its current slot
within the library and within the library and within the library and
specifies the slot address in specifies the slot address in specifies the slot address in
a message. a message. a message.

The server then prompts The server does not prompt The server does not prompt
you to remove the cartridge you to remove the cartridge you to remove the cartridge
from the slot and to issue a and does not require a and does not require a
REPLY command. eREPLY command. REPLY command.
Has entry/exit ports and an The server moves the The server moves the The server leaves the
entry/exit port is available cartridge to the available cartridge to the available cartridge in its current slot
entry/exit port and entry/exit port and within the library 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 The server does not prompt The server does not prompt
you to remove the cartridge you to remove the cartridge you to remove the cartridge
from the slot and to issue a and does not request a and does not require a
REPLY command. REPLY command. REPLY command.
Has entry/exit ports, but no The server leaves the The server waits for an The server leaves the
ports are available cartridge in its current slot entry/exit port to be made cartridge in its current slot
within the library and available. within the library and
specifies the slot address in specifies the slot address in
a message. a message.

The server then prompts The server does not prompt
you to remove the cartridge you to remove the cartridge
from the slot and to issue a and does not require a
REPLY command. REPLY command.

ACSLS libraries: The default is YES. The following table shows how the server
responds for ACSLS libraries.
Table 37. How theTivoli Storage Manager Server Responds for ACSLS Libraries
REMOVE=YES or REMOVE=BULK REMOVE=NO
The server ejects the cartridge to the convenience I/O The server does not eject the cartridge. The server deletes
station, and deletes the volume entry from the server the volume entry from the server library inventory and
library inventory. 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.


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 a CAP priority greater than zero does not exist in the library, this
parameter is required. If a CAP priority greater than zero does exist in the
library, this parameter is optional. If you do not specify the parameter, the
ACSLS server will choose any available CAP with a priority greater than zero.
To display valid CAP identifiers (x,y,z), issue the QUERY CAP command with
ALL specified from the Automated Cartridge System System Administrator
(ACSSA) console on the ACSLS server host. The identifiers are as follows:
x The Automated Cartridge System (ACS) ID. This identifier can be a
number between 0-126.
y The Library Storage Module (LSM) ID. This identifier can be a number
between 0-23.
z The CAP ID. This identifier can be a number between 0-11.

For more information, refer to your 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 38. Commands related to CHECKOUT LIBVOLUME
Command Description
AUDIT LIBRARY Ensures that an automated library is in a
consistent state.
library.
DEFINE VOLUME Assigns a volume to be used for storage
within a specified storage pool.


CHECKOUT LIBVOLUME

Table 38. Commands related to CHECKOUT LIBVOLUME (continued)
Command Description
LABEL LIBVOLUME Labels volumes in manual or automated
libraries.
libraries.
processes.
REPLY Allows a request to continue processing.
UPDATE LIBVOLUME Changes the status of a storage volume.


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

privilege.

Syntax
CLEAN DRIVE library_name drive_name

Parameters
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 39. Commands related to CLEAN DRIVE
Command Description
library.
CHECKOUT LIBVOLUME Checks a storage volume out of an
automated library.
DELETE DRIVE Deletes a drive from a library.
QUERY DRIVE Displays information about drives.


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 40. Commands related to COMMIT
Command Description
MACRO Runs a specified macro file.
ROLLBACK Discards any uncommitted changes to the
database since the last COMMIT was
executed.


COPY commands

COPY commands
Use the COPY commands to create a copy of Tivoli Storage Manager objects.

The following is a list of COPY commands for Tivoli Storage Manager:
v “COPY ACTIVEDATA (Copy active backup data from a primary storage pool to
an active-data pool)” on page 87
v “COPY CLOPTSET (Copy a client option set)” on page 91
v “COPY DOMAIN (Copy a policy domain)” on page 92
v “COPY MGMTCLASS (Copy a management class)” on page 94
v “COPY POLICYSET (Copy a policy set)” on page 96
v “COPY PROFILE (Copy a profile)” on page 98
v “COPY SCHEDULE (Copy a client or an administrative command schedule)” on
page 100
v “COPY SCRIPT (Copy a Tivoli Storage Manager script)” on page 104
v “COPY SERVERGROUP (Copy a server group)” on page 105


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

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 = No SHREDTONOshred = No

Wait = No SHREDTONOshred = No
Yes Yes

Notes:
1 The VOLUMESONLY parameter applies to sequential-access storage pools
only.


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
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
in the foreground. This parameter is optional. The default is NO. Possible
values are:


COPY ACTIVEDATA

No
Specifies that the server processes this command in the background.
You can continue with other tasks while the command is being processed.
logged.
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 41. Commands related to COPY ACTIVEDATA
Command Description
DEFINE DOMAIN Defines a policy domain that clients can be
assigned to.
DEFINE STGPOOL Defines a storage pool as a named collection
of server storage media.
EXPORT NODE Copies client node information to external
media.
EXPORT SERVER Copies all or part of the server to external
media.
IMPORT NODE Restores client node information from
external media.


COPY ACTIVEDATA

Table 41. Commands related to COPY ACTIVEDATA (continued)
Command Description
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.
QUERY CONTENT Displays information about files in a storage
pool volume.
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.
copy storage pools.
pools.
UPDATE DOMAIN Changes the attributes of a policy domain.
UPDATE STGPOOL Changes the attributes of a storage pool.


COPY CLOPTSET

COPY CLOPTSET (Copy a client option set)
Use this command to copy a client option set.

Privilege class

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 42. Commands related to COPY CLOPTSET
Command Description
DEFINE CLIENTOPT Adds a client option to a client option set.
DEFINE CLOPTSET Defines a client option set.
DELETE CLIENTOPT Deletes a client option from a client option
set.
DELETE CLOPTSET Deletes a client option set.
QUERY CLOPTSET Displays information about a client option
set.
UPDATE CLIENTOPT Updates the sequence number of a client
option in a client option set.
UPDATE CLOPTSET Updates the description of a client option set.


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


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

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 43. Commands related to COPY DOMAIN
Command Description
COPY MGMTCLASS Creates a copy of a management class.
class.
assigned to.
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.


COPY DOMAIN

Table 43. Commands related to COPY DOMAIN (continued)
Command Description
classes.
REGISTER NODE Defines a client to the server and sets options
for that user.
group.
class.
the policy set.


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

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
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

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 44. Commands related to COPY MGMTCLASS
Command Description
class.


COPY MGMTCLASS

Table 44. Commands related to COPY MGMTCLASS (continued)
Command Description
classes.
group.
class.


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

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
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 45. Commands related to COPY POLICYSET
Command Description
policy domain.
the policy set.


COPY POLICYSET


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


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

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 46. 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.


COPY PROFILE

Table 46. Commands related to COPY PROFILE (continued)
Command Description
SET CONFIGMANAGER Specifies whether a server is a configuration
manager.
UNLOCK PROFILE Enables a locked profile to be distributed to
managed servers.
UPDATE PROFILE Changes the description of a profile.


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.
Table 47. Commands related to COPY SCHEDULE
Command Description
DEFINE ASSOCIATION Associates clients with a schedule.
DEFINE SCHEDULE Defines a schedule for a client operation or
an administrative command.
DELETE SCHEDULE Deletes a schedule from the database.
QUERY SCHEDULE Displays information about schedules.
UPDATE SCHEDULE Changes the attributes of a schedule.


COPY SCHEDULE

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 = No

new_sched_name REPlace = No
Yes

Parameters
current_domain_name (Required)
Specifies the name of the policy domain that contains the schedule you want to
copy.
current_sched_name (Required)
Specifies the name of the schedule you want to copy.
new_domain_name (Required)
Specifies the name of a policy domain to which you want to copy the new
schedule.
new_sched_name
Specifies the name of the new schedule. You can specify up to 30 characters for
the name.
If you do not specify this name, the name of the original schedule is used.
If the schedule name is already defined in the policy domain, you must specify
REPLACE=YES, or the command fails.
REPlace
Specifies whether to replace a client schedule. The default is NO. The values
are:
No
Specifies that a client schedule is not replaced.
Yes
Specifies that a client schedule is replaced.


COPY SCHEDULE

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.
copy schedule employee_records weekly_backup
prog1 weekly_back2


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 Type = Administrative

REPlace = No

REPlace = No
Yes

Parameters
current_schedule_name (Required)
Specifies the name of the schedule you want to copy.
new_schedule_name (Required)
Specifies the name of the new schedule. You can specify up to 30 characters for
the name.
If the schedule name is already defined, you must specify REPLACE=YES, or
the command fails.
Type=Administrative
Specifies that an administrative command schedule is to be copied.
REPlace
Specifies whether to replace an administrative command schedule. The default
is NO. The values are:
No
Specifies that an administrative command schedule is not replaced.
Yes
Specifies that an administrative command schedule is replaced.

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


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 48. Commands related to COPY SCRIPT
Command Description
DEFINE SCRIPT Defines a script to the IBM Tivoli Storage
Manager server.
DELETE SCRIPT Deletes the script or individual lines from the
script.
QUERY SCRIPT Displays information about scripts.
RENAME SCRIPT Renames a script to a new name.
RUN Runs a script.
UPDATE SCRIPT Changes or adds lines to a script.


COPY SERVERGROUP

COPY SERVERGROUP (Copy a server group)
Use this command to create a copy of a server group.

Privilege class


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 49. Commands related to COPY SERVERGROUP
Command Description
DEFINE GRPMEMBER Defines a server as a member of a server
group.
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 SERVERGROUP Updates a server group.


DEFINE commands

DEFINE commands
Use the DEFINE commands to create Tivoli Storage Manager objects.

The following is a list of DEFINE commands for Tivoli Storage Manager:
v “DEFINE ASSOCIATION (Associate client nodes with a schedule)” on page 107
v “DEFINE BACKUPSET (Define a backup set)” on page 109
v “DEFINE CLIENTACTION (Define a one-time client action)” on page 113
v “DEFINE CLIENTOPT (Define an option to an option set)” on page 119
v “DEFINE CLOPTSET (Define a client option set name)” on page 122
v “DEFINE COLLOCGROUP (Define a collocation group)” on page 123
v “DEFINE COLLOCMEMBER (Define collocation group member)” on page 125
v “DEFINE COPYGROUP (Define a copy group)” on page 127
v “DEFINE DATAMOVER (Define a data mover)” on page 137
v “DEFINE DEVCLASS (Define a device class)” on page 140
v “DEFINE DOMAIN (Define a new policy domain)” on page 213
v “DEFINE DRIVE (Define a drive to a library)” on page 215
v “DEFINE EVENTSERVER (Define a server as the event server)” on page 219
v “DEFINE GRPMEMBER (Add a server to a server group)” on page 220
v “DEFINE LIBRARY (Define a library)” on page 221
v “DEFINE MACHINE (Define machine information for disaster recovery)” on
page 231
v “DEFINE MACHNODEASSOCIATION (Associate a node with a machine)” on
page 233
v “DEFINE MGMTCLASS (Define a management class)” on page 235
v “DEFINE NODEGROUP (Define a node group)” on page 238
v “DEFINE NODEGROUPMEMBER (Define node group member)” on page 239
v “DEFINE PATH (Define a path)” on page 240
v “DEFINE POLICYSET (Define a policy set)” on page 248
v “DEFINE PROFASSOCIATION (Define a profile association)” on page 250
v “DEFINE PROFILE (Define a profile)” on page 256
v “DEFINE RECMEDMACHASSOCIATION (Associate recovery media with a
machine)” on page 258
v “DEFINE RECOVERYMEDIA (Define recovery media)” on page 260
v “DEFINE SCHEDULE (Define a client or an administrative command schedule)”
on page 262
v “DEFINE SCRIPT (Define a Tivoli Storage Manager script)” on page 285
v “DEFINE SERVER (Define a server for server-to-server communications)” on
page 287
v “DEFINE SERVERGROUP (Define a server group)” on page 292
v “DEFINE SPACETRIGGER (Define the space trigger)” on page 293
v “DEFINE STGPOOL (Define a storage pool)” on page 296
v “DEFINE SUBSCRIPTION (Define a profile subscription)” on page 339
v “DEFINE VIRTUALFSMAPPING (Define a virtual file space mapping)” on page
341
v “DEFINE VOLUME (Define a volume in a storage pool)” on page 343


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
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.
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*


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 50. Commands related to DEFINE ASSOCIATION
Command Description
DEFINE SCHEDULE Defines a schedule for a client operation or
an administrative command.
DELETE ASSOCIATION Deletes the association between clients and a
schedule.
QUERY ASSOCIATION Displays the clients associated with one or
more schedules.
for that user.


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 backup_set_name_prefix
node_group_name

,

DEVclass = device_class_name VOLumes = volume_names

RETention = 365

RETention = days DESCription = description
NOLimit

WHEREDATAType = ALL

, TOC = PREFERRED
YES
WHEREDATAType = FILE NO
IMAGE

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


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.


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


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 51. Commands related to DEFINE BACKUPSET
Command Description
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DELETE NODEGROUP Deletes a node group.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a 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.


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

privilege, or restricted policy for the policy domain to which the schedule belongs.

Syntax
*
DEFine CLIENTAction
,
(1)
node_name

DOmain = *

,

DOmain = domain_name


DEFINE CLIENTACTION

| ACTion = Incremental

ACTion = Incremental
Selective
Archive
""
SUBACTion =
FASTBack
SYSTEMSTate
VM
Backup
""
SUBACTion =
FASTBack
SYSTEMSTate
VM
REStore
RETrieve
IMAGEBACkup
IMAGEREStore
Command
Macro

OPTions = option_string OBJects = object_string

Wait = No

Wait = No
Yes

Notes:
1 If you explicitly specify a NAS node name, the command will fail. If you
provide a pattern-matching expression for the node, any NAS nodes that
match the pattern will be ignored.

Parameters
node_name
Specifies the list of client nodes that will process the schedule associated with
the action. You can use a wildcard character to specify a client node or a list of
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


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
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
SUBACTion
"" 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.


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


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. The
following examples show how to specify some file names:
v To specify C:FILE 2, D:GIF FILES, and E:MY TEST FILE, enter:
OBJECTS='"C:FILE 2" "D:GIF FILES" "E:MY TEST FILE"'
v To specify D:TEST FILE, enter:
OBJECTS='"D:TEST FILE"'

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
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.
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.


DEFINE CLIENTACTION

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 52. Commands related to DEFINE CLIENTACTION
Command Description
QUERY ASSOCIATION Displays the clients associated with one or
more schedules.
QUERY EVENT Displays information about scheduled and
completed events for selected clients.
SET CLIENTACTDURATION Specifies the duration of a schedule defined
using the DEFINE CLIENTACTION
command.


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 SEQnumber = number
Yes

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://publib.boulder.ibm.com/infocenter/tsminfo/v6r2).

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:projtextdevel.*"
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 120 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


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:adminfile.txt from backup services.
define clientopt engbackup inclexcl "exclude c:adminfile.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 FilesMy Apps to a management class named
PRODCLASS.
define clientopt winspec inclexcl "include C:Data...* prodclass"
define clientopt winspec inclexcl "include 'C:Program
FilesMy Apps...*' prodclass"

Related commands
Table 53. Commands related to DEFINE CLIENTOPT
Command Description
COPY CLOPTSET Copies a client option set.
DEFINE CLOPTSET Defines a client option set.
set.
for that user.


DEFINE CLIENTOPT

Table 53. Commands related to DEFINE CLIENTOPT (continued)
Command Description
set.
UPDATE NODE Changes the attributes associated with a
client node.


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 54. Commands related to DEFINE CLOPTSET
Command Description
COPY CLOPTSET Copies a client option set.
DEFINE CLIENTOPT Adds a client option to a client option set.
set.
set.


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

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 55. Commands related to DEFINE COLLOCGROUP
Command Description
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
DELETE COLLOCGROUP Deletes a collocation group.
DELETE COLLOCMEMBER Deletes a client node from a collocation
group.
QUERY COLLOCGROUP Displays information about collocation
groups.
REMOVE NODE Removes a client from the list of registered
nodes for a specific policy domain.


DEFINE COLLOCGROUP

Table 55. Commands related to DEFINE COLLOCGROUP (continued)
Command Description
UPDATE COLLOCGROUP Updates the description of a collocation
group.


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 56. Commands related to DEFINE COLLOCMEMBER
Command Description
DEFINE COLLOCGROUP Defines a collocation group.
group.
groups.


DEFINE COLLOCMEMBER

Table 56. Commands related to DEFINE COLLOCMEMBER (continued)
Command Description
group.


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.
Table 57. 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.
DELETE COPYGROUP Deletes a backup or archive copy group from
a policy domain and policy set.
processing.
classes.
SET ARCHIVERETENTIONPROTECTION Specifies whether data retention protection is
activated.
group.


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

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 FREQuency = 0
DESTination = pool_name
Type = Backup FREQuency = days

VERExists = 2 VERDeleted = 1

VERExists = number VERDeleted = number
NOLimit NOLimit

RETExtra = 30 RETOnly = 60

RETExtra = days RETOnly = days
NOLimit NOLimit

MODE = MODified SERialization = SHRSTatic

MODE = MODified SERialization = SHRSTatic
ABSolute STatic
SHRDYnamic
DYnamic

TOCDestination = pool_name

Parameters
Specifies the policy domain for which you are defining the copy group.
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.
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.



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



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:



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.



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


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

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

FREQuency = Cmd
Type = Archive DESTination = pool_name
FREQuency = Cmd

RETVer = 365 RETInit = CREATion

RETVer = days RETInit = EVent
NOLimit

RETMin = 365 MODE = ABSolute

RETMin = days MODE = ABSolute

SERialization = SHRSTatic

SERialization = SHRSTatic
STatic
SHRDYnamic
DYnamic

Parameters
Specifies the name of the policy domain for which you are defining the copy
group.
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.
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.



DESTination (Required)
Specifies the primary storage pool where the server initially stores the archive
copy. You cannot specify a copy storage pool as the destination.
FREQuency=Cmd
Specifies the copy frequency, which must be CMD. This parameter is optional.
The default value is CMD.
RETVer
Specifies the number of days to keep an archive copy. This parameter is
optional. The default value is 365. Possible values are:
days
Specifies the number of days to keep an archive copy. You can specify an
integer from 0 to 30000.
If you specify a value of 0 (zero), and the destination storage pool for the
archive copy group is a Snaplock storage pool
(RECLAMATIONTYPE=SNAPLOCK), retention of the volumes will be set
using the value of the server option RETENTIONEXTENSION. The default
value for the RETENTIONEXTENSION option is 365 (days).
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:
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.

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 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 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


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

privilege.

Syntax
DEFine DATAMover data_mover_name Type = NAS HLAddress = address

LLAddress = 10000
USERid = userid PASsword = password
LLAddress = tcp_port

ONLine = Yes
DATAFormat = NETAPPDump
ONLine = Yes CELERRADump
No 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.


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


DEFINE DATAMOVER

Related commands
Table 58. Commands related to DEFINE DATAMOVER
Command Description
DELETE DATAMOVER Deletes a data mover.
QUERY DATAMOVER Displays data mover definitions.
for that user.
UPDATE DATAMOVER Changes the definition for a data mover.


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 use of a device.

Note: The DISK device class is defined by IBM Tivoli Storage Manager and cannot
be modified with the DEFINE DEVCLASS command.

The syntax and parameter descriptions are provided according to the device type.
The syntax and parameter information is presented in the following order:
v 3570 (“Syntax” on page 141)
v 4MM (“Syntax” on page 153)
v 8MM (“Syntax” on page 157)
v CENTERA (“Syntax” on page 163)
v DLT (“Syntax” on page 165)
v DTF (“Syntax” on page 171)
v ECARTRIDGE (“Syntax” on page 174)
v FILE (“Syntax” on page 180)
v GENERICTAPE (“Syntax” on page 183)
v LTO (“Syntax” on page 186)
v NAS (“Syntax” on page 192)
v OPTICAL and WORM Types (“Syntax” on page 195)
v QIC (“Syntax” on page 199)
v REMOVABLEFILE (“Syntax” on page 204)
v SERVER (“Syntax” on page 207)
v VOLSAFE (“Syntax” on page 209)
Table 59. Commands related to DEFINE DEVCLASS
Command Description
BACKUP DEVCONFIG Backs up IBM Tivoli Storage Manager device
information to a file.
DELETE DEVCLASS Deletes a device class name.
QUERY DEVCLASS Displays information about device classes.
QUERY DIRSPACE Displays information about FILE directories.


DEFINE DEVCLASS — 3570

DEFINE DEVCLASS (Define a 3570 device class)
Use the 3570 device class when you are using 3570 tape devices.

Privilege class

privilege.

Syntax

DEFine DEVclass device_class_name LIBRary = library_name

FORMAT = DRIVE
DEVType = 3570
FORMAT = DRIVE ESTCAPacity = size
3570B
3570C

PREFIX = ADSM MOUNTRetention = 60

PREFIX = ADSM MOUNTRetention = minutes
tape_volume_prefix

MOUNTWait = 60 MOUNTLimit = DRIVES

MOUNTWait = minutes MOUNTLimit = DRIVES
number
0

Parameters
device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of
the device class name is 30 characters.
LIBRary (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:



Table 60. Recording format and default estimated capacity for 3570 tape volumes
Estimated
Format Capacity Description
DRIVE — The server selects the highest format that is
supported by the drive on which a volume is
mounted.

Attention: Avoid specifying DRIVE when a mixture
of drives is used within the same library. For
example, do not use this option for a library
containing some drives that support recording
formats superior to other drives.
3570B 5.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 60.
PREFIX
Specifies the high level qualifier of the data set name that the server writes into
the sequential access media labels. For each sequential access volume assigned
to this device class, the server uses this prefix to create the data set name. This
parameter is optional. The default value is ADSM. The maximum length of this
prefix is 8 characters.
If you have already established a media label naming convention that supports
your current management system, use a volume prefix that conforms to your
naming conventions.
Values specified for this parameter must meet the following conditions:
v The value is to be made up of qualifiers, which can contain up to eight
characters (including periods). For example, the following value would be
acceptable:
AB.CD2.E
v The qualifiers must be separated by a single period.
v The first letter of each qualifier must be 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 1 to 4096.
If you plan to use the simultaneous-write function, ensure that sufficient drives
are available for the write operation. If the number of drives needed for a
simultaneous-write operation is greater than the value of the MOUNTLIMIT
parameter for a device class, the transaction fails.
For details about the simultaneous-write function, refer to 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.




Privilege class

privilege.

Syntax


FORMAT = DRIVE
DEVType = 3590
3590B
3590C
3590E-B
3590E-C
3590H-B
3590H-C


tape_volume_prefix


number
0

Parameters
LIBRary (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
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:



Table 61. Recording formats and default estimated capacities for 3590
Estimated
Format Description
Capacity
DRIVE – The server selects the highest format that is
mounted.

3590B 10.0 GB Uncompressed (basic) 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 Uncompressed (basic) format, similar to the 3590B
cartridge – format
standard—
length)

60.0 GB (K
cartridge -
extended length)
3590H-C See note Compressed format, similar to the 3590C format

60.0 GB (J
cartridge -
standard length)

120.0 GB (K
cartridge -
extended length)

Table 62. 3590 device recording format selections
Format
Device
3590B 3590C 3590E-B 3590E-C 3590H-B 3590H-C

3590 Read/Write Read/Write – – – –
Ultra SCSI Read/Write Read/Write – – – –
3590E Read Read Read/Write Read/Write – –
3590H Read Read Read Read Read/Write Read/Write

ESTCAPacity



ESTCAPACITY=100K).
PREFIX
naming conventions.
acceptable:
AB.CD2.E
ADSM.BFS.
MOUNTRetention
MOUNTWait
MOUNTLimit



Guide.
DRIVES
status).

MOUNTLIMIT value.
number
this device class.
0 (zero)




Privilege class

privilege.

Syntax


WORM = No SCALECAPacity = 100
DEVType = 3592
WORM = Yes SCALECAPacity = 100
No 90
20

FORMAT = DRIVE

3592
3592C
3592-2
3592-2C
3592-3
3592-3C


tape_volume_prefix


number
0

DRIVEEncryption = ALLOW

DRIVEEncryption = ON
ALLOW
OFF

Parameters
LIBRary (Required)
Specifies the 3592 device type is assigned to the device class.



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 221.
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
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 63. Recording formats and default estimated capacities for 3592
Estimated
Format Description
Capacity
mounted.

3592 300 GB Uncompressed (basic) format

900 GB
3592-2 500 GB Uncompressed (basic) format JA tapes

700 GB Uncompressed (basic) format JB tapes
3592-2C 1.5 TB Compressed format JA tapes

2.1 TB Compressed format JB tapes
3592–3 640 GB Uncompressed (basic) format JA tapes

1 TB Uncompressed (basic) format JB tapes
3592–3C 1.9 TB Compressed format JA tapes

3 TB Compressed format JB tapes
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
ESTCAPACITY=100K).
PREFIX



naming conventions.
acceptable:
AB.CD2.E
ADSM.BFS.
MOUNTRetention
MOUNTWait
MOUNTLimit
Guide.
DRIVES
status).



Tip: For EXTERNAL library types, do not use the DRIVES default for the
MOUNTLIMIT value.
number
this device class.
0 (zero)
DRIVEEncryption
Specifies whether drive encryption will be permitted. This parameter is
optional. The default is ALLOW.
ON
Specifies that Tivoli Storage Manager is the key manager for drive
encryption and will permit drive encryption for empty storage pool
volumes only if the application method is enabled. (Other types of
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.


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

privilege.

Syntax


FORMAT = DRIVE
DEVType = 4MM
DDS1
DDS1C
DDS2
DDS2C
DDS3
DDS3C
DDS4
DDS4C
DDS5
DDS5C
DDS6
DDS6C

PREFIX = ADSM MOUNTWait = 60

PREFIX = ADSM MOUNTWait = minutes
tape_volume_prefix

MOUNTRetention = 60 MOUNTLimit = DRIVES

MOUNTRetention = minutes MOUNTLimit = DRIVES
number
0

Parameters
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
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



The following table lists the recording formats and estimated capacities for 4
mm devices:
Table 64. Recording formats and default estimated capacities for 4 mm tapes
Estimated
DRIVE — The server selects the highest format that is
mounted.

DDS1 2.6 GB (60-meter) Uncompressed format, only applies to 60-meter and
90-meter tapes
4.0 GB (90-meter)
DDS1C See note Compressed format, only applies to 60-meter and
90-meter tapes
1.3 GB (60-meter)

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
tapes

24.0 GB
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



ESTCAPacity
ESTCAPACITY=100K).
For more information on the default estimated capacity for 4 mm tapes, see
Table 64 on page 154.
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
naming conventions.
acceptable:
AB.CD2.E
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.
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
MOUNTLimit



Guide.
DRIVES
status).

MOUNTLIMIT value.
number
class by the server. This value must never exceed the number of drives that
are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.



DEFINE DEVCLASS (Define an 8MM device class)
Use the 8MM device class when you are using 8 mm tape devices.

Privilege class

privilege.

Syntax


WORM = NO FORMAT = DRIVE
DEVType = 8MM
YES 8200
8200C
8500
8500C
8900
AIT
AITC
M2
M2C
SAIT
SAITC
VXA2
VXA2C
VXA3
VXA3C

PREFIX = ADSM

ESTCAPacity = size PREFIX = ADSM
tape_volume_prefix

MOUNTRetention = 60 MOUNTWait = 60

MOUNTRetention = minutes MOUNTWait = minutes

MOUNTLimit = DRIVES

MOUNTLimit = DRIVES
number
0

Parameters
LIBRary (Required)
Specifies the name of the defined library object that contains the 8 mm tape



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

Note: If you select YES, the only options available for the FORMAT
parameter are:
v DRIVE
v AIT
v AITC
No

FORMAT
The following table lists the recording formats and estimated capacities for 8
mm devices:
Table 65. Recording format and default estimated capacity for 8 mm tape
Format

Medium Type Estimated Capacity Description
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



Table 65. Recording format and default estimated capacity for 8 mm tape (continued)
Format

8500 See note Drives (Read Write)

15m 600 MB Eliant 820 (RW)
15m 600 MB Exabyte 8500/8500C (RW)
15m 600 MB Exabyte 8505 (RW)
54m 2.35 GB Eliant 820 (RW)
54m 2.35 GB Exabyte 8500/8500C (RW)
54m 2.35 GB Exabyte 8505 (RW)
112m 5 GB or 10.0 GB Eliant 820 (RW)
112m 5 GB or 10.0 GB Exabyte 8500/8500C (RW)
112m 5 GB or 10.0 GB Exabyte 8505 (RW)
160m XL 7 GB Eliant 820 (RW)
8500C See note Drives (Read Write)

15m 1.2 GB Exabyte 8500/8500C (RW)
54m 4.7 GB Exabyte 8500/8500C (RW)
112m 5 GB or 10.0 GB Eliant 820 (RW)
112m 5 GB or 10.0 GB Exabyte 8500/8500C (RW)
112m 5 GB or 10.0 GB Exabyte 8505 (RW)
160m XL 7 GB Eliant 820 (RW)
8900 See note Drive (Read Write)

15m – Mammoth 8900 (R)
54m – Mammoth 8900 (R)
112m – Mammoth 8900 (R)
160m XL – Mammoth 8900 (R)
22m 2.5 GB Mammoth 8900 (RW)
125m – Mammoth 8900 (RW with upgrade)
170m 40 GB Mammoth 8900 (RW)
AIT See note Drive

SDX1–25C 25 GB AIT, AIT2 and AIT3 drives
SDX2–36C 36 GB AIT2 and AIT3 drives
SDX3–100C 100 GB AIT3, AIT4, and AIT5 drives
SDX3X-150C 150 GB AIT3-Ex, AIT4, and AIT5 drives
SDX5-400C 400 GB AIT5 drive
AITC See note Drive

SDX3–100C 260 GB AIT3, AIT4, and AIT5 drives
SDX3X-150C 390 GB AIT3-Ex, AIT4, and AIT5 drives
SDX5-400C 1040 GB AIT5 drive



Table 65. Recording format and default estimated capacity for 8 mm tape (continued)
Format

M2 See note Drive (Read Write)

75m 20.0 GB Mammoth II (RW)
M2C See note Drive (Read Write)

SAIT See note Drive (Read Write)

500 GB Sony SAIT1–500(RW)
SAITC See note Drive (Read Write)

1300 GB (1.3 TB) Sony SAIT1–500(RW)
VXA2 See note Drive (Read Write)

V6 (62m) 20 GB VXA–2
V10 (124m) 40 GB
V17 (170m) 60 GB
VXA2C See note Drive (Read Write)

V6 (62m) 40 GB VXA–2
V10 (124m) 80 GB
V17 (170m) 120 GB
VXA3 See note Drive (Read Write)

X6 (62m) 40 GB VXA–3
X10 (124m) 86 GB
X23 (230m) 160 GB
VXA3C See note Drive (Read Write)

X6 (62m) 80 GB VXA–3
X10 (124m) 172 GB
X23 (230m) 320 GB
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
Specify this value as an integer followed by K (kilobytes), M (megabytes), or G
(gigabytes).



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
PREFIX
naming conventions.
acceptable:
AB.CD2.E
ADSM.BFS.
MOUNTRetention
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
MOUNTLimit



DRIVES
status).

MOUNTLIMIT value.
number
this device class.
0 (zero)

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


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

privilege.

Syntax

DEFine DEVclass device_class_name DEVType = CENTERA

,
(1) MINCAPacity = 100M
HLAddress = ip_address ?PEA_file
MINCAPacity = size

MOUNTLimit = 1

MOUNTLimit = number

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
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:controlFilesTSM.PEA


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.
(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.


DEFINE DEVCLASS — DLT

DEFINE DEVCLASS (Define a DLT device class)
Use the DLT device class when you are using DLT tape devices.

Privilege class

privilege.

Syntax


DEVType = DLT
YES DLT1
DLT1C
DLT10
DLT10C
DLT15
DLT15C
DLT20
DLT20C
DLT35
DLT35C
DLT40
DLT40C
DLT2
DLT2C
DLT4
DLT4C
SDLT
SDLTC
SDLT320
SDLT320C
SDLT600
SDLT600C
DLTS4
DLTS4C

PREFIX = ADSM

tape_volume_prefix



MOUNTLimit = DRIVES

MOUNTLimit = DRIVES
number
0



Parameters
LIBRary (Required)
Specifies the name of the defined library object that contains the DLT tape
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
Yes

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

For more information, refer to the Administrator's Guide.
FORMAT
access media. This parameter is optional; the default value is DRIVE.
DLT devices:
Table 66. Recording format and default estimated capacity for DLT
Estimated
mounted.

DLT1 40.0 GB Uncompressed format, using only CompacTape III
cartridges

Valid with DLT4000, DLT7000, and DLT8000 drives



Table 66. Recording format and default estimated capacity for DLT (continued)
Estimated
DLT1C See note 1 on Compressed format, using only CompacTape III
page 168. cartridges

80.0 GB Valid with DLT4000, DLT7000, and DLT8000 drives
DLT10 10.0 GB Uncompressed format, using only CompacTape III
cartridges

DLT10C See note 1 on Compressed format, using only CompacTape III

DLT15 15.0 GB Uncompressed format, using only CompacTape IIIxt
cartridges

DLT15C See note 1 on Compressed format, using only CompacTape IIIxt

DLT20 20.0 GB Uncompressed format, using only CompacTape IV
cartridges

DLT20C See note 1 on Compressed format, using only CompacTape IV

DLT35 35.0 GB Uncompressed format, using only CompacTape IV
cartridges

Valid with DLT7000 and DLT8000 drives
DLT35C See note 1 on Compressed format, using only CompacTape IV

70.0 GB Valid with DLT7000 and DLT8000 drives
DLT40 40.0 GB Uncompressed format, using CompacTape IV
cartridges

Valid with a DLT8000 drive
DLT40C See note 1 on Compressed format, using CompacTape IV cartridges
page 168.
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 Compressed format, using Quantum DLT tape VS1
page 168. media

160.0 GB



Table 66. Recording format and default estimated capacity for DLT (continued)
Estimated
DLT4 160.0 GB Uncompressed format, using Quantum DLTtape VS1
cartridges.

Valid with Quantum DLT-V4 drive
DLT4C See note 1. Compressed format, using Quantum DLTtape VS1
cartridges.
320.0 GB
Valid with Quantum DLT-V4 drive
SDLT 100.0 GB Uncompressed format, using Super DLT Tape 1
cartridges
See note 2.
Valid with a Super DLT drive
SDLTC See note 1. Compressed format, using Super DLT Tape 1
cartridges
See note 2. 200.0 GB
SDLT320 160.0 GB Uncompressed format, using Quantum SDLT I media

See note 2. 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

SDLT600C See note 1. Compressed format, using SuperDLTtape-II media

600.0 GB Valid with a Super DLT drive
DLTS4 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
(megabytes), or G (gigabytes).
is, ESTCAPACITY=100K).



For more information on estimated capacities, see Table 66 on page 166.
PREFIX
naming conventions.
acceptable:
AB.CD2.E
ADSM.BFS.
MOUNTRetention
MOUNTWait
MOUNTLimit
Guide.



DRIVES
status).

MOUNTLIMIT value.
number
0 (zero)


DEFINE DEVCLASS — DTF

DEFINE DEVCLASS (Define a DTF device class)
Use the DTF device class when you are using DTF tape devices.

Privilege class

privilege.

Syntax


FORMAT = DRIVE
DEVType = DTF
DTF
DTFC
DTF2
DTF2C


tape_volume_prefix


number
0

Parameters
LIBRary (Required)
Specifies the name of the defined library object that contains the DTF tape
DEVType=DTF (Required)
Specifies that the DTF tape devices are assigned to this device class.
FORMAT
DTF devices:



Table 67. Recording format and default estimated capacity for DTF
Estimated
DRIVE – The server selects the highest format that is supported by
the drive on which a volume is mounted.

Attention: Avoid specifying DRIVE when a mixture of
drives is used within the same library. For example, do
not use this option for a library containing some drives
that support recording formats superior to other drives.
DTF 12.0 GB Using GW-240 tape cassettes
42.0 GB Using GW-730L tape cassettes
DTFC 24.0 GB Using GW-240 tape cassettes
84.0 GB Using GW-730L tape cassettes
DTF2 60.0 GB Using GW2-60GS tape cassettes
200.0 GB Using GW2-200GL tape cassettes
DTF2C 120.0 GB Using GW2-60GS tape cassettes
400.0 GB Using GW2-200GL tape cassettes

ESTCAPacity
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.
ESTCAPACITY=100K).
For more information on estimated capacities, see Table 67.
PREFIX
naming conventions.
acceptable:
AB.CD2.E
ADSM.BFS.



MOUNTRetention
MOUNTWait
MOUNTLimit
Guide.
DRIVES
status).

MOUNTLIMIT value.
number
this device class.
0 (zero)


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

privilege.

Syntax


DEVType = ECARTridge
YES 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

PREFIX = ADSM

tape_volume_prefix





| (1) (2)
MOUNTLimit = DRIVES DRIVEEncryption = ALLOW

MOUNTLimit = DRIVES DRIVEEncryption = ON
number ALLOW
0 EXTERNAL
OFF

Notes:
| 1 You cannot specify both WORM=YES and DRIVEENCRYPTION=ON.
| 2 You can use drive encryption only for Sun StorageTek T10000B drives that
| have a format value of DRIVE, T10000B or T10000B-C.

Parameters
LIBRary (Required)
Specifies the name of the defined library object that contains the ECARTRIDGE
tape drives that can be used by this device class. For information about
defining a library object, see the DEFINE LIBRARY command.
DEVType=ECARTridge (Required)
Specifies that the ECARTRIDGE device type is assigned to the device class.
ECARTRIDGE indicates that a specific type of cartridge tape device
(StorageTek) is assigned to this device class.
WORM
Specifies whether the drives 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 9840
v 9840-C
v T9840D
v T9840D-C
v T10000A
v T10000A-C
v T10000B
v T10000B-C
FORMAT
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



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.
ECARTRIDGE devices:
Table 68. Recording formats and default estimated capacities for ECARTRIDGE tapes
Estimated
Format capacity Description
mounted.

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'
SD3BC 100 GB Compressed format, using a 25 GB 'B' cartridge with
SD3C 50 GB Uncompressed (standard) format, using a 50 GB 'C'
SD3CC 200 GB Compressed format, using a 50 GB 'C' cartridge with
9840 20 GB Uncompressed 9840 format, using a Sun StorageTek
9840 cartridge
9840-C 80 GB LZ-1 Enhanced (4:1) compressed 9840 format, using a
Sun StorageTek 9840 cartridge
9940 60 GB Uncompressed 9940 format, using a Sun StorageTek
9940 cartridge
9940-C 120 GB Compressed 9940 format, using a Sun StorageTek
9940 cartridge
9940B 200 GB Uncompressed 9940B format, using a Sun StorageTek
9940 cartridge
9940B-C 400 GB Compressed 9940B format, using a Sun StorageTek
9940 cartridge
M8100 10 GB Uncompressed (standard) format, using a 10 GB
cartridge



Table 68. Recording formats and default estimated capacities for ECARTRIDGE
tapes (continued)
Estimated
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 Sun
StorageTek 9840 cartridge
T9840C-C 80 GB Compressed T9840C format, using a Sun StorageTek
9840 cartridge
T9840D 75 GB Uncompressed T9840D format, using a Sun
StorageTek 9840 cartridge
T9840D-C 150 GB Compressed T9840D format, using a Sun StorageTek
9840 cartridge
T10000A 500 GB Uncompressed T10000A format, using a Sun
StorageTek T10000 cartridge
T10000A-C 1 TB Compressed T10000A format, using a Sun StorageTek
T10000 cartridge
T10000B 1 TB Uncompressed T10000B format, using a Sun
StorageTek T10000 cartridge
T10000B-C 2 TB Compressed T10000B format, using a Sun StorageTek
T10000 cartridge
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.

ESTCAPacity
ESTCAPACITY=100K).
PREFIX
Specifies the high-level qualifier of the data set name that the server writes into
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.



acceptable:
AB.CD2.E
ADSM.BFS is an example of a tape volume filename using the default prefix
and the added server qualifier.
MOUNTRetention
MOUNTWait
MOUNTLimit
Guide.
DRIVES
status).

MOUNTLIMIT value.
number
this device class.



0 (zero)
| DRIVEEncryption
| Specifies whether drive encryption is permitted. This parameter is optional.
| The default is ALLOW.

| Restrictions:
| 1. You can use drive encryption only for Sun StorageTek T10000B drives that
| have a format value of DRIVE, T10000B, or T10000B-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.
| 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.


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

privilege.

Syntax

DEFine DEVclass device_class_name DEVType = FILE

MOUNTLimit = 20 MAXCAPacity = 2G

MOUNTLimit = number MAXCAPacity = size

DIRectory = current_directory_name SHAREd = No

, SHAREd = No
Yes
DIRectory = directory_name

Parameters
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 1 to 4096.
If the device class will be shared with a storage agent (by specifying the
SHARED=YES parameter), drives will be defined or deleted to match the
mount limit value.
Guide.



MAXCAPacity
Specifies the maximum size of any data storage files defined to a storage pool
in this device class.
The value of the MAXCAPACITY parameter is also used as the unit of
allocation when storage pool space triggers create volumes. The default value
is 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.
(gigabytes). The minimum value you can use is 100 KB
(MAXCAPACITY=100K).
DIRectory
Specifies the directory location or locations of the files used in this device class.
Enclose the entire list of directories within quotation marks, using commas to
separate individual directory names. Special characters (for example, blank
spaces) are permitted within directory names. For example, the directory list
"abc def,xyz" contains two directories: abc def and xyz.
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:server00566497.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 240.

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
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


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

privilege.

Syntax


DEVType = GENERICTAPE
ESTCAPacity = size



MOUNTLimit = DRIVES

MOUNTLimit = DRIVES
number
0

Parameters
LIBRary (Required)
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.



ESTCAPacity
Specify a capacity appropriate to the particular tape drive being used.
ESTCAPACITY=100K).
MOUNTRetention
MOUNTWait
MOUNTLimit
Guide.
DRIVES
status).

MOUNTLIMIT value.
number



this device class.
0 (zero)


DEFINE DEVCLASS — LTO

DEFINE DEVCLASS (Define an LTO device class)
Use the LTO device class when you are using LTO tape devices.

Privilege class

privilege.

Syntax


| (1)
DEVType = LTO
YES ULTRIUM
ULTRIUMC
ULTRIUM2
ULTRIUM2C
ULTRIUM3
ULTRIUM3C
ULTRIUM4
ULTRIUM4C
ULTRIUM5
ULTRIUM5C

PREFIX = ADSM

tape_volume_prefix



(1) (2)
MOUNTLimit = DRIVES DRIVEEncryption = ALLOW

MOUNTLimit = DRIVES DRIVEEncryption = ON
number ALLOW
0 EXTERNAL
OFF

Notes:
1 You cannot specify both WORM=YES and DRIVEENCRYPTION=ON.
| 2 Drive encryption is supported only for IBM, HP, and Quantum Ultrium 4
| drives and media.

Parameters



LIBRary (Required)
Specifies the name of the defined library object that contains the LTO tape
DEVType=LTO (Required)
Specifies that the linear tape open (LTO) device type is assigned to the device
class.
WORM
Yes

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

For more information, refer to the Administrator's Guide.
FORMAT
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 69. Read - write capabilities for different generations of LTO drives
Generation 1 Generation 2 Generation 3 Generation 4 Generation 5
Drives media media media media media
Generation 1 Read and n/a n/a n/a n/a
write
Generation 2 Read and Read and n/a n/a n/a
write write
Generation 3 Read only Read and Read and n/a n/a
1
write write
Generation 4 n/a Read only Read and Read and n/a
2
write write



Table 69. Read - write capabilities for different generations of LTO drives (continued)
Generation 1 Generation 2 Generation 3 Generation 4 Generation 5
Drives media media media media media
| Generation 5 n/a n/a Read only Read and Read and
2
| write 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 or Generation 5 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. Generation 5 drives can read and write to Generation 4 and Generation 5 media,
| but Generation 5 drives can only read Generation 3 media.

LTO devices:
Table 70. Recording format and default estimated capacity for LTO
Estimated
mounted.

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
cartridges

800 GB
cartridges

1.6 TB
| ULTRIUM5 1.5 TB Uncompressed (standard) format, using Ultrium 5
| cartridges
| ULTRIUM5C See note Compressed format, using Ultrium 5 cartridges

| 3.0 TB
Note: If this format uses the tape-drive hardware-compression feature, depending on the



ESTCAPacity
| 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.
PREFIX
naming conventions.
acceptable:
AB.CD2.E
ADSM.BFS.
MOUNTRetention
library types, you can enhance device sharing between applications by setting
this parameter to a low value (for example, two minutes).
MOUNTWait
MOUNTLimit



Guide.
DRIVES
status).

MOUNTLIMIT value.
number
0 (zero)
DRIVEEncryption
Specifies whether drive encryption will be permitted. This parameter is
optional. The default is ALLOW.

Restriction:
1. Drive encryption is supported only for IBM and HP Ultrium 4 drives and
media.
2. You cannot specify Tivoli Storage Manager as the key manager for drive
encryption of WORM (write once, read many) media. (Specifying both
WORM=YES and DRIVEENCRYPTION=ON is not supported.)
ON
Specifies that Tivoli Storage Manager is the key manager for drive
encryption and will permit drive encryption for empty storage pool
volumes only if the application method is enabled. (Other types of
volumes will not be 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 will not be
permitted and backup operations will fail.
ALLOW
encryption. However, drive encryption for empty volumes is permitted if
another method of encryption is enabled.
EXTERNAL
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


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

privilege.

Syntax

DEFine DEVclass device_class_name DEVType = NAS

MOUNTWait = 60
LIBRary = library_name MOUNTRetention = 0
MOUNTWait = minutes

MOUNTLimit = DRIVES
ESTCAPacity = size
MOUNTLimit = DRIVES
number
0

PREFIX = ADSM

PREFIX = ADSM
tape_volume_prefix

Parameters
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
MOUNTRetention=0 (Required)
before dismounting it. Zero (0) is the only supported value for device classes
with DEVType=NAS.
MOUNTWait



MOUNTLimit
Guide.
DRIVES
status).

Tip: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value.
number
0 (zero)
ESTCAPacity (Required)
ESTCAPACITY=100K).
For example, ESTCAPACITY=100G specifies that the estimated capacity for a
volume in this device class is 100 GB.
PREFIX
naming conventions.
acceptable:
AB.CD2.E



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


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

privilege.

Syntax


FORMAT = DRIVE
DEVType = OPTical
WORM FORMAT = DRIVE
WORM12 (1)
WORM14 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

ESTCAPacity = size MOUNTRetention = minutes


number
0

Notes:
1 Not available for WORM12 or WORM14 device types
2 Available only for WORM12 device types



3 Available only for WORM14 device types

Parameters
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.
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
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.
OPTICAL and WORM devices:
Table 71. Estimated capacities for OPTICAL and WORM drives
Estimated
mounted.

650MB 650 MB Using a 650 MB 5.25-inch optical drive

Not valid for WORM12 or WORM14 device types



Table 71. Estimated capacities for OPTICAL and WORM drives (continued)
Estimated



5600MB 5600 MB Using a 5600 MB 12-inch optical drive

Valid for WORM12 device types only



Only valid for WORM14 device types


23GB 23 GB Using Sony Blue Laser read-write and WORM media

30GB 30 GB Using Plasmon UDO1 read-write and WORM media

60GB 60 GB Using Plasmon or IBM UDO2 read-write and WORM
media


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
ESTCAPACITY=100K).



MOUNTRetention
However, for EXTERNAL library types, setting this parameter to a low value
(for example, two minutes) enhances device sharing between applications.
MOUNTWait
MOUNTLimit
Guide.
DRIVES
defined to the library is used to calculate the true mount limit value
(including online status).

MOUNTLIMIT value.
number
this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool. Any
current transaction will continue and complete but new transactions will
be terminated.


DEFINE DEVCLASS — QIC

DEFINE DEVCLASS (Define a QIC device class)
Use the QIC device class when you are using QIC tape devices.

Privilege class

privilege.

Syntax


FORMAT = DRIVE
DEVType = QIC
QIC120
QIC150
QIC525
QIC1000
QIC2GB
QIC2GBC
QIC4GB
QIC4GBC
QIC12GB
QIC12GBC
QIC20GB
QIC20GBC
QIC30GB
QIC30GBC
QIC5010
QIC5010C
QIC25GB
QIC25GBC
QIC50GB
QIC50GBC
QIC70GB
QIC70GBC


tape_volume_prefix


number
0

Parameters
LIBRary (Required)



DEVType=QIC (Required)
Specifies that the quarter-inch cartridge (QIC) device type is assigned to the
device class.
FORMAT
to Administrator's Guide for information.
The following tables list the recording formats, estimated capacities and
recording format options for QIC devices:
Table 72. Recording format and default estimated capacity for quarter-inch cartridge (QIC)
tape
Estimated
DRIVE – The server selects the highest format that can be
supported by the sequential access drive on which a
volume is mounted.

Avoid specifying the DRIVE value when a mixture of
devices is used within the same library.

For example, do not use this option for a library
QIC120 26 MB – 172 MB 120 QIC format, depending on media

Using DC600XTD, DC6150, DC6320, and DC6525

Using DC600XTD, DC6150, DC6320, and DC6525

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

8 GB
QIC12GB 12 GB Uncompressed 12000 QIC format, using 343–meter
tape



Table 72. Recording format and default estimated capacity for quarter-inch cartridge (QIC)
tape (continued)
Estimated
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

40 GB

50 GB

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

Table 73. QIC tape recording format options

Tape Format QIC-120 QIC-150 QIC-525 QIC-1000

3M DC300XLP – – – –
3M DC600A Read – – –
3M DC600XTD Read/Write Read/Write – –
3M DC6150 Read/Write Read/Write – –
3M DC6320 Read/Write Read/Write Read/Write –
3M DC6525 Read/Write Read/Write Read/Write –
3M DC9100 – – – Read/Write
3M DC9120XL – – – Read/Write
Note: The server cannot use 3M DC300XLP and 3M DC600A tapes.

ESTCAPacity



ESTCAPACITY=100K).
For more information on the default estimated capacity for QIC tapes, see
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
naming conventions.
acceptable:
AB.CD2.E
ADSM.BFS.
MOUNTRetention
MOUNTWait
MOUNTLimit



Guide.
DRIVES
status).

MOUNTLIMIT value.
number
this device class.
0 (zero)


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

privilege.

Syntax


MAXCAPacity = space_remaining
DEVType = REMOVABLEfile
MAXCAPacity = size



MOUNTLimit = DRIVES

MOUNTLimit = DRIVES
number
0

Parameters
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.



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
(megabytes), or G (gigabytes).

For example, MAXCAPACITY=5M specifies that the maximum capacity for a
is, MAXCAPACITY=100K).
MOUNTRetention
MOUNTWait
MOUNTLimit
Guide.
DRIVES
status).

Tip: For EXTERNAL library types, do not specify DRIVES for the
MOUNTLIMIT value.



number
0 (zero)


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

privilege.

Syntax

DEFine DEVclass device_class_name DEVType = SERVER

MAXCAPacity = 500M
SERVERName = server_name
MAXCAPacity = size

MOUNTLimit = 1 MOUNTRetention = 60

MOUNTLimit = number MOUNTRetention = minutes

PREFIX = ADSM RETRYPeriod = 10

PREFIX = ADSM RETRYPeriod = retry_value_(minutes)
volume_prefix

RETRYInterval = 30

RETRYInterval = retry_value_(seconds)

Parameters
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).


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.
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.
acceptable:
AB.CD2.E
An example of a high level archive file name using the default prefix is
ADSM.volume1.
RETRYPeriod
Specifies the retry period in minutes. The retry period is the interval during
which the server attempts to contact a target server if there is a suspected
communications failure. This parameter is optional. The default value is 10
minutes.
RETRYInterval
Specifies the retry interval in seconds. The retry interval is how often retries
are done within a given time period. This parameter is optional. The default
value is 30 seconds.


DEFINE DEVCLASS — 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 reside in separate storage pools.
3. Check in cartridges with CHECKLABEL=YES on the CHECKIN LIBVOLUME
command.
4. Label cartridges with OVERWRITE=NO on the LABEL LIBVOLUME command.
If VolSafe cartridges are labeled more than once, no additional data can be
written to them.

See the Administrator's Guide for additional information.

Privilege class

privilege.

Syntax


FORMAT = DRIVE
DEVType = VOLSAFE
9840
9840C

MOUNTRetention = 60 PREFIX = ADSM

MOUNTRetention = minutes PREFIX = ADSM
volume_prefix


number
0

Parameters
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.



For information about defining a library object, see “DEFINE LIBRARY (Define
a library)” on page 221.
DEVType=VOLSAFE (Required)
Specifies that the VOLSAFE device type is assigned to the device class. The
label on this type of cartridge can only be overwritten one time, which Tivoli
Storage Manager does when it writes the first block of data. Therefore, it is
important to limit the use of the LABEL LIBVOLUME command to one time
per volume by using the OVERWRITE=NO parameter.
FORMAT

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.
VolSafe devices:
Table 74. Recording formats and default estimated capacities for Volsafe media
Estimated
mounted.

9840 20 GB Uncompressed (standard) format, using a 20 GB
9840C See note LZ-1 Enhanced (4:1) compressed format, using a 80
GB cartridge with 270 meters (885 feet) of tape
80 GB

ESTCAPacity
ESTCAPACITY=100K).
For more information on the default estimated capacity for cartridge tapes, see
Table 74.



MOUNTRetention
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.
acceptable:
AB.CD2.E
An example of a high level archive file name using the default prefix is
ADSM.volume1.
MOUNTWait
MOUNTLimit
Guide.
DRIVES
status).

MOUNTLIMIT value.



number
this device class.
0 (zero)


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


Syntax
DEFine DOmain domain_name

BACKRETention = 30 ARCHRETention = 365

BACKRETention = days ARCHRETention = days

,

ACTIVEDESTination = active-data_pool_name

Parameters
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
BACKRETention
Specifies the number of days (from the date the backup versions became
inactive) to retain backup versions of files that are no longer on the client file
system. This parameter is optional. You can specify an integer from 0 to 9999.
The default value is 30. The server uses the backup retention value to manage
inactive versions of files when any of the following conditions occur:
v A file is rebound to a new management class, but neither the new
management class nor the default management class contains a backup copy
group.
v The management class to which a file is bound no longer exists, and the
default management class does not contain a backup copy group.
v The backup copy group is deleted from the management class to which a
file is bound and the default management class does not contain a backup
copy group.


DEFINE DOMAIN

ARCHRETention
Specifies the number of days (from the date of archive) to retain archive copies.
This parameter is optional. You can specify an integer from 0 to 30000. The
default value is 365. The server uses the archive retention value to manage
archive copies of files when either of the following conditions occur:
v The management class to which a file is bound no longer exists, and the
default management class does not contain an archive copy group.
v The archive copy group is deleted from the management class to which a
file is bound and the default management class does not contain an archive
copy group.
ACTIVEDESTination
Specifies the names of active-data pools that store active versions of backup
data for nodes assigned to the domain. This parameter is optional. Spaces
between the names of the active-data pools are not permitted. You cannot
specify more than ten active-data pools for a domain.
Before the Tivoli Storage Manager server writes data to an active-data pool, it
verifies that the node owning the data is assigned to a domain that has the
active-data pool listed in the ACTIVEDESTINATION list. If the server verifies
that the node meets this criteria, the data is stored in the active-data pool. If
the node does not meet the criteria, then the data is not stored in the
active-data pool. If the 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 75. Commands related to DEFINE DOMAIN
Command Description
COPY DOMAIN Creates a copy of a policy domain.
policy domain.
DELETE DOMAIN Deletes a policy domain along with any
policy objects in the policy domain.


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 240.

You can define more than one drive for a library by issuing the DEFINE DRIVE
command once for each drive. Stand-alone drives always require a manual library.
For additional information, see the Administrator's Guide.

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. See the information on adding devices and
managing media in the Administrator's Guide.

For detailed and current drive support information, see the Supported Devices
Web site for your operating system:

Privilege class

privilege.

Syntax
SERial = AUTODetect
DEFine DRive library_name drive_name
SERial = AUTODetect
serial_number

(1)
ONLine = Yes ELEMent = AUTODetect

ONLine = Yes ELEMent = AUTODetect
No address

(3)
CLEANFREQuency = NONE

(2) CLEANFREQuency = NONE
ACSDRVID = drive_id (4)
ASNEEDED
gigabytes

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


DEFINE DRIVE

3 The CLEANFREQUENCY parameter is valid only for drives in SCSI libraries.
4 The CLEANFREQUENCY=ASNEEDED parameter value does not work for
all tape drives. See the parameter description for more information.

Parameters
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
SERial
Specifies the serial number for the drive being defined. This parameter is
optional. The default is AUTODETECT.
If SERIAL=AUTODETECT, then the serial number reported by the drive when
you define the path will be used as the serial number.
If SERIAL=serial_number, then the serial number entered will be used to verify
that the path to the drive is correct when you define the path.

Note: Depending on the capabilities of the device, SERIAL=AUTODETECT
may not be supported. In this case, the serial number will be reported as
blank.
ONLine
Specifies whether the drive is available for use. This parameter is optional. The
default is YES.
Yes
Specifies that the drive is available for use.
No
Specifies that the drive is not available for use.
ELEMent
Specifies the element address of the drive within a SCSI library. The server
uses the element address to connect the physical location of the drive to the
SCSI address of the drive. The default is AUTODETECT.
If ELEMENT=AUTODETECT, then the element number will automatically be
detected by Tivoli Storage Manager when the path to the drive is defined.
To find the element address for your library configuration, consult the
manufacturer's information.

Restriction:
v The ELEMENT parameter is valid only for drives in SCSI libraries.
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 may
not be supported. In this case you will have to supply the element address.
ACSDRVID
Specifies the ID of the drive that is being accessed in an ACSLS library. The
drive ID is a set of numbers that indicates the physical location of a drive
within an ACSLS library. This drive ID must be specified as a,l,p,d, where a is


DEFINE DRIVE

the ACSID, l is the LSM (library storage module), p is the panel number, and d
is the drive ID. The server needs the drive ID to connect the physical location
of the drive to the drive's SCSI address. See the StorageTek documentation for
details.

Restriction: In order to utilize 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.
For details about using this parameter for automated and manual libraries, see
the Administrator's Guide. This parameter is not valid for externally managed
libraries, such as 3494 libraries or StorageTek libraries 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. See the Administrator's Guide for details.
NONE
Specifies that the server does not track cleaning for this drive. This value
can be used for libraries that have their own automatic cleaning.
ASNEEDED
Specifies that the server loads the drive with a checked-in cleaner cartridge
only when a drive reports to the device driver that it needs cleaning.
The CLEANFREQUENCY=ASNEEDED parameter value does not work for
all tape drives. Visit the Supported Devices Web site 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 connected
to the NAS file server. If a drive is attached only to a NAS file server (no
connection to a storage agent or server), do not specify ASNEEDED for the
cleaning frequency.
gigabytes
Specifies, in gigabytes, how much data is processed on the drive before the
server loads the drive with a cleaner cartridge. The server resets the
gigabytes-processed counter each time it loads a cleaner cartridge in the
drive.
Consult the drive manufacturer's information for cleaning
recommendations. If the information gives recommendations for cleaning
frequency in terms of hours of use, convert to a gigabytes value by doing
the following:
1. Use the bytes-per-second rating for the drive to determine a
gigabytes-per-hour value.
2. Multiply the gigabytes-per-hour value by the recommended hours of
use between cleanings.
3. Use the result as the cleaning frequency value.
Using the cleaning frequency recommended by IBM for IBM drives will
not overclean the drives.


DEFINE DRIVE

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 76. Commands related to DEFINE DRIVE
Command Description
libraries.
QUERY PATH Displays information about the path from a
source to a destination.
path.


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


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 77. Commands related to DEFINE EVENTSERVER
Command Description
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.


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


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 78. Commands related to DEFINE GRPMEMBER
Command Description
communications.
DEFINE SERVERGROUP Defines a new server group.


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. This can be either an IBM Tivoli
Storage Manager server or a data mover. However, the drives in a library can be
accessed by multiple sources.

For detailed and current library support information, see the Supported Devices

This section includes syntax diagrams for a number of different library
configurations, on a LAN or storage area network (SAN):

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

Privilege class

privilege.

Syntax for a library in a LAN, not used for NDMP operations


DEFINE LIBRARY

LIBType = MANUAL
DEFine LIBRary library_name
LIBType = MANUAL
SCSI A
349X B
EXTernal
ACSLS C
RSM D

RESETDrives = Yes (1) AUTOLabel = Yes (2)

RESETDrives = Yes AUTOLabel = No
No Yes
OVERWRITE

A (SCSI):

AUTOLabel = No RELABELSCRatch = No

AUTOLabel = No RELABELSCRatch = No
Yes Yes
OVERWRITE

B (349X):

SCRATCHCATegory = 301 PRIVATECATegory = 300

SCRATCHCATegory = number PRIVATECATegory = number

WORMSCRatchcategory = number

C (ACSLS):

ACSID = number

D (RSM):

MEDIAType = media_type

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

Syntax for a library in a SAN, not used for NDMP operations
(define a library to a library manager)


DEFINE LIBRARY

DEFine LIBRary library_name LIBType = 349X A
SCSI B
FILE
ACSLS C

SHAREd = No RESETDrives = Yes (1)

SHAREd = Yes RESETDrives = Yes
No No

AUTOLabel = Yes (2)

AUTOLabel = No
Yes
OVERWRITE

A (349X):

SCRATCHCATegory = 301 PRIVATECATegory = 300

SCRATCHCATegory = number PRIVATECATegory = number

WORMSCRatchcategory = number

B (SCSI):

SERial = AUTODetect AUTOLabel = No

SERial = AUTODetect AUTOLabel = No
serial_number Yes
OVERWRITE

RELABELSCRatch = No

RELABELSCRatch = No
Yes

C (ACSLS):

ACSID = number

Notes:
SHARED=YES; otherwise, the parameter defaults to No.
libraries.

Syntax for a library in a SAN, not used for NDMP operations
(define a library to a library client)


DEFINE LIBRARY

DEFine LIBRary library_name

LIBType = SHAREd PRIMarylibmanager = server_name

Syntax for a library in a LAN or a SAN, used for NDMP
operations (define a library controlled directly by Tivoli Storage
Manager)
DEFine LIBRary library_name LIBType = SCSI A
ACSLS
349X

SHAREd = No AUTOLabel = Yes (1)

SHAREd = No AUTOLabel = No
Yes Yes
OVERWRITE

A (SCSI):

AUTOLabel = No RESETDrives = Yes (2)

AUTOLabel = No RESETDrives = Yes
Yes No
OVERWRITE

Notes:
libraries.
SHARED=YES; otherwise, the parameter defaults to No.

Syntax for a library in a LAN or a SAN, used for NDMP
operations (define a library controlled through a NAS file server)
DEFine LIBRary library_name LIBType = SCSI SHAREd = No

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

Parameters
Specifies the name of the library to be defined. The maximum length of this
LIBType
Specifies the type of library that is being defined. The default is MANUAL.


DEFINE LIBRARY

MANUAL
Specifies that the library is not automated. When volumes must be
mounted on drives in this type of library, messages are sent to operators.
This type of library is used with stand-alone drives.
FILE
Specifies that a pseudo-library is created for sequential file volumes. When
you issue the DEFINE DEVCLASS command with DEVTYPE=FILE and
SHARED=YES parameters, this occurs automatically. FILE libraries are
necessary only when sharing sequential file volumes between the server
and one or more storage agents. The use of FILE libraries requires library
sharing.
SCSI
Specifies that the library has a SCSI-controlled media changer device. To
mount volumes on drives in this type of library, Tivoli Storage Manager
uses the media changer device.
349X
Specifies that the library is an IBM 3494 Tape Library Dataserver.
For more information about specifying category numbers for scratch,
private, and WORM volumes, see the Administrator's Guide.

Restriction: IBM 3494 libraries support only one unique device type at a
time.
SHAREd
Specifies that the library is shared with another Tivoli Storage Manager
server over a storage area network (SAN) or a dual SCSI connection to
library drives. This library type is not valid for optical devices.

Important: Specify this library type when defining the library on the
library client.
EXTernal
Specifies that the library is managed by an external media management
system. This library type does not support drive definitions 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.
ACSLS
Specifies that the library is a StorageTek library that is controlled by
StorageTek Automated Cartridge System Library Software (ACSLS).

Attention: In order to utilize ACSLS functions, the installation of
StorageTek Library Attach software is required.
RSM
Specifies that the library is integrated with Windows Removable Storage
Management (RSM). This library type allows Tivoli Storage Manager to
share libraries with other applications that use RSM.


DEFINE LIBRARY

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 Managerlibrary_name. This library
can be associated with the LTO or GENERICTAPE device types. Do not
define an LTO drive to a library associated with a device class whose
device type is GENERICTAPE.
Use the Removable Storage Manager snap-in to view the contents of the
RSM database and included media pools.
You can create more than one RSM library type if each library_name is
unique.
You can delete RSM libraries, but you cannot update them.
SERial
Specifies the serial number for the library being defined. This parameter is
optional. The default is AUTODETECT.
If SERIAL=AUTODETECT, then when you define the path to the library, the
serial number reported by the library will be used as the serial number.
If SERIAL=serial_number, then the number you have entered will be compared
to the number detected by Tivoli Storage Manager.

Attention: Depending on the capabilities of the device,
SERIAL=AUTODETECT may not be supported. In this case, the serial number
will be reported as blank.
AUTOLabel
Specifies whether the server attempts to automatically label tape volumes. This
parameter is optional. The default for 349X, ACSLS, EXTERNAL, and
MANUAL libraries is YES. The default for SCSI libraries is NO.
To use this option, you need to check in the tapes with
CHECKLABEL=BARCODE on the CHECKIN LIBVOLUME command.
No
Specifies that the server does not attempt to label any volumes.
Yes
Specifies that the server only labels unlabeled volumes.
OVERWRITE
Specifies that the server attempts to overwrite an existing label. The server
overwrites existing labels only if both the existing label and the bar code
label are not already defined in any server storage pool or volume history
list.
RELABELSCRatch
Specifies whether the server relabels volumes that have been 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 will
be 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.


DEFINE LIBRARY

Yes
Specifies that the server relabels volumes that are deleted and returned to
scratch.
ACSID
Specifies the number of this StorageTek library assigned by the ACSSA
(Automatic Cartridge System System Administrator). This can be a number
from 0 to 126. Issue QUERY ACS on your system to get the number for your
library ID. This parameter is required and valid only when LIBTYPE=ACSLS.
See your StorageTek documentation for more information.
MEDIAType
Specifies the media type. The Windows Removable Storage Manager snap-in
displays this information under media pools. You must use quotation marks
(“”) around these media types because of embedded spaces. For example,
"4mm DDS" is a valid media type for tape.
This parameter is required and valid only when LIBTYPE=RSM.
PRIMarylibmanager
Specifies the name of the Tivoli Storage Manager server that is responsible for
controlling access to library resources. You must define this server with the
DEFINE SERVER command before you can use it as a library manager. This
parameter is required and valid only if LIBTYPE=SHARED (that is, when you
define a library in a SAN to a library client server).
PRIVATECATegory
Specifies the category number for private volumes that must be mounted by
name. This parameter is optional. The default value is 300 (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 than the
other category numbers in this library. This parameter is valid only when
LIBTYPE=349X.
SCRATCHCATegory
Specifies the category number to be used for scratch volumes in the library.
This parameter is optional. The default value is 301 (becomes 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 than the other
category numbers in this library. This parameter is valid only when
LIBTYPE=349X.
WORMSCRatchcategory
Specifies the category number to be used for WORM scratch volumes in the
library. This parameter is required if you use WORM volumes. You can specify
a number from 1 to 65279. This number must be unique. It cannot be shared
with other applications or defined libraries, and it must be different than the
other category numbers in this library. This parameter is only valid when
LIBTYPE=349X and 3592 WORM volumes are used.

Restriction: If a 349X library does not have the WORMSCRATCHCATEGORY
defined and the WORM parameter is set to YES for the device class, the
mount operation will fail with an error message.
SHAREd
Specifies whether this library is shared with other Tivoli Storage Manager


DEFINE LIBRARY

servers in a storage area network (SAN). This parameter is required when you
define a library to the library manager. This parameter is valid only when you
define a SCSI, 349X, or ACSLS library.
YES
Specifies that this library can be shared with other servers. When you
specify YES, the library manager server mounts volumes as requested by
other servers and tracks drive and volume allocation to other servers.
NO
Specifies that this library cannot be shared with other servers.
SHARED=NO is required if the library is controlled by passing commands
through a NAS file server.
RESETDrives
Specifies whether the server performs a target reset when the server is
restarted or when a library client or storage agent re-connection is established.
This parameter only applies to SCSI, 3494, MANUAL, and ACSLS type
libraries.
Yes
Specifies that the target reset is to be performed. YES is the default for
SCSI, 3494, MANUAL, and ACSLS libraries defined with SHARED=YES.
No
Specifies that the target reset is not performed. NO is the default for SCSI,
3494, MANUAL, and ACSLS libraries defined with SHARED=NO.

Example: Define a manual library

Define a library named MANUALMOUNT with the library type of MANUAL.
define library manualmount libtype=manual

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

Example: Define a SCSI library on a SAN

In a storage area network, two Tivoli Storage Manager servers, CASTOR and
POLLUX, must share a SCSI library. Define a SCSI library named LTOLIB, with
CASTOR as the library manager server.
1. On the library manager server, CASTOR, define the library as a shared library.
define library ltolib libtype=scsi shared=yes
2. On the library manager server, CASTOR, define the path. The device name for
the library is:
lb3.0.0.0
Issue the command to define the path:


DEFINE LIBRARY

define path castor ltolib srctype=server desttype=library
device=lb3.0.0.0
3. On the library manager client, POLLUX, define the library as a shared library.
The server CASTOR is identified as the library manager.
define library ltolib libtype=shared primarylibmanager=castor

Example: Define a shared ACSLS library

Define a library named ACSLIB with a library type of ACSLS and an ACSID of 1.
define library acslib libtype=acsls acsid=1 shared=yes

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"

Example: Define a library to be used for NDMP operations

A SCSI library named TSMLIB is connected to a Tivoli Storage Manager server.
Define that library so that it will be directly controlled by Tivoli Storage Manager
and used for NDMP operations.
1. Define the library:
define library tsmlib libtype=scsi
2. Define the path. The device name for the library is:
lb3.0.0.0
Issue the command to define the path:
define path server1 tsmlib srctype=server desttype=library
device=lb3.0.0.0

Example: Define an ACSLS library to be used for NDMP
operations

An ACSLS library named STKLIB is connected to a Tivoli Storage Manager server.
Define that library so that it will be directly controlled by Tivoli Storage Manager
and used for NDMP operations.
define library stklib libtype=acsls acsid=4

Example: Define a SCSI library to be controlled by a NAS data
mover and used for NDMP operations

A SCSI library named NASLIB is connected directly to a NAS file server. Define
that library so that it will be controlled by Tivoli Storage Manager through the
NAS data mover (named NASDM) and used for NDMP operations.
define library naslib libtype=scsi
2. Define the path:
define path nasdm naslib srctype=datamover desttype=library
device=mc1


DEFINE LIBRARY

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 filesGESEDTbinelm.exe
define library extlib libtype=external
2. Define the path:
define path server1 extlib srctype=server desttype=library
externalmanager="c:program filesGESEDTbinelm.exe"

Related commands
Table 79. Commands related to DEFINE LIBRARY
Command Description
AUDIT LIBRARY Ensures that an automated library is in a
consistent state.
communications.
DELETE PATH Deletes a path from a source to a destination.
libraries.
UPDATE LIBRARY Changes the attributes of a library.
path.


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


Syntax
DEFine MACHine machine_name

BUilding = building FLoor = floor ROom = room

PRIority = 50 ADSMServer = 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


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 80. Commands related to DEFINE MACHINE
Command Description
DEFINE MACHNODEASSOCIATION Associates an IBM Tivoli Storage Manager
node with a machine.
DEFINE RECMEDMACHASSOCIATION Associates recovery media with a machine.
DELETE MACHINE Deletes a machine.
INSERT MACHINE Inserts machine characteristics or recovery
instructions into the IBM Tivoli Storage
Manager database.
QUERY MACHINE Displays information about machines.
UPDATE MACHINE Changes the information for a machine.


DEFINE 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


Syntax
,

DEFine MACHNODEAssociation machine_name node_name

Parameters
Specifies the machine name.
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 81. Commands related to DEFINE MACHNODEASSOCIATION
Command Description
DEFINE MACHINE Defines a machine for DRM.
DELETE MACHNODEASSOCIATION Deletes association between a machine and
node.
for that user.


DEFINE MACHNODEASSOCIATION

Table 81. Commands related to DEFINE MACHNODEASSOCIATION (continued)
Command Description


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

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

SPACEMGTECHnique = AUTOmatic AUTOMIGNOnuse = days
SELective
NONE

MIGREQUIRESBkup = Yes MIGDESTination = SPACEMGPOOL

MIGREQUIRESBkup = Yes MIGDESTination = pool_name
No


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


DEFINE MGMTCLASS

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"


DEFINE MGMTCLASS

Related commands
Table 82. Commands related to DEFINE MGMTCLASS
Command Description
ASSIGN DEFMGMTCLASS Assigns a management class as the default
for a specified policy set.
class.
policy domain.
classes.
group.
class.


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

Parameters
group_name
Specifies the name of the node group that you want to create. The maximum
length of the name is 30 characters. The specified name may not be the same
as any existing client node name.
DESCription
Specifies a description of the node group. This parameter is optional. The

Example: Define a node group

Define a node group named group1.
define nodegroup group1

Related commands
Table 83. 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.
backup set.


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 84. Commands related to DEFINE NODEGROUPMEMBER
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to
a server.
DEFINE NODEGROUP Defines a group of nodes.
backup set.


DEFINE PATH

DEFINE PATH (Define a path)
Use this command to define a path from a source to a destination. A path provides
access to a destination from a source. You must define the source and destination
before you can define a path. For example, if a path is required between a server
and a drive, you must first issue the DEFINE DRIVE command and then issue the
DEFINE PATH command. A path must be defined after you issue the DEFINE
DRIVE command in order to make the drive usable by IBM Tivoli Storage
Manager software.

Privilege class

For detailed and current device support information, see the Supported Devices

To issue this command you must have system privilege or unrestricted storage
privilege.

Syntax when the destination is a drive
DEFine PATH source_name destination_name

SRCType = DATAMover DESTType = DRive
SERVer AUTODetect = No
Yes

LIBRary = library_name DEVIce = device_name
FILE

| GENERICTAPE = No ONLine = Yes

GENERICTAPE = Yes ONLine = Yes
No No

DIRectory = current_directory_name

,

DIRectory = directory_name

Syntax when the destination is a library
(1)
DEFine PATH source_name destination_name SRCType = DATAMover
SERVer

DESTType = LIBRary
AUTODetect = No
Yes


DEFINE PATH

ONLine = Yes
DEVIce = device_name
EXTERNALManager = path_name ONLine = Yes
No

Notes:
1 DATAMOVER only applies to NAS devices.

Parameters
source_name (Required)
Specifies the name of source for the path. This parameter is required.
destination_name (Required)
Specifies the name of the destination. This parameter is required.
The destination can be a drive or a library.

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 IBM Tivoli Storage Manager.

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. DESTTYPE=DRIVE only: If you set DESTTYPE=DRIVE and
AUTODETECT=YES, then the drive element number in the IBM Tivoli
Storage Manager database will be automatically changed to reflect the
same element number that corresponds to the serial number of that
drive. This is true for drives in a SCSI library. For more information
about the element number, see DEFINE DRIVE.


DEFINE PATH

4. Depending on the capabilities of the device, the AUTODETECT
parameter may not be supported.
DESTType (Required)
Specifies the type of the destination. This parameter is required. Possible
values are:
DRive
Specifies that a drive is the destination. When the destination is a drive,
you must specify a library name.
LIBRary
Specifies that a library is the destination.
LIBRary
Specifies the name of the library to which the drive is assigned. This parameter
is required if DESTTYPE=DRIVE. The library and its drives must already be
defined to the IBM Tivoli Storage Manager server. If the path is from a NAS
data mover to a library, the library must have LIBTYPE of SCSI, 349x, or
ACSLS.

Restriction: In order to utilize ACSLS functions, the installation of StorageTek
Library Attach software is required.
| 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 a library or optical drive. 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.
DEVIce
Specifies the name of the device as known to the source, or FILE if the device
is a logical drive in a FILE library.
The source uses the device name to access the drive or library. See Table 85 for
examples.
Table 85. Examples of device names
Source to destination Example
Server to a drive (not a FILE drive) mt3
Server to a library lb4.1
Storage agent (on a Windows system) to a drive (not a mt3
FILE drive)
Storage agent to a drive when the drive is a logical FILE
drive in a FILE library
NAS data mover to a library mc0


DEFINE PATH

Table 85. Examples of device names (continued)
Source to destination Example
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.
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:winntibmatl.conf file. For more information, refer to the IBM Tape
Device Drivers Installation and User’s Guide. The Guides can be downloaded
from the FTP site at ftp://ftp.software.ibm.com/storage/devdrvr/. They are
located in the Doc folder.
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 IBM Tivoli Storage
Manager can send media access requests. Use single quotation marks around
the value of this parameter. For example, enter: 'c:Program
Filesbinelm.exe'
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.
For example, if the path from a data mover to a drive is online, but either the
data mover or the drive is offline, you cannot use the path.

Attention: If the path to a library is offline, the server will not be able to
access the library. If the server is halted and restarted while the path to the
library is offline, the library will not be initialized. See the Administrator's Guide
for additional information.


DEFINE 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.
On a storage agent, this parameter is only valid when all of the following
conditions are true:
v The source type is SERVER (meaning a storage agent that has been defined
as a server to this server).
v The source name is the name of a storage agent, not the server.
v The destination is a logical drive that is part of a FILE library created when
the device class was defined.
If you specified multiple directories for the device class associated with the
FILE library, you must specify the same number of directories for each path to
the FILE library. Do not change or move existing directories on the server that
the storage agent is using so that the device class and the path remain
synchronized. Adding directories is permitted. Specifying a mismatched
number of directories can cause a run-time failure. See the following example.
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, the storage agent will experience mount failures.
The account associated with the storage agent service must be either 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 machine which administers
the remote share. For example, if a SAMBA server is providing access to
remote storage, the user ID and password in the SAMBA configuration must
match that of the local administrator user ID and password associated with the
storage agent service.
define devclass file devtype=file shared=yes mountlimit=1
directory=d:filedirdir1
define path sta1 file1 srctype=server desttype=drive
library=file1 device=file
directory=192.168.1.10filedirdir1

In the previous example, the DEFINE DEVCLASS command establishes the
shared file system in the directory accessed by the server as D:FILEDIRDIR1.
The storage agent, however, is using UNC name 192.168.1.10FILEDIRDIR1.
This means that the machine with TCP/IP address 192.168.1.10 is sharing the
same directory using FILEDIR as the shared name. Also, the storage agent
service has an account which can access this storage. It can access it either
because it is associated with a local account with the same user ID and
password as 192.168.1.10 or it is associated with a domain account which is


DEFINE PATH

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

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 IBM Tivoli Storage Manager server.
2. IBM Tivoli Storage Manager does not create shares or permissions, or
mount the target file system. You must perform these actions before
starting the storage agent.
The following illustrates the importance of matching device classes and paths
to ensure that storage agents can access newly created FILE volumes.
Suppose you want to use these three directories for a FILE library:
v c:server
v d:server
v e:server
1. You use the following command to set up a FILE library named CLASSA
with one drive named CLASSA1 on SERVER1:
define devclass classa devtype=file
directory="c:server,d:server,e:server"
shared=yes mountlimit=1
2. You want the storage agent STA1 to be able to use the FILE library, so you
define the following path for storage agent STA1:
define path server1 sta1 srctype=server desttype=drive device=file
directory="192.168.1.10cserver,192.168.1.10dserver,
192.168.1.10eserver" library=classa
In this scenario, the storage agent, STA1, will replace the directory name
c:server with the directory name 192.168.1.10cserver to access FILE
volumes that are in the c:server directory on the server.
3. File volume c:serverfile1.dsm is created by SERVER1. If you later
change the first directory for the device class with the following command:
update devclass classa directory="c:otherdir,d:server,e:server"

SERVER1 will still be able to access file volume c:serverfile1.dsm, but
the storage agent STA1 will not be able to access it because a matching
directory name in the PATH directory list no longer exists. If a directory
name is not available in the directory list associated with the device class,
the storage agent can lose access to a FILE volume in that directory.
Although the volume will still be accessible from the Tivoli Storage
Manager server for reading, failure of the storage agent to access the FILE
volume can cause operations to be retried on a LAN-only path or to fail.
4. If file volume /opt/tivoli1/file1.dsm is created on SERVER1, and if the
following command is issued,
update devclass classa directory="/opt/otherdir,/opt/tivoli2,
/opt/tivoli3"

SERVER1 will still be able to access file volume /opt/tivoli1/file1.dsm,
but the storage agent STA1 will not be able to access it because a matching
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,


DEFINE PATH

the storage agent can lose access to a FILE volume in that directory.
Although the volume will still be accessible from the Tivoli Storage
Manager server for reading, failure of the storage agent to access the FILE
volume can cause operations to be retried on a LAN-only path or to fail.

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 IBM 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.10filedata.

The data for FILE9 resides on the server at d:tsmdatafiledata.
define path sa1 file9 srctype=server desttype=drive library=file1 device=file
directory="192.168.1.10filedata"

Related commands
Table 86. Commands related to DEFINE PATH
Command Description
DEFINE DATAMOVER Defines a data mover to the IBM Tivoli
Storage Manager server.
DELETE PATH Deletes a path from a source to a destination.


DEFINE PATH

Table 86. Commands related to DEFINE PATH (continued)
Command Description
UPDATE DATAMOVER Changes the definition for a data mover.
path.


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
set belongs.

Syntax
DEFine POlicyset domain_name policy_set_name


Parameters
Specifies the name of the policy domain to which the policy set belongs.
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

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 87. Commands related to DEFINE POLICYSET
Command Description
COPY POLICYSET Creates a copy of a policy set.


DEFINE POLICYSET

Table 87. Commands related to DEFINE POLICYSET (continued)
Command Description
assigned to.
policy domain.
the policy set.


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


Syntax
DEFine 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 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
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.



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
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
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
v If you use a match-all definition and a list of scripts already exists, Tivoli



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
definition, an asterisk (*) by itself, to specify all client option sets that are
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
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
match-all definition, an asterisk (*) by itself, to specify all servers that are
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
v If you use a match-all definition and a list of servers already exists, Tivoli
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



| 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
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
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
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 88. 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.
profile.
manager.
profile.



Table 88. Commands related to DEFINE PROFASSOCIATION (continued)
Command Description
NOTIFY SUBSCRIBERS Notifies servers to refresh their configuration
information.
profiles.
manager.
managed servers.


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


Syntax
DEFine PROFIle profile_name

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 89. 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.
profile.
manager.
profile.
profiles.
manager.
managed servers.


DEFINE PROFILE

Table 89. Commands related to DEFINE PROFILE (continued)
Command Description


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


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.
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 90. 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 RECMEDMACHASSOCIATION Deletes association between recovery media
and a machine.
DELETE RECOVERYMEDIA Deletes recovery media.


DEFINE RECMEDMACHASSOCIATION

Table 90. Commands related to DEFINE RECMEDMACHASSOCIATION (continued)
Command Description
QUERY RECOVERYMEDIA Displays media available for machine
recovery.


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


Syntax
DEFine RECOVERYMedia media_name
,

VOLumenames = volume_name

DESCription = description LOcation = location

Type = OTher

Type = OTher PROduct = product_name
BOot

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
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
Type
Specifies the type of recovery media. This parameter is optional. The default is
OTHER.


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 91. Commands related to DEFINE RECOVERYMEDIA
Command Description
DEFINE RECMEDMACHASSOCIATION Associates recovery media with a machine.
DELETE RECOVERYMEDIA Deletes recovery media.
QUERY RECOVERYMEDIA Displays media available for machine
recovery.
UPDATE RECOVERYMEDIA Changes the attributes of recovery media.


DEFINE 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.

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 92. Commands related to DEFINE SCHEDULE
Command Description
COPY SCHEDULE Creates a copy of a schedule.
DEFINE ASSOCIATION Associates clients with a schedule.
QUERY EVENT Displays information about scheduled and
completed events for selected clients.
SET MAXCMDRETRIES Specifies the maximum number of retries
after a failed attempt to execute a scheduled
command.
SET MAXSCHEDSESSIONS Specifies the maximum number of
client/server sessions available for processing
scheduled work.
SET RETRYPERIOD Specifies the time between retry attempts by
the client scheduler.
UPDATE SCHEDULE Changes the attributes of a schedule.


DEFINE SCHEDULE

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



DEFINE SCHEDULE


Selective
Archive
""
SUBACTion =
FASTBack
Backup
""
SUBACTion =
FASTBack
SYSTEMSTate
VM
REStore
RETrieve
IMAGEBACkup
IMAGEREStore
Command
Macro
Deploy

OPTions = option_string (1)
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

DURUnits = Minutes SCHEDStyle = Classic
Hours
Days
INDefinite

PERiod = 1 PERUnits = Days

PERiod = number PERUnits = Hours
Days
Weeks
Months
Years
Onetime


DEFINE SCHEDULE

DAYofweek = ANY EXPiration = Never

WEEKDay date
WEEKEnd
SUnday
Monday
TUesday
Wednesday
THursday
Friday
SAturday

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

Syntax
Enhanced client schedule

DEFine SCHedule domain_name schedule_name
Type = Client



Selective
Archive
SUBACTion = FASTBack
Backup
""
SUBACTion =
FASTBack
SYSTEMSTate
VM
REStore
RETrieve
IMAGEBACkup
IMAGEREStore
Command
Macro

OPTions = option_string (1)
OBJects = object_string




DEFINE SCHEDULE



DURUnits = Hours
SCHEDStyle = Enhanced
DURUnits = Minutes
Hours
Days

MONth = ANY DAYOFMonth = ANY

JAnuary Day
February
MARch
APril
May
JUNe
JULy
AUgust
September
October
November
December

WEEKofmonth = ANY DAYofweek = ANY

FIrst WEEKDay
Second WEEKEnd
Third SUnday
FOurth Monday
Last TUesday
Wednesday
THursday
Friday
SAturday

EXPiration = Never

EXPiration = Never
date

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

Parameters
Specifies the name of the policy domain to which this schedule belongs.
Specifies the name of the schedule to be defined. You can specify up to 30
characters for the name.
Type=Client
Specifies that a schedule for a client is defined. This parameter is optional.


DEFINE SCHEDULE

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
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
IMAGEREStore
Specifies that the schedule restores logical volumes that are specified with
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
SUBACTion


DEFINE SCHEDULE

"" 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_WINc$tsmmaintenanceclientv6r2WindowsX32v620v6200*
| ..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.

| Important: The DEPLOY parameter can only be used for Windows clients.
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


DEFINE SCHEDULE

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
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!
When you specify ACTION=ARCHIVE, INCREMENTAL, or SELECTIVE for
this parameter, you can list a maximum of twenty (20) file specifications.


DEFINE SCHEDULE

Enclose the object string in double quotes if it contains blank characters
(spaces), and then surround the double quotes with single quotes. If the object
string contains multiple file names, enclose each file name with its own pair of
double quotes, then surround the entire string with one pair of single quotes.
Errors can occur if file names contain a space that is not quoted correctly. The
following examples show how to specify some file names:
v To specify C:FILE 2, D:GIF FILES, and E:MY TEST FILE, enter:
OBJECTS='"C:FILE 2" "D:GIF FILES" "E:MY TEST FILE"'
v To specify D:TEST FILE, enter:
OBJECTS='"D:TEST FILE"'

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
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:

TODAY+days or The current date plus days TODAY +3 or +3.
+days specified. The maximum
number of days you can specify
is 9999.

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:

HH:MM:SS A specific time 10:30:08
NOW The current time NOW


DEFINE SCHEDULE

NOW+HH:MM The current time plus hours and NOW+02:00 or +02:00.
or +HH:MM 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 The current time minus hours NOW-02:00 or –02:00.
or -HH:MM and minutes specified
STARTTIME=NOW–02:00 or
STARTTIME=-02:00, the beginning of

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.
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


DEFINE SCHEDULE

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.
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.
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
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


DEFINE SCHEDULE

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
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.


DEFINE SCHEDULE

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
-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, 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


DEFINE SCHEDULE

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
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


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.

: Notes
1. You cannot schedule the MACRO command or the QUERY ACTLOG
command.
2. If you are scheduling a command that specifies the WAIT parameter, the
parameter must be set to YES in order for the process to provide a return code
to the session that started it. For more information about the WAIT parameter,
see “Server command processing” on page 14.

Privilege class

To define an administrative command schedule, you must have system privilege.

Syntax
Classic administrative schedule

DEFine SCHedule schedule_name
Type = Administrative

ACTIVE = No
CMD = command
ACTIVE = Yes DESCription = description





DURUnits = Hours SCHEDStyle = Classic

DURUnits = Minutes SCHEDStyle = Classic
Hours
Days
INDefinite

PERiod = 1 PERUnits = Days

PERiod = number PERUnits = Hours
Days
Weeks
Months
Years
Onetime


DEFINE SCHEDULE


WEEKDay date
WEEKEnd
SUnday
Monday
TUesday
Wednesday
THursday
Friday
SAturday

Syntax
Enhanced administrative schedule

DEFine SCHedule schedule_name
Type = Administrative

ACTIVE = NO
CMD = Command
ACTIVE = YES DESCription = description





DURUnits = Hours
SCHEDStyle = Enhanced
DURUnits = Minutes
Hours
Days


JAnuary Day
February
MARch
APril
May
JUNe
JULy
AUgust
September
October
November
December


DEFINE SCHEDULE


FIrst WEEKDay
Second WEEKEnd
Third SUnday
FOurth Monday
Last TUesday
Wednesday
THursday
Friday
SAturday

EXPiration = Never

EXPiration = Never
date

Parameters
Specifies the name of the schedule to be defined. You can specify up to 30
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
PRIority
Specifies the priority value for a schedule. This parameter is optional. You can
specify an integer from 1 to 10, with 1 being the highest priority and 10 being
the lowest. The default is 5.


DEFINE SCHEDULE

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:

TODAY+days or The current date plus days TODAY +3 or +3.
+days specified. The maximum
number of days you can specify
is 9999.

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:

HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM The current time plus hours and NOW+02:00 or +02:00.
or +HH:MM minutes specified
STARTTIME=NOW+02:00 or
STARTTIME=+02:00, the beginning of
NOW-HH:MM The current time minus hours NOW-02:00 or –02:00.
or -HH:MM and minutes specified
STARTTIME=NOW–02:00 or
STARTTIME=-02:00, the beginning of

DURation
Specifies the number of units that define the length of the startup window of
the scheduled operation. This parameter is optional. This value must be from 1
to 999. The default is 1.
Use this parameter with the DURUNITS parameter to specify the length of the
startup window. For example, if you specify DURATION=20 and
DURUNITS=MINUTES, the schedule must be started within 20 minutes of the
start date and start time. The default length of the startup window is 1 hour.
The duration of the window must be shorter than the period between
windows.


DEFINE SCHEDULE

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


DEFINE SCHEDULE

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
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


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. 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


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, 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, the schedule will run during each of the specified weeks of the month.
If multiple values resolve to the same week, the schedule will run only once
during that week.
The default value is ANY, meaning the schedule will run during every week of
the month or on the day or days determined by other enhanced schedule
parameters. WEEKOFMONTH must have a value of ANY (either by default or
specified with the command) when used with the DAYOFMONTH parameter.
EXPiration
Specifies the date after which this schedule is no longer used. This parameter
is optional. The default is NEVER. Possible values are:
Never
Specifies that the schedule never expires.
expiration_date
Specifies the date on which this schedule expires, in MM/DD/YYYY
format. If you specify an expiration date, the schedule expires at 23:59:59
on the date you specify.

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

define schedule backup_archivepool type=administrative
cmd="backup stgpool archivepool recoverypool"
schedstyle=enhanced dayofmonth=1,15


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.

Tip:
1. The Administration Center only supports ASCII characters for input. If you
need to enter characters that are not ASCII, issue the DEFINE SCRIPT and
UPDATE SCRIPT commands from the server console.
2. When routing commands inside scripts, enclose the server or server group in
parentheses and omit the colon. Otherwise, if the syntax includes a colon, the
command is not routed when the RUN command is issued. Instead, the
command will only run on the server from which the RUN command is issued.
For more information, see “Performing tasks concurrently on multiple servers”
on page 16.

Privilege class

To issue this command, you must have operator, policy, storage, or system
privilege.

Syntax
Line = 001
DEFine SCRipt script_name command_line
Line = number
File = file_name


Parameters
script_name (Required)
Specifies the name of the script to be defined. You can specify up to 30
command_line
Specifies the first command to be processed in a script. You must specify either
this parameter (and, optionally, the LINE parameter) or the FILE parameter.
The command you specify can include substitution variables and can be
continued across multiple lines if you specify a continuation character (-) as the
last character in the command. Substitution variables are specified with a '$'
character, followed by a number that indicates the value of the parameter
when the script is processed. You can specify up to 1200 characters for the
command line. Enclose the command in quotation marks if it contains blanks.
Conditional logic flow statements can be used. These statements include IF,
EXIT, and GOTO. For more information, see the Administrator's Guide. For
return codes used with the IF statement, see Appendix A, “Return codes for
use in IBM Tivoli Storage Manager scripts,” on page 1311.


DEFINE SCRIPT

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

Related commands
Table 93. Commands related to DEFINE SCRIPT
Command Description
COPY SCRIPT Creates a copy of a script.
DELETE SCRIPT Deletes the script or individual lines from the
script.
QUERY SCRIPT Displays information about scripts.
RENAME SCRIPT Renames a script to a new name.
RUN Runs a script.
UPDATE SCRIPT Changes or adds lines to a script.


DEFINE SERVER

DEFINE SERVER (Define a server for server-to-server
communications)
Use this command to define a server.

Use this command to define a server for the following functions:
v Enterprise configuration
v Enterprise event logging
v Command routing
v Virtual volumes

| 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


Syntax

For Enterprise Configuration, Enterprise Event Logging, Command Routing, and
Storage Agent:

DEFine SERver server_name SERVERPAssword = password

HLAddress = ip_address LLAddress = tcp_port
COMMmethod = TCPIP

URL = url DESCription = description

(1) (2)
CROSSDEFine = No VALIdateprotocol = No

CROSSDEFine = No VALIdateprotocol = No
Yes All

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


DEFINE SERVER

Syntax

For Virtual Volumes:

DEFine SERver server_name PAssword = password

HLAddress = ip_address LLAddress = tcp_port
COMMmethod = TCPIP

URL = url DELgraceperiod = days NODEName = node_name


Parameters
server_name (Required)
Specifies the name of the server. This name must be unique on the server. The
maximum length of this name is 64 characters.
For command routing and server-to-server event logging functions, the server
name you specify here should match the name that was set using the SET
SERVERNAME command at the target server.
PAssword (Required)
Specifies the password used to sign on to the target server for virtual volumes.
If you specify the NODENAME parameter, you must specify the PASSWORD
parameter. If you specify the PASSWORD parameter but not the NODENAME
parameter, the node name defaults to the server name specified with the SET
SERVERNAME command.
SERVERPAssword
Specifies the password of the server you are defining. This password must
match the password set by the SET SERVERPASSWORD command. This
parameter is required for enterprise configuration, command routing, and
server-to-server event logging functions.

Tip: Command routing uses the ID and password of the administrator issuing
the command.
HLAddress (Required)
Specifies the IP address (in dotted decimal format) of the server.
Do not use the loopback address as the value of this parameter. Virtual
volumes are not supported when the source server and the target server are
the same Tivoli Storage Manager server.
LLAddress (Required)
Specifies the low-level address of the server. This address is usually the same
as that in the TCPPORT server option of the target server.
COMMmethod
Specifies the communication method used to connect to the server. This
URL
Specifies the URL address of this server. The parameter is optional.


DEFINE SERVER

DELgraceperiod
Specifies a number of days that an object remains on the target server after it
has been marked for deletion. Possible values are 0-9999. The default is 5. This
NODEName
Specifies a node name to be used by the server to connect to the target server.
This parameter is optional. If you specify the NODENAME parameter, you
must also specify the PASSWORD parameter. If you specify the PASSWORD
parameter but not the NODENAME parameter, the node name defaults to the
server name specified with the SET SERVERNAME command.
DESCription
Specifies a description of the server. The parameter is optional. The description
can be up to 255 characters. Enclose the description in quotation marks if it
contains blank characters.
CROSSDEFine
Specifies whether the server running this command will define itself to the
server being specified by this command. This parameter is optional.

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.
No
Cross definition is not to be performed.
Yes
Cross definition is to be performed.
VALIdateprotocol
Specify whether a cyclic redundancy check should be performed to validate
the data sent between the storage agent and Tivoli Storage Manager server.
The parameter is optional. The default is NO. Possible values are:
No
Specifies that data validation not be performed on any data sent between
the storage agent and server.
All
Specifies that data validation be performed on all client file data, client file
metadata, and Tivoli Storage Manager server metadata that is sent between
the storage agent and server. This mode impacts performance as additional
overhead is required to calculate and compare CRC values between the
storage agent and the server.

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, set the
password to SECRET, and specify that objects remain on the target server for 7
days after they have been marked for deletion.
define server server2 password=secret
hladdress=9.115.3.45 lladdress=1570 delgraceperiod=7


DEFINE SERVER

Example: Define a server to receive commands from other
servers

Define a server to enable it to receive commands routed from other servers. Name
the server WEST_COMPLEX, set the password to CACTUS, and set the high-level
address to 9.172.12.35, the low-level address to 1500, and the URL address to
http://west_complex:1580/.
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 servername server_b
set serverpassword mylife
set serverhladdress 9.115.20.80
set serverlladdress 1860
set crossdefine on
2. On SERVER_A, specify the server name, password, and high- and low-level
addresses of SERVER_A.
set servername server_a
set serverpassword yourlife
set serverhladdress 9.115.20.97
set serverlladdress 1500
3. On SERVER_A, define SERVER_B:
define server server_b hladdress=9.115.20.80 lladdress=1860
serverpassword=mylife crossdefine=yes

Related commands
Table 94. Commands related to DEFINE SERVER
Command Description
DELETE DEVCLASS Deletes a device class name.
DELETE FILESPACE Deletes data associated with client's file
spaces.
DELETE SERVER Deletes the definition of a server.
RECONCILE VOLUMES Reconciles source server virtual volume
definitions and target server archive objects.
for that user.
SET CROSSDEFINE Specifies whether to cross define servers.
SET SERVERNAME Specifies the name by which the server is
identified.


DEFINE SERVER

Table 94. Commands related to DEFINE SERVER (continued)
Command Description
SET SERVERHLADDRESS Specifies the high-level address of a server.
SET SERVERLLADDRESS Specifies the low-level address of a server.
SET SERVERPASSWORD Specifies the server password.
UPDATE NODE Changes the attributes associated with a
client node.


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


Syntax
DEFine SERVERGRoup group_name

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

Example: Define a server group

Define a server group named WEST_COMPLEX.
define servergroup west_complex

Related commands
Table 95. 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.
QUERY SERVERGROUP Displays information about server groups.


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 wrong storage pool 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

privilege.

Syntax
Fullpct = 80
DEFine SPACETrigger STG
Fullpct = percent

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


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 filestivolitsm
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:wnntsystem32 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


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 96. Commands related to DEFINE SPACETRIGGER
Command Description
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.


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.

The DEFINE STGPOOL command takes four forms:
v Defining a primary storage pool assigned to random access devices
v Defining a primary storage pool assigned to sequential access devices
v Defining a copy storage pool (always assigned to sequential access devices)
v Defining an active-data pool (always assigned to sequential access devices)
The syntax and parameters for each form are defined separately.
Table 97. Commands related to DEFINE STGPOOL
Command Description
BACKUP DB Backs up the IBM Tivoli Storage Manager
database to sequential access volumes.
BACKUP STGPOOL Backs up a primary storage pool to a copy
storage pool.
COPY ACTIVEDATA Copies active backup data.
DEFINE COLLOCGROUP Defines a collocation group.
DEFINE COLLOCMEMBER Adds a client node to a collocation group.
group.
DELETE STGPOOL Deletes a storage pool from server storage.
MOVE DATA Moves data from a specified storage pool
volume to another storage pool volume.
MOVE MEDIA Moves storage pool volumes that are
managed by an automated library.
groups.
QUERY DEVCLASS Displays information about device classes.


DEFINE STGPOOL

Table 97. Commands related to DEFINE STGPOOL (continued)
Command Description
QUERY SHREDSTATUS Displays information about data waiting to
be shredded.
RENAME STGPOOL Renames a storage pool.
copy storage pools.
pools.
SET DRMPRIMSTGPOOL Specifies that primary storage pools are
managed by DRM.
SHRED DATA Manually starts the process of shredding
deleted data.
group.


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


Syntax

POoltype = PRimary
DEFine STGpool pool_name DISK
POoltype = PRimary

ACCess = READWrite

DESCription = description ACCess = READWrite
READOnly
UNAVailable

MAXSIze = NOLimit CRCData = No

MAXSIze = maximum_file_size CRCData = Yes
No

HIghmig = 90

NEXTstgpool = pool_name HIghmig = percent

LOwmig = 70 CAChe = No MIGPRocess = 1

LOwmig = percent CAChe = Yes MIGPRocess = number
No

MIGDelay = 0 MIGContinue = Yes

MIGDelay = days MIGContinue = Yes
No

| AUTOCopy = CLient

AUTOCopy = None
CLient
MIGRation
All

,
COPYContinue = Yes
COPYSTGpools = copy_pool_name
COPYContinue = Yes
No


DEFINE STGPOOL

,

ACTIVEDATApools = active-data_pool_name

SHRED = 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
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.


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.
the NEXTSTGPOOL parameter) and is defined as unavailable, 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.
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 Meaning
K kilobyte
M megabyte
G gigabyte
T terabyte

If a file exceeds the maximum size and no pool is specified as the next storage
pool in the hierarchy, the server does not store the file. If a file exceeds the
maximum size and a pool is specified as the next storage pool, the server
stores the file in the next storage pool that can accept the file size. If you
specify the next storage pool parameter, at least one storage pool in your
hierarchy should have no limit on the maximum size of a file. By having no
limit on the size for at least one pool, you ensure that no matter what its size,
the server can store the file.
For logical files that are part of an aggregate, the server considers the size of
the aggregate to be the file size. Therefore, the server does not store logical
files that are smaller than the maximum size limit if the files are part of an
aggregate that is larger than the maximum size limit.
CRCData
Specifies whether a cyclic redundancy check (CRC) validates storage pool data
when audit volume processing occurs on the server. This parameter is optional.
The default value is NO. By setting CRCDATA to YES and scheduling an
AUDIT VOLUME command you can continually ensure the integrity of data
stored in your storage hierarchy. Possible values are:
Yes
Specifies that data is stored containing CRC information, allowing for audit
volume processing to validate storage pool data. This mode impacts
performance because additional overhead is required to calculate and
compare CRC values between the storage pool and the server.
No
Specifies that data is stored without CRC information.


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.
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:


DEFINE STGPOOL

v The number of migration processes is dependent upon the setting of the
MIGPROCESS parameter and the number of nodes or the number of
collocation groups with data in the migrating storage pool. For example, if
the MIGPROCESS parameter is equal to six, but there are only two nodes
with data on the storage pool, migration processing only consists of two
processes, not six.
| 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.
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.
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.


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
| 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.
| All
| 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
bound to the data. For details, refer to information about the
simultaneous-write function in the Administrator's Guide.


DEFINE STGPOOL

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.
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
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 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


DEFINE STGPOOL

| 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.
| 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.
and ACTIVEDATAPOOLS parameters can not exceed three.
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.
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.


DEFINE STGPOOL

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


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


Syntax

POoltype = PRimary
DEFine STGpool pool_name device_class_name
POoltype = PRimary

ACCess = READWrite

READOnly
UNAVailable

MAXSIze = NOLimit CRCData = No

(1) (2) CRCData = Yes
MAXSIze = maximum_file_size (1)
No

HIghmig = 90

(1) (2) (1) (2)
NEXTstgpool = pool_name HIghmig = percent

LOwmig = 70 REClaim = 60

(1) (2) (1) (2)
LOwmig = percent REClaim = percent

RECLAIMPRocess = 1

(1) (2) (1) (2)
RECLAIMPRocess = number RECLAIMSTGpool = pool_name

RECLAMATIONType = THRESHold COLlocate = GRoup

(1) (2) (3) (2)
RECLAMATIONType = THRESHold COLlocate = No
SNAPlock GRoup
NODe
FIlespace

(2) REUsedelay = 0
MAXSCRatch = number
(2) (1) (2)
REUsedelay = days OVFLOcation = location

MIGDelay = 0 MIGContinue = Yes

(1) (2) (1) (2)
MIGDelay = days MIGContinue = No
Yes

MIGPRocess = 1 DATAFormat = NATive

(1) (2) (2) (4)
MIGPRocess = number DATAFormat = NATive
NONblock
NETAPPDump
CELERRADump
NDMPDump


DEFINE STGPOOL

| AUTOCopy = CLient

AUTOCopy = None
CLient
MIGRation
All

,
(1) (2) COPYContinue = Yes
COPYSTGpools = copy_pool_name
(1) (2)
COPYContinue = Yes
No

DEDUPlicate = No

, DEDUPlicate = No
(5)
ACTIVEDATApools = active-data_pool_name Yes

IDENTIFYPRocess = 1

(6)
IDENTIFYPRocess = number

Notes:
1 This parameter is not available for storage pools that use the data formats
NETAPPDUMP, CELERRADUMP, or NDMPDUMP.
2 This parameter is not available or is ignored for Centera storage pools.
3 The RECLAMATIONTYPE=SNAPLOCK setting is valid only for storage
pools defined to servers that are enabled for System Storage Archive
Manager. The storage pool must be assigned to a FILE device class, and the
directories specified in the device class must be NetApp SnapLock volumes.
4 The values NETAPPDUMP, CELERRADUMP, and NDMPDUMP are not valid
for storage pools defined with a FILE-type device class.
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
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
ACCess
Specifies how client nodes and server processes (such as migration and


DEFINE STGPOOL

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.
the NEXTSTGPOOL parameter) and is defined as readonly, the storage
pool.
UNAVailable
storage pool.
Server processes can move files within the volumes in the storage pool and
can also move or copy files from this storage pool to another storage pool.
the NEXTSTGPOOL parameter) and is defined as unavailable, 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.
NOLimit
Specifies that there is no maximum size limit for physical files stored in the
storage pool.
maximum_file_size
Limits the maximum physical file size. Specify an integer from 1 to 999999,
followed by a scale factor. For example, MAXSIZE=5G specifies that the
maximum file size for this storage pool is 5 gigabytes. Scale factors are:

Scale factor Meaning
K kilobyte
M megabyte
G gigabyte
T terabyte

If a file exceeds the maximum size and no pool is specified as the next storage
pool in the hierarchy, the server does not store the file. If a file exceeds the
maximum size and a pool is specified as the next storage pool, the server
stores the file in the next storage pool that can accept the file size. If you
specify the next storage pool parameter, at least one storage pool in your


DEFINE STGPOOL

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
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
No

v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
NEXTstgpool
Specifies a primary storage pool to which files are migrated. You cannot
migrate data from a sequential access storage pool to a random access storage
pool. This parameter is optional.
If this storage pool does not have a next storage pool, the server cannot
migrate files from this storage pool and cannot store files that exceed the
maximum size for this storage pool in another storage pool.
When there is insufficient space available in the current storage pool, the
NEXTSTGPOOL parameter for sequential access storage pools does not allow
data to be stored into the next pool. In this case the server issues a message
and the transaction fails.
For next storage pools with a device type of FILE, the server performs a
preliminary check to determine whether sufficient space is available. If space is
not available, the server skips to the next storage pool in the hierarchy. If space
is available, the server attempts to store data in that pool. However, it is
possible that the storage operation could fail because, at the time the actual
storage operation is attempted, the space is no longer available.


DEFINE STGPOOL

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.

v NETAPPDUMP
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
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.

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.

v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP


DEFINE STGPOOL

REClaim
Specifies when the server reclaims a volume, based on the percentage of
reclaimable space on a volume. Reclamation makes the fragmented space on
volumes usable again by moving any remaining unexpired files from one
volume to another volume, thus making the original volume available for
reuse. This parameter is optional. You can specify an integer from 1 to 100. The
default value is 60, except for storage pools that use WORM devices.
For storage pools that use WORM devices, the default value is 100 to prevent
reclamation from occurring. This is the default because a WORM volume is not
reusable. If necessary, you can lower the value to allow the server to
consolidate data onto fewer volumes. Volumes emptied by reclamation can be
checked out of the library, freeing slots for new volumes.
Specify a value of 50 percent or greater for this parameter so that files stored
on two volumes can be combined onto a single output volume.

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
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
140.
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


DEFINE STGPOOL

volumes are eligible for reclamation, the server will start ten processes and
four of them will complete without processing a volume.

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:
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


DEFINE STGPOOL

specified is different than what is currently defined for storage pools
already defined to the device class name.

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.
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 belonging to a group of nodes on a
single tape or on as few tapes as possible. Data for a single node can
also be spread across several tapes associated with a group.
v Collocates by node the data for ungrouped nodes. Whenever possible,
the server stores the data for a single node on a single tape. All available
tapes that already have data for the node are used before available space
on any other tape is used.
NODe
Specifies that collocation is enabled at the client node level. The server
attempts to put data for one node on as few volumes as possible. If the
node has multiple file spaces, the server does not attempt to collocate those
file spaces. For backward compatibility, COLLOCATE=YES is still accepted
by the server to specify collocation at the client node level.
If a storage pool contains data for a node that is a member of a collocation
group and you specify COLLOCATE=NODE, the data will be collocated by
node not by group.


DEFINE STGPOOL

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 utilize 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.
default value is 0, which means that a volume can be rewritten or returned to
the scratch pool as soon as all the files are deleted from the volume.

Important: Use this parameter to help ensure that when you restore the
database to an earlier level, database references to files in the storage pool are
still valid. You must set this parameter to a value greater than the number of
days you plan to retain the oldest database backup. The number of days
specified for this parameter should be the same as the number specified for the
SET DRMDBBACKUPEXPIREDAYS command. For more information, see the
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

v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP


DEFINE STGPOOL

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.
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.

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.
Yes
Specifies that, when necessary to meet the low migration threshold, the
server continues to migrate files that do not satisfy the migration delay
time.
If you allow more than one migration process for the storage pool, some
files that do not satisfy the migration delay time may be migrated
unnecessarily. As one process migrates files that satisfy the migration delay
time, a second process could begin migrating files that do not satisfy the
migration delay time to meet the low migration threshold. The first process
that is still migrating files that satisfy the migration delay time might have,
by itself, caused the low migration threshold to be met.
No
Specifies that the server stops migration when no eligible files remain to be
migrated, even before reaching the low migration threshold. The server
does not migrate files unless the files satisfy the migration delay time.
MIGPRocess
Specifies the number of parallel processes to use for migrating the files from
the volumes in this storage pool. This parameter is optional. Enter a value
from 1 to 999. The default value is 1.
sequential storage pools that will be involved with the migration, and the
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


DEFINE STGPOOL

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
time, the migration processes will end. For information about specifying the
140.
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.

v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
DATAFormat
Specifies the data format to use to back up files to this storage pool and restore
files from this storage pool. The default format is the NATIVE server format.
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 the Tivoli Storage Manager for Space


DEFINE STGPOOL

Management client), you can minimize wasted space on storage volumes
by specifying the NONBLOCK data format. In most situations, however,
the NATIVE format is preferred.
NETAPPDump
Specifies the data is in a 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
| 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
| active-data pools during client store sessions or server import processes.


DEFINE STGPOOL

| 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
| 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.
| All
| 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.
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:
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:
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.


DEFINE STGPOOL

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
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.
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
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 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.
| 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.
| simultaneous-write function during server data migration. If data is being
| written simultaneously and a write failure occurs to any copy storage pool


DEFINE STGPOOL

| 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.

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.
and ACTIVEDATAPOOLS parameters can not exceed three.
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:
v NETAPPDUMP
v CELERRADUMP
v NDMPDUMP
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
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.


DEFINE STGPOOL

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.

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


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


Syntax

DEFine STGpool pool_name device_class_name POoltype = COpy

ACCess = READWrite

READOnly
UNAVailable

COLlocate = No REClaim = 100

COLlocate = No REClaim = percent
GRoup
NODe
FIlespace

RECLAIMPRocess = 1 RECLAMATIONType = THRESHold

RECLAIMPRocess = number (1)
RECLAMATIONType = THRESHold
SNAPlock

OFFSITERECLAIMLimit = NOLimit
MAXSCRatch = number
OFFSITERECLAIMLimit = number

REUsedelay = 0


DATAFormat = NATive CRCData = No

(2) CRCData = Yes
DATAFormat = NATive No
NONblock
NETAPPDump
CELERRADump
NDMPDump

DEDUPlicate = No IDENTIFYPRocess = 0

DEDUPlicate = No (4)
(3) IDENTIFYPRocess = number
Yes

Notes:


DEFINE STGPOOL

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.
parameter is YES.

Parameters
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.
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
copy storage pool.
The server can use files in the copy storage pool to restore files to primary
copy storage pool from volumes outside the storage pool. A storage pool
cannot be backed up to the copy storage pool.
COLlocate


DEFINE STGPOOL

possible. This parameter is optional. The default value is NO.
No
GRoup
spaces.
following actions:
NODe
node not by group.
FIlespace
REClaim
reclaimable space on a volume. Reclamation makes the fragmented space on
volumes usable again by moving any remaining unexpired files from one
volume to another volume, thus making the original volume available for
reuse. This parameter is optional. You can specify an integer from 1 to 100. The
default value is 100, which means that reclamation is not performed.


DEFINE STGPOOL

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
default value is 1.
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
140.
RECLAMATIONType
the following:
THRESHold


DEFINE STGPOOL

SNAPlock
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
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


DEFINE STGPOOL

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.
allowing the server to request scratch volumes as needed, you avoid having to
define each volume to be used.
volumes available in the copy storage pool and the corresponding estimated
capacity for the copy storage pool.
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

REUsedelay

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


DEFINE STGPOOL

DATAFormat
Specifies the data format to use to back up files to this storage pool and restore
NATive
Specifies the data format is the native IBM Tivoli Storage Manager server
NONblock

Tip: 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
migrating very small files using theTivoli Storage Manager for Space
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
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


DEFINE STGPOOL

Yes
No
DEDUPlicate
that are defined with a FILE-type device class. The default value is NO.
| IDENTIFYPRocess
| 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.
| 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


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


Syntax

DEFine STGpool pool_name device_class_name POoltype = ACTIVEdata

ACCess = READWrite

READOnly
UNAVailable

COLlocate = No REClaim = 60

COLlocate = No REClaim = percent
GRoup
NODe
FIlespace

RECLAIMPRocess = 1 RECLAMATIONType = THRESHold

RECLAIMPRocess = number (1)
RECLAMATIONType = THRESHold
SNAPlock

OFFSITERECLAIMLimit = NOLimit
MAXSCRatch = number
OFFSITERECLAIMLimit = number

REUsedelay = 0


DATAFormat = NATive CRCData = No

DATAFormat = NATive CRCData = Yes
NONblock No

DEDUPlicate = No IDENTIFYPRocess = 0

DEDUPlicate = No (3)
(2) IDENTIFYPRocess = number
Yes

Notes:


DEFINE STGPOOL

2 This parameter is valid only for storage pools that are defined with a FILE
device class.
parameter is YES.

Parameters
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
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.
The server can use files in the active-data pool to restore files to primary
active-data pool from volumes outside the storage pool. A storage pool
cannot be copied to the active-data pool.
UNAVailable
active-data pool.
The server can use files in the active-data pool to restore files to primary
active-data pool from volumes outside the storage pool. A storage pool
cannot be copied to the active-data pool.
COLlocate
possible. This parameter is optional. The default value is NO.


DEFINE STGPOOL

No
GRoup
spaces.
following actions:
NODe
node not by group.
FIlespace
REClaim
reclaimable space on a volume. Reclamation makes the fragmented space and
space occupied by inactive backup files on volumes usable again by moving
any remaining unexpired files and active backup files from one volume to
another volume. This makes the original volume available for reuse. This
value is 60.
If you change the value from the default, specify a value of 50 percent or
greater so that files stored on two volumes can be combined onto a single
output volume.
When an active-data pool volume that is offsite becomes eligible for
reclamation, the reclamation process attempts to obtain the unexpired files on


DEFINE STGPOOL

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
default value is 1.
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
140.
RECLAMATIONType
the following:
THRESHold
SNAPlock


DEFINE STGPOOL

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
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.


DEFINE STGPOOL

allowing the server to request scratch volumes as needed, you avoid having to
define each volume to be used.
volumes available in the active-data pool and the corresponding estimated
capacity for the active-data pool.
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

REUsedelay

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
OVFLOcation
DATAFormat
Specifies the data format to use to copy files to this storage pool and restore


DEFINE STGPOOL

NATive
NONblock

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
migrating very small files using the Tivoli Storage Manager for Space
CRCData
Yes
No
DEDUPlicate
that are defined with a FILE device class. The default value is NO.
| IDENTIFYPRocess
| 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.
| define a high number of duplicate-identification proces

Ibm tivoli storage manager for windows administrator's reference 6.2

More Related Content

What's hot (19)

Similar to Ibm tivoli storage manager for windows administrator's reference 6.2 (20)

More from Banking at Ho Chi Minh city (20)

Recently uploaded (20)

Ibm tivoli storage manager for windows administrator's reference 6.2