IBM Tivoli Storage Manager for Oracle Solaris ... · IBM T ivoli Stora ge Mana ger for Orac le Solaris V ersion 7.1.3 Administra tor's Reference IBM

IBM Tivoli Storage Managerfor Oracle SolarisVersion 7.1.3

Administrator's Reference

IBM

Note:Before you use this information and the product it supports, read the information in Notices on page 1675.

Third edition (September 2015)

This edition applies to version 7, release 1, modification 3 of IBM Tivoli Storage Manager (product numbers5608-E01, 5608-E02, 5608-E03), and to all subsequent releases and modifications until otherwise indicated in neweditions.

Copyright IBM Corporation 1993, 2015.US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

About this publication . . . . . . .. xiiiWho should read this guide . . . . . . .. xiiiPublications . . . . . . . . . . . . .. xiiiConventions used in this publication . . . .. xiii

New for Tivoli Storage ManagerVersion 7.1.3 . . . . . . . . . . .. xvTivoli Storage Manager server updates . . . .. xv

Optimize a storage environment by using inlinedata deduplication . . . . . . . . . .. xvBack up data to a cloud computing system . .. xvArchive diagnostic messages by using operatingsystem tools . . . . . . . . . . . .. xviStart the server in maintenance mode . . .. xviDecommission a client node . . . . . .. xviDeactivate data to free server storage space .. xviNarrow the search results when you querysessions . . . . . . . . . . . . .. xviiSpecify an action for all client nodes . . .. xvii

Chapter 1. Managing the server from thecommand line . . . . . . . . . . .. 1Issuing commands from the administrative client .. 1

Starting and stopping the administrative client .. 2Monitoring server activities from theadministrative client . . . . . . . . . .. 2Monitoring removable-media mounts from theadministrative client . . . . . . . . . .. 3Processing individual commands from theadministrative client . . . . . . . . . .. 3Processing a series of commands from theadministrative client . . . . . . . . . .. 4Formatting output from commands. . . . .. 4Saving command output to a specified location.. 5Administrative client options . . . . . . .. 5

Issuing commands from the Operations Center . .. 8Issuing commands from the server console . . .. 8Entering administrative commands . . . . . .. 8

Reading syntax diagrams . . . . . . . .. 9Using continuation characters to enter longcommands. . . . . . . . . . . . .. 13Naming Tivoli Storage Manager objects . . .. 13Using wildcard characters to specify objectnames . . . . . . . . . . . . . .. 14Specifying descriptions in keyword parameters 15

Controlling command processing . . . . . .. 16Server command processing . . . . . . .. 16Stopping background processes. . . . . .. 17

Performing tasks concurrently on multiple servers 17Routing commands to a single server. . . .. 18Routing commands to multiple servers . . .. 18Routing commands to a server group. . . .. 18Routing commands to server groups . . . .. 19Routing commands to two servers and a servergroup . . . . . . . . . . . . . .. 19

Routing commands inside scripts . . . . .. 19Privilege classes for commands . . . . . . .. 20

Commands requiring system privilege . . .. 20Commands requiring policy privilege . . .. 23Commands requiring storage privilege . . .. 24Commands requiring operator privilege . . .. 25Commands any administrator can issue . . .. 26

Chapter 2. Administrative commands 29ACCEPT DATE (Accepts the current system date) 30ACTIVATE POLICYSET (Activate a new policy set) 31ASSIGN DEFMGMTCLASS (Assign a defaultmanagement class) . . . . . . . . . . .. 33AUDIT commands . . . . . . . . . . .. 35

AUDIT CONTAINER commands . . . . .. 36AUDIT LDAPDIRECTORY (Audit an LDAPdirectory server) . . . . . . . . . . .. 43AUDIT LIBRARY (Audit volume inventories inan automated library) . . . . . . . . .. 45AUDIT LIBVOLUME (Verify databaseinformation for a tape volume) . . . . . .. 47AUDIT LICENSES (Audit server storage usage) 49AUDIT VOLUME (Verify database informationfor a storage pool volume) . . . . . . .. 50

BACKUP commands . . . . . . . . . .. 56BACKUP DB (Back up the database) . . . .. 57BACKUP DEVCONFIG (Create backup copies ofdevice configuration information) . . . . .. 63BACKUP NODE (Back up a NAS node) . . .. 65BACKUP STGPOOL (Back up primary storagepool data to a copy storage pool) . . . . .. 70BACKUP VOLHISTORY (Save sequential volumehistory information) . . . . . . . . .. 74

BEGIN EVENTLOGGING (Begin logging events) .. 76CANCEL commands . . . . . . . . . .. 78

CANCEL EXPIRATION (Cancel an expirationprocess) . . . . . . . . . . . . .. 79CANCEL EXPORT (Delete a suspended exportoperation) . . . . . . . . . . . . .. 80CANCEL PROCESS (Cancel an administrativeprocess) . . . . . . . . . . . . .. 81CANCEL REPLICATION (Cancel nodereplication processes) . . . . . . . . .. 83CANCEL REQUEST (Cancel one or more mountrequests) . . . . . . . . . . . . .. 84CANCEL RESTORE (Cancel a restartable restoresession). . . . . . . . . . . . . .. 85CANCEL SESSION (Cancel one or more clientsessions) . . . . . . . . . . . . .. 86

CHECKIN LIBVOLUME (Check a storage volumeinto a library). . . . . . . . . . . . .. 87CHECKOUT LIBVOLUME (Check a storage volumeout of a library) . . . . . . . . . . . .. 95CLEAN DRIVE (Clean a drive) . . . . . .. 101

Copyright IBM Corp. 1993, 2015 iii

||

COMMIT (Control committing of commands in amacro). . . . . . . . . . . . . . .. 102COPY commands . . . . . . . . . . .. 103

COPY ACTIVEDATA (Copy active backup datafrom a primary storage pool to an active-datapool) . . . . . . . . . . . . . .. 104COPY CLOPTSET (Copy a client option set) .. 108COPY DOMAIN (Copy a policy domain) . .. 109COPY MGMTCLASS (Copy a managementclass) . . . . . . . . . . . . . .. 111COPY POLICYSET (Copy a policy set) . . .. 113COPY PROFILE (Copy a profile) . . . . .. 115COPY SCHEDULE (Copy a client or anadministrative command schedule) . . . .. 117COPY SCRIPT (Copy a Tivoli Storage Managerscript) . . . . . . . . . . . . . .. 121COPY SERVERGROUP (Copy a server group) 122

DEACTIVATE DATA (Deactivate data for a clientnode) . . . . . . . . . . . . . . .. 123DECOMMISSION commands . . . . . . .. 126

DECOMMISSION NODE (Decommission anapplication or system) . . . . . . . .. 127DECOMMISSION VM (Decommission a virtualmachine) . . . . . . . . . . . . .. 130

DEFINE commands . . . . . . . . . .. 132DEFINE ALERTTRIGGER (Define an alerttrigger) . . . . . . . . . . . . .. 134DEFINE ASSOCIATION (Associate client nodeswith a schedule) . . . . . . . . . .. 137DEFINE BACKUPSET (Define a backup set) .. 139DEFINE CLIENTACTION (Define a one-timeclient action) . . . . . . . . . . .. 143DEFINE CLIENTOPT (Define an option to anoption set) . . . . . . . . . . . .. 149DEFINE CLOPTSET (Define a client option setname) . . . . . . . . . . . . . .. 151DEFINE COLLOCGROUP (Define a collocationgroup). . . . . . . . . . . . . .. 152DEFINE COLLOCMEMBER (Define collocationgroup member). . . . . . . . . . .. 154DEFINE COPYGROUP (Define a copy group) 158DEFINE DATAMOVER (Define a data mover) 168DEFINE DEVCLASS (Define a device class) .. 171DEFINE DOMAIN (Define a new policydomain) . . . . . . . . . . . . .. 233DEFINE DRIVE (Define a drive to a library) .. 235DEFINE EVENTSERVER (Define a server as theevent server) . . . . . . . . . . .. 240DEFINE GRPMEMBER (Add a server to aserver group) . . . . . . . . . . .. 241DEFINE LIBRARY (Define a library). . . .. 242DEFINE MACHINE (Define machineinformation for disaster recovery) . . . .. 262DEFINE MACHNODEASSOCIATION(Associate a node with a machine) . . . .. 264DEFINE MGMTCLASS (Define a managementclass) . . . . . . . . . . . . . .. 266DEFINE NODEGROUP (Define a node group) 269DEFINE NODEGROUPMEMBER (Define nodegroup member). . . . . . . . . . .. 270DEFINE PATH (Define a path) . . . . .. 271

DEFINE POLICYSET (Define a policy set) . .. 280DEFINE PROFASSOCIATION (Define a profileassociation) . . . . . . . . . . . .. 282DEFINE PROFILE (Define a profile) . . . .. 288DEFINE RECMEDMACHASSOCIATION(Associate recovery media with a machine) .. 290DEFINE RECOVERYMEDIA (Define recoverymedia) . . . . . . . . . . . . .. 292DEFINE SCHEDULE (Define a client or anadministrative command schedule) . . . .. 294DEFINE SCRATCHPADENTRY (Define ascratch pad entry) . . . . . . . . . .. 319DEFINE SCRIPT (Define a Tivoli StorageManager script) . . . . . . . . . .. 321DEFINE SERVER (Define a server forserver-to-server communications). . . . .. 324DEFINE SERVERGROUP (Define a servergroup). . . . . . . . . . . . . .. 331DEFINE SPACETRIGGER (Define the spacetrigger) . . . . . . . . . . . . .. 332DEFINE STATUSTHRESHOLD (Define a statusmonitoring threshold) . . . . . . . .. 335DEFINE STGPOOL (Define a storage pool) .. 339DEFINE STGPOOLDIRECTORY (Define astorage pool directory) . . . . . . . .. 394DEFINE SUBSCRIPTION (Define a profilesubscription) . . . . . . . . . . .. 396DEFINE VIRTUALFSMAPPING (Define avirtual file space mapping) . . . . . . .. 398DEFINE VOLUME (Define a volume in astorage pool) . . . . . . . . . . .. 400

