Administrator's Reference

Link to Other ADSM Books

Notices

Trademarks

Preface

Who Should Read This Publication

What You Should Know Before Reading This Publication

ADSTAR Distributed Storage Manager Publications

Related IBM Hardware Products Publications

IBM International Technical Support Center Publications (Redbooks)

Software Developer's Program

Do You Have Comments or Suggestions?

Translations

Changes for ADSTAR Distributed Storage Manager Version 3

Changes for Version 3--March 1998

Changes for Version 3--October 1997

Chapter 1. Using Syntax Diagrams

Chapter 2. Entering Administrative Commands

Command Components

Command Name

Positional Parameters

Keyword Parameters

Command Entry Rules

Processing Administrative Commands

Commands Processed in the Foreground

Commands Processed in the Background

Formatting Command Output on a Terminal

Using Wildcard Characters

Examples for Match-Any Characters

Examples for Match-Exactly-One Character

Naming Conventions

Naming Volumes

Case-Sensitivity

Naming Restrictions for Objects

Chapter 3. Using the Command-Line Interface

Using the Server Console

Using the Administrative Client Session

Using Administrative Client Options

Using Continuation Characters

Redirecting Command Output to a File in Batch and Interactive Modes

File Naming Conventions for Redirected Output

Using Macros to Issue Commands

Writing Commands in a Macro File

Writing Comments in a Macro File

Using Substitution Variables in a Macro

Running the Commands in a Macro

Controlling Command Processing in a Macro

Chapter 4. Using Commands Based on Privilege Class

Commands Requiring System Privilege

Commands Requiring Policy Privilege

Commands Requiring Storage Privilege

Commands Requiring Operator Privilege

Commands Requiring Analyst Privilege

Commands Any Administrator Can Issue

Chapter 5. Using Administrator Commands

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 STGPOOL (Back Up Primary Storage Pool to Copy Storage Pool)

BACKUP VOLHISTORY (Save Sequential Volume History Information)

BEGIN EVENTLOGGING (Begin Logging Events)

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)

COMMIT (Control Committing of Commands in a Macro)

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 SCHEDULE (Copy a Client or an Administrative Command Schedule)

DEFINE ASSOCIATION (Associate Client Nodes with a Schedule)

DEFINE CLIENTACTION (Define a Client Action)

DEFINE CLIENTOPT (Define an Option to an Option Set)

DEFINE CLOPTSET (Define Client Options)

DEFINE COPYGROUP (Define a Copy Group)

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 DOMAIN (Define a New Policy Domain)

DEFINE DRIVE (Define a Drive to a Library)

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 a Machine)

DEFINE MACHNODEASSOCIATION (Associate an ADSM Node With a Machine)

DEFINE MGMTCLASS (Define a Management Class)

DEFINE POLICYSET (Define a Policy Set)

DEFINE RECMEDMACHASSOCIATION (Associate Recovery Media with a Machine)

DEFINE RECOVERYMEDIA (Define Recovery Media)

DEFINE SCHEDULE (Define a Client or an Administrative Command Schedule)

DEFINE SERVER (Define a Target Server)

DEFINE STGPOOL (Define a Storage Pool)

DEFINE VOLUME (Define a Volume in a Storage Pool)

DELETE ASSOCIATION (Delete Node Associations with a Schedule)

DELETE CLIENTOPT (Delete an Option in an Option Set)

DELETE CLOPTSET (Delete a Client Option Set)

DELETE COPYGROUP (Delete a Copy Group)

DELETE DBBACKUPTRIGGER (Delete the Database Backup Trigger)

DELETE DBVOLUME (Delete a Database Volume)

DELETE DEVCLASS (Delete a Device Class)

DELETE DOMAIN (Delete a Policy Domain)

DELETE DRIVE (Delete a Drive from a Library)

DELETE EVENT (Delete Event Records)

DELETE FILESPACE (Delete Client Node Data from the Server)

DELETE LIBRARY (Delete a Library)

DELETE LOGVOLUME (Delete a Recovery Log Volume)

DELETE MACHINE (Delete a Machine)

DELETE MACHNODEASSOCIATION (Delete Association Between a Machine and a Node)

DELETE MGMTCLASS (Delete a Management Class)

DELETE POLICYSET (Delete a Policy Set)

DELETE RECMEDMACHASSOCIATION (Delete Recovery Media and Machine Association)

DELETE RECOVERYMEDIA (Delete Recovery Media)

DELETE SCHEDULE (Delete a Client or an Administrative Command Schedule)

DELETE SERVER (Delete a Target Server Definition)

DELETE STGPOOL (Delete a Storage Pool)

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)

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

LABEL LIBVOLUME (Label a Library Volume)

LOCK ADMIN (Lock Out an Administrator)

LOCK NODE (Lock Out a Client Node)

MACRO (Invoke a Macro)

MOVE DATA (Move Files on a Storage Pool Volume)

MOVE DRMEDIA (Move Disaster Recovery Media Offsite and Back Onsite)

MOVE MEDIA (Move Sequential Access Storage Pool Media)

PREPARE (Create a Recovery Plan File)

QUERY ACTLOG (Search Activity Log for Messages)

QUERY ADMIN (Display Information on One or More Administrators)

QUERY ASSOCIATION (Query Client Node Associations with a Schedule)

