OSBackupPolicyRequest Data Type

Properties
name data type constraints description
name string required, max size: 255, min size: 1
autoRemoveNonPresent boolean required
osAgents array of NameAndGuid  
backupRetryCount number required, min: 0
rules array of OSBackupRuleRequest  
priority number required, max: 100, min: 0
failRemainingBackupTasksExportThreshold number max: 100, min: 0
failRemainingBackupTasksStoreThreshold number max: 100, min: 0
active boolean required
dailyReportEnabled boolean required
mailingList NameAndGuid  
autoAssignSettings AutoAssignSettingsOSRequest required
executeAutoAssignmentAfterSavingPolicy boolean required
osType OSType  
disableCleanOldBackups boolean required

Example

{
  "name" : "...",
  "autoRemoveNonPresent" : true,
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "backupRetryCount" : 12345,
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "ruleBackupDestinations" : [ {
      "type" : "STORAGE",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "ARCHIVE",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "OS",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "PRIMARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    } ],
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "position" : 12345,
    "includes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ],
    "excludes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "ruleBackupDestinations" : [ {
      "type" : "VIRTUAL_MACHINE",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "PRIMARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "VIRTUAL_MACHINE",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "SECONDARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    } ],
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "position" : 12345,
    "includes" : [ {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ],
    "excludes" : [ {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ]
  } ],
  "priority" : 50,
  "failRemainingBackupTasksExportThreshold" : 12345.0,
  "failRemainingBackupTasksStoreThreshold" : 12345.0,
  "active" : true,
  "dailyReportEnabled" : true,
  "mailingList" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "autoAssignSettings" : {
    "mode" : "ASSIGN_AND_REMOVE",
    "includeRegExps" : [ "...", "..." ],
    "osAgents" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "executeAutoAssignmentAfterSavingPolicy" : true,
  "osType" : "LINUX",
  "disableCleanOldBackups" : true
}