OSBackupRuleDetails Data Type

Properties
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
ruleBackupDestinations array of RuleBackupDestinationResponse  
removable boolean required
daysToKeepRetentionLock number required
backupCount number required
includes array of OSRuleRangeDTO  
excludes array of OSRuleRangeDTO  

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,
  "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" : "SECONDARY",
    "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
    }
  } ],
  "removable" : true,
  "daysToKeepRetentionLock" : 12345,
  "backupCount" : 12345,
  "includes" : [ {
    "type" : "EXCLUDE",
    "protectedEntityGuid" : "...",
    "directory" : "...",
    "recursive" : true,
    "includeMountedFileSystems" : true,
    "filters" : [ {
      "type" : "SIZE",
      "conditions" : [ { }, { } ]
    }, {
      "type" : "SIZE",
      "conditions" : [ { }, { } ]
    } ]
  }, {
    "type" : "EXCLUDE",
    "protectedEntityGuid" : "...",
    "directory" : "...",
    "recursive" : true,
    "includeMountedFileSystems" : true,
    "filters" : [ {
      "type" : "SIZE",
      "conditions" : [ { }, { } ]
    }, {
      "type" : "SIZE",
      "conditions" : [ { }, { } ]
    } ]
  } ],
  "excludes" : [ {
    "type" : "EXCLUDE",
    "protectedEntityGuid" : "...",
    "directory" : "...",
    "recursive" : true,
    "includeMountedFileSystems" : true,
    "filters" : [ {
      "type" : "EXTENSION",
      "conditions" : [ { }, { } ]
    }, {
      "type" : "EXTENSION",
      "conditions" : [ { }, { } ]
    } ]
  }, {
    "type" : "INCLUDE",
    "protectedEntityGuid" : "...",
    "directory" : "...",
    "recursive" : true,
    "includeMountedFileSystems" : true,
    "filters" : [ {
      "type" : "SIZE",
      "conditions" : [ { }, { } ]
    }, {
      "type" : "EXTENSION",
      "conditions" : [ { }, { } ]
    } ]
  } ]
}