Performing a Restore (VMware command line)

You can perform a restore operation from the command line using a saved script.

Backup data can be identified using the value of the sourceItem parameter in the form '\vm_guid\drive\folder_name'. For example: '\4219f389-9a22-0981-6d20-c93c195134f9\Volume1\FULL|'.

To get the GUID for a VM, you can use the vmClientGUID parameter as described in REST API - POST VM Restore.

For more information on command line parameters and XML elements, see Command Line - Syntax.

Before You Begin

You can use an XML file to provide input parameter values for commands. Use one of the following methods to provide XML input:

  • Generate a script and XML parameters file from the CommCell Console and save it on the computer where the restore will be performed.

  • Download the restore_template.xml file, modify it to match your requirements, and include it in the command line as shown in the sample procedure and examples for this topic.

Procedure

  1. Log in to the CommServe host using the qlogin command.

  2. Navigate to the location where the .xml file is saved and execute the command with the saved .xml file:

    qoperation execute -af restore_template.xml -appName 'Virtual Server' -clientName xxxxx -backupsetName xxxxx -destPath xxxxx -sourceItem xxxxx –subclientName xxxxx

    Note

    If the sourceItem parameter contains a directory path, verify that the path is a valid path for backed up data before you run the command.

  3. Verify the status of the job using the following command:

    qlist job −j jobID
  4. Once the job completes, log off from the CommServe host using the qlogout command.

Examples

Restoring a Full VM Out of Place

qoperation execute -af restore_template.xml -associations/clientName pseudoclient_name -associations/instanceName VMware -associations/backupsetName defaultBackupSet -associations/subclientName test_subclient -backupset/backupsetName defaultBackupSet -backupset/clientName pseudoclient_name -backupset/appName 'Virtual Server' -backupset/instanceName Vmware-advancedRestoreOptions/guid 'vm_client_guid' -advancedRestoreOptions/name source_vm_name -advancedRestoreOptions/newName restore_vm_name -advancedRestoreOptions/Datastore destination_datastore -esxHost esx_name -diskLevelVMRestoreOption/esxServerName vcenter_name -userPassword/userName administrator@vsphere.local -nics/destinationNetwork 'VM Network' -destClient/clientName proxy_client_name -sourceItem \vm_client_guid -destinationVendor VMW -vCenterInstance/instanceName VMware -vCenterInstance/appName 'Virtual Server' -vCenterInstance/clientName pseudoclient_name -disks/name scsi0-0-centos7-base.vmdk -disks/Datastore destination_datastore

Restoring a Full VM in Place

qoperation execute -af restore_template.xml -associations/clientName pseudoclient_name -associations/instanceName VMware -associations/backupsetName defaultBackupSet -associations/subclientName test_subclient -backupset/backupsetName defaultBackupSet -backupset/clientName pseudoclient_name -backupset/appName 'Virtual Server' -backupset/instanceName Vmware-advancedRestoreOptions/guid 'vm_client_guid' -advancedRestoreOptions/name source_vm_name -advancedRestoreOptions/newName source_vm_name -advancedRestoreOptions/Datastore destination_datastore -esxHost esx_name -diskLevelVMRestoreOption/esxServerName vcenter_name -userPassword/userName administrator@vsphere.local -nics/destinationNetwork 'VM Network' -destClient/clientName proxy_client_name -sourceItem \vm_client_guid -destinationVendor VMW -vCenterInstance/instanceName VMware -vCenterInstance/appName 'Virtual Server' -vCenterInstance/clientName pseudoclient_name -disks/name scsi0-0-centos7-base.vmdk -disks/Datastore destination_datastore -inPlace true -passUnconditionalOverride true

Restoring a Disk

qoperation execute -af restore_template.xml -associations/clientName pseudoclient_name -associations/instanceName VMware -associations/backupsetName defaultBackupSet -associations/subclientName test_subclient -backupset/backupsetName defaultBackupSet -backupset/clientName pseudoclient_name -backupset/appName 'Virtual Server' -backupset/instanceName Vmware-diskLevelVMRestoreOption/esxServerName vcenter_name -userPassword/userName administrator@vsphere.local -destClient/clientName proxy_client_name -sourceItem \vm_client_guidscsi0-0-centos7-base.vmdk -destinationVendor VMW -volumeLevelRestoreType VMDK_FILES -destination/destPath 'C:restores' -hostOrCluster esx_name

Restoring a Disk and Attaching It to a VM

qoperation execute -af restore_template.xml -associations/clientName pseudoclient_name -associations/instanceName VMware -associations/backupsetName defaultBackupSet -associations/subclientName test_subclient -backupset/backupsetName defaultBackupSet -backupset/clientName pseudoclient_name -backupset/appName 'Virtual Server' -backupset/instanceName Vmware-diskLevelVMRestoreOption/esxServerName vcenter_name -userPassword/userName administrator@vsphere.local -destClient/clientName proxy_client_name -sourceItem vm_client_guidscsi0-0-centos7-base.vmdk -destinationVendor VMW -volumeLevelRestoreType DISK_ATTACH -vCenterInstance/instanceName VMware -vCenterInstance/appName 'Virtual Server' -vCenterInstance/clientName pseudoclient_name -disks/name scsi0-0-centos7-base.vmdk -disks/Datastore destination_datastore -advancedRestoreOptions/guid 'vm_client_guid' -advancedRestoreOptions/newGuid 'vm_client_guid' -advancedRestoreOptions/name source_vm_name -advancedRestoreOptions/newName restore_vm_name -advancedRestoreOptions/Datastore destination_datastore -esxHost esx_name

Restoring a File

qoperation execute -af restore_template.xml -associations/clientName pseudoclient_name -associations/instanceName VMware -associations/backupsetName defaultBackupSet -associations/subclientName test_subclient -backupset/backupsetName defaultBackupSet -backupset/clientName pseudoclient_name -backupset/appName 'Virtual Server' -backupset/instanceName Vmware-diskLevelVMRestoreOption/esxServerName vcenter_name -userPassword/userName administrator@vsphere.local -destClient/clientName proxy_client_name -sourceItem \vm_client_guid\path -destinationVendor VMW -volumeLevelRestoreType NONE -destination/destPath 'C:restores' -proxyForSnapClients/clientName FBR_client_name -isFileBrowse true -isDiskBrowse false

Developer SDK - Python

×

Loading...