tivoli storage manager for aix - ibm...

Tivoli Storage Managerfor AIX

Administrators ReferenceVersion 5 Release 1

GC32-0769-00

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

First Edition (March 2002)

This edition applies to Version 5 Release 1 of the Tivoli Storage Manager for AIX (product numbers 5698-ISM and5698-ISE) and to any subsequent releases until otherwise indicated in new editions or technical newsletters.

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 high-quality information. If you have anycomments about this book or any other Tivoli Storage Manager documentation, please see Contacting CustomerSupport on page xiii.

Copyright International Business Machines Corporation 1993, 2002. 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. . . . . . . . . . . . . . . xiTivoli Storage Manager Web Site . . . . . . . xiTivoli Storage Manager Publications . . . . . . xiRelated IBM Hardware Products Publications . . xiiiIBM International Technical Support CenterPublications (Redbooks) . . . . . . . . . . xiiiContacting Customer Support . . . . . . . . xiii

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

Summary of Changes for Tivoli StorageManager Version 5. . . . . . . . . . xvTechnical Changes for Version 5 Release 1March2002 . . . . . . . . . . . . . . . . . xv

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

Chapter 2. Entering AdministrativeCommands . . . . . . . . . . . . . 5Command Entry Rules . . . . . . . . . . . 5Processing Administrative Commands . . . . . . 6

Commands Processed in the Foreground . . . . 6Commands Processed in the Background . . . . 7

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

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

Routing Commands . . . . . . . . . . . . 9Examples of Routing Commands . . . . . . 10

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

Starting the Administrative Command LineClient . . . . . . . . . . . . . . . 13Stopping the Administrative Command LineClient . . . . . . . . . . . . . . . 13Console Mode . . . . . . . . . . . . 14Mount Mode . . . . . . . . . . . . . 14Batch Mode . . . . . . . . . . . . . 14Interactive Mode . . . . . . . . . . . 15

Using the Administrative Web Interface . . . . . 15Starting the Web Administrative Client . . . . 15Stopping the Web Administrative Client . . . . 15

Using Administrative Client Options . . . . . . 16Using Continuation Characters . . . . . . . . 17Redirecting Command Output . . . . . . . . 17

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

Chapter 5. Command Reference . . . . 27ACCEPT DATE (Accepts the Current System Date) 28ACTIVATE POLICYSET (Activate a New Policy Set) 29ASSIGN DEFMGMTCLASS (Assign a DefaultManagement Class). . . . . . . . . . . . 31AUDIT LIBRARY (Verify an Automated LibrarysInventory) . . . . . . . . . . . . . . . 33AUDIT LICENSES (Audit Server Storage Usage) . . 35AUDIT VOLUME (Verify Database Information fora Storage Pool Volume) . . . . . . . . . . 36BACKUP DB (Back Up the Database). . . . . . 41BACKUP DEVCONFIG (Create Backup Copies ofDevice Configuration Information) . . . . . . 44BACKUP NODE (Back Up a NAS Node) . . . . 46BACKUP STGPOOL (Back Up Primary Storage Poolto Copy Storage Pool) . . . . . . . . . . . 48BACKUP VOLHISTORY (Save Sequential VolumeHistory Information) . . . . . . . . . . . 51BEGIN EVENTLOGGING (Begin Logging Events) 53CANCEL EXPIRATION (Cancel an ExpirationProcess) . . . . . . . . . . . . . . . 55CANCEL PROCESS (Cancel an AdministrativeProcess) . . . . . . . . . . . . . . . 56CANCEL REQUEST (Cancel One or More MountRequests) . . . . . . . . . . . . . . . 58CANCEL RESTORE (Cancel a Restartable RestoreSession) . . . . . . . . . . . . . . . 59CANCEL SESSION (Cancel One or More ClientSessions) . . . . . . . . . . . . . . . 60CHECKIN LIBVOLUME (Check a Storage Volumeinto a Library) . . . . . . . . . . . . . 62CHECKOUT LIBVOLUME (Check a Storage Volumeout of a Library) . . . . . . . . . . . . . 71CLEAN DRIVE (Clean a Drive). . . . . . . . 77COMMIT (Control Committing of Commands in aMacro) . . . . . . . . . . . . . . . . 78CONVERT ARCHIVE (Allow Clients to QueryArchive Files by Description ) . . . . . . . . 79COPY CLOPTSET (Copy a Client Option Set) . . . 80COPY DOMAIN (Copy a Policy Domain) . . . . 81COPY MGMTCLASS (Copy a Management Class) 83COPY POLICYSET (Copy a Policy Set) . . . . . 85COPY PROFILE (Copy a Profile) . . . . . . . 87COPY SCHEDULE (Copy a Client or anAdministrative Command Schedule) . . . . . . 89

COPY SCHEDULE Client. . . . . . . . 90

Copyright IBM Corp. 1993, 2002 iii

COPY SCHEDULE Administrative Command 92Related Commands. . . . . . . . . . . 93

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

DEFINE COPYGROUP Backup . . . . . 109DEFINE COPYGROUP Archive . . . . . 113Related Commands . . . . . . . . . . 115

DEFINE DATAMOVER (Define a Data Mover) . . 116DEFINE DBBACKUPTRIGGER (Define theDatabase Backup Trigger) . . . . . . . . . 119DEFINE DBCOPY (Define a Volume Copy of aDatabase Volume) . . . . . . . . . . . . 121DEFINE DBVOLUME (Define a Database Volume) 123DEFINE DEVCLASS (Define a Device Class) . . . 125

DEFINE DEVCLASS 3570 . . . . . . . 126DEFINE DEVCLASS 3590 . . . . . . . 129DEFINE DEVCLASS 4MM . . . . . . . 132DEFINE DEVCLASS 8MM . . . . . . . 136DEFINE DEVCLASS CARTRIDGE . . . . 141DEFINE DEVCLASS DLT . . . . . . . 144DEFINE DEVCLASS DTF . . . . . . . 148DEFINE DEVCLASS ECARTRIDGE . . . . 151DEFINE DEVCLASS FILE . . . . . . . 155DEFINE DEVCLASS GENERICTAPE . . . 157DEFINE DEVCLASS LTO . . . . . . . 159DEFINE DEVCLASS NAS . . . . . . . 162DEFINE DEVCLASS OPTICAL and WORMTYPES. . . . . . . . . . . . . . . 165DEFINE DEVCLASS QIC . . . . . . . 169DEFINE DEVCLASS REMOVABLEFILE . . 174DEFINE DEVCLASS SERVER . . . . . . 176Related Commands . . . . . . . . . . 177

DEFINE DOMAIN (Define a New Policy Domain) 178DEFINE DRIVE (Define a Drive to a Library) . . 180DEFINE EVENTSERVER (Define a Server as theEvent Server) . . . . . . . . . . . . . 184DEFINE GRPMEMBER (Add a Server to a ServerGroup) . . . . . . . . . . . . . . . 185DEFINE LIBRARY (Define a Library) . . . . . 187DEFINE LOGCOPY (Define a Volume Copy of aRecovery Log Volume) . . . . . . . . . . 195DEFINE LOGVOLUME (Define a Recovery LogVolume) . . . . . . . . . . . . . . . 197DEFINE MACHINE (Define Machine Information) 199DEFINE MACHNODEASSOCIATION (Associate aNode With a Machine) . . . . . . . . . . 201DEFINE MGMTCLASS (Define a ManagementClass) . . . . . . . . . . . . . . . . 202DEFINE PATH (Define a Path) . . . . . . . 205DEFINE POLICYSET (Define a Policy Set). . . . 209

