IBM Tivoli Storage Managerfor LinuxVersion 7.1.5

Administrator's Reference

IBM

IBM Tivoli Storage Managerfor LinuxVersion 7.1.5

Administrator's Reference

IBM

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

Fifth edition (March 2016)

This edition applies to version 7, release 1, modification 5 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, 2016.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 . . . . . xiiiWhat's new in Version 7.1.5. . . . . . . . . xiv

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 . . . . . . . . . . . 3Formatting output from commands. . . . . . 4Saving command output to a specified location. . 4Administrative 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 . . . . . . . . . . . . . . . 19Routing commands inside scripts . . . . . . 19

Privilege classes for commands . . . . . . . . 20Commands 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) . . . . . . . 101COMMIT (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) . . . . . . . . . . . . . . . 121

Copyright IBM Corp. 1993, 2016 iii

COPY SERVERGROUP (Copy a server group) 122DEACTIVATE 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 DEVCLASS - z/OS media server(Define device class for z/OS media server) . . 230DEFINE DOMAIN (Define a new policydomain) . . . . . . . . . . . . . . 251DEFINE DRIVE (Define a drive to a library) . . 253DEFINE EVENTSERVER (Define a server as theevent server) . . . . . . . . . . . . 258DEFINE GRPMEMBER (Add a server to aserver group) . . . . . . . . . . . . 259DEFINE LIBRARY (Define a library). . . . . 260DEFINE MACHINE (Define machineinformation for disaster recovery) . . . . . 281DEFINE MACHNODEASSOCIATION(Associate a node with a machine) . . . . . 283DEFINE MGMTCLASS (Define a managementclass) . . . . . . . . . . . . . . . 285DEFINE NODEGROUP (Define a node group) 288DEFINE NODEGROUPMEMBER (Define nodegroup member). . . . . . . . . . . . 289DEFINE PATH (Define a path) . . . . . . 290DEFINE POLICYSET (Define a policy set) . . . 300DEFINE PROFASSOCIATION (Define a profileassociation) . . . . . . . . . . . . . 302DEFINE PROFILE (Define a profile) . . . . . 308DEFINE RECMEDMACHASSOCIATION(Associate recovery media with a machine) . . 310DEFINE RECOVERYMEDIA (Define recoverymedia) . . . . . . . . . . . . . . 312DEFINE SCHEDULE (Define a client or anadministrative command schedule) . . . . . 314DEFINE SCRATCHPADENTRY (Define ascratch pad entry) . . . . . . . . . . . 339DEFINE SCRIPT (Define a Tivoli StorageManager script) . . . . . . . . . . . 341

DEFINE SERVER (Define a server forserver-to-server communications). . . . . . 344DEFINE SERVERGROUP (Define a servergroup). . . . . . . . . . . . . . . 351DEFINE SPACETRIGGER (Define the spacetrigger) . . . . . . . . . . . . . . 352DEFINE STATUSTHRESHOLD (Define a statusmonitoring threshold) . . . . . . . . . 355DEFINE STGPOOL (Define a storage pool) . . 359DEFINE STGPOOLDIRECTORY (Define astorage pool directory) . . . . . . . . . 415DEFINE SUBSCRIPTION (Define a profilesubscription) . . . . . . . . . . . . 417DEFINE VIRTUALFSMAPPING (Define avirtual file space mapping) . . . . . . . . 419DEFINE VOLUME (Define a volume in astorage pool) . . . . . . . . . . . . 421

DELETE commands . . . . . . . . . . . 428DELETE ALERTTRIGGER (Remove a messagefrom an alert trigger) . . . . . . . . . . 430DELETE ASSOCIATION (Delete the nodeassociation to a schedule) . . . . . . . . 431DELETE BACKUPSET (Delete a backup set) . . 433DELETE CLIENTOPT (Delete an option in anoption set) . . . . . . . . . . . . . 438DELETE CLOPTSET (Delete a client option set) 439DELETE COLLOCGROUP (Delete a collocationgroup). . . . . . . . . . . . . . . 440DELETE COLLOCMEMBER (Delete collocationgroup member). . . . . . . . . . . . 441DELETE COPYGROUP (Delete a backup orarchive copy group) . . . . . . . . . . 444DELETE DATAMOVER (Delete a data mover) 446DELETE DEDUPSTATS (Delete datadeduplication statistics) . . . . . . . . . 447DELETE DEVCLASS (Delete a device class) . . 451DELETE DOMAIN (Delete a policy domain) 452DELETE DRIVE (Delete a drive from a library) 453DELETE EVENT (Delete event records). . . . 454DELETE EVENTSERVER (Delete the definitionof the event server) . . . . . . . . . . 456DELETE FILESPACE (Delete client node datafrom the server) . . . . . . . . . . . 457DELETE GRPMEMBER (Delete a server from aserver group) . .