Rule Data Type

Abstract Type
Subtypes
AppBackupRule, VmSnapshotMgmtRule, RecoveryPlanRule, StorageBackupRule, StorageSnapshotMgmtRule, OSBackupRule, VmBackupRule, BackupRule, CloudBackupRule
Properties
name data type description
name string
schedules array of Schedule
policy Policy
guid string
position number
ver number
auditEntityName string
nameAndGuid NameAndGuid
nameGuidAndType NameGuidAndType

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "name" : "...",
  "schedules" : [ {
    "guid" : "...",
    "ver" : 12345,
    "nameAndGuid" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "name" : "...",
    "millisSinceLocalMidnight" : 12345,
    "startWindowLength" : 12345,
    "active" : true,
    "lastRun" : 12345,
    "nameGuidAndType" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "lastSupposedRun" : 12345,
    "type" : "CLOUD_BACKUP",
    "executionType" : "TIME",
    "backupType" : "FULL",
    "daysOfWeek" : [ "FRIDAY", "THURSDAY" ],
    "dayOfWeekOccurrences" : [ "LAST_IN_MONTH", "FIRST_IN_MONTH" ],
    "months" : [ "JULY", "JULY" ],
    "rules" : [ {
      "name" : "...",
      "schedules" : [ { }, { } ],
      "policy" : { },
      "guid" : "...",
      "position" : 12345,
      "ver" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "name" : "...",
      "schedules" : [ { }, { } ],
      "policy" : { },
      "guid" : "...",
      "position" : 12345,
      "ver" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "interval" : {
      "startLocalTime" : 12345,
      "endLocalTime" : 12345,
      "frequency" : 12345
    },
    "projects" : [ {
      "uuid" : "...",
      "name" : "...",
      "active" : true,
      "present" : true,
      "hvManager" : { },
      "backupDestinations" : [ { }, { } ],
      "guid" : "...",
      "ver" : 12345,
      "hypervisorClusters" : [ { }, { } ],
      "hypervisorStorages" : [ { }, { } ],
      "quota" : { },
      "authenticationDomains" : [ { }, { } ],
      "sourceAuthenticationDomain" : { },
      "auditEntityName" : "...",
      "availableAuthenticationDomain" : { },
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "uuid" : "...",
      "name" : "...",
      "active" : true,
      "present" : true,
      "hvManager" : { },
      "backupDestinations" : [ { }, { } ],
      "guid" : "...",
      "ver" : 12345,
      "hypervisorClusters" : [ { }, { } ],
      "hypervisorStorages" : [ { }, { } ],
      "quota" : { },
      "authenticationDomains" : [ { }, { } ],
      "sourceAuthenticationDomain" : { },
      "auditEntityName" : "...",
      "availableAuthenticationDomain" : { },
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "visibleForAllProjects" : true,
    "buildInType" : "REAR_BACKUP",
    "forceFullBackup" : true,
    "auditEntityName" : "...",
    "startTime" : 12345
  }, {
    "guid" : "...",
    "ver" : 12345,
    "nameAndGuid" : {
      "guid" : "...",
      "name" : "..."
    },
    "name" : "...",
    "millisSinceLocalMidnight" : 12345,
    "startWindowLength" : 12345,
    "active" : true,
    "lastRun" : 12345,
    "nameGuidAndType" : {
      "type" : { },
      "guid" : "...",
      "name" : "..."
    },
    "lastSupposedRun" : 12345,
    "type" : "VM_RESTORE",
    "executionType" : "TIME",
    "backupType" : "SYNCHRONIZATION",
    "daysOfWeek" : [ "MONDAY", "SUNDAY" ],
    "dayOfWeekOccurrences" : [ "SECOND_IN_MONTH", "THIRD_IN_MONTH" ],
    "months" : [ "MAY", "JULY" ],
    "rules" : [ {
      "name" : "...",
      "schedules" : [ { }, { } ],
      "policy" : { },
      "guid" : "...",
      "position" : 12345,
      "ver" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "name" : "...",
      "schedules" : [ { }, { } ],
      "policy" : { },
      "guid" : "...",
      "position" : 12345,
      "ver" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "interval" : {
      "startLocalTime" : 12345,
      "endLocalTime" : 12345,
      "frequency" : 12345
    },
    "projects" : [ {
      "uuid" : "...",
      "name" : "...",
      "active" : true,
      "present" : true,
      "hvManager" : { },
      "backupDestinations" : [ { }, { } ],
      "guid" : "...",
      "ver" : 12345,
      "hypervisorClusters" : [ { }, { } ],
      "hypervisorStorages" : [ { }, { } ],
      "quota" : { },
      "authenticationDomains" : [ { }, { } ],
      "sourceAuthenticationDomain" : { },
      "auditEntityName" : "...",
      "availableAuthenticationDomain" : { },
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "uuid" : "...",
      "name" : "...",
      "active" : true,
      "present" : true,
      "hvManager" : { },
      "backupDestinations" : [ { }, { } ],
      "guid" : "...",
      "ver" : 12345,
      "hypervisorClusters" : [ { }, { } ],
      "hypervisorStorages" : [ { }, { } ],
      "quota" : { },
      "authenticationDomains" : [ { }, { } ],
      "sourceAuthenticationDomain" : { },
      "auditEntityName" : "...",
      "availableAuthenticationDomain" : { },
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "visibleForAllProjects" : true,
    "buildInType" : "POSTGRESQL_DB_BACKUP",
    "forceFullBackup" : true,
    "auditEntityName" : "...",
    "startTime" : 12345
  } ],
  "policy" : {
    "guid" : "...",
    "name" : "...",
    "ver" : 12345,
    "priority" : 12345,
    "backupRetryCount" : 12345,
    "autoAssignSettings" : {
      "guid" : "...",
      "ver" : 12345,
      "policy" : { },
      "mode" : "DISABLED",
      "regExps" : [ { }, { } ],
      "tags" : [ { }, { } ],
      "hvClusters" : [ { }, { } ],
      "nameAndGuid" : { },
      "storagePools" : [ { }, { } ],
      "nameGuidAndType" : { },
      "cloudServiceProviders" : [ { }, { } ],
      "osAgents" : [ { }, { } ],
      "projects" : [ { }, { } ],
      "auditEntityName" : "..."
    },
    "autoRemoveNonPresent" : true,
    "active" : true,
    "buildInType" : "REAR_BACKUP",
    "rules" : [ {
      "name" : "...",
      "schedules" : [ { }, { } ],
      "policy" : { },
      "guid" : "...",
      "position" : 12345,
      "ver" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "name" : "...",
      "schedules" : [ { }, { } ],
      "policy" : { },
      "guid" : "...",
      "position" : 12345,
      "ver" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "visibleForAllProjects" : true,
    "projects" : [ {
      "uuid" : "...",
      "name" : "...",
      "active" : true,
      "present" : true,
      "hvManager" : { },
      "backupDestinations" : [ { }, { } ],
      "guid" : "...",
      "ver" : 12345,
      "hypervisorClusters" : [ { }, { } ],
      "hypervisorStorages" : [ { }, { } ],
      "quota" : { },
      "authenticationDomains" : [ { }, { } ],
      "sourceAuthenticationDomain" : { },
      "auditEntityName" : "...",
      "availableAuthenticationDomain" : { },
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "uuid" : "...",
      "name" : "...",
      "active" : true,
      "present" : true,
      "hvManager" : { },
      "backupDestinations" : [ { }, { } ],
      "guid" : "...",
      "ver" : 12345,
      "hypervisorClusters" : [ { }, { } ],
      "hypervisorStorages" : [ { }, { } ],
      "quota" : { },
      "authenticationDomains" : [ { }, { } ],
      "sourceAuthenticationDomain" : { },
      "auditEntityName" : "...",
      "availableAuthenticationDomain" : { },
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "nameAndGuid" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "nameGuidAndType" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "auditEntityName" : "..."
  },
  "guid" : "...",
  "position" : 12345,
  "ver" : 12345,
  "auditEntityName" : "...",
  "nameAndGuid" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "nameGuidAndType" : {
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}