IBM Tivoli Storage Manager, Version 7.1

Administrative commands

Administrative commands are available to manage and configure the server.

Information for each command includes:

A description of the tasks a command performs
The administrator privilege class required to use the command
A syntax diagram that identifies the required and optional parameters for the command
Descriptions of each parameter of the command
Examples of using the command
A list of related commands

ACCEPT DATE (Accepts the current system date)
Use this command to allow the server to begin normal processing, when the server does not start normal processing because of a discrepancy between the server date and the current date on the system.
ACTIVATE POLICYSET (Activate a new policy set)
Use this command to copy the contents of a policy set to the ACTIVE policy set for the domain. The server uses the rules in the ACTIVE policy set to manage client operations in the domain. You can define multiple policy sets for a policy domain, but only one policy set can be active. The current ACTIVE policy set is replaced by the one you specify when you issue this command. You can modify the ACTIVE policy set only by activating another policy set.
ASSIGN DEFMGMTCLASS (Assign a default management class)
Use this command to specify a management class as the default management class for a policy set. You must assign a default management class for a policy set before you can activate that policy set.
AUDIT commands
Use the AUDIT commands to review or examine the adequacy of the database information and the storage pool volume. The AUDIT LDAPDIRECTORY command deletes nodes or administrator IDs from an LDAP directory server, that do not authenticate their passwords with the LDAP directory server.
BACKUP commands
Use the BACKUP commands to create backup copies of Tivoli® Storage Manager information or objects.
BEGIN EVENTLOGGING (Begin logging events)
Use this command to begin logging events to one or more receivers. A receiver for which event logging has begun is an active receiver.
CANCEL commands
Use the CANCEL commands to end a task or process before it is completed.
CHECKIN LIBVOLUME (Check a storage volume into a library)
Use this command to add a sequential access storage volume or a cleaning tape to the server inventory for an automated library. The server cannot use a volume that physically resides in an automated library until that volume is checked in.
CHECKOUT LIBVOLUME (Check a storage volume out of a library)
Use this command to remove a sequential access storage volume from the server inventory for an automated library. This command creates a background process that can be canceled with the CANCEL PROCESS command. To display information on background processes, use the QUERY PROCESS command.
CLEAN DRIVE (Clean a drive)
Use this command when you want Tivoli Storage Manager to immediately load a cleaner cartridge into a drive regardless of the cleaning frequency.
COMMIT (Control committing of commands in a macro)
Use this command to control when a command is committed in a macro and to update the database when commands complete processing. When issued from the console mode of the administrative client, this command does not generate a message.
COPY commands
Use the COPY commands to create a copy of Tivoli Storage Manager objects or data.
DEFINE commands
Use the DEFINE commands to create Tivoli Storage Manager objects.
DELETE commands
Use the DELETE commands to delete or remove a Tivoli Storage Manager object.
DISABLE commands
Use DISABLE commands to prevent some types of operations by the server.
DISMOUNT command
Use the DISMOUNT command to dismount a volume by the real device address or by volume name.
DISPLAY OBJNAME (Display a full object name)
Use this command when you want Tivoli Storage Manager to display a full object name if the name displayed in a message or query output has been abbreviated due to length. Object names that are very long can be difficult to display and use through normal operating system facilities. The Tivoli Storage Manager server will abbreviate long names and assign them a token ID which might be used if the object path name exceeds 1024 bytes. The token ID is displayed in a string that includes identifiers for the node, filespace, and object name. The format is: [TSMOBJ:nID.fsID.objID]. When specified with the DISPLAY OBJNAME command, the token ID can be used to show the full object name.
ENABLE commands
Use ENABLE commands to allow some types of operations by the server.
END EVENTLOGGING (Stop logging events)
Use this command to stop logging events to an active receiver.
EXPIRE INVENTORY (Manually start inventory expiration processing)
Use this command to manually start inventory expiration processing. The inventory expiration process removes client backup and archive file copies from server storage. Removal is based on policy specifications in the backup and archive copy groups of the management classes to which the files are bound.
EXPORT commands
Use the EXPORT commands to copy information from a Tivoli Storage Manager server to sequential removable media.
EXTEND DBSPACE (Increase space for the database)
Use this command to increase space for the database by adding directories for the database to use.
GENERATE commands
Use the GENERATE commands for backup sets for a selected filespace or client node.
GRANT commands
Use the GRANT command to grant appropriate privileges or access.
HALT (Shut down the server)
Use this command to shut down the server. The HALT command forces an abrupt shutdown, which cancels all the administrative and client node sessions even if they are not completed.
HELP (Get help on commands and error messages)
Use this command to display administrative commands and error messages. You can issue the command from an administrative command line client.
IDENTIFY DUPLICATES (Identify duplicate data in a storage pool)
Use this command to start or stop processes that identify duplicate data in a storage pool. You can specify the number of duplicate-identification processes and their duration.
IMPORT commands
Use the IMPORT commands to import information from export media to a Tivoli Storage Manager server.
INSERT MACHINE (Insert machine characteristics information or recovery instructions)
Use this command to add client machine characteristics or recovery instructions to existing machine information in the database.
ISSUE MESSAGE (Issue a message from a server script)
Use this command with return code processing in a script to issue a message from a server script to determine where the problem is with a command in the script.
LABEL LIBVOLUME (Label a library volume)
Use this command to label tape volumes or, in an automated library, to label the volumes automatically as they are checked in. With this command, the server uses the full-length label with which the volumes are often prelabeled.
LOCK commands
Use the LOCK command to prevent users from accessing the server.
MACRO (Invoke a macro)
Use this command to invoke a file from the administrative command line that contains one or more Tivoli Storage Manager administrative commands to be performed.
MIGRATE STGPOOL (Migrate storage pool to next storage pool)
Use this command to migrate files from one storage pool to the next storage pool in the storage hierarchy.
MOVE commands
Use the MOVE commands to either transfer backup or archive data between storage pools, or to move disaster recovery media on and off site.
NOTIFY SUBSCRIBERS (Notify managed servers to update profiles)
Use this command on a configuration manager to notify one or more managed servers to request that their configuration information be immediately refreshed.
PERFORM LIBACTION (Define or delete all drives and paths for a library)
Use this command to define or delete all drives and their paths for a single library in one step.
PING SERVER (Test the connection between servers)
Use this command to test the connection between the local server and a remote server.
PREPARE (Create a recovery plan file)
Use this command to create a recovery plan file, which contains the information that is needed to recover a Tivoli Storage Manager server. You can store a recovery plan file on a file system that is accessible to the source Tivoli Storage Manager server or on a target Tivoli Storage Manager server.
QUERY commands
Use the QUERY commands to request or display information about Tivoli Storage Manager objects.
QUIT (End the interactive mode of the administrative client)
Use this command to end an administrative client session in interactive mode.
RECLAIM STGPOOL (Reclaim volumes in a sequential-access storage pool)
Use this command to reclaim volumes in a sequential-access storage pool. Reclamation makes the fragmented space on volumes usable again by moving any remaining files from one volume to another volume. This action makes the original volume available for reuse. Reclamation does not move inactive versions of backup data from volumes in active-data pools. For storage pools defined with RECLAMATIONTYPE=SNAPLOCK, this command also deletes empty WORM FILE volumes that have exceeded their reclaim period.
RECONCILE VOLUMES (Reconcile differences in the virtual volume definitions)
Issue this command from the source server to reconcile differences between virtual volume definitions on the source server and archive files on the target server. Tivoli Storage Manager finds all volumes of the specified device class on the source server and all corresponding archive files on the target server. The target server inventory is also compared to the local definition for virtual volumes to see if inconsistencies exist.
REGISTER commands
Use the REGISTER commands to define or add objects to Tivoli Storage Manager.
REMOVE commands
Use the REMOVE commands to remove an object from Tivoli Storage Manager.
RENAME commands
Use the RENAME commands to change the name of an existing object.
REPLICATE NODE (Replicate data in file spaces that belong to a client node)
Use this command to replicate data in file spaces that belong to one or more client nodes or defined groups of client nodes.
REPLY (Allow a request to continue processing)
Use this command and an identification number to inform the server that you have completed a requested operation. Not all server requests require a reply. This command is required only if the request message specifically indicates that a reply is needed.
RESET PASSEXP (Reset password expiration)
Use the RESET PASSEXP command to reset the password expiration period to the common expiration period for administrator and client node passwords. The RESET PASSEXP command does not apply to passwords that are stored on an LDAP directory server.
RESTART EXPORT (Restart a suspended export operation)
Use this command to restart a suspended export operation.
RESTORE commands
Use the RESTORE commands to restore Tivoli Storage Manager storage pools or volumes.
REVOKE commands
Use the REVOKE commands to revoke privileges or access.
ROLLBACK (Rollback uncommitted changes in a macro)
Use this command within a macro to undo any processing changes made by commands run by the server but not yet committed to the database. A committed change is permanent and cannot be rolled back. The ROLLBACK command is useful for testing macros.
RUN (Run a Tivoli Storage Manager script)
Use this command to run a Tivoli Storage Manager script. To issue this command on another server, the script being run must be defined on that server.
SELECT (Perform an SQL query of the Tivoli Storage Manager database)
Use the SELECT command to create and format a customized query of the IBM® Tivoli Storage Manager database.
SET commands
Use the SET commands to specify values that affect many different Tivoli Storage Manager operations.
SETOPT (Set a server option for dynamic update)
Use the SETOPT command to update a server option dynamically without stopping and restarting the server. A SETOPT command contained in a macro or a script cannot be rolled back.
SHRED DATA (Shred data)
Use this command to manually start the process of shredding deleted sensitive data. Manual shredding is possible only if automatic shredding is disabled.
SUSPEND EXPORT (Suspend a currently running export operation)
Use this command to suspend a currently running server-to-server export operation which has a FILEDATA value that is not NONE. The export operation that you want to suspend must be past the initialization phase to be eligible for suspension. The state of the export operation is saved. The operation can be restarted by issuing the RESTART EXPORT command.
UNLOCK commands
Use the UNLOCK commands to reestablish access after an object was locked.
UPDATE commands
Use the UPDATE command to modify one or more attributes of an existing Tivoli Storage Manager object.
VALIDATE commands
Use the VALIDATE command to verify that an object is complete or valid for Tivoli Storage Manager.
VARY (Bring a random access volume online or offline)
Use this command to make a random access storage pool volume online or offline to the server.
AUDIT commands
Use the AUDIT commands to review or examine the adequacy of the database information and the storage pool volume. The AUDIT LDAPDIRECTORY command deletes nodes or administrator IDs from an LDAP directory server, that do not authenticate their passwords with the LDAP directory server.
BACKUP commands
Use the BACKUP commands to create backup copies of Tivoli Storage Manager information or objects.
CANCEL commands
Use the CANCEL commands to end a task or process before it is completed.
COPY commands
Use the COPY commands to create a copy of Tivoli Storage Manager objects or data.
DEFINE commands
Use the DEFINE commands to create Tivoli Storage Manager objects.
DELETE commands
Use the DELETE commands to delete or remove a Tivoli Storage Manager object.
DISABLE commands
Use DISABLE commands to prevent some types of operations by the server.
DISMOUNT command
Use the DISMOUNT command to dismount a volume by the real device address or by volume name.
ENABLE commands
Use ENABLE commands to allow some types of operations by the server.
EXPORT commands
Use the EXPORT commands to copy information from a Tivoli Storage Manager server to sequential removable media.
GENERATE commands
Use the GENERATE commands for backup sets for a selected filespace or client node.
GRANT commands
Use the GRANT command to grant appropriate privileges or access.
IMPORT commands
Use the IMPORT commands to import information from export media to a Tivoli Storage Manager server.
LOCK commands
Use the LOCK command to prevent users from accessing the server.
MOVE commands
Use the MOVE commands to either transfer backup or archive data between storage pools, or to move disaster recovery media on and off site.
QUERY commands
Use the QUERY commands to request or display information about Tivoli Storage Manager objects.
REGISTER commands
Use the REGISTER commands to define or add objects to Tivoli Storage Manager.
REMOVE commands
Use the REMOVE commands to remove an object from Tivoli Storage Manager.
RENAME commands
Use the RENAME commands to change the name of an existing object.
RESTORE commands
Use the RESTORE commands to restore Tivoli Storage Manager storage pools or volumes.
REVOKE commands
Use the REVOKE commands to revoke privileges or access.
SET commands
Use the SET commands to specify values that affect many different Tivoli Storage Manager operations.
UNLOCK commands
Use the UNLOCK commands to reestablish access after an object was locked.
UPDATE commands
Use the UPDATE command to modify one or more attributes of an existing Tivoli Storage Manager object.
VALIDATE commands
Use the VALIDATE command to verify that an object is complete or valid for Tivoli Storage Manager.

Parent topic: Server commands, options, and utilities

Feedback