Using commands

Table 1. Commands
Command	Description
archive	Archives files from a workstation to IBM Spectrum Protect™ 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 IBM Spectrum Protect 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 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 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	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 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 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 IBM Spectrum Protect 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 IBM Spectrum Protect server. This command is valid for all supported Windows clients.
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 the IBM Spectrum Protect server.
restore adobjects	Restores individual Active Directory objects from the local Active Directory Deleted Objects container.
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.
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 deprecated for online system restore operations. For more information, see Restore Systemstate.
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 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. 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 IBM Spectrum Protect password for your workstation.

Start and end a client command session
You can start or end a client command session in either batch mode or interactive mode.

Enter client command names, options, and parameters
A client command can include one or more of these components: Command name, options, and parameters. The topics that follow describe each of these components.

Wildcard characters
Use wildcard characters when you want to specify multiple files with similar names in one command. Without wildcard characters, you must repeat the command for each file.

Client commands reference
The following sections contain detailed information about each of the backup-archive client commands.

Archive
The archive command archives a single file, selected files, or all files in a directory and its subdirectories on a server.

Archive FastBack
Use the archive fastback command to archive Tivoli® Storage Manager FastBack volumes specified by the fbpolicyname, fbclientname and fbvolumename options for long-term retention.

Backup FastBack
Use the backup fastback command to back up Tivoli Storage Manager FastBack volumes specified by the fbpolicyname, fbclientname and fbvolumename options for long-term retention.

Backup Group
Use the backup group command to create and back 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.

Backup Image
The backup image command creates an image backup of one or more volumes on your system.

Backup NAS
The backup nas command creates an image backup of one or more file systems that belong to a Network Attached Storage (NAS) file server, otherwise known as NDMP Backup. You are prompted for the IBM Spectrum Protect administrator ID.

Backup Systemstate
Use the backup systemstate command to back up all bootable system state and system services components as a single object, to provide a consistent point-in-time snapshot of the system state.

Backup VM
Use the backup vm command to start a full backup of a virtual machine.

Cancel Process
The cancel process command displays a list of current NAS (if NDMP support is enabled) image backup and restore processes for which the administrative user has authority. You are prompted for the IBM Spectrum Protect administrator ID.

Cancel Restore
The cancel restore command displays a list of your restartable restore sessions in the server database.

Delete Access
The delete access command deletes authorization rules for files that are stored on the server.

Delete Archive
The delete archive command deletes archived files from IBM Spectrum Protect server storage. Your administrator must give you the authority to delete archived files.

Delete Backup
The delete backup command deletes files, images, and virtual machines that were backed up to IBM Spectrum Protect server storage. Your administrator must give you authority to delete objects.

Delete Filespace
The delete filespace command deletes file spaces in IBM Spectrum Protect server storage. A file space is a logical space on the server that contains files you backed up or archived.

Delete Group
Use the delete group command to delete a group backup on the IBM Spectrum Protect server.

Expire
The expire command deactivates the backup objects that you specify in the file specification or with the filelist option. You can specify an individual file to expire, or a file that contains a list of files to expire. If OBJTYPE=VM, this command deactivates the current backup for a virtual machine.

Help
Use the help command to display information about commands, options, and messages.

Incremental
The incremental command backs up all new or changed data in the locations that you specify, unless you exclude them from backup services.

Loop
The loop command starts an interactive command line session that is maintained until you enter quit.

Macro
The macro command runs a series of commands that you specify in a macro file.

Monitor Process
The monitor process command displays a list of current NAS (if NDMP support is enabled) image backup and restore processes for which the administrative user has authority. You are prompted for the IBM Spectrum Protect administrator ID.

Preview Archive
The preview archive command simulates an archive command without sending data to the server.

Preview Backup
The preview backup command simulates a backup command without sending data to the server.

Query Access
The query access command shows who was given access to backup versions or archive copies of specific files.

Query Adobjects
Use the query adobjects command to display information about the deleted objects that are located on the local Active Directory domain.

Query Archive
The query archive command displays a list of your archived files and the following information about each file: file size, archive date, file specification, expiration date, and archive description.

Query Backup
The query backup command displays a list of backup versions of your files that are stored on the IBM Spectrum Protect server, or that are inside a backup set from the server when the backupsetname option is specified.

