Administrator's Reference
Preface
Summary of Changes for Tivoli Storage Manager Version 5
Chapter 1. Using Syntax Diagrams
Chapter 2. Entering Administrative Commands
Chapter 3. Using the Command-Line Interface
Chapter 4. Using Commands Based on Privilege Class
Chapter 5. Command Reference
ACCEPT DATE (Accepts the Current System Date)
ACTIVATE POLICYSET (Activate a New Policy Set)
ASSIGN DEFMGMTCLASS (Assign a Default Management Class)
AUDIT LIBRARY (Verify an Automated Library's Inventory)
AUDIT LICENSES (Audit Server Storage Usage)
AUDIT VOLUME (Verify Database Information for a Storage Pool Volume)
BACKUP DB (Back Up the Database)
BACKUP DEVCONFIG (Create Backup Copies of Device Configuration Information)
BACKUP NODE (Back Up a NAS Node)
BACKUP STGPOOL (Back Up Primary Storage Pool to Copy Storage Pool)
BACKUP VOLHISTORY (Save Sequential Volume History Information)
BEGIN EVENTLOGGING (Begin Logging Events)
CANCEL EXPIRATION (Cancel an Expiration Process)
CANCEL PROCESS (Cancel an Administrative Process)
CANCEL REQUEST (Cancel One or More Mount Requests)
CANCEL RESTORE (Cancel a Restartable Restore Session)
CANCEL SESSION (Cancel One or More Client Sessions)
CHECKIN LIBVOLUME (Check a Storage Volume into a Library)
CHECKOUT LIBVOLUME (Check a Storage Volume out of a Library)
CLEAN DRIVE (Clean a Drive)
COMMIT (Control Committing of Commands in a Macro)
CONVERT ARCHIVE (Allow Clients to Query Archive Files by Description )
COPY CLOPTSET (Copy a Client Option Set)
COPY DOMAIN (Copy a Policy Domain)
COPY MGMTCLASS (Copy a Management Class)
COPY POLICYSET (Copy a Policy Set)
COPY PROFILE (Copy a Profile)
COPY SCHEDULE (Copy a Client or an Administrative Command Schedule)
COPY SCHEDULE -- Client
COPY SCHEDULE -- Administrative Command
COPY SCRIPT (Copy a Tivoli Storage Manager Script)
COPY SERVERGROUP (Copy a Server Group)
DEFINE ASSOCIATION (Associate Client Nodes with a Schedule)
DEFINE BACKUPSET (Define a Backup Set)
DEFINE CLIENTACTION (Define a One-Time Client Action)
DEFINE CLIENTOPT (Define an Option to an Option Set)
DEFINE CLOPTSET (Define a Client Option Set Name)
DEFINE COPYGROUP (Define a Copy Group)
DEFINE COPYGROUP -- Backup
DEFINE COPYGROUP -- Archive
DEFINE DATAMOVER (Define a Data Mover)
DEFINE DBBACKUPTRIGGER (Define the Database Backup Trigger)
DEFINE DBCOPY (Define a Volume Copy of a Database Volume)
DEFINE DBVOLUME (Define a Database Volume)
DEFINE DEVCLASS (Define a Device Class)
DEFINE DEVCLASS -- 3570
DEFINE DEVCLASS -- 3590
DEFINE DEVCLASS -- 4MM
DEFINE DEVCLASS -- 8MM
DEFINE DEVCLASS -- DLT
DEFINE DEVCLASS -- DTF
DEFINE DEVCLASS -- ECARTRIDGE
DEFINE DEVCLASS -- FILE
DEFINE DEVCLASS -- GENERICTAPE
DEFINE DEVCLASS -- LTO
DEFINE DEVCLASS -- NAS
DEFINE DEVCLASS -- OPTICAL and WORM TYPES
DEFINE DEVCLASS -- QIC
DEFINE DEVCLASS -- REMOVABLEFILE
DEFINE DEVCLASS -- SERVER
DEFINE DISK (Define a Disk)
DEFINE DOMAIN (Define a New Policy Domain)
DEFINE DRIVE (Define a Drive to a Library)
DEFINE EVENTSERVER (Define a Server as the Event Server)
DEFINE GRPMEMBER (Add a Server to a Server Group)
DEFINE LIBRARY (Define a Library)
DEFINE LOGCOPY (Define a Volume Copy of a Recovery Log Volume)
DEFINE LOGVOLUME (Define a Recovery Log Volume)
DEFINE MACHINE (Define Machine Information)
DEFINE MACHNODEASSOCIATION (Associate a Node With a Machine)
DEFINE MGMTCLASS (Define a Management Class)
DEFINE PATH (Define a Path)
DEFINE POLICYSET (Define a Policy Set)
DEFINE PROFASSOCIATION (Define a Profile Association)
DEFINE PROFILE (Define a Profile)
DEFINE RECMEDMACHASSOCIATION (Associate Recovery Media with a Machine)
DEFINE RECOVERYMEDIA (Define Recovery Media)
DEFINE SCHEDULE (Define a Client or an Administrative Command Schedule)
DEFINE SCHEDULE -- Client
DEFINE SCHEDULE -- Administrative Command
DEFINE SCRIPT (Define a Tivoli Storage Manager Script)
DEFINE SERVER (Define a Server for Server-to-Server Communications)
DEFINE SERVERGROUP (Define a Server Group)
DEFINE SPACETRIGGER (Define the Database or Recovery Log Space Trigger)
DEFINE STGPOOL (Define a Storage Pool)
DEFINE STGPOOL -- Primary Random Access
DEFINE STGPOOL -- Primary Sequential Access
DEFINE STGPOOL -- Copy Sequential Access
DEFINE SUBSCRIPTION (Define a Profile Subscription)
DEFINE VOLUME (Define a Volume in a Storage Pool)
DELETE ASSOCIATION (Delete the Node Association to a Schedule)
DELETE BACKUPSET (Delete a Backup Set)
DELETE CLIENTOPT (Delete an Option in an Option Set)
DELETE CLOPTSET (Delete a Client Option Set)
DELETE COPYGROUP (Delete a Copy Group)
DELETE DATAMOVER (Delete a Data Mover)
DELETE DBBACKUPTRIGGER (Delete the Database Backup Trigger)
DELETE DBVOLUME (Delete a Database Volume)
DELETE DEVCLASS (Delete a Device Class)
DELETE DISK (Delete a Disk)
DELETE DOMAIN (Delete a Policy Domain)
DELETE DRIVE (Delete a Drive from a Library)
DELETE EVENT (Delete Event Records)
DELETE EVENTSERVER (Deletes the Defintion of the Event Server)
DELETE FILESPACE (Delete Client Node Data from the Server)
DELETE GRPMEMBER (Delete a Server from a Server Group)
DELETE LIBRARY (Delete a Library)
DELETE LOGVOLUME (Delete a Recovery Log Volume)
DELETE MACHINE (Delete Machine Information)
DELETE MACHNODEASSOCIATION (Delete Association Between a Machine and a Node)
DELETE MGMTCLASS (Delete a Management Class)
DELETE PATH (Delete a Path)
DELETE POLICYSET (Delete a Policy Set)
DELETE PROFASSOCIATION (Delete a Profile Association)
DELETE PROFILE (Delete a Profile)
DELETE RECMEDMACHASSOCIATION (Delete Recovery Media and Machine Association)
DELETE RECOVERYMEDIA (Delete Recovery Media)
DELETE SCHEDULE (Delete a Client or an Administrative Command Schedule)
DELETE SCHEDULE -- Client
DELETE SCHEDULE -- Administrative Command
DELETE SCRIPT (Delete Command Lines from a Script or Delete the Entire Script)
DELETE SERVER (Delete a Server Definition)
DELETE SERVERGROUP (Delete a Server Group)
DELETE SPACETRIGGER (Delete the Database or Recovery Log Space Triggers)
DELETE STGPOOL (Delete a Storage Pool)
DELETE SUBSCRIBER (Delete Subscriptions from a Configuration Manager Database)
DELETE SUBSCRIPTION (Delete a Profile Subscription)
DELETE VOLHISTORY (Delete Sequential Volume History Information)
DELETE VOLUME (Delete a Storage Pool Volume)
DISABLE EVENTS (Disable Events for Event Logging)
DISABLE SESSIONS (Temporarily Prevent Client Node Access to the Server)
DISMOUNT VOLUME (Dismount a Volume by Volume Name)
ENABLE EVENTS (Enable Server or Client Events for Logging)
ENABLE SESSIONS (Resume User Activity on the Server)
END EVENTLOGGING (Stop Logging Events)
EXPIRE INVENTORY (Manually Start Inventory Expiration Processing)
EXPORT ADMIN (Copy Administrator Information to Sequential Media)
EXPORT NODE (Copy Client Node Information to Sequential Media)
EXPORT POLICY (Copy Policy Information to Sequential Media)
EXPORT SERVER (Copy Server Information to Sequential Media)
EXTEND DB (Increase the Assigned Capacity of the Database)
EXTEND LOG (Increase the Assigned Capacity of the Recovery Log)
GENERATE BACKUPSET (Generate a Backup Set of a Client's Data)
GRANT AUTHORITY (Add Administrator Authority)
HALT (Shut Down the Server)
HELP (Get Help on Commands and Error Messages)
IMPORT ADMIN (Import Administrator Information)
IMPORT NODE (Import Client Node Information)
IMPORT POLICY (Import Policy Information)
IMPORT SERVER (Import the Server)
INSERT MACHINE (Insert Machine Characteristics Information or Recovery Instructions)
ISSUE MESSAGE (Issue a Message From a Server Script)
LABEL LIBVOLUME (Label a Library Volume)
LOCK ADMIN (Lock Out an Administrator)
LOCK NODE (Lock Out a Client Node)
LOCK PROFILE (Lock a Profile)
MACRO (Invoke a Macro)
MOVE DATA (Move Files on a Storage Pool Volume)
MOVE DRMEDIA (Move Disaster Recovery Media Offsite and Back Onsite)
MOVE GRPMEMBER (Move a Server Group Member)
MOVE MEDIA (Move Sequential Access Storage Pool Media)
MOVE NODEDATA (Move Data by Node in a Sequential Access Storage Pool)
MOVE NODEDATA -- All File Spaces for One or More Nodes
MOVE NODEDATA -- Selected File Spaces for One Node
Related Commands
NOTIFY SUBSCRIBERS (Notify Managed Servers to Update Profiles)
PING SERVER (Test the Connection Between Servers)
PREPARE (Create a Recovery Plan File)
QUERY ACTLOG (Query the Activity Log)
QUERY ADMIN (Display Administrator Information)
QUERY ASSOCIATION (Query Client Node Associations with a Schedule)
QUERY AUDITOCCUPANCY (Query Client Node Storage Utilization)
QUERY BACKUPSET (Query a Backup Set)
QUERY BACKUPSETCONTENTS (Query Contents of a Backup Set)
QUERY CLOPTSET (Query a Client Option Set)
QUERY CONTENT (Query the Contents of a Storage Pool Volume)
QUERY COPYGROUP (Query Copy Groups)
QUERY DATAMOVER (Display Data Mover Definitions)
QUERY DB (Display Information on the Database)
QUERY DBBACKUPTRIGGER (Query the Database Backup Trigger)
QUERY DBVOLUME (Display Information on One or More Database Volumes)
QUERY DEVCLASS (Display Information on One or More Device Classes)
QUERY DISK (Query a Disk)
QUERY DOMAIN (Query a Policy Domain)
QUERY DRIVE (Query Information about a Drive)
QUERY DRMEDIA (Query Disaster Recovery Media)
QUERY DRMSTATUS (Query DRM System Parameters)
QUERY ENABLED (Query Enabled Events)
QUERY EVENT (Query Scheduled and Completed Events)
QUERY EVENT -- Client Schedules
QUERY EVENT -- Administrative Schedules
QUERY EVENTRULES (Query Rules for Server or Client Events)
QUERY EVENTSERVER (Query the Event Server)
QUERY FILESPACE (Query One or More File Spaces)
QUERY LIBRARY (Query a Library)
QUERY LIBVOLUME (Query a Library Volume)
QUERY LICENSE (Display License Information)
QUERY LOG (Display Information on the Recovery Log)
QUERY LOGVOLUME (Display Information on One or More Log Volumes)
QUERY MACHINE (Query Machine Information)
QUERY MEDIA (Query Sequential Access Storage Pool Media)
QUERY MGMTCLASS (Query a Management Class)
QUERY MOUNT (Display Information on Mounted Sequential Access Volumes)
QUERY NODE (Query Nodes)
QUERY OCCUPANCY (Query Client File Spaces in Storage Pools)
QUERY OPTION (Query Server Options)
QUERY PATH (Display a Path Definition)
QUERY POLICYSET (Query a Policy Set)
QUERY PROCESS (Query One or More Server Processes)
QUERY PROFILE (Query a Profile)
QUERY RECOVERYMEDIA (Query Recovery Media)
QUERY REQUEST (Query One or More Pending Mount Requests)
QUERY RESTORE (Query Restartable Restore Sessions)
QUERY RPFCONTENT (Query Recovery Plan File Contents Stored on a Target Server)
QUERY RPFILE (Query Recovery Plan File Information Stored on a Target Server)
QUERY SAN (Query the Devices on the SAN)
QUERY SCHEDULE (Query Schedules)
QUERY SCHEDULE -- Client
QUERY SCHEDULE -- Administrative
QUERY SCRIPT (Query Tivoli Storage Manager Scripts)
QUERY SERVER (Query a Server)
QUERY SERVERGROUP (Query a Server Group)
QUERY SESSION (Query Client Sessions)
QUERY SPACETRIGGER (Query the Database or Recovery Log Space Triggers)
QUERY SQLSESSION (Display SQL Session Value)
QUERY STATUS (Query System Parameters)
QUERY STGPOOL (Query Storage Pools)
QUERY SUBSCRIBER (Display Subscriber Information)
QUERY SUBSCRIPTION (Display Subscription Information)
QUERY SYSTEM (Query the System Configuration and Capacity)
QUERY VOLHISTORY (Display Sequential Volume History Information)
QUERY VOLUME (Query Storage Pool Volumes)
QUIT (End the Interactive Mode of the Administrative Client)
RECONCILE VOLUMES (Reconcile Differences in the Virtual Volume Definitions)
REDUCE DB (Decrease the Assigned Capacity of the Database)
REDUCE LOG (Decrease the Assigned Capacity of the Recovery Log)
REGISTER ADMIN (Register an Administrator)
REGISTER LICENSE (Register a New License)
REGISTER NODE (Register a Node)
REMOVE ADMIN (Delete an Administrator)
REMOVE NODE (Delete a Node or an Associated Machine Node)
RENAME ADMIN (Rename an Administrator)
RENAME FILESPACE (Rename a Client File Space on the Server)
RENAME NODE (Rename a Node)
RENAME SCRIPT (Rename a Tivoli Storage Manager Script)
RENAME SERVERGROUP (Rename a Server Group)
RENAME STGPOOL (Change the Name of a Storage Pool)
REPLY (Allow a Request to Continue Processing)
RESET BUFPOOL (Reset the Database Buffer Pool Statistics)
RESET DBMAXUTILIZATION (Reset the Utilization Statistic for the Database)
RESET LOGCONSUMPTION (Reset the Cumulative Log Consumption Statistic)
RESET LOGMAXUTILIZATION (Reset the Utilization Statistic for the Log)
RESTORE NODE (Restore a Node)
RESTORE STGPOOL (Restore Storage Pool Data from a Copy Pool)
RESTORE VOLUME (Restore Primary Volume Data from a Copy Pool)
REVOKE AUTHORITY (Remove Administrator Authority)
ROLLBACK (Rollback Uncommitted Changes in a Macro)
RUN (Run a Tivoli Storage Manager Script)
SELECT (Perform an SQL Query of the Tivoli Storage Manager Database)
SET ACCOUNTING (Set Accounting Records On or Off)
SET ACTLOGRETENTION (Set the Retention Period for the Activity Log)
SET AUTHENTICATION (Set Password Authentication)
SET CLIENTACTDURATION (Set the Duration Period for the Client Action)
SET CONFIGMANAGER (Specify a Configuration Manager)
SET CONFIGREFRESH (Set Managed Server Configuration Refresh)
SET CONTEXTMESSAGING (Set Message Context Reporting On or Off)
SET CROSSDEFINE (Specifies Whether to Cross-Define Servers)
SET DRMCHECKLABEL (Specify Label Checking)
SET DRMCMDFILENAME (Specify the Name of a File to Contain Commands)
SET DRMCOPYSTGPOOL (Specify the Copy Storage Pools to be Managed by DRM)
SET DRMCOURIERNAME (Specify the Courier Name)
SET DRMDBBACKUPEXPIREDAYS (Criteria for DB Backup Series Expiration)
SET DRMFILEPROCESS (Specify File Processing)
SET DRMINSTRPREFIX (Specify the Prefix for Recovery Instructions File Names)
SET DRMNOTMOUNTABLENAME (Specify the Not Mountable Location Name)
SET DRMPLANPREFIX (Specify a Prefix for Recovery Plan File Names)
SET DRMPLANVPOSTFIX (Specify Replacement Volume Names)
SET DRMPRIMSTGPOOL (Specify the Primary Storage Pools to be Managed by DRM)
SET DRMRPFEXPIREDAYS (Set Criteria for Recovery Plan File Expiration)
SET DRMVAULTNAME (Specify the Vault Name)
SET EVENTRETENTION (Set the Retention Period for Event Records)
SET INVALIDPWLIMIT (Set the Number of Invalid Logon Attempts)
SET LICENSEAUDITPERIOD (Set License Audit Period)
SET LOGMODE (Set Mode for Saving Recovery Log Records)
SET MAXCMDRETRIES (Set the Maximum Number of Command Retries)
SET MAXSCHEDSESSIONS (Set Maximum Scheduled Sessions)
SET MINPWLENGTH (Set Minimum Password Length)
SET PASSEXP (Set Password Expiration Date)
SET QUERYSCHEDPERIOD (Set Query Period for Polling Client Nodes)
SET RANDOMIZE (Set Randomization of Scheduled Start Times)
SET REGISTRATION (Set Open or Closed Registration)
SET RETRYPERIOD (Set Time between Retry Attempts)
SET SCHEDMODES (Select a Central Scheduling Mode)
SET SERVERFREE (Set Server-Free Data Movement Options)
SET SERVERHLADDRESS (Set the High-Level Address of a Server)
SET SERVERLLADDRESS (Set the Low-Level Address of a Server)
SET SERVERNAME (Specify the Server Name)
SET SERVERPASSWORD (Set Password for Server)
SET SERVERURL (Set URL for Server)
SET SQLDATETIMEFORMAT (Set the Format for Date, Time, and Time Stamp for SQL Data)
SET SQLDISPLAYMODE (Set the Display of SQL Data Types)
SET SQLMATHMODE (Set the Mode for SQL Arithmetic)
SET SUBFILE (Set Subfile Backup for Client Nodes)
SET SUMMARYRETENTION (Set Days to Keep Data in Activity Summary Table)
SET WEBAUTHTIMEOUT (Set the Web Time-out Interval)
SETOPT (Set a Server Option for Dynamic Update)
UNLOCK ADMIN (Unlock an Administrator)
UNLOCK NODE (Unlock a Client Node)
UNLOCK PROFILE (Unlock a Profile)
UPDATE ADMIN (Update an Administrator)
UPDATE BACKUPSET (Update a Retention Value Assigned to a Backup Set)
UPDATE CLIENTOPT (Update a Client Option Sequence Number)
UPDATE CLOPTSET (Update a Client Option Set Description)
UPDATE COPYGROUP (Update a Copy Group)
UPDATE COPYGROUP -- Backup
UPDATE COPYGROUP -- Archive
UPDATE DATAMOVER (Update a Data Mover)
UPDATE DBBACKUPTRIGGER (Update the Database Backup Trigger)
UPDATE DEVCLASS (Update the Attributes of a Device Class)
UPDATE DEVCLASS -- 3570
UPDATE DEVCLASS -- 3590
UPDATE DEVCLASS -- 4MM
UPDATE DEVCLASS -- 8MM
UPDATE DEVCLASS -- DLT
UPDATE DEVCLASS -- DTF
UPDATE DEVCLASS -- ECARTRIDGE
UPDATE DEVCLASS -- FILE
UPDATE DEVCLASS -- GENERICTAPE
UPDATE DEVCLASS -- LTO
UPDATE DEVCLASS -- NAS
UPDATE DEVCLASS -- OPTICAL and WORM TYPES
UPDATE DEVCLASS -- QIC
UPDATE DEVCLASS -- REMOVABLEFILE
UPDATE DEVCLASS -- SERVER
UPDATE DISK (Update a Disk)
UPDATE DOMAIN (Update a Policy Domain)
UPDATE DRIVE (Update a Drive)
UPDATE LIBRARY (Update a Library)
UPDATE LIBVOLUME (Change the Status of a Storage Volume)
UPDATE MACHINE (Update Machine Information)
UPDATE MGMTCLASS (Update a Management Class)
UPDATE NODE (Update Node Attributes)
UPDATE PATH (Change a Path)
UPDATE POLICYSET (Update a Policy Set Description)
UPDATE PROFILE (Update a Profile Description)
UPDATE RECOVERYMEDIA (Update Recovery Media)
UPDATE SCHEDULE (Update a Schedule)
UPDATE SCHEDULE -- Client
UPDATE SCHEDULE -- Administrative
UPDATE SCRIPT (Update a Tivoli Storage Manager Script)
UPDATE SERVER (Update a Server Defined for Server-to-Server Communications)
UPDATE SERVERGROUP (Update a Server Group Description)
UPDATE SPACETRIGGER (Update the Database or Recovery Log Space Triggers)
UPDATE STGPOOL (Update a Storage Pool)
UPDATE STGPOOL -- Primary Random Access
UPDATE STGPOOL -- Primary Sequential Access
UPDATE STGPOOL -- Copy Sequential Access
UPDATE VOLHISTORY (Update Sequential Volume History Information)
UPDATE VOLUME (Change a Storage Pool Volume)
VALIDATE POLICYSET (Verify a Policy Set)
VARY (Bring a Random Access Volume Online or Offline)
Chapter 6. Server Options Reference
Appendix A. Tivoli Storage Manager Utilities
Appendix B. Return Code Checking in Tivoli Storage Manager Scripts
Appendix C. Notices
Glossary
Index