name | data type | constraints | description |
---|---|---|---|
guid | string | ||
name | string | ||
policy | NameAndGuid | ||
schedules | array of NameAndGuid | ||
vmCount | number | required | |
schedulesCount | number | required | |
position | number | required | |
active | boolean | required | |
removable | boolean | required | |
daysToKeepRetentionLock | number | required | |
vms | array of RecoveryPlanRuleVmDetails | ||
hypervisorType | HypervisorType | ||
hypervisorManagerType | HypervisorManagerType | ||
hypervisor | NameGuidAndType | ||
hypervisorManager | NameGuidAndType | ||
node | NameAndGuid | ||
backupSelection | BackupSelection | ||
restoreStorageId | string | ||
restoreStoragePath | string | ||
restoreCephStoragePool | string | ||
restoreClusterId | string | ||
restoreHostId | string | ||
restoreToOriginalVolumeType | boolean | required | |
restoreProject | NameAndGuid | ||
restoreVmFlavor | NameAndGuid | ||
restoreAccessKey | NameAndGuid | ||
nameGenerationMethod | RecoveryPlanRuleNameGenerationMethod | ||
namePrefix | string | ||
nameSuffix | string | ||
restorePath | string | ||
overwrite | boolean | required | |
baseImage | BaseImageDTO | ||
dataCenter | DataCenterDTO | ||
restoredDiskAllocationFormat | DiskAllocationFormat | ||
sparsifyRestoreEnabled | boolean | required | |
powerOnAfterRestore | boolean | required | |
failTaskAfterPowerOnFail | boolean | required | |
ruleNetworks | array of RecoveryPlanRuleNetworkDetails | ||
restoreImageStorageId | string |
Example
{ "guid" : "...", "name" : "...", "policy" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "schedules" : [ { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, { "guid" : "...", "name" : "..." } ], "vmCount" : 12345, "schedulesCount" : 12345, "position" : 12345, "active" : true, "removable" : true, "daysToKeepRetentionLock" : 12345, "vms" : [ { "guid" : "...", "name" : "...", "networks" : [ { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, { "guid" : "...", "name" : "..." } ], "hvType" : "CITRIX", "hvmType" : "AWS" }, { "guid" : "...", "name" : "...", "networks" : [ { "guid" : "...", "name" : "..." }, { "guid" : "...", "name" : "..." } ], "hvType" : "OVM", "hvmType" : "ORACLE" } ], "hypervisorType" : "KVM", "hypervisorManagerType" : "OPENSTACK", "hypervisor" : { "type" : { "name" : "ENUM_NAME", "description" : "Enum description" }, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "hypervisorManager" : { "type" : { "name" : "ENUM_NAME", "description" : "Enum description" }, "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" }, "nameGenerationMethod" : "AUTO_GENERATED", "namePrefix" : "...", "nameSuffix" : "...", "restorePath" : "...", "overwrite" : true, "baseImage" : { "uuid" : "..." }, "dataCenter" : { "name" : "...", "guid" : "..." }, "restoredDiskAllocationFormat" : "SPARSE", "sparsifyRestoreEnabled" : true, "powerOnAfterRestore" : true, "failTaskAfterPowerOnFail" : true, "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" : "..." } } ], "restoreImageStorageId" : "..." }