InstantRestoreTaskRequest Data Type

Properties
name data type constraints description
overwrite boolean required
hypervisor NameAndGuid  
hypervisorManager NameAndGuid  
restoredPeName string  
sparsifyRestoreEnabled boolean required
powerOnAfterRestore boolean required
failTaskAfterPowerOnFail boolean required
restoredNetworks array of RestoredNetworkRequest  
backup NameAndGuid  
backupLocation NameAndGuid required
nodeConfig NameAndGuid  
node NameAndGuid  
unmountTime number required, min: 0
mode MountedBackupMode required
restoreClusterId string max size: 255, min size: 0
migrateAfterInstantRestore boolean required
restoreStorageId string  
nfsStorageId string  
taskFiles array of TaskFilesDetails  

Example

{
  "overwrite" : true,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hypervisorManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "restoredPeName" : "...",
  "sparsifyRestoreEnabled" : true,
  "powerOnAfterRestore" : true,
  "failTaskAfterPowerOnFail" : true,
  "restoredNetworks" : [ {
    "network" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "networkInterfaceCard" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }
  }, {
    "network" : {
      "guid" : "...",
      "name" : "..."
    },
    "networkInterfaceCard" : {
      "guid" : "...",
      "name" : "..."
    }
  } ],
  "backup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "backupLocation" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "node" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "unmountTime" : 12345,
  "mode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "restoreClusterId" : "...",
  "migrateAfterInstantRestore" : true,
  "restoreStorageId" : "...",
  "nfsStorageId" : "...",
  "taskFiles" : [ {
    "backupFile" : {
      "backupTime" : 1451649601000,
      "lastModifiedTime" : 12345,
      "size" : 12345,
      "effectiveBackupSize" : 12345,
      "effectiveSuccessfulObjects" : 12345,
      "effectiveTotalDirectories" : 12345,
      "effectiveFailedObjects" : 12345,
      "effectiveProcessedDirectories" : 12345,
      "effectiveSkippedObjects" : 12345,
      "path" : "...",
      "originalPath" : "...",
      "locations" : [ { }, { } ],
      "backup" : { },
      "mountable" : true,
      "iscsiMountable" : true,
      "originalStorageId" : "...",
      "originalDiskId" : "...",
      "format" : "QCOW2",
      "backupFileType" : "OS_FILE",
      "vmDisk" : { },
      "parentBackupFile" : { },
      "encryption" : 12345,
      "config" : "...",
      "compressionType" : "TAR_GZIP",
      "underlyingStorageType" : "OPENNEBULA_IMAGE_DS",
      "restoresTime" : [ 12345, 12345 ],
      "objectName" : "...",
      "sessionId" : "...",
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "cloudFeature" : "SHAREPOINT"
    },
    "path" : "...",
    "config" : "...",
    "storageId" : "...",
    "diskAllocationFormat" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "originalDiskGuid" : "...",
    "diskName" : "...",
    "excludedFromRestore" : true
  }, {
    "backupFile" : {
      "backupTime" : 12345,
      "lastModifiedTime" : 12345,
      "size" : 12345,
      "effectiveBackupSize" : 12345,
      "effectiveSuccessfulObjects" : 12345,
      "effectiveTotalDirectories" : 12345,
      "effectiveFailedObjects" : 12345,
      "effectiveProcessedDirectories" : 12345,
      "effectiveSkippedObjects" : 12345,
      "path" : "...",
      "originalPath" : "...",
      "locations" : [ { }, { } ],
      "backup" : { },
      "mountable" : true,
      "iscsiMountable" : true,
      "originalStorageId" : "...",
      "originalDiskId" : "...",
      "format" : "OS_FILE",
      "backupFileType" : "DISK_META",
      "vmDisk" : { },
      "parentBackupFile" : { },
      "encryption" : 12345,
      "config" : "...",
      "compressionType" : "BZIP2",
      "underlyingStorageType" : "PORTWORX_VOLUME",
      "restoresTime" : [ 12345, 12345 ],
      "objectName" : "...",
      "sessionId" : "...",
      "guid" : "...",
      "cloudFeature" : "SHAREPOINT_SITE"
    },
    "path" : "...",
    "config" : "...",
    "storageId" : "...",
    "diskAllocationFormat" : {
      "name" : "...",
      "description" : "..."
    },
    "originalDiskGuid" : "...",
    "diskName" : "...",
    "excludedFromRestore" : true
  } ]
}