Using commands
The backup-archive client provides a command-line interface (CLI) that you can use as an alternative to the graphical user interface (GUI). This topic describes how to start or end a client command session and how to enter commands.
- Start and end a client command session
- Enter client command names, options, and parameters
- Wildcard characters
The following table provides an alphabetical list of the commands and a brief description.
Command | Description |
---|---|
archive | Archives files from a workstation to Tivoli® Storage Manager storage. |
archive fastback | Archives volumes specified by the fbpolicyname, fbclientname and fbvolumename options for long term retention. |
backup fastback | Backs up volumes specified by the fbpolicyname, fbclientname and fbvolumename options for long term retention. |
backup group | Creates and backs up a group containing a list of files from one or more file space origins to a virtual file space on the Tivoli Storage Manager server. |
backup image | Creates an image backup of one or more file systems or logical volumes that you specify. |
backup nas | Creates an image backup of one or more file systems belonging to a Network Attached Storage (NAS) file server. |
backup systemstate | Backs up all startable system state and system services components as one object to provide a consistent point-in-time snapshot of the system state. This command is valid for any supported Windows client. |
backup vapp | Backs up a single VMware vApp, a list of vApps, or all vApps within an organization virtual data center. |
backup vm | Backs up virtual machines specified in the vmlist option. |
cancel process | Displays a list of current NAS (if NDMP support is enabled) image backup and restore processes for which the administrative user has authority. |
cancel restore | Displays a list of restartable restore sessions from which you can select one to cancel. |
delete access | Deletes authorization rules for files
that are stored on the server. On those clients that support image backup, this command deletes authorization rules for images that are stored on the server. |
delete archive | Deletes archived files from Tivoli Storage Manager server storage. |
delete backup | Deletes active and inactive backup files from Tivoli Storage Manager server storage. |
delete filespace | Deletes file spaces in Tivoli Storage Manager server storage. |
delete group | Deletes a group backup on the Tivoli Storage Manager server. |
expire | Inactivates backup objects that you specify in the file specification or with the filelist option. |
help | Displays a Table of Contents of help topics for the command-line client. |
incremental | Backs up all new or changed files or directories in the default client domain or from file systems, directories, or files you specify, unless you exclude them from backup services. |
loop | Starts an interactive command session. |
macro | Executes commands within a macro file that you specify. |
monitor process | Displays a list of current NAS image backup and restore processes from which you can select one to cancel. |
preview archive | Simulates an archive command without sending data to the server. |
preview backup | Simulates a backup command without sending data to the server. |
query access | Displays a list of current authorization rules. |
query adobjects | Displays a list of current authorization rules. |
query archive | Displays a list of archived files. |
query backup | Displays a list of backup versions. |
query backupset | Queries a backup set from a local file or the Tivoli Storage Manager server. On those clients that support tape devices, this command can query a backup set from a tape device. |
query filespace | Displays a list of file spaces in Tivoli Storage Manager storage. You can also specify a single file space name to query. |
query group | Displays information about group backups and their members. |
query image | Displays information about image backups. |
query inclexcl | Displays a list of include-exclude statements in the order in which they are processed during backup and archive operations. |
query mgmtclass | Displays information about available management classes. |
query node | Displays all the nodes for which an administrative user ID has authority to perform operations. |
query options | Displays all or part of your options and their current settings. |
query restore | Displays a list of your restartable restore sessions in the server database. |
query schedule | Displays information about scheduled events for your node. |
query session | Displays information about your session, including the current node name, when the session was established, server information, and server connection information. |
query systeminfo | Gathers Tivoli Storage Manager system information and outputs this information to a file or the console. |
query systemstate | Displays information about the backup of the system state on the Tivoli Storage Manager server. This command is valid for all supported Windows clients. |
query vapp | Determines which VMware vApps are backed up. |
query vm | Verifies the successful backups of the virtual machines from the vStorage backup server. |
restart restore | Displays a list of restartable restore sessions from which you can one to restart. |
restore | Restores copies of backup versions of your files from a Tivoli Storage Manager server. |
restore adobjects | Restores individual Active Directory objects from the local Active Directory Deleted Objects container. |
restore backupset | Restores a backup set from the Tivoli Storage Manager server or a local file. On those clients that support tape devices, this command can restore a backup set from a tape device. |
restore group | Restores specific members or all members of a group backup. |
restore image | Restores a file system or raw volume image backup. |
restore nas | Restores the image of a file system belonging to a Network Attached Storage (NAS) file server. |
restore systemstate | Restores a backup of the system state. This command is valid for all supported Windows clients. |
restore vapp | Restores a single VMware vApp. |
restore vm | Restores a full VM backup, and returns the full VM backup files to the vmbackdir directory on the vStorage backup server. |
retrieve | Retrieves copies of archived files from the Tivoli Storage Manager server. |
schedule | Starts the client scheduler on the workstation. |
selective | Backs up selected files. |
set access | Authorizes another user to access
your backup versions or archived copies. On those clients that support image backup, this command can set authorization rules for images that are stored on the server. |
set event | Allows you to specify the circumstances for when archived data is deleted. |
set netappsvm | Associates the login credentials for a cluster management server with a NetApp storage virtual machine and the data SVM name (data Vserver). This command must be entered before you can create a snapshot difference incremental backup of a clustered NetApp volume. |
set password | Changes the Tivoli Storage Manager password for your workstation. |
For proper operation, the was node must be restored to the same location and under the same name.