DELETE commands . . . . . . . . . .. 406DELETE ALERTTRIGGER (Remove a messagefrom an alert trigger) . . . . . . . . .. 408DELETE ASSOCIATION (Delete the nodeassociation to a schedule) . . . . . . .. 409DELETE BACKUPSET (Delete a backup set) .. 411DELETE CLIENTOPT (Delete an option in anoption set) . . . . . . . . . . . .. 416DELETE CLOPTSET (Delete a client option set) 417DELETE COLLOCGROUP (Delete a collocationgroup). . . . . . . . . . . . . .. 418DELETE COLLOCMEMBER (Delete collocationgroup member). . . . . . . . . . .. 419DELETE COPYGROUP (Delete a backup orarchive copy group) . . . . . . . . .. 422DELETE DATAMOVER (Delete a data mover) 424DELETE DEDUPSTATS (Delete datadeduplication statistics) . . . . . . . .. 425DELETE DEVCLASS (Delete a device class) .. 429DELETE DOMAIN (Delete a policy domain) 430DELETE DRIVE (Delete a drive from a library) 431DELETE EVENT (Delete event records). . .. 432DELETE EVENTSERVER (Delete the definitionof the event server) . . . . . . . . .. 434DELETE FILESPACE (Delete client node datafrom the server) . . . . . . . . . .. 435DELETE GRPMEMBER (Delete a server from aserver group) . . . . . . . . . . .. 439DELETE KEYRING (Delete passwordinformation in the key database) . . . . .. 440

iv IBM Tivoli Storage Manager for Oracle Solaris: Administrator's Reference

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

||

DELETE LIBRARY (Delete a library). . . .. 441DELETE MACHINE (Delete machineinformation) . . . . . . . . . . . .. 442DELETE MACHNODEASSOCIATION (Deleteassociation between a machine and a node) .. 443DELETE MGMTCLASS (Delete a managementclass) . . . . . . . . . . . . . .. 444DELETE NODEGROUP (Delete a node group) 445DELETE NODEGROUPMEMBER (Delete nodegroup member). . . . . . . . . . .. 446DELETE PATH (Delete a path) . . . . .. 447DELETE POLICYSET (Delete a policy set) . .. 449DELETE PROFASSOCIATION (Delete a profileassociation) . . . . . . . . . . . .. 450DELETE PROFILE (Delete a profile) . . . .. 453DELETE RECMEDMACHASSOCIATION(Delete recovery media and machineassociation) . . . . . . . . . . . .. 455DELETE RECOVERYMEDIA (Delete recoverymedia) . . . . . . . . . . . . .. 456DELETE SCHEDULE (Delete a client or anadministrative command schedule) . . . .. 457DELETE SCRATCHPADENTRY (Delete ascratch pad entry) . . . . . . . . . .. 460DELETE SCRIPT (Delete command lines from ascript or delete the entire script) . . . . .. 461DELETE SERVER (Delete a server definition) 462DELETE SERVERGROUP (Delete a servergroup). . . . . . . . . . . . . .. 463DELETE SPACETRIGGER (Delete the storagepool space triggers) . . . . . . . . .. 464DELETE STATUSTHRESHOLD (Delete a statusmonitoring threshold) . . . . . . . .. 465DELETE STGPOOL (Delete a storage pool) .. 467DELETE STGPOOLDIRECTORY (Deleting astorage pool directory) . . . . . . . .. 468DELETE SUBSCRIBER (Delete subscriptionsfrom a configuration manager database) . .. 470DELETE SUBSCRIPTION (Delete a profilesubscription) . . . . . . . . . . .. 471DELETE VIRTUALFSMAPPING (Delete avirtual file space mapping) . . . . . . .. 472DELETE VOLHISTORY (Delete sequentialvolume history information) . . . . . .. 473DELETE VOLUME (Delete a storage poolvolume) . . . . . . . . . . . . .. 478

DISABLE commands . . . . . . . . . .. 481DISABLE EVENTS (Disable events for eventlogging) . . . . . . . . . . . . .. 482DISABLE REPLICATION (Prevent outboundreplication processing on a server) . . . .. 486DISABLE SESSIONS (Prevent new sessions fromaccessing Tivoli Storage Manager) . . . .. 487

DISMOUNT command . . . . . . . . .. 489DISMOUNT VOLUME (Dismount a volume byvolume name) . . . . . . . . . . .. 490

DISPLAY OBJNAME (Display a full object name) 491ENABLE commands . . . . . . . . . .. 492

ENABLE EVENTS (Enable server or clientevents for logging) . . . . . . . . .. 493

ENABLE REPLICATION (Allow outboundreplication processing on a server) . . . .. 496ENABLE SESSIONS (Resume user activity onthe server) . . . . . . . . . . . .. 497

END EVENTLOGGING (Stop logging events) .. 499EXPIRE INVENTORY (Manually start inventoryexpiration processing) . . . . . . . . .. 501EXPORT commands . . . . . . . . . .. 506

EXPORT ADMIN (Export administratorinformation) . . . . . . . . . . . .. 507EXPORT NODE (Export client nodeinformation) . . . . . . . . . . . .. 514EXPORT POLICY (Export policy information) 536EXPORT SERVER (Export server information) 543

EXTEND DBSPACE (Increase space for thedatabase) . . . . . . . . . . . . . .. 562GENERATE commands . . . . . . . . .. 565

GENERATE BACKUPSET (Generate a backupset of Backup-Archive Client data) . . . .. 566GENERATE BACKUPSETTOC (Generate a tableof contents for a backup set) . . . . . .. 575GENERATE DEDUPSTATS (Generate datadeduplication statistics) . . . . . . . .. 577

GRANT commands . . . . . . . . . .. 580GRANT AUTHORITY (Add administratorauthority) . . . . . . . . . . . .. 581GRANT PROXYNODE (Grant proxy authorityto a client node) . . . . . . . . . .. 585

HALT (Shut down the server) . . . . . . .. 586HELP (Get help on commands and error messages) 588IDENTIFY DUPLICATES (Identify duplicate datain a storage pool) . . . . . . . . . . .. 590IMPORT commands . . . . . . . . . .. 594

IMPORT ADMIN (Import administratorinformation) . . . . . . . . . . . .. 595IMPORT NODE (Import client nodeinformation) . . . . . . . . . . . .. 599IMPORT POLICY (Import policy information) 606IMPORT SERVER (Import server information) 609

INSERT MACHINE (Insert machine characteristicsinformation or recovery instructions) . . . .. 615ISSUE MESSAGE (Issue a message from a serverscript) . . . . . . . . . . . . . . .. 616LABEL LIBVOLUME (Label a library volume) .. 618LOAD DEFALERTTRIGGERS (Load the default setof alert triggers) . . . . . . . . . . .. 625LOCK commands . . . . . . . . . . .. 627

LOCK ADMIN (Lock out an administrator) .. 628LOCK NODE (Lock out a client node) . . .. 630LOCK PROFILE (Lock a profile) . . . . .. 632

MACRO (Invoke a macro) . . . . . . . .. 634MIGRATE STGPOOL (Migrate storage pool to nextstorage pool) . . . . . . . . . . . .. 636MOVE commands . . . . . . . . . . .. 639

MOVE CONTAINER (Move a container) . .. 639MOVE DATA (Move files on a storage poolvolume) . . . . . . . . . . . . .. 641MOVE DRMEDIA (Move disaster recoverymedia offsite and back onsite) . . . . . .. 645MOVE GRPMEMBER (Move a server groupmember) . . . . . . . . . . . . .. 660

Contents v

|||

|||

|||

||

MOVE MEDIA (Move sequential access storagepool media) . . . . . . . . . . . .. 661MOVE NODEDATA (Move data by node in asequential access storage pool) . . . . .. 669

NOTIFY SUBSCRIBERS (Notify managed serversto update profiles). . . . . . . . . . .. 679PERFORM LIBACTION (Define or delete all drivesand paths for a library) . . . . . . . . .. 680PING SERVER (Test the connection betweenservers) . . . . . . . . . . . . . .. 684PREPARE (Create a recovery plan file) . . . .. 685PROTECT STGPOOL (Protect data that belongs toa storage pool) . . . . . . . . . . . .. 690QUERY commands . . . . . . . . . .. 693