DEFINE PROFASSOCIATION (Define a ProfileAssociation) . . . . . . . . . . . . . . 211DEFINE PROFILE (Define a Profile) . . . . . . 217DEFINE RECMEDMACHASSOCIATION(Associate Recovery Media with a Machine) . . . 219DEFINE RECOVERYMEDIA (Define RecoveryMedia) . . . . . . . . . . . . . . . 221DEFINE SCHEDULE (Define a Client or anAdministrative Command Schedule) . . . . . 223

DEFINE SCHEDULE Client . . . . . . 224DEFINE SCHEDULE AdministrativeCommand . . . . . . . . . . . . . 232Related Commands . . . . . . . . . . 237

DEFINE SCRIPT (Define a Tivoli Storage ManagerScript) . . . . . . . . . . . . . . . . 238DEFINE SERVER (Define a Server forServer-to-Server Communications) . . . . . . 241DEFINE SERVERGROUP (Define a Server Group) 245DEFINE SPACETRIGGER (Define the Database orRecovery Log Space Trigger) . . . . . . . . 246DEFINE STGPOOL (Define a Storage Pool) . . . 248

DEFINE STGPOOL Primary Random Access 249DEFINE STGPOOL Primary SequentialAccess. . . . . . . . . . . . . . . 255DEFINE STGPOOL Copy Sequential Access 264Related Commands . . . . . . . . . . 267

DEFINE SUBSCRIPTION (Define a ProfileSubscription) . . . . . . . . . . . . . 269DEFINE VOLUME (Define a Volume in a StoragePool) . . . . . . . . . . . . . . . . 271DELETE ASSOCIATION (Delete the NodeAssociation to a Schedule) . . . . . . . . . 275DELETE BACKUPSET (Delete a Backup Set) . . . 277DELETE CLIENTOPT (Delete an Option in anOption Set) . . . . . . . . . . . . . . 281DELETE CLOPTSET (Delete a Client Option Set) 282DELETE COPYGROUP (Delete a Copy Group) . . 283DELETE DATAMOVER (Delete a Data Mover) . . 285DELETE DBBACKUPTRIGGER (Delete theDatabase Backup Trigger) . . . . . . . . . 286DELETE DBVOLUME (Delete a Database Volume) 287DELETE DEVCLASS (Delete a Device Class) . . . 288DELETE DOMAIN (Delete a Policy Domain) . . . 289DELETE DRIVE (Delete a Drive from a Library) 290DELETE EVENT (Delete Event Records) . . . . 291DELETE EVENTSERVER (Deletes the Defintion ofthe Event Server) . . . . . . . . . . . . 293DELETE FILESPACE (Delete Client Node Datafrom the Server) . . . . . . . . . . . . 294DELETE GRPMEMBER (Delete a Server from aServer Group) . . . . . . . . . . . . . 298DELETE LIBRARY (Delete a Library) . . . . . 299DELETE LOGVOLUME (Delete a Recovery LogVolume) . . . . . . . . . . . . . . . 300DELETE MACHINE (Delete Machine Information) 301DELETE MACHNODEASSOCIATION (DeleteAssociation Between a Machine and a Node) . . . 302DELETE MGMTCLASS (Delete a ManagementClass) . . . . . . . . . . . . . . . . 303DELETE PATH (Delete a Path) . . . . . . . 305DELETE POLICYSET (Delete a Policy Set). . . . 307

iv Tivoli Storage Manager for AIX: Administrators Reference

DELETE PROFASSOCIATION (Delete a ProfileAssociation) . . . . . . . . . . . . . . 308DELETE PROFILE (Delete a Profile) . . . . . . 311DELETE RECMEDMACHASSOCIATION (DeleteRecovery Media and Machine Association) . . . 313DELETE RECOVERYMEDIA (Delete RecoveryMedia) . . . . . . . . . . . . . . . 314DELETE SCHEDULE (Delete a Client or anAdministrative Command Schedule) . . . . . 315

DELETE SCHEDULE Client . . . . . . 316DELETE SCHEDULE AdministrativeCommand . . . . . . . . . . . . . 317Related Commands . . . . . . . . . . 317

DELETE SCRIPT (Delete Command Lines from aScript or Delete the Entire Script) . . . . . . . 318DELETE SERVER (Delete a Server Definition) . . 319DELETE SERVERGROUP (Delete a Server Group) 320DELETE SPACETRIGGER (Delete the Database orRecovery Log Space Triggers) . . . . . . . . 321DELETE STGPOOL (Delete a Storage Pool) . . . 322DELETE SUBSCRIBER (Delete Subscriptions froma Configuration Manager Database) . . . . . . 324DELETE SUBSCRIPTION (Delete a ProfileSubscription) . . . . . . . . . . . . . 325DELETE VOLHISTORY (Delete Sequential VolumeHistory Information) . . . . . . . . . . . 326DELETE VOLUME (Delete a Storage Pool Volume) 331DISABLE EVENTS (Disable Events for EventLogging) . . . . . . . . . . . . . . . 334DISABLE SESSIONS (Temporarily Prevent ClientNode Access to the Server) . . . . . . . . . 337DISMOUNT VOLUME (Dismount a Volume byVolume Name) . . . . . . . . . . . . . 338ENABLE EVENTS (Enable Server or Client Eventsfor Logging) . . . . . . . . . . . . . . 339ENABLE SESSIONS (Resume User Activity on theServer) . . . . . . . . . . . . . . . 342END EVENTLOGGING (Stop Logging Events) . . 343EXPIRE INVENTORY (Manually Start InventoryExpiration Processing) . . . . . . . . . . 345EXPORT ADMIN (Copy Administrator Informationto Sequential Media) . . . . . . . . . . . 348EXPORT NODE (Copy Client Node Information toSequential Media) . . . . . . . . . . . . 352EXPORT POLICY (Copy Policy Information toSequential Media) . . . . . . . . . . . . 358EXPORT SERVER (Copy Server Information toSequential Media) . . . . . . . . . . . . 362EXTEND DB (Increase the Assigned Capacity ofthe Database) . . . . . . . . . . . . . 367EXTEND LOG (Increase the Assigned Capacity ofthe Recovery Log) . . . . . . . . . . . . 368GENERATE BACKUPSET (Generate a Backup Setof a Clients Data) . . . . . . . . . . . . 370GRANT AUTHORITY (Add AdministratorAuthority) . . . . . . . . . . . . . . 375HALT (Shut Down the Server). . . . . . . . 379HELP (Get Help on Commands and ErrorMessages) . . . . . . . . . . . . . . 381IMPORT ADMIN (Import AdministratorInformation). . . . . . . . . . . . . . 384

IMPORT NODE (Import Client Node Information) 387IMPORT POLICY (Import Policy Information) . . 393IMPORT SERVER (Import the Server) . . . . . 396INSERT MACHINE (Insert Machine CharacteristicsInformation or Recovery Instructions) . . . . . 400ISSUE MESSAGE (Issue a Message From a ServerScript) . . . . . . . . . . . . . . . . 402LABEL LIBVOLUME (Label a Library Volume) . . 404LOCK ADMIN (Lock Out an Administrator) . . . 411LOCK NODE (Lock Out a Client Node) . . . . 412LOCK PROFILE (Lock a Profile) . . . . . . . 413MACRO (Invoke a Macro) . . . . . . . . . 415MOVE DATA (Move Files on a Storage PoolVolume) . . . . . . . . . . . . . . . 417MOVE DRMEDIA (Move Disaster Recovery MediaOffsite and Back Onsite) . . . . . . . . . . 420MOVE GRPMEMBER (Move a Server GroupMember) . . . . . . . . . . . . . . . 432MOVE MEDIA (Move Sequential Access StoragePool Media) . . . . . . . . . . . . . . 433MOVE NODEDATA (Move Data by Node in aSequential Access Storage Pool) . . . . . . . 440

MOVE NODEDATA All File Spaces for Oneor More Nodes . . . . . . . . . . . . 441MOVE NODEDATA Selected File Spaces forOne Node . . . . . . . . . . . . . 444Related Commands . . . . . . . . . . 447

