Windows operating systems

Vmrestoretype

Use the vmrestoretype option with the query VM or restore VM commands to specify the type of restore operation to perform or query.

This option is only valid for VMware virtual machines. The virtual machines must be hosted on VMware ESXi 5.1 servers, or later versions. You must be licensed to use Tivoli® Storage Manager for Virtual Environments: Data Protection for VMware to use this option.

Supported Clients

Windows operating systemsThis option can be used with supported Windows clients.

Options file

This option must be specified on the command line of a restore vm or query vm command. You cannot set this option in the client options file.

Syntax

Read syntax diagramSkip visual syntax diagram
                  .-NONinstant------.   
>>-VMRESToretype--+-----------------+--------------------------><
                  +-INSTANTRestore--+   
                  +-INSTANTAccess---+   
                  +-VMCLeanup-------+   
                  +-VMFULLCLeanup---+   
                  +-ALLtype---------+   
                  '-MOUNTCLEANUPAll-'   

Parameters

noninstant
Specifies that classic full VM restore is performed. This is the default restore type.
instantrestore
Specifies that an instant restore is performed. During an instant restore operation, the VM is started during the restore operation. When this restore type is specified on a query VM command, the command returns a list of VMs running an instant restore operation.
Important: For instant restore operations, ensure that both the temporary datastore that you specify with the vmtempdatastore option and the VMware datastore that is specified by the datastore option on the restore VM command have enough free storage to save the virtual machine that you are restoring, and the snapshot file that contains changes made to the data.
instantaccess
Specifies that a temporary restore of the backed-up VM is performed. Use this restore type when you want to restore a VM temporarily, to test the integrity of a backup, before you run an instant restore. Any changes that are made to the temporary VM are not saved.
When this restore type is specified on a query vm command, the command returns a list of VMs that are running an instant access operation.
vmcleanup
Specifies that a cleanup of the selected VM and its components is performed.
For instant access operations, this option removes the temporary VM and all of its components.
For instant restore operations, this option removes only the components that are no longer needed (for example the iSCSI mounts). The virtual machine is not removed. Cleanup operations are not allowed when the VM is still running on the iSCSI disks. To force this behavior see vmfullcleanup.
vmfullcleanup
The VM and all its components are removed regardless of the current state. Do not start a full clean up operation while vMotion is still migrating a virtual machine.
alltype
Queries all active instant access and instant restore sessions.
mountcleanupall
Cleans up active VM file level restore mount operations that are older than the period specified with the vmmountage option. You must specify restore vm "*" to use the mountcleanupall option.

Examples

Command line:
Perform an instant access of the VM named Oslo. The original VM still exists. As a result, the -vmname option is used to assign the new name Oslo_verify.
dsmc restore vm Oslo -vmrest=instantaccess -vmname=Oslo_verify
Perform an instant restore of the VM named Cologne.
dsmc restore vm Cologne -vmrest=instantrestore 
  -vmtempdatastore=Verify_datastore
Perform a regular (full VM) restore of the virtual machine named San_Jose.
dsmc restore vm San_Jose
Alternatively, you can also use the following command: dsmc restore vm San_Jose -vmrest=noni
Perform an instant restore of the VM named Oslo, with the -pick option to choose a specific backup version.
dsmc restore vm Oslo -vmrest=instantrestore -pick
Perform a cleanup of the VM and all its components. These components include iSCSI mounts, devices, and temporary data that are associated with the VM name, on the ESX host.
dsmc restore vm Oslo -VMRESToretype=VMCLeanup -vmname=Oslo_Verify
Perform a query to find all active instant restore sessions and display an abbreviated status for each.
dsmc query vm * -VMRESToretype=INSTANTRestore
Perform a query to find all active instant restore mode and instant access mode virtual machines.
dsmc query vm * -VMRESToretype=ALLtype
Perform a query to find all active instant restore mode virtual machines, and obtain detailed status for each virtual machine.
dsmc query vm * -VMRESToretype=INSTANTRestore -Detail
Perform a query to find all active instant access sessions.
dsmc query vm * -VMRESToretype=INSTANTAccess
Perform a mount cleanup of all mount operations that are active longer than 24 hours.
dsmc restore vm "*" -vmrestoretype=mountcleanupall -vmmountage=24