QUERY ACTLOG (Query the activity log) . .. 696QUERY ADMIN (Display administratorinformation) . . . . . . . . . . . .. 702QUERY ALERTTRIGGER (Query the list ofdefined alert triggers) . . . . . . . .. 707QUERY ALERTSTATUS (Query the status of analert) . . . . . . . . . . . . . .. 709QUERY ASSOCIATION (Query client nodeassociations with a schedule) . . . . . .. 714QUERY AUDITOCCUPANCY (Query clientnode storage utilization). . . . . . . .. 716QUERY BACKUPSET (Query a backup set) .. 719QUERY BACKUPSETCONTENTS (Querycontents of a backup set) . . . . . . .. 724QUERY CLOPTSET (Query a client option set) 727QUERY COLLOCGROUP (Query a collocationgroup). . . . . . . . . . . . . .. 729QUERY CONTAINER (Query a container). .. 731QUERY CONTENT (Query the contents of astorage pool volume) . . . . . . . . .. 735QUERY COPYGROUP (Query copy groups) .. 742QUERY DAMAGED (Query damaged data in adirectory-container or cloud-container storagepool) . . . . . . . . . . . . . .. 747QUERY DATAMOVER (Display data moverdefinitions) . . . . . . . . . . . .. 751QUERY DB (Display database information) .. 754QUERY DBSPACE (Display database storagespace) . . . . . . . . . . . . . .. 757QUERY DEDUPSTATS (Query datadeduplication statistics) . . . . . . . .. 759QUERY DEVCLASS (Display information onone or more device classes). . . . . . .. 765QUERY DIRSPACE (Query storage utilization ofFILE directories) . . . . . . . . . .. 769QUERY DOMAIN (Query a policy domain) .. 770QUERY DRIVE (Query information about adrive) . . . . . . . . . . . . . .. 773QUERY DRMEDIA (Query disaster recoverymedia) . . . . . . . . . . . . .. 777QUERY DRMSTATUS (Query disaster recoverymanager system parameters) . . . . . .. 786QUERY ENABLED (Query enabled events) .. 789QUERY EVENT (Query scheduled andcompleted events) . . . . . . . . . .. 791QUERY EVENTRULES (Query rules for serveror client events) . . . . . . . . . .. 803

QUERY EVENTSERVER (Query the eventserver). . . . . . . . . . . . . .. 806QUERY EXPORT (Query for active orsuspended export operations) . . . . . .. 807QUERY EXTENTUPDATES (Query updateddata extents). . . . . . . . . . . .. 814QUERY FILESPACE (Query one or more filespaces) . . . . . . . . . . . . .. 816QUERY LIBRARY (Query a library) . . . .. 824QUERY LIBVOLUME (Query a library volume) 827QUERY LICENSE (Display license information) 830QUERY LOG (Display information about therecovery log) . . . . . . . . . . .. 832QUERY MACHINE (Query machineinformation) . . . . . . . . . . . .. 834QUERY MEDIA (Query sequential accessstorage pool media) . . . . . . . . .. 837QUERY MGMTCLASS (Query a managementclass) . . . . . . . . . . . . . .. 843QUERY MONITORSETTINGS (Query theconfiguration settings for monitoring alerts andserver status) . . . . . . . . . . .. 846QUERY MONITORSTATUS (Query themonitoring status) . . . . . . . . . .. 849QUERY MOUNT (Display information onmounted sequential access volumes). . . .. 853QUERY NASBACKUP (Query NAS backupimages) . . . . . . . . . . . . .. 855QUERY NODE (Query nodes) . . . . . .. 859QUERY NODEDATA (Query client data involumes) . . . . . . . . . . . . .. 871QUERY NODEGROUP (Query a node group) 874QUERY OCCUPANCY (Query client file spacesin storage pools) . . . . . . . . . .. 876QUERY OPTION (Query server options) . .. 880QUERY PATH (Display a path definition) . .. 882QUERY POLICYSET (Query a policy set) . .. 886QUERY PROCESS (Query one or more serverprocesses) . . . . . . . . . . . .. 889QUERY PROFILE (Query a profile) . . . .. 893QUERY PROXYNODE (Query proxy authorityfor a client node) . . . . . . . . . .. 896QUERY PVUESTIMATE (Display processorvalue unit estimate) . . . . . . . . .. 897QUERY RECOVERYMEDIA (Query recoverymedia) . . . . . . . . . . . . .. 901QUERY REPLICATION (Query node replicationprocesses) . . . . . . . . . . . .. 904QUERY REPLNODE (Display information aboutreplication status for a client node) . . . .. 915QUERY REPLRULE (Query replication rules) 919QUERY REPLSERVER (Query a replicationserver). . . . . . . . . . . . . .. 922QUERY REQUEST (Query one or more pendingmount requests) . . . . . . . . . .. 924QUERY RESTORE (Query restartable restoresessions) . . . . . . . . . . . . .. 925QUERY RPFCONTENT (Query recovery planfile contents stored on a target server) . . .. 928QUERY RPFILE (Query recovery plan fileinformation stored on a target server) . . .. 930

vi IBM Tivoli Storage Manager for Oracle Solaris: Administrator's Reference

|||

||

||||

|||

QUERY SAN (Query the devices on the SAN) 933QUERY SCHEDULE (Query schedules). . .. 936QUERY SCRATCHPADENTRY (Query a scratchpad entry) . . . . . . . . . . . .. 944QUERY SCRIPT (Query Tivoli Storage Managerscripts) . . . . . . . . . . . . .. 946QUERY SERVER (Query a server) . . . .. 949QUERY SERVERGROUP (Query a server group) 953QUERY SESSION (Query client sessions) . .. 955QUERY SHREDSTATUS (Query shreddingstatus ) . . . . . . . . . . . . .. 960QUERY SPACETRIGGER (Query the spacetriggers) . . . . . . . . . . . . .. 962QUERY SSLKEYRINGPW (Query SSL keydatabase file password) . . . . . . . .. 964QUERY STATUS (Query system parameters) 965QUERY STATUSTHRESHOLD (Query statusmonitoring thresholds) . . . . . . . .. 974QUERY STGPOOL (Query storage pools) . .. 977QUERY STGPOOLDIRECTORY (Query astorage pool directory) . . . . . . . .. 991QUERY SUBSCRIBER (Display subscriberinformation) . . . . . . . . . . . .. 994QUERY SUBSCRIPTION (Display subscriptioninformation) . . . . . . . . . . . .. 996QUERY SYSTEM (Query the systemconfiguration and capacity). . . . . . .. 998QUERY TAPEALERTMSG (Display status ofSET TAPEALERTMSG command) . . . .. 1000QUERY TOC (Display table of contents for abackup image) . . . . . . . . . .. 1001QUERY VIRTUALFSMAPPING (Query avirtual file space mapping) . . . . . .. 1004QUERY VOLHISTORY (Display sequentialvolume history information) . . . . . .. 1006QUERY VOLUME (Query storage poolvolumes) . . . . . . . . . . . .. 1014

QUIT (End the interactive mode of theadministrative client) . . . . . . . . .. 1022RECLAIM STGPOOL (Reclaim volumes in asequential-access storage pool) . . . . . .. 1023RECONCILE VOLUMES (Reconcile differences inthe virtual volume definitions) . . . . . .. 1026REGISTER commands . . . . . . . . .. 1029

REGISTER ADMIN (Register an administratorID) . . . . . . . . . . . . . .. 1030REGISTER LICENSE (Register a new license) 1034REGISTER NODE (Register a node) . . .. 1036

REMOVE commands . . . . . . . . .. 1054REMOVE ADMIN (Delete an administratoruser ID) . . . . . . . . . . . . .. 1055REMOVE NODE (Delete a node or anassociated machine node) . . . . . . .. 1057REMOVE REPLNODE (Remove a client nodefrom replication) . . . . . . . . . .. 1059REMOVE REPLSERVER (Remove a replicationserver) . . . . . . . . . . . . .. 1061

RENAME commands . . . . . . . . .. 1063RENAME ADMIN (Rename an administrator) 1064RENAME FILESPACE (Rename a client filespace on the server) . . . . . . . . .. 1066

RENAME NODE (Rename a node) . . . .. 1069RENAME SCRIPT (Rename a Tivoli StorageManager script) . . . . . . . . . .. 1071RENAME SERVERGROUP (Rename a servergroup) . . . . . . . . . . . . .. 1072RENAME STGPOOL (Change the name of astorage pool) . . . . . . . . . . .. 1073

REPAIR STGPOOL (Repair a directory-containerstorage pool) . . . . . . . . . . . .. 1074REPLICATE NODE (Replicate data in file spacesthat belong to a client node) . . . . . . .. 1076REPLY (Allow a request to continue processing) 1086RESET PASSEXP (Reset password expiration) 1087RESTART EXPORT (Restart a suspended exportoperation) . . . . . . . . . . . . .. 1089RESTORE commands . . . . . . . . .. 1091

RESTORE NODE (Restore a NAS node) . .. 1092RESTORE STGPOOL (Restore storage pooldata from a copy pool or an active-data pool) . 1097RESTORE VOLUME (Restore primary volumedata from a copy pool or an active-data pool) . 1101

REVOKE commands . . . . . . . . .. 1105REVOKE AUTHORITY (Remove administratorauthority) . . . . . . . . . . . .. 1106REVOKE PROXYNODE (Revoke proxyauthority for a client node) . . . . . .. 1110

ROLLBACK (Rollback uncommitted changes in amacro) . . . . . . . . . . . . . .. 1111RUN (Run a Tivoli Storage Manager script) . .. 1112SELECT (Perform an SQL query of the TivoliStorage Manager database) . . . . . . .. 1115SET commands . . . . . . . . . . .. 1125

SET ACCOUNTING (Set accounting records onor off) . . . . . . . . . . . . .. 1128SET ACTLOGRETENTION (Set the retentionperiod or the size of the activity log) . . .. 1129SET ALERTACTIVEDURATION (Set theduration of an active alert) . . . . . .. 1131SET ALERTCLOSEDDURATION (Set theduration of a closed alert) . . . . . . .. 1132SET ALERTEMAIL (Set the alert monitor toemail alerts to administrators) . . . . .. 1133SET ALERTEMAILFROMADDR (Set the emailaddress of the sender) . . . . . . . .. 1134SET ALERTEMAILSMTPHOST (Set the SMTPmail server host name) . . . . . . . .. 1135SET ALERTEMAILSMTPPORT (Set the SMTPmail server host port) . . . . . . . .. 1136SET ALERTSUMMARYTOADMINS (Set the listof administrators to receive alert summaries byemail ) . . . . . . . . . . . . .. 1137SET ALERTINACTIVEDURATION (Set theduration of an inactive alert) . . . . . .. 1138SET ALERTMONITOR (Set the alert monitor toon or off) . . . . . . . . . . . .. 1139SET ALERTUPDATEINTERVAL (Set how oftenthe alert monitor updates and prunes alerts) . 1140SET ARCHIVERETENTIONPROTECTION(Activate data retention protection) . . . .. 1141SET ARREPLRULEDEFAULT (Set the serverreplication rule for archive data). . . . .. 1143