NOTIFY SUBSCRIBERS (Notify Managed Serversto Update Profiles) . . . . . . . . . . . 448PING SERVER (Test the Connection BetweenServers) . . . . . . . . . . . . . . . 449PREPARE (Create a Recovery Plan File) . . . . 450QUERY ACTLOG (Query the Activity Log) . . . 456QUERY ADMIN (Display AdministratorInformation). . . . . . . . . . . . . . 461QUERY ASSOCIATION (Query Client NodeAssociations with a Schedule) . . . . . . . . 466QUERY AUDITOCCUPANCY (Query Client NodeStorage Utilization) . . . . . . . . . . . 468QUERY BACKUPSET (Query a Backup Set) . . . 471QUERY BACKUPSETCONTENTS (Query Contentsof a Backup Set) . . . . . . . . . . . . 475QUERY CLOPTSET (Query a Client Option Set) 477QUERY CONTENT (Query the Contents of aStorage Pool Volume). . . . . . . . . . . 479QUERY COPYGROUP (Query Copy Groups). . . 486QUERY DATAMOVER (Display Data MoverDefinitions) . . . . . . . . . . . . . . 491QUERY DB (Display Information on the Database) 494QUERY DBBACKUPTRIGGER (Query theDatabase Backup Trigger) . . . . . . . . . 497QUERY DBVOLUME (Display Information on Oneor More Database Volumes) . . . . . . . . 499QUERY DEVCLASS (Display Information on Oneor More Device Classes) . . . . . . . . . . 501QUERY DOMAIN (Query a Policy Domain) . . . 504QUERY DRIVE (Query Information about a Drive) 507QUERY DRMEDIA (Query Disaster RecoveryMedia) . . . . . . . . . . . . . . . 511QUERY DRMSTATUS (Query DRM SystemParameters) . . . . . . . . . . . . . . 519

Contents v

QUERY ENABLED (Query Enabled Events) . . . 522QUERY EVENT (Query Scheduled and CompletedEvents) . . . . . . . . . . . . . . . 524

QUERY EVENT Client Schedules . . . . . 525QUERY EVENT Administrative Schedules 531Related Commands . . . . . . . . . . 534

QUERY EVENTRULES (Query Rules for Server orClient Events) . . . . . . . . . . . . . 535QUERY EVENTSERVER (Query the Event Server) 538QUERY FILESPACE (Query One or More FileSpaces) . . . . . . . . . . . . . . . 539QUERY LIBRARY (Query a Library). . . . . . 543QUERY LIBVOLUME (Query a Library Volume) 546QUERY LICENSE (Display License Information) 548QUERY LOG (Display Information on theRecovery Log) . . . . . . . . . . . . . 549QUERY LOGVOLUME (Display Information onOne or More Log Volumes). . . . . . . . . 552QUERY MACHINE (Query Machine Information) 554QUERY MEDIA (Query Sequential Access StoragePool Media) . . . . . . . . . . . . . . 558QUERY MGMTCLASS (Query a ManagementClass) . . . . . . . . . . . . . . . . 565QUERY MOUNT (Display Information onMounted Sequential Access Volumes) . . . . . 568QUERY NODE (Query Nodes) . . . . . . . 569QUERY OCCUPANCY (Query Client File Spaces inStorage Pools) . . . . . . . . . . . . . 575QUERY OPTION (Query Server Options) . . . . 579QUERY PATH (Display a Path Definition) . . . . 582QUERY POLICYSET (Query a Policy Set) . . . . 586QUERY PROCESS (Query One or More ServerProcesses) . . . . . . . . . . . . . . 589QUERY PROFILE (Query a Profile) . . . . . . 591QUERY RECOVERYMEDIA (Query RecoveryMedia) . . . . . . . . . . . . . . . 595QUERY REQUEST (Query One or More PendingMount Requests) . . . . . . . . . . . . 598QUERY RESTORE (Query Restartable RestoreSessions) . . . . . . . . . . . . . . . 599QUERY RPFCONTENT (Query Recovery Plan FileContents Stored on a Target Server) . . . . . . 602QUERY RPFILE (Query Recovery Plan FileInformation Stored on a Target Server) . . . . . 604QUERY SCHEDULE (Query Schedules) . . . . 607

QUERY SCHEDULE Client . . . . . . . 608QUERY SCHEDULE Administrative . . . . 612Related Commands . . . . . . . . . . 614

QUERY SCRIPT (Query Tivoli Storage ManagerScripts) . . . . . . . . . . . . . . . 615QUERY SERVER (Query a Server) . . . . . . 619QUERY SERVERGROUP (Query a Server Group) 623QUERY SESSION (Query Client Sessions) . . . . 625QUERY SPACETRIGGER (Query the Database orRecovery Log Space Triggers) . . . . . . . . 628QUERY SQLSESSION (Display SQL Session Value) 631QUERY STATUS (Query System Parameters) . . . 633QUERY STGPOOL (Query Storage Pools) . . . . 639QUERY SUBSCRIBER (Display SubscriberInformation). . . . . . . . . . . . . . 645

QUERY SUBSCRIPTION (Display SubscriptionInformation). . . . . . . . . . . . . . 647QUERY SYSTEM (Query the System Configurationand Capacity) . . . . . . . . . . . . . 649QUERY VOLHISTORY (Display Sequential VolumeHistory Information) . . . . . . . . . . . 651QUERY VOLUME (Query Storage Pool Volumes) 658QUIT (End the Interactive Mode of theAdministrative Client) . . . . . . . . . . 663RECONCILE VOLUMES (Reconcile Differences inthe Virtual Volume Definitions) . . . . . . . 664REDUCE DB (Decrease the Assigned Capacity ofthe Database) . . . . . . . . . . . . . 667REDUCE LOG (Decrease the Assigned Capacity ofthe Recovery Log) . . . . . . . . . . . . 669REGISTER ADMIN (Register an Administrator) 671REGISTER LICENSE (Register a New License) . . 673REGISTER NODE (Register a Node). . . . . . 677REMOVE ADMIN (Delete an Administrator) . . . 684REMOVE NODE (Delete a Node or an AssociatedMachine Node) . . . . . . . . . . . . . 685RENAME ADMIN (Rename an Administrator) . . 687RENAME FILESPACE (Rename a Client File Spaceon the Server) . . . . . . . . . . . . . 688RENAME NODE (Rename a Node) . . . . . . 691RENAME SCRIPT (Rename a Tivoli StorageManager Script) . . . . . . . . . . . . 692RENAME SERVERGROUP (Rename a ServerGroup) . . . . . . . . . . . . . . . 693RENAME STGPOOL (Change the Name of aStorage Pool) . . . . . . . . . . . . . 694REPLY (Allow a Request to Continue Processing) 695RESET BUFPOOL (Reset the Database Buffer PoolStatistics) . . . . . . . . . . . . . . . 696RESET DBMAXUTILIZATION (Reset theUtilization Statistic for the Database) . . . . . 697RESET LOGCONSUMPTION (Reset theCumulative Log Consumption Statistic) . . . . 698RESET LOGMAXUTILIZATION (Reset theUtilization Statistic for the Log) . . . . . . . 699RESTORE NODE (Restore a Node) . . . . . . 700RESTORE STGPOOL (Restore Storage Pool Datafrom a Copy Pool). . . . . . . . . . . . 703RESTORE VOLUME (Restore Primary VolumeData from a Copy Pool) . . . . . . . . . . 706REVOKE AUTHORITY (Remove AdministratorAuthority) . . . . . . . . . . . . . . 710ROLLBACK (Rollback Uncommitted Changes in aMacro) . . . . . . . . . . . . . . . 714RUN (Run a Tivoli Storage Manager Script) . . . 715SELECT (Perform an SQL Query of the TivoliStorage Manager Database). . . . . . . . . 718SET ACCOUNTING (Set Accounting Records Onor Off). . . . . . . . . . . . . . . . 726SET ACTLOGRETENTION (Set the RetentionPeriod for the Activity Log) . . . . . . . . 727SET AUTHENTICATION (Set PasswordAuthentication). . . . . . . . . . . . . 728SET CLIENTACTDURATION (Set the DurationPeriod for the Client Action) . . . . . . . . 729

