VmBackupPolicyRequest Data Type

Properties
name data type constraints description
name string required, max size: 255, min size: 1
backupRetryCount number required, min: 0
priority number required, max: 100, min: 0
autoRemoveNonPresent boolean required
autoAssignSettings AutoAssignSettingsRequest required
active boolean required
vms array of NameAndGuid  
rules array of VmBackupRuleRequest required, not empty
failRemainingBackupTasksExportThreshold number max: 100, min: 0
failRemainingBackupTasksStoreThreshold number max: 100, min: 0
projects array of NameAndGuid  
projectUuid string  
visibleForAllProjects boolean required
dailyReportEnabled boolean required
mailingList NameAndGuid  
executeAutoAssignmentAfterSavingPolicy boolean required
disableCleanOldBackups boolean required
quiesceBeforeSnapshot boolean required

Example

{
  "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" : "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
  }, {
    "guid" : "...",
    "name" : "...",
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "ruleBackupDestinations" : [ {
      "type" : "APPLICATION",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "PRIMARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "CLOUD",
      "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
}