Contents vii

|||

|||

SET AUTHENTICATION (Set passwordauthentication) . . . . . . . . . .. 1145SET BKREPLRULEDEFAULT (Set the serverreplication rule for backup data). . . . .. 1146SET CLIENTACTDURATION (Set the durationperiod for the client action) . . . . . .. 1149SET CONFIGMANAGER (Specify aconfiguration manager). . . . . . . .. 1150SET CONFIGREFRESH (Set managed serverconfiguration refresh) . . . . . . . .. 1151SET CONTEXTMESSAGING (Set messagecontext reporting on or off) . . . . . .. 1152SET CPUINFOREFRESH (Refresh interval forthe client workstation information scan) . .. 1153SET CROSSDEFINE (Specifies whether tocross-define servers) . . . . . . . . .. 1154SET DBRECOVERY (Set the device class forautomatic backups) . . . . . . . . .. 1155SET DEDUPVERIFICATIONLEVEL (Set thepercentage of extents to verify) . . . . .. 1158SET DEFAULTAUTHENTICATION (Set thedefault authentication method for REGISTERNODE and REGISTER ADMIN commands) . . .. 1160SET DISSIMILARPOLICIES (Enable the policieson the target replication server to managereplicated data) . . . . . . . . . .. 1162SET DRMACTIVEDATASTGPOOL (Specify theactive-data pools to be managed by DRM) .. 1164SET DRMCHECKLABEL (Specify labelchecking) . . . . . . . . . . . .. 1165SET DRMCMDFILENAME (Specify the nameof a file to contain commands) . . . . .. 1166SET DRMCOPYSTGPOOL (Specify the copystorage pools to be managed by DRM) . .. 1167SET DRMCOURIERNAME (Specify the couriername) . . . . . . . . . . . . .. 1168SET DRMDBBACKUPEXPIREDAYS (SpecifyDB backup series expiration) . . . . . .. 1169SET DRMFILEPROCESS (Specify fileprocessing) . . . . . . . . . . . .. 1171SET DRMINSTRPREFIX (Specify the prefix forrecovery instructions file names) . . . .. 1172SET DRMNOTMOUNTABLENAME (Specifythe not mountable location name) . . . .. 1174SET DRMPLANPREFIX (Specify a prefix forrecovery plan file names) . . . . . . .. 1175SET DRMPLANVPOSTFIX (Specifyreplacement volume names) . . . . . .. 1177SET DRMPRIMSTGPOOL (Specify the primarystorage pools to be managed by DRM) . .. 1178SET DRMRPFEXPIREDAYS (Set criteria forrecovery plan file expiration) . . . . . .. 1179SET DRMVAULTNAME (Specify the vaultname) . . . . . . . . . . . . .. 1181SET EVENTRETENTION (Set the retentionperiod for event records) . . . . . . .. 1182SET FAILOVERHLADDRESS (Set a failoverhigh level address) . . . . . . . . .. 1183SET INVALIDPWLIMIT (Set the number ofinvalid logon attempts) . . . . . . . .. 1184

SET LDAPPASSWORD (Set the LDAPpassword for the server) . . . . . . .. 1186SET LDAPUSER (Specify the user ID for theLDAP directory server) . . . . . . . .. 1187SET LICENSEAUDITPERIOD (Set license auditperiod) . . . . . . . . . . . . .. 1189SET MAXCMDRETRIES (Set the maximumnumber of command retries) . . . . . .. 1190SET MAXSCHEDSESSIONS (Set maximumscheduled sessions) . . . . . . . . .. 1191SET MINPWLENGTH (Set minimum passwordlength) . . . . . . . . . . . . .. 1193SET MONITOREDSERVERGROUP (Set thegroup of monitored servers) . . . . . .. 1194SET MONITORINGADMIN (Set the name ofthe monitoring administrator) . . . . .. 1195SET NODEATRISKINTERVAL (Specifies at-riskmode for an individual node) . . . . .. 1196SET PASSEXP (Set password expiration date) 1198SET PRODUCTOFFERING (Set the productoffering that is licensed to your enterprise) .. 1200SET QUERYSCHEDPERIOD (Set query periodfor polling client nodes) . . . . . . .. 1202SET RANDOMIZE (Set randomization ofscheduled start times) . . . . . . . .. 1203SET REGISTRATION (Set open or closedregistration) . . . . . . . . . . .. 1205SET REPLRECOVERDAMAGED (Specifywhether damaged files are recovered from areplication server) . . . . . . . . .. 1207SET REPLRETENTION (Set the retentionperiod for replication records) . . . . .. 1210SET REPLSERVER (Set the target replicationserver) . . . . . . . . . . . . .. 1212SET RETRYPERIOD (Set time between retryattempts) . . . . . . . . . . . .. 1214SET SCHEDMODES (Select a centralscheduling mode) . . . . . . . . .. 1215SET SCRATCHPADRETENTION (Set scratchpad retention time) . . . . . . . . .. 1217SET SERVERHLADDRESS (Set the high-leveladdress of a server) . . . . . . . . .. 1218SET SERVERLLADDRESS (Set the low-leveladdress of a server) . . . . . . . . .. 1219SET SERVERNAME (Specify the server name) 1220SET SERVERPASSWORD (Set password forserver) . . . . . . . . . . . . .. 1221SET SPREPLRULEDEFAULT (Set the serverreplication rule for space-managed data) . .. 1222SET SSLKEYRINGPW (Set the SSL key ringpassword) . . . . . . . . . . . .. 1224SET STATUSATRISKINTERVAL (Specifieswhether to enable client at-risk activity intervalevaluation) . . . . . . . . . . . .. 1225SET STATUSMONITOR (Specifies whether toenable status monitoring) . . . . . . .. 1227SET STATUSREFRESHINTERVAL (Set refreshinterval for status monitoring) . . . . .. 1229SET STATUSSKIPASFAILURE (Specifieswhether to use client at-risk skipped files asfailure evaluation) . . . . . . . . .. 1231

viii IBM Tivoli Storage Manager for Oracle Solaris: Administrator's Reference

|||

|||

SET SUBFILE (Set subfile backup for clientnodes) . . . . . . . . . . . . .. 1233SET SUMMARYRETENTION (Set number ofdays to keep data in activity summary table) . 1234SET TAPEALERTMSG (Set tape alert messageson or off) . . . . . . . . . . . .. 1235SET TOCLOADRETENTION (Set loadretention period for table of contents) . . .. 1236SET VMATRISKINTERVAL (Specifies theat-risk mode for an individual VM filespace) . 1237

SETOPT (Set a server option for dynamic update) 1239SHRED DATA (Shred data) . . . . . . .. 1241SUSPEND EXPORT (Suspend a currently runningexport operation) . . . . . . . . . . .. 1243UNLOCK commands . . . . . . . . .. 1244

UNLOCK ADMIN (Unlock an administrator) 1245UNLOCK NODE (Unlock a client node) . .. 1247UNLOCK PROFILE (Unlock a profile). . .. 1249

UPDATE commands . . . . . . . . .. 1250UPDATE ALERTTRIGGER (Update a definedalert trigger) . . . . . . . . . . .. 1251UPDATE ALERTSTATUS (Update the status ofan alert) . . . . . . . . . . . . .. 1254UPDATE ADMIN (Update an administrator) 1256UPDATE BACKUPSET (Update a retentionvalue assigned to a backup set) . . . . .. 1260UPDATE CLIENTOPT (Update a client optionsequence number) . . . . . . . . .. 1265UPDATE CLOPTSET (Update a client optionset description) . . . . . . . . . .. 1266UPDATE COLLOCGROUP (Update acollocation group) . . . . . . . . .. 1267UPDATE COPYGROUP (Update a copy group) 1268UPDATE DATAMOVER (Update a datamover) . . . . . . . . . . . . .. 1276UPDATE DEVCLASS (Update the attributes ofa device class) . . . . . . . . . . .. 1278UPDATE DOMAIN (Update a policy domain) 1335UPDATE DRIVE (Update a drive) . . . .. 1337UPDATE FILESPACE (Update file-spacenode-replication rules) . . . . . . . .. 1341UPDATE LIBRARY (Update a library) . . .. 1346UPDATE LIBVOLUME (Change the status of astorage volume) . . . . . . . . . .. 1362UPDATE MACHINE (Update machineinformation) . . . . . . . . . . .. 1364UPDATE MGMTCLASS (Update amanagement class) . . . . . . . . .. 1366UPDATE NODE (Update node attributes) .. 1369UPDATE NODEGROUP (Update a nodegroup) . . . . . . . . . . . . .. 1387UPDATE PATH (Change a path) . . . .. 1388UPDATE POLICYSET (Update a policy setdescription) . . . . . . . . . . .. 1396UPDATE PROFILE (Update a profiledescription) . . . . . . . . . . .. 1398UPDATE RECOVERYMEDIA (Update recoverymedia) . . . . . . . . . . . . .. 1399UPDATE REPLRULE (Update replication rules) 1401UPDATE SCHEDULE (Update a schedule) 1403

