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 IBM Spectrum Protect™ storage. |
![]() |
![]() |
![]() ![]() |
![]() ![]() |
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 IBM Spectrum Protect server. |
![]() ![]() ![]() ![]() |
![]() ![]() ![]() ![]() |
![]() ![]() ![]() ![]() |
![]() ![]() ![]() ![]() |
![]() |
![]() |
![]() ![]() |
![]() ![]() |
![]() ![]() ![]() |
![]() ![]() ![]() |
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.
|
delete archive | Deletes archived files from IBM Spectrum Protect server storage. |
delete backup | Deletes active and inactive backup files from IBM Spectrum Protect server storage. |
delete filespace | Deletes file spaces in IBM Spectrum Protect server storage. |
delete group | Deletes a group backup on the IBM Spectrum Protect 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 |
|
loop | Starts an interactive command session. |
macro | Executes commands within a macro file that you specify. |
![]() ![]() ![]() ![]() |
![]() ![]() ![]() ![]() |
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 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 IBM Spectrum Protect 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 IBM Spectrum Protect storage. You can also specify a single file space name to query. |
query group | Displays information about group backups and their members. |
![]() ![]() ![]() ![]() |
![]() ![]() ![]() ![]() |
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 IBM Spectrum Protect system information and outputs this information to a file or the console. |
![]() |
![]() |
![]() ![]() |
![]() ![]() |
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 the IBM Spectrum Protect server. |
![]() |
![]() |
restore backupset | Restores a backup set from the IBM Spectrum Protect 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. |
![]() ![]() ![]() ![]() |
![]() ![]() ![]() ![]() |
![]() ![]() ![]() ![]() |
![]() ![]() ![]() ![]() |
![]() |
![]() |
![]() ![]() |
![]() ![]() |
retrieve | Retrieves copies of archived files from the IBM Spectrum Protect 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.
|
set event | Allows you to specify the circumstances for when archived data is deleted. |
![]() ![]() |
![]() ![]() |
set password | Changes the IBM Spectrum Protect password for your workstation. |
For proper operation, the was node must be restored to the same location and under the same name.