Query Backupset
The query backupset command queries a backup set from a local file, tape device (if applicable), or the IBM Spectrum Protect server.

Query Filespace
The query filespace command displays a list of file spaces for a node. The file spaces are stored on the IBM Spectrum Protect server, or inside a backup set from the server when the backupsetname option is specified. You can also specify a single file space name to query.

Query Group
Use the query group command to display information about a group backup and its members.

Query Image
The query image command displays information about file system images that are stored on the IBM Spectrum Protect server, or that are inside a backup set from the IBM Spectrum Protect server, when the backupsetname option is specified.

Query Inclexcl
The query inclexcl command displays a list of include-exclude statements in the order in which they are processed during backup and archive operations. The list displays the type of option, the scope of the option (archive, all, and so on), and the name of the source file.

Query Mgmtclass
The query mgmtclass command displays information about the management classes available in your active policy set.

Query Node
The query node command displays all the nodes for which an administrative user ID has authority to perform operations. You are prompted for the IBM Spectrum Protect administrator ID.

Query Options
Use the query options command to display all or part of your options and their current settings that are relevant to the command-line client.

Query Restore
The query restore command displays a list of your restartable restore sessions in the server database. The list contains these fields: owner, replace, subdir, preservepath, source, and destination.

Query Schedule
The query schedule command displays the events that are scheduled for your node. Your administrator can set up schedules to perform automatic backups and archives for you. To plan your work, use this command to determine when the next scheduled events occur.

Query Session
The query session command displays information about your session, including the current node name, when the session was established, server information, and server connection information.

Query Systeminfo
Use the query systeminfo command to gather information and output this information to a file or the console.

Query Systemstate
Use the query systemstate command to display information about a backup of the system state on the IBM Spectrum Protect server, or system state inside a backup set from the IBM Spectrum Protect server, when the backupsetname option is specified.

Query VM
Use the query VM command to list and verify the successful backups of virtual machines.

Restart Restore
The restart restore command displays a list of your restartable restore sessions in the server database.

Restore
The restore command obtains copies of backup versions of your files from the IBM Spectrum Protect server, or inside a backup set.

Restore Adobjects
Use the restore adobjects command to restore individual Active Directory objects from the local Deleted Objects container.

Restore Backupset
The restore backupset command restores a backup set from the IBM Spectrum Protect server, a local file, or a local tape device. You can restore the entire backup set, or, in some cases, specific files within the backup set.

Restore Group
Use the restore group command to restore specific members or all members of a group backup.

Restore Image
The restore image command restores a file system or raw volume image that was backed up using the backup image command.

Restore NAS
The restore nas command restores the image of a file system that belongs to a Network Attached Storage (NAS) file server. When you are using an interactive command-line session with a non-administrative ID, you are prompted for an administrator ID.

Restore Systemstate
The restore systemstate command is deprecated for online system state restore operations.

Restore VM
Use the restore vm command to restore a virtual machine that was previously backed up.

Retrieve
The retrieve command obtains copies of archived files from the IBM Spectrum Protect server. You can retrieve specific files or entire directories.

Schedule
The schedule command starts the client scheduler on your workstation. The client scheduler must be running before scheduled work can start.

Selective
The selective command backs up files that you specify. If you damage or mislay these files, you can replace them with backup versions from the server.

Set Access
The set access command gives users at other nodes access to your backup versions or archived copies.

Set Event
Using the set event command, you can specify the circumstances for when archived data is deleted.

Set Netappsvm
The set netappsvm command associates the logon credentials for a cluster management server, which are specified on the set password command, with a NetApp storage virtual machine, and the data storage virtual machine (SVM) name (data Vserver). You must enter this command before you can create a snapshot difference incremental backup of a clustered NetApp volume.

Set Password
The set password command changes the IBM Spectrum Protect password for your workstation, or sets the credentials that are used to access another server.

Set Vmtags
The set vmtags command creates data protection tags and categories that can be added to VMware inventory objects. You can manage IBM Spectrum Protect backups of virtual machines in these VMware objects by specifying the tags with tools such as VMware vSphere PowerCLI Version 5.5 R2 or later.