vi Tivoli Storage Manager for AIX: Administrators Reference

SET CONFIGMANAGER (Specify a ConfigurationManager) . . . . . . . . . . . . . . . 730SET CONFIGREFRESH (Set Managed ServerConfiguration Refresh) . . . . . . . . . . 732SET CONTEXTMESSAGING (Set Message ContextReporting On or Off) . . . . . . . . . . . 734SET CROSSDEFINE (Specifies Whether toCross-Define Servers). . . . . . . . . . . 735SET DRMCHECKLABEL (Specify Label Checking) 736SET DRMCMDFILENAME (Specify the Name of aFile to Contain Commands) . . . . . . . . 737SET DRMCOPYSTGPOOL (Specify the CopyStorage Pools to be Managed by DRM). . . . . 738SET DRMCOURIERNAME (Specify the CourierName). . . . . . . . . . . . . . . . 739SET DRMDBBACKUPEXPIREDAYS (Criteria forDB Backup Series Expiration) . . . . . . . . 740SET DRMFILEPROCESS (Specify File Processing) 742SET DRMINSTRPREFIX (Specify the Prefix forRecovery Instructions File Names) . . . . . . 743SET DRMNOTMOUNTABLENAME (Specify theNot Mountable Location Name) . . . . . . . 745SET DRMPLANPREFIX (Specify a Prefix forRecovery Plan File Names) . . . . . . . . . 746SET DRMPLANVPOSTFIX (Specify ReplacementVolume Names) . . . . . . . . . . . . 748SET DRMPRIMSTGPOOL (Specify the PrimaryStorage Pools to be Managed by DRM). . . . . 749SET DRMRPFEXPIREDAYS (Set Criteria forRecovery Plan File Expiration). . . . . . . . 750SET DRMVAULTNAME (Specify the Vault Name) 752SET EVENTRETENTION (Set the Retention Periodfor Event Records). . . . . . . . . . . . 753SET INVALIDPWLIMIT (Set the Number of InvalidLogon Attempts) . . . . . . . . . . . . 754SET LICENSEAUDITPERIOD (Set License AuditPeriod) . . . . . . . . . . . . . . . 755SET LOGMODE (Set Mode for Saving RecoveryLog Records) . . . . . . . . . . . . . 756SET MAXCMDRETRIES (Set the MaximumNumber of Command Retries). . . . . . . . 758SET MAXSCHEDSESSIONS (Set MaximumScheduled Sessions) . . . . . . . . . . . 759SET MINPWLENGTH (Set Minimum PasswordLength) . . . . . . . . . . . . . . . 760SET PASSEXP (Set Password Expiration Date) . . 761SET QUERYSCHEDPERIOD (Set Query Period forPolling Client Nodes). . . . . . . . . . . 763SET RANDOMIZE (Set Randomization ofScheduled Start Times) . . . . . . . . . . 764SET REGISTRATION (Set Open or ClosedRegistration). . . . . . . . . . . . . . 766SET RETRYPERIOD (Set Time between RetryAttempts) . . . . . . . . . . . . . . 768SET SCHEDMODES (Select a Central SchedulingMode) . . . . . . . . . . . . . . . . 770SET SERVERHLADDRESS (Set the High-LevelAddress of a Server) . . . . . . . . . . . 772SET SERVERLLADDRESS (Set the Low-LevelAddress of a Server) . . . . . . . . . . . 773SET SERVERNAME (Specify the Server Name) . . 774

SET SERVERPASSWORD (Set Password for Server) 775SET SERVERURL (Set URL for Server) . . . . . 776SET SQLDATETIMEFORMAT (Set the Format forDate, Time, and Time Stamp for SQL Data) . . . 777SET SQLDISPLAYMODE (Set the Display of SQLData Types) . . . . . . . . . . . . . . 779SET SQLMATHMODE (Set the Mode for SQLArithmetic) . . . . . . . . . . . . . . 780SET SUBFILE (Set Subfile Backup for Client Nodes) 781SET SUMMARYRETENTION (Set Days to KeepData in Activity Summary Table) . . . . . . . 782SET WEBAUTHTIMEOUT (Set the Web Time-outInterval) . . . . . . . . . . . . . . . 784SETOPT (Set a Server Option for Dynamic Update) 785UNLOCK ADMIN (Unlock an Administrator) . . 786UNLOCK NODE (Unlock a Client Node) . . . . 787UNLOCK PROFILE (Unlock a Profile) . . . . . 788UPDATE ADMIN (Update an Administrator). . . 789UPDATE BACKUPSET (Update a Retention ValueAssigned to a Backup Set) . . . . . . . . . 791UPDATE CLIENTOPT (Update a Client OptionSequence Number) . . . . . . . . . . . 795UPDATE CLOPTSET (Update a Client Option SetDescription) . . . . . . . . . . . . . . 796UPDATE COPYGROUP (Update a Copy Group) 797

UPDATE COPYGROUP Backup . . . . . 798UPDATE COPYGROUP Archive . . . . . 802Related Commands . . . . . . . . . . 804

UPDATE DATAMOVER (Update a Data Mover) 805UPDATE DBBACKUPTRIGGER (Update theDatabase Backup Trigger) . . . . . . . . . 807UPDATE DEVCLASS (Update the Attributes of aDevice Class) . . . . . . . . . . . . . 809

UPDATE DEVCLASS 3570 . . . . . . . 810UPDATE DEVCLASS 3590 . . . . . . . 813UPDATE DEVCLASS 4MM. . . . . . . 816UPDATE DEVCLASS 8MM. . . . . . . 819UPDATE DEVCLASS CARTRIDGE . . . . 824UPDATE DEVCLASS DLT . . . . . . . 828UPDATE DEVCLASS DTF . . . . . . . 832UPDATE DEVCLASS ECARTRIDGE . . . 835UPDATE DEVCLASS FILE . . . . . . . 839UPDATE DEVCLASS GENERICTAPE . . . 841UPDATE DEVCLASS LTO . . . . . . . 843UPDATE DEVCLASS NAS . . . . . . . 846UPDATE DEVCLASS OPTICAL and WORMTYPES. . . . . . . . . . . . . . . 848UPDATE DEVCLASS QIC . . . . . . . 851UPDATE DEVCLASS REMOVABLEFILE . . 855UPDATE DEVCLASS SERVER. . . . . . 856Related Commands . . . . . . . . . . 857

UPDATE DOMAIN (Update a Policy Domain) . . 858UPDATE DRIVE (Update a Drive) . . . . . . 860UPDATE LIBRARY (Update a Library) . . . . . 864UPDATE LIBVOLUME (Change the Status of aStorage Volume) . . . . . . . . . . . . 868UPDATE MACHINE (Update MachineInformation). . . . . . . . . . . . . . 870UPDATE MGMTCLASS (Update a ManagementClass) . . . . . . . . . . . . . . . . 872UPDATE NODE (Update Node Attributes) . . . 875

Contents vii

UPDATE PATH (Change a Path) . . . . . . . 880UPDATE POLICYSET (Update a Policy SetDescription) . . . . . . . . . . . . . . 884UPDATE PROFILE (Update a Profile Description) 886UPDATE RECOVERYMEDIA (Update RecoveryMedia) . . . . . . . . . . . . . . . 887UPDATE SCHEDULE (Update a Schedule) . . . 889