UPDATE SCRATCHPADENTRY (Update ascratch pad entry) . . . . . . . . .. 1427UPDATE SCRIPT (Update a Tivoli StorageManager script) . . . . . . . . . .. 1428UPDATE SERVER (Update a server defined forserver-to-server communications) . . . .. 1431UPDATE SERVERGROUP (Update a servergroup description) . . . . . . . . .. 1435UPDATE SPACETRIGGER (Update the spacetriggers) . . . . . . . . . . . . .. 1436UPDATE STATUSTHRESHOLD (Update astatus monitoring threshold) . . . . . .. 1438UPDATE STGPOOL (Update a storage pool) 1442UPDATE STGPOOLDIRECTORY (Update astorage pool directory) . . . . . . . .. 1488UPDATE VIRTUALFSMAPPING (Update avirtual file space mapping) . . . . . .. 1490UPDATE VOLHISTORY (Update sequentialvolume history information) . . . . . .. 1492UPDATE VOLUME (Change a storage poolvolume) . . . . . . . . . . . . .. 1494

VALIDATE commands . . . . . . . . .. 1498VALIDATE LANFREE (Validate LAN-Freepaths) . . . . . . . . . . . . .. 1499VALIDATE POLICYSET (Verify a policy set) 1501VALIDATE REPLICATION (Validatereplication for a client node) . . . . . .. 1503VALIDATE REPLPOLICY (Verify the policieson the target replication server) . . . . .. 1508

VARY (Bring a random access volume online oroffline) . . . . . . . . . . . . . .. 1511

Chapter 3. Server options . . . .. 1513Modifying server options . . . . . . . .. 1513Types of server options. . . . . . . . .. 1514

Server communication options . . . . .. 1514Server storage options . . . . . . . .. 1516Client-server options . . . . . . . .. 1517Date, number, time, and language options .. 1517Database options . . . . . . . . . .. 1517Data transfer options . . . . . . . .. 1518Message options . . . . . . . . . .. 1518Event logging options . . . . . . . .. 1519Security options and licensing options. . .. 1519Miscellaneous options . . . . . . . .. 1520

3494SHARED . . . . . . . . . . . .. 1521ACSACCESSID . . . . . . . . . . .. 1522ACSLOCKDRIVE . . . . . . . . . .. 1523ACSQUICKINIT . . . . . . . . . . .. 1524ACSTIMEOUTX . . . . . . . . . . .. 1525ACTIVELOGDIRECTORY . . . . . . . .. 1526ACTIVELOGSIZE . . . . . . . . . .. 1527ADMINCOMMTIMEOUT . . . . . . . .. 1528ADMINIDLETIMEOUT . . . . . . . .. 1529ADMINONCLIENTPORT . . . . . . . .. 1530ALIASHALT . . . . . . . . . . . .. 1531ALLOWREORGINDEX. . . . . . . . .. 1532ALLOWREORGTABLE . . . . . . . . .. 1533ARCHFAILOVERLOGDIRECTORY. . . . .. 1534ARCHLOGCOMPRESS. . . . . . . . .. 1535ARCHLOGDIRECTORY . . . . . . . .. 1536

Contents ix

|||

ARCHLOGUSEDTHRESHOLD . . . . . .. 1537ASSISTVCRRECOVERY . . . . . . . .. 1538AUDITSTORAGE . . . . . . . . . .. 1539CHECKTAPEPOS . . . . . . . . . .. 1540CLIENTDEDUPTXNLIMIT . . . . . . .. 1542COMMMETHOD . . . . . . . . . .. 1544COMMTIMEOUT . . . . . . . . . .. 1546DBDIAGLOGSIZE . . . . . . . . . .. 1547DBDIAGPATHFSTHRESHOLD . . . . . .. 1549DBMEMPERCENT . . . . . . . . . .. 1550DBMTCPPORT . . . . . . . . . . .. 1551DEDUPREQUIRESBACKUP . . . . . . .. 1552DEDUPTIER2FILESIZE. . . . . . . . .. 1553DEDUPTIER3FILESIZE. . . . . . . . .. 1554DEVCONFIG . . . . . . . . . . . .. 1555DISABLEREORGTABLE . . . . . . . .. 1556DISABLESCHEDS . . . . . . . . . .. 1557DISALLOWDES . . . . . . . . . . .. 1558DISKMAP . . . . . . . . . . . . .. 1559DISPLAYLFINFO. . . . . . . . . . .. 1560DNSLOOKUP . . . . . . . . . . . .. 1561DRIVEACQUIRERETRY . . . . . . . .. 1562ENABLENASDEDUP . . . . . . . . .. 1563EVENTSERVER . . . . . . . . . . .. 1564EXPINTERVAL . . . . . . . . . . .. 1565EXPQUIET . . . . . . . . . . . . .. 1566FFDCLOGNAME . . . . . . . . . .. 1567FFDCMAXLOGSIZE . . . . . . . . .. 1568FFDCNUMLOGS. . . . . . . . . . .. 1569FILEEXIT . . . . . . . . . . . . .. 1570FILETEXTEXIT . . . . . . . . . . .. 1571FSUSEDTHRESHOLD . . . . . . . . .. 1572IDLETIMEOUT . . . . . . . . . . .. 1573LANGUAGE . . . . . . . . . . . .. 1574LDAPCACHEDURATION. . . . . . . .. 1576LDAPURL . . . . . . . . . . . . .. 1577MAXSESSIONS . . . . . . . . . . .. 1578MESSAGEFORMAT . . . . . . . . . .. 1579MIRRORLOGDIRECTORY . . . . . . .. 1580MOVEBATCHSIZE . . . . . . . . . .. 1581MOVESIZETHRESH . . . . . . . . .. 1582MSGINTERVAL . . . . . . . . . . .. 1583NDMPCONNECTIONTIMEOUT . . . . .. 1584NDMPCONTROLPORT . . . . . . . .. 1585NDMPENABLEKEEPALIVE . . . . . . .. 1586NDMPPORTRANGE . . . . . . . . .. 1587NDMPPREFDATAINTERFACE . . . . . .. 1588NOPREEMPT . . . . . . . . . . . .. 1589NORETRIEVEDATE. . . . . . . . . .. 1590NUMOPENVOLSALLOWED. . . . . . .. 1591QUERYAUTH . . . . . . . . . . . .. 1593RECLAIMDELAY . . . . . . . . . .. 1594RECLAIMPERIOD . . . . . . . . . .. 1595REORGBEGINTIME. . . . . . . . . .. 1596REORGDURATION . . . . . . . . . .. 1597REPORTRETRIEVE . . . . . . . . . .. 1598REPLBATCHSIZE . . . . . . . . . .. 1599REPLSIZETHRESH . . . . . . . . . .. 1600REQSYSAUTHOUTFILE . . . . . . . .. 1601RESOURCETIMEOUT . . . . . . . . .. 1602RESTOREINTERVAL . . . . . . . . .. 1603

RETENTIONEXTENSION . . . . . . . .. 1604SANDISCOVERY. . . . . . . . . . .. 1605SANDISCOVERYTIMEOUT . . . . . . .. 1606SANREFRESHTIME . . . . . . . . . .. 1607SEARCHMPQUEUE. . . . . . . . . .. 1608SERVERDEDUPTXNLIMIT . . . . . . .. 1609SHMPORT . . . . . . . . . . . . .. 1611SHREDDING . . . . . . . . . . . .. 1612SNMPHEARTBEATINTERVAL . . . . . .. 1613SNMPMESSAGECATEGORY. . . . . . .. 1614SNMPSUBAGENT . . . . . . . . . .. 1615SNMPSUBAGENTHOST . . . . . . . .. 1616SNMPSUBAGENTPORT . . . . . . . .. 1617SSLDISABLELEGACYTLS . . . . . . . .. 1618SSLFIPSMODE . . . . . . . . . . .. 1619SSLINITTIMEOUT . . . . . . . . . .. 1620SSLTCPADMINPORT . . . . . . . . .. 1621SSLTCPPORT . . . . . . . . . . . .. 1622SSLTLS12 . . . . . . . . . . . . .. 1623TCPADMINPORT . . . . . . . . . .. 1624TCPNODELAY . . . . . . . . . . .. 1625TCPPORT . . . . . . . . . . . . .. 1626TCPWINDOWSIZE . . . . . . . . . .. 1627TECBEGINEVENTLOGGING . . . . . .. 1628TECHOST . . . . . . . . . . . . .. 1629TECPORT . . . . . . . . . . . . .. 1630TECUTF8EVENT . . . . . . . . . . .. 1631THROUGHPUTDATATHRESHOLD . . . .. 1632THROUGHPUTTIMETHRESHOLD . . . .. 1633TXNGROUPMAX . . . . . . . . . .. 1634UNIQUETDPTECEVENTS . . . . . . .. 1635UNIQUETECEVENTS . . . . . . . . .. 1636USEREXIT . . . . . . . . . . . . .. 1637VERBCHECK . . . . . . . . . . . .. 1638VOLUMEHISTORY . . . . . . . . . .. 1639

Chapter 4. Server utilities. . . . .. 1641DSMSERV (Start the server) . . . . . . .. 1642Server startup script: rc.dsmserv . . . . .. 1644DSMSERV DISPLAY DBSPACE (Displayinformation about database storage space) . .. 1645DSMSERV DISPLAY LOG (Display recovery loginformation) . . . . . . . . . . . .. 1646DSMSERV EXTEND DBSPACE (Increase space forthe database) . . . . . . . . . . . .. 1648DSMSERV FORMAT (Format the database andlog) . . . . . . . . . . . . . . .. 1650DSMSERV INSERTDB (Move a server databaseinto an empty database) . . . . . . . .. 1653DSMSERV LOADFORMAT (Format a database) 1656DSMSERV REMOVEDB (Remove a database) 1658DSMSERV RESTORE DB (Restore the database) 1659

