The API allows you to list, view, create and edit virtual machine backup policies.
Returns list of virtual machine backup policies filtered by specified query parameters.
name | type | description | default | constraints |
---|---|---|---|---|
direction | query | |||
extended | query | false | boolean | |
filter | query | |||
nameLike | query | |||
orderBy | query | |||
page | query | |||
project | query | |||
project-uuid | query | |||
size | query | |||
virtual-machine | query |
media type | data type | description |
---|---|---|
application/json | array of VmBackupPolicyListRecord (JSON) | list of virtual machine backup policies filtered by specified query parameters |
GET /policies/vm-backup
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"ruleCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"autoAssignMode" : "DISABLED",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"vmCount" : 12345,
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"ruleBackupDestinations" : [ {
"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,
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestination" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "ARCHIVE",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
}
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"rule" : {
"guid" : "...",
"name" : "..."
},
"backupDestination" : {
"type" : { },
"guid" : "...",
"name" : "..."
},
"roleType" : "SECONDARY",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
}
} ],
"priority" : 50
} ]
Create virtual machine backup policy.
name | type | description |
---|---|---|
project-uuid | query | specify uuid of project in which returned policies are visible |
media type | data type | description |
---|---|---|
application/json | VmBackupPolicyRequest (JSON) | specify details for new virtual machine backup policy |
media type | data type | description |
---|---|---|
application/json | VmBackupPolicyDetails (JSON) | details of newly created virtual machine backup policy |
POST /policies/vm-backup
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"backupRetryCount" : 12345,
"priority" : 50,
"autoRemoveNonPresent" : true,
"autoAssignSettings" : {
"mode" : "ASSIGN_AND_REMOVE",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"includeTags" : [ "...", "..." ],
"excludeTags" : [ "...", "..." ],
"hvClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"active" : true,
"vms" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"rules" : [ {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"ruleBackupDestinations" : [ {
"type" : "VIRTUAL_MACHINE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "OS",
"guid" : "...",
"backupDestination" : { },
"roleType" : "SECONDARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ],
"position" : 12345,
"secondaryBdEnabled" : true
}, {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"ruleBackupDestinations" : [ {
"type" : "APPLICATION",
"guid" : "...",
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "STORAGE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "SECONDARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ],
"position" : 12345,
"secondaryBdEnabled" : true
} ],
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projectUuid" : "...",
"visibleForAllProjects" : true,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"executeAutoAssignmentAfterSavingPolicy" : true,
"disableCleanOldBackups" : true,
"quiesceBeforeSnapshot" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"rules" : [ {
"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
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50,
"autoAssignSettings" : {
"mode" : "ASSIGN_ONLY",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"includeTags" : [ "...", "..." ],
"excludeTags" : [ "...", "..." ],
"hvClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"autoRemoveNonPresent" : true,
"vms" : [ {
"name" : "...",
"type" : "OS",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmBackupPolicy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvType" : "KVM",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "OPENSTACK",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastBackup" : 1451649601000,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "INVENTORY_SYNC", "HVM_READ" ],
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmFlavor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"accessKey" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"networks" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
}, {
"name" : "...",
"type" : "CLOUD_TEAMS",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "...",
"name" : "..."
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulFullBackup" : {
"guid" : "...",
"name" : "..."
},
"vmBackupPolicy" : {
"guid" : "...",
"name" : "..."
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "...",
"name" : "..."
},
"hvType" : "KUBERNETES",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "GCP",
"guid" : "...",
"project" : {
"guid" : "...",
"name" : "..."
},
"lastBackup" : 12345,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "READ", "READ" ],
"rule" : {
"guid" : "...",
"name" : "..."
},
"vmFlavor" : {
"guid" : "...",
"name" : "..."
},
"accessKey" : {
"guid" : "...",
"name" : "..."
},
"networks" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
} ],
"averageBackupSize" : 12345,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"projects" : [ {
"guid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"uuid" : "..."
}, {
"guid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "...",
"name" : "..."
},
"uuid" : "..."
} ],
"visibleForAllProjects" : true,
"backupRetryCount" : 12345,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true,
"quiesceBeforeSnapshot" : true
}
Get auto-assignment preview for all virtual machines and given new backup policy.
name | type | description |
---|---|---|
project-uuid | query | specify uuid of project in which the new policy will be visible |
media type | data type | description |
---|---|---|
application/json | VmBackupPolicyRequest (JSON) | specify virtual machine backup policy details to create preview |
media type | data type | description |
---|---|---|
application/json | array of AutoAssignResultPreviewListRecord (JSON) | list of auto-assignment result preview records |
POST /policies/vm-backup/auto-assignment-preview
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"backupRetryCount" : 12345,
"priority" : 50,
"autoRemoveNonPresent" : true,
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"includeTags" : [ "...", "..." ],
"excludeTags" : [ "...", "..." ],
"hvClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"active" : true,
"vms" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"rules" : [ {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"ruleBackupDestinations" : [ {
"type" : "CLOUD",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "STORAGE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "SECONDARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ],
"position" : 12345,
"secondaryBdEnabled" : true
}, {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"ruleBackupDestinations" : [ {
"type" : "VIRTUAL_MACHINE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "VIRTUAL_MACHINE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ],
"position" : 12345,
"secondaryBdEnabled" : true
} ],
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projectUuid" : "...",
"visibleForAllProjects" : true,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"executeAutoAssignmentAfterSavingPolicy" : true,
"disableCleanOldBackups" : true,
"quiesceBeforeSnapshot" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
[ {
"protectedEntity" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"changeType" : "REMOVAL",
"changeReason" : "PE_IS_NOT_PRESENT"
} ]
Returns detailed list of virtual machine backup policies.
name | type | description | default | constraints |
---|---|---|---|---|
direction | query | |||
extended | query | false | boolean | |
filter | query | |||
nameLike | query | |||
orderBy | query | |||
page | query | |||
project | query | |||
project-uuid | query | |||
size | query | |||
virtual-machine | query |
media type | data type | description |
---|---|---|
application/json | array of VmBackupPolicyDetails (JSON) | detailed list of virtual machine backup policies |
GET /policies/vm-backup/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"rules" : [ {
"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
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50,
"autoAssignSettings" : {
"mode" : "ASSIGN_ONLY",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"includeTags" : [ "...", "..." ],
"excludeTags" : [ "...", "..." ],
"hvClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"autoRemoveNonPresent" : true,
"vms" : [ {
"name" : "...",
"type" : "APP",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmBackupPolicy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvType" : "KVM",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "OPENSTACK",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastBackup" : 1451649601000,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "WRITE", "READ" ],
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmFlavor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"accessKey" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"networks" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
}, {
"name" : "...",
"type" : "CLOUD_USER",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "...",
"name" : "..."
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulFullBackup" : {
"guid" : "...",
"name" : "..."
},
"vmBackupPolicy" : {
"guid" : "...",
"name" : "..."
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "...",
"name" : "..."
},
"hvType" : "ESXI",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "OPENNEBULA",
"guid" : "...",
"project" : {
"guid" : "...",
"name" : "..."
},
"lastBackup" : 12345,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "HV_READ", "READ" ],
"rule" : {
"guid" : "...",
"name" : "..."
},
"vmFlavor" : {
"guid" : "...",
"name" : "..."
},
"accessKey" : {
"guid" : "...",
"name" : "..."
},
"networks" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
} ],
"averageBackupSize" : 12345,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"projects" : [ {
"guid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"uuid" : "..."
}, {
"guid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "...",
"name" : "..."
},
"uuid" : "..."
} ],
"visibleForAllProjects" : true,
"backupRetryCount" : 12345,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true,
"quiesceBeforeSnapshot" : true
} ]
Get all the policies and rules from selected virtual machines
media type | data type | description |
---|---|---|
application/json | ProtectedEntityPolicyRequest (JSON) | containing selected virtual machines |
media type | data type | description |
---|---|---|
application/json | array of BackupPolicyForBackupListRecord (JSON) | list of policies and rules |
POST /policies/vm-backup/list-by-entities
Content-Type: application/json
Accept: application/json
{
"protectedEntities" : [ "...", "..." ]
}
HTTP/1.1 201 Created
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"entityCount" : 12345,
"rules" : [ {
"guid" : "...",
"name" : "...",
"markedForDeletion" : true,
"position" : 12345,
"ruleBackupDestinations" : [ {
"backupDestination" : { },
"roleType" : "ARCHIVE"
}, {
"backupDestination" : { },
"roleType" : "SECONDARY"
} ]
}, {
"guid" : "...",
"name" : "...",
"markedForDeletion" : true,
"position" : 12345,
"ruleBackupDestinations" : [ {
"backupDestination" : { },
"roleType" : "SECONDARY"
}, {
"backupDestination" : { },
"roleType" : "ARCHIVE"
} ]
} ]
} ]
Check validity of auto-assignment settings for virtual machine backup policy
media type | data type | description |
---|---|---|
application/json | VmBackupPolicyRequest (JSON) | specify details for new (or updated) virtual machine backup policy |
media type | data type | description |
---|---|---|
application/json | PolicyProjectAndClusterScopeValidationResultListRecord (JSON) | validation results |
PUT /policies/vm-backup/validation
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"backupRetryCount" : 12345,
"priority" : 50,
"autoRemoveNonPresent" : true,
"autoAssignSettings" : {
"mode" : "ASSIGN_AND_REMOVE",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"includeTags" : [ "...", "..." ],
"excludeTags" : [ "...", "..." ],
"hvClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"active" : true,
"vms" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"rules" : [ {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"ruleBackupDestinations" : [ {
"type" : "STORAGE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "SECONDARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "APPLICATION",
"guid" : "...",
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ],
"position" : 12345,
"secondaryBdEnabled" : true
}, {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"ruleBackupDestinations" : [ {
"type" : "VIRTUAL_MACHINE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "CLOUD",
"guid" : "...",
"backupDestination" : { },
"roleType" : "SECONDARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ],
"position" : 12345,
"secondaryBdEnabled" : true
} ],
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projectUuid" : "...",
"visibleForAllProjects" : true,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"executeAutoAssignmentAfterSavingPolicy" : true,
"disableCleanOldBackups" : true,
"quiesceBeforeSnapshot" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projectsWithoutMatchingClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"clustersWithoutMatchingProjects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
Remove virtual machine backup policy.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for virtual machine backup policy (use by vProtect) |
DELETE /policies/vm-backup/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single virtual machine backup policy.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for virtual machine backup policy (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | VmBackupPolicyDetails (JSON) | a single virtual machine backup policy details |
GET /policies/vm-backup/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"rules" : [ {
"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
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50,
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"includeTags" : [ "...", "..." ],
"excludeTags" : [ "...", "..." ],
"hvClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"autoRemoveNonPresent" : true,
"vms" : [ {
"name" : "...",
"type" : "CLOUD_USER",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmBackupPolicy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvType" : "KVM",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "OPENSTACK",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastBackup" : 1451649601000,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "READ", "WRITE" ],
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmFlavor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"accessKey" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"networks" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
}, {
"name" : "...",
"type" : "CLOUD_TEAMS",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "...",
"name" : "..."
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulFullBackup" : {
"guid" : "...",
"name" : "..."
},
"vmBackupPolicy" : {
"guid" : "...",
"name" : "..."
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "...",
"name" : "..."
},
"hvType" : "NUTANIX",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "FUSIONCOMPUTE",
"guid" : "...",
"project" : {
"guid" : "...",
"name" : "..."
},
"lastBackup" : 12345,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "READ", "READ" ],
"rule" : {
"guid" : "...",
"name" : "..."
},
"vmFlavor" : {
"guid" : "...",
"name" : "..."
},
"accessKey" : {
"guid" : "...",
"name" : "..."
},
"networks" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
} ],
"averageBackupSize" : 12345,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"projects" : [ {
"guid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"uuid" : "..."
}, {
"guid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "...",
"name" : "..."
},
"uuid" : "..."
} ],
"visibleForAllProjects" : true,
"backupRetryCount" : 12345,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true,
"quiesceBeforeSnapshot" : true
}
Change virtual machine backup policy details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for virtual machine backup policy (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | VmBackupPolicyRequest (JSON) | specify virtual machine backup policy details to update |
media type | data type | description |
---|---|---|
application/json | VmBackupPolicyDetails (JSON) | updated details of virtual machine backup policy |
PUT /policies/vm-backup/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"backupRetryCount" : 12345,
"priority" : 50,
"autoRemoveNonPresent" : true,
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"includeTags" : [ "...", "..." ],
"excludeTags" : [ "...", "..." ],
"hvClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"active" : true,
"vms" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"rules" : [ {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"ruleBackupDestinations" : [ {
"type" : "CLOUD",
"guid" : "...",
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "CLOUD",
"guid" : "...",
"backupDestination" : { },
"roleType" : "SECONDARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ],
"position" : 12345,
"secondaryBdEnabled" : true
}, {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"ruleBackupDestinations" : [ {
"type" : "CLOUD",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "APPLICATION",
"guid" : "...",
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ],
"position" : 12345,
"secondaryBdEnabled" : true
} ],
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projectUuid" : "...",
"visibleForAllProjects" : true,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"executeAutoAssignmentAfterSavingPolicy" : true,
"disableCleanOldBackups" : true,
"quiesceBeforeSnapshot" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"rules" : [ {
"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
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50,
"autoAssignSettings" : {
"mode" : "ASSIGN_AND_REMOVE",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"includeTags" : [ "...", "..." ],
"excludeTags" : [ "...", "..." ],
"hvClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"autoRemoveNonPresent" : true,
"vms" : [ {
"name" : "...",
"type" : "CLOUD_USER",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmBackupPolicy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvType" : "KVM",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "OPENSTACK",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastBackup" : 1451649601000,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "READ", "HV_READ" ],
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmFlavor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"accessKey" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"networks" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
}, {
"name" : "...",
"type" : "OS_AGENT",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "...",
"name" : "..."
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulFullBackup" : {
"guid" : "...",
"name" : "..."
},
"vmBackupPolicy" : {
"guid" : "...",
"name" : "..."
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "...",
"name" : "..."
},
"hvType" : "OPENSHIFT",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "RHV",
"guid" : "...",
"project" : {
"guid" : "...",
"name" : "..."
},
"lastBackup" : 12345,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "READ", "HVM_READ" ],
"rule" : {
"guid" : "...",
"name" : "..."
},
"vmFlavor" : {
"guid" : "...",
"name" : "..."
},
"accessKey" : {
"guid" : "...",
"name" : "..."
},
"networks" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
} ],
"averageBackupSize" : 12345,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"projects" : [ {
"guid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"uuid" : "..."
}, {
"guid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "...",
"name" : "..."
},
"uuid" : "..."
} ],
"visibleForAllProjects" : true,
"backupRetryCount" : 12345,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true,
"quiesceBeforeSnapshot" : true
}
Get auto-assignment preview for all virtual machines and given existing backup policy.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for virtual machine backup policy (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | VmBackupPolicyRequest (JSON) | specify virtual machine backup policy details to create preview |
media type | data type | description |
---|---|---|
application/json | array of AutoAssignResultPreviewListRecord (JSON) | list of auto-assignment result preview records |
POST /policies/vm-backup/{guid}/auto-assignment-preview
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"backupRetryCount" : 12345,
"priority" : 50,
"autoRemoveNonPresent" : true,
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"includeTags" : [ "...", "..." ],
"excludeTags" : [ "...", "..." ],
"hvClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"active" : true,
"vms" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"rules" : [ {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"ruleBackupDestinations" : [ {
"type" : "STORAGE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "CLOUD",
"guid" : "...",
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ],
"position" : 12345,
"secondaryBdEnabled" : true
}, {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"ruleBackupDestinations" : [ {
"type" : "VIRTUAL_MACHINE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "SECONDARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "OS",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ],
"position" : 12345,
"secondaryBdEnabled" : true
} ],
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projectUuid" : "...",
"visibleForAllProjects" : true,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"executeAutoAssignmentAfterSavingPolicy" : true,
"disableCleanOldBackups" : true,
"quiesceBeforeSnapshot" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
[ {
"protectedEntity" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"changeType" : "REMOVAL",
"changeReason" : "PE_IS_NOT_PRESENT"
} ]
name | type | description |
---|---|---|
guid | path |
media type | data type |
---|---|
application/json | CloneDTO (JSON) |
media type | data type | description |
---|---|---|
application/json | VmBackupPolicyDetails (JSON) |
POST /policies/vm-backup/{guid}/clone
Content-Type: application/json
Accept: application/json
{
"name" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"rules" : [ {
"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
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50,
"autoAssignSettings" : {
"mode" : "ASSIGN_AND_REMOVE",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"includeTags" : [ "...", "..." ],
"excludeTags" : [ "...", "..." ],
"hvClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"autoRemoveNonPresent" : true,
"vms" : [ {
"name" : "...",
"type" : "APP",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmBackupPolicy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvType" : "KVM",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "OPENSTACK",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastBackup" : 1451649601000,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "HV_READ", "WRITE" ],
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmFlavor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"accessKey" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"networks" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
}, {
"name" : "...",
"type" : "CLOUD_SITE",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "...",
"name" : "..."
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "...",
"name" : "..."
},
"lastSuccessfulFullBackup" : {
"guid" : "...",
"name" : "..."
},
"vmBackupPolicy" : {
"guid" : "...",
"name" : "..."
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "...",
"name" : "..."
},
"hvType" : "HYPERV",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "OPENNEBULA",
"guid" : "...",
"project" : {
"guid" : "...",
"name" : "..."
},
"lastBackup" : 12345,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "INVENTORY_SYNC", "HV_READ" ],
"rule" : {
"guid" : "...",
"name" : "..."
},
"vmFlavor" : {
"guid" : "...",
"name" : "..."
},
"accessKey" : {
"guid" : "...",
"name" : "..."
},
"networks" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
} ],
"averageBackupSize" : 12345,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"projects" : [ {
"guid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"uuid" : "..."
}, {
"guid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "...",
"name" : "..."
},
"uuid" : "..."
} ],
"visibleForAllProjects" : true,
"backupRetryCount" : 12345,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true,
"quiesceBeforeSnapshot" : true
}
name | type | description |
---|---|---|
guid | path |
media type | data type | description |
---|---|---|
application/json | array of VirtualMachineListRecord (JSON) |
GET /policies/vm-backup/{guid}/entities
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"type" : "APP",
"backupUpToDate" : true,
"restorable" : true,
"uuid" : "...",
"hypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulBackupSize" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackupSize" : 12345,
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"warningsPresent" : true,
"hvCluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmBackupPolicy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"present" : true,
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvType" : "KVM",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"hvmType" : "OPENSTACK",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastBackup" : 1451649601000,
"originalName" : "...",
"restoreStatus" : "...",
"possibleActions" : [ "READ", "HV_READ" ],
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmFlavor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"accessKey" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"networks" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"supportsQuiesceSnapshot" : true
} ]