UPDATE SCHEDULE Client . . . . . . 890UPDATE SCHEDULE Administrative . . . 897Related Commands . . . . . . . . . . 902

UPDATE SCRIPT (Update a Tivoli StorageManager Script) . . . . . . . . . . . . 903UPDATE SERVER (Update a Server Defined forServer-to-Server Communications) . . . . . . 906UPDATE SERVERGROUP (Update a Server GroupDescription) . . . . . . . . . . . . . . 910UPDATE SPACETRIGGER (Update the Database orRecovery Log Space Triggers) . . . . . . . . 911UPDATE STGPOOL (Update a Storage Pool) . . . 913

UPDATE STGPOOL Primary Random Access 914UPDATE STGPOOL Primary SequentialAccess. . . . . . . . . . . . . . . 919UPDATE STGPOOL Copy Sequential Access 926Related Commands . . . . . . . . . . 929

UPDATE VOLHISTORY (Update SequentialVolume History Information) . . . . . . . . 930UPDATE VOLUME (Change a Storage PoolVolume) . . . . . . . . . . . . . . . 932VALIDATE POLICYSET (Verify a Policy Set) . . . 937VARY (Bring a Random Access Volume Online orOffline) . . . . . . . . . . . . . . . 939

Chapter 6. Server Options Reference 941Modifying the Server Options File . . . . . . 941Communication Options. . . . . . . . . . 941Server Storage Options . . . . . . . . . . 942Client-Server Options. . . . . . . . . . . 942Date, Number, Time, and Language Options . . . 943Database and Recovery Log Options . . . . . 943Data Transfer Options . . . . . . . . . . 943Message Options . . . . . . . . . . . . 944Event Logging Options . . . . . . . . . . 944Security Options and Licensing Options . . . . 944Miscellaneous Options . . . . . . . . . . 9453494SHARED . . . . . . . . . . . . . 946ACSACCESSID. . . . . . . . . . . . . 947ACSLOCKDRIVE . . . . . . . . . . . . 948ACSQUICKINIT . . . . . . . . . . . . 949ACSTIMEOUTX . . . . . . . . . . . . 950AIXASYNCIO . . . . . . . . . . . . . 951AIXDIRECTIO . . . . . . . . . . . . . 952ASSISTVCRRECOVERY . . . . . . . . . . 953AUDITSTORAGE . . . . . . . . . . . . 954BUFPOOLSIZE . . . . . . . . . . . . . 955COMMMETHOD . . . . . . . . . . . . 956COMMTIMEOUT . . . . . . . . . . . . 957DBPAGESHADOW . . . . . . . . . . . 958DBPAGESHADOWFILE . . . . . . . . . . 959DEVCONFIG . . . . . . . . . . . . . 960DISABLESCHEDS . . . . . . . . . . . . 961DRIVEACQUIRERETRY. . . . . . . . . . 962

ENABLE3590LIBRARY . . . . . . . . . . 963EVENTSERVER . . . . . . . . . . . . 964EXPINTERVAL . . . . . . . . . . . . . 965EXPQUIET . . . . . . . . . . . . . . 966FILEEXIT. . . . . . . . . . . . . . . 967FILETEXTEXIT . . . . . . . . . . . . . 968HTTPPORT . . . . . . . . . . . . . . 969IDLETIMEOUT. . . . . . . . . . . . . 970LANGUAGE . . . . . . . . . . . . . 971LOGPOOLSIZE . . . . . . . . . . . . 972LOGWARNFULLPERCENT . . . . . . . . 973MAXSESSIONS. . . . . . . . . . . . . 974MESSAGEFORMAT . . . . . . . . . . . 975MIRRORREAD . . . . . . . . . . . . . 976MIRRORWRITE . . . . . . . . . . . . 977MOVEBATCHSIZE . . . . . . . . . . . 978MOVESIZETHRESH . . . . . . . . . . . 979MSGINTERVAL . . . . . . . . . . . . 980NOPREEMPT . . . . . . . . . . . . . 981NORETRIEVEDATE . . . . . . . . . . . 982QUERYAUTH . . . . . . . . . . . . . 983REQSYSAUTHOUTFILE. . . . . . . . . . 984RESOURCETIMEOUT . . . . . . . . . . 985RESTOREINTERVAL . . . . . . . . . . . 986SEARCHMPQUEUE . . . . . . . . . . . 987SELFTUNEBUFPOOLSIZE . . . . . . . . . 988SELFTUNETXNSIZE . . . . . . . . . . . 989SHMPORT . . . . . . . . . . . . . . 990SNMPHEARTBEATINTERVAL . . . . . . . 991SNMPMESSAGECATEGORY . . . . . . . . 992SNMPSUBAGENT. . . . . . . . . . . . 993SNMPSUBAGENTHOST . . . . . . . . . 994SNMPSUBAGENTPORT. . . . . . . . . . 995STATUSMSGCNT . . . . . . . . . . . . 996TCPBUFSIZE . . . . . . . . . . . . . 997TCPNODELAY . . . . . . . . . . . . . 998TCPPORT . . . . . . . . . . . . . . 999TCPWINDOWSIZE . . . . . . . . . . . 1000TECBEGINEVENTLOGGING . . . . . . . 1001TECHOST . . . . . . . . . . . . . . 1002TECPORT . . . . . . . . . . . . . . 1003THROUGHPUTDATATHRESHOLD . . . . . 1004THROUGHPUTTIMETHRESHOLD . . . . . 1005TXNGROUPMAX . . . . . . . . . . . 1006USELARGEBUFFERS . . . . . . . . . . 1007USEREXIT . . . . . . . . . . . . . . 1008VOLUMEHISTORY . . . . . . . . . . . 1009

Appendix A. Tivoli Storage ManagerUtilities . . . . . . . . . . . . . 1011Recovery Log Extension Utility . . . . . . . 1011Database Recovery Utilities . . . . . . . . 1011Database Salvage Utilities . . . . . . . . . 1011Miscellaneous Server Utilities . . . . . . . 1012DSMSERV EXTEND LOG (Emergency LogExtension) . . . . . . . . . . . . . . 1013DSMSERV DISPLAY DBBACKUPVOLUME(Display Database Backup Volume Information) . 1014DSMSERV DISPLAY DBVOLUMES (DisplayDatabase Volume Information) . . . . . . . 1016

viii Tivoli Storage Manager for AIX: Administrators Reference

DSMSERV DISPLAY LOGVOLUMES (DisplayRecovery Log Volume Information). . . . . . 1018DSMSERV RESTORE DB (Restore the Database) 1020

Restoring a Database to Its Most Current State 1021Restoring a Single Database Volume to Its MostCurrent State . . . . . . . . . . . . 1022Restoring a Database to a Point in Time Volume History File Available . . . . . . 1024Restoring a Database to a Point in Time Volume History File Unavailable . . . . . 1026

DSMSERV UNLOADDB (Unload the Database) 1028DSMSERV AUDITDB (Verify DatabaseInformation) . . . . . . . . . . . . . 1031DSMSERV DUMPDB (Dump the Database) . . . 1033DSMSERV FORMAT (Format the Database andLog) . . . . . . . . . . . . . . . . 1036DSMSERV LOADDB (Reload the Database) . . . 1038DSMFMT (Formatting Files for the Server) . . . 1040

DSMLABEL (Label Volumes) . . . . . . . . 1042DSMSERV (Start the Server) . . . . . . . . 1045DSMSERV LOADFORMAT (Format the Databaseand Log For Load) . . . . . . . . . . . 1046DSMSERV RUNFILE (Run a File) . . . . . . 1048DSMULOG (Capture a Message to a User LogFile) . . . . . . . . . . . . . . . . 1049

Appendix B. Return Code Checkingin Tivoli Storage Manager Scripts . . 1051

