Parameters for Command Line Restores (VMware)

You can use the following parameters to control command line restores:

Parameter

Values

Parent Element

appName

Virtual Server

associations

backupset

vCenterInstance

backupsetName

Name of the backup set that contains the subclient.

associations

backupset

clientName

Name of the virtualization client that contains the subclient.

associations

backupset

clientName

Name of the client for Linux access node.

proxyForSnapClients

clientName

Name of the vCenter virtualization client

vCenterInstance

instanceName

Name of the instance that contains the subclient. By default this value is VMware.

associations

backupset

vCenterInstance

subclientName

Name of the subclient that contains the content to be restored.

associations

commCellName

Name of the CommCell.

associations

csGUID

Globally unique identifier for the CommServe system.

associations

flags

associations

hostName

Host name for the virtualization client.

associations

backupset/backupsetName

restoreOptions/browseOption

backupset/clientName

restoreOptions/browseOption

commCellId

The ID is always 2 for the CommServe system.

restoreOptions/browseOption

listMedia

restoreOptions/browseOption

copyPrecedence/copyPrecedenceApplicable

Whether the restore should be performed from a secondary copy for the storage policy (true or false).

restoreOptions/browseOption/mediaOption

drivePool

restoreOptions/browseOption/mediaOption

library

restoreOptions/browseOption/mediaOption

mediaAgent

restoreOptions/browseOption/mediaOption

noImage

restoreOptions/browseOption

timeRange/TimeZoneName

restoreOptions/browseOption

useExactIndex

restoreOptions/browseOption

clusterDBBackedup

true or false

restoreOptions/commonOptions

detectRegularExpression

true or false

restoreOptions/commonOptions

offlineMiningRestore

true or false

restoreOptions/commonOptions

powerRestore

true or false

restoreOptions/commonOptions

restoreToDisk

true or false

restoreOptions/commonOptions

systemStateBackup

true or false

restoreOptions/commonOptions

wildCard

true or false

restoreOptions/commonOptions

destClient/clientName

Client (proxy) where the content is to be restored.

restoreOptions/destination

inPlace

Whether the content should be restored in place (true or false).

restoreOptions/destination

isLegalHold

true or false

restoreOptions/destination

browseFilters

restoreOptions/fileOption

sourceItem

The backup data to be restored in the form '\vm_guid', '\vm_guid\drive\folder_name',

or '\vm_guid\disk_name'.

restoreOptions/fileOption

Datastore

Destination datastore

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

FolderPath

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

disks/Datastore

Virtual disk destination datastore.

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

disks/name

Virtual disk name.

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

nics/destinationNetwork

Name of the destination network.

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

nics/name

Network name.

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

nics/networkName

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

nics/subnetId

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

esxHost

ESX host name.

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

guid

GUID of source VM.

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

newGuid

GUID of destination VM.

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

name

Name of source VM.

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

newName

New name for the restored VM.

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

resourcePoolPath

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

vcloudOrgName

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

vcloudOwner

virtualServerRstOption/diskLevelVMRestoreOption/advancedRestoreOptions

dataCenterName

virtualServerRstOption/diskLevelVMRestoreOption

dataStore/dataStoreName

virtualServerRstOption/diskLevelVMRestoreOption

dataStore/freeSpaceInBytes

virtualServerRstOption/diskLevelVMRestoreOption

dataStore/totalSizeInBytes

virtualServerRstOption/diskLevelVMRestoreOption

delayMigrationMinutes

virtualServerRstOption/diskLevelVMRestoreOption

diskOption

virtualServerRstOption/diskLevelVMRestoreOption

esxServerName

Name of the vCenter where a VM is to be restored.

virtualServerRstOption/diskLevelVMRestoreOption

hostOrCluster

ESX host or cluster name.

virtualServerRstOption/diskLevelVMRestoreOption

generateNewGuid

Generate new GUID for destination VM (true or false).

virtualServerRstOption/diskLevelVMRestoreOption

passUnconditionalOverride

Overwrite destination VM (true or false).

virtualServerRstOption/diskLevelVMRestoreOption

powerOnVmAfterRestore

virtualServerRstOption/diskLevelVMRestoreOption

redirectWritesToDatastore

virtualServerRstOption/diskLevelVMRestoreOption

registerWithFailoverCluster

virtualServerRstOption/diskLevelVMRestoreOption

transportMode

virtualServerRstOption/diskLevelVMRestoreOption

useVcloudCredentials

virtualServerRstOption/diskLevelVMRestoreOption

userPassword/userName

User account name.

virtualServerRstOption/diskLevelVMRestoreOption

vcloudHostName

virtualServerRstOption/diskLevelVMRestoreOption

vcloudUserPassword/userName

virtualServerRstOption/diskLevelVMRestoreOption

vmFolderName

virtualServerRstOption/diskLevelVMRestoreOption

vmName

virtualServerRstOption/diskLevelVMRestoreOption

esxServer

virtualServerRstOption

isDiskBrowse

Used when browsing or restoring full VMs.

virtualServerRstOption

isFileBrowse

Used when browsing or restoring files or folders.

virtualServerRstOption

isVolumeBrowse

Used when browsing or restoring files or folders.

virtualServerRstOption

vCenterInstance/clientName

virtualServerRstOption

vCenterInstance/instanceName

virtualServerRstOption

viewType

virtualServerRstOption

volumeRstOption/destinationVendor

Type of destination (VMW).

restoreOptions

volumeRstOption/volumeLeveRestore

Used when restoring files or folders.

restoreOptions

volumeRstOption/volumeLevelRestoreType

VIRTUAL_MACHINE

VMDK_FILES

DISK_ATTACH

NONE

restoreOptions

destination/destPath

Destination restore path for files.

×

Loading...