VmBackupPolicyDetails Data Type

Properties
name data type constraints description
rules array of RuleDetails  
name string  
active boolean required
guid string  
priority number required
autoAssignSettings AutoAssignSettingsDetails  
autoRemoveNonPresent boolean required
vms array of VirtualMachineListRecord  
averageBackupSize number required
failRemainingBackupTasksExportThreshold number  
failRemainingBackupTasksStoreThreshold number  
projects array of ProjectForBackupPolicyDetail  
visibleForAllProjects boolean required
backupRetryCount number required
dailyReportEnabled boolean required
mailingList NameAndGuid  
disableCleanOldBackups boolean required
quiesceBeforeSnapshot boolean required

Example

{
  "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" : "OS_AGENT",
    "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" : [ "HVM_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_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" : "KVM",
    "averageProgress" : 12345.0,
    "lastChainMarkedForDeletion" : true,
    "hvmType" : "VIRTUOZZO",
    "guid" : "...",
    "project" : {
      "guid" : "...",
      "name" : "..."
    },
    "lastBackup" : 12345,
    "originalName" : "...",
    "restoreStatus" : "...",
    "possibleActions" : [ "HV_READ", "INVENTORY_SYNC" ],
    "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
}