Appendix C. Notices . . . . . . . . 1053Trademarks . . . . . . . . . . . . . 1055

Glossary . . . . . . . . . . . . . 1057

Index . . . . . . . . . . . . . . 1067

Contents ix

x Tivoli Storage Manager for AIX: Administrators Reference

Preface

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.

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

http://www.tivoli.com/support/storage_mgr/tivolimain.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.

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

Publication Title Order Number

Tivoli Storage Management Products License Information GH09-4572

Tivoli Storage Manager Messages GC32-0767

Tivoli Storage Manager for AIX Administrators Guide GC32-0768

Tivoli Storage Manager for AIX Administrators Reference GC32-0769

Tivoli Storage Manager for AIX Quick Start GC32-0770

Copyright IBM Corp. 1993, 2002 xi

http://www.tivoli.com/support/storage_mgr/tivolimain.html

The following table lists Tivoli Storage Manager storage agent publications.


Tivoli Storage Manager for AIX Managed System for SAN Storage AgentUsers Guide

GC32-0771

Tivoli Storage Manager for HP-UX Managed System for SAN StorageAgent Users Guide

GC32-0727

Tivoli Storage Manager for Sun Solaris Managed System for SAN StorageAgent Users Guide

GC32-0781

Tivoli Storage Manager for Windows Managed System for SAN StorageAgent Users Guide

GC32-0785

The following table lists the Tivoli Storage Manager client publications.


Tivoli Space Manager for UNIX: Using the Hierarchical StorageManagement Clients

GC32-0794

Tivoli Storage Manager for Macintosh: Backup-Archive Installation andUsers Guide

GC32-0787

Tivoli Storage Manager for NetWare: Backup-Archive Installation andUsers Guide

GC32-0786

Tivoli Storage Manager for UNIX: Backup-Archive Installation and UsersGuide

GC32-0789

Tivoli Storage Manager for Windows: Backup-Archive Installation andUsers Guide

GC32-0788

Tivoli Storage Manager Trace Facility Guide GC32-0792

Tivoli Storage Manager Using the Application Program Interface GC32-0793

The following table lists Tivoli Data Protection publications.

Publication TitleOrderNumber

Tivoli Data Protection for EMC Symmetrix for R/3 Installation and Users Guide SC33-6386

Tivoli Data Protection for IBM ESS for Oracle Databases DB2 UDB Installationand Users Guide

SH26-4125

Tivoli Data Protection for IBM ESS for R/3 Installation and Users Guide SC33-6387

Tivoli Data Protection for Informix Installation and Users Guide SH26-4095

Tivoli Data Protection for Lotus Domino for UNIX Installation and Users Guide SH26-4088

Tivoli Data Protection for Lotus Domino for Windows Installation GC26-7320

Tivoli Data Protection for Lotus Domino, S/390 Edition Licensed ProgramSpecifications

GC26-7305

Tivoli Data Protection for Lotus Notes on AIX Installation and Users Guide SH26-4067

Tivoli Data Protection for Lotus Notes on Windows NT Installation and UsersGuide

SH26-4065

Tivoli Data Protection for Microsoft Exchange Server Installation and Users Guide SH26-4110

Tivoli Data Protection for Microsoft SQL Server Installation and Users Guide SH26-4111

Tivoli Data Protection for Oracle for UNIX Installation and Users Guide SH26-4112

Tivoli Data Protection for Oracle for Windows Installation and Users Guide SH26-4113

xii Tivoli Storage Manager for AIX: Administrators Reference

Publication TitleOrderNumber

Tivoli Data Protection for R/3 Installation and Users Guide for Oracle SC33-6340

Tivoli Data Protection for R/3 Installation and Users Guide for DB2 UDB SC33-6341

Tivoli Data Protection for R/3 Installation and Users Guide SC33-6389

Tivoli Data Protection for WebSphere Application Server Installation and UsersGuide

SC33-6399

Tivoli Data Protection for Workgroups for NetWare Users Guide GC32-0444

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

Title Order Number

IBM Magstar 3494 Tape Library Introduction and Planning Guide GA32-0279

IBM 3490E Model E01 and E11 Users Guide GA32-0298

IBM Magstar MP 3570 Tape Subsystem Operators Guide GA32-0345

IBM SCSI Tape Drive, Medium Changer, and Library Device Drivers:Installation and Users Guide

GC35-0154

IBM TotalStorage Enterprise Tape System 3590 Operator Guide GA32-0330

IBM Magstar 3494 Tape Library Dataserver Operator Guide GA32-0280

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:

http://www.redbooks.ibm.com/redbooks

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

http://www.tivoli.com/support/storage_mgr/tivolimain.html.v Submit a problem management record (PMR) electronically at

IBMSERV/IBMLINK. You can access IBMLINK athttp://www2.ibmlink.ibm.com.

v Submit a problem management record (PMR) electronically athttp://www.tivoli.com/support. See Reporting a Problem on page xiv fordetails.

v Send e-mail to [email protected].

Customers in the United States can also call 1-800-TIVOLI8 (1-800-848-6548). Forproduct numbers 5697-TS9, 5697-DRS or 5697-DPM call 1-800-237-5511.

Preface xiii

http://www.redbooks.ibm.comhttp://www.tivoli.com/support/storage_mgr/tivolimain.htmlhttp://www2.ibmlink.ibm.comhttp://www.tivoli.com/support

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

You can also review the Customer Support Handbook, which is available on our Website at http://www.tivoli.com/support/handbook/.

When you contact Tivoli Customer Support, be prepared to provide identificationinformation for your company so that support personnel can readily assist you.Company identification information may also be needed to access various onlineservices available on the Web site.

The support Web site offers extensive information, including a guide to supportservices (the Customer Support Handbook); frequently asked questions (FAQs);and documentation for all Tivoli products, including Release Notes, Redbooks, andWhitepapers. The documentation for some product releases is available in bothPDF and HTML formats. Translated documents are also available for some productreleases.

You can order documentation by e-mail at [email protected]. Please provide thepublication number, part number, or order number of the desired document.Alternatively, you can provide the document title, version number, and date ofpublication.

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 contact us in one of thefollowing ways:v Send e-mail to [email protected] Complete our customer feedback survey at

http://www.tivoli.com/support/feedback/.

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 TSM 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 Tivoli Storage Manager for AIX: Administrators Reference

http://www.tivoli.com/support/handbook/http://www.tivoli.com/support/feedback/

Summary of Changes for Tivoli Storage Manager Version 5

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

Technical Changes for Version 5 Release 1March 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 Administrators Guide for more information.

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 NODE

Copyright IBM Corp. 1993, 2002 xv

UPDATE STGPOOL

High Availability Cluster MultiprocessingTivoli Storage Manager can now use High Availability ClusterMultiprocessing (HACMP). HACMP provides the leading AIX-basedclustering solution, which allows automatic system recovery during systemfailure detection. By using HACMP together with Tivoli Storage Manger,you can ensure server availability.


Tivoli Data Protection for New Network Data Management Protocol Support

New Network Data Management Protocol (NDMP) support now extendsto the AIX (32-bit and 64-bit) Tivoli Storage Manager server platform. Thenew Tivoli Data Protection for NDMP product supports NDMP backupand restore for network-attached storage (NAS) file servers from IBM andNetwork Appliance. NDMP allows a network storage-managementapplication to control the backup and restore of an NDMP-compliant fileserver without installing third-party software on that server. The NAS fileserver does not require installation of TSM software. The TSM server usesNDMP to connect to the NAS file server to initiate, control, and monitor afile system backup or restore operation. The NDMP support for NAS fileservers enables higher performance backup to tape devices withoutmoving the data over the LAN. TDP for NDMP is a separately priced andlicensed product.


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