QUERY AUDITOCCUPANCY (Query Client Node Storage Utilization)

QUERY CLOPTSET (Query a Client Option Set)

QUERY CONTENT (Query the Contents of a Storage Pool Volume)

QUERY COPYGROUP (Query One or More Copy Groups)

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 DOMAIN (Query One or More Policy Domains)

QUERY DRIVE (Display 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 EVENTRULES (Query Rules for Server or Client Events)

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 One or More Client Nodes)

QUERY OCCUPANCY (Display File Space Information by Storage Pool)

QUERY OPTION (Query One or More Server Options)

QUERY POLICYSET (Query a Policy Set)

QUERY PROCESS (Query One or More Server Processes)

QUERY RECOVERYMEDIA (Query Recovery Media)

QUERY REQUEST (Query One or More Pending Mount Requests)

QUERY RESTORE (Query Restartable Restore Sessions)

QUERY SCHEDULE (Query One or More Schedules)

QUERY SERVER (Query a Target Server)

QUERY SESSION (Query One or More Client Sessions)

QUERY SQLSESSION (Display SQL Session Value)

QUERY STATUS (Query System Parameters)

QUERY STGPOOL (Query One or More Storage Pools)

QUERY SYSTEM (Query the System Configuration and Capacity)

QUERY VOLHISTORY (Display Sequential Volume History Information)

QUERY VOLUME (Query One or More 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)

REMOVE ADMIN (Delete an Administrator)

REMOVE NODE (Delete a Client Node or an Associated Machine Node)

RENAME ADMIN (Rename an Administrator)

RENAME FILESPACE (Rename a Client Filespace on the Server)

RENAME NODE (Rename a Client Node)

REPLY (Allow a Request to Continue Processing)

RESET BUFPOOL (Reset the Buffer Pool Statistics for the Database)

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 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)

SELECT (Perform an SQL Query of the ADSM 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 DRMCHECKLABEL (Specify Label Checking)

SET DRMCMDFILENAME (Specify a File Name for Containing the Executable

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 Plan Instructions

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 DRMVAULTNAME (Specify the Vault Name)

SET EVENTRETENTION (Specify 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 Number of Times Scheduler Retries Commands)

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 (Randomly Distribute 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 SERVERNAME (Specify the Server Name)

SET SQLDATETIMEFORMAT (Sets the Date, Time, and Time Stamp for SQL Data

SET SQLDISPLAYMODE (Sets the Display of SQL Data Types)

SET SQLMATHMODE (Sets the Mode to Carry Out SQL Arithmetic)

SET WEBAUTHTIMEOUT (Sets the Web Timeout Interval)

SETOPT (Set a Server Option for Dynamic Update)

UNLOCK ADMIN (Unlock an Administrator)

UNLOCK NODE (Unlock a Client Node)

UPDATE ADMIN (Update an Administrator)

UPDATE CLIENTOPT (Update a Client Option Sequence Number)

UPDATE CLOPTSET (Update a Client Option Set Description)

UPDATE COPYGROUP (Update a Copy Group)

UPDATE DBBACKUPTRIGGER (Update the Database Backup Trigger)

UPDATE DEVCLASS (Change the Attributes of a Device Class)

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 a Client Node)

UPDATE POLICYSET (Update a Policy Set)

UPDATE RECOVERYMEDIA (Update Recovery Media)

UPDATE SCHEDULE (Update a Client or an Administrative Command Schedule)

UPDATE SERVER (Update a Target Server Definition)

UPDATE STGPOOL (Change the Attributes of a Storage Pool)

UPDATE VOLHISTORY (Update Sequential Volume History Information)

UPDATE VOLUME (Change the Attributes of One or More Storage Pool Volumes)

VALIDATE POLICYSET (Verify a Policy Set)

VARY (Bring a Random Access Volume Online or Offline)

Appendix A. Miscellaneous Command Utilities

DSMFMT (Formatting Files for the Server)

DSMLABEL (Labeling Volumes)

GETIPXAD (Get the IPX Address)

Appendix B. Recovery Log Extension Command

DSMSERV EXTEND LOG (Emergency Log Extension)

Appendix C. Database Recovery Commands

DSMSERV DISPLAY DBBACKUPVOLUME (Display Database Backup Volume Information)

DSMSERV DISPLAY DBVOLUMES (Display Database Volume Information)

DSMSERV DISPLAY LOGVOLUMES (Display Recovery Log Volume Information)

DSMSERV RESTORE DB (Restore the Database)

Appendix D. Database Salvage Commands

DSMSERV DUMPDB (Dump the Database)

DSMSERV FORMAT (Format the Database and Log)

DSMSERV LOADDB (Reload the Database)

DSMSERV AUDITDB (Verify Database Information)

Appendix E. Tailoring Server Options

Modifying the Server Options File

Setting Communication Options

Setting Client-Server Options

Setting Date, Number, Time, and Language Options

Setting Database and Recovery Log Options

Setting Group Options

Setting Message Options

Setting Event Logging Options

Setting Miscellaneous Options

Requesting Information about Server Options

SNMPHEARTBEATINTERVAL

Appendix F. Glossary

Index

[ Top of Page | Previous Page | Next Page | Index ]

Administrator's Reference

Table of Contents