DSMSERV RESTORE DB (Restore a database toits most current state) . . . . . . . .. 1660DSMSERV RESTORE DB (Restore a database toa point-in-time) . . . . . . . . . .. 1664

x IBM Tivoli Storage Manager for Oracle Solaris: Administrator's Reference

||

Appendix A. Return codes for use inIBM Tivoli Storage Manager scripts . 1669

Appendix B. Accessibility featuresfor the Tivoli Storage Managerproduct family . . . . . . . . .. 1673

Notices . . . . . . . . . . . .. 1675

Glossary . . . . . . . . . . . .. 1679

Index . . . . . . . . . . . . .. 1681

Contents xi

xii IBM Tivoli Storage Manager for Oracle Solaris: Administrator's Reference

About this publication

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

This publication provides you with the commands and options that you can use tomanage the Tivoli Storage Manager server.

Who should read this guideThis reference is intended for anyone who is registered as an administrator. Asingle administrator can manage Tivoli Storage Manager, or several people canshare administrative responsibilities.

You should be familiar with the operating system on which the server resides andthe communication protocols required for the client/server environment. You alsoneed to understand the storage management practices of your organization, suchas how you are currently backing up workstation files and how you are usingstorage devices.

PublicationsThe Tivoli Storage Manager product family includes IBM Tivoli StorageFlashCopy Manager, IBM Tivoli Storage Manager for Space Management, IBMTivoli Storage Manager for Databases, and several other storage managementproducts from IBM.

To view IBM product documentation, see http://www.ibm.com/support/knowledgecenter.

Conventions used in this publicationv Command to be entered on the Oracle Solaris command line:

> dsmadmc

v Command to be entered on the command line of an administrative client:query devclass

In the usage and descriptions for administrative commands, the term characterscorresponds to the number of bytes available to store an item. For languages inwhich it takes a single byte to represent a displayable character, the character tobyte ratio is 1 to 1. However, for DBCS and other multi-byte languages, thereference to characters refers only to the number of bytes available for the item andmay represent fewer actual characters.

Copyright IBM Corp. 1993, 2015 xiii

http://www.ibm.com/support/knowledgecenterhttp://www.ibm.com/support/knowledgecenter

xiv IBM Tivoli Storage Manager for Oracle Solaris: Administrator's Reference

New for Tivoli Storage Manager Version 7.1.3

Many features in the IBM Tivoli Storage Manager Version 7.1.3 server are new forprevious Tivoli Storage Manager users.

New and changed information in this product documentation is indicated by avertical bar (|) to the left of the change.

Tivoli Storage Manager server updatesNew features and other changes are available in the Tivoli Storage ManagerVersion 7.1.3 server.

Optimize a storage environment by using inline datadeduplication

With Tivoli Storage Manager Version 7.1.3, you can define a type of storage poolthat provides both inline and client-side data deduplication. You can use the newstorage pool, directory-container, to protect backup and archive data.

The directory-container storage pool provides the following benefits:v Simplified storage managementv Optimized data-deduplication processingv Reduced database growth and sizev Increased server performance and scalabilityv Improved recoverability of damaged extents

Back up data to a cloud computing systemWith Tivoli Storage Manager Version 7.1.3, you can define a new type ofcloud-container storage pool. The cloud-container storage pool protects backup andarchive data that is integrated with data deduplication. You can back up the datato either an IBM SoftLayer or OpenStack Swift cloud computing system.

The cloud-container storage pool provides the following benefits:v Reduced on-premises storage requirements and costv Simplified storage managementv Improved server performancev Use of public, off-premises, or private, on-premises cloud storagev Secure data through server-side encryption

Copyright IBM Corp. 1993, 2015 xv

Archive diagnostic messages by using operating system toolsTivoli Storage Manager Version 7.1.3 simplifies the process of archiving diagnosticmessages by using operating system tools. To archive diagnostic messages, you donot have to reset the DBDIAGLOGSIZE server option every time that the server isstarted.

In earlier releases, the maximum value of the DBDIAGLOGSIZE server option wasautomatically reset to 1024 each time the server was restarted, and it was notpossible to change this. This setting limited space for diagnostic log files to 1024MB. In this release, you can set the value of the DBDIAGLOGSIZE server option to 0.If you specify a value of 0, only one log file is used for all diagnostic messages. Nolimits are imposed on the size of the log file. In this way, you can archivediagnostic messages without having to reset the DBDIAGLOGSIZE value and interruptsystem operations.Related reference:DBDIAGLOGSIZE on page 1547

Start the server in maintenance modeWith Tivoli Storage Manager Version 7.1.3, maintenance mode is the preferredmethod for starting the server before you begin maintenance or reconfigurationtasks. When you start the server in maintenance mode, operations that mightdisrupt maintenance or reconfiguration tasks are automatically disabled.

Start the server in maintenance mode by running the DSMSERV utility with theMAINTENANCE parameter.Related reference:DSMSERV (Start the server) on page 1642

Decommission a client nodeWith Tivoli Storage Manager Version 7.1.3, you can remove a client node from theproduction environment in a systematic way.

When you start the decommission process, the server locks the client node toprevent it from accessing the server. Files that belong to the client node aregradually deleted, and then the client node is deleted.Related reference:DECOMMISSION NODE (Decommission an application or system) on page 127DECOMMISSION VM (Decommission a virtual machine) on page 130

Deactivate data to free server storage spaceTivoli Storage Manager Version 7.1.3 simplifies the process of deleting activebackup data that you no longer require. You can deactivate the data to ensure thatthe file will be deleted by the inventory expiration process. In this way, you canfree storage space on the Tivoli Storage Manager server.

The deactivation feature applies only to application clients that protect Oracledatabases.Related reference:DEACTIVATE DATA (Deactivate data for a client node) on page 123

xvi IBM Tivoli Storage Manager for Oracle Solaris: Administrator's Reference

Narrow the search results when you query sessionsWith Tivoli Storage Manager Version 7.1.3, you can narrow the search results of theQUERY SESSION command to obtain query output for specific clients. For example, ifa Tivoli Storage Manager solution includes hundreds of clients, you can run theQUERY SESSION command with the CLIENTNAME parameter to obtain sessioninformation for a specified client or group of clients.

In addition, you can use the TYPE parameter on the QUERY SESSION command tonarrow the search based on session type. You can set the TYPE parameter to displayinformation about administrative sessions, server-to-server sessions, or clientsessions.Related reference:QUERY SESSION (Query client sessions) on page 955

Specify an action for all client nodesWith Tivoli Storage Manager Version 7.1.3, you can use the DEFINE CLIENTACTIONcommand to schedule one or more clients to process a command for a one-timeaction.Related reference:DEFINE CLIENTACTION (Define a one-time client action) on page 143

New for Tivoli Storage Manager Version 7.1.3 xvii

xviii IBM Tivoli Storage Manager for Oracle Solaris: Administrator's Reference

Chapter 1. Managing the server from the command line

Tivoli Storage Manager provides several different command-line interfaces formanaging Tivoli Storage Manager servers.

About this task

The following command-line interfaces are available:

Administrative command-line clientThe administrative command-line client is a program that runs on a fileserver, workstation, or mainframe. It is installed as part of the TivoliStorage Manager server installation process. The administrative client canbe accessed remotely.

From the administrative client, you can issue any server commands.

Server consoleThe server console is a command-line window on the system where theserver is installed. Therefore, to use the server console, you must be at thephysical location of the server system.

Compared to the administrative client, the capabilities of the server consoleare limited. From the server console, you cannot issue certain commands,and you cannot route commands to other servers. Also, you cannot specifythat certain commands process before other commands can be issued.However, this limitation can be useful if, for example, you want to run twocommands in quick succession.

Operations Center command lineFrom the Operations Center, you can access the Tivoli Storage Managercommand line. You might want to use this command line to issue servercommands to complete certain Tivoli Storage Manager tasks that are notsupported in the Operations Center.

Server scripts provide for automation of common administrative tasks. A macro isa file that contains one or more Tivoli Storage Manager administrative commands.When you issue the MACRO command, the server processes all commands in themacro file in order, including commands that are contained in any nested macros.

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

About this task

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

Copyright IBM Corp. 1993, 2015 1

Note: Text strings that are sent from the client to the server do not depend on theserver language setting. The text will be displayed properly if the administrativeclient runs in the same locale when sending the string and when receiving thestring.

For example, assume that you update a node contact field with a value thatcontains national characters (update node myNode contact=NLcontact_info), andlater query the node (query node myNode format=detailed). If the client is runningin the same locale when you update as when you query, the NLcontact_info willdisplay properly. If you update the node contact field when the client is running inone locale, and query the node when the client is running in a different locale, it ispossible that the NLcontact_info will not display properly.

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

About this task

The Tivoli Storage Manager server must be running before an administrative clientcan connect.

Procedurev To start an administrative client session in command-line mode, enter this

command on your workstation:dsmadmc -id=admin -password=admin -dataonly=yes

By entering the DSMADMC command with the -ID and -PASSWORD options asshown, you are not prompted for a user ID and password.

v To stop an administrative command-line client session, enter the followingcommand:quit

v To interrupt a DSMADMC command before the Tivoli Storage Manager serverfinishes processing it, use the UNIX kill -9 command from an availablecommand line. Do not press Ctrl+C because, while it ends the session, it canlead to unexpected results.

Monitoring server activities from the administrative clientTo monitor Tivoli Storage Manager activities, such as server migration and clientlogons, run the administrative client in console mode. You cannot enter anyadministrative commands in console mode.

Procedurev To start an administrative client session in console mode, enter the following

command:dsmadmc -consolemode