Data Validation with Cyclic Redundancy CheckingTivoli Storage Manager provides the option of specifying whether a cyclicredundancy check (CRC) is performed during a client session with theserver, or for storage pools. The server validates the data by using a cyclicredundancy check which can help identify data corruption. Data validationcan 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 Administrators Guide and TSM Managed System for SAN Storage AgentUsers Guide for more information.

See the following changed commands:DEFINE SERVERDEFINE STGPOOLQUERY NODEQUERY SERVER

xvi Tivoli Storage Manager for AIX: Administrators Reference

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


Server Performance EnhancementsThere are two new Tivoli Storage Manager performance enhancements:v AIX Asynchronous I/O Support. This feature is available via a new

option in the server options file.v AIX Direct I/O Support. This feature is available via a new option in the

server options file.


See the following changed commands:QUERY OPTION

See the following new server options:AIXDIRECTIOAIXSYNCIO

Summary of Changes for Tivoli Storage Manager Version 5 xvii

xviii Tivoli Storage Manager for AIX: Administrators 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

Copyright IBM Corp. 1993, 2002 1

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

2 Tivoli Storage Manager for AIX: Administrators Reference

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 3

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 abbreviationspecified 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, for example, provide adescription of an object, identify an object (such as a storage pool or policydomain), or specify a setting for an option. You can enter either the entirekeyword, or the abbreviation 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 using the exactcapitalization 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 to be processed (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 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 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

IMPORT ADMIN

IMPORT NODE

IMPORT POLICY

IMPORT SERVER

MOVE DATA

MOVE DRMEDIA

MOVE MEDIA

PREPARE

REDUCE DB

REDUCE LOG

RESTORE STGPOOL

RESTORE VOLUME

VARY

Chapter 2. Entering Administrative Commands 7

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 1 provides references to wildcard characters for some operating systems. Usewildcard characters appropriate for your system.

Table 1. Wildcard Characters by Environment

Environment Match-Any Match-Exactly-One

AIX, UNIX, HP-UX, DOS, OS/2,SunOS, Windows

* ?

AS/400, 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*

However, 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 youcan enter:query mgmtclass domain1 policyset1 mc?

Tivoli Storage Manager displays information about management classes withnames MC.

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

Table 2. 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 3 shows additional examples using wildcard characters to match exactly onecharacter. The question mark (?) can be replaced by a percent sign (%) if yourplatform uses that character instead of (?).

Table 3. Match-Exactly-One Character


ab? abc ab, abab, abzzzz


Table 3. Match-Exactly-One Character (continued)


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 volumes for the database, recoverylog and storage pools, the naming convention for the volume name is dependenton the type 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.

AZ Any letter, A through Z

09 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, management classes, policy domains,profiles, schedules, scripts, backup sets 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 setup and manage multiple servers forcommand routing, see the Administrators Guide.

Routing commands to other servers requires that administrators have the sameadministrator ID and password as well as the administrative authority required on


each server to which the command is being routed. Administrators cannot routecommands to other servers from the server console.

Each server identified as the target of a routed command must first be definedusing the DEFINE SERVER command. The command is automatically routed to allservers specified as members of a server group or to individual servers specifiedwith 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

If the server group ADMIN has servers named SECURITY, PAYROLL,PERSONNEL defined as group members, the command is routed to each of theseservers.


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

or(admin2,admin3) query stgpool

If the server group ADMIN2 has servers SERVER_A, SERVER_B, and SERVER_Cdefined as group members, and server group ADMIN3 has servers ASTRO,GUMBY, and CRUSTY defined as group members, the command is routed toservers SERVER_A, SERVER_B, SERVER_C, ASTRO, GUMBY, and CRUSTY.

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

If the server group DEV_GROUP has servers SALES, MARKETING, and STAFFdefined 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

If the server group DEV_GROUP has servers SALES, MARKETING, and STAFFdefined as group members, the QUERY STGPOOL command is routed to theseservers.


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.

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 16. You can redirect output to a file using redirectioncharacters. For details, see Redirecting Command Output on page 17.

Starting the Administrative Command Line ClientThe TSM server must be running before any client can connect. See Quick Start forspecific 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 4.

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

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. Double quotes are not allowed in batchmode.

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

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

Using the Administrative Web InterfaceThe TSM server must be running before any client can connect. See Quick Start forspecific instructions.

Starting the Web Administrative ClientTo start the Web interface, enter the URL on a Web browser on your clientworkstation:http://server_name:1580

server_nameIs the IP address (name, dotted name, or dotted number - for example,server1 or 9.115.2.15) of the Tivoli Storage Manager server you want tocontact.

1580 Is the value specified in either the server option HTTPTCPPort orHTTPICSPort. The default is 1580.

Stopping the Web Administrative ClientTo end a Web administrative client session:v Select Log Off from Options.v Enter this command at the command line on the Web administrative interface:

Chapter 3. Using the Command-Line Interface 15

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 administrators user ID.

-PAssword=passwordSpecifies the administrators 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. Inbatch 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 data


format 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 by many common programs, including spreadsheets,databases, and report generators.

Besides the options listed here, you can also specify any option that is in the clientoptions file. Each option must be preceded with a hyphen and delimited with aspace.

Using Continuation CharactersYou can use continuation characters in the interactive mode of the administrativeclient. Continuation characters are useful when you want to process a commandthat is longer than your screen or window width.

Attention: Without continuation characters you can enter up to 256 characters.With continuation characters you can enter up to 1500 characters. In the MACROcommand, these maximums are 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 precedingblank 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 precedingblank spaces. For example:stgpools=stg1,stg2,stg3,-stg4,stg5,stg6

v Continue a string of values enclosed in quotation marks by entering the firstpart of the string enclosed in quotation marks, followed by a dash or a backslash at the end of the line. Then, enter the remainder of the string on the nextline 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 morethan one line.

Redirecting Command OutputYou can redirect output from any command. However, the most common use forredirecting output is to save the output from query commands. The output fromsome query commands can be quite lengthy. It may be easier for you to browse thecontents of a file or, in some cases, print the contents of the file.

Chapter 3. Using the Command-Line Interface 17

Some platforms support redirection of output via special characters like >, >>, and|. You can save the output from a command by entering redirection characters atthe end of the command. Redirection characters direct the output of a command toa file or program you specify instead of to your screen. See the examples below.

Output is not redirected if you do NOT leave a blank after the > symbol. Thefollowing will not redirect the output:SELECT * FROM NODES WHERE CLIENT_VERSION >2

Note: When redirecting output, follow the naming conventions of the operatingsystem running your administrative client.

If you want to: Enter this:

Redirect the output of a QUERY DOMAINcommand to a new file in batch or interactivemode

dsmadmc -id=xxx -pa=xxx query domain acctg > dominfo.acc

A single greater-than sign (>) indicates that Tivoli Storage Managerredirects the output to a new file or writes over an existing file.

Append the output of a QUERY DOMAINcommand to the end of an existing file inbatch or interactive mode

dsmadmc -id=xxx -pa=xxx query domain acctg >> dominfo.acc

Double greater-than signs (>>) indicates that Tivoli Storage Managerappends the output to the end of an existing file.

Redirect all output from an administrativeclient session in console mode to a programcalled filter.exe.

dsmadmc -console -id=admin -password=xxx | filter.exe

The program can be set up to monitor the output for individualmessages as they occur and take appropriate action, such as sendingmail to another user.


Chapter 4. Using Commands Based on Privilege Class

There are five administrator privilege classes in Tivoli Storage Manager:v Systemv Policyv Storagev Operatorv Analyst

The authority granted to an administrator determines the administrativecommands that the administrator can issue. After an administrator has beenregistered via the REGISTER ADMIN command, the administrator can issue alimited set of commands, including all query commands. When you install TivoliStorage Manager, the server console is defined as a system administrator namedSERVER_CONSOLE and is granted system privilege.

The following sections describe each type of administrator privilege and thecommands that can be issued by an administrator who has been granted thecorresponding authority.

Commands Requiring System PrivilegeAn administrator with system privilege has the highest level of authority in TivoliStorage Manager. With system privilege, an administrator can issue anyadministrative command and has authority to manage all policy domains and allstorage pools.

Table 5 on page 20 lists the commands that only administrators with systemprivilege can issue.


Table 5. System Privilege Commands

AUDIT LICENSES

ACCEPT DATE

BEGIN EVENTLOGGING

CANCEL EXPIRATION

CANCEL PROCESS

CANCEL REQUEST

CANCEL RESTORE

COPY CLOPTSET

COPY DOMAIN

COPY PROFILE

COPY SCHEDULE (See note)

COPY SCRIPT

COPY SERVERGROUP

DEFINE BACKUPSET

DEFINE CLIENTACTION

DEFINE CLOPTSET

DEFINE DOMAIN

DEFINE DRIVE

DEFINE EVENTSERVER

DEFINE GRPMEMBER

DEFINE LIBRARY

DEFINE MACHINE

DEFINE MACHNODEASSOCIATION

DEFINE MACHNODEASSOCIATION

DEFINE PROFASSOCIATION

DEFINE PROFILE

DEFINE RECMEDMACHASSOCIATION

DEFINE RECOVERYMEDIA

DEFINE SCHEDULE (See note.)

DEFINE SCRIPT

DEFINE SERVER

DEFINE SERVERGROUP

DEFINE SPACETRIGGER

DEFINE STGPOOL

DEFINE SUBSCRIPTION

DELETE BACKUPSET

DELETE CLIENTOPT

DELETE CLOPTSET

DELETE DOMAIN

DELETE EVENTSERVER

DELETE EXIT

DELETE GRPMEMBER

DELETE MACHINE

DELETE MACHNODEASSOCIATION

DELETE PROFASSOCIATION

DELETE PROFILE

DELETE RECMEDMACHASSOCIATION

DELETE RECOVERYMEDIA

DELETE SCHEDULE (See note)

DELETE SCRIPT

DELETE SERVER

DELETE SERVERGROUP

DELETE SPACETRIGGER

DELETE STGPOOL

DELETE SUBSCRIBER

DELETE SUBSCRIPTION

DISABLE EVENTS

ENABLE EVENTS

END EVENTLOGGING

EXPIRE INVENTORY

EXPORT ADMIN

EXPORT NODE

EXPORT POLICY

EXPORT SERVER

GENERATE BACKUPSET

GRANT AUTHORITY

IMPORT ADMIN

IMPORT NODE

IMPORT POLICY

IMPORT SERVER

INSERT MACHINE

LOCK ADMIN

LOCK PROFILE

MOVE DRMEDIA

MOVE GRPMEMBER

NOTIFY SUBSCRIBERS

PING SERVER

PREPARE

QUERY BACKUPSETCONTENTS

QUERY RPFCONTENT

RECONCILE VOLUMES

REGISTER ADMIN

REGISTER LICENSE

REMOVE ADMIN

RENAME ADMIN

RENAME SCRIPT

RENAME SERVERGROUP

RENAME STGPOOL

REVOKE AUTHORITY

RUN


Table 5. System Privilege Commands (continued)

SET ACCOUNTING

SET ACTLOGRETENTION

SET AUTHENTICATION

SET CLIENTACTDURATION

SET CONFIGMANAGER

SET CONFIGREFRESH

SET CROSSDEFINE

SET CONTEXTMESSAGING

SET DRMCHECKLABEL

SET DRMCOPYSTGPOOL

SET DRMCOURIERNAME

SET DRMDBBACKUPEXPIREDAYS

SET DRMCMDFILENAME

SET DRMFILEPROCESS

SET DRMINSTRPREFIX

SET DRMNOTMOUNTABLENAME

SET DRMPLANPREFIX

SET DRMPLANVPOSTFIX

SET DRMPRIMSTGPOOL

SET DRMRPFEXPIREDAYS

SET DRMVAULTNAME

SET EVENTRETENTION

SET MINPWLENGTH

SET PASSEXP

SET QUERYSCHEDPERIOD

SET RANDOMIZE

SET REGISTRATION

SET RETRYPERIOD

SET SCHEDMODES

SET SERVERHLADDRESS

SET SERVERLLADDRESS

SET SERVERNAME

SET SERVERPASSWORD

SET SERVERURL

SET SUBFILE

SET WEBAUTHTIMEOUT

SETOPT

UNLOCK ADMIN

UNLOCK PROFILE

UPDATE ADMIN

UPDATE BACKUPSET

UPDATE CLIENTOPT

UPDATE CLOPTSET

UPDATE LIBVOLUME

UPDATE MACHINE

UPDATE PROFILE

UPDATE RECOVERYMEDIA

UPDATE SCRIPT

UPDATE SERVER

UPDATE SERVERGROUP

UPDATE SPACETRIGGER

UPDATE VOLHISTORY

Note: Indicates that this command is restricted by the authority granted to an administrator.System privilege is required only for administrative command schedules. System or policyprivilege is required for client operation schedules.

Commands Requiring Policy PrivilegeAn administrator with policy privilege can issue commands that relate to policymanagement objects such as policy domains, policy sets, management classes, copygroups, and schedules. The policy domains that an administrator can managedepend on the authority granted to them by an administrator with systemprivilege.

As an administrator with policy privilege, you can have unrestricted or restrictedpolicy privilege.

Unrestricted policy privilege permits you to issue all of the administratorcommands that require policy privilege. You can issue commands that affect allexisting policy domains as well as any policy domains that are defined in thefuture. An unrestricted policy administrator cannot define, delete, or copy policydomains.

Chapter 4. Using Commands Based on Privilege Class 21

Restricted policy privilege permits you to issue administrator commands that affectone or more policy domains for which you have been explicitly granted authority.For example, the DELETE MGMTCLASS command requires you to have policyprivilege for the policy domain to which the management class belongs.

Table 6 lists the commands that an administrator with policy privilege can issue.

Table 6. Policy Privilege Commands

ACTIVATE POLICYSET

ASSIGN DEFMGMTCLASS

BACKUP NODE

COPY MGMTCLASS

COPY POLICYSET

COPY SCHEDULE (See note 2.)

DEFINE ASSOCIATION

DEFINE BACKUPSET

DEFINE COPYGROUP

DEFINE CLIENTACTION

DEFINE MGMTCLASS

DEFINE POLICYSET

DEFINE SCHEDULE

DELETE ASSOCIATION

DELETE BACKUPSET

DELETE COPYGROUP

DELETE EVENT (See note 1.)

DELETE FILESPACE

DELETE MGMTCLASS

DELETE POLICYSET

DELETE SCHEDULE (See note 2.)

GENERATE BACKUPSET

LOCK NODE

REGISTER NODE

REMOVE NODE

RENAME FILESPACE

RENAME NODE

SET SUMMARYRETENTION

QUERY BACKUPSETCONTENTS

RESTORE NODE

UNLOCK NODE

UPDATE BACKUPSET

UPDATE COPYGROUP

UPDATE DOMAIN

UPDATE MGMTCLASS

UPDATE NODE

UPDATE POLICYSET

UPDATE SCHEDULE (See note 2.)

VALIDATE POLICYSET

Notes:

1. Indicates that this command can be restricted by policy domain. An administrator withunrestricted policy privilege or restricted policy privilege for a specified policy domaincan issue this command.

2. Indicates that this command is restricted by the authority granted to an administrator.System privilege is required only for administrative command schedules. System orpolicy privilege is required for client operation schedules.

Commands Requiring Storage PrivilegeAn administrator with storage privilege can issue commands that allocate andcontrol storage resources for the server. The commands that an administrator canissue depend

tivoli storage manager for aix - ibm...

Documents