IBMpublib.boulder.ibm.com/tividd/td/SMSUNN/GC32-0779-01/en...COPY CLOPTSET (Copy a Client Option...

IBM Tivoli Storage Managerfor Sun Solaris

Administrator’s ReferenceVersion 5.2

GC32-0779-01

��

Note!Before using this information and the product it supports, be sure to read the general information under Appendix C,“Notices”, on page 1117.

Second Edition (April 2003)

This edition applies to Version 5.2 of the IBM Tivoli Storage Manager for Sun Solaris (program numbers 5698-ISM,5698-ISX, 5698-HSM, and 5698-SAN) and to any subsequent releases until otherwise indicated in new editions ortechnical newsletters.

Changes since the March 2002 edition are marked with a vertical bar (|) in the left margin. Ensure that you areusing the correct edition for the level of the product.

Order publications through your IBM representative or the IBM branch office serving your locality.

Your feedback is important in helping to provide the most accurate and highest quality information. If you haveany comments about this book or any other IBM Tivoli Storage Manager documentation, please see “ContactingCustomer Support” on page xiii.

© Copyright International Business Machines Corporation 1993, 2003. All rights reserved.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

|

|||

||

|

|||

Contents

Preface . . . . . . . . . . . . . . . xiWho Should Read This Publication . . . . . . xiWhat You Should Know Before Reading ThisPublication. . . . . . . . . . . . . . . xiIBM Tivoli Storage Manager Web Site . . . . . . xiIBM Tivoli Storage Manager Publications . . . . xiRelated IBM® Hardware Products Publications . . xiiiIBM International Technical Support CenterPublications (Redbooks) . . . . . . . . . . xiiiContacting Customer Support . . . . . . . . xiii

Reporting a Problem . . . . . . . . . . xivTranslations . . . . . . . . . . . . . . xiv

Changes for IBM Tivoli StorageManager Version 5. . . . . . . . . . xvTechnical Changes for Version 5 Release 2—April2003 . . . . . . . . . . . . . . . . . xvTechnical Changes for Version 5 Release 1—March2002 . . . . . . . . . . . . . . . . xix

Part 1. Using Commands . . . . . . 1

Chapter 1. Using Syntax Diagrams . . . 3Syntax Diagrams Descriptions . . . . . . . . 3

Chapter 2. Entering AdministrativeCommands . . . . . . . . . . . . . 7Command Entry Rules . . . . . . . . . . . 7Processing Administrative Commands . . . . . . 8

Commands Processed in the Foreground . . . . 8Commands Processed in the Background . . . . 9

Using Wildcard Characters . . . . . . . . . 10Examples for Match-Any Characters . . . . . 10Examples for Match-Exactly-One Character . . . 10

Naming Conventions in Tivoli Storage Manager . . 11Naming Objects in Tivoli Storage Manager . . . 11

Routing Commands . . . . . . . . . . . 11Examples of Routing Commands . . . . . . 12

Chapter 3. Using the Command-LineInterface . . . . . . . . . . . . . . 15Using the Server Console . . . . . . . . . . 15Using the Administrative Command Line Client . . 15

Starting the Administrative Command LineClient . . . . . . . . . . . . . . . 15Stopping the Administrative Command LineClient . . . . . . . . . . . . . . . 16Console Mode . . . . . . . . . . . . 16Mount Mode . . . . . . . . . . . . . 16Batch Mode . . . . . . . . . . . . . 16Interactive Mode . . . . . . . . . . . 17

Using the Administrative Web Interface . . . . . 17Starting the Administrative Web Interface . . . 17

Stopping the Administrative Web Interface . . . 18Using Administrative Client Options . . . . . . 18Using Continuation Characters . . . . . . . . 19Redirecting Command Output . . . . . . . . 20

Chapter 4. Using Commands Based onPrivilege Class . . . . . . . . . . . 21Commands Requiring System Privilege . . . . . 21Commands Requiring Policy Privilege . . . . . 23Commands Requiring Storage Privilege . . . . . 24Commands Requiring Operator Privilege . . . . 25Commands Requiring Analyst Privilege . . . . . 25Commands Any Administrator Can Issue . . . . 26

Part 2. Command Reference . . . . 27

Chapter 5. Administrative Commands 29ACCEPT DATE (Accepts the Current System Date) 30ACTIVATE POLICYSET (Activate a New Policy Set) 31ASSIGN DEFMGMTCLASS (Assign a DefaultManagement Class). . . . . . . . . . . . 33AUDIT LIBRARY (Verify an Automated Library’sInventory) . . . . . . . . . . . . . . . 35AUDIT LICENSES (Audit Server Storage Usage) . . 37AUDIT VOLUME (Verify Database Information fora Storage Pool Volume) . . . . . . . . . . 38BACKUP DB (Back Up the Database). . . . . . 43BACKUP DEVCONFIG (Create Backup Copies ofDevice Configuration Information) . . . . . . 46BACKUP NODE (Back Up a NAS Node) . . . . 48BACKUP STGPOOL (Back Up Primary Storage Poolto Copy Storage Pool) . . . . . . . . . . . 51BACKUP VOLHISTORY (Save Sequential VolumeHistory Information) . . . . . . . . . . . 54BEGIN EVENTLOGGING (Begin Logging Events) 56CANCEL EXPIRATION (Cancel an ExpirationProcess) . . . . . . . . . . . . . . . 58CANCEL PROCESS (Cancel an AdministrativeProcess) . . . . . . . . . . . . . . . 59CANCEL REQUEST (Cancel One or More MountRequests) . . . . . . . . . . . . . . . 61CANCEL RESTORE (Cancel a Restartable RestoreSession) . . . . . . . . . . . . . . . 62CANCEL SESSION (Cancel One or More ClientSessions) . . . . . . . . . . . . . . . 63CHECKIN LIBVOLUME (Check a Storage Volumeinto a Library) . . . . . . . . . . . . . 64CHECKOUT LIBVOLUME (Check a Storage Volumeout of a Library) . . . . . . . . . . . . . 73CLEAN DRIVE (Clean a Drive). . . . . . . . 79COMMIT (Control Committing of Commands in aMacro) . . . . . . . . . . . . . . . . 80CONVERT ARCHIVE (Allow Clients to QueryArchive Files by Description ) . . . . . . . . 81

© Copyright IBM Corp. 1993, 2003 iii

||||||

||||

||

COPY CLOPTSET (Copy a Client Option Set) . . . 82COPY DOMAIN (Copy a Policy Domain) . . . . 83COPY MGMTCLASS (Copy a Management Class) 85COPY POLICYSET (Copy a Policy Set) . . . . . 87COPY PROFILE (Copy a Profile) . . . . . . . 89COPY SCHEDULE (Copy a Client or anAdministrative Command Schedule) . . . . . . 91

COPY SCHEDULE — Client. . . . . . . . 92COPY SCHEDULE — Administrative Command 94Related Commands. . . . . . . . . . . 95

COPY SCRIPT (Copy a Tivoli Storage ManagerScript) . . . . . . . . . . . . . . . . 96COPY SERVERGROUP (Copy a Server Group) . . 97DEFINE ASSOCIATION (Associate Client Nodeswith a Schedule). . . . . . . . . . . . . 98DEFINE BACKUPSET (Define a Backup Set) . . . 100DEFINE CLIENTACTION (Define a One-TimeClient Action) . . . . . . . . . . . . . 102DEFINE CLIENTOPT (Define an Option to anOption Set) . . . . . . . . . . . . . . 107DEFINE CLOPTSET (Define a Client Option SetName) . . . . . . . . . . . . . . . . 111DEFINE COPYGROUP (Define a Copy Group) . . 112

DEFINE COPYGROUP — Backup . . . . . 113DEFINE COPYGROUP — Archive . . . . . 118Related Commands . . . . . . . . . . 121

DEFINE DATAMOVER (Define a Data Mover) . . 122DEFINE DBBACKUPTRIGGER (Define theDatabase Backup Trigger) . . . . . . . . . 125DEFINE DBCOPY (Define a Volume Copy of aDatabase Volume) . . . . . . . . . . . . 127DEFINE DBVOLUME (Define a Database Volume) 129DEFINE DEVCLASS (Define a Device Class) . . . 131

DEFINE DEVCLASS — 3570 . . . . . . . 132DEFINE DEVCLASS — 3590 . . . . . . . 135DEFINE DEVCLASS — 4MM . . . . . . . 139DEFINE DEVCLASS — 8MM . . . . . . . 143DEFINE DEVCLASS — CARTRIDGE . . . . 148DEFINE DEVCLASS — DLT . . . . . . . 151DEFINE DEVCLASS — DTF . . . . . . . 155DEFINE DEVCLASS — ECARTRIDGE . . . . 158DEFINE DEVCLASS — FILE . . . . . . . 162DEFINE DEVCLASS — GENERICTAPE . . . 164DEFINE DEVCLASS — LTO . . . . . . . 166DEFINE DEVCLASS — NAS . . . . . . . 169DEFINE DEVCLASS — OPTICAL and WORMTYPES. . . . . . . . . . . . . . . 172DEFINE DEVCLASS — QIC . . . . . . . 175DEFINE DEVCLASS — REMOVABLEFILE . . 180DEFINE DEVCLASS — SERVER . . . . . . 183DEFINE DEVCLASS — VOLSAFE . . . . . 185Related Commands . . . . . . . . . . 188

DEFINE DOMAIN (Define a New Policy Domain) 189DEFINE DRIVE (Define a Drive to a Library) . . 191DEFINE EVENTSERVER (Define a Server as theEvent Server) . . . . . . . . . . . . . 195DEFINE GRPMEMBER (Add a Server to a ServerGroup) . . . . . . . . . . . . . . . 196DEFINE LIBRARY (Define a Library) . . . . . 198DEFINE LOGCOPY (Define a Volume Copy of aRecovery Log Volume) . . . . . . . . . . 206

DEFINE LOGVOLUME (Define a Recovery LogVolume) . . . . . . . . . . . . . . . 208DEFINE MACHINE (Define Machine Information) 210DEFINE MACHNODEASSOCIATION (Associate aNode With a Machine) . . . . . . . . . . 212DEFINE MGMTCLASS (Define a ManagementClass) . . . . . . . . . . . . . . . . 214DEFINE PATH (Define a Path) . . . . . . . 217DEFINE POLICYSET (Define a Policy Set). . . . 223DEFINE PROFASSOCIATION (Define a ProfileAssociation) . . . . . . . . . . . . . . 225DEFINE PROFILE (Define a Profile) . . . . . . 231DEFINE RECMEDMACHASSOCIATION(Associate Recovery Media with a Machine) . . . 233DEFINE RECOVERYMEDIA (Define RecoveryMedia) . . . . . . . . . . . . . . . 235DEFINE SCHEDULE (Define a Client or anAdministrative Command Schedule) . . . . . 237

DEFINE SCHEDULE — Client . . . . . . 238DEFINE SCHEDULE — AdministrativeCommand . . . . . . . . . . . . . 246Related Commands . . . . . . . . . . 252

DEFINE SCRIPT (Define a Tivoli Storage ManagerScript) . . . . . . . . . . . . . . . . 253DEFINE SERVER (Define a Server forServer-to-Server Communications) . . . . . . 256DEFINE SERVERGROUP (Define a Server Group) 260DEFINE SPACETRIGGER (Define the Database orRecovery Log Space Trigger) . . . . . . . . 261DEFINE STGPOOL (Define a Storage Pool) . . . 264

DEFINE STGPOOL — Primary Random Access 265DEFINE STGPOOL — Primary SequentialAccess. . . . . . . . . . . . . . . 271DEFINE STGPOOL — Copy Sequential Access 279Related Commands . . . . . . . . . . 283

DEFINE SUBSCRIPTION (Define a ProfileSubscription) . . . . . . . . . . . . . 284DEFINE VOLUME (Define a Volume in a StoragePool) . . . . . . . . . . . . . . . . 286DELETE ASSOCIATION (Delete the NodeAssociation to a Schedule) . . . . . . . . . 290DELETE BACKUPSET (Delete a Backup Set) . . . 292DELETE CLIENTOPT (Delete an Option in anOption Set) . . . . . . . . . . . . . . 296DELETE CLOPTSET (Delete a Client Option Set) 297DELETE COPYGROUP (Delete a Copy Group) . . 298DELETE DATAMOVER (Delete a Data Mover) . . 300DELETE DBBACKUPTRIGGER (Delete theDatabase Backup Trigger) . . . . . . . . . 301DELETE DBVOLUME (Delete a Database Volume) 302DELETE DEVCLASS (Delete a Device Class) . . . 303DELETE DOMAIN (Delete a Policy Domain) . . . 304DELETE DRIVE (Delete a Drive from a Library) 305DELETE EVENT (Delete Event Records) . . . . 306DELETE EVENTSERVER (Deletes the Defintion ofthe Event Server) . . . . . . . . . . . . 308DELETE FILESPACE (Delete Client Node Datafrom the Server) . . . . . . . . . . . . 309DELETE GRPMEMBER (Delete a Server from aServer Group) . . . . . . . . . . . . . 313DELETE LIBRARY (Delete a Library) . . . . . 314

iv IBM Tivoli Storage Manager for Sun Solaris: Administrator’s Reference

||

DELETE LOGVOLUME (Delete a Recovery LogVolume) . . . . . . . . . . . . . . . 315DELETE MACHINE (Delete Machine Information) 316DELETE MACHNODEASSOCIATION (DeleteAssociation Between a Machine and a Node) . . . 317DELETE MGMTCLASS (Delete a ManagementClass) . . . . . . . . . . . . . . . . 318DELETE PATH (Delete a Path) . . . . . . . 320DELETE POLICYSET (Delete a Policy Set). . . . 322DELETE PROFASSOCIATION (Delete a ProfileAssociation) . . . . . . . . . . . . . . 323DELETE PROFILE (Delete a Profile) . . . . . . 326DELETE RECMEDMACHASSOCIATION (DeleteRecovery Media and Machine Association) . . . 328DELETE RECOVERYMEDIA (Delete RecoveryMedia) . . . . . . . . . . . . . . . 329DELETE SCHEDULE (Delete a Client or anAdministrative Command Schedule) . . . . . 330

DELETE SCHEDULE — Client . . . . . . 331DELETE SCHEDULE — AdministrativeCommand . . . . . . . . . . . . . 332Related Commands . . . . . . . . . . 333

DELETE SCRIPT (Delete Command Lines from aScript or Delete the Entire Script) . . . . . . . 334DELETE SERVER (Delete a Server Definition) . . 335DELETE SERVERGROUP (Delete a Server Group) 336DELETE SPACETRIGGER (Delete the Database orRecovery Log Space Triggers) . . . . . . . . 337DELETE STGPOOL (Delete a Storage Pool) . . . 338DELETE SUBSCRIBER (Delete Subscriptions froma Configuration Manager Database) . . . . . . 340DELETE SUBSCRIPTION (Delete a ProfileSubscription) . . . . . . . . . . . . . 341DELETE VOLHISTORY (Delete Sequential VolumeHistory Information) . . . . . . . . . . . 342DELETE VOLUME (Delete a Storage Pool Volume) 347DISABLE EVENTS (Disable Events for EventLogging) . . . . . . . . . . . . . . . 350DISABLE SESSIONS (Temporarily Prevent ClientNode Access to the Server) . . . . . . . . . 353DISMOUNT VOLUME (Dismount a Volume byVolume Name) . . . . . . . . . . . . . 354ENABLE EVENTS (Enable Server or Client Eventsfor Logging) . . . . . . . . . . . . . . 355ENABLE SESSIONS (Resume User Activity on theServer) . . . . . . . . . . . . . . . 358END EVENTLOGGING (Stop Logging Events) . . 359EXPIRE INVENTORY (Manually Start InventoryExpiration Processing) . . . . . . . . . . 361EXPORT ADMIN (Export AdministratorInformation). . . . . . . . . . . . . . 364

EXPORT ADMIN — To Sequential Media . . . 365EXPORT ADMIN— Directly to Another Server 368Related Commands . . . . . . . . . . 370

EXPORT NODE (Export Client Node Information) 371EXPORT NODE — To Sequential Media . . . 372EXPORT NODE — Directly to Another Server 378Related Commands . . . . . . . . . . 383

EXPORT POLICY (Export Policy Information) . . 384EXPORT POLICY — To Sequential Media . . . 385EXPORT POLICY— Directly to Another Server 388

Related Commands . . . . . . . . . . 390EXPORT SERVER (Export Server Information) . . 391

EXPORT SERVER — To Sequential Media . . . 392EXPORT SERVER — Directly to Another Server 397Related Commands . . . . . . . . . . 401

EXTEND DB (Increase the Assigned Capacity ofthe Database) . . . . . . . . . . . . . 402EXTEND LOG (Increase the Assigned Capacity ofthe Recovery Log) . . . . . . . . . . . . 404GENERATE BACKUPSET (Generate a Backup Setof a Client’s Data) . . . . . . . . . . . . 406GRANT AUTHORITY (Add AdministratorAuthority) . . . . . . . . . . . . . . 410HALT (Shut Down the Server). . . . . . . . 414HELP (Get Help on Commands and ErrorMessages) . . . . . . . . . . . . . . 416IMPORT ADMIN (Import AdministratorInformation). . . . . . . . . . . . . . 419IMPORT NODE (Import Client Node Information) 422IMPORT POLICY (Import Policy Information) . . 428IMPORT SERVER (Import Server Information) . . 431INSERT MACHINE (Insert Machine CharacteristicsInformation or Recovery Instructions) . . . . . 436ISSUE MESSAGE (Issue a Message From a ServerScript) . . . . . . . . . . . . . . . . 438LABEL LIBVOLUME (Label a Library Volume) . . 440LOCK ADMIN (Lock Out an Administrator) . . . 447LOCK NODE (Lock Out a Client Node) . . . . 448LOCK PROFILE (Lock a Profile) . . . . . . . 449MACRO (Invoke a Macro) . . . . . . . . . 451MOVE DATA (Move Files on a Storage PoolVolume) . . . . . . . . . . . . . . . 453MOVE DRMEDIA (Move Disaster Recovery MediaOffsite and Back Onsite) . . . . . . . . . . 456MOVE GRPMEMBER (Move a Server GroupMember) . . . . . . . . . . . . . . . 469MOVE MEDIA (Move Sequential Access StoragePool Media) . . . . . . . . . . . . . . 470MOVE NODEDATA (Move Data by Node in aSequential Access Storage Pool) . . . . . . . 477

MOVE NODEDATA — All File Spaces for Oneor More Nodes . . . . . . . . . . . . 478MOVE NODEDATA — Selected File Spaces forOne Node . . . . . . . . . . . . . 481Related Commands . . . . . . . . . . 485

NOTIFY SUBSCRIBERS (Notify Managed Serversto Update Profiles) . . . . . . . . . . . 486PING SERVER (Test the Connection BetweenServers) . . . . . . . . . . . . . . . 487PREPARE (Create a Recovery Plan File) . . . . 488QUERY ACTLOG (Query the Activity Log) . . . 494QUERY ADMIN (Display AdministratorInformation). . . . . . . . . . . . . . 499QUERY ASSOCIATION (Query Client NodeAssociations with a Schedule) . . . . . . . . 504QUERY AUDITOCCUPANCY (Query Client NodeStorage Utilization) . . . . . . . . . . . 506QUERY BACKUPSET (Query a Backup Set) . . . 509QUERY BACKUPSETCONTENTS (Query Contentsof a Backup Set) . . . . . . . . . . . . 513QUERY CLOPTSET (Query a Client Option Set) 515

Contents v

||

||

||

||

QUERY CONTENT (Query the Contents of aStorage Pool Volume). . . . . . . . . . . 517QUERY COPYGROUP (Query Copy Groups). . . 524QUERY DATAMOVER (Display Data MoverDefinitions) . . . . . . . . . . . . . . 529QUERY DB (Display Information on the Database) 532QUERY DBBACKUPTRIGGER (Query theDatabase Backup Trigger) . . . . . . . . . 535QUERY DBVOLUME (Display Information on Oneor More Database Volumes) . . . . . . . . 537QUERY DEVCLASS (Display Information on Oneor More Device Classes) . . . . . . . . . . 540QUERY DOMAIN (Query a Policy Domain) . . . 543QUERY DRIVE (Query Information about a Drive) 546QUERY DRMEDIA (Query Disaster RecoveryMedia) . . . . . . . . . . . . . . . 550QUERY DRMSTATUS (Query Disaster RecoveryManager System Parameters) . . . . . . . . 558QUERY ENABLED (Query Enabled Events) . . . 561QUERY EVENT (Query Scheduled and CompletedEvents) . . . . . . . . . . . . . . . 563

QUERY EVENT — Client Schedules . . . . . 564QUERY EVENT — Administrative Schedules 570Related Commands . . . . . . . . . . 574

QUERY EVENTRULES (Query Rules for Server orClient Events) . . . . . . . . . . . . . 575QUERY EVENTSERVER (Query the Event Server) 578QUERY FILESPACE (Query One or More FileSpaces) . . . . . . . . . . . . . . . 579QUERY LIBRARY (Query a Library). . . . . . 583QUERY LIBVOLUME (Query a Library Volume) 586QUERY LICENSE (Display License Information) 588QUERY LOG (Display Information on theRecovery Log) . . . . . . . . . . . . . 589QUERY LOGVOLUME (Display Information onOne or More Log Volumes). . . . . . . . . 592QUERY MACHINE (Query Machine Information) 595QUERY MEDIA (Query Sequential Access StoragePool Media) . . . . . . . . . . . . . . 599QUERY MGMTCLASS (Query a ManagementClass) . . . . . . . . . . . . . . . . 606QUERY MOUNT (Display Information onMounted Sequential Access Volumes) . . . . . 610QUERY NASBACKUP (Query NAS BackupImages) . . . . . . . . . . . . . . . 611QUERY NODE (Query Nodes) . . . . . . . 614QUERY OCCUPANCY (Query Client File Spaces inStorage Pools) . . . . . . . . . . . . . 621QUERY OPTION (Query Server Options) . . . . 625QUERY PATH (Display a Path Definition) . . . . 628QUERY POLICYSET (Query a Policy Set) . . . . 632QUERY PROCESS (Query One or More ServerProcesses) . . . . . . . . . . . . . . 635QUERY PROFILE (Query a Profile) . . . . . . 637QUERY RECOVERYMEDIA (Query RecoveryMedia) . . . . . . . . . . . . . . . 641QUERY REQUEST (Query One or More PendingMount Requests) . . . . . . . . . . . . 644QUERY RESTORE (Query Restartable RestoreSessions) . . . . . . . . . . . . . . . 645

QUERY RPFCONTENT (Query Recovery Plan FileContents Stored on a Target Server) . . . . . . 648QUERY RPFILE (Query Recovery Plan FileInformation Stored on a Target Server) . . . . . 650QUERY SCHEDULE (Query Schedules) . . . . 653

QUERY SCHEDULE — Client . . . . . . . 654QUERY SCHEDULE — Administrative . . . . 658Related Commands . . . . . . . . . . 661

QUERY SCRIPT (Query Tivoli Storage ManagerScripts) . . . . . . . . . . . . . . . 662QUERY SERVER (Query a Server) . . . . . . 666QUERY SERVERGROUP (Query a Server Group) 670QUERY SESSION (Query Client Sessions) . . . . 672QUERY SPACETRIGGER (Query the Database orRecovery Log Space Triggers) . . . . . . . . 675QUERY SQLSESSION (Display SQL Session Value) 678QUERY STATUS (Query System Parameters) . . . 680QUERY STGPOOL (Query Storage Pools) . . . . 686QUERY SUBSCRIBER (Display SubscriberInformation). . . . . . . . . . . . . . 692QUERY SUBSCRIPTION (Display SubscriptionInformation). . . . . . . . . . . . . . 694QUERY SYSTEM (Query the System Configurationand Capacity) . . . . . . . . . . . . . 696QUERY TAPEALERTMSG (Display Status of SETTAPEALERTMSG Command) . . . . . . . . 698QUERY TOC (Display Table of Contents for aBackup Image) . . . . . . . . . . . . . 699QUERY VOLHISTORY (Display Sequential VolumeHistory Information) . . . . . . . . . . . 702QUERY VOLUME (Query Storage Pool Volumes) 710QUIT (End the Interactive Mode of theAdministrative Client) . . . . . . . . . . 715RECONCILE VOLUMES (Reconcile Differences inthe Virtual Volume Definitions) . . . . . . . 716REDUCE DB (Decrease the Assigned Capacity ofthe Database) . . . . . . . . . . . . . 719REDUCE LOG (Decrease the Assigned Capacity ofthe Recovery Log) . . . . . . . . . . . . 720REGISTER ADMIN (Register an Administrator) 722REGISTER LICENSE (Register a New License) . . 724REGISTER NODE (Register a Node). . . . . . 728REMOVE ADMIN (Delete an Administrator) . . . 738REMOVE NODE (Delete a Node or an AssociatedMachine Node) . . . . . . . . . . . . . 739RENAME ADMIN (Rename an Administrator) . . 741RENAME FILESPACE (Rename a Client File Spaceon the Server) . . . . . . . . . . . . . 742RENAME NODE (Rename a Node) . . . . . . 745RENAME SCRIPT (Rename a Tivoli StorageManager Script) . . . . . . . . . . . . 746RENAME SERVERGROUP (Rename a ServerGroup) . . . . . . . . . . . . . . . 747RENAME STGPOOL (Change the Name of aStorage Pool) . . . . . . . . . . . . . 748REPLY (Allow a Request to Continue Processing) 749RESET BUFPOOL (Reset the Database Buffer PoolStatistics) . . . . . . . . . . . . . . . 750RESET DBMAXUTILIZATION (Reset theUtilization Statistic for the Database) . . . . . 751

vi IBM Tivoli Storage Manager for Sun Solaris: Administrator’s Reference

|||

||||||

RESET LOGCONSUMPTION (Reset theCumulative Log Consumption Statistic) . . . . 752RESET LOGMAXUTILIZATION (Reset theUtilization Statistic for the Log) . . . . . . . 753RESET PASSEXP (Reset Password Expiration) . . 754RESTORE NODE (Restore a NAS Node) . . . . 756RESTORE STGPOOL (Restore Storage Pool Datafrom a Copy Pool). . . . . . . . . . . . 760RESTORE VOLUME (Restore Primary VolumeData from a Copy Pool) . . . . . . . . . . 763REVOKE AUTHORITY (Remove AdministratorAuthority) . . . . . . . . . . . . . . 767ROLLBACK (Rollback Uncommitted Changes in aMacro) . . . . . . . . . . . . . . . 771RUN (Run a Tivoli Storage Manager Script) . . . 772SELECT (Perform an SQL Query of the IBM TivoliStorage Manager Database). . . . . . . . . 775SET ACCOUNTING (Set Accounting Records Onor Off). . . . . . . . . . . . . . . . 783SET ACTLOGRETENTION (Set the RetentionPeriod for the Activity Log) . . . . . . . . 784SET AUTHENTICATION (Set PasswordAuthentication). . . . . . . . . . . . . 785SET CLIENTACTDURATION (Set the DurationPeriod for the Client Action) . . . . . . . . 786SET CONFIGMANAGER (Specify a ConfigurationManager) . . . . . . . . . . . . . . . 787SET CONFIGREFRESH (Set Managed ServerConfiguration Refresh) . . . . . . . . . . 788SET CONTEXTMESSAGING (Set Message ContextReporting On or Off) . . . . . . . . . . . 789SET CROSSDEFINE (Specifies Whether toCross-Define Servers). . . . . . . . . . . 790SET DRMCHECKLABEL (Specify Label Checking) 791SET DRMCMDFILENAME (Specify the Name of aFile to Contain Commands) . . . . . . . . 792SET DRMCOPYSTGPOOL (Specify the CopyStorage Pools to be Managed by DRM). . . . . 793SET DRMCOURIERNAME (Specify the CourierName). . . . . . . . . . . . . . . . 794SET DRMDBBACKUPEXPIREDAYS (Criteria forDB Backup Series Expiration) . . . . . . . . 795SET DRMFILEPROCESS (Specify File Processing) 797SET DRMINSTRPREFIX (Specify the Prefix forRecovery Instructions File Names) . . . . . . 798SET DRMNOTMOUNTABLENAME (Specify theNot Mountable Location Name) . . . . . . . 800SET DRMPLANPREFIX (Specify a Prefix forRecovery Plan File Names) . . . . . . . . . 801SET DRMPLANVPOSTFIX (Specify ReplacementVolume Names) . . . . . . . . . . . . 803SET DRMPRIMSTGPOOL (Specify the PrimaryStorage Pools to be Managed by DRM). . . . . 804SET DRMRPFEXPIREDAYS (Set Criteria forRecovery Plan File Expiration). . . . . . . . 805SET DRMVAULTNAME (Specify the Vault Name) 807SET EVENTRETENTION (Set the Retention Periodfor Event Records). . . . . . . . . . . . 808SET INVALIDPWLIMIT (Set the Number of InvalidLogon Attempts) . . . . . . . . . . . . 809

SET LICENSEAUDITPERIOD (Set License AuditPeriod) . . . . . . . . . . . . . . . 810SET LOGMODE (Set Mode for Saving RecoveryLog Records) . . . . . . . . . . . . . 811SET MAXCMDRETRIES (Set the MaximumNumber of Command Retries). . . . . . . . 813SET MAXSCHEDSESSIONS (Set MaximumScheduled Sessions) . . . . . . . . . . . 814SET MINPWLENGTH (Set Minimum PasswordLength) . . . . . . . . . . . . . . . 815SET PASSEXP (Set Password Expiration Date) . . 816SET QUERYSCHEDPERIOD (Set Query Period forPolling Client Nodes). . . . . . . . . . . 818SET RANDOMIZE (Set Randomization ofScheduled Start Times) . . . . . . . . . . 819SET REGISTRATION (Set Open or ClosedRegistration). . . . . . . . . . . . . . 821SET RETRYPERIOD (Set Time between RetryAttempts) . . . . . . . . . . . . . . 823SET SCHEDMODES (Select a Central SchedulingMode) . . . . . . . . . . . . . . . . 824SET SERVERHLADDRESS (Set the High-LevelAddress of a Server) . . . . . . . . . . . 826SET SERVERLLADDRESS (Set the Low-LevelAddress of a Server) . . . . . . . . . . . 827SET SERVERNAME (Specify the Server Name) . . 828SET SERVERPASSWORD (Set Password for Server) 829SET SERVERURL (Set URL for Server) . . . . . 830SET SQLDATETIMEFORMAT (Set the Format forDate, Time, and Time Stamp for SQL Data) . . . 831SET SQLDISPLAYMODE (Set the Display of SQLData Types) . . . . . . . . . . . . . . 833SET SQLMATHMODE (Set the Mode for SQLArithmetic) . . . . . . . . . . . . . . 834SET SUBFILE (Set Subfile Backup for Client Nodes) 835SET SUMMARYRETENTION (Set Days to KeepData in Activity Summary Table) . . . . . . . 836SET TAPEALERTMSG (Set Tape Alert MessagesOn or Off) . . . . . . . . . . . . . . 837SET TOCLOADRETENTION (Set Load RetentionPeriod for Table of Contents) . . . . . . . . 838SET WEBAUTHTIMEOUT (Set the Web Time-outInterval) . . . . . . . . . . . . . . . 839SETOPT (Set a Server Option for Dynamic Update) 840UNLOCK ADMIN (Unlock an Administrator) . . 841UNLOCK NODE (Unlock a Client Node) . . . . 842UNLOCK PROFILE (Unlock a Profile) . . . . . 843UPDATE ADMIN (Update an Administrator). . . 844UPDATE BACKUPSET (Update a Retention ValueAssigned to a Backup Set) . . . . . . . . . 846UPDATE CLIENTOPT (Update a Client OptionSequence Number) . . . . . . . . . . . 850UPDATE CLOPTSET (Update a Client Option SetDescription) . . . . . . . . . . . . . . 851UPDATE COPYGROUP (Update a Copy Group) 852

UPDATE COPYGROUP — Backup . . . . . 853UPDATE COPYGROUP — Archive . . . . . 857Related Commands . . . . . . . . . . 860

UPDATE DATAMOVER (Update a Data Mover) 861UPDATE DBBACKUPTRIGGER (Update theDatabase Backup Trigger) . . . . . . . . . 863

Contents vii

||

||||||

UPDATE DEVCLASS (Update the Attributes of aDevice Class) . . . . . . . . . . . . . 865

UPDATE DEVCLASS — 3570 . . . . . . . 866UPDATE DEVCLASS — 3590 . . . . . . . 869UPDATE DEVCLASS — 4MM. . . . . . . 872UPDATE DEVCLASS — 8MM. . . . . . . 875UPDATE DEVCLASS — CARTRIDGE . . . . 880UPDATE DEVCLASS — DLT . . . . . . . 883UPDATE DEVCLASS — DTF . . . . . . . 887UPDATE DEVCLASS — ECARTRIDGE . . . 890UPDATE DEVCLASS — FILE . . . . . . . 894UPDATE DEVCLASS — GENERICTAPE . . . 896UPDATE DEVCLASS — LTO . . . . . . . 898UPDATE DEVCLASS — NAS . . . . . . . 901UPDATE DEVCLASS — OPTICAL and WORMTYPES. . . . . . . . . . . . . . . 903UPDATE DEVCLASS — QIC . . . . . . . 906UPDATE DEVCLASS — REMOVABLEFILE . . 910UPDATE DEVCLASS — SERVER. . . . . . 912UPDATE DEVCLASS — VOLSAFE . . . . . 914Related Commands . . . . . . . . . . 917

UPDATE DOMAIN (Update a Policy Domain) . . 918UPDATE DRIVE (Update a Drive) . . . . . . 920UPDATE LIBRARY (Update a Library) . . . . . 924UPDATE LIBVOLUME (Change the Status of aStorage Volume) . . . . . . . . . . . . 928UPDATE MACHINE (Update MachineInformation). . . . . . . . . . . . . . 930UPDATE MGMTCLASS (Update a ManagementClass) . . . . . . . . . . . . . . . . 932UPDATE NODE (Update Node Attributes) . . . 935UPDATE PATH (Change a Path) . . . . . . . 943UPDATE POLICYSET (Update a Policy SetDescription) . . . . . . . . . . . . . . 948UPDATE PROFILE (Update a Profile Description) 950UPDATE RECOVERYMEDIA (Update RecoveryMedia) . . . . . . . . . . . . . . . 951UPDATE SCHEDULE (Update a Schedule) . . . 953

UPDATE SCHEDULE — Client . . . . . . 954UPDATE SCHEDULE — Administrative . . . 962Related Commands . . . . . . . . . . 968

UPDATE SCRIPT (Update a Tivoli StorageManager Script) . . . . . . . . . . . . 969UPDATE SERVER (Update a Server Defined forServer-to-Server Communications) . . . . . . 971UPDATE SERVERGROUP (Update a Server GroupDescription) . . . . . . . . . . . . . . 975UPDATE SPACETRIGGER (Update the Database orRecovery Log Space Triggers) . . . . . . . . 976UPDATE STGPOOL (Update a Storage Pool) . . . 978

UPDATE STGPOOL — Primary Random Access 979UPDATE STGPOOL — Primary SequentialAccess. . . . . . . . . . . . . . . 984UPDATE STGPOOL — Copy Sequential Access 991Related Commands . . . . . . . . . . 994

UPDATE VOLHISTORY (Update SequentialVolume History Information) . . . . . . . . 995UPDATE VOLUME (Change a Storage PoolVolume) . . . . . . . . . . . . . . . 997VALIDATE POLICYSET (Verify a Policy Set) . . 1002

VARY (Bring a Random Access Volume Online orOffline) . . . . . . . . . . . . . . . 1004

Chapter 6. Server Options Reference 1007Modifying the Server Options File . . . . . . 1007Communication Options . . . . . . . . . 1007Server Storage Options . . . . . . . . . . 1008Client-Server Options . . . . . . . . . . 1008Date, Number, Time, and Language Options . . 1009Database and Recovery Log Options . . . . . 1009Data Transfer Options . . . . . . . . . . 1009Message Options . . . . . . . . . . . . 1010Event Logging Options. . . . . . . . . . 1010Security Options and Licensing Options . . . . 1010Miscellaneous Options . . . . . . . . . . 10113494SHARED . . . . . . . . . . . . . 1012ACSACCESSID . . . . . . . . . . . . 1013ACSLOCKDRIVE . . . . . . . . . . . 1014ACSQUICKINIT . . . . . . . . . . . . 1015ACSTIMEOUTX . . . . . . . . . . . . 1016ASSISTVCRRECOVERY . . . . . . . . . 1017AUDITSTORAGE . . . . . . . . . . . 1018BUFPOOLSIZE . . . . . . . . . . . . 1019COMMMETHOD . . . . . . . . . . . 1020COMMTIMEOUT . . . . . . . . . . . 1021DATEFORMAT . . . . . . . . . . . . 1022DBPAGESHADOW . . . . . . . . . . . 1023DBPAGESHADOWFILE . . . . . . . . . 1024DEVCONFIG . . . . . . . . . . . . . 1025DISABLESCHEDS . . . . . . . . . . . 1026DISKMAP . . . . . . . . . . . . . . 1027DRIVEACQUIRERETRY . . . . . . . . . 1028ENABLE3590LIBRARY . . . . . . . . . . 1029EVENTSERVER . . . . . . . . . . . . 1030EXPINTERVAL . . . . . . . . . . . . 1031EXPQUIET . . . . . . . . . . . . . . 1032FILEEXIT . . . . . . . . . . . . . . 1033FILETEXTEXIT . . . . . . . . . . . . 1034HTTPPORT . . . . . . . . . . . . . 1035IDLETIMEOUT . . . . . . . . . . . . 1036LANGUAGE . . . . . . . . . . . . . 1037LOGPOOLSIZE . . . . . . . . . . . . 1038LOGWARNFULLPERCENT . . . . . . . . 1039MAXSESSIONS . . . . . . . . . . . . 1040MESSAGEFORMAT . . . . . . . . . . . 1041MIRRORREAD . . . . . . . . . . . . 1042MIRRORWRITE . . . . . . . . . . . . 1043MOVEBATCHSIZE . . . . . . . . . . . 1044MOVESIZETHRESH . . . . . . . . . . 1045MSGINTERVAL . . . . . . . . . . . . 1046NOPREEMPT . . . . . . . . . . . . . 1047NORETRIEVEDATE. . . . . . . . . . . 1048NUMBERFORMAT . . . . . . . . . . . 1049QUERYAUTH . . . . . . . . . . . . . 1050REQSYSAUTHOUTFILE . . . . . . . . . 1051RESOURCETIMEOUT . . . . . . . . . . 1052RESTOREINTERVAL . . . . . . . . . . 1053SEARCHMPQUEUE. . . . . . . . . . . 1054SELFTUNEBUFPOOLSIZE . . . . . . . . 1055SELFTUNETXNSIZE . . . . . . . . . . 1056SHMPORT . . . . . . . . . . . . . . 1057

viii IBM Tivoli Storage Manager for Sun Solaris: Administrator’s Reference

||

SNMPHEARTBEATINTERVAL . . . . . . . 1058SNMPMESSAGECATEGORY. . . . . . . . 1059SNMPSUBAGENT . . . . . . . . . . . 1060SNMPSUBAGENTHOST . . . . . . . . . 1061SNMPSUBAGENTPORT . . . . . . . . . 1062STATUSMSGCNT . . . . . . . . . . . 1063TCPADMINPORT . . . . . . . . . . . 1064TCPNODELAY . . . . . . . . . . . . 1065TCPPORT . . . . . . . . . . . . . . 1066TCPWINDOWSIZE . . . . . . . . . . . 1067TECBEGINEVENTLOGGING . . . . . . . 1068TECHOST . . . . . . . . . . . . . . 1069TECPORT . . . . . . . . . . . . . . 1070THROUGHPUTDATATHRESHOLD . . . . . 1071THROUGHPUTTIMETHRESHOLD . . . . . 1072TIMEFORMAT . . . . . . . . . . . . 1073TXNGROUPMAX . . . . . . . . . . . 1074USELARGEBUFFERS . . . . . . . . . . 1075USEREXIT . . . . . . . . . . . . . . 1076VOLUMEHISTORY . . . . . . . . . . . 1077

Appendix A. IBM Tivoli StorageManager Utilities . . . . . . . . . 1079Miscellaneous Utilities . . . . . . . . . . 1079Database Recovery Utilities . . . . . . . . 1079Database Salvage Utilities . . . . . . . . . 1080DSMFMT (Formatting Files for the Server) . . . 1081DSMLABEL (Label Volumes) . . . . . . . . 1082DSMSERV (Start the Server) . . . . . . . . 1085DSMSERV AUDITDB (Verify DatabaseInformation) . . . . . . . . . . . . . 1086DSMSERV DISPLAY DBBACKUPVOLUME(Display Database Backup Volume Information) . 1088

DSMSERV DISPLAY DBVOLUMES (DisplayDatabase Volume Information) . . . . . . . 1090DSMSERV DISPLAY LOGVOLUMES (DisplayRecovery Log Volume Information). . . . . . 1092DSMSERV DUMPDB (Dump the Database) . . . 1094DSMSERV EXTEND LOG (Emergency LogExtension) . . . . . . . . . . . . . . 1097DSMSERV FORMAT (Format the Database andLog) . . . . . . . . . . . . . . . . 1098DSMSERV LOADDB (Reload the Database) . . . 1100DSMSERV LOADFORMAT (Format the Databaseand Log For Load) . . . . . . . . . . . 1102DSMSERV RESTORE DB (Restore the Database) 1104

Restoring a Database to Its Most Current State 1105Restoring a Single Database Volume to Its MostCurrent State . . . . . . . . . . . . 1106Restoring a Database to a Point-in-Time —Volume History File Available . . . . . . 1108Restoring a Database to a Point-in-Time —Volume History File Unavailable . . . . . 1110

DSMSERV UNLOADDB (Unload the Database) 1112

Appendix B. Return Code Checkingin IBM Tivoli Storage ManagerScripts . . . . . . . . . . . . . . 1115

Appendix C. Notices . . . . . . . . 1117Trademarks. . . . . . . . . . . . . . 1119

Glossary . . . . . . . . . . . . . 1121

Index . . . . . . . . . . . . . . 1131

Contents ix

||

x IBM Tivoli Storage Manager for Sun Solaris: Administrator’s Reference

Preface

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

Who Should Read This PublicationThis reference is intended for anyone who is registered as an administrator. Asingle administrator can manage Tivoli Storage Manager; however, several peoplecan share administrative responsibilities.

You can invoke all of the administrator commands that you need to operate andmaintain Tivoli Storage Manager from:v A workstation connected to the serverv A workstation with a Web browser that supports Java™ 1.1.6

What You Should Know Before Reading This PublicationYou should be familiar with the operating system on which the server resides andthe communication protocols required for the client/server environment.

You also need to understand the storage management practices of yourorganization, such as how you are currently backing up your workstation files andhow you are using storage devices.

IBM Tivoli Storage Manager Web SiteTechnical support information and publications are available at the followingaddress:

www.ibm.com/software/sysmgmt/products/support/IBMTivoliStorageManager.html

By accessing the Tivoli Storage Manager home page, you can access subjects thatinterest you. You can also keep up-to-date with the newest Tivoli Storage Managerproduct information.

IBM Tivoli Storage Manager PublicationsThe following table lists Tivoli Storage Manager server publications.

Publication Title Order Number

IBM Tivoli Storage Management Products License Information GH09-4572

IBM Tivoli Storage Manager Messages GC32-0767

IBM Tivoli Storage Manager for Sun Solaris Administrator’s Guide GC32-0778

IBM Tivoli Storage Manager for Sun Solaris Administrator’s Reference GC32-0779

IBM Tivoli Storage Manager for Sun Solaris Quick Start GC32-0780

© Copyright IBM Corp. 1993, 2003 xi

http://www.ibm.com/software/tivoli/solutions/storage/http://www.ibm.com/software/tivoli/solutions/storage/

The following table lists Tivoli Storage Manager storage agent publications.


IBM Tivoli Storage Manager for AIX Storage Agent User’s Guide GC32-0771

IBM Tivoli Storage Manager for HP-UX Storage Agent User’s Guide GC32-0727

IBM Tivoli Storage Manager for Linux Storage Agent User’s Guide GC23-4693

IBM Tivoli Storage Manager for Sun Solaris Storage Agent User’s Guide GC32-0781

IBM Tivoli Storage Manager for Windows Storage Agent User’s Guide GC32-0785

The following table lists Tivoli Storage Manager client publications.


IBM Tivoli Storage Manager for Space Management for UNIX: Using theHierarchical Storage Management Clients

GC32-0794

IBM Tivoli Storage Manager for Macintosh: Backup-Archive ClientsInstallation and User’s Guide

GC32-0787

IBM Tivoli Storage Manager for NetWare: Backup-Archive ClientsInstallation and User’s Guide

GC32-0786

IBM Tivoli Storage Manager for UNIX: Backup-Archive ClientsInstallation and User’s Guide

GC32-0789

IBM Tivoli Storage Manager for Windows: Backup-Archive ClientsInstallation and User’s Guide

GC32-0788

IBM Tivoli Storage Manager Using the Application Program Interface GC32-0793

The following table lists publications for application protection products.

Publication TitleOrderNumber

IBM Tivoli Storage Manager for Application Servers: Data Protection forWebSphere Application Server Installation and User’s Guide

SC32-9075

IBM Tivoli Storage Manager for Databases: Data Protection for Microsoft SQLServer Installation and User’s Guide

SC32-9059

IBM Tivoli Storage Manager for Databases: Data Protection for Oracle for UNIXInstallation and User’s Guide

SC32-9064

IBM Tivoli Storage Manager for Databases: Data Protection for Oracle forWindows Installation and User’s Guide

SC32-9065

IBM Tivoli Storage Manager for Databases: Data Protection for InformixInstallation and User’s Guide

SH26-4095

IBM Tivoli Storage Manager for Enterprise Resource Planning: Data Protection forR/3 Installation and User’s Guide for DB2 UDB

SC33-6341

IBM Tivoli Storage Manager for Enterprise Resource Planning: Data Protection forR/3 Installation and User’s Guide for Oracle

SC33-6340

IBM Tivoli Storage Manager for Hardware: Data Protection for EMC Symmetrixfor R/3 Installation and User’s Guide

SC33-6386

IBM Tivoli Storage Manager for Hardware: Data Protection for Enterprise StorageServer Databases (DB2 UDB) Installation and User’s Guide

SC32-9060

IBM Tivoli Storage Manager for Hardware: Data Protection for Enterprise StorageServer Databases (Oracle) Installation and User’s Guide

SC32-9061

xii IBM Tivoli Storage Manager for Sun Solaris: Administrator’s Reference

Publication TitleOrderNumber

IBM Tivoli Storage Manager for Hardware: Data Protection for IBM ESS for R/3Installation and User’s Guide for DB2 UDB

SC33-8204

IBM Tivoli Storage Manager for Hardware: Data Protection for IBM ESS for R/3Installation and User’s Guide for Oracle

SC33-8205

IBM Tivoli Storage Manager for Mail: Data Protection for Lotus Domino forUNIX and OS/400 Installation and User’s Guide

SC32-9056

IBM Tivoli Storage Manager for Mail: Data Protection for Lotus Domino forWindows Installation

SC32-9057

IBM Tivoli Storage Manager for Mail: Data Protection for Lotus Domino, S/390Edition Licensed Program Specifications

GC26-7305

IBM Tivoli Storage Manager for Mail: Data Protection for Microsoft ExchangeServer Installation and User’s Guide

SC32-9058

Related IBM® Hardware Products PublicationsThe following table lists related IBM hardware products publications.

Title Order Number

IBM Magstar MP 3570 Tape Subsystem Operator’s Guide GA32-0345

IBM TotalStorage Tape Device Drivers Installation and User’s Guide GC35-0154

IBM TotalStorage Enterprise Tape System 3590 Operator Guide GA32-0330

IBM International Technical Support Center Publications (Redbooks)The International Technical Support Center (ITSC) publishes Redbooks™, which arebooks on specialized topics such as using Tivoli Storage Manager to back updatabases. You can order publications through your IBM representative or the IBMbranch office serving your locality. You can also search for and order books ofinterest to you at the IBM Redbooks Web site at this address:

www.ibm.com/redbooks/

Contacting Customer SupportFor support for this or any Tivoli® product, you can contact IBM CustomerSupport in one of the following ways:v Visit the Tivoli Storage Manager technical support Web site at

www.ibm.com/software/sysmgmt/products/support/IBMTivoliStorageManager.html.

v Submit a problem management record (PMR) electronically atIBMSERV/IBMLINK. You can access IBMLINK at www.ibm.com/ibmlink/.

v Submit a problem management record (PMR) electronically atwww.ibm.com/software/support/probsub.html.

Customers in the United States can also call 1-800-IBM-SERV (1-800-426-7378).

International customers should consult the Web site for customer supporttelephone numbers.

Preface xiii

||

http://www.ibm.com/redbooks/http://www.ibm.com/software/sysmgmt/products/support/IBMTivoliStorageManager.htmlhttp://www.ibm.com/software/sysmgmt/products/support/IBMTivoliStorageManager.htmlhttp://www.ibm.com/ibmlink/http://www.ibm.com/software/support/probsub.html

Hearing-impaired customers should visit the TDD/TTY Voice Relay Services andAccessiblity Center Web site at www.ibm.com/able/voicerelay.html.

You can also review the IBM Software Support Guide, which is available on our Website at techsupport.services.ibm.com/guides/handbook.html.

When you contact IBM Software Support, be prepared to provide identificationinformation for your company so that support personnel can readily assist you.Company identification information is needed to register for online supportavailable on the Web site.

The support Web site offers extensive information, including a guide to supportservices (IBM Software Support Guide); frequently asked questions (FAQs); anddocumentation for all IBM Software products, including Release Notes, Redbooks,and white papers, defects (APARs), and solutions. The documentation for someproduct releases is available in both PDF and HTML formats. Translateddocuments are also available for some product releases.

All Tivoli publications are available for electronic download or order from the IBMPublications Center:www.ibm.com/shop/publications/order/

We are very interested in hearing about your experience with Tivoli products anddocumentation. We also welcome your suggestions for improvements. If you havecomments or suggestions about our documentation, please complete our customerfeedback survey at www.ibm.com/software/sysmgmt/products/support/IBMTivoliStorageManager.html by selecting the Feedback link in the leftnavigation bar.

Reporting a ProblemPlease have the following information ready when you report a problem:v The Tivoli Storage Manager server version, release, modification, and service

level number. You can get this information by entering the QUERY STATUScommand at the Tivoli Storage Manager command line.

v The Tivoli Storage Manager client version, release, modification, and servicelevel number. You can get this information by entering dsmc at the commandline.

v The communication protocol (for example, TCP/IP), version, and release numberyou are using.

v The activity you were doing when the problem occurred, listing the steps youfollowed before the problem occurred.

v The exact text of any error messages.

TranslationsSelected Tivoli Storage Manager publications are translated into languages otherthan American English. Contact your sales representative for more informationabout the translated publications and their availability.

xiv IBM Tivoli Storage Manager for Sun Solaris: Administrator’s Reference

http://www.ibm.com/able/voicerelay.htmlhttp://techsupport.services.ibm.com/guides/handbook.htmlhttp://www.ibm.com/shop/publications/order/http://www.ibm.com/software/sysmgmt/products/support/IBMTivoliStorageManager.htmlhttp://www.ibm.com/software/sysmgmt/products/support/IBMTivoliStorageManager.html

Changes for IBM Tivoli Storage Manager Version 5

This section summarizes changes that have been made to the IBM Tivoli StorageManager product and this publication.

Technical Changes for Version 5 Release 2—April 2003The following changes have been made to the product for this edition:

Security: Firewall SupportTivoli Storage Manager has enhanced support for environments withfirewalls in which communication originating from outside the firewall isto be restricted. Clients normally contact the server, but with the newfirewall support, you can choose to restrict session initiation to the server.Scheduled, backup-archive client operations can be restricted toserver-initiated sessions.

See Administrator’s Guide and Quick Start for more information.

See the following new server option:TCPADMINPORT

See the following changed server option:TCPPORT

See the following changed commands:QUERY NODEREGISTER NODEUPDATE NODE

NDMP OperationsFile-Level Restore: Tivoli Storage Manager currently can use NetworkData Management Protocol (NDMP) to communicate with and providebackup and recovery services for network-attached storage (NAS) fileservers.

Support for file-level restore includes enhancements to allow tracking ofindividual files within a backed-up file system image. A table of contents(TOC) for an image backup can be generated and stored in server storageduring the backup operation. This enhancement makes it possible todisplay the contents of an image backup, and individual files within thatimage can be selected for restore.

See Administrator’s Guide for more information.

See the following new commands:QUERY NASBACKUPQUERY TOCSET TOCLOADRETENTION

See the following changed commands:ACTIVATE POLICYSETBACKUP NODEDEFINE COPYGROUPQUERY COPYGROUPQUERY STATUSRESTORE NODE

© Copyright IBM Corp. 1993, 2003 xv

|||||||

|

||

||

||||

|||||

||||||

|

||||

|||||||

UPDATE COPYGROUPVALIDATE POLICYSET

3494 Library Support: NDMP support to 349X library types (IBM 3494Tape Library Dataserver) is now provided.


EMC Celerra NAS Device Support: Backup and restore operations forEMC Celerra file servers via NDMP are now supported. This supportincludes all base NDMP functions provided for Network Appliance fileservers as well as the file-level restore function.


Accurate SAN Device MappingDevice IDs within a SAN environment change when a bus reset or otherenvironmental changes occur. With accurate SAN device mapping, TivoliStorage Manager can now detect SAN changes and report that areconfiguration is required.


See the following changed commands:DEFINE DRIVEDEFINE LIBRARYDEFINE PATHUPDATE DRIVEUPDATE LIBRARYUPDATE PATH

Macintosh OS X Unicode Support for Backup-Archive ClientUnicode filespaces are now supported on the Macintosh client. Bysupporting a Unicode-enabled client, the Tivoli Storage Manager server canstore file spaces with Unicode file space names, directory names, and filenames. The client can successfully process a Tivoli Storage Manageroperation even when the file spaces contain directory names or files inmultiple languages, or when the client uses a different code page from theserver.


See the following changed commands:DELETE FILESPACEEXPORT NODEGENERATE BACKUPSETIMPORT NODEQUERY CONTENTQUERY FILESPACEQUERY OCCUPANCYQUERY RESTOREREGISTER NODERENAME FILESPACEUPDATE NODE

TapeAlert Device SupportTapeAlert is part of the SCSI specification for providing the softwareapplication with detailed diagnostic information. It captures the TapeAlert

xvi IBM Tivoli Storage Manager for Sun Solaris: Administrator’s Reference

||

||

|

||||

|

|||||

|

|||||||

||||||||

|

||||||||||||

|||

log page from the drive or library when tapes are dismounted or moved inthe library, allowing you to recognize problems as early as possible.


See the following new commands:SET TAPEALERTMSGQUERY TAPEALERTMSG

Increased Archive Retention LimitsTivoli Storage Manager now supports increased retention times forarchives and backup sets. These new retention values will allow dataarchives to be kept longer.


See the following changed commands:DEFINE BACKUPSETDEFINE COPYGROUPDEFINE DOMAINDELETE BACKUPSETGENERATE BACKUPSETQUERY BACKUPSETUPDATE BACKUPSETUPDATE COPYGROUPUPDATE DOMAIN

StorageTek VolSafe SupportTivoli Storage Manager now supports the WORM tape device typeVOLSAFE.


See the following changed commands:CHECKIN LIBVOLUMEDEFINE DEVCLASSLABEL LIBVOLUMEUPDATE DEVCLASS

Server to Server Export and ImportTivoli Storage Manager server export and import processing has beenenhanced to support the following functions:v Direct server export to server import over the TCP/IP communications

line between two servers of the same or differing platforms, whicheliminates the need for compatible sequential device types betweenservers to perform data movement.

v Merging of imported data into existing client file spaces on the server.v Ability to export client file data based on a date and time specification,

which allows server-to-server export and import opertaions to maintainduplicate copies of client data on two or more servers.


See the following changed commands:EXPORT ADMINEXPORT NODEEXPORT POLICYEXPORT SERVERIMPORT NODEIMPORT SERVER

Changes for IBM Tivoli Storage Manager Version 5 xvii

||

|

|||

||||

|

||||||||||

|||

|

|||||

|||

||||

|

|||

|

|||||||

Server Performance TuningThe maximum value of the server option TXNGROUPMAX has beenincreased. When transferring multiple small files, increasing theTXNGROUPMAX option can improve throughput for operations to tape. Itis now possible to set the TXNGROUPMAX option for individual clients.


See the following changed commands:QUERY NODEREGISTER NODEUPDATE NODE

See the following changed server option:TXNGROUPMAX

Product Packaging and Name ChangesThe following table lists changes to product packaging and names for IBMTivoli Storage Manager. Seewww.ibm.com/software/tivoli/solutions/storage/ for complete details.

Table 1. Product Packaging and Name Changes

Former name Current name or term Notes

Tivoli Disaster RecoveryManager

disaster recovery manager(DRM)

This product is now part ofIBM Tivoli Storage ManagerExtended Edition.

Tivoli Data Protection forNDMP

operations that use NDMP This product is now part ofIBM Tivoli Storage ManagerExtended Edition.

Tivoli Storage ManagerManaged System for SAN

IBM Tivoli Storage Managerfor Storage Area Networks

This product includesLAN-free data movementand library sharing on SANs.

Tivoli SANergy is a separateproduct, licensed to usersthrough this product.

Tivoli Space Manager IBM Tivoli Storage Managerfor Space Management

The client is called spacemanager or HSM client.

Tivoli Data Protectionproducts

One of the following:

IBM Tivoli StorageManager for ApplicationServers

IBM Tivoli StorageManager for Databases

IBM Tivoli StorageManager for EnterpriseResource Planning

IBM Tivoli StorageManager for Hardware

IBM Tivoli StorageManager for Mail

See the Web site for details.

The clients are frequentlycalled application clients in theproduct information.

xviii IBM Tivoli Storage Manager for Sun Solaris: Administrator’s Reference

|||||

|

||||

||

||||

||

|||

|||||||

||||||

|||||||

|||

|||||

|||

|||

||

|||

||

||

|

|||

http://www.ibm.com/software/tivoli/solutions/storage/

Technical Changes for Version 5 Release 1—March 2002The following changes have been made to the product for this edition:

Changes in Defining Drives and Libraries

v Device names are now specified in the DEFINE PATH and UPDATEPATH commands, rather than in the DEFINE DRIVE, UPDATE DRIVE,DEFINE LIBRARY, and UPDATE LIBRARY commands

v Path names for external libraries are now specified in the DEFINE PATHcommand.


See the following new commands:DEFINE PATHDELETE PATHQUERY PATHUPDATE PATH

See the following changed commands:DEFINE DRIVEDEFINE LIBRARYQUERY DRIVEQUERY LIBRARYUPDATE DRIVEUPDATE LIBRARY

Moving Data by NodeYou can use the MOVE NODEDATA command to move data in asequential-access storage pool for one or more nodes, or move data in asingle node with selected file spaces. You can also use MOVE NODEDATAto consolidate data for offsite disaster recovery storage, or move data toanother storage pool.


Support for Simultaneous Writes to Primary and Copy Storage PoolsYou can specify copy storage pools in a primary storage pool definition.When a client backs up, archives, or migrates a file, the file is written tothe primary storage pool and is simultaneously stored into each copystorage pool.


See the following changed commands:DEFINE STGPOOLQUERY SESSIONQUERY STGPOOLREGISTER NODEUPDATE NODEUPDATE STGPOOL

Tivoli Data Protection for New Network Data Management Protocol Support

New Network Data Management Protocol (NDMP) support now extendsto the Sun Solaris (32-bit and 64-bit) IBM Tivoli Storage Manager serverplatform. The new Tivoli Data Protection for NDMP product supportsNDMP backup and restore for network-attached storage (NAS) file serversfrom IBM and Network Appliance. NDMP allows a network

Changes for IBM Tivoli Storage Manager Version 5 xix

storage-management application to control the backup and restore of anNDMP-compliant file server without installing third-party software on thatserver. The NAS file server does not require installation of Tivoli StorageManager software. The Tivoli Storage Manager server uses NDMP toconnect to the NAS file server to initiate, control, and monitor a file systembackup or restore operation. The NDMP support for NAS file serversenables higher performance backup to tape devices without moving thedata over the LAN. TDP for NDMP is a separately priced and licensedproduct.


See the following new commands:BACKUP NODEDEFINE DATAMOVERDEFINE PATHDELETE DATAMOVERDELETE PATHQUERY DATAMOVERQUERY PATHUPDATE DATAMOVERUPDATE PATHRESTORE NODE

Data Validation with Cyclic Redundancy CheckingIBM Tivoli Storage Manager provides the option of specifying whether acyclic redundancy check (CRC) is performed during a client session withthe server, or for storage pools. The server validates the data by using acyclic redundancy check which can help identify data corruption. Datavalidation can be enabled for one or all of the following:v Tivoli Storage Manager client nodes at Version 5.1v Tivoli Storage Manager storage agents at Version 5.1v Storage pools

See Administrator’s Guide and Tivoli Storage Manager Storage Agent User’sGuide for more information.

See the following changed commands:DEFINE SERVERDEFINE STGPOOLQUERY NODEQUERY SERVERQUERY VOLUMEREGISTER NODEUPDATE NODEUPDATE SERVERUPDATE STGPOOL

New Licensing MethodThe new licensing method enables you to register the exact number oflicenses that are required, rather than in increments of 1, 5, 10, and 50.


xx IBM Tivoli Storage Manager for Sun Solaris: Administrator’s Reference

Part 1. Using Commands

© Copyright IBM Corp. 1993, 2003 1

2 IBM Tivoli Storage Manager for Sun Solaris: Administrator’s Reference

Chapter 1. Using Syntax Diagrams

This section describes how to read the syntax diagrams for each administratorcommand contained in this manual.

To read a syntax diagram, follow the path of the line. Read from left to right andfrom 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.

Syntax items (for example, a keyword or variable) may be:v Directly on the line (required)v Above the line (default)v Below the line (optional)

Syntax Diagrams DescriptionsThis section covers syntax diagrams including descriptions and examples:

Abbreviations: Uppercase letters denote the shortest acceptable abbreviation. If anitem appears entirely in uppercase letters, you cannot abbreviate the item.

You can type the item in uppercase letters, lowercase letters, or any combination.In this example, you can enter CMDNA, CMDNAM, or CMDNAME in anycombination of uppercase and lowercase letters.

�� CMDNAme ��

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

Variables: Highlighted lowercase items (like this) denote variables. In this example,var_name represents a variable you must specify when you code the CMDNAMEcommand.

�� CMDNAme var_name ��


Repetition: An arrow returning to the left means that the item can be repeated. Acharacter within the arrow means that you must separate repeated items with thatcharacter.

��

,

repeat ��

A footnote (1) by the arrow refers to a limit that tells how many times the item canbe repeated.

��

,(1)

repeat ��

Notes:

1 Specify repeat up to 5 times.

Required Choices: When two or more items are in a stack and one of them is onthe line, you must specify one item.

In this example, you must choose CMDNAME=A, CMDNAME=B, orCMDNAME=C. Do not include any blanks immediately before or after the equalsign (=).

�� CMDNAme = ABC

��

Optional Choices: When an item is below the line, the item is optional. In thisexample, you can choose CMDNAME=A or nothing at all. Do not include anyblanks immediately before or after the equal sign (=).

��CMDNAme = A

��

When two or more items are in a stack below the line, all of them are optional. Inthis example, you can choose CMDNAME=A, CMDNAME=B, CMDNAME=C, ornothing at all. Do not include any blanks immediately before or after the equalsign (=).

��CMDNAme = A

BC

��

Defaults: Defaults are above the line. The system uses the default unless youoverride it. You can override the default by coding an option from the stack belowthe line.

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


��CMDNAme = A

CMDNAme = ABC

��

Repeatable Choices: A stack of items followed by an arrow returning to the leftmeans that you can select more than one item or, in some cases, repeat a singleitem. In this example, you can choose more than one value, with each namedelimited with a comma. Do not include any blanks before or after the equal sign(=).

��

,

CMDNAme = value1value2value3

��

Syntax Fragments: Some diagrams, because of their length, must fragment thesyntax. The fragment name appears between vertical bars in the diagram.

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

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

�� Fragment ��

Fragment:

A

BC

Chapter 1. Using Syntax Diagrams 5

Chapter 2. Entering Administrative Commands

This chapter contains information about entering and routing administrativecommands. An administrative command includes:

Command name: The command name can consist of a single action word, such asHALT, or it can consist of an action word and an object for the action, such asDEFINE DOMAIN. You can enter the entire command name or the abbreviationthat is specified in the syntax diagram for the command.

Positional parameters: Some commands have required or optional positionalparameters. You must enter positional parameters in the order indicated in thesyntax diagram for a command.

For example, to copy a policy set:1. Enter the name of the policy to which the policy set belongs2. Enter the name of the policy set you want to copy3. Enter the name you want to assign the copycopy policyset domain1 oldset newset

Keyword parameters: Some commands have required or optional keywordparameters. When included in a command, a keyword parameter must follow anypositional parameters in the command. Use the equal sign to distinguish betweenthe keyword and the value. A keyword parameter can provide a description of anobject, identify an object (such as a storage pool or policy domain), or specify asetting for an option. You can enter either the entire keyword or the abbreviationthat is identified in the syntax diagram for the command.

For example, to include a description for a new policy domain, enter:define domain acctg description="accounting"

Command Entry RulesThe following are general rules for entering Tivoli Storage Manager administrativecommands:v Enter a command in any column of the input line.v Unless otherwise noted, you can specify commands in any combination of

uppercase and lowercase characters.v If a parameter allows a list of values, enter the values immediately following the

equal sign and delimit the value with a comma. For example,classes=policy,storage

v When you refer to file space names, specify the file space name by using theexact capitalization that is used by Tivoli Storage Manager. Use the QUERYFILESPACE command to find out the correct capitalization.

v If a description (a string of text) for a parameter begins with a single or doublequote or contains any embedded blanks or equal signs, you must surround thevalue in either single (') or double (") quotation marks. The opening and closingquotation marks must be the same type of quotation marks. For example, if theopening quotation is a single quotation mark, the closing quotation mark mustalso be a single quotation mark.


For example, to register a new client node named Louie, with a password ofsecret, 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 CONTACTparameter. The value can contain quotation marks, embedded blanks, or equalsigns.

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

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' orcontact="manager reports to dept. 61f"

Processing Administrative CommandsTivoli Storage Manager processes administrator commands in the foreground or inthe background. When administrative commands process, you receive a messageindicating:v Whether the command completed successfully (in the case of a foreground

process)v Whether the command was sent to the server for processing (in the case of a

background process)

Tivoli Storage Manager sends a confirmation message when commands are issuedthat affect the availability of the server or data managed by the server. TivoliStorage Manager does not send a confirmation message if the command is issuedfrom the server console or from an administrative client with the NOCONFIRMoption specified.

Tivoli Storage Manager formats the output processed from commands according toyour screen or window width. If the width of your screen or window is not wideenough to display the output horizontally, Tivoli Storage Manager arranges anddisplays the information vertically.

Commands Processed in the ForegroundForeground processing specifies that each command issued must complete beforeanother command is issued. You can cancel commands that are processed in theforeground from the server console or another administrative client session.

When you issue a QUERY command from the administrative client, multiplescreens of output may be generated. If this occurs and additional output is notneeded, you can cancel the display of output to the client workstation. Whilecanceling does not end the processing of the command, it ends any further displayof command output.


For some commands, you can specify whether to wait for Tivoli Storage Managerto complete processing the command in the foreground before you issue othercommands. By including the WAIT parameter, you can specify whether TivoliStorage Manager processes the following commands in the foreground:

BACKUP DB

BACKUP STGPOOL

DEFINE DBVOLUME

DEFINE LOGVOLUME

DEFINE VOLUME

DELETE FILESPACE

DELETE VOLUME

EXPIRE INVENTORY

EXTEND DB

EXTEND LOG

MOVE DATA

MOVE DRMEDIA

PREPARE

REDUCE DB

REDUCE LOG

RESTORE STGPOOL

RESTORE VOLUME

VARY

Commands Processed in the BackgroundBackground processing specifies that you can enter commands while the server isprocessing a previously issued command. When you enter a command that createsa background process, Tivoli Storage Manager submits a request to the server toperform the task identified in the command. Each background process is assigneda process number. Use the CANCEL PROCESS command to cancel commands thatgenerate background processes.

Use the QUERY PROCESS command to obtain the status and process number of abackground process. If a background process is active when you cancel it, theserver stops the process. Any changes that are uncommitted are rolled back.However, changes that are committed are not rolled back.

The following is a list of commands that can generate background processes:

AUDIT LIBRARY

AUDIT LICENSES

AUDIT VOLUME

BACKUP DB

BACKUP NODE

BACKUP STGPOOL

CHECKIN LIBVOLUME

CHECKOUT LIBVOLUME

DEFINE DBCOPY

DEFINE LOGCOPY

DELETE DBVOLUME

DELETE FILESPACE

DELETE LOGVOLUME

DELETE VOLUME

EXPIRE INVENTORY

EXPORT ADMIN

EXPORT NODE

EXPORT POLICY

EXPORT SERVER

EXTEND LOG

GENERATE BACKUPSET

IMPORT ADMIN

IMPORT NODE

IMPORT POLICY

IMPORT SERVER

MOVE DATA

MOVE DRMEDIA

MOVE MEDIA

PREPARE

REDUCE DB

REDUCE LOG

RESTORE NODE

RESTORE STGPOOL

RESTORE VOLUME

VARY

Chapter 2. Entering Administrative Commands 9

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

The wildcard characters you use depend on the operating system from which youissue 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 apercent sign (%) to match exactly one character.

Table 2 provides references to wildcard characters for some operating systems. Usewildcard characters appropriate for your system.

Table 2. Wildcard Characters by Environment

Environment Match-Any Match-Exactly-One

AIX®, UNIX®, HP-UX, DOS, Linux,OS/2®, OS/400® for PASE, SunOS,Windows®

* ?

CMS, TSO * %

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

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

Tivoli Storage Manager displays information about management classes withnames MC.

Examples for Match-Any CharactersTable 3 shows additional examples by using wildcard characters to match anycharacters.

Table 3. Match-Any Character

Pattern Matches Does Not Match

ab* ab, abb, abxxx a, b, aa, bb

ab*rs abrs, abtrs, abrsrs ars, aabrs, abrss

ab*ef*rs abefrs, abefghrs abefr, abers

Examples for Match-Exactly-One CharacterTable 4 on page 11 shows additional examples by using wildcard characters tomatch exactly one character. The question mark (?) can be replaced by a percentsign (%) if your platform uses that character instead of (?).


|||

Table 4. Match-Exactly-One Character

Pattern Matches Does Not Match

ab? abc ab, abab, abzzzz

ab?rs abfrs abrs, abllrs

ab?ef?rs abdefjrs abefrs, abdefrs, abefjrs

ab??rs abcdrs, abzzrs abrs, abjrs, abkkkrs

Naming Conventions in Tivoli Storage ManagerWhen you use DEFINE commands to define database, recovery log, and storagepool volumes, the naming convention for the volume name is dependent on thetype of sequential access media or random access media you are using. Thispublication provides the command syntax and rules to follow when naming thesevolumes.

Naming Objects in Tivoli Storage ManagerTivoli Storage Manager restricts the number and type of characters that you canuse to name objects.

The following characters are available for defining object names.

A–Z Any letter, A through Z

0–9 Any number, 0 through 9

_ Underscore

. Period

- Hyphen

+ Plus

& Ampersand

Note: A password is not case-sensitive.

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

Type of Name Maximum Length

Administrators, client option sets, client nodes,passwords, server groups, server names

64

Device classes, drives, libraries, management classes,policy domains, profiles, schedules, scripts, backupsets, storage pools

30

Routing CommandsCommand routing allows you to route commands to one or more servers forprocessing. Command routing allows the server that originated the command toroute the command to multiple servers and then to collect the output from theseservers. For information about how to set up and manage multiple servers forcommand routing, see the Administrator’s Guide.


Routing commands to other servers requires that administrators have the sameadministrator ID and password as well as the administrative authority required oneach server to which the command is being routed. Administrators cannot routecommands to other servers from the server console.

Each server that is identified as the target of a routed command must first bedefined using the DEFINE SERVER command. The command is automaticallyrouted to all servers specified as members of a server group or to individualservers specified with the command.

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 inits entirety, followed by the output from SERVER_B. The output includes summarymessages for each individual server and identifies which server processed theoutput. Return codes indicate whether or not commands processed on the serverssuccessfully. These return codes will include one of three severities: 0, ERROR, orWARNING.

Examples of Routing CommandsThe following examples describe how to route the QUERY STGPOOL command toone server, multiple servers, a server group, multiple server groups, or acombination of servers and server groups. Each server or server group in a listmust be separated with a comma, without spaces. When routing commands insidescripts, you must enclose the server or server group in parentheses and omit thecolon.

Routing Commands to a Single Server: To route the QUERY STGPOOL commandto a server named ASTRO, enter:astro: query stgpool

The colon after the server name indicates the end of the routing information. Thisis also called the server prefix. Another way to indicate the end of routinginformation is to use parentheses around the server name, for example:(astro) query stgpool

Routing Commands to Multiple Servers: To route the QUERY STGPOOL commandto multiple servers named HD_QTR, MIDAS, SATURN, enter:hd_qtr,midas,saturn: query stgpool

or(hd_qtr,midas,saturn) query stgpool

If the first server has not been defined to Tivoli Storage Manager, the command isrouted to the next defined server in the list of servers.

Routing Commands to a Server Group: To route the QUERY STGPOOL commandto a server group named ADMIN, enter:admin: query stgpool

or(admin) query stgpool


In this example, the server group ADMIN has servers named SECURITY,PAYROLL, PERSONNEL defined as group members. The command is routed toeach of these servers.

Routing Commands to Server Groups: To route the QUERY STGPOOL command totwo server groups that are named ADMIN2 and ADMIN3, enter:admin2,admin3: query stgpool

or(admin2,admin3) query stgpool

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 serversASTRO, GUMBY, and CRUSTY defined as group members. The command isrouted to servers SERVER_A, SERVER_B, SERVER_C, ASTRO, GUMBY, andCRUSTY.

Routing Commands to Two Servers and a Server Group: To route the QUERYSTGPOOL command to a server group named DEV_GROUP and to the serversnamed MERCURY and JUPITER, enter:dev_group,mercury,jupiter: query stgpool

or(dev_group,mercury,jupiter) query stgpool

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.

Routing Commands Inside Scripts: When routing commands inside scripts, youmust 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 STGPOOLcommand is routed to these servers.


Chapter 3. Using the Command-Line Interface

This section provides information about how to start and end an administrativesession with Tivoli Storage Manager. You can start an administrative command-linesession from the server console or from an administrative client.

Using the Server ConsoleTivoli Storage Manager provides a user ID named SERVER_CONSOLE that allowsyou to administer the server from the server console after Tivoli Storage Manageris installed. At installation, SERVER_CONSOLE is automatically registered as anadministrator and is given system authority. You can use the SERVER_CONSOLEuser ID to issue administrative commands.

An administrator with system privilege can revoke or grant new privileges to theSERVER_CONSOLE user ID. However, you cannot:v Register or update the SERVER_CONSOLE user IDv Lock or unlock the SERVER_CONSOLE user IDv Rename the SERVER_CONSOLE user IDv Remove SERVER_CONSOLE user IDv Route commands from the SERVER_CONSOLE user ID

Using the Administrative Command Line ClientThe administrative command-line client is a program that runs on a file server,workstation, or mainframe that allows administrators to control and monitor theserver through administrative commands.

Ensure that your administrative client and your server are running in compatiblelanguages. See “LANGUAGE” on page 1037 for language and locale options. Ifyour client and server are using different languages, the messages that TivoliStorage Manager generates may not be understandable.

You can start an administrative client session in console, mount, batch, orinteractive mode by using the DSMADMC command. In each of these modes, youcan specify certain options with commands. For details, see “Using AdministrativeClient Options” on page 18. You can redirect output to a file using redirectioncharacters. For details, see “Redirecting Command Output” on page 20.

Starting the Administrative Command Line ClientThe Tivoli Storage Manager server must be running before any client can connect.See Quick Start for specific instructions.

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

Note: Enter the DSMADMC command with your user ID and password by usingthe -ID and -PASSWORD options as shown if you do not want to beprompted for that information.


||||

|

||

||

|

|||

Stopping the Administrative Command Line ClientEnd an administrative command line client session by entering this command onyour workstation:quit

Console ModeUse console mode to monitor Tivoli Storage Manager activities as they occur or tocapture processing messages to an output file. For example, you can monitormigration processes and clients logging on to Tivoli Storage Manager. You cannotenter 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. Ifyou do not want to be prompted for your user ID and password, enter theDSMADMC command with the -ID and -PASSWORD options.

To have Tivoli Storage Manager redirect all output to a file, specify the -OUTFILEoption with a destination file name. For example, enter:dsmadmc -id=sullivan -password=secret -consolemode -outfile=save.out

To end an administrative client session in console mode, see Table 5.

Table 5. Keyboard Break SequencesEnvironment Break SequenceUNIX-based clients Ctrl+CCMS HXDOS and OS/2, Windows and Windows NT® Ctrl+C, Ctrl+BreakTSO ATTN

Mount ModeUse mount mode to monitor removable media mount activities. While the sessionis 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. Ifyou do not want to be prompted for your user ID and password, enter theDSMADMC command with the -ID and -PASSWORD options.

To have Tivoli Storage Manager redirect all output to a file, specify the -OUTFILEoption with a destination file name. For example, enter:dsmadmc -id=sullivan -password=secret -mountmode -outfile=save.out

To end an administrative client session in mount mode, see Table 5.

Batch ModeUse batch mode to enter a single administrative command. Your administrativeclient session automatically ends when the command has processed.

To start an administrative client session in batch mode, enter:


|

||

|

|

dsmadmc

You can enter the DSMADMC command with your user ID and password byusing the -ID and -PASSWORD options, respectively if you do not want to beprompted for that information.

To have Tivoli Storage Manager redirect all output to a file, specify the -OUTFILEoption with a destination file name. For example, to issue the QUERY NODEcommand in batch mode with the output redirected to the SAVE.OUT file, enter:dsmadmc -id=sullivan -password=secret -outfile=save.out query node

In batch mode, you must enter the complete command on one line. If a commanddoes not fit on one line, enter the command by using a macro or a script. If youspecify a parameter with a string of text using batch mode, enclose the text insingle quotation marks (' ') in the macro. Do not use double quotes for commandsin batch mode, because your operating system may not parse the quotes correctly.

Interactive ModeUse the interactive mode to enter a series of administrative commands. You canautomatically restart your administrative client session by entering anothercommand each time the tsm: servername > prompt appears.

To start an administrative client session in interactive mode, a server session mustbe available. To ensure the availability of server sessions for both administrativeand client node sessions, the interactive mode of the administrative client isdisconnected 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 moreinformation, see “Using Continuation Characters” on page 19.

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

Using the Administrative Web InterfaceThe Tivoli Storage Manager server must be running. See Quick Start for specificinstructions.

Note: To use the administrative Web interface, your browser must have Java 1.1.6support.

Starting the Administrative Web InterfaceTo start the administrative Web interface, enter the URL on a Web browser on yourworkstation:http://server_name:1580

where:

Chapter 3. Using the Command-Line Interface 17

||

|

||

||

|

||

|

|

server_nameThe IP address (host name or number) of the Tivoli Storage Managerserver that you want to contact. For example, the name can be server1, or9.115.2.15.

1580 The TCP/IP port number specified in the server option HTTPPort. Thedefault is 1580.

Stopping the Administrative Web InterfaceTo end the administrative Web interface session, do one of the following:v Select and click Log Off from Options.v Enter this command at the command line on the administrative Web interface:

quit

Using Administrative Client OptionsIn all administrative client modes, the administrative client options modify youradministrative client session responses.

The following administrative client options can be specified with the DSMADMCcommand and are valid from an administrative client session only:

-DISPLaymode=LISt or TABleAllows you to force the QUERY output to tabular or list format regardless ofthe command line window column width.

If you want the output to go to a file and you are using the -DISPLaymodeoption, use redirection to write to the file. Do not use the -OUTfile option.

-ID=useridSpecifies the administrator’s user ID.

-PAssword=passwordSpecifies the administrator’s password.

-NOConfirmSpecifies that you do not want Tivoli Storage Manager to request confirmationbefore processing commands that affect the availability of the server or datamanaged by the server.

-QuietSpecifies that Tivoli Storage Manager does not display standard outputmessages to your screen. However, when you use this option, certain errormessages still appear.

-CONsolemodeSpecifies that Tivoli Storage Manager runs in console mode. All unsolicitedserver console output is echoed to your screen.

-MOUNTmodeSpecifies that Tivoli Storage Manager runs in mount mode. All serverremovable-media mount messages are echoed to your screen.

-ItemcommitSpecifies that Tivoli Storage Manager commits commands inside a script or amacro as each command is processed.

-OUTfile=filenameSpecifies 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 theoutput matches the format of the output on your screen.

In interactive, console, or mount mode sessions, output displays on yourscreen.

-OUTfileSpecifies that output from a server query is formatted one line per query. Thisoption is available in batch mode only.

-COMMAdelimitedSpecifies that any tabular output from a server query is to be formatted ascomma-separated strings rather than in readable format. This option isintended to be used primarily when redirecting the output of an SQL query(SELECT command). The comma-separated value format is a standard dataformat which can be processed by many common programs, includingspreadsheets, data bases, and report generators.

-TABdelimitedSpecifies that any tabular output from a server query is to be formatted astab-separated strings rather than in readable format. This option is intended tobe used primarily when redirecting the output of an SQL query (SELECTcommand). The tab-separated value format is a standard data format whichcan be processed

IBMpublib.boulder.ibm.com/tividd/td/SMSUNN/GC32-0779-01/en...COPY CLOPTSET (Copy a Client Option...

Documents

Transcript of IBMpublib.boulder.ibm.com/tividd/td/SMSUNN/GC32-0779-01/en...COPY CLOPTSET (Copy a Client Option...