You are prompted for a password if authentication is turned on for the server. Ifyou do not want to be prompted for your user ID and password, enter theDSMADMC command with the -ID and -PASSWORD options.

v To end an administrative client session in console mode, use a keyboard breaksequence.

Operating system Break sequence

UNIX and Linux clients Ctrl+C

2 IBM Tivoli Storage Manager for Oracle Solaris: Administrator's Reference


Windows clients Ctrl+C or Ctrl+Break

Monitoring removable-media mounts from the administrativeclient

To monitor the mounting and dismounting of removable media, run theadministrative client in mount mode. When the client is running in mount mode,you cannot enter any administrative commands.

Procedurev To start an administrative client session in mount mode, enter the following

command:dsmadmc -mountmode

You are prompted for a password if authentication is turned on for the server. Ifyou do not want to be prompted for your user ID and password, enter theDSMADMC command with the -ID and -PASSWORD options.

v To end an administrative client session in mount mode, use a keyboard breaksequence.


UNIX and Linux clients Ctrl+C

Windows clients Ctrl+C or Ctrl+Break

Processing individual commands from the administrativeclient

Use batch mode to enter a single administrative command. Your administrativeclient session automatically ends when the command is processed.

About this task

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

If you do not want to be prompted for your user ID and password, you can enterthe DSMADMC command with the -ID and -PASSWORD options.

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

Chapter 1. Managing the server from the command line 3

Processing a series of commands from the administrativeclient

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

About this task

To start an administrative client session in interactive mode, a server session mustbe available. To ensure the availability of server sessions for both administrativeand client node sessions, the interactive mode of the administrative client isdisconnected if one or more of the following conditions is true:v The server was stopped using the HALT command.v Commands were not issued from the administrative client session for the length

of time specified with the IDLETIMEOUT server option.v The administrative client session was canceled with the CANCEL SESSION

command.

You can use continuation characters when using interactive mode. For moreinformation, see Using continuation characters to enter long commands on page13.

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

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

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

Formatting output from commandsTivoli Storage Manager formats the output processed from commands according toyour screen or window width.

About this task

If the width of your screen or window is not wide enough to display the outputhorizontally, Tivoli Storage Manager arranges and displays the informationvertically.

You can format the output of QUERY commands using the DISPLAYMODE andOUTFILE administrative client options.


Saving command output to a specified locationThe most common use for redirecting output is to save the output from querycommands to a specified file or program. You can then browse the contents of thefile or, in some cases, print the contents.

About this task

Some platforms support redirection of output using special characters such as >,>>, and |. You can save the output from a command by entering redirectioncharacters at the end of the command. Redirection characters direct the output of acommand to a file or program you specify instead of to your screen. To redirectoutput, leave a blank between the redirection character and the file or programname. See the following examples.

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

If you want to: Enter this:

Redirect the output of aQUERY DOMAIN commandto a new file in batch orinteractive mode

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

A single greater-than sign (>) indicates that Tivoli StorageManager redirects the output to a new file or writes over anexisting file.

Append the output of aQUERY DOMAIN commandto the end of an existingfile in batch orinteractive mode

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

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

Redirect all output froman administrative clientsession in console modeto a program calledfilter.exe

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

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

You can also redirect all output to a specified file by specifying the -OUTFILEoption with a destination file name. For example, enter:dsmadmc -id=sullivan -password=secret -consolemode -outfile=save.out

Administrative client optionsIn all administrative client modes, you can use options to modify administrativeclient session responses.

DSMADMC

DSMADMC

admin_client_option server_command

Here is an example of a task and how to use the administrative client options: Youcan enter the DSMADMC command with your user ID and password by using the -IDand -PASSWORD options so that you are not prompted for that information. To haveTivoli Storage Manager redirect all output to a file, specify the -OUTFILE option


with a destination file name. For example, to issue the QUERY NODE command inbatch mode with the output redirected to the SAVE.OUT file, enter:dsmadmc -id=sullivan -password=secret -outfile=save.out query node

Options

Administrative client options can be specified with the DSMADMC command and arevalid from an administrative client session only. You can type an option inuppercase letters, lowercase letters, or any combination. Uppercase letters denotethe shortest acceptable abbreviation. If an option appears entirely in uppercaseletters, you cannot abbreviate it.

-ALWAYSPromptSpecifies that a command prompt is displayed if the input is from thekeyboard or if it is redirected (for example, from a file). If this option is notspecified and the input is redirected, the command prompt is not written.

If the input is redirected, only the command output is displayed. If this optionis specified, the command prompt and the command output are displayed.

-CHECKAliashaltAllows the administrative client to recognize an alias for the HALT command asset in the ALIASHALT server option. See ALIASHALT on page 1531 fordetails.

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

-CONsolemodeSpecifies that Tivoli Storage Manager runs in console mode. Most serverconsole output is echoed to your screen. The exception are items such asresponses to query commands that are issued from the console, trace output,or any system messages that displayed on the console.

-DATAONLY=NO or YESSpecifies whether product version information and output headers displaywith the output. The default is NO.

NO Specifies that the product version information and output column headersdisplay.

YESSuppresses the product version information and output column headers.

-DISPLaymode=LISt or TABleYou can force the QUERY output to tabular or list format regardless of thecommand-line window column width.

If you are using the -DISPLAYMODE option and you want the output to go to afile, do not specify the -OUTFILE option. Use redirection to write to the file.

-ID=useridSpecifies the administrator's user ID.

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


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

-NEWLINEAFTERPromptSpecifies that a newline character is written after the command prompt andcommands that are entered from the keyboard are displayed underneath theprompt. If this option is not specified, commands entered from the keyboardare displayed to the right side of the prompt.

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

-OUTfileSpecifies that output from a server query is displayed in one row. If the outputin a row exceeds the column width that is defined by the server, the output isdisplayed on multiple lines in that row. This option is available in batch modeonly.

-OUTfile=filenameSpecifies that output from a server query is redirected to a specified file. Inbatch mode, output is redirected to a file you specify and the format of theoutput matches the format of the output on your screen.

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

-PAssword=passwordSpecifies the administrator's password.

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

-SErveraddressSpecifies the server stanza in the dsm.sys file. The client uses the server stanzato determine the server it connects to. The SERVERADDRESS option is supportedby administrative clients that are running on UNIX, Linux, and Macintoshoperating systems only.

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

-TCPPortSpecifies a TCP/IP port address for a Tivoli Storage Manager server. TheTCPPORT option is only supported by administrative clients that are running onWindows operating systems and is valid on the Windows administrative clientcommand line.

-TCPServeraddressSpecifies a TCP/IP server address for a Tivoli Storage Manager server. The


TCPSERVERADDRESS option is only supported by administrative clients that arerunning on Windows operating systems and is valid on the Windowsadministrative client command line.

In addition to the options that are listed here, you can also specify any option thatis in the client options file. Each option must be preceded with a hyphen anddelimited with a space.

Issuing commands from the Operations CenterFrom the Operations Center command-line interface, you can issue commands tomanage Tivoli Storage Manager servers that are configured as hub or spokeservers.

Procedure

To open the command-line interface, hover over the globe icon

in theOperations Center menu bar, and click Command Builder.

Issuing commands from the server consoleTivoli Storage Manager provides a user ID named SERVER_CONSOLE that allowsyou to issue commands and administer the server from the server console afterTivoli Storage Manager is installed. At installation, SERVER_CONSOLE isautomatically registered as an administrator and is given system authority.

About this task

If you have system privilege, you can revoke or grant new privileges to theSERVER_CONSOLE user ID. You cannot take any of the following actions:v Register or update the SERVER_CONSOLE user IDv Lock or unlock the SERVER_CONSOLE user IDv Rename the SERVER_CONSOLE user IDv Remove SERVER_CONSOLE user IDv Route commands from the SERVER_CONSOLE user ID

Not all Tivoli Storage Manager commands are supported by the server console.You cannot specify the WAIT parameter from the server console.

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

About this task

To display command-line help for server commands that have unique names, youcan type help commandName, where commandName is the name of the servercommand for which you want information. For example, to display help for theREGISTER NODE command, type help register node. Command syntax andparameter descriptions are displayed in the output.

You can also type help followed by the topic number for the command. Topicnumbers are listed in the table of contents for command-line help, for example:


3.0 Administrative commands3.46 REGISTER

3.46.1 REGISTER ADMIN (Register an administrator)3.46.2 REGISTER LICENSE (Register a new license)3.46.3 REGISTER NODE (Register a node)

To display help about the REGISTER NODE command, type:help 3.46.3

Use topic numbers to display command-line help for subcommands. DEFINEDEVCLASS is an example of a command that has subcommands. For example, youcan specify the DEFINE DEVCLASS command for 3590 device classes and for 3592device classes:3.0 Administrative commands

...3.13.10 DEFINE DEVCLASS (Define a device class)

3.13.10.1 DEFINE DEVCLASS (Define a 3590 device class)3.13.10.2 DEFINE DEVCLASS (Define a 3592 device class)...

To display help for the DEFINE DEVCLASS command for 3590 device classes, type:help 3.13.10.1

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

onto the next line.v The symbol at the beginning of a line indicates that a syntax diagram

continues from the previous line.v The symbol indicates the end of a syntax diagram.

Command names

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

Enter the entire command name or the abbreviation that is specified in the syntaxdiagram for the command. Uppercase letters denote the shortest acceptableabbreviation. If a command appears entirely in uppercase letters, you cannotabbreviate it. You can enter the command in uppercase letters, lowercase letters, orany combination. In this example, you can enter CMDNA, CMDNAM, orCMDNAME in any combination of uppercase and lowercase letters.

CMDNAme

Note: Command names in descriptive text are always capitalized.


Required parameters

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

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

PARMName = ABC

Optional parameters

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

