RecoveryPlanRuleRequest Data Type

Properties
name data type constraints default description
guid string    
name string required, max size: 255, min size: 1  
schedules array of NameAndGuid    
policy NameAndGuid    
position number required  
vms array of NameAndGuid    
active boolean required  
hypervisorType HypervisorType    
hypervisorManagerType HypervisorManagerType    
hypervisor NameAndGuid    
hypervisorManager NameAndGuid    
node NameAndGuid    
backupSelection BackupSelection    
restoreStorageId string    
restoreStoragePath string    
restoreCephStoragePool string    
restoreClusterId string    
restoreHostId string    
restoreToOriginalVolumeType boolean required  
restoreProject NameAndGuid    
restoreVmFlavor NameAndGuid    
restoreAccessKey NameAndGuid    
sparsifyRestoreEnabled boolean required  
powerOnAfterRestore boolean required false
failTaskAfterPowerOnFail boolean required false
nameGenerationMethod RecoveryPlanRuleNameGenerationMethod    
namePrefix string max size: 50, min size: 0  
nameSuffix string max size: 50, min size: 0  
restorePath string    
overwrite boolean required  
baseImage BaseImageDTO    
dataCenter DataCenterRequest    
ruleNetworks array of RecoveryPlanRuleNetworkRequest    
restoredDiskAllocationFormat DiskAllocationFormat    
restoreImageStorageId string    

Example

{
  "guid" : "...",
  "name" : "...",
  "schedules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "policy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "position" : 12345,
  "vms" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "active" : true,
  "hypervisorType" : "KVM",
  "hypervisorManagerType" : "OPENSTACK",
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hypervisorManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "node" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "backupSelection" : "LAST_SUCCESSFUL",
  "restoreStorageId" : "...",
  "restoreStoragePath" : "...",
  "restoreCephStoragePool" : "...",
  "restoreClusterId" : "...",
  "restoreHostId" : "...",
  "restoreToOriginalVolumeType" : true,
  "restoreProject" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "restoreVmFlavor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "restoreAccessKey" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "sparsifyRestoreEnabled" : true,
  "powerOnAfterRestore" : true,
  "failTaskAfterPowerOnFail" : true,
  "nameGenerationMethod" : "ORIGINAL_NAME",
  "namePrefix" : "...",
  "nameSuffix" : "...",
  "restorePath" : "...",
  "overwrite" : true,
  "baseImage" : {
    "uuid" : "..."
  },
  "dataCenter" : {
    "name" : "...",
    "uuid" : "...",
    "guid" : "...",
    "hvManager" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }
  },
  "ruleNetworks" : [ {
    "oldNetwork" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "newNetwork" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }
  }, {
    "oldNetwork" : {
      "guid" : "...",
      "name" : "..."
    },
    "newNetwork" : {
      "guid" : "...",
      "name" : "..."
    }
  } ],
  "restoredDiskAllocationFormat" : "FIXED_SIZE",
  "restoreImageStorageId" : "..."
}