Tivoli Storage Manager for AS/400 -...

Tivoli Storage Managerfor AS/400

Administrator’s ReferenceVersion 3 Release 1

GC35-0316-01

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

Second Edition (September 1999)

This edition applies to Version 3 of Tivoli Storage Manager for AS/400 (5697-TSM and 5697-DRM), and to anysubsequent releases until otherwise indicated in new editions or technical newsletters. Make sure you are using thecorrect edition for the level of the product.

Changes since the September 1998 edition are marked with a vertical bar in the left margin. Ensure that you are usingthe correct edition for the level of the product.

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

Your comments and suggestions can contribute to the quality and usability of this publication. If you have commentsabout this book or any other ADSM documentation, please see “Do You Have Comments or Suggestions?” onpage xvi.

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

|||

||

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . xiiiWho Should Read This Publication. . . . . . . . . . . . . . . . . xiiiWhat You Should Know Before Reading This Publication . . . . . . . . . xiiiTivoli Storage Manager Web site . . . . . . . . . . . . . . . . . xiiiTivoli Storage Manager Publications . . . . . . . . . . . . . . . . xivRelated AS/400® System Publications. . . . . . . . . . . . . . . . xvRelated IBM® Hardware Products Publications . . . . . . . . . . . . . xvIBM International Technical Support Center Publications (Redbooks) . . . . . xviDo You Have Comments or Suggestions? . . . . . . . . . . . . . . xviTranslations . . . . . . . . . . . . . . . . . . . . . . . . xvi

Changes for Tivoli Storage Manager . . . . . . . . . . . . . . . xviiProduct Repackaging Changes—September 1999 . . . . . . . . . . . xviiChanges for Version 3 —September 1999 . . . . . . . . . . . . . . xviiChanges for Version 3—September 1998 . . . . . . . . . . . . . . xx

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

Chapter 2. Entering Administrative Commands . . . . . . . . . . . . 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 . . . . . . . . . . . . . . . 9Examples for Match-Exactly-One Character . . . . . . . . . . . . . 9

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

Routing Commands . . . . . . . . . . . . . . . . . . . . . . 10Examples of Routing Commands . . . . . . . . . . . . . . . . 11

Chapter 3. Using the Command-Line Interface . . . . . . . . . . . . 13Using the Administrative Client Session . . . . . . . . . . . . . . . 13

Using the AS/400 Administrative Client . . . . . . . . . . . . . . 13Using Administrative Client Options . . . . . . . . . . . . . . . 14Using Continuation Characters . . . . . . . . . . . . . . . . . 15Using Console Mode . . . . . . . . . . . . . . . . . . . . 16Using Mount Mode . . . . . . . . . . . . . . . . . . . . . 16Using Batch Mode . . . . . . . . . . . . . . . . . . . . . 16Using Interactive Mode. . . . . . . . . . . . . . . . . . . . 17

Chapter 4. Using Commands Based on Privilege Class . . . . . . . . . 19Commands Requiring System Privilege . . . . . . . . . . . . . . . 19Commands Requiring Policy Privilege . . . . . . . . . . . . . . . . 21Commands Requiring Storage Privilege . . . . . . . . . . . . . . . 23Commands Requiring Operator Privilege . . . . . . . . . . . . . . . 24

© Copyright IBM Corp. 1994, 1999 iii

||||

||||

Commands Requiring Analyst Privilege . . . . . . . . . . . . . . . 24Commands Any Administrator Can Issue . . . . . . . . . . . . . . . 25

Chapter 5. Using Administrator Commands . . . . . . . . . . . . . 27ACCEPT DATE (Accepts the Current System Date) . . . . . . . . . . . 28ACTIVATE POLICYSET (Activate a New Policy Set) . . . . . . . . . . . 29ASSIGN DEFMGMTCLASS (Assign a Default Management Class) . . . . . . 31AUDIT LIBRARY (Verify an Automated Library’s Inventory) . . . . . . . . . 33AUDIT LICENSES (Audit Server Storage Usage) . . . . . . . . . . . . 35AUDIT VOLUME (Verify Database Information for a Storage Pool Volume) . . . 37BACKUP DB (Back Up the Database). . . . . . . . . . . . . . . . 41BACKUP DEVCONFIG (Create Backup Copies of Device Configuration

Information) . . . . . . . . . . . . . . . . . . . . . . . 45BACKUP STGPOOL (Back Up Primary Storage Pool to Copy Storage Pool) . . . 47BACKUP VOLHISTORY (Save Sequential Volume History Information) . . . . . 50BEGIN EVENTLOGGING (Begin Logging Events) . . . . . . . . . . . . 52CANCEL EXPIRATION (Cancel an Expiration Process) . . . . . . . . . . 54CANCEL PROCESS (Cancel an Administrative Process) . . . . . . . . . 55CANCEL REQUEST (Cancel One or More Mount Requests) . . . . . . . . 57CANCEL RESTORE (Cancel a Restartable Restore Session) . . . . . . . . 58CANCEL SESSION (Cancel One or More Client Sessions) . . . . . . . . . 59CHECKIN LIBVOLUME (Check a Storage Volume into a Library). . . . . . . 61CHECKOUT LIBVOLUME (Check a Storage Volume out of a Library) . . . . . 65COMMIT (Control Committing of Commands in a Macro) . . . . . . . . . 67COPY CLOPTSET (Copy a Client Option Set) . . . . . . . . . . . . . 69COPY DOMAIN (Copy a Policy Domain) . . . . . . . . . . . . . . . 70COPY MGMTCLASS (Copy a Management Class) . . . . . . . . . . . 72COPY POLICYSET (Copy a Policy Set) . . . . . . . . . . . . . . . 74COPY PROFILE (Copy a Profile) . . . . . . . . . . . . . . . . . 76COPY SCHEDULE (Copy a Client or an Administrative Command Schedule). . . 78

COPY SCHEDULE — Client . . . . . . . . . . . . . . . . . . 79COPY SCHEDULE — Administrative Command . . . . . . . . . . . 81Related Commands . . . . . . . . . . . . . . . . . . . . . 82

COPY SCRIPT (Copy a Tivoli Storage Manager Script) . . . . . . . . . . 83COPY SERVERGROUP (Copy a Server Group) . . . . . . . . . . . . 84DEFINE ASSOCIATION (Associate Client Nodes with a Schedule) . . . . . . 86DEFINE CLIENTACTION (Define a One-Time Client Action) . . . . . . . . 88DEFINE CLIENTOPT (Define an Option to an Option Set) . . . . . . . . . 91DEFINE CLOPTSET (Define Client Options) . . . . . . . . . . . . . 93DEFINE COPYGROUP (Define a Copy Group). . . . . . . . . . . . . 95

DEFINE COPYGROUP — Backup . . . . . . . . . . . . . . . . 96DEFINE COPYGROUP — Archive . . . . . . . . . . . . . . . . 101Related Commands . . . . . . . . . . . . . . . . . . . . . 104

DEFINE DBBACKUPTRIGGER (Define the Database Backup Trigger) . . . . . 105DEFINE DBCOPY (Define a Volume Copy of a Database Volume) . . . . . . 107DEFINE DBVOLUME (Define a Database Volume) . . . . . . . . . . . 109DEFINE DEVCLASS (Define a Device Class) . . . . . . . . . . . . . 111

DEFINE DEVCLASS — FILE . . . . . . . . . . . . . . . . . 112DEFINE DEVCLASS — SERVER . . . . . . . . . . . . . . . . 114DEFINE DEVCLASS — 8MM . . . . . . . . . . . . . . . . . 116

iv Tivoli Storage Manager for AS/400: Administrator’s Reference

||

||

||||

DEFINE DEVCLASS — QIC . . . . . . . . . . . . . . . . . . 119DEFINE DEVCLASS — 3590 . . . . . . . . . . . . . . . . . 123DEFINE DEVCLASS — 3570 . . . . . . . . . . . . . . . . . 126DEFINE DEVCLASS — CARTRIDGE . . . . . . . . . . . . . . . 129DEFINE DEVCLASS — OPTICAL and WORM TYPES . . . . . . . . . 133DEFINE DEVCLASS — REEL . . . . . . . . . . . . . . . . . 135Related Commands . . . . . . . . . . . . . . . . . . . . . 138

DEFINE DOMAIN (Define a New Policy Domain) . . . . . . . . . . . . 139DEFINE DRIVE (Define a Drive to a Library) . . . . . . . . . . . . . 141DEFINE EVENTSERVER (Define a Server as the Event Server) . . . . . . . 143DEFINE EXIT (Define an Exit Program) . . . . . . . . . . . . . . . 144DEFINE GRPMEMBER (Add a Server to a Server Group) . . . . . . . . . 146DEFINE LIBRARY (Define a Library) . . . . . . . . . . . . . . . . 148DEFINE LOGCOPY (Define a Volume Copy of a Recovery Log Volume) . . . . 152DEFINE LOGVOLUME (Define a Recovery Log Volume) . . . . . . . . . 154DEFINE MACHINE (Define a Machine) . . . . . . . . . . . . . . . 156DEFINE MACHNODEASSOCIATION (Associate a Node With a Machine) . . . . 158DEFINE MGMTCLASS (Define a Management Class) . . . . . . . . . . 160DEFINE POLICYSET (Define a Policy Set) . . . . . . . . . . . . . . 163DEFINE PROFASSOCIATION (Define a Profile Association) . . . . . . . . 165DEFINE PROFILE (Define a Profile) . . . . . . . . . . . . . . . . 171DEFINE RECMEDMACHASSOCIATION (Associate Recovery Media with a

Machine) . . . . . . . . . . . . . . . . . . . . . . . . 173DEFINE RECOVERYMEDIA (Define Recovery Media) . . . . . . . . . . 175DEFINE SCHEDULE (Define a Client or an Administrative Command Schedule) . 178

DEFINE SCHEDULE — Client . . . . . . . . . . . . . . . . . 179DEFINE SCHEDULE — Administrative Command. . . . . . . . . . . 187Related Commands . . . . . . . . . . . . . . . . . . . . . 193

DEFINE SCRIPT (Define a Tivoli Storage Manager Script) . . . . . . . . . 194DEFINE SERVER (Define a Server) . . . . . . . . . . . . . . . . 197DEFINE SERVERGROUP (Define a Server Group) . . . . . . . . . . . 201DEFINE SPACETRIGGER (Define the Database or Recovery Log Space Trigger) . 203DEFINE STGPOOL (Define a Storage Pool) . . . . . . . . . . . . . 205

DEFINE STGPOOL — Primary Random Access . . . . . . . . . . . 206DEFINE STGPOOL — Primary Sequential Access . . . . . . . . . . 211DEFINE STGPOOL — Copy Sequential Access . . . . . . . . . . . 217Related Commands . . . . . . . . . . . . . . . . . . . . . 221

DEFINE SUBSCRIPTION (Define a Profile Subscription) . . . . . . . . . 222DEFINE VOLUME (Define a Volume in a Storage Pool) . . . . . . . . . . 224DELETE ASSOCIATION (Delete the Node Association to a Schedule) . . . . . 228DELETE CLIENTOPT (Delete an Option in an Option Set) . . . . . . . . . 230DELETE CLOPTSET (Delete a Client Option Set) . . . . . . . . . . . . 232DELETE COPYGROUP (Delete a Copy Group) . . . . . . . . . . . . 233DELETE DBBACKUPTRIGGER (Delete the Database Backup Trigger) . . . . . 235DELETE DBVOLUME (Delete a Database Volume) . . . . . . . . . . . 236DELETE DEVCLASS (Delete a Device Class) . . . . . . . . . . . . . 238DELETE DOMAIN (Delete a Policy Domain) . . . . . . . . . . . . . 239DELETE DRIVE (Delete a Drive from a Library) . . . . . . . . . . . . 240DELETE EVENT (Delete Event Records). . . . . . . . . . . . . . . 241DELETE EVENTSERVER (Deletes the Defintion of the Event Server) . . . . . 243

Contents v

||

||

||||

||

||||

||

DELETE EXIT (Delete an Exit Program) . . . . . . . . . . . . . . . 244DELETE FILESPACE (Delete Client Node Data from the Server) . . . . . . . 246DELETE GRPMEMBER (Delete a Server from a Server Group) . . . . . . . 249DELETE LIBRARY (Delete a Library) . . . . . . . . . . . . . . . . 251DELETE LOGVOLUME (Delete a Recovery Log Volume) . . . . . . . . . 252DELETE MACHINE (Delete Machine Information) . . . . . . . . . . . . 254DELETE MACHNODEASSOCIATION (Delete Association Between a Machine and

a Node) . . . . . . . . . . . . . . . . . . . . . . . . . 256DELETE MGMTCLASS (Delete a Management Class) . . . . . . . . . . 257DELETE POLICYSET (Delete a Policy Set) . . . . . . . . . . . . . . 259DELETE PROFASSOCIATION (Delete a Profile Association) . . . . . . . . 261DELETE PROFILE (Delete a Profile) . . . . . . . . . . . . . . . . 265DELETE RECMEDMACHASSOCIATION (Delete Recovery Media and Machine

Association) . . . . . . . . . . . . . . . . . . . . . . . 267DELETE RECOVERYMEDIA (Delete Recovery Media) . . . . . . . . . . 268DELETE SCHEDULE (Delete a Client or an Administrative Command Schedule) . 269

DELETE SCHEDULE — Client . . . . . . . . . . . . . . . . . 270DELETE SCHEDULE — Administrative Command . . . . . . . . . . 271Related Commands . . . . . . . . . . . . . . . . . . . . . 272

DELETE SCRIPT (Delete Command Lines from a Script or Delete the EntireScript) . . . . . . . . . . . . . . . . . . . . . . . . . 273

DELETE SERVER (Delete a Server Definition) . . . . . . . . . . . . . 275DELETE SERVERGROUP (Delete a Server Group) . . . . . . . . . . . 276DELETE SPACETRIGGER (Delete the Database or Recovery Log Space Triggers) 277DELETE STGPOOL (Delete a Storage Pool) . . . . . . . . . . . . . 279DELETE SUBSCRIBER (Delete Subscriptions from a Configuration Manager

Database) . . . . . . . . . . . . . . . . . . . . . . . . 281DELETE SUBSCRIPTION (Delete a Profile Subscription) . . . . . . . . . 283DELETE VOLHISTORY (Delete Sequential Volume History Information) . . . . 285DELETE VOLUME (Delete a Storage Pool Volume) . . . . . . . . . . . 289DISABLE EVENTS (Disable Events for Event Logging) . . . . . . . . . . 292DISABLE SESSIONS (Temporarily Prevent Client Node Access to the Server) . . 295DISMOUNT VOLUME (Dismount a Volume by Volume Name). . . . . . . . 296ENABLE EVENTS (Enable Server or Client Events for Logging) . . . . . . . 297ENABLE SESSIONS (Resume User Activity on the Server) . . . . . . . . 300END EVENTLOGGING (Stop Logging Events) . . . . . . . . . . . . . 301EXPIRE INVENTORY (Manually Start Inventory Expiration Processing). . . . . 303EXPORT ADMIN (Copy Administrator Information to Sequential Media). . . . . 305EXPORT NODE (Copy Client Node Information to Sequential Media) . . . . . 309EXPORT POLICY (Copy Policy Information to Sequential Media). . . . . . . 314EXPORT SERVER (Copy Server Information to Sequential Media) . . . . . . 318EXTEND DB (Increase the Assigned Capacity of the Database) . . . . . . . 323EXTEND LOG (Increase the Assigned Capacity of the Recovery Log) . . . . . 325GRANT AUTHORITY (Add Administrator Authority) . . . . . . . . . . . 327HALT (Shut Down the Server) . . . . . . . . . . . . . . . . . . 332HELP (Get Help on Commands and Error Messages) . . . . . . . . . . 334IMPORT ADMIN (Import Administrator Information) . . . . . . . . . . . 337IMPORT NODE (Import Client Node Information) . . . . . . . . . . . . 340IMPORT POLICY (Import Policy Information) . . . . . . . . . . . . . 345IMPORT SERVER (Import the Server) . . . . . . . . . . . . . . . 348

vi Tivoli Storage Manager for AS/400: Administrator’s Reference

||

||||

|||

||||

|||||

INSERT MACHINE (Insert Machine Characteristics Information or RecoveryInstructions) . . . . . . . . . . . . . . . . . . . . . . . 352

LOCK ADMIN (Lock Out an Administrator) . . . . . . . . . . . . . . 354LOCK NODE (Lock Out a Client Node) . . . . . . . . . . . . . . . 355LOCK PROFILE (Lock a Profile) . . . . . . . . . . . . . . . . . 356MACRO (Invoke a Macro). . . . . . . . . . . . . . . . . . . . 358MOVE DATA (Move Files on a Storage Pool Volume) . . . . . . . . . . 360MOVE DRMEDIA (Move Disaster Recovery Media Offsite and Back Onsite) . . . 362MOVE GRPMEMBER (Move a Server Group Member) . . . . . . . . . . 375NOTIFY SUBSCRIBERS (Notify Managed Servers to Update Profiles) . . . . . 377PING SERVER (Test the Connection Between Servers) . . . . . . . . . . 378PREPARE (Create a Recovery Plan File) . . . . . . . . . . . . . . 379QUERY ACTLOG (Query the Activity Log) . . . . . . . . . . . . . . 383QUERY ADMIN (Display Administrator Information) . . . . . . . . . . . 388QUERY ASSOCIATION (Query Client Node Associations with a Schedule) . . . 393QUERY AUDITOCCUPANCY (Query Client Node Storage Utilization) . . . . . 395QUERY CLOPTSET (Query a Client Option Set) . . . . . . . . . . . . 398QUERY CONTENT (Query the Contents of a Storage Pool Volume). . . . . . 401QUERY COPYGROUP (Query Copy Groups) . . . . . . . . . . . . . 407QUERY DB (Display Information on the Database) . . . . . . . . . . . 412QUERY DBBACKUPTRIGGER (Query the Database Backup Trigger) . . . . . 416QUERY DBVOLUME (Display Information on One or More Database Volumes) . . 418QUERY DEVCLASS (Display Information on One or More Device Classes) . . . 421QUERY DOMAIN (Query a Policy Domain) . . . . . . . . . . . . . . 424QUERY DRIVE (Query Information about a Drive). . . . . . . . . . . . 428QUERY DRMEDIA (Query Disaster Recovery Media) . . . . . . . . . . 431QUERY DRMSTATUS (Query DRM System Parameters) . . . . . . . . . 439QUERY ENABLED (Query Enabled Events). . . . . . . . . . . . . . 442QUERY EVENT (Query Scheduled and Completed Events) . . . . . . . . 444

QUERY EVENT — Client Schedules . . . . . . . . . . . . . . . 445QUERY EVENT — Administrative Schedules . . . . . . . . . . . . 452Related Commands . . . . . . . . . . . . . . . . . . . . . 456

QUERY EVENTRULES (Query Rules for Server or Client Events) . . . . . . 457QUERY EVENTSERVER (Query the Event Server) . . . . . . . . . . . 460QUERY EXIT (Query Information on One or All Exits) . . . . . . . . . . 461QUERY FILESPACE (Query One or More File Spaces) . . . . . . . . . . 464QUERY LIBRARY (Query a Library) . . . . . . . . . . . . . . . . 467QUERY LIBVOLUME (Query a Library Volume) . . . . . . . . . . . . 470QUERY LICENSE (Display License Information) . . . . . . . . . . . . 472QUERY LOG (Display Information on the Recovery Log) . . . . . . . . . 474QUERY LOGVOLUME (Display Information on One or More Log Volumes) . . . 477QUERY MACHINE (Query Machine Information) . . . . . . . . . . . . 480QUERY MGMTCLASS (Query a Management Class) . . . . . . . . . . 484QUERY MOUNT (Display Information on Mounted Sequential Access Volumes) . . 488QUERY NODE (Query Nodes) . . . . . . . . . . . . . . . . . . 489QUERY OCCUPANCY (Query Client File Spaces in Storage Pools) . . . . . . 495QUERY OPTION (Query Server Options) . . . . . . . . . . . . . . 499QUERY POLICYSET (Query a Policy Set) . . . . . . . . . . . . . . 501QUERY PROCESS (Query One or More Server Processes) . . . . . . . . 504QUERY PROFILE (Query a Profile) . . . . . . . . . . . . . . . . 506

Contents vii

||

||

||

||

QUERY RECOVERYMEDIA (Query Recovery Media) . . . . . . . . . . 510QUERY REQUEST (Query One or More Pending Mount Requests) . . . . . . 513QUERY RESTORE (Query Restartable Restore Sessions) . . . . . . . . . 514QUERY RPFCONTENT (Query Recovery Plan File Contents Stored on a Target

Server) . . . . . . . . . . . . . . . . . . . . . . . . . 516QUERY RPFILE (Query Recovery Plan File Information Stored on a Target Server) 518QUERY SCHEDULE (Query Schedules) . . . . . . . . . . . . . . . 521

QUERY SCHEDULE — Client . . . . . . . . . . . . . . . . . 522QUERY SCHEDULE — Administrative . . . . . . . . . . . . . . 526Related Commands . . . . . . . . . . . . . . . . . . . . . 530

QUERY SCRIPT (Query Tivoli Storage Manager Scripts) . . . . . . . . . 531QUERY SERVER (Query a Server) . . . . . . . . . . . . . . . . 535QUERY SERVERGROUP (Query a Server Group) . . . . . . . . . . . 540QUERY SESSION (Query Client Sessions) . . . . . . . . . . . . . . 542QUERY SPACETRIGGER (Query the Database or Recovery Log Space Triggers) . 545QUERY SQLSESSION (Display SQL Session Value) . . . . . . . . . . . 548QUERY STATUS (Query System Parameters) . . . . . . . . . . . . . 550QUERY STGPOOL (Query Storage Pools) . . . . . . . . . . . . . . 555QUERY SUBSCRIBER (Display Subscriber Information) . . . . . . . . . 561QUERY SUBSCRIPTION (Display Subscription Information) . . . . . . . . 563QUERY SYSTEM (Query the System Configuration and Capacity) . . . . . . 565QUERY VOLHISTORY (Display Sequential Volume History Information) . . . . 567QUERY VOLUME (Query Storage Pool Volumes) . . . . . . . . . . . . 573QUIT (End the Interactive Mode of the Administrative Client) . . . . . . . . 578RECONCILE VOLUMES (Reconcile Differences in the Virtual Volume Definitions) . 579REDUCE DB (Decrease the Assigned Capacity of the Database). . . . . . . 582REDUCE LOG (Decrease the Assigned Capacity of the Recovery Log). . . . . 584REGISTER ADMIN (Register an Administrator) . . . . . . . . . . . . . 586REGISTER LICENSE (Register a New License) . . . . . . . . . . . . 588REGISTER NODE (Register a Client Node) . . . . . . . . . . . . . . 590REMOVE ADMIN (Delete an Administrator) . . . . . . . . . . . . . . 595REMOVE NODE (Delete a Client Node or an Associated Machine Node) . . . . 596RENAME ADMIN (Rename an Administrator) . . . . . . . . . . . . . 598RENAME FILESPACE (Rename a Client File Space on the Server) . . . . . . 599RENAME NODE (Rename a Client Node) . . . . . . . . . . . . . . 601RENAME SCRIPT (Rename a Tivoli Storage Manager Script) . . . . . . . . 602RENAME SERVERGROUP (Rename a Server Group) . . . . . . . . . . 603RENAME STGPOOL (Change the Name of a Storage Pool) . . . . . . . . 604REPLY (Allow a Request to Continue Processing). . . . . . . . . . . . 606RESET BUFPOOL (Reset the Database Buffer Pool Statistics) . . . . . . . 607RESET DBMAXUTILIZATION (Reset the Utilization Statistic for the Database) . . 608RESET LOGCONSUMPTION (Reset the Cumulative Log Consumption Statistic) . 609RESET LOGMAXUTILIZATION (Reset the Utilization Statistic for the Log). . . . 610RESTORE STGPOOL (Restore Storage Pool Data from a Copy Pool) . . . . . 611RESTORE VOLUME (Restore Primary Volume Data from a Copy Pool) . . . . 615REVOKE AUTHORITY (Remove Administrator Authority) . . . . . . . . . 619ROLLBACK (Rollback Uncommitted Changes in a Macro) . . . . . . . . . 623RUN (Run a Tivoli Storage Manager Script) . . . . . . . . . . . . . . 625SELECT (Perform an SQL Query of the TSM Database) . . . . . . . . . 628SET ACCOUNTING (Set Accounting Records On or Off) . . . . . . . . . 636

viii Tivoli Storage Manager for AS/400: Administrator’s Reference

|||||

||

||

||

||||

||||||

||

SET ACTLOGRETENTION (Set the Retention Period for the Activity Log) . . . . 637SET AUTHENTICATION (Set Password Authentication) . . . . . . . . . . 638SET CLIENTACTDURATION (Set the Duration Period for the Client Action) . . . 639SET CONFIGMANAGER (Specify a Configuration Manager) . . . . . . . . 640SET CONFIGREFRESH (Set Managed Server Configuration Refresh) . . . . . 642SET CROSSDEFINE (Specifies Whether to Cross-Define Servers) . . . . . . 644SET DRMCHECKLABEL (Specify Label Checking) . . . . . . . . . . . 645SET DRMCMDFILENAME (Specify the Name of a File to Contain Commands) . . 646SET DRMCOPYSTGPOOL (Specify the Copy Storage Pools to be Managed by

DRM). . . . . . . . . . . . . . . . . . . . . . . . . . 647SET DRMCOURIERNAME (Specify the Courier Name) . . . . . . . . . . 649SET DRMDBBACKUPEXPIREDAYS (Criteria for DB Backup Series Expiration) . . 650SET DRMFILEPROCESS (Specify File Processing) . . . . . . . . . . . 652SET DRMINSTRPREFIX (Specify the Prefix for Recovery Instructions File Names). 653SET DRMNOTMOUNTABLENAME (Specify the Not Mountable Location Name). . 655SET DRMPLANPREFIX (Specify a Prefix for Recovery Plan File Names) . . . . 656SET DRMPLANVPOSTFIX (Specify Replacement Volume Names) . . . . . . 657SET DRMPRIMSTGPOOL (Specify the Primary Storage Pools to be Managed by

DRM). . . . . . . . . . . . . . . . . . . . . . . . . . 659SET DRMRPFEXPIREDAYS (Set Criteria for Recovery Plan File Expiration) . . . 660SET DRMVAULTNAME (Specify the Vault Name) . . . . . . . . . . . . 662SET EVENTRETENTION (Set the Retention Period for Event Records) . . . . 663SET INVALIDPWLIMIT (Set the Number of Invalid Logon Attempts) . . . . . . 665SET LICENSEAUDITPERIOD (Set License Audit Period) . . . . . . . . . 666SET LOGMODE (Set Mode for Saving Recovery Log Records) . . . . . . . 667SET LRECLRECOVERYFILE (Set Logical Record Length for a File) . . . . . 669SET MAXCMDRETRIES (Set the Maximum Number of Command Retries) . . . 670SET MAXSCHEDSESSIONS (Set Maximum Scheduled Sessions) . . . . . . 672SET MINPWLENGTH (Set Minimum Password Length) . . . . . . . . . . 674SET PASSEXP (Set Password Expiration Date) . . . . . . . . . . . . 675SET QUERYSCHEDPERIOD (Set Query Period for Polling Client Nodes) . . . . 677SET RANDOMIZE (Set Randomization of Scheduled Start Times) . . . . . . 679SET REGISTRATION (Set Open or Closed Registration) . . . . . . . . . 681SET RETRYPERIOD (Set Time between Retry Attempts) . . . . . . . . . 683SET SCHEDMODES (Select a Central Scheduling Mode) . . . . . . . . . 685SET SERVERHLADDRESS (Set the High Level Address of a Server) . . . . . 687SET SERVERLLADDRESS (Set the Low Level Address of a Server) . . . . . 688SET SERVERNAME (Specify the Server Name) . . . . . . . . . . . . 689SET SERVERPASSWORD (Set Password for Server) . . . . . . . . . . 690SET SERVERURL (Set URL for Server) . . . . . . . . . . . . . . . 691SET SQLDATETIMEFORMAT (Set the Format for Date, Time, and Time Stamp for

SQL Data) . . . . . . . . . . . . . . . . . . . . . . . . 692SET SQLDISPLAYMODE (Set the Display of SQL Data Types) . . . . . . . 694SET SQLMATHMODE (Set the Mode for SQL Arithmetic) . . . . . . . . . 695SET SUMMARYRETENTION (Set Days to Keep Data in Activity Summary Table) . 696SET WEBAUTHTIMEOUT (Set the Web Time-out Interval) . . . . . . . . . 698SETOPT (Set a Server Option for Dynamic Update) . . . . . . . . . . . 699UNLOCK ADMIN (Unlock an Administrator) . . . . . . . . . . . . . . 700UNLOCK NODE (Unlock a Client Node) . . . . . . . . . . . . . . . 701UNLOCK PROFILE (Unlock a Profile) . . . . . . . . . . . . . . . . 702

Contents ix

||||

||

||

||

UPDATE ADMIN (Update an Administrator) . . . . . . . . . . . . . . 703UPDATE CLIENTOPT (Update a Client Option Sequence Number) . . . . . . 705UPDATE CLOPTSET (Update a Client Option Set Description) . . . . . . . 706UPDATE COPYGROUP (Update a Copy Group) . . . . . . . . . . . . 707

UPDATE COPYGROUP — Backup . . . . . . . . . . . . . . . 708UPDATE COPYGROUP — Archive . . . . . . . . . . . . . . . 712Related Commands . . . . . . . . . . . . . . . . . . . . . 715

UPDATE DBBACKUPTRIGGER (Update the Database Backup Trigger) . . . . 716UPDATE DEVCLASS (Update the Attributes of a Device Class) . . . . . . . 718

UPDATE DEVCLASS—FILE . . . . . . . . . . . . . . . . . . 719UPDATE DEVCLASS—SERVER . . . . . . . . . . . . . . . . 720UPDATE DEVCLASS — 8MM . . . . . . . . . . . . . . . . . 722UPDATE DEVCLASS — QIC . . . . . . . . . . . . . . . . . 725UPDATE DEVCLASS — 3590 . . . . . . . . . . . . . . . . . 728UPDATE DEVCLASS — 3570 . . . . . . . . . . . . . . . . . 731UPDATE DEVCLASS — CARTRIDGE . . . . . . . . . . . . . . 734UPDATE DEVCLASS — OPTICAL and WORM TYPES . . . . . . . . . 737UPDATE DEVCLASS — REEL . . . . . . . . . . . . . . . . . 739Related Commands . . . . . . . . . . . . . . . . . . . . . 742

UPDATE DOMAIN (Update a Policy Domain) . . . . . . . . . . . . . 743UPDATE DRIVE (Update a Drive) . . . . . . . . . . . . . . . . . 745UPDATE EXIT (Update an Exit Program). . . . . . . . . . . . . . . 748UPDATE LIBRARY (Update a Library). . . . . . . . . . . . . . . . 750UPDATE LIBVOLUME (Change the Status of a Storage Volume). . . . . . . 752UPDATE MACHINE (Update Machine Information) . . . . . . . . . . . 754UPDATE MGMTCLASS (Update a Management Class) . . . . . . . . . . 756UPDATE NODE (Update a Client Node) . . . . . . . . . . . . . . . 759UPDATE POLICYSET (Update a Policy Set Description) . . . . . . . . . 763UPDATE PROFILE (Update a Profile Description) . . . . . . . . . . . . 765UPDATE RECOVERYMEDIA (Update Recovery Media) . . . . . . . . . . 767UPDATE SCHEDULE (Update a Schedule) . . . . . . . . . . . . . . 769

UPDATE SCHEDULE — Client . . . . . . . . . . . . . . . . . 770UPDATE SCHEDULE — Administrative . . . . . . . . . . . . . . 778Related Tables . . . . . . . . . . . . . . . . . . . . . . 784

UPDATE SCRIPT (Update a Tivoli Storage Manager Script) . . . . . . . . 785UPDATE SERVER (Update a Server Defined for Server-to-Server

Communications) . . . . . . . . . . . . . . . . . . . . . . 788UPDATE SERVERGROUP (Update a Server Group Description) . . . . . . . 792UPDATE SPACETRIGGER (Update the Database or Recovery Log Space

Triggers) . . . . . . . . . . . . . . . . . . . . . . . . 793UPDATE STGPOOL (Update a Storage Pool) . . . . . . . . . . . . . 795

UPDATE STGPOOL — Primary Random Access . . . . . . . . . . . 796UPDATE STGPOOL — Primary Sequential Access . . . . . . . . . . 801UPDATE STGPOOL — Copy Sequential Access . . . . . . . . . . . 807Related Commands . . . . . . . . . . . . . . . . . . . . . 810

UPDATE VOLHISTORY (Update Sequential Volume History Information) . . . . 811UPDATE VOLUME (Change a Storage Pool Volume) . . . . . . . . . . 813VALIDATE POLICYSET (Verify a Policy Set) . . . . . . . . . . . . . 818VARY (Bring a Random Access Volume Online or Offline) . . . . . . . . . 820

x Tivoli Storage Manager for AS/400: Administrator’s Reference

||

||

|||||

Appendix A. AS/400 Utilities . . . . . . . . . . . . . . . . . . 823Database Recovery Utilities . . . . . . . . . . . . . . . . . . . 823Database Salvage Utilities . . . . . . . . . . . . . . . . . . . 823Miscellaneous Server Utilities . . . . . . . . . . . . . . . . . . 824DSPVOLADSM (Display Volume Information) . . . . . . . . . . . . . 825STRRSTADSM (Start Restore for TSM) . . . . . . . . . . . . . . . 828DMPADSM (Dump TSM Database) . . . . . . . . . . . . . . . . 834INZSVRADSM (Initialize Server for ADSM) . . . . . . . . . . . . . . 838LODADSM (Load the TSM Database) . . . . . . . . . . . . . . . . 846STRAUDADSM (Start Audit of TSM Database) . . . . . . . . . . . . . 849CRTVOLADSM (Formatting a Physical File Member for the Server) . . . . . . 852STRSVRADSM (Start Server) . . . . . . . . . . . . . . . . . . 856VFYSVRADSM (Verify Server Status) . . . . . . . . . . . . . . . . 861WRKDEVADSM (Work with Devices) . . . . . . . . . . . . . . . . 862CHGADMADSM (Change Administrative Client Options). . . . . . . . . . 865CHGSVRADSM (Change Server Options for ADSM) . . . . . . . . . . . 871ENDSVRADSM (End Server for ADSM) . . . . . . . . . . . . . . . 898

Appendix B. Return Code Checking in Tivoli Storage Manager Scripts . . . 901

Appendix C. Notices . . . . . . . . . . . . . . . . . . . . . 903Trademarks . . . . . . . . . . . . . . . . . . . . . . . . 905

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . 907

Index . . . . . . . . . . . . . . . . . . . . . . . . . . 927

Contents xi

||

xii Tivoli Storage Manager for AS/400: Administrator’s Reference

Preface

Tivoli® Storage Manager (TSM) is a client/server program that provides storagemanagement to customers in a multivendor computer environment. TSM provides anautomated, centrally scheduled, policy-managed backup, archive, and spacemanagement facility for file-servers and workstations.

Who Should Read This Publication

This reference is intended for anyone who is registered as an administrator. TSM canbe managed by a single administrator; however, administrative responsibilities can bedivided among several people as an installation requires.

All of the administrator commands you need to operate and maintain TSM can beinvoked from a workstation connected to the server, or from a workstation with a Webbrowser at release level 4 or higher with support for Java Developer’s Kit 1.1.

What You Should Know Before Reading This Publication

You should be familiar with the operating system on which the server resides and thecommunication protocols required for the client/server environment.

For information on product requirements for TSM, see Tivoli Storage ManagementProducts License Information. For information on installing TSM, see Tivoli StorageManager for AS/400 Administrator’s Guide.

You also need to understand the storage management practices of your organization,such as how you are currently backing up your workstation files and how you are usingrandom access media and sequential access media.

Tivoli Storage Manager Web site

All TSM publications are available on the TSM home page on the World Wide Web atthe following address:

http://www.tivoli.com/tsm

By accessing the TSM home page, you can access subjects that interest you. You canalso keep up-to-date with the newest TSM product information.

© Copyright IBM Corp. 1994, 1999 xiii


Tivoli Storage Manager Publications

The following table list TSM server publications.

Publication Title Order Number

Tivoli Storage Manager Messages GC35-0382

Tivoli Storage Management Products License Information LC23-4466

Tivoli Storage Manager for AS/400 Quick Start GC35-0317

Tivoli Storage Manager for AS/400 Administrator’s Guide GC35-0315

The following table list the TSM client publications.


ADSTAR Distributed Storage Manager Version 3: Using the UNIXHierarchical Storage Management Clients

SH26-4083

ADSTAR Distributed Storage Manager Version 3: Using the AppleMacintosh Backup-Archive Client

SH26-4079

Tivoli Storage Manager for UNIX Using the Backup-Archive Clients SH26-4076

ADSTAR Distributed Storage Manager Version 3: Using the OS/2Backup-Archive Client

SH26-4099

Tivoli Storage Manager for Netware Using the Backup-Archive Client SH26-4100

Tivoli Storage Manager for Windows Using the Backup-Archive Client SH26-4101

ADSTAR Distributed Storage Manager Version 3: Using the OS/2 LotusNotes Backup Agent

SH26-4084

Tivoli Storage Manager Installing the Clients SH26-4102

Tivoli Storage Manager Reference Cards for the Backup-Archive Clients SX26-6021

Tivoli Storage Manager Trace Facility Guide SH26-4104

ADSTAR Distributed Storage Manager Version 3: Using the ApplicationProgram Interface

SH26-4081

Tivoli Storage Manager AFS/DFS Backup Clients SH26-4106

The following table list Tivoli Data Protection publications.


Tivoli Data Protection for Informix Installation and User’s Guide SH26-4095

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

GC26-7305

Tivoli Data Protection for Lotus Domino, S/390 Edition Memo to Licensees GH26-4094

Program Directory for Tivoli Data Protection for Lotus Domino, S/390 Edition GI10-4519

Tivoli Data Protection for Lotus Domino for UNIX Installation and User’s Guide SH26-4088

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

ADSMConnect Agent for Lotus Notes on AIX Installation and User’s Guide SH26-4067

xiv Tivoli Storage Manager for AS/400: Administrator’s Reference


ADSMConnect Agent for Lotus Notes on Windows NT Installation and User’sGuide

SH26-4065

ADSMConnect Agent for Microsoft Exchange Server Installation and User’s Guide SH26-4071

ADSMConnect Agent for Microsoft SQL Server Installation and User’s Guide SH26-4069

ADSMConnect Agent for Oracle Backup on AIX Installation and User’s Guide SH26-4061

ADSMConnect Agent for Oracle Backup on HP-UX Installation and User’s Guide SH26-4073

ADSMConnect Agent for Oracle Backup on Sun Solaris Installation and User’sGuide

SH26-4063

ADSMConnect Agent for Oracle Backup on Windows NT Installation and User’sGuide

SH26-4086

Related AS/400 ® System Publications

The following table lists related AS/400 publications.


OS/400 CL Reference SC41-3722

AS/400 Local Device Configuration SC41-3121

AS/400 Publications Reference SC41-3003

AS/400 Automated Tape Library Planning and Management SC41-3309

OS/400 Work Management SC41-3306

Backup Recovery and Media Services for OS/400 SC41-3345

OS/400 Backup and Recovery – Basic SC41-3304

OS/400 Backup and Recovery – Advanced SC41-3305

OS/400 Communications Configuration SC41-3401

OS/400 Remote Work Station Support SC41-3402

Related IBM ® Hardware Products Publications

The following table lists related IBM hardware products publications.


IBM 3490 Magnetic Tape Subsystem Enhanced Capability Models E01and E11 User’s Guide

GA32-0298

IBM 3494 Tape Library Dataserver Operator’s Guide GA32-0280

IBM Magstar 3590 Tape Subsystem Operator’s Guide GA32-0330

IBM 3495 Tape Library Dataserver Models L20, L30, L40, and L50Operator’s Guide

GA32-0235

IBM 3494 Media Library Device Driver for AS/400 User’s Guide GC35-0153

Preface xv

IBM International Technical Support Center Publications (Redbooks)

The International Technical Support Center (ITSC) publishes redbooks, which are bookson specialized topics such as using TSM to back up databases. You can orderpublications through your IBM representative or the IBM branch office serving yourlocality. You can also search for and order books of interest to you by visiting the IBMRedbooks home page on the World Wide Web at this address:

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

Do You Have Comments or Suggestions?

Your feedback is important in helping to provide the most accurate and high-qualityinformation. Your comments and suggestions can contribute to the quality and usabilityof this publication.

You can send us comments electronically by using these addresses:

v Internet: [email protected]

v Fax from U.S. and Canada: 520 799–2906

v Fax from other countries: (1) 520 799–2906

You can also mail your comments to:

International Business Machines Corporation

Information Development, Dept. 61C

9000 South Rita Road

Tucson, AZ 85744-0001, U.S.A.

When you send information to IBM, you grant IBM a nonexclusive right to use ordistribute the information in any way it believes appropriate without incurring anyobligation to you.

Translations

Selected TSM publications have been translated into languages other than AmericanEnglish. Contact your sales representative for more information about the translatedpublications and whether these translations are available in your country.

xvi Tivoli Storage Manager for AS/400: Administrator’s Reference

http://www.redbooks.ibm.com

Changes for Tivoli Storage Manager

This section summarizes changes made to the Tivoli Storage Manager (TSM) productand this publication.

Product Repackaging Changes—September 1999

The ADSTAR® Distributed Storage Manager product and its features are now part ofthe Tivoli Storage Management product set. The table below shows the most importantname changes. The transition of the entire product set to the new names may not becomplete at the time of publishing, and as a result the terms ADSM and ADSTARDistributed Storage Manager may still appear. For the latest information onrequirements and compatibility among products, see this URL: http://www.tivoli.com/tsm

Table 1. Product Name Changes

Former name Current name Notes

ADSTAR Distributed StorageManager (ADSM)

Tivoli Storage Manager (TSM) Base product now includessome functions that werepurchased features for ADSM.

Hierarchical StorageManagement (HSM) client

Tivoli Space Manager (alsoreferred to as space managerclient or HSM client)

Formerly required purchase ofa feature; now a separateproduct with Tivoli StorageManager as the prerequisite.

Disaster Recovery Manager(DRM)

Tivoli Disaster RecoveryManager (DRM)


ADSMConnect Agents Tivoli Data Protection forapplications (also referred to asapplication clients)


Changes for Version 3 —September 1999

The following changes have been made for this edition:

Enterprise AdministrationYou can manage a network of servers in a consistent way from a single, webbrowser-based administrative interface. You can set up one server as theconfiguration manager that distributes configuration information (such aspolicy) to managed servers.

See the following new commands for details:

COPY PROFILE

DEFINE PROFILE

QUERY PROFILE

UNLOCK PROFILE

© Copyright IBM Corp. 1994, 1999 xvii

|

||

||||||

|||

|||

||||||

|||||

||||

||||||||

||||

||||

||

|

|||||

|

|

|

|

|


UPDATE PROFILE

DEFINE PROFASSOCIATION

DELETE PROFASSOCIATION

DEFINE SUBSCRIPTION

DELETE SUBSCRIPTION

QUERY SUBSCRIPTION

DELETE SUBSCRIBER

QUERY SUBSCRIBER

NOTIFY SUBSCRIBERS

RENAME STGPOOL

SET CONFIGMANAGER

SET CONFIGREFRESH

Enterprise Event Logging and MonitoringYou can log events from other servers and clients to a specific server.


DEFINE EVENTSERVER

DELETE EVENTSERVER

QUERY EVENTSERVER

See the following changed commands for details:

BEGIN EVENTLOGGING

DISABLE EVENTS

ENABLE EVENTS

END EVENTLOGGING

QUERY ENABLED

QUERY EVENTRULES

Routing Commands to Other Servers

You can route commands to one or more servers. See the following newcommands for details:

COPY SERVERGROUP

DEFINE SERVERGROUP

DELETE SERVERGROUP

QUERY SERVERGROUP

RENAME SERVERGROUP

UPDATE SERVERGROUP

DEFINE GRPMEMBER

DELETE GRPMEMBER

MOVE GRPMEMBER

PING SERVER

xviii Tivoli Storage Manager for AS/400: Administrator’s Reference

|

|

|

|

|

|

|

|

|

|

|

|

||

|

|

|

|

|

|

|

|

|

|

|

|

||

|

|

|

|

|

|

|

|

|

|

Server-to-Server Communication EnhancementsIn order to manage a network of servers, server-to-server communicationshave been enhanced to allow for the functions described above.


SET CROSSDEFINE

SET SERVERHLADDRESS

SET SERVERLLADDRESS

SET SERVERPASSWORD

SET SERVERURL


DEFINE SERVER

DELETE SERVER

QUERY SERVER

UPDATE SERVER

TSM Server ScriptsYou can create and store server scripts in the TSM database. Scripts cancontain TSM administrative commands and can include conditional statementsthat evaluate the results of earlier commands in the script before proceeding.Scripts can be distributed to other servers and can be scheduled to run withthe DEFINE SCHEDULE command.


COPY SCRIPT

DEFINE SCRIPT

DELETE SCRIPT

QUERY SCRIPT

RENAME SCRIPT

RUN

UPDATE SCRIPT

Database and Recovery Log AutomationYou can set up triggers that automate increasing the size of the database orrecovery log based on utilization levels.


DEFINE SPACETRIGGER

DELETE SPACETRIGGER

QUERY SPACETRIGGER

UPDATE SPACETRIGGER

Storage Pool Migration by AgeYou can set a minimum age for data before the server can migrate the datafrom a storage pool.


Changes for Tivoli Storage Manager xix

|||

|

|

|

|

|

|

|

|

|

|

|

||||||

|

|

|

|

|

|

|

|

|||

|

|

|

|

|

|||

|

DEFINE STGPOOL

UPDATE STGPOOL

Disaster Recovery Manager Plan FileYou can store the recovery plan file on another server to which your serverhas access via server-to-server communication.


QUERY RPFCONTENT

QUERY RPFILE

SET DRMRPFEXPIREDAYS

Changes for Version 3—September 1998

Tivoli Disaster Recovery ManagerThe Tivoli Disaster Recovery Manager feature allows you to prepare for andhelps you to recover from disasters that destroy the server and clients.

See the following commands for details:

DEFINE MACHINE

DEFINE MACHNODEASSOCIATION

DEFINE RECMEDMACHASSOCIATION

DEFINE RECOVERYMEDIA

DELETE MACHINE

DELETE MACHNODEASSOCIATION

DELETE RECOVERYMEDIA

INSERT MACHINE

MOVE MEDIA

PREPARE

QUERY DRMEDIA

QUERY DRMSTATUS

QUERY MACHINE

QUERY RECOVERYMEDIA

SET DRMCHECKLABEL

SET DRMCOPYSTGPOOL

SET DRMCOURIERNAME

SET DRMDBBACKUPEXPIREDAYS

SET DRMFILEPROCESS

SET DRMINSTRPREFIX

SET DRMPLANVPOSTFIX

SET DRMPLANPREFIX

SET DRMPRIMSTGPOOL

UPDATE MACHINE

xx Tivoli Storage Manager for AS/400: Administrator’s Reference

|

|

|||

|

|

|

|

|

UPDATE RECOVERYMEDIA

Central logging and monitoringYou can specify that event messages logged by the client and server bedirected to specified receivers.


BEGIN EVENTLOGGING

DISABLE EVENTS

ENABLE EVENTS

END EVENTLOGGING

QUERY ENABLED

QUERY EVENTRULES

The QUERY ACTLOG command provides more detailed information aboutevent messages logged by the client and server.

SQL queries of the TSM databaseYou can use SQL queries to get information about the server and clients.


QUERY SQLSESSION

SELECT

SET SQLDATETIMEFORMAT

SET SQLDISPLAYMODE

SET SQLMATHMODE

Restartable Client Restore SessionsClients can restart restore client sessions that have been interrupted.Administrators can request information about these sessions and cancel them.


CANCEL RESTORE

QUERY RESTORE

Data stored on another TSM serverYou can store data for one TSM server (a source server) on another TSMserver (a target server). Using another TSM server is especially useful forstoring backups of the TSM database and TSM storage pools.


DEFINE SERVER

DELETE SERVER

QUERY SERVER

UPDATE SERVER


DEFINE DEVCLASS

UPDATE DEVCLASS

Changes for Tivoli Storage Manager xxi

Device support enhancementsDevice support has been enhanced to allow TSM to use the following devices:

v IBM 3570 tape devices. For these devices, use the device type of 3570.

v Rewritable and write-once (WORM) optical devices that use 5.25–inchmedia. For these devices, use a device type of either OPTICAL (forrewritable optical devices) or WORM (for write-once optical devices).


DEFINE DEVCLASS

UPDATE DEVCLASS

Administrative client web interfaceYou can access TSM server functions from any workstation with a webbrowser that supports HTML 2.0 or higher. The workstation does not need tohave an administrative client installed. See the SET WEBAUTHTIMEOUTcommand for details about setting the time interval for reauthorization to theweb session.

Immediate processing of commands on a clientYou can use a TSM administrative command to run an operation immediatelyon a client workstation. You can also set the number of days that the operationis to remain active.


DEFINE CLIENTACTION

SET CLIENTACTDURATION

Client options at the serverYou can define, update, or delete client options at the server from the serverconsole or from an administrative client.


COPY CLOPSET

DEFINE CLIENTOPT

DEFINE CLOPTSET

DELETE CLIENTOPT

DELETE CLOPTSET

QUERY CLOPTSET

UPDATE CLIENTOPT

UPDATE CLOPTSET

You can specify which clients should use the option sets. See the followingcommands for details:

REGISTER NODE

UPDATE NODE

Server options enhancementYou can change some server options and have the changes take effect withoutstopping and starting the server. See the SETOPT command for details.

xxii Tivoli Storage Manager for AS/400: Administrator’s Reference

System configuration and capacity informationYou can obtain information regarding TSM’s configuration and capacity from acommand that consolidates output from a multiple of query commands. Seethe QUERY SYSTEM command for details.

Changes for Tivoli Storage Manager xxiii

xxiv Tivoli Storage Manager for AS/400: 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 and fromtop 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 continuesonto the next line.

v The Ê─── symbol, at the beginning of a line, indicates that a syntax diagramcontinues 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 Descriptions

This section covers syntax diagrams including descriptions and examples:

Abbreviations: Uppercase letters denote the shortest acceptable abbreviation. If anitem appears entirely in uppercase letters, it cannot be abbreviated.

You can type the item in uppercase letters, lowercase letters, or any combination. Inthis example, you can enter CMDNA, CMDNAM, or CMDNAME in any combination ofuppercase and lowercase letters.

ÊÊ CMDNAme ÊÍ

Symbols: You must code these symbols exactly as they appear in the syntax diagram.

* Asterisk

: Colon

, Comma

= Equal Sign

- Hyphen

( ) Parentheses

. Period

© Copyright IBM Corp. 1994, 1999 1

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 you must separate repeated items with that character.

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

ÊÊ ·

,

repeat ÊÍ

ÊÊ ·

,

repeat ÊÍ

ÊÊ ·

,(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 on theline, you must specify one item.

In this example, you must choose CMDNAME=A, CMDNAME=B, or CMDNAME=C. Donot include any blanks immediately before or after the equal sign (=).

ÊÊ 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 any blanksimmediately before or after the equal sign (=).

2 Tivoli Storage Manager for AS/400: Administrator’s Reference

When two or more items are in a stack below the line, all of them are optional. In thisexample, you can choose CMDNAME=A, CMDNAME=B, CMDNAME=C, or nothing atall. Do not include any blanks immediately before or after the equal sign (=).

ÊÊCMDNAme = A

ÊÍ

ÊÊCMDNAme = A

BC

ÊÍ

Defaults: Defaults are above the line. The system uses the default unless you overrideit. You can override the default by coding an option from the stack below the 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 the equalsign (=).

ÊÊCMDNAme = A

CMDNAme = ABC

ÊÍ

Repeatable Choices: A stack of items followed by an arrow returning to the left meansthat you can select more than one item or, in some cases, repeat a single item. In thisexample, you can choose more than one value, with each name delimited with acomma. 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. The expanded fragment is identified by a heading with thefragment name. Commands appearing directly on the line are required.

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

Chapter 1. Using Syntax Diagrams 3

ÊÊ Fragment ÊÍ

Fragment:

A

BC


Chapter 2. Entering Administrative Commands

This chapter contains information about entering and routing administrative commands.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 as DEFINEDOMAIN. You can enter the entire command name or the abbreviation specified in thesyntax diagram for the command.

Positional parameters: Some commands have required or optional positionalparameters. Positional parameters must be entered in the order indicated in the syntaxdiagram for a command.

For example, to copy a policy set, enter the name of the policy to which the policy setbelongs, the name of the policy set you want to copy, and the name you want to assignthe copy, in that order:

copy 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 between thekeyword and the value. A keyword parameter can, for example, provide a description ofan object, 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 abbreviationidentified 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 Rules

The following are general rules for entering TSM administrative commands:

v Enter a command in any column of the input line.

v Unless otherwise noted, commands can be specified in any combination ofuppercase and lowercase characters.

v If a parameter allows a list of values, enter the values immediately following theequal sign and delimit the value with a comma. For example,

cLasses=policy,storage

v When referring to file space names, specify the file space name using the exactcapitalization that is used by TSM. Use the QUERY FILESPACE command to findout the correct capitalization.

v If a description (a string of text) for a parameter begins with a single or double quoteor contains any embedded blanks or equal signs, you must surround the value ineither single (') or double (") quotation marks. The opening and closing quotation


marks must be the same type of quotation marks. For example, if the openingquotation is a single quotation mark, the closing quotation mark must also be a singlequotation mark.

For example, to register a new client node named Louie, with a password of secret,and with his title included as contact information, enter:

register node louie secret contact="manager of dept. 61f"

The following table presents ways of entering a description for the CONTACTparameter. The value can contain quotation marks, embedded blanks, or equal signs.

For this description Enter this

manager contact=manager

manager's contact="manager's" or contact='manager''s'

"manager" contact='"manager"' or contact="""manager"""

manager's report contact="manager's report" or contact='manager''s report'

manager's "report" contact='manager''s "report"'

manager=dept. 61f contact='manager=dept. 61f'

manager reports to dept. 61f contact='manager reports to dept. 61f' orcontact="manager reports to dept. 61f"

Processing Administrative Commands

TSM processes administrator commands in the foreground or in the background. Whenadministrative commands are processed, you receive a message indicating:

v Whether the command completed successfully (in the case of a foreground process)

v Whether the command has been sent to the server to be processed (in the case of abackground process)

TSM sends a confirmation message when commands are issued that affect theavailability of the server or data managed by the server. TSM does not send aconfirmation message if the command is issued from the server console or from anadministrative client with the NOCONFIRM option specified.

TSM formats the output processed from commands according to your screen or windowwidth. If the width of your screen or window is not wide enough to display the outputhorizontally, TSM arranges and displays the information vertically.

Commands Processed in the Foreground

Foreground processing specifies that each command issued must complete beforeanother command is issued. Commands processed in the foreground can be canceledfrom the server console or another administrative client session.

When you issue a QUERY command from the administrative client, multiple screens ofoutput may be generated. If this occurs and additional output is not needed, you can


cancel the display of output to the client workstation. While canceling does not end theprocessing of the command, it ends any further display of command output.

For some commands, you can specify whether to wait for TSM to complete processingthe command in the foreground before you issue other commands. By including theWAIT parameter, you can specify whether TSM processes the following commands inthe foreground:

BACKUP DB

BACKUP STGPOOL

DELETE FILESPACE

DELETE VOLUME

EXPIRE INVENTORY

EXTEND DB

EXTEND LOG

MOVE DATA

REDUCE DB

REDUCE LOG

RESTORE STGPOOL

RESTORE VOLUME

VARY

Commands Processed in the Background

Background processing specifies that you can enter commands while the server isprocessing a previously issued command. When you enter a command that creates abackground process, TSM submits a request to the server to perform the task identifiedin the command. Each background process is assigned a process number. Use theCANCEL PROCESS command to cancel commands that generate backgroundprocesses.

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, the serverstops the process. Any changes that are uncommitted are rolled back, however,changes that are committed are not rolled back.

Chapter 2. Entering Administrative Commands 7

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

REDUCE DB

REDUCE LOG

RESTORE STGPOOL

RESTORE VOLUME

VARY

Using Wildcard Characters

In some commands, such as the query commands, you can use wildcard characters tocreate 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 you issuecommands. For example, you can use wildcard characters such as an asterisk (*) tomatch any (0 or more) characters or you can use a question mark (?), or a percent 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, OS/2, SunOS,Windows

* ?

AS/400, CMS, TSO * %

For example, if you want to query all the management classes whose names begin withDEV in all the policy sets in DOMAIN1, and your system uses an asterisk as thematch-any character, you can enter:

query mgmtclass domain1 * dev*


However, if your system uses a quotation mark as the match-exactly-one character, andyou want to query the management classes in POLICYSET1 in DOMAIN1 you canenter:

query mgmtclass domain1 policyset1 mc?

TSM displays information about management classes with names MC.

Examples for Match-Any Characters

Table 3 shows additional examples using wildcard characters to match any characters.

Table 3. Match-Any Character

Pattern Matches Does Not Match

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

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

ab*ef*rs abefrs, abefghrs abefr, abers

Examples for Match-Exactly-One Character

Table 4 shows additional examples using wildcard characters to match exactly onecharacter. The question mark (?) can be replaced by a percent sign (%) if your platformuses 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 for Tivoli Storage Manager

When you use DEFINE commands to define volumes for the database, recovery logand storage pools, 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 Manager

TSM restricts the number and type of characters that you can use to name objects.


Valid Characters for Naming 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.

Maximum Characters for Naming Objects

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

30

Routing Commands

Command routing allows you to route commands to one or more servers forprocessing. Command routing allows the server that originated the command to routethe command to multiple servers and then to collect the output from these servers. Forinformation about how to setup and manage multiple servers for command routing, seethe Administrator’s Guide.

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

Each server identified as the target of a routed command must first be defined usingthe DEFINE SERVER command. The command is automatically routed to all serversspecified as members of a server group or to individual servers specified with thecommand.

After the command has completed processing on all servers, the output is displayed, inits entirety, for each server. For example, the output from SERVER_A is displayed in itsentirety, followed by the output from SERVER_B. The output includes summarymessages for each individual server and identifies which server the output is from.


||

|||||

||||

||||

||||

Return codes indicate whether or not commands were processed on the serverssucessfully. These return codes will include one of three severities: 0, ERROR, orWARNING.

Examples of Routing Commands

The following examples describe how to route the QUERY STGPOOL command to oneserver, multiple servers, a server group, multiple server groups, or a combination ofservers and server groups. Each server or server group in a list must be separated witha comma, without spaces. When routing commands inside scripts, you must enclosethe server or server group in parentheses and omit the colon.

Routing Commands to a Single Server: To route the QUERY STGPOOL command toa server named ASTRO, enter:

astro: query stgpool

The colon after the server name indicates the end of the routing information. This isalso called the server prefix. Another way to indicate the end of routing information is touse 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 TSM, the command is routed to the nextdefined server in the list of servers.

Routing Commands to a Server Group: To route the QUERY STGPOOL command toa server group named ADMIN, enter:

admin: query stgpool

or

(admin) query stgpool

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

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 to serversSERVER_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 servers namedMERCURY 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, you mustenclose the server or server group in parentheses and omit the colon. Otherwise, thecommand will not be routed when the RUN command is issued, and will only be run onthe 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:

(dev_group) define script qu_stg "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 starting and ending an administrative sessionwith TSM. You can start an administrative command-line sessions from anadministrative client.

Using the Administrative Client Session

The administrative command-line client is a program that runs on a file server,workstation, or mainframe that allows administrators to control and monitor the serverthrough administrative commands.

You can start an administrative client session in one of four modes:

v Console mode (not supported on AS/400)

v Mount mode (not supported on AS/400)

v Batch mode

v Interactive mode

In each of these modes, you can specify certain options with commands. For details,see “Using the AS/400 Administrative Client Options” on page 14.

Using the AS/400 Administrative Client

The AS/400 administrative client supports all TSM administrative functions, with theexception of console and mount modes. The AS/400 administrative client runs on a5250 emulation session and uses APPC and TCP/IP communication.

Although console and mount modes are not supported with the AS/400 administrativeclient, you can simulate console and mount modes by using the change server optionscommand, CHGSVRADSM. When you specify the CSLMSGQ option, consolemessages are sent to the specified message queue. If you specify the MNTMSGQoption, mount messages are sent to the specified message queue. These messagescan then be viewed immediately.

Starting the AS/400 Administrative Client

You will be issuing administrative commands from an administrative client to customizeyour server. There are several ways to start the AS/400 administrative client:

v From the TSM menu interface (access by entering go adsm)

v From the AS/400 command line

v From an AS/400 batch job

Starting the AS/400 Administrative Client from the TSM Menu: To start theadministrative client:

1. At the command line, enter:


|

go adsm

2. Select Start administrative client

3. Enter your administrator name and password. If authentication is turned on and youdo not enter a password, you will be prompted for one.

4. Enter your administrative commands.

Starting the AS/400 Administrative Client from the Command Line: From theAS/400 command line, you can enter the STRADMADSM command to start the AS/400administrative client.

Starting the AS/400 Administrative Client in a Batch Job: You can run the AS/400administrative client in batch mode from an AS/400 batch job. For example, theSTRADMADSM command can be started from a CL program running in the batchsubsystem. The ADMINNAME and PASSWORD parameters of the STRADMADSMcommand are required when submitting the AS/400 administrative client in a batch job.You should also specify either a macro or administrative command. If the OUTFILEparameter is not specified, the output is written to a qprint spooled file.

The following example starts the AS/400 administrative client in a batch job and issuesadministrative commands specified in the QUSRADSM/QCSRC(MACFILE). Thecommand output is sent to a qprint file. To view the output, use WRKSPLF.

SBMJOB CMD(STRADMADSM ADMINNAME(adsmadmin) PASSWORD(adsmadmin)WRKLIB(qusradsm) MACINF(qusradsm/qcsrc) MACINMBR(macfile))

Using Administrative Client Options

Regardless of whether you are using the AS/400 administrative client or another client,such as OS/2, the options you specify affect the client response. The parameters areimplemented differently, but produce the same results.

Using the AS/400 Administrative Client Options

There are several parameters on the STRADMADSM command that can be used tomodify your administrative client session responses. These parameters have the sameresults as options specified on other administrative client platforms, but they use theAS/400 notation.

ADMINNAMESpecifies the TSM administrator’s user ID. This option is equivalent to the -IDoption on other administrative client platforms.

PASSWORDSpecifies the TSM administrator’s password.

COMMANDSpecifies a valid administrative command.

CONFIRMSpecifies whether you want TSM to request confirmation before executing


commands that affect the availability of the server or data managed by the server.Valid values are *YES and *NO. The default is *YES.

This option is equivalent to the -NOConfirm option on other administrative clientplatforms.

ITEMCOMMITSpecifies whether you want TSM to commit commands inside a macro as eachcommand is executed. Valid values are *YES and *NO. The default is *NO.

This option is equivalent to the -Itemcommit option on other administrative clientplatforms.

MACINFSpecifies the macro input file that contains one or more TSM administrativecommands.

MACINMBRSpecifies the name of the macro input file member.

OUTFILESpecifies that you want TSM to write all terminal output to a specified file.

OUTMBRSpecifies the output file member.

QUIETSpecifies that TSM does not display standard output messages to your screen.Valid values are *YES and *NO. The default is *NO.

This option is equivalent to the -Quiet option on other platforms.

Using Continuation Characters

Some platforms support continuation characters like dashes or back slashes.Continuation characters are supported on administrative clients such as AIX and OS/2.

You can use continuation characters in a macro file. Continuation characters are usefulwhen you want to execute a command that is longer than your screen or window width.

Attention: Without continuation characters you can enter up to 256 characters. Withcontinuation characters you can enter up to 1500 characters. In the MACRO command,these maximums are after any substitution variables have been applied.

With continuation characters, you can do the following:

v Enter a dash or a back slash at the end of the line you want to continue.

For example:

REGister Admin pease mypasswd -CONtact="David, ext1234"

v Continue a list of values by entering a dash or a back slash, with no preceding blankspaces, after the last comma of the list that you enter on the first line. Then, enterthe remaining items in the list on the next line with no preceding blank spaces. Forexample:

Chapter 3. Using the Command-Line Interface 15

STGpools=stg1,stg2,stg3,-stg4,stg5,stg6

v Continue a string of values enclosed in quotation marks by entering the first part ofthe string enclosed in quotation marks, followed by a dash or a back slash at the endof the line. Then, enter the remainder of the string on the next line enclosed in thesame type of quotation marks. For example:

CONtact="DAVID PEASE, BLDG. 100, ROOM 2B, SAN JOSE, "-"EXT. 1234, ALTERNATE CONTACT-NORM PASS, EXT. 2345"

TSM concatenates the two strings with no intervening blanks. You must use only thismethod to continue a quoted string of values across more than one line.

Using Console Mode

In console mode, you can monitor basic server activities as they occur. For example,you can monitor migration processes and clients logging on to TSM.

Although the console mode option is not supported on the AS/400 administrative client,you can simulate console mode by specifying the CSLMSGQ option (console messagequeue) using the change server options command, CHGSVRADSM. The informationcan be viewed by entering the DSPMSG command.

You can turn off the console message queue by setting the CSLMSGQ parameter(option) to *NONE using the CHGSVRADSM command.

Using Mount Mode

Although the mount mode option is not supported on the AS/400 administrative client,you can simulate mount mode by specifying the MNTMSGQ option (mount messagequeue) using the change server options command, CHGSVRADSM. When this option isspecified, mount messages are sent to the specified message queue and thesemessages can then be viewed immediately.

You can turn off the mount message queue by setting the MNTMSGQ parameter(option) to *NONE using the CHGSVRADSM command.

Using Batch Mode

Use batch mode for your administrative client session to enter a single administratorcommand or a MACRO command. Your administrative client session automatically endswhen the command or macro has executed. Also, if you want to use single quotationmarks in batch mode, you must use them inside a macro file.

The following examples invoke the administrative client in batch mode:

v To issue the VARY command, enter:

stradmadsm adminname(adsmadmin) password(adsmadmin) wrklib(qusradsm)command('vary')


v To use the CONFIRM option to have TSM perform the DELETE DOMAIN commandwithout prompting you for confirmation, enter:

stradmadsm adminname(sullivan) password(secret) wrklib(qusradsm)command('delete domain domain1') confirm(*no)

You can enter any of the other DSMADMC command options (exceptCONSOLEMODE or MOUNTMODE) that you want to use.

v To route the output to the client session, enter:

stradmadsm adminname(adsmadmin) password(adsmadmin) wrklib(qusradsm)command('q node')

v To issue administrative commands specified in the QUSRADSM/QCSRC(MACFILE),enter:

stradmadsm adminname(adsmadmin) password(adsmadmin) wrklib(qusradsm)macinf(qusradsm/qcsrc) macinmbr(macfile)

The command output appears on the client session.

Using Interactive Mode

Use interactive mode for your administrative client session when you want to enter aseries of administrative commands. To start an administrative client session ininteractive mode, a server session must be available. The interactive mode of theadministrative client is disconnected if one or more of the following conditions is true:

v The server was stopped using the HALT command.

v The administrative client session did not issue any commands for at least 15minutes. On an AS/400 administrative client, you can specify a different time periodusing the CLTCNN option of the CHGSVRADSM command.

v The administrative client session was canceled with the CANCEL SESSIONcommand.

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

stradmadsm adminname(adsmadmin) password(adsmadmin) wrklib(qusradsm)

Command processing can be stopped by either canceling the existing client session orstopping and then restarting the client program. To end an administrative client sessionin interactive mode, use the QUIT command or select PF3 to exit the administrativeclient session.

Chapter 3. Using the Command-Line Interface 17

Chapter 4. Using Commands Based on Privilege Class

In TSM there are five administrator privilege classes:

v System

v Policy

v Storage

v Operator

v Analyst

The authority granted to an administrator determines the administrative commands thatthe administrator can issue. After an administrator has been registered via theREGISTER ADMIN command, the administrator can issue a limited set of commands,including all query commands. When you install TSM a system administrator ID ofADSMADMIN is available. The password in ADSMADMIN.

The following sections describe each type of administrator privilege and the commandsthat can be issued by an administrator who has been granted the correspondingauthority.

Commands Requiring System Privilege

An administrator with system privilege has the highest level of authority in TSM. Withsystem privilege, an administrator can issue any administrative command and hasauthority to manage all policy domains and all storage pools.

Table 5 on page 20 lists the commands that only administrators with system privilegecan issue.


Table 5. System Privilege Commands

AUDIT LICENSES

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 CLIENTACTION

DEFINE CLOPTSET

DEFINE DOMAIN

DEFINE DRIVE

DEFINE EVENTSERVER

DEFINE EXIT

DEFINE GRPMEMBER

DEFINE LIBRARY

DEFINE MACHINE



DEFINE PROFILE



DEFINE SCHEDULE (See note.)

DEFINE SCRIPT

DEFINE SERVER

DEFINE SERVERGROUP

DEFINE SPACETRIGGER

DEFINE STGPOOL

DEFINE SUBSCRIPTION

DELETE CLIENTOPT

DELETE CLOPTSET

DELETE DOMAIN

DELETE EVENTSERVER

DELETE EXIT

DELETE GRPMEMBER

DELETE MACHINE



DELETE PROFILE

DELETE RECMEDMACHASSOCIATION


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

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


|

||

|

|

||

|

||

|

|

|

||

|

||

||

|

|||

Table 5. System Privilege Commands (continued)

RECONCILE VOLUMES

REGISTER ADMIN

REGISTER LICENSE

REMOVE ADMIN

RENAME ADMIN

RENAME SCRIPT

RENAME SERVERGROUP

RENAME STGPOOL

REVOKE AUTHORITY

RUN

SET ACCOUNTING

SET ACTLOGRETENTION

SET AUTHENTICATION


SET CONFIGMANAGER

SET CONFIGREFRESH

SET CROSSDEFINE

SET DRMCHECKLABEL

SET DRMCOPYSTGPOOL

SET DRMCOURIERNAME


SET DRMCMDFILENAME

SET DRMFILEPROCESS

SET DRMINSTRPREFIX

SET DRMNOTMOUNTABLENAME

SET DRMPLANPREFIX

SET DRMPLANVPOSTFIX

SET DRMPRIMSTGPOOL

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 WEBAUTHTIMEOUT

SETOPT

UNLOCK ADMIN

UNLOCK PROFILE

UPDATE ADMIN

UPDATE CLIENTOPT

UPDATE CLOPTSET

UPDATE EXIT

UPDATE LIBVOLUME

UPDATE MACHINE

UPDATE PROFILE


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 policy privilegeis required for client operation schedules.

Commands Requiring Policy Privilege

An 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 manage dependon the authority granted to them by an administrator with system privilege.

Chapter 4. Using Commands Based on Privilege Class 21

|||

|

|||

||

||

|

|

|

||

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

Unrestricted policy privilege permits you to issue all of the administrator commands thatrequire policy privilege. You can issue commands that affect all existing policy domainsas well as any policy domains that are defined in the future. An unrestricted policyadministrator cannot define, delete, or copy policy domains.

Restricted policy privilege permits you to issue administrator commands that affect oneor more policy domains for which you have been explicitly granted authority. Forexample, the DELETE MGMTCLASS command requires you to have policy privilege forthe 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

COPY MGMTCLASS

COPY POLICYSET

COPY SCHEDULE (See note 2.)

DEFINE ASSOCIATION

DEFINE COPYGROUP

DEFINE CLIENTACTION

DEFINE MGMTCLASS

DEFINE POLICYSET

DEFINE SCHEDULE

DELETE ASSOCIATION

DELETE COPYGROUP

DELETE EVENT (See note 1.)

DELETE FILESPACE

DELETE MGMTCLASS

DELETE POLICYSET

DELETE SCHEDULE (See note 2.)

LOCK NODE

REGISTER NODE

REMOVE NODE

RENAME FILESPACE

RENAME NODE

UNLOCK NODE

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 domain can issuethis command.

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


Commands Requiring Storage Privilege

An administrator with storage privilege can issue commands that allocate and controlstorage resources for the server. The commands that an administrator can issuedepend on the authority granted to them by and administrator with system privilege. Asan administrator with storage privilege, you can have unrestricted or restricted storageprivilege.

Unrestricted storage privilege permits you to issue all of the administrator commandsthat require storage privilege. You can issue commands that affect all existing storagepools as well as any storage pools that are defined in the future. You can also issuecommands that affect the database and the recovery log. An unrestricted storageadministrator cannot define or delete storage pools.

Restricted storage privilege permits you to issue administrator commands that onlyaffect a storage pool for which you have been granted authority. For example, theDELETE VOLUME command only affects a storage pool volume that is defined to aspecific storage pool.

Table 7 lists the commands an administrator with storage privilege can issue.

Table 7. Storage Privilege Commands

AUDIT LIBRARY

AUDIT VOLUME (See note.)

BACKUP DB

BACKUP DEVCONFIG

BACKUP STGPOOL

BACKUP VOLHISTORY

CHECKIN LIBVOLUME

CHECKOUT LIBVOLUME

DEFINE DBBACKUPTRIGGER

DEFINE DBCOPY

DEFINE DBVOLUME

DEFINE DEVCLASS

DEFINE DRIVE

DEFINE LIBRARY

DEFINE LOGCOPY

DEFINE LOGVOLUME

DEFINE VOLUME (See note.)

DEFINE SPACETRIGGER

DELETE DBBACKUPTRIGGER

DELETE DBVOLUME

DELETE DEVCLASS

DELETE DRIVE

DELETE LIBRARY

DELETE LOGVOLUME

DELETE SPACETRIGGER

DELETE VOLHISTORY

DELETE VOLUME (See note.)

EXTEND DB

EXTEND LOG

MOVE DATA (See note.)

REDUCE DB

REDUCE LOG

RESTORE STGPOOL

RESTORE VOLUME

UPDATE DBBACKUPTRIGGER

UPDATE DEVCLASS

UPDATE DRIVE

UPDATE LIBRARY

UPDATE SPACETRIGGER

UPDATE STGPOOL (See note.)

Note: Indicates that this command can be restricted by storage pool. An administrator withunrestricted storage privilege or restricted storage privilege for a specified storage pool can issuethis command.


|

|

|

Commands Requiring Operator Privilege

An administrator with operator privilege can issue commands that control the immediateoperation of the server and the availability of storage media.

Table 8 lists the commands an administrator with operator privilege can issue.

Table 8. Operator Privilege Commands

CANCEL SESSION

DISABLE SESSIONS

DISMOUNT VOLUME

ENABLE SESSIONS

HALT

MOVE DRMEDIA

REPLY

UPDATE VOLUME

VARY

Commands Requiring Analyst Privilege

An administrator with analyst privilege can issue commands that reset the counters thattrack server statistics.

Table 9 lists the commands an administrator with analyst privilege can issue.

Table 9. Analyst Privilege Commands

RESET BUFPOOL

RESET DBMAXUTILIZATION

RESET LOGCONSUMPTION

RESET LOGMAXUTILIZATION


Commands Any Administrator Can Issue

Table 10 lists the commands any registered administrator can issue even if thatadministrator has not been granted any specific administrator privileges.

Table 10. Commands Issued by All Administrators

COMMIT

HELP

MACRO

QUERY ACTLOG

QUERY ADMIN

QUERY ASSOCIATION

QUERY AUDITOCCUPANCY

QUERY CONTENT

QUERY COPYGROUP

QUERY DB

QUERY DBBACKUPTRIGGER

QUERY DBVOLUME

QUERY DEVCLASS

QUERY DOMAIN

QUERY DRIVE

QUERY DRMEDIA

QUERY DRMSTATUS

QUERY ENABLED

QUERY EVENT

QUERY EVENTRULES

QUERY EVENTSERVER

QUERY EXIT

QUERY FILESPACE

QUERY LICENSE

QUERY LIBRARY

QUERY LIBVOLUME

QUERY LOG

QUERY LOGVOLUME

QUERY MGMTCLASS

QUERY MOUNT

QUERY NODE

QUERY OCCUPANCY

QUERY OPTION

QUERY POLICYSET

QUERY PROCESS

QUERY PROFILE

QUERY RECOVERYMEDIA

QUERY REQUEST

QUERY RESTORE

QUERY SCHEDULE

QUERY SCRIPT

QUERY SERVER

QUERY SERVERGROUP

QUERY SESSION

QUERY SPACETRIGGER

QUERY SQLSESSION

QUERY STATUS

QUERY STGPOOL

QUERY SUBSCRIBER

QUERY SUBSCRIPTION

QUERY SYSTEM

QUERY VOLHISTORY

QUERY VOLUME

QUIT

ROLLBACK

SELECT


SET SQLDISPLAYMODE

SET SQLMATHMODE


|

|

|

|

||

Chapter 5. Using Administrator Commands

This chapter describes the ADSM administrator commands.

Information for each command includes:

v A description of the tasks a command performs

v The administrator privilege class required to use the command

v A syntax diagram that identifies the required and optional parameters for thecommand

v Descriptions of each parameter of the command

v Usage notes (when appropriate)

v Examples of using the command

v A list of related commands


ACCEPT DATE (Accepts the Current System Date)

Use this command to cause the server to accept the current date as valid when aninvalid date is detected. An invalid date can be one that is earlier than the serverinstallation date and time. When TSM detects an invalid date, server sessions becomedisabled (as if the DISABLE SESSIONS command had been issued). Consequently,expiration, migration, reclamation, and volume history deletion operations are not ableto continue processing.

Use the ENABLE SESSIONS command after you issue this command to re-enable theserver for client node activity.

Privilege Class

To issue this command, you must have system privilege.

Syntax

ÊÊ ACCept Date ÊÍ

Parameters

None.

Examples

Task

Allow the server to accept the current date as the valid date.

Command:accept date

Related Commands

Table 11. Command Related to ACCEPT DATE

Command Description

ENABLE SESSIONS Resumes server activity following the DISABLEcommand.

ACCEPT DATE


||

||||||

||

|

|

|

||||||||

|

|

|

|

|

|

||

|

|||

||

|||

|

ACTIVATE POLICYSET (Activate a New Policy Set)

Use this command to copy the contents of a policy set to the ACTIVE policy set for thedomain. The server uses the rules in the ACTIVE policy set to manage client operationsin the domain. You can define multiple policy sets for a policy domain, but only onepolicy set can be active. The current ACTIVE policy set is replaced by the one youspecify when you issue this command. You can modify the ACTIVE policy set only byactivating another policy set.

Before activating a policy set, check that the policy set is complete and valid by usingthe VALIDATE POLICYSET command.

The ACTIVATE POLICYSET command fails if the following conditions exist:

v A copy group specifies a copy storage pool as a destination.

v A management class specifies a copy storage pool as the destination forspace-managed files.

v The policy set has no default management class.

The ACTIVE policy set and the last activated policy set are not necessarily identical.You can modify the original policy set that you activated without affecting the ACTIVEpolicy set.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege for the policy domain to which the policy set belongs.

Syntax

ÊÊ ACTivate POlicyset domain_name policy_set_name ÊÍ

Parametersdomain_name (Required)

Specifies the policy domain for which you want to activate a policy set.

policy_set_name (Required)Specifies the policy set to activate.

Examples

Task

Activate the VACATION policy set in the EMPLOYEE_RECORDS policy domain.

Command:activate policyset employee_records vacation

ACTIVATE POLICYSET

Chapter 5. Using Administrator Commands 29

Related Commands

Table 12. Commands Related to ACTIVATE POLICYSET

Command Description

COPY POLICYSET Creates a copy of a policy set.

DEFINE POLICYSET Defines a policy set within the specified policydomain.

DELETE POLICYSET Deletes a policy set, including its managementclasses and copy groups, from a policy domain.

QUERY DOMAIN Displays information about policy domains.

QUERY POLICYSET Displays information about policy sets.

UPDATE POLICYSET Changes the description of a policy set.

VALIDATE POLICYSET Verifies and reports on conditions theadministrator must consider before activating thepolicy set.

ACTIVATE POLICYSET


ASSIGN DEFMGMTCLASS (Assign a Default Management Class)

Use this command to specify a management class as the default management class fora policy set. You must assign a default management class for a policy set before youcan activate that policy set. To ensure clients can always back up and archive files,choose a default management class that contains both an archive copy group and abackup copy group.

The server uses the default management class to manage client files when amanagement class is not otherwise assigned or appropriate. For example, the serveruses the default management class when a user does not specify a management classin the include-exclude list. See Administrator’s Guide for details.

Privilege Class


Syntax

ÊÊ ASsign DEFMGmtclass domain_name policy_set_name class_name ÊÍ


Specifies the policy domain to which the management class belongs.

policy_set_name (Required)Specifies the policy set for which you want to assign a default management class.You cannot assign a default management class to the ACTIVE policy set.

class_name (Required)Specifies the management class that is to be the default management class for thepolicy set.

Examples

Task

Assign DEFAULT1 as the default management class for policy set SUMMER in thePROG1 policy domain.

Command:assign defmgmtclass prog1 summer default1

ASSIGN DEFMGMTCLASS


Related Commands

Table 13. Commands Related to ASSIGN DEFMGMTCLASS

Command Description

ACTIVATE POLICYSET Validates and activates a policy set.

COPY MGMTCLASS Creates a copy of a management class.

DEFINE COPYGROUP Defines a copy group for backup or archiveprocessing within a specified managementclass.

DEFINE MGMTCLASS Defines a management class.


DELETE MGMTCLASS Deletes a management class and its copygroups from a policy domain and policy set.

QUERY COPYGROUP Displays the attributes of an existing copygroup.

QUERY MGMTCLASS Displays information about managementclasses.


UPDATE COPYGROUP Changes one or more attributes of a copygroup.

UPDATE MGMTCLASS Changes the attributes of a management class.


ASSIGN DEFMGMTCLASS


AUDIT LIBRARY (Verify an Automated Library’s Inventory)

Use this command to ensure that the server’s library volume inventory is consistent withthe volumes that are physically located in an automated library. If TSM detectsinconsistencies, the server updates its inventory to reflect the current state of the library.TSM deletes missing volumes and updates moved volume locations. TSM does notautomatically add new volumes; you must check in new volumes with the CHECKINLIBVOLUME command.

This command prevents any other activity with the library until this background processcompletes. For example, no restore or retrieve requests that involve this library processwhile this command runs.

Privilege Class

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

Syntax

ÊÊ AUDIT LIBRary library_name ÊÍ

Parameterslibrary_name (Required)

Specifies the name of the library to audit.

Examples

Task

Ensure that the EZLIFE automated library agrees with the TSM server’s library volumeinventory.

Command:audit library ezlife

Related Commands

Table 14. Commands Related to AUDIT LIBRARY

Command Description

CANCEL PROCESS Cancels a background server process.

DEFINE LIBRARY Defines an automated or manual library.

DELETE LIBRARY Deletes a library.

DISMOUNT VOLUME Dismounts a sequential, removable volume bythe volume name.

AUDIT LIBRARY


Table 14. Commands Related to AUDIT LIBRARY (continued)

Command Description

QUERY LIBRARY Displays information about one or more libraries.

QUERY LIBVOLUME Displays information about a library volume.

QUERY PROCESS Displays information about backgroundprocesses.

UPDATE LIBRARY Changes the attributes of a library.

AUDIT LIBRARY


AUDIT LICENSES (Audit Server Storage Usage)

Use this command to audit the server storage used by client nodes and to audit theserver licenses. The audit determines whether the current configuration is in compliancewith the license terms.

An audit creates a background process you can cancel with the CANCEL PROCESScommand. If you halt and restart the server, an audit is run automatically as specifiedby the SET LICENSEAUDITPERIOD. To view audit results, use the QUERY LICENSEcommand.

Attention: The audit of server storage can take a lot of CPU time. You can use theAUDITSTORAGE server option to specify that storage is not to be audited.

Privilege Class


Syntax

ÊÊ AUDit LICenses ÊÍ

Parameters

None.

Examples

Task

Issue the AUDIT LICENSES command.

Command:audit licenses

Related Commands

Table 15. Commands Related to AUDIT LICENSES

Command Description


QUERY AUDITOCCUPANCY Displays the server storage utilization for a clientnode.

QUERY LICENSE Displays information about licenses and audits.


AUDIT LICENSES


Table 15. Commands Related to AUDIT LICENSES (continued)

Command Description

QUERY STATUS Displays the settings of server parameters, suchas those selected by the SET commands.

REGISTER LICENSE Registers a new license with the TSM server.

SET LICENSEAUDITPERIOD Specifies the number of days betweenautomatic license audits.

AUDIT LICENSES


AUDIT VOLUME (Verify Database Information for a Storage Pool Volume)

Use this command to check for inconsistencies between database information and astorage pool volume. During the audit, the server sends processing information to theactivity log and the server console.

While an audit process is active, clients cannot restore data from the specified volumeor store new data to that volume.

If the server detects a file with errors, handling of the file will depend on the type ofstorage pool to which the volume belongs, whether the FIX option is specified on thiscommand, and whether the file is also stored on a volume assigned to other pools.

You cannot audit a volume if it is being deleted from a primary or copy storage pool.

If TSM does not detect errors for a file that was marked as damaged, the state of thefile is reset so that the file can be used.

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

Privilege Class

To issue this command, you must have system privilege, unrestricted storage privilege,or restricted storage privilege for the storage pool to which the volume is defined.

Syntax

ÊÊ AUDit Volume volume_nameFix = No

Fix = NoYes

SKIPPartial = No

SKIPPartial = NoYes

Ê

ÊQuiet = No

Quiet = NoYes

ÊÍ

Parametersvolume_name (Required)

Specifies the name of the storage pool volume you want to audit.

FixSpecifies how TSM resolves inconsistencies between the database inventory andthe specified storage pool volume. This parameter is optional. The default is NO.

AUDIT VOLUME


The actions TSM performs depend on whether the volume is assigned to a primaryor a copy storage pool.

Primary Storage Pool:

Fix=NoTSM reports, but does not delete, database records that refer to files withinconsistencies:

v TSM marks the file as damaged in the database. If a backup copy is storedin a copy storage pool, you can restore the file using the RESTOREVOLUME or RESTORE STGPOOL command.

v If the file is a cached copy, you must delete references to the file on thisvolume by issuing the AUDIT VOLUME command and specifying FIX=YES.If the physical file is not a cached copy, and a duplicate is stored in a copystorage pool, it can be restored by using the RESTORE VOLUME orRESTORE STGPOOL command.

If the AUDIT VOLUME command does not detect an error in a file that hadpreviously been marked as damaged, the state of the file is reset so that thefile can be used. This provides a means for resetting the state of damagedfiles if it is determined that the errors were caused by correctable hardwareproblems such as a dirty tape head.

Fix=YesTSM fixes any inconsistencies as they are detected:

v If the physical file is a cached copy, TSM deletes the database records thatrefer to the cached file. The primary file is stored on another volume.

v If the physical file is not a cached copy, and the file is also stored in one ormore copy storage pools, the error will be reported and the physical filemarked as damaged in the database. You can restore the physical file byusing the RESTORE VOLUME or RESTORE STGPOOL command.

v If the physical file is not a cached copy, and the physical file is not stored ina copy storage pool, each logical file for which inconsistencies are detectedare deleted from the database.

If the AUDIT VOLUME command does not detect an error in a file that waspreviously marked as damaged, TSM resets the state of the file so that it canbe used. This provides a means for resetting the state of damaged files if it isdetermined that the errors were caused by correctable hardware problemssuch as a dirty tape head.

Note: Do not use the AUDIT VOLUME command with FIX=YES if a restoreprocess (RESTORE STGPOOL or RESTORE VOLUME) is running. TheAUDIT VOLUME command could cause the restore to be incomplete.

Copy Storage Pool:

Fix=NoTSM reports the error and marks the physical file copy as damaged in thedatabase.

AUDIT VOLUME


Fix=YesTSM deletes any references to the physical file and any database records thatpoint to a physical file that does not exist.

SKIPPartialSpecifies whether TSM ignores skipped files, which are files that span multiplestorage pool volumes. This parameter is optional. The default value is NO. Whenperforming an audit operation on a sequential access media volume, this parameterprevents additional sequential access media mounts that may be necessary toaudit any skipped files. Possible values are:

No TSM audits files that span multiple volumes.

Unless you specify SKIPPARTIAL=YES, TSM attempts to process each filestored on the volume, including files that span into and out of other volumes.To audit files that span multiple volumes, the following conditions must be true:

v For sequential access volumes, the additional sequential access volumesmust have an access mode of read/write or read-only.

v For random access volumes, the additional volumes must be online.

YesTSM audits only files that are stored on the volume to be audited. The statusof any skipped files is unknown.

QuietSpecifies whether TSM sends detailed informational messages to the activity logand the server console about irretrievable files on the volume. This parameter isoptional. The default is NO. Possible values are:

No Specifies that TSM sends detailed informational messages and a summary.Each message contains the node, file space, and client name for the file.

YesSpecifies that TSM sends only a summary report.

Examples

Task

Verify that the database information for storage pool volume PROG2 is consistent withthe data stored on the volume. TSM fixes any inconsistencies.

Command:audit volume prog2 fix=yes

Related Commands

Table 16. Commands Related to AUDIT VOLUME

Command Description


QUERY CONTENT Displays information about files in a storagepool volume.

AUDIT VOLUME


Table 16. Commands Related to AUDIT VOLUME (continued)

Command Description


QUERY VOLUME Displays information about storage poolvolumes.

AUDIT VOLUME


BACKUP DB (Back Up the Database)

Use this command to back up a TSM database to sequential access volumes.

To determine how much additional storage space a backup will require, use the QUERYDB command. That command displays the database pages, in megabytes, that havechanged since the last backup.

The DEVCFGFILE server option in the CHGSVRADSM command lets you specify a filein a different library and create additional backup device configuration files. When youuse this option, the files specified are automatically updated whenever a device class,library, or drive is defined. After the server is restarted, TSM updates deviceconfiguration information in the database, and also updates the same information in thebackup files.

Privilege Class


Syntax

ÊÊ BAckup DB DEVclass = device_class_nameType = Incremental

Type = IncrementalFull

Ê

Ê

·

,

VOLumenames = volume_namefile_name

Scratch = Yes

Scratch = YesNo

Ê

ÊWait = No

Wait = NoYes

ÊÍ

ParametersDEVclass (Required)

Specifies the name of the sequential access device class to use for the backup.

If all drives for this device class are busy when the backup runs, TSM cancelslower priority operations, such as reclamation, to make a drive available for thebackup.

BACKUP DB


TypeSpecifies the type of backup to run. This parameter is optional. The default isINCREMENTAL. Possible values are:

IncrementalSpecifies that you want to run an incremental backup of the TSM database.The maximum number of incremental backups you can run between fullbackups is 32.

FullSpecifies that you want to run a full backup of the TSM database.

VOLumenames

Specifies the volumes used to back up the database. This parameter is optional.However, if you specify SCRATCH=NO, you must specify a list of volumes.

volume_nameSpecifies the volumes used to back up the database. Specify multiple volumesby separating the names with commas and no intervening spaces.

FILE:filenameSpecifies the name of a file that contains a list of volumes used to back up thedatabase. Each volume name must be on a separate line. Blank lines andcomment lines, which begin with an asterisk, are ignored.

For example, to use volumes DB0001, DB0002, and DB0003, create a filenamed TAPEVOL that contains these lines:

DB0001DB0002DB0003

You can then specify the volumes for the command as follows:

VOLUMENAMES=FILE:QUSRADSM/TAPEVOL

ScratchSpecifies whether scratch volumes can be used for the backup. This parameter isoptional. The default is YES. Possible values are:

YesSpecifies that scratch volumes can be used.

If you specify SCRATCH=YES and the VOLUMENAMES parameter, TSM usesscratch volumes only if space is unavailable on the specified volumes.

If you do not include a list of volumes by using the VOLUMENAMESparameter, you must either specify SCRATCH=YES or use the default.

No Specifies that scratch volumes cannot be used.

If you specify volumes by using the VOLUMENAMES parameter andSCRATCH=NO, the backup will fail if not enough space is available to storethe backup data on the specified volumes.

BACKUP DB


WaitSpecifies whether to wait for the server to complete processing this command inthe foreground. The default is NO. Possible values are:

No Specifies that the server processes this command in the background. You cancontinue with other tasks while the command is being processed. Messagescreated from the background process are displayed either in the activity log orthe server console, depending on where messages are logged.

To cancel a background process, use the CANCEL PROCESS command. If aBACKUP DB background process is canceled, some of the database mayhave already been backed up before the cancellation.

YesSpecifies that the server processes this command in the foreground. You waitfor the command to complete before continuing with other tasks. The serverthen displays the output messages to the administrative client when thecommand completes.

Examples

Task

Run an incremental backup of the database using a scratch volume. Assume a deviceclass of FILE for the backup.

Command:backup db devclass=file type=incremental

Related Commands

Table 17. Commands Related to BACKUP DB

Command Description

BACKUP DEVCONFIG Backs up TSM device information to a file.

BACKUP VOLHISTORY Records volume history information in externalfiles.


DEFINE DBBACKUPTRIGGER Defines a trigger for automatic TSM databasebackups.

DELETE VOLHISTORY Removes sequential volume history informationfrom the volume history file.

QUERY DB Displays allocation information about thedatabase.

QUERY DBBACKUPTRIGGER Displays information about the database backuptrigger.


QUERY VOLHISTORY Displays sequential volume history informationthat has been collected by the server.

BACKUP DB


Table 17. Commands Related to BACKUP DB (continued)

Command Description

SET LOGMODE Sets the mode for saving records in therecovery log.

STRRSTADSM Start restore for TSM

UPDATE DBBACKUPTRIGGER Changes one or more attributes of the databasebackup trigger.

BACKUP DB


BACKUP DEVCONFIG (Create Backup Copies of Device ConfigurationInformation)

Use this command to back up the following information in one or more files:

v Device class definitions

v Library definitions

v Drive definitions

To restore the TSM database, device configuration information must be available.

The DEVCFGFILE server option in the CHGSVRADSM command lets you specify a filein a different library and create additional backup device configuration files. After theserver is restarted, TSM updates device configuration information in the database andin the backup files. TSM then updates the files whenever a device class, library, or driveis defined.

Privilege Class


Syntax

ÊÊ BAckup DEVCONFig

·

,

Filenames= filename

ÊÍ

ParametersFilenames

Specifies the files in which to store device configuration information. You canspecify multiple files by separating the names with commas and no interveningspaces. This parameter is optional.

If you do not specify a file name, TSM stores the information in all files specifiedwith the DEVCONFIG option in the server options file.

Examples

Task

Back up device configuration information to a file named DEVICE.

Command:

BACKUP DEVCONFIG


Related Commands

Table 18. Commands Related to BACKUP DEFCONFIG

Command Description

DEFINE DEVCLASS Defines a device class.

DEFINE DRIVE Assigns a drive to a library.


UPDATE DEVCLASS Changes the attributes of a device class.

UPDATE DRIVE Changes the attributes of a drive.


BACKUP DEVCONFIG


BACKUP STGPOOL (Back Up Primary Storage Pool to Copy Storage Pool)

Use this command to back up primary storage pool files to a copy storage pool. If a filealready exists in the copy storage pool, the file is not backed up unless the copy ismarked damaged. However, a new copy is not created if the file in the primary storagepool is also marked damaged. In a random-access storage pool, neither cached copiesof migrated files nor damaged primary files are backed up.

If migration for a storage pool starts during a storage pool backup, some files may bemigrated before they are backed up. You may want to back up storage pools that arehigher in the migration hierarchy before backing up storage pools that are lower.

Privilege Class

To issue this command, you must have system privilege, unrestricted storage privilege,or restricted storage privilege for the copy storage pool in which backup copies are tobe produced.

Syntax

ÊÊ BAckup STGpool primary_pool_name copy_pool_nameMAXPRocess = 1

MAXPRocess = numberÊ

ÊPreview = No

Preview = NoYes

(1)VOLumesonly

Wait = No

Wait = NoYes

ÊÍ

Notes:

1 Applies only to sequential storage pools.

Parametersprimary_pool (Required)

Specifies the primary storage pool.

copy_pool (Required)Specifies the copy storage pool.

MAXPRocessSpecifies the maximum number of parallel processes to use for backing up files.Using multiple, parallel processes may improve throughput for the backup. Thisparameter is optional. Enter a value from 1 to 999. The default is 1.

When determining this value, consider the number of logical and physical drivesthat can be dedicated to this operation. To access a sequential access volume,

BACKUP STGPOOL


TSM uses a mount point and, if the device type is not FILE, a physical drive. Thenumber of available mount points and drives depends on other TSM and systemactivity and on the mount limits of the device classes for the sequential accessstorage pools that are involved in the backup.

Each process needs a mount point for copy storage pool volumes, and, if thedevice type is not FILE, each process also needs a drive. If you are backing up asequential storage pool, each process needs an additional mount point for primarystorage pool volumes and, if the device type is not FILE, an additional drive. Forexample, suppose you specify a maximum of 3 processes to back up a primarysequential storage pool to a copy storage pool of the same device class. Eachprocess requires 2 mount points and 2 drives. To run all 3 processes, the deviceclass must have a mount limit of at least 6, and at least 6 mount points and 6drives must be available.

To preview a backup, only one process is used and no mount points or drives areneeded.

PreviewSpecifies if you want to preview but not perform the backup. The preview displaysthe number of files and bytes to be backed up and a list of the primary storagepool volumes that you must mount. This parameter is optional. The default is NO.Possible values are:

No Specifies that the backup is done.

YesSpecifies that you want to preview the backup but not do the backup.

VOLumesonlySpecifies that you want to preview the backup only as a list of the volumesthat must be mounted. This choice requires the least processing time.

WaitSpecifies whether to wait for the server to complete processing this command inthe foreground. This parameter is optional. The default is NO. Possible values are:

No Specifies that the server processes this command in the background.

You can continue with other tasks while the command is being processed.Messages created from the background process are displayed either in theactivity log or the server console, depending on where messages are logged.

To cancel a background process, use the CANCEL PROCESS command. Ifyou cancel this process, some files may have already been backed up prior tothe cancellation.

YesSpecifies that the server performs this operation in the foreground. You mustwait for the operation to complete before continuing with other tasks. Theserver displays the output messages to the administrative client when theoperation completes.

BACKUP STGPOOL


Examples

Task

Back up the primary storage pool named PRIMARY_POOL to the copy storage poolnamed COPYSTG.

Command:backup stgpool primary_pool copystg

Related Commands

Table 19. Commands Related to BACKUP STGPOOL

Command Description


MOVE DRMEDIA Moves DRM media onsite and offsite.

QUERY DRMEDIA Displays information about disaster recoveryvolumes.


QUERY STGPOOL Displays information about storage pools.

RESTORE STGPOOL Restores files to a primary storage pool fromcopy storage pools.

RESTORE VOLUME Restores files stored on specified volumes in aprimary storage pool from copy storage pools.

BACKUP STGPOOL


BACKUP VOLHISTORY (Save Sequential Volume History Information)

Use this command to back up sequential volume history information to one or morefiles. You can use volume history information when you reload the database and auditaffected storage pool volumes. If you cannot start the server, you can use the volumehistory file to query the database about these volumes. The volume history includesinformation about the following types of volumes:

v Database backup volumes

v Database dump volumes

v Export volumes

v The following sequential access storage pool volumes:

– Volumes added to storage pools

– Volumes reused through reclamation or MOVE DATA operations

– Volumes removed by using the DELETE VOLUME command or duringreclamation of scratch volumes

TSM updates volume history files whenever server sequential volume historyinformation is changed.

The VOLHSTFILE server option in the CHGSVRADSM command lets you specify a filein a different library and create additional backup volume history files. After the server isrestarted, whenever TSM updates volume information in the database, it also updatesthe same information in the backup files.

Privilege Class


Syntax

ÊÊ BAckup VOLHistory

·

,

Filenames= file_name

ÊÍ

ParametersFilenames

Specifies the names of one or more files in which to store a backup copy of volumehistory information. Separate multiple file names with commas and no interveningspaces. This parameter is optional.

If you do not specify a file name, TSM stores the information in all files specifiedwith the VOLHSTFILE parameter (option) using the CHGSRVADSM command.

BACKUP VOLHISTORY


Examples

Task

Back up the volume history information to a file called VOLHIST.

Command:

Related Commands

Table 20. Commands Related to BACKUP VOLHISTORY

Command Description


DELETE VOLUME Deletes a volume from a storage pool.


UPDATE VOLHISTORY Adds or changes location information for avolume in the volume history file.

BACKUP VOLHISTORY


BEGIN EVENTLOGGING (Begin Logging Events)

Use this command to begin logging events to one or more receivers. A receiver forwhich event logging has begun is an active receiver.

When the server is started, event logging automatically begins for the console andactivity log and for any receivers that are started automatically based on entries in theserver options file. You can use this command to begin logging events to receivers forwhich event logging is not automatically started at server startup. You can also use thiscommand after you have disabled event logging to one or more receivers.

Privilege Class


Syntax

ÊÊ BEGin EVentlogging

·

ALL

,

CONSOLEACTLOGEVENTSERVERFILETIVOLIUSEREXIT

ÊÍ

Parameters

Specify one or more receivers. You can specify multiple receivers by separating themwith commas and no intervening spaces. If you specify ALL or no receiver, loggingbegins for all receivers that are configured.

ALLSpecifies all receivers that are configured for event logging.

CONSOLESpecifies the server console as a receiver.

ACTLOGSpecifies the TSM activity log as a receiver.

EVENTSERVERSpecifies the event server as a receiver.

FILESpecifies a user file as a receiver.

TIVOLISpecifies the Tivoli Management Environment (TME) as a receiver.

BEGIN EVENTLOGGING


||

USEREXITSpecifies a user-written routine to which TSM writes information as a receiver.

Examples

Task

Begin logging events to the TSM activity log.

Command:begin eventlogging actlog

Related Commands

Table 21. Commands Related to BEGIN EVENTLOGGING

Command Description

DISABLE EVENTS Disables specific events for receivers.

ENABLE EVENTS Enables specific events for receivers.

END EVENTLOGGING Ends event logging to a specified receiver.

QUERY ENABLED Displays enabled or disabled events for aspecific receiver.

QUERY EVENTRULES Displays information about rules for server andclient events.


BEGIN EVENTLOGGING


CANCEL EXPIRATION (Cancel an Expiration Process)

Use this command to cancel a process that is running as a result of an inventoryexpiration operation.

Privilege Class


Syntax

ÊÊ CANcel EXPIration ÊÍ

Examples

Task

Cancel the process that was generated by an inventory expiration operation.

Command:cancel expiration

Related Commands

Table 22. Command Related to CANCEL EXPIRATION

Command Description


EXPIRE INVENTORY Manually starts inventory expiration processing.

CANCEL EXPIRATION


CANCEL PROCESS (Cancel an Administrative Process)

Use this command to cancel a background process started by an administrativecommand or by a process, such as storage pool migration.

The following commands 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

PREPARE

REDUCE DB

REDUCE LOG

RESTORE STGPOOL

RESTORE VOLUME

VARY

The following internal server operations generate background processes:

v Inventory expiration

v Migration

v Reclamation

To cancel a process, you must have the number, which you can obtain with the QUERYPROCESS command.

If the process to be cancelled is waiting for a sequential access volume to be mounted,the mount request is automatically cancelled.

Privilege Class


Syntax

ÊÊ CANcel PRocess process_number ÊÍ

CANCEL PROCESS


Parametersprocess_number (Required)

Specifies the number of the background process you want to cancel.

Examples

Task

Cancel background process number 3.

Command:cancel process 3

Related Commands

Table 23. Command Related to CANCEL PROCESS

Command Description


CANCEL PROCESS


CANCEL REQUEST (Cancel One or More Mount Requests)

Use this command to cancel one or more pending media mount requests. To cancel amount request, you need to know the request number assigned to the request. Thisnumber is included in the mount request message and can also be shown by using theQUERY REQUEST command.

Privilege Class

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

Syntax

ÊÊ CANcel REQuest request_numberALl PERManent

ÊÍ

Parametersrequest_number

Specifies the request number of the mount request to cancel.

ALlSpecifies to cancel all pending mount requests.

PERManentSpecifies that you want the server to flag the volumes for which you are cancelinga mount request as unavailable. This parameter is optional.

Examples

Task

Cancel request number 2.

Command:cancel request 2

Related Commands

Table 24. Commands Related to CANCEL REQUEST

Command Description

QUERY REQUEST Displays information about all pending mountrequests.

UPDATE VOLUME Updates the attributes of storage pool volumes.

CANCEL REQUEST


CANCEL RESTORE (Cancel a Restartable Restore Session)

Use this command to cancel a restartable restore session. You can cancel restoresessions in the active or restartable state. Any outstanding mount requests related tothis session are automatically cancelled.

To display restartable restore sessions, use the QUERY RESTORE command.

Privilege Class

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

Syntax

ÊÊ CANcel RESTore session_numberALl

ÊÍ

Parameterssession_number

Specifies the number for the restartable restore session. An active session is apositive number, and a restartable session is a negative number.

ALlSpecifies that all the restartable restore sessions are to be cancelled.

Examples

Task 1

Cancel all restore operations.

Command:cancel restore all

Related Commands

Table 25. Commands Related to CANCEL RESTORE

Command Description

QUERY RESTORE Displays information about restartable restoresessions.

CANCEL RESTORE


CANCEL SESSION (Cancel One or More Client Sessions)

Use this command to cancel existing administrative or client node sessions, and toforce an administrative or client node session off TSM. Any outstanding mount requestsrelated to this session are automatically cancelled. The client node must start a newsession to resume TSM activities.

If you cancel a session that is in the idle wait (IdleW) state, the client session isautomatically reconnected to the server when it starts to send data again.

If this command interrupts a process, such as backup or archive, the results of anyprocessing active at the time of interruption are rolled back and not committed to thedatabase.

Privilege Class


Syntax

ÊÊ CANcel SEssion session_numberALl

ÊÍ

Parameterssession_number

Specifies the number of the administrative or client node session that you want tocancel.

ALlSpecifies that all client node sessions are cancelled. You cannot use this parameterto cancel administrative client sessions.

Examples

Task

Cancel the client node session with NODEP (session 3).

Command:cancel session 3

CANCEL SESSION


Related Commands

Table 26. Commands Related to CANCEL SESSION

Command Description

DISABLE SESSIONS Prevents new clients from accessing TSM butpermits existing sessions to continue.

LOCK ADMIN Prevents an administrator from accessing TSM.

LOCK NODE Prevents a client from accessing the server.

QUERY SESSION Displays information about all activeadministrator and client sessions with TSM.

CANCEL SESSION


CHECKIN LIBVOLUME (Check a Storage Volume into a Library)

Use this command to add a sequential access storage volume or a cleaning tape to theTSM inventory for an available, automated library. This command informs TSM that avolume is available for use. TSM does not use a volume that physically resides in anautomated library until the volume has been checked in via this command.

Note: The CHECKIN LIBVOLUME command processing will not wait for a drive tobecome available, even if the drive is only in the IDLE state. If necessary, alibrary must be made available by dismounting the drive with the DISMOUNTVOLUME command. Once a library drive is available, the CHECKINLIBVOLUME command can be reissued.


Privilege Class


Syntax

ÊÊ CHECKIn LIBVolume library_name volume_name STATus = PRIvateSCRatch

Ê

Ê

·

,

VOLList = volume_nameFILE: file_name

CHECKLabel = Yes

CHECKLabel = YesNo

Ê

ÊSWAP = No

SWAP = NoYes

MOUNTWait = 60

MOUNTWait = mountwaitvalue

SEARCH = No

SEARCH = NoYesA

ÊÍ

A:SEARCH=YES:

CATegory =*SYSNAME/

*SYSNAME/category system-name/

category_name*INSERT*NOSHARE*SHARE400

CHECKIN LIBVOLUME



Specifies the name of the library.

volume_nameSpecifies the volume name of the storage volume being checked in. Do not enterthis parameter if the SEARCH parameter equals YES or BULK. This parameter isrequired if SEARCH equals NO.

VOLListSpecifies the list of volumes to be processed for the command. Possible valuesare:

volume_nameSpecifies the names of one or more values used for the command. Example:VOLLIST=TAPE01,TAPE02.

Note: VOLList is designed to filter only the volumes to be checked in orlabeled, and it requires that CHECKLabel=BARCODE.

FILE:file_nameSpecifies the name of a file that contains a list of volumes for the command. Inthe file, each volume name must be on a separate line. Blank lines andcomment lines that begin with a asterisk are ignored. For example, to usevolumes TAPE01, TAPE02 and TAPE03, create a file named TAPEVOL thatcontains the lines in the following example:

TAPE01TAPE02TAPE03

You can specify the volumes for the command as follows:VOLLIST=TAPEVOL.

Note: The file name is case sensitive.

STATus (Required)Specifies the volume status. Possible values are:

PRIvateSpecifies that the volume is a private volume that is mounted only when it isrequested by name.

SCRatchSpecifies that the volume is a new scratch volume. This new scratch volumecan be mounted to satisfy scratch mount requests during either data storageoperations or export operations.

CHECKLabelSpecifies how or whether TSM should read sequential media labels of volumes.This parameter is optional. The default is YES.

Possible values are:

CHECKIN LIBVOLUME


YesSpecifies that an attempt is made to read the media label during check-in.

No Specifies that the media label is not read during check-in. However,suppressing label checking can result in future errors (for example, either awrong label or an improperly labeled volume can cause an error).

SWAPSpecifies whether TSM swaps cartridges if an empty library slot is not available.This parameter is optional. The default is NO. Possible values are:

No Specifies that TSM checks in the volume only if an empty slot is available.

YesSpecifies that if an empty slot is not available, TSM swaps cartridges to checkin the volume.

Note: The volume selected for the swap operation (target swap volume) isejected from the library and replaced with the volume being checked in.TSM identifies a target swap volume by checking for an availablescratch volume. If none exist, TSM identifies the least frequentlymounted volume.

MOUNTWaitSpecifies the number of minutes to wait for a storage volume to be mounted. Thisparameter is optional. If the volume is not mounted within the specified amount oftime, the mount request is canceled. Specify an integer from 0 to 9999. The defaultis 60 minutes.

SEARCHSpecifies whether TSM searches the library to see if the volume has beenpreviously checked in. This parameter is optional. The default is NO. The valuesare:

No Specifies that only the named volume is checked into the library. The serverissues a mount request to have the volume inserted into the library’s entry/exitport.

YesSpecifies that TSM should search the library for volumes that can be checkedin automatically. Since volume names are determined from the media label ofvolumes that already reside in the library, the volume name (volname)parameter must be omitted when this option is used.

If the library is shared between applications, be cautious when selecting thisparameter. TSM could examine a volume required by another application.

If YES is specified, you must also specify the CATEGORY keyword along withother applicable parameters.

CATegorySpecifies the system name and category name for this category.

*SYSNAME/Specifies the system on which the command is being issued. Thisparameter is the default.

CHECKIN LIBVOLUME


category system-name/Specifies the system to which the category belongs. This parameter isoptional. The default is *SYSNAME/.

category_nameSpecifies the category name of the volumes to check in by TSM. Thename of a predefined category name is required. The following arethe predefined category names:

*INSERTSpecifies that the volume is in the insert category.

*NOSHARESpecifies that the volume can be mounted only from this system.

*SHARE400Specifies that the volume can be shared with other AS/400systems that are attached to the Media Library Device.

Examples

Task 1

Check in the volume named WPDV00 into the library named AUTO.

Command:checkin libvolume auto wpdv00 status=scratch

Task 2

Scan the category for all *share400 volumes and put them in scratch status.

Command:checkin libvolume abc search=yes status=scratch category=*share400

Related Commands

Table 27. Commands Related to CHECKIN LIBVOLUME

Command Description

AUDIT LIBRARY Ensures that an automated library is in aconsistent state.

CHECKOUT LIBVOLUME Checks a storage volume out of an automatedlibrary.




UPDATE LIBVOLUME Changes the status of a storage volume.

LABEL LIBVOLUME Labels a library volume.

CHECKIN LIBVOLUME


CHECKOUT LIBVOLUME (Check a Storage Volume out of a Library)

Use this command to remove a sequential access storage volume from the TSMinventory for an automated library.

Note: The CHECKOUT LIBVOLUME command processing will not wait for a drive tobecome available, even if the drive is only in the IDLE state. If necessary, alibrary drive may be made available by dismounting the drive with theDISMOUNT VOLUME command. After a library is available, the CHECKOUTLIBVOLUME command can be reissued.

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

Privilege Class


Syntax

ÊÊ CHECKOut LIBVolume library_name volume_nameCHECKLabel = Yes

CHECKLabel = YesNo

Ê

ÊFORCE = No

FORCE = NoYes

REMove = Yes

REMove = YesNo

ÊÍ



volume_name (Required)Specifies the volume name.

CHECKLabelSpecifies how or whether TSM reads sequential media labels of volumes. Thisparameter is optional. The default is YES. Possible values are:

YesSpecifies that TSM attempts to read the media label to verify that the correctvolume is being checked out.

No Specifies that during checkout the media label is not read. This improvesperformance because the read process does not occur.

CHECKOUT LIBVOLUME


FORCESpecifies whether TSM checks out a volume if an input/output (I/O) error occurswhen reading the label. This parameter is optional. The default is NO. Possiblevalues are:

No TSM does not check out a storage volume if an I/O error occurs when readingthe label.

YesTSM checks out the storage volume even if an I/O error occurs.

REMoveSpecifies whether TSM ejects a volume from either an IBM 3494 or 3495 library.This parameter is optional. The default is YES. Possible values are:

YesSpecifies that a volume is placed into the bulk I/O station. TSM deletes thevolume entry from the TSM library inventory.

No Specifies that a volume is not ejected. TSM deletes the volume entry from theTSM library inventory and leaves the volume in the library for use by otherapplications.

Examples

Task

Check out the volume named WPDV00 from the library named AUTO.

Command:CHECKOut LIBVolume auto wpdv00

Related Commands

Table 28. Commands Related to CHECKOUT LIBVOLUME

Command Description



CHECKIN LIBVOLUME Checks a storage volume into an automatedlibrary.


DEFINE VOLUME Assigns a volume to be used for storage withina specified storage pool.





CHECKOUT LIBVOLUME


||

COMMIT (Control Committing of Commands in a Macro)

Use this command to control when a command is committed in a macro and to updatethe database when commands complete processing. When issued from the consolemode of the administrative client, this command does not generate a message.

If an error occurs while processing the commands in a macro, the server stopsprocessing of the macro and rolls back any changes (since the last COMMIT). After acommand is committed, it cannot be rolled back.

Ensure that your administrative client session is not running with the ITEMCOMMIToption if you want to control command processing.

Privilege Class

Any administrator can issue this command.

Syntax

ÊÊ COMMIT ÊÍ

Parameters

None.

Examples

Task

From the interactive mode of the administrative client, register and grant authority tonew administrators using a macro named REG.ADM. Changes are committed aftereach administrator is registered and is granted authority.

Macro Contents:

/* REG.ADM-register policy admin & grant authority*/REGister Admin sara hobbyGRant AUTHority sara CLasses=PolicyCOMMIT /* Commits changes */REGister Admin ken planeGRant AUTHority ken CLasses=PolicyCOMMIT /* Commits changes */

Command:macro reg.adm

COMMIT


Related Commands

Table 29. Commands Related to COMMIT

Command Description

MACRO Runs a specified macro file.

ROLLBACK Discards any uncommitted changes to thedatabase since the last COMMIT was executed.

COMMIT


COPY CLOPTSET (Copy a Client Option Set)

Use this command to copy a client option set.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege for the policy domain to which the client node is assigned.

Syntax

ÊÊ COPy CLOptset current_option_set_name new_option_set_name ÊÍ

Parameterscurrent_option_set_name (Required)

Specifies the name of the client option set to be copied.

new_option_set_name (Required)Specifies the name of the new client option set. The maximum length of the nameis 64 characters.

Examples

Task

Copy a client option set named ENG to a new client option set named ENG2.

Command:copy cloptset eng eng2

Related Commands

Table 30. Commands Related to COPY CLOPTSET

Command Description

DEFINE CLIENTOPT Adds a client option to a client option set.

DEFINE CLOPTSET Defines a client option set.

DELETE CLIENTOPT Deletes a client option from a client option set.

DELETE CLOPTSET Deletes a client option set.

QUERY CLOPTSET Displays information about a client option set.

UPDATE CLIENTOPT Updates the sequence number of a clientoption.

UPDATE CLOPTSET Updates the description of a client option set.

COPY CLOPTSET


COPY DOMAIN (Copy a Policy Domain)

Use this command to create a copy of a policy domain. The server copies the followinginformation to the new domain:

v Policy domain description

v Policy sets in the policy domain (including the ACTIVE policy set, if a policy set hasbeen activated)

v Management classes in each policy set (including the default management class, ifassigned)

v Copy groups in each management class

Privilege Class


Syntax

ÊÊ COPy DOmain current_domain_name new_domain_name ÊÍ

Parameterscurrent_domain_name (Required)

Specifies the policy domain to copy.

new_domain_name (Required)Specifies the name of the new policy domain. The maximum length of this name is30 characters.

Examples

Task

Copy the policy domain PROG1 to new policy domain PROG2.

Command:copy domain prog1 prog2

Related Commands

Table 31. Commands Related to COPY DOMAIN

Command Description




COPY DOMAIN


Table 31. Commands Related to COPY DOMAIN (continued)

Command Description

DEFINE DOMAIN Defines a policy domain that can be assigned toclients.



DELETE COPYGROUP Deletes a backup or archive copy group from apolicy domain and policy set.

DELETE DOMAIN Deletes a policy domain along with any policyobjects in the policy domain.






REGISTER NODE Defines a client to the server and sets optionsfor that user.


UPDATE DOMAIN Changes the attributes of a policy domain.




COPY DOMAIN


COPY MGMTCLASS (Copy a Management Class)

Use this command to create a copy of a management class within the same policy set.The server copies the following information to the new management class:

v Management class description

v Copy groups defined to the management class

v Any attributes for managing files for HSM clients

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege for the policy domain to which the new management classbelongs.

Syntax

ÊÊ COPy MGmtclass domain_name policy_set_name Ê

Ê current_class_name new_class_name ÊÍ



policy_set_name (Required)Specifies the policy set to which the management class belongs.

current_class_name (Required)Specifies the management class to copy.

new_class_name (Required)Specifies the name of the new management class. The maximum length of thisname is 30 characters.

Examples

Task

Copy the management class ACTIVEFILES to a new management class,FILEHISTORY. The management class is in policy set VACATION in theEMPLOYEE_RECORDS policy domain.

Command:copy mgmtclass employee_records vacation activefiles filehistory

COPY MGMTCLASS


Related Commands

Table 32. Commands Related to COPY MGMTCLASS

Command Description








COPY MGMTCLASS


COPY POLICYSET (Copy a Policy Set)

Use this command to copy a policy set (including the ACTIVE policy set) within thesame policy domain. The server copies the following information to the new policy set:

v Policy set description

v Management classes in the policy set (including the default management class, ifassigned)

v Copy groups in each management class

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege for the policy domain to which the new policy set belongs.

Syntax

ÊÊ COPy POlicyset domain_name current_set_name new_set_name ÊÍ


Specifies the policy domain to which the policy set belongs.

current_set_name (Required)Specifies the policy set to copy.

new_set_name (Required)Specifies the name of the new policy set. The maximum length of this name is 30characters.

Examples

Task

Copy the policy set VACATION to the new policy set HOLIDAY in theEMPLOYEE_RECORDS policy domain.

Command:copy policyset employee_records vacation holiday

Related Commands

Table 33. Commands Related to COPY POLICYSET

Command Description



COPY POLICYSET


Table 33. Commands Related to COPY POLICYSET (continued)

Command Description






COPY POLICYSET


COPY PROFILE (Copy a Profile)

Use this command on a configuration manager to copy a profile and all its associatedobject names to a new profile.

Privilege Class


Syntax

ÊÊ COPy PROFIle current_profile_name new_profile_name ÊÍ

Parameterscurrent_profile_name (Required)

Specifies the profile to copy.

new_profile_name (Required)Specifies the name of the new profile. The maximum length of the profile name is30 characters.

Examples

Task

Copy a profile named VAL to a new profile named VAL2.

Command:copy profile val val2

Related Commands

Table 34. Commands Related to COPY PROFILE

Command Description

DEFINE PROFASSOCIATION Associates objects with a profile.

DEFINE PROFILE Defines a profile for distributing information tomanaged servers.

DEFINE SUBSCRIPTION Subscribes a managed server to a profile.

DELETE PROFASSOCIATION Deletes the association of an object with aprofile.

DELETE PROFILE Deletes a profile from a configuration manager.

DELETE SUBSCRIBER Deletes obsolete managed server subscriptions.

DELETE SUBSCRIPTION Deletes a specified profile subscription.

LOCK PROFILE Prevents distribution of a configuration profile.

COPY PROFILE


||

||

|

|

|

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

|

|

||

|||

|

|

|

||

|

|||

||

||

|||

||

|||

||

||

||

||

Table 34. Commands Related to COPY PROFILE (continued)

Command Description

NOTIFY SUBSCRIBERS Notifies servers to refresh their configurationinformation.

QUERY PROFILE Displays information about configuration profiles.

QUERY SUBSCRIBER Displays information about subscribers and theirsubscriptions to profiles.

QUERY SUBSCRIPTION Displays information about profile subscriptions.

SET CONFIGMANAGER Specifies whether a server is a configurationmanager.

UNLOCK PROFILE Enables a locked profile to be distributed tomanaged servers.

UPDATE PROFILE Changes the description of a profile.

COPY PROFILE


|

||

|||

||

|||

||

|||

|||

||

|

COPY SCHEDULE (Copy a Client or an Administrative Command Schedule)

Use this command to create a copy of a schedule.

The COPY SCHEDULE command takes two forms, depending on whether the scheduleapplies to client operations or administrative commands. The syntax and parameters foreach form are defined separately.

COPY SCHEDULE


COPY SCHEDULE — Client

Use the COPY SCHEDULE command to create a copy of a schedule for clientoperations. You can copy a schedule within a policy domain or from one policy domainto another policy domain. Use the DEFINE ASSOCIATION command to associate thenew schedule with the client nodes.

Privilege Class

To copy a client schedule, you must have system privilege, unrestricted policy privilege,or restricted policy privilege for the policy domain to which you are copying theschedule.

Syntax

ÊÊ COPy SCHedule current_domain_name current_sched_name new_domain_name Ê

Êcurrent_sched_name

new_sched_name

REPlace = No

REPlace = NoYes

ÊÍ

Parameterscurrent_domain_name (Required)

Specifies the name of the policy domain that contains the schedule you want tocopy.

current_sched_name (Required)Specifies the name of the schedule you want to copy.

new_domain_name (Required)Specifies the name of a policy domain to which you want to copy the newschedule.

new_sched_nameSpecifies the name of the new schedule. You can specify up to 30 characters forthe name.

If you do not specify this name, the name of the original schedule is used.

If the schedule name is already defined in the policy domain, specifyREPLACE=YES or the command fails.

REPlaceSpecifies whether to replace a client schedule. The default is NO. The values are:

No Specifies that a client schedule is not replaced.

YesSpecifies that a client schedule is replaced.

COPY SCHEDULE— Client


Examples

Task

Copy the WEEKLY_BACKUP schedule that belongs to policy domainEMPLOYEE_RECORDS to the PROG1 policy domain and name the new scheduleWEEKLY_BACK2. If there is already a schedule with this name defined in the PROG1policy domain, do not replace it.

Command:copy schedule employee_records weekly_backup prog1 weekly_back2

COPY SCHEDULE— Client


COPY SCHEDULE — Administrative Command

Use the COPY SCHEDULE command to create a copy of an administrative commandschedule.

Privilege Class

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

Syntax

ÊÊ COPy SCHedule current_sched_name new_sched_name Type = Administrative Ê

ÊREPlace = No

REPlace = NoYes

ÊÍ

Parameterscurrent_schedule_name (Required)

Specifies the name of the schedule you want to copy.

new_schedule_name (Required)Specifies the name of the new schedule. You can specify up to 30 characters forthe name.

If the schedule name is already defined, specify REPLACE=YES, or the commandfails.

Type=AdministrativeSpecifies that an administrative command schedule is to be copied.

REPlaceSpecifies whether to replace an administrative command schedule. The default isNO. The values are:

No Specifies that an administrative command schedule is not replaced.

YesSpecifies that an administrative command schedule is replaced.

Examples

Task

Copy the administrative command schedule, DATA_BACKUP and name the scheduleDATA_ENG. If there is already a schedule with this name, replace it.

Command:copy schedule data_backup data_eng type=administrative replace=yes



Related Commands

Table 35. Commands Related to COPY SCHEDULE

Command Description

DEFINE ASSOCIATION Associates clients with a schedule.

DEFINE SCHEDULE Defines a schedule for a client operation or anadministrative command.

DELETE SCHEDULE Deletes a schedule from the database.

QUERY SCHEDULE Displays information about schedules.

UPDATE SCHEDULE Changes the attributes of a schedule.



COPY SCRIPT (Copy a Tivoli Storage Manager Script)

Use this command to copy a TSM script to a new script.

Privilege Class

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

Syntax

ÊÊ COPy SCRipt current_script_name new_script_name ÊÍ

Parameterscurrent_script_name (Required)

Specifies the name of the script you want to copy.

new_script_name (Required)Specifies the name of the new script. You can specify up to 30 characters for thename.

Examples

Task

Copy script TESTDEV to a new script and name it ENGDEV.

Command:copy script testdev engdev

Related Commands

Table 36. Commands Related to COPY SCRIPT

Command Description

DEFINE SCRIPT Defines a script to the TSM server.

DELETE SCRIPT Deletes the script or individual lines from thescript.

QUERY SCRIPT Displays information about scripts.

RENAME SCRIPT Renames a script to a new name.

RUN Runs a script.

UPDATE SCRIPT Changes or adds lines to a script.

COPY SCRIPT


||

|

|

|

|

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

|

|

||

|||

|

|

|

||

|

|||

||

||

|||

||

||

||

||

|

COPY SERVERGROUP (Copy a Server Group)

Use this command to create a copy of a server group.

Privilege Class


Syntax

ÊÊ COPy SERVERGRoup current_group_name new_group_name ÊÍ

Parameterscurrent_group_name (Required)

Specifies the server group to copy.

new_group_name (Required)Specifies the name of the new server group. The maximum length of this name is64 characters.

Examples

Task

Copy the server group GRP_PAYROLL to the new group HQ_PAYROLL.

Command:copy servergroup grp_payroll hq_payroll

Related Commands

Table 37. Commands Related to COPY SERVERGROUP

Command Description

DEFINE GRPMEMBER Defines a server as a member of a servergroup.

DEFINE SERVER Defines a server for server-to-servercommunications.

DEFINE SERVERGROUP Defines a new server group.

DELETE GRPMEMBER Deletes a server from a server group.

DELETE SERVER Deletes the definition of a server.

DELETE SERVERGROUP Deletes a server group.

MOVE GRPMEMBER Moves a server group member.

QUERY SERVER Displays information about servers.

QUERY SERVERGROUP Displays information about server groups.

COPY SERVERGROUP


||

|

|

|

|

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

|

|

||

|||

|

|

|

||

|

|||

||

|||

|||

||

||

||

||

||

||

||

Table 37. Commands Related to COPY SERVERGROUP (continued)

Command Description

RENAME SERVERGROUP Renames a server group.

UPDATE SERVER Updates information about a server.

UPDATE SERVERGROUP Updates a server group.

COPY SERVERGROUP


|

||

||

||

||

|

DEFINE ASSOCIATION (Associate Client Nodes with a Schedule)

Use this command to associate one or more clients with a schedule. A client node mustbe assigned to the policy domain to which a schedule belongs. Client nodes processoperations according to the schedules associated with the nodes.

Note: In a macro, the server may stall if some commands (such as REGISTER NODEand DEFINE ASSOCIATION) are not committed as soon as you issue them. Youcould follow each command in a macro with a COMMIT command. However, asimpler solution is to include the -ITEMCOMMIT option with the DSMADMCcommand.

Privilege Class

To perform this task, you must have one of the following privilege classes:

v System privilege

v Unrestricted policy privilege, or

v Restricted policy privilege for the policy domain to which the schedule belongs

Syntax

ÊÊ DEFine ASSOCiation domain_name schedule_name ·

,

node_name ÊÍ


Specifies the name of the policy domain to which the schedule belongs.

schedule_name (Required)Specifies the name of the schedule that you want to associate with one or moreclients.

node_name (Required)Specifies the name of the client node or a list of client nodes to be associated withthe specified schedule. The items in the list are separated by commas, with nointervening spaces. You can use a wildcard character to specify a name. If a clientis listed, but is already associated with the specified schedule or is not assigned tothe policy domain to which the schedule belongs, the command has no effect forthat client.

Examples

Task 1

Associate the client nodes SMITH or JOHN with the WEEKLY_BACKUP schedule. Theassociated clients are assigned to the EMPLOYEE_RECORDS policy domain.

DEFINE ASSOCIATION


Command:define association employee_records weekly_backup smith*,john*

Task 2

Associate the client nodes JOE, TOM, and LARRY with the WINTER schedule. Theassociated clients are assigned to the EMPLOYEE_RECORDS policy domain; however,the client JOE is already associated with the WINTER schedule.

Command:define association employee_records winter joe,tom,larry

Related Commands

Table 38. Commands Related to DEFINE ASSOCIATION

Command Description


DELETE ASSOCIATION Deletes the association between clients and aschedule.


QUERY ASSOCIATION Displays the clients associated with one or moreschedules.


DEFINE ASSOCIATION


DEFINE CLIENTACTION (Define a One-Time Client Action)

Use this command to schedule one or more clients to process a command for aone-time action. The server automatically defines a schedule and associates the clientnode to the schedule. The server sets the priority parameter to 1, sets the PERUNITSto onetime, and the DURATION and DURUNITS parameters according to the value setin the SET CLIENTACTION command.

How quickly the client processes this command depends on whether the schedulingmode for the client is set to server-prompted or client-polling. The client scheduler mustbe started on the client workstation in order for the server to process the schedule.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy for the policy domain to which the schedule belongs.

Syntax

ÊÊ DEFine CLIENTAction

·

*

,

node_name

DOmain = domain_nameÊ

Ê ACTion = IncrementalSelectiveArchiveREStoreRETrieveCommandMacro

OPTions = option_stringÊ

ÊOBJects = object_string

ÊÍ

Parametersnode_name

Specifies the list of client nodes that will process the schedule associated with theaction. You can use a wildcard character to specify a client node or a list of clientnodes. Separate the client node names with commas and no intervening spaces. Ifyou do not specify a value, all client nodes will be scheduled for the action.

DOmainSpecifies the list of policy domains used to limit the list of client nodes. Only clientnodes that are assigned to one of the specified policy domains will be scheduled.

DEFINE CLIENTACTION


All clients assigned to a matching domain will be scheduled. If you do not specify avalue, all policy domains will be included in the list.

ACTionSpecifies the action that occurs when this schedule is processed. Possible valuesare:

IncrementalSpecifies that the schedule backs up all files that are new or that havechanged since the last incremental backup. Incremental also backs up any filefor which all existing backups may have expired.

SelectiveSpecifies that the schedule backs up only files that are specified with theOBJECTS parameter.

ArchiveSpecifies that the schedule archives files that are specified with the OBJECTSparameter.

REStoreSpecifies that the schedule restores files that are specified with the OBJECTSparameter.

RETrieveSpecifies that the schedule retrieves files that are specified with the OBJECTSparameter.

CommandSpecifies that the schedule processes a client command that is specified withthe OBJECTS parameter.

MacroSpecifies that a client processes a macro whose file name is specified with theOBJECTS parameter.

OPTionsSpecifies the client options that you specify to the DSMC command at the time theschedule is processed. Only those options that are valid on the DSMC commandline may be specified for this parameter. Refer to the appropriate client manual forinformation on which options are valid from the command line. This parameter isoptional.

Do not include the following options because they have no effect when the clientprocesses the scheduled command:

MAXCMDRETRIES

QUERYSCHEDPERIOD

RETRYPERIOD

SCHEDLOGNAME

SCHEDMODE

SERVERNAME

TCPCLIENTADDRESS

TCPCLIENTPORT

DEFINE CLIENTACTION


OBJectsSpecifies the objects (file spaces or directories) for which the specified action isperformed. To select all file spaces or directories, explicitly list them in theobject-string. Entering an asterisk will cause the backup to only occur for thedirectory where the scheduler was started. This parameter is required except whenACTION=INCREMENTAL.

When you specify ACTION=INCREMENTAL without specifying a value for thisparameter, the DSMC command is invoked without specified objects and attemptsto process the objects as defined in your client’s option file.

You can specify more than one object by separating the objects with blank spacesand quotation marks. Enclose the file string in quotation marks if it contains blankcharacters. If the file string contains multiple file names, each must be surroundedby its own pair of double quotes, with one pair of single quotes surrounding the filestring. For example, to specify the following file strings:

v C:\FILE 2, D:\A B C, E:\MY TEST FILE, enter:

OBJECTS='"C:\FILE 2" "D:\A B C" "E:\MY TEST FILE"'

v D:\TEST FILE, enter:

OBJECTS="D:\TEST FILE"

Examples

Task

Issue an incremental backup command for client node TOM assigned to policy domainEMPLOYEE_RECORDS. TSM defines a schedule and associates the schedule to clientnode TOM (assuming the client scheduler is running).

Command:define clientaction tom domain=employee_records action=incremental

Related Commands

Table 39. Commands Related to DEFINE CLIENTACTION

Command Description



QUERY EVENT Displays information about scheduled andcompleted events for selected clients.


SET CLIENTACTDURATION Specifies the duration of a schedule definedusing the DEFINE CLIENTACTION command.

DEFINE CLIENTACTION


DEFINE CLIENTOPT (Define an Option to an Option Set)

Use this command to add a client option to an option set.

Privilege Class

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

Syntax

ÊÊ DEFine CLIENTOpt option_set_name option_name option_value Ê

ÊForce = No

Force = NoYes

SEQnumber = numberÊÍ

Parametersoption_set_name (Required)

Specifies the name of the option set.

option_name (Required)Specifies a client option to add to the option set. The following are the validoptions:

v BOOKS

v CHANGINGRETRIES

v COMPRESSALWAYS

v COMPRESSION

v DIRMC

v DOMAIN

v INCLEXCL

v MAXCMDRETRIES

v MEMORYEFFICIENTBACKUP

v NFSTIMEOUT

v POSTNSCHEDULECMD

v POSTSCHEDULECMD

v PRENSCHEDULECMD

v PRESCHEDULECMD

v QUERYSCHEDPERIOD

v QUIET

v NWUSER

v RETRYPERIOD

v RUNASSERVICE

v SCHEDMODE

v SCROLLLINES

v SCROLLPROMPT

v SUBDIR

v TRACEFLAGS

v TRACEMAX

v TAPEPROMPT

v TXNBYTELIMIT

v VERBOSE

option_value (Required)Specifies the value for the option. If the option includes more than one value,enclose the value in quotation marks.

DEFINE CLIENTOPT


SEQnumberSpecifies a sequence number when an option name is specified more than once.This parameter is optional.

ForceSpecifies whether the client can override an option value. The value is ignored foradditive options, such as INCLEXCL and DOMAIN. The default is NO. Thisparameter is optional. The values are:

YesSpecifies that the client cannot override the value.

No Specifies that the client can override the value.

Examples

Task

Add a client option (MAXCMDRETRIES 5) to a client option set named ENG.

Command:define clientopt eng maxcmdretries 5

Related Commands

Table 40. Commands Related to DEFINE CLIENTOPT

Command Description

COPY CLOPTSET Copies an existing client option set.








UPDATE NODE Changes the attributes associated with a clientnode.

DEFINE CLIENTOPT


DEFINE CLOPTSET (Define Client Options)

Use this command to define a set of options you can assign to clients for archive,backup, restore, and retrieve operations.

To add options to the new set, use the DEFINE CLIENTOPT command.

Privilege Class


Syntax

ÊÊ DEFine CLOptset option_set_nameDESCription = description

ÊÍ


Specifies the name of the client option set. The maximum length of the name is 64characters.

DESCRIPTIONSpecifies a description of the client option set. The maximum length of thedescription is 255 characters. The description must be enclosed in quotation marksif it contains any blank characters. This parameter is optional.

Examples

Task

Define a client option set named ENG.

Command:define cloptset eng

Related Commands

Table 41. Commands Related to DEFINE CLOPTSET

Command Description






DEFINE CLOPTSET


Table 41. Commands Related to DEFINE CLOPTSET (continued)

Command Description



DEFINE CLOPTSET


DEFINE COPYGROUP (Define a Copy Group)

Use this command to define a new backup or archive copy group within a specificmanagement class, policy set, and policy domain. The server uses the backup andarchive copy groups to control how clients back up and archive files, and to manage thebacked-up and archived files. To allow clients to use the new copy group, you mustactivate the policy set that contains the new copy group.

You can define one backup and one archive copy group for each management class.To ensure that client nodes can back up files, include a backup copy group in thedefault management class for a policy set.

Note: The DEFINE COPYGROUP command fails if you specify a copy storage pool asa destination.

The DEFINE COPYGROUP command has two forms, one for defining a backup copygroup and one for defining an archive copy group. The syntax and parameters for eachform are defined separately.

DEFINE COPYGROUP


DEFINE COPYGROUP — Backup

Use this command to define a new backup copy group within a specific managementclass, policy set, and policy domain.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege for the policy domain to which the copy group belongs.

Syntax

ÊÊ DEFine COpygroup domain_name policy_set_name class_nameSTANDARD

STANDARDÊ

ÊType = Backup

Type = BackupDESTination = pool_name

FREQuency = 0

FREQuency = daysÊ

ÊVERExists = 2

VERExists = numberNOLimit

VERDeleted = 1

VERDeleted = numberNOLimit

Ê

ÊRETExtra = 30

RETExtra = daysNOLimit

RETOnly = 60

RETOnly = daysNOLimit

Ê

ÊMODE = MODified

MODE = MODifiedABSolute

SERialization = SHRSTatic

SERialization = SHRSTaticSTaticSHRDYnamicDYnamic

ÊÍ


Specifies the policy domain for which you are defining the copy group.

policy_set_name (Required)Specifies the policy set for which you are defining the copy group.

You cannot define a copy group for a management class that belongs to theACTIVE policy set.



class_name (Required)Specifies the management class for which you are defining the copy group.

STANDARDSpecifies the name of the copy group, which must be STANDARD. This parameteris optional. The default value is STANDARD.

Type=BackupSpecifies that you want to define a backup copy group. The default parameter isBACKUP. This parameter is optional.

DESTination (Required)Specifies the primary storage pool where the server initially stores backup data.You cannot specify a copy storage pool as the destination.

FREQuencySpecifies how frequently TSM can back up a file. This parameter is optional. TSMbacks up a file only when the specified number of days has elapsed since the lastbackup. The FREQUENCY value is used only during a full incremental backupoperation. This value is ignored during selective backup or partial incrementalbackup. You can specify an integer from 0 to 9999. The default value is 0, meaningthat TSM can back up a file regardless of when the file was last backed up.

VERExistsSpecifies the maximum number of backup versions to retain for files that arecurrently on the client file system. This parameter is optional. The default value is2.

If a backup operation causes the limit to be exceeded, the server expires the oldestbackup version that exists in server storage. Possible values are:

numberSpecifies the number of backup versions to retain for files that are currently onthe client file system. You can specify an integer from 1 to 9999.

NOLimitSpecifies that you want the server to retain all backup versions.

The number of backup versions to retain is controlled by this parameter untilversions exceed the retention time specified by the RETEXTRA parameter.

VERDeletedSpecifies the maximum number of backup versions to retain for files that havebeen deleted from the client file system after being backed up using TSM. Thisparameter is optional. The default value is 1.

If a user deletes a file from the client file system, the next backup causes theserver to expire the oldest versions of the file in excess of this number. Theexpiration date for the remaining versions is determined by the retention timespecified by the RETEXTRA or RETONLY parameter. Possible values are:

numberSpecifies the number of backup versions to retain for files that are deletedfrom the client file system after being backed up. You can specify an integerfrom 0 to 9999.



NOLimitSpecifies that you want the server to retain all backup versions for files thatare deleted from the client file system after being backed up.

RETExtraSpecifies the number of days to retain a backup version after that version becomesinactive. A version of a file becomes inactive when the client stores a more recentbackup version, or when the client deletes the file from the workstation and thenruns a full incremental backup. The server deletes inactive versions based onretention time even if the number of inactive versions does not exceed the numberallowed by the VEREXISTS or VERDELETED parameters. This parameter isoptional. The default value is 30 days. Possible values are:

daysSpecifies the number of days to retain inactive backup versions. You canspecify an integer from 0 to 9999.

NOLimitSpecifies that you want to retain inactive backup versions indefinitely.

If you specify NOLIMIT, the server deletes inactive backup versions based onthe VEREXISTS parameter (when the file still exists on the client file system)or the VERDELETED parameter (when the file no longer exists on the clientfile system).

RETOnlySpecifies the number of days to retain the last backup version of a file that hasbeen deleted from the client file system. This parameter is optional. The defaultvalue is 60. Possible values are:

daysSpecifies the number of days to retain the last remaining inactive version of afile. You can specify an integer from 0 to 9999.

NOLimitSpecifies that you want to keep the last remaining inactive version of a fileindefinitely.

If you specify NOLIMIT, the server retains the last remaining backup versionforever, unless a user or administrator deletes the file from server storage.

MODESpecifies whether TSM backs up a file only if the file has changed since the lastbackup, or whenever a client requests a backup. This parameter is optional. Thedefault value is MODIFIED. Possible values are:

MODifiedSpecifies that TSM backs up the file only if it has changed since the lastbackup. TSM considers a file changed if any of the following is true:

v The date last modified is different

v The file size is different

v The file owner is different

v The file permissions are different



ABSoluteSpecifies that TSM backs up the file regardless of whether it has beenmodified.

The MODE value is used only for full incremental backup. This value is ignoredduring partial incremental backup or selective backup.

SERializationSpecifies how TSM handles files or directories when they are modified duringbackup processing. This parameter is optional. The default value is SHRSTATIC.Possible values are:

SHRSTaticSpecifies that TSM backs up a file or directory only if it is not being modifiedduring backup. TSM attempts to perform a backup as many as four times,depending on the value specified for the CHANGINGRETRIES client option. Ifthe file or directory is modified during each backup attempt, TSM does notback it up.

STaticSpecifies that TSM backs up a file or directory only if it is not being modifiedduring backup. TSM attempts to perform the backup only once.

Platforms that do not support the STATIC option default to SHRSTATIC.

SHRDYnamicSpecifies that if the file or directory is being modified during a backup attempt,TSM backs up the file or directory during the last attempt even though the fileor directory is being modified. TSM attempts to perform a backup as many asfour times, depending on the value specified for the CHANGINGRETRIESclient option.

DYnamicSpecifies that TSM backs up a file or directory on the first attempt, regardlessof whether the file or directory is being modified during backup processing.

Attention: Be careful about using the SHRDYNAMIC and DYNAMIC values.These values allow TSM to back up a file or directory while modifications areoccurring. As a result, the backup version might be a fuzzy backup. A fuzzy backupdoes not accurately reflect what is currently in the file or directory because itcontains some, but not all, modifications. If a file that contains a fuzzy backup isrestored, the file may or may not be usable, depending on the application that usesthe file. If a fuzzy backup is not acceptable, be sure to use a serialization value thatallows TSM to create a backup version only if the file or directory is not beingmodified (SHRSTATIC or STATIC).

Examples

Task

Create a backup copy group named STANDARD for management class ACTIVEFILESin policy set VACATION in the EMPLOYEE_RECORDS policy domain. Set the backup



destination to BACKUPPOOL. Set the minimum interval between backups to threedays, regardless of whether the files have been modified. Retain up to five backupversions of a file while the file exists on the client file system.

Command:define copygroup employee_records vacation activefiles standardtype=backup destination=backuppool frequency=3 verexists=5mode=absolute



DEFINE COPYGROUP — Archive

Use this command to define a new archive copy group within a specific managementclass, policy set, and policy domain.

Privilege Class


Syntax

ÊÊ DEFine COpygroup domain_name policy_set_name class_nameSTANDARD

STANDARDÊ

Ê Type = Archive DESTination = pool_nameFREQuency = Cmd

FREQuency = CmdÊ

ÊRETVer = 365

RETVer = daysNOLimit

MODE = ABSolute

MODE = ABSoluteÊ

ÊSERialization = SHRSTatic

SERialization = SHRSTaticSTaticSHRDYnamicDYnamic

ÊÍ


Specifies the name of the policy domain for which you are defining the copy group.

policy_set_name (Required)Specifies the name of the policy set for which you are defining the copy group.

You cannot define a copy group for a management class that belongs to theACTIVE policy set.

class_name (Required)Specifies the name of the management class for which you are defining the copygroup.



STANDARDSpecifies the name of the copy group, which must be STANDARD. This parameteris optional. The default value is STANDARD.

Type=Archive (Required)Specifies that you want to define an archive copy group.

DESTination (Required)Specifies the primary storage pool where the server initially stores the archive copy.You cannot specify a copy storage pool as the destination.

FREQuency=CmdSpecifies the copy frequency, which must be CMD. This parameter is optional. Thedefault value is CMD.

RETVerSpecifies the number of days to keep an archive copy. This parameter is optional.The default value is 365. Possible values are:

daysSpecifies the number of days to keep an archive copy. You can specify aninteger from 0 to 9999.

NOLimitSpecifies that you want to keep an archive copy indefinitely.

If you specify NOLIMIT, the server retains archive copies forever, unless a useror administrator deletes the file from server storage.

The value of the RETVER parameter can affect the management class to whichthe server binds an archived directory. If the client does not use the ARCHMCoption, the server binds directories that are archived to the default managementclass. If the default management class has no archive copy group, the server bindsdirectories that are archived to the management class with the shortest retentionperiod.

MODE=ABSoluteSpecifies that a file is always archived when the client requests it. The MODE mustbe ABSOLUTE. This parameter is optional. The default value is ABSOLUTE.

SERializationSpecifies how TSM handles files that are modified during archive. This parameteris optional. The default value is SHRSTATIC. Possible values are:

SHRSTaticSpecifies that TSM archives a file only if it is not being modified. TSM attemptsto perform an archive operation as many as four times, depending on thevalue specified for the CHANGINGRETRIES client option. If the file is modifiedduring the archive attempt, TSM does not archive the file.

STaticSpecifies that TSM archives a file only if it is not being modified. TSM attemptsto perform the archive operation only once.




||||||

SHRDYnamicSpecifies that if the file is being modified during an archive attempt, TSMarchives the file during its last attempt even though the file is being modified.TSM attempts to archive the file as many as four times, depending on thevalue specified for the CHANGINGRETRIES client option.

DYnamicSpecifies that TSM archives a file on the first attempt, regardless of whetherthe file is being modified during archive processing.

Attention: Be careful about using the SHRDYNAMIC and DYNAMIC values.These values allow TSM to archive a file while modifications are occurring. As aresult, the archive copy might be a fuzzy backup. A fuzzy backup does notaccurately reflect what is currently in the file because it contains some, but not all,modifications. If a file that contains a fuzzy backup is retrieved, the file may or maynot be usable, depending on the application that uses the file. If a fuzzy backup isnot acceptable, be sure to use a serialization value that allows TSM to create anarchive copy only if the file is not being modified (SHRSTATIC or STATIC).

Examples

Task

Create an archive copy group named STANDARD for management class MCLASS1 inpolicy set SUMMER in the PROG1 policy domain. Set the archive destination toARCHIVEPOOL, where the archive copy is kept for 730 days.

Command:define copygroup prog1 summer mclass1 standard type=archivedestination=archivepool retver=730



Related Commands

Table 42. Commands Related to DEFINE COPYGROUP

Command Description

ASSIGN DEFMGMTCLASS Assigns an existing management class as thedefault for a specified policy set.



DEFINE STGPOOL Defines a storage pool as a named collection ofserver storage media.









DEFINE DBBACKUPTRIGGER (Define the Database Backup Trigger)

Use this command to specify when TSM backs up the database. A backup occurs whenthe specified percentage of the assigned capacity of the recovery log is reached. TSMuses the database trigger only if the log mode is set to ROLLFORWARD.

Note: If the backup fails, TSM waits 60 seconds and then tries again. It continues toretry the backup until it is successful.

Privilege Class


v System privilege

v Unrestricted storage

Syntax

ÊÊ DEFine DBBackuptrigger DEVclass = device_class_name Ê

ÊLOGFullpct = 50

LOGFullpct = percent INCRDEVclass = device_class_nameÊ

ÊNUMINCremental = 6

NUMINCremental = numberÊÍ

ParametersDEVclass (Required)

Specifies the name of the sequential access device class to use for backups.

LOGFullpctSpecifies a recovery log utilization percentage from 1 to 99. When this value isexceeded, TSM backs up the database. This parameter is optional. The default is50.

INCRDEVclassSpecifies the name of the sequential access device class to use for incrementalbackups. This parameter is optional. The default is the device class specified withthe DEVCLASS parameter.

NUMINCrementalSpecifies the maximum number of incremental backups that can be run before afull backup is required. The range is from 0 to 32. A value of 0 specifies that TSMruns only full backups. This parameter is optional. The default is 6.



Each incremental backup, whether run automatically or requested by anadministrator, is added to the count of incremental backups run. Each full backup,whether run automatically or requested by an administrator, resets the count forincremental backups to zero.

Examples

Task

Set the database backup trigger to 80 percent. After two incremental backups, do a fullbackup. Use the FILE device class.

Command:define dbbackuptrigger devclass=file logfullpct=80 numincremental=2

Related Commands

Table 43. Commands Related to DEFINE DBBACKUPTRIGGER

Command Description

BACKUP DB Backs up the TSM database to sequentialaccess volumes.


DELETE DBBACKUPTRIGGER Deletes the database backup trigger.






DEFINE DBCOPY (Define a Volume Copy of a Database Volume)

Use this command to create a copy (mirrored volume) of a database volume. Mirroringthe database increases database availability and provides a safeguard against mediafailure. You can have as many as two copies of a database volume. After eachdatabase volume copy is defined, the server attempts to synchronize the volume copywith the database.

All database volumes reside on a random access volume. Volume copies must have atleast the same capacity as the original volume and should be defined on separatephysical devices. Any additional space on the volume copy is not used.

This command generates a background process that you can cancel with the CANCELPROCESS command. If a DEFINE DBCOPY process is canceled, the volume copy iscreated. However, synchronization processing is canceled, leaving the volume in a stalestate. To display information on background processes, use the QUERY PROCESScommand.

Privilege Class


Syntax

ÊÊ DEFine DBCopy volume_name copy_volume_name ÊÍ


Specifies the name of the database volume to be mirrored.

copy_volume_name (Required)Specifies the file name of the volume copy. The name cannot contain embeddedblanks or equal signs.

This file name can be entered with either the fully qualified path name or the namerelative to the server’s current AS/400 object library. For example, if the file name ismainvol, enter the path name as:

/QUSRADSM/MAINVOL.MAINVOL

Examples

Task

Create a database volume copy named DB.2 for the database volume named DB.1.

DEFINE DBCOPY


|

Command:define dbcopy/dbvol/db.1/dbvol/db.2

Related Commands

Table 44. Commands Related to DEFINE DBCOPY

Command Description


DEFINE DBVOLUME Assigns a volume to be used for databasestorage.

DELETE DBVOLUME Deletes a volume from the database.

QUERY DBVOLUME Displays information database volumes.


DEFINE DBCOPY


|

DEFINE DBVOLUME (Define a Database Volume)

Use this command to define a new database volume. All database volumes reside onrandom access You can have TSM create the volume before it is assigned.

Attention: Do not change the size of a database volume after you have defined it toTSM. If you change the size, TSM may not initialize correctly and you could lose data.

When you define a new database volume, you provide additional space to thedatabase. To permit the database to use this additional space, use the EXTEND DBcommand.

A database volume must be at least 5MB. TSM uses 1MB of each database volume foroverhead. For example, if you define a 9MB database volume, 8MB are available forstorage.

Privilege Class


Syntax

ÊÊ DEFine DBVolume volume_nameFormatsize = megabytes

Ê

ÊWait = No

Wait = NoYes

ÊÍ


Specifies the file name of the database volume. Enclose the name in quotationmarks if it contains embedded blanks or equal signs.

This file name can be entered with either the fully qualified path name or a namethat is relative to the server’s current AS/400 object library. For example, if the filename is mainvol, enter the path name as:


FormatsizeSpecifies the size of the volume that is defined and formatted in one operation.This parameter is optional. The value is specified in megabytes.

WaitSpecifies whether a volume creation and formatting operation is performed in the

DEFINE DBVOLUME


|

|

|||

||

foreground or background. This parameter is optional. The default is NO. It isignored unless the FORMATSIZE parameter is also specified.

No Specifies that a volume creation and formatting operation is performed in thebackground.

YesSpecifies that a volume creation and formatting operation is performed in theforeground.

Examples

Task 1

Create a database volume named db.2.

Command:define dbvolume /dbvol/db.2

Related Commands

Table 45. Commands Related to DEFINE DBVOLUME

Command Description

DEFINE DBCOPY Creates a volume copy of a database volume.


EXTEND DB Extends usable database storage within thevolumes previously allocated for its use.


DEFINE DBVOLUME


||

|||

|||

|

|

DEFINE DEVCLASS (Define a Device Class)

Use this command to define a device class to support the sequential access devices atyour installation.

Note: The DISK device class is predefined by TSM and cannot be modified with theDEFINE DEVCLASS command.

The syntax and parameter descriptions are provided according to the device type. Thesyntax and parameter information is presented in the following order:

v FILE (“Syntax” on page 112)

v SERVER (“Syntax” on page 114)

v 8MM (“Syntax” on page 116)

v QIC (“Syntax” on page 119)

v 3590 (“Syntax” on page 123)


v CARTRIDGE (“Syntax” on page 129)

v OPTICAL and WORM Types (“Syntax” on page 133)

v REEL (“Syntax” on page 135)

DEFINE DEVCLASS


DEFINE DEVCLASS — FILE

Privilege Class


Syntax

ÊÊ DEFine DEVclass device_class_name DEVType = FILE Ê

ÊMOUNTLimit = 1

MOUNTLimit = mountlimitvalue

MAXCAPacity = 4M

MAXCAPacity = sizeÊ

ÊOLIBRary object_library_name

ÊÍ

Parametersdevice_class_name (Required)

Specifies the name of the device class to be defined. The maximum length of thedevice class name is 30 characters.

DEVType=FILE (Required)Specifies that the FILE device type is assigned to the device class. FILE indicatesthat a file is assigned to this device class. When the server needs to access avolume that belongs to this device class, it opens a file and reads or writes filedata. A file is a form of sequential access media.

Note: Do not use the CRTVOLADSM command to create and format the volumesto be used by a device class with a device type of FILE. These volumes arecreated automatically.

MOUNTLimitSpecifies the maximum number of files that can be simultaneously open forinput/output. This parameter is optional. The default value is 1. You can specify anumber from 1 to 256.

MAXCAPacitySpecifies the maximum size of any data storage files defined to a storage pool inthis device class. This parameter is optional. You must specify this value as aninteger followed by K (Kilobytes), M (Megabytes), or G (Gigabytes).

For example, MAXCAPACITY=5M specifies that the maximum capacity for avolume in this device class is 5 megabytes. The default value is 4MB(MAXCAPACITY=4M). The minimum value allowed is 100KB(MAXCAPACITY=100K).



OLIBRary=AS400 object_library_nameSpecifies the object library that contains the file used in this device class. Thisparameter is optional.

Examples

Task

Define a device class named PLAINFILES with a file device type and a maximumcapacity of 50MB.

Command:define devclass plainfiles devtype=file maxcapacity=50m



DEFINE DEVCLASS — SERVER

Privilege Class


Syntax

ÊÊ DEFine DEVclass device_class_name DEVType = SERVER Ê

Ê SERVERName = server_nameMAXCAPacity = 500M

MAXCAPacity = maxcapÊ

ÊMOUNTLimit = 1

MOUNTLimit = mountlimitvalue

MOUNTRetention = 60

MOUNTRetention = minutesÊ

ÊPREFIX = ADSM

PREFIX = ADSMvolprefix

RETRYPeriod = 10

RETRYPeriod = retryvalue(minutes)Ê

ÊRETRYInterval = 30

RETRYInterval = retryvalue(seconds)ÊÍ



DEVType=SERVER (Required)Specifies a remote connection that supports virtual volumes.

SERVERName (Required)Specifies the name of the server. The SERVERNAME parameter must match adefined server.

Note: If you change the SERVERNAME of an existing server to a new name, dataon the volumes under the old SERVERNAME will no longer be accessiblewith this device class.

MAXCAPacitySpecifies the maximum size that objects can be when created on the target server;



the default for this value is 500M. This parameter is optional. You must specify thisvalue as an integer followed by K (Kilobytes), M (Megabytes), or G (Gigabytes).

For example, MAXCAPACITY=5M specifies that the maximum capacity for avolume in this device class is 5 megabytes. The default value is 500M(MAXCAPACITY=500M). The minimum value allowed is 100KB(MAXCAPACITY=100K).

MOUNTLimitSpecifies the maximum number of volumes that can be simultaneously open forinput/output. This parameter is optional. The default value is 1. You can specify anumber from 1 to 256.

MOUNTRetentionSpecifies the number of minutes to retain an idle connection with the target serverbefore closing the connection. This parameter is optional. The default value is 60.You can specify a number from 0 to 9999.

This parameter can improve response time for sequential access media mounts byleaving previously mounted volumes online.

PREFIXSpecifies the beginning portion of the high-level archive file name on the targetserver. This parameter is optional. The default value is ADSM. The maximumlength of this prefix is 8 characters.

Values specified for this parameter must meet the following conditions:

v The value is to be made up of qualifiers, which can contain up to 8 characters(including periods). For example, the following value would be acceptable:

AB.CD2.E

v The qualifiers must be separated by a single period.

v The first letter of each qualifier must be alphabetical or national (@,#,$), followedby alphabetical, national, hyphen, or numeric characters.

An example of a high level archive file name using the default prefix (with the TSMqualifier added) is ADSM.volume1.

RETRYPeriodSpecifies the retry period in minutes. The retry period is the interval during whichthe server attempts to contact a target server if there is a suspectedcommunications failure. This parameter is optional. The default value is 10 minutes.

RETRYIntervalSpecifies the retry interval in seconds. The retry interval is how often retries aredone within a given time period. This parameter is optional. The default value is 30seconds.



DEFINE DEVCLASS — 8MM

Privilege Class


Syntax

ÊÊ DEFine DEVclass device_class_name DEVType = 8MMFORMAT = DRIVE

FORMAT = DRIVE82008500870020GB

Ê

Ê LIBRary = library_nameMOUNTRetention = 60


ÊPREFIX = ADSM

PREFIX = ADSMtapevolprefix

ESTCAPacity = sizeÊ

ÊMOUNTWait = 60

MOUNTWait = minutes

MOUNTLimit = 1ÊÍ



DEVType=8MM (Required)Specifies that the 8MM device type is assigned to the device class. 8MM indicatesthat 8mm tape devices are assigned to this device class.

FORMATSpecifies the recording format to be used when writing data to sequential accessmedia. This parameter is optional; the default value is DRIVE.

Possible values for 8mm devices:

DRIVESpecifies that TSM selects the highest format that can be supported by thesequential access drive on which a volume is mounted.



Note: Avoid specifying the DRIVE value when a mixture of devices is usedwithin the same library. For example, if you have drives that supportrecording formats superior to other drives in a library, do not specify theFORMAT=DRIVE option.

8200Specifies that TSM writes data using the 8200 recording format. This results ina tape capacity of 2.3GB when using standard 112-meter tape cartridges.



20GBSpecifies that TSM writes data that uses the 20GB recording format. Thisresults in a tape capacity of 20.0GB when using standard 112-meter tapecartridges.

LIBRarySpecifies the name of the defined library object that contains the 8mm tape drivesused by this device class. For information about defining a library object, see theDEFINE LIBRARY command.

MOUNTRetentionSpecifies the number of minutes to retain an idle sequential access volume beforedismounting it. This parameter is optional. The default value is 60. You can specifya number from 0 to 9999.

This parameter can improve response time for sequential access media mounts byleaving previously mounted volumes online. However, for EXTERNAL library types(that is, a library managed by an external media management system), set thisparameter to a low value (for example, two minutes) to enhance device sharingbetween applications.

PREFIXSpecifies the high level qualifier of the data set name that the server writes into thesequential access media labels. For each sequential access volume assigned tothis device class, TSM uses this prefix to create the data set name. This parameteris optional. The default value is ADSM. The maximum length of this prefix is 8characters.

If you have already established a media label naming convention that supportsyour current management system, use a volume prefix that conforms to yournaming conventions. Values specified for this parameter must meet the followingconditions:


AB.CD2.E





ESTCAPacitySpecifies the estimated capacity for the sequential access volumes categorized bythis device class. This parameter is optional. You can specify this parameter if thedefault estimated capacity for the device class is inaccurate due to compression ofdata.

You must specify this value as an integer followed by K (Kilobytes), M(Megabytes), or G (Gigabytes).

For more information on the default estimated capacity for 8MM tapes, seeTable 46.

Table 46. TSM Default Estimated Capacity for 8mm Tape

Tape Format Estimated Capacity

8200 2.3GB

8500 5.0GB

8700 7.0GB

20GB 20.0GB

MOUNTWaitSpecifies the maximum number of minutes to wait for a sequential access volumeto be mounted in a manual library. This parameter is optional and does not apply toautomated libraries. If the mount request is not satisfied within the specified amountof time, the mount request is canceled. The default value is 60 minutes. You canspecify a number from 0 to 9999.

MOUNTLimitSpecifies the maximum number of sequential access volumes that can besimultaneously mounted for the device class. This parameter is optional. Thedefault value is 1. You can specify a number from 1 to 256. This value should beequal to the number of drives available to this device class.

If this value is set to 1, then it may not be possible for media-to-media operations(like reclamation) to work.

Examples

Task

Define a device class named 8MMTAPE for an 8mm device in a library named AUTO.The format is DRIVE, mount limit is 2, mount retention is 10, tape volume prefix isnamed ADSMVOL, and the estimated capacity is 6GB.

Command:define devclass 8mmtape devtype=8mm library=auto format=drivemountlimit=2 mountretention=10 prefix=adsmvol estcapacity=6G



||

DEFINE DEVCLASS — QIC

Privilege Class


Syntax

ÊÊ DEFine DEVclass device_class_name DEVType = QICFORMAT = DRIVE

FORMAT = DRIVE1205251000200050104GB2DC4DC25GB

Ê



ÊPREFIX = ADSM



ÊMOUNTWait = 60

MOUNTWait = minutes

MOUNTLimit = 1

MOUNTLimit = mountlimitvalueÊÍ



DEVType=QIC (Required)Specifies that the QIC device type is assigned to the device class. QIC indicatesthat quarter-inch cartridge tape devices are assigned to this device class.




The following are possible values for QIC devices:

DRIVESpecifies that TSM selects the highest format that can be supported by thesequential access drive on which a volume is mounted. Attention: Use theDRIVE value only when the device class has compatible sequential accessdevices. If you specify DRIVE for a device class that has non-compatiblesequential access devices, then you must mount volumes on devices that arecapable of reading or writing at the format established when the volume wasfirst mounted. This can cause delays if the only sequential access device thatcan access the volume is already in use.

120Specifies the 120 quarter-inch recording format used for quarter-inch cartridgetapes that can hold 150MB of data.


1000Specifies the 1000 quarter-inch recording format used for quarter-inch cartridgetapes that can hold 1GB of data.


5010Specifies the 5010 recording format used for quarter-inch cartridge tapes thatcan hold 13.4GB of data.

4GBSpecifies the 4GB recording format that uses quarter-inch cartridge tapes thathold 3.9GB of data.

2DCSpecifies the 2DC recording format that uses quarter-inch cartridge tapes thathold 4.9GB of data.

4DCSpecifies the 4DC recording format that uses quarter-inch cartridge tapes thathold 7.9GB of data.

25GBSpecifies the 25GB recording format that uses quarter-inch cartridge tapes thathold 24.9GB of data.

LIBRarySpecifies the name of the defined library object that contains the CARTRIDGE tapedrives that can be used by this device class. For information about defining alibrary object, see the DEFINE LIBRARY command.





PREFIXSpecifies the high level qualifier of the data set name that the server writes into thesequential access media labels. The maximum length of this prefix is 8 characters.All sequential access volumes assigned to this device class are prefixed with thisvalue. This parameter is optional. The default value is ADSM.

If you have already established a media label naming convention that supportsyour current management system, use a volume prefix that conforms to yournaming conventions.



AB.CD2.E



An example of a tape volume data set name using the default prefix (with the TSMqualifier added) is ADSM.BFS.

ESTCAPacitySpecifies the estimated capacity for the sequential access volumes categorized bythis device class. This parameter is optional. You can specify this parameter if thedefault estimated capacity for the device class is inaccurate due to compression ofdata.You must specify this value as an integer followed by K (Kilobytes), M(Megabytes), or G (Gigabytes).

For more information on the default estimated capacity for QIC tapes, see Table 47.

Table 47. TSM Default Estimated Capacity for QIC Tape


120 150MB

525 525MB

1000 1.0GB

2000 2.0GB

5010 13.4GB

4GB 3.9GB

2DC 4.9GB

4DC 7.9GB

25GB 24.9GB



||

||

||

||


MOUNTLimitSpecifies the maximum number of sequential access volumes that can besimultaneously mounted for the device class. This parameter is optional. Thedefault value is 1. You can specify a number from 1 to 256.




DEFINE DEVCLASS — 3590

Privilege Class


Syntax

ÊÊ DEFine DEVclass device_class_name DEVType = 3590FORMAT = DRIVE

FORMAT = DRIVE35903590E

Ê



ÊPREFIX = ADSM



ÊMOUNTWait = 60

MOUNTWait = minutes

MOUNTLimit = 1




DEVType=3590 (Required)Specifies the 3590 device type is assigned to the device class. 3590 indicates thatIBM 3590 cartridge tape devices are assigned to this device class.


The following are possible values for 3590 devices:

DRIVESpecifies that TSM selects the highest format that can be supported by the



sequential access drive on which a volume is mounted.Attention: Use theDRIVE value only when the device class has compatible sequential accessdevices. If you specify DRIVE for a device class that has incompatiblesequential access devices, then you must mount volumes on devices that arecapable of reading or writing at the format established when the volume wasfirst mounted. This can cause delays if the only sequential access device thatcan access the volume is already in use.

3590Specifies that TSM writes data using the basic format or, if available,compacted recording format. This results in a tape capacity of approximately10GB. If the compacted recording format is used, the actual capacity may begreater depending on the effectiveness of the compression.

3590ESpecifies that TSM writes data by using the basic format or, if available,compacted recording format. This results in a tape capacity of approximately20GB. If the compacted recording format is used, the actual capacity may begreater depending on the effectiveness of the compression.

LIBRarySpecifies the name of the defined library object that contains the tape drives thatcan be used by this device class. For information about defining a library object,see the DEFINE LIBRARY command.

MOUNTRetentionSpecifies the amount of time, in minutes, to retain an idle sequential access volumebefore dismounting it. This parameter is optional. The default value is 60. You canspecify a number from 0 to 9999.

This parameter can improve response time for sequential access media mounts byleaving previouslyvolumes online.




AB.CD2.E



ESTCAPacitySpecifies the estimated capacity for the sequential access volumes categorized by



this device class. This parameter is optional. You can specify this parameter if thedefault estimated capacity for the device class is inaccurate due to compression ofdata.


For example, ESTCAPACITY=5M specifies that the estimated capacity for avolume in this device class is 5 megabytes. The smallest value allowed is 100KB(that is, ESTCAPACITY=100K).

Table 48. TSM Estimated Capacity for Cartridge Tape


3590 10GB

3590E 20GB (see note)

Note: This format uses the tape drive hardware compression feature. Depending on theeffectiveness of compression, the actual capacity may be greater than the listed value.







Privilege Class


Syntax

ÊÊ DEFine DEVclass device_class_name DEVType = 3570FORMAT = DRIVE


Ê



ÊPREFIX = ADSM



ÊMOUNTWait = 60

MOUNTWait = minutes

MOUNTLimit = 1




DEVType=3570 (Required)Specifies the 3570 device type is assigned to the device class. The 3570 indicatesthat IBM 3570 cartridge tape devices are assigned to this device class.

FORMATSpecifies the recording format to be used when writing data to sequential accessmedia. This parameter is optional; the default value is DRIVE. Attention: Use theDRIVE value only when the device class has compatible sequential accessdevices. If you specify DRIVE for a device class that has incompatible sequentialaccess devices, then you must mount volumes on devices that are capable ofreading or writing at the format established when the volume was first mounted.This can cause delays if the only sequential access device that can access thevolume is already in use.





3570Specifies that TSM writes data using the basic format or, if available,compacted recording format. This results in a tape capacity of approximately5GB. If the compacted recording format is used, the actual capacity may begreater depending on the effectiveness of compression.

Note: If you are using D/T3570-Bxx, you must use “B” media and specifyFORMAT=3570.

3570ESpecifies that TSM writes data that uses the basic format or, if available,compacted recording format. This results in a tape capacity of approximately5GB. If the compacted recording format is used, the actual capacity may begreater depending on the effectiveness of compression.

Note: If you are using D/T3570-Cxx, you must use “C” media and specifyFORMAT=3570E.






ESTCAPacitySpecifies the estimated capacity for the sequential access volumes defined to astorage poolcategorized by this device class. This parameter is optional. You canspecify this parameter if the default estimated capacity for the device class isinaccurate due to compression of data. You must specify this value as an integerfollowed by K (Kilobytes), M (Megabytes), or G (Gigabytes).




For more information on the default estimated capacity for 3570 cartridge tapes,see Table 49.



3570 5GB

3570E 5GB (see note)







DEFINE DEVCLASS — CARTRIDGE

Privilege Class


Syntax

ÊÊ DEFine DEVclass device_class_name DEVType = CARTridge Ê

ÊFORMAT = DRIVE


LIBRary = library_name Ê

ÊMOUNTRetention = 60

MOUNTRetention = minutes

PREFIX = ADSM


Ê

ÊESTCAPacity = size

MOUNTWait = 60

MOUNTWait = minutesÊ

ÊMOUNTLimit = 1




DEVType=CARTridge (Required)Specifies that the CARTRIDGE device type is assigned to the device class.CARTRIDGE indicates that cartridge tape devices are assigned to this deviceclass.


There are five possible values for CARTRIDGE devices:




Note: Avoid specifying DRIVE when a mixture of devices is used within thesame library. For example, if you have drives that support recordingformats superior to other drives in a library, do not specify theFORMAT=DRIVE option. If you specify DRIVE for a device class thathas non-compatible sequential access devices, then you must mountvolumes on devices that are capable of reading or writing at the formatestablished when the volume was first mounted. This can cause delaysif the only sequential access device that can access the volume isalready in use.

3480Specifies 3480 Basic recording format (18 track).

3490Specifies 3490 basic recording format or if available, compacted recordingformat (18 track).

3490ESpecifies 3490E basic recording format or if available, compacted recordingformat (36 track).




PREFIXSpecifies the high-level qualifier of the data set name that the server writes into thesequential access media labels. For each sequential access volume assigned tothis device class, TSM uses this prefix to create the data set name. This parameteris optional. The default value is ADSM.

If you have already established a tape label naming convention that supports yourcurrent tape management system, use a tape volume prefix that conforms to yournaming conventions.



AB.CD2.E





ADSM.BFS is an example of a tape volume filename using the default prefix andthe added TSM qualifier.



For example, ESTCAPACITY=5M specifies that the estimated capacity for avolume in this device class is 5 megabytes. The smallest value allowed is 100KB(ESTCAPACITY=100K).

For more information on the default estimated capacity for cartridge tapes, seeTable 50.


Tape Format Media Type Estimated Capacity

3480 CST 180MB

3490 CST 180MB

3490E CST 180MB

3490E ECCST 720MB




Examples

Task



Define a device class named SQUARE1 with a CARTRIDGE tape device and withRACF protection active for all tape volumes assigned to this device class. All data iscompressed for this device class.

Command:define devclass square1 devtype=cartridge compression=Yesprotection=yes



DEFINE DEVCLASS — OPTICAL and WORM TYPES

Privilege Class


Syntax

ÊÊ DEFine DEVclass device_class_name DEVType = OPTicalWORM

Ê

Ê ESTCAPacity = sizeMOUNTLimit = 1




DEVType (Required)Specifies that the OPTICAL and WORM device types are assigned to the deviceclass.


OPTicalSpecifies that the device class uses two-sided 5.25 inch rewritable opticalmedia.

WORMSpecifies that the device class uses two-sided 5.25 inch write-once read-many(WORM) optical media.

ESTCAPacity (Required)Specifies the estimated capacity for the sequential access volumes defined to astorage pool categorized by this device class.

The estimated capacity of an OPTICAL volume (two sides of a cartridge) is twicethe value of the ESTCAPacity parameter because the ESTCAPacity value specifiesthe amount of data that can be stored on each side of an OPTICAL cartridge.





MOUNTLimitSpecifies the maximum number of sequential access volumes that can besimultaneously mounted for the device class. This parameter is optional. Thedefault is 1. You can specify a number from 1 to 256. This value should be equal tothe number of drives available to this device class.

To ensure reasonable performance, set the mount limit less than or equal to thenumber of optical drives on the AS/400 system. If the mount limit is set too large, itmay cause the library to frequently mount and dismount cartridges that areaccessed concurrently by the TSM server. This will severely impact performance,because most of the time will be spent moving cartridges instead of actuallyreading or writing data.

If you want to ensure that at least one optical drive on the AS/400 system isavailable for use by applications other than the TSM server, set the mount limitvalue to one less than the number of drives on the system.




DEFINE DEVCLASS — REEL

Privilege Class


Syntax

ÊÊ DEFine DEVclass device_class_name DEVType = REELFORMAT = DRIVE

FORMAT = DRIVE160032006250

Ê

Ê LIBRary = library_nameMOUNTLimit = 1

MOUNTLimit = mountlimitvalueÊ

ÊMOUNTRetention = 60

MOUNTRetention = minutes

PREFIX = ADSM


Ê

ÊESTCAPacity = size

MOUNTWait = 60

MOUNTWait = minutesÊÍ



DEVType=REEL (Required)Specifies the REEL device type is assigned to the device class. REEL indicatesthat reel tape devices are assigned to this device class.


The values for the REEL devices are:

DRIVESpecifies that TSM selects the highest format that can be supported by the



sequential access drive on which a volume is mounted. Attention: Use theDRIVE value only when the device class has compatible sequential accessdevices. If you specify DRIVE for a device class that has non-compatiblesequential access devices, then you must mount volumes on devices that arecapable of reading or writing at the format established when the volume wasfirst mounted. This can cause delays if the only sequential access device thatcan access the volume is already in use.

1600Specifies that the reel tape device can read and write 1600 bits per inch.



LIBRarySpecifies the name of the defined library object that contains the REEL tape drivesthat can be used by this device class. For information about defining a libraryobject, see the DEFINE LIBRARY command.





PREFIXSpecifies the high level qualifier of the data set name that the server writes into thesequential access media labels. The maximum length of this prefix is 8 characters.All sequential access volumes assigned to this device class are prefixed with thisvalue. This parameter is optional. The default value is ADSM.

If you have already established a media label naming convention that supportsyour current management system, consider using a volume prefix that conforms toyour naming conventions.

ESTCAPacitySpecifies the estimated capacity for the sequential access volumes defined to astorage pool categorized by this device class. This parameter is optional. You canspecify this parameter if the default estimated capacity for the device class isinaccurate due to compression of data.





For more information on the default estimated capacity for reel tapes, see Table 51.

Table 51. TSM Estimated Capacity for Reel Tape


1600 44MB

3200 82MB

6250 156MB




Related Commands

Table 52. Commands Related to DEFINE DEVCLASS

Command Description


DELETE DEVCLASS Deletes a device class name.

QUERY DEVCLASS Displays information about device classes.




DEFINE DOMAIN (Define a New Policy Domain)

Use this command to define a new policy domain. A policy domain contains policy sets,management classes, and copy groups. A client is assigned to one policy domain. TheACTIVE policy set in the policy domain determines the rules for clients assigned to thedomain. The rules control the archive, backup, and space management servicesprovided for the clients.

You must activate a policy set in the domain before clients assigned to the policydomain can back up, archive, or migrate files.

Privilege Class


Syntax

ÊÊ DEFine DOmain domain_nameDESCription = description

Ê

ÊBACKRETention = 30

BACKRETention = days

ARCHRETention = 365

ARCHRETention = daysÊÍ


Specifies the name of the policy domain to be defined. The maximum length of thisname is 30 characters.

DESCriptionSpecifies a description of the policy domain. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters.

BACKRETentionSpecifies the number of days (from the date the backup versions became inactive)to retain backup versions of files that are no longer on the client file system. Thisparameter is optional. You can specify an integer from 0 to 9999. The default valueis 30. The server uses the backup retention value to manage inactive versions offiles when any of the following conditions occur:

v A file is rebound to a new management class, but neither the new managementclass nor the default management class contains a backup copy group.

v The management class to which a file is bound no longer exists, and the defaultmanagement class does not contain a backup copy group.

DEFINE DOMAIN


|||||

||

v The backup copy group is deleted from the management class to which a file isbound and the default management class does not contain a backup copygroup.

ARCHRETentionSpecifies the number of days (from the date of archive) to retain archive copies.This parameter is optional. You can specify an integer from 0 to 9999. The defaultvalue is 365. The server uses the archive retention value to manage archive copiesof files when either of the following conditions occur:

v The management class to which a file is bound no longer exists, and the defaultmanagement class does not contain an archive copy group.

v The archive copy group is deleted from the management class to which a file isbound and the default management class does not contain an archive copygroup.

Examples

Task

Define a policy domain with a name of PROG1 and the description, ProgrammingGroup Domain. Specify that archive copies are retained for 90 days when managementclasses or archive copy groups are deleted and the default management class does notcontain an archive copy group. Also specify that backup versions are retained for 60days when management classes or copy groups are deleted and the defaultmanagement class does not contain a backup copy group.

Command:define domain prog1 description="Programming Group Domain"backretention=60 archretention=90

Related Commands

Table 53. Commands Related to DEFINE DOMAIN

Command Description


COPY DOMAIN Creates a copy of a policy domain.





DEFINE DOMAIN


DEFINE DRIVE (Define a Drive to a Library)

Use this command to define a drive that TSM can use to access data on storagevolumes. Each drive is assigned to a single library. You must define this library beforeyou issue this command. You can define more than one drive for a given library byissuing the DEFINE DRIVE command once for each drive. The DEFINE DRIVEcommand only applies to MANUAL library types.

Note: Do not mix emulated device types with actual device types. For example, if a4mm device is emulating an 8mm device, do not mix this emulated 8mm devicewith actual 8mm devices.

Privilege Class


Syntax

ÊÊ DEFine DRive lib_name drive_name DEVIce = device_name Ê

ÊSHARE = No

SHARE = NoYes

AUTOloader = NoYes

ÊÍ

Parameterslib_name (Required)

Specifies the name of the library to which the drive is assigned. This parameter isrequired for all drives, including stand-alone drives. The specified library must havebeen previously defined by using the DEFINE LIBRARY command.

drive_name (Required)Specifies the name that is assigned to the drive. The maximum length of this nameis 30 characters.

DEVIce (Required)Specifies the name of the device that corresponds to the drive. For example, youmight specify tap04.

SHARESpecifies whether or not this drive is a shared device. One or more systems use ashared device. The default is NO. The values are:

No Specifies the drive is not a shared device. If the initial status of the device isvaried offline, the server does not attempt to vary the device online. The serverdoes not use the device.

DEFINE DRIVE


YesSpecifies the drive is a shared device that can be used by one or moresystems. If the initial status of the device is varied offline, the device is variedonline when the server operation begins and is varied offline when the serveroperation ends.

AUTOloaderSpecifies that either a 3480 or 3490 has an automatic cartridge loader (ACL). Thisparameter is optional and only applies to a device class with a device type ofCARTRIDGE (3480/3490). Setting this parameter to YES allows TSM to use theACL. The values are:

No Specifies that an ACL is either not available or not to be used.

YesSpecifies that TSM will use the ACL.

Examples

Task

You have already defined a manual tape library named MANLIB using the DEFINELIBRARY command. You now want to inform the server that you have a tape drive thatcan be used to access storage media. You choose the name TAPEDRIVE3 for thisdrive.

Command:define drive manlib tapedrive3 device=tap04

Related Commands

Table 54. Commands Related to DEFINE DRIVE

Command Description


DELETE DRIVE Deletes a drive from a library.


QUERY DRIVE Displays information about drives.



DEFINE DRIVE


DEFINE EVENTSERVER (Define a Server as the Event Server)

Use this command to identify a server as the event server.

If you define an event server, one TSM server can send events to another TSM serverthat will log those events. See the Administrator’s Guide for information about setting uplogging events to an event server.

Privilege Class


Syntax

ÊÊ DEFine EVENTSERVer server_name ÊÍ

Parametersserver_name (Required)

Specifies the name of the event server. The server you specify must have alreadybeen defined with the DEFINE SERVER command.

Examples

Task

Designate ASTRO to be the event server.

Command:define eventserver astro

Related Commands

Table 55. Commands Related to DEFINE EVENTSERVER

Command Description


DELETE EVENTSERVER Deletes reference to the event server.



PING SERVER Test the connections between servers.

QUERY EVENTSERVER Displays the name of the event server.


DEFINE EVENTSERVER


||

|

|||

|

|

|

||||||||||

|

|

|||

|

|

|

||

|

|||

||

|||

||

||

||

||

||

||

|

DEFINE EXIT (Define an Exit Program)

Use this command to define an exit program and specify its location on the AS/400.

Privilege Class


Syntax

ÊÊ DEFine EXIT MOuntDIsmountDEletionEXpiration

*CURLIB/

*CURLIB/*LIBL/object_library_name/

exit_name ÊÍ

Parametersexit_type (Required)

Specifies which exit program is being defined. The values are:

MOuntSpecifies the mount exit program is being defined.

DIsmountSpecifies the dismount exit program is being defined.

DEletionSpecifies the deletion exit program is being defined.

EXpirationSpecifies the expiration exit program is being defined.

exitlibrarySpecifies which AS/400 library contains the exit program object. This parameter isoptional. The default is *CURLIB. The values are:

*CURLIBThe exit program object is located in the current AS/400 library of the TSMserver.

*LIBLThe exit program object is located in the AS/400 library list of the TSM server.

object_library_nameSpecifies the AS/400 library that contains the exit program object. Themaximum length of this name is 10 characters.

exit_name (Required)Specifies the name of the exit program object. The maximum length of this name is10 characters.

DEFINE EXIT


Examples

Task

Suppose that you have decided to call your mount exit program ADSMMOUNT.Additionally, you have already completed work on this exit program and have placed the*PGM object in an AS/400 library that is named ADSMEXITS. You now wish to informthe server about your mount exit program.

Command:define exit mount adsmexits/adsmmount

Related Commands

Table 56. Commands Related to DEFINE EXIT

Command Description


DELETE EXIT Deletes an existing exit program.

QUERY EXIT Displays information about exit programs.


UPDATE EXIT Changes the attributes of an exit program.


DEFINE EXIT


DEFINE GRPMEMBER (Add a Server to a Server Group)

Use this command to add a server as a member of a server group. You can also addone server group to another server group. A server group lets you route commands tomultiple servers by specifying only the server group name.

Privilege Class


Syntax

ÊÊ DEFine GRPMEMber group_name ·

,

member_name ÊÍ

Parametersgroup_name (Required)

Specifies the name of the server group to which the member will be added.

member_name (Required)Specifies the names of the servers or groups to be added to the group. To specifymultiple servers and groups, separate the names with commas and no interveningspaces. The servers or server groups must already be defined to the server.

Examples

Task 1

Define the server SANJOSE to server group CALIFORNIA.

Command:define grpmember california sanjose

Task 2

Define the server TUCSON and the server group CALIFORNIA to server groupWEST_COMPLEX.

Command:define grpmember west_complex tucson,california

DEFINE GRPMEMBER


||

|||

|

|

|

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

|

|

||

||||

|

|

|

||

|

||

||

Related Commands

Table 57. Commands Related to DEFINE GRPMEMBER

Command Description









DEFINE GRPMEMBER


|

|||

||

|||

||

||

||

||

||

||

||

|

DEFINE LIBRARY (Define a Library)

Use this command to define a library. A library is a collection of one or more drives, andpossibly robotics devices (depending on the library type), which can be used to accessstorage volumes.

Important: Do not mix emulated device types with actual device types. For example, ifa 4mm device is emulating an 8mm device, do not mix this emulated 8mmdevice with actual 8mm devices.

Privilege Class


Syntax

ÊÊ DEFine LIBRary library_nameLIBType = MANUAL

LIBType = MANUAL AAS400MLB BUSRDFN C

ÊÍ

A:

DRIVESELection = AUTOmatic

DRIVESELection = AUTOmaticOPERator

B:

*SYSNAME/CATegory =

*SYSNAME/category_ system_name/

category_name MLD = mld_name

C:

DRIVESELection = EXIT

DRIVESELection = EXITOPERator

DEFINE LIBRARY



Specifies the name of the library to be defined. The maximum length of this nameis 30 characters.

LIBTypeSpecifies the type of library that is being defined. This parameter is optional. Thedefault is MANUAL. The values are:

MANUALSpecifies that the library type is not automated. When volumes need to bemounted on drives that reside in this type of library, messages are sent tomount operators to inform them of the required action. This type of library isused with stand-alone drives. If this parameter is selected or used as thedefault, you can optionally enter the following parameters:

DRIVESELectionSpecifies whether TSM or a mount operator performs the drive selection.This parameter is optional. The default is AUTOMATIC. The values are:

AUTOmaticSpecifies that TSM performs the drive selection. This parameter is thedefault.

OPERatorSpecifies that a mount operator must perform the drive selection.

USRDFNSpecifies that the library type is a user-defined mounting facility that requiresTSM to interact with a set of user-written exit programs. When volumes needto be mounted on drives that reside in this type of library, a mount exitprogram receives control to inform the system of the required action.Generally, this type of library is used with a media management system. If thisparameter is selected, you can optionally enter the following parameters:

DRIVESELectionSpecifies whether TSM, a mount operator or the mount exit programperforms the drive selection. This parameter is optional. The default isEXIT. The values are:

EXITSpecifies that the mount exit program must perform the driveselection. This parameter is the default.


AS400MLBSpecifies that the library type uses the AS/400 automated library support. Ifyou select this parameter, you must also enter the CATEGORY and MLDparameters. The IBM 3590 cartridge tape device with an Automatic CartridgeFacility (ACF) can be accessed via the AS400MLB library type.

CATegorySpecifies the system name and category name for this category.

DEFINE LIBRARY


*SYSNAME/Specifies the system on which the command is being issued. Thisparameter is the default.

category_ system_name/Specifies the system to which the category belongs. This parameter isoptional. The default is *SYSNAME/.

category_nameSpecifies the category name to be used for TSM volumes in thelibrary. This name must be unique within the AS/400 system (that is,other applications utilizing the AS/400 system cannot be using thisname). This parameter is required for AS400MLB library types.

MLDSpecifies the name of the Media Library Device. This parameter isrequired for AS400MLB library types.

Examples

Task 1

Define a library named MANLIB with the library type of MANUAL for which the mountoperator performs the drive selection.

Commanddefine library manlib libtype=manual driveselection=operator

Task 2

Define a library named EZLIFE with a library type of AS400MLB, a category systemname of TUC400E, a category name of ADSMCAT, and a Media Library Device nameof MLD01.

Commanddefine library ezlife libtype=as400mlb category=tuc400e/adsmcatmld=mld01

Task 3

Define a library named HOME with a library type of USRDFN, and indicate that themount exit program should perform drive selection.

Commanddefine library home libtype=usrdfn driveselection=exit

DEFINE LIBRARY


Related Commands

Table 58. Commands Related to DEFINE LIBRARY

Command Description








DEFINE LIBRARY


DEFINE LOGCOPY (Define a Volume Copy of a Recovery Log Volume)

Use this command to create a copy (mirrored volume) of a recovery log volume.Mirroring the recovery log increases the recovery log availability and provides asafeguard against media failure. You can have as many as two copies of a recovery logvolume. After each recovery log volume copy is defined, the server attempts tosynchronize the volume copy with the recovery log.

All recovery log volumes reside on a random access volume. Volume copies must haveat least the same capacity as the original volume and should be defined on separatephysical devices. Any additional space on the volume copy is not used.

This command generates a background process that you can cancel with the CANCELPROCESS command. If a DEFINE LOGCOPY process is canceled, the volume copy iscreated. However, synchronization processing is canceled leaving the volume in a stalestate. To display information on background processes, use the QUERY PROCESScommand.

Privilege Class


Syntax

ÊÊ DEFine LOGCopy volume_name copy_volume_name ÊÍ


Specifies the name of the recovery log to be mirrored.

copy_volume_name (Required)Specifies the file name of the volume you want to assign as a recovery log volumecopy. The name cannot contain any embedded blanks or equal signs.

Enter the file name as either a fully qualified path name or a name relative to theserver’s current AS/400 object library. For example, if the file name is mainvol,enter the path name as:

QUSRADSM/MAINVOL(MAINVOL)

Examples

Task

Create a recovery log volume copy named LOG.2 for the recovery log volume namedLOG.1.

DEFINE LOGCOPY


Command:define logcopy log.1 log.2

Related Commands

Table 59. Commands Related to DEFINE LOGCOPY

Command Description


DEFINE LOGVOLUME Defines a disk volume to the recovery log.

DELETE LOGVOLUME Deletes a volume from the recovery log.

QUERY LOGVOLUME Displays information about log volumes.


DEFINE LOGCOPY


DEFINE LOGVOLUME (Define a Recovery Log Volume)

Use this command to define a new recovery log volume. All recovery log volumes mustreside on random accessvolume. media.

Attention: You cannot change the size of an allocated recovery log volume after youhave defined it to TSM. If you change the size of TSM volumes TSM may not initializecorrectly and you could lose data.

A recovery log volume must be at least 9MB. Storage space is used in 4MB blocks and1MB is used for overhead purposes. For example, if you define a recovery log volumewith a capacity of 9MB, 8MB are available for storage on the volume.

Privilege Class


Syntax

ÊÊ DEFine LOGVolume volume_nameFormatsize = megabytes

Ê

ÊWait = No

Wait = NoYes

ÊÍ


Specifies the file name of the recovery log volume. The name cannot contain anyembedded blanks or equal signs.

Enter this name as either a fully qualified path name or a name relative to theserver’s current AS/400 object library. For example, if the file name is mainvol,enter the path name as:


FormatsizeSpecifies the size of the volume that is defined and formatted in one operation.This parameter is optional. The value is specified in megabytes.

WaitSpecifies whether a volume creation and formatting operation is performed in theforeground or background. This parameter is optional. The default is NO. It isignored unless the FORMATSIZE parameter is also specified.

DEFINE LOGVOLUME


|

|||

||||

No Specifies that a volume creation and formatting operation is performed in thebackground.


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

Examples

Task 1

Define a recovery log volume named LOG.1A located in file LOG that resides in theAS/400 library, QUSRADSM.

Command:define logvolume /qusradsm/log.log1a

Related Commands

Table 60. Commands Related to DEFINE LOGVOLUME

Command Description

DEFINE LOGCOPY Creates a volume copy of a recovery logvolume.


EXTEND LOG Extends usable log storage within the volumespreviously allocated for its use.

QUERY LOG Displays allocation information about therecovery log.


DEFINE LOGVOLUME


|||

|||

|

|

|

DEFINE MACHINE (Define a Machine)

Use this command to save disaster recovery information for a TSM server or clientnode machine.

Note: TSM does not use the information. It is only to help you plan for the disasterrecovery of client machines.

Privilege Class


Syntax

ÊÊ DEFine MAchine machine_nameDESCription = description

Ê

ÊBUilding = building FLoor = floor ROom = room

Ê

ÊPRIority = 50

PRIority = number

ADSMServer = No

ADSMServer = NoYes

ÊÍ

Parametersmachine_name (Required)

Specifies the machine name. The name can be up to 64 characters.

DESCriptionSpecifies a machine description. This parameter is optional. The text can be up to255 characters. Enclose the text in quotation marks if it contains any blankcharacters.

BUildingSpecifies the building that this machine is in. This parameter is optional. The textcan be up to 16 characters. Enclose the text in quotation marks if it contains anyblank characters.

FLoorSpecifies the floor that this machine is on. This parameter is optional. The text canbe up to 16 characters. Enclose the text in quotation marks if it contains any blankcharacters.

DEFINE MACHINE


ROomSpecifies the room that this machine is in. This parameter is optional. The text canbe up to 16 characters. Enclose the text in quotation marks if it contains any blankcharacters.

PRIoritySpecifies the restore priority for the machine. You can specify an integer from 1 to99. The highest priority is 1. This parameter is optional. The default is 50.

ADSMServerSpecifies whether the machine contains a TSM server. Only one machine can bedefined as containing a TSM server. This parameter is optional. The default is NO.Possible values are:

No This machine does not contain a TSM server.

YesThis machine contains a TSM server.

Examples

Task

Define a machine named DISTRICT5, and specify a location, a floor, and a room name.This machine contains critical data and has the highest priority.

Command:define machine district5 building=101 floor=27 room=datafacilitiespriority=1

Related Commands

Table 61. Commands Related to DEFINE MACHINE

Command Description

DEFINE MACHNODEASSOCIATION Associates a TSM node with a machine.

DEFINE RECMEDMACHASSOCIATION Associates recovery media with a machine.

DELETE MACHINE Deletes an existing machine.

INSERT MACHINE Inserts machine characteristics or recoveryinstructions into the TSM database.

QUERY MACHINE Displays information about machines.

UPDATE MACHINE Changes the information of an existing machine.

DEFINE MACHINE


DEFINE MACHNODEASSOCIATION (Associate a Node With a Machine)

Use this command to associate TSM client nodes with a machine. The machine mustbe defined to TSM, and the nodes must be registered to TSM. During disaster recovery,you can use this information to determine what TSM client nodes resided on destroyedmachines. To retrieve the information, issue the QUERY MACHINE command.

Note: TSM does not use the information. It is available only to help you plan for thedisaster recovery of client machines.

A node remains associated with a machine unless the node, the machine, or theassociation itself is deleted.

Privilege Class


Syntax

ÊÊ DEFine MACHNODEAssociation machine_name ·

,

node_name ÊÍ


Specifies the machine name.

node_name (Required)Specifies the node names. A node can only be associated with one machine. Tospecify multiple nodes, separate the names with commas and no interveningspaces. You can use wildcard characters to specify a name.

Examples

Task

Associate the node named ACCOUNTSPAYABLE with the machine named DISTRICT5.

Command:define machnodeassociation district5 accountspayable

Related Commands

Table 62. Commands Related to DEFINE MACHNODEASSOCIATION

Command Description

DEFINE MACHINE Defines a machine for DRM.



Table 62. Commands Related to DEFINE MACHNODEASSOCIATION (continued)

Command Description


DELETE MACHNODEASSOCIATION Deletes association between a machine andnode.



REMOVE NODE Removes a client from the list of registerednodes for a specific policy domain.



DEFINE MGMTCLASS (Define a Management Class)

Use this command to define a new management class in a policy set. To allow clientsto use the new management class, you must activate the policy set that contains thenew class.

You can define one or more management classes for each policy set in a policydomain. A management class can contain a backup copy group, an archive copy group,or both. The user of a client node can select any management class in the active policyset or use the default management class.

Note: The DEFINE MGMTCLASS command fails if a copy storage pool is specified asthe destination for space-managed files.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege for the policy domain to which the management class belongs.

Syntax

ÊÊ DEFine MGmtclass domain_name policy_set_name class_name Ê

ÊSPACEMGTECHnique = NONE

SPACEMGTECHnique = AUTOmaticSELectiveNONE

AUTOMIGNOnuse = 0

AUTOMIGNOuse = daysÊ

ÊMIGREQUIRESBkup = Yes

MIGREQUIRESBkup = YesNo

MIGDESTination = pool_nameÊ

ÊDESCription = description

ÊÍ



policy_set_name (Required)Specifies the policy set to which the management class belongs. You cannot definea management class to the ACTIVE policy set.

DEFINE MGMTCLASS


class_name (Required)Specifies the name of the new management class. The maximum length of thisname is 30 characters. You cannot use either default or grace_period as a classname.

SPACEMGTECHniqueSpecifies whether a file using this management class is eligible for migration. Thisparameter is optional. The default is NONE. This parameter is effective only forTivoli Space Manager clients (also known as HSM clients), not for backup-archiveclients or application clients. Possible values are:

AUTOmaticSpecifies that the file is eligible for both automatic migration and selectivemigration.

SELectiveSpecifies that the file is eligible for selective migration only.

NONESpecifies that the file is not eligible for migration.

AUTOMIGNOnuseSpecifies the number of days that must elapse since a file was last accessedbefore it is eligible for automatic migration. This parameter is optional. The defaultvalue is 0. If SPACEMGTECHNIQUE is not AUTOMATIC, the server ignores thisattribute. You can specify an integer from 0 to 9999.

This parameter is effective only for HSM clients, not for backup-archive clients orapplication clients.

MIGREQUIRESBkupSpecifies whether a backup version of a file must exist before a file can bemigrated. This parameter is optional. The default is YES. This parameter iseffective only for HSM clients, not for backup-archive clients or application clients.Possible values are:

YesSpecifies that a backup version must exist.

No Specifies that a backup version is optional.

MIGDESTinationSpecifies the primary storage pool where the server initially stores files migratedfrom HSM clients. This parameter is effective only for HSM clients, not forbackup-archive clients or application clients.

The command fails if you specify a copy storage pool as the destination.

DESCriptionSpecifies a description of the management class. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters.

DEFINE MGMTCLASS


||||

||

|

|

Examples

Task

Define a management class called MCLASS1 for policy set SUMMER in the PROG1policy domain. For HSM clients, allow both automatic and selective migration, and storemigrated files in the SMPOOL storage pool. Add the description, Technical SupportMgmt Class.

Command:define mgmtclass prog1 summer mclass1 spacemgtechnique=automaticmigdestination=smpool description="technical support mgmt class"

Related Commands

Table 63. Commands Related to DEFINE MGMTCLASS

Command Description











DEFINE MGMTCLASS


DEFINE POLICYSET (Define a Policy Set)

Use this command to define a policy set in a policy domain. A policy set containsmanagement classes, which contain copy groups. You can define one or more policysets for each policy domain. To put a policy set into effect, you must activate the policyset by using the ACTIVATE POLICYSET command. Only one policy set can be active ina policy domain. The copy groups and management classes within the active policy setdetermine the rules by which client nodes perform backup, archive, and spacemanagement operations, and how the client files stored are managed.

Use the VALIDATE POLICYSET command to verify that a policy set is complete andvalid before activating it with the ACTIVATE POLICYSET command.

Privilege Class


Syntax

ÊÊ DEFine POlicyset domain_name policy_set_name Ê


ÊÍ


Specifies the name of the policy domain to which the policy set belongs.

policy_set_name (Required)Specifies the name of the policy set. The maximum length of this name is 30characters. You cannot define a policy set named ACTIVE.

DESCriptionSpecifies a description for the new policy set. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters.

Examples

Task

Define a policy set called SUMMER for the PROG1 policy domain and include thedescription, Programming Group Policies.

Command:define policyset prog1 summer description="Programming Group Policies"

DEFINE POLICYSET


|||||||

Related Commands

Table 64. Commands Related to DEFINE POLICYSET

Command Description










DEFINE POLICYSET


DEFINE PROFASSOCIATION (Define a Profile Association)

Use this command on a configuration manager to associate one or more objects with aconfiguration profile for distribution to subscribing managed servers. After a managedserver subscribes to a profile, the configuration manager sends object definitionsassociated with the profile to the managed server where they are stored in thedatabase. Objects created this way in the database of a managed server becomemanaged objects. An object can be associated with more than one profile.

You can use this command to define an initial set of profile associations and to add toexisting associations.

You can associate the following types of objects with a profile:

v Administrator registrations and authorities

v Policy domains, which include the domains’ policy sets, management classes, copygroups, and client schedules.

v Administrative schedules

v Server command scripts

v Client option sets

v Server definitions

v Server group definitions

Note: The configuration manager does not distribute status information for an object tomanaged servers. For example, information such as the number of days sincean administrator last accessed the server is not distributed to managed servers.This type of information is maintained in the databases of the individualmanaged servers.

Privilege Class


Syntax

ÊÊ DEFine PROFASSOCiation profile_name

·

ADMins = *,

admin_name

Ê



||

||||||

||

|

|

||

|

|

|

|

|

|||||

|

|

|

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

||

Ê

·

DOmains = *,

domain_name

Ê

Ê

·

ADSCHeds = *,

schedule_name

Ê

Ê

·

SCRipts = *,

script_name

Ê

Ê

·

CLOptsets = *,

option_set_name

Ê

Ê

·

SERVers = *,

server_name

Ê

Ê

·

SERVERGroups = *,

group_name

ÊÍ

Parametersprofile_name (Required)

Specifies the name of the configuration profile.

ADMinsSpecifies administrators to associate with the profile. You can use wildcardcharacters in the names. You can specify more than one name by separating thenames with commas and no intervening spaces. Use the match-all definition, anasterisk (*) by itself, to specify all administrators that are registered with theconfiguration manager. If you specify the match-all definition and later add moreadministrators, they are automatically distributed through the profile.



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

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

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

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

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

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

|

|

||

|||||||

The configuration manager distributes the administrator name, password, contactinformation, and authorities of administrators associated with the profile. Theconfiguration manager does not distribute the following:

v The administrator named SERVER_CONSOLE, even if you use a match-alldefinition

v The locked or unlocked status of an administrator

When the profile already has administrators associated with it, the following apply:

v If you specify a list of administrators and a list already exists, TSM combines thenew list with the existing list.

v If you specify a match-all definition and a list of administrators already exists,TSM replaces the list with the match-all definition.

v If you specify a list of administrators, and a match-all definition had previouslybeen specified, TSM ignores the list. To remove the match-all definition, issuethe DELETE PROFASSOCIATION command with the ADMINS=* parameter.

DOmainsSpecifies policy domains to associate with the profile. You can use wildcardcharacters in the names. You can specify more than one name by separating thenames with commas and no intervening spaces. Use the match-all definition, anasterisk (*) by itself, to specify all domains that are defined on the configurationmanager. If you specify the match-all definition and later add more domains, theyare automatically distributed through the profile.

The configuration manager distributes domain information that includes definitionsof policy domains, policy sets, management classes, copy groups, and clientschedules. The configuration manager does not distribute the ACTIVE policy set.Administrators on a managed server can activate any policy set within a manageddomain on a managed server.

When the profile already has domains associated with it, the following apply:

v If you specify a list of domains and a list already exists, TSM combines the newlist with the existing list.

v If you use a match-all definition and a list of domains already exists, TSMreplaces the list with the match-all definition.

v If you specify a list of domains, and a match-all definition had previously beenspecified, TSM ignores the list. To remove the match-all definition, issue theDELETE PROFASSOCIATION command with the DOMAINS=* parameter.

Attention: Client operations such as backup and archive fail if destination pools donot exist. Therefore, managed servers that subscribe to this profile must havedefinitions for any storage pools specified as destinations in the associateddomains. Use the RENAME STGPOOL command to rename existing storage poolsto match the destination names distributed.

ADSCHedsSpecifies administrative schedules to associate with the profile. You can usewildcard characters in the names. You can specify more than one name byseparating the names with commas and no intervening spaces. Use the match-alldefinition, an asterisk (*) by itself, to specify all administrative schedules that are



|||

||

|

|

||

||

|||

|||||||

|||||

|

||

||

|||

|||||

|||||

defined on the configuration manager. If you specify the match-all definition andlater add more administrative schedules, they are automatically distributed throughthe profile.

Note: Administrative schedules are not active when they are distributed by aconfiguration manager. An administrator on a managed server must activateany schedule to have it run on that server.

When the profile already has administrative schedules associated with it, thefollowing apply:

v If you specify a list of administrative schedules and a list already exists, TSMcombines the new list with the existing list.

v If you use a match-all definition and a list of administrative schedules alreadyexists, TSM replaces the list with the match-all definition.

v If you specify a list of administrative schedules, and a match-all definition hadpreviously been specified, TSM ignores the list. To remove the match-alldefinition, issue the DELETE PROFASSOCIATION command with theADSCHEDS=* parameter.

SCRiptsSpecifies server command scripts to associate with the profile. You can usewildcard characters in the names. You can specify more than one name byseparating the names with commas and no intervening spaces. Use the match-alldefinition, an asterisk (*) by itself, to specify all scripts that are defined on theconfiguration manager. If you specify the match-all definition and later add morescripts, they are automatically distributed through the profile.

When the profile already has scripts associated with it, the following apply:

v If you specify a list of scripts and a list already exists, TSM combines the newlist with the existing list.

v If you use a match-all definition and a list of scripts already exists, TSM replacesthe list with the match-all definition.

v If you specify a list of scripts, and a match-all definition had previously beenspecified, TSM ignores the list. To remove the match-all definition, issue theDELETE PROFASSOCIATION command with the SCRIPTS=* parameter.

CLOptsetsSpecifies client option sets to associate with the profile. You can use wildcardcharacters in the names. You can specify more than one name by separating thenames with commas and no intervening spaces. Use the match-all definition, anasterisk (*) by itself, to specify all client option sets that are defined on theconfiguration manager. If you specify the match-all definition and later add moreclient option sets, they are automatically distributed through the profile.

When the profile already has client option sets associated with it, the followingapply:

v If you specify a list of client option sets and a list already exists, TSM combinesthe new list with the existing list.

v If you use a match-all definition and a list of client option sets already exists,TSM replaces the list with the match-all definition.



|||

|||

||

||

||

||||

|||||||

|

||

||

|||

|||||||

||

||

||

v If you specify a list of client option sets, and a match-all definition had previouslybeen specified, TSM ignores the list. To remove the match-all definition, issuethe DELETE PROFASSOCIATION command with the CLOPSETS=* parameter.

SERVersSpecifies server definitions to associate with the profile. The definitions aredistributed to managed servers that subscribe to this profile. You can use wildcardcharacters in the names. You can specify more than one name by separating thenames with commas and no intervening spaces. Use the match-all definition, anasterisk (*) by itself, to specify all servers that are defined on the configurationmanager. If you specify the match-all definition and later add more servers, theyare automatically distributed through the profile.

The configuration manager distributes the following server attributes:communication method, IP address, port address, server password, URL, and thedescription. Distributed server definitions always have the ALLOWREPLACEattribute set to YES on the managed server, regardless of this parameter’s valueon the configuration manager. On the managed server, you can use the UPDATESERVER command to set all other attributes.

When the profile already has servers associated with it, the following apply:

v If you specify a list of servers and a list already exists, TSM combines the newlist with the existing list.

v If you use a match-all definition and a list of servers already exists, TSMreplaces the list with the match-all definition.

v If you specify a list of servers, and a match-all definition had previously beenspecified, TSM ignores the list. To remove the match-all definition, issue theDELETE PROFASSOCIATION command with the SERVERS=* parameter.

Notes:

1. A server definition on a managed server is not replaced by a definition from theconfiguration manager unless you have allowed replacement of the definitionon the managed server. To allow replacement, on the managed server updatethe server definition by using the UPDATE SERVER command withALLOWREPLACE=YES.

2. If a configuration manager distributes a server definition to a managed server,and a server group of the same name exists on the managed server, thedistributed server definition replaces the server group definition.

SERVERGroupsSpecifies server groups to associate with the profile. You can use wildcardcharacters in the names. You can specify more than one name by separating thenames with commas and no intervening spaces. Use the match-all definition, anasterisk (*) by itself, to specify all server groups that are defined on theconfiguration manager. If you specify the match-all definition and later add moreserver groups, they are automatically distributed through the profile.

Note: A configuration manager does not distribute a server group definition to amanaged server if the managed server has a server defined with the samename as that of the server group.



|||

||||||||

||||||

|

||

||

|||

|

|||||

|||

|||||||

|||

When the profile already has server groups associated with it, the following apply:

v If you specify a list of server groups and a list already exists, TSM combines thenew list with the existing list.

v If you use a match-all definition and a list of server groups already exists, TSMreplaces the list with the match-all definition.

v If you specify a list of server groups, and a match-all definition had previouslybeen specified, TSM ignores the list. To remove the match-all definition, issuethe DELETE PROFASSOCIATION command with the SERVERGROUPS=*parameter.

Examples

Task 1

Associate a domain named MARKETING with a profile named DELTA.

Command:define profassociation delta domains=marketing

Task 2

You have already associated a list of domains with a profile named GAMMA. Nowassociate all domains defined on the configuration manager with the profile.

Command:define profassociation gamma domains=*

Related Commands

Table 65. Commands Related to DEFINE PROFASSOCIATION

Command Description

COPY PROFILE Creates a copy of a profile.












|

||

||

||||

|

|

|

||

|

||

||

|

|||

||

||

|||

|||

||

||

|||

||

|||

|||

||

DEFINE PROFILE (Define a Profile)

Use this command on a configuration manager to define a profile (a set of configurationinformation) that can be distributed to managed servers.

After defining a profile, you can use the DEFINE PROFASSOCIATION command tospecify objects to be distributed to managed servers subscribing to the profile.

Privilege Class


Syntax

ÊÊ DEFine PROFIle profile_nameDESCription = description

ÊÍ


Specifies the name of the profile. The maximum length of the name is 30characters.

DESCriptionSpecifies a description of the profile. The maximum length of the description is 255characters. Enclose the description in quotation marks if it contains any blankcharacters. This parameter is optional.

Examples

Task

Define a profile named ALPHA with a description of Programming Center.

Command:define profile alpha description="Programming Center"

Related Commands

Table 66. Commands Related to DEFINE PROFILE

Command Description





DEFINE PROFILE


||

||

||

|

|

|

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

|

|

|||

||||

|

|

|

||

|

|||

||

||

||

||

|||

Table 66. Commands Related to DEFINE PROFILE (continued)

Command Description







DEFINE PROFILE


|

||

||

||

||

|||

|||

||

|

DEFINE RECMEDMACHASSOCIATION (Associate Recovery Media with aMachine)

Use this command to associate recovery media with one or more machines. A machineis associated with recovery media so that the location of the boot media and its list ofvolume names are available to recover the machine. To retrieve the information, issuethe QUERY MACHINE command.

Note: TSM does not use the information in any way. It is available only to help youplan for the disaster recovery of client machines.

To associate a machine with recovery media, both the machine and media must bedefined to TSM. A machine remains associated with the media until the association, themedia, or the machine is deleted.

Privilege Class


Syntax

ÊÊ DEFine RECMEDMACHAssociation media_name ·

,

machine_name ÊÍ

Parametersmedia_name (Required)

Specifies the name of the recovery media with which one or more machines will beassociated.

machine_name (Required)Specifies the name of the machines to be associated with the recovery media. Amachine can be associated with multiple recovery media. To specify a list ofmachines, separate the names with commas and without intervening spaces. Youcan use wildcard characters to specify a name.

Examples

Task

Associate machines DISTRICT1 and DISTRICT5 to the DIST5RM recovery media.

Command:define recmedmachassociation dist5rm district1,district5



Related Commands

Table 67. Commands Related to DEFINE RECMEDMACHASSOCIATION

Command Description


DEFINE RECOVERYMEDIA Defines the media required to recover amachine.


DELETE RECMEDMACHASSOCIATION Deletes association between recovery mediaand a machine.

DELETE RECOVERYMEDIA Deletes existing recovery media.


QUERY RECOVERYMEDIA Displays media available for machine recovery.



DEFINE RECOVERYMEDIA (Define Recovery Media)

Use this command to define the media needed to recover a machine. The same mediacan be associated with multiple machines. To display the information, use the QUERYMACHINE command.


Privilege Class


Syntax

ÊÊ DEFine RECOVERYMedia media_name

·

,

VOLumenames = volume_name

Ê

ÊDESCription = description LOcation = location

Ê

ÊType = OTher

Type = OTherBOot

PROduct = product_nameÊ

ÊPRODUCTInfo = product_information

ÊÍ


Specifies the name of the recovery media to be defined. The name can be up to 30characters.

VOLumenamesSpecifies the names of volumes that contain the recoverable data (for example,operating system image copies). This parameter is required if you specify a mediatype of BOOT. Specify boot media volume names in the order in which they are tobe inserted into the machine at recovery time. The maximum length of the volumenames list is 255 characters. Enclose the list in quotation marks if it contains anyblank characters.



DESCriptionSpecifies the description of the recovery media. This parameter is optional. Themaximum length is 255 characters. Enclose the text in quotation marks if itcontains any blank characters.

LOcationSpecifies the location of the recovery media. This parameter is optional. Themaximum length is 255 characters. Enclose the text in quotation marks if itcontains any blank characters.

TypeSpecifies the type of recovery media. This parameter is optional. The default isOTHER.

BOotSpecifies that this is boot media. You must specify volume names if the type isBOOT.

OTherSpecifies that this is not boot media. For example, a CD-ROM that containsoperating system manuals.

PROductSpecifies the name of the product that wrote to this media. This parameter isoptional. The maximum length is 16 characters. Enclose the text in quotation marksif it contains any blank characters.

PRODUCTInfoSpecifies information about the product that wrote to the media. This would beinformation that you may need to restore the machine. This parameter is optional.The maximum length is 255 characters. Enclose the text in quotation marks if itcontains any blank characters.

Examples

Task

Define the recovery media named DIST5RM. Include a description and the location.

Command:define recoverymedia dist5rm description="district 5 base system image"location="district 1 vault"

Related Commands

Table 68. Commands Related to DEFINE RECOVERYMEDIA

Command Description






Table 68. Commands Related to DEFINE RECOVERYMEDIA (continued)

Command Description

UPDATE RECOVERYMEDIA Changes the attributes of existing recoverymedia.



DEFINE SCHEDULE (Define a Client or an Administrative Command Schedule)

Use this command to create a client or administrative command schedule.

For each schedule, a startup window is specified. The startup window is the time periodduring which the schedule must be initiated. The schedule will not necessarily completeprocessing within this window. If the server is not running when this window starts, butis started before the end of the defined window is reached, the schedule will run whenthe server is restarted.

The DEFINE SCHEDULE command takes two forms, depending on whether theschedule applies to client operations or administrative commands. The syntax andparameters for each form are defined separately.

DEFINE SCHEDULE


DEFINE SCHEDULE — Client

Use the DEFINE SCHEDULE command to define a client schedule that TSM uses toperform automatic backup and archive operations for your client workstation at specifiedintervals or times. After you define a schedule, use the DEFINE ASSOCIATIONcommand to associate the client with the schedule. The client scheduler must bestarted on the client workstation in order for TSM to process the schedule.

Note: Not all clients can run all scheduled operations, even though TSM allows you todefine the schedule on the server and associate it with the client. For example, aMacintosh client cannot run a schedule when the action is to restore or retrievefiles, or run an executable script. An executable script is also known as acommand file, a batch file, or a script on different client operating systems.

Privilege Class

To define a client schedule, you must have system privilege, unrestricted policyprivilege, or restricted policy privilege for the policy domain to which the schedulebelongs.

Syntax

ÊÊ DEFine SCHedule domain_name schedule_nameType = Client

Ê


ACTion = Incremental

ACTion = IncrementalSelectiveArchiveREStoreRETrieveCommandMacro

Ê

ÊOPTions = option_string (1)

OBJects = object_string

Ê

ÊPRIority = 5

PRIority = number

STARTDate = current_date

STARTDate = dateÊ



ÊSTARTTime = current_time

STARTTime = time

DURation = 1

DURation = numberÊ

ÊDURUnits = Hours

DURUnits = MinutesHoursDaysINDefinite

PERiod = 1

PERiod = numberÊ

ÊPERUnits = Days

PERUnits = HoursDaysWeeksMonthsYearsOnetime

DAYofweek = ANY

DAYofweek = ANYWEEKDayWEEKEndSUndayMondayTUesdayWednesdayTHursdayFridaySAturday

Ê

ÊEXPiration = Never

EXPiration = Neverdate

ÊÍ

Notes:

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


Specifies the name of the policy domain to which this schedule belongs.

schedule_name (Required)Specifies the name of the schedule to be defined. You can specify up to 30characters for the name.

Type=ClientSpecifies that a schedule for a client is defined. This parameter is optional.

DESCriptionSpecifies a description of the schedule. This parameter is optional. You can specifyup to 255 characters for the description. Enclose the description in quotation marksif it contains any blank characters.













MAXCMDRETRIES

QUERYSCHEDPERIOD

RETRYPERIOD

SCHEDLOGNAME

SCHEDMODE

SERVERNAME

TCPCLIENTADDRESS

TCPCLIENTPORT

OBJectsSpecifies the objects (file spaces or directories) for which the specified action is



performed. To select all file spaces or directories, explicitly list them in theobject-string. Entering an asterisk will cause the backup to only occur for thedirectory where the scheduler was started. This parameter is required except whenACTION=INCREMENTAL.







PRIoritySpecifies the priority value for a schedule. This parameter is optional. You canspecify an integer from 1 to 10, with 1 being the highest priority and 10 being thelowest. The default is 5.

If two or more schedules have the same window start time, the value you specifydetermines when TSM processes the schedule. The schedule with the highestpriority starts first. For example, a schedule with PRIORITY=3 starts before aschedule with PRIORITY=5.

STARTDateSpecifies the date for the beginning of the window in which the schedule is firstprocessed. This parameter is optional. The default is the current date. Use thisparameter with the STARTTIME parameter to specify when the initial startupwindow of the schedule starts.

You can specify the data using one of the values below:

Value Description Example

MM/DD/YYYY A specific date 09/15/1998

TODAY The current date TODAY

TODAY+days or+days

The current date plus daysspecified. The maximum numberof days you can specify is 9999.

TODAY +3 or +3.

STARTTimeSpecifies the time for the beginning of the window in which the schedule is firstprocessed. This parameter is optional. The default is the current time. Thisparameter is used in conjunction with the STARTDATE parameter to specify whenthe initial startup window begins.





HH:MM:SS A specific time 10:30:08

NOW The current time NOW

NOW+HH:MM or+HH:MM

The current time plus hours andminutes specified

NOW+02:00 or +02:00.

If you issue this command at 5:00 withSTARTTIME=NOW+02:00 orSTARTTIME=+02:00, the beginning of thestartup window is at 7:00.

NOW−HH:MMor−HH:MM

The current time minus hours andminutes specified

NOW−02:00 or –02:00.

If you issue this command at 5:00 withSTARTTIME=NOW–02:00 orSTARTTIME=-02:00, the beginning of thestartup window is at 3:00.

DURationSpecifies the number of units that define the length of the startup window of thescheduled operation. This parameter is optional. This value must be from 1 to 999.The default is 1.

Use this parameter with the DURUNITS parameter to specify the length of thestartup window. For example, if you specify DURATION=20 andDURUNITS=MINUTES, the schedule must be started within 20 minutes of the startdate and start time. The default length of the startup window is 1 hour. Theduration of the window must be shorter than the period between windows.

This value is ignored if you specify DURUNITS=INDEFINITE.

DURUnitsSpecifies the time units used to determine the duration of the window in which theschedule can start. This parameter is optional. The default is HOURS.

Use this parameter with the DURATION parameter to specify how long the startupwindow remains open to process the schedule. For example, if DURATION=20 andDURUNITS=MINUTES, the schedule must be started within 20 minutes of the startdate and start time. The schedule may not necessarily complete processing withinthis window. If the schedule needs to be retried for any reason, the retry attemptsmust begin before the startup window elapses, or the operation does not restart.

The default value for the length of the startup window is 1 hour. Possible valuesare:

MinutesSpecifies that the duration of the window is defined in minutes.

HoursSpecifies that the duration of the window is defined in hours.

DaysSpecifies that the duration of the window is defined in days.



INDefiniteSpecifies that the startup window of the scheduled operation has an indefiniteduration. The schedule can run any time after the scheduled start time, untilthe schedule expires. You cannot specify DURUNITS=INDEFINITE, unless youspecify PERUNITS=ONETIME.

PERiodSpecifies the length of time between startup windows for this schedule. Thisparameter is optional. You can specify an integer from 1 to 999. The default is 1.

Use this parameter with the PERUNITS parameter to specify the period betweenstartup windows. For example, if you specify PERIOD=5 and PERUNITS=DAYS(assuming that DAYOFWEEK=ANY), the operation is scheduled every five daysafter the initial start date and start time. The period between startup windows mustexceed the duration of each window. The default is 1 day.

This value is ignored if you specify PERUNITS=ONETIME.

PERUnitsSpecifies the time units used to determine the period between startup windows forthis schedule. This parameter is optional. The default is DAYS.

Use this parameter with the PERIOD parameter to specify the period betweenstartup windows. For example, if you specify PERIOD=5 and PERUNITS=DAYS(assuming that DAYOFWEEK=ANY), the operation is scheduled every 5 days afterthe initial start date and start time. The default is 1 day. Possible values are:

HoursSpecifies that the time between startup windows is in hours.

DaysSpecifies that the time between startup windows is in days.

WeeksSpecifies that the time between startup windows is in weeks.

MonthsSpecifies that the time between startup windows is in months.

Note: When you specify PERUNITS=MONTHS, the scheduled operation willbe processed each month on the same date. For example, If the startdate for the scheduled operation is 02/04/1998, the schedule willprocess on the 4th of every month thereafter. However, if the date is notvalid for the next month, then the scheduled operation will be processedon the last valid date in the month. Thereafter, subsequent operationsare based on this new date. For example, if the start date is03/31/1998, the next month’s operation will be scheduled for04/30/1998. Thereafter, all subsequent operations will be on the 30th ofthe month until February. Because February has only 28 days, theoperation will be scheduled for 02/28/1999. Subsequent operations willbe processed on the 28th of the month.

YearsSpecifies that the time between startup windows for the schedule is in years.



Note: When you specify PERUNITS=YEARS, the scheduled operation will beprocessed on the same month and date of each year. For example, ifthe start date for the scheduled operation is 02/29/2004, the next year’sscheduled operation will be 02/28/2005 because February only has 28days. Thereafter, subsequent operations will be scheduled for February28th.

OnetimeSpecifies that the schedule processes once. This value overrides the value youspecified for the PERIOD parameter.

DAYofweekSpecifies the day of the week on which the startup window for the schedule begins.This parameter is optional. If the start date and start time fall on a day that doesnot correspond to a day you specify, the start date and start time will be shiftedforward in 24-hour increments until the DAYOFWEEK parameter is satisfied.

If you select a value for DAYOFWEEK other than ANY, and depending on thevalues for PERIOD and PERUNITS, schedules may not be processed when youwould expect. The default is ANY. Possible values are:

ANYSpecifies that the startup window can begin on any day of the week.

WEEKDaySpecifies that the startup window can begin on Monday, Tuesday, Wednesday,Thursday, or Friday.

WEEKEndSpecifies that the startup window can begin on Saturday or Sunday.

SUndaySpecifies that the startup window begins on Sunday.

MondaySpecifies that the startup window begins on Monday.

TUesdaySpecifies that the startup window begins on Tuesday.

WednesdaySpecifies that the startup window begins on Wednesday.

THursdaySpecifies that the startup window begins on Thursday.

FridaySpecifies that the startup window begins on Friday.

SAturdaySpecifies that the startup window begins on Saturday.

EXPirationSpecifies the date after which this schedule is no longer used. This parameter isoptional. The default is NEVER. Possible values are:



NeverSpecifes that the schedule never expires.

expirationdateSpecifies the date on which this schedule expires, in MM/DD/YYYY format. Ifyou specify an expiration date, the schedule expires at 23:59:59 on the dateyou specify.

Examples

Task 1

Define a schedule named MONTHLY_BACKUP that initiates an incremental backup ofall associated nodes. Because the specified start date, May 1, 1997 (05/01/1997), is aThursday and does not match the specified day of the week (Sunday), the initial startupwindow begins on the first Sunday after May 1, 1997 (05/01/1997). The startupwindows for this schedule extend from 01:00 through 03:00. This monthly scheduleinitiates backup of c: and d: file spaces for all associated nodes.

Command:define schedule standard monthly_backup description="Monthly Backup ofc: and d: drives" objects="c:\* d:\*" startdate=05/01/1997starttime=01:00 duration=2 durunits=hours period=1 perunits=monthsdayofweek=sunday

Task 2

Define a schedule named WEEKLY_BACKUP that initiates an incremental backup of allassociated nodes. The initial startup window for this schedule extends from 23:00 onSaturday, June 7, 1997 (06/07/1997), to 03:00 on Sunday, June 8, 1997 (06/08/1997).Subsequent windows begin at 23:00, every Saturday. No messages are returned to theclient node when this schedule is executed.

Command:define schedule employee_records weekly_backup startdate=06/07/1997starttime=23:00 duration=4 durunits=hours perunits=weeksdayofweek=saturday options=-quiet



DEFINE SCHEDULE — Administrative Command

Use the DEFINE SCHEDULE command to create a new schedule for processing anadministrative command. You can include scripts in an administrative commandschedule so that they are processed automatically.

Note: You cannot schedule the MACRO command or the QUERY ACTLOG command.

Privilege Class

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

Syntax

ÊÊ DEFine SCHedule schedule_nameType = Administrative

CMD = command Ê

ÊACTIVE = No

ACTIVE = Yes DESCription = description

PRIority = 5

PRIority = numberÊ

ÊSTARTDate = current_date

STARTDate = date

STARTTime = current_time

STARTTime = timeÊ

ÊDURation = 1

DURation = number

DURUnits = Hours

DURUnits = MinutesHoursDaysINDefinite

PERiod = 1

PERiod = numberÊ

ÊPERUnits = Days

PERUnits = HoursDaysWeeksMonthsYearsOnetime

DAYofweek = ANY

DAYofweek = ANYWEEKDayWEEKEndSUndayMondayTUesdayWednesdayTHursdayFridaySAturday

Ê



ÊEXPiration = Never

EXPiration = Neverdate

ÊÍ

Parametersschedule_name (Required)

Specifies the name of the schedule to be defined. You can specify up to 30characters for the name.

Type=AdministrativeSpecifies that a schedule for an administrative command is defined. This parameteris optional. An administrative command is assumed if the CMD parameter isspecified.

CMD (Required)Specifies the administrative command to schedule for processing. The maximumlength of the command is 512 characters. Enclose the administrative command inquotation marks if it contains any blank characters.

Note: Redirection characters cannot be specified with this parameter.

ACTIVESpecifies whether TSM processes an administrative command schedule when thestartup window occurs. This parameter is optional. The default is NO. Theadministrative command schedule must be set to the active state with the UPDATESCHEDULE command so that TSM can process the schedule. Possible values are:

YESSpecifies that TSM processes an administrative command schedule when thestartup window begins.

NOSpecifies that TSM does not process an administrative command schedulewhen the startup window begins.

DESCriptionSpecifies a description of the schedule. This parameter is optional. You can specifyup to 255 characters for the description. Enclose the description in quotation marksif it contains any blank characters.










TODAY+days or+days


TODAY +3 or +3.






NOW+HH:MM or+HH:MM


NOW+02:00 or +02:00.




NOW−02:00 or –02:00.

















Examples

Task

Define a schedule named BACKUP_ARCHIVEPOOL that backs up the primary storagepool ARCHIVEPOOL to the copy storage pool RECOVERYPOOL. The backup runs at 8p.m. every two days.

Command:define schedule backup_archivepool type=administrative cmd="backupstgpool archivepool recoverypool" active=yes starttime=20:00 period=2



Related Commands

Table 69. Commands Related to DEFINE SCHEDULE

Command Description

COPY SCHEDULE Creates a copy of a schedule.





SET MAXCMDRETRIES Specifies the maximum number of retries after afailed attempt to execute a scheduled command.

SET MAXSCHEDSESSIONS Specifies the maximum number of client/serversessions available for processing scheduledwork.

SET RETRYPERIOD Specifies the time between retry attempts by theclient scheduler.




DEFINE SCRIPT (Define a Tivoli Storage Manager Script)

Use this command to define a TSM script or to create a new TSM script using thecontents from another script.

The first line for the script may be defined with this command. To add subsequent linesto the script, use the UPDATE SCRIPT command.

Note: When routing commands inside scripts, enclose the server or server group inparentheses and omit the colon. If the syntax includes a colon, the command isnot routed when the RUN command is issued. Instead, the command will onlyrun on the server from which the RUN command is issued.

Privilege Class

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

Syntax

ÊÊ DEFine SCRipt script_nameLine = 001

command_lineLine = number

File = file_name

Ê


ÊÍ

Parametersscript_name (Required)

Specifies the name of the script to be defined. You can specify up to 30 charactersfor the name.

command_lineSpecifies the first command to be processed in a script. You must specify eitherthis parameter (and, optionally, the LINE parameter) or the FILE parameter.

The command you specify can include substitution variables and can be continuedacross multiple lines if you specify a continuation character (-) as the last characterin the command. Substitution variables are specified with a ’$’ character, followedby a number that indicates the value of the parameter when the script isprocessed. You can specify up to 1200 characters for the command line. Enclosethe command in quotation marks if it contains blanks.

LineSpecifies the line number for the command line. Because commands arespecified in multiple lines, line numbers are used to determine the order forprocessing when the script is run. The first line, or line 001 is the default. Thisparameter is optional.

DEFINE SCRIPT


||

||

||

||||

|

|

|

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

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

|

|

|||

|||

||||||

|||||

FileSpecifies the name of the file whose contents will be read into the script to bedefined. The file must reside on the server running this command. If you specifythe FILE parameter, you cannot specify a command line or line number.

You can create a script by querying another script and specifying theFORMAT=RAW and OUTPUTFILE parameters. The output from querying the scriptis directed to a file you specify with the OUTPUTFILE parameter. To create the newscript, the contents of the script to be defined are read in from the file you specifiedwith the OUTPUTFILE parameter.

DESCriptionSpecifies a description for the script. You can specify up to 255 characters for thedescription. Enclose the description in quotation marks if it contains blankcharacters. This parameter is optional.

Examples

Task 1

Define a script that will display all AIX® clients.

Command:define script qaixc "select node_name from nodes where platform='AIX'"desc='Display aix clients'

Task 2

Define and run a script that will route the QUERY STGPOOL command to a servergroup named DEV_GROUP.

1. Define a script called QU_STG and route it to the DEV_GROUP server group:

Command:(dev_group) define script qu_stg "query stgpool"

2. Run the script:

Command:run qu_stg

Task 3

Define a script whose command lines are read in from a file that is namedQUSRADSM/SCRIPT(MY).. Name the new script AGADM.

Command:define script agadm file=qusradsm/script(my)

DEFINE SCRIPT


||||

|||||

||||

|

|

|

|||

|

||

|

||

|

||

|

||

||

Related Commands

Table 70. Commands Related to DEFINE SCRIPT

Command Description

COPY SCRIPT Creates a copy of a script.




RUN Runs a script.


DEFINE SCRIPT


|

|||

||

||

|||

||

||

||

||

|

DEFINE SERVER (Define a Server)

Use this command to define a server for the following functions:

v Enterprise configuration

v Enterprise event logging

v Command routing

v Virtual volumes

Privilege Class


Syntax

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

ÊÊ DEFine SERver server_name SERVERPAssword = password Ê

Ê HLAddress = ip_address LLAddress = tcp_portCOMMmethod = TCPIP

Ê

ÊURL = url DESCription = description

CROSSDefine = No

CROSSDefine = NoYes

ÊÍ

Syntax

For Virtual Volumes:

ÊÊ DEFine SERver server_name PAssword = password HLAddress = ip_address Ê

Ê LLAddress = tcp_portCOMMmethod = TCPIP URL = url

Ê

ÊDELgraceperiod = days NODEName = node_name

Ê


ÊÍ

DEFINE SERVER


|

|

|

|

|

|


Specifies the name of the server. This name must be unique on the server. Themaximum length of this name is 64 characters.

For command routing and server-to-server event logging functions, the servername you specify here should match the name that was set using the SETSERVERNAME command at the target server.

PAsswordSpecifies the password used to sign on to the target server for virtual volumes. Ifyou specify the NODENAME parameter, you must specify the PASSWORDparameter. If you specify the PASSWORD parameter but not the NODENAMEparameter, the node name defaults to the server name specified with the SETSERVERNAME command.

SERVERPAsswordSpecifies the password of the server you are defining. This password must matchthe password set by the SET SERVERPASSWORD command. This parameter isrequired for enterprise configuration, command routing, and server-to-server eventlogging functions.

HLAddress (Required)Specifies the IP address (in dotted decimal format) of the server.

LLAddress (Required)Specifies the low-level address of the server. This address is usually the same asthat in the TCPPORT server option of the target server.

COMMmethodSpecifies the communication method used to connect to the server. This parameteris optional.

URLSpecifies the URL address of this server. The parameter is optional.

DELgraceperiodSpecifies a number of days that an object remains on the target server after it hasbeen marked for deletion. The minimum value is 0. The default is 5. The maximumvalue is unlimited. This parameter is optional.

NODENameSpecifies a node name to be used by the server to connect to the target server.This parameter is optional. If you specify the NODENAME parameter, you mustalso specify the PASSWORD parameter. If you specify the PASSWORD parameterbut not the NODENAME parameter, the node name defaults to the server namespecified with the SET SERVERNAME command.

DESCriptionSpecifies a description of the server. The parameter is optional. The descriptioncan be up to 255 characters. Enclose the description in quotation marks if itcontains blank characters.

CROSSDefineSpecifies whether the server running this command will define itself to the server

DEFINE SERVER


|||

|||

||||||

|||||

||||

||

being specified on the DEFINE SERVER command. This parameter is optional. Ifthis parameter is included, you must also issue the SET SERVERNAME, SETSERVERPASSWORD, SET SERVERHLADDRESS, SET CROSSDEFINE, andSET SERVERLLADDRESS commands. The default is NO. Possible values are:

No Cross definition is not to be performed.

YesCross definition is to be performed.

Examples

Task 1

A target server has a high-level address of 9.116.2.67 and a low-level address of 1570.Define that target server to the source server, name it SERVER2, set the password toSECRET, and specify that objects remain on the target server for 7 days after theyhave been marked for deletion.

Command:define server server2 password=secret hladdress=9.115.3.45lladdress=1570 delgraceperiod=7

Task 2

Define a server to enable it to receive commands routed from other servers. Name theserver WEST_COMPLEX, set the password to CACTUS, and set the high-level addressto 9.283.299 and a low-level address to 1500.

Command:define server west_complex serverpassword=cactus hladdress=9.283.299lladdress=1500

Task 3

Use cross definition to define SERVER_A and SERVER_B.

Command:

1. On SERVER_B, specify the server name, password, and high- andlow-level addresses of SERVER_B. Specify that cross defining is allowed.

set servername server_bset serverpassword mylifeset serverhladdress 9.115.20.80set serverlladdress 1860set crossdefine on

2. On SERVER_A, specify the server name, password, and high- andlow-level addresses of SERVER_A.

set servername server_aset serverpassword yourlifeset serverhladdress 9.115.20.97set serverlladdress 1500

DEFINE SERVER


||||

||

||

|

|

|

3. On SERVER_A, define SERVER_B:

define server server_b hladdress=9.115.20.80 lladdress=1860serverpassword=mylife crossdefine=yes

Related Commands

Table 71. Commands Related to DEFINE SERVER

Command Description



DELETE FILESPACE Deletes data associated with client’s filespaces.


QUERY NODE Displays partial or complete information aboutone or more clients.


RECONCILE VOLUMES Reconciles source server virtual volumedefinitions and target server archive objects.



SET CROSSDEFINE Specifies whether to cross define servers.

SET SERVERNAME Specifies the name by which the server isidentified.

SET SERVERHLADDRESS Specifies the high-level address of a server.

SET SERVERLLADDRESS Specifies the low-level address of a server.

SET SERVERPASSWORD Specifies the server password.

SET SERVERURL Specifies the URL used to access a server froma web browser interface.




DEFINE SERVER


DEFINE SERVERGROUP (Define a Server Group)

Use this command to define a server group. A server group lets you route commands tomultiple servers by specifying only the group name. After defining the server group, addservers to the group by using the DEFINE GRPMEMBER command.

Privilege Class


Syntax

ÊÊ DEFine SERVERGRoup group_nameDESCription = description

ÊÍ


Specifies the name of the server group. The maximum length of the name is 64characters.

DESCriptionSpecifies a description of the server group. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters.

Examples

Task

Define a server group named WEST_COMPLEX.

Command:define servergroup west_complex

Related Commands

Table 72. Commands Related to DEFINE SERVERGROUP

Command Description

COPY SERVERGROUP Creates a copy of a server group.






DEFINE SERVERGROUP


||

|||

|

|

|

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

|

|

|||

||||

|

|

|

||

|

|||

||

||

|||

||

||

||

||

Table 72. Commands Related to DEFINE SERVERGROUP (continued)

Command Description



DEFINE SERVERGROUP


|

||

||

||

|

DEFINE SPACETRIGGER (Define the Database or Recovery Log Space Trigger)

Use this command to define settings for triggers that determine when and how TSMresolves space shortages in the database and recovery log.

Note: Setting a space trigger does not mean that the percentage used in the databaseand recovery log will always be less than the value specified with the FULLPCTparameter. TSM checks usage when database and recovery log activity resultsin a commit. Deleting database volumes and reducing the database does notcause the trigger to activate. Therefore, the utilization percentage can exceedthe set value before new volumes are online.

Privilege Class


Syntax

ÊÊ DEFine SPACETrigger DBLOG

Fullpct = 80

Fullpct = percentÊ

ÊSPACEexpansion = 20

SPACEexpansion = percent EXPansionprefix = prefixÊ

ÊMAXimumsize = megabytes

ÊÍ

ParametersDB

Specifies a database space trigger.

LOGSpecifies a recovery log space trigger.

FullpctThis parameter is optional. Specify an integer value from 0 to 99. The default is 80.A value of zero (0) disables the space trigger.

SPACEexpansionSpecifies an increase in the database or recovery log as a percentage of thecurrent size. Specify an integer from 0 to 200. The default is 20. The databasemust be at least 4MB (5MB file with processing space); the recovery log must be at

DEFINE SPACETRIGGER


||

||

||||||

|

||

|

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

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

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

|

|

||

||

|||

||||

least 8MB (9MB file with processing space). New database or recovery logvolumes must be multiples of 5MB or 9MB respectively. A value of zero (0) disablesexpansion.

EXPansionprefixSpecifies the prefix name for the files that TSM uses to create new database orrecovery log files. The prefix name must use a fully qualified path name, forexample,/svtemp/. Specify up to 200 characters. If you specify an invalid prefix,automatic expansion can fail.

MAXimumsizeSpecifies the maximum size, in megabytes, of the database or the recovery log.When this size is reached, expansion stops, and TSM issues a message. Thisparameter is optional. Specify a value from 9 to 5000 (5GB) for the recovery log, orfrom 4 to 9999999MB for the database. A value of zero (0) or omitting thisparameter disables checking for maximum size.

Examples

Task

Set the database space trigger to 80 percent. When the database reaches this value,allocate a volume that is twice the current size.

Command:

define spacetrigger db spaceexpansion=100

Related Commands

Table 73. Commands Related to DEFINE SPACETRIGGER

Command Description

DELETE SPACETRIGGER Deletes the database or recovery log spacetrigger.

QUERY SPACETRIGGER Displays information about the database orrecovery log space trigger.

UPDATE SPACETRIGGER Changes attributes of the database or recoverylog space trigger.

DEFINE SPACETRIGGER


|||

|||||

||||||

|

|

||

||

|

|

|||

||

|||

|||

|||

|

DEFINE STGPOOL (Define a Storage Pool)

Use this command to define a primary storage pool or a copy storage pool. You use aprimary storage pool as the destination for backup files, archive files, or files migratedfrom client nodes. You use a copy storage pool to store backup copies of files that arein primary storage pools.

All volumes in a storage pool belong to the same device class. Random access storagepools use the DISK device type. After you define a random access storage pool, youmust define volumes for the pool to create storage space.

Sequential access storage pools use device classes that you define for tape devices,optical devices, files on disk (FILE device type), and storage on another server(SERVER device type). To create storage space in a sequential access storage pool,you must allow scratch volumes for the pool when you define or update it, or definevolumes for the pool after you define the pool. You can also do both.

The DEFINE STGPOOL command takes three forms, depending on whether you aredefining a primary storage pool assigned to random access devices, a primary storagepool assigned to sequential access devices, or a copy storage pool (always assigned tosequential access devices). The syntax and parameters for each form are definedseparately.

DEFINE STGPOOL


DEFINE STGPOOL — Primary Random Access

Use this command to define a primary storage pool assigned to random accessdevices.

Privilege Class


Syntax

ÊÊ DEFine STGpool pool_name DISKPOoltype = PRimary

POoltype = PRimaryÊ


ACCess = READWrite

ACCess = READWriteREADOnlyUNAVailable

Ê

ÊMAXSIze = NOLimit

MAXSIze = maximum_file_size NEXTstgpool = pool_nameÊ

ÊHIghmig = 90

HIghmig = percent

LOwmig = 70

LOwmig = percent

CAChe = No

CAChe = NoYes

Ê

ÊMIGPRocess = 1

MIGPRocess = number

MIGDelay = 0

MIGDelay = days

MIGContinue = Yes

MIGContinue = NoYes

ÊÍ

Parameterspool_name (Required)

Specifies the name of the storage pool to be defined. The maximum length of thename is 30 characters.

DISK (Required)Specifies that you want to define a storage pool to the DISK device class (the DISKdevice class is predefined during installation).

POoltype=PRimarySpecifies that you want to define a primary storage pool. This parameter isoptional. The default value is PRIMARY.



DESCriptionSpecifies a description of the storage pool. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters.

ACCessSpecifies how client nodes and server processes (such as migration andreclamation) can access files in the storage pool. This parameter is optional. Thedefault value is READWRITE. Possible values are:

READWriteSpecifies that client nodes and server processes can read and write to filesstored on volumes in the storage pool.

READOnlySpecifies that client nodes can only read files from the volumes in the storagepool.

Server processes can move files within the volumes in the storage pool.However, no new writes are permitted to volumes in the storage pool fromvolumes outside the storage pool.

If this storage pool has been specified as a subordinate storage pool (with theNEXTSTGPOOL parameter) and is defined as readonly, the storage pool isskipped when server processes attempt to write files to the storage pool.

UNAVailableSpecifies that client nodes cannot access files stored on volumes in thestorage pool.

Server processes can move files within the volumes in the storage pool andcan also move or copy files from this storage pool to another storage pool.However, no new writes are permitted to volumes in the storage pool fromvolumes outside the storage pool.

If this storage pool has been specified as a subordinate storage pool (with theNEXTSTGPOOL parameter) and is defined as unavailable, the storage pool isskipped when server processes attempt to write files to the storage pool.

MAXSIzeSpecifies the maximum size for a physical file that the server can store in thestorage pool during a session with a client. This parameter is optional. The defaultvalue is NOLIMIT. Possible values are:

NOLimitSpecifies that there is no maximum size limit for physical files stored in thestorage pool.

maxfilesizeLimits the maximum physical file size. Specify an integer from 1 to 999999,followed by a scale factor. For example, MAXSIZE=5G specifies that themaximum file size for this storage pool is 5 gigabytes. Scale factors are:

Scale factor MeaningK kilobyte



M megabyteG gigabyteT terabyte

If a file exceeds the maximum size and no pool is specified as the next storagepool in the hierarchy, the server does not store the file. If a file exceeds themaximum size and a pool is specified as the next storage pool, the server storesthe file in the next storage pool that can accept the file size. If you specify the nextstorage pool parameter, at least one storage pool in your hierarchy should have nolimit on the maximum size of a file. By having no limit on the size for at least onepool, you ensure that no matter what its size, the server can store the file.

For logical files that are part of an aggregate, the server considers the size of theaggregate to be the file size. Therefore, the server does not store logical files thatare smaller than the maximum size limit if the files are part of an aggregate that islarger than the maximum size limit.

Note: This size limit applies only when the server is storing files during a sessionwith a client. The limit does not apply when you move data from one pool toanother, either manually or automatically through storage pool migration.

NEXTstgpoolSpecifies a primary storage pool to which files are migrated. This parameter isoptional. The next storage pool must be a primary storage pool.

If you do not specify a next storage pool, the server cannot migrate files from thisstorage pool and cannot store in another storage pool files that exceed themaximum size for this storage pool.

You cannot create a chain of storage pools that leads to an endless loop throughthe NEXTSTGPOOL parameter. At least one storage pool in the hierarchy musthave no value specified for NEXTSTGPOOL.

HIghmigSpecifies that the server starts migration for this storage pool when the amount ofdata in the pool reaches this percentage of the pool’s estimated capacity. Thisparameter is optional. You can specify an integer from 0 to 100. The default valueis 90.

When the storage pool exceeds the high migration threshold, the server can startmigration of files by node, to the next storage pool, as defined with theNEXTSTGPOOL parameter. You can specify HIGHMIG=100 to prevent migrationfor this storage pool.

LOwmigSpecifies that the server stops migration for this storage pool when the amount ofdata in the pool reaches this percentage of the pool’s estimated capacity. Thisparameter is optional. You can specify an integer from 0 to 99. The default value is70.

When the storage pool reaches the low migration threshold, the server does notstart migration of another node’s files. Because all file spaces that belong to a node



|

|||

|

are migrated together, the occupancy of the storage pool can fall below the valueyou specified for this parameter. You can set LOWMIG=0 to permit migration toempty the storage pool.

CACheSpecifies whether the migration process leaves a cached copy of a file in thisstorage pool after migrating the file to the next storage pool. This parameter isoptional. The default value is NO. Possible values are:

Yes Specifies that caching is enabled.

No Specifies that caching is disabled.

Using cache may improve the retrievability of files, but may affect the performanceof other processes. See Administrator’s Guide for details.

MIGPRocessSpecifies the number of processes that the server uses for migrating files from thisstorage pool. This parameter is optional. You can specify an integer from 1 to 999.The default value is 1.

During migration, the server runs this number of processes in parallel to providethe potential for improved migration rates.

MIGDelaySpecifies the minimum number of days that a file must remain in a storage poolbefore the file becomes eligible for migration from the storage pool. The servercounts the number of days from the day that the file was stored in the storage poolor retrieved by a client, whichever is more recent. This parameter is optional. Youcan specify an integer from 0 to 9999. The default is 0, which means that you donot want to delay migration.

If you want the server to count the number of days based only on when a file wasstored and not when it was retrieved, use the NORETRIEVEDATE server option.

MIGContinueSpecifies whether you allow the server to migrate files that do not satisfy themigration delay time. This parameter is optional. The default is YES.

Because you can require that files remain in the storage pool for a minimumnumber of days, the server may migrate all eligible files to the next storage pool yetnot meet the low migration threshold. This parameter allows you to specify whetherthe server is allowed to continue the migration process by migrating files that donot satisfy the migration delay time.


YesSpecifies that, when necessary to meet the low migration threshold, the servercontinues to migrate files that do not satisfy the migration delay time.

If you allow more than one migration process for the storage pool, some filesthat do not satisfy the migration delay time may be migrated unnecessarily. Asone process migrates files that satisfy the migration delay time, a secondprocess could begin migrating files that do not satisfy the migration delay time



|||

|||||

|

|||

||||

to meet the low migration threshold. The first process that is still migrating filesthat satisfy the migration delay time might have, by itself, caused the lowmigration threshold to be met.

No Specifies that the server stops migration when no eligible files remain to bemigrated, even before reaching the low migration threshold. The server doesnot migrate files unless the files satisfy the migration delay time.

Examples

Task

Define a primary storage pool, POOL1, to use the DISK device class, with cachingenabled. Limit the maximum file size to 5MB. Store any files larger than 5MB insubordinate storage pools beginning with the PROG2 storage pool. Set the highmigration threshold to 70 percent, and the low migration threshold to 30 percent.

Command:define stgpool pool1 disk description="main disk storage pool"maxsize=5m highmig=70 lowmig=30 cache=yes nextstgpool=prog2



|||

||||

|

DEFINE STGPOOL — Primary Sequential Access

Use this command to define a primary storage pool assigned to sequential accessdevices.

Privilege Class


Syntax

ÊÊ DEFine STGpool pool_name device_class_namePOoltype = PRimary

POoltype = PRimaryÊ


ACCess = READWrite


Ê

ÊMAXSIze = NOLimit

MAXSIze = maximum_file_size NEXTstgpool = pool_nameÊ

ÊHIghmig = 90

HIghmig = percent

LOwmig = 70

LOwmig = percent

REClaim = 60

REClaim = percentÊ

ÊRECLAIMSTGpool = pool_name

COLlocate = No

COLlocate = NoYesFILespace

Ê

Ê MAXSCRatch = numberREUsedelay = 0

REUsedelay = days

MIGDelay = 0

MIGDelay = daysÊ

ÊMIGContinue = Yes

MIGContinue = NoYes

ÊÍ




Specifies the name of the storage pool to be defined. The maximum length of thename is 30 characters.

device_class_name (Required)Specifies the name of the device class to which this storage pool is assigned. Youcan specify any device class except for the DISK device class.

POoltype=PRimarySpecifies that you want to define a primary storage pool. This parameter isoptional. The default value is PRIMARY.

DESCriptionSpecifies a description of the storage pool. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description mustin quotation marks if it contains any blank characters.

ACCessSpecifies how client nodes and server processes (such as migration andreclamation) can access files in the storage pool. This parameter is optional. Thedefault value is READWRITE. Possible values are:










MAXSIzeSpecifies the maximum size for a physical file that the server can store in thestorage pool during a session with a client. This parameter is optional. The defaultvalue is NOLIMIT. Possible values are:



Scale factor MeaningK kilobyteM megabyteG gigabyteT terabyte





If you do not specify a next storage pool, the server cannot migrate files from thisstorage pool and cannot store in another storage pool files that exceed themaximum size for this storage pool.


HIghmigSpecifies that the server starts migration for this storage pool when the number ofvolumes containing data reaches this percentage of the total number of volumes in



|

|||

|

the storage pool. The total number of volumes includes the maximum number ofscratch volumes. This parameter is optional. You can specify an integer from 1 to100. The default value is 90.

When the storage pool exceeds the high migration threshold, the server can startmigration of files by volume to the next storage pool defined for the pool. You canset the high migration threshold to 100 to prevent migration for the storage pool.

LOwmigSpecifies that the server stops migration for this storage pool when the number ofvolumes containing data reaches this percentage of the total number of volumes inthe storage pool. The total number of volumes includes the maximum number ofscratch volumes. This parameter is optional. You can specify an integer from 0 to99. The default value is 70.

When the storage pool reaches the low migration threshold, the server does notstart migration of files from another volume. You can set the low migrationthreshold to 0 to permit migration to empty the storage pool.

REClaimSpecifies when the server reclaims a volume, based on the percentage ofreclaimable space on a volume. Reclamation makes the fragmented space onvolumes usable again by moving any remaining unexpired files from one volume toanother volume, thus making the original volume available for reuse. Thisparameter is optional. You can specify an integer from 1 to 100. The default valueis 60, except for storage pools that use WORM devices.

For storage pools that use WORM devices, the default value is 100 to preventreclamation from occurring. This is the default because a WORM volume is notreusable. If necessary, you can lower the value to allow the server to consolidatedata onto fewer volumes. Volumes emptied by reclamation can be checked out ofthe library, freeing slots for new volumes.

Specify a value of 50 percent or greater for this parameter so that files stored ontwo volumes can be combined onto a single output volume.

RECLAIMSTGpoolSpecifies another primary storage pool as a target for reclaimed data from thisstorage pool. This parameter is optional. When the server reclaims volumes for thestorage pool, the server moves unexpired data from the volumes being reclaimedto the storage pool named with this parameter.

A reclaim storage pool is most useful for a storage pool that has only one drive inits library. When you specify this parameter, the server moves all data fromreclaimed volumes to the reclaim storage pool regardless of the number of drivesin the library.

To move data from the reclaim storage pool back to the original storage pool, usethe storage pool hierarchy. Specify the original storage pool as the next storagepool for the reclaim storage pool.

COLlocateSpecifies whether the server attempts to keep data belonging to a single clientnode or client file space assigned to as few volumes as possible. This parameter isoptional. The default value is NO.



Collocation reduces the number of sequential access media mounts for restore,retrieve, and recall operations. However, collocation increases both the amount ofserver time needed to collocate files for storing and the number of volumesrequired. For details, see Administrator’s Guide.


YesSpecifies that collocation is enabled at the client node level. The server tries toput data for one node on as few volumes as possible. If the node has multiplefile spaces, no attempt is made to collocate those file spaces.

No Specifies that collocation is disabled.

FILespaceSpecifies that collocation is enabled at the file space level for client nodes. Theserver tries to put data for one node and file space on as few volumes aspossible. If a node has multiple file spaces, the server attempts to put data fordifferent file spaces on different volumes.

MAXSCRatch (Required)Specifies the maximum number of scratch volumes that the server can request forthis storage pool. You can specify an integer from 0 to 100000000. By allowing theserver to request scratch volumes, you avoid having to define each volume to beused.

The value specified for this parameter is used to estimate the total number ofvolumes available in the storage pool and the corresponding estimated capacity forthe storage pool.

Scratch volumes are automatically deleted from the storage pool when theybecome empty. When scratch volumes with the device type of FILE are deleted,the space that the volumes occupied is freed by the server and returned to the filesystem.

REUsedelaySpecifies the number of days that must elapse after all files are deleted from avolume before the volume can be rewritten or returned to the scratch pool. Thisparameter is optional. You can specify an integer from 0 to 9999. The default valueis 0, which means that a volume can be rewritten or returned to the scratch pool assoon as all the files are deleted from the volume.

Important: Use this parameter to help ensure that when you restore the databaseto an earlier level, database references to files in the storage pool arestill valid. You must set this parameter to a value greater than thenumber of days you plan to retain the oldest database backup. Thenumber of days specified for this parameter should be the same as thenumber specified for the SET DRMDBBACKUPEXPIREDAYScommand. For more information, see Administrator’s Guide.

MIGDelaySpecifies the minimum number of days since a file was stored in the storage poolbefore the file becomes eligible for migration from the storage pool. This parameter



|||

is optional. You can specify an integer from 0 to 9999. The default is 0, whichmeans that you do not want to delay migration.

MIGContinueSpecifies whether you allow the server to migrate files that have not been stored inthe storage pool for the number of days required by the migration delay. Thisparameter is optional. The default is YES.

Because you can require that files remain in the storage pool for a minimumnumber of days, the server may migrate all eligible files to the next storage pool yetnot meet the low migration threshold. This parameter allows you to specify whetherthe server is allowed to continue migration by migrating files that do not satisfy themigration delay time.


YesSpecifies that, when necessary to meet the low migration threshold, the servercontinues to migrate files that have not been stored in the storage pool for thenumber of days specified by the migration delay period.

No Specifies that the server stops migration when no eligible files remain to bemigrated, even before reaching the low migration threshold. The server doesnot migrate files unless the files have been stored in the storage pool for thenumber of days specified by the migration delay period.

Examples

Task

Define a primary storage pool named POOLA to the ENDOBYTE device class (with adevice type of CARTRIDGE). Limit the maximum file size to 5MB. Store any files largerthan 5MB in subordinate pools, beginning with POOL1. Enable collocation of files forclient nodes. Allow as many as 50 scratch volumes for this storage pool.

Command:define stgpool poola endobyte maxsize=5m nextstgpool=pool1collocate=yes maxscratch=50



||

||||

|||||

|

||||

|||||

|

DEFINE STGPOOL — Copy Sequential Access

Use this command to define a copy storage pool assigned to sequential accessdevices.

Privilege Class


Syntax

ÊÊ DEFine STGpool pool_name device_class_name POoltype = COpy Ê


ACCess = READWrite


Ê

ÊCOLlocate = No


REClaim = 100

REClaim = percentMAXSCRatch = number Ê

ÊREUsedelay = 0

REUsedelay = daysÊÍ


Specifies the name of the copy storage pool to be defined. The maximum length ofthe name is 30 characters.

device_class_name (Required)Specifies the name of the sequential access device class to which this copystorage pool is assigned. You can specify any device class except DISK.

POoltype=COpy (Required)Specifies that you want to define a copy storage pool.

DESCriptionSpecifies a description of the copy storage pool. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters.



ACCessSpecifies how client nodes and server processes (such as reclamation) can accessfiles in the copy storage pool. This parameter is optional. The default value isREADWRITE. Possible values are:

READWriteSpecifies that files can be read from and written to the volumes in the copystorage pool.

READOnlySpecifies that client nodes can only read files stored on the volumes in thecopy storage pool.

Server processes can move files within the volumes in the storage pool. Theserver can use files in the copy storage pool to restore files to primary storagepools. However, no new writes are permitted to volumes in the copy storagepool from volumes outside the storage pool. A storage pool cannot be backedup to the copy storage pool.

UNAVailableSpecifies that client nodes cannot access files stored on volumes in the copystorage pool.


COLlocateSpecifies whether the server attempts to keep data belonging to a single clientnode or client file space assigned to as few volumes as possible. This parameter isoptional. The default value is NO.






REClaimSpecifies when the server reclaims a volume, based on the percentage of



reclaimable space on a volume. Reclamation makes the fragmented space onvolumes usable again by moving any remaining unexpired files from one volume toanother volume, thus making the original volume available for reuse. Thisparameter is optional. You can specify an integer from 1 to 100. The default valueis 100, which means that reclamation is not performed.

If you change the value from the default, specify a value of 50 percent or greaterso that files stored on two volumes can be combined onto a single output volume.

When a copy pool volume that is offsite becomes eligible for reclamation, thereclamation process attempts to obtain the unexpired files on the reclaimablevolume from a primary or copy storage pool that is onsite. The process then writesthese files to an available volume in the original copy storage pool. Effectively,these files are moved back to the onsite location. However, the files could beobtained from the offsite volume after a disaster if a database backup is used thatreferences the files on the offsite volume. Because of the way reclamation workswith offsite volumes, use it carefully with copy storage pools.

MAXSCRatch (Required)Specifies the maximum number of scratch volumes that the server can request forthis storage pool. You can specify an integer from 0 to 100000000. By allowing theserver to request scratch volumes as needed, you avoid having to define eachvolume to be used.

The value specified for this parameter is used to estimate the total number ofvolumes available in the copy storage pool and the corresponding estimatedcapacity for the copy storage pool.

Scratch volumes are automatically deleted from the storage pool when theybecome empty. However, if the access mode for a scratch volume is OFFSITE, thevolume is not deleted from the copy storage pool until the access mode ischanged. This allows an administrator to query the server for empty, offsite scratchvolumes and return these to the onsite location.

When scratch volumes with the device type of FILE become empty and aredeleted, the space that the volumes occupied is freed by the server and returned tothe file system.

REUsedelaySpecifies the number of days that must elapse after all files are deleted from avolume before the volume can be rewritten or returned to the scratch pool. Thisparameter is optional. You can specify an integer from 0 to 9999. The default valueis 0, which means that a volume can be rewritten or returned to the scratch pool assoon as all the files are deleted from the volume.

Important: Use this parameter to help ensure that when you restore the databaseto an earlier level, database references to files in the copy storage poolare still valid. You must set this parameter to a value greater than thenumber of days you plan to retain the oldest database backup. Thenumber of days specified for this parameter should be the same as thenumber specified for the SET DRMDBBACKUPEXPIREDAYScommand. For more information, see Administrator’s Guide.



Examples

Task

Define a copy storage pool, TAPEPOOL2, to the DC480 device class. Allow up to 50scratch volumes for this pool. Delay the reuse of volumes for 45 days.

Command:define stgpool tapepool2 dc480 pooltype=copy maxscratch=50reusedelay=45



Related Commands

Table 74. Commands Related to DEFINE STGPOOL

Command Description


BACKUP STGPOOL Backs up a primary storage pool to a copystorage pool.



DELETE STGPOOL Deletes a storage pool from server storage.





SET DRMPRIMSTGPOOL Specifies that primary storage pools aremanaged by DRM.

UPDATE STGPOOL Changes the attributes of a storage pool.



DEFINE SUBSCRIPTION (Define a Profile Subscription)

Use this command on a managed server to subscribe that managed server to a profile.

When a server subscribes to its first profile, a subscription is also created to the defaultprofile (if one exists) of the configuration manager. The server then contacts theconfiguration manager periodically for configuration updates.

Notes:

1. A server cannot subscribe to profiles from more than one configuration manager.

2. If a server subscribes to a profile with an associated object that is already definedon the server, the local definition is replaced by the definition from the configurationmanager. For example, if a server has an administrative schedule named WEEKLY_BACKUP, then subscribes to a profile that also has an administrative schedulenamed WEEKLY_BACKUP, the local definition is replaced.

Privilege Class


Syntax

ÊÊ DEFine SUBSCRIPtion profile_nameSERVer = server_name

ÊÍ


Specifies the name of the profile to which the server subscribes.

SERVerSpecifies the name of the configuration manager from which the configurationinformation is obtained. This parameter is required, if the managed server does nothave at least one subscription. If the managed server has a subscription, you canomit this parameter and it defaults to the configuration manager for thatsubscription.

Examples

Task

Subscribe a profile named BETA that resides on a configuration manager named TOM.

Command:define subscription beta server=tom

DEFINE SUBSCRIPTION


||

|

|||

|

|

|||||

|

|

|

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

|

|

||

||||||

|

|

|

||

Related Commands

Table 75. Commands Related to DEFINE SUBSCRIPTION

Command Description












SET CONFIGREFRESH Specifies a time interval for managed servers tocontact configuration managers.



DEFINE SUBSCRIPTION


|

|||

||

||

|||

||

||

||

||

|||

||

|||

||

|||

|||

|||

||

|

DEFINE VOLUME (Define a Volume in a Storage Pool)

Use this command to assign a random or sequential access volume to a storage pool.

For a random access storage pool, you must use this command to define volumes thatcreate space in the pool.

For a sequential access storage pool, you create space by defining volumes, byallowing the server to request scratch volumes as needed (the MAXSCRATCHparameter for the storage pool), or by doing both.

Attention: The size of a storage pool volume cannot be changed once it has beendefined to the TSM server. If you change the size of TSM volumes, the server may notinitialize correctly and data could be lost.

Privilege Class

To issue this command, you must have system privilege, unrestricted storage privilege,or restricted storage privilege for the storage pool to which the volume is assigned.

Syntax

ÊÊ DEFine Volume pool_name volume_nameACCess = READWrite


(1)OFfsite

Ê

Ê(2) WAIT = No

Formatsize = megabytesWAIT = No

Yes

Ê

Ê(3)

LOcation = location

ÊÍ

Notes:

1 This value is valid only for volumes assigned to copy storage pools.

2 This parameter is valid only for random access volumes.

3 This parameter is valid only for sequential access volumes.

DEFINE VOLUME



Specifies the name of the storage pool to which the volume is assigned.

volume_name (Required)Specifies the name of the storage pool volume to be defined. The volume namethat you can specify depends on the device class device type of the associatedstorage pool:

v For device classes with a FILE or DISK device type, specify the name of the filethat contains the volume data. For a device class with a FILE device type,specify a file that is located in the library file system. For a device class with aDISK device type, specify a file that is located either in the library file system orthe root file system:

For the library file system, enter this file name with either the fully qualified pathname or the path name relative to the AS/400 object library identified in theOLibrary of the associated device class. For example, if the file name is mainvol,enter the path name as:

QUSRADSM/MAINVOL(MAINVOL)

In this example, the file name and member name are the same, but this is not arequirement. The fully qualified name could also be:

QUSRADSM/MAINVOL(VOL1)

For the root file system, you must enter this file name with a fully qualified pathname that starts with the root directory. For example:

/storagep/pool1/vol1

v For all device classes that represent tape devices, specify a 1–6 alphanumericcharacters. An example is DSMT01 (the server always converts volume namesto uppercase).

v For device classes with an OPTICAL or WORM device type, the TSM volumename for an optical cartridge inside the library has the form SIDEA/SIDEB.SIDEA is the name of one side of the cartridge and SIDEB is the name of theother side. The server always sorts the names so that the name string that isalphabetically first is to the left of the slash. Specify the name of one or bothsides of an optical cartridge. For example, any of the following is acceptable:

define volume opt-pool sideadefine volume opt-pool sidebdefine volume worm-pool sidea/sidebdefine volume worm-pool sideb/sidea

The volume name cannot contain any embedded blanks or equal signs.

ACCessSpecifies how client nodes and server processes (such as migration) can accessfiles in the storage pool volume. This parameter is optional. The default value isREADWRITE. Possible values are:

DEFINE VOLUME


|||||

||||

|

||

|

||

|

|

READWriteSpecifies that client nodes and server processes can read from and write tofiles stored on the volume.

READOnlySpecifies that client nodes and server processes can only read files stored onthe volume.

UNAVailableSpecifies that neither client nodes nor server processes can access files storedon the volume.

If you define a random access volume as UNAVAILABLE, you cannot vary thevolume online.

If you define a sequential access volume as UNAVAILABLE, the server doesnot attempt to access the volume.

OFfsiteSpecifies that the volume is at an offsite location from which it cannot bemounted. You can specify this value only for volumes in copy storage pools.

Use this value to help you track volumes at offsite locations. The server treatsvolumes designated as offsite differently:

v The server does not generate mount requests for volumes designated offsite

v The server reclaims or moves data from offsite volumes by retrieving filesfrom other storage pools

v The server does not automatically delete empty, offsite scratch volumesfrom a copy storage pool

LOcationSpecifies the location of the volume. This parameter is optional. It can be specifiedonly for volumes in sequential access storage pools. The location information canbe a maximum length of 255 characters. Enclose the location in quotation marks ifit contains any blank characters.

FormatsizeSpecifies the size of the random access volume that is created and formatted inone step. This parameter is optional and valid only for DISK volumes. The valueyou specify is in megabytes. The value must be no more than 2047MB. Unless youalso specify WAIT=YES, the server performs the operation as a backgroundprocess.

If you do not use this parameter, you must create and format the volume beforedefining the volume. Use the create and format volume option (CRTVOLADSMcommand) from the Utilities menu for Tivoli Storage Manager.

WaitSpecifies whether a random access volume creation and formatting operation isperformed in the foreground or background. This parameter is optional. It is ignoredunless you also specify the format size parameter.

No Specifies that a volume creation and formatting operation is performed in thebackground. This is the default when you also specify a format size.

DEFINE VOLUME


||||||

|||

||||

|||


Examples

Task 1

In the library file system, define a volume named DSM010 to the PRIMARY_POOLstorage pool, with READWRITE access.

Command:define volume primary_pool dsm010 access=readwrite

Task 2

In the root file system, define a a new volume of 100MB named TEST to theBACKUPPOOL storage pool. The volume name is /data/temp/test. Let the volume becreated as a background process.

Command:define volume backuppool /data/temp/test formatsize=100

Related Commands

Table 76. Commands Related to DEFINE VOLUME

Command Description





DEFINE VOLUME


|||

|

|

|

DELETE ASSOCIATION (Delete the Node Association to a Schedule)

Use this command to delete the association of a client node to a client schedule. TSMno longer runs the schedule on the client node.

If you try to disassociate a client from a schedule to which it is not associated, thiscommand has no effect for that client.

Privilege Class


v System privilege

v Unrestricted policy privilege, or

v Restricted policy privilege for the domain to which the schedule belongs

Syntax

ÊÊ DELete ASSOCiation domain_name schedule_name ·

,

node_name ÊÍ



schedule_name (Required)Specifies the name of the schedule from which clients are to be disassociated.

node_name (Required)Specifies the name of the client node that is no longer associated with the clientschedule. You can specify a list of clients which are to be no longer associated withthe specified schedule. The items in the list are separated by commas, with nointervening spaces. You can also use a wildcard character to specify a name. Allmatching clients are disassociated from the specified schedule.

Examples

Task 1

Delete the association of the node JEFF, assigned to the DOMAIN1 policy domain, tothe WEEKLY_BACKUP schedule.

Command:delete association domain1 weekly_backup jeff

DELETE ASSOCIATION


Task 2

Delete the association of selected clients, assigned to the DOMAIN1 policy domain, tothe WEEKLY_BACKUP schedule so that this schedule is no longer executed by theseclients. The nodes that are disassociated from the schedule contain ABC or XYZ in thenode name.

Command:delete association domain1 weekly_backup *abc*,*xyz*

Related Commands

Table 77. Commands Related to DELETE ASSOCIATION

Command Description



DELETE ASSOCIATION


DELETE CLIENTOPT (Delete an Option in an Option Set)

Use this command to delete a client option in an option set.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege.

Syntax

ÊÊ DELete CLIENTOpt option_set_name option_nameSEQnumber = number

ALL

ÊÍ


Specifies the name of the client option set.

option_name (Required)Specifies a valid client option.

SEQnumberSpecifies a sequence number when an option name is specified more than once.This parameter is optional. Valid values are:

n Specifies an integer of 0 or greater.

ALLSpecifies all sequence numbers.

Examples

Task

Delete the date format option in an option set named ENG.

Command:delete clientopt eng dateformat

Related Commands

Table 78. Commands Related to DELETE CLIENTOPT

Command Description




DELETE CLIENTOPT


Table 78. Commands Related to DELETE CLIENTOPT (continued)

Command Description





DELETE CLIENTOPT


DELETE CLOPTSET (Delete a Client Option Set)

Use this command to delete a client option set.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege.

Syntax

ÊÊ DELete CLOptset option_set_name ÊÍ


Specifies the name of the client option set to be deleted.

Examples

Task

Delete a client option set named ENG.

Command:delete cloptset eng

Related Commands

Table 79. Commands Related to DELETE CLOPTSET

Command Description








DELETE CLOPTSET


DELETE COPYGROUP (Delete a Copy Group)

Use this command to delete a backup or archive copy group from a management class.You cannot delete a copy group in the ACTIVE policy set.

When you activate the changed policy set, any files that are bound to a deleted copygroup are managed by the default management class.

You can delete the predefined STANDARD copy group in the STANDARD policydomain (STANDARD policy set, STANDARD management class). However, if you laterreinstall the TSM server, the process restores all STANDARD policy objects.

Privilege Class


Syntax

ÊÊ DELete COpygroup domain_name policy_set_name class_nameSTANDARD

STANDARDÊ

ÊType = Backup

Type = BackupArchive

ÊÍ


Specifies the policy domain to which the copy group belongs.

policy_set_name (Required)Specifies the policy set to which the copy group belongs.

class_name (Required)Specifies the management class to which the copy group belongs.

STANDARDSpecifies the copy group, which is always STANDARD. This parameter is optional.The default value is STANDARD.

TypeSpecifies the type of copy group to delete. This parameter is optional. The defaultvalue is BACKUP. Possible values are:

BackupSpecifies that the backup copy group is deleted.

DELETE COPYGROUP


ArchiveSpecifies that the archive copy group is deleted.

Examples

Task 1

Delete the backup copy group from the ACTIVEFILES management class that is in theVACATION policy set of the EMPLOYEE_RECORDS policy domain.

Command:delete copygroup employee_records vacation activefiles

Task 2

Delete the archive copy group from the MCLASS1 management class that is in theSUMMER policy set of the PROG1 policy domain.

Command:delete copygroup prog1 summer mclass1 type=archive

Related Commands

Table 80. Commands Related to DELETE COPYGROUP

Command Description




DELETE COPYGROUP


DELETE DBBACKUPTRIGGER (Delete the Database Backup Trigger)

Use this command to delete the definition of the database backup trigger. After youdelete the database backup trigger, issue the SET LOGMODE command to change thelog mode to NORMAL.

Privilege Class


Syntax

ÊÊ DELete DBBackuptrigger ÊÍ

Parameters

None.

Examples

Task

Delete the definition for the database backup trigger.

Command:delete dbbackuptrigger

Related Commands

Table 81. Commands Related to DELETE DBBACKUPTRIGGER

Command Description





DELETE DBBACKUPTRIGGER


DELETE DBVOLUME (Delete a Database Volume)

Use this command to delete a database volume or database volume copy. Thiscommand may require data on the volume to be moved to other database volumes.

Note: You cannot delete the last synchronized volume in a group of mirrored volumesunless TSM can move the information on the volume to other synchronizedvolumes.

This command can generate a background process that can be canceled with theCANCEL PROCESS command. If a DELETE DBVOLUME background process iscanceled, some of the database data may have already been moved. To displayinformation on background processes, use the QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ DELete DBVolume volume_name ÊÍ


Specifies the name of the database volume.

Usage Notes

When you delete a database volume, the server moves existing data to available spaceon other volumes. After the data has been moved, these volumes are deleted from theserver. You can then delete the physical file member and free up space on the AS/400by issuing the AS/400 RMVM command.

Examples

Task

Delete the database volume named DB.2.

Command:delete dbvolume /dbvol/db.2

DELETE DBVOLUME


|

Related Commands

Table 82. Commands Related to DELETE DBVOLUME

Command Description






DELETE DBVOLUME


DELETE DEVCLASS (Delete a Device Class)

Use this command to delete a device class.

To use this command, you must first delete all storage pools assigned to the specifieddevice class and, if necessary, cancel any database dump, export, or import processesthat are using the device class.

You cannot delete the device class DISK, which is predefined at installation, but youcan delete any device classes defined by the TSM administrator.

Privilege Class


Syntax

ÊÊ DELete DEVclass device_class_name ÊÍ


Specifies the name of the device class to be deleted.

Examples

Task

Delete the device class named MYTAPE. There are no storage pools assigned to thedevice class.

Command:delete devclass mytape

Related Commands

Table 83. Commands Related to DELETE DEVCLASS

Command Description




DELETE DEVCLASS


DELETE DOMAIN (Delete a Policy Domain)

Use this command to delete a policy domain. All associated policy sets, managementclasses, and copy groups are deleted along with the policy domain. You cannot delete apolicy domain to which client nodes are registered.

You can delete the predefined STANDARD policy domain. However, if you later reinstallthe TSM server, the process restores all STANDARD policy objects.

Privilege Class


Syntax

ÊÊ DELete DOmain domain_name ÊÍ


Specifies the policy domain to delete.

Examples

Task

Delete the EMPLOYEE_RECORDS policy domain.

Command:delete domain employee_records

Related Commands

Table 84. Commands Related to DELETE DOMAIN

Command Description





DELETE DOMAIN


DELETE DRIVE (Delete a Drive from a Library)

Use this command to delete a drive from a library. A drive that is in use cannot bedeleted.

Privilege Class


Syntax

ÊÊ DELete DRive library_name drive_name ÊÍ


Specifies the name of the library where the drive is located.

drive_name (Required)Specifies the name of the drive to be deleted.

Examples

Task

Delete DRIVE3 from the library named AUTO.

Command:delete drive auto drive3

Related Commands

Table 85. Commands Related to DELETE DRIVE

Command Description







DELETE DRIVE


DELETE EVENT (Delete Event Records)

Use this command to delete event records from the database. An event record iscreated whenever processing of a scheduled command is started or missed.

This command only deletes the event records that exist at the time the command isprocessed. An event record will not be found if the event record has never been created(the event is scheduled for the future) or if the event has passed and the event recordhas already been deleted.

Privilege Class


Syntax

ÊÊ DELete EVent date00:00

time

TYPE = Client

TYPE = ClientADministrativeALl

ÊÍ

Parametersdate (Required)

Specifies the date used to determine which event records to delete. The maximumnumber of days you can specify is 9999.

Use this parameter in conjunction with the TIME parameter to specify a date andtime for deleting event records. Any record whose scheduled start occurs beforethe specified date and time is deleted. However, records are not deleted for eventswhose startup window has not yet passed.





TODAY−days or−days

The current date minus daysspecified

TODAY−3 or −3.

timeSpecifies the time used to determine which event records to delete. Use thisparameter in conjunction with the DATE parameter to specify a date and time fordeleting event records. Any record whose scheduled start occurs before thespecified date and time is deleted. However, records are not deleted for eventswhose startup window has not yet passed. The default is 00:00.

DELETE EVENT






NOW+HH:MM or+HH:MM


NOW+03:00 or +03:00Note: If you issue this command at 9:00using NOW+03:00 or +03:00, TSM deletesrecords with a time of 12:00 or later on thedate you specify.

NOW−HH:MM or−HH:MM


NOW−03:00 or –03:00

TYPESpecifies the type of events to be deleted. This parameter is optional. The defaultis CLIENT. Possible values are:

ClientSpecifies that event records for client schedules are to be deleted.

ADministrativeSpecifies that event records for administrative command schedules are to bedeleted.

ALlSpecifies that event records for both client and administrative commandschedules are to be deleted.

Examples

Task

Delete records for events with scheduled start times prior to 08:00 on May 26, 1998(05/26/1998), and whose startup window has passed. Records for these events aredeleted regardless of whether the retention period for event records, as specified withthe SET EVENTRETENTION command, has passed.

Command:delete event 05/26/1998 08:00

Related Commands

Table 86. Commands Related to DELETE EVENT

Command Description


SET EVENTRETENTION Specifies the number of days to retain recordsfor scheduled operations.

DELETE EVENT


DELETE EVENTSERVER (Deletes the Defintion of the Event Server)

Use this command to delete the definition of the event server. You must issue thiscommand before you issue the DELETE SERVER command. If you specify the serverdefined as the event server on the DELETE SERVER command, you will receive anerror message.

Privilege Class


Syntax

ÊÊ DELete EVENTSERVer ÊÍ

Examples

Task

Delete the definition for the event server ASTRO.

Command:delete eventserver astro

Related Commands

Table 87. Commands Related to DELETE EVENTSERVER

Command Description

DEFINE EVENTSERVER Defines a server as an event server.


DELETE EVENTSERVER


||||

DELETE EXIT (Delete an Exit Program)

Use this command to delete an existing exit program. Prior to deleting an exit program,all libraries of type USRDFN must be deleted.

Privilege Class


Syntax

ÊÊ DELete EXIT MOuntDIsmountDEletionEXpiration

ÊÍ

Parametersexit_type (Required)

Specifies which exit program is being deleted. The values are:

MOuntSpecifies the mount exit program is being deleted.

DIsmountSpecifies the dismount exit program is being deleted.

DEletionSpecifies the deletion exit program is being deleted.

EXpirationSpecifies the expiration exit program is being deleted.

Examples

Task

Suppose you have previously defined a dismount exit program to the server and nowyou wish to delete it. You must ensure that all libraries of type USRDFN are deletedbefore you issue this command.

Command:delete exit dismount

DELETE EXIT


Related Commands

Table 88. Commands Related to DELETE EXIT

Command Description

DEFINE EXIT Defines an exit program and specifies itslocation on the AS/400 library.






DELETE EXIT


DELETE FILESPACE (Delete Client Node Data from the Server)

Use this command to delete file spaces from the server. Files that belong to the filespace are deleted from primary and copy storage pools.

TSM deletes one or more file spaces as a series of batch database transactions, thuspreventing a rollback or commit for an entire file space as a single action. If the processis canceled or if a system failure occurs, a partial deletion can occur. A subsequentDELETE FILESPACE command for the same node or owner can delete the remainingdata.

Privilege Class


Syntax

ÊÊ DELete FIlespace node_name file_space_nameType = ANY

Type = ANYBackupARchiveSPacemanagedSERver

Ê

ÊWait = No

Wait = NoYes

OWNer = owner_nameÊÍ

Parametersnode_name (Required)

Specifies the name of the client node to which the file space belongs.

file_space_name (Required)Specifies the name of the file space to be deleted. This name is case-sensitive andmust be entered exactly as it is known to the server. To determine how to enter thename, use the QUERY FILESPACE command. You can use wildcard characters tospecify this name.

TypeSpecifies the type of data to be deleted. This parameter is optional. The defaultvalue is ANY. Possible values are:

ANYDelete only backed-up versions of files and archived copies of files.

DELETE FILESPACE


If you specify DELETE FILESPACE node_name * TYPE=ANY, all backed-updata and archived data in all file spaces for that node are deleted. File spacesare deleted only if they do not contain files that are migrated from an HSMclient.

BackupDelete backup data for the file space.

ARchiveDelete all archived data on the server for the file space.

SPacemanagedDelete files migrated from a user’s local file system (space-managed files froman HSM client). The OWNER parameter is ignored when you specifyTYPE=SPACEMANAGED.

SERverDelete all archived files in all file spaces for a node that is registered asTYPE=SERVER.

WaitSpecifies whether to wait for the server to complete processing this command inthe foreground. This parameter is optional. The default value is No. Possible valuesare:

No Specifies that the server processes this command in the background. You cancontinue with other tasks while the command is being processed. Messagescreated from the background process are displayed either in the activity log orthe server console, depending on where messages are logged.

YesSpecifies that the server processes this command in the foreground. Wait forthe command to complete before continuing with other tasks. The serverdisplays the output messages to the administrative client when the commandcompletes.

OWNerRestricts the data that is deleted to files belonging to the owner. This parameter isoptional; it is ignored when TYPE=SPACEMANAGED. This parameter only appliesto multiuser client systems such as AIX and SunOS.

Examples

Task 1

Delete the file space named C_Drive that belongs to the client node HTANG.

Command:delete filespace htang C_Drive

Task 2

Delete all files migrated from client node APOLLO (that is, all space-managed files).

DELETE FILESPACE


||||

|

|

Command:delete filespace apollo * type=spacemanaged

Related Commands

Table 89. Commands Related to DELETE FILESPACE

Command Description


QUERY ACTLOG Displays messages from the server activity log.

QUERY FILESPACE Displays information about data in filespacesthat belong to a client.

QUERY OCCUPANCY Displays file space information by storage pool.



RENAME FILESPACE Renames a client filespace on the server.

DELETE FILESPACE


DELETE GRPMEMBER (Delete a Server from a Server Group)

Use this command to delete a server or server group from a server group.

Privilege Class


Syntax

ÊÊ DELete GRPMEMber group_name ·

,

member_name ÊÍ


Specifies the group.

member_name (Required)Specifies the server or group to delete from the group. To specify multiple names,separate the names with commas and no intervening spaces.

Examples

Task

Delete member PHOENIX from group WEST_COMPLEX.

Command:delete grpmember west_complex phoenix

Related Commands

Table 90. Commands Related to DELETE GRPMEMBER

Command Description









DELETE GRPMEMBER


||

|

|

|

|

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

|

|

||

|||

|

|

|

||

|

|||

||

|||

||

||

||

||

||

||

||

Table 90. Commands Related to DELETE GRPMEMBER (continued)

Command Description


DELETE GRPMEMBER


|

||

||

|

DELETE LIBRARY (Delete a Library)

Use this command to delete an existing library. Prior to deleting a library, all assigneddrives must be deleted.

Privilege Class


Syntax

ÊÊ DELete LIBRary library_name ÊÍ


Specifies the name of the library to be deleted.

Examples

Task

Delete the MANLIB library.

Command:delete library manlib

Related Commands

Table 91. Commands Related to DELETE LIBRARY

Command Description








DELETE LIBRARY


DELETE LOGVOLUME (Delete a Recovery Log Volume)

Use this command to delete a recovery log volume or volume copy. When you deletethe volume from the recovery log, the server moves existing data to available space onother volumes.

Note: You cannot delete the last synchronized volume in a group of mirrored volumesunless TSM can move the information on the volume to other synchronizedvolumes.

This command can generate a background process that can be canceled with theCANCEL PROCESS command. If a DELETE LOGVOLUME background process iscancelled, some of the database may have already been moved. To display informationon background processes, use the QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ DELete LOGVolume volume_name ÊÍ


Specifies the virtual address of the recovery log volume.

Usage Notes

When you delete a recovery log volume, the server moves existing data to availablespace on other volumes. After the data has been moved, these volumes are deletedfrom the server. You can then delete the physical file member and free up space on theAS/400 by issuing the AS/400 RMVM command.

Examples

Task

Delete the recovery log volume LOG.1 .

Command:delete logvolume /dbvol/log.1

DELETE LOGVOLUME


|

Related Commands

Table 92. Commands Related to DELETE LOGVOLUME

Command Description






DELETE LOGVOLUME


DELETE MACHINE (Delete Machine Information)

Use this command to delete machine description information. To replace existinginformation, issue this command and then issue an INSERT MACHINE command.

Privilege Class


Syntax

ÊÊ DELete MAchine machine_nameType = All

Type = AllRECOVERYInstructionsCHaracteristics

ÊÍ


Specifies the name of the machine to be deleted.

TypeSpecifies the type of machine information. This parameter is optional. The default isALL. Possible values are:

All Specifies all information.

RECOVERYInstructionsSpecifies the recovery instructions.

CHaracteristicsSpecifies the machine characteristics.

Examples

Task

Delete the machine characteristics associated with the DISTRICT5 machine.

Command:delete machine district5 type=characteristics

Related Commands

Table 93. Commands Related to DELETE MACHINE

Command Description


DELETE MACHINE


Table 93. Commands Related to DELETE MACHINE (continued)

Command Description





DELETE MACHINE


DELETE MACHNODEASSOCIATION (Delete Association Between a Machine anda Node)

Use this command to delete the association between a machine and one or morenodes. This command does not delete the node from TSM.

Privilege Class


Syntax

ÊÊ DELete MACHNODEAssociation machine_name ·

,

node_name ÊÍ


Specifies the name of a machine that is associated with one or more nodes.

node_name (Required)Specifies the name of a node associated with a machine. If you specify a list ofnode names, separate the names with commas and no intervening spaces. Youcan use wildcard characters to specify a name. If a node is not associated with themachine, that node is ignored.

Examples

Task

Delete the association between the DISTRICT5 machine and the ACCOUNTSPAYABLEnode.

Command:delete machnodeassociation district5 accountspayable

Related Commands

Table 94. Commands Related to DELETE MACHNODEASSOCIATION

Command Description





DELETE MGMTCLASS (Delete a Management Class)

Use this command to delete a management class. You cannot delete a managementclass in the ACTIVE policy set. All copy groups in the management class are deletedalong with the management class. You can delete the management class assigned asthe default for a policy set, but a policy set cannot be activated unless it has a defaultmanagement class.

You can delete the predefined STANDARD management class in the STANDARD policydomain. However, if you later reinstall the TSM server, the process restores allSTANDARD policy objects.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege for the policy domain to which the management class belongs.

Syntax

ÊÊ DELete MGmtclass domain_name policy_set_name class_name ÊÍ



policy_set_name (Required)Specifies the policy set to which the management class belongs.

class_name (Required)Specifies the management class to delete.

Examples

Task

Delete the ACTIVEFILES management class from the VACATION policy set of theEMPLOYEE_RECORDS policy domain.

Command:delete mgmtclass employee_records vacation activefiles

Related Commands

Table 95. Commands Related to DELETE MGMTCLASS

Command Description


DELETE MGMTCLASS


Table 95. Commands Related to DELETE MGMTCLASS (continued)

Command Description





DELETE MGMTCLASS


DELETE POLICYSET (Delete a Policy Set)

Use this command to delete a policy set. You cannot delete the ACTIVE policy set.When you delete a policy set, all management classes and copy groups that belong tothe policy set are also deleted.

You can delete the predefined STANDARD policy set. However, if you later reinstall theTSM server, the process restores all STANDARD policy objects.

Privilege Class


Syntax

ÊÊ DELete POlicyset domain_name policy_set_name ÊÍ



policy_set_name (Required)Specifies the policy set to delete.

Examples

Task

Delete the VACATION policy set from the EMPLOYEE_RECORDS policy domain.

Command:delete policyset employee_records vacation

Related Commands

Table 96. Commands Related to DELETE POLICYSET

Command Description






DELETE POLICYSET


Table 96. Commands Related to DELETE POLICYSET (continued)

Command Description


DELETE POLICYSET


DELETE PROFASSOCIATION (Delete a Profile Association)

Use this command on a configuration manager to delete the association of one or moreobjects from a profile. If associations are deleted, the objects are no longer distributedto subscribing managed servers. When managed servers request updated configurationinformation, the configuration manager notifies them of the object deletions.

Attention: A managed server deletes the objects that were deleted from the profile,unless the objects are associated with another profile to which that server subscribes.

Privilege Class


Syntax

ÊÊ DELete PROFASSOCiation profile_name

·

ADMins = *,

admin_name

Ê

Ê

·

DOmains = *,

domain_name

Ê

Ê

·

ADSCHeds = *,

schedule_name

Ê

Ê

·

SCRipts = *,

script_name

Ê

Ê

·

CLOptsets = *,

option_set_name

Ê



||

||||

||

|

|

|

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

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

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

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

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

||

Ê

·

SERVers = *,

server_name

Ê

Ê

·

SERVERGroups = *,

group_name

ÊÍ


Specifies the profile from which to delete associations.

ADMinsSpecifies the administrators whose association with the profile is deleted. You canspecify more than one name by separating the names with commas and nointervening spaces. Use the match-all character (*) to delete all administrators fromthe profile. If you specify a list of administrators and a match-all definition exists forthe profile, the command fails.

Administrator definitions are not changed on the configuration manager. However,they are automatically deleted from all subscribing managed servers at the nextconfiguration refresh, with the following exceptions:

v An administrator is not deleted if that administrator has an open session on theserver.

v An administrator is not deleted if, as a result, the managed server would have noadministrators with system privilege class.

DOmainsSpecifies the domains whose association with the profile is deleted. You canspecify more than one name by separating the names with commas and nointervening spaces. Use the match-all character (*) to delete all domains from theprofile. If you specify a list of domains and a match-all domain definition exists forthe profile, the command fails.

The domain information is automatically deleted from all subscribing managedservers. However, a policy domain that has client nodes assigned will not bedeleted. To delete the domain at the managed server, assign those client nodes toanother policy domain.

ADSCHedsSpecifies a list of administrative schedules whose association with the profile isdeleted. You can specify more than one name by separating the names withcommas and no intervening spaces. If you specify a list of administrative schedules



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

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

|

|

||

||||||

|||

||

||

||||||

||||

||||

and a match-all administrative schedule definition exists for the profile, thecommand fails. Use the match-all character (*) to delete all administrativeschedules from the profile.

The administrative schedules are automatically deleted from all subscribingmanaged servers. However, an administrative schedule is not deleted if theschedule is active on the managed server. To delete an active schedule, make theschedule inactive.

SCRiptsSpecifies the server command scripts whose association with the profile is deleted.You can specify more than one name by separating the names with commas andno intervening spaces. Use the match-all character (*) to delete all scripts from theprofile. If you specify a list of scripts and a match-all script definition exists for theprofile, the command fails. The server command scripts are automatically deletedfrom all subscribing managed servers.

CLOptsetsSpecifies the client option sets whose association with the profile is deleted. Youcan specify more than one name by separating the names with commas and nointervening spaces. Use the match-all character (*) to delete all client option setsfrom the profile. If you specify a list of client option sets and a match-all clientoption set definition exists for the profile, the command fails. The client option setsare automatically deleted from all subscribing managed servers.

SERVersSpecifies the servers whose association with the profile is deleted. You can specifymore than one name by separating the names with commas and no interveningspaces. You can use the match-all character (*) to delete all servers from theprofile. If you specify a list of servers and a match-all server definition exists for theprofile, the command fails. The server definitions are automatically deleted from allsubscribing managed servers with the following exceptions:

v A server definition is not deleted if the managed server has an open connectionto another server.

v A server definition is not deleted if the managed server has a device class of thedevice type SERVER that refers to the other server.

v A server definition is not deleted if the server is the event server for themanaged server.

SERVERGroupsSpecifies the server groups whose association with the profile is deleted. You canspecify more than one name by separating the names with commas and nointervening spaces. You can use the match-all character (*) to delete all servergroups from the profile. If you specify a list of server groups and a match-all groupdefinition exists for the profile, the command fails. The server group definitions areautomatically deleted from all subscribing managed servers.



|||

||||

|||||||

|||||||

|||||||

||

||

||

|||||||

Examples

Task

Delete all domain associations from a profile named MIKE.

Command:delete profassociation mike domains=*

Related Commands

Table 97. Commands Related to DELETE PROFASSOCIATION

Command Description













|

|

|

||

|

|||

||

||

||

|||

||

||

|||

||

|||

|||

||

|

DELETE PROFILE (Delete a Profile)

Use this command on a configuration manager to delete a profile and stop itsdistribution to managed servers.

You cannot delete a locked profile. You must first unlock the profile with the UNLOCKPROFILE command.

Attention: Deleting a profile from a configuration manager does not delete objectsassociated with that profile from the managed servers. You can use the DELETESUBSCRIPTION command with the DISCARDOBJECTS=YES parameter on eachsubscribing managed server to delete subscriptions to the profile and associatedobjects. This also prevents the managed servers from requesting further updates to theprofile.

Privilege Class


Syntax

ÊÊ DELete PROFIle profile_nameForce = No

Force = NoYes

ÊÍ


Specifies the profile to delete.

ForceSpecifies whether the profile is deleted if one or more managed servers havesubscriptions to that profile. The default is NO. Possible values are:

No Specifies that the profile is not deleted if one or more managed servers havesubscriptions to that profile. You can delete the subscriptions on eachmanaged server using the DELETE SUBSCRIPTION command.

YesSpecifies that the profile is deleted even if one or more managed servers havesubscriptions to that profile. Each subscribing server continues to requestupdates for the deleted profile until the subscription is deleted.

Examples

Task

Delete a profile named BETA, even if one or more managed servers subscribe to it.

DELETE PROFILE


||

||

||

||||||

|

|

|

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

|

|

||

|||

||||

||||

|

|

|

Command:delete beta force=yes

Related Commands

Table 98. Commands Related to DELETE PROFILE

Command Description













DELETE PROFILE


||

|

|||

||

||

||

|||

||

|||

||

||

||

||

|||

|||

||

|

DELETE RECMEDMACHASSOCIATION (Delete Recovery Media and MachineAssociation)

Use this command to remove the association of one or more machines with a recoverymedia. This command does not delete the machine from TSM.

Privilege Class


Syntax

ÊÊ DELete RECMEDMACHAssociation media_name ·

,

machine_name ÊÍ


Specifies the name of the recovery media that is associated with one or moremachines.

machine_name (Required)Specifies the name of the machine associated with the recovery media. To specifya list of machine names, separate the names with commas and no interveningspaces. You can use wildcard characters to specify a name. If a machine is notassociated with the recovery media, the machine is ignored.

Examples

Task

Delete the association between the DIST5RM recovery media and the DISTRICT1 andDISTRICT5 machines.

Command:delete recmedmachassociation dist5rm district1,district5

Related Commands

Table 99. Commands Related to DELETE RECMEDMACHASSOCIATION

Command Description




DELETE RECMEDMACHASSOCIATION


DELETE RECOVERYMEDIA (Delete Recovery Media)

Use this command to delete a recovery media definition from TSM.

Privilege Class


Syntax

ÊÊ DELete RECOVERYMedia media_name ÊÍ


Specifies the name of the recovery media.

Examples

Task

Delete the DIST5RM recovery media.

Command:delete recoverymedia dist5rm

Related Commands

Table 100. Commands Related to DELETE RECOVERYMEDIA

Command Description






DELETE SCHEDULE (Delete a Client or an Administrative Command Schedule)

Use this command to delete schedules from the database.

The DELETE SCHEDULE command takes two forms, depending on whether theschedule applies to client operations or administrative commands. The syntax andparameters for each form are defined separately.

DELETE SCHEDULE


DELETE SCHEDULE — Client

Use the DELETE SCHEDULE command to delete one or more client schedules fromthe database. Any client associations to a schedule are removed when the schedule isdeleted.

Privilege Class

To delete a client schedule, you must have system privilege, unrestricted policyprivilege, or restricted policy privilege for the specified policy domain.

Syntax

ÊÊ DELete SCHedule domain_name schedule_nameType = Client

ÊÍ



schedule_name (Required)Specifies the name of the schedule to be deleted. You can use a wildcardcharacter to specify this name.

Type=ClientSpecifies that a client schedule is deleted. This parameter is optional. The defaultis CLIENT.

Examples

Task

Delete the WEEKLY_BACKUP schedule, which belongs to the EMPLOYEE_RECORDSpolicy domain.

Command:delete schedule employee_records weekly_backup

DELETE SCHEDULE — Client


DELETE SCHEDULE — Administrative Command

Use this command to delete one or more administrative command schedules from thedatabase.

Privilege Class

To delete an administrative command schedule, you must have system authority.

Syntax

ÊÊ DELete SCHedule schedule_name Type = Administrative ÊÍ


Specifies the name of the schedule to be deleted. You can use a wildcardcharacter to specify this name.

Type=Administrative (Required)Specifies that an administrative command schedule is deleted.

Examples

Task

Delete the administrative command scheduled named DATA_ENG.

Command:delete schedule data_eng type=administrative



Related Commands

Table 101. Commands Related to DELETE SCHEDULE

Command Description







DELETE SCRIPT (Delete Command Lines from a Script or Delete the EntireScript)

Use this command to delete a single line from a TSM script or to delete the entire TSMscript.

Privilege Class

To issue this command, the administrator must have previously defined the script ormust have system privilege.

Syntax

ÊÊ DELete SCRipt script_nameLine = number

ÊÍ


Specifies the name of the script to delete. The script is deleted unless you specifya line number.

LineSpecifies the line number to delete from the script. If you do not specify a linenumber, the entire script is deleted.

Examples

Task

Using the following script named QSAMPLE:

001 /* This is a sample script */005 QUERY STATUS010 QUERY PROCESS

Delete line 005 from QSAMPLE.

Command:delete script qsample line=5

Related Commands

Table 102. Commands Related to DELETE SCRIPT

Command Description



DELETE SCRIPT


||

|

||

|

||

|

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

|

|

|||

|||

|

|

|

|||

|

||

|

|||

||

||

||

Table 102. Commands Related to DELETE SCRIPT (continued)

Command Description



RUN Runs a script.


DELETE SCRIPT


|

||

||

||

||

||

|

DELETE SERVER (Delete a Server Definition)

Use this command to delete a server definition. This command fails if the server:

v Is defined as the event server.

v Is named in a device class definition whose device type is SERVER.

v Has an open connection to another server.

Privilege Class


Syntax

ÊÊ DELete SERver server_name ÊÍ


Specifies a server name.

Examples

Task

Delete the definition for a server named SERVER2.

Command:delete server server2

Related Commands

Table 103. Commands Related to DELETE SERVER

Command Description






DELETE SERVER


DELETE SERVERGROUP (Delete a Server Group)

Use this command to delete a server group. If the group being deleted is a member ofother server groups, TSM also removes the group from the other groups.

Privilege Class


Syntax

ÊÊ DELete SERVERGRoup group_name ÊÍ


Specifies the server group to delete.

Examples

Task

Delete a server group named WEST_COMPLEX.

Command:delete servergroup west_complex

Related Commands

Table 104. Commands Related to DELETE SERVERGROUP

Command Description









DELETE SERVERGROUP


||

||

|

|

|

||||||||||

|

|

||

|

|

|

||

|

|||

||

||

|||

||

||

||

||

||

||

|

DELETE SPACETRIGGER (Delete the Database or Recovery Log Space Triggers)

Use this command to delete the definition of the database or recovery log space trigger.

Privilege Class


Syntax

ÊÊ DELete SPACETrigger DBLOG

ÊÍ

ParametersDB

Specifies the database space trigger.

LOGSpecifies the recovery log space trigger.

Examples

Task 1

Delete the definition for the database space trigger.

Command:

delete spacetrigger db

Task 2

Delete the definition for the recovery log space trigger.

Command:

delete spacetrigger log

Related Commands

Table 105. Commands Related to DELETE SPACETRIGGER

Command Description

DEFINE SPACETRIGGER Defines the database or recovery log spacetrigger.


DELETE SPACETRIGGER


||

|

|

||

|

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

|

|

||

||

|

|

|

|

|

|

|

|

|

|

|||

||

|||

|||

Table 105. Commands Related to DELETE SPACETRIGGER (continued)

Command Description


DELETE SPACETRIGGER


|

||

|||

|

DELETE STGPOOL (Delete a Storage Pool)

Use this command to delete a storage pool. To delete a storage pool, you must firstdelete all volumes assigned to the storage pool.

You cannot delete a storage pool that is identified as the next storage pool for anotherstorage pool. For more information on storage pool hierarchy, see the NEXTSTGPOOLparameter in the DEFINE STGPOOL command.

Attention: Do not delete a storage pool that is specified as a destination for amanagement class or copy group in the ACTIVE policy set. Client operations might failas a result.

Privilege Class


Syntax

ÊÊ DELete STGpool pool_name ÊÍ


Specifies the storage pool to delete.

Examples

Task

Delete the storage pool named POOLA.

Command:delete stgpool poola

Related Commands

Table 106. Commands Related to DELETE STGPOOL

Command Description




SET DRMCOPYSTGPOOL Specifies that copy storage pools are managedby DRM.

DELETE STGPOOL


|||

Table 106. Commands Related to DELETE STGPOOL (continued)

Command Description


DELETE STGPOOL


DELETE SUBSCRIBER (Delete Subscriptions from a Configuration ManagerDatabase)

Use this command on a configuration manager to delete managed server subscriptionsfrom the configuration manager database. Use this command when a managed serverno longer exists or cannot notify the configuration manager after deleting a subscription.

Attention: Use this command only in rare situations in which the configurationmanager’s database contains an entry for a subscription, but the managed server doesnot have such a subscription. For example, use this command if a managed server nolonger exists or cannot notify the configuration manager after deleting a subscription.

Under normal circumstances, use the DELETE SUBSCRIPTION command to delete asubscription from the managed server. The managed server notifies the configurationmanager, which then deletes the subscription from its database.

Privilege Class


Syntax

ÊÊ DELete SUBSCRIBer server_name ÊÍ


Specifies the name of the managed server with subscription entries to be deleted.

Examples

Task

Delete all subscription entries for a managed server named DAN.

Command:delete subscriber dan

Related Commands

Table 107. Commands Related to DELETE SUBSCRIBER

Command Description




DELETE SUBSCRIBER


||

|

|||

||||

|||

|

|

|

||||||||||

|

|

||

|

|

|

||

|

|||

||

||

||

|||

Table 107. Commands Related to DELETE SUBSCRIBER (continued)

Command Description



DELETE SUBSCRIBER


|

||

|||

||

|

DELETE SUBSCRIPTION (Delete a Profile Subscription)

Use this command on a managed server to delete a profile subscription. You can alsodelete from the managed server all objects associated with the profile.

Privilege Class


Syntax

ÊÊ DELete SUBSCRIPtion profile_nameDISCARDobjects = No

DISCARDobjects = NoYes

ÊÍ


Specifies the name of the profile for which the subscription is to be deleted.

DISCARDobjectsSpecifies whether objects associated with the profile are to be deleted on themanaged server. This parameter is optional. The default is NO.

No Specifies that the objects are not to be deleted.

YesSpecifies that the objects are to be deleted, unless they are associated withanother profile for which a subscription is defined.

Examples

Task

Delete a subscription to a profile named ALPHA and its associated objects from amanaged server.

Command:delete subscription alpha discardobjects=yes

Related Commands

Table 108. Commands Related to DELETE SUBSCRIPTION

Command Description



DELETE SUBSCRIPTION


||

||

|

|

|

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

|

|

||

|||

||

|||

|

|

||

||

|

|||

||

||

||

Table 108. Commands Related to DELETE SUBSCRIPTION (continued)

Command Description




DELETE SUBSCRIPTION


|

||

|||

|||

||

|

DELETE VOLHISTORY (Delete Sequential Volume History Information)

Use this command to delete volume history file records that are no longer needed (forexample, records for obsolete database backup volumes).

When you delete records for volumes that are not in storage pools (for example,database backup or export volumes), the volumes return to scratch status if TSMacquired them as scratch volumes. Scratch volumes of device type FILE are deleted.When you delete the records for storage pool volumes, the volumes remain in the TSMdatabase.

Notes:

1. Volumes for the most recent database backup series are not deleted.

2. Existing volume history files are not automatically updated with this command.

3. You can use the DEFINE SCHEDULE command to periodically delete volumehistory records.

4. For users of DRM, the database backup expiration should be controlled with theSET DRMDBBACKUPEXPIREDAYS command instead of this DELETEVOLHISTORY command. Using the DELETE VOLHISTORY command removesTSM’s record of the volume. This can cause volumes to be lost that were managedby the MOVE DRMEDIA command. The recommended way to manage theautomatic expiration of DRM database backup volumes is by using the SETDRMDBBACKUPEXPIREDAYS command.

The VOLHSTFILE server option lets you specify a file in a different library and createadditional backup volume history files. After the server is restarted, whenever TSMupdates volume information in the database, it also updates the same information in thebackup files specified by the CHGSVRADSM command.

Privilege Class


Syntax

ÊÊ DELete VOLHistory TODate = dateTOTime = time

Ê

DELETE VOLHISTORY


|

|||||||

Ê Type = AllDBBackupDBDumpDBRpfEXPortRPFileSTGNewSTGReuseSTGDelete

ÊÍ

ParametersTODate (Required)

Specifies the date to use to select sequential volume history information to bedeleted. TSM deletes only those records with a date on or before the date youspecify. You can specify the data using one of the values below:




TODAY−daysor−days

The current date minus daysspecified. The maximum numberof days you can specify is 9999.

TODAY–30 or –30.

To delete records that are 30 or more daysold, you can specify TODAY-30 or simply-30.

TOTimeSpecifies that you want to delete records created on or before this time on thespecified date. This parameter is optional. The default is midnight (00:00:00). Youcan specify the data using one of the values below:


HH:MM:SS A specific time on the specifieddate

12:30:22

NOW The current time on the specifieddate

NOW

NOW+HH:MM or+HH:MM

The current time plus hours andminutes on the specified date

NOW+03:00 or +03:00.

If you issue the DELETE VOLHISTORYcommand at 9:00 withTOTIME=NOW+03:00 or TOTIME=+03:00,TSM deletes records with a time of 12:00or earlier on the specified date.


The current time minus hours andminutes on the specified date

NOW−03:30 or −03:30.

If you issue the DELETE VOLHISTORYcommand at 9:00 withTOTIME=NOW−3:30 or TOTIME=−3:30,TSM deletes records with a time of 5:30 orlater on the specified date.

DELETE VOLHISTORY


Type (Required)Specifies the type of records, which also meet the date and time criteria, to deletefrom the volume history file. Possible values are:

All Specifies to delete all records.

DBBackup

DBDumpSpecifies to delete only online database dump volumes.

DBRpfSpecifies to delete only records that contain information about full andincremental database backup volumes and recovery plan file volumes.

EXPortSpecifies to delete only records that contain information about export volumes.

RPFileSpecifies to delete only records that contain information about recovery planfile objects that are stored on a target server and that meet the specified dateand time criteria.

STGNewSpecifies to delete only records that contain information about new sequentialaccess storage volumes.

STGReuseSpecifies to delete only records that contain information about reusedsequential storage pool volumes.

STGDeleteSpecifies to delete only records that contain information about deletedsequential storage pool volumes.

Examples

Task

Delete all recovery plan file information created on or before 03/28/1998.

Command:delete volhistory type=rpfile todate=03/28/1998

Related Commands

Table 109. Commands Related to DELETE VOLHISTORY

Command Description




DELETE VOLHISTORY


|||

||||

|

|

||

Table 109. Commands Related to DELETE VOLHISTORY (continued)

Command Description

PREPARE Creates a recovery plan file..

QUERY RPFILE Displays information about recovery plan files.




SET DRMRPFEXPIREDAYS Set criteria for recovery plan file expiration.

SET DRMDBBACKUPEXPIREDAYS Specifies criteria for database backup seriesexpiration.

DELETE VOLHISTORY


DELETE VOLUME (Delete a Storage Pool Volume)

Use this command to delete a storage pool volume and, optionally, the files stored inthe volume. If the volume has data, to delete the volume you must do one of thefollowing:

v Before deleting the volume, use the MOVE DATA command to move all files toanother volume.

v Explicitly request to discard all files in the volume when the volume is deleted (byspecifying DISCARDDATA=YES).

If you are deleting several volumes, delete the volumes one at a time. Deleting morethan one volume at a time can adversely affect server performance.

Storage pool volumes cannot be deleted if they are in use. For example, a volumecannot be deleted if a user is restoring or retrieving a file residing in the volume, if theserver is writing information to the volume, or if a reclamation process is using thevolume.

When the volume you delete is a volume with device class DISK, you must free thedisk space after deleting the volume. Delete the physical file member to free up spaceby issuing the AS/400 RMVM command.

Privilege Class

To issue this command, you must have system privilege, unrestricted storage privilege,or restricted storage privilege for the storage pool to which the volume is defined.

Syntax

ÊÊ DELete Volume volume_nameDISCARDdata = No

DISCARDdata = NoYes

Wait = No

Wait = NoYes

ÊÍ


Specifies the name of the volume to delete.

DISCARDdataSpecifies whether files stored in the volume are deleted. This parameter is optional.The default value is NO. Possible values are:

No Specifies that files stored in the volume are not deleted. If the volume containsany files, the volume is not deleted.

YesSpecifies that all files stored in the volume are deleted. The server does notneed to mount the volume for this type of deletion.

DELETE VOLUME


If the volume being deleted is a primary storage pool volume, the serverchecks whether any copy storage pool has copies of files that are beingdeleted. When files stored in a primary storage pool volume are deleted, anycopies of these files in copy storage pools are also deleted.

When you delete a disk volume in a primary storage pool, the command alsodeletes any files that are cached copies (copies of files that have beenmigrated to the next storage pool).

Do not use the DELETE VOLUME command with DISCARDDATA=YES if arestore process (RESTORE STGPOOL or RESTORE VOLUME) is running.The DELETE VOLUME command could cause the restore to be incomplete.

If you cancel the DELETE VOLUME operation during processing or if a systemfailure occurs, some files might remain on the volume. You can delete thesame volume again to have the server delete the remaining files and then thevolume.

WaitSpecifies whether to wait for the server to complete processing this command inthe foreground. This parameter affects processing only when you have alsorequested that any data on the volume be discarded. This parameter is optional.The default value is No. Possible values are:

No Specifies that the server processes this command in the background. You cancontinue with other tasks while the command is being processed. The serverdisplays the messages that are created from the background process either inthe activity log or the console output message queue, depending on wheremessages are logged.


Examples

Task

Delete storage pool volume stgvol.1 from the storage pool FILEPOOL.

Command:delete volume stgvol.1

Related Commands

Table 110. Commands Related to DELETE VOLUME

Command Description



DELETE VOLUME


||||

Table 110. Commands Related to DELETE VOLUME (continued)

Command Description

MOVE DATA Moves data from a specified storage poolvolume to another storage pool volume.





DELETE VOLUME


DISABLE EVENTS (Disable Events for Event Logging)

Use this command to disable the processing of one or more events to one or morereceivers (destinations).

If you enter any invalid events, receivers, node or server names, TSM issues an errormessage. However, TSM disables any valid events, receivers, node or server namesthat were specified.

Notes:

1. Messages in the SEVERE category and message ANR9999D can provide valuablediagnostic information if there is a serious TSM problem. For this reason, youshould not disable these messages.

2. Certain messages are displayed on the console even if they are disabled. Theseinclude some messages issued during server startup and shutdown and responsesto administrative commands.

3. Server messages, which originated on the server from which this command wasissued, cannot be disabled for the activity log.

Privilege Class


Syntax

ÊÊ DISAble EVents ·

,

ALLCONSOLEACTLOGEVENTSERVERFILETIVOLIUSEREXIT

·

,

event_nameALLINFOWARNINGERRORSEVERE

Ê

Ê

·

·

,

NODEname = node_name,

SERVername = server_name

ÊÍ

DISABLE EVENTS


Parametersreceivers (Required)

Specifies the name of one or more receivers for which to disable events. You canspecify multiple receivers by separating them with commas and no interveningspaces. Possible values are:

ALLSpecifies all receivers, except for server events on the activity log receiver(ACTLOG). Only client events can be disabled for the activity log receiver.

CONSOLESpecifies the standard server console as a receiver.

ACTLOGSpecifies the TSM activity log as a receiver. Only client events can be disabledfor this receiver. Server events cannot be disabled for the activity log.




USEREXITSpecifies a user-written program to which TSM writes information as areceiver.

events (Required)Specifies the names of events to be disabled. You can specify multiple events byseparating them with commas and no intervening spaces. Valid values are ALL, amessage name, or a severity category.

ALLSpecifies all events.

eventnameSpecifies a four-digit message number preceded by ANR for a server event orANE for a client event. The NODENAMES parameter is required if clientevents are to be disabled for matching nodes. The SERVERNAME parameteris required if server events are to be disabled for matching servers. Validranges are from ANR0001 to ANR9999 and from ANE4000 to ANE4999.

severity categoriesIf the event list contains a severity category, all events of that severity aredisabled for the specified nodes. The message types are:

INFOInformation messages (type of I).

WARNINGWarning messages (type of W).

DISABLE EVENTS


||

|||||

ERRORError messages (type of E).

SEVERESevere error messages (type of S).

NODEnameSpecifies the name of one or more node names for which events are to bedisabled. You can use the wildcard character to specify all nodes. You can specifyNODENAME or SERVERNAME. If neither parameter is specified, the events aredisabled for the server running this command.

SERVernameSpecifies the name of one or more server names for which events are to bedisabled. You can use the wildcard character to specify all servers other than theserver running this command. You can specify NODENAME or SERVERNAME. Ifneither parameter is specified, the events are disabled for the server running thiscommand.

Examples

Task

Disable all client events in the INFO and WARNING categories for the activity log andconsole receivers for all nodes.

Command:disable events actlog,console info,warning nodename=*

Related Commands

Table 111. Commands Related to DISABLE EVENTS

Command Description

BEGIN EVENTLOGGING Starts event logging to a specified receiver.






DISABLE EVENTS


|||||

||||||

DISABLE SESSIONS (Temporarily Prevent Client Node Access to the Server)

Use this command to prevent client nodes from starting new sessions; however, activesessions will complete. Server processes, such as migration and reclamation, are notaffected when you issue this command.

Privilege Class


Syntax

ÊÊ DISAble SESSions ÊÍ

Parameters

None.

Examples

Task

Temporarily prevent new client node sessions from accessing the server.

Command:disable sessions

Related Commands

Table 112. Commands Related to DISABLE SESSIONS

Command Description

CANCEL SESSION Cancels active sessions with the server.




DISABLE SESSIONS


DISMOUNT VOLUME (Dismount a Volume by Volume Name)

Use this command to dismount an idle volume by volume name.

Privilege Class


Syntax

ÊÊ DISMount Volume volume_name ÊÍ


Specifies the name of the volume to dismount.

Examples

Task

Dismount the volume BTV005.

Command:dismount volume btv005

Related Commands

Table 113. Command Related to DISMOUNT VOLUME

Command Description

QUERY MOUNT Displays information about mounted sequentialaccess media.

DISMOUNT VOLUME


ENABLE EVENTS (Enable Server or Client Events for Logging)

Use this command to enable one or more server or client events for logging to one ormore receivers (destinations).

If you enter any invalid events, receivers, node or server names, TSM issues an errormessage. However, TSM enables any valid events, receivers, node or server namesthat were specified.

Note: Certain events, such as some messages issued during server start-up andshutdown, automatically go to the console but do not go to other receivers evenif they are enabled.

Privilege Class


Syntax

ÊÊ ENable EVents ·

,

ALLCONSOLEACTLOGEVENTSERVERFILETIVOLIUSEREXIT

·

,

event_nameALLINFOWARNINGERRORSEVERE

Ê

Ê

·

·

,

NODEname = node_name,

SERVername = server_name

ÊÍ

Parametersreceivers (Required)

Specifies one or more receivers for which to log enabled events. You can specifymultiple receivers by separating them with commas and no intervening spaces.Valid values are:

ALLSpecifies all receivers.


ENABLE EVENTS







eventsSpecifies the type of events to be enabled. You can specify multiple events byseparating them with commas and no intervening spaces. This is a requiredparameter. Valid values are ALL, a message name or a severity category.

ALLSpecifies that all events are enabled.

eventnameSpecifies a four-digit message number preceded by ANR for a server event orANE for a client event. To enable client events, you must specify theNODENAMES parameter. To enable server events, you must specify theSERVERNAMES parameter.Valid ranges are from ANR0001 to ANR9999 andfrom ANE4000 to ANE4999.

severity categoriesIf the event list contains a severity category, all events of that severity areenabled for the specified nodes. The message types are:

INFOInformation messages (type of I) are enabled.

WARNINGWarning messages (type of W) are enabled.

ERRORError messages (type of E) are enabled.

SEVERESevere error messages (type of S) are enabled.

NODEnameSpecifies one or more client nodes for which events are enabled. You can use awildcard character to specify all client nodes. You can specify NODENAME orSERVERNAME. If neither parameter is specified, events are enabled for the serverrunning this command.

SERVernameSpecifies one or more servers for which events are to be enabled. You can use awildcard character to specify all servers other than the server from which this

ENABLE EVENTS


||

|||

|||

command is issued. You can specify SERVERNAME or NODENAME. If neitherparameter is specified, the events are enabled for the server running thiscommand.

Examples

Task

Enable all ERROR and SEVERE client events to the USEREXIT receiver for the nodeBONZO.

Command:enable events userexit error,severe nodename=bonzo

Related Commands

Table 114. Commands Related to ENABLE EVENTS

Command Description







ENABLE EVENTS


|||

ENABLE SESSIONS (Resume User Activity on the Server)

Use this command to allow client node activity to begin after issuing the DISABLESESSIONS command. The processing of this command does not affect systemprocesses, such as migration and reclamation.

Use the QUERY STATUS command to display the availability of the server.

Privilege Class


Syntax

ÊÊ ENable SESSions ÊÍ

Parameters

None.

Examples

Task

Resume normal operation, permitting client nodes to access the server.

Command:enable sessions

Related Commands

Table 115. Commands Related to ENABLE SESSIONS

Command Description





ENABLE SESSIONS


END EVENTLOGGING (Stop Logging Events)

Use this command to stop logging events to an active receiver.

Privilege Class


Syntax

ÊÊ

·

ALLEND EVentlogging

,


ÊÍ

Parameters

Specify a type of receiver. You can specify multiple receivers by separating them withcommas and no intervening spaces. This is an optional parameter. The default is ALL. Ifyou specify ALL or no receiver, logging ends for all receivers.

ALLSpecifies all receivers.

CONSOLESpecifies the server console as a receiver.

ACTLOGSpecifies the TSM activity log as a receiver. Logging can be stopped only for clientevents.





END EVENTLOGGING


||

Examples

Task

End logging of events to the user exit.

Command:end eventlogging userexit

Related Commands

Table 116. Commands Related to END EVENTLOGGING

Command Description







END EVENTLOGGING


EXPIRE INVENTORY (Manually Start Inventory Expiration Processing)

Use this command to manually start inventory expiration processing. The inventoryexpiration process removes client backup and archive file copies from server storagebased on policy specified in the backup and archive copy groups of the managementclasses to which the files are bound.

Only one expiration process is allowed at any time. If an expiration process is currentlyrunning, you cannot start another process.

You can set up automatic expiration processing by using the expiration intervalspecified in the server options. If you set the expiration interval value to 0, the serverdoes not run expiration automatically, and you must issue the EXPIRE INVENTORYcommand to start expiration processing. See the SVRPARM parameter in theCHGSVRADSM command for more information.


When you have the Tivoli Disaster Recovery Manager product for your TSM server, theinventory expiration process removes eligible virtual volumes that are used for databasebackup. The SET DRMDBBACKUPEXPIREDAYS command controls when thesevolumes are eligible for expiration. The inventory expiration process that runs duringTSM initialization does not remove virtual volumes.

Privilege Class


Syntax

ÊÊ EXPIre InventoryQuiet = No

Quiet = NoYes

Wait = No

Wait = NoYes

Ê

ÊDUration = minutes

ÊÍ

ParametersQuiet

Specifies whether the server suppresses detailed messages about policy changesduring expiration processing. This parameter is optional. The default is NO.Possible values are:

EXPIRE INVENTORY


|||||

No Specifies that the server sends detailed informational messages.

YesSpecifies that the server sends only summary messages. The server issuesmessages about policy changes only when files are deleted and either thedefault management class or retention grace period for the domain has beenused to expire the files.

You can also limit expiration messages to summary messages by setting aserver option. See the SRVPARM parameter in the CHGSRVADSM commandfor more information.


No Specifies that the server processes this command in the background. You cancontinue with other tasks while the command is being processed.


DUrationSpecifies the maximum number of minutes for the expiration process to run. Theprocess stops when the specified number of minutes pass or when all eligibleexpired objects are deleted, whichever comes first. You can specify a number from1 to 999999. This parameter is optional.

Examples

Task

Run the expiration process for two hours.

Command:expire inventory duration=120

Related Commands

Table 117. Commands Related to EXPIRE INVENTORY

Command Description

AUDIT LICENSES Checks for compliance with defined licenses.



EXPIRE INVENTORY


|||||

|

||

|

EXPORT ADMIN (Copy Administrator Information to Sequential Media)

Use this command to export administrator and authority definitions from a TSM serverto sequential media. TSM exports administrator information such as:

v Administrator name, password, and contact information

v Administrative privilege classes the administrator has been granted

v Whether the administrator ID is locked from server access

You can use the QUERY ACTLOG command to view the status of the export operation.You can also view this information from the server console.

This command generates a background process that can be cancelled with theCANCEL PROCESS command. If an EXPORT ADMIN background process iscancelled, the sequential media holding the exported data are incomplete and shouldnot be used for importing data. To display information on background processes, usethe QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ EXPort Admin

·

*

,

admin_name

Preview = No

(1) (2)Preview = No

Yes

Ê

Ê(1)

DEVclass =device_class_name

Scratch = Yes

(2)Scratch = Yes

No

Ê

Ê

·

,(2)

VOLumenames = volume_nameFILE:file_name

USEDVolumelist =file_nameÊÍ

Notes:

1 If PREVIEW=NO, a device class must be specified.

2 If PREVIEW=NO and SCRATCH=NO, one or more volumes must be specified.

EXPORT ADMIN


Parametersadmin_name

Specifies the administrators for which information is to be exported. This parameteris optional. The default is all administrators.

Separate the items in the list by commas, with no intervening spaces. You can usewildcard characters to specify names.

PreviewSpecifies whether to preview the results of the export operation, without exportinginformation. You can use this parameter to preview how many bytes of data aretransferred, allowing you to determine how many volumes will be required. Thisparameter is optional. The default value is NO. The values are:

No Specifies that the administrator information is to be exported. If you specify thisvalue, you must specify a device class.

YesSpecifies that the operation will be previewed but not performed. Information isreported to the server console and the activity log. If you specify this value,you do not need to specify a device class.

DEVclassSpecifies the device class to which the export data is to be written. You cannotspecify the DISK device class.

Notes:

1. If all drives for the device class are busy when the export runs, TSM cancelslower priority operations, such as reclamation, to make a drive available.

2. You can export data to a storage pool on another server by specifying a deviceclass whose device type is SERVER. For details about storing data on anotherserver, see the Administrator’s Guide.

ScratchSpecifies whether scratch volumes can be used. The default value is YES. Thevalues are:

YesSpecifies that scratch volumes can be used for the export. If you also specify alist of volumes, scratch volumes are used only if there is not enough space onthe volumes specified.

No Specifies that scratch volumes cannot be used for export. To determine howmany volumes you may need, you can run the command specifyingPREVIEW=YES.

VOLumenamesSpecifies the volumes to be used to contain exported data. This parameter isoptional, unless you specify SCRATCH=NO and PREVIEW=NO. The values are:

volume_nameSpecifies the volume name. To specify multiple volumes, separate the nameswith commas and no intervening spaces.

EXPORT ADMIN


FILE:file_nameSpecifies the name of a file that contains a list of volumes. In the file, eachvolume name must be on a separate line. Blank and comment lines that beginwith an asterisk are ignored.

Use these naming conventions when specifying volumes associated with thefollowing device types:

For this device Specify

TAPE 1 – 6 alphanumeric characters.

FILE Any fully qualified file name string. For example,QUSRADSM/EXPORT(VOLl).

OPTICAL 1–32 alphanumeric characters.

SERVER 1–250 alphanumeric characters.

USEDVolumelistSpecifies a file where a list of volumes used in the export operation will be stored.This parameter is optional.

This file can be used as input to the import operation. This file will containcomment lines with the date and time the export was done, and the commandissued to create the export.

Note: If you specify an existing file, the file will be overwritten.

Examples

Task 1

From the server, export the information for all defined administrators to tape volumesTAPE01, TAPE02, and TAPE03. Specify that these tape volumes be read by a deviceassigned to the MENU1 device class.

The number and type of objects exported are reported to the system console and in theactivity log.

Command:export admin devclass=menu1 volumenames=tape01,tape02,tape03

Task 2

From the server, export the information for all defined administrators to tape volumeslisted in a file named TAPEVOL . This file contains these lines:

TAPE01TAPE02TAPE03

Specify that these tape volumes be used by a device assigned to the MENU1 deviceclass.

EXPORT ADMIN


The number and type of objects exported are reported to the system console and in theactivity log.

Command:export admin devclass=menu1 volumenames=file:qusradsm/tapevol

Related Commands

Table 118. Commands Related to EXPORT ADMIN

Command Description


EXPORT NODE Copies client node information to externalmedia.

EXPORT POLICY Copies policy information to external media.

EXPORT SERVER Copies all or part of the server to externalmedia.

IMPORT ADMIN Restores administrative information fromexternal media.



EXPORT ADMIN


EXPORT NODE (Copy Client Node Information to Sequential Media)

Use this command to export client node definitions from a TSM server to sequentialmedia. Each client node definition includes following:

v User ID, password, and contact information

v Name of the client’s assigned policy domain

v File compression status

v Whether the user has the authority to delete backed up or archived files from serverstorage

v Whether the client node ID is locked from server access

Optionally, you can also export the following:

v File space definitions

v Backed up, archived, and space-managed files

v Access authorization information pertaining to the file spaces exported

This command generates a background process that can be cancelled with theCANCEL PROCESS command. If an EXPORT NODE background process is cancelled,the sequential media holding the exported data are incomplete and should not be usedfor importing data. To display information on background processes, use the QUERYPROCESS command.

You can use the QUERY ACTLOG command to view the status of the export operation.

Privilege Class


Syntax

ÊÊ EXPort Node

·

*

,

node_name

Ê

Ê

·

,

FILESpace=file_space_name

Ê

EXPORT NODE


Ê

·

,

DOmains=domain_name

FILEData = None

FILEData = ALlNoneARchiveBackupBACKUPActiveALLActiveSPacemanaged

Ê

ÊPreview = No

(1) (2)Preview = No

Yes

(1)DEVclass =device_class_name

Ê

ÊScratch = Yes

(2)Scratch = Yes

No ·

,(2)


Ê

ÊUSEDVolumelist =file_name

ÊÍ

Notes:



Parametersnode_name

Specifies the client node names for which information is to be exported. Thisparameter is optional. Separate multiple names with commas and no interveningspaces. You can use wildcard characters to specify names.

FILESpaceSpecifies the file spaces for which data is to be exported. This parameter isoptional. Separate multiple names with commas and no intervening spaces. Youcan use wildcard characters to specify a name.

DOmainsSpecifies the policy domains from which nodes should be exported. This parameteris optional. Separate multiple names with commas and no intervening spaces. Fora node to be exported, it must belong to one of the specified domains. You can usewildcard characters to specify a name.

EXPORT NODE


FILEDataSpecifies the type of files that should be exported for all nodes defined to theserver. This parameter is optional. The default value is NONE.

The device class used by the file data is determined by the device class for thestorage pool. If it is the same device class specified in this command, two drivesare needed to export node information. The mount limit for the device class mustbe at least 2.

Note: If client nodes registered as TYPE=SERVER are being exported, specifyALL, ARCHIVE, or ALLACTIVE.

The following descriptions mention active and inactive backup file copies. An activebackup file copy is the most recent backup copy for a file that still exists on theclient workstation. All other backup file copies are called inactive copies. Thevalues are:

ALlTSM exports all backup versions of files, all archived files, and allspace-managed files.

NoneTSM does not export files, only definitions.

ARchiveTSM exports only archived files.

BackupTSM exports only backup versions, whether active or inactive.

BACKUPActiveTSM exports only active backup versions.

ALLActiveTSM exports all active backup versions of files, all archived files, and allspace-managed files.

SPacemanagedTSM exports only space-managed files.

PreviewSpecifies whether to preview the results of the export operation, without exportinginformation. You can use this parameter to preview how many bytes of data wouldbe transferred, allowing you to determine how many volumes will be required. Thisparameter is optional. The default value is NO. The values are:

No Specifies that the node information is to be exported. If you specify this value,you must also specify a device class.


EXPORT NODE


DEVclassSpecifies the device class to which export data is to be written. You cannot specifythe DISK device class.

Notes:



ScratchSpecifies whether scratch volumes can be used. The default is SCRATCH=YES.The values are:

YesSpecifies that scratch volumes can be used for export. If you also specify a listof volumes, scratch volumes are used only if there is not enough space on thevolumes specified.


VOLumenamesSpecifies the volumes to be used to contain exported data. This parameter isoptional, unless you specify SCRATCH=NO and PREVIEW=NO. If you do notspecify a volume name, scratch volumes are used. The values are:









USEDVolumelistSpecifies the file where a list of volumes used in the export operation will bestored. This parameter is optional.

EXPORT NODE




Examples

Task 1

From the server, export client node information to tape volumes TAPE01, TAPE02, andTAPE03. Specify that these tape volumes be used by a device assigned to the MENU1device class.

Command:export node devclass=menu1 volumenames=tape01,tape02,tape03

Task 2

From the server, export the client node information to tape volumes listed in a filenamed TAPEVOL . This file contains these lines:

TAPE01TAPE02TAPE03

Specify that these tape volumes be read by a device assigned to the MENU1 deviceclass.

Command:export node devclass=menu1 volumenames=file:qusradsm/tapevol

Related Commands

Table 119. Commands Related to EXPORT NODE

Command Description


EXPORT ADMIN Copies administrative information to externalmedia.



IMPORT NODE Restores client node information from externalmedia.



EXPORT NODE


EXPORT POLICY (Copy Policy Information to Sequential Media)

Use this command to export policy information from a TSM server to sequential media.TSM exports administrator information, such as:

v Policy domain definitions

v Policy set definitions, including the active policy set

v Management class definitions, including the default management class

v Backup copy group and archive copy group definitions

v Schedule definitions for each policy domain

v Client node associations, if the client node exists on the target server

You can use the QUERY ACTLOG command to view the status of the export operation.You can also view this information from the server console.

This command generates a background process that can be cancelled with theCANCEL PROCESS command. If an EXPORT POLICY background process iscancelled, the sequential media holding the exported data are incomplete and shouldnot be used for importing data. To display information on background processes, usethe QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ EXPort Policy

·

*

,

domain_name

Preview = No

(1) (2)Preview = No

Yes

Ê

Ê(1)

DEVclass =device_class_name

Scratch = Yes

(2)Scratch = Yes

No

Ê

Ê

·

,(2)


USEDVolumelist =file_nameÊÍ

EXPORT POLICY


Notes:



Parametersdomain_name

Specifies the policy domains for which information is to be exported. Thisparameter is optional. The default is all policy domains. Separate multiple nameswith commas and no intervening spaces. You can use wildcard characters tospecify names.

PreviewSpecifies whether to preview the results of the export operation, without exportinginformation. You can use this parameter to preview how many bytes of data aretransferred, allowing you to determine how many volumes will be required. Thisparameter is optional. The default value is NO. The values are:

No Specifies that the policy information is to be exported. If you specify this value,you must also specify a device class.


DEVclassSpecifies the device class to which export data is to be written. This parameter isrequired, unless you specified PREVIEW=YES. You cannot specify the DISKdevice class.

Notes:



ScratchSpecifies whether scratch volumes can be used. The default is SCRATCH=YES.The values are:



VOLumenamesSpecifies the volumes to be used to contain exported data. This parameter is

EXPORT POLICY


optional, unless SCRATCH=NO and PREVIEW=NO. If you do not specify a volumename, scratch volumes are used. The values are:









USEDVolumelistSpecifies a file where a list of volumes used in the export operation will be stored.This parameter is optional.

This file can be used as input to the export operation. This file will containcomment lines with the date and time the export was done, and the commandissued to create the export.


Examples

Task 1

From the server, export policy information to tape volumes TAPE01, TAPE02, andTAPE03. Specify that these tape volumes be read by a device assigned to the MENU1device class.

Command:export policy devclass=menu1 volumenames=tape01,tape02,tape03

Task 2

From the server, export policy information to tape volumes listed in a file namedTAPEVOL . This file contains these lines:

TAPE01TAPE02TAPE03

EXPORT POLICY



Command:export policy devclass=menu1 volumenames=file:qusradsm/tapevol

Related Commands

Table 120. Commands Related to EXPORT POLICY

Command Description





IMPORT POLICY Restores policy information from external media.



EXPORT POLICY


EXPORT SERVER (Copy Server Information to Sequential Media)

Use this command to export all or part of the server control information and client filedata (if specified) from the TSM server to sequential media.

The EXPORT SERVER command exports server control information such as:

v Policy domain definitions

v Policy set definitions

v Management class and copy group definitions

v Schedule definitions defined for each policy domain

v Administrator definitions

v Client node definitions, if the client node exists on the target server

Optionally, you can export server data information such as:

v File space definitions

v Access authorization information pertaining to the file spaces exported

v Backed up, archived, and space-managed files

You can use the QUERY ACTLOG command to view the actual status informationindicating the size and the success or failure of the export operation.

This command generates a background process that can be cancelled with theCANCEL PROCESS command. If an EXPORT SERVER background process iscancelled, the sequential media holding the exported data are incomplete and shouldnot be used for importing data. To display information on background processes, usethe QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ EXPort ServerFILEData = None


Ê

EXPORT SERVER


ÊPreview = No

(1) (2)Preview = No

Yes

(1)DEVclass =device_class_name

Ê

ÊScratch = Yes

(2)Scratch = Yes

No ·

,(2)


Ê

ÊUSEDVolumelist =file_name

ÊÍ

Notes:



ParametersFILEData

Specifies the type of files that should be exported for all nodes defined to theserver. This parameter is optional. The default value is NONE.

The device class used by the file data is determined by the device class for thestorage pool. If it is the same device class specified in this command, two drivesare needed to export server information. The mount limit for the device class mustbe set to at least 2.


ALlTSM exports all backup versions of files, all archived files, and allspace-managed files.

NoneTSM does not export files, only definitions.

ARchiveTSM exports only archived files.

BackupTSM exports only backup versions, whether active or inactive.

BACKUPActiveTSM exports only active backup versions.

EXPORT SERVER


ALLActiveTSM exports all active backup versions of files, all archived files, and allspace-managed files.

SPacemanagedTSM exports only space-managed files.

PreviewSpecifies whether you want to preview the results of the export operation, withoutexporting information. You can use this parameter to preview how many bytes ofdata are transferred, allowing you to determine how many volumes will be required.This parameter is optional. The default value is NO. The values are:

No Specifies that the server information is to be exported. If you specify this value,you must also specify a device class.


DEVclassSpecifies the device class to which export data is to be written. You cannot specifythe DISK device class.

Notes:


2. You can export data to a storage pool on another server by specifying a deviceclass whose device type is SERVER. For details about storing data on anotherserver, see Administrator’s Guide.

ScratchSpecifies whether scratch volumes can be used. The default is YES. The valuesare:



VOLumenamesSpecifies the volumes to be used to contain exported data. This parameter isoptional, unless you specify SCRATCH=NO and PREVIEW=YES. If you do notspecify a volume name, scratch volumes are used. The values are:


EXPORT SERVER









USEDVolumelistSpecifies the file where a list of volumes used in the export operation will bestored. This parameter is optional.



Examples

Task 1

From the server, export server information to tape volumes TAPE01, TAPE02, andTAPE03. Specify that these tape volumes be read by a device assigned to the MENU1device class.

Command:export server devclass=menu1 volumenames=tape01,tape02,tape03

Task 2

From the server, export server information to tape volumes listed in a file namedTAPEVOL . This file contains these lines:

TAPE01TAPE02TAPE03


Command:export server devclass=menu1 volumenames=file:qusradsm/tapevol

EXPORT SERVER


Related Commands

Table 121. Commands Related to EXPORT SERVER

Command Description





IMPORT SERVER Restores all or part of the server from externalmedia.



EXPORT SERVER


EXTEND DB (Increase the Assigned Capacity of the Database)

Use this command to increase the space that can be used by the database in allallocated database volumes.

Attention: You cannot change the size of an allocated database volume after it hasbeen defined to TSM. If you do, TSM may not initialize correctly and data could be lost.

The EXTEND DB command can be initiated while users are accessing the server. Usethe QUERY DB command to determine how much you can increase the assignedcapacity of the database.

Privilege Class


Syntax

ÊÊ EXTend DB megabytesWait = No

Wait = NoYes

ÊÍ

Parametersmegabytes (Required)

Specifies space, in megabytes, to be added to the assigned capacity of thedatabase. The value should be in increments of 4MB. If you do not specify theextension in 4MB increments, TSM rounds the number to the next 4MB partition.



YesSpecifies that the server processes this command in the foreground

Examples

Task

Extend the assigned capacity of the database by 52MB.

Command:extend db 52

EXTEND DB


Related Commands

Table 122. Commands Related to EXTEND DB

Command Description





REDUCE DB Attempts to free up a database volume byreducing usable storage within the volumesdefined.

EXTEND DB


EXTEND LOG (Increase the Assigned Capacity of the Recovery Log)

Use this command to increase space that can be used by the recovery log in allallocated recovery log volumes.

Attention: Do not change the size of an allocated recovery log volume after it isdefined to TSM. If you do, TSM may not initialize correctly and data could be lost.

The EXTEND LOG command can be initiated while users are accessing the server. Usethe QUERY LOG command to determine how much you can increase the assignedcapacity of the recovery log.

Privilege Class


Syntax

ÊÊ EXTend LOG megabytesWait = No

Wait = NoYes

ÊÍ


Specifies the space, in megabytes, to be added to the assigned capacity of therecovery log. The value should be in increments of 4MB. If you do not specify theextension in 4MB increments, TSM rounds the number to the next 4MB partition.

WaitSpecifies whether to wait for the server to complete processing this command inthe foreground. This parameter is optional. The default is No. Possible values are:


YesSpecifies that the server processes this command in the foreground.

Examples

Task

Extend the assigned capacity of the recovery log by 4MB.

Command:extend log 4

EXTEND LOG


Related Commands

Table 123. Commands Related to EXTEND LOG

Command Description






REDUCE LOG Attempts to free up a log volume by reducingusable storage within the volumes defined.

EXTEND LOG


GRANT AUTHORITY (Add Administrator Authority)

Use this command to grant an administrator one or more administrative privilegeclasses, and authority to access client nodes.

You cannot grant restricted privilege to an unrestricted policy or unrestricted storageadministrator. You must use the REVOKE AUTHORITY command to remove theadministrator’s unrestricted privilege, then use this command to grant restricted privilegeto the administrator.

Privilege Class


Syntax

ÊÊ GRant AUTHority admin_name ·

,(1)

CLasses = SYstemPolicySTorageOperatorAnalystNode A

Ê

Ê

·

,(1)

DOmains = domain_name ·

,(1)

STGpools = pool_name

ÊÍ

A:

AUTHority = Access

AUTHority = AccessOwner

DOmains=domain_nameNOde=node_name

Notes:

1 You must specify one or more of these parameters.

Parametersadmin_name (Required)

Specifies the name of the administrator being granted an administrative privilegeclass.

GRANT AUTHORITY


CLassesSpecifies one or more privilege classes to grant to an administrator. This parameteris required, except when you specify the STGPOOLS parameter. You can specifymore than one privilege class by separating each with a comma. Possible classesare:

SYstemSpecifies that you want to grant system privilege to an administrator. A systemadministrator has the highest level of authority in TSM. A system administratorcan issue any administrative command and has authority to manage all policydomains and all storage pools. Do not specify additional privilege classes orthe DOMAINS or STGPOOLS parameters when granting system privilege toan administrator. Only a system administrator can grant authority to otheradministrators.

PolicySpecifies that you want to grant policy privilege to an administrator. If you donot specify the DOMAINS parameter, unrestricted policy privilege is granted.An unrestricted policy administrator can issue commands that affect all existingpolicy domains as well as any policy domains that are defined in the future. Anunrestricted policy administrator cannot define, delete, or copy policy domains.Use the GRANT AUTHORITY command with CLASSES=POLICY and noDOMAINS parameter to upgrade a restricted policy administrator to anunrestricted policy administrator.

STorageSpecifies that you want to grant storage privilege to an administrator. If theSTGPOOLS parameter is not specified, unrestricted storage privilege isgranted. An unrestricted storage administrator can issue all commands thatallocate and control storage resources for the server. An unrestricted storageadministrator can issue commands that affect all existing storage pools as wellas any storage pools that are defined in the future. An unrestricted storageadministrator cannot define or delete storage pools. Using the GRANTAUTHORITY command with CLASSES=STORAGE and no STGPOOLSparameter upgrades a restricted storage administrator to an unrestrictedstorage administrator.

OperatorSpecifies that you want to grant operator privilege to an administrator. Anadministrator with operator privilege can issue commands that control theimmediate operation of the server and the availability of storage media.

AnalystSpecifies that you want to grant analyst privilege to an administrator. Anadministrator with analyst privilege can issue commands that reset thecounters which track server statistics.

NodeSpecifies that you want to grant a node privilege to a user. A user with clientnode privilege can remotely access a web backup-archive client with anadministrative user ID and password if they have been given owner authorityor access authority. Access authority is the default for a node privilege class.

GRANT AUTHORITY


||

|||||

Note: When you specify the node privilege class, you must also specify eitherthe DOMAIN parameter or the NODE parameter, but not both.

AUTHoritySpecifies the authority level of a user with node privilege. This parameteris optional.

If an administrator already has system or policy privilege to the policydomain to which the node belongs, this command will not change theadministrator’s privilege. Possible authority levels are:

AccessSpecifies that you want to grant client access authority to a user withthe node privilege class. This is the default when CLASSES=NODE isspecified. A user with client access authority can access a webbackup-archive client and perform backup and restore actions on thatclient.

Note: A user with client access authority cannot access that clientfrom another system by using the -NODENAME parameter.

A client node can set the REVOKEREMOTEACCESS option torestrict a user that has node privilege with client accessauthority from accessing a client workstation that is running aweb client. This option does not apply to administrators withclient owner authority, system privilege, or policy privilege tothe policy domain to which the node belongs.

OwnerSpecifies that you want to grant client owner authority to a user withthe node privilege class. A user with client owner authority can accessa web backup-archive client through the web client interface and alsoaccess their data from another client using the -NODENAMEparameter.

DOmainsSpecifies that you want to grant to the administrator client access or clientowner authority to all clients in the specified policy domain. You cannotuse this parameter together with the NODE parameter.

NOdeSpecifies that you want to grant the administrator client access or clientowner authority to the node. You cannot use this parameter together withthe DOMAIN parameter.

DOmainsSpecifies that you want to grant restricted policy privilege to an administrator.

Restricted policy privilege permits an administrator to issue a subset of the policycommands for the domains to which the administrator is authorized. You can usethis parameter to grant additional policy domain authority to a restricted policyadministrator. This parameter is optional. You can specify more than one policydomain by delimiting each policy domain name with a comma.

GRANT AUTHORITY


||

|||

|||

||||||

||

||||||

||||||

||||

||||

|

You can use wildcard characters to specify a name. Authority for all matching policydomains is granted.

STGpoolsSpecifies that you want to grant restricted storage privilege to an administrator. Ifthe STGPOOLS parameter is specified, then CLASSES=STORAGE is optional.

Restricted storage privilege permits you to issue a subset of the storage commandsfor the storage pools to which the administrator is authorized. You can use thisparameter to grant additional storage pool authority to a restricted storageadministrator. This parameter is optional. You can specify more than one storagepool by delimiting each storage pool name with a comma.

You can use wildcard characters to specify a name. Authority for all matchingstorage pools is granted.

Examples

Task 1

Grant system privilege to administrator LARRY.

Command:grant authority larry classes=system

Task 2

Specify additional policy domains that the restricted policy administrator CLAUDIA canmanage.

Command:grant authority claudia domains=employee_records,prog1

Task 3

Provide administrator TOM with unrestricted storage privilege and restricted policyprivilege for the domains whose names start with EMP.

Command:grant authority tom classes=storage domains=emp*

Task 4

Grant node privilege to user HELP so that help desk personnel can assist the clientnode LABCLIENT in backing up or restoring data without having other higher-level TSMprivileges.

Command:grant authority help classes=node node=labclient

GRANT AUTHORITY


|

|||

||

Related Commands

Table 124. Commands Related to GRANT AUTHORITY

Command Description

QUERY ADMIN Displays information about one or more TSMadministrators.

REVOKE AUTHORITY Revokes one or more privilege classes orrestricts access to policy domains and storagepools.

GRANT AUTHORITY


|

HALT (Shut Down the Server)

Use this command to shut down the server. The HALT command forces an abruptshutdown, which cancels all the administrative and client node sessions even if they arenot completed.

Any transactions in progress interrupted by this command are rolled back when yourestart the server. If the QUIESCE option is specified, transaction activity is halted whencurrent transactions are completed and the server is shut down.

Use the QUIESCE option only if you plan to perform a stand-alone database dump withthe DSMSERV DUMPDB command immediately following server shutdown. See theDSMSERV DUMPDB command for more information.

Use the HALT command only after the administrative and client node sessions arecompleted or canceled. To shut down the server without severely impactingadministrative and client node sessions, perform the following steps:

1. Use the DISABLE SESSIONS command to prevent starting new client nodesessions.

2. Use the QUERY SESSIONS command to identify any existing administrative andclient node sessions.

3. Notify any existing administrative and client node sessions that you plan to shutdown the server (you must do this outside of TSM).

4. Use the CANCEL SESSIONS command to cancel any existing administrative orclient node sessions.

5. Issue the HALT command to shut down the server and stop any administrative andclient node sessions.

Privilege Class


Syntax

ÊÊ HALTQuiesce

ÊÍ

ParametersQuiesce

Specifies that all database transaction activity will be halted when currenttransactions complete. Use this option only to perform a standalone databasedump with the DMPADSM command to dump database contents to sequentialmedia, such as tape.

The results of any transactions in progress interrupted by this command are rolledback when you restart the server. This is optional.

HALT


When you specify the QUIESCE option, the server attempts to stop all database updatetransactions and to record database pages to stable media. This process provides aconsistent image of the database that can be dumped with the DMPADSM command.This attempt to stop update activity may be retried a number of times, and may fail ifthere are many transactions in progress. If this failure occurs, the HALT command stopsprocessing and the server continues to run. If this occurs, you can cancel all clientsessions, cancel all background server processes, and re-issue the HALT QUIESCEcommand. The HALT command without the QUIESCE option causes the server to haltsuccessfully.

Examples

Task 1

Shut down the server, from an administrative client. All user activity stops immediatelyand no new activity can start.

Command:halt

Task 2

Before performing the standalone database dump using the DMPADSM command, shutdown the TSM server with the QUIESCE option.

Command:halt quiesce

The standalone dump can now be performed.

Related Commands

Table 125. Commands Related to HALT

Command Description







HALT


HELP (Get Help on Commands and Error Messages)

Use this command to display administrative commands and error messages. You canissue the command from an administrative command line client.

Privilege Class


Syntax

ÊÊ Helphelp_menu_numbercommand_name

subcommand_namemessage_number

ÊÍ

Parametershelp_menu_number

Specifies the number of your selection from the help menu. This parameter isoptional.

command_nameSpecifies the name of the administrative command you want to display. Thisparameter is optional.

subcommand_nameSpecifies the subcommand name associated with the name of theadministrative command you want to display. This parameter is optional.

message_numberSpecifies the number of the message for which you want to display information.This parameter is optional. You can get help information on server messages(prefixed by ANR) and client messages (prefixed by ANE or ANS). Do not includethe prefix and severity code when specifying an error message number.

Examples

Task 1

Display the help menu for the command-line interface.

Command:help

Output:

HELP


The following help sections are available:1 - Using Syntax Diagrams2 - Entering Administrative Commands3 - Using the Server Console Session4 - Using the Administrative Client5 - Using the Administrative Client Options6 - Using Continuation Characters7 - Using Console Mode8 - Using Mount Mode9 - Using Batch Mode10 - Using Interactive Mode11 - Redirecting Command Output to a File12 - Using Macros to Issue Commands13 - Using Commands Based on Privilege Classes14 - Commands Requiring System Privilege15 - Commands Requiring Policy Privilege16 - Commands Requiring Storage Privilege17 - Commands Requiring Operator Privilege18 - Commands Requiring Analyst Privilege19 - Commands Any Administrator Can Issue

Task 2

Display help information using the help menu in Example 1.

Command:help 19

Output:

Display information on commands that can be issued by any administrator.

Task 3

Display help information on the REMOVE commands.

Command:help remove

Output:

REMOVE______

Use the REMOVE commands to remove an object from Tivoli Storage Manager.

The following is a list of REMOVE commands for Tivoli Stroage Manager:

"REMOVE ADMIN (Delete an Administrator)"

"REMOVE NODE (Delete a Client Node)"

Task 4

Display help information on the error message ANR7800I.

Command:help 7800

HELP


ANR7800I DSMSERV GENERATED AT time ON date.EXPLANATION: The Tivoli Storage Manger server module was generated at the indicateddate and time.SYSTEM ACTION: Server operation continues.USER RESPONSE: None.

Related Commands

None.

HELP


IMPORT ADMIN (Import Administrator Information)

Use this command to import administrator and authority definitions for one or moreadministrators from export media to the TSM server.

You can use the QUERY ACTLOG command to view the status of the import operation.

This command generates a background process that can be cancelled with theCANCEL PROCESS command. If an IMPORT ADMIN background process is cancelled,some of the data is already imported. To display information on background processes,use the QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ IMport Admin

·

*

,

admin_name

Preview = No

Preview = NoYes

Ê

Ê DEVclass=device_class_name ·

,

VOLumename = volume_nameFILE:file_name

Ê

ÊReplacedefs = No

Replacedefs = NoYes

ÊÍ


Specifies the administrators for which you want to import information. Thisparameter is optional. Separate multiple names with commas and no interveningspaces. You can use wildcard characters to specify names.

PreviewSpecifies whether you want to preview the results of the import operation, withoutimporting administrator information. The PREVIEW=YES option requires that youmount the export volumes. This parameter is optional. The default value is NO. Thevalues are:

No Specifies that the information is to be imported.

IMPORT ADMIN


YesSpecifies that the operation will be previewed but not performed. Informationon the number and types of objects imported, together with the number ofbytes transferred, are reported to the server console and the activity log.

DEVclass (Required)Specifies the device class from which import data is to be read. You cannot specifythe DISK device class. If all drives for the device class are busy when the importruns, TSM cancels lower priority operations, such as reclamation, to make a driveavailable.

VOLumename (Required)Specifies the volumes to be used for the import operation. Volumes must beimported in the same order as they were exported. The values are:

volume_nameSpecifies the volume name. To specify multiple volumes, separate names withcommas and no intervening spaces.

FILE:file_nameSpecifies the name of a file that contains a list of volumes used for theimported data. In the file, each volume name must be on a separate line.Blank and comment lines that begin with an asterisk are ignored.







ReplacedefsSpecifies whether to replace administrator definitions on the target server. Thedefault value is NO. The values are:

No Specifies that definitions are not to be replaced.

YesSpecifies that definitions are to be replaced.

Examples

Task 1

From the server, import the information for all defined administrators from tape volumesTAPE01, TAPE02, and TAPE03. Specify that these tape volumes be read by a deviceassigned to the MENU1 device class.

IMPORT ADMIN


Command:import admin devclass=menu1 volumenames=tape01,tape02,tape03

Task 2

From the server, import the information for all defined administrators from tape volumeslisted in a file named TAPEVOL . This file contains these lines:

TAPE01TAPE02TAPE03


Command:import admin devclass=menu1 volumenames=file:qusradsm/tapevol

Related Commands

Table 126. Commands Related to IMPORT ADMIN

Command Description








IMPORT ADMIN


IMPORT NODE (Import Client Node Information)

Use this command to import client node definitions from sequential media to the TSMserver.

You can use the QUERY ACTLOG command to view the status of the import operation.You can also view this information from the server console.

This command generates a background process that can be cancelled with theCANCEL PROCESS command. If an IMPORT NODE background process is cancelled,some of the data is already imported. To display information on background processes,use the QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ IMport Node

·

*

,

node_name

FILESpace =

·

*

,

file_space_name

Ê

Ê DOmains

·

*

,

domain_name =

FILEData = None


Ê

ÊPreview = No

Preview = NoYes

DEVclass=device_class_nameDates = Absolute

Dates = AbsoluteRelative

Ê

Ê ·

,


Replacedefs = No

Replacedefs = NoYes

ÊÍ

IMPORT NODE


Parametersnode_name

Specifies the client nodes for which you want to import information. This parameteris optional.

Separate multiple names with commas and no intervening spaces. You can usewildcard characters to specify names. All matching nodes are included in the list.

FILESpaceSpecifies file space names for which you want to import information. Thisparameter is optional.

Separate multiple names with commas and no intervening spaces. You can usewildcard characters to specify names.

Note: Existing file spaces are not replaced. New file spaces are created whenidentical names are encountered.

DOmainsSpecifies the policy domains to which data is to be imported. This parameter isoptional.

Separate multiple names with commas and no intervening spaces. You can usewildcard characters to specify a name. The default is all domains.

FILEDataSpecifies the type of files that should be imported for all nodes specified and foundon the export media. This parameter is optional. The default value is NONE.

The device class used by the file data is determined by the device class for thestorage pool. If it is the same device class specified in this command, two drivesare needed to import the node information. The mount limit for the device classmust be at least 2.


ALlTSM imports all backup versions of files, all archived files, and allspace-managed files.

NoneNo files, only node definitions, are to be imported. TSM does not export files.

ARchiveTSM imports only archived files.

BackupTSM imports only backup versions, whether active or inactive.

BACKUPActiveTSM imports only active backup versions.

IMPORT NODE


ALLActiveTSM imports all active backup versions of files, all archived files, and allspace-managed files.

SPacemanagedTSM imports only space-managed files.

PreviewSpecifies whether to preview the results of the import operation, without importinginformation. The PREVIEW=YES option requires that you mount the exportvolumes. This parameter is optional. The default value is NO. The values are:

No Specifies that the node information is to be imported.

YesSpecifies that you want to preview the results of the import operation, withoutimporting files. Information is reported to the server console and the activitylog.

DEVclass (Required)Specifies the device class from which import data is to be read. You cannot specifythe DISK device class.

If all drives for the device class are busy when the import runs, TSM cancels lowerpriority operations, such as reclamation, to make a drive available.

DatesSpecifies whether the date of the file copies are as specified when the files wereexported (ABSOLUTE), or are adjusted to the date of import (RELATIVE). Thedefault value is ABSOLUTE.

If the export media has been idle for some time after export (sitting on a shelf forsix months, for example), the original backup or archive dates may be old enoughto trigger immediate expiration of file copies when the data is imported into aserver. The RELATIVE specification for this value will adjust for time elapsed sinceexport so that the file copies are not immediately expired.

For example, assume that an export tape contains an archive file copy that wasarchived 5 days before export. If the media are saved for 6 months and thenimported, the archive file will appear to have been inserted six months and 5 daysago by default (DATES=ABSOLUTE) and may be subject to immediate expirationdepending on the retention value that is specified in the file’s management class.Specifying DATES=RELATIVE will result in resetting the archive date for the file to5 days ago during import. The DATES=RELATIVE parameter thus adjusts filebackup and archive dates for the time that has elapsed since the export operationoccurred.


AbsoluteThe dates for file copies are set to the values specified when the files wereexported.

RelativeThe dates for file copies are adjusted to the date of import.

IMPORT NODE


VOLumename (Required)Specifies the volumes to be used for the import operation. Volumes must beimported in the same order as they were exported. The values are:









ReplacedefsSpecifies whether to replace definitions on the target server. The default value isNO. The values are:

No Objects are not to be replaced.

YesObjects are to be replaced.

Examples

Task 1

From the server, import client node information from tape volumes TAPE01, TAPE02,and TAPE03. Specify that these tape volumes be read by a device assigned to theMENU1 device class.

Command:import node devclass=menu1 volumenames=tape01,tape02,tape03

Task 2

From the server, import client node information from tape volumes listed in a file namedTAPEVOL . This file contains these lines:

TAPE01TAPE02TAPE03

IMPORT NODE



Command:import node devclass=menu1 volumenames=file:qusradsm/tapevol

Related Commands

Table 127. Commands Related to IMPORT NODE

Command Description








IMPORT NODE


IMPORT POLICY (Import Policy Information)

Use this command to import policy domain information from sequential export media tothe TSM server.

TSM client data can be moved between TSM servers with export and importprocessing, if the same removable media type is supported on both platforms.

You can use the QUERY ACTLOG command to view the status of the import operation.

This command generates a background process that can be cancelled with theCANCEL PROCESS command. If an IMPORT POLICY background process iscancelled, some of the data is already imported. To display information on backgroundprocesses, use the QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ IMport Policy

·

*

,

domain_name

Preview = No

Preview = NoYes

Ê

Ê DEVclass=device_class_name ·

,


Ê

ÊReplacedefs = No

Replacedefs = NoYes

ÊÍ


Specifies the policy domains for which information is to be imported. Separatemultiple names with commas and no intervening spaces. You can use wildcardcharacters to specify names. The default (*) is all policy.

PreviewSpecifies whether you want to preview the results of the import operation without

IMPORT POLICY


importing information. The PREVIEW=YES option requires that you mount theexport volumes. This parameter is optional. The default value is NO. The valuesare:

No Specifies that the information is to be imported.

YesSpecifies that the operation will be previewed but not performed. Information isreported to the server console and the activity log.



VOLumenames (Required)Specifies the volumes to be used for the import operation. Volumes must beimported in the same order as they were exported. The values are:






FILE Any fully qualified file name string. For example,QUSRADSM/IMPORT(VOLl).



ReplacedefsSpecifies whether to replace policy definitions on the target server. The defaultvalue is NO. The values are:

YesSpecifies that objects are to be replaced by the imported objects.

No Specifies that objects are not to be replaced by imported objects.

IMPORT POLICY


Examples

Task 1

From the server, import the information for all defined policies from tape volumesTAPE01, TAPE02, and TAPE03. Specify that these tape volumes be read by a deviceassigned to the MENU1 device class.

Command:import policy devclass=menu1 volumenames=tape01,tape02,tape03

Task 2

From the server, import the information for all defined policies from tape volumes listedin a file named TAPEVOL . This file contains these lines:

TAPE01TAPE02TAPE03


Command:import policy devclass=menu1 volumenames=file:qusradsm/tapevol

Related Commands

Table 128. Commands Related to IMPORT POLICY

Command Description








IMPORT POLICY


IMPORT SERVER (Import the Server)

Use this command to copy all or part of the server control information and client filedata (if specified) from export media to the TSM server.

This command generates a background process that can be cancelled with theCANCEL PROCESS command. If an IMPORT SERVER background process iscancelled, some of the data is already imported. To display information on backgroundprocesses, use the QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ IMport ServerFILEData = None


Preview = No

Preview = NoYes

Ê

Ê DEVclass=device_class_nameDates = Absolute

Dates = AbsoluteRelative

Ê

Ê ·

,


Replacedefs = No

Replacedefs = NoYes

ÊÍ

ParametersFILEData

Specifies the type of files that should be imported for all nodes defined to theserver. This parameter is optional. The default value is NONE.

The device class used by the file data is determined by the device class for thestorage pool. If it is the same device class specified in this command, two drivesare needed to import information. The mount limit for the device class must be setto at least 2.

IMPORT SERVER


The following descriptions mention active and inactive backup file copies. An activebackup file copy is the most recent backup copy for a file that still exists on theclient workstation. All other file copies are called inactive copies. The values are:

ALlTSM imports all backup versions of files, all archived files, and allspace-managed files.

NoneTSM does not export files, only node definitions.

ARchiveTSM imports only archived files.

BackupTSM imports only backup versions, whether active or inactive.

BACKUPActiveTSM imports only active backup versions.

ALLActiveTSM imports all active backup versions of files, all archived files, and allspace-managed files.

SPacemanagedTSM imports only space-managed files.

PreviewSpecifies whether to preview the results of the import operation, without importinginformation. The PREVIEW=YES option requires that you mount the exportvolumes. This parameter is optional. The default value is NO. Possible values are:

No Specifies that the server information is to be imported.

YesSpecifies that the operation will be previewed but not performed. Information istransferred to the server console and the activity log.



DatesSpecifies whether the dates of the file copies are set as specified when the fileswere exported (ABSOLUTE), or are adjusted to the date of import (RELATIVE).The default value is ABSOLUTE.

If the import media has been idle for some time after export (sitting on a shelf forsix months, for example), the original backup or archive dates may be old enoughto trigger immediate expiration of file copies when the data is imported into aserver. The RELATIVE specification for this value will adjust for time elapsed sinceexport so that the file copies are not immediately expired.

IMPORT SERVER


For example, assume that an import tape contains an archive file copy that wasarchived 5 days before to the export operation. If the export media are saved for 6months and then imported, the archive file will appear to have been inserted sixmonths and 5 days ago by default (DATES=ABSOLUTE) and may be subject toimmediate expiration depending upon the retention value that is specified in thefile’s management class. Specifying DATES=RELATIVE results in resetting thearchive date for the file to 5 days ago during import. DATES=RELATIVE parameterthus adjusts file backup and archive dates for the time that has elapsed since theexport operation occurred.


AbsoluteThe dates for file copies are set to the values specified when the files wereexported.

RelativeThe date for file copies are adjusted to the date of import.

VOLumenames (Required)Specifies the volumes to be used for the import operation. Volumes must beimported in the same order as they were exported. The values are:









ReplacedefsSpecifies whether to replace objects on the server. Existing file spaces are notreplaced. New file spaces are created when identical names are encountered. Thedefault value is NO. Possible values are:

No Specifies that objects are not to be replaced by imported objects.

YesSpecifies that objects are to be replaced by the imported objects.

IMPORT SERVER


Examples

Task 1

From the server, import the information for all defined servers from tape volumesTAPE01, TAPE02, and TAPE03. Specify that these tape volumes be read by a deviceassigned to the MENU1 device class.

Command:import server devclass=menu1 volumenames=tape01,tape02,tape03

Task 2

From the server, import the information for all defined servers from tape volumes listedin a file named TAPEVOL. This file contains these lines:

TAPE01TAPE02TAPE03


Command:import server devclass=menu1 volumenames=file:qusradsm/tapevol

Related Commands

Table 129. Commands Related to IMPORT SERVER

Command Description








IMPORT SERVER


INSERT MACHINE (Insert Machine Characteristics Information or RecoveryInstructions)

Use this command to add client machine characteristics or recovery instructions to theTSM database. You can write a program to read files containing this information andgenerate the appropriate INSERT commands. A sample program is shipped with theproduct. Before modifying the sample program, copy the program into a different file orlibrary. You can either create a new library or you can place the exit in the work libraryof the server.

You can use QUERY commands to retrieve the information if a disaster occurs.

Attention: TSM does not use this information to coordinate disaster recovery or tomanage the server under normal operation.

Privilege Class


Syntax

ÊÊ INsert MAchine machine_name sequence_number Ê

Ê CHaracteristics = textRECOVERYInstructions = text

ÊÍ


Specifies the name of the client machine.

sequence_number (Required)Specifies the sequence number for the line of text in the database.

CHaracteristicsSpecifies machine characteristics information. You must specify the characteristicsor recovery instructions, but not both. Enclose the text in quotation marks if itcontains blank characters. The text can be up to 1024 characters.

RECOVERYInstructionsSpecifies recovery instructions. You must specify the characteristics or recoveryinstructions, but not both. Enclosed the text in quotation marks if it contains blankcharacters. The text can be up to 1024 characters.

Examples

Task

INSERT MACHINE


For the machine DISTRICT5, insert this characteristics text on line 1: “Machine owner isMary Smith”.

Command:insert machine district5 1 characteristics="Machine owner is MarySmith"

Related Commands

Table 130. Commands Related to INSERT MACHINE

Command Description




INSERT MACHINE


LOCK ADMIN (Lock Out an Administrator)

Use this command to prevent an administrator from accessing the server. Theadministrator is locked out until a system administrator uses the UNLOCK ADMINcommand to reestablish access for the administrator.

You cannot issue the LOCK ADMIN command against the SERVER_CONSOLEadministrative ID.

Privilege Class


Syntax

ÊÊ LOCK Admin admin_name ÊÍ


Specifies the name of the administrator to be locked out.

Examples

Task

Lock out the administrator CLAUDIA.

Command:lock admin claudia

Related Commands

Table 131. Commands Related to LOCK ADMIN

Command Description


UNLOCK ADMIN Enables a locked administrator to access TSM.

LOCK ADMIN


LOCK NODE (Lock Out a Client Node)

Use this command to prevent a client node from accessing the server. A locked clientcannot perform any TSM operations, even if the operations are scheduled.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege for the policy domain to which the client node belongs.

Syntax

ÊÊ LOCK Node node_name ÊÍ


Specifies the name of the client node to lock out.

Examples

Task

Lock the client node SMITH.

Command:lock node smith

Related Commands

Table 132. Commands Related to LOCK NODE

Command Description


UNLOCK NODE Enables a locked user in a specific policydomain to access the server.

LOCK NODE


LOCK PROFILE (Lock a Profile)

Use this command on a configuration manager to temporarily lock a profile so thatconfiguration information is not distributed to subscribing managed servers.

You can use this command when you are making multiple updates to your configurationand do not want to distribute this information until the changes are completed.

Privilege Class


Syntax

ÊÊ60

LOCK PROFIle profile_nameminutes

ÊÍ


Specifies the profile to lock. You can use wildcard characters to indicate multiplenames.

minutesSpecifies the time, in minutes, before TSM unlocks the configuration profile. Specifyan integer from 0 to 10000. The default is 60 minutes. If you specify 0, theconfiguration profile will not unlock automatically. Use the UNLOCK PROFILEcommand to unlock the profile before the time period elapses, or to unlock it if youhave specified a value of 0. This parameter is optional.

Examples

Task

Lock a profile named DELTA for 30 minutes.

Command:lock profile delta 30

Related Commands

Table 133. Commands Related to LOCK PROFILE

Command Description



LOCK PROFILE


||

||

||

|

|

|

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

|

|

|||

||||||

|

|

|

||

|

|||

||

||

||

Table 133. Commands Related to LOCK PROFILE (continued)

Command Description








LOCK PROFILE


|

||

|||

|||

||

||

|||

|||

||

|

MACRO (Invoke a Macro)

Use this command to invoke a file from the administrative command line that containsone or more TSM administrative commands to be performed.

This command is used with administrative command-line clients only .

A macro is a file that contains one or more TSM administrative commands. You canonly issue a macro from the administrative client in batch or interactive mode. A macrois stored as a file on the administrative client machine (or system). Macros are notdistributed across servers and cannot be scheduled on the server.

Creating a macro to enter commands can be helpful when you want to issuecommands that are used repeatedly, to issue commands that contain severalparameters, or to process related commands in a specific order. After you create amacro, you can update the information it contains and use it again, or you can copy themacro file, make changes to the copy, and then run the copy.

For detailed information on macros, how to use them, and the differences betweencommand scripts and administrative command-line client macros, refer to theAdministrator’s Guide.

Privilege Class


Syntax

ÊÊ MACRO macro_name

·

,

substitution_value

ÊÍ

Parametersmacro_name (Required)

Specifies the name of the macro.

substitution_valueSpecifies the value for a substitution variable in a macro. When you use asubstitution variable, you can reuse a macro whenever you need to perform thesame task for different objects or with different parameter values. Each substitutionvalue must be delimited with a comma. To specify a value that contains blanks, youmust enclose the value in quotation marks. This parameter is optional.

Examples

Task 1

MACRO


|

|||

Create a macro file named REGNG. Use the macro to register and grant authority to anew administrator. Write the macro as follows:

/* Register and grant authority to a new administrator */REGister Admin jones passwd -CONtactinfo="x1235"GRant AUTHority jones -CLasses=Policy

Command:macro regng.mac

Task 2

Create a macro file named AUTHRG, containing substitution variables, to register andgrant authority to a new administrator. Write the macro as follows:

/* Register and grant authority to a new administrator */REGister Admin %1 %2 - /* Enter userid and password */CONtact=%3 /* Enter contact info (in quotes if nec.) */GRant AUTHority %1 - /* Server uses variable already */- /* defined by you */CLasses=%4 /* Enter the privilege class */

Enter the values you want to pass to the server to process the command when you runthe macro.

Command:macro authrg.mac jones passwd x1235 Policy

Related Commands

Table 134. Commands Related to MACRO

Command Description

COMMIT Makes changes to the database permanent.

ROLLBACK Discards any uncommitted changes to thedatabase since the last COMMIT was executed.

MACRO


MOVE DATA (Move Files on a Storage Pool Volume)

Use this command to move files from one storage pool volume to other storage poolvolumes. You can move files from a primary storage pool volume only to volumes in thesame or a different primary storage pool. You can move files from a copy storage poolvolume only to volumes in the same copy storage pool.

If you are moving files to volumes within the same storage pool, sufficient space mustbe available on the volumes or the operation fails.

When you move files from a sequential access volume, multiple sequential accessvolume mounts are required to move files that span volumes.

When you move files from a random access volume, the server erases any cachedcopies of files on the volume.

A volume may not be empty after a move data operation completes if one or more filescannot be relocated to another volume because of input/output errors on the device orbecause errors were found in the file. If needed, you can delete the volume using theoption to discard any data. The files with I/O or other errors are then deleted.

You can use this command to move files from an offsite volume in a copy storage pool.Because the offsite volume cannot be mounted, the server obtains the files that are onthe offsite volume from either a primary storage pool or another copy storage pool.These files are then written to the destination volumes in the original copy storage pool.

Do not use the MOVE DATA command if a restore process (RESTORE STGPOOL orRESTORE VOLUME) is running. The MOVE DATA command could cause the restoreto be incomplete.

Privilege Class

To issue this command, you must have system privilege, unrestricted storage privilege,or restricted storage privilege for the storage pool to which the volume belongs and alsofor the new storage pool, if one is specified.

Syntax

ÊÊ MOVe Data volume_nameSTGpool = pool_name

Wait = No

Wait = NoYes

ÊÍ


Specifies the storage pool volume from which to move files.

MOVE DATA


STGpoolSpecifies the primary storage pool to which you want to move files. This parameteris optional and applies only to moving data from primary storage pool volumes. Ifyou do not specify a value for this parameter, files are moved to other volumeswithin the same storage pool.


No Specifies that the server processes this command in the background. You cancontinue with other tasks while the command is being processed. The serverdisplays messages that are created from the background process either in theactivity log or the server console, depending on where messages are logged.

To cancel a background process, use the CANCEL PROCESS command. If aMOVE DATA background process is canceled, some files may have alreadymoved prior to the cancellation.


Examples

Task

Move files from storage pool volume STGVOL.1 to any available volumes assigned tothe 8MMPOOL storage pool.

Command:move data stgvol.1 stgpool=8mmpool

Related Commands

Table 135. Commands Related to MOVE DATA

Command Description








MOVE DATA


MOVE DRMEDIA (Move Disaster Recovery Media Offsite and Back Onsite)

Use this command to track database backup and copy storage pool volumes that are tobe moved offsite and to identify the expired or empty volumes that are to be movedonsite for reuse. You cannot specify volumes that are backup objects stored on anotherserver. You can change volumes through each state or you can use the TOSTATEparameter and skip states to simplify the movements.

Note: The MOVE DRMEDIA command always processes copy storage pool volumes(see the description of the COPYSTGPOOL parameter for more information).You can use the SOURCE parameter to control whether the commandprocesses database backup volumes.

Privilege Class

To issue this command, you must have one of the following privilege classes:

v If the CMD parameter is specified and the REQSYSAUTHOUTFILE server optionis set to NO: operator, unrestricted storage, or system privilege.

v If the CMD parameter is specified and the REQSYSAUTHOUTFILE server optionis set to YES (the default): system privilege.

Syntax

ÊÊ MOVe DRMedia volume_nameWHERESTate = MOuntable

NOTMOuntableCOUrierVAULTRetrieveCOURIERRetrieve

Ê

ÊBEGINDate = date ENDDate = date BEGINTime = time

Ê

ÊENDTime = time COPYstgpool = pool_name

DBBackup = Yes

DBBackup = YesNo

Ê

ÊREMove = No

REMove = NoYes

TOSTate = NOTMOuntableCOUrierVAultCOURIERRetrieveONSITERetrieve

Ê

MOVE DRMEDIA


|

||

||

|

ÊWHERELOcation = location TOLOcation = location

Ê

ÊCMd = "command" CMDFilename = file_name

APPend = No

APPend = NoYes

Ê

ÊLRecl = lrecl

Wait = No

Wait = NoYes

ÊÍ


Specifies the name of the database backup or copy storage pool volume to beprocessed. If you use wildcard characters to specify this name, you must alsospecify WHERESTATE.

WHERESTateSpecifies the state of volumes to be processed. This parameter is required if theTOSTATE is not specified. If you use a wildcard character in the volume name, youmust specify WHERESTATE. For more information, see Table 136 on page 370 andTable 137 on page 370.


MOuntableThese volumes contain valid data and are available for onsite processing.They will change to NOTMOUNTABLE if the TOSTATE is not specified. TSMejects volumes that are in an automated library before changing to thedestination state. For information about how TSM ejects the volume, see theREMOVE parameter description.

NOTMOuntableThese volumes are onsite, contain valid data, and are not available for onsiteprocessing. They will change to COURIER if the TOSTATE is not specified.

COUrierThese volumes are with the courier and being moved offsite. They will changeonly to VAULT.

VAULTRetrieveThese volumes do not contain valid data and are offsite. They will change toCOURIERRETRIEVE if the TOSTATE is not specified.

COURIERRetrieveThese volumes are with the courier and being moved onsite. They will changeonly to ONSITERETRIEVE. The volume records of the database backup andscratch copy storage pool volumes are deleted from the TSM database.

MOVE DRMEDIA


BEGINDateSpecifies the beginning date used to select volumes. This parameter is optional.Volumes are considered eligible if the MOVE DRMEDIA command has changed thevolume to its current state on or after the specified date. The default is the earliestdate for which volume information exists.







TODAY–7 or –7.

To identify volumes that were changed totheir current state a week ago, you canspecify TODAY-7 or simply -7.

ENDDateSpecifies the ending date used to select volumes. This parameter is optional.Volumes are considered eligible if the MOVE DRMEDIA command has changed thevolume to its current state on or before the specified date. The default is thecurrent date.





To identify volumes that were changed totheir current state today, specify TODAY.


The current date minus daysspecified. The maximum numberof days is 9999.

TODAY–1 or –1.

To identify volumes that were changed totheir current state a week ago, you canspecify TODAY-1 or simply -1.

BEGINTimeSpecifies the beginning time used to select volumes for processing. This parameteris optional. Volumes are considered eligible if the MOVE DRMEDIA command haschanged the volume to its current state on or after the specified time and date. Thedefault is midnight (00:00:00) on the date specified with the BEGINDATEparameter.



HH:MM:SS A specific time on the specifiedbegin date

12:33:28

NOW The current time on the specifiedbegin date

NOW

MOVE DRMEDIA



NOW+HH:MM or+HH:MM

The current time plus hours andminutes on the specified begindate

NOW+03:00 or +03:00.


The current time minus hours andminutes on the specified begindate

NOW−03:30 or −03:30.

If you issue the MOVE DRMEDIAcommand at 9:00 withBEGINTIME=NOW−03:30 or BEGINTIME=−03:30, TSM identifies the volumes thatwere changed to their current state at 5:30on the begin date you specify.

ENDTimeSpecifies the ending time used to select volumes for processing. This parameter isoptional. Volumes are considered eligible if the MOVE DRMEDIA command haschanged the volume to its current state on or after the specified time and date. Thedefault is 23:59:59.



HH:MM:SS A specific time on the specifiedend date

12:33:28

NOW The current time on the specifiedend date

NOW

NOW+HH:MM or+HH:MM

The current time plus hours andminutes on the specified end date

NOW+03:00 or +03:00.

If you issue the MOVE DRMEDIAcommand at 9:00 withENDTIME=NOW+03:30 orENDTIME=+03:30, TSM identifies thevolumes that were changed to their currentstate at 12:30 on the end date you specify.


The current time minus hours andminutes on the specified end date

NOW−03:30 or −03:30.

COPYstgpoolSpecifies the name of the copy storage pool whose volumes are to be processed.This parameter is optional. You can use wildcard characters to specify this name.The copy storage pools specified with this parameter override those specified withthe SET DRMCOPYSTGPOOL command. If you do not specify a copy storage poolname, all volumes in the specified state, except MOUNTABLE state, areprocessed. See SET DRMCOPYSTGPOOL command for processing the volumesin the MOUNTABLE state.

DBBackupSpecifies whether database backup volumes are selected. This parameter isoptional. The default is YES. Possible values are:

YesDatabase backup volumes are selected.

MOVE DRMEDIA


No Database backup volumes are not selected.

REMoveSpecifies whether TSM ejects the volumes from the library. This parameter isoptional. The default is NO.

Note: For a 349x library, the volume is always ejected from the library even if youspecify NO.


No Specifies that the volume is not ejected from the library. This option is notrecommended for an automated library without an I/O station. This optiondeletes the volume entry from the TSM library inventory, marks the volume asunavailable for onsite processing, changes the cartridge category toDRMEJECT, and leaves the volume in its slot.

After processing has completed, you can issue the AS/400 WRKTAPCTGcommand with category DRMEJECT. The command lists all cartridges to beejected from the library and sent offsite. After the list is displayed, you canspecify the remove option for each item on the list, and AS/400 ejects thevolumes from the library.

If you have an automated SCSI library with an I/O station that becomes fullduring remove processing, eject processing stops and AS/400 issues amessage that requires a reply. To display the message, issue DSPMSGQSYSOPR, take the appropriate action, and reply to the message.

If you have an automated IBM 3494 library and the I/O station becomes fullduring remove processing, eject processing stops until the I/O station isemptied. As the I/O station is emptied, ejection processing resumes.

If you have an automated library without an I/O station, the volume remain inits slot and the cartridge category is changed to *EJECT when the remove isspecified.

YesSpecifies that the volume is to be ejected from the library. The followingdescribes processing by the autolibrary:

Automated library without I/O stationThe volume remains in its slot, and the cartridge category is set to*EJECT. The volume entry is deleted from the TSM library inventory.

Automated library with I/O stationVolumes are ejected from the library. The volume entry is deleted from theTSM library inventory.

If the I/O station on a SCSI library becomes full, AS/400 issues a messagethat requires a reply. The TSM server may appear to hang. To display themessage, issue DSPMSG QSYSOPR, take the appropriate action, andreply to the message.

MOVE DRMEDIA


If the I/O station on the IBM 3494 automated library becomes full, ejectionprocessing stops until the I/O station is emptied. As the I/O station isemptied, ejection processing resumes. These actions have no effect onTSM.

TOSTateSpecifies the destination state of the volumes being processed. This parameter isrequired if WHERESTATE is not specified. If you specify TOSTATE but notWHERESTATE, you must specify the volume name. Wildcard characters are notallowed. For more information, see Table 136 on page 370 and Table 137 onpage 370.


NOTMOuntableSpecifies that volumes are to change to the NOTMOUNTABLE state. Thisvalue is valid only if the volumes are in the MOUNTABLE state. If the volumesare in an automated library, MOVE DRMEDIA ejects the volumes beforechanging them to the NOTMOUNTABLE state (for information about howMOVE DRMEDIA ejects the volume, see the REMOVE parameter description).

COUrierSpecifies that volumes are to change to the COURIER state. This value isvalid only if the volumes are in the MOUNTABLE or NOTMOUNTABLE state. Ifthe volumes are in an automated library, MOVE DRMEDIA ejects the volumesbefore changing them to the COURIER state (for information about how MOVEDRMEDIA ejects the volume, see the REMOVE parameter description).

VAultSpecifies that volumes are to change to the VAULT state. This value is validonly if the volumes are in the MOUNTABLE, NOTMOUNTABLE, or COURIERstate. If the volumes are in an automated library, MOVE DRMEDIA ejects thembefore changeing them to the VAULT state (for information about how MOVEDRMEDIA ejects the volume, see the REMOVE parameter description).

COURIERRetrieveSpecifies that volumes are to change to the COURIERRETRIEVE state. Thisvalue is valid only if the volumes are in the VAULTRETRIEVE state.

ONSITERetrieveSpecifies that volumes are to change to the ONSITERETRIEVE state. Thisvalue is valid only if the volumes are in the VAULTRETRIEVE orCOURIERRETRIEVE state. For database backup and scratch copy storagepool volumes that are changeing to the ONSITERETRIEVE state, TSM deletesthe volume records from the database.

WHERELOcationSpecifies the current location of the volumes. This parameter is optional. Themaximum length of the location is 255 characters. Enclose the text in quotationmarks if it contains any blank characters.

TOLOcationSpecifies the destination location of the volumes. This parameter is optional. Themaximum length of the location specified is 255 characters. Enclose the text in

MOVE DRMEDIA


quotation marks if it contains any blank characters. If you do not specify thedestination location, the location defined by the SET DRMNOTMOUNTABLEcommand is used.

CMdSpecifies the creation of executable commands to process the volume name andlocation obtained by this command. This parameter is optional. You must enclosethe command specification in quotation marks. The maximum length of thisparameter is 255 characters. DRM writes the commands to a file specified by theCMDFILENAME parameter or the SET DRMCMDFILENAME command, orgenerated by the QUERY DRMEDIA command. If the command length is greaterthan 240 characters, it is split into multiple lines and continuation characters (+) areadded. You may need to alter the continuation character according to the productthat runs the commands.

stringThe command string. The string must not include embedded quotation marks.For example,

VALID:

CMD="CHECKIN LIBVOL LIB8MM &VOL STATUS=SCRATCH"

NOT VALID:

CMD=""CHECKIN LIBVOL LIB8MM" &VOL STATUS=SCRATCH""

substitutionA substitution variable. The variables are not case-sensitive, and must notcontain blank spaces after the ampersand (&). The possible variables are:

&VOLA volume name variable.

&LOCA volume location.

&VOLDSNThe name of the file the server writes into the sequential access medialabels. An example of a copy storage pool tape volume file name usingthe default prefix ADSM is ADSM.BFS. An example of a database backuptape volume file name using a prefix ADSM310 defined with the deviceclass is ADSM310.DBB.

&NLThe new line character. When &NL is specified, MOVE DRMEDIAcommand splits the command at the &NL variable and does not append acontinuation character. You must specify the proper continuation characterbefore the &NL if one is required. If the &NL is not specified and thecommand line is greater than 240 characters, the line is split into multiplelines and continuation characters (+) are added.

CMDFilenameSpecifies the fully qualified name of the file that will contain the commandsspecified with CMD parameter. This parameter is optional. You can specify anyvalid AS/400 file name of the form lib/filename(memname). If you do not specify a

MOVE DRMEDIA


file name or if you specify a null string (″″), the file name specified with the SETDRMCMDFILENAME is used. If you do not specify a file name with the SETDRMCMDFILENAME command, MOVE DRMEDIA will create the file exec(cmds) inthe current server work library (WRKLIB).

If the operation fails after the command file has been created, the file is notdeleted.

APPendSpecifies whether to overwrite any existing contents of the command file or appendthe commands to the file. This parameter is optional. The default is NO. Possiblevalues are:

No DRM overwrites the contents of the file.

YesDRM appends the commands to the file.

LReclSpecifies the logical record length for the file that contains the command stringspecified with CMD. This parameter is optional. You can specify a length from 1 to1550 characters. The default length is 240 characters.

WaitSpecifies whether to wait for the server to complete processing this command inthe foreground. This parameter is optional. The default value is NO. Possiblevalues are:

No Specifies that the server processes this command in the background. You cancontinue with other tasks while the command is being processed. Messagescreated from the background process are displayed either in the activity log orthe server console, depending on where messages are logged. To determinewhether MOVE DRMEDIA successfully completed processing, you can issuethe QUERY ACTLOG command.

YesSpecifies that the server processes this command in the foreground. Wait forthe command to complete before continuing with other tasks. The server thendisplays the output messages to the administrative client.

Destination State and Location

The following table shows how DRM determines the destination state and location of avolume.

Destination state

v TOSTATE specified.

v The next state of the WHERESTATE specified, if the TOSTATE is notspecified.

Destination location

v TOLOCATION specified.

v The location of the TOSTATE specified, if the TOLOCATION is not specified.

MOVE DRMEDIA


||||

v The location of the next state of the WHERESTATE specified, if theTOLOCATION and TOSTATE are not specified.

Table 136. Volume Destination and Location Table

Parameters Specified Destination State Destination Location

WHERESTATE The next state of the WHERESTATE Location of the next state

WHERESTATETOSTATE

TOSTATE Location of the TOSTATE

WHERESTATETOLOCATION

The next state of the WHERESTATE TOLOCATON

WHERESTATETOSTATETOLOCATION

TOSTATE TOLOCATION

TOSTATE TOSTATE Location of the TOSTATE

TOSTATE WHERELOCATION TOSTATE Location of the TOSTATE

TOSTATE WHERELOCATIONTOLOCATION

TOSTATE TOLOCATION

State change

The following tables show the eligible state changes:

Table 137. State change for Volumes Table

Volume’s CurrentState

Destination State

MOUNTABLE NOTMOUNTABLE COURIER VAULT

MOUNTABLE N Y Y Y

NOTMOUNTABLE N N Y Y

COURIER N N N Y

VAULT N N N N

VAULT-RETRIEVE N N N N

COURIER-RETRIEVE N N N N

ONSITE-RETRIEVE N N N N

Volume’s Current State

Destination State

VAULT-RETRIEVE COURIER-RETRIEVE ONSITE-RETRIEVE

MOUNTABLE N N N

NOTMOUNTABLE N N N

COURIER N N N

VAULT N N N

VAULT-RETRIEVE N Y Y

COURIER-RETRIEVE N N Y

ONSITE-RETRIEVE N N N

MOVE DRMEDIA


Examples

Task 1

Move DRM media that is in the NOTMOUNTABLE state to the COURIER state.

Command:

move drmedia * wherestate=notmountable

query actlog search="MOVE DRMEDIA"

Output:

08/11/1997 11:12:24 ANR0984I Process 10 for MOVE DRMEDIA startedin the BACKGROUND at 11:12:24.

08/11/1997 11:12:24 ANR0610I MOVE DRMEDIA started by HSIAO asprocess 10.

08/11/1997 11:12:25 ANR6683I MOVE DRMEDIA: Volume TAPE0P was movedfrom NOTMOUNTABLE state to COURIER.

08/11/1997 11:12:25 ANR6683I MOVE DRMEDIA: Volume TAPE1P was movedfrom NOTMOUNTABLE state to COURIER.

08/11/1997 11:12:25 ANR6683I MOVE DRMEDIA: Volume DBTP02 was movedfrom NOTMOUNTABLE state to COURIER.

08/11/1997 11:12:25 ANR6683I MOVE DRMEDIA: Volume DBTP01 was movedfrom NOTMOUNTABLE state to COURIER.

08/11/1997 11:12:25 ANR6682I MOVE DRMEDIA command ended: 4 volumesprocessed.

08/11/1997 11:12:25 ANR0611I MOVE DRMEDIA started by HSIAO asprocess 10 has ended.

08/11/1997 11:12:25 ANR0985I Process 10 for MOVE DRMEDIA running inthe BACKGROUND processed 4 items with acompletion state of SUCCESS at 11:12:25.

Task 2

Move DRM media from the MOUNTABLE state to the COURIER state. If the media isin an automated library, MOVE DRMEDIA checks the media out of the library beforechanging the state.

Command:

move drmedia * wherestate=mountable tostate=courier

Output:

MOVE DRMEDIA


ANR0984I Process 12 for MOVE DRMEDIA startedin the FOREGROUND at 09:57:17.

ANR0609I MOVE DRMEDIA started as process 12.ANR0610I MOVE DRMEDIA started by HSIAO asprocess 12.

ANR6696I MOVE DRMEDIA: CHECKOUT LIBVOLUME forvolume TAPE01 in library LIB8MM starting.

ANR6697I MOVE DRMEDIA: CHECKOUT LIBVOLUME forvolume TAPE01 in library LIB8MM completedsuccessful.

ANR6683I MOVE DRMEDIA: Volume TAPE01 was movedfrom MOUNTABLE state to COURIER.

ANR6696I MOVE DRMEDIA: CHECKOUT LIBVOLUME forvolume TAPE02 in library LIB8MM starting.

ANR6697I MOVE DRMEDIA: CHECKOUT LIBVOLUME forvolume TAPE02 in library LIB8MM completedsuccessful.

ANR6683I MOVE DRMEDIA: Volume TAPE02 was movedfrom MOUNTABLE state to COURIER.

ANR6696I MOVE DRMEDIA: CHECKOUT LIBVOLUME forvolume DBTP05 in library LIB8MM starting.

ANR6697I MOVE DRMEDIA: CHECKOUT LIBVOLUME forvolume DBTP05 in library LIB8MM completedsuccessful.

ANR6683I MOVE DRMEDIA: Volume DBTP05 was movedfrom MOUNTABLE state to COURIER.

ANR6696I MOVE DRMEDIA: CHECKOUT LIBVOLUME forvolume DBTP04 in library LIB8MM starting.

ANR6697I MOVE DRMEDIA: CHECKOUT LIBVOLUME forvolume DBTP04 in library LIB8MM completedsuccessful.

ANR6683I MOVE DRMEDIA: Volume DBTP04 was movedfrom MOUNTABLE state to COURIER.

ANR6682I MOVE DRMEDIA command ended: 4 volumesprocessed.

ANR0611I MOVE DRMEDIA started by HSIAO asprocess 12 has ended.

ANR0985I Process 12 for MOVE DRMEDIA runningin the FOREGROUND processed 4 items with acompletion state of SUCCESS at 10:12:25.

Task 3

Move DRM media that is in the VAULTRETRIEVE state to the ONSITERETRIEVEstate, and generate a CHECKIN LIBVOLUME command for each volume successfullyprocessed in a file, drm/exec(cmds).

Command:move drmedia * wherestate=vaultretrieve tostate=onsiteretrievecmdfilename=drm/exec(cmds) cmd="checkin libvol lib8mm &volstatus=scratch"

query actlog search="MOVE DRMEDIA"

Output:

MOVE DRMEDIA


08/13/1997 09:12:24 ANR0984I Process 15 for MOVE DRMEDIA started inthe BACKGROUND at 09:12:24.

08/13/1997 09:12:24 ANR0610I MOVE DRMEDIA started by HSIAO as process15.

08/13/1997 09:12:24 ANR6684I MOVE DRMEDIA: Volume CSTP01 was deleted.08/13/1997 09:12:24 ANR6684I MOVE DRMEDIA: Volume CSTP02 was deleted.08/13/1997 09:12:24 ANR6684I MOVE DRMEDIA: Volume DBTP10 was deleted.08/13/1997 09:12:24 ANR6684I MOVE DRMEDIA: Volume DBTP11 was deleted.08/13/1997 09:12:27 ANR6682I MOVE DRMEDIA command ended: 4 volumes

processed.08/13/1997 09:12:42 ANR0611I MOVE DRMEDIA started by HSIAO as process

15 has ended.08/13/1997 09:12:42 ANR0985I Process 15 for MOVE DRMEDIA running in

the BACKGROUND processed 4 items with acompletion state of SUCCESS at 09:12:42.

MOVE DRMEDIA also created commands in drm/exec(cmds):

checkin libvol lib8mm CSTP01 status=scratchcheckin libvol lib8mm CSTP02 status=scratchcheckin libvol lib8mm DBTP10 status=scratchcheckin libvol lib8mm DBTP11 status=scratch

Note: To process the CHECKIN LIBVOLUME commands, issue the MACRO commandwith drm/exec(cmds) as the macro name.

Related Commands

Table 138. Commands Related to MOVE DRMEDIA

Command Description






PREPARE Creates a recovery plan file.


QUERY DRMSTATUS Displays DRM system parameters.



SET DRMCHECKLABEL Specifies whether TSM should read volumelabels during MOVE DRMEDIA commandprocessing.

MOVE DRMEDIA


Table 138. Commands Related to MOVE DRMEDIA (continued)

Command Description


SET DRMCOURIERNAME Specifies the name of the courier for thedisaster recovery media.


SET DRMVAULTNAME Specifies the name of the vault where DRMmedia is stored.

SET DRMCMDFILENAME Specifies a file name for containing DRMexecutable commands.

SET DRMFILEPROCESS Specifies whether the MOVE DRMEDIA orQUERY DRMEDIA command processes filesassociated with a device type of file.

SET DRMNOTMOUNTABLENAME Specifies the location name of the DRM mediato be sent offsite.

MOVE DRMEDIA


MOVE GRPMEMBER (Move a Server Group Member)

Use this command to move a member from one server group to another server group.The command fails if the member you are moving has the same name as a currentmember of the group.

Privilege Class


Syntax

ÊÊ MOVe GRPMEMber member_name from_group to_group ÊÍ

Parametersmember_name (Required)

Specifies the member (a server or a server group) to move.

from_group (Required)Specifies the server group with which the member is currently associated.

to_group (Required)Specifies the new server group for the member.

Examples

Task

Move member PAYSON from REGION1 group to REGION2 group.

Command:move grpmember payson region1 region2

Related Commands

Table 139. Commands Related to MOVE GRPMEMBER

Command Description








MOVE GRPMEMBER


||

|||

|

|

|

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

|

|

||

||

||

|

|

|

||

|

|||

||

|||

||

||

||

||

||

||

Table 139. Commands Related to MOVE GRPMEMBER (continued)

Command Description


MOVE GRPMEMBER


|

||

||

|

NOTIFY SUBSCRIBERS (Notify Managed Servers to Update Profiles)

Use this command on a configuration manager to notify one or more managed serversto request that their configuration information be immediately refreshed.

Privilege Class


Syntax

ÊÊ NOTIfy SUBSCRIBers ·

,

PROFIle = profile_name ÊÍ

ParametersPROFIle (Required)

Specifies the name of the profile. Any managed servers that subscribe to the profileare notified. You can use wildcard characters to specify multiple profiles. To specifymultiple profiles, separate the names with commas and no intervening spaces.

Examples

Task

Notify all managed servers that subscribe to a profile named DELTA to request toupdated configuration information.

Command:notify subscribers profile=delta

Related Commands

Table 140. Commands Related to NOTIFY SUBSCRIBERS

Command Description





QUERY SUBSCRIPTION Specifies whether a server is a configurationmanager.

SET CONFIGMANAGER Displays information about profile subscriptions.


NOTIFY SUBSCRIBERS


||

PING SERVER (Test the Connection Between Servers)

Use this command to test the connection between the local server and a remote server.

Attention: The name and password of the administrator client issuing this commandmust also be defined on the remote server.

Privilege Class


Syntax

ÊÊ PING SERVER server_name ÊÍ


Specifies the name of the remote server.

Examples

Task

Test the connection to server FRED.

Command:ping server fred

Related Commands

Table 141. Commands Related to PING SERVER

Command Description



PING SERVER


||

|

||

|

|

|

||||||||||

|

|

||

|

|

|

||

|

|||

||

|||

||

|

PREPARE (Create a Recovery Plan File)

Use this command to create a recovery plan file, which contains the information neededto recover an TSM server. You can store a recovery plan file on a file system that isaccessible to the source TSM server or on a target TSM server.

You can use the QUERY ACTLOG command to view whether the PREPARE commandwas successful. You can also view this information from the server console or, if theWAIT parameter equals YES, an administrative client session.

Privilege Class


Syntax

ÊÊ PREPAREDEVclass = device_class_name PLANPrefix = prefix

Ê

ÊINSTRPrefix = prefix

·

,

COPYstgpool = pool_name

Ê

Ê

·

,

PRIMstgpool = pool_name

Wait = No

Wait = NoYes

ÊÍ

ParametersDEVclass

Specifies the device class name that is used to create a recovery plan file objecton a target server. The device class must have a device type of SERVER.

Note: The maximum capacity for the device class must be larger than the size ofthe recovery plan file. If the size of the recovery plan file exceeds themaximum capacity, the command fails.

The naming convention for the archive object that contains the recovery plan file onthe target server is:

Filespace name: ADSM.SERVER

High-level qualifier: devclassprefix/servername.yyyymmdd.hhmmss

Low-level qualifier: RPF.OBJ.1

The recovery plan file virtual volume name as recorded in the volume history tableon the source server is in the format servername.yyyymmdd.hhmmss.

PREPARE


|

If the DEVCLASS parameter is not specified, the recovery plan file is written to afile based on the plan prefix.

PLANPrefixSpecifies the library that will contain the recovery plan file.The maximum length is10 characters. This parameter is optional.

TSM appends to the prefix the sortable date and time formatDyyyymmdd(Thhmmss). For example: D19971115(T051421).

You can specify any valid library name. TSM uses the prefix as the library andcreates the file and member name using the date and time information in theformat Dyyyymmdd(Thhmmss). For example:

PLANPREFIX=DRMPLAN

The resulting file name would look like this:

DRMPLAN/D19971115(T051421)

If the PLANPREFIX parameter is not specified, TSM selects the prefix in one ofthese ways:

v If the SET DRMPLANPREFIX command has been issued:

TSM uses the prefix specified in that command.

v If the SET DRMPLANPREFIX command has not been issued, TSM uses thecurrent server work library (WRKLIB). For example, the WRKLIB is the following:

QUSRADSM

The resulting file name would look like this:

QUSRADSM/D19971115(T051421)

INSTRPrefixSpecifies the library that TSM uses to locate the files that contain the recoveryinstructions. This parameter is optional. The maximum length is 10 characters.

You can specify any valid library name. TSM gets instruction files from the libraryspecified by the prefix. For example:

INSTRPREFIX=DRMPLAN

For the general server recovery instructions file, INSTR(GENERAL), the resultingfile name would be:

DRMPLAN/INSTR(GENERAL)

If the INSTRPREFIX parameter is not specified, the prefix is selected in thefollowing order:

1. The prefix is defined by the SET DRMINSTRPREFIX command

2. If the SET DRMINSTRPREFIX command is not defined, the PREPAREcommand uses the current server work library (WRKLIB). For example, if thecurrent server work library (WRKLIB) is QUSRADSM, the name of theINSTR(GENERAL) file would be:

QUSRADSM/INSTR(GENERAL)

PREPARE


PRIMstgpoolSpecifies the names of the primary storage pools that you want to restore.Separate the storage pool names with commas and no intervening spaces. Youcan use wildcard characters. If this parameter is not specified, TSM selects thestorage pools as follows:

v If the SET DRMPRIMSTGPOOL command has been issued, TSM includes theprimary storage pools named in that command.

v If the SET DRMPRIMSTGPOOL command has not been issued, TSM includesall the primary storage pools.

COPYstgpoolSpecifies the names of the copy storage pools used to back up the primary storagepools that you want to restore (see the PRIMSTGPOOL parameter). Separatestorage pool names with commas and no intervening spaces. You can use wildcardcharacters. If this parameter is not specified, TSM selects the storage pools asfollows:

v If the SET DRMCOPYSTGPOOL command has been issued, TSM includesthose copy storage pools.

v If the SET DRMCOPYSTGPOOL command has not been issued, TSM includesall copy storage pools.

WaitSpecifies whether this command is processed in the background or foreground.

No Specifies background processing. This is the default.

YesSpecifies foreground processing.

Examples

Task

Issue the PREPARE command and query the activity log to check the results.

Commands:

preparequery actlog search=prepare

Output:

PREPARE


05/03/1998 12:01:13 ANR0984I Process 3 for PREPARE started in theBACKGROUND at 12:01:13.

05/03/1998 12:01:13 ANR6918W PREPARE: Recovery instructions filePLANFILE/INSTR(DATABASE) not found.

05/03/1998 12:01:13 ANR6918W PREPARE: Recovery instructions filePLANFILE/INSTR(STGPOOL) not found

05/03/1998 12:01:13 ANR6913W PREPARE: No volumes with backup dataexist in copy storage pool CSTORAGEP.

05/03/1998 12:01:13 ANR6913W PREPARE: No volumes with backup dataexist in copy storage pool CSTORAGEPSM.

05/03/1998 12:01:14 ANR6920W PREPARE: Generated replacement volumename BACK4X@ is not valid for devicetype 8mm. Original volume name: BACK4X. Stanzais PRIMARY.VOLUMES.REPLACEMENT macro.

05/03/1998 12:01:14 ANR6900I PREPARE: The recovery plan filePLANFILE/D19980503(T120114) was created.

05/03/1998 12:01:14 ANR0985I Process 3 for PREPARE running in theBACKGROUND completed with completion stateSUCCESS at 12:01:14.

Related Commands

Table 142. Commands Related to PREPARE

Command Description



QUERY RPFCONTENT Displays the contents of a recovery plan file.





SET DRMINSTRPREFIX Specifies the prefix portion of the path name forthe recovery plan instructions.

SET DRMPLANVPOSTFIX Specifies the replacement volume names in therecovery plan file.

SET DRMPLANPREFIX Specifies the prefix portion of the path name forthe recovery plan.


SET DRMRPFEXPIREDAYS Set criteria for recovery plan file expiration.


PREPARE


|||

||

||

||

|||

|||

QUERY ACTLOG (Query the Activity Log)

Use this command to display messages generated by the server. This command offersyou various filtering options that can be used to limit the amount of messages displayedand the time it takes to process this query. If you do not specify any parameters withthis command, all messages generated in the last hour are displayed.

Note: You cannot schedule the QUERY ACTLOG command using the DEFINESCHEDULE command.

Privilege Class


Syntax

ÊÊ Query ACtlogBEGINDate = current_date

BEGINDate = dateÊ

ÊBEGINTime = currenttime_minus_1_hour

BEGINTime = time

ENDDate = current_date

ENDDate = dateÊ

ÊENDTime = current_time

ENDTime = time MSGno = message_numberÊ

ÊSearch = string

ORiginator = ALL

ORiginator = ALLSErverCLient A

ÊÍ

A:

NODEname = node_name OWNERname = owner_nameÊ

ÊSCHedname = schedule_name Domainname = domain_name

Ê

QUERY ACTLOG


ÊSESsnum = session_number

ParametersBEGINDate

Specifies the beginning date of the range for messages to be displayed. Allmessages meeting the time range criteria that occurred after this date aredisplayed. The default is the current date. This parameter is optional.







TODAY –7 or –7.

To display information beginning withmessages created a week ago, you canspecify BEGINDATE=TODAY−7 orBEGINDATE= −7.

BEGINTimeSpecifies the beginning time of the range for messages to be displayed. Allmessages meeting the time range criteria that occurred after this time aredisplayed. If you do not specify time, all messages that occurred in the last hourare displayed.




10:30:08


NOW

NOW+HH:MM or+HH:MM


NOW+03:00 or +03:00.

If you issue this command at 9:00 withBEGINTIME=NOW+3 or BEGINTIME=+3,TSM displays messages with a time of12:00 or later on the begin date.



NOW−04:00 or −04:00.

If you issue the QUERY ACTLOGcommand at 9:00 withBEGINTime=NOW−3:30 or BEGINTime=−3:30, TSM displays messages with a timeof 5:30 or later on the begin date.

ENDDateSpecifies the ending date of the range for messages to be displayed. All messages

QUERY ACTLOG


meeting the time range criteria that occurred before this date are displayed. If youdo not specify a value, the current date is used. This parameter is optional.







TODAY–1 or –1.

To display information created up toyesterday, you can specifyENDDATE=TODAY−1 or simplyENDDATE= −1.

ENDTimeSpecifies the ending time of the range for messages to be displayed. All messagesmeeting this time range criteria that occurred before this time are displayed. If youdo not specify a value, all messages are displayed up to the time when you issuedthis command. This parameter is optional.




10:30:08


NOW

NOW+HH:MM or+HH:MM


NOW+03:00 or +03:00.

If you issue this command at 9:00 withENDTIME=NOW+3:00 or ENDTIME=+3:00, TSM displays messages with a timeof 12:00 or later on the end date youspecify.



NOW−03:30 or −03:30.

If you issue this command at 9:00 withENDTIME=NOW−3:30 or ENDTIME=−3:30, TSM displays messages with a timeof 5:30 or later on the end date youspecify.

MSGnoSpecifies an integer that defines the number of the message to be displayed fromthe activity log. This is the numeric part of the message without the ANR prefix orthe message type suffix (that is, I, W, E, S, or D). This parameter is optional.

SearchSpecifies a text string expression that you want to search for in the activity log.Enclose the string expression in quotation marks if it contains blanks. You can usea wildcard character to specify this string. This parameter is optional.

QUERY ACTLOG


ORiginatorSpecifies that the query displays messages logged by the server, client, or both.The default is ALL. Possible values are:

ALLSpecifies that the query displays messages that originated from the client andthe server.

SErverSpecifies that the query displays messages that originated from the server.

CLientSpecifies that the query displays messages that originated from the client.

You can specify one of the following values to minimize processing time whenquerying the activity log for messages logged by the client:

NODEnameSpecifies that the query displays messages logged for this node. If you donot specify a value for this parameter, messages for all nodes aredisplayed.

OWNERnameSpecifies that the query displays messages logged for a particular owner.If you do not specify a value for this parameter, messages for all ownersare displayed.

SCHednameSpecifies that the query displays messages logged by a particularscheduled client activity. If you do not specify a value for this parameter,messages for all schedules are displayed.

DOmainnameSpecifies that the query displays messages logged for a particular policydomain to which a named schedule belongs. This parameter is optional,unless you are specifying a schedule name.

SESsnumSpecifies that the query displays messages logged from a particular clientsession number. If you do not specify a value for this parameter,messages for all client sessions are displayed.

Examples

Task 1

Search the activity log for any message that contains the string “delete”. The outputincludes only messages produced during the past hour.

Command:query actlog search=delete

Output:

QUERY ACTLOG


Date/Time Message-------------------- -------------------------------------------------08/27/1998 15:19:43 ANR0812I Inventory client file expiration

complete: 0 files deleted.

Task 2

Display messages that occurred yesterday between 9:30 and 12:30.

Command:query actlog begindate=today-1 begintime=09:30:00 endtime=12:30:00

Output:

Date/Time Message-------------------- -------------------------------------------------10/21/1998 10:52:36 ANR0407I Session 3921 started for administrator ADMIN

(WebBrowser) (HTTP 9.115.20.100(2315)).10/21/1998 11:06:08 ANR0405I Session 3922 ended for administrator ADMIN

(WebBrowser).10/21/1998 12:16:50 ANR0405I Session 3934 ended for administrator ADMIN

(WebBrowser).10/21/1998 12:36:18 ANR2501I Schedule AGADM_TEST deleted from policy

domain STANDARD.

Task 3

Search the activity log for TSM messages from the client for node JEE.

Command:query actlog originator=client node=jee

Output:

Date/Time Message-------------------- -----------------------------------------------------06/10/1998 15:46:22 ANE4007E (Session No: 3 Node: JEE) Error processing

'/jee/report.out': access to the object isdenied

06/11/1998 15:56:56 ANE4009E (Session No: 4 Node: JEE) Error processing'/jee/work.lst': disk full condition

Related Commands

Table 143. Command Related to QUERY ACTLOG

Command Description

SET ACTLOGRETENTION Specifies the number of days to retain logrecords in the activity log.

QUERY ACTLOG


QUERY ADMIN (Display Administrator Information)

Use this command to display information on one or more administrators.

Privilege Class


Syntax

ÊÊ Query ADmin*

admin_name

·

,

CLasses = SYstemPolicySTorageAnalystOperatorNode

Ê

ÊFormat = Standard

Format = StandardDetailed

ÊÍ


Specifies the name of the administrator for which you want to display information.This parameter is optional. You can use wildcard characters to specify this name. Ifyou do not specify a value for this parameter, all administrators are displayed.

CLassesSpecifies that you want to restrict output to those administrators that have privilegeclasses that you specify. This parameter is optional. You can specify multipleprivilege classes in a list by separating the names with commas and no interveningspaces. If you do not specify a value for this parameter, information on alladministrators is displayed, regardless of privilege class. Possible values are:

SYstemDisplay information on administrators with system privilege.

PolicyDisplay information on administrators with policy privilege.

STorageDisplay information on administrators with storage privilege.

AnalystDisplay information on administrators with analyst privilege.

QUERY ADMIN


OperatorDisplay information on administrators with operator privilege.

NodeDisplay information on users with client node privilege.

FormatSpecifies how the information is displayed. This parameter is optional. The defaultvalue is STANDARD. Possible values are:

StandardSpecifies that partial information is displayed for the specified administrators.

DetailedSpecifies that complete information is displayed for the specifiedadministrators.

Examples

Task 1

Display partial information on all administrators.

Command:query admin

Output:

Administrator Days Since Days Since Locked? Privilege ClassesName Last Access Password

Set------------- ----------- ---------- --------- ------------------SHELLBEE <3 <21 No Policy OperatorMIKE <11 <11 No PolicyJANET No System

See Task 2 for descriptions.

Task 2

Display complete information for the administrator named ADMIN.

Command:query admin admin format=detailed

Output:

QUERY ADMIN


||

Administrator Name: ADMINLast Access Date/Time: 1998.06.04 17.10.52Days Since Last Access: <1Password Set Date/Time: 1998.06.04 17.10.52Days Since Password Set: 26

Invalid Sign-on Count: 0Locked?: NoContact:

System Privilege: YesPolicy Privilege: **Included with system privilege**Storage Privilege: **Included with system privilege**Analyst Privilege: **Included with system privilege**Operator Privilege: **Included with system privilege**

Client Access Privilege: **Included with system privilege**Client Owner Privilege: **Included with system privilege**Registration Date/Time: 05/09/1998 23:54:20

Registering Administrator: RAYManaging profile:

Password Expiration Period: 90 Day (s)

where:

Administrator NameSpecifies the name of the administrator.

Last Access Date/TimeSpecifies the date and time that the administrator last accessed the server.

Days Since Last AccessSpecifies the number of days since the administrator last accessed the server.

Password Set Date/TimeSpecifies the date and time that the administrator’s password was defined or mostrecently updated.

Days Since Password SetSpecifies the number of days since the administrator’s password was defined ormost recently updated.

Invalid Sign-on CountSpecifies the number of invalid sign-on attempts that have been made since thelast successful sign-on. This count can only be non-zero when an invalid passwordlimit (SET INVALIDPWLIMIT) is greater than zero. When the number of invalidattempts equals the limit set by the SET INVALIDPWLIMIT command, theadministrator is locked out of the system.

Locked?Specifies whether the administrator is locked out of the system.

ContactSpecifies any contact information for the administrator.

System PrivilegeSpecifies whether the administrator has been granted system privilege.

QUERY ADMIN


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

Policy PrivilegeSpecifies whether the administrator has been granted unrestricted policy privilegeor the names of any policy domains that the restricted policy administrator canmanage.

Storage PrivilegeSpecifies whether the administrator has been granted unrestricted storage privilegeor the names of any storage pools that the restricted storage administrator canmanage.

Analyst PrivilegeSpecifies whether the administrator has been granted analyst privilege.

Operator PrivilegeSpecifies whether the administrator has been granted operator privilege.

Client Access PrivilegeSpecifies that client access authority has been granted to a user with nodeprivilege.

Client Owner PrivilegeSpecifies that client owner authority has been granted to a user with node privilege.

Registration Date/TimeSpecifies the date and time that the administrator was registered.

Registering AdministratorSpecifies the name of the administrator who registered the administrator. If this fieldcontains $$CONFIG_MANAGER$$, the administrator is associated with a profilethat is managed by the configuration manager.

Managing ProfileSpecifies the profiles to which the managed server subscribed to get the definitionof this administrator.

Related Commands

Table 144. Commands Related to QUERY ADMIN

Command Description

GRANT AUTHORITY Assigns privilege classes to an administrator.



REGISTER ADMIN Defines a new administrator without grantingadministrative authority.

REMOVE ADMIN Removes an administrator from the list ofregistered administrators.

RENAME ADMIN Changes a TSM administrator’s name.

REVOKE AUTHORITY Revokes one or more privilege classes orrestricts access to policy domains and storagepools.

QUERY ADMIN


Table 144. Commands Related to QUERY ADMIN (continued)

Command Description

SET INVALIDPWLIMIT Sets the maximum number of invalid sign-onattempts allowed before an administrator islocked out of the system.

SET MINPWLENGTH Sets the minimum length for client passwords.

QUERY ADMIN


QUERY ASSOCIATION (Query Client Node Associations with a Schedule)

Use this command to display information about which client nodes are associated withone or more schedules. Client nodes associated with a schedule perform operationssuch as backup or archive according to that schedule.

Privilege Class

Any administrator can perform this task.

Syntax

ÊÊ Query ASSOCiation* *

*domain_name

schedule_name

ÊÍ


Specifies the name of the policy domain to display. You can use a wildcardcharacter to specify this name. All matching policy domain names are displayed. Ifyou do not specify a value for this parameter, all existing policy domains arequeried. If you specify a domain name, you do not have to specify a schedulename.

schedule_nameSpecifies the name of the schedule to display. You can use a wildcard character tospecify this name. All matching schedule names are displayed. If you do notspecify a value for this parameter, all existing schedules are queried. If you specifya schedule name, you must also specify a policy domain name.

Examples

Task

Display all the client nodes that are associated with each schedule that belongs to theEMPLOYEE_RECORDS policy domain.

Command:query association employee_records *

Output:

QUERY ASSOCIATION


Policy Domain Name: EMPLOYEE_RECORDSSchedule Name: WEEKLY_BACKUP

Associated Nodes: JOE JOHNSON LARRY SMITH SMITHERS TOM

where:

Policy Domain NameSpecifies the name of the policy domain to which the schedule belongs.

Schedule NameSpecifies the name of the schedule.

Associated NodesSpecifies the names of the client nodes that are associated with the specifiedschedule.

Related Commands

Table 145. Commands Related to QUERY ASSOCIATION

Command Description


DELETE ASSOCIATION Deletes the association between clients and aschedule.

QUERY ASSOCIATION


QUERY AUDITOCCUPANCY (Query Client Node Storage Utilization)

Use this command to display information about client node server storage utilization. Todisplay current license audit information from the server, use the AUDIT LICENSEcommand prior to issuing the QUERY AUDITOCCUPANCY command.

Note: As part of a license audit operation, the server calculates, by node, the amountof backup, archive, and space management storage in use. For serversmanaging large amounts of data, this calculation can take a great deal of CPUtime and can stall other server activity. You can use the AUDITSTORAGE serveroption to specify that storage is not to be calculated as part of a license audit.

You can use the information from this query to determine if and where client nodestorage utilization needs to be balanced. This information can also assist you withbilling clients for storage usage.

Privilege Class


Syntax

ÊÊ Query AUDITOccupancy

·

,

node_name ·

,

DOmain = domain_name

Ê

ÊPOoltype = ANY

POoltype = ANYPRimaryCOpy

ÊÍ

Parametersnode_name

Specifies a list of nodes for which to display server storage use information.Specify more than one node by separating the node names with commas, with nointervening spaces. You can use wildcard characters to specify names. The default(*) is to query all client nodes. Use the DOMAIN parameter to limit this list by policydomain. This parameter is optional.

DOmainSpecifies a list of policy domains to restrict which nodes are displayed. Nodesbelonging to the specified policy domains are displayed. Specify more than onepolicy domain by separating the policy domain names with commas, with nointervening spaces. You can use wildcard characters to specify names. Thisparameter is optional.



POoltypeSpecifies the type of storage pool storage to display. This parameter is optional.The default is ANY. Possible values are:

ANYSpecifies both primary and copy storage pools. The value presented is thetotal for the two pools.

PRimarySpecifies primary storage pools only.

COpySpecifies copy storage pools only.

Examples

Task

Display combined storage use in primary and copy storage pools.

Command:query auditoccupancy

Output:

License information as of last audit on 05/22/1996 14:49:51.

Client Node Name Backup Archive Space-Managed TotalStorage Storage Storage Used Storage

Used (MB) Used (MB) (MB) Used (MB)--------------------- --------- ---------- ------------ ---------CLIENT 245 20 0 265SMITH 245 20 0 265SMITHERS 245 20 0 265JOHNSON 300 15 0 320JOE 245 20 0 265TOM 300 15 0 320LARRY 245 20 0 265

where:

Client Node NameSpecifies the name of the client node.

Backup Storage Used (MB)Specifies, in megabytes, the total backup storage use for the node.

Archive Storage Used (MB)Specifies, in megabytes, the total archive storage use for the node.

Space-Managed Storage Used (MB)Specifies, in megabytes, the amount of server storage used to store files migratedfrom the client node.

Total Storage Used (MB)Specifies, in megabytes, the total storage use for the node.



Related Commands

Table 146. Commands Related to QUERY AUDITOCCUPANCY

Command Description








QUERY CLOPTSET (Query a Client Option Set)

Use this command to query a client option set.

Privilege Class


Syntax

ÊÊ*

Query CLOptsetoption_set_name DESCription = description

ÊÍ

Parametersoption_set_name

Specifies the name of the client option set to be queried. You can use wildcardcharacters to specify this name. This parameter is optional. The default is optionset names.

DESCriptionSpecifies the description used on the DEFINE or UPDATE CLOPTSET commandsto be used as a filter. If the description contains spaces, enclose it in quotationmarks. This parameter is optional.

Examples

Task

From a managed server, query a client option set named ENG.

Command:query cloptset eng

Output:

QUERY CLOPTSET


Optionset: ENGDescription:

Last Update by (administrator): $$CONFIG_MANAGER$$Managing profile:

Option: SCROLLINESSequence number: 0

Override: NoOption Value: 40

Option: SCROLLPROMPTSequence number: 0

Override: NoOption Value: yes

where:

OptionsetSpecifies the name of the option set.

DescriptionSpecifies the description of the client option set.

Last Update by (administrator)Specifies the name of the administrator that most recently updated the option set. Ifthis field contains $$CONFIG_MANAGER$$, the client option set is associated witha profile that is managed by the configuration manager.

Managing ProfileSpecifies the profile to which the managed server subscribed to get the definition ofthe client option set.

OptionSpecifies the name of the option.

Sequence NumberSpecifies the sequence number of the option.

OverrideSpecifies whether the client’s option file can override the option.

Option ValueSpecifies the value of the option.

Related Commands

Table 147. Commands Related to QUERY CLOPTSET

Command Description






QUERY CLOPTSET


Table 147. Commands Related to QUERY CLOPTSET (continued)

Command Description




QUERY CLOPTSET


QUERY CONTENT (Query the Contents of a Storage Pool Volume)

Use this command to display information about files in a storage pool volume. You canuse this command to identify files that the server has found to be damaged and filesthat have been backed up to a copy storage pool. This command is useful when avolume is damaged or before you:

v Request the server to fix any inconsistencies between a volume and the database

v Move files from one volume to another volume

v Delete a volume from a storage pool

Because this command can take a long time to run and the results can be very large,you should consider using the COUNT parameter to limit the number of files displayed.

Note: Files that are cached in a disk volume and that are marked as damaged are notincluded in the results.

Privilege Class


Syntax

ÊÊ Query CONtent volume_nameNODE = node_name

Ê

ÊFIlespace = file_space_name COUnt = number

Ê

ÊType = ANY

Type = ANYBackupArchiveSPacemanaged

Format = Standard


Ê

ÊDAmaged = ANY

DAmaged = ANYYesNo

(1)COPied = ANY

COPied = ANYYesNo

ÊÍ

Notes:

1 Use this parameter only for volumes in primary storage pools.

QUERY CONTENT



Specifies the volume to be queried.

NODESpecifies the backup-archive client or the Tivoli Space Manager (HSM client)associated with the file space to query. This parameter is optional. You can usewildcard characters to specify this name. If you do not specify a name, allbackup-archive and HSM clients are included.

FIlespaceSpecifies the file space to query. This parameter is optional. You can use wildcardcharacters to specify this name. File space names are case-sensitive. If you do notspecify a file space name, all file spaces are included.

COUntSpecifies the number of files to be displayed. This parameter is optional. You canspecify either a positive integer or a negative integer. If you specify a positiveinteger, n, the first n files are displayed. If you specify a negative integer, -n, thelast n files are displayed in reverse order. You cannot specify COUNT=0. If you donot specify a value for this parameter, all files are displayed.

TypeSpecifies the types of files to query. This parameter is optional. The default value isANY. Possible values are:

ANYSpecifies that all types of files in the storage pool volume are queried: backupversions of files, archived copies of files, and files migrated from HSM clientnodes.

BackupSpecifies that only backup files are queried.

ArchiveSpecifies that only archive files are queried.

SPacemanagedSpecifies that only space-managed files (files migrated from HSM clients) arequeried.


StandardSpecifies that partial information is displayed.

DetailedSpecifies that complete information is displayed.

DAmagedSpecifies criteria to restrict the query output based on whether files have beenmarked as damaged. For purposes of this criteria, the server examines only

QUERY CONTENT


physical files (a file that may be a single logical file or an aggregate that consists oflogical files). This parameter is optional. The default value is ANY. Possible valuesare:

ANYSpecifies that files are displayed regardless of whether the server has foundthe files to be damaged.

YesSpecifies that only files that have been marked as damaged are displayed.These are files in which the server found errors when a user attempted torestore, retrieve, or recall the file, or when an AUDIT VOLUME command wasrun.

No Specifies that only files not known to have been damaged are displayed.

COPiedSpecifies criteria to restrict the query output based on whether files have beenbacked up to a copy storage pool. This parameter is optional. The default value isANY. Possible values are:

ANYSpecifies that files are displayed regardless of whether the files are backed upto a copy storage pool. Primary and cached file copies are displayed.

YesSpecifies that the files displayed are only those for which at least one usablebackup copy exists in a copy storage pool. A file is not displayed if its copy inthe copy storage pool is known to have errors. Cached file copies are notdisplayed because these files are never restored.

Use COPIED=YES to identify primary files that can be restored using theRESTORE VOLUME or RESTORE STGPOOL command.

No Specifies that the files displayed are only those for which no usable backupcopies exist in a copy storage pool. Cached file copies are not displayedbecause these files are never restored.

Use COPIED=NO to identify primary files that cannot be restored using theRESTORE VOLUME or RESTORE STGPOOL command.

Examples

Task 1

Query the contents of the volume that is named /adsmstg/vol002. Limit the query tospace-managed files from the PEGASUS client node.

Command:query content /adsmstg/vol002 node=pegasus type=spacemanaged

Output:

QUERY CONTENT


|

|

Node Name Type Filespace Client's Name for FileName

------------------------ ---- ---------- ----------------------PEGASUS SpMg /home /sunday/08PEGASUS SpMg /home /sunday/09PEGASUS SpMg /home /sunday/11PEGASUS SpMg /home /sunday/14

where:

Node NameThe node to which the file belongs.

TypeThe type of file: archive (Arch), backup (Bkup), or space-managed (SpMg).

Filespace NameThe file space to which the file belongs.

Client’s Name for FileThe client’s name for the file.

Results of the command include all logical files that make up any aggregate that ison the volume, even if the aggregate is stored on more than this volume. Foraggregates, the query does not determine which logical files are actually stored onthe volume for which the query is performed.

Task 2

Query the contents of the tape volume named WPD001. Display only files backed up bythe node DWE, and only the first four files on the volume. Display complete information.

Command:query content wpd001 node=dwe count=4 type=backup format=detailed

QUERY CONTENT


Node Name: DWEType: Bkup

Filespace Name: OS2Client's Name for File: \ README

Aggregated?: NoStored Size: 27,089

Segment Number: 1/1Cached Copy?: No


Filespace Name: DRIVE_L_K:Client's Name for File: \COMMON\DSMCOMMN\ AB0CTCOM.ENT

Aggregated?: 1/4Stored Size: 202,927



Filespace Name: DRIVE_L_K:Client's Name for File: \COMMON\DSMCOMMN\ AB0CTGLO.IDE




Filespace Name: DRIVE_L_K:Client's Name for File: \COMMON\DSMCOMMN\ AB0CTTRD.IDE



Node NameThe node to which the file belongs.

TypeThe type of file: archive (Arch), backup (Bkup), or space-managed (SpMg).

Filespace NameThe file space to which the file belongs.

Client’s Name for FileThe client’s name for the file.

Aggregated?Whether the file is a logical file that is stored as part of an aggregate. If the file ispart of an aggregate, the sequence of this file within the aggregate and the totalnumber of logical files in the aggregate are displayed.

Results of the command include all logical files that make up any aggregate that ison the volume, even if the aggregate is stored on more than this volume. Thequery does not determine which logical files are actually stored on the volume forwhich the query is performed.

Stored SizeThe size of the physical file, in bytes. If the file is a logical file that is stored as partof an aggregate, this value indicates the size of the entire aggregate.

QUERY CONTENT


Segment NumberFor volumes in sequential-access storage pools, specifies whether the physical file(either a single logical file or an aggregate of logical files) is stored across multiplevolumes. For example, if the logical file is stored in an aggregate that spans twovolumes, the segment number indicates 1/2 (the first part of the physical file isstored on the volume) or 2/2 (the second part of the physical file is stored on thevolume). If the segment number is 1/1, the physical file is completely stored on thevolume. For volumes in random-access storage pools, no value is displayed for thisfield.

Cached Copy?Whether the physical file is a cached copy of a file migrated to the next storagepool. If the file is part of an aggregate, this value pertains to the aggregate.

Related Commands

Table 148. Commands Related to QUERY CONTENT

Command Description







QUERY CONTENT


QUERY COPYGROUP (Query Copy Groups)

Use this command to display information about one or more copy groups.

Privilege Class


Syntax

ÊÊ Query COpygroup Ê

Ê* * * STANDARD

* * STANDARDdomain_name

* STANDARDpolicy_set_name

STANDARDclass_name

STANDARD

Ê

ÊType = Backup

Type = BackupArchive

Format = Standard


ÊÍ


Specifies the policy domain associated with the copy group to query. Thisparameter is optional. You can use wildcard characters to specify names. If you donot specify a value for this parameter, all policy domains are queried. You mustspecify this parameter when querying an explicitly named copy group.

policy_set_nameSpecifies the policy set associated with the copy group to query. This parameter isoptional. You can use wildcard characters to specify names. If you do not specify avalue for this parameter, all policy sets are queried. You must specify thisparameter when querying an explicitly named copy group.

class_nameSpecifies the management class associated with the copy group to query. Thisparameter is optional. You can use wildcard characters to specify names. If you donot specify a value for this parameter, all management classes are queried. Youmust specify this parameter when querying an explicitly named copy group.

QUERY COPYGROUP


STANDARDSpecifies the name of the copy group. This parameter is optional. The name of thecopy group must be STANDARD. The default is STANDARD.

TypeSpecifies the type of copy group to be queried. This parameter is optional. Thedefault value is BACKUP. Possible values are:

BackupSpecifies that you want to query backup copy groups.

ArchiveSpecifies that you want to query archive copy groups.




Examples

Task 1

From a managed server, display complete information on the backup copy groupassigned to the STANDARD management class in the STANDARD policy set of theADMIN_RECORDS policy domain.

Command:query copygroup admin_records standard standard format=detailed

Output:

Policy Domain Name: ADMIN_RECORDSPolicy Set Name: STANDARDMgmt Class Name: STANDARDCopy Group Name: STANDARDCopy Group Type: Backup

Versions Data Exists: 2Versions Data Deleted: 1Retain Extra Versions: 30

Retain Only Version: 60Copy Mode: Modified

Copy Serialization: Shared StaticCopy Frequency: 0

Copy Destination: BACKUPPOOLLast Update by (administrator): $$CONFIG_MANAGER$$

Last Update Date/Time: 1998.06.04 17.51.49Managing profile: ADMIN_INFO

where:

QUERY COPYGROUP


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

Policy Domain NameThe name of the policy domain.

Policy Set NameThe name of the policy set.

Mgmt Class NameThe name of the management class.

Copy Group NameThe name of the copy group. This name is always STANDARD.

Copy Group TypeThe type of the copy group.

Versions Data ExistsThe maximum number of backup versions to retain for files that are on the clientfile system.

Versions Data DeletedThe maximum number of backup versions to retain for files that have been deletedfrom the client file system.

Retain Extra VersionsThe number of days to retain a backup version after that version becomes inactive(that is, a more recent backup version is stored).

Retain Only VersionThe number of days to retain the last backup version of a file that has been deletedfrom the client file system.

Copy ModeWhether TSM backs up a file only if the file has changed since the last backup.This value can be Modified or Absolute. The copy mode value is only used forincremental backups. This value is ignored during selective backups.

Copy SerializationWhether a file can be in use during a backup operation.

Copy FrequencyThe minimum days between backups.

Copy DestinationThe name of the storage pool where the server initially stores files associated withthis copy group.

Last Update by (administrator)The name of the administrator or server that most recently updated the copy group.If this field contains $$CONFIG_MANAGER$$, the copy group is associated with adomain that is managed by the configuration manager.

Last Update Date/TimeThe date and time when the copy group was most recently defined or updated.

Managing ProfileThe profile or profiles to which the managed server subscribed to get the definitionof this copy group.

QUERY COPYGROUP


|||

Task 2

From a managed server, display complete information on the archive copy groupSTANDARD that is assigned to the MCLASS1 management class in the SUMMERpolicy set of the PROG1 policy domain.

Command:query copygroup prog1 summer mclass1 type=archive format=detailed

Output:

Policy Domain Name: PROG1Policy Set Name: SUMMERMgmt Class Name: MCLASS1Copy Group Name: STANDARDCopy Group Type: ArchiveRetain Version: 730

Copy Serialization: Shared StaticCopy Frequency: Cmd

Copy Mode: AbsoluteCopy Destination: ARCHPOOL

Last Update by (administrator): $$CONFIG_MANAGER$$Last Update Date/Time: 1998.06.05 17.42.49

Managing profile: ADMIN_INFO

where:



Mgmt Class NameThe name of the management class.

Copy Group NameThe name of the copy group. This name is always STANDARD.

Copy Group TypeThe type of the copy group.

Retain VersionThe number of days to keep an archive copy.

Copy SerializationWhether a file can be in use during an archive operation.

Copy FrequencyThe copy frequency of the copy group. For archive copy groups, this value isalways CMD.

Copy ModeSpecifies that files in the copy group are archived regardless of whether they havebeen modified. For archive copy groups, this value is always ABSOLUTE.

QUERY COPYGROUP


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

Copy DestinationThe name of the storage pool where the server initially stores files associated withthis archive copy group.

Last Update by (administrator)The name of the administrator or server that most recently updated the copy group.If this field contains $$CONFIG_MANAGER$$, the copy group is associated with adomain that is managed by the configuration manager.

Last Update Date/TimeThe date and time when the copy group was most recently defined or updated.

Managing ProfileThe profile or profiles to which the managed server subscribed to get the definitionof this policy copy group.

Related Commands

Table 149. Commands Related to QUERY COPYGROUP

Command Description




QUERY COPYGROUP


|||

QUERY DB (Display Information on the Database)

Use this command to display statistical information about the database.

Privilege Class


Syntax

ÊÊ Query DBFormat = Standard


ÊÍ

ParametersFormat

Specifies how the information is displayed. This parameter is optional. The defaultis STANDARD. Possible values are:



Examples

Task 1

Display statistical information about the database.

Command:query db

Output:

Available Assigned Maximum Maximum Page Total Used Pct Max.Space Capacity Extension Reduction Size Pages Pages Util Pct(MB) (MB) (MB) (MB) (bytes) Util

--------- -------- --------- --------- ------- ------ ----- ----- -----8 4 4 0 4,096 1,024 94 9.2 9.2

See Task 2 for parameter definitions.

Task 2

Display statistical information about the database in detail.

QUERY DB


Command:query db format=detailed

Output:

Available Space (MB): 8Assigned Capacity (MB): 4Maximum Extension (MB): 4Maximum Reduction (MB): 0

Page Size (bytes): 4,096Total Usable Pages: 1,024

Used Pages: 94Pct Util: 9.2

Max. Pct Util: 9.2Physical Volumes: 3Buffer Pool Pages: 64

Total Buffer Requests: 4,702Cache Hit Pct.: 97.68Cache Wait Pct.: 0.00

Backup in Progress?: NoType of Backup In Progress:

Incrementals Since Last Full: 0Changed Since Last Backup (MB): 0.37

Percentage Changed: 100.00Last Complete Backup Date/Time:

where:

Available Space (MB)Specifies the amount of space available, in megabytes.

Assigned Capacity (MB)Specifies the assigned storage capacity, in megabytes.

Maximum Extension (MB)Specifies the maximum amount the database can be extended, in megabytes.

Maximum Reduction (MB)Specifies the maximum amount the database can be reduced, in megabytes.

Page Size (bytes)Specifies the page size, in bytes.

Total Usable PagesSpecifies the total number of pages available. The total number of pages willalways be a multiple of the Assigned Capacity value, by a factor of 256 (1megabyte/256 pages).

Used PagesSpecifies the total number of pages currently being used.

Pct UtilSpecifies the current utilization as a percentage of the assigned capacity.

Max. Pct UtilSpecifies the maximum occupancy for the database, as a percentage of theavailable space. This value is the greatest utilization percentage.

QUERY DB


Physical VolumesSpecifies the number of database volumes and copies.

Buffer Pool PagesSpecifies the number of pages in the database buffer pool.

Total Buffer RequestsSpecifies the cumulative number of requests for database pages since the lastRESET BUFPOOL command (or since the server was last started).

Cache Hit Pct.Specifies, as a percentage of the total number of requests, the number of requestsfor a database page that are already in the buffer pool.

Cache Wait Pct.Specifies, as a percentage, the number requests for a database buffer pool pagethat was unavailable (because all buffer pool pages are occupied).

Backup in Progress?Specifies if a backup is in progress.

Type of Backup in ProgressSpecifies a full or an incremental backup.

Incremental Since Last FullSpecifies the number of incremental backups run since the last full backup.

Changed Since Last Backup (MB)Specifies the database pages, in megabytes, that have changed since the lastbackup.

Percentage ChangedSpecifies, as a percentage, the number of pages that have changed since the lastbackup.

Last Complete Backup Date/TimeSpecifies the date and time of the last complete backup.

Related Commands

Table 150. Commands Related to QUERY DB

Command Description






QUERY DB


Table 150. Commands Related to QUERY DB (continued)

Command Description



RESET BUFPOOL Resets the buffer pool statistics for thedatabase.

RESET DBMAXUTILIZATION Resets the maximum utilization statistic for thedatabase.

QUERY DB


QUERY DBBACKUPTRIGGER (Query the Database Backup Trigger)

Use this command to display the settings for the database backup trigger.

Privilege Class


Syntax

ÊÊ Query DBBackuptriggerFormat = Standard


ÊÍ

ParametersFormat


StandardPartial information is displayed.

DetailedDetailed information is displayed.

Examples

Task

Display the settings for the database backup trigger.

Command:query dbbackuptrigger format=detailed

Output:

Full Device Class: FILEIncremental Device Class: FILE

Log Full Percentage: 50Incrementals Between Fulls: 6

Last Update by (administrator): JANETLast Update Date/Time: 05/31/1997 11:15:35

where:

Full Device ClassThe name of the device class used for full backups.



Incremental Device ClassThe name of the device class used for incremental backups.

Log Full PercentageThe space utilization percentage of the recovery log at which TSM automaticallybacks up the database.

Incrementals Between FullsThe number of incremental database backups that TSM runs between full backups.

Last Update by (administrator)The name of the administrator that most recently updated the trigger.

Last Update Date/TimeWhen the administrator most recently updated the trigger.

Related Commands

Table 151. Commands Related to QUERY DBBACKUPTRIGGER

Command Description






QUERY DBVOLUME (Display Information on One or More Database Volumes)

Use this command to display information about database volumes and volume copies.

Privilege Class


Syntax

ÊÊ Query DBVolume*

volume_name

Format = Standard


ÊÍ

Parametersvolume_name

Specifies the name of the database volume. This parameter is optional. You canuse wildcard characters to specify names. If you do not specify a volume name,information on all database volumes is displayed.

FormatSpecifies how the information is displayed. This parameter is optional. The defaultis STANDARD. Possible values are:



Examples

Task 1

Display partial information on the database volume named db1.

Command:query dbvolume /dbvol/db1

Output:

QUERY DBVOLUME


|

Volume Name Copy Volume Name Copy Volume Name Copy(Copy 1) Status (Copy 2) Status (Copy 3) Status---------------- ------ ----------- ------ ----------- ---/QUSRADSM/DBVOL.DB1 Sync'd Sync'd Undef-

ined

Task 2

Display detailed information on the database volume named DB1.

Command:query dbvolume /dbvol/db1 format=detailed

Output:

Volume Name (Copy 1): /QUSRADSM/DBVOL.DB1Copy Status: Sync'd

Volume Name (Copy 2):Copy Status: Undefined


Available Space (MB): 4Allocated Space (MB): 4

Free Space (MB): 0

where:

Volume Name (Copy n)Specifies the name of the volume. The output displays status of the three volumecopies (Copy 1, Copy 2, and Copy 3).

Copy StatusSpecifies the status of the volume. Possible values are:

OfflineThe volume is varied offline.

StaleThe volume is not synchronized with the other volumes and cannot be used forstorage.

Sync’dThe volume is synchronized with the other volumes and can be used forstorage.

UndefinedNo volume has been defined.

Available Space (MB)Specifies the total amount of space that is available, both allocated and free, inmegabytes.

Allocated SpaceSpecifies the amount of space allocated, in megabytes.

QUERY DBVOLUME


|||||||

|

||||||||||

Free SpaceSpecifies the amount of unassigned space for this mirror set that can be allocatedfor use, in megabytes.

Related Commands

Table 152. Commands Related to QUERY DBVOLUME

Command Description




VARY Specifies whether a disk volume is available tothe server for use.

QUERY DBVOLUME


QUERY DEVCLASS (Display Information on One or More Device Classes)

Use this command to display information on one or more device classes.

Privilege Class


Syntax

ÊÊ Query DEVclass*

device_class_name

Format = Standard


ÊÍ

Parametersdevice_class_name

Specifies the name of the device class to be queried. This parameter is optional.You can use wildcard characters to specify this name. All matching device classesare displayed. If you do not specify a value for this parameter, all device classesare displayed.


StandardSpecifies that partial information is displayed for the specified device class.

DetailedSpecifies that complete information is displayed for the specified device class.

Examples

Task 1

Display information on all device classes.

Command:query devclass

Output:

QUERY DEVCLASS


Device Device Storage Device Format Est/Max MountClass Access Pool Type Capacity LimitName Strategy Count (MB)

--------- ---------- ------- ------ ------ -------- -----8MMTAPE Sequential 1 8MM DRIVE 6,144.0 2DISK Random 4PLAINFIL- Sequential 1 FILE 50.0 1ES


Task 2

Display information in full detail on the DC480 device class.

Command:query devclass dc480 format=detailed

Output:

Device Class Name: DC480Device Access Strategy: Sequential

Storage Pool Count: 0Device Type: FILE

Format:Est/Max Capacity (MB): 4.0

Mount Limit: 1Mount Wait (min): 60

Mount Retention (min): 60Label Prefix: ADSM

Library: QUSRADSMOLibrary:

Server Name:Retry Period:

Retry Interval:Last Update by (administrator): ADMIN

Last Update Date/Time: 05/31/1996 13:15:36

Device Class NameSpecifies the name of the device class.

Device Access StrategySpecifies how data is written to the device class.

Storage Pool CountSpecifies the number of storage pools that are assigned to the device class.

Device TypeSpecifies the device type of the device class.

FormatSpecifies the recording format.

Est/Max Capacity (MB)Specifies the estimated or maximum capacity of a volume associated with thedevice class.

QUERY DEVCLASS


Mount LimitSpecifies the maximum number of sequential access volumes that can be mountedconcurrently.

Mount Wait (min)Specifies the maximum number of minutes to wait for a sequential access volumeto be mounted.

Mount Retention (min)Specifies the number of minutes to retain an idle sequential access volume beforedismounting it.

Label PrefixSpecifies the high-level qualifier of the data set name that the server writes into thesequential access media labels.

LibrarySpecifies the name of the defined library object that contains the drives used by thedevice class.

OLibrarySpecifies the object library that contains the file or files used in the device class.

Server NameSpecifies the name of a defined server for the device class.

Retry PeriodSpecifies the interval over which the server should attempt to contact a targetserver if there is a suspected communications failure.

Retry IntervalSpecifies the how often the retries are done within a given retry period.

Last Update by (administrator)Specifies the administrator that made the last update to the device class.

Last Update Date/TimeSpecifies the date and time of the last update.

Related Commands

Table 153. Commands Related to QUERY DEVCLASS

Command Description






QUERY DEVCLASS


QUERY DOMAIN (Query a Policy Domain)

Use this command to display information on one or more policy domains.

Privilege Class


Syntax

ÊÊ Query DOmain*

domain_name

Format = Standard


ÊÍ


Specifies the policy domain to query. This parameter is optional. You can usewildcard characters to specify names. If you do not specify a value for thisparameter, all policy domains are displayed.




Examples

Task 1

Display partial information for all policy domains on the server.

Command:query domain

Output:

QUERY DOMAIN


Policy Activated Activated Number of DescriptionDomain Policy Default RegisteredName Set Mgmt Nodes

Class--------- --------- --------- ---------- ------------------EMPLOYEE- VACATION ACTIVEFI- 6 Employee Records_RECORDS LES DomainPROG1 0 Programming Group

Test DomainPROG2 0 Programming Group

Test DomainSTANDARD STANDARD STANDARD 1 Installed default

policy domain


Task 2

From a managed server, display information in full detail for theEMPLOYEE_RECORDS policy domain.

Command:query domain employee_records format=detailed

Output:

Policy Domain Name: EMPLOYEE_RECORDSActivated Policy Set: VACATIONActivation Date/Time: 1998.06.04 17.18.30Days Since Activation: <1

Activated Default Mgmt Class: ACTIVEFILESNumber of Registered Nodes: 6

Description: Employee Records domainBackup Retention (Grace Period): 30Archive Retention (Grace Period): 365

Last Update by (administrator): $$CONFIG_MANAGER$$Last Update Date/Time: 06/04/1998 17:18:30

Managing Profile: ADMIN_INFO

where:


Activated Policy SetThe name of the policy set that was last activated in the domain.

The definitions in the last activated policy set and the ACTIVE policy set are notnecessarily identical. When you activate a policy set, the server copies the contentsof the policy set to the policy set with the special name ACTIVE. The copieddefinitions in the ACTIVE policy set can be modified only by activating anotherpolicy set. You can modify the original policy set without affecting the ACTIVEpolicy set. Therefore, definitions in the policy set that was last activated might notbe the same as those in the ACTIVE policy set.

QUERY DOMAIN


Activation Date/TimeThe date and time that the policy set was activated.

Days Since ActivationThe number of days since the policy set was activated.

Activated Default Mgmt ClassThe assigned default management class for the policy set.

Number of Registered NodesThe number of client nodes registered to the policy domain.

DescriptionThe description of the policy domain.

Backup Retention (Grace Period)The number of days to retain inactive backup versions of files when any of thefollowing conditions occur:

v A file is rebound to a new management class, but neither the new managementclass nor default management class contains a backup copy group.



Archive Retention (Grace Period)The number of days to retain an archive file that meets either of the followingconditions:



Last Update by (administrator)The administrator that defined or most recently updated the policy domain. If thisfield contains $$CONFIG_MANAGER$$, the policy domain is associated with aprofile that is managed by the configuration manager.

Last Update Date/TimeWhen the administrator defined or most recently updated the policy domain.

Managing ProfileThe profile or profiles to which the managed server subscribed to get the definitionof this policy domain.

Related Commands

Table 154. Commands Related to QUERY DOMAIN

Command Description


QUERY DOMAIN


Table 154. Commands Related to QUERY DOMAIN (continued)

Command Description




QUERY DOMAIN


QUERY DRIVE (Query Information about a Drive)

Use this command to display information about a drive located in a server-attachedlibrary.

Privilege Class


Syntax

ÊÊ Query DRive* *

*library_name

drive_name

Format = Standard


ÊÍ

Parameterslibrary_name

Specifies the name of the library where the queried drive is located. This parameteris optional. You can use a wildcard character to specify this name.

You must specify a value for this parameter if you specify DRIVE_NAME.

drive_nameSpecifies the name assigned to the drive. This parameter is optional. You can usea wildcard character to specify this name. If you specify DRIVE_NAME, you mustalso specify a LIBRARY_NAME.


StandardSpecifies that partial information is displayed for the drive.

DetailedSpecifies that complete information is displayed for the drive.

Examples

Task 1

Display information about all drives associated with your server.

Command:query drive

Output:

QUERY DRIVE


Library Drive Device Device Share AutoloaderName Name Type-------- ------ -------- -------- ----- --------8MMLIB DRIVE08 8MM TAPE08 NOMANLIB DRIVE01 CARTRIDGE TAPE01 YES NOQICLIB DRIVE06 QIC TAPE06 NO3490LIB DRIVE04 CARTRIDGE TAPE04 NO YES


Task 2

Display information in full detail about the drive named DRIVE04 located in the librarynamed 3490LIB.

Command:query drive 3490lib drive04 format=detailed

Output:

Library Name: 3490LIBDrive Name: DRIVE04Device Type: CARTRIDGE

Device: TAPE04Share: NO

Autoloader: NOLast Update by (administrator): JANET

Last Update Date/Time: 1995-01-13 15:25:03

where:

Library NameSpecifies the name of the library to which the drive is assigned.

Drive NameSpecifies the name assigned to the drive.

Device TypeSpecifies the type of device.

DeviceSpecifies the name of the device that corresponds to the drive.

ShareSpecifies the device is a shared device that can be used by one or more systems.

AutoloaderSpecifies that the device does not hve an automatic cartridge loader that TSM canuse. This parameter only applies to the device type CARTRIDGE.

Last Update by (administrator)Specifies who performed the last update to the drive.

Last Update Date/TimeSpecifies the date and time when the last update occurred.

QUERY DRIVE


Related Commands

Table 155. Commands Related to QUERY DRIVE

Command Description






QUERY DRIVE


QUERY DRMEDIA (Query Disaster Recovery Media)

Use this command to display information about database backup and copy storage poolvolumes. You can also use the command to create a file of executable commands toprocess the volumes.

Note: The MOVE DRMEDIA command always processes copy storage pool volumes(see the description of the COPYSTGPOOL parameter for more information).You can use the SOURCE parameter to control whether the commandprocesses database backup volumes.

Privilege Class

To issue this command, you must have one of the following privilege classes:

v If the CMD parameter is specified and the REQSYSAUTHOUTFILE server optionis set to NO: operator, unrestricted storage, or system privilege.

v If the CMD parameter is specified and the REQSYSAUTHOUTFILE server optionis set to YES (the default): system privilege.

Syntax

ÊÊ Query DRMedia*

volume_name

WHERESTate = All

WHERESTate =AllMOuntableNOTMOuntableCOUrierVAultVAULTRetrieveCOURIERRetrieveREmote

Ê

ÊBEGINDate = date ENDDate = date BEGINTime = time

Ê

ÊENDTime = time COPYstgpool = pool_name

DBBackup = Yes

DBBackup = YesNo

Ê

QUERY DRMEDIA


|

|

||

||

|

ÊFormat = Standard

Format = StandardDetailedCmd

WHERELOCation = locationÊ

Ê

·CMd = ″command″

CMDFilename = file_nameÊ

ÊAPPend = No

APPend = NoYes

LRecl = lreclÊÍ


Specifies the name of the database backup and copy storage pool volumes to bequeried. You can use wildcard characters to specify multiple names. Thisparameter is optional. The default is to query all database backup volumes and allcopy storage pool volumes associated with the storage pools named in theCOPYSTGPOOL parameter or set by SET DRMCOPYSTGPOOL command (ifthere is no COPYSTGPOOL parameter).

WHEREStateSpecifies the state of volumes to be processed. This parameter is optional. Thedefault is ALL. Possible values are:

All Specifies all volumes in all states.

MOuntableVolumes in this state contain valid data and are accessible for onsiteprocessing.

NOTMOuntableVolumes in this state are onsite, contain valid data, and not accessible foronsite processing.

COUrierVolumes in this state are being moved to an offsite location.

VAultVolumes in this state are offsite, contain valid data, and are not accessible foronsite processing.

VAULTRetrieveVolumes in this state do not contain valid data and are at the offsite vault.

COURIERRetrieveVolumes in this state being moved back to the onsite location.

QUERY DRMEDIA


REmoteVolumes in this state contain valid data and are located at the offsite remoteserver.

BEGINDateSpecifies the beginning date used to select volumes. This parameter is optional.Volumes are considered eligible if the MOVE DRMEDIA command has changed thevolume to its current state on or after the specified date. The default is the earliestdate for which volume information exists. You can specify the data using one of thevalues below:






TODAY–7 or –7.

To query volumes beginning with recordschanged to their current state a week ago,you can specify BEGINDATE=TODAY-7 orBEGINDATE=-7.

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






TODAY–7 or –7.

To query volumes beginning with recordschanged to their current state a week ago,you can specify BEGINDATE=TODAY-7 orBEGINDATE=-7.

BEGINTimeSpecifies the beginning time used to select volumes. This parameter is optional.Volumes are considered eligible if the MOVE DRMEDIA command has changed thevolume to its current state on or after the specified time and date. The default ismidnight (00:00:00) on the date specified with the BEGINDATE parameter.




12:33:28


NOW

QUERY DRMEDIA



NOW+HH:MM or+HH:MM


NOW+03:00 or +03:00.

If you issue QUERY DRMEDIA commandat 9:00 with BEGINTIME=NOW+03:00 orBEGINTIME=+03:00. TSM displaysvolumes that were changed to their currentstate at 12:00 on the begin date youspecify.



NOW−03:30 or −03:30.

If you issue QUERY DRMEDIA commandat 9:00 with BEGINTIME=NOW–03:30 orBEGINTIME=–03:30. TSM displaysvolumes that were changed to their currentstate at 5:30 on the begin date youspecify.

ENDTimeSpecifies the ending time used to select volumes. This parameter is optional.Volumes are considered eligible if the MOVE DRMEDIA command has changed thevolume to its current state on or before the specified time and date. The default is23:59:59.




10:30:08


NOW

NOW+HH:MM or+HH:MM


NOW+03:00 or+03:00.

If you issue QUERY DRMEDIA commandat 9:00 with ENDTIME=NOW+03:00 orENDTIME=+03:00, TSM processesvolumes that were changed to their currentstate at 12:00 on the end date you specify.



NOW−03:30 or −03:30

If you issue QUERY DRMEDIA commandat 9:00 with ENDTIME=NOW–03:00 orENDTIME=–03:00, TSM processesvolumes that were changed to their currentstate at 6:00 on the end date you specify.

COPYstgpoolSpecifies the name of the copy storage pool whose volumes are to be processed.This parameter is optional. You can use wildcard characters to specify this name.The copy storage pools specified with this parameter override those specified withthe SET DRMCOPYSTGPOOL command. If you do not specify a copy storage pool

QUERY DRMEDIA


name, all volumes in the specified state, except MOUNTABLE state, areprocessed. See SET DRMCOPYSTGPOOL command for processing the volumesin the MOUNTABLE state.


YesDatabase backup volumes are selected.



YesFull/incremental database backup volumes are selected.


FormatSpecifies the information to be displayed. This parameter is optional. The default isSTANDARD. Possible values are:


DetailedSpecifies that detailed information is displayed.

CmdSpecifies that executable commands are built for the selected volumes. If youspecify FORMAT=CMD, you must also specify the CMD parameter.

WHERELOcationSpecifies the location of the volumes to be queried. This parameter is optional. Themaximum length of the location is 255 characters. Enclose the text in quotationmarks if it contains any blank characters. If you specify a target server name, DRMdisplays all database backup volumes and copy storage pool volumes located onthe target server.

CMdSpecifies the creation of executable commands to process the volume name andlocation obtained by this command. This parameter is optional. You must enclosethe command specification in quotation marks. The maximum length of thisparameter is 255 characters. DRM writes the commands to a file specified by theCMDFILENAME parameter or the SET DRMCMDFILENAME command, orgenerated by the QUERY DRMEDIA command. If the command length is greaterthan 240 characters, it is split into multiple lines and a continuation characters (+)are added. You may need to alter the continuation character according to theproduct that runs the commands.

If you do not specify the FORMAT=CMD parameter, this command will not writecreate any command lines.

QUERY DRMEDIA


stringThe command string. Do not include embedded quotation marks. For example,

VALID:

CMD="CHECKIN LIBVOLUME LIB8MM &VOL STATUS=SCRATCH"

NOT VALID:

CMD=""CHECKIN LIBVOLUME LIB8MM" &VOL STATUS=SCRATCH""

substitutionSpecifies a substitution variable to tell QUERY DRMEDIA to substitute a valuefor the variable. The variables are not case-sensitive, and must not containblank spaces after the ampersand (&). The possible variables are:

&VOLA volume name variable.

&LOCA volume location.

&VOLDSNThe name of the file the server writes into the sequential access medialabels. An example of a copy storage pool tape volume file name usingthe default prefix ADSM is ADSM.BFS. An example of a database backuptape volume file name using a prefix ADSM310 defined with the deviceclass is ADSM310.DBB.

&NLThe new line character. When &NL is specified, QUERY DRMEDIAcommand splits the command at the &NL variable and does not append acontinuation character. You must specify the proper continuation characterbefore the &NL if one is required. If the &NL is not specified and thecommand line is greater than 240 characters, the line is split into multiplelines and continuation characters (+) are added.

CMDFilenameSpecifies the fully qualified name of the file to contain the commands specified withCMD parameter. This parameter is optional. You can specify any valid AS/400 filename of the form lib/filename(memname). If you do not specify a file name, thename from the SET DRMCMDFILENAME is used. If you do not specify a file namewith the SET DRMCMDFILENAME, DRM creates the file exec(cmds) in the currentserver work library (WRKLIB). If you specify a null string (″″), the commands aredisplayed on the console only.

If the operation fails after the command file has been created, the file is notdeleted.

APPendSpecifies whether to overwrite any existing contents of the command file or appendthe commands to the file. This parameter is optional. The default is NO. Possiblevalues are:

No DRM overwrites the contents of the file.

QUERY DRMEDIA


YesDRM appends the commands to the file.

LReclSpecifies the logical record length for the file that contains the command stringspecified by the CMD parameter. This parameter is optional. You can specify alength from 1 to 1550 characters. The default length is 240 characters.

Examples

Task 1

Display all volumes to be given to a courier for offsite storage.

Command:query drmedia wherestate=notmountable format=standard

Output:

Volume Name State Last Update AutomatedDate/Time LibName

--------------- -------------- -------------------- -----------------TAPE01 Not mountable 01/20/1998 14:25:22DBTP01 Not mountable 01/20/1998 14:25:22DBTP03 Not mountable 01/20/1998 14:31:53

Task 2

Display detailed information about all volumes at the vault.

Command:query drmedia wherestate=vault format=detailed

Output:

Volume Name: DBTP02State: Vault

Last Update Date/Time: 01/20/1998 13:29:02Location: Ironmnt

Volume Type: DBBackupCopy Storage Pool Name:

Automated LibName:

where:

Volume NameThe name of the database backup or copy storage pool volume.

StateThe state of the volume.

Last Update Date/TimeThe date and time that the volume was last updated.

QUERY DRMEDIA


||||

LocationThe volume location.

Volume TypeThe type of volume. Possible values are:

DBBackupA full or incremental database backup volume.

DBSnapshotA database snapshot backup volume.

CopyStgPoolA copy storage pool volume.

Copy Storage Pool NameFor a copy storage pool volume, the name of the copy storage pool.

Automated LibNameThe name of the automated library if the volume is in a library.

Related Commands

Table 156. Commands Related to QUERY DRMEDIA

Command Description









QUERY DRMEDIA


QUERY DRMSTATUS (Query DRM System Parameters)

Use this command to display information about the system parameters defined forDisaster Recovery Manager (DRM).

Privilege Class


Syntax

ÊÊ Query DRMSTatus ÊÍ

Parameters

None.

Examples

Task

Display information about the DRM system parameters.

Command:query drmstatus

Output:

Recovery Plan Prefix:Plan Instructions Prefix:

Replacement Volume Postfix: @Primary Storage Pools: PRIM1 PRIM2

Copy Storage Pools: COPY*Not Mountable Location name: Local

Courier Name: FedexVault Site Name: Ironmnt

DB Backup Series expiration days: 30 Day(s)Check Label?: No

Process FILE Device Type?: NoCommand file name:

where:

Recovery Plan PrefixUser-specified prefix portion of the file name for the recovery plan file.

Plan Instructions PrefixUser-specified prefix portion of the file names for the server recovery instructionsfiles.

QUERY DRMSTATUS


Replacement Volume PostfixThe character added to the end of the replacement volume names in the recoveryplan file.

Primary Storage PoolsThe primary storage pools that are eligible for processing by the PREPAREcommand. If this field is blank, all primary storage pools are eligible.

Copy Storage PoolsThe copy storage pools that are eligible for processing by the MOVE DRMEDIA,PREPARE, and QUERY DRMEDIA commands. If this field is blank, all copystorage pools are eligible.

Not Mountable Location NameThe name of the offsite location where the media to be shipped are stored.

Courier NameThe name of the courier used to carry the media to the vault.

Vault Site NameThe name of the vault where the media is stored.

DB Backup Series Expiration DaysThe minimum number of days that must elapse since a database series has beencreated before it is eligible to be expired by the MOVE DRMEDIA command.

Check Label?Whether media labels are read for sequential media volumes checked out by theMOVE DRMEDIA command. Possible values are Yes or No.

Process FILE Device Type?Whether MOVE DRMEDIA or QUERY DRMEDIA commands process databasebackup and copy storage pool volumes associated with a device class with a FILEdevice type. Possible values are Yes or No.

Command File NameThe full path file name that contains the executable commands generated by theMOVE DRMEDIA or QUERY DRMEDIA command.

Related Commands

Table 157. Commands Related to QUERY DRMSTATUS

Command Description

SET DRMCHECKLABEL Specifies whether TSM should read volumelabels during MOVE DRMEDIA commandprocessing.


SET DRMCOURIERNAME Specifies the name of the courier for thedisaster recovery media.


QUERY DRMSTATUS


Table 157. Commands Related to QUERY DRMSTATUS (continued)

Command Description


SET DRMINSTRPREFIX Specifies the prefix portion of the path name forthe recovery plan instructions.






SET DRMVAULTNAME Specifies the name of the vault where DRMmedia is stored.


SET DRMNOTMOUNTABLENAME Specifies the location name of the DRM mediato be sent offsite.

QUERY DRMSTATUS


QUERY ENABLED (Query Enabled Events)

Use this command to display either a list of enabled events or a list of disabled events,whichever is shorter.

Privilege Class


Syntax

ÊÊ Query ENabled CONSOLEACTLOGEVENTSERVERFILETIVOLIUSEREXIT

NODEname = node_nameSERVername = server_name

ÊÍ

Parametersreceiver

Specifies a type of receiver for enabled events. This is a required parameter. Validvalues are:







NODEnameSpecifies a node name to be queried. You can specify NODENAME orSERVERNAME. If neither parameter is specified, the query is for events enabledfor the server running this command.

SERVernameSpecifies a server name to be queried. You can specify NODENAME orSERVERNAME. If neither parameter is specified, the query is for events enabledfor the server running this command.

QUERY ENABLED


||

||||

||||

Examples

Task

Query the server for server events that are enabled for the console. There are 10000possible server events. Either a list of enabled events or disabled events is displayed(whichever list is shorter).

Command:query enabled console

Output:

9998 events are enabled for the CONSOLE receiver. Thefollowing events are DISABLED for the CONSOLE receiver:

|ANR8409, ANR8410

Related Commands

Table 158. Commands Related to QUERY ENABLED

Command Description







QUERY ENABLED


QUERY EVENT (Query Scheduled and Completed Events)

Use this command to check whether schedules were processed successfully. Tominimize the time it takes to process this query, you can limit the output to eventswhose scheduled start times fall within a date and time range.

The QUERY EVENT command may display information about an event for which thereis no event record. For example, if you request information about a scheduled futureevent, this command will display the status of Future for the event even though anevent record has not been created for this event. In addition, this command will displaythe status for past events whose event records have already been removed from thedatabase. In this case, the server returns the status of Uncertain because the actualevent status cannot be determined without the event records.

The QUERY EVENT command takes two forms, depending on whether the queryapplies to scheduled client operations or scheduled administrative commands. Thesyntax and parameters for each form are defined separately.

QUERY EVENT


QUERY EVENT — Client Schedules

Use the QUERY EVENT command to display scheduled and completed events forselected clients.

Privilege Class


Syntax

ÊÊ Query EVent domain_name schedule_nameType = Client

Ê

Ê

·

,

Nodes = node_name

BEGINDate = current_date

BEGINDate = dateÊ

ÊBEGINTime = 00:00

BEGINTime = time

ENDDate = end_date

ENDDate = date

ENDTime = 23:59

ENDTime = timeÊ

ÊEXceptionsonly = No

EXceptionsonly = NoYes

Format = Standard


ÊÍ


Specifies the name of the policy domain to which the schedules belong. You canuse a wildcard character to specify this name.

schedule_name (Required)Specifies the name of the schedule for which events are displayed. You can use awildcard character to specify this name.

Type=ClientSpecifies that the query displays events for client schedules. This parameter isoptional. The default is CLIENT.

NodesSpecifies the name of the client node that belongs to the specified policy domainfor which events are displayed. You can specify multiple client nodes by separatingthe names with commas and no intervening spaces. You can use wildcardcharacters to specify nodes. If you do not specify a client name, events for allclients matching the DOMAINNAME and SCHEDULENAME parameters aredisplayed.



BEGINDateSpecifies the beginning date of the time range for events to be displayed. Allevents scheduled to start during this time are displayed. This parameter is optional.The default is the current date.





TODAY+days or+days


TODAY +3 or +3.



TODAY–7 or –7.

To query events scheduled to start duringthe past seven days, specifyBEGINDATE=TODAY-7ENDDATE=TODAY or BEGINDATE=-7ENDDATE=TODAY.

BEGINTimeSpecifies the beginning time of the range for events to be displayed. All eventsscheduled to start during this time are displayed. This parameter is optional. Thedefault value is 00:00.




10:30:08


NOW

NOW+HH:MM or+HH:MM


NOW+03:00 or +03:00.

If you issue this command at 9:00 to queryevents scheduled to start 3 hours fromnow, you can specify eitherBEGINTIME=NOW+03:00 orBEGINTIME=+03:00. TSM displays eventsat 12:00 on the specified begin date.



NOW−04:00 or −04:00.

If you issue this command at 9:00 to queryevents scheduled to start during the last 4hours, you can specify eitherBEGINTIME=NOW−04:00ENDTIME=NOW or BEGINTIME=−04:00ENDTIME=NOW. TSM displays events at5:00 on the specified begin date.

ENDDateSpecifies the ending date of the time range for events to be displayed. All events



that were schedule to start during this time are displayed. This parameter isoptional. The default is the value used for the BEGINDATE.





TODAY+days or+days


TODAY +3 or+3.



TODAY–8 or –8.

To query events scheduled to start duringa one-week period that ended yesterday,you can specify eitherBEGINDATE=TODAY−8ENDDATE=TODAY−1 or BEGINDATE=−8

ENDDATE=−1.

ENDTimeSpecifies the ending time of the range for events to be displayed. All events thatwere scheduled to start during this time are displayed. This parameter is optional.The default value is 23:59.




10:30:08


NOW

NOW+HH:MM or+HH:MM


NOW+03:00 or +03:00.

If you issue this command at 9:00 to queryevents scheduled to start 3 hours fromnow, you can specify eitherBEGINTIME=NOWENDTIME=NOW+03:00 orBEGINTIME=NOW ENDTIME=+03:00.



NOW−04:00 or −04:00

EXceptionsonlySpecifies the type of information you want on scheduled or completed events. Thisparameter is optional. The default is NO. Possible values are:

No Specifies that the information on past and projected events is displayed.

YesSpecifies that the events that failed or did not process as scheduled aredisplayed.



FormatSpecifies how information is displayed. This parameter is optional. The default isSTANDARD. Possible values are:

StandardSpecifies that partial information for events is displayed.

DetailedSpecifies that complete information for events is displayed.

Examples

Task 1

Display partial information for all events scheduled for DOMAIN1 that did not executesuccessfully. Limit the search to the client named JOE. Limit the events displayed tothose scheduled to occur from February 11, 1997 (02/11/1997) to February 12, 1997(02/12/1997).

Command:query event domain1 * nodes=joe begindate=02/11/1997 enddate=02/12/1997exceptionsonly=yes

Output:

Scheduled Start Actual Start Schedule Node StatusName Name

-------------------- -------------------- --------- ---- ---------02/11/1997 01:00:00 02/11/1997 01:13:55 BACK1 JOE Failed02/12/1997 01:00:00 DAILYBKP JOE Missed

where:

Scheduled StartSpecifies the scheduled start date and time for the event.

Actual StartSpecifies the date and time at which the client began processing the scheduledcommand. No information is displayed if the schedule has not started processing.

Schedule NameSpecifies the name of the schedule that initiated the command.

Node NameSpecifies the client scheduled to perform the operation.

StatusSpecifies whether the startup of the event has been completed. Possible valuesare:

CompletedSpecifies that the scheduled event has been completed.



||

MissedSpecifies that the scheduled startup window for this event has passed and theschedule has not begun.

FailedSpecifies that the client reports a failure in processing the scheduled operationand successive retries have not succeeded.

StartedSpecifies that the event has begun processing.

RestartedSpecifies that the client has retried processing the scheduled operation.

SeveredSpecifies that the communications with the client were severed before theevent could complete.

FutureSpecifies that the beginning of the startup window for the event is in the future.

PendingSpecifies that the QUERY EVENT command was issued during the startupwindow for the event, but processing the scheduled operation has not yetbegun.

UncertainSpecifies that the state of the event cannot be determined. The serverspecifies Uncertain if the QUERY EVENT command does not find an eventrecord. An event record will not be found if the record was deleted or if theserver was unavailable during the scheduled startup window (the schedule wasnever started). Records with Uncertain status do not reside in the database. Ifyou do not want these records to be displayed, either specifyEXCEPTIONSONLY=YES or delete the schedule if it is no longer needed.

Task 2

Display complete information for all events scheduled for processing by client JOE inDOMAIN1 any time from January 16, 1997 (01/16/1997) through January 17, 1997(01/17/1997).

Command:query event domain1 * nodes=joe begindate=01/16/1997 enddate=01/17/1997format=detailed

Output:



Policy Domain Name: DOMAIN1Schedule Name: DAILY_BACKUP

Node Name: JOEScheduled Start: 01/16/1997 01:00:00

Actual Start:Completed:

Status: MissedResult: 0

Policy Domain Name: DOMAIN1Schedule Name: DAILY_BACKUP

Node Name: JOEScheduled Start: 01/16/1997 01:00:00

Actual Start: 01/16/1997 01:13:55Completed: 01/16/1997 01:18:27

Status: CompletedResult: 0

where:

Policy Domain NameSpecifies the name of the policy domain to which the schedule is assigned.

Schedule NameSpecifies the name of the schedule that initiated this event.

Node NameSpecifies the client scheduled to perform the operation.

Scheduled StartSpecifies the scheduled starting date and time for the event.

Actual StartSpecifies the date and time at which the client began processing the scheduledoperation. No information is displayed if the schedule has not started executing.

CompletedSpecifies the date and time the scheduled event is completed.

StatusSpecifies whether the startup of the event has been completed. Possible valuesare:

CompletedSpecifies that the scheduled event has been completed.

MissedSpecifies that the scheduled startup window for this event has passed and theschedule has not begun.

FailedSpecifies that the client reports a failure in executing the scheduled operationand successive retries have not succeeded.

StartedSpecifies that the event has begun processing.

RestartedSpecifies that the client has retried processing the scheduled operation.



SeveredSpecifies that the communications with the client is severed before the eventcan complete.

FutureSpecifies that the beginning of the startup window for the event is in the future.

PendingSpecifies that the QUERY EVENT command was issued during the startupwindow for the event, but processing the scheduled operation has not yetbegun.

UncertainSpecifies that the state of the event cannot be determined. The serverspecifies Uncertain if the QUERY EVENT command does not find an eventrecord. An event record will not be found if the record was deleted or if theserver was unavailable during the scheduled startup window (the schedule wasnever started). Records with Uncertain status do not reside in the database. Ifyou do not want these records to be displayed, either specifyEXCEPTIONSONLY=YES or delete the schedule if it is no longer needed.

ResultSpecifies the return code from the client that identifies whether the schedule hasprocessed successfully. If the return code is something other than a zero, examinethe option string you specified using the OPTIONS parameter or the object stringyou specified using the OBJECTS parameter in the DEFINE SCHEDULEcommand.



QUERY EVENT — Administrative Schedules

Use the QUERY EVENT command to display scheduled and completed events forselected administrative command schedules.

Privilege Class


Syntax

ÊÊ Query EVent schedule_name Type = Administrative Ê

ÊBEGINDate = current_date

BEGINDate = date

BEGINTime = 00:00

BEGINTime = timeÊ

ÊENDDate = begin_date

ENDDate = date

ENDTime = 23:59

ENDTime = timeÊ

ÊEXceptionsonly = No

EXceptionsonly = NoYes

Format = Standard


ÊÍ


Specifies the name of the schedule for which events are displayed. You can usewildcard characters to specify names.

Type=Administrative (Required)Specifies that the query displays events for administrative command schedules.

BEGINDateSpecifies the beginning date of the time range for events to be displayed. Allevents scheduled to start during this time are displayed. This parameter is optional.The default is the current date.








TODAY+days or+days


TODAY +3 or +3.



TODAY–7 or –7.

To query events scheduled to start duringthe past seven days, specifyBEGINDATE=TODAY-7ENDDATE=TODAY or BEGINDATE=-7ENDDATE=TODAY.

BEGINTimeSpecifies the beginning time of the range for events to be displayed. All eventsscheduled to start during this time are displayed. This parameter is optional. Thedefault value is 00:00.




10:30:08


NOW

NOW+HH:MM or+HH:MM


NOW+03:00 or +03:00.

If you issue this command at 9:00 to queryevents scheduled to start 3 hours fromnow, you can specify eitherBEGINTIME=NOW+03:00 orBEGINTIME=+03:00. TSM displays eventsat 12:00 on the specified begin date.



NOW−04:00 or −04:00.

If you issue this command at 9:00 to queryevents scheduled to start during the last 4hours, you can specify eitherBEGINTIME=NOW−04:00ENDTIME=NOW or BEGINTIME=−04:00ENDTIME=NOW. TSM displays events at5:00 on the specified begin date.

ENDDateSpecifies the ending date of the time range for events to be displayed. All eventsthat were schedule to start during this time are displayed. This parameter isoptional. The default is the value used for the BEGINDATE.








TODAY+days or+days


TODAY +3 or+3.



TODAY–8 or –8.

To query events scheduled to start duringa one-week period that ended yesterday,you can specify eitherBEGINDATE=TODAY−8ENDDATE=TODAY−1 or BEGINDATE=−8

ENDDATE=−1.

ENDTimeSpecifies the ending time of the range for events to be displayed. All events thatwere scheduled to start during this time are displayed. This parameter is optional.The default value is 23:59.




10:30:08


NOW

NOW+HH:MM or+HH:MM


NOW+03:00 or +03:00.

If you issue this command at 9:00 to queryevents scheduled to start 3 hours fromnow, you can specify eitherBEGINTIME=NOWENDTIME=NOW+03:00 orBEGINTIME=NOW ENDTIME=+03:00.



NOW−04:00 or −04:00

EXceptionsonlySpecifies the type of information you want on scheduled or completed events. Thisparameter is optional. The default is NO. Possible values are:

No Specifies that the information on past and projected events is displayed.

YesSpecifies that the events that failed or did not process as scheduled aredisplayed.


StandardSpecifies that partial information for events is displayed.



DetailedSpecifies that complete information for events is displayed.

Examples

Task

Display partial information for all events scheduled for an administrative schedulenamed DOSADMIN. Limit the query to events scheduled for March 30, 1997(03/30/1997).

Command:query event dosadmin type=administrative begindate=03/30/1997enddate=03/30/1997

Output:

Scheduled Start Actual Start Schedule StatusName

-------------------- -------------------- --------- ---------03/30/1997 00:00:00 03/30/1997 00:00:01 DOSADMIN Completed03/30/1997 04:00:00 03/30/1997 04:00:01 DOSADMIN Completed03/30/1997 12:00:00 DOSADMIN Future03/30/1997 16:00:00 DOSADMIN Future

where:

Scheduled StartSpecifies the scheduled starting date and time for the event.

Actual StartSpecifies the date and time at which the client began processing the scheduledoperation. No information is displayed if the schedule has not started executing.

Schedule NameSpecifies the name of the schedule that initiated this event.

StatusSpecifies whether the startup of the event has been completed.



Related Commands

Table 159. Commands Related to QUERY EVENT

Command Description


DELETE EVENT Deletes event records prior to a specified dateand time.


SET RANDOMIZE Specifies the randomization of start times withina window for schedules in client-polling mode.



QUERY EVENTRULES (Query Rules for Server or Client Events)

Use this command to display the history of events that are enabled or disabled by aspecified receiver for the server or for a client node.

Privilege Class


Syntax

ÊÊ Query EVENTRUles

·

*

,


NODEname = node_nameSERVername = server_name

ÊÍ

Parametersreceivers

Specifies the name of one or more receivers for enabled events. This parameter isoptional.

You can use a wildcard character to specify all receivers.

Valid values are:

CONSOLESpecifies the standard console as a receiver.






NODEnameSpecifies a node name to be queried. You can use a wildcard character to specify

QUERY EVENTRULES


||

a name. You can specify NODENAME or SERVERNAME. If neither parameter isspecified, the query is for event rules for the server running this command.

SERverSpecifies a server name to be queried. You can use a wildcard character to specifya name. You can specify NODENAME or SERVERNAME. If neither parameter isspecified, the query is for event rules for the server running this command.

Examples

Task 1

Display the history of client events enabled or disabled for the server console andactivity log receivers.

Command:query eventrules console,actlog nodename=*

Output:

Date/Time Client Event Rules-------------------- ----------------------------------------------------05/29/97 13:39:58 ENABLE EVENTS CONSOLE ANE4001 NODENAMES=JEE05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4962 NODENAMES=JEE05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4963 NODENAMES=JEE05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4965 NODENAMES=JEE05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4966 NODENAMES=JEE05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4967 NODENAMES=JEE05/30/97 13:46:25 DISABLE EVENTS ACTLOG ANE4968 NODENAMES=JEE05/30/97 14:24:20 ENABLE EVENTS CONSOLE ANE4015 NODENAMES=RON05/30/97 14:24:50 ENABLE EVENTS CONSOLE ANE4026 NODENAMES=DONNA05/30/97 14:25:59 ENABLE EVENTS CONSOLE ANE4015 NODENAMES=DONNA

Task 2

Display the history of server events enabled or disabled for all receivers.

Command:query eventrules

Output:

Date/Time Server Event Rules-------------------- ----------------------------------------------------05/22/97 14:35:13 ENABLE EVENTS CONSOLE ANR257805/30/97 14:29:31 ENABLE EVENTS CONSOLE ANR027205/30/97 14:31:46 ENABLE EVENTS USEREXIT ANR013005/30/97 14:31:54 ENABLE EVENTS USEREXIT ANR013105/30/97 14:50:28 ENABLE EVENTS USEREXIT ANR0266

Related Commands

Table 160. Commands Related to QUERY ENABLED

Command Description


QUERY EVENTRULES


||||

Table 160. Commands Related to QUERY ENABLED (continued)

Command Description





QUERY EVENTRULES


QUERY EVENTSERVER (Query the Event Server)

Use this command to display the name of the event server.

Privilege Class


Syntax

ÊÊ Query EVENTSERVer ÊÍ

Examples

Task

Display the name of the event server.

Command:query eventserver

Related Commands

Table 161. Commands Related to QUERY EVENTSERVER

Command Description


DEFINE EVENTSERVER Defines a server as an event server.


DELETE EVENTSERVER Deletes reference to the event server.



QUERY EVENTSERVER


QUERY EXIT (Query Information on One or All Exits)

Use this command to display information on one or all of the defined exits.

Privilege Class


Syntax

ÊÊ Query EXITMOuntDIsmountDEletionEXpiration

Format = Standard


ÊÍ

Parametersexittype

Specifies which exit program to query. This parameter is optional. If you do notspecify a value for this parameter, all exit programs display. The values are:

MOuntSpecifies the mount exit program.

DIsmountSpecifies the dismount exit program.

DEletionSpecifies the deletion exit program.

EXpirationSpecifies the expiration exit program.

FormatSpecifies how the information displays. This parameter is optional. The defaultvalue is STANDARD. The values are:

StandardSpecifies that partial information displays for the defined exit.

DetailedSpecifies that complete information displays for the defined exit.

Examples

Task 1

Display information about all exit programs associated with your server.

QUERY EXIT


Command:Query EXIT

Exit Type Exit Name Resolved Last ModifiedDate/Time

---------- ----------------- -------- -------------------MOUNT ADSMEXITS/MOUNTC Yes 11/01/1994 09:38:30DISMOUNT ADSMEXITS/DSMNTC Yes 10/31/1994 12:05:57DELETION ADSMEXITS/DELTNC Yes 10/31/1994 12:03:19EXPIRATION ADSMEXITS/EXPIRC Yes 10/31/1994 12:03:18


Task 2

Display information in full detail about the mount exit program.

Command:Query EXIT MOunt Format=Detailed

Exit Type: MOUNTExit Name: ADSMEXITS/ADSMMOUNTResolved: Yes

Last Modified Date/Time: 11/01/1994 09:38:30Last Update by (administrator): ADSMADMIN


where:

Exit TypeSpecifies the type of exit program.

Exit NameSpecifies the fully qualified AS/400 name of the exit program.

ResolvedSpecifies whether or not the server was able to successfully resolve the exitprogram. If this column does not contain YES, the server will not be able to invokethe exit program.

Last ModifiedSpecifies the date and time when the *PGM object on the AS/400 was lastmodified. This field can be used to determine if the server is using the latestversion of the exit program.



QUERY EXIT


Related Commands

Table 162. Commands Related to QUERY EXIT

Command Description







QUERY EXIT


QUERY FILESPACE (Query One or More File Spaces)

Use this command to display information about file spaces that belong to a client node.The information displayed reflects data as of the last incremental backup.

Privilege Class


Syntax

ÊÊ Query FIlespace* *

*node_name

file_space_name

Ê

ÊFormat = Standard


ÊÍ

Parametersnode_name

Specifies the client node to which the file space belongs. Use wildcard charactersto specify this name. This parameter is optional. The default is all client nodesnames. You must specify a value for this parameter if you specify a file name.

file_space_nameSpecifies the name of the file space to be queried. Use wildcard characters tospecify this name. This parameter is optional. If a value is not specified, all filespaces are queried.

File space names are case-sensitive. You can use the QUERY FILESPACEcommand to determine the correct capitalization for the file space to be queried.


StandardSpecifies that partial information is displayed for the specified file space.

DetailedSpecifies that complete information is displayed for the specified file space.

QUERY FILESPACE


Examples

Task 1

Query all file spaces associated with all client nodes.

Command:query filespace

Output:

Node Name Filespace Platform Filespace Capacity Pct UtilName Type (MB)

----------- ----------- -------- --------- -------- -----JOEOS2 OS2 OS/2 HPFS 58.0 32.0JOEOS2 D_DRIVE OS/2 HPFS 57.0 30.8

Task 2

Display detailed information on the OS2 file space that belongs to the client nodeJOEOS2.

Command:query filespace joeos2 OS2 format=detailed

Output:

Node Name: JOEOS2Filespace Name: OS2

Platform: OS/2Filespace Type: HPFSCapacity (MB): 58.0

Pct Util: 99.7Last Backup Start Date/Time:

Days Since Last Backup Started:Last Backup Completion Date/Time:Days Since Last Backup Completed:

where:

Node NameSpecifies the name of the client node.

Filespace NameSpecifies the name of the file space for the client node.

PlatformSpecifies the platform for the client node.

Filespace TypeSpecifies the type of file space.

Capacity (MB)Specifies the amount of space, in megabytes, assigned to this file space on theclient node.

QUERY FILESPACE


Pct UtilSpecifies the percentage of the file space that is occupied.

Last Backup Start Date/TimeSpecifies the start date and time of the last incremental backup of the file space.

Days Since Last Backup StartedSpecifies the number of days since the start of the last incremental backup of thefile space.

Last Backup Completion Date/TimeSpecifies the completion date and time of the last incremental backup of the filespace.

Days Since Last Backup CompletedSpecifies the number of days since the completion of the last incremental backupof the file space.

Related Commands

Table 163. Commands Related to QUERY FILESPACE

Command Description




RENAME FILESPACE Renames a client filespace on the server.


QUERY FILESPACE


QUERY LIBRARY (Query a Library)

Use this command to display information about libraries.

Privilege Class


Syntax

ÊÊ Query LIBRarylibrary_name

Format = Standard


ÊÍ


Specifies the name of the library to be queried. You can use wildcards to specifynames. This parameter is optional.


StandardSpecifies that partial information is displayed for the library.

DetailedSpecifies that complete information displays for the library.

Examples

Task 1

Display information about the libraries attached to your server.

Command:query library

Output:

QUERY LIBRARY


Library Name Library Drive Media Library CategoryType Selection Device

------ ------- -------- -------- --------HOME USRDFN Exit8MMLIB MANUAL AutomaticMANLIB MANUAL OperatorROBOLIB AS400MLB AS400MLB ROBOT TUC400I/8MMTAPES


Task 2

Display information in full detail about the library namedROBOLIB.

Command:query library robolib format=detailed

Output:

Library Name: ROBOLIBLibrary Type: AS400MLB

Drive Selection: AS400MLBMedia Library Device: ROBOT

Category:Last Update by (administrator): DOCTOR_MIKE

Last Update Date/Time: 1996-12-05 15:24:53

where:

Library NameSpecifies the name of the library to which the drive is assigned.

Library TypeSpecifies the type of library to which the drive is assigned.

Drive SelectionSpecifies whether TSM (automatic), a mount exit program, or a mount operatorperforms the drive selection.

For users of AS/400 Version 3 Release 6 or any subsequent release, automatic isonly applicable to manual libraries.

Media Library DeviceSpecifies the name that corresponds to the Media Library Device.

CategorySpecifies the system name and category name for this library.



QUERY LIBRARY


Related Commands

Table 164. Commands Related to QUERY LIBRARY

Command Description




QUERY LIBRARY


QUERY LIBVOLUME (Query a Library Volume)

Use this command to display information about one or more volumes that are checkedinto an automated library for use by the TSM server.

Privilege Class


Syntax

ÊÊ Query LIBVolume*

library_name

*

volume_nameÊÍ


Specifies the name of the library. You can use wildcard characters to specify thisname. This parameter is optional. The default is all libraries.

volume_nameSpecifies the volume name. You can use wildcard characters to specify this name.This parameter is optional. The default is all volumes.

Examples

Task

Display information about all of the volumes that are checked into the library namedAUTO.

Command:query libvolume auto

Output:

Library Name Volume Name Status Last Use Access------------ ----------- ------- --------- ------------AUTO 154VAM Private AvailableAUTO 154VEB Private Data AvailableAUTO 154VTG Private Available

Library NameSpecifies the name of the library where the storage volume is located.

Volume NameSpecifies the name of the storage volume.

QUERY LIBVOLUME


||||||||

StatusSpecifies the status of the storage volume. If the status is Private, the volume isbeing used by TSM. If the status is Scratch, the volume is available for use.

Last UseSpecifies the type of data on the storage volume. This field applies only to storagevolumes with the Private status.

AccessSpecifies the access state of the storage volume.

Related Commands

Table 165. Commands Related to QUERY LIBVOLUME

Command Description







QUERY LIBVOLUME


||

QUERY LICENSE (Display License Information)

Use this command to display license audit, license terms, and compliance information.

Privilege Class


Syntax

ÊÊ Query LICense ÊÍ

Parameters

None.

Examples

Task

Display license audit, license terms, and compliance information.

Command:query license

Output:

Last License Audit: 06/17/1998 11:59:53Registered Client Nodes: 36

Licensed Client Nodes: 10Are Open Systems Environment clients registered ?: No

Are Open Systems Environment clients licensed ?: YesIs space management in use ?: No

Is space management licensed ?: YesIs disaster recovery manager in use ?: No

Is disaster recovery manager licensed ?: YesAre Enterprise Administration services in use ?: NoAre Enterprise Administration services licensed?: Yes

Are Server-to-Server Virtual Volumes in use?: NoAre Server-to-Server Virtual Volumes licensed?: Yes

Server License Compliance: Valid

where:

Last License AuditSpecifies the date and time of the last license audit. The remainder of thedisplayed information is valid as of this date and time.

Registered Client NodesSpecifies the number of registered client nodes that are defined to the server.

QUERY LICENSE


Licensed Client NodesSpecifies the total number of client nodes that can be registered as defined in thelicense.

Are Open Systems Environment clients registered?Specifies whether Open Systems Environment clients are registered with theserver.

Are Open Systems Environment clients licensed?Specifies whether the server is licensed to support Open Systems Environmentclients.

Is space management in use on the server?Specifies whether the server is implementing space management.

Is space management licensed on the server?Specifies whether the server is licensed for space management.

Is disaster recovery manager in use on the server?Specifies whether the server is implementing the TSM Disaster Recovery Manager(DRM).

Is disaster recovery manager licensed on the server?Specifies whether the server is licensed for the DRM.

Are server-to-server virtual volumes in use?Specifies whether the source server is storing sequential volumes as objects on aremote server.

Are server-to-server virtual volumes licensed?Specifies whether the source server is licensed to store sequential volumes asobjects on a remote server.

Server License ComplianceSpecifies whether the TSM server is in compliance (Valid) or out of compliance(FAILED) with the license terms.

Related Commands

Table 166. Commands Related to QUERY LICENSE

Command Description






QUERY LICENSE


QUERY LOG (Display Information on the Recovery Log)

Use this command to display information about the recovery log.

Privilege Class


Syntax

ÊÊ Query LOGFormat = Standard


ÊÍ

ParametersFormat




Examples

Task 1

Display information about the recovery log.

Command:query log

Output:

Available Assigned Maximum Maximum Page Total Used Pct Max.Space Capacity Extension Reduction Size Usable Pages Util Pct(MB) (MB) (MB) (MB) (bytes) Pages Util

--------- -------- --------- --------- ------- ----- ----- ----- -----16 8 8 4 4,096 1,536 187 12.2 12.8

See Task 2 for definitions.

Task 2

Display detailed information about the recovery log.

QUERY LOG


Command:query log format=detailed

Output:

Available Space (MB): 16Assigned Capacity (MB): 8Maximum Extension (MB): 08Maximum Reduction (MB): 4

Page Size (bytes): 4,096Total Usable Pages: 1,536

Used Pages: 187Pct Util: 12.2

Max. Pct Util: 12.8Physical Volumes: 3

Log Pool Pages: 64Log Pool Pct. Util: 0.31Log Pool Pct. Wait: 0.00

Cumulative Consumption (MB): 0.60Consumption Reset Date/Time: 05/31/1996 13:02:42

where:

Available Space (MB)Specifies the amount of space available in the recovery log, in megabytes.

Assigned Capacity (MB)Specifies the assigned storage capacity for the recovery log, in megabytes.

Maximum Extension (MB)Specifies the maximum amount of storage space that you can extend the recoverylog, in megabytes.

Maximum Reduction (MB)Specifies the maximum amount of storage space by which you can reduce therecovery log, in megabytes.

Page Size (bytes)Specifies the page size, in bytes.

Total Usable PagesSpecifies the total number of pages available for transactions in the recovery log.

Used PagesSpecifies the total number of pages currently in use by the recovery log.

Pct UtilSpecifies the current utilization as a percentage value of the assigned capacity.

Max. Pct UtilSpecifies the maximum occupancy for the recovery log, as a percentage of theavailable space. This value specifies the highest capacity occupied by the recoverylog since the last reset of this statistic.

Physical VolumesSpecifies the total number of recovery log volumes defined to the recovery log,including volume copies.

QUERY LOG


Log Pool PagesSpecifies the number of pages in the recovery log buffer pool.

Log Pool Pct. UtilSpecifies, as a percentage of all recovery log buffer pool pages, the number ofbuffer pool pages that are used to write changes to the recovery log after atransaction is committed.

Log Pool Pct. WaitSpecifies, as a percentage of all recovery log buffer pool requests, the number ofrequests for a buffer pool page that is not available (because all buffer pool pagesare in use).

Cumulative Consumption (MB)Specifies the amount of log space used by the server since the last reset of thisstatistic, in megabytes.

Consumption Reset Date/TimeSpecifies the date and time of the last reset of the cumulative consumption statisticfor the recovery log.

Related Commands

Table 167. Commands Related to QUERY LOG

Command Description







RESET LOGCONSUMPTION Resets the statistic on recovery log space used.

RESET LOGMAXUTILIZATION Resets the maximum utilization statistic for therecovery log.

QUERY LOG


QUERY LOGVOLUME (Display Information on One or More Log Volumes)

Use this command to display information about recovery log volumes and volumecopies.

Privilege Class


Syntax

ÊÊ Query LOGVolume*

volume_name

Format = Standard


ÊÍ


Specifies the name of the recovery log volume. This parameter is optional. You canuse wildcard characters to specify this name. If you do not specify a volume name,all volumes are displayed.




Examples

Task 1

Display information about recovery log volume named log.1.

Command:query logvolume /dbvol/log.1

Output:

QUERY LOGVOLUME


|

Volume Name Copy Volume Name Copy Volume Name Copy(Copy 1) Status (Copy 2) Status (Copy 3) Status---------------- ------ ------------ ------ ----------- ------/QUSRADSM/DBVOL.LOG.1 Sync'd Undef- Undef-LOG.1) ined ined


Task 2

Display detailed information about the recovery log volume named log.1.

Command:query logvolume /dbvol/log.1 format=detailed

Output:

Volume Name (Copy 1):/QUSRADSM/DBVOL/LOG.1.LOG.1Copy Status: Sync'd



Available Space (MB): 36Allocated Space (MB): 36

Free Space (MB): 0

where:

Volume Name (Copy n)Specifies the name of the recovery log volume. The output displays status of thethree volume copies (Copy 1, Copy 2, and Copy 3).

Copy StatusSpecifies the status of the recovery log volume. Possible values are:


StaleThe volume is not synchronized with the other volumes in the recovery log andcannot be used for storage.

Sync’dThe volume is synchronized with the other volumes in the recovery log andcan be used for storage.


Available Space (MB)Specifies the total amount of space that is available, both allocated and free, forthe recovery log, in megabytes.

Allocated Space (MB)Specifies the amount of space allocated for the recovery log, in megabytes.

QUERY LOGVOLUME


||||||

|

|||||||||

Free Space (MB)Specifies the amount of unassigned space in the recovery log that can be allocatedfor use, in megabytes.

Related Commands

Table 168. Commands Related to QUERY LOGVOLUME

Command Description





QUERY LOGVOLUME


QUERY MACHINE (Query Machine Information)

Use this command to display information for one or more machines. You can use thisinformation to recover TSM client machines in case of a disaster.


TSM displays information for multiple machines in the following order:

v According to the priority specified.

v Within a priority, according to the specified location and machine name.

Privilege Class


Syntax

ÊÊ Query MAchine*

machine_name BUilding = buildingÊ

ÊFLoor = floor ROom = room PRIority = priority

Ê

ÊADSMServer = Yes

No

Format = Standard

Format = StandardDetailedRECOVERYInstructionsCHaracteristics

ÊÍ

Parametersmachine_name

Specifies the name of one or more machines to be queried. You can use wildcardcharacters to specify this name. This parameter is optional. The default is allmachines that meet the specified criteria.

BUildingSpecifies the name or number of the building that the machines are in. Thisparameter is optional. Enclose the text in quotation marks if it contains any blankcharacters.

FLoorSpecifies the name or number of the floor that the machines are on. Thisparameter is optional. Enclose the text in quotation marks if it contains any blankcharacters.

QUERY MACHINE


ROomSpecifies the name or number of the room that the machines are in. Thisparameter is optional. The text can be up to 16 characters. Enclose the text inquotation marks if it contains any blank characters.

PRIoritySpecifies the priority number of the machines. This parameter is optional.

ADSMServerSpecifies if the machine contains a TSM server. This parameter is optional. Thedefault is to display any machines that meet the other criteria. Possible values are:

YesThe machine contains a TSM server.

No The machines do not contain a TSM server.


StandardTSM displays partial information for the machines.

DetailedTSM displays all information for the machines.

RECOVERYInstructionsTSM displays only machine recovery instructions. This option is valid onlywhen querying a specific machine.

CHaracteristicsTSM displays only machine characteristics. This option is valid only whenquerying a specific machine.

Examples

Task 1

Display information for a machine named MACH1.

Command:query machine MACH1

Output:

Machine Machine Building Floor Room Node Name RecoveryName Priority Media Name------- -------- -------- ----- ----- --------- ----------MACH1 1 21 2 2929 VIRGINIA RECMED1

Task 2

Display detailed information for all priority 1 machines on the second floor of building21.

QUERY MACHINE


Command:query machine * building=21 floor=2 priority=1 format=detailed

Output:

Machine Name: MACH1Machine Priority: 1

Building: 21Floor: 2Room: 2929

ADSM Server?: YesDescription: ADSM server machine

Node Name: VIRGINIARecovery Media Name: RECMED1

Characteristics?: YesRecovery Instructions?: Yes

where:

Machine NameThe name of the machine.

Machine PriorityThe recovery priority of the machine.

BuildingThe building in which the machine is located.

FloorThe floor on which the machine is located.

RoomThe room in which the machine is located.

ADSM Server?Whether the machine contains a TSM server.

DescriptionA description of the machine.

Node NameThe TSM client nodes associated with this machine.

Recovery Media NameThe recovery media associated with this machine.

Characteristics?Whether the characteristics text of the machine is stored in the database.

Recovery Instructions?Specifies whether recovery instructions text for a machine is stored in the TSMdatabase.

QUERY MACHINE


Related Commands

Table 169. Commands Related to QUERY MACHINE

Command Description







QUERY MACHINE


QUERY MGMTCLASS (Query a Management Class)

Use this command to display information about management classes.

Privilege Class


Syntax

ÊÊ Query MGmtclass* * *

* *domain_name

*policy_set_name

class_name

Ê

ÊFormat = Standard


ÊÍ


Specifies the policy domain associated with the management class to query. Thisparameter is optional. You can use wildcard characters to specify this name. If youdo not specify a value for this parameter, management classes in all policydomains are queried. You must specify this parameter when querying an explicitlynamed management class.

policy_set_nameSpecifies the policy set associated with the management class to query. Thisparameter is optional. You can use wildcard characters to specify this name. If youdo not specify a value for this parameter, management classes in all policy sets arequeried. You must specify this parameter when querying an explicitly namedmanagement class.

class_nameSpecifies the management class to query. This parameter is optional. You can usewildcard characters to specify this name. If you do not specify a value for thisparameter, all management classes are queried.



QUERY MGMTCLASS



Examples

Task 1

Query all management classes for all policy domains. Create the output in standardformat.

Command:query mgmtclass

Output:

Policy Policy Mgmt Default DescriptionDomain Set Name Class MgmtName Name Class ?--------- --------- --------- --------- ---------------------EMPLOYEE- ACTIVE ACTIVEFI- Yes Modified default_RECORDS LES management classEMPLOYEE- HOLIDAY ACTIVEFI- Yes Modified default_RECORDS LES management classEMPLOYEE- HOLIDAY FILEHIST- No Test modified_RECORDS ORY management classEMPLOYEE- VACATION ACTIVEFI- Yes Original default_RECORDS LES management classEMPLOYEE- VACATION FILEHIST- No Test modified_RECORDS ORY management classPROG1 SUMMER MCLASS1 No Technical Support

Mgmt ClassPROG2 SUMMER MCLASS1 No Technical Support

Mgmt ClassSTANDARD ACTIVE STANDARD Yes Installed default

management classSTANDARD STANDARD STANDARD Yes Installed default

management class


Task 2

Query the ACTIVEFILES management class that is assigned to the VACATION policyset of the EMPLOYEE_RECORDS policy domain. Create the output in detailed format.

Command:query mgmtclass employee_records vacation activefiles format=detailed

Output:

QUERY MGMTCLASS


Policy Domain Name: EMPLOYEE_RECORDSPolicy Set Name: VACATIONMgmt Class Name: ACTIVEFILES

Default Mgmt Class ?: YesDescription: Installed default management class

Space Management Technique: NoneAuto-Migrate on Non-Use: 0

Migration Requires Backup?: YesMigration Destination: SPACEMGPOOL


Managing Profile: EMPLOYEE

where:

Policy Domain NameThe policy domain.

Policy Set NameThe policy set.

Mgmt Class NameThe management class.

Default Mgmt Class?Whether the management class is the default management class for the policy set.

DescriptionThe description of the management class.

Space Management TechniqueThe space management technique for the management class, for Tivoli SpaceManager clients (also known as HSM clients).

Auto-Migrate on Non-UseThe number of days that must elapse since a file was last accessed before it iseligible for automatic migration from HSM clients.

Migration Requires Backup?Whether a backup version of a file must exist before a file can be migrated fromHSM clients.

Migration DestinationThe storage pool that is the destination for files migrated from HSM clients.

Last Update by (administrator)The administrator or server that most recently updated the management class. Ifthis field contains $$CONFIG_MANAGER$$, the management class is associatedwith a domain that is managed by the configuration manager.

Last Update Date/TimeThe date and time when the management class was most recently defined orupdated.

Managing ProfileThe profile or profiles to which the managed server subscribed to get the definitionof this management class.

QUERY MGMTCLASS


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

||||

|||

Related Commands

Table 170. Commands Related to QUERY MGMTCLASS

Command Description







QUERY MGMTCLASS


||

QUERY MOUNT (Display Information on Mounted Sequential Access Volumes)

Use this command to display information about the status of one or more sequentialaccess volumes that are mounted.

Privilege Class


Syntax

ÊÊ Query MOunt*

volume_nameÊÍ


Specifies the name of the mounted sequential access volume. You can usewildcard characters to specify this name. This parameter is optional. The default isall mounted volumes.

Examples

Task

Display information on the mounted sequential media volume named WPD000.

Command:query mount wpd000

Output:

ANR8331I 8MMTAPE volume WPD000 is mounted R/Win drive 8MM.1 (), status: DISMOUNTING.mountsANR8334I 1 volume(s) found.

Related Commands

Table 171. Commands Related to QUERY MOUNT

Command Description


REPLY Allows a request to continue processing.

QUERY MOUNT


QUERY NODE (Query Nodes)

Use this command to display information about one or more registered nodes.

Privilege Class


Syntax

ÊÊ Query Node*

node_name

·

,

DOmain = domain_name

Ê

ÊFormat = Standard


Type = Client

Type = ServerClientAny

ÊÍ

Parametersnode_name

Specifies the name of the client node to be queried. You can use wildcardcharacters to specify this name. All matching client nodes are queried. If you do notspecify a value for this parameter, all client nodes are queried. The parameter isoptional.

DOmainSpecifies a list of policy domains that limit the client node query. Only nodes thatare assigned to one of the specified policy domains are displayed. This parameteris optional. Separate the items in the list by commas, with no intervening spaces.You can use wildcard characters to specify a domain. All clients assigned to amatching domain are displayed. If you do not specify a value for this parameter, allpolicy domains are included in the query.


StandardSpecifies that partial information is displayed for the specified client nodes.

DetailedSpecifies that complete information is displayed for the specified client nodes.

TypeSpecifies the type of node to include in the query results. The parameter isoptional. The default value is CLIENT. Possible values are:

QUERY NODE


ClientSpecifies client nodes that are backup-archive or HSM clients.

ServerSpecifies client nodes that are other TSM servers.

AnySpecifies any type of node.

Examples

Task 1

Display information on all registered client nodes.

Command:query node

Output:

Node Name Platform Policy Domain Days Since Days Since Locked?Name Last Password

Access Set--------- -------- -------- --------- ---------- ---------CLIENT1 AIX STANDARD 6 6 NoGEORGE AIX STANDARD 1 1 NoJANET AIX STANDARD 1 1 NoJOEOS2 (?) STANDARD <1 <1 NoTOMC (?) STANDARD 1 1 No

where:


PlatformSpecifies the platform of the client node. A question mark (?) is displayed until theclient node first accesses the server and reports its platform type.

Note: After a node initially accesses the server and reports its platform type, theplatform type will be constant, even if the node platform subsequentlychanges.

Policy Domain NameSpecifies the name of the policy domain to which the client node is assigned.

Days Since Last AccessSpecifies the number of days that have elapsed since the last time the client nodeaccessed the server.

Days Since Password SetSpecifies the number of days that have elapsed since the client node’s passwordwas set.

QUERY NODE


Locked?Specifies whether the client node is locked out of TSM.

Task 2

Display complete information on the client node named JOE.

Command:query node joe format=detailed

Output:

Node Name: JOEPlatform: WinNT

Client OS Level: 4.00Client Version: Version 3, Release 1, Level 3.0

Policy Domain Name: STANDARDLast Access Date/Time: 05/19/1999 18:55:46Days Since Last Access: 6Password Set Date/Time: 05/19/1999 18:26:43Days Since Password Set: 6

Invalid Sign-on Count: 0Locked?: NoContact:

Compression: Client's ChoiceArchive Delete Allowed?: YesBackup Delete Allowed?: NoRegistration Date/Time: 05/19/1999 18:26:43

Registering Administrator: SERVER_CONSOLELast Communication Method Used: Tcp/Ip

Bytes Received Last Session: 108,731Bytes Sent Last Session: 698

Duration of Last Session (sec): 0.00Pct. Idle Wait Last Session: 0.00Pct. Comm. Wait Last Session: 0.00Pct. Media Wait Last Session: 0.00

Optionset:URL:http://JOE:2121

Node Type: ClientPassword Expiration Period: 60

where:


PlatformSpecifies the platform of the client node. A question mark (?) is displayed until theclient node first accesses the server and reports its platform type.

Note: After a node initially accesses the server and reports its platform type, theplatform type will be constant, even if the node platform subsequentlychanges.

Client OS LevelSpecifies the level of the client’s operating system.

QUERY NODE


Client VersionSpecifies the version of the client you have installed.

Policy Domain NameSpecifies the client node’s assigned policy domain.

Last Access Date/TimeSpecifies the last date and time that the client node accessed the server.


Password Set Date/TimeSpecifies the date and time that the client node’s password was set.

Days Since Password SetSpecifies the number of days that have elapsed since the client node’s passwordwas set.

Invalid Sign-on CountSpecifies the number of invalid sign-on attempts that have been made since thelast successful sign-on. This count can only be non-zero when an invalid passwordlimit (SET INVALIDPWLIMIT) is greater than zero. When the number of invalidattempts equals the limit set by the SET INVALIDPWLIMIT command, the node islocked out of the system.

Locked?Specifies whether the client node is locked out of TSM.

ContactSpecifies any contact information for the client node.

CompressionSpecifies whether compression is enabled.

Archive Delete Allowed?Specifies whether the client node can delete its own archive files.

Backup Delete Allowed?Specifies whether the client node can delete its own backup files.

Registration Date/TimeSpecifies the date and time that the client node was registered.

Registering AdministratorSpecifies the name of the administrator that registered the client node.

Last Communication Method UsedSpecifies the communication method that was last used by the client node.

Bytes Received Last SessionSpecifies the number of bytes received by the server during the last client nodesession.

Bytes Sent Last SessionSpecifies the number of bytes sent to the client node.

QUERY NODE


Duration of Last Session (sec)Specifies how long the most recent client node session lasted.

Pct. Idle Wait Last SessionSpecifies the percentage of the total session time that the client was not performingany functions.

Pct. Comm. Wait Last SessionSpecifies the percentage of the total session time that the client waited for acommunication response from the server.

Pct. Media Wait Last SessionSpecifies the percentage of the total session time that the client waited for aremovable volume to be mounted.

OptionsetSpecifies the name of the client option set.

URLSpecifies the client’s Uniform Resource Locator (URL) address that theadministrator can contact from the administrative web interface.

Node TypeSpecifies the type of client node. The value is either Client (backup-archive client orHSM client) or Server (a TSM server).

Password Expiration PeriodSpecifies the client node’s password expiration period.

Related Commands

Table 172. Commands Related to QUERY NODE

Command Description






RENAME NODE Changes the name for an existing user thatbelongs to a specific policy domain.

SET INVALIDPWLIMIT Sets the number of invalid logon attemptsbefore a node is locked.



QUERY NODE


||

Table 172. Commands Related to QUERY NODE (continued)

Command Description


QUERY NODE


QUERY OCCUPANCY (Query Client File Spaces in Storage Pools)

Use this command to display information on where client file spaces are stored andhow much space they occupy.

Privilege Class


Syntax

ÊÊ Query OCCupancy* *

*node_name

file_space_name

STGpool = pool_nameÊ

ÊDEVclass = device_class_name

Type = ANY

Type = ANYBackupArchiveSPacem

ÊÍ

Parametersnode_name

Specifies the node that owns the file spaces that you want to locate. Thisparameter is optional. You can use wildcard characters to specify names. If you donot specify a value for this parameter, all nodes are queried.

file_space_nameSpecifies the file space that you want to locate. This parameter is optional. You canuse wildcard characters to specify names. If you do not specify a value for thisparameter, all file spaces are queried. You must specify a node name if you specifya file space name.

STGpoolSpecifies the storage pool to query for files from the specified file space. Thisparameter is optional. You can use wildcard characters to specify names. If you donot specify a value for this parameter, all storage pools are queried.

DEVclassSpecifies the device class associated with the devices where the file spaces arestored. This parameter is optional. You can use wildcard characters to specifynames. If you do not specify a value for this parameter, storage pools associatedwith any device class are queried.

QUERY OCCUPANCY


TypeSpecifies the types of files to query in the file spaces. This parameter is optional.The default value is ANY. Possible values are:

ANYSpecifies that all types of files are queried: backup versions of files, archivedcopies of files, and files migrated from HSM clients.

BackupSpecifies that backup files are queried.

ArchiveSpecifies that archive files are queried.

SPacemSpecifies that space-managed files (files migrated from HSM clients) arequeried.

Examples

Task 1

Display information on where all file spaces assigned to the node named DAISY arestored.

Command:query occupancy daisy

Output:

Node Name Type Filespace Storage Number Physical LogicalName Pool of Space Space

Name Files Occupied Occupied(MB) (MB)

--------- ---- ---------- --------- -------- ------- --------DAISY Bkup DRIVED COPYFILE 38 0.45 0.42DAISY Bkup DRIVED YESBACK 38 0.45 0.43DAISY Bkup DRIVE_F_N: COPYFILE 7 0.16 0.13DAISY Bkup DRIVE_F_N: YESBACK 7 0.16 0.12DAISY Bkup DRIVE_G_S: YESBACK 16 0.03 0.02DAISY Arch (archive) YESARCH 14 0.02 0.01DAISY Arch DRIVE_F_N: YESARCH 6 0.02 0.01DAISY Arch OS2 YESARCH 65 0.58 0.23DAISY Arch DRIVE_G_S: YESARCH 14 0.02 0.01


Task 2

Display information on the file spaces that belong to the node WAYNE, and that have abackup file type.

Command:query occupancy wayne type=backup

QUERY OCCUPANCY


Output:

Node Name Type Filespace Storage Number Physical LogicalName Pool of Space Space

Name Files Occupied Occupied(MB) (MB)

--------- ----- --------- ----------- ------- --------- --------WAYNE Bkup DWG1 BACKUPPOOL1 2,330 53.19 50.01WAYNE Bkup OS2C BACKUPPOOL1 1,554 32.00 31.30WAYNE Bkup OS2D BACKUPPOOL1 1,716 35.30 34.40

where:

Node NameThe node that owns the file space.

TypeThe type of data. Possible values are:

ArchData that has been archived

BkupData that has been backed up

SpmgData that has been migrated from an HSM client (space-managed files)

Filespace NameThe name of the file space that belongs to the node. Where the name of the filespace is (archive), that data was archived before collocation by file space wasadded to the TSM product.

Storage Pool NameThe storage pool where the file space currently resides.

Number of FilesThe number of logical files that belong to the file space and are stored in thisstorage pool.

Physical Space Occupied (MB)The amount of physical space occupied by the file space. Physical space includesempty space within aggregate files, from which files may have been deleted orexpired.

Logical Space Occupied (MB)The amount of space occupied by logical files in the file space. Logical space is thespace actually used to store files, excluding empty space within aggregates.

Related Commands

Table 173. Commands Related to QUERY OCCUPANCY

Command Description


QUERY OCCUPANCY


Table 173. Commands Related to QUERY OCCUPANCY (continued)

Command Description



QUERY OCCUPANCY


QUERY OPTION (Query Server Options)

Use this command to display information about server options.

Change server options by editing the server options file or by issuing the SETOPTcommand. If you edit the server options file, you must restart the server before anychanges take effect. Any changes you make by issuing the SETOPT command takeeffect immediately.

Set options through the TSM Utilities menu or by issuing the CHGSVRADSMcommand.

Privilege Class


Syntax

ÊÊ Query OPTion*

optionnameÊÍ

Parametersoptionname

Specifies the name of an option in the server options file. This parameter isoptional. You can use wildcard characters to specify this name. All matching serveroptions are displayed. If you do not specify this parameter, information on alloptions is displayed.

Examples

Task 1

Display general information about all server options.

Command:query option

Output:

QUERY OPTION


SERVER OPTION OPTION SETTING SERVER OPTION OPTION SETTING---------------- -------------------- ----------------- --------------COMMTIMEOUT 60 IDLETIMEOUT 15BUFPOOLSIZE 512 LOGPOOLSIZE 128DATEFORMAT 1 (mm/dd/yyyy) TIMEFORMAT 1 (hh:mm:ss)NUMBERFORMAT 1 (1,000.00) MESSAGEFORMAT 1LANGUAGE AMENG MAXSESSIONS 25EXPINTERVAL 24 EXPQUIET NoMIRRORREAD DB Normal MIRRORREAD LOG NormalMIRRORWRITE DB Sequential MIRRORWRITE LOG ParallelVOLUMEHISTORY QUSRADSM/VOLHISTORY DEVCONFIG QUSRADSM/DEVCONFIG

(VOLHISTORY) (DEVCONFIG)TXNGROUPMAX 16 MOVEBATCHSIZE 32MOVESIZETHRESH 1 STATUSMSGCNT 10RESTOREINTERVAL 1,440 USELARGEBUFFERS NoMESSAGEINTERVAL 1 MAXMEMORY 1JOBPOOL 0 CONSOLEOUTPUT OFFCONSOLEMSGQ ADSMMSGQ QUSRADSM MOUNTMSGQ ADSMMSGQ QUSRADSMLRECLRECOVERYFILE 240 TCPPORT 1,500TCPBUFFERSIZE 32,768 TCPNODELAY YesIPXSOCKET 8522 IPXBUFFERSIZE 32,768SNABUFFERSIZE 15,360 HTTPPORT 1,580COMMMETHOD TCPIP COMMMETHOD APPCTECPort 0 TECHOSTUSEREXIT FILEEXIT FILEEXITMODE APPEND

where:

Server OptionSpecifies the name of the server option.

Option SettingSpecifies the current value of the server option.

Related Commands

Table 174. Commands Related to QUERY OPTION

Command Description

SETOPT Updates a server option without stopping andrestarting the server.

QUERY OPTION


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

QUERY POLICYSET (Query a Policy Set)

Use this command to display information about one or more policy sets.

Privilege Class


Syntax

ÊÊ Query POlicyset* *

*domain_name

policy_set_name

Ê

ÊFormat = Standard


ÊÍ


Specifies the policy domain associated with the policy set to query. This parameteris optional. You can use wildcard characters to specify names. If you do not specifya value for this parameter, all policy domains are queried. You must specify thisparameter when querying an explicitly named policy set.

policy_set_nameSpecifies the policy set to query. This parameter is optional. You can use wildcardcharacters to specify names. If you do not specify either ACTIVE or a policy setname, all policy sets are queried.




Examples

Task 1

Query all policy sets for all policy domains. Create the output in standard format.

QUERY POLICYSET


Command:query policyset

Output:

Policy Policy Default DescriptionDomain Set Name MgmtName Class

Name--------- --------- --------- ------------------------EMPLOYEE- ACTIVE ACTIVEFI- Personnel Department_RECORDS LES

EMPLOYEE- HOLIDAY ACTIVEFI- Personnel Department_RECORDS LES

EMPLOYEE- VACATION ACTIVEFI- Personnel Department_RECORDS LES

PROG1 SUMMER Programming GroupPolicies

PROG2 SUMMER Programming GroupPolicies

STANDARD ACTIVE STANDARD Installed default policyset.

STANDARD STANDARD STANDARD Installed default policyset.


Task 2

Query the VACATION policy set that is in the EMPLOYEE_RECORDS policy domain.Create the output in detailed format.

Command:query policyset employee_records vacation format=detailed

Output:

Policy Domain Name: EMPLOYEE_RECORDSPolicy Set Name: VACATION

Default Mgmt Class Name: ACTIVEFILESDescription: Personnel Department


Managing profile: ADSM_INFO

where:



Default Mgmt Class NameThe management class assigned as the default for the policy set.

DescriptionThe description of the policy set.

QUERY POLICYSET


Last Update by (administrator)The name of the administrator or server that most recently updated the policy set.If this field contains $$CONFIG_MANAGER$$, the policy set is associated with adomain that is managed by the configuration manager.

Last Update Date/TimeThe date and time when the policy set was most recently defined or updated.

Managing ProfileThe profile or profiles that manage the domain to which this policy set belongs.

Related Commands

Table 175. Commands Related to QUERY POLICYSET

Command Description








QUERY POLICYSET


||||

||

QUERY PROCESS (Query One or More Server Processes)

Use this command to display active background process information.

Use the CANCEL PROCESS command to cancel background processes.

Privilege Class


Syntax

ÊÊ Query PRocessprocess_number

ÊÍ

Parametersprocess_number

Specifies the number of the background process to be queried. This parameter isoptional. If not specified, information on all background processes is displayed.

Examples

Task

Display information about background process 202.

Command:query process 202

Output:

Process Process Description StatusNumber

-------- ------------------------ --------------------------202 EXPORT SERVER ANR0648I Have copied the

following: 8 Domains 2Policy Sets 10 ManagementClasses 4 Copy Groups 1Administrators 746 Bytes(0 errors have beendetected)

where:

Process NumberSpecifies the number assigned to the background process.

Process DescriptionSpecifies a description of the background process.

QUERY PROCESS


StatusSpecifies the completion status of the background process.

Related Commands

Table 176. Command Related to QUERY PROCESS

Command Description


QUERY PROCESS


QUERY PROFILE (Query a Profile)

Use this command to display information about profiles and associated objects. Issuethis command from a configuration manager or from a managed server. You can usethis command to get profile information from any configuration manager defined to theserver, even if the server does not subscribe to any profile.

If you query a locked profile from the configuration manager to which the profilebelongs, complete profile information is displayed. If you query a locked profile fromanother server, the query displays only that the profile is locked.

Privilege Class


Syntax

ÊÊ Query PROFIle*

profile_name (1)SERVer = server_name

Ê

ÊFormat = Standard


USELocal = Yes

USELocal = YesNo

ÊÍ

Notes:

1 The server name you specify depends on the server from which you issue thecommand. See the description of the SERVER parameter.

Parametersprofile_name

Specifies the profile to display. To specify multiple names, use a wildcard character.This parameter is optional. The default is to display all profiles.

SERVerSpecifies the configuration manager whose profile information is displayed. Therequirements for the name depends on where the query is issued:

v From a configuration manager: This parameter is optional. The default is theconfiguration manager’s name.

v From a managed server: This parameter is optional. The default is the name ofthe configuration manager for this managed server.

v From a server that is neither a configuration manager nor a managed server:You must specify a name.

QUERY PROFILE


||

||||

|||

|

|

|

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

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

|

|

|||

|

|||

|||

||

||

||

FormatSpecifies whether partial or detailed information is displayed. The default isSTANDARD. Possible values are:


DetailedSpecifies that detailed information is displayed.

USELocalWhen you perform the query from a managed server, this parameter specifieswhether the profile information is obtained from the configuration manager or themanaged server. If the profile information does not exist on the managed server,the information is obtained from the configuration manager, regardless of the valueof this parameter.

If you use this parameter on a server that is not managed by the configurationmanager that owns the profile, the parameter is ignored. The default value is YES.Possible values are:

YesSpecifies that the profile information, if available, is obtained from the managedserver. The configuration manager is contacted if information is not availablefrom the managed server.

No Specifies that the profile information is obtained from the configurationmanager even if the information is available from the managed server. Thisensures that you receive current information about the profile.

Examples

Task 1

Display profile information from a configuration manager.

Command:query profile

Output:

Configuration Profile name Locked?manager--------------- --------------- ------SERVER1 DEFAULT_PROFILE NoSERVER1 ADMIN_INFO NoSERVER1 EMPLOYEE NoSERVER1 PERSONNEL Yes

Task 2

From a managed server, display current detailed information for profile ADMIN_INFO.

Note: When the profile is locked, most fields are not displayed.

QUERY PROFILE


|||

||

||

||||||

|||

||||

||||

|

|

|

||

|

||||||||

|

|

|

Command:query profile admin_info format=detailed uselocal=no

Output:

Configuration manager: SERVER1Profile name: ADMIN_INFO

Locked: NoDescription: Distributed administrative schedules

Server administrators: DENNIS EMILY ANDREAPolicy domains: ADMIN RECORDS

Administrative command schedules: ** all objects **Server Command Scripts:

Client Option Sets:Servers:

Server Groups:

where:

Configuration managerThe name of the configuration manager that owns the profile.

Profile nameThe name of the profile.

Locked?Whether the profile is locked.

DescriptionThe description of the profile.

Server administratorsThe administrators that are associated with the profile.

Policy domainsThe policy domains that are associated with the profile.

Administrative command schedulesThe administrative schedules that are associated with the profile.

Server Command ScriptsThe server command scripts that are associated with the profile.

Client Option SetsThe client option sets that are associated with the profile.

ServersThe servers that are associated with the profile.

Server GroupsThe names of server groups that are associated with the profile.

Related Commands

Table 177. Commands Related to QUERY PROFILE

Command Description


QUERY PROFILE


||

|

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

|

||

||

||

||

||

||

||

||

||

||

||

|

|||

||

||

Table 177. Commands Related to QUERY PROFILE (continued)

Command Description










QUERY PROFILE


|

||

||

|||

||

|||

||

||

|||

|||

||

|

QUERY RECOVERYMEDIA (Query Recovery Media)

Use this command to display information about the media (for example, boot media)needed to recover a machine. Media are displayed in alphabetical order by name.


Privilege Class


Syntax

ÊÊ Query RECOVERYMedia*

media_name Type = BOotOTher

Ê

ÊLOcation = location

Format = Standard


ÊÍ

Parametersmedia_name

Specifies the name of the recovery media. You can use wildcard characters tospecify the name. This parameter is optional. The default is all recovery media.

TypeSpecifies the type of media to be queried. This parameter is optional. If thisparameter is not specified, all recovery media are queried. Possible values are:

BOotOnly boot media are queried.

OTherAll media other than boot media are queried.

LOcationSpecifies the location of the recovery media to be queried. This parameter isoptional. You can specify up to 255 characters. Enclose the description in quotationmarks if it contains any blank characters.

FormatSpecifies how the information is displayed. This parameter is optional. Possiblevalues are:

StandardTSM displays partial information. This is the default.

QUERY RECOVERYMEDIA


DetailedTSM displays all information.

Examples

Task 1

Display information for the recovery media named RECMED1.

Command:query recoverymedia RECMED1

Output:

Recovery Media Name Volume Names Location Machine Name-------------------- ---------------- ---------------- ------------RECMED1 vol1 vol2 vol3 IRONMOUNTAIN MACH1

vol4

Task 2

Display detailed information for the recovery media named RECMED1.

Command:query recoverymedia RECMED1 format=detailed

Output:

Recovery Media Name: RECMED1Type: Boot

Volume Names: vol1 vol2 vol3 vol4Location: IRONMOUNTAIN

Description:Product:

Product Information:Machine Name: MACH1

where:

Recovery Media NameThe name of the recovery media.

TypeWhether the recovery media are boot media or another type of media. Possiblevalues are:

BootThe recovery media are boot media.

OtherThe recovery media are not boot media.

Volume NamesThe set of volumes that contain the data needed to recover machines associatedwith this media.

QUERY RECOVERYMEDIA


LocationWhere the recovery media is stored.

DescriptionA description of the recovery media.

ProductThe product used to create the boot media.

Product InformationInformation about the product that created the boot media. This information may beneeded for restoring the machine.

Machine NameThe machines that are associated with this recovery media.

Related Commands

Table 178. Commands Related to QUERY RECOVERYMEDIA

Command Description





QUERY RECOVERYMEDIA


QUERY REQUEST (Query One or More Pending Mount Requests)

Use this command to display information about one or more pending mount requests.

Privilege Class


Syntax

ÊÊ Query REQuestrequest_number

ÊÍ

Parametersrequest_number

Specifies the identification number of the pending mount request. This parameter isoptional. The default is all pending mount requests.

Examples

Task

Display information on all pending mount requests.

Command:query request

Output:

ANR8352I Requests outstanding:ANR8326I 001: Mount 8MM volume EXP001 R/Win drive 8MM.1 (TAP04) of libraryMANLIB within 60 minute(s).

Related Commands

Table 179. Related Commands for QUERY REQUEST

Command Description

CANCEL REQUEST Cancels pending volume mount requests.

REPLY Allows a request to continue processing.

QUERY REQUEST


QUERY RESTORE (Query Restartable Restore Sessions)

Use this command to display information about the restartable restore sessions.

Privilege Class


Syntax

ÊÊ Query RESTorenode_name file_space_name

Format = Standard


ÊÍ

Parametersnode_name

Specifies the client node to be queried. This parameter is optional. If you do notspecify a value, all client nodes with restartable restore sessions are displayed. Youmust specify a value for this parameter if you specify a file space name.

file_space_nameSpecifies the file space to be queried. This parameter is optional. If you do notspecify a value, all file spaces are matched for the specified node.

Examples

Task

Display detailed information about client node JAMES associated with file spaceDRIVE_F_R.

Command:query restore james drive_f_r format=detailed

Sess Number: -1Restore State: Restartable

Elapsed Minutes: 2Node Name: JAMES

Filespace Name: DRIVE_F_R:File Spec: /RESTORE/TESTDIRF\\

where:

Sess NumberSpecifies the session number for the restartable restore session. The number foractive restore sessions is the same number displayed on the QUERY SESSIONcommand. For restore sessions in the restartable state, a negative number is

QUERY RESTORE


displayed for the session number. Any session number displayed in the QUERYRESTORE output may be specified from the QUERY RESTORE output.

Restore State

1. Active: Specifies the restore session is actively restoring files to the client.

2. Restartable: Specifies the restore session failed or was cancelled and can berestarted from where it left off.

Elapsed MinutesSpecifies the number of minutes since the restore session started. Any restartablerestore session with an elapsed time greater than the RESTOREINTERVAL serveroption can be automatically deleted from the database when needed or duringexpiration processing. If the elapsed time is less than the RESTOREINTERVAL,you can delete this entry (and unlock the filespace) only by issuing the CANCELRESTORE command lowering the RESTOREINTERVAL value.

Node NameSpecifies the node associated with the restartable restore session.

Filespace NameSpecifies the file space associated with the restartable restore session.

File SpecSpecifies the file specification used on the restore operation. The same filespecification must be specified if a failed restore operation is to be restarted fromwhere it stopped.

Related Commands

Table 180. Commands Related to QUERY RESTORE

Command Description

CANCEL RESTORE Cancels a restartable restore session.

QUERY RESTORE


QUERY RPFCONTENT (Query Recovery Plan File Contents Stored on a TargetServer)

Note: This command applies only to recovery plan files created when the DEVCLASSparameter was specified on the PREPARE command.

Use this command to display the contents of a recovery plan file stored on a targetserver. You can issue this command from either the server that created the file (thesource server) or the server that stores the recovery plan file (the target server). Youcannot issue this command from the server console.

The output may be delayed if the file is on tape.

Note: From the web administrative interface you can display the contents of one ormore recovery plan file stanzas.

Privilege Class


Syntax

ÊÊ Query RPFContent plan_file_name DEVclass = device_class_nameNODEName = node_name

ÊÍ

Parametersplan_file_name (Required)

Specifies the name of the recovery plan file to be queried. The format of the filename is servername.yyyymmdd.hhmmss. To see the names of existing files, issuethe QUERY RPFILE command.

DEVclassSpecifies the name of the device class used to create the recovery plan file. Usethis parameter when you are logged on to the server that created the file. Wildcardcharacters are not allowed.

Specify this parameter when:

v You want to display the contents of the recovery plan file that was created forthis server.

v You are issuing this command to the same server on which the PREPAREcommand was issued (the source server).

v The specified device class name was used on the PREPARE command thatcreated the recovery plan file.

NODENameSpecifies the node name, registered on the target server, of the source server that

QUERY RPFCONTENT


||

|

||||||

|

||

|

|

|

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

|

|

||||

||||

|

||

||

||

||

created the recovery plan file. Use this parameter when you are logged on to thetarget server or when the source server is not available. Wildcard characters arenot allowed.

Specify this parameter when:

v You want to display the contents of the recovery plan file that was stored on thisserver.

v You are issuing this command to the server that was the target of the PREPAREcommand that created the recovery plan file.

v The specified node name is registered to this server with a node type ofSERVER.

v The TSM server that created the recovery plan file is not available.

Examples

Task 1

On the source server: Display the contents of a recovery plan file that was created forthis server on March 19, 1998, at 6:10AM. The PREPARE command specified thedevice class REMOTE.

Command:

query rpfcontent branch1.19980319.061000 devclass=remote

Task 2

On the target server: Display the contents of a recovery plan file that was stored inthis server on March 19, 1998, at 6:10AM. The server that created the file is registeredon the target server as a node named POLARIS with a node type of SERVER.

Command:

query rpfcontent branch1.19980319.061000 nodename=polaris

Output:The output of these commands is the entire contents of the recovery plan file.The Web administrative interface lets you display the contents of one or morerecovery plan file stanzas. See the Administrator’s Guide for an example of adisaster recovery plan file.

Related Commands

Table 181. Commands Related to QUERY RPFCONTENT

Command Description




QUERY RPFCONTENT


|||

|

||

||

||

|

|

|

|||

|

|

|

|||

|

|

|||||

|

|||

||

||

||

|||

|

QUERY RPFILE (Query Recovery Plan File Information Stored on a TargetServer)

Use this command to display information about recovery plan files stored on a targetserver. You can issue this command from either the server that created the file (thesource server) or the server that stores the recovery plan file (the target server).

Privilege Class


Syntax

ÊÊ Query RPFile DEVclass = device_class_nameNODEName = node_name

Format = Standard


ÊÍ

ParametersDEVclass

Specifies the name of the device class that was used to create the recovery planfile. Use this parameter when logged on to the server that created the recoveryplan file. You can use wildcard characters in the device class name. All recoveryplan files that are created with the device class specified are included in the query.

NODENameSpecifies the node name, registered on the target server, of the source server thatcreated the recovery plan files. Use this parameter when logged on to the targetserver. You can use this parameter when the source server is not available. Youcan use wildcard characters to specify the node name. All file objects that arestored with the node name specified are included in this query.


StandardTSM displays partial information for the recovery plan file.

DetailedTSM displays all information for the recovery plan file.

Examples

Task 1

Display a list of recovery plan files that were created for this server using the specifieddevice class.

QUERY RPFILE


||

|

|||

|

|

|

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

|

|

|||||

||||||

|||

||

||

|

|

||

Command:

query rpfile devclass=* format=detailed

Output:

Recovery Plan File Name: ALASKA.19980406.170423Node Name: BRANCH1

Device Class Name: REMOTERecovery Plan File Type: RPFILE

Mgmt Class Name: STANDARDRecovery Plan File Size: 16,255 Bytes

Marked for Deletion: YesDeletion Date: 06/12/1999 13:05:31

Recovery Plan File Name: ALASKA.19980407.170845Node Name: BRANCH1

Device Class Name: REMOTEMgmt Class Name: STANDARD

Recovery Plan File Size: 16,425 BytesMarked for Deletion: No

Deletion Date:

Task 2

Display a list of all recovery plan file objects that are stored with the specified nodename (type=SERVER).

Command:

query rpfile nodename=branch1

Output:

Recovery Plan File Name Node Name Device Class Name----------------------- --------- -----------------ALASKA.19980406.170423 BRANCH1 REMOTEALASKA.19980407.170845 BRANCH1 REMOTE

where:

Recovery Plan File NameThe recovery plan file name.

Node NameThe node name that is registered with the target server and used to store therecovery plan file objects

Device Class NameThe device class name that is defined in the source server and used to create therecovery plan files

Mgmt Class NameThe management class name that the recovery plan file is associated with in thetarget server.

Recovery Plan File SizeEstimated size of the recovery plan file object on the target server.

QUERY RPFILE


|

|

||

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

|

||

|

|

||

|||||

|

||

|||

|||

|||

||

Marked For DeletionWhether the object that contains the recovery plan file has been deleted from thesource server and marked for deletion on the target server if the grace period hasnot expired. Possible values are:

YesThe object is marked for deletion.

No The object is not marked for deletion.

Deletion DateDate that the object has been deleted from the source server and marked fordeletion on the target server. This field is blank if the object has not been markedfor deletion.

Related Commands

Table 182. Commands Related to QUERY RPFILE

Command Description




QUERY RPFILE


||||

||

||

||||

|

|||

||

||

|||

||

|

QUERY SCHEDULE (Query Schedules)

Use this command to display information about one or more schedules.

The QUERY SCHEDULE command takes two forms, depending on whether theschedule applies to client operations or administrative commands. The syntax andparameters for each operation are defined separately.

QUERY SCHEDULE


QUERY SCHEDULE — Client

Privilege Class


Syntax

ÊÊ Query SCHedule* *

*domain_name

schedule_name

Type = ClientÊ

Ê

·

,

Nodes = node_name

Format = Standard


ÊÍ


Specifies the name of the policy domain to which the schedule belongs. You canuse a wildcard character to specify this name. If you specify a domain name, youdo not have to specify a schedule name.

schedule_nameSpecifies the name of the schedule that belongs to the specified policy domain.You can use a wildcard character to specify this name. If you specify a schedulename, you must also specify a policy domain name.

Type=ClientSpecifies that the query displays client schedules. This parameter is optional. Thedefault is CLIENT.

NodesSpecifies the name of one or more client nodes that are associated with theschedules to be displayed. This parameter is optional. You can use a wildcardcharacter to specify client nodes. If you do not specify a client name, all schedulesmatching the DOMAINNAME and SCHEDULENAME parameters are displayed.You can specify multiple client nodes by separating the names with commas andno intervening spaces.


StandardSpecifies that partial information is displayed for the schedules.



DetailedSpecifies that detailed information is displayed for the schedules.

Examples

Task 1

Display all schedules that belong to the EMPLOYEE_RECORDS policy domain.

Command:query schedule employee_records

Output:

Domain * Schedule Name Action Start Date/Time Duration Period Day----------- - ------------ ---- ----------------- ------- ---- ---EMPLOYEE_RE- WEEKLY_BACKUP Inc Bk 1998.06.04 17.04.20 1 H 1 D AnyCORDSEMPLOYEE_RE- EMPLOYEE_BACKUP Inc Bk 1998.06.04 17.04.20 1 H 1 D AnyCORDS

where:

DomainSpecifies the name of the policy domain to which the specified schedule belongs.

* (Asterisk)Specifies whether the corresponding schedule has expired. If there is an asterisk inthis column, the corresponding schedule has expired.


ActionSpecifies the action that occurs when this schedule is processed.

Start Date/TimeSpecifies the initial starting date and time for this schedule.

DurationSpecifies the length of the startup window for this schedule.

PeriodSpecifies the time between startup windows (assuming DAYOFWEEK=ANY).

DaySpecifies the day of the week on which the startup windows for the schedule begin.

Task 2

From a managed server, display detailed information about client schedules.

Command:query schedule * type=client format=detailed



Output:

Policy Domain Name: ADMIN_RECORDSSchedule Name: ADMIN_BACKUP

Description:Action: IncrementalOptions:Objects:Priority: 5

Start Date/Time: 1998.06.04 17.04.20Duration: 1 Hour(s)

Period: 1 Day(s)Day of Week: AnyExpiration:

Last Update by (administrator): $$CONFIG_MANAGER$$Last Update Date/Time: 1998.06.04 17.51.49

Managing profile: ADMIN_INFO

Policy Domain Name: EMPLOYEE_RECORDSSchedule Name: EMPLOYEE_BACKUP

Description:Action: IncrementalOptions:Objects:Priority: 5



Last Uppdate by (administrator): $$CONFIG_MANAGER$$Last Update Date/Time: 1998.06.04 17.18.30

Managing profile: EMPLOYEE

where:

Policy Domain NameSpecifies the name of the policy domain.


DescriptionSpecifies the description of the schedule.

ActionSpecifies the type of action that occurs when this schedule is run. See the DEFINESCHEDULE command for a listing of actions.

OptionsSpecifies the options that are supplied to the DSMC command when the scheduleis run.

ObjectsSpecifies the objects for which the specified action is performed.

PrioritySpecifies the priority value for the schedule.



Start Date/TimeSpecifies the initial starting date and time for the schedule.

DurationSpecifies the length of the startup window for the schedule.


Day of WeekSpecifies the day of the week on which the startup windows for the schedule begin.

ExpirationSpecifies the date and time on which this schedule expires. If this column is blank,the schedule does not expire.

Last Update by (administrator)Specifies the name of the administrator that most recently updated the schedule. Ifthis field contains a $$CONFIG_MANAGER$$, the schedule is associated with adomain that is managed by the configuration manager.

Last Update Date/TimeSpecifies the last date and time the schedule was last updated.

Managing ProfileSpecifies the profile or profiles to which the managed server subscribed to get thedefinition of this schedule.



QUERY SCHEDULE — Administrative

Privilege Class


Syntax

ÊÊ Query SCHedule*

schedule_nameType = Administrative Ê

ÊFormat = Standard


ÊÍ

Parametersschedule_name

Specifies the name of the schedule to be queried. You can use a wildcardcharacter to specify this name.

Type=Administrative (Required)Specifies that the query displays administrative command schedules.


StandardSpecifies that partial information is displayed for the schedules.

DetailedSpecifies that detailed information is displayed for the schedules.

Examples

Task 1

From a managed server, display detailed information about administrative commandschedules.

Command:query schedule * type=administrative format=detailed

Output:



Schedule Name: BACKUP_ARCHIVEPOOLDescription:

Command: backup dbPriority: 5


Period: 1 Day(s)Day of Week: Any:Expiration:

Active: NoLast Update by (administrator): $$CONFIG MANAGER$$

Last Update Date/Time: 1998.06.04 17.51.49Managing Profile: ADMIN_INFO

Schedule Name: MONTHLY_BACKUPDescription:

Command: q statusPriority: 5


Period: 1 Day(s)Day of Week: Any:Expiration:

Active: NoLast Update by (administrator): $$CONFIG MANAGER

Last Update Date/Time: 1998.06.04 17.51.49Managing Profile: ADMIN_INFO

where:



CommandSpecifies the command that is scheduled.

PrioritySpecifies the priority value for this schedule.


DurationSpecifies the length of the startup window.


Day of WeekSpecifies the day of the week on which the startup windows begin.

ExpirationSpecifies the date after which this schedule will no longer be used. If this column isblank, the schedule does not expire.



Active?Specifies whether the schedule has been processed according to the time and dateset for this schedule.

Last Update by (administrator)Specifies the name of the administrator that most recently updated the schedule. Ifthis field contains a $$CONFIG_MANAGER$$, the schedule is associated with adomain that is managed by the configuration manager.

Last Update Date/TimeSpecifies the last date and time the schedule was modified.

Managing ProfileSpecifies the profile or profiles to which the managed server subscribed to get thedefinition of this schedule.

Task 1

Display, in detail, the administrative command schedule (BACKUP_BACKUPPOOL)defined to backup the primary storage pool BACKUPPOOL to the copy storage poolCOPYSTG.

Command:query schedule backup_backuppool type=administrative format=detailed

Output:

Schedule Name: BACKUP_BACKUPPOOLDescription:

Command: backup stgpool backuppool copystgPriority: 5

Start Date/Time: 05/30/1997 20:00:00Duration: 1 Hour(s)


Active?: YesLast Update by (administrator): ADMIN


where:



CommandSpecifies the command that is scheduled.

PrioritySpecifies the priority value for this schedule.




DurationSpecifies the length of the startup window.


Day of WeekSpecifies the day of the week on which the startup windows begin.

ExpirationSpecifies the date and time on which this schedule will no longer be used. If thiscolumn is blank, the schedule does not expire.

Active?Specifies whether the schedule has been processed according to the time and dateset for this schedule.

Last Update by (administrator)Specifies the name of the administrator that most recently modified the schedule.

Last Update Date/TimeSpecifies the last date and time the schedule was modified.



Related Commands

Table 183. Command Related to QUERY SCHEDULE

Command Description






QUERY SCRIPT (Query Tivoli Storage Manager Scripts)

Use this command to display information about scripts. You can use this command inconjunction with the DEFINE SCRIPT command to create a new script using thecontents from another script.

Privilege Class

An administrator can issue this command unless it includes the OUTPUTFILEparameter. If the OUTPUTFILE parameter is specified and the REQSYSAUTHOUTFILEserver option is set to YES, the administrator must have system privilege. If theOUTPUTFILE parameter is specified and the REQSYSAUTHOUTFILE server option isset to NO, the administrator must have operator, policy, storage or system privilege.

Syntax

ÊÊ Query SCRipt*

script_name

FORMAT = Standard

FORMAT = StandardLinesDetailedRaw

Ê

ÊOutputfile = file_name

ÊÍ

Parametersscript_name

Specifies the name of the script for which information is to be displayed. You caninclude a wildcard character to specify this name. Attention: If you do not specifya script, the query displays information about all scripts. The time used to processthis command and the amount of information displayed can be extensive.

FormatSpecifies the output format for displaying script information. The default isSTANDARD. Possible values are:

StandardSpecifies that only the script name and description in a script are displayed.

LinesSpecifies that the script name, the line number of the commands, commentlines, and the commands in the script are displayed.

DetailedSpecifies that detailed information about the script is displayed.

RawSpecifies that commands contained in the script are written to a file named

QUERY SCRIPT


||

|||

|

|||||

|

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

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

|

|

|||||

|||

||

|||

||

||

with the OUTPUTFILE parameter. This format is a way of directing output froma script to a file so that it can be copied into another script using the DEFINESCRIPT command.

OutputfileSpecifies the name of the file to which output is directed when you specifyFORMAT=RAW. The file you specify must reside on the server running thiscommand. If the file exists, the query output is appended to the end of the file.

Examples

Task 1

Display the standard information about scripts.

Command:query script *

Name Description--------------- ------------------------------------------------------QCOLS Display columns for a specified SQL tableQSAMPLE Sample SQL QueryEXAMPLE Backup the store pools and database when no sessions

Task 2

Display the lines information for a script named Q_AUTHORITY.

Command:query script q_authority format=lines

Name Line CommandNumber

---------- ------ --------------------------------------------------Q_AUTHORITY 1 /* ------------------------------------------*/

5 /* Script Name: Q_AUTHORITY */10 /* Description: Display administrators that */15 /* have the authority to issue */20 /* commands requiring a */25 /* specific privilege. */30 /* Parameter 1: privilege name - in the form */35 /* x_priv - EX. policy_priv */40 /* Example: run q_authority storage_priv */45 /* ------------------------------------------*/50 select admin_name from admins where -55 upper(system_priv) <> 'NO' or -60 upper($1) <> 'NO'

Task 3

Display detailed information about scripts.

Command:query script * format=detailed

QUERY SCRIPT


|||

||||

|

|

|

||

||||||||

|

|

||

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

|

|

||

Name: QCOLSLine Number: DESCRIPTION

Command: Display columns for a specified SQL tableLast Update by (administrator): SERVER_CONSOLE


Name: QCOLSLine Number: 1

Command: select colname from columns wheretabname='$1'

Last Update by (administrator): SERVER_CONSOLELast Update Date/Time: 12/02/1997 16:05:29

where:

NameThe name of the script.

Line NumberThe line number of the script or the string DESCRIPTION.

CommandThe command included on the line number displayed in the previous field.

Last Update by (administrator)The name of the administrator that has defined or most recently updated the script.

Last Update Date/TimeThe date and time that the administrator defined or updated the script.

Task 4

Query the ENGDEV script and direct the output to a file namedQUSRADSM/SCRIPT(MY).

Command:query script engdev format=raw outputfile=qusradsm/script(my)

query dbvolumedef dev $1 devtype=file mountl=$2 maxcap=$3query logvolume

Create a new script by using the contents from file, QUSRADSM/SCRIPT(MY). Namethe new script AGADM.

Command:define script agadm file=qusradsm/script(my)

Related Commands

Table 184. Commands Related to QUERY SCRIPT

Command Description



QUERY SCRIPT


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

|

||

||

||

||

||

|

||

||

||||

||

||

|

|||

||

||

||

Table 184. Commands Related to QUERY SCRIPT (continued)

Command Description



RUN Runs a script.


QUERY SCRIPT


|

||

|||

||

||

||

|

QUERY SERVER (Query a Server)

Use this command to display information about a server definition.

Privilege Class


Syntax

ÊÊ Query SERver*

server_name

Format = Standard


ÊÍ

Parametersserver_name

Specifies the name of the server to be queried. You can use wildcard characters tospecify this name. This parameter is optional. The default is all server names.

FormatSpecifies how the information is displayed. The parameter is optional. The defaultis STANDARD.



Examples

Task 1

Display information about target server REMOTE1.

Command:query server remote1

Output:

DaysSince

Server Comm. High-level Low-level LastName Method Address Address Access Node Name------- ------ ---------- --------- ------ ---------REMOTE1 TCP 9.115.4.15 1500 <1 REMOTE1

where:

QUERY SERVER


Server NameSpecifies the name of the server.

Comm. MethodSpecifies the communication method used to connect to the target server.

High-level AddressSpecifies the IP address (in dotted decimal format) of the server.

Low-level AddressSpecifies the port number of the target server for the TCP/IP communicationmethod.



Task 2

From a managed server, display detailed information about SERVER_A.

Command:query server server_a format=detailed

Output:

Server Name: SERVER_AComm. Method: TCPIP

High-level Address: 9.115.4.15Low-level Address: 1500

Description:Allow Replacement:

Node Name:Last Access Date/Time: 06/09/1998 12:51:51Days Since Last Access: <1

Locked?:Compression: Client's Choice

Archive Delete Allowed?: NoURL:

Registration Date/Time: 06/09/1998 12:51:51Registering Administrator: $$CONFIG_MANAGER$$

Bytes Received Last Session: 0Bytes Sent Last Session: 0

Duration of Last Session (sec): 0.00Pct. Idle Wait Last Session: 0.00Pct. Comm. Wait Last Session: 0.00Pct. Media Wait Last Session: 0.00

Grace Deletion Period: 5Managing Profile:

Server Password Set Date/Time:Days since Server Password Set:

Invalid Sign-on count for Server:Virtual Volume Password Set: No

Virtual Volume Password Set Date/Time:(?)Days Since Virtual Volume Password Set:(?)

Invalid Sign-on Count for Virtual Volume Node: 0

where:

QUERY SERVER


|

||

|

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

|

Server NameThe name of the server.

Communication MethodThe communication method used to connect to the server.

High-level AddressThe IP address (in dotted decimal format) of the server.

Low-level AddressThe port number of the server.

DescriptionThe server description.

Allow ReplacementWhether a server definition on a managed server can be replaced with a definitionfrom a configuration manager.

Node NameThe name of the client node.

Last Access Date/TimeThe last date and time that the client node accessed the server.

Days Since Last AccessThe number of days since the client node accessed the server.

Locked?Whether the client node is locked out of TSM.

CompressionThe type of compression performed by TSM on client files.

Archive Delete Allowed?Whether the client node can delete its own archive files.

URLThe URL used to access this server from a Web browser-based interface.

Registration Date/TimeThe date and time that the client node was registered.

Registering AdministratorThe name of the administrator that registered the client node.

Bytes Received Last Sessionthe number of bytes received by the server during the last client node session.

Bytes Sent Last SessionThe number of bytes sent to the client node.

Duration of Last Session (sec)The length of the last client node session, in seconds.

Pct. Idle Wait Last SessionThe percentage of the total session time that the client was not performing anyfunctions.

QUERY SERVER


||

||

||

||

||

|||

||

||

||

||

||

||

||

||

||

||

||

||

|||

Pct. Comm. Wait Last SessionThe percentage of the total session time that the client waited for a response fromthe server.

Pct. Media Wait Last SessionThe percentage of the total session time that the client waited for a removablevolume to be mounted.

Grace Deletion PeriodHow many days an object remains on the target server after it has been marked fordeletion.

Managing Profile?The profile from which the managed server got the definition of this server.

Server Password Set Date/TimeWhen the server’s password was set.

Days since Server Password SetThe number of days since the server password was set.

Invalid Sign-on count for Server:The maximum number of invalid sign-on attempts that the server will accept.

Virtual Volume Password Set:Whether the password used to sign on to the target server has been set.

Virtual Volume Password Set Date/Time:When the password for virtual volume support was last set.

Days Since Virtual Volume Password Set:The number of days since the password for virtual volume support was set.

Invalid Sign-on Count for Virtual Volume Node:The maximum number of invalid sign-on attempts that are accepted on the targetserver.

Related Commands

Table 185. Commands Related to QUERY SERVER

Command Description








QUERY SERVER


|||

|||

|||

||

||

||

||

||

||

||

|||

|

Table 185. Commands Related to QUERY SERVER (continued)

Command Description






QUERY SERVER


QUERY SERVERGROUP (Query a Server Group)

Use this command to display information about server groups and group members.

Privilege Class


Syntax

ÊÊ QUERY SERVERGRoup*

group_nameÊÍ

Parametersgroup_name

Specifies the server group to query. This parameter is optional. You can usewildcard characters to specify this name.

Examples

Task

From a managed server, query all server groups.

Command:query servergroup *

Output:

Server Group Group Member Description Managing Profile------------ ------------ --------------------- ----------------ADMIN_GROUP SERVER_A Headquarters ADMIN_INFO

SERVER_BSERVER_CSERVER_D

where:

Server GroupThe name of the server group.

Group MemberThe group members.

DescriptionThe description of the server group.

QUERY SERVERGROUP


||

|

|

|

|

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

|

|

|||

|

|

|

||

|

|||||||

|

||

||

||

Managing ProfileThe profile or profiles to which the managed server subscribed to get the definitionof the server groups.

Related Commands

Table 186. Commands Related to QUERY SERVERGROUP

Command Description







QUERY SERVERGROUP


|||

|

|||

||

||

||

||

||

||

||

|

QUERY SESSION (Query Client Sessions)

Use this command to display information on one or more administrative and client nodesessions.

Privilege Class


Syntax

ÊÊ Query SEssionsessnum

Format = Standard


ÊÍ

Parameterssessnum

Specifies the number of the administrative or client node session to query. Thisparameter is optional. If you do not specify a value for this parameter, all sessionsdisplay.

FormatSpecifies how the information displays. This parameter is optional. The defaultvalue is STANDARD. Possible values are:

StandardSpecifies that partial information displays for the session.

DetailedSpecifies that complete information displays for the session.

Examples

Task 1

Display information on all administrative and client node sessions that arecommunicating with the server.

Command:query session

Output:

QUERY SESSION


Sess Comm. Sess Wait Bytes Bytes Sess Platform ClientNumber Method State Time Sent Recvd Type Name------ ------ ------ ------ ------- ------- ----- -------- ------

77 TCP/IP Run 0 S 134 159 Admin OS/2 ADMIN


Task 2

Display information in full detail about all administrative and client node sessions thatare communicating with the server.

Command:query session format=detailed

Output:

Sess Number: 77Comm. Method: Tcp/Ip

Sess State: RunWait Time: 0 SBytes Sent: 409Bytes Recvd: 202

Sess Type: AdminPlatform: OS/2

Client Name: ADMINMedia Access Status: MediaW

User Name:

where:

Sess NumberSpecifies a unique session identification number assigned by the server.

Comm. MethodSpecifies the method being used by the client to communicate with the server.

Sess StateSpecifies the current communications state of the server. Possible states are:

End The session is ending (session resources are released).

IdleW Waiting for client’s next request (session is idle).

MediaWThe session is waiting for access to a sequential access volume.

RecvW Waiting to receive an expected message from the client.

Run The server is executing a client request (and not waiting to send data).

SendW The server is waiting to send data to the client (waiting for data to bedelivered to the client node that has already been sent).

Start The session is starting (authentication is in progress).

QUERY SESSION


Wait TimeSpecifies the amount of time (seconds, minutes, or hours) the server has been inthe current state shown.

Bytes SentSpecifies the number of bytes of data sent to the client node since the session wasinitiated.

Bytes RecvdSpecifies the number of bytes of data received from the client node since thesession was initiated.

Sess TypeSpecifies the type of session in process: either ADMIN for an administrativesession, or NODE for a client node session.

PlatformSpecifies the type of operating system associated with the client.

Client NameSpecifies the name of the client node or the administrator.

Media Access StatusSpecifies the type of media wait state. This information is only provided when thesession state equals MediaW.

User NameSpecifies the user ID of the node, on a multi-user system, that connects to theserver when it is not the same system user who originally connected to the server.

Related Commands

Table 187. Command Related to QUERY SESSION

Command Description


QUERY SESSION


QUERY SPACETRIGGER (Query the Database or Recovery Log Space Triggers)

Use this command to display the settings for the database or recovery log spacetriggers.

Privilege Class


Syntax

ÊÊ Query SPACETrigger DBLOG

Format = Standard


ÊÍ

ParametersDB

Specifies the database space trigger.

LOGSpecifies the recovery log space trigger.




Examples

Task 1

Display detailed settings for the database space trigger.

Command:

query spacetrigger db format=detailed

Output:

QUERY SPACETRIGGER


||

||

|

|

|

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

|

|

||

||

|||

||

||

|

|

|

|

||

||

DB Full Percentage: 80DB Space Expansion: 20DB Expansion prefix:

Maximumsize: 1000Last Update by (administrator): BF


where:

DB Full PercentageSpecifies when TSM automatically allocates more space for the database.

DB Space ExpansionSpecifies the percentage of space by which the database is expanded.

DB Expansion prefixSpecifies the prefix name for the files that TSM uses to create database files whenexpanding the database.

MaximumsizeSpecifies the maximum size, in megabytes, of the database.

Last Update by (administrator)Specifies the name of the administrator who most recently updated the databasespace trigger.

Last Update Date/TimeSpecifies when the administrator most recently updated the database space trigger.

Task 2

Display detailed settings for the recovery log space trigger.

Command:

query spacetrigger log format=detailed

Output:

Log Full Percentage: 80LOG Space Expansion: 20LOG Expansion prefix:

Maximumsize: 1000Last Update by (administrator): BF


where:

Log Full PercentageSpecifies when TSM automatically allocates more space for the recovery log.

LOG Space ExpansionSpecifies the percentage of space by which the recovery log is expanded.

QUERY SPACETRIGGER


|||||||

|

||

||

|||

||

|||

||

|

|

|

|

||

|||||||

|

||

||

LOG Expansion prefixSpecifies the prefix name for the files that TSM uses to create recovery log fileswhen expanding the recovery log.

MaximumsizeSpecifies the maximum size, in megabytes, of the recovery log.

Last Update by (administrator)Specifies the name of the administrator who most recently updated the recoverylog space trigger.

Last Update Date/TimeSpecifies when the administrator most recently updated the recovery log spacetrigger.

Related Commands

Table 188. Commands Related to QUERY SPACETRIGGER

Command Description




QUERY SPACETRIGGER


|||

||

|||

|||

|

|||

||

|||

|||

|||

|

QUERY SQLSESSION (Display SQL Session Value)

Use this command to display the current values of the SQL session attribute.

Privilege Class


Syntax

ÊÊ Query SQLsession ÊÍ

Parameters

None

Examples

Task

Display the current values of the SQL session attribute.

Command:query sqlsession

Output:

Column Date-Time Arithmetic CursorsDisplay Format Mode Allowed?Format-------- --------- ---------- --------Narrow ISO Truncate Yes

Column Display FormatThe format in which SQL data types are displayed. The default is NARROW, and itcan be overidden by the SET SQLDISPLAYMODE command.

Date-Time FormatThe format in which SQL date, time, and time stamp data are displayed. Thedefault is ISO, and it can be overidden by the SET SQLDATETIMEFORMATcommand.

Arithmetic ModeThe mode in which SQL arithmetic is carried out. The default is TRUNCATE, and itcan be overidden by the SET SQLMATHMODE command.

QUERY SQLSESSION


Cursors Allowed?The cursor is an object used for storing the output of a query for row by rowprocessing by the application.

Related Commands

Table 189. Commands Related to QUERY SQLSESSION

Command Description

SELECT Allows customized queries of the TSMdatabase.

SET SQLDATETIMEFORMAT Controls the formatting of date and time in thedisplay of SQL queries.

SET SQLDISPLAYMODE Controls the column width in the display of SQLqueries.

SET SQLMATHMODE Controls how decimal numbers are displayed inSQL queries.

QUERY SQLSESSION


QUERY STATUS (Query System Parameters)

Use this command for the following:

v To display the service level of the server

v To display information about the general server parameters, such as those defined bythe SET commands

v To display information about the general server parameters, such as those defined bythe SET commands

v To request information about client sessions, such as the availability of the server,password authentication, accounting settings, or the retention period for theinformation retained in the activity log

v To display information about the central scheduler, such as the central schedulingmode of the server

v To display the maximum number of retries allowed after a failed attempt to execute ascheduled command

Privilege Class


Syntax

ÊÊ Query STatus ÊÍ

Parameters

None.

Examples

Task

Display general information about server parameters; command was issued on aconfiguration manager.

Command:query status

Output:

QUERY STATUS


|

Server Name: SERVER1Server host name or IP address:

Server TCP/IP port number:Server URL:Crossdefine: Off

Server Password Set: NoServer Installation Date/Time: 05/21/1999 17:20:59

Server Restart Date/Time: 06/04/1999 13:42:52Authentication: On

Password Expiration Period: 90 Day(s)Invalid Sign-on Attempt Limit: 0

Minimum Password Length: 0WEB Admin Authentication Time-out (minutes): 10

Registration: ClosedAvailability: Enabled

Accounting: OffActivity Log Retention Period: 1 Day(s)

Activity Summary Retention Period:License Audit Period: 30 Day(s)

Last License Audit: 06/04/1999 13:12:37Server License Compliance: Valid

Central Scheduler: ActiveMaximum Sessions: 25

Maximum Scheduled Sessions: 12Event Record Retention Period: 10 Day(s)

Client Action Duration: 5 Day(s)Schedule Randomization Percentage: 25

Query Schedule Period: Client's ChoiceMaximum Command Retries: Client's Choice

Retry Period: Client's ChoiceScheduling Modes: Any

Log Mode: NormalDatabase Backup Trigger: Not Defined

Active Receivers: CONSOLE ACTLOGConfiguration manager?: Off

Refresh interval: 60Last refresh date/time:

where:

Server NameSpecifies the name of the server.

Server host name or IP addressSpecifies the server TCP/IP address.

Server TCP/IP port numberSpecifies the server port address.

Server URLSpecifies the URL address of the server that issued this command.

CrossdefineSpecifies whether another server running the DEFINE SERVER command willautomatically define itself to this server. See the SET CROSSDEFINE command.

Server Password SetSpecifies whether the password has been set for the server.

Server Installation Date/TimeSpecifies the date and time when the server was installed.

QUERY STATUS


||

|||

||

Server Restart Date/TimeSpecifies the last date and time when the server was started.

AuthenticationSpecifies whether password authentication is set on or off.

Password Expiration PeriodSpecifies the period, in days, after which the administrator or client node passwordexpires.

Invalid Sign-on Attempt LimitSpecifies the number of invalid sign-on attempts before a node is locked.

Minimum Password LengthSpecifies the minimum number of characters for the password.

WEB Admin Authentication Time-out (minutes)Specifies the time out, in minutes, allowed for Web administration authentication.

RegistrationSpecifies whether client node registration is open or closed.

AvailabilitySpecifies whether the server is enabled or disabled.

AccountingSpecifies whether an accounting record is generated at the end of each client nodesession.

Activity Log Retention PeriodSpecifies the number of days information is retained in the activity log.

Activity Summary Retention PeriodSpecifies the number of days information is retained in the SQL activity summarytable.

License Audit PeriodSpecifies the period, in days, after which the license manager automatically auditsthe TSM license. Additional licensing information is available by using the QUERYLICENSE command.

Last License AuditSpecifies the date and time when the last license audit occurred. Additionallicensing information is available by using the QUERY LICENSE command.

Server License ComplianceSpecifies whether the server is in compliance (Valid) or out of compliance (Failed)with the license terms. Use the QUERY LICENSE command to see what factorsare causing the server to fail to comply with the license terms.

Central SchedulerSpecifies whether central scheduling is running (active or inactive).

Maximum SessionsSpecifies the maximum number of client/server sessions.

QUERY STATUS


|||

Maximum Scheduled SessionsSpecifies the maximum number of client/server sessions available for processingscheduled work.

Event Record Retention PeriodSpecifies the number of days central scheduler event records are retained.

Client Action DurationSpecifies the duration of the period during which the client processes the scheduledefined with the DEFINE CLIENTACTION command.

Schedule Randomization PercentageSpecifies how much of the startup window is used for executing scheduled eventsin client-polling mode.

Query Schedule PeriodSpecifies the frequency with which clients poll the server to obtain scheduled work,in client-polling mode. If the value in this field is Client’s Choice, the pollingfrequency is determined by the client node.

Maximum Command RetriesSpecifies the maximum number of times that a client scheduler retries after a failedattempt to execute a scheduled command. If the value in this field is Client’sChoice, the client node determines the maximum number of retries.

Retry PeriodSpecifies the number of minutes between attempts by the client scheduler to retryafter a failed attempt to contact the server or to execute a scheduled command. Ifthe value in this field is Client’s Choice, the client node determines the number ofminutes between retries.

Scheduling ModesSpecifies the central scheduling modes supported by the server.

Log ModeSpecifies the mode for saving recovery log records. The mode is either roll-forwardor normal.

Database Backup TriggerSpecifies that TSM automatically runs a backup of the database if the databasebackup trigger is enabled.

Active ReceiversSpecifies the receivers for which event logging has begun.

Configuration manager?Specifies whether the server is a configuration manager.

Refresh intervalSpecifies the interval that elapses before the managed server requests a refresh ofany changes from a configuration manager.

Last refresh date/timeIf the server is a managed server, specifies the date and time of the last successfulrefresh of configuration information from the configuration manager.

QUERY STATUS


||

|||

|||

Related Commands

Table 190. Commands Related to QUERY STATUS

Command Description






SET ACCOUNTING Specifies whether accounting records arecreated at the end of each client session.


SET AUTHENTICATION Specifies whether clients are prompted for apassword at the beginning of a session.






SET PASSEXP Specifies the number of days after which apassword is expired and must be changed.

SET QUERYSCHEDPERIOD Specifies the frequency for clients to obtainscheduled work, in client-polling mode.

SET RANDOMIZE Specifies the randomization of start times withina window for schedules in client-polling mode.

SET REGISTRATION Specifies whether users can register themselvesor must be registered by an administrator.


SET SCHEDMODES Specifies the central scheduling mode for theserver.



SET SERVERNAME Specifies the name by which the server isidentified.


QUERY STATUS


QUERY STGPOOL (Query Storage Pools)

Use this command to display information about one or more storage pools. You canalso use this command to monitor migration processes for the storage pool.

Privilege Class


Syntax

ÊÊ Query STGpool*

pool_name

Format = Standard


Ê

ÊPOoltype = ANY

POoltype = ANYPRimaryCOpy

ÊÍ

Parameterspool_name

Specifies the storage pool to query. This parameter is optional. You can usewildcard characters to specify this name. If you do not specify a value for thisparameter, all storage pools are displayed.




POoltypeSpecifies the type of storage pool to query. This parameter is optional. The defaultvalue is ANY. Possible values are:

ANYQuery primary and copy storage pools.

PRimaryQuery only primary storage pools.

COpyQuery only copy storage pools.

QUERY STGPOOL


Examples

Task 1

Display information for the storage pool named POOL1.

Command:query stgpool pool1

Output:

Storage Device Estimated Pct Pct High Low NextPool Name Class Name Capacity Util Migr Mig Mig Storage

(MB) Pct Pct Pool---------- ---------- --------- ----- ----- ---- ---- --------POOL1 DISK 58.5 0.8 0.7 90 70 POOL2


Task 2

Display details for the storage pool named POOL1.

Command:query stgpool pool1 format=detailed

Output:

QUERY STGPOOL


Storage Pool Name: POOL1Storage Pool Type:Device Class Name: DISK

Estimated Capacity (MB): 58.5Pct Util: 0.0Pct Migr: 0.0

Pct Logical: 0.0High Mig Pct: 90Low Mig Pct: 70

Migration Delay: 0Migration Continue: YesMigration Processes:

Next Storage Pool: SPOOL2Reclaim Storage Pool:

Maximum Size Threshold: No LimitAccess: Read/Write

Description:Overflow Location:

Cache Migrated Files?:Collocate?: Yes

Reclamation Threshold: 60Maximum Scratch Volumes Allowed: 5

Delay Period for Volume Reuse: 0 Day(s)Migration in Progress?: No

Amount Migrated (MB): 0.00Elapsed Migration Time (seconds): 0

Reclamation in Progress?: NoVolume Being Migrated/Reclaimed:Last Update by (administrator): ADMIN


where:

Storage Pool NameThe name of the storage pool.

Storage Pool TypeThe type of storage pool.

Device Class NameThe name of the device class assigned to the storage pool.

Estimated Capacity (MB)The estimated capacity of the storage pool, in megabytes.

For DISK devices, this is the capacity of all volumes in the storage pool, includingany volumes that are varied offline.

For sequential access devices, this is an estimate of the total space of all thesequential access volumes in the storage pool, regardless of their access mode. Ifthe storage pool has stored data on at least one scratch volume, the estimatedcapacity includes the maximum number of scratch volumes allowed for the pool.

Pct UtilAn estimate of the utilization of the storage pool, as a percentage.

For sequential access devices, this is expressed as a percentage of the number ofactive bytes on each sequential access volume and the estimated capacity of allvolumes in the storage pool.

QUERY STGPOOL


For disk devices, this is expressed as a percentage of the estimated capacity,including cached data and data that resides on any volumes that are varied offline.The value for Pct Util can be higher than the value for Pct Migr if you issue thiscommand while a file creation transaction is in progress. The value for Pct Util isdetermined by the amount of space actually allocated (while the transaction is inprogress). The value for Pct Migr represents only the space occupied by committedfiles. At the end of the transaction, these values become synchronized.

The Pct Util value includes cached data on disk volumes. Therefore, when cache isenabled and migration occurs, the Pct Util value remains the same because themigrated data remains on the volume as cached data. The Pct Util value decreasesonly when the cached data expires or when the space that cached files occupyneeds to be used for noncached files.

Pct Migr (primary storage pools only)An estimate of the percentage of data in the storage pool that can be migrated.The server uses this value and the high and low migration thresholds to determinewhen to start and stop migration.

For disk devices, this value is specified as a percentage of the value for theestimated capacity, excluding cached data, but including data on any volumesvaried offline.

For sequential access devices, this value is the percentage of the total number ofvolumes in the pool that contain at least 1 byte of active data. The total number ofvolumes includes the maximum number of scratch volumes.

The Pct Util value includes cached data on a volume; the Pct Migr value excludescached data. Therefore, when cache is enabled and migration occurs, the Pct Migrvalue decreases but the Pct Util value remains the same because the migrateddata remains on the volume as cached data. The Pct Util value decreases onlywhen the cached data expires or when the space that cached files occupy needsto be used for noncached files.

Pct LogicalThe logical occupancy of the storage pool as a percentage of the total occupancy.Logical occupancy is space occupied by client files that may or may not be part ofan aggregate. A Pct Logical value less than 100% indicates that there is vacantspace within aggregates in the storage pool.

High Mig Pct (primary storage pools only)The high migration threshold, which specifies when the server can begin migrationfor the storage pool. The server starts migration processes when the percentage ofdata that can be migrated reaches this threshold.

Low Mig Pct (primary storage pools only)The low migration threshold, which specifies when the server can stop migration forthe storage pool. The server stops migration processes when the percentage ofdata that can be migrated reaches this threshold.

Migration Delay (primary storage pools only)The minimum number of days that a file must remain in a storage pool before theserver can migrate the file to the next storage pool. For a disk storage pool, thedays are counted from the time that the file was stored in the storage pool or last

QUERY STGPOOL


retrieved by a client. For a sequential access storage pool, the days are countedfrom the time that the file was stored in the storage pool.

Migration Continue (primary storage pools only)Whether the server continues to migrate files to the next storage pool even if thefiles have not been in the pool for the number of days specified by the migrationdelay.

Migration Processes (random access storage pools only)The number of processes that are used for migrating files from a storage pool.When files are migrated from this storage pool to a storage pool that uses physicaldrives, each migration process uses a drive. Therefore, the number of migrationprocesses should not exceed the number of drives that can be dedicated tomigration processing.

Next Storage Pool (primary storage pools only)The storage pool that is the destination for data that is migrated from this storagepool.

Reclaim Storage Pool (primary, sequential access storage pools only)If specified, the storage pool that is the destination for data moved from volumesduring reclamation processing. If no pool is specified, by default reclamationprocessing moves data only among volumes within the same storage pool.

Maximum Size Threshold (primary storage pools only)The maximum size of files that may be stored in the storage pool during a sessionwith a client.

AccessHow the data in the storage pool can be accessed.

DescriptionThe description of the storage pool.

Overflow Location (sequential access storage pools only)Overflow location does not apply to this operating environment.

Cache Migrated Files? (random access storage pools only)Whether caching is enabled for files migrated to the next storage pool.

Collocate? (sequential access storage pools only)Whether collocation is enabled.

Reclamation Threshold (sequential access storage pools only)The threshold that determines when volumes in a storage pool are reclaimed. Theserver compares the percentage of reclaimable space on a volume to this value todetermine if reclamation is necessary.

Maximum Scratch Volumes Allowed (sequential access storage pools only)The maximum number of scratch volumes that the server can request for thestorage pool.

Delay Period for Volume Reuse (sequential access storage pools only)The number of days that must elapse after all files have been deleted from avolume, before the server returns the volume to scratch or reuses the volume.

QUERY STGPOOL


Migration in Progress? (primary storage pools only)Whether at least one migration process is active for the storage pool.

Amount Migrated (MB) (primary storage pools only)The amount of data, in megabytes, that has been migrated, if migration is inprogress. If migration is not in progress, this value indicates the amount of datamigrated during the last migration. When multiple, parallel migration processes areused for the storage pool, this value indicates the total amount of data migrated byall processes.

Elapsed Migration Time (seconds) (primary storage pools only)The amount of time that has elapsed since migration began, if migration is active. Ifmigration is not active, this value indicates the amount of time required to completethe last migration. When multiple, parallel migration processes are used for thestorage pool, this value indicates the total time from the beginning of the firstprocess until the completion of the last process.

Reclamation in Progress? (sequential access storage pools only)Whether a reclamation process is active for the storage pool.

Volume Being Migrated/Reclaimed (sequential access storage pools only)The name of a volume for which migration or reclamation processing is active. If nomigration or reclamation processes are active, this field is blank.

Last Update by (administrator)The name of the administrator that has defined or most recently updated thestorage pool.

Last Update Date/TimeThe date and time that an administrator defined or most recently updated thestorage pool.

Related Commands

Table 191. Commands Related to QUERY STGPOOL

Command Description




QUERY STGPOOL


QUERY SUBSCRIBER (Display Subscriber Information)

Use this command on a configuration manager to display information about subscribersand their profile subscriptions.

Privilege Class


Syntax

ÊÊ Query SUBSCRIBer*

server_name

PROFIle = *

PROFIle = profile_nameÊÍ

Parametersserver_name

Specifies the name of managed server a for which subscription information isdisplayed. You can use wildcard characters to specify multiple server names. Thisparameter is optional. The default is all managed servers.

PROFIleSpecifies a profile name for which information is displayed. You can use wildcardcharacters to specify multiple profile names. This parameter is optional. The defaultis all profiles.

Examples

Task

Display subscriber information for all profile subscriptions to this configuration manager.

Command:query subscriber

Output:

Subscriber Profile name Is current? Last updatedate/time

--------------- --------------- ------------ --------------------SERVER2 DEFAULT_PROFILE Yes Thu, May 14, 1998

01:14:42 PMSERVER2 SETUP Yes Thu, May 14, 1998

01:14:42 PM

where:

SubscriberThe name of the subscriber (managed server).

QUERY SUBSCRIBER


||

||

|

|

|

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

|

|

||||

||||

|

|

|

||

|

||||||||

|

||


Is current?Whether the subscription has been refreshed with the current informationassociated with the profile. Possible values are:

YesThe managed server is current.

No The managed server is not current. If this field is NO after the profile has beenrefreshed, check the server messages for error conditions that might cause therefresh to fail.

UnknownEither the managed server has a more recent version of the profile than theconfiguration manager, or the profile no longer exists on the configurationmanager, but the subscription is still associated with the profile.

Last update date/timeSpecifies the date and time that configuration information for the subscription wassuccessfully distributed to the subscriber.

Related Commands

Table 192. Commands Related to QUERY SUBSCRIBER

Command Description







QUERY SUBSCRIBER


||

|||

||

||||

||||

|||

|

|||

||

||

||

||

|||

|||

||

|

QUERY SUBSCRIPTION (Display Subscription Information)

Use this command on a managed server to display profile subscription information.

Privilege Class


Syntax

ÊÊ Query SUBSCRIPtion*

profile_nameÊÍ

Parametersprofile_name

Specifies the name of the profile for which subscription information is displayed.You can use wildcard characters to specify multiple names. This parameter isoptional. The default is all profiles.

Examples

Task

Display subscription information for all profiles.

Command:query subscription

Output:

Configuration Profile name Last updatemanager date/time--------------- --------------- ---------SERVER1 ADMIN_INFO Thu, May 14, 1998

01:35:13 PMSERVER1 DEFAULT_PROFILE Thu, May 14, 1998

01:35:13 PMSERVER1 EMPLOYEE Thu, May 14, 1998

01:35:13 PM

where:

Configuration managerThe name of the configuration manager.


QUERY SUBSCRIPTION


||

|

|

|

|

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

|

|

||||

|

|

|

||

|

||||||||||

|

||

||

Last update date/timeWhen the most recent configuration information was successfully distributed to thesubscriber.

Related Commands

Table 193. Commands Related to QUERY SUBSCRIPTION

Command Description






QUERY SUBSCRIPTION


|||

|

|||

||

||

||

||

|||

|||

|

QUERY SYSTEM (Query the System Configuration and Capacity)

Use this command to obtain consolidated information regarding TSM configuration andcapacity. This command consolidates output from the following commands:

QUERY ASSOCIATION

QUERY COPYGROUP

QUERY DB

QUERY DBVOLUME

QUERY DEVCLASS

QUERY DOMAIN

QUERY LOG

QUERY LOGVOLUME

QUERY MGMTCLASS

QUERY OPTIONS

QUERY PROCESS

QUERY SCHEDULE

QUERY SESSION

QUERY STATUS

QUERY STGPOOL

QUERY VOLUME

Privilege Class


Syntax

ÊÊ Query SYStem ÊÍ

Examples

Task 1

Issue the QUERY SYSTEM command to obtain consolidated system information. Forsample outputs for these query commands, see the individual commands.

Command:query system

Related Commands

Table 194. Commands Related to QUERY SYSTEM

Command Description






QUERY SYSTEM


Table 194. Commands Related to QUERY SYSTEM (continued)

Command Description




QUERY OPTION Displays information about server options.







QUERY SYSTEM


QUERY VOLHISTORY (Display Sequential Volume History Information)

Use this command to display sequential volume history information. To save sequentialvolume history information to one or more files, use the BACKUP VOLHISTORYcommand.

Use the VOLHSTFILE server option on the CHGSVRADSM command to specify one ormore volume history files. After the server is restarted, TSM updates volume informationin both the database and the files.

Privilege Class


Syntax

ÊÊ Query VOLHistoryBEGINDate=date ENDDate=date BEGINTime=time

Ê

ÊENDTime=time

Type = All

Type = AllDBBackupDBDumpDBRpfEXPortRPFileSTGNewSTGReuseSTGDelete

ÊÍ

ParametersBEGINDate

Specifies that you want to display information beginning with records created onthe specified date. This parameter is optional. The default is the earliest date forwhich history information exists.





QUERY VOLHISTORY





TODAY–7 or –7.

To display information beginning withrecords created a week ago, specifyBEGINDATE=TODAY-7 orBEGINDATE=-7.

ENDDateSpecifies that you want to display information ending with records created on thespecified date. This parameter is optional. The default is the current date.







TODAY–1 or –1.

To display records created up to yesterday,specify ENDDATE=TODAY-1 orENDDATE=-1.

BEGINTimeSpecifies that you want to display information beginning with records created at thespecified time. This parameter is optional. The default is midnight (00:00:00).




12:33:28


NOW

NOW+HH:MM or+HH:MM


NOW+03:00 or +03:00.

If you issue this command at 9:00 withBEGINTIME=NOW+03:00 orBEGINTIME=+03:00. TSM displaysrecords with a time of 12:00 or later on thebegin date.



NOW−03:30 or −03:30.

If you issue this command at 9:00 withBEGINTIME=NOW−03:30 orBEGINTIME=−03:30, TSM displaysrecords with a time of 5:30 or later on thebegin date.

ENDTimeSpecifies that you want to display information ending with records created at thespecified time on the end date. This parameter is optional. The default is thecurrent time.

QUERY VOLHISTORY





10:30:08


NOW

NOW+HH:MM or+HH:MM


NOW+03:00 or+03:00.

If you issue this command at 9:00 withENDTIME=NOW+03:00 orENDTIME=+03:00, TSM displays recordswith a time of 12:00 or later on the enddate.



NOW−03:30 or −03:30

If you issue this command at 9:00 withENDTIME=NOW-3:30 or ENDTIME=-3:30,TSM displays records with a time of 5:30or earlier on the end date.

TypeSpecifies the type of records to display from the volume history file. This parameteris optional. The default is ALL. Possible values are:

All Specifies all records.

DBBackupSpecifies to display only records that contain information about volumes usedfor backups (volume types of BACKUPFULL and BACKUPINCR).

DBDumpSpecifies only records that contain information about online database dumpvolumes.

DBRpfSpecifies to display only records that contain information about full andincremental database backup volumes and recovery plan file object volumes(volume types of BACKUPFULL, BACKUPINCR, and RPFILE).

EXPortSpecifies only records that contain information about export volumes.

RPFileSpecifies to display only records that contain information about recovery planfile objects that are saved on a target server.

STGNewSpecifies only records that contain information about new sequential accessstorage volumes.

STGReuseSpecifies only records that contain information about reused sequential storagepool volumes.

QUERY VOLHISTORY


||

||||

|||

STGDeleteSpecifies only records that contain information about deleted sequentialstorage pool volumes.

Examples

Task

Display volume history information stored in the TSM database.

Command:query volhistory

Output:

Date/Time: 02/03/1999 18:28:06Volume Type: STGNEW

Backup Series: 0Backup Operation: 0

Volume Seq: 0Device Class: DC480Volume Name: QUSRADSM/MAINVOL(MAINVOL)

Volume Location:

Date/Time: 02/04/1999 16:20:46Volume Type: BACKUPFULL

Backup Series: 1Backup Operation: 0

Volume Seq: 1Device Class: DC480Volume Name: QUSRADSM/QUNR.dbb(00000001)

Volume Location:

Date/Time: 02/05/1999 16:26:02Volume Type: RPFILE

Backup Operation: 0Volume Seq: 1

Device Class: DEV.JANUSVolume Name: JANUS.19980518.162102

Volume Location: JANUS

where:

Date/TimeThe date and time that the volume was created.

Volume TypeThe type of volume:

BACKUPFULLFull database backup volume

BACKUPINCRIncremental database backup volume

DBDUMPOnline database dump

QUERY VOLHISTORY


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

|

EXPORTExport volume

RPFILERecovery plan file object volume created assuming full and incrementaldatabase backups

STGDELETEDeleted sequential access storage pool volume

STGNEWAdded sequential access storage pool volume

STGREUSEReused sequential access storage pool volume

Backup Series

The value of this field is always zero (0) for all volume types except BACKUPFULL,BACKUPINCR, and RPFILE.

If the volume type is BACKUPFULL or BACKUPINCR, the number shown hereidentifies the backup series. Each backup series consists of a full backup and allincremental backups that apply to that full backup. Another series begins with thenext full backup of the database.

If the volume type is RPFILE, the number shown here identifies the backup seriesthat is associated with the RPFILE entry.

Backup Operation

The value of this field is always zero (0) for all volume types except BACKUPFULLand BACKUPINCR.

If the volume type is BACKUPFULL or BACKUPINCR, the number shown hereidentifies the operation number of this backup volume within the backup series. Thefull backup within a backup series is operation 0. The first incremental backup forthat full backup is operation 1, the second incremental backup is operation 2, andso on.

This field is blank when the volume type is BACKUPSET.

Volume Seq

The value of this field is always zero (0) for all volume types except BACKUPFULL,BACKUPINCR, EXPORT, or RPFILE.

The value of this field is always one (1) for a volume type of RPFILE.

If the volume type is BACKUPFULL, BACKUPINCR, or EXPORT, the numbershown here identifies the sequence number of the volume when it was used forbacking up the database or for exporting data.

If the volume type is BACKUPFULL or BACKUPINCR, this number is thesequence, or position, of the volume within the backup series. Volume sequence 1identifies the first volume used for the first operation (a full backup), and so on. Forexample, if the full backup occupies three volumes, these volumes are identified as

QUERY VOLHISTORY


|||

|

||

||||

||

|

||

|||||

|

||

|

|||

||||

volume sequence 1, 2, and 3, respectively. The first volume of the next operation(the first incremental backup) is then volume sequence 4.

Device ClassThe name of the device class associated with this volume.

Volume NameThe name of the volume.

Volume LocationThe location of the volume. This information is available only for volume types ofBACKUPFULL, BACKUPINCR, DBDUMP, EXPORT and RPFILE.

For RPFILE this location field is the server name defined in the device classdefinition used by the PREPARE command when the DEVCLASS parameter isspecified.

Related Commands

Table 195. Commands Related to QUERY VOLHISTORY

Command Description






QUERY VOLHISTORY


||

|||

QUERY VOLUME (Query Storage Pool Volumes)

Use this command to display information about storage pool volumes.

Privilege Class


Syntax

ÊÊ Query Volume*

volume_name

·

,

ACCess = READWriteREADOnlyUNAVailableOFfsiteDEStroyed

Ê

Ê

·

,

STatus = ONlineOFflineEMPtyPENdingFILlingFULl

STGpool = *

STGpool = pool_nameÊ

ÊDEVclass = *

DEVclass = device_class_name

Format = Standard


ÊÍ


Specifies the volume to query. This parameter is optional. You can use wildcardcharacters to specify names. If you do not specify a name, all storage poolvolumes are included in the query.

ACCessSpecifies that output is restricted by volume access mode. This parameter isoptional. You can specify multiple access modes by separating the modes withcommas and no intervening spaces. If you do not specify a value for thisparameter, output is not restricted by access mode. Possible values are:

READWriteDisplay volumes with an access mode of READWRITE.

QUERY VOLUME


READOnlyDisplay volumes with an access mode of READONLY.

UNAVailableDisplay volumes with an access mode of UNAVAILABLE.

OFFsiteDisplay volumes with an access mode of OFFSITE.

DEStroyedDisplay volumes with an access mode of DESTROYED.

STatusSpecifies that output is restricted by volume status. This parameter is optional. Youcan specify multiple status values by separating values with commas and nointervening spaces. If you do not specify a value for this parameter, output is notrestricted by volume status. Possible values are:

ONlineDisplay volumes with a status of ONLINE.

OFflineDisplay volumes with a status of OFFLINE.

EMPtyDisplay volumes with a status of EMPTY.

PENdingDisplay volumes with a status of PENDING. These are volumes from which allfiles have been deleted, but the time specified by the REUSEDELAYparameter from the DEFINE STGPOOL command has not elapsed.

FILlingDisplay volumes with a status of FILLING.

FULlDisplay volumes with a status of FULL.

STGPoolSpecifies the storage pool to include in the query. This parameter is optional. Youcan use wildcard characters to specify names. If you do not specify a storage poolname, all storage pools are included in the query.

DEVclassSpecifies the device class to include in the query. This parameter is optional. Youcan use wildcard characaters to specify names. If you do not specify a device classname, all devices are included in the query.




QUERY VOLUME


Examples

Task 1

In the root file system, display information on all storage pool volumes prefixed with thename ATF.

Command:query volume atf*

Output:

Volume Name Storage Device Estimated Pct VolumePool Name Class Name Capacity Util Status

(MB)----------------------- ----------- ---------- --------- ----- -------/qusradsm/server/atf001 BACKUPPOOL DISK 400.1 18.3 On-Line/qusradsm/server/atf002 BACKUPPOOL DISK 400.1 18.8 On-Line/qusradsm/server/atf003 BACKUPPOOL DISK 400.1 18.9 On-Line


Task 2

In the library file system, display information in full detail about the storage pool volumethat is named PROG2.

Command:query volume prog2 format=detailed

Output:

Volume Name: QUSRADSM/PROG2(PROG2)Storage Pool Name: PRIMARY POOLDevice Class Name: DC480

Estimated Capacity (MB): 5.8Pct Util: 0.1

Volume Status: On-lineAccess: Read/Write

Pct. Reclaimable Space: 3.2Scratch Volume?:In Error State?: No

Number of Writable Sides: 1Number of Times Mounted: 11

Write Pass Number: 1Approx. Date Last Written: 04/14/1998 16:17:26

Approx. Date Last Read: 04/01/1998 13:26:18Date Became Pending:

Number of Write Errors: 0Number of Read Errors: 0

Volume Location:Last Update by (administrator): COLLIN


where:

QUERY VOLUME


||

||

||

||||||||

|

||

||

||

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

|

Volume NameThe name of the storage pool volume.

Storage Pool NameThe storage pool to which the volume is defined.

Device Class NameThe device class assigned to the storage pool.

Estimated Capacity (MB)The estimated capacity of the volume, in megabytes.

For DISK devices, this value is the capacity of the volume.

For sequential access devices, this value is an estimate of the total space availableon the volume, based on the device class.

Pct UtilAn estimate of the utilization of the volume. The utilization includes all spaceoccupied by both non-aggregated files and aggregates, including empty spacewithin aggregates.

For DISK volumes, the utilization also includes space occupied by cached data.

Volume StatusThe status of the volume.

AccessWhether the volume is available to the server.

Pct. Reclaimable Space (sequential access volumes only)The amount of space on this volume that can be reclaimed because data hasexpired or been deleted. This value is compared to the reclamation threshold forthe storage pool to determine if reclamation is necessary. Reclaimable spaceincludes empty space within aggregates.

Scratch Volume? (sequential access volumes only)Whether this volume was originally a scratch volume that the server acquired for itsuse. If the volume was a scratch volume, the server returns the volume to scratchwhen the volume becomes empty.

In Error State?Whether the volume is in an error state. The server cannot write to volumes in anerror state.

Number of Writable SidesThis information is reserved for TSM.

Number of Times MountedThe number of times the volume has been mounted.

Write Pass Number (sequential access volumes only)The number of times the volume has been written to from the beginning to the end.

Approx. Date Last WrittenThe approximate date on which the volume was last written.

QUERY VOLUME


Approx. Date Last ReadThe approximate date on which the volume was last read.

Date Became PendingThe date that the status of the volume changed to pending.

Number of Write ErrorsThe number of writing errors that have occurred on the volume.

Number of Read ErrorsThe number of reading errors that have occurred on the volume.

Volume LocationThe location of the volume.

Last Update by (administrator)The administrator that defined or most recently updated the volume.

Last Update Date/TimeWhen the volume was defined or most recently updated.

Related Commands

Table 196. Commands Related to QUERY VOLUME

Command Description





QUERY VOLUME


QUIT (End the Interactive Mode of the Administrative Client)

Use this command to end an administrative client session in interactive mode.

You cannot use the QUIT command from the SERVER_CONSOLE administrative ID, orthe console, batch, or mount modes of the administrative client.

Privilege Class


Syntax

ÊÊ QUIT ÊÍ

Parameters

None.

Examples

Task

End an administrative client session in the interactive mode.

Command:quit

Related Commands

Table 197. Commands Related to QUIT

Command Description

None

QUIT


RECONCILE VOLUMES (Reconcile Differences in the Virtual Volume Definitions)

Issue this command from the source server to reconcile differences between virtualvolume definitions on the source server and archive files on the target server. TSMfinds all volumes of the specified device class on the source server and allcorresponding archive files on the target server. The target server inventory is alsocompared to the local definition for virtual volumes to see if inconsistencies exist.

Privilege Class


Syntax

ÊÊ REConcile Volumes*

device_class_name

Fix = No

Fix = NoYes

Ê

ÊSKIPPartial = No

SKIPPartial = NoYes

Quiet = No

Quiet = NoYes

ÊÍ


Specifies the device class name of the virtual volumes. If you do not specify aname, TSM reconciles all virtual volumes. This parameter is optional.

FIXSpecifies whether or not TSM attempts to correct any identified inconsistencies.This parameter is optional. The default is NO. Possible values are:

No Specifies that TSM does not fix any inconsistencies.

YesSpecifies that TSM makes the following corrections:

v TSM marks as unavailable storage pool volumes on the source server thatcannot be located on the target server. Volumes that are only found in thevolume history, such as database backups and import and export volumes,are reported as being inconsistent.

v Archive files on the target server that do not correspond to any virtualvolumes on the source server are marked for deletion from the target server.

RECONCILE VOLUMES


The following table shows the details of the actions taken:

FIX= At theSourceServer

At the Target Server Action

NO

Volumesexist

No files exist

Report errorFiles exist but are markedfor deletion

Active files exist butattributes do not match

Volumes donot exist

Active files exist Report error

Files exist but are markedfor deletion

None

YES

Volumesexist

No files exist Report error

Storage pool volumes: Marked asunavailable

Files exist but marked fordeletion

Report error

Storage pool volumes: If attributesmatch, mark files on the target serveras active again, mark volumes on thesource server as unavailable, andrecommend that an AUDIT VOLUMEbe done to verify the data. If attributesdo not match, mark volumes asunavailable.

Active files exist butattributes do not match

Report error

Storage pool volumes: Mark asunavailable and recommend that anAUDIT VOLUME be done to verify thedata.

Volumes donot exist

Active files existMark files for deletion on the targetserver.

Files exist but marked fordeletion

None

SKIPPartialSpecifies whether TSM does not audit files that span multiple sequential accessstorage pool volumes (skipped files) This parameter is optional. The default is NO.Possible values are:

No Specifies that TSM audits files that span multiple volumes.

YesSpecifies that TSM does not audit files that span multiple volumes. This optionprevents additional media mounts to audit any skipped files. The status ofskipped files is unknown.

QuietSpecifies whether or not TSM sends detailed informational messages to the activity

RECONCILE VOLUMES


log and the server console about irretrievable files on the volume. This parameteris optional. The default is NO. Possible values are:

No TSM sends detailed informational messages and a summary report. Eachmessage contains the node, file space, and client name for the file.

YesTSM only sends a summary report.

Examples

Task

Reconcile the differences between all virtual volumes definitions on the source serverand archive files on the target server to correct any inconsistencies.

Command:reconcile volumes remote1 fix=yes

Related Commands

Table 198. Commands Related to RECONCILE VOLUMES

Command Description






RECONCILE VOLUMES


REDUCE DB (Decrease the Assigned Capacity of the Database)

Use this command to decrease the space that can be used by the database.

The REDUCE DB command can be initiated while users are accessing the server. Usethe QUERY DB command to determine how much you can reduce the assignedcapacity of the database.

This command can generate a background process that can be canceled with theCANCEL PROCESS command. If a REDUCE DB background process is canceled, theassigned capacity of the database may be partially reduced. To display information onbackground processes, use the QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ REDuce DB megabytes ÊÍ


Specifies the number of megabytes to be removed from the assigned capacity ofthe database. This value should be in increments of 4MB. If you do not specify thereduction in 4MB increments, TSM rounds the number to the next 4MB partition.

Examples

Task

Reduce the size of the database by 52MB.

Command:reduce db 52

Related Commands

Table 199. Commands Related to REDUCE DB

Command Description




REDUCE DB


Table 199. Commands Related to REDUCE DB (continued)

Command Description





REDUCE DB


REDUCE LOG (Decrease the Assigned Capacity of the Recovery Log)

Use this command to decrease the space that can be used by the recovery log.

You can use the REDUCE LOG command while users are accessing the server. Usethe QUERY LOG command to determine how much you can reduce the assignedcapacity of the recovery log.

This command can generate a background process that can be canceled with theCANCEL PROCESS command. If a REDUCE LOG background process is canceled,the assigned capacity ofthe recovery log may be partially reduced. To displayinformation on background processes, use the QUERY PROCESS command.

Privilege Class


Syntax

ÊÊ REDuce LOG megabytes ÊÍ


Specifies the number of megabytes to be removed from the assigned capacity ofthe recovery log. The value is in increments of 4MB. If you do not specify thereduction in 4MB increments, TSM rounds the number to the next 4MB partition

Examples

Task

Reduce the size of the recovery log by 16MB.

Command:reduce log 16

Related Commands

Table 200. Commands Related to REDUCE LOG

Command Description



REDUCE LOG


Table 200. Commands Related to REDUCE LOG (continued)

Command Description









REDUCE LOG


REGISTER ADMIN (Register an Administrator)

Use this command to add an administrator to the server. After registration, theadministrator can issue a limited set of commands, including all query commands. Toprovide additional privileges, use the GRANT AUTHORITY command.

Privilege Class


Syntax

ÊÊ REGister Admin admin_name passwordPASSExp = days

Ê

ÊCONtact = text

FORCEPwreset = No

FORCEPwreset = NoYes

ÊÍ


Specifies the name of the administrator to be registered. The maximum length ofthe name is 64 characters. The password is not case-sensitive. See “NamingConventions for Tivoli Storage Manager” on page 9 for a table that lists thecharacters available for specifying a password.

You cannot specify an adminstrator name of NONE.

password (Required)Specifies the password of the administrator to be registered. The maximum lengthof the password is 64 characters.

PASSExpSpecifies the number of days the password remains valid. You can set thepassword expiration period from 0 to 9999 days. A value of 0 means that thepassword never expires. This parameter is optional. If you do not specify thisparameter, the password is set with the global expiration period of 90 days.

CONtactSpecifies information identifying the administrator being registered. This parameteris optional. The maximum length of this string is 255 characters. The contactinformation must be enclosed in quotation marks if it contains any blanks.

FORCEPwresetSpecifies whether the administrator is required to change or reset the password.This parameter is optional. The default value is NO. Possible values are:

REGISTER ADMIN


|||

|

|||||

No Specifies that the administrator does not need to change or reset the passwordwhile attempting to sign on to the server.

YesSpecifies that the administrator’s password will expire at the next sign-on. Theclient or administrator must change or reset the password at that time. If apassword is not specified, you will receive an error message.

Examples

Task

Define an administrator, LARRY, with the password PASSONE. You can identify LARRYas second-shift personnel by specifying this information with the CONTACT parameter.

Command:register admin larry passone contact='second shift'

Related Commands

Table 201. Commands Related to REGISTER ADMIN

Command Description





REMOVE ADMIN Removes an administrator from the list ofregistered administrators.



UNLOCK ADMIN Enables a locked administrator to access TSM.

UPDATE ADMIN Changes the password or contact informationassociated with any administrator.


REGISTER ADMIN


REGISTER LICENSE (Register a New License)

Use the REGISTER LICENSE command to register a new license with the TSM serverand to change existing license terms. You can register a new license for the following:

v Additional clients

v OpenSystem environment

v Space-managed clients

v Disaster Recovery Manager (DRM)

v Server-to-server virtual volume support

Privilege Class


Syntax

ÊÊ REGister LICense CLIENTS numberENTERPRISEADMINOPENSYSTEMSSPACEMGMTDRMVIRTVOLS

ÊÍ

ParametersCLIENTS number

Specifies the licensed number of client connections for the server.

ENTERPRISEADMINSpecifies that the server is licensed to support enterprise administration.

OPENSYSTEMSSpecifies that the server is licensed to support OpenSystems environment clients.

SPACEMGMTSpecifies that the server is licensed to support space managed clients. If the serveris not licensed for space management, migration operations for clients using spacemanagement fail.

DRMSpecifies that the server is licensed to support disaster recovery manager (DRM). Ifthe server is not licensed for DRM, DRM operations will fail.

VIRTVOLSSpecifies that the server is licensed to support virtual volumes.

REGISTER LICENSE


||

Examples

Task

Register a new license with the TSM server for support of 500 client connections.

Command:register license clients 500

Related Commands

Table 202. Commands Related to REGISTER LICENSE

Command Description






REGISTER LICENSE


REGISTER NODE (Register a Client Node)

Use this command to register a client node to the server.

This command also automatically creates an administrative user ID with client ownerauthority over the node. You can use this administrative user ID to access the Webbackup-archive client from remote locations through a Web browser. If an administrativeuser ID already exists with the same name as the node being registered, anadministrative user ID is not automatically defined. The client node is registered withoutan administrative user ID. This process also applies if your site uses open registration.

If a client requires a different policy domain than STANDARD, you must register theclient node with this command or update the registered node.

Privilege Class


Syntax

ÊÊ REGister Node node_name passwordPASSExp = days

Ê

ÊUSerid = node_name

USerid = NONEuser_id

CONtact = text DOmain = domain_nameÊ

ÊCOMPression = Client

COMPression = ClientYesNo

ARCHDELete = Yes

ARCHDELete = YesNo

Ê

ÊBACKDELete = No

BACKDELete = NoYes

CLOptset = option_set_nameÊ

ÊFORCEPwreset = No


Type = Client

Type = ServerClient

URL = urlÊÍ

REGISTER NODE


||||||


Specifies the name of the client node to be registered. The maximum length of thename is 64 characters.

You cannot specify a node name of NONE.

password (Required)Specifies the client node’s password. The maximum length of the name is 64characters. The password is not case-sensitive. See “Naming Conventions for TivoliStorage Manager” on page 9 for a table that lists the characters available forspecifying a password.

PASSExpSpecifies the number of days the password remains valid. You can set thepassword expiration period from 0 to 9999 days. A value of 0 means that thepassword never expires. This parameter is optional. If you do not specify thisparameter, the password is set with the global expiration period of 90 days.

USeridSpecifies the administrative user ID with client owner authority. If you do not specifya user ID, by default an administrative user ID with client owner authority is createdusing the nodename of the client node to be registered. This parameter is optional.When PASSWORDACCESS=GENERATE is used by the client to change thepassword, the administrative ID with the same name can be used to access theweb backup-archive client from a remote location. Possible values are:

NONESpecifies that an administrative user ID will not be automatically defined.

otheruseridSpecifies a node ID different than the node being registered. You can use thisparameter to grant client owner authority to an existing administrative user ID.

CONtactSpecifies a text string of information identifying the node. The parameter isoptional. The maximum length of the text string is 255 characters. The contactinformation must be enclosed in quotation marks if it contains any blanks.

DOmainSpecifies the name of the policy domain to which the node is assigned. Theparameter is optional. If you do not specify a policy domain name, the node isassigned to the default policy domain (STANDARD).

When a source server is registered as a node, it is assigned to a policy domain.Data from the source server is stored in the storage pool specified in the archivecopy group of the default management class of that domain.

COMPressionSpecifies whether the client node compresses its files before sending them to theserver for backup and archive. The parameter is optional. The default value isCLIENT. Possible values are:

ClientSpecifies that the client determines whether to compress files.

REGISTER NODE


|

|||

|||||

|||||||

||

|||

|

YesSpecifies that the client node compresses its files before sending them to theserver for backup and archive.

No Specifies that the client node does not compress its files before sending themto the server for backup and archive.

ARCHDELeteSpecifies whether the client node can delete its own archive files from the server.The parameter is optional. The default value is YES. Possible values are:

YesSpecifies that the client node can delete its own archive files from the server.

No Specifies that the client node cannot delete its own archive files from theserver.

BACKDELeteSpecifies whether the client node can delete its own backup files from the server.The parameter is optional. The default value is NO. Possible values are:

No Specifies that the client node cannot delete its own backup files from theserver.

YesSpecifies that the client node can delete its own backup files from the server.

CLOptsetSpecifies the name of the option set to be used by the client. The parameter isoptional.

FORCEPwresetSpecifies whether to force a client to change or reset the password. The parameteris optional. The default value is NO. Possible values are:

No Specifies that the password expiration period is set by the SET PASSEXPcommand. The client does not need to change or reset the password whileattempting to logon to the server.

YesSpecifies that the client node password will expire at the next logon. The clientmust change or reset the password at that time. If a password is not specified,you will receive an error message.

TypeSpecifies the type of node being registered. The parameter is optional. The defaultvalue is CLIENT. Possible values are:

ClientSpecifies that the client node is a backup-archive or HSM client.

ServerSpecifies that the client node is a source server being registered on the targetserver.

REGISTER NODE


URLSpecifies the URL address that is used in your Web browser to administer the TSMclient. The parameter is optional.

Examples

Task 1

Register the client node JOEOS2 with the password SECRETCODE and assign thisnode to the DOM1 policy domain. This node can delete its own backup and archivefiles from the server. All files are compressed by the client node before they are sent tothe server. This command automatically creates a JOEOS2 administrative user ID withpassword SECRETCODE. In addition, the administrator now has client owner authorityto the JOEOS2 node.

Command:register node joeos2 secretcode domain=dom1 archdelete=yesbackdelete=yes compression=yes

Task2

Register the client node FRAN and prevent an administrative user ID from beingautomatically defined.

Command:register node fran xy34z userid=none

Task 3

Grant client owner authority to an existing administrative user ID, HELPADMIN, whenregistering the client node JAN. This would not automatically create an administrator IDnamed JAN, but would grant client owner authority for this node to the HELPADMINadministrator.

Command:register node jan pwdsafe userid=helpadmin

Related Commands

Table 203. Commands Related to REGISTER NODE

Command Description







REGISTER NODE


|||

|

||

||

|

||||

||

|

Table 203. Commands Related to REGISTER NODE (continued)

Command Description




SET REGISTRATION Specifies whether users can register themselvesor must be registered by an administrator.




REGISTER NODE


REMOVE ADMIN (Delete an Administrator)

Use this command to remove an administrator from the system.

You cannot remove the last system administrator or the SERVER_CONSOLEadministrative ID from the system.

Privilege Class


Syntax

ÊÊ REMove Admin admin_name ÊÍ


Specifies the name of the administrator to be removed.

Examples

Task

Remove the administrator LARRY.

Command:remove admin larry

Related Commands

Table 204. Commands Related to REMOVE ADMIN

Command Description





REMOVE ADMIN


REMOVE NODE (Delete a Client Node or an Associated Machine Node)

Use this command to remove a client node from the server. If you are using the TivoliDisaster Recovery Manager (DRM) feature and the node to be removed is associatedwith a machine, the association between the node and the machine is also deleted.

When a node is removed, the corresponding administrative ID is removed only if:

v The administrator name is identical to the client node name.

v The administrator has client owner or client access authority only to the node beingremoved.

v The administrator is not a managed object.

Attention: Before you can remove a client node, you must delete all backup andarchive file spaces that belong to that client node.

Privilege Class


Syntax

ÊÊ REMove Node node_name ÊÍ


Specifies the name of the node to be removed.

Examples

Task

Remove the client node LARRY.

Command:remove node larry

Related Commands

Table 205. Commands Related to REMOVE NODE

Command Description





REMOVE NODE


|

|

||

|

|

Table 205. Commands Related to REMOVE NODE (continued)

Command Description





REMOVE NODE


RENAME ADMIN (Rename an Administrator)

Use this command to change the name of an existing administrator. Existing informationfor this administrator such as password, contact information, and privilege classes is notaltered.

If you are assigning an existing administrative user ID to another person, it isrecommended that you use the UPDATE ADMIN command to change the password.

You cannot rename the SERVER_CONSOLE administrative ID.

Privilege Class


Syntax

ÊÊ REName Admin current_admin_name new_admin_name ÊÍ

Parameterscurrent_admin_name (Required)

Specifies the name of the administrator to be renamed.

new_admin_name (Required)Specifies the new administrator name. The maximum length of the name is 64characters.

Examples

Task

Rename the TSM administrator CLAUDIA to BILL.

Command:rename admin claudia bill

Related Commands

Table 206. Commands Related to RENAME ADMIN

Command Description



RENAME ADMIN


RENAME FILESPACE (Rename a Client File Space on the Server)

Use this command to rename an existing client file space on the server to a new filespace name or to rename imported file spaces.

If the name of an imported file space is the same as a file space that already exists ona client node, the server will not overlay the existing file space. Instead, the systemgenerates a new name for the imported file space. However, this new name couldmatch an existing name on the client node, which may have file spaces not yet backedup to the server.

Privilege Class

Any administrator with unrestricted policy authority or with restricted policy authorityover the client’s policy domain can issue this command.

Syntax

ÊÊ REName FIlespace node_name current_file_space_name new_file_space_name ÊÍ


Specifies the name of the client node to which the file space to be renamedbelongs.

current_file_space_name (Required)Specifies the name of the file space to be renamed. A file space name iscase-sensitive and must be specified exactly as defined to the server.

new_file_space_name (Required)Specifies the new name for the file space. A client file space name iscase-sensitive and must be specified exactly as it is to be defined to the server.

Examples

Task

An AIX client node named LARRY backed up file space /r033 to the TSM server. Thefile space was exported to tape and later reimported to the server. When this file spacewas imported, a system-generated name, /r031, was created for it because /r033already existed for client node LARRY.

Client node LARRY, however, already had a file space named /r031 that was notbacked up, therefore, was unknown to the server. Unless the imported file space isrenamed, it will overlay filespace /r031 because the file space name generated by theIMPORT function is the same as a file space on client node LARRY that is unknown tothe server.

RENAME FILESPACE


Use the following command to rename imported filespace /r031:

Command:rename file space larry /r031 /imported-r033

The new name, /imported-r033, identifies that the new filespace is an imported image offilespace /r033.

Related Commands

Table 207. Commands Related to RENAME FILESPACE

Command Description




QUERY OCCUPANCY Displays file space information by storage pool.

RENAME FILESPACE


RENAME NODE (Rename a Client Node)

Use this command to rename a client node.

If you are assigning an existing client node ID to another person, it is recommendedthat you use the UPDATE NODE command to change the password.

Privilege Class


Syntax

ÊÊ REName Node current_node_name new_node_name ÊÍ

Parameterscurrent_node_name

Specifies the name of the client node to be renamed. This parameter is required.

new_node_nameSpecifies the new name of the client node. The maximum length of the name is 64characters. This parameter is required.

Examples

Task

Rename the client node JOE to JOYCE.

Command:rename node joe joyce

Related Commands

Table 208. Commands Related to RENAME NODE

Command Description



RENAME NODE


RENAME SCRIPT (Rename a Tivoli Storage Manager Script)

Use this command to rename a TSM script.

Privilege Class

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

Syntax

ÊÊ REName SCRipt current_script_name new_script_name ÊÍ

Parameterscurrent_script_name (Required)

Specifies the name of the script to rename.

new_script_name (Required)Specifies the new name for the script. The name can contain as many as 30characters.

Examples

Task

Rename SCRIPT1 to a new script named SCRIPT2.

Command:rename script script1 script2

Related Commands

Table 209. Commands Related to RENAME SCRIPT

Command Description





RUN Runs a script.


RENAME SCRIPT


||

|

|

||

|

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

|

|

||

|||

|

|

|

||

|

|||

||

||

||

|||

||

||

||

|

RENAME SERVERGROUP (Rename a Server Group)

Use this command to rename a server group.

Privilege Class


Syntax

ÊÊ RENAME SERVERGRoup current_group_name new_group_name ÊÍ

Parameterscurrent_group_name (Required)

Specifies the server group to rename.

new_group_name (Required)Specifies the new name of the server group. The maximum length of the name is64 characters.

Examples

Task

Rename server group WEST_COMPLEX to BIG_WEST.

Command:rename servergroup west_complex big_west

Related Commands

Table 210. Commands Related to RENAME SERVERGROUP

Command Description






RENAME SERVERGROUP


||

|

|

|

|

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

|

|

||

|||

|

|

|

||

|

|||

||

||

||

||

||

||

|

RENAME STGPOOL (Change the Name of a Storage Pool)

Use this command to change the name of a storage pool. You can change storage poolnames so that the same names can be used on a configuration manager and itsmanaged servers.

When you change a storage pool name, any administrators with restricted storageprivilege for the old storage pool are automatically given restricted storage privilege forthe renamed storage pool. However, if a management class or copy group specifies theexisting storage pool as the destination for files, the destination is not changed to thenew storage pool name.

If processes are active when a storage pool is renamed, the old name may still bedisplayed in messages or queries for those processes.

Privilege Class


Syntax

ÊÊ REName STGpool current_pool_name new_pool_name ÊÍ

Parameterscurrent_pool_name (Required)

Specifies the storage pool to rename.

new_pool_name (Required)Specifies the new name of the storage pool. The maximum length of the name is30 characters.

Examples

Task

Rename storage pool STGPOOLA to STGPOOLB:

Command:rename stgpool stgpoola stgpoolb

Related Commands

Table 211. Commands Related to RENAME STGPOOL

Command Description


RENAME STGPOOL


||

|||

|||||

||

|

|

|

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

|

|

||

|||

|

|

|

||

|

|||

||

|||

Table 211. Commands Related to RENAME STGPOOL (continued)

Command Description






RENAME STGPOOL


|

||

|||

||

||

|||

||

|

REPLY (Allow a Request to Continue Processing)

Use this command and the identification number to inform the server that you havecompleted the requested operation. Not all requests require a reply. This command isrequired only if the request message specifically indicates that a REPLY is needed.

Privilege Class


Syntax

ÊÊ REPLY request_numberdevice_name

ÊÍ

Parametersrequest_number (Required)

Specifies the identification number of the request.

device_nameSpecifies the name of the device that corresponds to the drive. For example, youcan specify tap04. This parameter is required for manual libraries with a driveselection of operator. This parameter is not applicable to libraries with a driveselection of automatic.

Examples

Task

Respond to a reply request using 3 as the request number.

Command:reply 3

Related Commands

Table 212. Commands Related to REPLY

Command Description

CANCEL REQUEST Cancels pending volume mount requests.

QUERY REQUEST Displays information about all pending mountrequests.

REPLY


RESET BUFPOOL (Reset the Database Buffer Pool Statistics)

Use this command to reset the database buffer pool statistics. The buffer pool statisticsconsist of the following:

v The number of database requests since the last RESET BUFPOOL command orsince the server was last started.

v The percentage of database page requests that are in the buffer pool as cachedcopies.

v The percentage of database requests that waited for a page in the buffer pool tobecome available.

You can use the QUERY DB command (FORMAT=DETAILED) to display the detailedbuffer pool statistics.

Privilege Class

To issue this command, you must have system privilege or analyst privilege.

Syntax

ÊÊ RESet BUFPool ÊÍ

Parameters

None.

Examples

Task

Reset the buffer pool statistics.

Command:reset bufpool

Related Commands

Table 213. Commands Related to RESET BUFPOOL

Command Description


RESET DBMAXUTILIZATION Resets the maximum utilization statistic for thedatabase.

RESET LOGMAXUTILIZATION Resets the maximum utilization statistic for therecovery log.

RESET BUFPOOL


RESET DBMAXUTILIZATION (Reset the Utilization Statistic for the Database)

Use this command to reset the maximum utilization statistic for the database to thecurrent utilization.

You can use the QUERY DB command (FORMAT=DETAILED) to display the detailedbuffer pool statistics.

Privilege Class


Syntax

ÊÊ RESet DBMaxutilization ÊÍ

Parameters

None.

Examples

Task

Reset the maximum utilization statistic for the database.

Command:reset dbmaxutilization

Related Commands

Table 214. Commands Related to RESET DBMAXUTILIZATION

Command Description


RESET BUFPOOL Resets the buffer pool statistics for thedatabase.

RESET DBMAXUTILIZATION


RESET LOGCONSUMPTION (Reset the Cumulative Log Consumption Statistic)

Use this command to reset the statistic on the amount of recovery log space used sincethe last reset.

Privilege Class

To issue this command, you must have analyst privilege.

Syntax

ÊÊ RESet LOGConsumption ÊÍ

Parameters

None.

Examples

Task

Reset the statistic for recovery log consumption.

Command:reset logconsumption

Related Commands

Table 215. Commands Related to RESET LOGCONSUMPTION

Command Description



RESET LOGCONSUMPTION


RESET LOGMAXUTILIZATION (Reset the Utilization Statistic for the Log)

Use this command to reset the maximum utilization statistic for the recovery log to 0.You can display the maximum utilization statistic with the QUERY LOG command.

Privilege Class


Syntax

ÊÊ RESet LOGMaxutilization ÊÍ

Parameters

None.

Examples

Task

Reset the maximum utilization statistic for the recovery log.

Command:reset logmaxutilization

Related Commands

Table 216. Command Related to RESET LOGMAXUTILIZATION

Command Description


RESET LOGMAXUTILIZATION


RESTORE STGPOOL (Restore Storage Pool Data from a Copy Pool)

Use this command to restore files from one or more copy storage pools to a primarystorage pool. TSM restores all the primary storage pool files that:

v Have been identified as having errors

v Reside on a volume with an access mode of DESTROYED

You can also use this command to identify volumes that contain damaged, primary files.During restore processing, a message is issued for every volume in the restoredstorage pool that contains damaged, non-cached files. Use the QUERY CONTENTcommand to identify damaged, primary files on a specific volume.

Restoration of file may be incomplete if backup file copies in copy storage pools weremoved or deleted by other TSM processes during restore processing. To prevent thisproblem, do not issue the following commands for copy storage pool volumes whilerestore processing is in progress:

v MOVE DATA

v DELETE VOLUME (DISCARDDATA=YES)

v AUDIT VOLUME (FIX=YES)

Also, you can prevent reclamation processing for your copy storage pools by setting theRECLAIM percentage to 100 with the UPDATE STGPOOL command.

Privilege Class

To issue this command, you must have system privilege, unrestricted storage privilege,or restricted storage privilege for the primary storage pool for which files are to berestored. If you are a restricted storage administrator and you want to restore files to anew primary storage pool, you must also have authority for the new storage pool.

Syntax

ÊÊ RESTORE STGpool primary_pool_nameCOPYstgpool = copy_pool_name

Ê

ÊNEWstgpool = new_primary_pool_name

MAXPRocess = 1


ÊPreview = No

Preview = NoYes

Wait = No

Wait = NoYes

ÊÍ

RESTORE STGPOOL


Parametersprimary_pool_name (Required)

Specifies the name of the primary storage pool that is being restored.

COPYstgpoolSpecifies the name of the copy storage pool from which the files are to be restored.This parameter is optional. If this parameter is not specified, files are restored fromany copy pool in which copies can be located.

NEWstgpoolSpecifies the name of the new storage pool to which to restore the files. Thisparameter is optional. If this parameter is not specified, files are restored to theoriginal primary storage pool (the pool being restored).

MAXPRocessSpecifies the maximum number of parallel processes that are used for restoringfiles. Using multiple, parallel processes may improve throughput for the restore.This parameter is optional. You can specify a value from 1 to 999. The default is 1.

When determining this value, consider the number of mount points (logical drives)and physical drives that can be dedicated to this operation. To access a sequentialaccess volume, TSM uses a mount point, and, if the device type is not FILE, aphysical drive. The number of available mount points and drives depends on otherTSM and system activity and on the mount limits of the device classes for thesequential access storage pools that are involved in the restore.

Each process needs a mount point for copy storage pool volumes, and, if thedevice type is not FILE, each process also needs a drive. If you are restoring filesin a sequential storage pool, each process needs an additional mount point forprimary storage pool volumes and, if the device class is not FILE, an additionaldrive. For example, suppose you specify a maximum of 3 processes to restore aprimary sequential storage pool from a copy storage pool of the same device class.Each process requires two mount points and two drives. To run all three processes,the device class must have a mount limit of at least 6, and at least 6 mount pointsand 6 drives must be available.

To preview a restore, only one process is used and no mount points or drives areneeded.

PreviewSpecifies if you want to preview but not perform the restore. The preview lets youidentify volumes required to restore the storage pool.The preview displays:

v A list of primary storage pool volumes that contain damaged files.

v The number of files and the number of bytes to be restored, assuming that theaccess mode of the required copy storage pool volumes is READWRITE orREADONLY when the restore operation is performed.

v A list of copy storage pool volumes containing files to be restored. Thesevolumes must be mounted if you perform the restore.

v A list of any volumes containing files that cannot be restored.

Note: For only a list of offsite copy storage pool volumes to be mounted during arestore, change the access mode of the copy pool volumes to

RESTORE STGPOOL


UNAVAILABLE. This prevents reclamation and move data processing of thevolumes until they are moved onsite for the restore.

This parameter is optional. The default is NO. Possible values are:

No Specifies that the restore is done.

YesSpecifies that you want to preview the restore but not do the restore.



You can continue with other tasks while the command is being processed.

Messages created from the background process are displayed either in theactivity log or the server console, depending on where messages are logged.To cancel a background process, use the CANCEL PROCESS command. Ifyou cancel this process, some files may have already been restored prior tothe cancellation.

YesSpecifies that the server performs this operation in the foreground. Theoperation must complete before you can continue with other tasks. The serverthen displays the output messages to the administrative client when theoperation completes.

Examples

Task

Restore files from any copy storage pool to the primary storage pool, PRIMARY_POOL.

Command:restore stgpool primary_pool

Related Commands

Table 217. Commands Related to RESTORE STGPOOL

Command Description






RESTORE STGPOOL


Table 217. Commands Related to RESTORE STGPOOL (continued)

Command Description


RESTORE STGPOOL


RESTORE VOLUME (Restore Primary Volume Data from a Copy Pool)

Use this command to restore all files on damaged volumes in a primary storage poolthat was backed up to a copy storage pool. TSM does not restore cached copies offiles and removes those cached files from the database during restore processing.

Notes:

1. Before you restore a random-access volume, issue the VARY command to vary thevolume offline.

2. To prevent copy storage pools files from being moved or deleted by other TSMprocesses, do not issue the following commands for copy storage pool volumesduring a restore:

v MOVE DATA

v DELETE VOLUME (DISCARDDATA=YES)

v AUDIT VOLUME (FIX=YES)

To prevent reclamation processing of copy storage pools, issue the UPDATESTGPOOL command with the RECLAIM parameter set to 100.

This command changes the access mode of the specified volumes to DESTROYED.When all files on a volume are restored to other locations, the destroyed volume isempty, and TSM deletes it from the database.

The restoration may be incomplete for one or more of the following reasons:

v Files were either never backed up or the backup copies are marked as damaged.Use the QUERY CONTENT command to get more information on the remaining fileson the volume.

v A copy storage pool was specified on the RESTORE command, but files werebacked up to a different copy storage pool. Use the PREVIEW parameter when youissue the RESTORE command again to determine if this is the problem.

v Volumes in the copy storage pool needed to perform the restore operation are offsiteor unavailable. Check the activity log for messages that occurred during restoreprocessing.

v Backup file copies in copy storage pools were moved or deleted by other TSMprocesses during a restore. See note 2.

Privilege Class

To issue this command you must have system privilege, unrestricted storage privilege,or restricted storage privilege for the primary storage pool. If you have restrictedprivilege and want to restore files to a new primary storage pool, you must also haveauthority for the new storage pool.

Syntax

RESTORE VOLUME


ÊÊ RESTORE Volume ·

,

volume_nameCOPYstgpool = copy_pool_name

Ê

ÊNEWstgpool = new_primary_pool_name

MAXPRocess = 1


ÊPreview = No

Preview = NoYes

Wait = No

Wait = NoYes

ÊÍ


Specifies the name of the primary storage pool volume to be restored. To specify alist of volumes that belong to the same primary storage pool, separate the nameswith commas and no intervening spaces.

COPYstgpoolSpecifies the name of the copy storage pool from which the files are to be restored.This parameter is optional. If you do not specify this parameter, files are restoredfrom any copy pool in which copies can be located.

NEWstgpoolSpecifies the name of the new storage pool to which to restore the files. Thisparameter is optional. If you do not specify this parameter, files are restored to theoriginal primary storage pool.

MAXPRocessSpecifies the maximum number of parallel processes to use for restoring files.Using parallel processes may improve throughput. This parameter is optional. Youcan specify a value from 1 to 999. The default is 1.

When determining this value, consider the number of mount points (logical drives)and physical drives that can be dedicated to this operation. To access a sequentialaccess volume, TSM uses a mount point, and, if the device type is not FILE, aphysical drive. The number of available mount points and drives depends on otherTSM and system activity and on the mount limits of the device classes for thesequential access storage pools that are involved in the restore.

Each process needs a mount point for copy storage pool volumes. If the devicetype is not FILE, each process also needs a drive. If you are restoring a sequentialstorage pool, each process needs an additional mount point for primary storagepool volumes and, if the device type is not FILE, an additional drive. For example,suppose you specify a maximum of three processes to back up a primarysequential storage pool to a copy storage pool of the same device class. Each

RESTORE VOLUME


process requires two mount points and two drives. To run all three processes, thedevice class must have a mount limit of at least 6, and at least 6 mount points and6 drives must be available.

To preview a backup, only one process is used and no mount points or drives areneeded.

PreviewSpecifies if you want to preview but not perform the restore. You can use thisoption to identify the offsite volumes required to restore a storage pool. Thisparameter is optional. The default is NO. Possible values are:

No Specifies that you want to perform the restore operation.

YesSpecifies that you want to preview the restore operation but restore the data.

Note: If you preview a restore to see a list of offsite copy pool volumes to bemounted, you should you change the access mode of the identifiedvolumes to UNAVAILABLE. This prevents reclamation and MOVE DATAprocessing for these volumes until they are transported to the onsitelocation for use in restore processing.

The preview displays the following:

v The number of files and bytes to be restored, if the access mode of thecopy storage pool volumes is READWRITE or READONLY when therestoration is performed.

v A list of copy storage pool volumes containing files to be restored. Thesevolumes must be mounted if you perform the restore.

v A list of volumes containing files that cannot be restored.

WaitSpecifies whether to wait for the server to complete processing this command inthe foreground. This parameter is optional. This default is NO. Possible values are:


You can continue with other tasks while the command is being processed.Messages created from the background process are displayed either in theactivity log or the server console, depending on where messages are logged.

To cancel a background process, use the CANCEL PROCESS command. Ifyou cancel this process, some files may have already been backed up prior tothe cancellation.

YesSpecifies that the server processes this command in the foreground. Theoperation must complete before you can continue with other tasks. The serverthen displays the output messages to the administrative client when thecommand completes.

RESTORE VOLUME


Examples

Task

Restore files stored on volume PVOL2 in primary storage pool PRIMARY_POOL.

Command:restore volume pvol2

Related Commands

Table 218. Commands Related to RESTORE VOLUME

Command Description





RESTORE VOLUME


REVOKE AUTHORITY (Remove Administrator Authority)

Use this command to revoke one or more privilege classes from an administrator. Youcan also use this command to reduce:

v the number of policy domains to which a restricted policy administrator has authority.

v the number of storage pools to which a restricted storage administrator has authority.

If you use the REVOKE AUTHORITY command without the CLASSES, DOMAINS, andSTGPOOLS parameters, you will revoke all privileges for the specified administrator.

At least one administrator must have system privilege; therefore, if the administrator isthe only one with system privilege, you cannot revoke the authority.

Privilege Class


Syntax

ÊÊ REVoke AUTHority admin_name

·

,(1)

CLasses = SYstemPolicySTorageOperatorAnalystNode A

Ê

Ê

·

,(1)

DOmains = domain_name ·

,(1)

STGpools = pool_name

ÊÍ

A:

AUTHority = Access

AUTHority = AccessOwner

DOmains=domain_nameNOde=node_name

Notes:

1 If all these parameters are omitted, all administrator privileges will be revoked forthis administrator.

REVOKE AUTHORITY



Specifies the name of the administrator whose administrative privilege is to berevoked or reduced.

CLassesSpecifies one or more administrative privilege classes to be revoked. You canspecify more than one class by separating each with a comma.

SYstemIndicates that system authority is to be revoked for this administrator. IfCLASSES=SYSTEM is specified, no other classes can be specified, and theDOMAINS and STGPOOLS parameters cannot be specified.

PolicyIndicates that policy privilege is to be revoked for this administrator. To revokeall policy privilege, specify CLASSES=POLICY and do not specify theDOMAINS parameter.

STorageIndicates that storage privilege is to be revoked for this administrator. Torevoke all storage privilege, specify CLASSES=STORAGE and do not specifythe STGPOOLS parameter.

OperatorIndicates that operator privilege is to be revoked for this administrator.

AnalystIndicates that analyst privilege is to be revoked for this administrator.

NodeIndicates that node privilege is to be revoked for this user.

AUTHorityIndicates the authority level to revoke for a user with node privilege. Thisparameter is optional.

If an administrator already has system or policy privilege to the policydomain to which the node belongs, this command will not change theadministrator’s privilege. Possible authority levels are:

AccessIndicates that client access authority is revoked. This is the defaultwhen CLASSES=NODE is specified.

Note: A client node can set the REVOKEREMOTEACCESS option toprevent access by a user with node privilege and client accessauthority. If a user with node privilege has client ownerauthority, or has system or policy privileges to the policydomain to which the node belongs, that administrator can stillaccess the web backup-archive client.

OwnerIndicates that client owner authority is revoked.

REVOKE AUTHORITY


||

|||

|||

|||

||||||

||

DOmainsIndicates that you want to revoke an administrator’s client access or clientowner authority to all clients in the specified policy domain. This parametercannot be used together with the NODE parameter.

NOdeIndicates that you want to revoke an administrator’s client access or clientowner authority to the node. This parameter cannot be used together withthe DOMAIN parameter.

DOmainsSpecifies a list of policy domains that can no longer be managed by a restrictedpolicy administrator. (The administrator had been authorized to manage thesedomains until the REVOKE command was issued.) This parameter is optional. Theitems in the list are separated by commas, with no intervening spaces. You can usewildcard characters to specify a name. Authority for all matching domains will berevoked. If DOMAINS is specified, the parameter CLASSES=POLICY is optional.

STGpoolsSpecifies a list of storage pools that can no longer be managed by a restrictedpolicy administrator. (The administrator had been authorized to manage thesestorage pools until the REVOKE command was issued.) This parameter is optional.The items in the list are separated by commas, with no intervening spaces. Youcan use wildcard characters to specify a name. Authority for all matching storagepools will be revoked. If STGPOOLS is specified then the parameterCLASSES=STORAGE is optional.

Usage Notes1. To change an unrestricted storage administrator to a restricted storage

administrator, you must first use this command to revoke the unrestricted privilege.Then, use the GRANT AUTHORITY command to grant the administrator restrictedstorage privilege and to identify the storage pools to which the administrator hasauthority.

To revoke unrestricted storage privilege from an administrator, specify theCLASSES=STORAGE parameter. You cannot use the STGPOOLS parameter torevoke authority for selected storage pools from an unrestricted storageadministrator.

2. To change an unrestricted policy administrator to a restricted policy administrator,you must first use this command to revoke the unrestricted privilege. Then, use theGRANT AUTHORITY command to grant the administrator restricted policy privilegeand to identify the policy domains to which the administrator has authority.

To revoke unrestricted policy privilege from an administrator, specify theCLASSES=POLICY parameter. You cannot use the DOMAINS parameter to revokeauthority for selected domains from an unrestricted administrator.

REVOKE AUTHORITY


||||

||||

|

Examples

Task 1

Revoke part of administrator CLAUDIA’s privileges. CLAUDIA has restricted policyprivilege for the policy domains EMPLOYEE_RECORDS and PROG1. RestrictCLAUDIA’s policy privilege to the EMPLOYEE_RECORDS policy domain.

Command:revoke authority claudia classes=policy domains=employee_records

Task 2

Administrator LARRY currently has operator, analyst, and restricted policy privilege.Revoke all administrative privileges for administrator LARRY. To revoke alladministrative privileges for an administrator, identify the administrator, but do notspecify CLASSES, DOMAINS, or STGPOOLS. LARRY remains an administrator but hecan only use those commands that can be issued by any administrator.

Command:revoke authority larry

Task 3

Help desk personnel user CONNIE currently has node privilege with client ownerauthority for client node WARD3. Revoke her node privilege with client owner authority.

Command:revoke authority connie classes=node auth=owner node=ward3

Related Commands

Table 219. Commands Related to REVOKE AUTHORITY

Command Description



REVOKE AUTHORITY


|

||

||

|

ROLLBACK (Rollback Uncommitted Changes in a Macro)

Use this command within a macro to undo any processing changes made bycommands executed by the server but not yet committed to the database. A committedchange is permanent and cannot be rolled back. The ROLLBACK command is usefulfor testing macros.

Ensure that your administrative client session is not running with the ITEMCOMMIToption when using this command.

Note: SETOPT commands inside a macro cannot be rolled back.

Privilege Class


Syntax

ÊÊ ROLLBACK ÊÍ

Parameters

None.

Examples

Task

Run the REGN macro with the ROLLBACK command to verify that the macro workswithout committing any changes.

Macro Contents:

/* Macro to register policyadministrators & grant authority */REGister Admin sara hobbyGRant AUTHority sara CLasses=PolicyREGister Admin ken planeGRant AUTHority ken CLasses=PolicyROLLBACK /* prevents any changes from being committed */

Command:macro regn

ROLLBACK


Related Commands

Table 220. Commands Related to ROLLBACK

Command Description

COMMIT Makes changes to the database permanent.

MACRO Runs a specified macro file.

ROLLBACK


RUN (Run a Tivoli Storage Manager Script)

Use this command to run a TSM script. To issue this command on another server, thescript being run must be defined on that server.

You can include RUN commands in scripts as long as they do not create loops. Forexample, you should avoid including RUN commands where SCRIPT_A runsSCRIPT_B and SCRIPT_B runs SCRIPT_A.

Privilege Class

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

Syntax

ÊÊ RUn script_name

·

,

substitution_value

Preview = No

Preview = NoYes

Ê

ÊVerbose = No

Verbose = NoYes

ÊÍ


Specifies the name of the script you want processed. The name you specify cannotbe a substitution variable, such as $1.

substitution_valueSpecifies one or more values to substitute for variables when the script is run. In ascript, a substitution variable consists of a '$' character, followed by a number.When you run the script, TSM replaces the substitution variables defined in a scriptwith the values you supply with this command. You must specify values for eachsubstitution variable defined in the script or the script will fail. This parameter isoptional.

PreviewSpecifies whether to preview the command lines of a script without actuallyprocessing the script. The default is NO.


YesSpecifies that the command lines included in a script are displayed, but thescript is not processed.

RUN


||

||

|||

|

||

|

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

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

|

|

|||

|||||||

|||

|

|||

No Specifies that the command lines included in a script are displayed and thescript is processed.

VerboseSpecifies whether command lines, variable substitution, and conditional logictesting used in a script are displayed as the script is being processed. Thisparameter is ignored if PREVIEW=YES is specified. The default is NO.


YesSpecifies that the command lines, variable substitution, and conditional logictesting are displayed as the script is being processed.

No Specifies that the command lines, variable substitution, and conditional logictesting do not display as the script is being processed.

Examples

Task 1

Assume that you have defined a script called QSAMPLE to include the following lines:

001 /* This is a sample SQL Query in wide format */005 SET SQLDISPLAYMODE WIDE010 SELECT colname FROM -015 COLUMNS WHERE TABNAME='$1'

Preview the commands in the QSAMPLE script before running the script. SpecifyACTLOG as the value for the substitution variable, $1.

Command:run qsample actlog preview=yes

ANR1461I RUN: Executing command script QSAMPLE.ANR1466I RUN: Command script QSAMPLE, Line 5 : set sqldisplaymode wide.ANR1466I RUN: Command script QSAMPLE, Line 15 :

select colname from columns where tabname='ACTLOG'.ANR1470I RUN: Command script QSAMPLE completed successfully (PREVIEW mode)

Task 2

Run the script to display column names for the ACTLOG table.

Command:run qsample actlog verbose=yes

RUN


|||

||||

|

|||

|||

|

|

|

||||

||

||

||||||

|

|

||

ANR1461I RUN: Executing command script QSAMPLE.ANR1466I RUN: Command script QSAMPLE, Line 5 : set sqldisplaymode wide.ANR1466I RUN: Command script QSAMPLE, Line 5 : RC=RC_OKANR1466I RUN: Command script QSAMPLE, Line 15 :

select colname from columns where tabname='ACTLOG'.

COLNAME------------------DATE_TIMEMSGNOSEVERITYMESSAGEORIGINATORNODENAMEOWNERNAMESCHEDNAMEDOMAINNAMESESSID

ANR1462I RUN: Command script QSAMPLE, Line 15 : RC=RC_OKANR1462I RUN: Command script QSAMPLE completed successfully.

Run the same command without displaying the individual command lines.

Command:run qsample actlog verbose=no

COLNAME------------------DATE_TIMEMSGNOSEVERITYMESSAGEORIGINATORNODENAMEOWNERNAMESCHEDNAMEDOMAINNAMESESSID

ANR1462I RUN: Command script QSAMPLE completed successfully.

Related Commands

Table 221. Commands Related to RUN

Command Description







RUN


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

|

||

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

|

|||

||

||

||

|||

||

||

||

|

SELECT (Perform an SQL Query of the TSM Database)

Use this command to create and format a customized query of the TSM database. OnTSM, this command uses a subset of the SQL92 and SQL93 standards.

The SELECT command is consistent with most relational database products, such asLOTUS 1-2-3® and Microsoft® Access. It presents server information in the form ofrelational tables containing rows (records) and columns (fields).

To help you find what information is available, TSM provides three system catalogtables:

SYSCAT.TABLES contains information about all tables that can be queried with theSELECT command.

SYSCAT.COLUMNS describes the columns in each table.

SYSCAT.ENUMTYPES defines the valid values for each type and the ordering ofthose values for columns that have an enumerated data type (SQL93).

You can issue the SELECT command to query these tables to determine the location ofthe information that you want.

Notes:

1. To stop SELECT processing after it starts, cancel the administrative session thatissued the command. Cancel the session from either the server console or anotheradministrative session.

2. If an SQL query requires significant server time or resources, you will be asked toconfirm your request.

3. Any SQL query requires at least one free 4MB partition. The more processing that aquery requires, the more free space is required. Complicated or lengthy queries canaffect TSM server performance.

Privilege Class


Syntax

Attention: The following syntax diagram and parameter list include the more commonparameters of the SELECT command. Other parameters are available. See anystandard SQL documentation. However, these parameters are not supported by theSELECT command: UNION, INTERSECT, EXCEPT, and correlated subqueries.

ÊÊ SELECT ·

,

value_expressionaggregate_function AS column_name

Ê

SELECT


|||

Ê ·

,

FROM table_name subqueryWHERE predicate

Ê

ÊGROUP BY . column_name

table_nameHAVING predicate

Ê

Ê

·

·

,

ORDER BY output_columnASCDESC

,

positive_integerASCDESC

ÊÍ

Parametersvalue_expression or aggregate_function (Required)

Specifies the columns to be returned. Valid values are:

value_expressionSpecifies the set of source columns to be returned. In the simplest form, this isa list of the columns specified in the FROM clause. In a more advanced form,it can include DISTINCT, CAST, or CASE expressions or subqueries.

aggregate_functionSpecifies a function that extracts a single value from groups of column names.For example, AVG, COUNT, MAX, or SUM.

AS column_nameSpecifies the column title to display. The default is to display the value expressionor aggregate function. The default column name for expressions is UNNAMED(N).

FROM (Required)Specifies where to find data in the database. Valid values are:

table_nameSpecifies one or more source tables from which to extract the query rows andcolumns. You can find these names by querying SYSCAT.TABLES. If youspecify two or more tables, you are requesting a JOIN of the tables. You canspecify the columns for the JOIN criteria in the WHERE parameter. Or thetables can be joined by matching every row from one table to every row fromanother table.

SELECT


subquerySpecifies another SELECT command from which the selected columns are tobe taken.

WHERE predicateSpecifies that only certain rows are displayed based on criteria in the predicate.This is an optional parameter. You can use the AND, OR, and NOT operators tostring predicates together.

GROUP BY column_nameSpecifies groups of rows to be formed if aggregate functions (for example, AVG,COUNT, MAX, SUM) are specified. This is an optional parameter.

HAVING predicateSpecifies a condition to be used to filter the extracted values before displayingthem. This is an optional parameter.

ORDER BYSpecifies how output sorts for display. You can specify column names or numericpositions and whether you want the sort in ascending or descending order. This isan optional parameter. Valid values are:

output_columnSpecifies order by column. The columns are sorted according to the order inwhich they are specified.

positive_integerSpecifies order by the numeric position of the columns. The columns aresorted according to the order in which they are specified.

ASCSpecifies that the columns are sorted in ascending order.

DSCSpecifies that the columns are sorted in descending order.

The SELECT command supports the following expressions, clauses, functions, andpredicates:

ALL

ANY

AVG

AS

BETWEEN

CASE

CAST

COUNT

CURRENT_DATE

CURRENT_TIME

CURRENT_TIMESTAMP

CURRENT_USER

DISTINCT

EXISTS

EXTRACT

FROM

GROUP BY

HAVING

IN

JOIN

LIKE

MAX

MIN

NULL

ORDER BY

POSITION

SOME

SUBSTRING

SUM

TRIM

WHERE

SELECT


Examples

The SELECT command lets you customize a wide variety of queries. To give you anidea of what you can do with the command, this section includes many examples.There are, however, many more possibilities.

Note: Query output is shown only for the more complex commands to illustrateformatting.

v Get a list of all the tables available for querying the TSM database.

Command:select * from syscat.tables

Output: (shows partial output)

TABSCHEMA: SERVER1TABNAME: ACTLOG

CREATE_TIME: 1999-05-01 07:39:06COLCOUNT: 10

INDEX_COLCOUNT: 1UNIQUE_INDEX: FALSE

REMARKS: Server activity log

TABSCHEMA: SERVER1TABNAME: ADMIN_SCHEDULES


INDEX_COLCOUNT: 1UNIQUE_INDEX: TRUE

REMARKS: Administrative command schedules

TABSCHEMA: SERVER1TABNAME: ADMINS


INDEX_COLCOUNT: 1UNIQUE_INDEX: TRUE

REMARKS: Server administrators

TABSCHEMA: SERVER1TABNAME: ARCHIVES


INDEX_COLCOUNT: 5UNIQUE_INDEX: FALSE

REMARKS: Client archive files

v Which client nodes and administrative clients are currently locked from serveraccess?

Command:

select node_name from nodes where locked='YES'

select admin_name from admins where locked='YES'

v Which client nodes and administrative clients have not specified the correct passwordlately?

Command:

SELECT


select node_name from nodes where invalid_pw_count <> 0

select admin_name from admins where invalid_pw_count <> 0v Which nodes in the standard policy domain are not associated with the daily backup

schedule DAILYBACKUP ?

Command:

select node_name from nodes where domain_name='STANDARD' andnode_name not in (select node_name from associationswhere domain_name='STANDARD' and schedule_name='DAILYBACKUP')

v Which administrators have policy authority ?

Command:

select admin_name from admins where upper(system_priv) <> 'NO'or upper(policy_priv) <> 'NO'

v What messages of type E (ERROR) or W (WARNING) have been issued in the timeperiod for which activity log records have been maintained ?

Command:

select date_time,msgno,message from actlogwhere severity='E' or severity='W'

v Which administrative schedules have been defined or altered by administrator JAKE?

Command:

select schedule_name from admin_schedules where chg_admin='JAKE'

v What are the relative administrative schedule priorities?

Command:

select schedule_name,priority from admin_schedules orderby priority

v Which management classes have an archive copy group with a retention periodgreater than 365 days ?

Command:

select domain_name,set_name,class_name from ar_copygroupswhere retver='NOLIMIT' or cast(retver as integer) > 365

v Which management classes specify more than 5 backup versions ?

Command:

select domain_name,set_name,class_name from bu_copygroupswhere verexists = 'NOLIMIT' or cast(verexists as integer) > 5

v Which client nodes are using the client option set named SECURE ?

Command:

select node_name from nodes where option_set='SECURE'

v How many client nodes are in each policy domain?

Command:

SELECT


select domain_name,num_nodes from domains

v How many files have been archived from each node ?

Attention: This command could take a long time to complete.

Command:

select node_name,count(*) from archives group by node_name

v Which clients are using space management?

Command:

select node_name from auditocc where spacemg_mb <> 0

v If the reclamation threshold were to be changed to 50 percent for storage pool TAPE,how many volumes would be reclaimed ?

Command:

select count(*) from volumes where stgpool_name='TAPE' andupper(status)='FULL' and pct_utilized < 50

v If the DAILY management class in the STANDARD policy domain is changed ordeleted, how many backup files would be affected for each node?

Note: This command will take significant time and resource to complete.

Command:

select node_name, count(*) as "Files" from backupswhere class_name='DAILY' and node_name in(select node_name from nodes where domain_name='STANDARD')group by node_name

v For all active client sessions, determine how long have they been connected andtheir effective throughput in bytes per second:

Command:

select session_id as "Session",client_name as "Client",state as "State",current_timestamp-start_time as "Elapsed Time",(cast(bytes_sent as decimal(18,0)) /cast((current_timestamp-start_time)seconds as decimal(18,0)))as "Bytes sent/second",(cast(bytes_received as decimal(18,0)) /cast((current_timestamp-start_time)seconds as decimal(18,0)))as "Bytes received/second"from sessions

SELECT


Output:

Session: 24Client: ALBERTState: Run

Elapsed Time: 0 01:14:05.000000Bytes sent/second: 564321.9302768451

Bytes received/second: 0.0026748857944

Session: 26Client: MILTONState: Run

Elapsed Time: 0 00:06:13.000000Bytes sent/second: 1638.5284210992221

Bytes received/second: 675821.6888561849

v How long have the current background processes been running and what is theireffective throughput in time and files per second ?

Command:

select process_num as "Number",process,current_timestamp-start_time as "Elapsed Time",(cast(files_processed as decimal(18,0)) /cast((current_timestamp-start_time)seconds as decimal(18,0)))as "Files/second",(cast(bytes_processed as decimal(18,0)) /cast((current_timestamp-start_time)seconds as decimal(18,0)))as "Bytes/second"from processes

Output:

Number: 1PROCESS: Expiration

Elapsed Time: 0 00:24:36.000000Files/second: 6.3216755870092Bytes/second: 0.0000000000000

Note: Expiration does not report the number of bytes processed.

v How many client nodes are there for each platform type?

Command:

select platform_name,count(*) as "Number of Nodes" from nodesgroup by platform_name

Output:

PLATFORM_NAME Number of Nodes------------- ---------------

AIX 6SunOS 27Win32 14

v How many filespaces does each client node have, listed in ascending order?

Command:

SELECT


select node_name, count(*) as "number of filespaces" from filespacesgroup by node_name order by 2

Output:

NODE_NAME number of filespaces------------------ --------------------

ALBERT 2MILTON 2BARNEY 3SEBASTIAN 3MAILHOST 4FALCON 4WILBER 4NEWTON 4JEREMY 4WATSON 5RUSSELL 5

Related Commands

Table 222. Commands Related to SELECT

Command Description

QUERY SQLSESSION Displays the current settings of the SQLformatting commands.




SELECT


SET ACCOUNTING (Set Accounting Records On or Off)

Use this command to determine whether an accounting record is created every time aclient node session ends.

An accounting record tracks the amount of storage used by a client node session.These records are stored in an accounting file named dsmaccnt.log. See theAdministrator’s Guide for more information on accounting.

Use the QUERY STATUS command to determine whether accounting records aregenerated. At installation, this value is set to off.

Privilege Class


Syntax

ÊÊ Set ACCounting ONOFf

ÊÍ

ParametersON

Specifies that the server creates an accounting record every time a client nodesession ends.

OFfSpecifies that the server does not create accounting records.

Examples

Task

Create an accounting record at the end of each client node session.

Command:set accounting on

Related Commands

Table 223. Commands Related to SET ACCOUNTING

Command Description


SET ACCOUNTING


SET ACTLOGRETENTION (Set the Retention Period for the Activity Log)

Use this command to specify the number of days to retain server activity log records inthe database. Activity log information includes messages, such as the following:

v Client session starts and ends

v Migration starts and ends

v Diagnostic error messages

v Scheduled administrative command output

Privilege Class


Syntax

ÊÊ Set ACTlogretention days ÊÍ

Parametersdays (Required)

Specifies the number of days to retain messages in the activity log. You can specifya number from 0 to 9999. A value of 0 disables activity log retention. A value of 1specifies to retain the activity log records only for the current day.

Examples

Task

Set the server to retain activity log records for 30 days.

Command:set actlogretention 30

Related Commands

Table 224. Command Related to SET ACTLOGRETENTION

Command Description


SET ACTLOGRETENTION


SET AUTHENTICATION (Set Password Authentication)

Use this command to specify whether administrators and client nodes need a passwordto access the server. The value is set to ON at installation.

Privilege Class


Syntax

ÊÊ Set AUthentication ONOFf

ÊÍ

ParametersON

Specifies that administrators and client nodes need a password to access theserver.

OFfSpecifies that administrators and client nodes do not need a password to accessthe server.

Examples

Task

Set authentication to ON to require administrators and client nodes to enter a passwordwhen accessing the server.

Command:set authentication on

Related Commands

Table 225. Command Related to SET AUTHENTICATION

Command Description


SET AUTHENTICATION


SET CLIENTACTDURATION (Set the Duration Period for the Client Action)

Use this command to specify the duration for the schedule that was defined with theDEFINE CLIENTACTION command.

Records for the event are deleted regardless of whether the client has processed theschedule. Schedules may not be deleted, however, until after the first event recordshave been deleted. The retention period for events is set to 10 days at installation.

Privilege Class


Syntax

ÊÊ SET CLIENTACTDuration days ÊÍ


Specifies the number of days during which the schedule for the client action isactive. You can specify an integer from 0 to 999. The default is 5 days.

The number of days you specify determines how long the schedule will be retainedin the database before it is automatically deleted. A value of 0 indicates that theschedule duration is indefinite and the schedule and associations are not deletedfrom the database.

Examples

Task

Specify that the schedule for the client action be active for 15 days.

Command:set clientactduration 15

Related Commands

Table 226. Commands Related to SET ClIENTACTDURATION

Command Description

DEFINE CLIENTACTION Defines a command to be performed at a clientnode.




SET CONFIGMANAGER (Specify a Configuration Manager)

Use this command to specify whether a server is a configuration manager. On aconfiguration manager, you can define configuration profiles to which other servers cansubscribe. You cannot designate a server as a configuration manager if the serversubscribes to one or more profiles on another configuration manager.

If a server is a configuration manager, you cannot change this designation until youdelete all profiles, including the default profile.

Issue the QUERY STATUS command to determine if a server is a configurationmanager. When a server is installed, it is not designated as a configuration manager.

Privilege Class


Syntax

ÊÊ Set CONFIGManagerOFf

ONÊÍ

ParametersON

Specifies that the server is a configuration manager.

When you designate a server as a configuration manager, TSM creates a defaultprofile named DEFAULT_PROFILE and associates with the profile all servers andserver groups defined on the configuration manager. You can modify or delete thedefault profile.

OFfSpecifies that the server is not a configuration manager.

Examples

Task

Designate a server as a configuration manager.

Command:set configmanager on

SET CONFIGMANAGER


||

||||

||

||

|

|

|

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

|

|

||

||||

||

|

|

|

||

Related Commands

Table 227. Commands Related to SET CONFIGMANAGER

Command Description




SET CONFIGMANAGER


|

|||

||

|||

|||

|||

|

SET CONFIGREFRESH (Set Managed Server Configuration Refresh)

Use this command on a managed server to specify how often that server contacts itsconfiguration manager for updated configuration information. To display the currentsetting, issue the QUERY STATUS command. At installation, the interval is set to 60minutes.

Privilege Class


Syntax

ÊÊ Set CONFIGRefresh minutes ÊÍ

Parametersminutes (Required)

Specifies the interval, in minutes, before a managed server contacts itsconfiguration manager for configuration updates. Specify an integer from 0 to10000.

v If the value is greater than 0, the managed server immediately contacts theconfiguration manager. The next contact occurs when the specified interval isreached.

v If the value is 0, the managed server does not contact the configurationmanager.

This value is ignored if the server does not subscribe to at least one profile on aconfiguration manager.

Examples

Task

Specify that a managed server contacts its configuration manager every 45 minutes.

Command:set configrefresh 45

Related Commands

Table 228. Commands Related to SET CONFIGREFRESH

Command Description



SET CONFIGREFRESH


||

||||

|

|

|

||||||||||

|

|

||||

|||

||

||

|

|

|

||

|

|||

||

||

|||

Table 228. Commands Related to SET CONFIGREFRESH (continued)

Command Description





SET CONFIGREFRESH


|

||

|||

|||

|||

||

|

SET CROSSDEFINE (Specifies Whether to Cross-Define Servers)

Use this command to specify whether a server is automatically defined to anotherserver.

Privilege Class


Syntax

ÊÊ Set CROSSDefine ONOFf

ÊÍ

ParametersON

Specifies that a server may be cross-defined to another server. To automaticallydefine one server to another, you must also permit cross defining in the serverdefinition.

OFfSpecifies that a server may not be cross-defined to another server.

Examples

Task

Set crossdefine to allow a server to be cross-defined to another server.

Command:set crossdefine on

Related Commands

Table 229. Command Related to SET CROSSDEFINE

Command Description






SET CROSSDEFINE


||

SET DRMCHECKLABEL (Specify Label Checking)

Use this command to specify whether TSM reads the labels of sequential mediachecked out by the MOVE DRMEDIA command. At installation, the value of theDRMCHECKLABEL is set to YES. This command does not apply to the IBM 3494automated library.

Use the QUERY DRMSTATUS command to check the current setting.

Privilege Class


Syntax

ÊÊ Set DRMCHECKLabelYes

YesNo

ÊÍ

ParametersYes

Specifies that TSM reads the labels of sequential media checked out by the MOVEDRMEDIA command.

No Specifies that TSM does not read the labels of sequential media checked out bythe MOVE DRMEDIA command.

Examples

Task

Specify that TSM does not perform label checking.

Command:set drmchecklabel no

Related Commands

Table 230. Commands Related to SET DRMCHECKLABEL

Command Description



SET DRMCHECKLABEL


SET DRMCMDFILENAME (Specify the Name of a File to Contain Commands)

Use this command to name a file that can contain the commands created when theMOVE DRMEDIA or QUERY DRMEDIA commands are issued. If the SETDRMCMDFILENAME is not issued, the MOVE DRMEDIA or QUERY DRMEDIAcommand generates a file name.

Use the QUERY DRMSTATUS command to display the current command file name.

Privilege Class


Syntax

ÊÊ Set DRMCMDFilename file_name ÊÍ

Parametersfile_name (Required)

Specifies a fully qualified name for a file to contain the commands built by MOVEDRMEDIA or QUERY DRMEDIA command. You can specify any valid AS/400 filename of the form lib/filename(memname).

Note: If a file of the same name already exists, MOVE DRMEDIA or QUERYDRMEDIA command tries to use it, and the existing data is overwritten.

Examples

Task

Specify a file name of drm/exec(cmds).

Command:set drmcmdfilename drm/exec(cmds)

Related Commands

Table 231. Commands Related to SET DRMCMDFILENAME

Command Description

MOVE DRMEDIA Move DRM media offsite and back onsite

QUERY DRMEDIA Query DRM media


SET DRMCMDFILENAME


SET DRMCOPYSTGPOOL (Specify the Copy Storage Pools to be Managed byDRM)

Use this command to specify names of the copy storage pools to be recovered after adisaster. TSM uses these names if the PREPARE command does not include theCOPYSTGPOOL parameter.

If the MOVE DRMEDIA or QUERY DRMEDIA command does not include theCOPYSTGPOOL parameter, the command processes the volumes in the MOUNTABLEstate that are in the copy storage pool named by the SET DRMCOPYSTGPOOLcommand.

At installation, all copy storage pools are eligible for DRM processing. Use the QUERYDRMSTATUS command to display the current settings.

Privilege Class


Syntax

ÊÊ Set DRMCOPYstgpool ·

,

copy_pool_name ÊÍ

Parameterscopy_pool_name (Required)

Specifies the copy storage pool names. Separate multiple names with commas andno intervening spaces. You can use wildcard characters. The specified namesreplace any previous setting. If you enter a null string(""), all current names areremoved, and all copy storage pools are eligible for processing.

Examples

Task

Set COPYSTGPOOL1 as the eligible copy storage pool.

Command:set drmcopystgpool copystgpool1

SET DRMCOPYSTGPOOL


Related Commands

Table 232. Commands Related to SET DRMCOPYSTGPOOL

Command Description


PREPARE Creates a recovery plan file..




SET DRMCOPYSTGPOOL


SET DRMCOURIERNAME (Specify the Courier Name)

Use this command to specify the courier name. At installation, this name is set toCOURIER. The MOVE DRMEDIA command uses the courier name to set the locationof volumes that are moving to the COURIER state.

You can use the QUERY DRMSTATUS to see the name of the courier.

Privilege Class


Syntax

ÊÊ Set DRMCOUriername courier_name ÊÍ

Parameterscourier_name (Required)

Specifies the name of the courier. The name can be up to 255 characters. Enclosethe name in quotation marks if it contains any blank characters.

Examples

Task

Set the name of the courier to Joe’s Courier Service.

Command:set drmcouriername "Joe’s Courier Service"

Related Commands

Table 233. Commands Related to SET DRMCOURIERNAME

Command Description




SET DRMCOURIERNAME


SET DRMDBBACKUPEXPIREDAYS (Criteria for DB Backup Series Expiration)

Use this command to specify when a database series is eligible to be expired by theMOVE DRMEDIA command.

A database backup volume is eligible for expiration if all of the following are true:

v The last volume of the series has exceeded the expiration value of the SETDRMDBBACKUPEXPIREDAYS command.

v The volume state is VAULT.

v The volume is not part of the most recent series.

Use the QUERY DRMSTATUS to see the number of days specified.

Privilege Class


Syntax

ÊÊ Set DRMDBBackupexpiredays days ÊÍ


Specifies the number of days that must elapse since a database series wascreated before it is eligible to be expired. The number of days must match thevolume reuse delay period for copy storage pools managed by DRM. Specify aninteger from 0 to 9999.

Examples

Task

Set the database backup series expiration value to 60.

Command:set drmdbbackupexpiredays 60

Related Commands

Table 234. Commands Related to SET DRMDBBACKUPEXPIREDAYS

Command Description

DSMSERV RESTORE DB Restores a TSM database or database volume.




Table 234. Commands Related to SET DRMDBBACKUPEXPIREDAYS (continued)

Command Description






SET DRMFILEPROCESS (Specify File Processing)

Use this command to specify if the MOVE DRMEDIA or QUERY DRMEDIA commandshould process database backup volumes and copy storage pool volumes that areassociated with a FILE device class. At installation, the value is set to NO. Use theQUERY DRMSTATUS to determine the current setting.

Privilege Class


Syntax

ÊÊ Set DRMFILEProcessNo

NoYes

ÊÍ

ParametersNo Specifies that the MOVE DRMEDIA and QUERY DRMEDIA commands does not

process database backup and copy storage pool volumes that are associated witha FILE device class. This is the default.

YesSpecifies that the MOVE DRMEDIA and QUERY DRMEDIA commands processdatabase backup and copy storage pool volumes that are associated with a FILEdevice class.

Examples

Task

Set the file processing value to no.

Command:set drmfileprocess no

Related Commands

Table 235. Commands Related to Set DRMFILEPROCESS

Command Description




SET DRMFILEPROCESS


SET DRMINSTRPREFIX (Specify the Prefix for Recovery Instructions File Names)

Use this command to specify a library to the recovery instructions file name. TSM usesthis prefix if the PREPARE command is issued without the INSTRPREFIX parameter.Use the QUERY DRMSTATUS command to display the current value for the prefix.

If no prefix is set, the library used is the current server work library (WRKLIB).

Privilege Class


Syntax

ÊÊ Set DRMINSTRPrefix prefix ÊÍ

Parametersprefix (Required)

Specifies the library for the files that contain the recovery instructions. Whenprocessing the PREPARE command, TSM appends the name of the appropriaterecovery plan file stanza to find the file. This parameter is required. The maximumlength is 10 characters.

You can specify any valid library name. TSM gets instruction files from the libraryspecified by the prefix. For example:

DRMPLAN

For the general server recovery instructions file, INSTR(GENERAL), the resultingfile name would be:

DRMPLAN/INSTR(GENERAL)

Examples

Task

Specify reading the recovery plan instructions from library drmplan.

Command:set drminstrprefix drmplan

Related Commands

Table 236. Commands Related to SET DRMINSTRPREFIX

Command Description


SET DRMINSTRPREFIX


Table 236. Commands Related to SET DRMINSTRPREFIX (continued)

Command Description


SET DRMINSTRPREFIX


SET DRMNOTMOUNTABLENAME (Specify the Not Mountable Location Name)

Use this command to specify the name of the offsite location for storing the media. Atinstallation, the name is set to NOTMOUNTABLE. Use the QUERY DRMSTATUS to seethe location name.

The location name is used by the MOVE DRMEDIA command to set the location ofvolumes that are moving to the NOTMOUNTABLE state.

Privilege Class


Syntax

ÊÊ Set DRMNOTMOuntablename location ÊÍ

Parameterslocation (Required)

Specifies the name of the offsite location for storing the media. The name can beup to 255 characters. Enclose the name in quotation marks if it contains any blankcharacters.

Examples

Task

Set the name of the location to room123/31.

Command:set drmnotmountablename "room 123/31"

Related Commands

Table 237. Commands Related to SET DRMNOTMOUNTABLENAME

Command Description




SET DRMNOTMOUNTABLENAME


SET DRMPLANPREFIX (Specify a Prefix for Recovery Plan File Names)

Use this command to specify the default library that will contain the recovery plan filename.

Use the QUERY DRMSTATUS command to display the current value for the recoveryplan prefix.

Privilege Class


Syntax

ÊÊ Set DRMPLANPrefix prefix ÊÍ

Parametersprefix (Required)

Specifies the library that will contain the recovery plan file. The maximum length ofthe prefix is 10 characters.

You can specify any valid library name. For example, a PREPARE command isissued without the PLANPREFIX parameter and the SET DRMPLANPREFIX is setto the following:

DRMPLAN

The resulting recovery plan filename is the following:

DRMPLAN/D19971115(T051421)

Examples

Task

Specify a prefix so that the generated recovery plan files is stored in library drmplan.

Command:set drmplanprefix drmplan

Related Commands

Table 238. Commands Related to SET DRMPLANPREFIX

Command Description



SET DRMPLANPREFIX


SET DRMPLANVPOSTFIX (Specify Replacement Volume Names)

Use this command to specify the character to be appended to replacement volumenames in the recovery plan file. At installation, the character is set to @. TSMgenerates replacement names for primary storage pool volumes that were added by theDEFINE VOLUME command. Use the appended character to:

v Find replacement volume names in the recovery plan stanzas so that you canchange the names at recovery time. For example, you may not know the names ofthe available tape volumes at the recovery site.

v Generate replacement volume names. You need a naming convention that works forany device type in your primary storage pools. Consider the following:

– The generated length of replacement volume name

– Legal characters in the replacement volume name

– Conflicts with existing volume names

– A replacement volume name must be different from any destroyed, existing, ornew volume name.

Use the QUERY DRMSTATUS to see the character added to the end of thereplacement volume names.

Privilege Class


Syntax

ÊÊ Set DRMPLANVpostfix character ÊÍ

Parameterscharacter (Required)

Specifies the character appended to the replacement volume names in therecovery plan file. Specify an alphanumeric or special character.

Examples

Task

Set the character appended to the replace volume names to R.

Command:set drmplanvpostfix R

SET DRMPLANVPOSTFIX


Related Commands

Table 239. Commands Related to SET DRMPLANVPOSTFIX

Command Description



SET DRMPLANVPOSTFIX


SET DRMPRIMSTGPOOL (Specify the Primary Storage Pools to be Managed byDRM)

Use this command to specify the names of primary storage pools that you want torecover. The PREPARE command processes these names if the PREPARE commanddoes not include the PRIMSTGPOOL parameter.

Use the QUERY DRMSTATUS command to display the current settings. At installation,all primary storage pools defined to the server are eligible for DRM processing.

Privilege Class


Syntax

ÊÊ Set DRMPRIMstgpool ·

,

primary_pool_name ÊÍ

Parametersprimary_pool_name (Required)

Specifies the names of the primary storage pool names you want to recover.Separate multiple names with commas and no intervening spaces. You can usewildcard characters to specify names. The names that you specify replace anyprevious setting. If you enter a null string (""), all current names are removed, andall primary storage pools are eligible for DRM processing.

Examples

Task

Set the primary storage pool to be managed by DRM to PRIMSTGPOOL1.

Command:set drmprimstgpool primstgpool1

Related Commands

Table 240. Commands Related to SET DRMPRIMSTGPOOL

Command Description




SET DRMPRIMSTGPOOL


SET DRMRPFEXPIREDAYS (Set Criteria for Recovery Plan File Expiration)

Use this command to control how long to keep the objects that contain the recoveryplan files.

Note: This command applies to recovery plan files that were created with theDEVCLASS parameter specified on the PREPARE command.

Expiration processing on the source server expires plan files stored on the targetserver. Locally created recovery plan files are not expired.

A recovery plan file can be expired if both of the following are true:

v The last recovery plan file of the series has exceeded the expiration value specifiedwith the SET DRMRPFEXPIREDAYS command.

v The recovery plan file is not part of the most recent series.

Privilege Class


Syntax

ÊÊ Set DRMRPFEXpiredays days ÊÍ


Specifies the number of days that must elapse before a recovery plan file expires.You can specify a number from 0 to 9999. At installation, this value is set to 60.

Examples

Task

Set the recovery plan file expiration value to 30.

Command:set drmrpfexpiredays 30

Related Commands

Table 241. Commands Related to SET DRMRPFEXPIREDAYS

Command Description






||

||

||||

|

||

|

|

|

|

||||||||||

|

|

|||

|

|

|

||

|

|||

||

||

||

||

Table 241. Commands Related to SET DRMRPFEXPIREDAYS (continued)

Command Description






|

||

||

|||

|||

|

SET DRMVAULTNAME (Specify the Vault Name)

Use this command to specify the vault name. At installation the name is set to VAULT.Use the QUERY DRMSTATUS command to see the name of the vault.

Privilege Class


Syntax

ÊÊ SET DRMVAultname vault_name ÊÍ

Parametersvault_name (Required)

Specifies the name of the vault. The name can be up to 255 characters. Enclosethe name in quotation marks if it contains any blank characters.

Examples

Task

Specify a vault name of ironmountain.

Command:set drmvaultname ironmountain

Related Commands

Table 242. Commands Related to SET DRMVAULTNAME

Command Description




SET DRMVAULTNAME


SET EVENTRETENTION (Set the Retention Period for Event Records)

Use this command to set the retention period for event records in the server databasethat will allow you to monitor completed schedules. An event record is createdwhenever processing of a scheduled command is started or missed.

You can adjust the length of time that event information is maintained to avoidinsufficient or outdated data. The server automatically removes the event records fromthe database after the retention period passes and the startup window for the event haselapsed.

You can issue the QUERY EVENT command to display information about scheduledand completed events.

You can issue the DELETE EVENT command to delete event records regardless ofwhether their retention period has passed.

You can issue the QUERY STATUS command to display the value for the eventretention period. At installation, this value is set to 10 days.

Privilege Class

To perform this task, you must have system privilege.

Syntax

ÊÊ Set EVentretention days ÊÍ


The number of days that event records are retained in the database. You canspecify an integer from 0 to 9999. A value of 0 indicates that only event records forthe current day will be retained.

Examples

Task

Set the retention period to 15 days.

Command:set eventretention 15

SET EVENTRETENTION


Related Commands

Table 243. Commands Related to SET EVENTRETENTION

Command Description

DELETE EVENT Deletes event records prior to a specified dateand time.



SET EVENTRETENTION


SET INVALIDPWLIMIT (Set the Number of Invalid Logon Attempts)

Use this command to set the number of invalid logon attempts allowed before a node islocked.

Privilege Class


Syntax

ÊÊ Set INVALIDPwlimit number ÊÍ

Parametersnumber (Required)

Specifies the number of invalid logon attempts allowed before a node is locked.

You can specify an integer from 0 to 9999. A value of 0 means that invalid logonattempts are not checked. A value of 1 means that if a user issues an invalidpassword once, the node is locked by the server. The default is 0.

Examples

Task

Set the number of invalid logon attempts allowed.

Command:set invalidpwlimit 6

Related Commands

Table 244. Commands Related to SET INVALIDPWLIMIT

Command Description





SET INVALIDPWLIMIT


SET LICENSEAUDITPERIOD (Set License Audit Period)

Use this command to specify the period, in days, between automatic license auditsperformed by TSM.

Privilege Class


Syntax

ÊÊ30

Set LICenseauditperioddays

ÊÍ

Parametersdays

Specifies the number of days between automatic server license audits. Thisparameter is optional. The default value is 30. You can specify an integer from 1 to30, inclusive.

Examples

Task

Specify that the server audits licences every 14 days.

Command:set licenseauditperiod 14

Related Commands

Table 245. Commands Related to SET LICENSEAUDITPERIOD

Command Description






SET LICENSEAUDITPERIOD


SET LOGMODE (Set Mode for Saving Recovery Log Records)

Use this command to determine how long TSM saves records in the recovery log andwhat kind of database recovery you can use. You cannot change the log mode during adatabase backup.

Privilege Class


Syntax

ÊÊ Set LOGMode NormalRollforward

ÊÍ

ParametersNormal

Specifies that TSM saves only the records needed to restore the database to thetime of the last backup (point-in-time recovery). Changes made to the databaseafter the last backup cannot be recovered. This is the default.

In NORMAL mode, you cannot use a database backup trigger.

RollforwardSpecifies that TSM saves the records needed to restore the database to its mostcurrent state (roll-forward recovery). You can use a database backup series createdin ROLLFORWARD mode for either point-in-time or roll-forward recovery.

In ROLLFORWARD mode, you can use the database backup trigger. If the triggeris defined when you change to ROLLFORWARD mode, TSM immediately runs afull backup. If the trigger is not defined, your next database backup must be a fullbackup. If you attempt an incremental backup, the operation fails.

Examples

Task

Change the log mode from roll-forward to normal.

Command:set logmode normal

SET LOGMODE


Related Commands

Table 246. Commands Related to SET LOGMODE

Command Description





SET LOGMODE


SET LRECLRECOVERYFILE (Set Logical Record Length for a File)

Use this command to specify the logical record length for the file. The LRECLVALUEaffects volume history files, device configuration files, and Tivoli Disaster RecoveryManager (DRM) plan files. This setting affects the active server session only. When theserver restarts, the setting reverts to the LRECLRECOVERYFILE option value that isset in the TSM server options file.

Privilege Class


Syntax

ÊÊ Set LRECLrecoveryfile lreclvalue ÊÍ

Parameterslreclvalue

Specifies the logical record length value that you use to create volume history files,device configuration files, and Tivoli Disaster Recovery Manager (DRM) plan files.You can set a value from 1 to 32760 characters. You cannot edit this file if thevalue is greater than 240.

Examples

Task

Set the logical record length to 60.

Command:set lreclrecoveryfile 60

Related Commands

Table 247. Commands Related to SET LRECLRECOVERYFILE

Command Description




SET LRECLRECOVERYFILE


||

|||||

|

|

|

||||||||||

|

|

|||||

|

|

|

||

|

|||

||

||

|||

|||

|

SET MAXCMDRETRIES (Set the Maximum Number of Command Retries)

Use this command to set the maximum number of times that a scheduler on a clientnode can retry a failed, scheduled command.

You can use the command to override the maximum number of retries specified by theclient node. A client’s value is overridden only if the client is able to connect with theserver.

This command is used with the SET RETRYPERIOD command to regulate the timeand the number of retry attempts to execute a failed command.

You can issue the QUERY STATUS command to display the current retry value. Atinstallation, TSM is configured so that each client determines its own retry value.

Privilege Class


Syntax

ÊÊ Set MAXCMDRetriesnumber

ÊÍ

Parametersnumber

Specifies the maximum number of times the scheduler on a client node can retry afailed scheduled command. This parameter is optional.

The default is that each client determines its own value for this parameter. You canspecify an integer from 0 to 9999. See the appropriate client documentation formore information on setting the maximum command retries from the client.

Examples

Task

Retry, only twice, a failed attempt to process a scheduled command.

Command:set maxcmdretries 2

SET MAXCMDRETRIES


||

Related Commands

Table 248. Command Related to SET MAXCMDRETRIES

Command Description



SET MAXCMDRETRIES


|

SET MAXSCHEDSESSIONS (Set Maximum Scheduled Sessions)

Use this command to set the number of sessions that are allowed to the server forprocessing scheduled operations. This command specifies the maximum number ofscheduled sessions as a percentage of the total number of server sessions available.

Limiting the number of sessions ensures that sessions are available for unscheduledoperations, such as backup or archive.

You can increase either the total number of sessions (with the MAXSESSIONSparameter) or the maximum percentage of scheduled sessions. Increasing the totalnumber of sessions available can affect server performance. Increasing the maximumpercentage of scheduled sessions can reduce the sessions available for unscheduledoperations.

Privilege Class


Syntax

ÊÊ Set MAXSCHedsessions percent ÊÍ

Parameterspercent (Required)

Specifies the percentage of total server sessions that can be used for scheduledoperations. You can specify an integer from 0 to 100. The maximum number oftotal available server sessions is determined by the MAXSESSIONS parameter inthe server option file.

If you set the maximum percentage of scheduled sessions to 0, no scheduledevents can begin. If you set the maximum percentage of scheduled sessions to100, the maximum number of scheduled sessions is the value of theMAXSESSIONS option.

Examples

Task

The MAXSESSIONS option is set to 80. To permit no more than 20 sessions to beavailable for scheduled activity, set the percentage to 25.

Command:set maxschedsessions 25

SET MAXSCHEDSESSIONS


Related Commands

Table 249. Commands Related to SET MAXSCHEDSESSIONS

Command Description



SET MAXSCHEDSESSIONS


SET MINPWLENGTH (Set Minimum Password Length)

Use this command to set the minimum length of a password.

Privilege Class


Syntax

ÊÊ Set MINPwlength length ÊÍ

Parameterslength (Required)

Specifies the minimum length of a password. You can specify an integer from 0 to64. A value of 0 means that the password length is not checked. At installation, thevalue for minimum password length is set to 0.

Examples

Task

Set the minimum password length to 5 characters.

Command:set minpwlength 5

Related Commands

Table 250. Commands Related to SET MINPWLENGTH

Command Description


SET INVALIDPWLIMIT Sets the number of invalid logon attemptsbefore a node is locked.

SET MINPWLENGTH


SET PASSEXP (Set Password Expiration Date)

Use this command to set the password expiration period for administrator and clientnode passwords.

Attention: If you do not specify either the NODE or ADMIN parameters, all client nodeand administrator passwords will be assigned the new password expiration period.

Use the QUERY STATUS command to display the password expiration period, which atinstallation is set to 90 days.

Privilege Class


Syntax

ÊÊ Set PASSExp Ê

Ê

· ·

days, ,

Node = node_name Admin = admin_name

ÊÍ


Specifies the number of days the password remains valid.

You can specify from 1 to 9999 if you do not specify NODE= or ADMIN=. If youspecify the NODE or the ADMIN parameter, you can specify from 0 to 9999. Avalue of 0 means that the password never expire. If a password expires, the serverprompts for a new password when the administrator or client node contacts theserver.

NodeSpecifies the name of the node whose password expiration period you would like toset. To specify a list of nodes, separate the names with commas and no interveningspaces. This parameter is optional.

AdminSpecifies the name of the administrator whose password expiration period youwould like to set. To specify a list of administrators, separate the names withcommas and no intervening spaces. This parameter is optional.

SET PASSEXP


||

||

|||||

||||

||||

Examples

Task 1

Set the administrator and client node password expiration period to 45 days.

Command:set passexp 45

Task 2

Set the administrator LARRY’s password expiration period to 120 days.

Command:set passexp 120 admin=larry

Related Commands

Table 251. Commands Related to SET PASSEXP

Command Description



SET PASSEXP


SET QUERYSCHEDPERIOD (Set Query Period for Polling Client Nodes)

Use this command to regulate how often client nodes contact the server to obtainscheduled work when it is running in the client-polling scheduling mode.

Each client can set its own retry period at the time its scheduler is started. You can usethis command to override the value specified by all clients that can connect with theserver.

If client nodes poll more frequently for schedules, the nodes receive changes toschedules more quickly. However, increased polling by the client nodes also increasesnetwork traffic.

You can issue the QUERY STATUS command to display the value for the periodbetween schedule queries. At installation, TSM is configured so that each client nodedetermines its own value for this setting.

Privilege Class


Syntax

ÊÊ Set QUERYSCHedperiodhours

ÊÍ

Parametershours

Specifies the maximum number of hours the scheduler on a client node waitsbetween attempts to contact the server to obtain a schedule. This parameter isoptional. You can specify an integer from 1 to 9999. If you do not specify a valuefor this parameter, each client determines its own value for this parameter.

Examples

Task

Have all clients using the polling scheduling mode contact the server every 24 hours.

Command:set queryschedperiod 24



Related Commands

Table 252. Commands Related to SET QUERYSCHEDPERIOD

Command Description





SET RANDOMIZE (Set Randomization of Scheduled Start Times)

Use this command to set randomized start times within the startup window of eachschedule for clients using the client-polling scheduling mode. A startup window is thestart time and duration during which a schedule must be initiated. A client-pollingscheduling mode is a client/server communication technique where the client queriesthe server for work. Each schedule has a window during which execution can begin. Tobalance network and server load, the start times for clients can be scattered across thatwindow. Use this command to specify the fraction of the window over which start timesfor clients are to be distributed.

The randomization occurs at the beginning of the window to allow time for retries, ifnecessary, unless the client’s first contact with the server is after the start time for theevent.

You can issue the QUERY STATUS command to display the value for the schedulerandomization percentage. At installation, the value is set to 25 percent.

Set the randomization percentage to a value greater than 0 to prevent communicationerrors that can result from a large group of clients contacting the server simultaneously.If you do experience communication errors, you can increase the randomizationpercentage so that client contact is spread out, thus decreasing the chance forcommunication overload and failure.

Privilege Class


Syntax

ÊÊ Set RANDomize percent ÊÍ

Parameterspercent (Required)

Specifies the percentage of the startup window over which the start times forindividual clients are distributed. You can specify an integer from 0 to 50.

A value of 0 indicates that no randomization occurs and that all clients executeschedules at the beginning of the startup windows.

A value of 50 indicates that clients are assigned start times that are randomlyscattered across the first half of each startup window.

At installation, this value is set to 25, indicating that the first 25 percent of thewindow is used for randomization.

SET RANDOMIZE


If you have specified DURUNITS=INDEFINITE in the DEFINE SCHEDULEcommand, the percentage is applied to a 24 hour period. For example, a value of25 percent would result in a 6 hour window.

Examples

Task

Set randomization to 50 percent.

Command:set randomize 50

Related Commands

Table 253. Commands Related to SET RANDOMIZE

Command Description




SET RANDOMIZE


SET REGISTRATION (Set Open or Closed Registration)

Use this command to require a system or policy administrator to register client nodes(closed registration) or to permit each user to register his own workstation as a clientnode with the server (open registration).

With closed registration, an administrator defines the following:

v Each workstation’s node name and password

v The policy domain to which the client node belongs

v Whether the user can choose to compress files before sending them to serverstorage

v Whether the user can delete backup or archive files from server storage

With open registration, when a user accesses the server from an unregistered clientnode, the server prompts the user for a node name, password, and contact information,and registers the workstation. The server sets the following defaults:

v Each client node is assigned to the policy domain named STANDARD

v Each user defines whether data compression is used before files are sent to serverstorage

v Each user is allowed to delete archived files from server storage. The user cannotdelete backup files

v The administrator can reassign domains or change node attributes using theUPDATE NODE command

Existing registered client nodes are not affected by changes in the registration process.

Use the QUERY STATUS command to display the status of registration. At installation,this value is set to CLOSED.

Privilege Class


Syntax

ÊÊ Set REGistration ClosedOpen

ÊÍ

ParametersClosed

Specifies that client nodes must be registered by a system or policy administrator.

OpenSpecifies that users can register their workstations as client nodes with the server.

SET REGISTRATION


Examples

Task 1

A policy or system administrator registers all client nodes to the server.

Command:set registration closed

Task 2

Users register as client nodes to the server.

Command:set registration open

Related Commands

Table 254. Command Related to SET REGISTRATION

Command Description


SET REGISTRATION


SET RETRYPERIOD (Set Time between Retry Attempts)

Use this command to set the number of minutes the scheduler on a client node waitsbetween retry attempts after a failed attempt to contact the server or after a scheduledcommand fails to process.

Each client can set its own retry period at the time its scheduler program is started. Youcan use this command to override the values specified by all clients that can connectwith the server.

This command is used in conjunction with the SET MAXCMDRETRIES command toregulate the period of time and the number of retry attempts to execute a failedcommand.

You can issue the QUERY STATUS command to display the value for the periodbetween retries. At installation,TSM allows each client to determine its own retry period.

Privilege Class


Syntax

ÊÊ Set RETRYPeriodminutes

ÊÍ

Parametersminutes

Specifies the number of minutes the scheduler on a client node waits between retryattempts after a failed attempt to contact the server or after a scheduled commandfails to process. When setting the retry period, set a time period that permits morethan one retry attempt within a typical startup window. You can specify an integerfrom 1 to 9999.

Examples

Task

Have the client scheduler retry failed attempts to contact the server or to processscheduled commands every 15 minutes.

Command:set retryperiod 15

SET RETRYPERIOD


Related Commands

Table 255. Commands Related to SET RETRYPERIOD

Command Description



SET RETRYPERIOD


SET SCHEDMODES (Select a Central Scheduling Mode)

Use this command to determine how the clients communicate with the server to beginscheduled work. Each client must be configured to select the scheduling mode in whichit operates.

This command is used with the SET RETRYPERIOD command to regulate the timeand the number of retry attempts to process a failed command.

You can issue the QUERY STATUS command to display the value for the schedulingmode supported. At installation, the value is set to ANY.

Privilege Class


Syntax

ÊÊ Set SCHEDMODes ANYPOllingPRompted

ÊÍ

ParametersANY

Specifies that the server allows clients to run in either the client-polling or theserver-prompted scheduling mode.

POllingSpecifies that only the client-polling mode can be used. Client nodes poll the serverat prescribed time intervals to obtain scheduled work.

PRomptedSpecifies that only the server-prompted mode can be used. This mode is onlyavailable for clients that communicate with TCP/IP. Client nodes wait to becontacted by the server when scheduled work needs to be performed and asession is available.

Examples

Task

A server allows both server-prompted and client-polling central scheduling. You want totemporarily restrict the scheduled operations to clients that use the client-polling mode.If you set the schedule mode to POLLING, the server discontinues prompting clients toexecute scheduled commands. This means that any client scheduler using theserver-prompted mode waits until you set the schedule mode to ANY or PROMPTED.

SET SCHEDMODES


||

Command:set schedmodes polling

Related Commands

Table 256. Command Related to SET SCHEDMODES

Command Description



SET SCHEDMODES


|

SET SERVERHLADDRESS (Set the High Level Address of a Server)

Use this command to set the high level address (IP) of a server. TSM uses the addresswhen you issue a DEFINE SERVER command with CROSSDEFINE=YES.

Privilege Class


Syntax

ÊÊ Set SERVERHladdress ip_address ÊÍ

Parametersip_address (Required)

Specifies a server high-level address as a numeric dotted decimal name or a hostname. If a host name is specified, a server that can resolve the name to the dotteddecimal form must be available.

Examples

Task

Set the high-level address of HQ_SERVER to 9.230.99.66.

Command:set serverhladdress 9.230.99.66

Related Commands

Table 257. Command Related to SET SERVERHLADDRESS

Command Description





SET SERVERHLADDRESS


||

||||

|

||

|

SET SERVERLLADDRESS (Set the Low Level Address of a Server)

Use this command to set the low level address of a server. TSM uses the addresswhen you issue a DEFINE SERVER command with CROSSDEFINE=YES.

Privilege Class


Syntax

ÊÊ Set SERVERLladdress tcp_port ÊÍ

Parameterstcp_port (Required)

Specifies the low level address of the server. Generally, this address is identical tothe TCPPORT option in the server option file of the server.

Examples

Task

Set the low level address of HQ_SERVER to 1500.

Command:set serverlladdress 1500

Related Commands

Table 258. Command Related to SET SERVERLLADDRESS

Command Description





SET SERVERLLADDRESS


||

|||

|

||

|

SET SERVERNAME (Specify the Server Name)

Use this command to change the server name. If you migrate from ADSM to TivoliStorage Manager, the name is set to ADSM or the name last specified to ADSM with aSET SERVERNAME command. If you do not migrate from ADSM, the name is set atinstallation to SERVER1.

Use the QUERY STATUS command to display the server name.

Privilege Class


Syntax

ÊÊ Set SERVername server_name ÊÍ


Specifies the new server name. The name must be unique across a server networkfor enterprise event logging, enterprise configuration, command routing, or virtualvolumes. The maximum length of the name is 64 characters.

Examples

Task

Name the server WELLS_DESIGN_DEPT.

Command:set servername wells_design_dept

Related Commands

Table 259. Command Related to SET SERVERNAME

Command Description


SET SERVERNAME


SET SERVERPASSWORD (Set Password for Server)

Use this command to set the password for communication between servers to supportenterprise administration and enterprise event logging and monitoring.

Privilege Class


Syntax

ÊÊ Set SERVERPAssword password ÊÍ

Parameterspassword (Required)

Specifies a password for the server. Other servers must have the same passwordin their definitions of this server.

Examples

Task

Set the password for HQ_SERVER to agave.

Command:set serverpassword agave

Related Commands

Table 260. Command Related to SET SERVERPASSWORD

Command Description





SET SERVERPASSWORD


||

||

|

||

|

SET SERVERURL (Set URL for Server)

Use this command to specify a Uniform Resource Locator (URL) address for accessingthe server from the web browser interface. TSM uses this address when a server isdefined and cross definition is permitted.

Privilege Class


Syntax

ÊÊ Set SERVERURL url ÊÍ

Parametersurl (Required)

Specifies the URL address for accessing the server from a Web browser interface.

Examples

Task

Set the URL address for SERVER_A to http://9.115.33.173:1581

Command:set serverurl http://9.115.33.173:1581

Related Commands

Table 261. Command Related to SET SERVERURL

Command Description





SET SERVERURL


|||

|

|

||

|

SET SQLDATETIMEFORMAT (Set the Format for Date, Time, and Time Stamp forSQL Data)

Use this command to control the format in which SQL date, time, and time stamp dataare displayed. See your SQL documentation for details about these formats.

Privilege Class


Syntax

ÊÊ Set SQLDATETIMEformatIso

IsoUsaEurJisLocal

ÊÍ

Parameters

Select one of the following formats:

IsoSpecifies the International Standards Organization (ISO) format. ISO is the default.

UsaSpecifies the IBM USA standard format.

EurSpecifies the IBM European standard format.

JisSpecifies the Japanese Industrial Standard Christian Era. Currently the JIS formatis the same as the ISO format.

LocalSite-defined. Currently, the LOCAL format is the same as the ISO format.

Examples

Task

Set the format for SQL date, time, and time stamp data to ISO.

Command:set sqldatetimeformat iso



Related Commands

Table 262. Commands Related to SET SQLDATETIMEFORMAT

Command Description







SET SQLDISPLAYMODE (Set the Display of SQL Data Types)

Use this command to control how SQL data types are displayed.

Privilege Class


Syntax

ÊÊ Set SQLDISPlaymodeNarrow

NarrowWide

ÊÍ

ParametersNarrow

Specifies that the column display width is set to 18. Any wider string is forced ontomultiple lines at the client. NARROW is the default.

WideSpecifies that the column display width is set to 250.

Examples

Task

Set the SQL data type display to wide column.

Command:set sqldisplaymode wide

Related Commands

Table 263. Commands Related to SET SQLDISPLAYMODE

Command Description





SET SQLDISPLAYMODE


SET SQLMATHMODE (Set the Mode for SQL Arithmetic)

Use this command to round or truncate decimal numbers for SQL arithmetic.

Privilege Class


Syntax

ÊÊ Set SQLMATHmodeTruncate

TruncateRound

ÊÍ

ParametersTruncate

Specifies that decimal numbers are truncated according to DB2 SQL formulas.TRUNCATE is the default.

RoundSpecifies that decimal numbers are rounded according to DB2 SQL formulas.

Examples

Task

Set SQL arithmetic mode to TRUNCATE.

Command:set sqlmathmode truncate

Related Commands

Table 264. Commands Related to SET SQLMATHMODE

Command Description





SET SQLMATHMODE


SET SUMMARYRETENTION (Set Days to Keep Data in Activity Summary Table)

Use this command to specify the number of days to keep information in the SQL activitysummary table.

The SQL activity summary table contains statistics about each client session and serverprocesses. For a description of the information in the SQL activity summary table, usethe following command:

select colname,remarks from columns, where tabname='SUMMARY'

Issue the QUERY STATUS command to display the number of days the information iskept. At installation, TSM allows each server to determine its own number of days forkeeping information in the SQL activity summary table.

Privilege Class


Syntax

ÊÊ Set SUMmaryretentiondays

ÊÍ

Parametersdays

Specifies the number of days to keep information in the activity summary table. Youcan specify a number from 0 to 9999. A value of 0 means that information in theactivity summary table is not kept. A value of 1 specifies to keep the activitysummary table for the current day.

Examples

Task

Set the server to retain the activity summary table information for 15 days.

Command:set summaryretention 15

Related Commands

Table 265. Commands Related to SET RETRYPERIOD

Command Description


SET SUMMARYRETENTION


Table 265. Commands Related to SET RETRYPERIOD (continued)

Command Description




SET SUMMARYRETENTION


SET WEBAUTHTIMEOUT (Set the Web Time-out Interval)

Use this command to set the time-out interval for the administrative Web interface. Afterthe interval elapses, an administrator must re-enter the administrator name andpassword.

Privilege Class


Syntax

ÊÊ Set WEBauthtimeout minutes ÊÍ

Parametersminutes (Required)

Specifies the time-out interval in minutes. The minimum value is 0, which meansthat the administrators are never timed out. The maximum value is 9999. Thedefault is 10.

Examples

Task

Set the time-out interval to 15 minutes.

Command:set webauthtimeout 15

Table 266. Commands Related to SET WEBAUTHTIMEOUT

Command Description


SET WEBAUTHTIMEOUT


|||

||

|||

|

SETOPT (Set a Server Option for Dynamic Update)

Use this command to update a server option dynamically without stopping andrestarting the server. A SETOPT command contained in a macro or a script cannot berolled back.

Privilege Class


Syntax

ÊÊ SETOPT option_name option_value ÊÍ

Parametersoption_name (Required)

Specifies a text string of information identifying the server option to be updated.The maximum length of the text string is 255 characters. The following options areavailable:

MAXSESSIONS

COMMTIMEOUT NOAUDITSTORAGEDATEFORMAT NUMBERFORMATEXPINTERVAL RESTOREINTERVALEXPQUIET TIMEFORMATIDLETIMEOUT

option_value (Required)Specifies the value for the server option.

Examples

Task

Update an existing server option; for example, DATEFORMAT 1 to DATEFORMAT 5.

Command:setopt dateformat 5

Related Commands

Table 267. Commands Related to SETOPT

Command Description


QUERY SYSTEM Displays details about the TSM server system.

SETOPT


UNLOCK ADMIN (Unlock an Administrator)

Use this command to allow a locked administrator to access the server again.

Privilege Class


Syntax

ÊÊ UNLOCK Admin admin_name ÊÍ


Specifies the name of the administrator to unlock.

Examples

Task

The administrator JOE is locked out of TSM. Permit JOE to access the server.

Command:unlock admin joe

Related Commands

Table 268. Commands Related to UNLOCK ADMIN

Command Description



UNLOCK ADMIN


UNLOCK NODE (Unlock a Client Node)

Use this command to allow a locked client node to access the server again.

Privilege Class


Syntax

ÊÊ UNLOCK Node node_name ÊÍ


Specifies the name of the client node to unlock.

Examples

Task

The client node SMITH is locked out of TSM. Permit SMITH to access the server.

Command:unlock node smith

Related Commands

Table 269. Commands Related to UNLOCK NODE

Command Description



UNLOCK NODE


UNLOCK PROFILE (Unlock a Profile)

Use this command on a configuration manager to unlock a configuration profile so itcan be distributed to subscribing managed servers.

Privilege Class


Syntax

ÊÊ UNLOCK PROFIle profile_name ÊÍ


Specifies the profile to unlock. You can use wildcard characters to indicate multiplenames.

Examples

Task

Unlock a profile named TOM.

Command:unlock profile tom

Related Commands

Table 270. Commands Related to UNLOCK PROFILE

Command Description










UNLOCK PROFILE


||

||

|

|

|

||||||||||

|

|

|||

|

|

|

||

|

|||

||

||

||

|||

|||

||

||

||

|||

||

UPDATE ADMIN (Update an Administrator)

Use this command to change the password or contact information for an administrator.However, you cannot update the SERVER_CONSOLE administrator name.

Passwords for administrators must be changed after a length of time determined by theSET PASSEXP command.

You must use the RENAME ADMIN command to change the name of a registeredadministrator.

Privilege Class

To issue this command to change another administrator’s password or contactinformation, you must have system privilege. Any administrator can issue this commandto update his or her own password or contact information.

Syntax

ÊÊ(1)

UPDate Admin admin_namepassword PASSExp = days

Ê

ÊCONtact = text FORCEPwreset = No

Yes

ÊÍ

Notes:

1 You must specify at least one optional parameter on this command.


Specifies the name of the administrator to be updated.

passwordSpecifies the administrator’s password. This parameter is optional. Passwordsremain current for a period determined by the password expiration period.

PASSExpSpecifies the number of days the password remains valid. You can set thepassword expiration period from 0 to 9999 days. A value of 0 means that thepassword never expires. This parameter is optional. If you do not specify thisparameter the password expiration period is unchanged.

CONtactSpecifies a text string that identifies the administrator. This parameter is optional.Enclose the text string in quotation marks if it contains any blanks. To removepreviously defined contact information, specify a null string ("").

UPDATE ADMIN


|

|||||

FORCEPwresetSpecifies whether the administrator is required to change or reset the password.This parameter is optional. Possible values are:

No Specifies that the administrator does not need to change or reset the passwordwhile attempting to sign on to the server. The password expiration period is setby the SET PASSEXP command.

YesSpecifies that the administrator’s password will expire at the next sign on. Theadministrator must change or reset the password at that time. If a password isnot specified, you will receive a syntax error.

Examples

Task

Update the administrator LARRY to have the password SECRETWORD and apassword expiration period of 120 days.

Command:update admin larry secretword passexp=120

Related Commands

Table 271. Commands Related to UPDATE ADMIN

Command Description








UPDATE ADMIN


||

UPDATE CLIENTOPT (Update a Client Option Sequence Number)

Use this command to update the sequence number of a client option.

Privilege Class


Syntax

ÊÊ UPDate CLIENTOpt option_set_name option_name Ê

Ê current_sequence_number new_sequence_number ÊÍ



option_name (Required)Specifies a valid client option.

current_sequence_number (Required)Specifies the current sequence number of the option.

new_sequence_number (Required)Specifies the new sequence number of the option.

Examples

Task

Update current client option sequence number.

Command:update clientopt eng dateformat 0 9

Related Commands

Table 272. Commands Related to UPDATE CLIENTOPT

Command Description






UPDATE CLIENTOPT


UPDATE CLOPTSET (Update a Client Option Set Description)

Use this command to update the description for a client option set.

Privilege Class


Syntax

ÊÊ UPDate CLOptset option_set_name DESCription = description ÊÍ



DESCription (Required)Specifies a description of the client option set. The maximum length of thedescription is 255 characters. Enclose the description in quotation marks if itcontains blank characters.

Examples

Task

Update the description for a client option set named ENG.

Command:update cloptset eng description="unix"

Related Commands

Table 273. Commands Related to UPDATE CLOPTSET

Command Description








UPDATE CLOPTSET


UPDATE COPYGROUP (Update a Copy Group)

Use this command to update a backup or archive copy group. To allow clients to usethe updated copy group, you must activate the policy set that contains the copy group.

Note: The UPDATE COPYGROUP command fails if you specify a copy storage poolas a destination.

The UPDATE COPYGROUP command takes two forms, depending upon whether theupdate is for a backup copy group or for an archive copy group. The syntax andparameters for each form are defined separately.

UPDATE COPYGROUP


UPDATE COPYGROUP — Backup

Use this command to update a defined backup copy group.

Privilege Class


Syntax

ÊÊ UPDate COpygroup domain_name policy_set_name class_name STANDARD Ê

ÊType = Backup DESTination = pool_name FREQuency = days

Ê

ÊVERExists = number

NOLimitVERDeleted = number

NOLimit

Ê

ÊRETExtra = days

NOLimitRETOnly = days

NOLimit

Ê

ÊMODE = MODified

ABSoluteSERialization = SHRSTatic

STaticSHRDYnamicDYnamic

ÊÍ



policy_set_name (Required)Specifies the policy set to which the copy group belongs. You cannot update acopy group in the ACTIVE policy set.


STANDARD (Required)Specifies the copy group, which must be STANDARD.

Type=BackupSpecifies that you want to update a backup copy group. This parameter is optional.



DESTinationSpecifies the primary storage pool where the server initially stores backup data.This parameter is optional. You cannot specify a copy storage pool as thedestination.

FREQuencySpecifies how frequently TSM can back up a file. This parameter is optional. TSMbacks up a file only when the specified number of days has elapsed since the lastbackup. The FREQUENCY value is used only during a full incremental backupoperation. This value is ignored during selective backup or partial incrementalbackup. You can specify an integer from 0 to 9999. The value 0 means that TSMcan back up a file regardless of when the file was last backed up.

VERExistsSpecifies the maximum number of backup versions to retain for files that arecurrently on the client file system. This parameter is optional.

If a backup causes the limit to be exceeded, the server expires the oldest backupversion that exists in server storage. Possible values are:

numberSpecifies the number of backup versions to retain for files that are currently onthe client file system. You can specify an integer from 1 to 9999.

NOLimitSpecifies that you want the server to retain all backup versions.

The number of backup versions to retain is controlled by this parameter untilversions exceed the retention time specified by the RETEXTRA parameter.

VERDeletedSpecifies the maximum number of backup versions to retain for files that havebeen deleted from the client file system after being backed up using TSM. Thisparameter is optional.

If a user deletes a file from the client file system, the next backup causes theserver to change the active backup version of the file to inactive and expire theoldest versions in excess of this number. The expiration date for the remainingversions is determined by the retention time specified by the RETEXTRA orRETONLY parameter. Possible values are:

numberSpecifies the number of backup versions to retain for files that are deletedfrom the client file system after being backed up. You can specify a value from0 to 9999.

NOLimitSpecifies that you want the server to retain all backup versions for files thatare deleted from the client file system after being backed up.

RETExtraSpecifies the number of days that the server retains a backup version after thatversion becomes inactive. A version of a file becomes inactive when the clientstores a more recent backup version, or when the client deletes the file from theworkstation and then runs a full incremental backup. The server deletes inactive



versions based on retention time even if the number of inactive versions does notexceed the number allowed by the VEREXISTS or VERDELETED parameters. Thisparameter is optional. Possible values are:

daysSpecifies the number of days to retain inactive backup versions. You canspecify an integer from 0 to 9999.

NOLimitSpecifies that you want to retain inactive backup versions indefinitely.

If you specify NOLIMIT, the server deletes extra backup versions based on theVEREXISTS parameter (when the file still exists on the client file system) orthe VERDELETED parameter (when the file no longer exists on the client filesystem).

RETOnlySpecifies the number of days to retain the last backup version of a file that hasbeen deleted from the client file system. This parameter is optional. Possible valuesare:

daysSpecifies the number of days to retain the last remaining inactive copy of a file.You can specify an integer from 0 to 9999.

NOLimitSpecifies that you want to keep the last remaining inactive version of a fileindefinitely.

If you specify NOLIMIT, the server retains the last remaining backup versionforever, unless a user or administrator deletes the file from server storage.

MODESpecifies whether TSM backs up a file only if the file has changed since the lastbackup, or whenever a client requests a backup. This parameter is optional.Possible values are:

MODifiedSpecifies that the file is backed up only if it has changed since the last backup.A file is considered changed if any of the following is true:

v The date last modified is different

v The file size is different

v The file owner is different

v The file permissions are different

ABSoluteSpecifies that the file is backed up regardless of whether it has been changed.

The MODE value is used only for full incremental backup. This value is ignoredduring partial incremental backup or selective backup.

SERializationSpecifies how TSM handles files or directories when they are modified duringbackup processing. This parameter is optional. Possible values are:



SHRSTaticSpecifies that TSM backs up a file or directory only if it is not being modifiedduring backup. TSM attempts to perform a backup as many as four times,depending on the value specified for the CHANGINGRETRIES client option. Ifthe file or directory is modified during each backup attempt, TSM does notback it up.

STaticSpecifies that TSM backs up a file or directory only if it is not being modifiedduring backup. TSM attempts to perform the backup only once.


SHRDYnamicSpecifies that if the file or directory is being modified during a backup attempt,TSM backs up the file or directory during the last attempt even though the fileor directory is being modified. TSM attempts to perform a backup as many asfour times, depending on the value specified for the CHANGINGRETRIESclient option.

DYnamicSpecifies that TSM backs up a file or directory on the first attempt, regardlessof whether the file or directory is being modified during backup processing.

Attention: Be careful about using the SHRDYNAMIC and DYNAMIC values.These values allow TSM to back up a file or directory while modifications areoccurring. As a result, the backup version might be a fuzzy backup. A fuzzy backupdoes not accurately reflect what is currently in the file or directory because itcontains some, but not all, modifications. If a file that contains a fuzzy backup isrestored, the file may or may not be usable, depending on the application that usesthe file. If a fuzzy backup is not acceptable, be sure to use a serialization value thatallows TSM to create a backup version only if the file or directory is not beingmodified (SHRSTATIC or STATIC).

Examples

Task

Update the backup copy group (STANDARD) in the EMPLOYEE_RECORDS policydomain, VACATION policy set, ACTIVEFILES management class. Change thedestination to DISKPOOL, with a minimum interval of seven days between backups,regardless of whether the files have been modified. Retain up to three backup versionswhile a file still exists on a client file system.

Command:update copygroup employee_records vacation activefiles standardtype=backup destination=diskpool frequency=7 verexists=3 mode=absolute



UPDATE COPYGROUP — Archive

Use this command to update a defined archive copy group.

Privilege Class


Syntax

ÊÊ UPDate COpygroup domain_name policy_set_name class_name STANDARD Ê

Ê Type = ArchiveDESTination = pool_name FREQuency = Cmd

Ê

ÊRETVer = days

NOLimitMODE = ABSolute

Ê

ÊSERialization = SHRSTatic

STaticSHRDYnamicDYnamic

ÊÍ



policy_set_name (Required)Specifies the policy set to which the copy group belongs. You cannot update acopy group in the ACTIVE policy set.


STANDARDSpecifies the copy group, which must be standard. This parameter is required.

Type=ArchiveSpecifies that you want to update an archive copy group. This parameter isrequired.

DESTinationSpecifies the primary storage pool where the server initially stores the archive copy.This parameter is optional. You cannot specify a copy storage pool as thedestination.



FREQuency=CmdSpecifies the copy frequency, which must be CMD. This parameter is optional.

RETVerSpecifies the number of days to keep an archive copy. This parameter is optional.Possible values are:

daysSpecifies the number of days to keep an archive copy. You can specify aninteger from 0 to 9999.

NOLimitSpecifies that you want to keep an archive copy indefinitely.

If you specify NOLIMIT, the server retains archive copies forever, unless a useror administrator deletes the file from server storage.

The value of the RETVER parameter can affect the management class to whichthe server binds an archived directory. If the client does not use the ARCHMCoption, the server binds directories that are archived to the default managementclass. If the default management class has no archive copy group, the server bindsdirectories that are archived to the management class with the shortest retentionperiod.

MODE=ABSoluteSpecifies that a file is always archived when the client requests it. The MODE mustbe ABSOLUTE. This parameter is optional.

SERializationSpecifies how TSM handles files that are modified during archive. This parameteris optional. Possible values are:

SHRSTaticSpecifies that TSM does not archive a file that is being modified. TSMattempts to perform an archive as many as four times, depending on the valuespecified for the CHANGINGRETRIES client option. If the file is modifiedduring the archive attempt, TSM does not archive the file.

STaticSpecifies that TSM does not archive a file that is being modified. If a file ismodified during the archive attempt, TSM does not archive the file.


SHRDYnamicSpecifies that if the file is being modified during an archive attempt, TSMarchives the file during its last attempt even though the file is being modified.TSM attempts to archive the file as many as four times, depending on thevalue specified for the CHANGINGRETRIES client option.

DYnamicSpecifies that TSM archives a file on the first attempt, regardless of whetherthe file is being modified during archive processing.



||||||

Attention: Be careful about using the SHRDYNAMIC and DYNAMIC values.These values allow TSM to archive a file while modifications are occurring. As aresult, the archive copy might be a fuzzy backup. A fuzzy backup does notaccurately reflect what is currently in the file because it contains some, but not all,modifications. If a file that contains a fuzzy backup is retrieved, the file may or maynot be usable, depending on the application that uses the file. If a fuzzy backup isnot acceptable, be sure to use a serialization value that allows TSM to create anarchive copy only if the file is not being modified (SHRSTATIC or STATIC).

Examples

Task

Update the archive copy group (STANDARD) in the EMPLOYEE_RECORDS policydomain, VACATION policy set, ACTIVEFILES management class. Change thedestination to TAPEPOOL. Keep archive copies for 190 days.

Command:update copygroup employee_records vacation activefiles standardtype=archive destination=tapepool retver=190



Related Commands

Table 274. Commands Related to UPDATE COPYGROUP

Command Description













UPDATE DBBACKUPTRIGGER (Update the Database Backup Trigger)

Use this command to update the database backup trigger.

Privilege Class


Syntax

ÊÊ UPDate DBBackuptriggerLOGFullpct = percentage

Ê

ÊDEVclass = device_class_name INCRDEVclass = device_class_name

Ê

ÊNUMINCremental = number

ÊÍ

ParametersLOGFullpct

Specifies a recovery log utilization percentage. When this value is exceeded, TSMbacks up the database. The range is from 1 to 99.

DEVclassSpecifies the name of the sequential access device class to use for backups.

If all drives associated with this device class are busy when the backup istriggered, TSM cancels lower priority operations, such as reclamation, to make adrive available for the backup.

INCRDEVclassSpecifies the name of the sequential access device class to use for incrementalbackups.

NUMINCrementalSpecifies the maximum number of incremental backups that can be run before afull backup is required. The range is from 0 to 32. The default is 6. A value of 0specifies that TSM runs only full backups.

Each incremental backup, whether run automatically by TSM or run by anadministrator request, is added to the count of incremental backups run.

Each full backup, whether run automatically by TSM or run by an administratorrequest, resets the count for incremental backups to zero.



Note: If you explicitly request an incremental backup, TSM performs one even ifthe number exceeds this setting. This occurs if the backup is done by anadministrator or through an administrative schedule.

Examples

Task

Reset the database backup trigger to 60 percent and the number of incrementalbackups to 5.

Command:update dbbackuptrigger logfull=60 numincremental=5

Related Commands

Table 275. Commands Related to UPDATE DBBACKUPTRIGGER

Command Description









UPDATE DEVCLASS (Update the Attributes of a Device Class)

Use this command to update a defined device class.

Note: The DISK device class is predefined by TSM and cannot be modified with theUPDATE DEVCLASS command.

The syntax and parameter descriptions are provided according to the device type. Thesyntax and parameter information is presented in the following order:

v FILE (“Syntax” on page 719)

v SERVER (“Syntax” on page 720)

v 8MM (“Syntax” on page 722)

v QIC (“Syntax” on page 725)



v CARTRIDGE (“Syntax” on page 734)

v OPTICAL and WORM Types (“Syntax” on page 737)

v REEL (“Syntax” on page 739)

UPDATE DEVCLASS


UPDATE DEVCLASS—FILE

Privilege Class


Syntax

ÊÊ UPDate DEVclass device_class_nameMOUNTLimit = number

Ê

ÊMAXCAPacity = size DIRectory = directory_name

Ê

ÊOLIBRary object_library_name

ÊÍ


Specifies the name of the device class to be updated.

MOUNTLimitSpecifies the maximum number of files that can be simultaneously open forinput/output. This parameter is optional. You can specify a a number from 1 to 256.

MAXCAPacitySpecifies the maximum size of any data storage files categorized by this deviceclass. This parameter is optional. You must specify this value as an integerfollowed by K (Kilobytes), M (Megabytes), or G (Gigabytes).

For example, MAXCAPACITY=5M specifies that the maximum capacity for avolume in this device class is 5 megabytes. The smallest value allowed is 100KB(that is, MAXCAPACITY=100K).

OLIBRary AS400Specifies the object library that contains the file used in this device class. Thisparameter is optional.

Examples

Task

Update a device class named PLAINFILES with a file device type and a maximumcapacity of 50MB.

Command:update devclass plainfiles devtype=file maxcapacity=50m

UPDATE DEVCLASS—FILE


UPDATE DEVCLASS—SERVER

Privilege Class


Syntax

ÊÊ UPDdate DEVclass device_class_nameSERVERName = server name

Ê

ÊMAXCAPacity = 500M PREFIX = ADSM

volume_prefix

Ê

ÊRETRYPeriod = minutes RETRYInterval = seconds

Ê

ÊMOUNTRetention = minutes MOUNTLimit = number

0

ÊÍ


Specifies the name of the device class to be updated. The maximum length of thedevice class name is 30 characters.

SERVERNameSpecifies the name of the server. The SERVERNAME parameter must match adefined server.

Note: If you change the SERVERNAME of an existing server to a new name, dataon the volumes under the old SERVERNAME will no longer be accessiblewith this device class.

MAXCAPacitySpecifies the maximum size that objects can be when created on the target server;the default for this value is 500M. This parameter is optional.


For example, MAXCAPACITY=5M specifies that the maximum capacity for avolume in this device class is 5 megabytes. The default value is 500M (that is,MAXCAPACITY=500M). The smallest value allowed is 100KB (that is,MAXCAPACITY=100K).



PREFIXSpecifies the beginning portion of the high-level archive file name on the targetserver. This parameter is optional. The maximum length of this prefix is 8characters. Values specified for this parameter must meet the following conditions:


AB.CD2.E



An example of a high level archive file name using the default prefix, with a TSMqualifier added, is ADSM.volume1.

RETRYPeriodSpecifies the retry period in minutes. The retry period is the interval during whichthe server attempts to contact a target server if there is a suspectedcommunications failure. This parameter is optional. The default value is 10 minutes.

RETRYIntervalSpecifies the retry interval in seconds. The retry interval is how often retries aredone within a given time period. This parameter is optional. The default value is 30seconds.

MOUNTRetentionSpecifies the number of minutes to retain an idle connection with the target serverbefore closing the connection. This parameter is optional. The default value is 60.You can specify a number from 0 to 9999.


MOUNTLimitSpecifies the maximum number of sequential access volumes that can besimultaneously mounted for the device class. This parameter is optional. You canspecify a number from 0 to 256.

The following are possible values:

numberSpecifies the maximum number of drives used concurrently in this device classby TSM. This value must never exceed the number of drives that are definedand online in the library that services this device class.

0 (zero)Specifies that no new transactions can gain access to the storage pool. Anycurrent transaction will continue and complete, but new transactions will beterminated.



UPDATE DEVCLASS — 8MM

Privilege Class


Syntax

ÊÊ UPDate DEVclass device_class_nameFORMAT = DRIVE

82008500870020GB

Ê

ÊLIBRary = library_name MOUNTRetention = minutes

Ê

ÊPREFIX = ADSM

prefixESTCAPacity = size MOUNTWait = minutes

Ê

ÊMOUNTLimit = DRIVES

number

ÊÍ



FORMATSpecifies the recording format to be used when writing data to sequential accessmedia. This parameter is optional.

Possible values for 8MM devices are:








20GBSpecifies that TSM writes data using the 20GB recording format. This resultsin a tape capacity of 20.0GB when using standard 112-meter tape cartridges.

LIBRarySpecifies the name of the defined library object that contains the 8MM tape drivesthat can be used by this device class. For information about defining a libraryobject see the DEFINE LIBRARY command.

MOUNTRetentionSpecifies the number of minutes to retain an idle sequential access volume beforedismounting it. This parameter is optional. You can specify a number from 0 to9999.


PREFIXSpecifies the high level qualifier of the data set name that the server writes into thesequential access media labels. For each sequential access volume assigned tothis device class, TSM uses this prefix to create the data set name. This parameteris optional. The maximum length of this prefix is 8 characters.


ESTCAPacitySpecifies the estimated capacity for the sequential access volumes categorized bythis device class. This parameter is optional.



Table 276. TSM Default Estimated Capacity for 8mm Tape


8200 2.3GB

8500 5.0GB



|||

Table 276. TSM Default Estimated Capacity for 8mm Tape (continued)


8700 7.0GB

20GB 20.0GB


MOUNTWaitSpecifies the maximum number of minutes to wait for a sequential access volumeto be mounted in a manual library. This parameter is optional and does not apply toautomated libraries. If the mount request is not satisfied within the specified amountof time, the mount request is canceled. You can specify a number from 0 to 9999.

MOUNTLimitSpecifies the maximum number of sequential access volumes that can besimultaneously mounted for the device class. This parameter is optional. You canspecify a number from 1 to 256. This value should be equal to the number ofdrives available to this device class.




||

UPDATE DEVCLASS — QIC

Privilege Class


Syntax


1201505251000200050104GB2DC4DC25GB

Ê


Ê

ÊPREFIX = ADSM


Ê

ÊMOUNTLimit = DRIVES

number

ÊÍ


Specifies the name of the device class to be defined.


The following are possible values for QIC devices:









5010Specifies the 5010 quarter-inch recording format used for quarter-inch cartridgetapes that can hold 13.4GB of data.

4GBSpecifies the 4GB quarter-inch recording format used for quarter-inch cartridgetapes that can hold 3.9GB of data.

2DCSpecifies the 2DC quarter-inch recording format used for quarter-inch cartridgetapes that can hold 4.9GB of data.

4DCSpecifies the 4DC quarter-inch recording format used for quarter-inch cartridgetapes that can hold 7.9GB of data.

25GBSpecifies the 25GB quarter-inch recording format used for quarter-inchcartridge tapes that can hold 24.9GB of data.

LIBRarySpecifies the name of the defined library object that contains the QIC tape drivesthat can be used by this device class. For information about defining a libraryobject, see the DEFINE LIBRARY command.



PREFIXSpecifies the high level qualifier of the file name that the server writes into the



|||

|||

|||

|||

sequential access media labels. For each sequential access volume assigned tothis device class, TSM uses this prefix to create the data set name. This parameteris optional. The maximum length of this prefix is 8 characters.





For more information on the default estimated capacity for QIC tapes, seeTable 277.

Table 277. TSM Default Estimated Capacity for QIC Tape


120 150MB

525 525MB

1000 1.1GB

2000 2.0GB

5010 13.4GB

4GB 3.9GB

2DC 4.9GB

4DC 7.9GB

25GB 24.9GB






||

||

||

||

UPDATE DEVCLASS — 3590

Privilege Class


Syntax

ÊÊ UPDate DEVclass device_class_name DEVType = 3590FORMAT = DRIVE


Ê



ÊPREFIX = ADSM

PREFIX = ADSMprefix

ESTCAPacity = size

MOUNTWait = 60

MOUNTWait = minutesÊ

ÊMOUNTLimit = number

ÊÍ



DEVType=3590 (Required)Specifies the 3590 device type is assigned to the device class. The 3590 indicatesthat IBM 3590 cartridge tape devices are assigned to this device class.


The values for 3590 devices are:


Note: Use the DRIVE value only when the device class has compatiblesequential access devices. If you specify DRIVE for a device class that



has noncompatible sequential access devices, then you must mountvolumes on devices that are capable of reading or writing at the formatestablished when the volume was first mounted. This can cause delaysif the only sequential access device that can access the volume isalready in use.

3590Specifies that TSM writes data using the basic format or, if available,compacted recording format. This results in a tape capacity of approximately10GB. If the compacted recording format is used, the actual capacity may begreater, depending on the effectiveness of compression.

3590ESpecifies that TSM writes data using the basic format or, if available,compacted recording format. This results in a tape capacity of approximately20GB. If the compacted recording format is used, the actual capacity may begreater depending on the effectiveness of the compression.




PREFIXSpecifies the high-level qualifier of the data set name that the server writes into thesequential access media labels. The maximum length of this prefix is 8 characters.All sequential access volumes assigned to this device class are prefixed with thisvalue. This parameter is optional. The default value is ADSM.


ESTCAPacitySpecifies the estimated capacity for the sequential access volumes defined to astorage pool categorized by this device class. This parameter is optional. You canspecify this parameter if the default estimated capacity for the device class isinaccurate due to compression of data.


The default estimated 3590 cartridge tape capacity is 10GB.

MOUNTWaitSpecifies the maximum number of minutes to wait for a sequential access volumeto be mounted in a manual library. This parameter is optional and does not apply to



|||||

automated libraries. If the mount request is not satisfied within the specified amountof time, the mount request is canceled. The default value is 60 minutes. You canspecify a number from 0 to 9999.






Privilege Class


Syntax

ÊÊ UPDate DEVclass device_class_name DEVType = 3570FORMAT = DRIVE

35703570E

Ê


Ê

ÊPREFIX = ADSM


Ê


ÊÍ


Specifies the name of the device class to be defined.

DEVType (Required)Specifies the 3570 device type is assigned to the device class. The 3570 indicatesthat IBM 3570 cartridge tape devices are assigned to this device class.




Note: Use the DRIVE value only when the device class has compatiblesequential access devices. If you specify DRIVE for a device class thathas noncompatible sequential access devices, then you must mountvolumes on devices that are capable of reading or writing at the format



established when the volume was first mounted. This can cause delaysif the only sequential access device that can access the volume isalready in use.

3570Specifies that TSM writes data using the basic format or, if available,compacted recording format. This results in a tape capacity of approximately5GB. If the compacted recording format is used, the actual capacity may begreater, depending on the effectiveness of compression.


3570ESpecifies that TSM writes data using the basic format or, if available,compacted recording format. This results in a tape capacity of approximately5GB. If the compacted recording format is used, the actual capacity may begreater depending on the effectiveness of compression.



MOUNTRetentionSpecifies the number of minutes, to retain an idle sequential access volume beforedismounting it. This parameter is optional. You can specify a number from 0 to9999.


PREFIXSpecifies the high level qualifier of the data set name that the server writes into thesequential access media labels. For each sequential access volume assigned tothis device class, TSM uses this prefix to create the data set name. This parameteris optional. The maximum length of this prefix is 8 characters.


ESTCAPacitySpecifies the estimated capacity for the sequential access volumes defined to astorage poolcategorized by this device class. This parameter is optional. You canspecify this parameter if the default estimated capacity for the device class isinaccurate due to compression of data.




|

||

|||||

||

|

UPDATE DEVCLASS — CARTRIDGE

Privilege Class


Syntax


348034903490E

Ê


Ê

ÊPREFIX = ADSM

prefixESTCAPacity = size

Ê

ÊMOUNTWait = minutes MOUNTLimit = number

ÊÍ




Possible values for CARTRIDGE devices are:

DRIVESpecifies that TSM selects the highest format that can be supported by thesequential access drive on which a volume is mounted. Attention: UseDRIVE only when the device class has compatible sequential access devices.If you specify DRIVE for a device class that has non-compatible sequentialaccess devices, then you must mount volumes on devices that are capable ofreading or writing at the format established when the volume was firstmounted. This can cause delays if the only sequential access device that canaccess the volume is already in use.

3480Specifies 3480 Basic recording format (18 track).



3490Specifies 3490 Basic recording format, or if available, Compacted recordingformat (18 track).

3490ESpecifies 3490E Basic recording format, or if available, Compacted recordingformat (36 track).




PREFIXSpecifies the high-level qualifier of the data set name that the server writes into thesequential access media labels. For each sequential access volume assigned tothis device class, TSM uses this prefix to create the data set name. This parameteris optional.


v The value must consist of qualifiers that contain up to 8 characters (includingperiods). For example, the following value is acceptable:

AB.CD2.E



An example of a tape volume data set name using the default prefix, with a TSMqualifier added, is ADSM.BFS.

If you have already established a tape label naming convention that supports yourcurrent tape management system, consider using a tape volume prefix thatconforms to your naming conventions.

ESTCAPacitySpecifies the estimated capacity for the sequential access volumes categorized bythis device class. This parameter is optional.



For more information on the default estimated capacity for cartridge tapes, seeTable 278 on page 736.




Tape Format Media Type Estimated Capacity

3480 CST 180MB

3490 CST 360MB

3490E ECCST 720MB (see note)

Note: This format uses the tape drive hardware compression feature, depending on theeffectiveness of compression the actual capacity may be greater than the listed value.






UPDATE DEVCLASS — OPTICAL and WORM TYPES

Privilege Class


Syntax

ÊÊ UPDate DEVclass device_class_nameESTCAPacity = size

Ê


ÊÍ



DEVType=OPTical (Required)Specifies the OPTical device type is assigned to the device class.

DEVType=WORMSpecifies the WORM device type is assigned to the device class. Write Once-ReadMany (WORM) optical media is an archival media. It is intended to store largeamounts of data for a long period of time. Files written to the media are permanentand their space cannot be reused.

ESTcapacity (Required)Specifies the estimated capacity for the sequential access volumes defined to astorage pool categorized by this device class.

The estimated capacity of an OPTICAL volume (two sides of a cartridge) is twicethe value of the ESTcapacity parameter, since the ESTcapacity value specifies theamount of data that can be stored on each side of an OPTICAL cartridge.


For example, ESTcapacity=5M specifies that the estimated capacity for this deviceclass is 5MB.

MOUNTLimitSpecifies the maximum number of sequential access volumes that can besimultaneously mounted for the device class. The default is 1. You can specify anumber from 1 to 256. This value should be equal to the number of drives availableto this device class.

To ensure reasonable performance, set the mount limit less than or equal to thenumber of optical drives on the AS/400 system. If the mount limit is set too large, it



may cause the library to frequently mount and dismount cartridges that areaccessed concurrently by the TSM server. This will severely impact performance,because most of the time will be spent moving cartridges instead of actuallyreading or writing data.

If you want to ensure that at least one optical drive on the AS/400 system isavailable for use by applications other than the TSM server, set the mount limitvalue to one less than the number of drives on the system.




UPDATE DEVCLASS — REEL

Privilege Class


Syntax


160032006250

Ê

ÊLIBRary = library_name MOUNTLimit = number

Ê

ÊMOUNTRetention = minutes PREFIX = ADSM

prefix

Ê

ÊESTCAPacity = size MOUNTWait = minutes

ÊÍ




The values for REEL devices are:


Note: Use DRIVE only when the device class has compatible sequentialaccess devices. If you specify DRIVE for a device class that hasnon-compatible sequential access devices, then you must mountvolumes on devices that are capable of reading or writing at the formatestablished when the volume was first mounted. This can cause delaysif the only sequential access device that can access the volume isalready in use.






LIBRarySpecifies the name of the defined library object with the REEL tape drives that canbe used by this device class. For information about defining a library object, seethe DEFINE LIBRARY command.





PREFIXSpecifies the high level qualifier of the data set name that the server writes into thesequential access media labels. The maximum length of this prefix is 8 characters.All sequential access volumes assigned to this device class are prefixed with thisvalue. This parameter is optional.

If you have already established a media label-naming convention that supportsyour current management system, consider using a volume prefix that conforms toyour naming conventions.

ESTCAPacitySpecifies the estimated capacity for the sequential access volumes defined to astorage pool categorized by this device class. This parameter is optional.


For example, ESTCAPACITY=5M specifies that the estimated capacity for thisdevice class is 5MB.

For more information on the default estimated capacity for reel tapes, seeTable 279 on page 741.



Table 279. TSM Estimated Capacity for REEL Tape


1600 44MB

3200 82MB

6250 156MB


Examples

Task 1

Update a file device class named PLAINFILES to a maximum capacity of 25MB.

Command:update devclass plainfiles sizeacity=25m

Task 2

Update an 8mm device class named 8MMTAPE to a 15-minute mount retention.

Command:update devclass 8mmtape mountretention=15



Related Commands

Table 280. Commands Related to UPDATE DEVCLASS

Command Description







UPDATE DOMAIN (Update a Policy Domain)

Use this command to change a policy domain.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, orrestricted policy privilege for the specified policy domain.

Syntax

ÊÊ UPDate DOmain domain_nameDESCription = description

Ê

ÊBACKRETention = days ARCHRETention = days

ÊÍ


Specifies the name of the policy domain.

DESCriptionDescribes the policy domain using a text string. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters. To remove a previously defineddescription, specify a null string ("").

BACKRETentionSpecifies the number of days (from the date the backup versions became inactive)to retain backup versions that are no longer on the client file system. Thisparameter is optional. You can specify an integer from 0 to 9999. The server usesthe backup retention value to manage inactive versions of files when any of thefollowing conditions occur:

v A file is rebound to a new management class, but neither the new managementclass nor the default management class contains a backup copy group.



ARCHRETentionSpecifies the number of days (from the date of archive) to retain archive copies.This parameter is optional. You can specify an integer from 0 to 9999. The serveruses the archive retention value to manage archive copies of files when either ofthe following conditions occur:

UPDATE DOMAIN




Examples

Task

For the EMPLOYEE_RECORDS policy domain, set the backup retention to 45 daysand the archive retention to 75 days.

Command:update domain employee_records backretention=45 archretention=75

Related Commands

Table 281. Commands Related to UPDATE DOMAIN

Command Description






UPDATE DOMAIN


UPDATE DRIVE (Update a Drive)

Use this command to update a drive.

Note: The UPDATE DRIVE command only applies to MANUAL library type.

Privilege Class


Syntax

ÊÊ UPDate DRive library_name drive_nameDEVIce = device_name

Ê

ÊSHARE = No

SHARE = NoYes

(1)AUTOloader = No

Yes

ÊÍ

Notes:

1 The AUTOLOADER parameter only applies to a device class with a device typeof CARTRIDGE (3480/3490).


Specifies the name of the library to which the drive is assigned.

drive_name (Required)Specifies the name that is assigned to the drive.

DEVIceSpecifies the name of the device that corresponds to the drive. For example, youmight specify tap04. This parameter is optional.

Important: When updating a device name, the device type must be the same. Forexample, if you are updating the device name for a 3490 device type,the new device name must correspond with a 3490 device type. If thedevice type is not the same, update processing does not completesuccessfully.

SHARESpecifies whether or not this drive is a shared device. A shared device is utilized byone or more systems. The values are:

UPDATE DRIVE


No Specifies the drive is not a shared device. If the initial status of the device isvaried offline, the server does not attempt to vary the device online. The deviceis not used by the server.

YesSpecifies the drive is a shared device that is used by one or more systems. Ifthe initial status of the device is varied offline, the device is varied online whenthe server operation begins and is varied offline when the server operationends.

AUTOloaderSpecifies that either a 3480 or 3490 has an Automatic Cartridge Loader (ACL). Thisparameter is optional and only applies to a device class with a device type ofCARTRIDGE (3480/3490). Setting this parameter to YES allows TSM to use theACL. The values are:

No Specifies that an ACL is not available for use.

YesSpecifies that the ACL is available for use.

Examples

Task 1

Update the drive named DRIVE3 (a 3490 device) located in the library named MANLIBby indicating that TSM should use the Automatic Cartridge Loader.

Command:UPDate DRive manlib drive3 AUTOloader=Yes

Task 2

Update the drive named DRIVE8 (a 3490 device) located in the library named MANLIBto notify TSM that the drive is a shared device that can be used by one or moresystems.

Command:UPDate DRive manlib drive8 SHARE=Yes

Related Commands

Table 282. Commands Related to UPDATE DRIVE

Command Description





UPDATE DRIVE


|||

|||

Table 282. Commands Related to UPDATE DRIVE (continued)

Command Description



UPDATE DRIVE


UPDATE EXIT (Update an Exit Program)

Use this command to update an existing exit program. You typically use this commandto notify the server of either a new exit program name or that it must resolve the currentexit program again.

Privilege Class


Syntax

ÊÊ UPDate EXIT MOuntDIsmountDEletionEXpiration

*CURLIB/

*CURLIB/*LIBL/object_library_name/

exit_name ÊÍ

Parametersexit_type Required)

Specifies which exit program to update. The values are:

MOuntSpecifies to update the mount exit program.

DIsmountSpecifies to update the dismount exit program.

DEletionSpecifies to update the deletion exit program.

EXpirationSpecifies to update the expiration exit program.

new_exit_programSpecifies the name of a new exit program. This parameter is optional. The defaultis the name of the currently defined exit program.

exit_librarySpecifies which AS/400 library contains the exit program object. Thisparameter is optional. The default is *CURLIB. The values are:

*CURLIBThe exit program object is located in the current AS/400 library of the TSMserver.

*LIBLThe exit program object is located in the AS/400 library list of the TSMserver.

UPDATE EXIT


object_library_nameSpecifies the AS/400 library that contains the exit program object. Themaximum length of this name is 10 characters.

exit_nameSpecifies the name of the exit program object. This parameter is required. Themaximum length of this name is 10 characters.

Examples

Task 1

Suppose you have previously defined a deletion exit program to the server. You havejust made some modifications to the program and have rebuilt the *PGM object. Nowyou wish to notify the server that it must resolve the exit program again.

Command:update exit deletion

Task 2

Suppose you have previously defined an expiration exit program to the server and nowyou wish to have the server use a totally new exit program. You have decided to callyour new expiration exit program ADSMEXPIRE and have placed the *PGM object inan AS/400 library called ADSMEXITS.

Command:update exit expiration ADSMEXITS/ADSMEXPIRE

Related Commands

Table 283. Commands Related to UPDATE EXIT

Command Description







UPDATE EXIT


UPDATE LIBRARY (Update a Library)

Use this command to modify either the Media Library Device name (MLD parameter) forAS400MLB libraries or the drive selection parameter for manual libraries anduser-defined libraries.

Privilege Class


Syntax

ÊÊ UPDate LIBRary library_name MLD = mld_nameDRIVESELection = AUTOmatic

OPERatorEXIT

ÊÍ


Specifies the name of the library to be updated.

MLDSpecifies the new name of the Media Library Device (MLD). This parameter isrequired for AS400MLB library types. The Media Library Device that this namerefers to must be the same device as the original MLD name referred to. If theMedia Library Device is not the same, update processing does not completesuccessfully.

DRIVESELectionSpecifies whether TSM, a mount operator, or the mount exit program performs thedrive selection. This parameter is required for MANUAL or USRDFN library types.The values are:

AUTOmaticSpecifies that TSM performs the drive selection.

Note: Automatic is only applicable to libraries of type MANUAL.


EXITSpecifies that the mount exit program must perform the drive selection. Thisvalue is only valid for a library type of USRDFN.

UPDATE LIBRARY


Examples

Task 1

Update the library named AUTOLIB with a new MLD name of MLD02.

Command:UPDate LIBRary autolib MLD=mld02

Task 2

Update the library named MANLIB to indicate that TSM should perform the driveselection.

Command:UPDate LIBRary MANLIB DRIVESEL=AUTOmatic

Related Commands

Table 284. Commands Related to UPDATE LIBRARY

Command Description









UPDATE LIBRARY


UPDATE LIBVOLUME (Change the Status of a Storage Volume)

Use this command to change the status of a sequential access storage volume in alibrary.

Privilege Class


Syntax

ÊÊ UPDate LIBVolume library_name volume_nameSTATus = PRIvate

SCRatch

Ê

ÊACCess = AVAilable

UNAvailable

ÊÍ



volume_name (Required)Specifies the volume name of the storage volume.

STATusSpecifies a change to the status of a storage volume. Possible values are:

PRIvateSpecifies that TSM updates the storage volume to a private volume.

SCRatchSpecifies that TSM updates the storage volume to a scratch volume.

ACCessSpecifies a change to the access state of a storage volume. Possible values are:

AVAilableSpecifies that TSM updates the storage volume to an access state ofavailable.

UNAvailableSpecifies that TSM updates the storage volume to an access state ofunavailable.

UPDATE LIBVOLUME


||

|||

|||

Examples

Task 1

Update the volume named WPDV00 located in the library named AUTO to reflect astatus of PRIVATE.

Command:update libvolume auto wpdv00 status=private

Task 2

Update the volume named WPDV00 located in the library named AUTO to indicate thatthe volume can be mounted by the server.

Command:update libvolume auto wpdv00 access=available

Related Commands

Table 285. Commands Related to UPDATE LIBVOLUME

Command Description







UPDATE LIBVOLUME


|

|

||

||

|

UPDATE MACHINE (Update Machine Information)

Use this command to update machine information.


Privilege Class


Syntax

ÊÊ UPDate MAchine machine_nameDESCription = description

Ê

ÊBUilding = building FLoor = floor ROom = room

Ê

ÊPRIority = number ADSMServer = Yes

No

ÊÍ


Specifies the name of the machine to be updated.

DESCriptionSpecifies a description of the machine. This parameter is optional. The text can beup to 255 characters. Enclose the text in quotation marks if it contains any blankcharacters. To remove existing text, specify a null string ("").

BUildingSpecifies the name or number of the building that this machine is in. Thisparameter is optional. The text can be up to 16 characters. Enclose the text inquotation marks if it contains any blank characters. To remove existing text, specifya null string ("").

FLoorSpecifies the name or number of the floor that this machine is on. This parameteris optional. The text can be up to16 characters. Enclose the text in quotation marksif it contains any blank characters. To remove existing text, specify a null string ("").

ROomSpecifies the name or number of the room that this machine is in. This parameter

UPDATE MACHINE


is optional. The text can be up to 16 characters. Enclose the text in quotationmarks if it contains any blank characters. To remove existing text, specify a nullstring ("").

PRIoritySpecifies the restore priority for the machine. You can specify an integer from 1 to99. The highest priority is 1. This parameter is optional. TSM uses this value toprioritize client machine recovery.

ADSMServerSpecifies whether the machine contains a TSM server. This parameter is optional.Possible values are:

No This machine does not contain a TSM server.

YesThis machine contains a TSM server. Only one machine can be defined ascontaining an TSM server.

Examples

Task

Update the DISTRICT5 machine information to reflect that it contains the TSM server.

Command:update machine district5 adsmserver=yes

Related Commands

Table 286. Commands Related to UPDATE MACHINE

Command Description





UPDATE MACHINE


UPDATE MGMTCLASS (Update a Management Class)

Use this command to change a management class. To allow clients to use the updatedmanagement class, you must activate the policy set that contains the managementclass.

Note: The UPDATE MGMTCLASS command fails if a copy storage pool is specified asthe destination for space-managed files.

Privilege Class


Syntax

ÊÊ UPDate MGmtclass domain_name policy_set_name class_name Ê

ÊSPACEMGTECHnique = AUTOmatic

SELectiveNONE

AUTOMIGNonuse = daysÊ

ÊMIGREQUIRESBkup = Yes

NoMIGDESTination = pool_name

Ê


ÊÍ



policy_set_name (Required)Specifies the policy set to which the management class belongs. You cannotupdate a management class that belongs to the ACTIVE policy set.

class_name (Required)Specifies the management class to update.

SPACEMGTECHniqueSpecifies whether a file using this management class is eligible for migration. Thisparameter is optional. This parameter is effective only for Tivoli Space Managerclients (also known as HSM clients), not for backup-archive clients or applicationclients. Possible values are:

UPDATE MGMTCLASS


||||

AUTOmaticSpecifies that the file is eligible for both automatic migration and selectivemigration.

SELectiveSpecifies that the file is eligible for selective migration only.

NONESpecifies that the file is not eligible for migration.

AUTOMIGNonuseSpecifies the number of days that must elapse since a file was last used before itis eligible for automatic migration. This parameter is optional. IfSPACEMGTECHNIQUE is not AUTOMATIC, the server ignores this attribute. Youcan specify an integer from 0 to 9999.

This parameter is effective only for HSM clients, not for backup-archive clients orapplication clients.

MIGREQUIRESBkupSpecifies whether a backup version of a file must exist before a file can bemigrated. This parameter is optional. This parameter is effective only for HSMclients, not for backup-archive clients or application clients. Possible values are:

YesSpecifies that a backup version must exist.

No Specifies that a backup version is optional.

MIGDESTinationSpecifies the primary storage pool where the server initially stores files migratedfrom HSM clients. This parameter is effective only for HSM clients, not forbackup-archive clients or application clients.

The command fails if you specify a copy storage pool as the destination.

DESCriptionSpecifies a description of the management class. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters. To remove a previously defineddescription, specify a null string ("").

Examples

Task

For the management class ACTIVEFILES, in policy set VACATION in theEMPLOYEE_RECORDS policy domain, change the storage pool where migrated filesare stored.

Command:update mgmtclass employee_records vacation activefilesmigdestination=diskpool2

UPDATE MGMTCLASS


||

|

|

Related Commands

Table 287. Commands Related to UPDATE MGMTCLASS

Command Description











UPDATE MGMTCLASS


UPDATE NODE (Update a Client Node)

Use this command to modify the attributes of a registered client node.

You must use the RENAME NODE command to change the name of a registered clientnode.

Privilege Class


Syntax

ÊÊ(1)

UPDate Node node_namepassword


FORCEPwreset = Yes

Ê

ÊPASSExp = days CLOptset = option_set_name CONtact = text

Ê

ÊDOmain = domain_name COMPression = Client

YesNo

Ê

ÊARCHDELete = Yes

NoBACKDELete = No

Yes

Ê

ÊWHEREDOmain = domain_name WHEREPLatform = client_platform_name

Ê

ÊMAXNUMMP = number

ÊÍ

Notes:


UPDATE NODE



Specifies the name of the client node to be updated. You can use wildcardcharacters to specify this name.

passwordSpecifies the new password for the client node. This parameter is optional. Themaximum length of the password is 64 characters. Passwords remain current for aperiod determined by the password expiration period.

FORCEPwresetSpecifies whether to force a client to change or reset the password. Thisparameter is optional. Possible values are:

No Specifies that the password expiration period is set by the SET PASSEXPcommand. The administrator does not force a client to change or reset thepassword while attempting to logon to the server.

Note: This value is valid only when you specify a password.

YesSpecifies that the client node or administrator’s password will expire at thenext logon. The client must change or reset the password at that time.

PASSExpSpecifies the number of days the password remains valid. You can set thepassword expiration period from 0 to 9999 days. A value of 0 means that thepassword never expires. This parameter is optional. If you do not specify thisparameter, the password expiration period is unchanged.

CLOptsetSpecifies the name of the option set to be used by the client. This parameter isoptional.

CONtactSpecifies a text string of information identifying the client node. This parameter isoptional. The maximum length of the text string is 255 characters. Enclose thecontact information in quotation marks if it contains any blanks. To removepreviously defined contact information, specify a null string ("").

DOmainSpecifies the name of the policy domain to which the client node is registered. Thisparameter is optional.

COMPressionSpecifies whether the client node compresses its files before sending them to theserver for backup and archive. This parameter is optional. Possible values are:

ClientSpecifies that the client determines whether files will be compressed.

YesSpecifies that the client node compresses its files before sending them to theserver for backup and archive.

UPDATE NODE


|||||

No Specifies that the client node does not compress its files before sending themto the server for backup and archive.

ARCHDELeteSpecifies whether the client node can delete its own archived files from the server.This parameter is optional. Possible values are:

YesSpecifies that the client node can delete its own archive files from the server.

No Specifies that the client node cannot delete its own archive files from theserver.

BACKDELeteSpecifies whether the client node can delete its own backup files from the server.This parameter is optional. Possible values are:

No Specifies that the client node cannot delete its own backup files from theserver.

YesSpecifies that the client node can delete its own backup files from the server.

WHEREDOmainSpecifies the name of the policy domain to be used as a filter in combination withthe node name to select nodes to update. This parameter is optional.

WHEREPLatformSpecifies the name of the client platform to be used as a filter in combination withthe node name to select nodes to update. This parameter is optional.

Examples

Task

Update node LARRY so that the data on node LARRY will be compressed when it isbacked up or archived by TSM and so that the client cannot delete archived files.

Command:update node larry compression=yes archdelete=no

Related Commands

Table 288. Commands Related to UPDATE NODE

Command Description




UPDATE NODE


Table 288. Commands Related to UPDATE NODE (continued)

Command Description





UPDATE NODE


UPDATE POLICYSET (Update a Policy Set Description)

Use this command to change the description of a policy set. You cannot change thedescription of the ACTIVE policy set.

Privilege Class


Syntax

ÊÊ UPDate POlicyset domain_name policy_set_name DESCription = description ÊÍ



policy_set_name (Required)Specifies the policy set to update. You cannot change the ACTIVE policy set.

DESCription (Required)Specifies text that describes the policy set. The maximum length of the descriptionis 255 characters. Enclose the description in quotation marks if it contains anyblank characters. To remove a previously defined description, specify a null string("").

Examples

Task

Update a policy set called VACATION for the EMPLOYEE_RECORDS policy domainwith a description of Schedule Planning Information.

Command:update policyset employee_records vacation description="scheduleplanning information"

Related Commands

Table 289. Commands Related to UPDATE POLICYSET

Command Description




UPDATE POLICYSET


Table 289. Commands Related to UPDATE POLICYSET (continued)

Command Description






UPDATE POLICYSET


UPDATE PROFILE (Update a Profile Description)

Use this command on a configuration manager to update a profile description.

Privilege Class


Syntax

ÊÊ UPDate PROFIle profile_name DESCription = description ÊÍ


Specifies the profile to update.

DESCription (Required)Specifies a description for the profile. The maximum length of the description is 255characters. Enclose the description in quotation marks if it contains any blankcharacters. To remove a description, specify a null string ("").

Examples

Task

Update the description for profile DELTA.

Command:update profile delta description="PAYROLL domain"

Related Commands

Table 290. Commands Related to UPDATE PROFILE

Command Description









UPDATE PROFILE


||

|

|

|

|

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

|

|

||

||||

|

|

|

||

|

|||

||

||

||

|||

|||

||

||

||

|||

Table 290. Commands Related to UPDATE PROFILE (continued)

Command Description


UPDATE PROFILE


|

||

|||

|

UPDATE RECOVERYMEDIA (Update Recovery Media)

Use this command to update information about recovery media.

Privilege Class


Syntax

ÊÊ UPDate RECOVERYMedia media_name

·

,

VOLumenames = volume_name

Ê

ÊDESCription = description LOcation = location

Ê

ÊType = BOot

OTherPROduct = product_name

Ê

ÊPRODUCTInfo = product_information

ÊÍ


Specifies the name of the recovery media to be updated.

VOLumenamesSpecifies the names of volumes that contain the recoverable data (for example,operating system image copies). If you specify a TYPE=BOOT, you must specifythe boot media volume names in the order in which they are to be loaded atrecovery time. The volume names list can be up to 255 characters. Enclose the listin quotation marks if it contains any blank characters. To remove all volume names,specify a null string ("").

DESCriptionSpecifies the description of the recovery media. This parameter is optional. You canuse up to 255 characters. Enclose the text in quotation marks if it contains anyblank characters.

LOcationDescribes the location of the recovery media. This parameter is optional. You canuse up to 255 characters. Enclose the text in quotation marks if it contains anyblank characters. To remove a location description, specify a null string ("") for thevalue.



TypeSpecifies the type of recovery media. This parameter is optional. Possible valuesare:

BOotSpecifies that this is boot media. You must specify volume names if the type isBOOT.

OTherSpecifies that this is not boot media. For example, a CD-ROM that containsoperating system manuals.

PROductSpecifies the name of the product that wrote to this media. This parameter isoptional. You can use up to 16 characters. Enclose the text in quotation marks if itcontains any blank characters. To remove a product name, specify a null string ("")for the value.

PRODUCTInfoSpecifies any information about the product that wrote to the media that you mayneed to restore the machine. This parameter is optional. You can use up to 255characters. Enclose the text in quotation marks if it contains any blank characters.To remove a previously defined product information, specify a null string ("") for thevalue.

Examples

Task

Update the location description for recovery media DIST5RM to ″CorporateHeadquarters Data Vault″.

Command:update recoverymedia dist5rm location="Corporate Headquarters DataVault"

Related Commands

Table 291. Commands Related to UPDATE RECOVERYMEDIA

Command Description






UPDATE SCHEDULE (Update a Schedule)

Use this command to update a client or administrative command schedule.

The UPDATE SCHEDULE command takes two forms, depending on whether theschedule applies to client operations or administrative commands. The syntax andparameters for each form are defined separately.

UPDATE SCHEDULE


UPDATE SCHEDULE — Client

Use the UPDATE SCHEDULE to update selected parameters for a client schedule.

This command does not change the client associations that have been made to thisschedule. Any clients that are associated with the original schedule process themodified schedule.

Note: Not all clients can run all scheduled operations, even though TSM allows you todefine the schedule on the server and associate it with the client. For example, aMacintosh client cannot run a schedule when the action is to restore or retrievefiles, or run an executable script. An executable script is also known as acommand file, a batch file, or a script on different client operating systems.

Privilege Class

To update a client schedule, you must have system privilege, unrestricted policyprivilege, or restricted policy privilege for the policy domain to which the schedulebelongs.

Syntax

ÊÊ UPDate SCHedule(1)

domain_name schedule_nameType = Client

Ê

ÊDESCription = description ACTion = Incremental

SelectiveArchiveREStoreRETrieveCommandMacro

Ê

ÊOPTions = option_string OBJects = object_string

Ê

ÊPRIority = number STARTDate = date STARTTime = time

Ê

ÊDURation = number DURUnits = Minutes

HoursDaysINDefinite

Ê



ÊPERiod = number PERUnits = Hours

DaysWeeksMonthsYearsOnetime

Ê

ÊDAYofweek = ANY

WEEKDayWEEKEndSUndayMondayTUesdayWednesdayTHursdayFridaySAturday

EXPiration= Neverdate

ÊÍ

Notes:



Specifies the name of the policy domain to which this schedule belongs.

schedule_name (Required)Specifies the name of the schedule to be updated.

Type=ClientSpecifies that a client schedule is updated. This parameter is optional. The defaultis CLIENT.

DESCriptionSpecifies a description of the schedule. This parameter is optional. You can specifyup to 255 characters for the description. Enclose the description in quotation marksif it contains blank characters. To remove a previously defined description, specify anull string ("") for this value.













MAXCMDRETRIES

QUERYSCHEDPERIOD

RETRYPERIOD

SCHEDLOGNAME

SCHEDMODE

SERVERNAME

TCPCLIENTADDRESS

TCPCLIENTPORT

OBJectsSpecifies the objects (file spaces or directories) for which the specified action isperformed. To select all file spaces or directories, explicitly list them in theobject-string. Entering an asterisk will cause the backup to only occur for thedirectory where the scheduler was started. This parameter is required except whenACTION=INCREMENTAL.
















TODAY+days or+days


TODAY +3 or +3.









NOW+HH:MM or+HH:MM


NOW+02:00 or +02:00.




NOW−02:00 or –02:00.

























Note: When you specify PERUNITS=YEARS, the scheduled operation will beprocessed on the same month and date of each year. For example, ifthe start date for the scheduled operation is 02/29/2004, the next year’s



scheduled operation will be 02/28/2005 because February only has 28days. Thereafter, subsequent operations will be scheduled for February28th.



















Examples

Task 1

Update the MONTHLY_BACKUP schedule that belongs to the STANDARD policydomain by setting its priority value to 1.

Command:update schedule standard monthly_backup priority=1

Task 2

Update the WEEKLY_BACKUP schedule that belongs to the EMPLOYEE_RECORDSpolicy domain to expire on March 29, 1997 (03/29/1997).

Command:update schedule employee_records weekly_backup expiration=03/29/1997



UPDATE SCHEDULE — Administrative

Use this command to update selected parameters for an administrative commandschedule.

Note: You cannot schedule MACRO or QUERY ACTLOG commands.

Privilege Class

To update an administrative schedule, you must have system privilege.

Syntax

ÊÊ UPDate SCHedule(1)

schedule_name Type = Administrative Ê

ÊCMD = command ACTIVE = Yes

NoDESCription = description

Ê

ÊPRIority = number STARTDate = date STARTTime = time

Ê

ÊDURation = number DURUnits = Minutes

HoursDaysINDefinite

Ê

ÊPERiod = number PERUnits = Hours

DaysWeeksMonthsYearsOnetime

Ê

UPDATE SCHEDULE —Administrative


ÊDAYofweek = ANY

WEEKDayWEEKEndSUndayMondayTUesdayWednesdayTHursdayFridaySAturday

EXPiration= Neverdate

ÊÍ

Notes:



Specifies the name of the schedule to be updated.

Type=Administrative (Required)Specifies that an administrative command schedule is updated.

CMDSpecifies the administrative command to be scheduled for processing. Thisparameter is optional. The command you specify can contain up to 512 characters.Enclose the command in quotation marks if it contains blanks.

Note: You cannot specify redirection characters with this parameter.

ACTIVESpecifies whether the administrative command is eligible for processing. Thisparameter is optional. An administrative command schedule will not be processedunless it is set to the active state. Possible values are:

YESSpecifies that the administrative command is eligible for processing.

NOSpecifies that the administrative command is not eligible for processing.

DESCriptionSpecifies a description of the schedule. This parameter is optional. You can specifyup to 255 characters for the description. Enclose the description in quotation marksif it contains blanks. To remove a previously defined description, specify a nullstring ("") for this value.










TODAY+days or+days


TODAY +3 or +3.






NOW+HH:MM or+HH:MM


NOW+02:00 or +02:00.




NOW−02:00 or –02:00.



Use this parameter with the DURUNITS parameter to specify the length of thestartup window. For example, if you specify DURATION=20 andDURUNITS=MINUTES, the schedule must be started within 20 minutes of the start



date and start time. The default length of the startup window is 1 hour. Theduration of the window must be shorter than the period between windows.




























Examples

Task 1

Update existing administrative schedule named BACKUP_BACKUPPOOL so thatstarting today, the BACKUPPOOL primary storage pool is backed up to the COPYSTGcopy storage pool every three days at 10:00 p.m.

Command:update schedule backup_backuppool type=administrative cmd="backupstgpool backuppool copystg" active=yes starttime=22:00 period=3



Related Tables

Table 292. Commands Related to UPDATE SCHEDULE

Command Description









UPDATE SCHEDULE


UPDATE SCRIPT (Update a Tivoli Storage Manager Script)

Use this command to change a command line or to add a new command line to a TSMscript.

Privilege Class

To issue this command, the administrator must have previously defined the script ormust have system privilege.

Syntax

ÊÊ UPDate SCRipt script_namecommand_line

Line = number

Ê


ÊÍ


Specifies the name of the script to be updated.

command_lineSpecifies a new or updated command to be processed in a script. You must updatea command, a description, or both when you issue this command.

Command can contain substitution variables and may be continued across multiplelines if you specify a continuation character (-) as the last character in thecommand. You can specify up to 1200 characters for the command. Enclose thecommand in quotation marks if it contains blanks. If you specify this parameter, youcan optionally specify the following parameter.

LineSpecifies the line number for the command. If you do not specify a linenumber, the command line is appended to the existing series of commandlines. The appended command line is assigned a line number of five greaterthan the last command line number in the sequence. For example, if the lastline in your script is 015, the appended command line is assigned a linenumber of 020.

If you specify a line number, the command will replace an existing line (if thenumber is the same as an existing line). Or the command will insert thespecified line (if the line number does not correspond to an existing linenumber for the command line sequence).

UPDATE SCRIPT


||

||

|

||

|

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

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

|

|

||

|||

|||||

|||||||

||||

DESCriptionSpecifies a description for the script. You can specify up to 255 characters for thedescription. Enclose the description in quotation marks if it contains blankcharacters.

Examples

Task 1

Assume that you have defined a script named QSAMPLE with the following three lines:

001 /* This is a sample script */005 QUERY STATUS010 QUERY PROCESS

1. Add command QUERY SESSION to the end of the QSAMPLE script.

Command:update script qsample "query session"

The script consists of the following lines after it processes:

001 /* This is a sample script */005 QUERY STATUS010 QUERY PROCESS015 QUERY SESSION

2. Change line 010 so that it processes the QUERY STGPOOL command instead ofthe QUERY PROCESS command:

Command:update script qsample "query stgpool" line=010

After the script processes, the script now consists of the following lines:

001 /* This is a sample script */005 QUERY STATUS010 QUERY STGPOOL015 QUERY SESSION

Task 2

Insert a new command line (SET REGISTRATION OPEN) after the QUERY STATUScommand line in the QSAMPLE script:

Command:update script qsample "set registration open" line=007

The following command lines result:

UPDATE SCRIPT


||||

|

|

|

||||

|

||

|

|||||

||

||

|

|||||

|

||

||

|

001 /* This is a sample script */005 QUERY STATUS007 SET REGISTRATION OPEN010 QUERY STGPOOL015 QUERY SESSION

Related Commands

Table 293. Commands Related to UPDATE SCRIPT

Command Description






RUN Runs a script.

UPDATE SCRIPT


|||||

|

|||

||

||

||

|||

||

||

||

|

UPDATE SERVER (Update a Server Defined for Server-to-ServerCommunications)

Use this command to update a server definition.

Privilege Class


Syntax

For Enterprise Configuration, Enterprise Event Logging, and Command Routing

ÊÊ UPDate SERver server_nameSERVERPAssword = password

Ê

ÊHLAddress = ip_address LLAddress = tcp_port

Ê

ÊCOMMmethod = TCPIP URL = url ALLOWReplace = Yes

No

Ê

ÊDESCription = description CROSSDefine = No

Yes

ÊÍ

For Virtual Volumes

ÊÊ UPDate SERver server_namePAssword = password

Ê

ÊHLAddress = ip_address LLAddress = tcp_port

Ê

ÊCOMMmethod = TCPIP URL = url DELgraceperiod = days

Ê

ÊNODEName = node_name FORCESync = Yes

No

Ê

UPDATE SERVER


|


ÊÍ


Specifies the name of the server to be updated. This parameter is required.

PAsswordSpecifies the password used to sign on to the target server for virtual volumes.This parameter is optional.

SERVERPAsswordSpecifies the server password, which is used for enterprise configuration, commandrouting, and server-to-server event logging functions. The password must matchthe server password set by the SET SERVERPASSWORD command. Thisparameter is optional.

HLAddressSpecifies the IP address (in dotted decimal format) of the server. This parameter isoptional.

LLAddressSpecifies the low-level address of the server. This address is usually the same asthat in the TCPPORT server option of the target server. This parameter is optional.

COMMmethodSpecifies the communication method used to connect to the server. This parameteris optional.

URLSpecifies the URL address used to access this server from a Web administrativeinterface. The parameter is optional.

DELgraceperiodSpecifies a number of days that an object remains on the target server after it hasbeen marked for deletion. The minimum value is 0. The maximum value isunlimited. This parameter is optional.

NODENameSpecifies a node name to be used by the server to connect to the target server.This parameter is optional.

DESCriptionSpecifies a description of the server. This parameter is optional. The descriptioncan be up to 255 characters. Enclose the description in quotation marks if itcontains blank characters. To remove an existing description, specify a null string('').

FORCESyncSpecifies whether to reset the server verification key when the source server nextsigns on to the target server. A valid verification key lets a source server putobjects on the target server, manage the grace deletion period value, and update

UPDATE SERVER


|

|||||

the password (if the current password is known and the verification key matches).The parameter is optional. Possible values are:

YesSpecifies that a new verification key will be sent to and accepted by the targetserver if a valid password is received.

No Specifies that a new verification key will not be sent to the target server.

ALLOWReplaceSpecifies whether a server definition that was defined by a managed server can bereplaced with a definition from the configuration manager. This parameter isoptional. Possible values are:

YesSpecifies that a server definition can be replaced by a definition from theconfiguration manager.

No Specifies that a server definition cannot be replaced by the definition from theconfiguration manager.

Examples

Task

Update the definition of SERVER2 to specify that objects remain on the target serverfor 10 days after they have been marked for deletion.

Command:update server server2 delgraceperiod=10

Related Commands

Table 294. Commands Related to UPDATE SERVER

Command Description










UPDATE SERVER


||||

|||

|||

|

Table 294. Commands Related to UPDATE SERVER (continued)

Command Description




UPDATE SERVER


UPDATE SERVERGROUP (Update a Server Group Description)

Use this command to update the description of a server group.

Privilege Class


Syntax

ÊÊ UPDate SERVERGRoup group_name DESCription = description ÊÍ


Specifies the server group to update.

DESCription (Required)Specifies a description of the server group. The maximum length of the descriptionis 255 characters. Enclose the description in quotation marks if it contains blankcharacters.

Examples

Task

Update the description of the server group named WEST_COMPLEX to WesternRegion Complex.

Command:update servergroup west_complex description="western region complex"

Related Commands

Table 295. Commands Related to UPDATE SERVERGROUP

Command Description






UPDATE SERVERGROUP


||

|

|

|

|

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

|

|

||

||||

|

|

||

||

|

|||

||

||

||

||

||

||

|

UPDATE SPACETRIGGER (Update the Database or Recovery Log SpaceTriggers)

Use this command to update settings that determine when and how TSM resolvesspace shortages in the database or recovery log.

This command does not create new volumes. It does extend the database and recoverylog space if available. If it is not available TSM displays a message indicating theamount of new space needed. You can then use these values to allocate the neededspace.

See the DEFINE SPACETRIGGER command for more information.

Privilege Class


Syntax

ÊÊ UPDate SPACETrigger DBLOG Fullpct = percent

Ê

ÊSPACEexpansion = percent EXPansionprefix = prefix

Ê

ÊMAXimumsize = megabytes

ÊÍ

ParametersDB

Specifies a database space trigger.

LOGSpecifies a recovery log space trigger.

FullpctThis parameter is optional. You can specify an integer value from 0 to 99. Thedefault is 80. A value of zero (0) disables the space trigger.

SPACEexpansionSpecifies, as a percentage of the current size, the amount by which the databaseor recovery log can be increased. This parameter is optional. Specify a value from0 to 200. The default is 20. The database must be at least 4MB (5MB file withprocessing space); the recovery log must be at least 8MB (9MB file with processing

UPDATE SPACETRIGGER


||

|

||

||||

|

|

||

|

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

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

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

|

|

||

||

|||

|||||

space). New database or recovery log volumes must be multiples of 5MB or 9MBrespectively. A value of zero (0) disables expansion.

EXPansionprefixSpecifies the prefix that TSM uses to create new database or recovery log files.The prefix name must use a fully qualified path name, for example,/svtemp/. Youcan specify up to 200 characters. If you specify an invalid prefix, automaticexpansion can fail.

MAXimumsizeSpecifies the maximum size, in megabytes, of the database or the recovery log.This parameter is optional. When this size is reached, expansion stops, and TSMissues a message. You can specify a value from 9 to 5000 (5GB) for the recoverylog, or from 4 to is 9999999MB for the database. A value of zero (0) or omitting thisparameter disables checking for maximum size.

Examples

Task 1

Update the setting of the database expansion to 50 percent.

Command:update spacetrigger db spaceexpansion=50

Task 2

Disable automatic expansion of the recovery log.

Command:

update spacetrigger log spaceexpansion=0

Related Commands

Table 296. Commands Related to UPDATE SPACETRIGGER

Command Description






UPDATE SPACETRIGGER


||

|||||

||||||

|

|

|

||

|

|

|

||

|

|||

||

|||

|||

|||

|||

|||

|

UPDATE STGPOOL (Update a Storage Pool)

Use this command to change a storage pool.

The UPDATE STGPOOL command takes three forms, depending on whether theupdate is for a primary storage pool assigned to random access devices, a primarystorage pool assigned to sequential access devices, or a copy storage pool. The syntaxand parameters for each form are defined separately.

UPDATE STGPOOL


UPDATE STGPOOL — Primary Random Access

Use this command to update a random access storage pool.

Privilege Class

To issue this command, you must have system privilege, unrestricted storage privilege,or restricted storage privilege for the storage pool to be updated.

Syntax

ÊÊ UPDate STGpool pool_nameDESCription = description

Ê

ÊACCess = READWrite

READOnlyUNAVailable

MAXSIze = maximum_file_sizeNOLimit

Ê

ÊNEXTstgpool = pool_name HIghmig = percent LOwmig = percent

Ê

ÊCAChe = Yes

NoMIGPRocess = number MIGDelay = days

Ê

ÊMIGContinue = No

Yes

ÊÍ


Specifies the storage pool to update. This parameter is required.

DESCriptionSpecifies a description of the storage pool. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters. To remove an existingdescription, specify a null string ("").

ACCessSpecifies how client nodes and server processes (such as migration andreclamation) can access files in the storage pool. This parameter is optional.Possible values are:










MAXSIzeSpecifies the maximum size for a physical file that the server can store in thestorage pool. This parameter is optional. Possible values are:




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



limit on the maximum size of a file. By having no limit on the size for at least onepool, you ensure that no matter what its size, the server can store the file.



To remove an existing storage pool from the storage hierarchy, specify a null string("") for this value.

If this storage pool does not have a next storage pool, the server cannot migratefiles from this storage pool and cannot store in another storage pool files thatexceed the maximum size for this storage pool.


HIghmigSpecifies that the server starts migration for this storage pool when the amount ofdata in the pool reaches this percentage of the pool’s estimated capacity. Thisparameter is optional. You can specify an integer from 0 to 100.

When the storage pool exceeds the high migration threshold, the server can startmigration of files by node to the next storage pool, as defined with theNEXTSTGPOOL parameter. You can specify HIGHMIG=100 to prevent migrationfor this storage pool.

LOwmigSpecifies that the server stops migration for this storage pool when the amount ofdata in the pool reaches this percentage of the pool’s estimated capacity. Thisparameter is optional. You can specify an integer from 0 to 99.

When the storage pool reaches the low migration threshold, the server does notstart migration of another node’s files. Because all file spaces that belong to a nodeare migrated together, the occupancy of the storage pool can fall below the valueyou specified for this parameter. You can set LOWMIG=0 to permit migration toempty the storage pool.

CACheSpecifies whether the migration process leaves a cached copy of a file in thisstorage pool after migrating the file to the next storage pool. This parameter isoptional. Possible values are:

Yes Specifies that caching is enabled.

No Specifies that caching is disabled.

Using cache may improve the retrievability of files, but may affect the performanceof other processes. See Administrator’s Guide for details.



MIGPRocessSpecifies the number of processes that are used for migrating files from thisstorage pool. This parameter is optional. You can specify an integer from 1 to 999.

During migration, these processes are performed in parallel to provide the potentialfor improved migration rates.

MIGDelaySpecifies the minimum number of days that a file must remain in a storage poolbefore the file becomes eligible for migration from the storage pool. The servercounts the number of days from the day that the file was stored in the storage poolor retrieved by a client, whichever is more recent. This parameter is optional. Youcan specify an integer from 0 to 9999. The value 0 specifies that you do not wantto delay migration.

If you want the server to count the number of days based only on when a file wasstored and not when it was retrieved, use the NORETRIEVEDATE server option.

MIGContinueSpecifies whether you allow the server to migrate files that do not satisfy themigration delay time. This parameter is optional.

Because you can require that files remain in the storage pool for a minimumnumber of days, the server may migrate all eligible files to the next storage pool yetnot meet the low migration threshold. This parameter allows you to specify whetherthe server is allowed to continue the migration process by migrating files that donot satisfy the migration delay time.


YesSpecifies that, when necessary to meet the low migration threshold, the servercontinues to migrate files that do not satisfy the migration delay time.

If you allow more than one migration process for the storage pool, some filesthat do not satisfy the migration delay time may be migrated unnecessarily. Asone process migrates files that satisfy the migration delay time, a secondprocess could begin migrating files that do not satisfy the migration delay timeto meet the low migration threshold. The first process that is still migrating filesthat satisfy the migration delay time might have, by itself, caused the lowmigration threshold to be met.

No Specifies that the server stops migration when no eligible files remain to bemigrated, even before reaching the low migration threshold. The server doesnot migrate files unless the files satisfy the migration delay time.

Examples

Task

Update the random access storage pool named BACKUPPOOL to permit caching whenthe server migrates files to the next storage pool.



|||||||

||

|||

|||||

|

|||

|||||||

||||

|

Command:update stgpool backuppool cache=yes



UPDATE STGPOOL — Primary Sequential Access

Use this command to update a primary sequential access storage pool.

Privilege Class


Syntax


Ê


READOnlyUNAVailable

MAXSIze = maximum_file_sizeNOLimit

Ê

ÊNEXTstgpool = pool_name HIghmig = percent LOwmig = percent

Ê

ÊREClaim = percent RECLAIMSTGpool = pool_name

Ê

ÊCOLlocate = No

YesFILespace

MAXSCRatch = numberÊ

ÊREUsedelay = days MIGDelay = days MIGContinue = No

Yes

ÊÍ


Specifies the name of the storage pool to be updated.

DESCriptionSpecifies a description of the storage pool. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters. To remove an existingdescription, specify a null string ("").

UPDATE STGPOOL —Primary Sequential Access


ACCessSpecifies how client nodes and server processes (such as migration andreclamation) can access files in the storage pool. This parameter is optional.Possible values are:








MAXSIzeSpecifies the maximum size for a physical file that the server can store in thestorage pool during a session with a client. This parameter is optional. Possiblevalues are:










To remove an existing value, specify a null string ("").

If this storage pool does not have a next storage pool, the server cannot migratefiles from this storage pool and cannot store in another storage pool files thatexceed the maximum size for this storage pool.


HIghmigSpecifies that the server starts migration for this storage pool when the number ofvolumes containing data reaches this percentage of the total number of volumes inthe storage pool. The total number of volumes includes the maximum number ofscratch volumes. This parameter is optional. You can specify an integer from 1 to100.

When the storage pool exceeds the high migration threshold, the server can startmigration of files by volume to the next storage pool defined for the storage pool.You can set the high migration threshold to100 to prevent migration for the storagepool.

LOwmigSpecifies that the server stops migration for this storage pool when the number ofvolumes containing data reaches this percentage of the total number volumes inthe storage pool. The total number of volumes includes the maximum number ofscratch volumes. This parameter is optional. You can specify an integer from 0 to99.

When the storage pool reaches the low migration threshold, the server does notstart migration of files from another volume. You can set the low migrationthreshold to 0 to permit migration to empty the storage pool.



REClaimSpecifies when the server reclaims a volume, based on the percentage ofreclaimable space on a volume. Reclamation makes the fragmented space onvolumes usable again by moving any remaining unexpired files from one volume toanother volume, thus making the original volume available for reuse. Thisparameter is optional. You can specify an integer from 1 to 100.

Specify a value of 50 percent or greater for this parameter so that files stored ontwo volumes can be combined onto a single output volume.

For storage pools that use WORM devices, you can lower the value from thedefault of 100. Lowering the value allows the server to consolidate data onto fewervolumes when needed. Volumes emptied by reclamation can be checked out of thelibrary, freeing slots for new volumes. Because the volumes are write-once, thevolumes cannot be reused.

RECLAIMSTGpoolSpecifies another primary storage pool as a target for reclaimed data from thisstorage pool. This parameter is optional. When the server reclaims volumes for thestorage pool, unexpired data is moved from the volumes being reclaimed to thestorage pool named with this parameter.

To remove an existing value, specify a null string ("").

A reclaim storage pool is most useful for a storage pool that has only one drive inits library. When you specify this parameter, the server moves all data fromreclaimed volumes to the reclaim storage pool regardless of the number of drivesin the library.

To move data from the reclaim storage pool back to the original storage pool, usethe storage pool hierarchy. Specify the original storage pool as the next storagepool for the reclaim storage pool.

COLlocateSpecifies whether the server attempts to keep data belonging to a single clientnode or client file space assigned to as few volumes as possible. This parameter isoptional.





FILespaceSpecifies that collocation is enabled at the file space level for client nodes. Theserver tries to put data for one node and file space on as few volumes as



possible. If a node has multiple file spaces, the server attempts to put data fordifferent file spaces on different volumes.

MAXSCRatchSpecifies the maximum number of scratch volumes that the server can request.This parameter is optional. You can specify an integer from 0 to 100000000. Byallowing the server to request scratch volumes, you avoid having to define eachvolume to be used.

The value specified for this parameter is used to estimate the total number ofvolumes available in the storage pool and the corresponding estimated capacity forthe storage pool.

Scratch volumes are automatically deleted from the storage pool when theybecome empty. When scratch volumes with the device type of FILE are deleted,the space that the volumes occupied is freed by the server and returned to the filesystem.

REUsedelaySpecifies the number of days that must elapse after all files are deleted from avolume before the volume can be rewritten or returned to the scratch pool. Thisparameter is optional. You can specify an integer from 0 to 9999. The value 0means that a volume can be rewritten or returned to the scratch pool as soon as allfiles are deleted from the volume.

By specifying this parameter, you can ensure that the database could be restoredto an earlier level and database references to files in the storage pool would still bevalid.

MIGDelaySpecifies the minimum number of days since a file was stored in the storage poolbefore the file becomes eligible for migration from the storage pool. This parameteris optional. You can specify an integer from 0 to 9999. The value 0 specifies thatmigration is not delayed.

MIGContinueSpecifies whether you allow the server to migrate files that do not satisfy themigration delay time. This parameter is optional.

Because you can require that files remain in the storage pool for a minimumnumber of days, the server may migrate all eligible files to the next storage pool yetnot meet the low migration threshold. This parameter allows you to specify whetherthe server is allowed to continue migration by migrating files that do not satisfy themigration delay time.


YesSpecifies that, when necessary to meet the low migration threshold, the servercontinues to migrate files that have not been stored in the storage pool for thenumber of days specified by the migration delay period.

No Specifies that the server stops migration when no eligible files remain to bemigrated, even before reaching the low migration threshold. The server does



|||||

|||

|||||

|

||||

|||

not migrate files unless the files have been stored in the storage pool for thenumber of days specified by the migration delay period.

Examples

Task

Update the primary sequential storage pool named TAPEPOOL1 to permit as many as10 scratch volumes to be mounted.

Command:update stgpool tapepool1 maxscratch=10



||

|

UPDATE STGPOOL — Copy Sequential Access

Use this command to update a copy sequential access storage pool.

Privilege Class


Syntax


Ê


READOnlyUNAVailable


Ê

ÊREClaim = percent MAXSCRatch = number REUsedelay = days

ÊÍ


Specifies the name of the copy storage pool to be updated.

DESCriptionSpecifies a description of the copy storage pool. This parameter is optional. Themaximum length of the description is 255 characters. Enclose the description inquotation marks if it contains any blank characters. To remove an existingdescription, specify a null string ("").

ACCessSpecifies how client nodes and server processes (such as reclamation) can accessfiles in the copy storage pool. This parameter is optional. Possible values are:

READWriteSpecifies that files can be read from and written to the volumes in the copystorage pool.

READOnlySpecifies that client nodes can only read files stored on the volumes in thecopy storage pool.




UNAVailableSpecifies that client nodes cannot access files stored on volumes in the copystorage pool.


COLlocateSpecifies whether the server attempts to keep data belonging to a single clientnode or client file space assigned to as few volumes as possible. This parameter isoptional.






REClaimSpecifies when the server reclaims a volume, based on the percentage ofreclaimable space on a volume. Reclamation makes the fragmented space onvolumes usable again by moving any remaining active files from one volume toanother volume, thus making the original volume available for reuse. Thisparameter is optional. You can specify an integer from 1 to 100. The value 100means that reclamation is not performed.

If you change the value from the default of 100, specify a value of 50 percent orgreater so that files stored on two volumes can be combined onto a single outputvolume.

When a copy pool volume that is offsite becomes eligible for reclamation, thereclamation process attempts to obtain the active files on the reclaimable volumefrom a primary or copy storage pool that is onsite. The process then writes thesefiles to an available volume in the original copy storage pool. Effectively, these filesare moved back to the onsite location. However, the files could be obtained fromthe offsite volume after a disaster if a database backup is used that references thefiles on the offsite volume. Because of the way reclamation works with offsitevolumes, use it carefully with copy storage pools.



MAXSCRatchSpecifies the maximum number of scratch volumes that the server can request forthis storage pool. This parameter is optional. You can specify an integer from 0 to100000000. By allowing the server to request scratch volumes as needed, youavoid having to define each volume to be used.

The value specified for this parameter is used to estimate the total number ofvolumes available in the copy storage pool and the corresponding estimatedcapacity for the copy storage pool.

Scratch volumes are automatically deleted from the storage pool when theybecome empty. However, if the access mode for a scratch volume is OFFSITE, thevolume is not deleted from the copy storage pool until the access mode ischanged. This allows an administrator to query the server for empty, offsite scratchvolumes and return these to the onsite location.

When scratch volumes with the device type of FILE become empty and aredeleted, the space that the volumes occupied is freed by the server and returned tothe file system.

REUsedelaySpecifies the number of days that must elapse after all files are deleted from avolume before the volume can be rewritten or returned to the scratch pool. Thisparameter is optional. You can specify an integer from 0 to 9999. A value of 0means that a volume can be rewritten or returned to the scratch pool as soon as allfiles are deleted from the volume.

Important: Use this parameter to help ensure that when you restore the databaseto an earlier level, database references to files in the copy storage poolare still valid. You must set this parameter to a value greater than thenumber of days you plan to retain the oldest database backup. Thenumber of days specified for this parameter should be the same as thenumber specified for the SET DRMDBBACKUPEXPIREDAYScommand. For more information, see Administrator’s Guide.

Examples

Task

Update the copy storage pool named TAPEPOOL2 to change the delay for volumereuse to 30 days and to collocate files by client node.

Command:update stgpool tapepool2 reusedelay=30 collocate=yes



Related Commands

Table 297. Commands Related to UPDATE STGPOOL

Command Description












UPDATE VOLHISTORY (Update Sequential Volume History Information)

Use this command to update volume history information for a volume produced by adatabase dump, a database backup, or an export operation. This command does notapply to storage pool volumes.

Note: Use the UPDATE BACKUPSET command to update specified backup setvolume information in the volume history file. Do not use this UPDATEVOLHISTORY command to update backup set volume information in the volumehistory file.

Privilege Class

You must have system privilege or unrestricted storage privilege to issue this command.

Syntax

ÊÊ UPDate VOLHistory volume_name DEVclass = device_class_name Ê

ÊLOcation = location ORMSTate = MOuntable

NOTMOuntableCOUrierVAultCOURIERRetrieve

ÊÍ


Specifies the volume name. The volume must have been used for a databasedump, a database backup, or an export operation.

DEVclass (Required)Specifies the name of the device class for the volume.

LOcationSpecifies the volume location. This parameter is required if the ORMSTATEparameter is not specified. The maximum text length is 255 characters. Enclose thetext in quotation marks if it contains any blank characters.

ORMSTateSpecifies a change to the state of a database backup volume. This parameter isrequired if the LOCATION parameter is not specified. The ORMSTATE parameter ismanaged and used by the MOVE DRMEDIA and QUERY DRMEDIA commands.Use caution when invoking this parameter. Possible values are:

MOuntableThe volume contains valid data and is accessible for onsite processing.

UPDATE VOLHISTORY


||||

NOTMOuntableThe volume is onsite, contains valid data, and is not accessible for onsiteprocessing.

COUrierThe volume is being moved offsite.

VAultThe volume is offsite, contains valid data, and is not accessible for onsiteprocessing.

COURIERRetrieveThe volume is being moved onsite.

Examples

Task

Update the location of a volume used for database backup, BACKUP1, to show that ithas been moved to an offsite location.

Command:update volhistory backup1 devclass=tapebkup location="700 w. magee rd."

Related Commands

Table 298. Commands Related to UPDATE VOLHISTORY

Command Description







UPDATE VOLHISTORY


UPDATE VOLUME (Change a Storage Pool Volume)

Use this command to change the access mode for one or more volumes in storagepools.

You can correct an error condition associated with a volume by updating the volume toan access mode of READWRITE. You can also use this command to change thelocation information for one or more volumes in sequential access storage pools.

Note: If you specify values for both the ACCESS and LOCATION parameters but theaccess mode cannot be updated for a particular volume, the location attribute isalso not updated for that volume. For example, if you specifyACCESS=OFFSITE and a LOCATION value for a primary storage pool volume,neither the access nor location values are updated because a primary storagepool volume cannot be given an access mode of OFFSITE.

Privilege Class


Syntax

ÊÊ(1)

UPDate Volume volume_nameACCess = READWrite

READOnlyUNAVailable

(2)DEStroyed

(3)OFfsite

Ê

Ê(4)

LOcation = location

WHERESTGpool = *

WHERESTGpool = pool_nameÊ

ÊWHEREDEVclass = *

WHEREDEVclass = device_class_nameÊ

UPDATE VOLUME


Ê

·

,

WHEREACCess = READWriteREADOnlyUNAVailableOFfsiteDEStroyed

·

,

WHERESTatus = ONlineOFflineEMPtyPENdingFILlingFULl

Ê

ÊPreview = No

Preview = NoYes

ÊÍ

Notes:

1 You must update at least one attribute (ACCESS or LOCATION).

2 This value is valid only for volumes in primary storage pools.

3 This value is valid only for volumes in copy storage pools.

4 This parameter is valid only for volumes in sequential access storage pools.


Specifies the storage pool volume to update. You can use wildcard characters tospecify names.

ACCessSpecifies how client nodes and server processes (such as migration) can accessfiles in the storage pool volume. This parameter is optional. Possible values are:

READWriteSpecifies that client nodes and server processes can read from and write tofiles stored on the volume.

If the volume being updated is an empty scratch volume that had an accessmode of offsite, the server deletes the volume from the database.

READOnlySpecifies that client nodes and server processes can only read files stored onthe volume.


UNAVailableSpecifies that neither client nodes nor server processes can access files storedon the volume.

UPDATE VOLUME


Before making a random access volume unavailable, you must vary thevolume offline. After you make a random access volume unavailable, youcannot vary the volume online.

If you make a sequential access volume unavailable, the server does notattempt to mount the volume.


DEStroyedSpecifies that a primary storage pool volume has been permanently damaged.Neither client nodes nor server processes can access files stored on thevolume. Use this access mode to indicate an entire volume that needs to berestored by using the RESTORE STGPOOL command. After all files on adestroyed volume have been restored to other volumes, the serverautomatically deletes the destroyed volume from the database.

Only volumes in primary storage pools can be updated to DESTROYED.

Before updating a random access volume to DESTROYED access, you mustvary the volume offline. After you update a random access volume toDESTROYED, you cannot vary the volume online.

If you update a sequential access volume to DESTROYED, the server doesnot attempt to mount the volume.

If a volume contains no files and you change the access mode toDESTROYED, the server deletes the volume from the database.

OFfsiteSpecifies that a copy storage pool volume is at an offsite location from which itcannot be mounted. Only volumes in copy storage pools can have the accessmode of OFFSITE.

Use this mode to help you track volumes that you move to offsite locations.See Administrator’s Guide for details.

LOcationSpecifies the location of the volume. This parameter is optional. It can be specifiedonly for volumes in sequential access storage pools. The maximum length of thelocation is 255 characters. Enclose the location in quotation marks if it contains anyblank characters. To remove a previously defined location, specify the null string("").

WHERESTGpoolSpecifies the name of the storage pool for volumes to be updated. Use thisparameter to restrict the update by storage pool. This parameter is optional. Youcan use wildcard characters to specify names. If you do not specify a storage poolname, volumes belonging to any storage pool are updated.

WHEREDEVclassSpecifies the name of the device class for volumes to be updated. Use thisparameter to restrict the update by device class. This parameter is optional. Youcan use wildcard characters to specify names. If you do not specify a device classname, volumes with any device class are updated.

UPDATE VOLUME


WHEREACCessSpecifies the current access mode of volumes to be updated. Use this parameterto restrict the update to volumes that currently have the specified access mode.This parameter is optional. You can specify multiple access modes by separatingthe modes with commas and no intervening spaces. If you do not specify a valuefor this parameter, the update is not restricted by the current access mode of avolume. Possible values are:

READWriteUpdate volumes with an access mode of READWRITE.

READOnlyUpdate volumes with an access mode of READONLY.

UNAVailableUpdate volumes with an access mode of UNAVAILABLE.

OFfsiteUpdate volumes with an access mode of OFFSITE.

DEStroyedUpdate volumes with an access mode of DESTROYED.

WHERESTatusSpecifies the status of volumes to be updated. Use this parameter to restrict theupdate to volumes that have a specified status. This parameter is optional. You canspecify multiple status values by separating the values with commas and nointervening spaces. If you do not specify a value for this parameter, the update isnot restricted by volume status. Possible values are:

ONlineUpdate volumes with a status of ONLINE.

OFflineUpdate volumes with a status of OFFLINE.

EMPtyUpdate volumes with a status of EMPTY.

PENdingUpdate volumes with a status of PENDING. These are volumes from which allfiles have been deleted, but the time specified by the REUSEDELAYparameter has not elapsed.

FILlingUpdate volumes with a status of FILLING.

FULlUpdate volumes with a status of FULL.

PreviewSpecifies whether you want to preview the update operation without actuallyupdating volumes. This parameter is optional. The default value is NO. Possiblevalues are:

No Specifies that volumes are actually updated.

UPDATE VOLUME


YesSpecifies that you want only to preview the update operation. This optiondisplays the volumes that will be updated if you actually perform the updateoperation.

Examples

Task 1

Update a tape volume named DSMT20 to make it unavailable to client nodes andserver processes.

Command:update volume dsmt20 access=unavailable

Task 2

Update all empty, offsite volumes in the TAPEPOOL2 storage pool. Set the accessmode to READWRITE and delete the location information for the updated volumes.

Command:update volume * access=readwrite location="" wherestgpool=tapepool2whereaccess=offsite wherestatus=empty

Related Commands

Table 299. Commands Related to UPDATE VOLUME

Command Description





UPDATE VOLUME


VALIDATE POLICYSET (Verify a Policy Set)

Use this command to verify that a policy set is complete and valid before you activate it.The command examines the management class and copy group definitions in the policyset and reports on conditions that you need to consider before activating the policy set.

The VALIDATE POLICYSET command fails if any of the following conditions exist:

v The policy set has no default management class.

v A copy group within the policy set specifies a copy storage pool as a destination.

v A management class specifies a copy storage pool as the destination forspace-managed files.

The server issues warning messages for the following conditions:

v A copy group specifies a storage pool that does not exist as a destination forbacked-up or archived files.

If you activate a policy set with copy groups that specify nonexistent storage pools,the client backup or archive operations fail.

v A management class specifies a storage pool that does not exist as a destination forfiles migrated from HSM clients.

v The policy set does not have one or more management classes that exist in thecurrent ACTIVE policy set.

If you activate the policy set, backup files bound to the deleted management classesare rebound to the default management class in the new active policy set.

v The policy set does not have one or more copy groups that exist in the currentACTIVE policy set.

If you activate the policy set, files bound to the management classes with deletedcopy groups are no longer archived or backed up.

v The default management class for the policy set does not contain a backup orarchive copy group.

If you activate the policy set with this default management class, clients using thedefault cannot back up or archive files.

v A management class specifies that a backup version must exist before a file can bemigrated from a client node (MIGREQUIRESBKUP=YES), but the management classdoes not contain a backup copy group.

Privilege Class


Syntax

ÊÊ VALidate POlicyset domain_name policy_set_name ÊÍ

VALIDATE POLICYSET



Specifies the name of the policy domain to which the policy set is assigned.

policy_set_name (Required)Specifies the name of the policy set to be validated.

Examples

Task

Validate the policy set VACATION located in the EMPLOYEE_RECORDS policydomain.

Command:validate policyset employee_records vacation

Related Commands

Table 300. Commands Related to VALIDATE POLICYSET

Command Description









VALIDATE POLICYSET


VARY (Bring a Random Access Volume Online or Offline)

Use this command to make a random access volume online or offline to the server as adatabase, recovery log, or storage pool volume. This command is valid only for volumeson random access devices. For example, use this command during maintenance orcorrective action of a random access volume. You cannot vary a random access volumeonline that is defined as unavailable.

Privilege Class


Syntax

ÊÊ VARy ONlineOFfline

volume_nameWait = No

Wait = NoYes

ÊÍ

ParametersONline

Specifies that the server can use the random access volume.

OFflineSpecifies that the server cannot use the volume.

volume_name (Required)Specifies the volume identifier. Volume names cannot contain embedded blanks orequal signs.


No

YesSpecifies that the server processes this command in the foreground. Wait forthe command to complete before you continue with other tasks. The serverdisplays the output messages to the administrative client when the commandcompletes.

Examples

Task

Make volume available to the server for use as a database volume.

Command:

VARY


Related Commands

Table 301. Commands Related to VARY

Command Description












VARY


VARY


Appendix A. AS/400 Utilities

You can access the utilities listed in the following tables from the command line or byissuing the GO ADSM command. The syntax diagrams in this section are similar tothose in TSM commands. However, they follow the AS/400 format. For information onhow to interpret AS/400 diagrams, see the CL Reference.

Database Recovery Utilities

Use the following utilities to re-establish your server database if a catastrophic erroroccurs, and you have a backup copy of the database available.

Table 302. Database Recovery Utilities

Utility Description Reference Page

DSPVOLADSM Displays database backup volumeinformation

825

STRRSTADSM Restores the database 828

Database Salvage Utilities

Use the following utilities to re-establish your server database if a catastrophic erroroccurs, and the database cannot be recovered effectively using the STRRSTADSMutility. These utilities are presented in the order in which they must be processed.

Table 303. Database Salvage Utilities


DMPADSM Dumps the database on sequential media 834

INZSVRADSM Initializes the database and recovery log 838

LODADSM Reloads the database 846

STRAUDADSM Verifies database information 849

The DMPADSM and LODADSM utilities use the device configuration file. This filecontains a copy of the device class, library, and drive definitions that exist in yourdatabase. TSM automatically creates and maintains a current device configuration file ifyou specify the DEVCFGFILE parameter using the CHGSVRADSM utility. You can alsocreate the file by using the BACKUP DEVCONFIG command. If no device configurationfile has been maintained or created, you must manually create one with an editor. Forinformation on how to create a device configuration file manually, see Administrator’sGuide.


Miscellaneous Server Utilities

The following utilities are available with TSM.

Table 304. Miscellaneous Utilities


CRTVOLADSM Creates and formats a physical file memberas a TSM volume.

852

STRSVRADSM Starts the server. 856

VFYSVRADSM Checks the status of the server. 861

WRKDEVADSM Sets up TSM devices. 862

CHGADMADSM Updates your administrative client options. 865

CHGSVRADSM Updates your server options. 871

ENDSVRADSM Ends the TSM server. 898


DSPVOLADSM (Display Volume Information)

Use this command to display information about the database volumes, recovery logvolumes, or specific database backup volumes known to the TSM server. You mayneed this to recover the database.

If TSM is running when you issue DSPVOLADSM, the command fails. You will receivea message indicating when the command starts and ends processing.

The information is displayed in the message queue specified by the CSLMSGQparameter of the CHGSVRADSM command. The information is sent to your spool filesif you have set the CSLOUT parameter to *ON on the CHGSVRADSM command.

Syntax

Job: B,I Pgm: B,I REXX: B,I Exec

ÊÊ(1)

DSPVOLADSM*LOG

TYPE( *DB )*DBBACKUP

Ê

ÊQUSRADSM

WRKLIB( *CURLIB )work-library

DEVCLASS( device-class )Ê

Ê

·(2)

VOL( volume-name )

ÊÍ

Notes:

1 All parameters preceding this point can be specified in positional form.

2 A maximum of 30 repetitions

ParametersTYPE

Specifies the type of volume information to display. This parameter is optional. Thevalues are:

*LOGAll recovery log volumes. This is the default.

*DBAll database volumes.

DSPVOLADSM

Appendix A. AS/400 Utilities 825

*DBBACKUPDatabase backup volumes specified by the VOL parameter.

WRKLIBSpecifies the server work library (the library containing work objects). Thisparameter is optional. The values are:

QUSRADSMThe QUSRADSM library. This is the default.

*CURLIBThe current library.

work-libraryAny valid library name. If the library does not exist or you do not have authorityto create objects in it, the command fails.

VOL(volume_name)Specifies the database backup volume names. This parameter is required if thetype of volume specified is *DBBACKUP.

DEVCLASS(device_class_name)Specifies the name of the sequential access device class to use when displaying*DBBACKUP volumes. The device class defined in an external file specified withthe DEVCFGFILE parameter on the CHGSVRADSM command. This parameter isonly valid if the volume type is *DBBACKUP.

Examples

Task

Display information about TSM recovery log files.

Command:DSPVOLADSM TYPE(*LOG) WRKLIB (QUSRADSM)

Output:

ANR0200I Recovery log assigned capacity is 12 megabytes.ANR0201I Database assigned capacity is 12 megabytes.Volume Name (Copy 1): QUSRADSM/LOG(LOG)

Copy Status: Sync'dVolume Name (Copy 2):

Copy Status: UndefinedVolume Name (Copy 3):

Copy Status: UndefinedAvailable Space (MB): 12Allocated Space (MB): 12

Free Space (MB): 0

Where:

Volume Name (Copy n)The database or recovery log volume. The output displays the status of the threevolumes copies (Copy 1, Copy 2, and Copy 3)

DSPVOLADSM


Copy StatusThe volume status:


StaleThe volume is not synchronized with the other volumes in the database orrecovery log and cannot be used for storage.

Sync’dThe volume is synchronized with the other volumes in the database orrecovery log and can be used for storage.


Available SpaceThe total available space for the volume, in megabytes

Allocated SpaceThe allocated space for the volume, in megabytes

Free SpaceThe unassigned space, in megabytes, that can be allocated for use.

DSPVOLADSM


STRRSTADSM (Start Restore for TSM)

Use the STRRSTADSM command to:

v Restore a database to its most current state using the recovery log

v Restore a single database volume to its most current state

v Restore an database to a specific point in time

v Restore multiple volumes when the volume history file does not exist

Attention: If the original database or recovery log volumes are available, you issueonly the STRRSTADSM command. However, if those volumes have been lost, you mustfirst issue the INZSVRADSM command to initialize the database and recovery log, thenissue the STRRSTADSM command.

The restore uses backup versions of the database that you created with the BACKUPDB command or backup versions which were created automatically based on settingsyou specified with the DEFINE DBBACKUPTRIGGER command. The TSM server mustnot be running when this command is issued or the command will fail. This commandwill submit a job to process the restore. You will receive a message when the job startsprocessing and when the job stops processing. Volume mount requests will be sent tothe message queue specified on the MOUNTMSGQ parameter on the CHGSVRADSMcommand.

Syntax


ÊÊ STRRSTADSM(6)

TYPE( *RCYLOG )*SNGVOL*RSTDATE*VOLLIST

QUSRADSMWRKLIB( *CURLIB )

work-library-name

Ê

Ê*NO

PREVIEW( *YES )(1)

SNGVOL( database-volume-name )

Ê

Ê(2) *TODAY 0 *NOW 0

RSTDATE( restore-to-date days-offset restore-to-time hours-offset )

Ê

Ê

·

(3)VOLLIST( *VOLFILE )

.(5)

database-volume-name

Ê

Ê(4) *WRKLIB/ *FILE

VOLFILE( volume-list-file-name volume-list-member-name )library-name/

Ê

STRRSTADSM


Ê(3) *NO

COMMIT( *YES )(3)

DEVCLASS( device-class-identifier )

ÊÍ

Notes:

1 Valid only if TYPE(*SNGVOL) specified.

2 Valid only if TYPE(*RSTDATE) specified.

3 Valid only if TYPE(*VOLLIST) specified.

4 Valid only if VOLLIST(*VOLFILE) specified.



ParametersTYPE

Specifies the type of restore to perform. This parameter is required.

The values are:

*RCYLOGSpecifies that TSM recovery log volumes will be used to perform the restore.To do this type of restore, the following must be true:

v The log mode was set to ROLLFORWARD continuously from the time thelast backup series was created

v The recovery log is available and intact

v The volume history file is available and intact

*SNGVOLSpecifies a roll-forward recovery will be performed for a single databasevolume. To do a single volume restore, the following conditions must be true:

v The log mode was set to ROLLFORWARD continuously from the time thelast backup series was created.

v The recovery log is available and intact

*RSTDATESpecifies that a point-in-time restore will be performed. To do this type ofrestore, you must define at least one volume history file with the VOLHSTFILEparameter and at least one device configuration file with the DEVCFGFILEparameter using the CHGSVRADSM command.

*VOLLISTSpecifies that if the volume history file is unavailable, you can do apoint-in-time restore manually using a list of volumes and device class youprovide.

Any device class you specify for a restore must be defined in an externaldevice configuration file specified with the DEVCFGFILE parameter using the

STRRSTADSM


CHGSVRADSM command. If a device configuration file is not available, youcan manually create one. See Administrator’s Guide for more information.

WRKLIBSpecifies the server work library containing error logs and work objects. Thisparameter is optional. The same work library should be used to initialize, start, andend the server.

The values are:

QUSRADSMSpecifies that QUSRADSM will be used as the server work library. The defaultlibrary is WRKLIB(QUSRADSM).

*CURLIBSpecifies that the current library will be used as the server work library.

work-library-nameSpecifies the name of the server work library. You can specify any valid libraryname, but if the library does not exist or you do not have authority to createobjects in the library, the command fails.

PREVIEWSpecifies whether you want TSM to display a list of volumes needed to restore thedatabase, without actually performing the restore operation. This parameter is notvalid when TYPE(*VOLLIST) is specified. This parameter is optional.

The values are:

*NOSpecifies that you want to restore the database. *NO is the default.

*YESSpecifies that you only want TSM to display the list of database backupvolumes, without actually restoring the database.

SNGVOL (database-volume-name)Specifies the name of the single database volume to be restored. This parameter isvalid only if you specify TYPE(*SNGVOL).

RSTDATESpecifies the date and time to recover the server. This parameter is valid only ifyou specify TYPE(*RSTDATE).

Element 1. Restore-to-dateSpecifies the date to which to restore the database. The values are:

*TODAYSpecifies that you want to restore the database using the most recentbackup series that was created prior to the current date.

dateSpecifies that you want to restore the database using the most recentbackup series that was created prior to a specific date.

STRRSTADSM


Element 2. Days offset (if *TODAY is specified)Specifies that if *TODAY is specified, you can also indicate an offset from thedate. The values are:

0 Specifies that the database will be recovered to today’s date.

days-offsetSpecifies the number of days (from today’s date) to recover the database.

For example, to restore a database using the most recent backup seriesthat was created prior to one week ago, you can enter:

STRRSTADSM TYPE(*RSTDATE) RSTDATE(*TODAY-7)

Element 3. Restore-to-timeSpecifies the time of day to which to restore the database. The time isspecified in a 24-hour format and can be specified with or without a timeseparator. For example:

v Without a time separator, specify a string of 4 or 6 digits (hhmm or hhmmss)where:

hh = hours

mm = minutes

ss = seconds

Hours, minutes, and seconds must each be exactly 2 digits.

v With a time separator, specify a string of 5 or 8 digits where the timeseparator specified is used to separate the hours, minutes, and seconds.For example, you can use HH:MM:SS. If you enter this command from thecommand line, the string must be enclosed in apostrophes. If a timeseparator other than the separator specified for your job is used, thiscommand will fail.

The values are:

*NOWSpecifies that you want to restore the database using the most recentbackup series that was created on or before the current time on thespecified date.

For example, if you issue this command at 9:00 with RSTDATE(*NOW),TSM restores the database using the last backup series created on orprior to 9:00 on the specified date.

restore-to-timeSpecifies that you want to restore the database using the most recentbackup series that was created on or before a specific time on thespecified date.

Element 4. Hours offset (if *NOW is specified)Specifies that if *NOW is specified, you can also indicate an offset. The valuesare:

0 Specifies that the database will be recovered to the current time.

STRRSTADSM


hours-offsetSpecifies that if *NOW is specified for the time, you can indicate an offsetfrom this time.

For example, if you issue the STRRSTADSM command at 9:00 withRSTDATE (*NOW - 3:30), TSM restores the database using the lastbackup series created on or prior to 5:30 on the specified date. You canenter the following command to perform that task:

STRRSTADSM TYPE(*RSTDATE) RSTDATE(*TODAY *NOW -3:30)

VOLLISTSpecifies the volumes to be used to restore the database. These volumes can befound in the volume history file. This parameter is only valid if TYPE(*VOLLIST) isspecified. The values are:

*VOLFILESpecifies that the list of volumes will provided in a file specified in theVOLFILE parameter.

database-volume-nameSpecifies the name of the database volume used to restore the database. Youcan specify up to 30 database volume names.

VOLFILESpecifies the file that contains the list of volumes to be used to restore thedatabase. This parameter is only if VOLLIST(*VOLFILE) is specified.

Element 1. Volume list file nameThe volume list file name can be qualified by using one of the following libraryvalues:

*WRKLIBSpecifies that file will be located in the server work library, *WRKLIB. Thisis the default.

library-nameSpecifies the name of the library where the file is to be located. You canspecify any valid name, but if the library does not exist or you do not haveauthority to create objects in the library, the command will fail.

volume-list-file-nameSpecifies the name of the file containing the list of volumes used to restore thedatabase.

Element 2. Volume list file memberSpecifies the name of the file member. The default is *FILE indicating that thename of the volume list file is the same as the file name.

COMMITSpecifies whether this is the last restore command you intend to issue to restorethe database. The values are:

STRRSTADSM


*NOSpecifies that you intend to issue at least one more restore command. Thedatabase remains in an inconsistent state until you issue the STRRSTADSMcommand with COMMIT (*YES).

*YESSpecifies that this is the last restore command you intend to use to restore thedatabase. With this command, you are specifying the last volumes you want touse for the restore operation.

DEVCLASS (device-class-identifier)Specifies the sequential access device class to use when restoring *DBBACKUPvolumes. Any device class you specify must be defined in an external file specifiedwith the DEVCONFIG parameter of the CHGSVRADSM command. If a deviceconfiguration file is not available, you can manually create one. See Administrator’sGuide for more information.

Examples

Task 1

Restore the database to its state on February 12, 1996. The volume history file isavailable.

Command:STRRSTADSM TYPE(*RSTDATE) WRKLIB(QUSRADSM) PREVIEW(*NO)

Task 2

Restore a database volume named DB located in library QUSRADSM.

Command:STRRSTADSM TYPE(*SNGVOL) WRKLIB(QUSRADSM) SNGVOL(QUSRADSM/DB(DB))

Task 3

Restore the database using database volume named QANR.DBB.(D826643504) anddevice class class named DBBDEV. The volume history file is unavailable.

Command:STRRSTADSM TYPE(*VOLLIST) VOLLIST('QUSRADSM/QANR.DBB(D826643504)')COMMIT(*YES) DEVCLASS(DBBDEV)

STRRSTADSM


DMPADSM (Dump TSM Database)

Use this command as the first step in dumping, reinitializing, and reloading the serverdatabase if a catastrophic error occurs, and you cannot use the STRRSTADSMcommand. No other server activity is allowed during the DMPADSM commandprocessing.

When you issue this command, it is submitted to batch for processing. TSM generatesa message indicating when the command starts processing and when the commandcompletes processing. If the CSLMSGQ parameter of the CHGSVRADSM commandhas been specified, information about the dump is displayed in the message queuespecified. The information can also be found in your spool files if the CSLOUTparameter is set to *ON on the CHGSVRADSM command.

After DMPADSM processing is complete, do the following:

1. Backup your recovery log and database files (or use the new ones so the originalfile remains untouched).

2. Issue the INZSVRADSM command to reinitialize the database and recovery log.

3. Issue the LODADSM command to reload the database.

4. Issue the STRAUDADSM command to locate and correct any databaseinconsistencies.

If you are dumping to tape, you must have a device configuration file that includes thedefinition for this device class, and any libraries and drives needed. You must alsospecify the name of that device configuration file by specifying the DEVCFGFILEparameter in the CHGSVRADSM command. The device configuration file should beavailable if you had previously included a DEVCFGFILE parameter using theCHGSVRADSM command and then started the server. If the device configuration filehas been lost or was never created, do one of the following:

v If the server can be restarted, restart the server and issue the BACKUPDEVCONFIG command.

v If the server cannot be restarted, create the device configuration file manually with aneditor. For information on how to create a device configuration file manually, seeAdministrator’s Guide

Consider the following before dumping the database:

v Before dumping the database to sequential access media, estimate how much mediais required. If you cannot bring up the server, use the size of your existing databasevolumes.

If you can bring the server up, estimate the size by following these steps:

1. Issue the QUERY DB command.

2. From the output of the QUERY DB command, multiply the number of used pagesby 4096 bytes to determine the space occupied by the database.

3. Divide the product of step 2 by the capacity of a single medium to estimate thenumber of media required.

DMPADSM


v Record the order in which the volumes are mounted during dump processing. Youmust remount the volumes in the same order during recovery processing. Label thevolumes to indicate the order in which they have been mounted. For example, labeltapes as DSM001, DSM002, DSM003, and so on.

v When dumping, you can use scratch volumes to ensure that there is sufficient spaceto store the database. If you use scratch volumes, record the label names andsequence for each volume mounted during the dump process. The volumes used bythe DMPADSM command are not recorded in the sequential volume historyinformation.

v The server recovery log is not accessed during the dump process. Therefore,database entries that were not written to the database at the time of the dump, arenot recorded. During recovery from a catastrophic failure, the most recent databaseupdates are recorded in the recovery log.

v The dump command requires standard label tapes if you are dumping to tape.

Syntax


ÊÊ DMPADSM(1)

DEVCLASS( device-class )*YES

SCRATCH( *NO )

Ê

Ê

·

.(2)

VOL( volume-name )

WRKLIB( . )ÊÍ

QUSRADSM*CURLIBwork-library-name

Notes:



ParametersDEVCLASS(devclassname)

Specifies the device class to which the database is to be written. This parameter isrequired.

SCRATCH(scratchvalue)Specifies that scratch volumes can be used for dumping the database. The defaultvalue is *YES. The values are:

DMPADSM


*YESScratch volumes can be used for dumping the database. If you include a list ofvolumes on the VOL parameter, then scratch volumes are used only if there isnot enough space to dump the database on the volumes specified. If thedevice type associated with the specified device class is FILE, a file namedQANR.DMP(D00000001) is chosen for the first scratch volume. If a file alreadyexists by this name in the target directory, you must rename or erase it if youwant to use SCRATCH(*YES).

*NOScratch volumes cannot be used for dumping the database. You must includea list of volumes on the VOL parameter to contain all of the database data.

VOL(volname)Specifies the volumes to be used to dump the database. This parameter isoptional. You can specify a list of volumes. This parameter must be specified ifSCRATCH(*NO). If you do not specify this parameter and SCRATCH(*YES) isspecified or assumed, scratch volumes are used. You must remember the volumenames used and specify them in the same order on a future LODADSM command.

WRKLIBSpecifies the library to contain work objects. If multiple instances of the TSM serverare going to be run, each server requires its own work library. The same worklibrary should be used to initialize, start, and end server operations. The values are:

QUSRADSMQUSRADSM will be used as the server work library. QUSRADSM is thedefault.

*CURLIBThe current library will be used as the server library.

work-library-nameSpecifies the name of the library to use as the server work library. Use anyvalid library name. If you do not have authority to create objects in the library,the command fails.

Examples

Task

Dump the AS/400 TSM database to a cartridge tape named TAP07.

1. Halt the server.

2. Ensure that the DEVCFGFILE parameter has been specified using theCHGSVRADSM command. The device configuration file must contain the deviceclass, library, and drive definitions needed for the dump operation.

3. Issue the DMPADSM command specifying that the data be written to scratchvolumes on a device associated with the device class 8MMTAPE.

Command:

DMPADSM DEVCLASS(8MMTAPE)

DMPADSM


Wait for the message indicating that the command has completedprocessing. You can then select option 3 (Display console messages) fromthe TSM menu to display the output.

DMPADSM


INZSVRADSM (Initialize Server for ADSM)

Use this command to create and format physical files to be used as TSM database andrecovery volumes. Issuing the command initializes the server with those volumes.

Attention: Issue this command only once. Rerunning this command reinitializes theserver, and any data that was backed up is lost.

If you want to add database or recovery log volumes after the server is initialized,format them using the CRTVOLADSM command and define them to the server usingthe DEFINE VOLUME command.

Syntax


ÊÊ(1)

INZSVRADSMQUSRADSM

WRKLIB( *CURLIB )library-name

Ê

Ê*VOLLIST

VOLSPC( *FILE )*VOLSTMF

*YESPRPWEB( *NO )

ÊÍ

*VOLLIST Details:

·*WRKLIB/ *FILE 25 *NO (2)

LOGVOL( file-name member-name member-size *YES )*LIBL/*CURLIB/library-name/

Ê

Ê ·*WRKLIB/ *FILE 25 *NO (3)

DBVOL( file-name member-name member-size *YES )*LIBL/*CURLIB/library-name/

*FILE Details:

RPLFILES( *NO )*YES

*WRKLIB/LOGFILE( file-name )

*CURLIB/library-name/

Ê

INZSVRADSM


Ê*FILE

LOGFILEMBR( )file-name

*WRKLIB/DBFILE( file-name )

*CURLIB/library-name/

Ê

Ê*FILE

DBFILEMBR( )file-name

*VOLSTMF Details:

·25 *NO (4)

LOGSTMF( volume-name volume-size *YES ) Ê

Ê ·25 *NO (5)

DBSTMF( volume-name volume-size *YES )

Notes:






ParametersWRKLIB

Specifies the library associated with this TSM server. If multiple instances of theTSM server to going to be run, each server will need its own work library. Thesame work library should be used to initialize, start, and end server operations. Thevalues are:

QUSRADSMSpecifies that library QUSRADSM is used as the work library.

*CURLIBSpecifies that the current library is used as the work library.

library-nameSpecifies the name of any valid library. If the library does not exist or you donot have authority to create objects in the library, the command fails.

VOLSPCSpecifies how the volumes are specified. The options are:

INZSVRADSM


*VOLLISTSpecifies that the volumes are listed individually.

*FILESpecifies that a file is named that contains a list of volume names and sizes.Database volume information and recovery log volume information must be inseparate files.

*VOLSTMFSpecifies that the volumes are listed individually. Each volume name isspecified as the path name of a stream file.

LOGVOLSpecifies the recovery log volumes to be used by the TSM server. This includesthe name of the file and the library where the file is to be located. The namespecified for the recovery log volume must be different from the name specified forthe database volumes. This parameter is required only if you specifyVOLSPC(*VOLLIST).

Element 1: Recovery log volume fileThe recovery log volume file can be qualified by using one of the followinglibrary values:

*WRKLIBSpecifies that the file will be created in the working library. *WRKLIB/ isthe default.

*CURLIBSpecifies that the file will be created in the current library.

*LIBLSpecifies to use a library list to locate the file. If the file exists and is to bereplaced, the file is deleted. The file is then recreated in the current library.

library-nameSpecifies the name of the library where the file will to be created. You canspecify any valid library name, but if the library does not exist or you donot have authority to create objects in the library, the command will fail.

file-nameSpecifies the name of the file to be used as the recovery log volume. Thename you specify for the recovery log volume should be different than thename you specify for the database volume.

Element 2: File memberSpecifies the name of the physical file member. The values are:

*FILESpecifies that the member name is the same as the file name. *FILE isthe default.

member-nameSpecifies the name of the physical file member.

Element 3: File member size or volume member sizeSpecifies the size of the file or volume to be formatted in megabytes (for

INZSVRADSM


|||

||

example, 5 indicates 5MB, 12 indicates 12MB). This value is expressed as apositive integer. The allocated file or volume size must be a multiple of 4MBplus an additional 1MB for overhead. For example, for an 8MB recovery log,specify 9; for a 12MB log specify 13. The minimum recovery log file or volumesize is 25MB.

Element 4: Replace memberSpecifies whether of not to replace the specified physical file member if italready exists. The values are:

*NOSpecifies to not replace the specified physical file member if it alreadyexists.

Note: If the member already exists and you specify *NO, INZSVRADSMfails.

*YESSpecifies to replace the physical file member if it already exists.

DBVOLSpecifies the database volumes to be used to initalize the TSM server. Thisincludes the name of the file and the library where the file is to be located. Thename specified for the database volumes must be different from the name specifiedfor the recovery log volumes. This parameter is required only if you specifyVOLSPC(*VOLLIST)

Element 1: Database volume fileThe database volume file can be qualified by using one of the following libraryvalues:

*WRKLIBSpecifies that the file will be created in the working library. *WRKLIB/ isthe default.



library-nameSpecifies the name of the library where the file is to be created.

file-nameSpecifies the name of the file to be used as the database volume. The nameyou specify for the database volume should be different than the name youspecify for the recovery log volume.



INZSVRADSM


|||||


Element 3: File member sizeSpecifies the size of the file to be formatted in megabytes (for example, 5indicates 5MB, 12 indicates 12MB). This value is expressed as a positiveinteger. The allocated file size is always a multiple of 4MB plus an additional1MB for overhead. For example, for an 100MB recovery log, specify 101; for a200MB log specify 201.


*NOSpecifies to not replace the specified physical file member if it alreadyexists.

Note: If the member already exists and you specify *NO, INZSVRADSMfails.

*YESSpecifies to replace the physical file member if it already exists.

RPLFILESSpecifies whether the volumes should be replaced if they exist. If the volumes existand you do not allow them to be replaced, the command will fail.

*NODo not replace the specified physical files if they already exist. Note that if afile and member already exist and *NO is specified, INZSVRADSM fails.

*YESReplace the specified physical files if they already exist.

LOGFILESpecify the name of the file containing the list of recovery log volumes to beinitialized. This must be a different file from the one specified for the databasevolumes. The file must contain the recovery log name and size.

*WRKLIBSpecifies that the file will be created in the working library. *WRKLIB/ is thedefault.


library-nameSpecifies to use a library list to locate the file. If the file exists and is to bereplaced, the file is deleted. The file is then recreated in the current library.

file-nameSpecifies the name of the file to be used as the recovery log volume. Thename you specify for the recovery log volume should be different than thename you specify for the database volume.

INZSVRADSM


LOGFILEMBRSpecify the member name of the file containing the list of recovery log volumes tobe initialized.

*FILESpecifies that the member name is the same as the file name. *FILE is thedefault.

file-nameSpecifies the name of the physical file member.

DBFILESpecify the name of the file containing the list of database volumes to be initialized.This must be a different file from the one specified for the recovery log volumes.The file must contain the database name and size.

*WRKLIBSpecifies that the file will be created in the working library. *WRKLIB/ is thedefault.


library-nameSpecifies to use a library list to locate the file. If the file exists and is to bereplaced, the file is deleted. The file is then recreated in the current library.

file-nameSpecifies the name of the file to be used as the database volume. The nameyou specify for the database volume should be different than the name youspecify for the recovery log volume.

DBFILEMBRSpecify the member name of the file containing the list of db volumes to beinitialized.

*FILESpecifies that the member name is the same as the file name. *FILE is thedefault.

file-nameSpecifies the name of the physical file member.

LOGSTMFSpecifies the recovery log volumes to be used by the TSM server. The volumename is specified as the path name of a stream file. The name specified for therecovery log volume must be different from the name specified for the databasevolumes. This parameter is required only if you specify VOLSPC(*VOLSTMF).

Element 1: Recovery log volumeSpecifies the name of the file to be used as the recovery log volume. Thename you specify for the recovery log volume should be different than thename you specify for the database volume.

The path name must be absolutely qualified. An absolute path name starts with’/’.

INZSVRADSM


Element 2: Volume sizeSpecifies the size of the file or volume to be formatted in megabytes (forexample, 5 indicates 5MB, 12 indicates 12MB). This value is expressed as apositive integer. The allocated file or volume size must be a multiple of 4MBplus an additional 1MB for overhead. For example, for an 8MB recovery log,specify 9; for a 12MB log specify 13. The minimum recovery log file or volumesize is 25MB.

Element 3: Replace volumeSpecifies whether of not to replace the specified stream file if it already exists.The values are:

*NOSpecifies to not replace the specified stream file if it already exists.

Note: If the file already exists and you specify *NO, INZSVRADSM fails.

*YESSpecifies to replace the stream file if it already exists.

DBSTMFSpecifies the database volumes to be used by the server. The volume name isspecified as the path name of a stream file. The name specified for the databasevolume must be different from the name specified for the recovery log volumes.This parameter is required only if you specify VOLSPC(*VOLSTMF).

Element 1: Database volumeSpecifies the name of the file to be used as the database volume. The nameyou specify for the database volume should be different than the name youspecify for the recovery log volume.


Element 2: Volume sizeSpecifies the size of the file or volume to be formatted in megabytes (forexample, 5 indicates 5MB, 12 indicates 12MB). This value is expressed as apositive integer. The allocated file or volume size must be a multiple of 4MBplus an additional 1MB for overhead. For example, for an 8MB recovery log,specify 9; for a 12MB log specify 13. The minimum database volume size is25MB.


*NOSpecifies to not replace the specified stream file if it already exists.

Note: If the file already exists and you specify *NO, INZSVRADSM fails.

*YESSpecifies to replace the stream file if it already exists.

INZSVRADSM


|||||||

|||||

||||

||

|||||||

|||

||

|

||

PRPWEBSpecifies whether the TSM server database is prepared for the administrative webinterface. This option must be specified in order to use the web administrativefunction.

Note: When using this command in preparation for a LODADSM command, youmust specify *NO for this parameter. Otherwise, as part of the serverinitialization, the database is prepared for the administration web interface.When *YES is specified, the server’s data is no longer a considered aninitialized database. This can cause the LODADSM command not to processsuccessfully.

The values are:

*YESSpecifies that the database is prepared for the administrative web interface.The default is *YES.

*NOSpecifies that the database is not prepared for the administrative webinterface.

Examples

Task

Initialize the TSM server with two 48MB recovery log volumes (LOG001 and LOG002)and two 500MB database volumes (DB001 and DB002) in the server work library. Thistask can be done in either of two ways:

v Command 1: Lists the volume names and sizes in the command (Command 1)

v Command 2: Specifies files that list the volume names and sizes (Command 2)

Command 1

INZSVRADSM VOLSPC(*VOLLIST) LOGVOL((LOG001 *FILE 49) (LOG002 *FILE 49))DBVOL ((DB001 *FILE 501) (DB002 *FILE 501))

Command 2

INZSVRADSM VOLSPC(*FILE) RLPFILES(*YES) LOGFILE(LFLIST001)LOGFILEMBR(*FILE) DBFILE(DBLIST001) DBFILEMBR(*FILE)

INZSVRADSM


|

LODADSM (Load the TSM Database)

Use the LODADSM command to reload a dumped database to a newly installed TSMserver. The database must have been dumped by the DMPADSM command. You mustreinitialize server database and recovery log volumes for TSM before issuing thiscommand. No other server activity is allowed during LODADSM command processing.

When recovering from a failure, you should reinitialize your server by issuing theINZSVRADSM command and specifying a new database and log. Thus, if you mustrepeat the dump and load process, the original database and log volumes are intact.

A message at the end of the output from the LODADSM command indicates whether aSTRAUDADSM command is required. If the server was quiesced when it was haltedbefore the DMPADSM command was issued, the STRAUDADSM command is notrequired. Otherwise, you must issue the STRAUDADSM command to ensure that thedatabase is returned to a consistent state after it is reloaded.

The LODADSM command requires a device configuration file. Use the CHGSVRADSMcommand with the DEVCFGFILE parameter to create a device configuration file. Thedevice configuration file contains a copy of the device class, library, and drive definitionsthat exist in your database. The file specified with the DEVCFGFILE parameter mustcontain at least the definition of the device class specified in the LODADSM command,along with any necessary library and drive definitions.

Syntax


ÊÊ(1)

LODADSM DEVCLASS( device-class ) Ê

Ê ·(2) (3)

VOL( volume-name )QUSRADSM

WRKLIB( *CURLIB )work-library-name

ÊÍ

Notes:

1 Before issuing the LODADSM command, you must reinitialize the serverdatabase and recovery log.



LODADSM


ParametersDEVCLASS(devclassname)

Specifies the device class from which the database information is to be read. Thisparameter is required.

You must have a device configuration file that includes the definition for this deviceclass, and any libraries and drives needed. You must also specify the name of thatdevice configuration file by using the DEVCFGFILE parameter in theCHGSVRADSM command. The device configuration file should be available if youhad previously included a DEVCFGFILE parameter in the CHGSVRADSMcommand and then started the server. If the device configuration file has been lostor was never created, do one of the following:

v If the server can be restarted, restart the server and issue the BACKUPDEVCONFIG command.

v If you cannot restart the server, create the device configuration file manually withan editor. For details, see Administrator’s Guide

VOL(volname)Specifies one or more volumes to be used to load the database from. Thisparameter is required.

During the dump process, if the device type associated with the specified deviceclass was FILE and SCRATCH(*YES), then you must provide the file name andmember name, for example, QANR.DMP(D00000001), for all dump files. You mustspecify the same list of volumes in the same order used for the DMPADSMcommand. The volume names in the list are separated by a space.

WRKLIBSpecifies the library to contain work objects. If multiple instances of the TSM serverare going to be run, each server requires its own work library. The same worklibrary should be used to initialize, start, and end server operations. The values are:

QUSRADSMSpecifies that library QUSRADSM will be used as the server work library.QUSRADSM is the default.

*CURLIBSpecifies that the current library will be used as the server library.

work-library-nameSpecifies the name of the library to use as the server work library. You can useany valid library name, but if the library does not exist or you do not haveauthority to create objects in the library, the command fails.

Usage Notes1. When you issue this command, it is submitted to batch for processing. TSM

generates a message indicating when the command starts processing and when thecommand completes processing. If the CSLMSGQ parameter of theCHGSVRADSM command has been specified, information about the load will bedisplayed in the message queue specified. The information can also be found inyour spool files if the CSLOUT parameter is set to *ON on the CHGSVRADSMcommand.

LODADSM


2. Before you issue the LODADSM command, save your current sequential volumehistory to a file for future reference. The LODADSM process will cause thesequential volume history information to regress.

3. If, since the dump of the database you are reloading, there were activities thatinvolve the storage pool volumes, audit the volumes via the AUDIT VOLUMEcommand. You should issue the AUDIT VOLUME command against all of your diskvolumes. The volume history information that you saved earlier can help you identifywhich sequential volumes need to be audited. You should audit all volumes thathave been reused since the time of the original dump of the database. Any volumesthat were deleted from TSM are also recorded in the sequential volume historyinformation. If these volumes can still be obtained, you can try auditing thesevolumes. If these volumes cannot be obtained, you should delete references tothese volumes in the database using the DELETE VOLUME command with theDISCARDDATA=YES option.

Examples

Task

Load the database from the previously dumped database.

In this example, the following steps are required:

1. Locate the file with the most recent sequential volume history information. Copy thisfile to another file so it can be referred to later and will not be overwritten when yourestart TSM after you reload the database.

2. Re-initialize the database and log.

3. Ensure that the DEVCFGFILE parameter has been specified in the CHGSVRADSMcommand. The device configuration file specified with this option must exist andmust contain the device class, library, and drive definitions needed for the loadoperation.

4. Load the TSM dumped database from a device associated with the device class8MMTAPE. The database is on volumes QANR.DMP(D00001) andQANR.DMP(D00002).

Command:

LODADSM DEVCLASS(8MMTAPE) VOL('QANR.DMP(D00001)' 'QANR.DMP(D00002)')

LODADSM


STRAUDADSM (Start Audit of TSM Database)

Use this command to audit the TSM database to ensure that it is returned to aconsistent state after it is reloaded using the LODADSM command. You must issue thiscommand before you start the server. No other server activity is allowed duringSTRAUDADSM command processing.

When you issue this command, it is submitted to batch for processing. TSM generatesa messages indicating the when command processing starts and ends. If theCSLMSGQ parameter of the CHGSVRADSM command has been specified, informationabout the audit is displayed in the message queue specified. The information can alsobe found in your spool files if the CSLOUT parameter is set to *ON using theCHGSVRADSM command. For more information about these parameters, see theCHGSVRADSM command under “Miscellaneous Server Utilities” on page 824.

If, before TSM server reinstallation, STANDARD policy objects were deleted, messagesare issued during the STRAUDADSM command processing to indicate that an instancecount does not agree with actual data. You can delete the STANDARD policy objects.However, they are all restored during the reinstallation. The STRAUDADSM commanddoes not delete the STANDARD policy objects. However, it does synchronize theinstance count to include the restored STANDARD policy objects.

Syntax


ÊÊ(1)

STRAUDADSMQUSRADSM


Ê

Ê*NO

FIX( *YES )*NO

DETAIL( *YES )

Ê

Ê*ALL

TYPE( *ADMIN )*STORAGE*INVENTORY*DRM*ARCHSTORAGE*BACKSTORAGEname

*NORMALLOGMODE( *ROLLFWD )

ÊÍ

Notes:


STRAUDADSM


ParametersWRKLIB

Specifies the server work library for the TSM server. If multiple instances of theTSM server are going to be run, each server will need its own work library. Thesame library should be used to initialize, start, and end the server.

The values are:

QUSRADSMSpecifies that library QUSRADSM will be used as the server work library.


work-library-nameSpecifies the name of the sever work library. You can specify any valid libraryname, but if the library does not exist or you do not have authority to createobjects in the library, the command fails.

FIXSpecifies how TSM resolves any inconsistencies in the database. This parameter isoptional. The default value is *NO.

The values are:

*NOSpecifies that TSM reports, but does not fix, any logical inconsistencies found.

If the audit finds inconsistencies when the command is run with FIX(*NO),before making the server available for production work, you must re-issue thecommand specifying FIX(*YES).

Since the STRAUDADSM command must be run with FIX(*YES) to recoverthe database, this is the recommended usage in a recovery situation. SpecifyFIX(*YES) the first time.

*YESSpecifies that TSM fixes any inconsistencies and issues messages indicatingthe corrective actions.

DETAILSpecifies whether audit processing should verify all database information in everydatabase record or whether audit processing should skip trivial audits to improveaudit performance slightly. This parameter is optional. The default value is *NO.

The values are:

*NOSpecifies that TSM skips trivial audits. Some verification will still occur on eachdatabase record, but not all fields in each record will be checked. Thisprovides a small performance improvement during audit processing.

*YESSpecifies that TSM audits all fields in the database.

STRAUDADSM


TYPESpecifies whether a full audit should be performed or whether a subset should beperformed. The values are:

*ALLSpecifies that you want TSM to perform the full audit.

*ADMINSpecifies that you want TSM to audit administrative information.

*STORAGESpecifies that you want TSM to audit all storage information.

*INVENTORYSpecifies that you want TSM to audit inventory information.

*DRMSpecifies that you want TSM to audit TSM Disaster Recovery Manager (DRM)information.

*ARCHSTORAGESpecifies that you want TSM to audit archive storage information.

*BACKSTORAGESpecifies that you want TSM to audit backup storage information.

nameAllows for future audit options

LOGMODESpecifies the log mode on the audit. The values are:

*NORMALSpecifies that the log mode is normal.

*ROLLFWDSpecifies the log mode is roll forward.

Examples

Task

Audit the TSM database and specify that TSM fix any inconsistencies found.

Command:STRAUDADSM FIX(*YES)

STRAUDADSM


CRTVOLADSM (Formatting a Physical File Member for the Server)

This command creates and formats a physical file member for use as an TSM volume.After the file is defined and formatted, you must define it to TSM with the DEFINEVOLUME, DEFINE LOGVOLUME, or DEFINE DBVOLUME command.

Note: Do not use this command to create and format the volumes to be used by adevice class with a device type of FILE. Those volumes are createdautomatically.

Syntax


ÊÊ CRTVOLADSM(1)

*FILEVOLTYPE( *STMF )

ÊÍ

*FILE Details:

·QUSRADSM/ *FILE 12 *NO (2)

VOL( file-name member-name member-size *YES )*CURLIB/library-name/

*STMF Details:

·25 *NO (3) (4)

VOLSTMF( volume-name volume-size *YES )

Notes:





ParametersVOLTYPE

Specifies how the volumes are specified. The options are:

*FILESpecifies that each volume is a member of a physical file.

CRTVOLADSM


||

||

*STMFSpecifies that each volume name is the path name of a stream file.

VOLSpecifies the name of the volumes to be formatted for the server. This includes thename of the file and the library where the file is to be located. This parameter isrequired only if you specify VOLTYPE(*FILE)

Element 1: Volume File NameThe database volume file can be qualified by using one of the following libraryvalues:

QUSRADSMSpecifies that the volume is created and formatted in the default libraryQUSRADSM. *QUSRADSM is the default.



library-nameSpecifies the name of the library where the file is to be created.

file-nameSpecifies the name of the file.




Element 3: Member sizeSpecifies the size of the file to be formatted in megabytes (for example, 5indicates 5MB, 12 indicates 12MB). If the file is to be used as a storage poolvolume, it can be of any size. If the file is to be used as a recovery log ordatabase volume, the size must be a multiple of 4MB plus 1MB for overhead.For example, to specify 8MB, enter 9MB. To specify 12MB, enter 13MB.


*NOSpecifies to not replace the specified physical file member if it alreadyexists. *NO is the default.

Note: If the member already exists and you specify *NO, CRTVOLADSMfails.

CRTVOLADSM


||

||||

|||

|||

||

|||

||

||

||

|||

||

||||||

|||

|||

||

*YESSpecifies to replace the specified file member if it alreadyexists.Attention: Specifies *YES only if you want to delete all serveractivity todate and start without any record or data of previous serveractions.

VOLSTMFSpecifies the name of the volumes to be formatted for the server. The volumename is specified as the path name of a stream file. This parameter is requiredonly if you specify VOLTYPE(*STMF)

Element 1: Volume Stream FileSpecifies the volume as the path name of a stream file.


Element 2: Volume sizeSpecifies the size of the file to be formatted in megabytes (for example, 5indicates 5MB, 12 indicates 12MB). If the file is to be used as a storage poolvolume, it can be of any size. If the file is to be used as a recovery log ordatabase volume, the size must be a multiple of 4MB plus 1MB for overhead.For example, to specify 8MB, enter 9MB. To specify 12MB, enter 13MB.


*NOSpecifies to not replace the specified stream file if it already exists. *NO isthe default.

Note: If the stream file already exists and you specify *NO,CRTVOLADSM fails.

*YESSpecifies to replace the specified stream file if it already exists.Attention: Specifies *YES only if you want to delete all server activitytodate and start without any record or data of previous server actions.

Examples

Task 1

Format a new 12MB disk storage pool file named QUSRADSM/ATF001(ATF001).

Command:CRTVOLADSM VOL(ATF001 *FILE 12)

Task 2

Format a new 40MB database volume named QUSRADSM/DB01(DB01).

CRTVOLADSM


|||||

||||

||

||

||||||

|||

|||

||

||||

|

Command:CRTVOLADSM VOL(DB01 *FILE 41)

CRTVOLADSM


STRSVRADSM (Start Server)

Use this command to start the TSM server.

Note: By adding this command to your system startup program, you can have the TSMserver automatically started when the system is IPLed.

Syntax


ÊÊ(1)

STRSVRADSMQUSRADSM


Ê

Ê*NORMAL

SVRMODE( *PRPWEB )*SERVICE*RUNFILE

ÊÍ

*NORMAL Details:

*NORESET( *YES )

*YESEXPIRE( *NO )

*SERVICE Details:

*FILEVOLTYPE( *STMF )

*RUNFILE Details:

QADSM/ QAANRSMP SCRIPTSRUNFILE( )

library-name/ file-name member-name

*FILE Details:

STRSVRADSM


*WRKLIB/ *FILELOGVOL( file-name extend-log-size )

library-name/ member-name

*STMF Details:

LOGSTMF( volume-name extend-log-size )

Notes:


ParametersWRKLIB (Required)

Specifies the TSM server work library. If multiple instances of the TSM server aregoing to be run, each server requires its own work library. Use the same worklibrary to initialize, start, and end server operations. QUSRADSM is the default. Thevalues are:

QUSRADSMSpecifies that the QUSRADSM library will be used as the work library.

*CURLIBSpecifies the current library will be used as the work library.

work-library-nameSpecifies the name of the server work library. You can use any valid libraryname. If the library does not exist or you do not have authority to createobjects in the library, the command fails.

SVRMODESpecifies the server mode in which to start the server. The values are:

*NORMALSpecifies that the server should be started in normal mode. This allows normalTSM operations.

*PRPWEBSpecifies that the server database will be upgraded to permit administration ofthe server by web browsers. In this mode the server will start, perform thedatabase upgrade, and then stop.

*SERVICESpecifies that you want to start the server in service mode. In this mode, thelog can be extended. The server will start, extend the log, and then stop.

*RUNFILESpecifies that you want to start the server in run file mode. In this mode, theserver will start, perform the operations that are contained in the given file, andthen stop.

STRSVRADSM


||||

RUNFILESpecifies the file to be run by the server.

Element 1: File name

library-nameSpecifies the library name, the default is QADSM.

file-nameSpecifies the file name, the default is QAANRSMP.

Element 2: Member nameSpecifies the member name, the default is SCRIPTS.

RESETSpecifies whether the default administrator ID (ADSMADMIN) and password(ADSMADMIN) should be reset to the original shipped values. *NO is the default.The values are:

*NOSpecifies that no change will occur to the ADSMADMIN ID.

*YESSpecifies that ADSMADMIN will be reset to its original shipped values.

EXPIRESpecifies whether the inventory expiration should be disabled. Specifying theSVRPARM parameter of the CHGSVRADSM command can disable expiration.*YES is the default. For more information, see the CHGSVRADSM commanddescribed under “Miscellaneous Server Utilities” on page 824.

The values are:

*YESSpecifies that inventory expiration is enabled and expiration processing is runwhen the server is started.

*NOSpecifies that inventory expiration is disabled and expiration processing is notrun when the server is started.

VOLTYPESpecifies how the volumes are specified. The options are:

*FILESpecifies that each volume is a member of a physical file.

*STMFSpecifies that each volume name is the path name of a stream file.

LOGVOLSpecifies that an additional recovery log volume is specified so that the server canbe started with enough recovery log space to initialize and perform the neededdatabase backup.

Note: To specify this parameter, you must set SVRMODE to *SERVICE.

STRSVRADSM


||

|

||

||

||

|

||

||

||

|

When running the server with the log mode set to ROLLFORWARD, the servercould run out of recovery log space before database backup operations arecomplete. This usually results from a recovery log that is too small or a databasebackup trigger set so that the database backup log full percentage is too high.

When the recovery log is overcommitted in this manner, you may not be able tostart the server for normal operation. Additional recovery log space is required tostart the server and perform a database backup so that log space can be freed.

Element 1: Log file nameUse one of the following library values to qualify the recovery log file name:

*WRKLIBSpecifies that the log volume file will be located in the server work library.

library-nameSpecifies the name of the library where the log volume file will be located.You can use any valid library name. If the library does not exist or you donot have authority to create objects in the library, the command fails.

file-nameSpecifies the name of a new, formatted log volume to be used for theextension. The volume should have been created and formatted using theCRTVOLADSM command, and the size specified on the CRTVOLADSMcommand should be an increment of 4 plus 1. If no extension is to take place,specify *NOEXTEND as the file name.

Element 2: Log sizeSpecifies the size, in megabytes, that the recovery log should be extended.This specification should be a multiple of 4 and should be at least 1 megabyteless than the size of the volume formatted with the CRTVOLADSM command.

Element 3: Log member nameSpecifies the name of log volume member. The values are:

*FILESpecifies the member name is the same as the file name.


LOGSTMFSpecifies that an additional recovery log volume is specified so that the server canbe started with enough recovery log space to initialize and perform the neededdatabase backup.

Note: To specify this parameter, you must set SVRMODE to *SERVICE.

When running the server with the log mode set to ROLLFORWARD, the servercould run out of recovery log space before database backup operations arecomplete. This usually results from a recovery log that is too small or a databasebackup trigger set so that the database backup log full percentage is too high.

STRSVRADSM


When the recovery log is overcommitted in this manner, you may not be able tostart the server for normal operation. Additional recovery log space is required tostart the server and perform a database backup so that log space can be freed.

Element 1: Volume-nameSpecifies the formatted volume as the path name of a stream file.

Element 2: Extend-log sizeSpecifies the size, in megabytes, that the recovery log should be extended.This specification should be a multiple of 4 and should be at least 1 megabyteless than the size of the volume formatted with the CRTVOLADSM command.

Examples

Task

Start the server and turn expiration off.

Command:STRSVRADSM SVRMODE(*NORMAL) EXPIRE(*NO)

STRSVRADSM


VFYSVRADSM (Verify Server Status)

Use the VFYSVRADSM command to check the status of the server for TSM. Amessage is displayed at the bottom of your screen indicating whether the server isrunning, initializing, halting, or stopped.

Syntax

Job: I Pgm: I REXX: I Exec

ÊÊ VFYSVRADSM(1) QUSRADSM

WRKLIB( *CURLIB )work-library

ÊÍ

Notes:


ParametersWRKLIB

Specifies the server work library of the TSM server.

The values are:

QUSRADSMSpecifies that QUSRADSM will be used as the work library.


work-librarySpecifies the name of the work library. You can specify any valid library name,but if the library does not exist or you do not have authority to create objects inthe library, the command fails. You can specify up to 10 characters for thelibrary name.

Examples

Task

Determine the status of the TSM server running out of library QUSRADSM.

Command:VFYSVRADSM WRKLIB(QUSRADSM)

VFYSVRADSM


WRKDEVADSM (Work with Devices)

Use the WRKDEVADSM command to help you define devices to TSM. When you issuethis command, a screen similar to Figure 1 on page 864 is displayed. You can use thiscommand to help you:

v Define libraries and drives

v Define device classes

v Define storage pools

v Define and change the primary storage pool hierarchy

After you have customized these definitions, they are submitted to TSM. For detailsabout using this command, see Administrator’s Guide

Note: The server must be running when this command is issued or the command fails.

Syntax

Job: I Pgm: I REXX: I Exec

ÊÊ WRKDEVADSM ADMINNAME( administrator-name )(1)

PASSWORD( password ) Ê

ÊQUSRADSM


Ê

Ê*WRKLIB/ MACROS

MACOUTF( macro-output-file-name )*CURLIB/library-name/

Ê

ÊDEVCFG

MACOUTMBR( *FILE )macro-output-member-name

ÊÍ

Notes:


ParametersADMINNAME(administrator-name)

Specifies the name of the administrator. This parameter is required.

WRKDEVADSM


PASSWORD(password)Specifies the password of the administrator. This parameter is required.

WRKLIBSpecifies the working library of the server. This parameter is optional.

The values are:

QUSRADSMSpecifies the working library to be used for setting up devices. QUSRADSM isthe default.

*CURLIBSpecifies that the current library will be used for setting up devices.

work-library-nameSpecifies the name of the library to be used for setting up devices. If the librarydoes not exist or you do not have authority to create objects in the library, thecommand fails.

MACOUTFSpecifies the macro output file that contains one or more administrative commandswith objects to be defined or updated by TSM. This file is then sent to the server tobe run. This parameter is optional.

The values are:

MACROSSpecifies that the default output file MACROS will contain the macro commandoutput.

The macro output file can be qualified by using one of the following libraryvalues:

*WRKLIBSpecified that the macro output file will be located in the server worklibrary.

*CURLIBSpecifies that the macro output file will be located in the current library.

library-nameSpecifies the name of the library where the macro output file will belocated. If the library does not exist or you do not have authority to createobjects in the library, the command fails.

macro-output-file-nameSpecifies the name of the macro output file that will contain the macrocommand output. If the file does not exist or the file cannot be opened, thecommand fails.

MACOUTMBRSpecifies the macro output member into which one or more administrativecommands are written. The values are:

WRKDEVADSM


DEVCFGSpecifies that the output member DEVCFG in the specified macro outputfile will contain macro output. DEVCFG is the default.

*FILESpecifies that the name of the macro output file member is the same asthe file name.

macro-output-member-nameSpecifies the name of the macro output member into which administrativecommands are written.

Examples

Task

Administrator MIKE, whose administrative client password is QUARK, wants to define atape device to TSM.

Command:WRKDEVADSM ADMIN(MIKE) PASSWORD (QUARK)

Output:

Macro output file . . MACROS___Library . . . . . . QUSRADSM__

Macro output member DEVCFG__

Type options, press Enter.2=Change 5=Display

Opt Storage Hierarchy Type StatusARCHIVEPOOL STGPOOL DEFINEDBACKUPPOOL STGPOOL DEFINEDSPACEMGPOOL STGPOOL DEFINEDCART_TAPEPOOL1 STGPOOL NEW

CART_TAPECLASS1 DEVCLASS NEWMANLIB LIBRARY NEW

TAP03 DRIVE NEWTAP04 DRIVE NEW

BottomF3=Exit F5=Refresh F8=Submit to server F9=CommandF10=Work with libraries F11=Work with storage pools F12=Cancel

Figure 1. Work with Devices Screen

WRKDEVADSM


CHGADMADSM (Change Administrative Client Options)

Use this command to change your TSM adminstrative client options.

Syntax


ÊÊ CHGADMADSM(1) (2)


work-library-name

Ê

Ê*SAME

CSI( CSI-object-name )*SAME

CMNMTH( *SNA )*IP

Ê

Ê*SAME

TCPPORT( port-address )*NONE

RMTLOCNAME( )

Ê

Ê*SAME *SAME *SAME *SAME(3) (4) (5) (6) *SAME

DSPPARM( number-format )ENU *MDY ’/’ ’ :’ENP *YMD ’-’ ’ ,’ESP *DMY ’.’ ’ .’

’12HR’

ÊÍ

Notes:


2 All parameters preceding this point are key parameters.

3 Language

4 Date format

5 Date separator

6 Time format


Specifies the TSM server work library. If multiple instances of the TSM server areto be run, each server requires its own work library. The same library should beused to initialize, start, and end the server. QUSRADSM is the default.

The values are:

CHGADMADSM


QUSRADSMSpecifies that library QUSRADSM is used as the server work library.

*CURLIBSpecifies that the current library is used as the server work library.

library-nameSpecifies the name of the library to use as the work library. You can specifyany valid library name, but if the library does not exist or you do not haveauthority to create objects in the library, the command fails.

CMNMTHSpecifies the communication method (CMNMTH) that provides connectivity forclient/server communication. *SNA is the default. This parameter is optional.

The values are:

*SAMESpecifies that the communication method specified when this command waspreviously issued does not change.

*SNASpecifies the Systems Network Architecture (SNA) logical unit 6.2 (LU6.2)communication method.

*IP Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP)communication method. A remote location is required when *IP is specified.

CSISpecifies the name of the side information object (*CSI) that contains theinformation needed to communicate with the TSM server through APPC. Thisparameter is optional.

The values are:

*SAMESpecifies that the name specified when this command was previously issueddoes not change.

side-information-file-nameSpecifies the side information file that contains the transaction program name,the mode, and the remote location used to communicate with the server.Specify QANRCSI as the side information file if you are using the defaultserver with the work library, QUSRADSM.

TCPPORTSpecifies the server’s TCP/IP port address. Obtain the port address from your TSMadministrator.

The values are:

*SAMESpecifies that the TCP/IP port address specified when this command waspreviously issued does not change.

CHGADMADSM


port-addressSpecifies the TCP/IP server port address. The default is 1500. You can specifya value from 1024 through 32767.

RMTLOCNAMESpecifies the TCP/IP address for a TSM server. Obtain this server address fromyour TSM administrator. *NONE is the default. The values are:

*SAMESpecifies that the TCP/IP address for an TSM server used when this commandwas previously issued does not change.

*NONESpecifies that the TCP/IP address is not specified.

remote-locationSpecifies the TCP/IP address for a TSM server. It can be a TCP/IP internetdomain name or a dot address. The internet address is specified in the form,nnn.nnn.nnn.nnn, where nnn is a decimal number from 0 through 255. If theinternet address is entered from a command line, the address must be inapostrophes. A value for remote location needs to be specified when *IP isused as the communication method.

DSPPARMSpecifies how information is displayed to the administrative client. Language, dateformat, time format, and number formats can be controlled. This parameter isoptional.

The options are:

Element 1: LanguageSpecifies the language in which messages are displayed.

The values are:

*SAMESpecifies that the language value that was specified when this commandwas previously issued, does not change.

language-valueSpecifies the language used to present server messages. The default isENU. The values are:

ENU United States English

ENP Upper case English

ESP Spanish

Element 2: Date formatSpecifies the format for displaying the date.

The values are:

*SAMESpecifies that the date format value that was specified when thiscommand was previously issued, does not change.

CHGADMADSM


date-format-valueSpecifies the value for the displaying the date.

The values are:

*MDY Specifies that the format for displaying dates is month, day, year(MDY).

*YMD Specifies that the format for displaying dates is year, month, day(YMD).

*DMY Specifies that the format for displaying dates is day, month, year(DMY).

Element 3: Date separatorSpecifies the separator to be used when displaying the date.

The values are:

*SAMESpecifies that the date separator value that was specified when thiscommand was previously issued, does not change.

date-separator-valueSpecifies the value for the date separator to be used when displaying thedate.

The values are:

’/’ Specifies that a slash (/) is used for the date separator. Thisvalue is valid only if the date format is specified as *MDY.

’-’ Specifies that a dash (-) is used for the date separator. This valueis valid only if the date format is specified as *DMY or *YMD.

’.’ Specifies that a period (.) is used for the date separator. Thisvalue is valid only if the date format is specified as *DMY or*YMD.

Element 4: Time formatSpecifies the format for displaying the time.

The values are:

*SAMESpecifies that the time format value that was specified when thiscommand was previously issued, does not change.

time-format-valueSpecifies the value used for displaying the time.

The values are:

’:’ Specifies that a colon (:) is used for the time separator.

’,’ Specifies that a comma (,) is used for the time separator.

’.’ Specifies that a period (.) is used for the time separator.

CHGADMADSM


’12HR’ Specifies that time is displayed in a 12-hour clock format withAM/PM.

Element 5: Number formatSpecifies the format for displaying the numbers.

The values are:

*SAMESpecifies that the number format value that was specified when thiscommand was previously issued, does not change.

number-format-valueSpecifies the format by which numbers are displayed by the server. Youcan select a value from 1–6 to identify the format. The default is 1.

1 = 1,000.00

2 = 1,000,00

3 = 1000,00

4 = 1000.00

5 = 1.000,00

6 = 1’000,00

Examples

Task

From the command line, change the side information file to QANRCSI.

Command:CHGADMADSM WRKLIB(QUSRADSM) CSI(QANRCSI)

This command changes the side information file for the administrative client toQANRCSI.

Figure 2 on page 870 shows the screen used to change your administrative clientoptions.

CHGADMADSM


Server working library . . . . . QUSRADSM Name, *CURLIBCommunication side information QANRCSI Name, *SAMECommunication method . . . . . . *IP Name, *SAME, *SNA, *IPTCP/IP port. . . . . . . . . . . 1500 1024-32767, *SAMERemote location. . . . . . . . . 9.115.44.239

Display parameters:Language . . . . . . . . . . . ENU *SAME, ENU, ENP, ESPDate format . . . . . . . . . *MDY *SAME, *MDY, *YMD, *DMYDate separator . . . . . . . . '/' *SAME, /, -, .Time format . . . . . . . . . ':' *SAME, :, ,, ., 12HRNumber format . . . . . . . . 1 1-6, *SAME

Figure 2. Client Option Screen

CHGADMADSM


CHGSVRADSM (Change Server Options for ADSM)

Use the change server options command to customize the TSM server. These optionsinclude:

v License terms

v Client and server communication protocols

v Client connection parameters

v Server processing parameters

v Console output and message queue

v Server display parameters

v Database and recovery log parameters

v Volume history and device configuration

v Event logging to file, user exits, or Tivoli

If you change any server options, you must stop and start the server before thechanges take effect.

If a server option is added through the service stream, it may not be immediatelyavailable on the CHGSVRADSM command. In such a case, you can use the newoption by manually editing the server options file, WRKLIB/QOPTADSM(OPTIONS). Forexample, you can use the DISABLESCHEDS option in this way. This option specifieswhether or not administrative and client schedules are disabled during an TSM serverrecovery scenario. The option would be on of the following:

disablescheds yes

or

disablescheds no

Where:

v yes specifies that the schedule manager is disabled.

v no specifies that the schedule manager is enabled.

Syntax


ÊÊ CHGSVRADSM(1) (2)


work-library-name

Ê

CHGSVRADSM


ÊLIC( LIC Details )

Ê

Ê*SAME *SAME(3) *SAME *SAME (4)

TCP( TCP/IP-port TCP/IP-buffer-size )*YES *YES*NO *NO

Ê

Ê*SAME(5) *SAME

APPC( SNA-buffer-size )*YES*NO

Ê

Ê*SAME(6) *SAME *SAME

IPX( IPX-socket-number IPX-buffer-size )*YES*NO

Ê

Ê*SAME(7) *SAME

HTTP( HTTP-port )*YES*NO

ÊÍ

Notes:


2 All parameters preceding this point are key parameters.

3 Enable TCP/IP

4 TCP/IP no delay

5 Enable APPC

6 Enable IPX

7 Enable HTTP

ÊÊ*SAME *SAME *SAME

CLTCNN( communication-timeout idle-timeout maximum-client-sessions )

Ê

CHGSVRADSM


ÊSVRPARM( SVRPARM Details ) *SAME

CSLOUT( *NONE )*ON*OFF

Ê

Ê*SAME

CSLMSGQ( *NONE )*WRKLIB/

console-output-message-queue-name*LIBL/library-name/

Ê

Ê*SAME

MNTMSGQ( *NONE )*WRKLIB/

mount-message-queue-name*LIBL/library-name/

Ê

ÊDSPPARM( DSPPARM Details )

Ê

Ê*SAME *SAME

*SAMEDBPARM( buffer-pool-size )

(1) (2)

*NORMAL *SEQUENTIAL*VERIFY *PARALLEL

Ê

Ê*SAME *SAME

*SAME (1) (2)RCYLOGPARM( log-pool-size )

*NORMAL *SEQUENTIAL*VERIFY *PARALLEL

Ê

Ê

·

*SAMEVOLHSTFILE( *NONE )

*WRKLIB/ *FILE (3)volume-history-file-name member-name

library-name/

Ê

Ê

·

*SAMEDEVCFGFILE( *NONE )

*WRKLIB/ *FILE (3)device-configuration-file-name member-name

library-name/

ÊÍ

Notes:

1 Mirror read

2 Mirror write


CHGSVRADSM


ÊÊ

·

*SAME (2)(1) *SAME *SAME

EVTLOGFILE( *NONE *APPEND )*YES *REPLACE*NO *WRKLIB/ *FILE

file-name member-namelibrary-name/

Ê

Ê

·

*SAME(3) *SAME

EVTLOGPGM( *NONE )*YES*NONE *WRKLIB/ (3)

exit-program-namelibrary-name/

Ê

Ê*SAME(4) *SAME (5)

EVTLOGTEC( *NONE )*YES *SEARCH *NONE*NO port-number

ÊÍ

LIC Details:

*SAMElicensed-clients

*SAME(6)

*YES*NO

*SAME(7)

*YES*NO

*SAME(8)

*YES*NO

*SAME(9)

*YES*NO

*SAME(10)

*YES*NO

SVRPARM Details:

*SAMEmount-message-interval

*SAMEexpiration-interval

*SAMErestore-interval Ê

Ê*SAMEmaximum-transaction-group-size

*SAMEstatus-message-count

*SAMEmove-batch-size Ê

Ê*SAMEmove-size-threshold

*SAMEjob-pool-size

*SAMEmaximum-increments Ê

Ê

(11)*SAME*YES*NO

(12)*SAME*YES*NO

(13)*SAME*YES*NO

Notes:

1 Enable logging to file

CHGSVRADSM


2 Event file mode

3 Enable logging to a user exit

4 Enable logging to Tivoli

5 Remote location

6 MVS Open Edition clients

7 Space management

8 Server-to-server virtual volumes

9 Disaster Recovery Manager

10 Enterprise Administration

11 Use larger buffers

12 Limit expiration messages

13 Storage audit

DSPPARM Details:

*SAME(1)

ENUENPESP

*SAME(2)

*MDY*YMD*DMY

*SAME(3)

’/’’-’’.’

*SAME(4)

’:’’,’’.’’12HR’

*SAMEnumber-format Ê

Ê*SAMEmessage-format

Notes:

1 Language

2 Date format

3 Date separator

4 Time format


Specifies the server work library of the TSM server. If multiple instances of theTSM server are going to be run, each server requires its own work library. Thesame library should be used to initialize, start, and end the server. QUSRADSM isthe default. The values are:

QUSRADSMSpecifies that library QUSRADSM will be used as the server work library.

CHGSVRADSM



work-library-nameSpecifies the name of the library to be used as the work library. You canspecify any valid library name, but if the library does not exist or you do nothave authority to create objects in the library, the command fails.

LICSpecifies the license terms. This parameter is optional.

The options are:

Element 1: Number of licensed clientsSpecifies the number of clients that are licensed to use the server. The valuesare:

*SAMESpecifies that the number of licensed clients specified when this commandwas previously issued does not change.

licensed-clientsSpecifies the number of licensed clients. The default is 1.

Element 2: OpenSystems Environment clientsSpecifies whether OpenSystems Environment clients are licensed to use theserver. The values are:

*SAMESpecifies that the value specified when this command was previouslyissued does not change.

*YESSpecifies that OpenSystems Environment clients are licensed to use theserver.

*NOSpecifies that OpenSystems Environment clients are not licensed to usethe server.

Element 3: Space managementSpecifies whether the server is licensed for the space management feature ofTSM. The values are:


*YESSpecifies that the server is licensed to use the space managementfeature.

*NOSpecifies that the server is not licensed to use the space managementfeature.

CHGSVRADSM


Element 4: Server-to-serverSpecifies that the server is licensed for the server-to-server virtual volumefeature. The values are:


*YESSpecifies that the server is licensed to use the server-to-server virtualvolume feature.

*NOSpecifies that the server is not licensed to use the server-to-server virtualvolume feature.

Element 5: Disaster Recovery ManagerSpecifies that the server is licensed for the Disaster Recovery Manager (DRM).The values are:


*YESSpecifies that the server is licensed to use the Disaster RecoveryManager feature.

*NOSpecifies that the server is not licensed to use the Disaster RecoveryManager feature.

Element 6: Enterprise AdministrationSpecifies that the server is licensed for Enterprise Administration. The valuesare:


*YESSpecifies that the server is licensed to use the Enterprise Administrationfeature.

*NOSpecifies that the server is not licensed to use the EnterpriseAdministration feature.

TCPSpecifies whether to use TCP/IP as one of the TSM client/server communicationprotocols. If a communication protocol is not specified, the default is APPC. Theoptions are:

Element 1: Enable TCP/IPSpecifies whether TCP/IP is enabled. The values are:

CHGSVRADSM


|||

|||

|||

|||

|

*SAMESpecifies that the communication protocol specified when this commandwas previously issued does not change.

*YESSpecifies that TCP/IP is used as one of the TSM client/servercommunication protocols.

*NOSpecifies that TCP/IP is not used as one of the TSM client/servercommunication protocols.

Element 2: TCP/IP portSpecifies the TCP/IP server port address. The values are:

*SAMESpecifies that the port-address value specified when this command waspreviously issued does not change.

TCP/IP-portSpecifies the TCP/IP server port address. The default is 1500. You canspecify a value from 1024–32767.

Element 3: TPC/IP buffer sizeSpecifies the size of the TCP/IP send and receive buffers. The values are:

*SAMESpecifies that the TCP/IP buffer size specified when this command waspreviously issued does not change.

TCP/IP-buffer-size:Specifies the size of the TCP/IP send and receive buffers in kilobytes. Thedefault is 32. You can specify a value from 1 to 256.

Element 4: TCP/IP no delaySpecifies whether the TSM server should send small amounts of data or allowTCP/IP to buffer the data. Disallowing buffering may improve throughput at theexpense of more packets being sent over the network. The values are:

*SAMESpecifies that this parameter does not change from its current value.

*YESSpecifies that TCP/IP does not buffer small TSM messages. This is thedefault.

*NOSpecifies that TCP/IP does buffer small TSM messages.

APPCSpecifies whether to use APPC as one of the TSM client/server communicationprotocols. If a communication protocol is not specified, the default is APPC. Thisparameter is optional.

The options are:

CHGSVRADSM


Element 1: Enable APPCSpecifies whether APPC is enabled. The values are:


*YESSpecifies that APPC is used as one of the TSM client/servercommunication protocols.

*NOSpecifies that APPC is not used as one of the TSM client/servercommunication protocols.

Element 2: SNA buffer sizeSpecifies the size of the APPC send and receive buffers. The values are:

*SAMESpecifies that the SNA buffer size specified when this command waspreviously issued does not change.

SNA-buffer-sizeSpecifies the size of APPC send and receive buffers in kilobytes. Thedefault is 15 kilobytes. You can specify a value from 1–31 kilobytes.

IPXSpecifies whether to use IPX as one of the TSM client/server communicationprotocols. If no communication protocol is specified, the default is APPC. Thisparameter is optional. The values are:

Element 1: Enable IPXSpecifies whether IPX is enabled. The values are:


*YESSpecifies that IPX is used as one of the TSM client/server communicationprotocols.

*NOSpecifies that IPX is not used as one of the TSM client/servercommunication protocols.

Element 2: IPX socket numberSpecifies the socket number of the TSM server. The values are:

*SAMESpecifies that the number specified when this command was previouslyissued does not change.

IPX-socket-numberSpecifies the IPX socket number. The default is 8522. You can specify avalue from 0001–FFFF.

CHGSVRADSM


Element 3: IPX buffer sizeSpecifies the size of the IPX send and receive buffers. The values are:

*SAMESpecifies that the IPX buffer size specified when this command waspreviously issued does not change.

IPX-buffer-sizeSpecifies the size of the IPX send and receive buffers in kilobytes. Thedefault is 32 kilobytes. You can specify a value from 1–256 kilobytes.

HTTPSpecifies whether to use the administrative client web interface communicationprotocol. The administrative client web interface lets you access TSM serverfunctions from any workstation with a web browser that supports HTML 2.0 orhigher. This parameter is optional.

This communication protocol supports only the administrative client web interface.Other TSM clients cannot use this communication protocol to contact the TSMserver.

Element 1: Enable HTTPSpecifies whether HTTP is enabled. The values are:


*YESSpecifies that HTTP is used as one of the TSM client/servercommunication protocols.

*NOSpecifies that HTTP is not used as one of the TSM client/servercommunication protocols.

Element 2: HTTP portSpecifies the port number for the HTTP communication method. The valuesare:


http-port-numberSpecifies the HTTP port. The default is 1580. Values range from 1024 to32767. This value cannot be the same as the TCP/IP port address.

CLTCNNSpecifies the parameters that control server and client connections. This parameteris optional.

The options are:

Element 1: Communication timeoutSpecifies the maximum number of seconds the server waits for an expectedmessage from a client, during a database update transaction, before ending

CHGSVRADSM


the session with the client. The server ends the session to releasecommunication resources as soon as possible, and to ensure that databaselocks are not held for undue periods of time. The values are:

*SAMESpecifies that the communication-timeout value specified when thiscommand was previously issued does not change.

communication-timeoutSpecifies the maximum number of seconds the server waits for anexpected message from a client. The default is 60 seconds. You canspecify a value from 1–2147483647 seconds.

Element 2: Idle timeoutSpecifies the amount of time, in minutes, that a server waits while a client isexpected to, but does not, initiate communication. The values are:

*SAMESpecifies that the idle-timeout value specified when this command waspreviously issued does not change.

idle-timeoutSpecifies the amount of time, in minutes, that a server waits while a clientdoes not initiate communication. The default is 15 minutes. You canspecify a value from 1–2147483647 minutes.

Element 3: Maximum client sessionsSpecifies the maximum number of client sessions that can be simultaneouslyconnected to the server. The values are:

*SAMESpecifies that the maximum client sessions specified when this commandwas previously issued does not change.

maximum-client-sessionsSpecifies the maximum number of client communications that can besimultaneously connected to the server. The default is 25 client sessions.You can specify a value from 2–2147483647. However, the maximumvalue is limited by the available virtual memory size of communicationresources.

SVRPARMSpecifies server processing information such as how quickly the server sends amessage to mount a tape to a tape operator, how often the server removes expiredcopies from the TSM database, how many files that will be transferred as a groupbetween commit points, and how many database records will be processedbetween status messages. This parameter is optional.

The options are:

Element 1: Mount message intervalSpecifies the time between each reminder message that the server generatesfor manual mount requests. The values are:

CHGSVRADSM


*SAMESpecifies that the time specified when this command was previouslyissued does not change.

mount-message-intervalSpecifies the time between each reminder message that the servergenerates for manual mount requests. The default is 1. You can specify avalue from 1–9999 minutes.

Element 2: Expiration intervalSpecifies the interval between automatic database inventory expirationprocessing. Inventory expiration processing removes client backup and archivefile copies from the server as specified by the management classes to whichthe client files are bound.

Periodically running expiration processing ensures efficient use of storageresources because expired copies are removed to reclaim storage pool spacefor additional client files. If the interval is set to 0, automatic expiration will notstart. Issuing the EXPIRE INVENTORY command is the only way to removeexpired files when the expiration interval is set to 0. The values are:


expiration-intervalSpecifies the interval, in hours, between automatic database inventoryexpiration processing sessions. The default is 24 hours. You can specify avalue from 0 (no expiration processing) to 336 hours (14 days).

Element 3: Restore intervalSpecifies how long a restartable restore can be saved in the TSM serverdatabase. As long as the restore is saved in the database, it can be restartedfrom the point at which it stopped. The values are:


restore-intervalSpecify the interval, in minutes, that a restartable session can reside in theserver database before it can be expired. The minimum value is 0. Themaximum is 10080 (one week). The default is 1440 minutes (24 hours). Ifthe value is set to 0 and the restore is interrupted or fails, the restore isstill put in the restartable state. However, it is immediately eligible to beexpired.

Element 4: Maximum transaction group sizeSpecifies the maximum number of files that will be transferred as a groupbetween a client and server before a commit occurs. You can improve theperformance of the backup-archive client BACKUP, ARCHIVE, RESTORE, andRETRIEVE commands by specifying a large value for this option.

The values are:

CHGSVRADSM



maximum-transaction-group-sizeSpecifies the maximum number of files that will be transferred as a groupbetween a client and a server between transaction commit points. Thedefault is 16 files. You can specify a value from 4–256 files.

Element 5: Status message countSpecifies the number of database records which will be processed betweenstatus messages. The values are:

*SAMESpecifies that the status message count specified when this commandwas previously issued does not change.

status-message-countSpecifies the number of database records that will be processed betweenstatus messages. The default is 10 records. You can specify a value from1–10000 records.

Element 6: Move batch sizeSpecifies the number of files that are moved and grouped together in a batchwithin the same server transaction. The values are:

*SAMESpecifies that the batch size specified when this command was previouslyissued does not change.

move-batch-sizeSpecifies the number of files that are to be moved and grouped togetherin a batch within the same server transaction. The default is 32 files. Youcan specify a value from 1–1000 files.

Element 7: Move size thresholdSpecifies the amount of data moved as a batch within the same servertransaction. The values are:

*SAMESpecifies that the move size threshold specified when this command waspreviously issued does not change.

move-size-thresholdSpecifies the threshold in megabytes for the amount of data moved as abatch within the same server transaction. The default is 1 megabyte. Youcan specify a value from 1–500 megabytes.

Element 8: Job pool sizeSpecifies the number of jobs to keep active and available for reuse. Thisparameter is optional. The values are:

*SAMESpecifies that the job pool size specified when this command waspreviously issued does not change.

CHGSVRADSM


job-pool-sizeSpecifies the number of jobs to keep active and available for reuse. Thedefault is 3.

Element 9: Maximum memory incrementsSpecifies the maximum number of memory increments to be used by theserver. Each memory increment lets the server use up to an additional 80megabytes of space. The server starts with the minimum amount of memoryrequired to perform basic operations and increases its memory use asnecessary. The values are:


maximum-increments-valueSpecifies the maximum number of memory increments for the server.Values range from 1 to 99. The default is one.

Element 10: Use large buffersSpecifies that large buffers are used for client/server communications. Thevalues are:


*YESSpecifies that large buffers are used. This is the default.

*NOSpecifies that large buffers are not used.

Element 11: Limit expiration messagesSpecifies whether TSM sends detailed messages during expiration processing.The values are:


*YESSpecifies that TSM sends only minimal messages. These messages aresent only for files that have expired based on the copy group in the defaultmanagement class or retention grace period for the domain.

*NOSpecifies that TSM sends detailed messages. This is the default.

Element 12: Storage AuditSpecifies that as part of the license audit operation, the server calculates, bynode, the amount of backup, archive, and space management storage in use.For servers managing large amounts of data, this calculation can take a greatdeal of CPU time and can stall other server activity. You can use this option tospecify that storage is not to be calculated as part of a license audit. Thevalues are:

CHGSVRADSM



*YESSpecifies that storage is calculated as part of the license audit. The defaultis *YES.

*NOSpecifies that storage is not calculated as part of the license audit.

CSLOUTSpecifies whether to route all of the console output to a single print file. Theinformation contained in this print file is similar to that in the activity log. The printfile cannot be viewed until the server is halted. The parameter should be set to*OFF unless output is needed for service reasons. The values are:

*SAMESpecifies that the console output value specified when this command waspreviously issued does not change.

*NONESpecifies that console output will be saved in multiple print files. Each serverjob will create its own print file.

*ONSpecifies that all console output will be routed to a single print file.

*OFFSpecifies that console output will not be routed to a print file. *OFF is therecommended setting.

CSLMSGQSpecifies the console message queue where console messages will be routed to.This parameter is optional. The values are:

*SAMESpecifies that the console output message value specified when this commandwas previously issued does not change.

*NONESpecifies that console messages will not be routed to a message queue.

The console message queue can be qualified by using one of the followinglibrary values:

*WRKLIBSpecifies the console message queue is located in the server work library.

*LIBLSpecifies to use a library list to locate where console message queueresides.

library-nameSpecifies the name of the library where the message queue is located.

CHGSVRADSM


console-message-queue-nameSpecifies the name of the console message queue where console output willbe sent. The message queue must already exist.

MNTMSGQSpecifies the message queue to which volume-mount related messages are sent(for example, requests to mount a volume on a tape drive). If you choose to routeall volume-mount messages to a message queue, the message queue mustalready exist. This parameter is optional. The values are:

*SAMESpecifies that the mount message queue value specified when this commandwas previously issued does not change.

*NONESpecifies that mount messages will not be sent to a message queue.

The mount message queue can be qualified by using one of the followinglibrary values:

*WRKLIBSpecifies that the mount message queue is located in the server worklibrary.

*LIBLSpecifies to use a library list to locate where console message queueresides.

library-nameSpecifies the name of the library in which the mount message queueresides.

mount-message-queue-nameSpecifies the name of the mount message queue where the volume-mountmessages will be sent.

DSPPARMSpecifies how information is displayed on the server in reports, logs, andmessages. Language, date format, time format, and number formats can becontrolled. This parameter is optional.

The options are:

Element 1: LanguageSpecifies the language in which messages will be displayed. The values are:

*SAMESpecifies that the language value specified when this command waspreviously issued does not change.

language-valueSpecifies the language used to present server messages. The default isENU. The values are:

ENU Specifies that information will be displayed in English.

ENP Specifies that information will be displayed in upper case English.

CHGSVRADSM


ESP Specifies that information will be displayed in Spanish.

Element 2: Date formatSpecifies the format for displaying the date. The values are:

*SAMESpecifies that the date format value specified when this command waspreviously issued does not change.

date-format-valueSpecifies the value for displaying the date. The values are:

*MDY Specifies that the format for displaying dates is month, day, year(MDY).

*YMD Specifies that the format for displaying dates is year, month, day(YMD).

*DMY Specifies that the format for displaying dates is day, month, year(DMY).

Element 3: Date separatorSpecifies the separator to be used when displaying the date. The values are:

*SAMESpecifies that the date separator value specified when this command waspreviously issued does not change.

date-separator-valueSpecifies the value for the date separator to be used when displaying thedate. The values are:

’/’ Specifies that a slash (/) is used for the date separator. Thisvalue is valid only if the date format is specified as *MDY.

’-’ Specifies that a dash (-) is used for the date separator. This valueis valid only if the date format is specified as *DMY or *YMD.

’.’ Specifies that a period (.) is used for the date separator. Thisvalue is valid only if the date format is specified as *DMY or*YMD.

Element 4: Time formatSpecifies the format for displaying the time. The values are:

*SAMESpecifies that the time format value specified when this command waspreviously issued does not change.

time-format-valueSpecifies the value used for displaying the time. The values are:

:

’:’ Specifies that a colon (:) is used for the time separator.

’,’ Specifies that a comma (,) is used for the time separator.

’.’ Specifies that a period (.) is used for the time separator.

CHGSVRADSM


’12HR’ Specifies that time is displayed in a 12-hour clock format withAM/PM.

Element 5: Number formatSpecifies the format for displaying the numbers. The values are:

*SAMESpecifies that the number format value specified when this command waspreviously issued does not change.

number-format-valueSpecifies the format by which numbers are displayed by the server. Youcan select a value from 1–6 to identify the format. The default is 1.

1 = 1,000.00

2 = 1,000,00

3 = 1000,00

4 = 1000.00

5 = 1.000,00

6 = 1’000,00

Element 6: Message formatSpecifies the format for displaying the message. The values are:

*SAMESpecifies that the message format value specified when this commandwas previously issued does not change.

message-format-valueSpecifies the number (1 or 2) that identifies the message format used bythe server. You can select either 1 or 2 to identify the format. The defaultis 1.

1 Message headers are displayed only on the first line of themessage

2 Message headers are displayed on multi-line messages

DBPARMSpecifies parameters controlling the TSM database. This parameter is optional. Theoptions are:

Element 1: Buffer pool sizeSpecifies the size of the database buffer pool. A large buffer pool size requiresmore memory. However, it enables cache memory to retain database pageslonger, resulting in fewer input and output operations to data storage. Thevalues are:

*SAMESpecifies that the buffer-pool-size value specified when this command waspreviously issued does not change.

buffer-pool-sizeSpecifies the size of the database buffer pool in kilobytes. The default is512 kilobytes. You can specify a value from 256–2147483647 kilobytes.

CHGSVRADSM


Element 2: Mirror readSpecifies how mirrored volumes are to be accessed when the server reads adatabase page during normal processing. The values are:

*SAMESpecifies that the mirror-read value specified when this command waspreviously issued does not change.

*NORMALSpecifies that only one mirrored volume is read to obtain a databasepage. *NORMAL is the default.

*VERIFYSpecifies that all mirrored volumes are read to obtain a database page.The server automatically resynchronizes invalid database pages with otherpages on mirrored volumes, thus decreasing TSM performance becauseeach mirrored volume is accessed for every page TSM reads.

Element 3: Mirror writeSpecifies how mirrored volumes are accessed when the server writes to adatabase page during normal processing. The values are:

*SAMESpecifies that the mirror-write value specified when this command waspreviously issued does not change.

*SEQUENTIALSpecifies that the server successfully writes to one mirrored databasevolume before writing to other mirrored volumes. Server performancedecreases because a successfully input and output operation must occurbefore other mirror write operations can occur. *SEQUENTIAL is thedefault.

*PARALLELSpecifies that the server writes to all mirrored database pages in parallel.Therefore, all mirrored volumes obtain the new database page atapproximately the same time. System outages occurring during adatabase write can result in partially written database pages.

RCYLOGPARMSpecifies the parameters controlling the recovery log. This parameter isoptional. The options are:

Element 1: Log pool sizeSpecifies the size of the recovery log buffer pool size. Large pool sizerequires more memory. However, it can increase the rate at whichdatabase transactions are committed. The values are:

*SAMESpecifies that the log-pool-size value specified when this commandwas previously issued does not change.

CHGSVRADSM


log-pool-sizeSpecifies the size of the recovery log buffer pool in kilobytes. Thedefault is 128 kilobytes. You can specify a value from128–2147483647 kilobytes.

Element 2: Mirror readSpecifies how mirrored volumes are accessed when the server reads arecovery log during normal processing. The values are:

*SAMESpecifies that the mirror-read value specified when this command waspreviously issued does not change.

*NORMALSpecifies that only one mirrored volume is read to obtain a recoverylog volume. *NORMAL is the default.

*VERIFYSpecifies that all mirrored volumes are read to obtain a recovery logpage. The server automatically resynchronizes invalid recovery logpages with other pages on mirrored volumes, thus decreasingADSM’s performance because each mirrored volume is accessed forevery page that TSM reads.

Element 3: Mirror writeSpecifies how mirrored volumes are accessed when the server writes tothe recovery log during normal processing. The values are:

*SAMESpecifies that the mirror-write value specified when this commandwas previously issued does not change.

*SEQUENTIALSpecifies that the server successfully writes to one mirrored databasevolume before writing to other mirrored volumes. Server performancedecreases because a successfully input and output must occur beforeother mirror write operations can occur.

*PARALLELSpecifies that the server writes to all mirrored database pages inparallel. Therefore, all mirrored volumes obtain the new databasepage at approximately the same time. System outages occurringduring a database write can result in partially written recovery logpages. *PARALLEL is the default.

VOLHSTFILESpecifies the names of one or more files in which to keep a volume history. Usethe DELETE VOLHISTORY command to delete volume history informationcollected by the server when the information is no longer needed. This parameteris optional. The values are:

*SAMESpecifies that the files specified when this command was previously issued donot change.

CHGSVRADSM


*NONESpecifies that no volume history should be updated.

Element 1: Volume history fileThe volume history file can be qualified by using one of the following librarytypes:

*WRKLIBSpecifies that the volume history file is located in the server work library.

library-nameSpecifies the name of the library in which to store the volume history files.

volume-history-file-nameSpecifies the name of the volume history file that should be updated whenserver sequential volume history information is changed. This file will becreated by the server if it does not already exist. You can specify up to 9 files.

Element 2: Volume history memberSpecifies the name of the volume history member. The values are:



DEVCFGFILESpecifies the names of one or more files in which to keep device configurationinformation. You can specify up to 9 files. This parameter is optional. The valuesare:

*SAMESpecifies that the file or files specified when this command was previouslyissued do not change.

*NONESpecifies that no device configuration file is used.

Element 1: Device configuration fileThe device configuration file can be qualified by using one of the followinglibrary types:

*WRKLIBSpecifies the device configuration file is located in the server work library.

library-nameSpecifies the name of the library in which to store device configurationfiles.

device-configuration-file-nameSpecifies the names of one or more files in which to keep device configurationinformation.

Element 2: Device configuration memberSpecifies the name of the device configuration file member:

CHGSVRADSM




EVTLOGFILESpecifies a file to which enabled events are logged. This parameter is optional. Theoptions are:

Element 1: Enable logging to a fileThe values are:


*YESSpecifies that event logging to the file exit receiver begins automatically atserver startup. When this parameter is specified, a file to receive theevents must be specified.

*NOSpecifies that event logging to the file exit receiver does not beginautomatically at server startup. When this parameter has been specified,you must begin event logging manually by issuing the BEGINEVENTLOGGING command.

Element 2: Event fileThe event file can be qualified by using one of the following library types:

*WRKLIBSpecifies that the event file is located in the server work library.

library-nameSpecifies the name of the library in which to store the event file.

file-nameSpecifies the name of the event file.

Element 3: Volume history memberSpecifies the name of the event member. The values are:



Element 4: Event file modeSpecifies how data is written to an existing event file. Values are:


CHGSVRADSM


*APPENDSpecifies that data is appended to the file. This is the default.

*REPLACESpecifies that any data in the file is overwritten.

EVTLOGPGMSpecifies a user-defined exit that is given control to handle an event. Thisparameter is optional. The options are:

Element 1: Enable logging to a user exitThe values are:


*YESSpecifies that event logging to the user exit receiver begins automaticallyat server startup. When this parameter is specified, an exit program toreceive the events must be specified.

*NOSpecifies that event logging to the user exit receiver does not beginautomatically at server startup. When this parameter has been specified,you must begin event logging manually by issuing the BEGINEVENTLOGGING command.

Element 2: Event user exit programSpecifies the event user exit program.

Library types:The name of the user exit program can be qualified by using one of thefollowing library types:

*WRKLIBSpecifies that the event user exit program is located in the serverwork library.

library-nameSpecifies the name of the library in which to store the event user exitprogram.

Event program name:The event program name can have one of the following values:


*NONESpecifies that no user exit program is used.

program-nameSpecifies the name of the user exit program in which the events arelogged.

CHGSVRADSM


EVTLOGTECSpecifies whether to use the TIVOLI event console receiver for event logging.

Element 1: Enable TivoliSpecifies whether the TIVOLI receiver is enabled. The values are:


*YESSpecifies that event logging to the Tivoli receiver begins when the serverstarts up. When this parameter is specified, both a Tivoli port and a Tivoliremote location must be specified.

*NOSpecifies that event logging to the Tivoli receiver does not begin when theserver starts up. When this parameter has been specified, you must beginevent logging manually by issuing the BEGIN EVENTLOGGINGcommand.

Element 2: TIVOLI portSpecifies the TCP/IP port number for the TIVOLI receiver. The values are:


*NONESpecifies that no TCP/IP port exists on which a Tivoli event server islistening.

*SEARCHSpecifies that TSM should try to dynamically determine the TCP/IP port onwhich a Tivoli event server is listening. You can use a value of *SEARCHif the Tivoli event server is on a system that has a Port Mapper servicerunning.

port-numberSpecify the TCP/IP port on which the Tivoli event server is listening. ATivoli port must be specified when Tivoli remote location is specified.

Element 3: TIVOLI remote locationSpecifies the TCP/IP address for the TIVOLI receiver. The values are:


*NONESpecifies that no TCP/IP address exists for a Tivoli event server.

remote-locationSpecify the TCP/IP address for the Tivoli event server. It can be a TCP/IPinternet domain name or a dot address. The internet address is specifiedin the form, nnn.nnn.nnn.nnn, wherennn is a decimal number ranging from

CHGSVRADSM


0 to 255. If the internet address is entered from a command line, theaddress must be in apostrophes. A Tivoli remote location must bespecified when Tivoli port is specified.

Examples

Task

From the command line, update the server options so that TCP/IP is enabled and setthe TCP/IP port address to 1600.

Command:CHGSVRADSM WRKLIB(QUSRADSM) TCP(*YES 1600 *SAME)

This command updates the server options so that TCP/IP is enabled and the portaddress is set to 1600.

Figure 3 on page 896 shows the screen used to change your server options.

CHGSVRADSM


Change Server Options (CHGSVRADSM)

Type choices, press Enter.

Server working library . . . . . QUSRADSM Name, *CURLIB

License terms:Licensed clients . . . . . . . 1 Number, *SAMEOpenSystems Environment. . . . *NO *SAME, *YES, *NOSpace management . . . . . . . *NO *SAME, *YES, *NOServer to server . . . . . . . *NO *SAME, *YES, *NODisaster Recovery Manager. . . *NO *SAME, *YES, *NOEnterprise Administration . . *NO *SAME, *YES, *NO

TCP/IP communication method:Enable TCP/IP . . . . . . . . *YES *SAME, *YES, *NOTCP/IP port . . . . . . . . . 1600 1024-32767, *SAMETCP/IP buffer size . . . . . . 4 1-8 kilobytes, *SAMETCP/IP no delay . . . . . . . *YES *SAME, *YES, *NO

APPC communication method:Enable APPC . . . . . . . . . *YES *SAME, *YES, *NOSNA buffer size . . . . . . . 15 1-31 kilobytes, *SAME

IPX communication method:Enable IPX . . . . . . . . . . *NO *SAME, *YES, *NOIPX socket number . . . . . . 8522 0001-FFFF, *SAMEIPX buffer size . . . . . . . 4 1-8 kilobytes, *SAME

HTTP communication method:Enable HTTP . . . . . . . . . *YES *SAME, *YES, *NOHTTP port . . . . . . . . . . 1580 1024-32767, *SAME

Client connection parameters:Communication timeout . . . . 60 0-2147483647 seconds, *SAMEIdle timeout . . . . . . . . . 15 0-2147483647 minutes, *SAMEMaximum client sessions . . . 25 2-2147483647, *SAME

Server processing parameters:Mount message interval . . . . 1 1-9999 minutes, *SAMEExpiration interval . . . . . 24 0-336 hours, *SAMERestore interval . . . . . . . 1440 0-10080 minutes, *SAMEMaximum transaction group size 16 4-256, *SAMEStatus message count . . . . . 10 1-10000, *SAMEMove batch size . . . . . . . 32 1-1000, *SAMEMove size threshold . . . . . 1 1-500 megabytes, *SAMEJob pool size. . . . . . . . . 3 Number, *SAMEMaximum memory increments . . 1 1-99, *SAMEUse large buffers . . . . . . *NO *SAME, *YES, *NOLimit expiration messages . . *NO *SAME, *YES, *NOStorage audit . . . . . . . . *YES *SAME, *YES, *NO

Figure 3. Change Server Options Screens (Part 1 of 2)

CHGSVRADSM


Console output . . . . . . . . . *OFF *SAME, *NONE, *ON, *OFFConsole output message queue . . ADSMMSGQ Name, *SAME, *NONELibrary . . . . . . . . . . . QUSRADSM Name, *WRKLIB, *LIBL

Mount message queue . . . . . . ADSMMSGQ *NAME, *NONELibrary . . . . . . . . . . . QUSRADSM Name, *WRKLIB, *LIBL

Display parameters:Language . . . . . . . . . . . ENU *SAME, ENU, ENP, ESPDate format . . . . . . . . . *MDY *SAME, *MDY, *YMD, *DMYDate separator . . . . . . . . '/' *SAME, /, -, .Time separator . . . . . . . . ':' *SAME, *, ,, ., 12HRNumber format . . . . . . . . 1 1-6, *SAME, 1=1,000.00.Message format . . . . . . . . 1 1-2, *SAME

Database Parameters:Buffer pool size . . . . . . . 512 256-2147483647 kilobytesMirror read . . . . . . . . . *NORMAL *SAME, *NORMAL, *VERIFYMirror write . . . . . . . . . *SEQUENTIAL *SAME, *SEQUENTIAL, *PARALLEL

Recovery log parameters:Log pool size . . . . . . . . 128 128-2147483647 kilobytesMirror read . . . . . . . . . *NORMAL *SAME, *NORMAL, *VERIFYMirror write . . . . . . . . . *PARALLEL *SAME, *SEQUENTIAL, *PARALLEL

Volume history:File . . . . . . . . . . . . . VOLHISTORY Name, *SAME, *NONELibrary . . . . . . . . . . QUSRADSM Name, *WRKLIB

Member . . . . . . . . . . . . VOLHISTORY Name, *FILEDevice configuration:File . . . . . . . . . . . . . DEVCONFIG Name, *SAME, *NONELibrary . . . . . . . . . . QUSRADSM Name, *WRKLIB

Member . . . . . . . . . . . . DEVCONFIG Name, *FILELog events to file:Enable logging . . . . . . . . *NO *SAME, *YES, *NOEvent file:File . . . . . . . . . . . . . *NONE Name, *SAME, *NONELibrary . . . . . . . . . . Name, *WRKLIB

Member . . . . . . . . . . . . Name, *FILEEvent file mode . . . . . . . *APPEND *SAME, *APPEND, *REPLACE

Log events to user exit:Enable logging . . . . . . . . *YES *SAME, *YES, *NOExit program . . . . . . . . . EXITPGM Name, *SAME, *NONELibrary . . . . . . . . . . QUSRADSM Name, *WRKLIB

Log events to Tivoli:Enable logging . . . . . . . . *NO *SAME, *YES, *NOTivoli port . . . . . . . . . *NONE 0-32767, *SAME, *NONE, *SEARCHTivoli remote location . . . . *NONE

Figure 3. Change Server Options Screens (Part 2 of 2)

CHGSVRADSM


ENDSVRADSM (End Server for ADSM)

Use this command to end the TSM server. This command can only be issued by theperson who originally started the server or by a person who has all object authority.

Syntax


ÊÊ ENDSVRADSMQUSRADSM


Ê

Ê*CNTRLD

OPTION( *IMMED )

ÊÍ

ParametersWRKLIB( libname)

Specifies the TSM server work library. This library should be used to initialize, start,and end server operations. If multiple instances of the TSM server are to be run,each server requires its own work library. The default is QUSRADSM.

The values are:

QUSRADSMSpecifies that library QUSRADSM will be used as the work library.

*CURLIBSpecifies that the current library will be used as the work library.

library-nameSpecifies the name of any valid library. If the library does not exist or you donot have authority to create objects in the library, the command fails.

OPTIONSpecifies whether to end the server immediately or to end in a controlled fashion.The default is *CNTRLD. The values are:

*CNTRLDSpecifies that all database transaction activity should be halted when currenttransactions complete.

See “HALT (Shut Down the Server)” on page 332 for further information on theQuiesce parameter.

*IMMEDSpecifies to end the server immediately.

ENDSVRADSM


Examples

Task

End the TSM server.

Command:ENDSVRADSM

ENDSVRADSM


ENDSVRADSM


Appendix B. Return Code Checking in Tivoli Storage ManagerScripts

You can write TSM scripts that include return codes. As each command is processed ina script, the return code can be used to determine how processing of the script shouldproceed based on the return code value. Shown below are the return codes. The returncodes can be one of three severities: OK, WARNING, ERROR. TSM scripts use thesymbolic return code for processing, not the numeric value. The numeric values aredisplayed by the administrative client when a command is run.

Table 305. Return Code Checking

Return code Severity Numericvalue

Description

RC_OK OK 0 Command completed successfully

RC_NOTFOUND WARNING 11 Returned by a QUERY or SQL SELECTcommand when no objects are found thatmatch specifications

RC_UNKNOWN ERROR 2 Command is not found; not a knowncommand

RC_SYNTAX ERROR 3 Command is valid, but one or moreparameters were not specified correctly

RC_ERROR ERROR 4 An internal server error prevented thecommand from successfully completing

RC_NOMEMORY ERROR 5 The command could not be completedbecause of insufficient memory on the server

RC_NOLOG ERROR 6 The command could not be completedbecause of insufficient recovery log space onthe server

RC_NODB ERROR 7 The command could not be completedbecause of insufficient database space onthe server

RC_NOSTORAGE ERROR 8 The command could not be completedbecause of insufficient storage space on theserver

RC_NOAUTH ERROR 9 The administrator is not authorized to issuethe command

RC_EXISTS ERROR 10 The command failed because the specifiedobject already exists on the server

RC_INUSE ERROR 12 The command failed because the object tobe operated upon was in use

RC_ISREFERENCED ERROR 13 The command failed because the object tobe operated upon is still referenced by someother server construct

RC_NOTAVAILABLE ERROR 14 The command failed because the object tobe operated upon is not available


|

||

||||||

|||

|||||

||||

||||||

|||||

|||||

|||||

|||||

||||||

||||||

||||||

|||||

|||||

|||||

||||||

|||||

Table 305. Return Code Checking (continued)

Return code Severity Numericvalue

Description

RC_IOERROR ERROR 15 The command failed because an I/O errorwas encountered on the server

RC_NOTXN ERROR 16 The command failed because a databasetransaction failed on the server

RC_NOLOCK ERROR 17 The command failed because a lock conflictwas encountered in the server database

RC_NOTHREAD ERROR 19 The command could not be completedbecause of insufficient memory on the server

RC_LICENSE ERROR 20 The command failed because the server isnot in compliance with licensing

RC_INVDEST ERROR 21 The command failed because a destinationvalue was invalid

RC_IFILEOPEN ERROR 22 The command failed because an input filethat was needed could not be opened

RC_OFILEOPEN ERROR 23 The command failed because it could notopen a required output file

RC_OFILEWRITE ERROR 24 The command failed because it could notsuccessfully write to a required output file

RC_INVADMIN ERROR 25 The command failed because theadministrator was not defined

RC_SQLERROR ERROR 26 An SQL error was encountered during aSELECT statement query


|

|||||

|||||

|||||

|||||

|||||

|||||

|||||

|||||

|||||

|||||

|||||

|||||

Appendix C. Notices

This information was developed for products and services offered in the U.S.A. IBMmay not offer the products, services, or features discussed in this document in othercountries. Consult your local IBM representative for information on the products andservices currently available in your area. Any reference to an IBM product, program, orservice is not intended to state or imply that only that IBM product, program, or servicemay be used. Any functionally equivalent product, program, or service that does notinfringe any IBM intellectual property right may be used instead. However, it is theuser’s responsibility to evaluate and verify the operation of any non-IBM product,program, or service.

IBM may have patents or pending patent applications covering subject matter describedin this document. The furnishing of this document does not give you any license tothese patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia CorporationLicensing2-31 Roppongi 3-chome, Minato-kuTokyo 106, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law: INTERNATIONALBUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION “AS IS”WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states donot allow disclaimer of express or implied warranties in certain transactions, therefore,this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changesare periodically made to the information herein; these changes will be incorporated innew editions of the publication. IBM may make improvements and/or changes in theproduct(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenienceonly and do not in any manner serve as an endorsement of those Web sites. Thematerials at those Web sites are not part of the materials for this IBM product and useof those Web sites is at your own risk.


|

IBM may use or distribute any of the information you supply in any way it believesappropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose ofenabling: (i) the exchange of information between independently created programs andother programs (including this one) and (ii) the mutual use of the information which hasbeen exchanged, should contact:

IBM CorporationInformation Enabling RequestsDept. M135600 Cottle RoadSan Jose CA 95193-0001U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this information and all licensed material availablefor it are provided by IBM under terms of the IBM Customer Agreement, IBMInternational Program License Agreement, or any equivalent agreement between us.

Information concerning non-IBM products was obtained from the suppliers of thoseproducts, their published announcements or other publicly available sources. IBM hasnot tested those products and cannot confirm the accuracy of performance,compatibility or any other claims related to non-IBM products. Questions on thecapabilities of non-IBM products should be addressed to the suppliers of thoseproducts.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names are fictitiousand any similarity to the names and addresses used by an actual business enterprise isentirely coincidental.

If you are viewing this information softcopy, the photographs and color illustrations maynot appear.


Trademarks

The following terms are trademarks of the International Business Machines Corporationin the United States or other countries or both:

ACF/VTAMAD/CycleADSTARAdvanced Peer-to-Peer NetworkingAIXAIX/6000Application System/400APPNAS/400ATBookManagerBookshelfC/370Common User AccessCUADATABASE 2DB2DFDSMDFSMSDFSMS/MVSDFSMS/VMDFSMSdssDFSMShsmDFSMSrmmES/9000

ESCONExtended ServicesIBMIBMLinkLibrary ReaderMVS/ESAMVS/SPOpenEditionOperating System/2Operating System/400OS/2OS/390OS/400POWERparallelProprinterRACFRISC System/6000RS/6000SPSystem/370System/390SystemViewVM/ESAVTAMXT

Lotus, Lotus 1–2–3, Lotus Approach, Lotus Domino and Lotus Notes are trademarks ofLotus Development Corporation in the United States and/or other countries.

AFS and DFS are trademarks of Transarc Corporation in the United States and/or othercountries.

Tivoli and Tivoli ADSM are trademarks of Tivoli Systems Inc. in the United States and/orother countries.

Microsoft, Win32, Windows, Windows NT, and the Windows 95 logo are trademarks ofMicrosoft Corporation in the United States and/or other countries.

UNIX is a registered trademark in the United States and/or other countries licensedexclusively through X/Open Company Limited.

Java and all Java-based trademarks and logos are trademarks of Sun Microsystems,Inc. in the United States and/or other countries.

Intel is a registered trademark of the Intel Corporation in the United States and/or othercountries.

Appendix C. Notices 905

Other company, product, and service names may be trademarks or service marks ofothers.


Glossary

The terms in this glossary are defined as theypertain to the Tivoli Storage Manager library. If youdo not find the term you need, refer to the IBMSoftware Glossary on the Web at this URL:www.networking.ibm.com/nsg/nsgmain. You canalso refer to IBM Dictionary of Computing, NewYork: McGraw-Hill, 1994.

This glossary may include terms and definitionsfrom:

v The American National Standard Dictionary forInformation Systems, ANSI X3.172-1990,copyright (ANSI). Copies may be purchasedfrom the American National Standards Institute,11 West 42nd Street, New York 10036.

v The Information Technology Vocabulary,developed by Subcommittee 1, Joint TechnicalCommittee 1, of the International Organizationfor Standardization and the InternationalElectrotechnical Commission (ISO/IECJTC2/SC1).

A

absolute. A value for the backup copy groupmode indicating that a file is considered forincremental backup even if the file has notchanged since the last backup. See also mode.Contrast with modified.

access mode. An attribute of a storage pool or astorage volume attribute that specifies whetherTSM can write to or read from the storage pool orstorage volume. The access mode can beread/write, read-only, or unavailable. Volumes inprimary storage pools can also have an accessmode of destroyed. Volumes in copy storage poolscan also have an access mode of offsite.

accounting facility. A facility that recordsstatistics about client session activity.

accounting records. Files that record sessionresource usage at the end of each client session.

activate. The process of validating the contentsof a policy set and copying the policy set to theACTIVE policy set.

active policy set. The policy set that containsthe policy rules currently in use by all client nodesassigned to the policy domain. The active policyset is the policy set that was most recentlyactivated for the policy domain. See policy set.

active version. The most recent backup copy ofa file stored by TSM. Such a file is not eligible fordeletion until a backup process detects that theuser has either replaced the file with a newerversion, or has deleted the file from theworkstation. Contrast with inactive version.

activity log. A log that records normal activitymessages generated by the server. Thesemessages include information about server andclient operations, such as the start time ofsessions or device I/O errors. Each messageincludes a message ID, date and time stamp, anda text description. The number of days to retainmessages in the activity log can be specified.

administrative client. A program that runs on afile server, workstation, or mainframe that allowsadministrators to control and monitor the serverthrough administrator commands. Contrast withbackup-archive client.

administrative command schedule. A databaserecord that describes the planned processing ofan administrative command during a specific timeperiod. See also client schedule.

administrative privilege class. A level ofauthority granted to an administrator of TSM. Theprivilege class determines which TSMadministrative tasks the administrator can perform.For example, an administrator with systemprivilege class can perform any administrativetask. See system privilege class, policy privilegeclass, storage privilege class, operator privilegeclass, and analyst privilege class.


http://www.networking.ibm.com/nsg/nsgmain.htm

administrative session. A period of time inwhich an administrator user ID communicates witha server to perform administrative tasks. Contrastwith client node session.

administrator. A user who has been registeredto the server. Administrators can be authorized toone or more of the following administrativeprivilege classes: system, policy, storage, operator,or analyst. Administrators can use theadministrative commands and queries allowed bytheir privileges.

Advanced Interactive Executive (AIX). Anoperating system used in the RISC System/6000®

computers. The AIX operating system is the IBMimplementation of the UNIX® operating system.

Advanced Peer-to-Peer Networking ® (APPN®).An extension to the LU6.2 peer orientation forend-user services. See SNA LU6.2 and SystemsNetwork Architecture.

Advanced Program-to-ProgramCommunication (APPC). An implementation ofthe SNA/SDLC LU6.2 protocol that allowsinterconnected systems to communicate andshare the processing of programs. See SNALU6.2, Systems Network Architecture, andCommon Programming Interface Communications.

AFS. Andrew file system.

aggregate file. A file, stored in one or morestorage pools, consisting of a group of logical filespackaged together. See logical file and physicalfile.

AIX. Advanced Interactive Executive.

analyst privilege class. An administrativeprivilege class that allows an administrator to resetstatistics.

Andrew file system (AFS). A distributed filesystem developed for UNIX operating systems.

API. Application program interface.

APPC. Advanced Program-to-ProgramCommunication.

application client. One of the Tivoli DataProtection for application programs installed on asystem. The Tivoli Storage Manager serverprovides backup services to these clients.

APPN. Advanced Peer-to-Peer Networking.

archive. A function that allows users to copy oneor more files to a storage pool for long-termstorage. Archive copies may be accompanied bydescriptive information and may be retrieved byarchive date, by file name, or by description.Contrast with retrieve.

archive copy. A user file that has been archivedto a TSM storage pool.

archive copy group. A policy object containingattributes that control the generation, destination,and expiration of archive files. An archive copygroup belongs to a management class.

archive retention grace period. The number ofdays that TSM retains an archive copy when theserver is unable to rebind the file to an appropriatemanagement class.

AS/400. Application System/400®.

assigned capacity. The portion of availablespace that can be used to store database orrecovery log information. See also availablespace.

association. (1) The defined relationshipbetween a client node and a client schedule. Anassociation identifies the name of a schedule, thename of the policy domain to which the schedulebelongs, and the name of a client node thatperforms scheduled operations. (2) On aconfiguration manager, the defined relationshipbetween a profile and an object such as a policydomain. Profile associations define theconfiguration information that will be distributed tomanaged servers when they subscribe to theprofile.

audit. The process of checking for logicalinconsistencies between information that theserver has and the actual condition of the system.TSM has processes for auditing volumes, thedatabase, libraries, and licenses. For example, in


||||

|||||||

auditing a volume TSM checks for inconsistenciesbetween information about backed up or archivedfiles stored in the database and actual dataassociated with each backup version or archivecopy in server storage.

authentication. The process of checking auser’s password before allowing that user accessto the server. Authentication can be turned on oroff by an administrator with system privilege.

authority. The right granted to a user to performtasks with TSM servers and clients. Seeadministrative privilege class.

autochanger. A small multislot tape device thathas a mechanism that automatically puts tapecartridges into the tape drive or drives. Also calledmedium or media changer, or a library.

availability management. Managing recoveryfrom relatively common computer system outagessuch as a disk drive head crash. Recovery is oftenaccomplished by using disk mirroring and otherforms of RAID technology, or by maintainingonsite backup copies of data.

available space. The amount of space, inmegabytes, that is available to the database andrecovery log. This space can be used to extendthe capacity of the database or recovery log, or toprovide sufficient free space before a volume isdeleted from the database or recovery log.

awk. In AIX, a pattern-matching program forprocessing text files. With the DRM product, youcan use an awk script to break up the disasterrecovery plan file into usable parts.

B

background process. A server process thatruns in the background, allowing the administrativesession to be used for other work.

backup. The process of copying information forsafekeeping. TSM has processes for backing upuser files, the TSM database, and storage pools.For example, users can back up one or more filesto a storage pool to ensure against loss of data.

Contrast with restore. See also database backupseries and incremental backup.

backup-archive client. A program that runs on aworkstation or file server and provides a meansfor users to back up, archive, restore, and retrievefiles. Contrast with administrative client.

backup copy. A user file that has been backedup to a TSM storage pool.

backup copy group. A policy object containingattributes that control the generation, destination,and expiration of backup files. A backup copygroup belongs to a management class.

backup retention grace period. The number ofdays that TSM retains a backup version after theserver is unable to rebind the file to an appropriatemanagement class.

backup series. See database backup series.

backup set. A portable, consolidated group ofactive backup files for a single client. Generationof a backup set is possible for selectedbackup-archive clients that obtain services from aserver at the latest software level.

backup version. A file, directory, or file spacethat a user has backed up, which resides in TSMserver storage. There may be more than onebackup version of a file in the storage pool, but atmost only one is an active backup version. Seeactive version and inactive version.

binding. The process of associating a file with amanagement class name. See rebinding.

boot media. Media that contains operatingsystem and other files essential to running aworkstation or server.

buffer. Storage used to compensate fordifferences in the data rate flow, when transferringdata from one device to another.

buffer pool. Temporary space used by theserver to hold database or recovery log pages.See database buffer pool and recovery log bufferpool.

Glossary 909

|||

|||

|||||

C

cache. The process of leaving a duplicate copyon random access media when the servermigrates a file to another storage pool in thehierarchy.

CARTRIDGE. On TSM servers that support it, adevice class that is used to categorize tapedevices that support tape cartridges, such as the3490 Magnetic Tape Subsystem.

cartridge system tape (CST). The base tapecartridge media used with 3480 or 3490 MagneticTape Subsystems. When specified as a mediatype in TSM, CST identifies standard length tape.Contrast with enhanced capacity cartridge systemtape.

central scheduler. A function that allows anadministrator to schedule client operations andadministrative commands. The operations can bescheduled to occur periodically or on a specificdate. See client schedule and administrativecommand schedule.

CID. Configuration Installation and Distribution.

client. A program running on a PC, workstation,file server, LAN server, or mainframe that requestsservices of another program, called the server.The following types of clients can obtain servicesfrom a TSM server: administrative client,application client, API client, backup-archive client,HSM client (also known as space manager client),and host server.

Client Access ™/400®. A software product thatsupports advanced program-to-programcommunications (APPC) in the DOS, OS/2®, andMicrosoft Windows® environments and provides aset of end user services.

client domain. The set of drives, file systems, orvolumes selected by a backup-archive client userduring a backup or archive operation.

client migration. The process of copying a filefrom a client node to TSM storage and replacingthe file with a stub file on the client node. Theprocess is controlled by the user and by space

management attributes in the management class.See also space management.

client node. A file server or workstation on whichthe backup-archive client program has beeninstalled, which has been registered to the server.

client node session. A period of time in which auser communicates with a server to performbackup, restore, archive, retrieve, migrate, orrecall requests. Contrast with administrativesession.

client options file. A file that a client canchange, containing a set of processing optionsthat identify the server, communication method,and options for backup, archive, hierarchicalstorage management, and scheduling. Also calledthe dsm.opt file.

client polling scheduling mode. A client/servercommunication technique where the client queriesthe server for work.

client schedule. A database record thatdescribes the planned processing of a clientoperation during a specific time period. The clientoperation can be a backup, archive, restore, orretrieve operation, a client operating systemcommand, or a macro. See also administrativecommand schedule.

client/server. A system architecture in which oneor more programs (clients) request computing ordata services from another program (server).

client system options file. A file, used on UNIXclients, containing a set of processing options thatidentify the TSM servers to be contacted forservices. This file also specifies communicationmethods and options for backup, archive,hierarchical storage management, and scheduling.Also called the dsm.sys file. See also client useroptions file.

client user options file. A user-created file,used on UNIX clients, containing a set ofprocessing options that identify the server,communication method, backup and archiveoptions, space management options, andscheduling options. Also called the dsm.opt file.See also client system options file.


||||||||

||||||

closed registration. A registration process inwhich an administrator must register workstationsas client nodes with the server. Contrast with openregistration.

collocation. A process that attempts to keep alldata belonging to a single client node or a singleclient file space on a minimal number ofsequential access media volumes within a storagepool. Collocation can reduce the number ofvolumes that must be accessed when a largeamount of data must be restored.

commit. To make changes permanent in thedatabase. Changes made to the database filesare not permanent until they are committed.

Common Programming InterfaceCommunications (CPI-C). A programminginterface that allows program-to-programcommunication using SNA LU6.2. See alsoSystems Network Architecture.

Common User Access ® (CUA®). Guidelines forthe dialog between a human and a workstation orterminal. One of the three Systems ApplicationArchitecture areas.

communication manager. A component of OS/2that allows a workstation to connect to a hostcomputer and use the host resources as well asthe resources of other personal computers towhich the workstation is attached, either directly orthrough a host.

communication method. The method used by aclient and server for exchanging information.

communication protocol. A set of definedinterfaces that allow computers to communicatewith each other.

compression. The process of saving storagespace by eliminating empty fields or unnecessarydata in a file. In TSM, compression can occur at aworkstation before files are backed up or archivedto server storage. On some types of tape drives,hardware compression can be used.

Configuration Installation and Distribution(CID). The term used to describe the capability ofIBM products for automated installation.CID-enabled products are capable of unattended,remote installation.

configuration manager. One TSM server thatdistributes configuration information to other TSMservers (called managed servers) via profiles.Configuration information can include policy andschedules. See managed server and profile.

copy group. A policy object that containsattributes that control the generation, destination,and expiration of backup and archive files. Thereare two kinds of copy groups: backup and archive.Copy groups belong to management classes. Seealso frequency, destination, mode, serialization,retention, and version.

copy status. The status of volume copiesdefined to the database or recovery log. The copystatus can be synchronized, stale, off-line, orundefined.

copy storage pool. A named set of volumes thatcontains copies of files that reside in primarystorage pools. Copy storage pools are used onlyto back up the data stored in primary storagepools. A copy storage pool cannot be a destinationfor a backup copy group, an archive copy group,or a management class (for space-managed files).See primary storage pool and destination.

CPI-C. Common Programming InterfaceCommunications.

CST. Cartridge system tape.

CUA. Common User Access.

D

daemon. In the AIX operating system, a programthat runs unattended to perform a standardservice. Some daemons are triggeredautomatically to perform their tasks; othersoperate periodically.

daemon process. In the AIX operating system, aprocess begun by the root user or by the root

Glossary 911

|||||

shell that can be stopped only by the root user.Daemon processes generally provide services thatmust be available at all times, such as sendingdata to a printer.

damaged file. A physical file for which TSM hasdetected read errors.

DASD. Direct access storage device.

database. A collection of information about allobjects managed by the server, including policymanagement objects, users and administrators,and client nodes.

database audit. A utility that checks for andoptionally corrects inconsistent databasereferences.

database backup series. One full backup of thedatabase, plus up to 32 incremental backupsmade since that full backup. Each full backup thatis run starts a new database backup series. Abackup series is identified with a number.

database backup trigger. A set of criteria thatdefines when and how database backups are runautomatically. The criteria determine how often thebackup is run, whether the backup is a full orincremental backup, and where the backup isstored.

database buffer pool. Storage that is used as acache to allow database pages to remain inmemory for long periods of time, so that theserver can make continuous updates to pageswithout requiring input or output (I/O) operationsfrom external storage.

database dump. The action performed by theDSMSERV DUMPDB utility (DMPADSM commandon AS/400), which copies TSM database entries tomedia for later reload in case a catastrophic erroroccurs.

database load. The action performed by theDSMSERV LOADDB utility (LODADSM commandon AS/400), which copies TSM database entriesfrom media to a newly installed database.

database snapshot. A function of TSM thatbacks up the entire TSM database to media that

can be taken off-site. The database snapshotdoes not interrupt any database backup seriesand cannot have incremental database backupsassociated with it. Contrast with full backup.

database volume. A volume that has beenassigned to the TSM database.

dataserver. See Tape Library Dataserver.

data set. See linear data set.

DDM. Distributed Data Management.

default management class. A managementclass assigned to a policy set, which is used togovern backed up or archived files when a userdoes not specify a management class for a file.

deletion exit. For MVS or VM, aninstallation-wide exit that informs a tapemanagement system or operator that the serverhas deleted a sequential access media volumefrom its database.

delimiter. (1) A character used to indicate thebeginning and end of a character string. (2) Acharacter that groups or separates words orvalues in a line of input.

desktop client. The group of backup-archiveclients supported by TSM that includes clients onOS/2, DOS, Windows, Apple, and Novell NetWareoperating systems.

destination. A copy group or management classattribute that specifies the primary storage pool towhich a client file will be backed up, archived, ormigrated.

device class. A named group of storage deviceswith common characteristics. Each device classhas a unique name and represents a device typeof disk, file, optical disk, or tape.

device configuration file. A file that containsinformation about defined device classes, and, onsome TSM servers, defined libraries and drives.The file can be created by using a TSM commandor by using an option in the server options file.The information is a copy of the deviceconfiguration information in the TSM database.


||

||||

device driver. A collection of subroutines thatcontrol the interface between I/O device adaptersand the processor.

device type. A category of storage device. Eachdevice class is categorized with one of thesupported device types, for example, DISK orCARTRIDGE.

direct access storage device (DASD). A devicein which access time is effectively independent ofthe location of the data.

disaster recovery. Recovery from catastrophicinterruptions of computer systems, such as loss ofthe system location because of natural events.Backup data is kept offsite to protect against suchcatastrophes.

Disaster Recovery Manager. See Tivoli DisasterRecovery Manager.

disaster recovery plan. A document thatcontains information about how to recovercomputer systems if a disaster occurs. The TivoliDisaster Recovery Manager (DRM) product allowsyou to create the plan for a TSM server. The planis a file that contains information about thesoftware and hardware used by the TSM server,and the location of recovery media.

DISK. A device class that is defined by TSM atinstallation. It is used to categorize disk drives,such as internal disk drives or 3390 DASD.

disk operating system (DOS). An operatingsystem used in IBM PC, PS/2, and compatiblecomputers.

Distributed Data Management (DDM). A featureof the System Support Program Product thatallows an application program (client) to useserver program functions to work on files thatreside in a remote system.

DLL. Dynamic link library.

DLT. Digital linear tape.

domain. See policy domain or client domain.

DOS. Disk operating system.

drive. A device used to read and write data on amedium such as a magnetic disk, optical disk, ortape.

DRM. A short name for Tivoli Disaster RecoveryManager.

dsm.opt file. See client options file and clientuser options file.

dsmserv.opt. See server options file.

dsm.sys file. See client system options file.

dynamic. A copy group serialization value thatspecifies that TSM accepts the first attempt toback up or archive a file regardless of whether thefile is modified during the backup or archiveprocess. See also serialization. Contrast withshared dynamic, shared static, and static.

dynamic link library. A file containingexecutable code and data bound to a program atload time or run time, rather than during linking.The code and data in a dynamic link library canbe shared by several applications simultaneously.

E

ECCST. Enhanced capacity cartridge systemtape.

enhanced capacity cartridge system tape(ECCST). Cartridge system tape with increasedcapacity that can only be used with 3490E tapesubsystems. Contrast with cartridge system tape.

enterprise configuration. A capability thatallows the administrator to distribute theconfiguration of one TSM server to other serversusing server-to-server communication. Seeconfiguration manager, managed server, profile,and subscription.

enterprise logging. The sending of events fromTSM servers to a designated event server. Theevent server routes the events to designatedreceivers, such as to a user exit. See also event.

error log. A character file written on randomaccess media that contains information abouterrors detected by the server or client.

Glossary 913

||||||||

||||||

||||

estimated capacity. The available space, inmegabytes, of a storage pool.

Ethernet. A data link protocol and LAN thatinterconnects personal computers andworkstations via coaxial cable.

event. (1) An administrative command or a clientoperation that is scheduled to be run using TSMscheduling. (2) A message that a TSM server orclient issues. Messages can be logged using TSMevent logging.

event record. A database record that describesactual status and results for events.

event server. A server to which other serverscan send events for logging. The event serverroutes the events to any receivers that areenabled for the sending server’s events.

exclude. The process of identifying files ordirectories in an include-exclude list to preventthese objects from being backed up whenever auser or schedule issues an incremental orselective backup operation, or to prevent theseobjects from being migrated off the client node viaTivoli Space Manager space management.

exclude-include list. See include-exclude list.

exit. To execute an instruction within a portion ofa computer program in order to terminate theexecution of that portion.

exit machine. On a VM server, a virtual machinethat runs the mount and deletion installation-wideexits on VM systems.

expiration. The process by which files areidentified for deletion because their expiration dateor retention period has passed. Backed up orarchived files are marked expired by TSM basedon the criteria defined in the backup or archivecopy group.

expiration date. On MVS, VM, and VSE servers,a device class attribute used to notify tapemanagement systems of the date when TSM nolonger needs a tape volume. The date is placed inthe tape label so that the tape management

system does not overwrite the information on thetape volume before the expiration date.

export. The process of copying administratordefinitions, client node definitions, policydefinitions, server control information or file data toexternal media.

export/import facility. See import/export facility.

extend. The process of increasing the portion ofavailable space that can be used to storedatabase or recovery log information. Contrastwith reduce.

F

file record extent. The extent of the fileenumerated in number of records.

file space. A logical space in a client’s storagethat can contain a group of files. For clients onsystems such as OS/2, a file space is a logicalpartition and is identified by a volume label. Forclients on systems such as AIX and UNIX, a filespace can consist of any subset of directories andsubdirectories stemming from a virtual mountpoint. Clients can restore, retrieve, or delete theirfile spaces from TSM server storage. TSM doesnot necessarily store all the files from a single filespace together, but can identify all the files inserver storage that came from a single file space.

File Transfer Protocol (FTP). In TCP/IP, theprotocol that makes it possible to transfer dataamong hosts and to use foreign hosts indirectly.

format. A device class attribute that specifies therecording format used to read or write tosequential access media such as tape.

frequency. A copy group attribute that specifiesthe minimum interval, in days, betweenincremental backups.

FTP. File Transfer Protocol.

full backup. A function of TSM that copies theentire database. A full backup begins a new


|||

||||

||

database backup series. Contrast with incrementalbackup and database snapshot. See databasebackup series.

fuzzy copy. A backup version or archive copy ofa file that might not accurately reflect what iscurrently in the file because TSM backed up orarchived the file while the file was being modified.

G

GUI. Graphical user interface.

H

HDA. Head-disk assembly.

head-disk assembly (HDA). A field replaceableunit in a direct access storage device containingthe disks and actuators.

hierarchical storage management (HSM)client. The Tivoli Space Manager program thatruns on workstations to allow users to maintainfree space on their workstations by migrating andrecalling files to and from Tivoli Storage Managerstorage. Synonymous with space manager client.

high migration threshold. A percentage of thestorage pool capacity that identifies when TSMcan start migrating files to the next availablestorage pool in the hierarchy. Contrast with lowmigration threshold. See server migration.

host server. The name for the system on whichthe Tivoli Data Protection for Workgroups programruns. The host server obtains scheduling servicesfrom Tivoli Storage Manager.

HP-UX. Hewlett-Packard UNIX operating system.

HSM client. Hierarchical storage managementclient. Also known as the space manager client.

I

import. The process of copying exportedadministrator definitions, client node definitions,policy definitions, server control information or filedata from external media to a target server.

import/export facility. The facility that allowssystem administrators to copy definitions and filedata from a source server to external media tomove or copy information between servers. Asubset of information can be imported to a targetserver from the external media.

inactive version. A backup version of a file forwhich a more recently backed-up version exists.Inactive backup versions are eligible for expirationprocessing according to the management classassigned to the file. Contrast with active version.

include-exclude file. On UNIX clients, a filecontaining statements that TSM uses to determinewhether to back up or migrate certain files, and todetermine the associated management classes touse for backup, archive, and space management.See include-exclude list.

include-exclude list. A group of include andexclude option statements in a file. TSM uses thestatements to determine whether to back up ormigrate certain files, and to determine theassociated management classes to use forbackup, archive, and space management. Theexclude options identify files that should not bebacked up or migrated off the client node. Theinclude options identify files that are exempt fromthe exclusion rules, or assign a management classto a file or group of files for backup, archive, orspace management services. The include-excludelist is defined either in the include-exclude file (forUNIX clients) or in the client options file (for otherclients).

incremental backup. (1) A function that allowsusers to back up files or directories that are newor have changed since the last incrementalbackup. With this function, users can back up filesor directories from a client domain that are notexcluded in the include-exclude list and that meetthe requirements for frequency, mode, andserialization as defined in the backup copy groupof the management class assigned to the files.Contrast with selective backup. (2) A function ofTSM that copies only the pages in the databasethat are new or changed since the last full orincremental backup of the database. Contrast withfull backup. See database backup series.

Glossary 915

|||

|||||

||||

internal mounting facility. On a VM server, aVM facility that allows the server to request tapemounts by sending a message to a mountoperator. The message is repeated until the tapeis mounted or until the mount wait time isexceeded.

inter-user communication vehicle (IUCV)facility. On a VM server, a VM communicationmethod used to pass data between virtualmachines and VM components.

IPX/SPX. Internetwork PacketExchange/Sequenced Packet Exchange. IPX/SPXis Novell NetWare’s communication protocol.

IUCV. Inter-user communication vehicle.

K

KB. Kilobyte.

kernel. The part of an operating system thatperforms basic functions such as allocatinghardware resources.

kernel extension. A program that modifies partsof the kernel that can be customized to provideadditional services and calls. See kernel.

kilobyte (KB). 1024 bytes.

L

LAN. Local area network.

length. A device class attribute that specifies thelength of cartridge tape by specifying one of thefollowing media types: CST for standard lengthtape or ECCST for double length tape.

library. (1) A repository for demountablerecorded media, such as magnetic tapes. (2) ForTSM, a collection of one or more drives, andpossibly robotic devices (depending on the librarytype), which can be used to access storagevolumes. (3) In the AS/400 system, a systemobject that serves as a directory to other objects.A library groups related objects, and allows theuser to find objects by name.

linear data set. A type of MVS data set thatTSM uses for the database, the recovery log, andstorage pools. The data set must be preallocatedusing VSAM IDCAMS and formatted by TSM forits use.

load. See mount.

local area network (LAN). A network in which aset of devices are connected to one another forcommunication and that can be connected to alarger network.

logical file. A client file stored in one or moreserver storage pools, either by itself or as part ofan aggregate file. See also aggregate file andphysical file.

logical occupancy. The space required for thestorage of logical files in a storage pool. Becauselogical occupancy does not include the unusedspace created when logical files are deleted fromaggregates, it may be less than physicaloccupancy. See also physical file and logical file.

logical volume. (1) A portion of a physicalvolume that contains a filesystem. (2) For the TSMserver, the combined space from all volumesdefined to either the database or the recovery log.The database is one logical volume and therecovery log is one logical volume.

log pool size. The size of an area in memoryused to store recovery log pages.

low migration threshold. A percentage of thestorage pool capacity that specifies when TSMcan stop the migration of files to the next storagepool. Contrast with high migration threshold. Seeserver migration.

M

machine information. Details about the machineon which a client node resides.

macro file. A file that contains one or moreadministrative commands and that is run from anadministrative client. Contrast with TSM commandscript.


||

managed object. A definition in the TSMdatabase of a managed server that wasdistributed to the managed server by aconfiguration manager. In general, the definitioncannot be modified locally on the managed server.When a managed server subscribes to a profile,all objects associated with that profile becomemanaged objects in the database of the managedserver. Objects can include policy, schedules,client options sets, server scripts, administratorregistrations, and server and server groupdefinitions.

managed server. A TSM server that receivesconfiguration information from a configurationmanager via subscription to one or more profiles.Configuration information can include definitions ofobjects such as policy and schedules. Seeconfiguration manager, subscription, and profile.

management class. A policy object that userscan bind to each file to specify how the servermanages the file. The management class cancontain a backup copy group, an archive copygroup, and space management attributes. Thecopy groups determine how the TSM servermanages backup versions or archive copies offiles. The space management attributes determinewhether files are eligible for migration from spacemanager client nodes to TSM storage, and underwhat conditions. See also copy group, binding andrebinding.

mask. A pattern of characters that controls thekeeping, deleting, or testing of positions of anotherpattern of characters or bits.

maximum extension. Specifies the maximumamount of storage space, in megabytes, that youcan extend the database or recovery log.

maximum reduction. Specifies the maximumamount of storage space, in megabytes, that youcan reduce the database or recovery log.

maximum utilization. The highest percentage ofassigned capacity used by the database orrecovery log.

MB. Megabyte.

megabyte (MB). (1) For processor storage andreal and virtual memory, 220 or 1 048 576 bytes.(2) For disk storage capacity and transmissionrates, 1 000 000 bytes.

migrate. (1) To move data from one storage poolto the storage pool specified as the next pool inthe hierarchy. The process is controlled by thehigh and low migration thresholds for the firststorage pool. See high migration threshold andlow migration threshold. (2) To copy a file from aTivoli Space Manager client node to TSM storage.Tivoli Space Manager replaces the file with a stubfile on the client node. The process is controlledby the include-exclude list and by spacemanagement attributes in management classes.

migration. The process of moving data from onestorage location to another. See client migrationand server migration.

minidisk. A logical subdivision of a VM physicaldisk that provides storage on contiguous cylindersof DASD. On a VM server, a minidisk can bedefined as a disk volume that can be used by thedatabase, recovery log, or a storage pool.

mirroring. A feature that protects against dataloss within the database or recovery log by writingthe same data to multiple disks at the same time.Mirroring supports up to three exact copies ofeach database or recovery log volume.

mm. Millimeter.

mode. A copy group attribute that specifieswhether to back up a file that has not beenmodified since the last time the file was backedup. See modified and absolute.

modified. A backup copy group mode valueindicating that a file is considered for incrementalbackup only if it has changed since the lastbackup. A file is considered changed if the date,size, owner, or permissions have changed. Seemode. Contrast with absolute.

Motif. A graphical user interface that performswindow management and contains a high leveltoolkit for application program development. It

Glossary 917

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

||||||

||||||

provides an icon view of the UNIX file system.Also known as X-Windows/Motif or MotifX—Toolkit.

mount. To place a data medium (such as a tapecartridge) on a drive in a position to operate.

mount exit. On a VM server, an installation-wideexit (DSMMOUNT EXEC) that requests tapemounts on behalf of the server on VM systems.

mount limit. A device class attribute specifyingthe maximum number of volumes that can besimultaneously accessed from the same deviceclass, that is, the maximum number of mountpoints. See mount point.

mount operator. On a VM server, a VM user IDthat can receive tape mount messages from theserver.

mount point. A logical drive through which TSMaccesses volumes in a sequential access deviceclass. For a device class with a removable mediadevice type (for example, CARTRIDGE), a mountpoint is a logical drive associated with a physicaldrive. For a device class with the device type ofFILE, a mount point is a logical drive associatedwith an I/O stream. The number of mount pointsfor a device class is determined by the mount limitfor that class. See mount limit.

mount request. A server request to mount asequential access media volume so that data canbe read from or written to the sequential accessmedia.

mount retention period. A device class attributethat specifies the maximum number of minutesthat the server retains a mounted sequentialaccess media volume that is not being usedbefore it dismounts the sequential access mediavolume.

mount wait period. A device class attribute thatspecifies the maximum number of minutes that theserver waits for a sequential access volume mountrequest to be satisfied before canceling therequest.

Multiple Virtual Storage (MVS). One of thefamily of IBM operating systems for the

System/370™ or System/390® processor, such asMVS/ESA™. MVS is one of the supported serverenvironments.

MVS. Multiple Virtual Storage.

N

Named Pipes. A communication protocol that isbuilt into the Windows NT® or OS/2 operatingsystem. It can be used to establishcommunications between the TSM server and anyTSM clients on the same system.

NetBIOS. Network Basic Input/Output System.

network adapter. A physical device, and itsassociated software, that enables a processor orcontroller to be connected to a network.

Network Basic Input/Output System(NetBIOS). An operating system interface forapplication programs used on IBM personalcomputers that are attached to the IBMToken-Ring Network.

Network File System (NFS). A protocol definedby Sun Microsystems that extends TCP/IPnetwork file services. NFS permits remote nodefiles to appear as though they are stored on alocal workstation.

Networking Services/DOS (NS/DOS). Asoftware product that supports advancedprogram-to-program communications (APPC) inthe DOS and Microsoft Windows 3.1environments. With NS/DOS, communicationsapplications on your workstation “talk to” partnerapplications on other systems that support APPC.

NFS. Network File System.

node. A unique name used to identify aworkstation to the server. See also client node.

notify operator. A VM user ID that specifies anoperator who receives messages about severeerrors and abnormal conditions.


|||||

O

object. A collection of data managed as a singleentity.

offsite recovery media. Media that is kept at adifferent location to ensure its safety if a disasteroccurs at the primary location of the computersystem. The media contains data necessary torecover the TSM server and clients. The offsiterecovery media manager, which is part of DRM,identifies recovery media to be moved offsite andback onsite, and tracks media status.

offsite volume. A removable media volume thatis at a location where it cannot be mounted foruse.

open registration. A registration process inwhich users can register their own workstations asclient nodes with the server. Contrast with closedregistration.

Operating System/2 ® (OS/2). An operatingsystem used in IBM PC AT®, PS/2, andcompatible computers.

operator privilege class. An administrativeprivilege class that allows an administrator toissue commands that control the operation of theserver. This privilege class allows disabling orhalting the server to perform maintenance,enabling the server, canceling server processes,and managing tape.

optical library. A storage device that housesoptical disk drives and optical disks, and containsa mechanism for moving optical disks between astorage area and optical disk drives.

OS/2. Operating System/2.

OS/390®. Operating System/390.

OS/400®. Operating System/400®.

owner. The owner of backup-archive files sentfrom a multiuser client node, such as AIX.

P

page. (1) A block of instructions, data, or both.(2) In TSM, a unit of space allocation withindatabase volumes. (3) In a virtual storage system,a fixed block that has a virtual address and istransferred as a unit between real storage andauxiliary storage.

paging. (1) The action of transferringinstructions, data, or both, between real storageand external page storage. (2) Moving databetween memory and a mass storage device asthe data is needed.

pattern-matching expression. A stringexpression that uses wildcard characters tospecify one or more TSM objects. See alsowildcard character.

physical file. A file, stored in one or morestorage pools, consisting of either a single logicalfile, or a group of logical files packaged together(an aggregate file). See also aggregate file andlogical file.

physical occupancy. The occupancy of physicalfiles in a storage pool. This is the actual spacerequired for the storage of physical files, includingthe unused space created when logical files aredeleted from aggregates. See also physical file,logical file, and logical occupancy.

platform. The operating system environment inwhich a program runs.

policy domain. A policy object that containspolicy sets, management classes, and copygroups that are used by a group of client nodes.See policy set, management class, and copygroup.

policy privilege class. An administrativeprivilege class that allows an administrator tomanage policy objects, register client nodes, andschedule client operations (such as backupservices) for client nodes. Administrators can beauthorized with unrestricted or restricted policyprivilege.

Glossary 919

|

policy set. A policy object that contains a groupof management class definitions that exist for apolicy domain. At any one time there can be manypolicy sets within a policy domain but only onepolicy set can be active. See management classand active policy set.

premigration. For an HSM client, the process ofcopying files that are eligible for migration to TSMstorage, but leaving the original file intact on thelocal system.

primary storage pool. A named set of volumesthat TSM uses to store backup versions of files,archive copies of files, and files migrated fromHSM client nodes. A primary storage pool may bebacked up to a copy storage pool. See destinationand copy storage pool.

privilege class. A level of authority granted toan administrator of TSM . The privilege classdetermines which TSM administrative tasks theadministrator can perform. For example, anadministrator with system privilege class canperform any administrative task. See systemprivilege class, policy privilege class, storageprivilege class, operator privilege class, andanalystprivilege class.

profile. A named group of configurationinformation that can be distributed from aconfiguration manager when a managed serversubscribes. Configuration information can includeregistered administrators, policy, client schedules,client option sets, administrative schedules, servercommand macros, server definitions, and servergroup definitions. See configuration manager andmanaged server.

protection status. A device class attribute thatspecifies whether to update the RACF profile toidentify which users have access to cartridgetapes associated with this device class on MVSservers.

Q

QIC. Quarter-inch cartridge (a type of magnetictape media).

R

random access media. Any volume accessed ina nonsequential manner. In TSM, volumes areaccessed in a nonsequential manner if they residein the DISK device class.

randomization. The percentage of the startupwindow that the server can use to randomize starttimes for different client nodes associated with aschedule.

rebinding. The process of associating a file witha backed-up file with a new management classname. For example, rebinding occurs when themanagement class associated with a file isdeleted. See binding.

recall. A function that allows users to accessfiles that have been migrated from theirworkstations to TSM storage via the Tivoli SpaceManager (HSM client). Contrast with migrate.

reclamation. A process of consolidating theremaining data from many sequential accessvolumes onto fewer new sequential accessvolumes.

reclamation threshold. The percentage ofreclaimable space that a sequential access mediavolume must have before the server can reclaimthe volume. Space becomes reclaimable whenfiles are expired or are deleted. The percentage isset for a storage pool.

recovery log. A log of updates that are about tobe written to the database. The log can be used torecover from system and media failures.

recovery log buffer pool. Used to hold newtransactions records until they can be written tothe recovery log.

recovery media. Media that contains datanecessary to recover the TSM server and clients.

reduce. The process of freeing up enough spaceto allow you to delete a volume from the databaseor recovery log. Contrast with extend.


|||||||||

REEL. On TSM servers that support it, a deviceclass that is used to categorize tape devices thatsupport tape reels, such as the 3420 9-track tapedevice.

register. (1) Define a client node or administratorwho can access the server. See registration. (2)Specify licenses that have been purchased for theserver.

registration. The process of identifying a clientnode or administrator to the server.

reply operator. On a VM server, a VM user IDthat specifies an operator who will reply to tapemount requests by the server.

restore. The process of returning a backup copyto an active storage location for use. TSM hasprocesses for restoring its database, storagepools, storage pool volumes, and users’backed-up files. For example, users can copy abackup version of a file from the storage pool tothe workstation. The backup version in the storagepool is not affected. Contrast with backup.

retention. The amount of time, in days, thatinactive backed up or archived files are kept in thestorage pool before they are deleted. Copy groupattributes and default retention grace periods forthe domain define retention.

retention period. On an MVS server, a deviceclass attribute that specifies how long files areretained on sequential access media. When used,TSM passes this information to the MVS operatingsystem to ensure that other tape managementsystems do not overwrite tape volumes thatcontain retained data.

retrieve. A function that allows users to copy anarchive copy from the storage pool to theworkstation. The archive copy in the storage poolis not affected. Contrast with archive.

rollback. To remove changes that were made todatabase files since the last commit point.

root user. In the AIX and UNIX environments, auser who has superuser authority. The user can

log in and execute restricted commands, shutdown the system, and edit or delete protectedfiles.

S

schedule. A database record that describesscheduled client operations or administrativecommands. See administrative commandschedule and client schedule.

scheduling mode. The type of schedulingoperation set for the server and client. TSMsupports two scheduling modes for clientoperations: client-polling and server-prompted.

scratch volume. A volume that is available forTSM use. The volume is labeled, is either blank orcontains no valid data, and is not defined to TSM.

script. See TSM command script.

SCSI. Small computer system interface.

selective backup. A function that allows users toback up specific files or directories from a clientdomain. With this function, users can back up filesor directories that are not excluded in theinclude-exclude list and that meet the requirementfor serialization as defined in the backup copygroup of the management class assigned to thefiles. Contrast with incremental backup.

sequential access media. Any volume that isaccessed in a sequential manner, as opposed to arandom manner. In TSM, volumes are accessedsequentially if they reside in a device class otherthan DISK.

serialization. A copy group attribute thatspecifies what TSM does if files are modifiedduring back up or archive processing. The valueof this attribute determines whether processingcontinues, is retried, or is stopped. See static,dynamic, shared static, and shared dynamic.

server. The program that provides backup,archive, space management, and administrativeservices to clients. The server program must be atthe necessary level to provide all of theseservices.

Glossary 921

|

server migration. The process of moving datafrom one storage pool to the next storage pool ascontrolled by the high and low migrationthresholds. See high migration threshold and lowmigration threshold.

server options file. A file that specifiesprocessing options for communication methods,tape handling, pool sizes, language, and date,time, and number formats.

server-prompted scheduling mode. Aclient/server communication technique where theserver contacts the client when a scheduledoperation needs to be done.

server storage. The primary and copy storagepools used by the server to store users’ files:backup versions, archive copies, and filesmigrated from Tivoli Space Manager client nodes(space-managed files). See primary storage pool,copy storage pool, storage pool volume, andvolume.

session resource usage. The amount of waittime, CPU time, and space used or retrievedduring a client session.

shared dynamic. A copy group serializationvalue that specifies that a file must not bemodified during a backup or archive operation.TSM attempts to retry the backup or archiveoperation a number of times; if the file is in useduring each attempt, TSM will back up or archivethe file on its last try even though the file is in use.See also serialization. Contrast with dynamic,shared static, and static.

shared static. A copy group serialization valuethat specifies that the file must not be modifiedduring backup or archive. TSM will retry thebackup or archive operation a number of times; ifthe file is in use during each attempt, TSM will notback up or archive the file. See also serialization.Contrast with dynamic, shared dynamic, andstatic.

shell. In the AIX and UNIX environments, asoftware interface between a user and theoperating system of a computer. Shell programsinterpret commands and user interactions on

devices such as keyboards, pointing devices, andtouch-sensitive screens and communicate them tothe operating system.

SMIT. System Management Interface Tool.

SNA LU6.2. Systems Network ArchitectureLogical Unit 6.2.

snapshot. See database snapshot.

socket. (1) An endpoint for communicationbetween processes or applications. (2) A pairconsisting of TCP port and IP address, or UDPport and IP address.

source server. A server that can send data, inthe form of virtual volumes, to another server.Contrast with target server.

space-managed file. A file that is migrated fromand recalled to a client node via Tivoli SpaceManager (HSM client).

space management. The process performed byTivoli Space Manager to keep sufficient freestorage space available on a client node bymigrating files to Tivoli Storage Manager storage.The files are migrated based on criteria defined inmanagement classes to which files are bound,and the include-exclude list. Synonymous withhierarchical storage management. See alsomigration.

space manager client. Synonym for hierarchicalstorage management (HSM) client.

stale copy status. Specifies that a volume copyis not available to the database or recovery log.

stanza. A group of lines in a file that togetherhave a common function or define a part of thesystem. Stanzas are usually separated by blanklines or colons, and each stanza has a name.

startup window. A time period during which aschedule must be initiated.

static. A copy group serialization value thatspecifies that the file must not be modified duringbackup or archive. If the file is modified during theattempt, TSM will not back up or archive the file.


|

|||||||||

||

See also serialization. Contrast with dynamic,shared dynamic, and shared static.

storage hierarchy. A logical ordering of primarystorage pools, as defined by an administrator withsystem privilege. Generally, the ordering is basedon the speed and capacity of the devices that thestorage pools use. In TSM, the storage hierarchyis defined by identifying the next storage pool in astorage pool definition. See storage pool.

storage management services. A componentthat allows a central system to act as a filebackup, archive, and space management serverfor local area network file servers andworkstations.

storage pool. A named set of storage volumesthat TSM uses to store client data. A storage poolis either a primary storage pool or a copy storagepool. See primary storage pool and copy storagepool.

storage pool volume. A volume that has beenassigned to a TSM storage pool. See volume,copy storage pool, and primary storage pool.

storage privilege class. An administrativeprivilege class that allows an administrator tocontrol the allocation and use of storage resourcesfor the server, such as monitoring the database,recovery log, and server storage. Administratorscan be authorized with unrestricted or restrictedstorage privilege.

stub file. A file that replaces the original file on aclient node when the file is migrated from theclient node to TSM storage.

subscription. The method by which a managedserver requests that it receive configurationinformation associated with a particular profile ona configuration manager. See managed server,configuration manager, and profile.

superuser. See root user.

synchronized copy status. Specifies that thevolume is the only volume copy or is synchronizedwith other volume copies in the database orrecovery log. When synchronized, mirroring hasstarted.

system privilege class. An administrativeprivilege class that allows an administrator toissue all server commands.

Systems Application Architecture (SAA).Software interfaces, conventions, and protocolsthat provide a framework for designing anddeveloping applications that are consistent acrosssystems.

Systems Network Architecture (SNA). A set ofrules for data to be transmitted in a network.Application programs communicate with eachother using a layer of SNA called advancedprogram-to-program communications (APPC).

T

tape library. (1) A term used to refer to acollection of tape cartridges. (2) An automateddevice that performs tape cartridge mounts anddemounts without operator intervention.

Tape Library Dataserver. An automated tapelibrary consisting of mechanical components,cartridge storage frames, IBM tape subsystems,and controlling hardware and software. The tapelibrary dataserver performs tape cartridge mountsand demounts without operator intervention.

tape volume prefix. A device class attribute thatis the high-level-qualifier of the file name or thedata set name in the standard tape label.

target server. A server that can receive datasent from another server. Contrast with sourceserver. See also virtual volumes.

TCP/IP. Transmission Control Protocol/InternetProtocol.

Telnet. In TCP/IP, the protocol that opens theconnection to the system.

Tivoli Disaster Recovery Manager (DRM). Aproduct that works with TSM to assist in preparingand later using a disaster recovery plan for theTSM server.

Glossary 923

|||||

|||||

Tivoli Storage Manager (TSM). A client/serverprogram that provides storage management tocustomers in a multivendor computer environment.

Transmission Control Protocol/InternetProtocol (TCP/IP). A set of communicationprotocols that support peer-to-peer connectivityfunctions for both local and wide area networks.

trusted communication agent. A program thatperforms communication tasks on behalf of theclient or server, and ensures the security of thecommunications.

TSM. Tivoli Storage Manager.

TSM application program interface (API). A setof functions that applications running on a clientplatform can call to store, query, and retrieveobjects from TSM storage.

TSM command script. A sequence of TSMadministrative commands that are stored in theTSM database. The script can include substitutionfor command parameters and conditional logic.You can run the script from any interface to theserver.

U

unit name. On an MVS server, a device classattribute that specifies a group of tape devicesused with the MVS server. A unit name can be ageneric device type, an esoteric unit name, or aphysical device.

UNIX System Services. MVS/ESA services thatsupport an environment within which operatingsystems, servers, distributed systems, andworkstations share common interfaces. UNIXSystem Services supports standard applicationdevelopment across multivendor systems and isrequired to create and use applications thatconform to the POSIX standard. UNIX SystemServices was formerly known as OpenEdition®

MVS.

utilization. The percent of assigned capacityused by the database or recovery log at a specificpoint of time.

V

validate. The process of ensuring that the activepolicy set contains a default management classand reporting on copy group definition errors.

version. The maximum number of backup copiesretained for files and directories. The followingcopy group attributes define version criteria:versions data exists and versions data deleted.

Virtual Machine (VM). One of the family of IBMoperating systems for the System/390 processor,including VM/ESA®.

Virtual Storage Extended (VSE). One of thefamily of IBM operating systems for theSystem/390 processor, including VSE/ESA™.

virtual volume. A volume that appears to be asequential media volume on a source server butthat is actually stored as an archive file on a targetserver.

VM. Virtual Machine.

volume. The basic unit of storage for the TSMdatabase, recovery log, and storage pools. Avolume can be an LVM logical volume, a standardfile system file, a tape cartridge, or an opticalcartridge. Each volume is identified by a uniquevolume identifier. See database volume, scratchvolume, and storage pool volume.

volume history file. A file that containsinformation about: volumes used for databasebackups and database dumps; volumes used forexport of administrator, node, policy, or serverdata; and sequential access storage pool volumesthat have been added, reused, or deleted. Theinformation is a copy of the same types of volumeinformation in the TSM database.

VSE. Virtual Storage Extended.

W

wildcard character. A character or set ofcharacters used to specify an unknown number orset of characters in a search string. Also calledpattern-matching character.


||||||

WORM. A type of optical media that can only bewritten to and cannot be erased.

X

X Windows. A network transparent windowingsystem developed by MIT. It is the basis for otherproducts, such as Enhanced X Windows whichruns on the AIX operating system.

Glossary 925

Index

Numerics3490 device type (CARTRIDGE) 1293570 device type 1263590 device type 1238MM device type 116

AACCEPT DATE command 28account record, setting 636ACTIVATE POLICYSET command 29activating policy sets 29activity log

querying 383setting retention period 637

administrative clientbatch mode 13, 16console mode 13, 16continuation characters 15interactive mode 13, 17mount mode 13, 16privilege classes 19TSM 13using 13

administrative client optionsoutfile 16

administrative commandcomponents 5entering 5entry rules 5formatting terminal output 6help 334issued by all administrators 25issued with analyst privilege 24issued with operator privilege 24issued with policy privilege 21issued with storage privilege 23issued with system privilege 19naming conventions 9positional parameters

optional 5required 5

privilege class for 19processing

background 6, 7foreground 6

scheduling 187using 27using wildcard characters 8

administrative scheduleassociating with profile 165copying 78defining 187

administrative schedule (continued)deleting 269distributing 171updating 769

administrative session, canceling 59administrator

associating with profile 165distributing 171exporting 305importing 337locking 354querying 388registering 586removing 595renaming 598updating 703

archivedefining 101description of 101frequency 102retention grace period 139, 743

archive copy groupattributes of 95defining 95serialization 95

AS400MLB librariesabout 148defining 149

ASSIGN DEFMGMTCLASS command 31assigning

client node to domain 590, 759default management class 31

association, object with profiledefining 165deleting 261

association of client with scheduledefining 86deleting 228querying 393

AUDIT LIBRARY command 33AUDIT LICENSES command 35audit occupancy

displaying storage pool utilization 395querying 395

AUDIT VOLUME command 37auditing

library 33storage pool volume 37

authenticationsetting open or closed 638web time-out 698


authorityclient access 327client owner 327for command use 19granting 327revoking 619unlocking 700use of 14

Bbackground process

canceling 55query process 55, 504

backupclient 96database 41device information 45primary storage pool 47scheduling for client 179trigger for database 105volume history 50

backup copy groupattributes of 95defining 95serialization 95updating 708

BACKUP DB command 41BACKUP DEVCONFIG command 45BACKUP STGPOOL command 47BACKUP VOLHISTORY command 50batch mode

ending 16restrictions 16starting 16using 16

BEGIN EVENTLOGGING command 52buffer pool statistic, resetting 607

Ccancel

administrative session 59client node session 59mount requests 57process 55restartable restore session 58

CANCEL PROCESS command 55CANCEL REQUEST command 57CANCEL RESTORE command 58CANCEL SESSION command 59CARTRIDGE device type 129characters available for specifying passwords 10CHECKIN LIBVOLUME command 61CHECKOUT LIBVOLUME command 65CHGADMADSM command parameters

CSI 865DSPPARM 865

CHGSVRADSM command parametersAPPC 878CLTCNN 880CSLMSGQ 885CSLOUT 885DBPARM 888DEVCFGFILE 891DSPPARM 886IPX 879JOBPOOL 883, 884LIC 876MNTMSGQ 886RCYLOGPARM 889STGAUDIT 884SVRPARM 871TCP 871VOLHSTFILE 890

Client access authority 327client node session

canceling 59scheduling 178

client owner authority 327collocation 214, 218command line interface

administrative client 13using 13

command routingdefining server groups for 10defining servers for 10syntax 5

commandsACCEPT DATE 28ACTIVATE POLICYSET 29ASSIGN DEFMGMTCLASS 31AUDIT LIBRARY 33AUDIT LICENSES 35AUDIT VOLUME 37BACKUP DB 41BACKUP DEVCONFIG 45BACKUP STGPOOL 47BACKUP VOLHISTORY 50BEGIN EVENTLOGGING 52CANCEL PROCESS 55CANCEL REQUEST 57CANCEL RESTORE 58CANCEL SESSION 59CHECKIN LIBVOLUME 61CHECKOUT LIBVOLUME 65CHGADMADSM 865CHGSVRADM 871COMMIT 67COPY CLOPTSET 69COPY DOMAIN 70COPY MGMTCLASS 72COPY POLICYSET 74


commands (continued)COPY PROFILE 76COPY SCHEDULE 78COPY SCRIPT 83COPY SERVERGROUP 84CRTVOLADSM 852DEFINE ASSOCIATION 86DEFINE CLIENTACTION 88DEFINE CLIENTOPT 91DEFINE CLOPTSET 93DEFINE COPYGROUP 95DEFINE DBBACKUPTRIGGER 105DEFINE DBCOPY 107DEFINE DBVOLUME 109DEFINE DEVCLASS 111DEFINE DOMAIN 139DEFINE DRIVE 141DEFINE EVENTSERVER 143DEFINE EXIT 144DEFINE GRPMEMBER 146DEFINE LIBRARY 148DEFINE LOGCOPY 152DEFINE LOGVOLUME 154DEFINE MACHINE 156DEFINE MACHNODEASSOCIATION 158DEFINE MGMTCLASS 160DEFINE POLICYSET 163DEFINE PROFASSOCIATION 165DEFINE PROFILE 171DEFINE RECMEDMACHASSOCIATION 173DEFINE RECOVERYMEDIA 175DEFINE SCHEDULE 178DEFINE SCRIPT 194DEFINE SERVER 197DEFINE SERVERGROUP 201DEFINE SPACETRIGGER 203DEFINE STGPOOL 205DEFINE SUBSCRIPTION 222DEFINE VOLUME 224DELETE ASSOCIATION 228DELETE CLIENTOPT 230DELETE CLOPTSET 232DELETE COPYGROUP 233DELETE DBBACKUPTRIGGER 235DELETE DBVOLUME 236DELETE DEVCLASS 238DELETE DOMAIN 239DELETE DRIVE 240DELETE EVENT 241DELETE EXIT 244DELETE FILESPACE 246DELETE GRPMEMBER 249DELETE LIBRARY 251DELETE LOGVOLUME 252DELETE MACHINE 254

commands (continued)DELETE MACHNODEASSOCIATION 256DELETE MGMTCLASS 257DELETE POLICYSET 259DELETE PROFASSOCIATION 261DELETE PROFILE 265DELETE RECMEDMACHASSOCIATION 267DELETE RECOVERYMEDIA 268DELETE SCHEDULE 269DELETE SCRIPT 273DELETE SERVER 275DELETE SERVERGROUP 276DELETE SPACETRIGGER 277DELETE STGPOOL 279DELETE SUBSCRIBER 281DELETE SUBSCRIPTION 283DELETE VOLHISTORY 285DELETE VOLUME 289DISABLE EVENTS 292DISABLE SESSIONS 295DISMOUNT VOLUME 296DMPADSM 834DSPVOLADSM 825ENABLE EVENTS 297, 301ENABLE SESSIONS 300ENDSVRADSM 898EXPIRE INVENTORY 303EXPORT ADMIN 305EXPORT NODE 309EXPORT POLICY 314EXPORT SERVER 318EXTEND DB 323EXTEND LOG 325GRANT AUTHORITY 327HALT 332HELP 334IMPORT ADMIN 337IMPORT NODE 340IMPORT POLICY 345IMPORT SERVER 348INSERT MACHINE 352INZSVRADSM 838LOCK ADMIN 354LOCK NODE 355LOCK PROFILE 356LODADSM 846MACRO 358MOVE DATA 360MOVE DRMEDIA 362MOVE GRPMEMBER 375NOTIFY SUBSCRIBERS 377PING SERVER 378PREPARE 379QUERY ACTLOG 383QUERY ADMIN 388

Index 929

commands (continued)QUERY ASSOCIATION 393QUERY AUDITOCCUPANCY 395QUERY CLOPTSET 398QUERY CONTENT 401QUERY COPYGROUP 407QUERY DB 412QUERY DBBACKUPTRIGGER 416QUERY DBVOLUME 418QUERY DEVCLASS 421QUERY DOMAIN 424QUERY DRIVE 428QUERY DRMEDIA 431QUERY DRMSTATUS 439QUERY ENABLED 442QUERY EVENT 444QUERY EVENTRULES 457QUERY EVENTSERVER 243, 460QUERY EXIT 461QUERY FILESPACE 464QUERY LIBRARY 467QUERY LIBVOLUME 470QUERY LICENSE 472QUERY LOG 474QUERY LOGVOLUME 477QUERY MACHINE 480QUERY MGMTCLASS 484QUERY MOUNT 488QUERY NODE 489QUERY OCCUPANCY 495QUERY OPTION 499QUERY POLICYSET 501QUERY PROCESS 504QUERY PROFILE 506QUERY RECOVERYMEDIA 510QUERY REQUEST 513QUERY RESTORE 514QUERY RPFCONTENT 516QUERY RPFILE 518QUERY SCHEDULE 521QUERY SCRIPT 531QUERY SERVER 535QUERY SERVERGROUP 540QUERY SESSION 542QUERY SPACETRIGGER 545QUERY SQLSESSION 548QUERY STATUS 550QUERY STGPOOL 555QUERY SUBSCRIBER 561QUERY SUBSCRIPTION 563QUERY SYSTEM 565QUERY VOLHISTORY 567QUERY VOLUME 573QUIT 578RECONCILE VOLUMES 579

commands (continued)REDUCE DB 582REDUCE LOG 584REGISTER ADMIN 586REGISTER LICENSE 588REGISTER NODE 590REMOVE ADMIN 595REMOVE NODE 596RENAME ADMIN 598RENAME FILESPACE 599RENAME NODE 601RENAME SCRIPT 602RENAME SERVERGROUP 603RESET BUFPOOL 607RESET DBMAXUTILIZATION 608RESET LOGCONSUMPTION 609RESET LOGMAXUTILIZATION 610RESTORE STGPOOL 611RESTORE VOLUME 615REVOKE AUTHORITY 619ROLLBACK 623RUN 625SELECT 628SET ACCOUNTING 636SET ACTLOGRETENTION 637SET AUTHENTICATION 638SET CLIENTACDURATION 639SET CONFIGMANAGER 640SET CONFIGREFRESH 642SET CROSSDEFINE 644SET DRMCHECKLABEL 645SET DRMCMDFILENAME 646SET DRMCOPYSTGPOOL 647SET DRMCOURIERNAME 649SET DRMDBBACKUPEXPIREDAYS 650SET DRMFILEPROCESS 652SET DRMINSTRPREFIX 653SET DRMNOTMOUNTABLENAME 655SET DRMPLANPREFIX 656SET DRMPLANVPOSTFIX 657SET DRMPRIMSTGPOOL 659SET DRMRPFEXPIREDAYS 660SET DRMVAULTNAME 662SET EVENTRETENTION 663SET INVALIDPWLIMIT 665SET LICENSEAUDITPERIOD 666SET LOGMODE 667SET LRECLRECOVERYFILE 669SET MAXCMDRETRIES 670SET MAXSCHEDSESSIONS 672SET MINPWLENGTH 674SET PASSEXP 675SET QUERYSCHEDPERIOD 677SET RANDOMIZE 679SET REGISTRATION 681


commands (continued)SET RETRYPERIOD 683SET SCHEDMODES 685SET SERVERHLADDRESS 687SET SERVERLLADDRESS 688SET SERVERNAME 689SET SERVERPASSWORD 690SET SERVERURL 691SET SUMMARYRETENTION 696SET WEBAUTHTIMEOUT 698SETOPT 699STRAUDADSM 849STRRSTADSM 828STRSVRADSM 856UNLOCK ADMIN 700UNLOCK NODE 701UNLOCK PROFILE 702UPDATE ADMIN 703UPDATE CLIENTOPT 705UPDATE CLOPTSET 706UPDATE COPYGROUP 707UPDATE DBBACKUPTRIGGER 716UPDATE DEVCLASS 718UPDATE DOMAIN 743UPDATE DRIVE 745UPDATE EXIT 748UPDATE LIBRARY 750UPDATE LIBVOLUME 752UPDATE MACHINE 754UPDATE MGMTCLASS 756UPDATE NODE 759UPDATE POLICYSET 763UPDATE PROFILE 765UPDATE RECOVERYMEDIA 767UPDATE SCHEDULE 769UPDATE SCRIPT 785UPDATE SERVER 788UPDATE SERVERGROUP 792UPDATE SPACETRIGGER 793UPDATE STGPOOL 795UPDATE VOLHISTORY 811UPDATE VOLUME 813VALIDATE POLICYSET 818VARY 820WRKDEVADSM 862

commands in a macrocommitting 67rolling back 623

COMMIT command 67committing commands in a macro 67configuration manager 222configuration profile 171console mode

restrictions 16using 16

continuation charactersdescription of 15restriction of 15using the maximum number of 15

COPY CLOPTSET command 69COPY DOMAIN command 70copy group

defining archive 95defining backup 95deleting 233description of 95querying 407restriction 95updating archive 707updating backup 707

COPY MGMTCLASS command 72COPY POLICYSET command 74COPY PROFILE command 76COPY SCHEDULE command 78COPY SCRIPT 83COPY SERVERGROUP command 84copying

management class 72policy domain 70policy set 74profile 76schedule 78script 83server group 84

CRTVOLADSM command 852

Ddata

moving 360removing expired 303

databasebackup 41backup trigger 105extending 323querying 412reducing 582resetting maximum utilization statistic 608restoring 828space trigger 203volume information 418

database maximum utilization statisticresetting 608

database recoveryback up volume history 50delete volume history 285DMPADSM command 834LODADSM command 846query volume history 567STRAUDADSM command 849

database volumedefining 109

Index 931

database volume (continued)deleting 236querying 418

default management class assigning 31DEFINE ASSOCIATION command 86DEFINE CLIENTACTION command 88DEFINE CLIENTOPT command 91DEFINE CLOPTSET command 93DEFINE COPYGROUP command 95DEFINE DBBACKUPTRIGGER command 105DEFINE DBCOPY command 107DEFINE DBVOLUME command 109DEFINE DEVCLASS command 111DEFINE DOMAIN command 139DEFINE DRIVE command 141DEFINE EVENTSERVER command 143DEFINE EXIT command 144DEFINE GRPMEMBER command 146DEFINE LIBRARY command 148DEFINE LOGCOPY command 152DEFINE LOGVOLUME command 154DEFINE MACHINE command 156DEFINE MACHNODEASSOCIATION command 158DEFINE MGMTCLASS command 160DEFINE POLICYSET command 163DEFINE PROFASSOCIATION command 165DEFINE PROFILE command 171DEFINE RECMEDMACHASSOCIATION command 173DEFINE RECOVERYMEDIA command 175DEFINE SCHEDULE command 178DEFINE SCRIPT command 194DEFINE SERVER command 197DEFINE SERVERGROUP command 201DEFINE SPACETRIGGER command 203DEFINE STGPOOL command 205DEFINE SUBSCRIPTION command 222DEFINE VOLUME command 224defining

association 86client with schedule 179configuration manager 222copy group 95database backup trigger 105database volume 109device class 111devices to TSM 862domain 139drive 141event server 143group member 146library 148management class 160mirrored database volume 107mirrored log volume 152object with profile 165

defining (continued)policy set 163profile 171profile association 165recovery log volume 154schedule 178script 194server 197server group 201spacetrigger 203storage pool 205storage pool volume 224subscription 222

DELETE ASSOCIATION command 228DELETE CLIENTOPT command 230DELETE CLOPTSET command 232DELETE COPYGROUP command 233DELETE DBBACKUPTRIGGER command 235DELETE DBVOLUME command 236DELETE DEVCLASS command 238DELETE DOMAIN command 239DELETE DRIVE command 240DELETE EVENT command 241DELETE EXIT command 244DELETE FILESPACE command 246DELETE LIBRARY command 251DELETE LOGVOLUME command 252DELETE MACHINE command 254DELETE MACHNODEASSOCIATION command 256DELETE MGMTCLASS command 257DELETE POLICYSET command 259DELETE PROFASSOCIATION command 261DELETE PROFILE command 265DELETE RECMEDMACHASSOCIATION

command 267, 646DELETE RECOVERYMEDIA command 268DELETE SCHEDULE command 269DELETE SCRIPT command 273DELETE SERVER command 275DELETE SERVERGROUP command 276DELETE SPACETRIGGER command 277DELETE STGPOOL command 279DELETE SUBSCRIBER command 281DELETE SUBSCRIPTION command 283DELETE VOLHISTORY command 285DELETE VOLUME command 289deleting

copy group 233database backup trigger 235database volume 236device class 238domain 239drive 240event record 241event server 243


deleting (continued)expired data 303file space 246group member 249library 251management class 257policy set 259profile 265profile association 261recovery log volume 252schedule 269script 273server 275server group 276spacetrigger 277storage pool 279storage pool volume 289subscriber 281subscription 283volume history 285

determining retention periods for policy domains 424device class

3590 728defining 111deleting 238QIC 119querying 421REEL 135restriction 112updating 718

device configuration file 45device type

3570 1263590 123, 728, 7318MM 116, 722CARTRIDGE 129, 734FILE 112, 114, 133, 719, 720, 737QIC 119, 725REEL 135

DISABLE EVENTS command 292DISABLE SESSIONS command 295disabling the server 295DISMOUNT VOLUME command 296dismounting volumes 296displaying

scheduled and completed events 444volume information 825

DMPADSM command 834domain

associating with profile 165copy 70defining 139deleting 239distributing 171querying 424

domain (continued)updating 743

drivedefining 141, 428deleting 240updating 745

DSPVOLADSM command 825dumping the TSM database 834

EENABLE EVENTS command 297ENABLE SESSIONS command 300enabling the server 300END EVENTLOGGING command 301ending

batch mode 16server for TSM 898

ENDSVRADSM command 898entering administrative commands 5event, querying 444event logging

description of 241, 663managing 663querying 444, 550removing from the database 241send events to receivers 52set logging off by receivers 301setting retention period 663

exit programdefining 144example of 145querying 461types of 144

EXPIRE INVENTORY command 303expiring inventory 303export

administrator 305node 309policy information 314server 318

EXPORT ADMIN command 305EXPORT NODE command 309EXPORT POLICY command 314EXPORT SERVER command 318EXTEND DB command 323EXTEND LOG command 325extending

database 323recovery log 325

FFILE device type 112, 114, 720file space

deleting 246querying 464renaming 599

Index 933

filescollocating by client 214, 218moving 360removing expired files 303

GGRANT AUTHORITY command 327granting

authority 327types of privilege classes 327

HHALT command 332halting the server 332HELP command 334help for administrative commands 334hierarchical storage management

DEFINE MGMTCLASS 160description of 160UPDATE MGMTCLASS 756

hierarchy of storage poolsconsiderations for backup 47defining 205

history informationbacking up 50deleting 285querying 567

IIMPORT ADMIN command 337IMPORT NODE command 340IMPORT POLICY command 345IMPORT SERVER command 348importing

administrator 337node 340policy information 345server 348

incremental backup of database 41INSERT MACHINE command 352interactive mode

continuation characters 15quitting 578restrictions 17using 17

inventory expiring 303INZSVRADSM command parameters

DBVOL 838LOGVOL 838

issuing commands for a one-time action 88

Llibrary

auditing 33defining 148deleting 251

library (continued)manual 149querying 467types of 148updating 750user defined 149

library volumechecking out 65querying 470updating 752

licenseauditing 35querying 472registering 588setting audit period 666

loading the TSM database 846LOCK ADMIN command 354LOCK NODE command 355LOCK PROFILE command 356locking

administrator 354node 355profile 356

LODADSM command 846log mode, setting 667logic flow statements in scripts 901logical record length setting 669

MMACRO command 358macros

continuation characters 15rolling back 623using 358

managed server 222management class

copying 72defining the default 31deleting 257querying 484updating 756

MANUAL library 148maximum retries, setting 670media mount requests 57member, server group 146migration

files from client node 161storage pool 205

mirrored database volumedefining 107description of 107

mirrored log volumedefining 152description of 109

monitoringTSM activities 16


mount modeusing 16

mount request 57canceling 57querying 513

mounted sequential access volumesdismounting 296querying 488

MOVE DATA command 360MOVE DRMEDIA command 362MOVE GRPMEMBER command 375moving

data in storage pool 360files 360group member 375

Nnaming conventions

case-sensitivity 5introduction 9naming volumes 9passwords 9restrictions 10

nodeassociating with a schedule 86exporting 309finding file for 495importing 340locking 355querying 489registering 590removing 596renaming 601unlocking 701updating 759

normal recovery log mode 41, 667NOTIFY SUBSCRIBERS command 377

example 377related commands 377

Ooccupancy

displaying filespace information 495querying 495

options, serverimportance for recovery 41querying 499

Ppasswords

case-sensitivity 9, 10characters allowed for entering 10entered with the REGISTER ADMIN command 586entered with the REGISTER NODE command 590entered with the UPDATE ADMIN command 703setting expiration interval 675

passwords (continued)setting the maximum length 10

pattern-matching expressioncreating 8

policy domainassociating with profile 165copy 70defining 139deleting 239distributing 171querying 424updating 743

policy privilege classadministrative commands 21restricted 21unrestricted 21

policy setactivating 29copying 74defining 163deleting 259querying 501updating 763validating 818

pollinginformation about 677setting frequency 677

PREPARE command 379privilege class

administrative commands 23, 24administrator issued 25analyst 19, 24none 25operator 19policy 19, 22restricted 23storage 19, 23system 19unrestricted 23

processcanceling 55querying 504

profile 171profle association 165

QQIC device type 119QUERY ACTLOG command 383QUERY ADMIN command 388QUERY ASSOCIATION command 393QUERY AUDITOCCUPANCY command 395QUERY CLOPTSET command 398QUERY CONTENT command 401QUERY COPYGROUP command 407QUERY DB command 412QUERY DBBACKUPTRIGGER command 416

Index 935

QUERY DBVOLUME command 418QUERY DEVCLASS command 421QUERY DOMAIN command 424QUERY DRIVE command 428QUERY DRMEDIA command 431QUERY DRMSTATUS command 439QUERY ENABLED command 442QUERY EVENT command 444QUERY EVENTRULES command 243, 457, 460QUERY EXIT command 461QUERY FILESPACE command 464QUERY LIBRARY command 467QUERY LIBVOLUME command 470QUERY LICENSE command 472QUERY LOG command 474QUERY LOGVOLUME command 477QUERY MACHINE command 480QUERY MGMTCLASS command 484QUERY MOUNT command 488QUERY NODE command 489QUERY OCCUPANCY command 495QUERY OPTION command 499QUERY POLICYSET command 501QUERY PROCESS command 504QUERY PROFILE command 506QUERY RECOVERYMEDIA command 510QUERY REQUEST command 513QUERY RESTORE command 514QUERY RPFCONTENT command 516QUERY RPFILE command 518QUERY SCHEDULE command 521QUERY SCRIPT command 531QUERY SERVER command 535QUERY SERVERGROUP command 540QUERY SESSION command 542QUERY SPACETRIGGER command 545QUERY SQLSESSION command 548QUERY STATUS command 550QUERY STGPOOL command 555QUERY SUBSCRIBER command 561QUERY SUBSCRIPTION command 563QUERY SYSTEM command 565QUERY VOLHISTORY command 567QUERY VOLUME command 573querying

activity log 383administrator 388audit occupancy 395clients with schedules 393completed events 444contents of a volume 401copy group 407database 412database backup trigger 416database volume 418

querying (continued)device class 421domain 424drive 428event server 460file space 464library 467library volume 470license 472management class 484mount requests 513node 489occupancy 495option 499policy set 501process 504profile 506recovery log 474recovery log volume 477recovery plan file 518recovery plan file content 516scheduled events 444schedules 521script 531server group 540session 542spacetrigger 545status 550storage pool 555storage pool volume 573subscriber 561subscription 563volume history file 567

QUIT command 578quitting

interactive mode 578

Rreclamation of volumes 214, 219, 804, 808RECONCILE VOLUMES command 579recovery log

backup trigger 105consumption statistic, resetting 609extending 325maximum utilization statistic, resetting 610reducing 584setting mode 667

recovery log volumedefining 154deleting 252querying 477

recovery plan filedisplay contents 516query information 518set expire days 660


REDUCE DB command 582REDUCE LOG command 584reducing

database 582recovery log 584

REGISTER ADMIN command 586REGISTER LICENSE command 588REGISTER NODE command 590registering

administrator 586license 588node 590

registrationclosed 681description of 681setting 681

REMOVE ADMIN command 595REMOVE NODE command 596removing

administrator 595client association 228node 596storage volumes from library 65

RENAME ADMIN command 598RENAME FILESPACE command 599RENAME NODE command 601RENAME SCRIPT command 602RENAME SERVERGROUP command 603renaming

administrator 598file space 599node 601script 602server group 603storage pool 604

REPLY command 606RESET BUFPOOL command 607RESET DBMAXUTILIZATION command 608RESET LOGCONSUMPTION command 609RESET LOGMAXUTILIZATION command 610resetting

buffer pool statistic 607maximum utilization statistic (recovery log) 610recovery log consumption statistic 609

RESTORE STGPOOL command 611RESTORE VOLUME command 615restoring

multiple volumes 828single volumes 828TSM database 828

retention perioddescription of 663setting 663

retry perioddescription of 683

retry period (continued)setting 683

return code checking 901REVOKE AUTHORITY command 619revoking

authority 619types of privilege classes 619

roll-forward recovery log mode 41, 667ROLLBACK command 623rolling back commands in a macro 623routing commands 10RUN command 625

Sschedule

administrative command 187associating with a client node 86client 180, 187copying 78defining 160, 178deleting 269description of 187querying 521querying results of (events) 444restrictions of 178startup window 182, 189, 773, 780types of 178updating 769

schedule eventquerying 444setting start date for displaying 445setting start time for displaying 446, 447, 453, 454viewing information about 444

scheduling modecopying 83defining 194deleting 273information about 685querying 531renaming 602running 625setting 685updating 785

scratch volumes in storage pool 215, 219, 805, 809SELECT command 628sequential volume history

backing up 50deleting 285display sequential volume history 567querying 567

serverdisabling 295enabling 300ending 898exporting 318importing 348

Index 937

server (continued)initializing for TSM 838setting name for 689starting 856

server name settings 689server options

APPC 878CLTCNN 880CSLMSGQ 885CSLOUT 885DBPARM 888DEVCFGFILE 891DSPPARM 886IPX 879JOBPOOL 883, 884LIC 876MNTMSGQ 886RCYLOGPARM 889SVRPARM 881TCP 871VOLHSTFILE 890

server-to-server communications 197session

maximum number scheduled 672querying 542

SET ACCOUNTING command 636SET ACTLOGRETENTION command 637SET AUTHENTICATION command 638SET CLIENTACTDURATION command 639SET CONFIGMANAGER command 640SET CONFIGREFRESH command 642SET CROSSDEFINE command 644SET DRMCHECKLABEL command 645SET DRMCMDFILENAME command 646SET DRMCOPYSTGPOOL command 647SET DRMCOURIERNAME command 649SET DRMDBBACKUPEXPIREDAYS command 650SET DRMFILEPROCESS command 652SET DRMINSTRPREFIX command 653SET DRMNOTMOUNTABLENAME command 655SET DRMPLANPREFIX command 656SET DRMPLANVPOSTFIX command 657SET DRMPRIMSTGPOOL command 659SET DRMRPFEXPIREDAYS command 660SET DRMVAULTNAME command 662SET EVENTRETENTION command 663SET INVALIDPWLIMIT command 665SET LICENSEAUDITPERIOD command 666SET LOGMODE command 667SET LRECLRECOVERYFILE command 669SET MAXCMDRETRIES command 670SET MAXSCHEDSESSIONS command 672SET MINPWLENGTH command 674SET PASSEXP command 675SET QUERYSCHEDPERIOD 677

SET RANDOMIZE command 679SET REGISTRATION command 681SET RETRYPERIOD command 683SET SCHEDMODES 685SET SERVERNAME 689SET SRVHLADDRESS 687SET SRVLLADDRESS 688SET SRVPASSWORD 690SET SRVURL 691SET SUMMARYRETENTION command 696SET WEBAUTHTIMEOUT 698SETOPT command 699setting

accounting record 636authentication 638configuration manager 640configuration refresh 642cross define of a server 644frequency for client-polling 677frequency for one-time client action 639high level address of a server 687license audit period 666low level address of a server 688maximum retries of a command 670maximum scheduled sessions 672password for a server 690password for expiration date 675randomization of start times 679recovery log mode 667registration 681retention period for activity log 637retention period for event records 663retry period 683scheduling mode 685server name 689summaryretention days 696URL for server 691web authentication time-out 698

space managementDEFINE MGMTCLASS 160description of 160UPDATE MGMTCLASS 756

space trigger commandsDEFINE SPACETRIGGER 203DELETE SPACETRIGGER 277QUERY SPACETRIGGER 545UPDATE SPACETRIGGER 793

start timeinformation about 178setting 679

startingbatch mode 16server for TSM 856

statusinformation about 550


status (continued)querying 550

storage pooldefining 205deleting 279querying 555restoring 611updating 795

storage pool volumeauditing 37defining 224deleting 289querying 401, 573scratch 215, 219, 805, 809updating 813varying 820

storage volumesnaming 9

STRAUDADSM command parametersAUDFILE 849AUDMBR 849DETAIL 849

STRRSTADSM command parametersRCYLOG 828RSTDATE 829VOLFILE 832

STRSVRADSM command parametersEXPIRE 858

syntax diagramabbreviations 1default value 3fragments 3optional choice 2repeatable choice 3repeating values 2required choices 2symbols 1using 1variables 2

system privilege classadministrative commands 19

Ttape

AUDIT LIBRARY command 33AUDIT VOLUME command 37CHECKIN LIBVOLUME command 61CHECKOUT LIBVOLUME command 65DEFINE DEVCLASS command 111DEFINE DRIVE command 141DEFINE LIBRARY command 148DEFINE STGPOOL command 205, 211, 217DEFINE VOLUME command 224DELETE DEVCLASS command 238DELETE DRIVE command 240

tape (continued)DELETE LIBRARY command 251DELETE VOLUME command 289QUERY DEVCLASS command 421QUERY DRIVE command 428QUERY LIBRARY command 467QUERY LIBVOLUME command 470QUERY VOLUME command 573UPDATE DEVCLASS command 718UPDATE DRIVE command 745UPDATE LIBRARY command 750UPDATE LIBVOLUME command 752UPDATE VOLUME command 813

terminal output, formatting 6trigger, for database backup 105, 416type, device

3570 1263590 123, 728, 7318MM 116, 722CARTRIDGE 129, 734FILE 112, 114, 133, 719, 720, 737QIC 119, 725REEL 135, 739

UUNLOCK ADMIN command 700UNLOCK NODE command 701UNLOCK PROFILE command 702unlocking

administrator 700node 701profile 702

UPDATE ADMIN command 703UPDATE CLIENTOPT command 705UPDATE CLOPTSET command 706UPDATE COPYGROUP command 707UPDATE DBBACKUPTRIGGER command 716UPDATE DEVCLASS command 718UPDATE DOMAIN command 743UPDATE DRIVE command 745UPDATE EXIT command 748UPDATE LIBRARY command 750UPDATE LIBVOLUME command 752UPDATE MACHINE command 754UPDATE MGMTCLASS command 756UPDATE NODE command 759UPDATE POLICYSET command 763UPDATE PROFILE command 765UPDATE RECOVERYMEDIA command 767UPDATE SCHEDULE command 769UPDATE SCRIPT command 785UPDATE SERVER command 788UPDATE SERVERGROUP command 792UPDATE SPACETRIGGER command 793UPDATE STGPOOL command 795

Index 939

UPDATE VOLHISTORY 811UPDATE VOLUME command 813updating

administrator 703copy group 707database and recovery log space triggers 793database backup trigger 716device class 718domain 743drive 745library 750library volume 752management class 756node 759policy set 763profile 765schedule 769script 785server group 792storage pool 795storage pool volume 813volume history 811

updating a backup copy group 707updating an archive copy group 707using

administrative privilege classes 19command-line interface 13commands by administrative privilege 19continuation characters 15macros 358syntax diagram 1system date on the server 28the AS/400 administrative client 13

USRDFN library 148

VVALIDATE POLICYSET command 818validating

policy set 818VARY command 820varying

volume 820verify automated library inventory 33VFYSVRADSM command 861volume history

deleting 285querying 567

volumes, storagedefining 224naming 9reclaiming 214, 219, 804, 808restoring 615scratch, maximum in storage pool 215, 219, 805,

809

Wweb authentication time-out 698wildcard

match-any examples 9match-exactly-one examples 9using 8


Program Number: 5697-TSM5697-DRM

Printed in the United States of Americaon recycled paper containing 10%recovered post-consumer fiber.

GC35-0316-01

Spine information:

Tivoli Storage Managerfor AS/400 Administrator’s Reference

Version 3Release 1

Tivoli Storage Manager for AS/400 -...

Documents

Transcript of Tivoli Storage Manager for AS/400 -...