PARMName = A

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

PARMNAme = A

BC

Defaults

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

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

PARMNAme = A

PARMName = ABC

Variables

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


CMDNAme var_name

PARMname = var_name

Special characters

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

* Asterisk

: Colon

, Comma

= Equal sign

- Hyphen

( ) Parentheses

. Period

Repeating values

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

,

file_name

Repeatable choices

A stack of values followed by an arrow returning to the left means that you canselect more than one value or, when permitted, 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 (=).

,

PARMNAme = value1value2value3

Footnotes

Footnotes are enclosed in parentheses.

,(1)

file_name

Notes:

1 You can specify up to five file names.


Entering parameters

The order in which you enter parameters can be important. The following exampleshows a portion of the command for defining a copy storage pool:

DEFine STGpool pool_name device_class_name POoltype = COpy

DESCription = description

REClaim = 100

REClaim = percent

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

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

reclaim=50define stgpool mycopypool mydeviceclass description=engineering pooltype=copy

reclaim=50

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

reclaim=50

Syntax fragments

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

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

In this example, the fragment is named Fragment.

Fragment

Fragment:

A

BC


Using continuation characters to enter long commandsContinuation characters are useful when you want to process a command that islonger than your screen or window width. You can use continuation characters inthe interactive mode of the administrative client.

About this task

Without continuation characters, you can enter up to 256 characters. Withcontinuation characters, you can enter up to 1500 characters.

Note: In the MACRO command, the maximums apply after any substitution variableshave been applied.

With continuation characters, you can do the following:v Enter a dash at the end of the line you want to continue.

For example:register admin pease mypasswd -contact="david, ext1234"

v Continue a list of values by entering a dash or a back slash, with no precedingblank spaces, after the last comma of the list that you enter on the first line.Then, enter the remaining items in the list on the next line with no precedingblank spaces. For example:stgpools=stg1,stg2,stg3,-stg4,stg5,stg6

v Continue a string of values that are enclosed in quotation marks by entering thefirst part of the string that is enclosed in quotation marks, followed by a dash ora back slash at the end of the line. Then, enter the remainder of the string on thenext line, enclosed in the same type of quotation marks.For example:contact="david pease, bldg. 100, room 2b, san jose,"-"ext. 1234, alternate contact-norm pass,ext 2345"

Tivoli Storage Manager concatenates the two strings with no intervening blanks.You must use only this method to continue a quoted string of values acrossmore than one line.

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

About this task

The following characters are available for defining object names.

Character Description

AZ Any letter, A through Z

09 Any number, 0 through 9

_ Underscore

. Period

- Hyphen

+ Plus

& Ampersand


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, virtual filespace names

64

Restartable export identifiers 64

High-level and low-level TCP/IP (IPv4 or IPv6)addresses

64

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

30

The following characters are available for defining password names:a b c d e f g h i j k l m n o p q r s t u v w x y zA B C D E F G H I J K L M N O P Q R S T U V W X Y Z0 1 2 3 4 5 6 7 8 9~ ! @ # $ % ^ & * _ - + = ` | ( ) { } [ ] : ; < > , . ? /

Passwords considered LOCAL are those passwords that authenticate with theTivoli Storage Manager server and are not case-sensitive. Passwords consideredLDAP are those passwords that authenticate with an LDAP directory server andare case-sensitive.

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

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

About this task

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

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

Table 1. Wildcard characters by operating system

Operating system Match any Match exactly one

AIX, HP-UX, Linux, OS/2, OracleSolaris, Windows

* ?

TSO * %


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

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

Tivoli Storage Manager displays information about management classes withnames MC.

Table 2 shows additional examples of using wildcard characters to match anycharacters.

Table 2. Match-any character

Pattern Matches Does not match

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

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

ab*ef*rs abefrs, abefghrs abefr, abers

Table 3 shows additional examples of using wildcard characters to match exactlyone character. The question mark (?) can be replaced by a percent sign (%) if yourplatform uses that character instead of (?).

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

Specifying descriptions in keyword parametersIf a description (a string of text) for a parameter begins with a single or doublequotation mark, or contains any embedded blanks or equal signs, you mustsurround the value with either single (') or double (") quotation marks.

About this task

The opening and closing quotation marks must be the same type of quotationmarks. For example, if the opening quotation is a single quotation mark, theclosing quotation mark must also be a single quotation mark.

For example, to register a new client node named Louie, with a password of secret,and with his title included as contact information, enter:register node louie secret contact="manager of dept. 61f"

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


For this description Enter this

manager contact=manager

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

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

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

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

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

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

Controlling command processingYou can run some Tivoli Storage Manager commands sequentially or concurrentlywith other commands. You can also route commands from one server to otherservers for processing.

About this task

Server command processingTivoli Storage Manager processes administrator commands either in the foregroundor in the background. Commands that process in the foreground must completebefore you can issue another command. When commands are processing in thebackground, you can issue additional commands at any time.

Most Tivoli Storage Manager commands process in the foreground. For somecommands that normally process in the background (for example, BACKUP DB),you can specify the WAIT parameter (WAIT=YES) with the command so that thecommand processes in the foreground. You might want to process a command inthe foreground rather than in the background for any of the following reasons:v To quickly determine whether a command completed successfully. When you

issue a command that processes in the foreground, Tivoli Storage Manager sendsa confirmation message indicating that the command completed successfully. Ifyou process the command in the background, you need to open operationalreporting or query the activity log to determine whether the commandcompleted successfully.

v To monitor server activities (for example, messages) on the administrative clientas a command is being processed. This might be preferable to searching a longactivity log after the command has completed.

v To be able to start another process immediately after a command has completed.For example, you might specify WAIT=YES for a command that takes a shorttime to process so that, when the processing completes, you can immediatelystart processing another command.

v To serialize commands in an administrative script when it is important that onecommand completes before another begins.

Check the individual command description to determine whether a command hasa WAIT parameter.

You can cancel commands that are processed in the foreground from the serverconsole or from another administrative client session.


Each background process is assigned a process number. Use the QUERY PROCESScommand to obtain the status and process number of a background process.

Note:

v If you are defining a schedule with a command that specifies WAIT=NO (thedefault), and you issue QUERY EVENT to determine the status of yourscheduled operation, failed operations will report an event status ofCOMPLETED with a return of OK. In order for the QUERY EVENT output toreflect the failed status, the WAIT parameter must be set to YES. This will runthe scheduled operation in the foreground and inform you of the status when itcompletes.

v You cannot process commands in the foreground from the server console.

Stopping background processesUse the CANCEL PROCESS command to cancel commands that generatebackground processes.

About this task

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

When you issue a QUERY command from the administrative client, multiplescreens of output might be generated. If this occurs and additional output is notneeded, you can cancel the display of output to the client workstation. Doing sodoes not end the processing of the command.

Performing tasks concurrently on multiple serversCommand routing allows you to route commands to one or more servers forprocessing and then collect the output from these servers.

About this task

To route commands to other servers, you must have the same administrator IDand password as well as the required administrative authority on each server towhich the command is being routed. You cannot route commands to other serversfrom the server console.

After the command has completed processing on all servers, the output displays,in its entirety, for each server. For example, the output from SERVER_A displays inits entirety, followed by the output from SERVER_B. The output includes summarymessages for each individual server and identifies which server processed theoutput. Return codes indicate whether commands processed on the serverssuccessfully. These return codes include one of three severities: 0, ERROR, orWARNING.

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


The following examples describe how to route the QUERY STGPOOL command toone server, multiple servers, a server group, multiple server groups, or acombination of servers and server groups. Each server or server group in a listmust be separated with a comma, without spaces.

Routing commands to a single serverProcedure

To route the QUERY STGPOOL command to a server named ASTRO, enter:astro: query stgpool

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

Routing commands to multiple serversAbout this task

Procedure

To route the QUERY STGPOOL command to multiple servers named HD_QTR,MIDAS, SATURN, enter:hd_qtr,midas,saturn: query stgpool

If the first server has not been defined to Tivoli Storage Manager, the command isrouted to the next defined server in the list of servers.You can also enter the command this way:(hd_qtr,midas,saturn) query stgpool

Routing commands to a server groupAbout this task

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

Procedure

To route the QUERY STGPOOL command to the server group named ADMIN,enter:admin: query stgpool

You can also enter the command this way:(admin) query stgpool


Routing commands to server groupsAbout this task

In this example, the server group ADMIN2 has servers SERVER_A, SERVER_B,and SERVER_C defined as group members, and server group ADMIN3 has serversASTRO, GUMBY, and CRUSTY defined as group members. The command isrouted to servers SERVER_A, SERVER_B, SERVER_C, ASTRO, GUMBY, andCRUSTY.

Procedure

To route the QUERY STGPOOL command to two server groups that are namedADMIN2 and ADMIN3, enter:admin2,admin3: query stgpool

You can also enter the command this way:(admin2,admin3) query stgpool

Routing commands to two servers and a server groupAbout this task

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

Procedure

To route the QUERY STGPOOL command to a server group named DEV_GROUPand to the servers named MERCURY and JUPITER, enter:dev_group,mercury,jupiter: query stgpool

You can also enter the command this way:(dev_group,mercury,jupiter) query stgpool

Routing commands inside scriptsAbout this task

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

For example, to route the QUERY STGPOOL command inside a script:

Procedure1. Define a script called QU_STG to route it to the DEV_GROUP server group.

define script qu_stg "(dev_group) query stgpool"

2. Run the QU_STG script:run qu_stg


Results

In this

IBM Tivoli Storage Manager for Oracle Solaris ... · IBM T ivoli Stora ge Mana ger for Orac le Solaris V ersion 7.1.3 Administra tor's Reference IBM

Documents